Class CompilerBaseAbstract

A base class for all compiler implementations

Hierarchy

Constructors

constructor

Methods

compile compileBySourceCode generateAci generateAciBySourceCode validate validateBySourceCode version

Constructors

constructor

Methods

Abstract compile

  • Compile contract by contract's path Available only in Node.js

    Parameters

    • path: string

      Path to contract source code

    Returns Promise<{
        aci: Aci;
        bytecode: `cb_${string}`;
    }>

    ACI and bytecode

Abstract compileBySourceCode

  • Compile contract by contract's source code

    Parameters

    • sourceCode: string

      Contract source code as string

    • Optional fileSystem: Record<string, string>

      A map of contract filename to the corresponding contract source code to include into the main contract

    Returns Promise<{
        aci: Aci;
        bytecode: `cb_${string}`;
    }>

    ACI and bytecode

    Example

    {
      'library.aes': 'namespace TestLib =\n  function sum(x: int, y: int) : int = x + y'
    }

Abstract generateAci

  • Generate contract's ACI by contract's path Available only in Node.js

    Parameters

    • path: string

      Path to contract source code

    Returns Promise<Aci>

    ACI

Abstract generateAciBySourceCode

  • Generate contract's ACI by contract's source code

    Parameters

    • sourceCode: string

      Contract source code as string

    • Optional fileSystem: Record<string, string>

      A map of contract filename to the corresponding contract source code to include into the main contract

    Returns Promise<Aci>

    ACI

    Example

    {
      'library.aes': 'namespace TestLib =\n  function sum(x: int, y: int) : int = x + y'
    }

Abstract validate

  • Verify that a contract bytecode is the result of compiling the given source code Available only in Node.js

    Parameters

    • bytecode: `cb_${string}`

      Contract bytecode to verify

    • path: string

      Path to contract source code

    Returns Promise<boolean>

    ACI and bytecode

Abstract validateBySourceCode

  • Verify that a contract bytecode is the result of compiling the given source code

    Parameters

    • bytecode: `cb_${string}`

      Contract bytecode to verify

    • sourceCode: string

      Contract source code as string

    • Optional fileSystem: Record<string, string>

      A map of contract filename to the corresponding contract source code to include into the main contract

    Returns Promise<boolean>

    Example

    {
      'library.aes': 'namespace TestLib =\n  function sum(x: int, y: int) : int = x + y'
    }

Abstract version

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc