nethereum-codegen

v2.0.3

Code generator of Nethereum and Ethereum integration classes and projects For more information about how to use this package see README

Latest version published 5 months ago

License: MIT

NPM

GitHub

Package Health Score

72 / 100

security
No known security issues
popularity
Small
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
2.0.3	\|	08/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.29	\|	06/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (191)

GitHub Stars: 2.18K
Forks: 729
Contributors: -

Direct Usage Popularity

The npm package nethereum-codegen receives a total of 191 downloads a week. As such, we scored nethereum-codegen popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package nethereum-codegen, we found that it has been starred 2,179 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 0
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like nethereum-codegen is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 104
Open PR: 3
Last Release: 5 months ago
Last Commit: 1 month ago

Further analysis of the maintenance status of nethereum-codegen based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that nethereum-codegen demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 7 years
Dependencies: 1 Direct
Versions: 32
Install Size: 1.89 MB
Dist-tags: 1
# of Files: 16
Maintainers: 1
TS Typings: No

nethereum-codegen has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

nethereum-codegen

The Nethereum code generator provides a simple way to generate the different messages and DTOs classes to integrate with Ethereum smart contracts using Nethereum.

Nethereum Code Generation

The nethereum code generator provides different ways to to generate code to interact with smart contracts using Nethereum, including standard class libraries, Unity requests, MUD tables, and services.

Installation

To install the module, use npm or yarn:

npm install nethereum-codegen

yarn add nethereum-codegen

Usage

Basic Example

var codegen = require('nethereum-codegen');

var contractByteCode = "0x00";
var abierc20 = '[{"inputs":[],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[],"name":"ECDSAInvalidSignature","type":"error"},...]';  // truncated for brevity
var abi = abierc20;
var contractName = "ERC20";
var baseNamespace = "Nethereum.Unity.Contracts.Standards";
var basePath = "codeGenNodeTest";

var mudTables = '{"tables":{"Counter":{"schema":{"value":"uint32"},"key":[]},"Item":{"schema":{"id":"uint32","price":"uint32","name":"string","description":"string","owner":"string"},"key":["id"]}}}';

var projectName = "MyProject";

// Generating a .NET Standard class library
codegen.generateNetStandardClassLibrary(projectName, basePath, 0);

// Generating all classes
codegen.generateAllClasses(abi, contractByteCode, contractName, baseNamespace, basePath, 0);

// Generating Unity requests
codegen.generateUnityRequests(abi, contractByteCode, contractName, baseNamespace, basePath);

// Generating MUD tables
codegen.generateMudTables(mudTables, baseNamespace, "Tables", basePath, 0, "");

// Generating MUD service
codegen.generateMudService(abi, contractByteCode, contractName, baseNamespace, basePath, 0, "");

Generating Files from Configuration File

You can generate files using a JSON configuration file or string:

Using a JSON Configuration String

var jsonGeneratorSetsExample1 = 
`[
    {
        "paths": ["out/ERC20.sol/Standard_Token.json"],
        "generatorConfigs": [
            {
                "baseNamespace": "MyProject.Contracts",
                "basePath": "codeGenNodeTest/GeneratorSets/Example1/MyProject.Contracts",
                "codeGenLang": 0,
                "generatorType": "ContractDefinition"
            },
            {
                "baseNamespace": "MyProject.Contracts",
                "basePath": "codeGenNodeTest/GeneratorSets/Example1/MyProject.Contracts",
                "codeGenLang": 0,
                "generatorType": "UnityRequest"
            }
        ]
    },
    {
        "paths": ["out/IncrementSystem.sol/IncrementSystem.json"],
        "generatorConfigs": [
            {
                "baseNamespace": "MyProject.Contracts.MyWorld.Systems",
                "basePath": "codeGenNodeTest/GeneratorSets/Example1/MyProject.Contracts.MyWorld.Systems",
                "codeGenLang": 0,
                "generatorType": "ContractDefinition"
            },
            {
                "baseNamespace": "MyProject.Contracts.MyWorld.Systems",
                "basePath": "codeGenNodeTest/GeneratorSets/Example1/MyProject.Contracts.MyWorld.Systems",
                "codeGenLang": 0,
                "generatorType": "MudExtendedService",
                "mudNamespace": "MyWorld"
            }
        ]
    },
    {
        "paths": ["mudSingleNamespace/mud.config.ts"],
        "generatorConfigs": [
            {
                "baseNamespace": "MyProject.Contracts.MyWorld.Tables",
                "basePath": "codeGenNodeTest/GeneratorSets/Example1/MyProject.Contracts.MyWorld.Tables",
                "generatorType": "MudTables",
                "mudNamespace": "MyWorld"
            }
        ]
    }
]`;

codegen.generateFilesFromConfigJsonString(jsonGeneratorSetsExample1, "examples/testAbi");

Using a JSON Configuration File

codegen.generateFilesFromConfigJsonFile("path/to/config.json", "examples/testAbi");

Configuration Examples

JSON Configuration Example 1

[
    {
        "paths": ["out/ERC20.sol/Standard_Token.json"],
        "generatorConfigs": [
            {
                "baseNamespace": "MyProject.Contracts",
                "basePath": "codeGenNodeTest/GeneratorSets/Example1/MyProject.Contracts",
                "codeGenLang": 0,
                "generatorType": "ContractDefinition"
            },
            {
                "baseNamespace": "MyProject.Contracts",
                "basePath": "codeGenNodeTest/GeneratorSets/Example1/MyProject.Contracts",
                "codeGenLang": 0,
                "generatorType": "UnityRequest"
            }
        ]
    },
    {
        "paths": ["out/IncrementSystem.sol/IncrementSystem.json"],
        "generatorConfigs": [
            {
                "baseNamespace": "MyProject.Contracts.MyWorld.Systems",
                "basePath": "codeGenNodeTest/GeneratorSets/Example1/MyProject.Contracts.MyWorld.Systems",
                "codeGenLang": 0,
                "generatorType": "ContractDefinition"
            },
            {
                "baseNamespace": "MyProject.Contracts.MyWorld.Systems",
                "basePath": "codeGenNodeTest/GeneratorSets/Example1/MyProject.Contracts.MyWorld.Systems",
                "codeGenLang": 0,
                "generatorType": "MudExtendedService",
                "mudNamespace": "MyWorld"
            }
        ]
    },
    {
        "paths": ["mudSingleNamespace/mud.config.ts"],
        "generatorConfigs": [
            {
                "baseNamespace": "MyProject.Contracts.MyWorld.Tables",
                "basePath": "codeGenNodeTest/GeneratorSets/Example1/MyProject.Contracts.MyWorld.Tables",
                "generatorType": "MudTables",
                "mudNamespace": "MyWorld"
            }
        ]
    }
]

JSON Configuration Example 2

[
    {
        "paths": ["out/ERC20.sol/Standard_Token.json"],
        "generatorConfigs": [
            {
                "baseNamespace": "MyProject.Contracts",
                "basePath": "codeGenNodeTest/GeneratorSets/Example2/MyProject.Contracts",
                "codeGenLang": 0,
                "generatorType": "ContractDefinition"
            },
            {
                "baseNamespace": "MyProject.Contracts",
                "basePath": "codeGenNodeTest/GeneratorSets/Example2/MyProject.Contracts",
                "codeGenLang": 0,
                "generatorType": "UnityRequest"
            }
        ]
    },
    {
        "paths": ["out/IncrementSystem.sol/IncrementSystem.json"],
        "generatorConfigs": [
            {
                "baseNamespace": "MyProject.Contracts.MyWorld1.Systems",
                "basePath": "codeGenNodeTest/GeneratorSets/Example2/MyProject.Contracts.MyWorld1.Systems",
                "codeGenLang": 0,
                "generatorType": "ContractDefinition"
            },
            {
                "baseNamespace": "MyProject.Contracts.MyWorld1.Systems",
                "basePath": "codeGenNodeTest/GeneratorSets/Example2/MyProject.Contracts.MyWorld1.Systems",
                "codeGenLang": 0,
                "generatorType": "MudExtendedService",
                "mudNamespace": "myworld1"
            }
        ]
    },
    {
        "paths": ["mudMultipleNamespace/mud.config.ts"],
        "generatorConfigs": [
            {
                "baseNamespace": "MyProject.Contracts.MyWorld1.Tables",
                "basePath": "codeGenNodeTest/GeneratorSets/Example2/MyProject.Contracts.MyWorld1.Tables",
                "generatorType": "MudTables",
                "mudNamespace": "myworld1"
            }
        ]
    },
    {
        "paths": ["mudMultipleNamespace/mud.config.ts"],
        "generatorConfigs": [
            {
                "baseNamespace": "MyProject.Contracts.MyWorld2.Tables",
                "basePath": "codeGenNodeTest/GeneratorSets/Example2/MyProject.Contracts.MyWorld2.Tables",
                "generatorType": "MudTables",
                "mudNamespace": "myworld2"
            }
        ]
    }
]

API

generateNetStandardClassLibrary

Generates a .NET Standard class library.

Parameters

projectName (string): The name of the project.
basePath (string): The base path where the project will be generated.
codeLang (number): The programming language (0 for C#, 1 for VB, 3 for F#).

Example

codegen.generateNetStandardClassLibrary("MyProject", "codeGenNodeTest", 0);

generateAllClasses

Generates all classes for a smart contract.

Parameters

abi (string): The ABI of the contract.
byteCode (string): The bytecode of the contract.
contractName (string): The name of the contract.
baseNamespace (string): The base namespace for the generated code.
basePath (string): The base path where the code will be generated.
codeGenLang (number): The programming language (0 for C#, 1 for VB, 3 for F#).

Example

codegen.generateAllClasses(abi, contractByteCode, "ERC20", "Nethereum.Unity.Contracts.Standards", "codeGenNodeTest", 0);

generateMudService

Generates a MUD service for a smart contract.

Parameters

abi (string): The ABI of the contract.
byteCode (string): The bytecode of the contract.
contractName (string): The name of the contract.
baseNamespace (string): The base namespace for the generated code.
basePath (string): The base path where the code will be generated.
codeGenLang (number): The programming language (0 for C#, 1 for VB, 3 for F#).
mudNamespace (string): The MUD namespace.

Example

codegen.generateMudService(abi, contractByteCode, "ERC20", "Nethereum.Unity.Contracts.Standards", "codeGenNodeTest", 0, "");

generateMudTables

Generates MUD tables from a JSON configuration.

Parameters

json (string): The JSON configuration for the tables.
baseNamespace (string): The base namespace for the generated code.
namespace (string): The namespace for the tables.
basePath (string): The base path where the code will be generated.
codeGenLang (number): The programming language (0 for C#, 1 for VB, 3 for F#).
mudNamespace (string): The MUD namespace.

Example

var mudTables = '{"tables":{"Counter":{"schema":{"value":"uint32"},"key":[]},"Item":{"schema":{"id":"uint32","price":"uint32","name":"string","description":"string","owner":"string"},"key":["id"]}}}';
codegen.generateMudTables(mudTables, "Nethereum.Unity.Contracts.Standards", "Tables", "codeGenNodeTest", 0, "");

generateUnityRequests

Generates Unity requests for a smart contract.

Parameters

abi (string): The ABI of the contract.
byteCode (string): The bytecode of the contract.
contractName (string): The name of the contract.
baseNamespace (string): The base namespace for the generated code.
basePath (string): The base path where the code will be generated.

Example

codegen.generateUnityRequests(abi, contractByteCode, "ERC20", "Nethereum.Unity.Contracts.Standards", "codeGenNodeTest");

generateFilesFromConfigJsonString

Generates files from a JSON configuration string.

Parameters

configJson (string): The JSON configuration string.
rootPath (string): The root path for the configurations.

Example

var jsonConfig = '[...]';  // your JSON configuration
codegen.generateFilesFromConfigJsonString(jsonConfig, "examples/testAbi");

GeneratorType Enum

Enum for specifying the generator type.

export enum GeneratorType {
    ContractDefinition = "ContractDefinition",
    UnityRequest = "UnityRequest",
    MudExtendedService = "MudExtendedService",
    MudTables = "MudTables",
    NetStandardLibrary = "NetStandardLibrary"
}

GeneratorConfig Interface

Interface for a generator configuration.

export interface GeneratorConfig {
    baseNamespace: string;
    codeGenLang: number;
    basePath: string;
    generatorType: GeneratorType;
    mudNamespace: string;
}

GeneratorSetConfig Interface

Interface for a generator set configuration.

export interface GeneratorSetConfig {
    paths: string[];
    default: boolean;
    generatorConfigs: GeneratorConfig[];
}

nethereum-codegen dependencies

fs-extra

nethereum-codegen development dependencies

@types/fs-extra @types/node

FAQs

What is nethereum-codegen?

Code generator of Nethereum and Ethereum integration classes and projects . Visit Snyk Advisor to see a full health score report for nethereum-codegen, including popularity, security, maintenance & community analysis.

Is nethereum-codegen popular?

The npm package nethereum-codegen receives a total of 191 weekly downloads. As such, nethereum-codegen popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is nethereum-codegen well maintained?

We found indications that nethereum-codegen maintenance is sustainable demonstrating some project activity. We saw a total of 0 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is nethereum-codegen safe to use?

The npm package nethereum-codegen was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 28 November-2024, at 21:13 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (191)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

nethereum-codegen

Nethereum Code Generation

Table of Contents

Installation

Usage

Basic Example

Generating Files from Configuration File

Using a JSON Configuration String

Using a JSON Configuration File

Configuration Examples

JSON Configuration Example 1

JSON Configuration Example 2

API

generateNetStandardClassLibrary

Parameters

Example

generateAllClasses

Parameters

Example

generateMudService

Parameters

Example

generateMudTables

Parameters

Example

generateUnityRequests

Parameters

Example

generateFilesFromConfigJsonString

Parameters

Example

GeneratorType Enum

GeneratorConfig Interface

GeneratorSetConfig Interface

nethereum-codegen dependencies

nethereum-codegen development dependencies

FAQs

What is nethereum-codegen?

Is nethereum-codegen popular?

Is nethereum-codegen well maintained?

Is nethereum-codegen safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues