feat: core deployment toolkit with tested RPC integration #1351

Jim8y · 2025-07-09T09:16:59Z

Summary

This PR introduces a production-ready deployment toolkit for Neo smart contracts, complete with deterministic RPC shims and exhaustive unit coverage.

Highlights

✅ DeploymentToolkit now enforces safe RPC usage, confirmation policies, and state snapshotting for manifest-driven deployments.
✅ Rich configuration surface (SetNetwork, ConfigureOptions, SetWifKey) with disposal/validation guards to prevent misuse.
✅ Helper infrastructure (QueueRpcClientFactory, StubRpcClient) enabling hermetic tests without live RPC endpoints.
✅ Expanded unit suite (39 tests, no skips) plus deterministic JSON-RPC handlers replacing formerly skipped "integration" coverage.

Example Usage

var toolkit = new DeploymentToolkit()
    .SetNetwork("testnet")
    .SetWifKey(wif)
    .ConfigureOptions(o => o.WaitForConfirmation = true);

var result = await toolkit.DeployArtifactsAsync(
    nefPath,
    manifestPath,
    initParams: new object?[] { "admin", 1 },
    waitForConfirmation: true);

Console.WriteLine($"Contract hash: {result.ContractHash}");

Testing

dotnet test tests/Neo.SmartContract.Deploy.UnitTests/Neo.SmartContract.Deploy.UnitTests.csproj
All tests green; no external RPC dependency required.

Follow-ups

Future PRs will hook this toolkit into CLI workflows and add manifest-driven batch deployment ergonomics.

* SafeAttribute supports in properties * Update Nep11Token.cs * Safe setters are not allowed

- Add DeploymentToolkit class with basic deployment API - Implement network configuration support (mainnet, testnet, local, custom RPC) - Add WIF key support for transaction signing - Create comprehensive project structure with interfaces and models - Add configuration management with JSON and environment variable support - Include 16 unit tests covering all basic functionality - Update README.md with deployment documentation and usage examples This establishes the foundation for Neo smart contract deployment capabilities without implementation details, providing a clean base for future enhancements.

…rence - Fix whitespace formatting issues in deployment toolkit files - Add missing final newlines to all source files - Remove duplicate Microsoft.NET.Test.Sdk package reference in test project - All 16 unit tests continue to pass - Code formatting now passes GitHub Actions checks

neo-devpack-dotnet.sln

src/Neo.SmartContract.Deploy/Models/NetworkConfiguration.cs

src/Neo.SmartContract.Deploy/Neo.SmartContract.Deploy.csproj

- Remove Network property from NetworkConfiguration as it depends on RpcUrl - Change NetworkMagic to nullable and retrieve from RPC when not configured - Add logic to fetch NetworkMagic from RPC using GetVersionAsync() - Remove unnecessary Compile Update section from csproj file - Update unit tests to match new behavior

- Add tests to verify network magic can be retrieved from RPC - Add tests for network configuration priority (specific > global > RPC) - Add tests for SetNetwork with various inputs and edge cases - Add tests to ensure proper RPC URL configuration for known networks - Document expected network magic values for mainnet and testnet

- Change testnet RPC URL from testnet1.neo.coz.io to testnet.rpc.ngd.network - Update all test assertions to use the new NGD testnet URL - Add integration tests to verify RPC connectivity (skipped by default) - Ensure network magic retrieval works with NGD testnet endpoint

- Change from testnet.rpc.ngd.network to testnet.ngd.network - Update all test assertions to use the correct URL

- Change testnet RPC URL to http://seed2t5.neo.org:20332 - Update all test assertions to use the Neo seed node URL - Update integration test names to reflect Neo testnet

vncoelho

Hi @Jim8y

My suggestion is that if this is able to Deploy and test, so, the examples we have here should be deployed during tests and we could verify states.
That would be a good test that has a real flow behind.

On the other hand, I see some separation between this repo and the framework being pushed here.

Jim8y · 2025-07-09T15:55:35Z

Hi @Jim8y

My suggestion is that if this is able to Deploy and test, so, the examples we have here should be deployed during tests and we could verify states. That would be a good test that has a real flow behind.

On the other hand, I see some separation between this repo and the framework being pushed here.

its hard to balance, smaller prs for easier to review, but lacks complete functionality, complete tookit too large for reviewing. yet if you wish to review as a whole, you can check the full pr. bellow is the deployed example contracts on testnet.

Latest Deployment (TestNet)

Contract	Address	Transaction Hash	Network
TokenContract	`0x2db2dce76b4a7f8116ecfae0d819e7099cb3a256`	`0x29397173e0e5ad93010f721ff6f786171e32e84f9bc44067072df332853e9554`	TestNet
NFTContract	`0x8699c5d074fc27cdbd7caec486387c1a29300536`	`0xc0b8c4b7dd68525da2adc39455252f32ac884947aeaba387c6ce20fa017952b7`	TestNet
GovernanceContract	`0xa3db58df3764610e43f3fda0c7b8633636c6c147`	`0x43d4a849396ddaf6b9917a3aeb30e49929a15fa32ebf51b1ab4b2d9e46dcf5a8`	TestNet

Deployment Details:

Deployer Address: NTmHjwiadq4g3VHpJ5FQigQcD4fF5m8TyX (0x0c3146e78efc42bfb7d4cc2e06e3efd063c01c56)
Network: NEO TestNet
RPC Endpoint: https://testnet1.neo.coz.io:443
Total GAS Consumed: ~30.00233163 GAS
Deployment Mode: Multi-contract with dependencies

vncoelho · 2025-07-09T15:57:45Z

I see @Jim8y, but why this needed to be here in Devpack?
Isn't this focussed on the C# compiler.

What I see in this pr is like a framework for interacting with the blockchain.

vncoelho · 2025-07-09T15:58:08Z

I see @Jim8y, but why this needed to be here in Devpack? Isn't this focussed on the C# compiler.

What I see in this pr is like a framework for interacting with the blockchain.

Maybe even the Core itself is better than here

Jim8y · 2025-07-09T15:59:57Z

I see @Jim8y, but why this needed to be here in Devpack? Isn't this focussed on the C# compiler.
What I see in this pr is like a framework for interacting with the blockchain.

Maybe even the Core itself is better than here

implementing, testing, deploying is a complete workflow, with this, developer can do everfything easily all together. they dont need to download and install and sync neo-cli, or searching for some unknown deployment methods. All of these is for a better development experience.

Jim8y · 2025-07-11T13:53:14Z

@shargon all your concern and suggestion have being resolved.

src/Neo.SmartContract.Deploy/DeploymentToolkit.cs

shargon · 2025-07-13T10:58:45Z

src/Neo.SmartContract.Deploy/Models/NetworkConfiguration.cs

+/// <summary>
+/// Wallet configuration settings
+/// </summary>
+public class WalletConfiguration


One class per file please

tests/Neo.SmartContract.Deploy.UnitTests/RpcIntegrationTests.cs

tests/Neo.SmartContract.Deploy.UnitTests/DeploymentToolkitTests.cs

src/Neo.SmartContract.Deploy/Shared/ScriptBuilderHelper.cs

Co-authored-by: Shargon <[email protected]>

…ffolding; add DeploymentArtifactsDemo example; fix RpcStore OnNewSnapshot; docs update

examples/DeploymentArtifactsDemo/Program.cs

shargon · 2025-09-12T09:55:51Z

@Jim8y Could you solve the conflicts?

…mples/Directory.Build.props and RpcStore; apply IsNullOrWhiteSpace in DeploymentArtifactsDemo

…support

…amework

shargon · 2025-10-28T08:29:43Z

src/Neo.SmartContract.Deploy/NetworkProfile.cs

+    public static NetworkProfile MainNet { get; } = new("mainnet", "https://mainnet1.neo.coz.io:443", 860833102, 0x35);
+    public static NetworkProfile TestNet { get; } = new("testnet", "http://seed2t5.neo.org:20332", 894710606, 0x35);
+    public static NetworkProfile Local { get; } = new("local", "http://localhost:50012");
+    public static NetworkProfile Private { get; } = new("private", "http://localhost:50012");


I think that the AddressVersion and NetworkMagic should be taken from an rpc request, we are not able to sign a different network by rpc

- README: document new signer hooks and standardise init param example - DeploymentArtifactsRequest.cs: add signer + custom transaction signer hooks - DeploymentOptions.cs: add signer provider, transaction signer plumbing

Jim8y · 2025-11-08T10:55:27Z

Thanks for the detailed write-up and examples. I still have a few blocking concerns before this can merge.

Scope / repo ownership – this PR adds an entire deployment framework (brand-new Neo.SmartContract.Deploy project plus example + extensive tests) to the compiler repo. Devpack currently ships the compiler/test harness and is consumed inside other IDE tooling. Dropping ~1.6k lines of runtime deployment/client code here creates a new product surface with its own lifecycle, dependencies (Microsoft.Extensions.Configuration, RPC factories, WIF management, etc.) and release cadence. Can we keep this effort in a dedicated repository/package and leave the devpack focused on compilation? If the intent really is to own deployment tooling here, it needs a clear plan for packaging, versioning and long-term maintenance.
Configuration loading from Directory.GetCurrentDirectory() – DeploymentToolkit’s default ctor (see src/Neo.SmartContract.Deploy/DeploymentToolkit.cs:52-66) walks the current working directory and environment-specific appsettings.*.json. In library usage (MSBuild, dotnet CLI, editors) the current directory is unpredictable, so the toolkit may try to load the caller’s appsettings file or a random file on disk. Please require an explicit configuration root (or default to AppContext.BaseDirectory) so using the toolkit from scripts/tests doesn’t depend on process working directory.
Plain-text WIF handling – _wifKey is kept as a raw string field (DeploymentToolkit.cs:37, 765-804) and copied around by UseTemporaryWif. Disposing the toolkit never zeroes the string, so the private key stays live in managed memory. At minimum we should store a WalletAccount/KeyPair and zero the underlying byte array when we’re done; holding WIF text in a volatile string is an easy leak vector for crash dumps/logging. Could you refactor this so sensitive key material is contained inside WalletAccount/KeyPair instances and cleared/disposed when we stop using it?

Happy to re-review once those items are resolved.

erikzhang and others added 2 commits June 16, 2025 21:35

SafeAttribute supports in properties (#1330)

6375fe6

* SafeAttribute supports in properties * Update Nep11Token.cs * Safe setters are not allowed

Jim8y mentioned this pull request Jul 9, 2025

feat: implement full Neo smart contract deployment functionality #1352

Closed

Jim8y force-pushed the pr1-core-deployment-framework branch from 2f05ca7 to ce28e18 Compare July 9, 2025 11:00

chore: update neo submodule to latest commit

ef94799

Jim8y force-pushed the pr1-core-deployment-framework branch from ce28e18 to ef94799 Compare July 9, 2025 11:06

shargon reviewed Jul 9, 2025

View reviewed changes

Jim8y added 8 commits July 9, 2025 21:07

fix: resolve code formatting issues

9e3ef8d

fix: correct NGD testnet RPC URL

7ae2d02

- Change from testnet.rpc.ngd.network to testnet.ngd.network - Update all test assertions to use the correct URL

chore: update testnet RPC URL to Neo seed node

877d6ef

- Change testnet RPC URL to http://seed2t5.neo.org:20332 - Update all test assertions to use the Neo seed node URL - Update integration test names to reflect Neo testnet

docs: add PR #1 test summary

eca436b

fix: resolve code formatting issues in test files

992f18e

vncoelho reviewed Jul 9, 2025

View reviewed changes

shargon reviewed Jul 13, 2025

View reviewed changes

Jim8y and others added 7 commits July 17, 2025 14:11

Update src/Neo.SmartContract.Deploy/Shared/ScriptBuilderHelper.cs

2f2f1ab

Co-authored-by: Shargon <[email protected]>

Update src/Neo.SmartContract.Deploy/Shared/ScriptBuilderHelper.cs

de026c3

Co-authored-by: Shargon <[email protected]>

Update src/Neo.SmartContract.Deploy/Shared/ScriptBuilderHelper.cs

12def91

Co-authored-by: Shargon <[email protected]>

Update src/Neo.SmartContract.Deploy/Shared/ScriptBuilderHelper.cs

630a3a3

Co-authored-by: Shargon <[email protected]>

Update src/Neo.SmartContract.Deploy/Shared/ScriptBuilderHelper.cs

ce8ccdd

Co-authored-by: Shargon <[email protected]>

Update src/Neo.SmartContract.Deploy/Shared/ScriptBuilderHelper.cs

cb776b7

Co-authored-by: Shargon <[email protected]>

Update tests/Neo.SmartContract.Deploy.UnitTests/RpcIntegrationTests.cs

da96daf

Co-authored-by: Shargon <[email protected]>

superboyiii mentioned this pull request Jul 24, 2025

v3.9.0 Checklist neo-project/neo#4091

Open

feat(deploy): implement minimal artifact deployment + calls; trim sca…

92cbba3

…ffolding; add DeploymentArtifactsDemo example; fix RpcStore OnNewSnapshot; docs update

ajara87 requested changes Sep 10, 2025

View reviewed changes

examples/DeploymentArtifactsDemo/Program.cs Outdated Show resolved Hide resolved

ajara87 requested changes Sep 10, 2025

View reviewed changes

examples/DeploymentArtifactsDemo/Program.cs Outdated Show resolved Hide resolved

ajara87 requested changes Sep 10, 2025

View reviewed changes

examples/DeploymentArtifactsDemo/Program.cs Outdated Show resolved Hide resolved

shargon changed the base branch from master to dev September 12, 2025 09:44

Jim8y and others added 6 commits September 22, 2025 20:54

Merge dev: update neo submodule to 8afce406; resolve conflicts in exa…

3e74910

…mples/Directory.Build.props and RpcStore; apply IsNullOrWhiteSpace in DeploymentArtifactsDemo

feat(deploy): add configurable toolkit with compilation and manifest …

18daa75

…support

chore: switch mainnet rpc default to coz endpoint

1dfe05d

Merge branch 'dev' into pr1-core-deployment-framework

8d46f2e

Merge remote-tracking branch 'origin/dev' into pr1-core-deployment-fr…

24239c5

…amework

Refine deployment toolkit RPC handling

0ae7817

Jim8y changed the title ~~feat: add core Neo smart contract deployment framework~~ feat: core deployment toolkit with tested RPC integration Oct 24, 2025

Merge branch 'dev' into pr1-core-deployment-framework

922ae56

shargon requested a review from ajara87 October 27, 2025 20:50

Merge branch 'dev' into pr1-core-deployment-framework

fe30520

shargon reviewed Oct 28, 2025

View reviewed changes

Jim8y added 4 commits November 5, 2025 20:36

Merge branch 'dev' into pr1-core-deployment-framework

de11b80

Throttle network magic retries and expand coverage

2440213

Extend deployment request/options APIs and docs

31783e0

- README: document new signer hooks and standardise init param example - DeploymentArtifactsRequest.cs: add signer + custom transaction signer hooks - DeploymentOptions.cs: add signer provider, transaction signer plumbing

Merge branch 'dev' into pr1-core-deployment-framework

db44f0a

feat: core deployment toolkit with tested RPC integration #1351

Are you sure you want to change the base?

feat: core deployment toolkit with tested RPC integration #1351

Conversation

Jim8y commented Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Highlights

Example Usage

Testing

Follow-ups

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vncoelho left a comment

Choose a reason for hiding this comment

Uh oh!

Jim8y commented Jul 9, 2025

Latest Deployment (TestNet)

Uh oh!

vncoelho commented Jul 9, 2025

Uh oh!

vncoelho commented Jul 9, 2025

Uh oh!

Jim8y commented Jul 9, 2025

Uh oh!

Jim8y commented Jul 11, 2025

Uh oh!

Uh oh!

shargon Jul 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shargon commented Sep 12, 2025

Uh oh!

shargon Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Jim8y commented Nov 8, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Jim8y commented Jul 9, 2025 •

edited

Loading