@truffle/contract-schema
    TypeScript icon, indicating that this package has built-in type declarations

    3.4.2 • Public • Published

    Schema Description: Truffle Contract Object

    type object
    JSON Schema contract-object.spec.json

    @truffle/contract uses a formally specified1 JSON object format to represent Ethereum Virtual Machine (EVM) smart contracts. This representation is intended to facilitate the use of general purpose smart contract abstractions (such as @truffle/contract) by capturing relevant smart contract information in a persistent and portable manner.

    Objects following this schema represent individual smart contracts as defined by their name and interface. Each object primarily includes a JSON array representing the contract's ABI2, but extends to include any and all information related to the contract and its lifecycle(s). Objects in this schema may represent pre-compiled source code, compilation annotations such as source mappings, references to specified deployed instances on multiple networks, and/or links to external contracts.

    A full property listing is below. Properties not marked "required" are not necessary to include in valid descriptions of contract objects, but functionally certain information must be present to allow the contract object representation to be useful (source/bytecode/etc. enable the deployment of new instances, networks listed with prior contract instance addresses enable interaction with deployed contracts on-chain)

    References

    1. JSON Schema http://json-schema.org

    2. Ethereum Contract JSON ABI https://github.com/ethereum/wiki/wiki/Ethereum-Contract-ABI#json

    Properties

    contractName

    type string matching pattern ^[a-zA-Z_][a-zA-Z0-9_]*$
    default "Contract"

    Name used to identify the contract. Semi-alphanumeric string.

    abi

    type array
    JSON Schema abi.spec.json
    required

    External programmatic description of contract's interface. The contract's ABI determines the means by which applications may interact with individual contract instances. Array of functions and events representing valid inputs and outputs for the instance.

    metadata

    type string

    Contract metadata. Stringified JSON.

    bytecode

    type string matching pattern ^0x0$|^0x([a-fA-F0-9]{2}|__.{38})+$
    ref Bytecode

    EVM instruction bytecode that runs as part of contract create transaction. Constructor code for new contract instance. Specified as a hexadecimal string, may include __-prefixed (double underscore) link references.

    deployedBytecode

    type string matching pattern ^0x0$|^0x([a-fA-F0-9]{2}|__.{38})+$
    ref Bytecode

    EVM instruction bytecode associated with contract that specifies behavior for incoming transactions/messages. Underlying implementation of ABI. Specified as a hexadecimal string, may include __-prefixed (double underscore) link references.

    sourceMap

    type string matching pattern ^[0-9;]*

    Source mapping for bytecode, pairing contract creation transaction data bytes with origin statements in uncompiled source.

    deployedSourceMap

    type string matching pattern ^[0-9;]*

    Source mapping for deployedBytecode, pairing contract program data bytes with origin statements in uncompiled source.

    source

    type string

    Uncompiled source code for contract. Text string.

    sourcePath

    type string

    File path for uncompiled source code.

    ast

    type object

    format not included in current version of this specification

    Abstract Syntax Tree. A nested JSON object representation of contract source code, as output by compiler.

    legacyAST

    type object

    format not included in current version of this specification

    Legacy Abstract Syntax Tree. A nested JSON object representation of contract source code, as output by compiler.

    compiler

    type object

    Compiler information.

    name

    type string

    Name of the compiler used.

    version

    type string

    Version of the compiler used.

    networks

    type object

    Listing of contract instances. Object mapping network ID keys to network object values. Includes address information, links to other contract instances, and/or contract event logs.

    Properties (key matching ^[a-zA-Z0-9]+$)

    type object
    ref Network Object

    schemaVersion

    type string matching pattern [0-9]+\.[0-9]+\.[0-9]+

    Version of this schema used by contract object representation.

    updatedAt

    type string
    format IS0-8601 Datetime

    Time at which contract object representation was generated/most recently updated.

    networkType

    type string
    default "ethereum"

    Specific blockchain network type targeted.

    devdoc

    type string

    NatSpec developer documentation of the contract.

    userdoc

    type string

    NatSpec user documentation of the contract.

    Custom Properties

    ^x-([a-zA-Z]+-)*[a-zA-Z]+

    type string or number or object or array

    Objects following this schema may include additional properties with x--prefixed keys.

    Definitions

    Bytecode

    type string matching pattern ^0x0$|^0x([a-fA-F0-9]{2}|__.{38})+$

    0x-prefixed string representing compiled EVM machine language.

    This string representation may indicate link references in place of linked instance addresses. Link references must begin with __ and be exactly 40 characters long (i.e., string length of an address in hexadecimal).

    Install

    npm i @truffle/contract-schema

    DownloadsWeekly Downloads

    22,816

    Version

    3.4.2

    License

    MIT

    Unpacked Size

    277 kB

    Total Files

    21

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar