Class Compiler

constructor

• new Compiler($host: string, options?: CompilerOptionalParams): Compiler

  Initializes a new instance of the Compiler class.

  Parameters

  • $host: string

    server parameter
  • Optionaloptions: CompilerOptionalParams

    The parameter options

  Returns Compiler

Readonly$host

api

• api(options?: ApiOptionalParams): Promise<ApiResponse>

  Get the Api description

  Parameters

  • Optionaloptions: ApiOptionalParams

    The options parameters.

  Returns Promise<ApiResponse>

apiVersion

• apiVersion(options?: ApiVersionOptionalParams): Promise<ApiVersion>

  Get the version of the API

  Parameters

  • Optionaloptions: ApiVersionOptionalParams

    The options parameters.

  Returns Promise<ApiVersion>

compileContract

• compileContract(
      body: Contract,
      options?: CompileContractOptionalParams,
  ): Promise<CompileResult>

  Compile a sophia contract from source and return byte code and ACI

  Parameters

  • body: Contract

    contract code
  • Optionaloptions: CompileContractOptionalParams

    The options parameters.

  Returns Promise<CompileResult>

decodeCalldataBytecode

• decodeCalldataBytecode(
      body: DecodeCalldataBytecode,
      options?: DecodeCalldataBytecodeOptionalParams,
  ): Promise<DecodedCalldata>

  Identify function name and arguments in Calldata for a compiled contract

  Parameters

  • body: DecodeCalldataBytecode

    Calldata + compiled contract
  • Optionaloptions: DecodeCalldataBytecodeOptionalParams

    The options parameters.

  Returns Promise<DecodedCalldata>

decodeCalldataSource

• decodeCalldataSource(
      body: DecodeCalldataSource,
      options?: DecodeCalldataSourceOptionalParams,
  ): Promise<DecodedCalldata>

  Identify function name and arguments in Calldata for a (partial) contract

  Parameters

  • body: DecodeCalldataSource

    Calldata + contract (stub) code
  • Optionaloptions: DecodeCalldataSourceOptionalParams

    The options parameters.

  Returns Promise<DecodedCalldata>

decodeCallResult

• decodeCallResult(
      body: SophiaCallResultInput,
      options?: DecodeCallResultOptionalParams,
  ): Promise<DecodeCallResultResponse>

  Decode the result of contract call

  Parameters

  • body: SophiaCallResultInput

    Binary data in Sophia ABI format
  • Optionaloptions: DecodeCallResultOptionalParams

    The options parameters.

  Returns Promise<DecodeCallResultResponse>

decodeCallResultBytecode

• decodeCallResultBytecode(
      body: BytecodeCallResultInput,
      options?: DecodeCallResultBytecodeOptionalParams,
  ): Promise<DecodedCallresult>

  Decode the result of contract call from Bytecode

  Parameters

  • body: BytecodeCallResultInput

    Call result + compiled contract
  • Optionaloptions: DecodeCallResultBytecodeOptionalParams

    The options parameters.

  Returns Promise<DecodedCallresult>

encodeCalldata

• encodeCalldata(
      body: FunctionCallInput,
      options?: EncodeCalldataOptionalParams,
  ): Promise<Calldata>

  Encode Sophia function call according to sophia ABI.

  Parameters

  • body: FunctionCallInput

    Sophia function call - contract code + function name + arguments
  • Optionaloptions: EncodeCalldataOptionalParams

    The options parameters.

  Returns Promise<Calldata>

generateACI

• generateACI(
      body: Contract,
      options?: GenerateACIOptionalParams,
  ): Promise<GenerateACIResponse>

  Generate an Aeternity Contract Interface (ACI) for contract

  Parameters

  • body: Contract

    contract code
  • Optionaloptions: GenerateACIOptionalParams

    The options parameters.

  Returns Promise<GenerateACIResponse>

getCompilerVersion

• getCompilerVersion(
      body: ByteCodeInput,
      options?: GetCompilerVersionOptionalParams,
  ): Promise<CompilerVersion>

  Extract compiler version from bytecode

  Parameters

  • body: ByteCodeInput

    contract byte array
  • Optionaloptions: GetCompilerVersionOptionalParams

    The options parameters.

  Returns Promise<CompilerVersion>

getFateAssemblerCode

• getFateAssemblerCode(
      body: ByteCodeInput,
      options?: GetFateAssemblerCodeOptionalParams,
  ): Promise<FateAssembler>

  Get FATE assembler code from bytecode

  Parameters

  • body: ByteCodeInput

    contract byte array
  • Optionaloptions: GetFateAssemblerCodeOptionalParams

    The options parameters.

  Returns Promise<FateAssembler>

validateByteCode

• validateByteCode(
      body: ValidateByteCodeInput,
      options?: ValidateByteCodeOptionalParams,
  ): Promise<void>

  Verify that an encoded byte array is the result of compiling a given contract

  Parameters

  • body: ValidateByteCodeInput

    contract byte array and source code
  • Optionaloptions: ValidateByteCodeOptionalParams

    The options parameters.

  Returns Promise<void>

version

• version(options?: VersionOptionalParams): Promise<CompilerVersion>

  Get the version of the underlying Sophia compiler version

  Parameters

  • Optionaloptions: VersionOptionalParams

    The options parameters.

  Returns Promise<CompilerVersion>