OpenParable
Skip to content
← Back to skills

Code Generation

Development
code-generation

Code Generation is an Agent Skill for development published in the Nethereum/Nethereum repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Generate typed C# contract services, DTOs, Unity requests, MUD tables, and Blazor pages from Solidity ABI using Nethereum code generation. Use this skill when the user asks about generating C# from Solidity, ABI code generation, Foundry/Forge integration, nethereum-gen.multisettings, contract service generation, Unity contract requests, MUD table generation, or Blazor contract pages.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/Nethereum/Nethereum/blob/HEAD/plugins/nethereum-skills/skills/code-generation/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/code-generation, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Nethereum Code Generation

Workflow: Solidity → Forge → C# Bindings

Solidity source → forge build → JSON artifacts (out/) → Nethereum Generator → C# services + DTOs

CLI Tool

dotnet tool install -g Nethereum.Generator.Console

Generate from ABI

Nethereum.Generator.Console generate from-abi \
  -abi ./MyContract.abi -bin ./MyContract.bin \
  -o ./Generated -ns MyProject.Contracts -cn MyContract

Generate from Forge Output (Primary Workflow)

forge build
Nethereum.Generator.Console generate from-config \
  -cfg .nethereum-gen.multisettings -r .

Or use the script:

.\scripts\generate-csharp-from-forge.ps1 -Build

Configuration File (.nethereum-gen.multisettings)

Multi-contract config with shared types and struct references:

[
  {
    "paths": ["out/EntryPoint.sol/EntryPoint.json"],
    "generatorConfigs": [
      {
        "baseNamespace": "MyProject.AccountAbstraction",
        "basePath": "../src/MyProject.AccountAbstraction",
        "codeGenLang": 0,
        "generatorType": "ContractDefinition",
        "referencedTypesNamespaces": ["MyProject.Structs"],
        "structReferencedTypes": ["PackedUserOperation"]
      }
    ]
  },
  {
    "paths": [
      "out/NethereumAccount.sol/NethereumAccount.json",
      "out/NethereumAccountFactory.sol/NethereumAccountFactory.json"
    ],
    "generatorConfigs": [
      {
        "baseNamespace": "MyProject.Contracts.Core",
        "basePath": "../src/MyProject/Contracts/Core",
        "codeGenLang": 0,
        "generatorType": "ContractDefinition",
        "referencedTypesNamespaces": ["MyProject.Structs"],
        "structReferencedTypes": ["PackedUserOperation"]
      }
    ]
  }
]

Config Options

FieldDescription
pathsForge JSON artifact paths
baseNamespaceC# namespace
basePathOutput directory
codeGenLang0=C#, 1=VB, 3=F#
generatorTypeContractDefinition, UnityRequest, MudTables, MudExtendedService, BlazorPageService, NetStandardLibrary
sharedTypesNamespaceNamespace for shared events/errors/structs
sharedTypes["events", "errors", "structs", "functions"]
referencedTypesNamespacesImport existing struct types instead of regenerating
structReferencedTypesSpecific struct names to import
mudNamespaceMUD world namespace

Generated Output

MyContract/
├── ContractDefinition/
│   └── MyContractDefinition.gen.cs    # Deployment + all DTOs
└── MyContractService.gen.cs           # Service with typed methods

Generated Service (partial — extend without modifying .gen.cs)

var service = await MyContractService.DeployContractAndGetServiceAsync(web3, deployment);

// Query (two overloads: raw params or typed message)
var balance = await service.BalanceOfQueryAsync(ownerAddress);
var balance = await service.BalanceOfQueryAsync(
    new BalanceOfFunction { Owner = ownerAddress }, blockParameter);

// Transact
var receipt = await service.TransferRequestAndWaitForReceiptAsync(
    new TransferFunction { To = recipient, Value = amount });

// Events
var events = await service.GetTransferEvent()
    .CreateFilterInput(fromBlock, toBlock)
    .GetAllChangesAsync();

Generator Types

TypeOutputUse Case
ContractDefinitionService + all DTOsStandard .NET
UnityRequestCoroutine-based requestsUnity engine
MudTablesTable schemas from mud.config.tsMUD World
MudExtendedServiceExtended MUD serviceMUD systems
BlazorPageServiceRazor componentBlazor apps
NetStandardLibraryComplete .csprojStandalone packages

Multiple types per contract:

{
  "paths": ["out/ERC20.sol/Standard_Token.json"],
  "generatorConfigs": [
    { "generatorType": "ContractDefinition", ... },
    { "generatorType": "UnityRequest", ... },
    { "generatorType": "BlazorPageService", ... }
  ]
}

Shared Types

For shared events/errors/structs across contracts:

{
  "sharedTypesNamespace": "MyProject.SharedTypes",
  "sharedTypes": ["events", "errors", "structs"]
}

For referencing existing structs from another project:

{
  "referencedTypesNamespaces": ["MyProject.AccountAbstraction.Structs"],
  "structReferencedTypes": ["PackedUserOperation"]
}

MUD Generation

Tables from mud.config.ts:

{ "generatorType": "MudTables", "mudNamespace": "MyWorld" }

Systems (both definition + extended service):

[
  { "generatorType": "ContractDefinition", "mudNamespace": "MyWorld" },
  { "generatorType": "MudExtendedService", "mudNamespace": "MyWorld" }
]

Node.js API

npm install nethereum-codegen
var codegen = require('nethereum-codegen');
codegen.generateAllClasses(abi, bytecode, "ERC20", "MyProject", "SharedTypes", ["events"], "./out", 0);
codegen.generateFilesFromConfigJsonFile("./config.json", "./contracts");
codegen.generateUnityRequests(abi, bytecode, "ERC20", "MyProject", "SharedTypes", ["events"], "./out");
codegen.generateMudTables(mudJson, "MyProject.Tables", "Tables", "./out", 0, "MyWorld");
codegen.generateBlazorPageService(abi, "ERC20", "MyProject", "./out", "SharedTypes", 0);

MSBuild Integration

dotnet add package Nethereum.Autogen.ContractApi

Place .abi + .bin in project → code generated on dotnet build.

Key Rules

  • Generated files use .gen.cs suffix — never edit them manually
  • All classes are partial — extend in separate files
  • Use referencedTypesNamespaces when structs are shared across contracts
  • Use sharedTypes when events/errors repeat across contracts in the same generation run
  • The config file is the source of truth for how Solidity maps to C# namespaces
  • VS Code Solidity extension handles compilation + generation in one step for single contracts