Class Compiler

constructor

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

• Initializes a new instance of the Compiler class.

  Parameters

  • $host: string

    server parameter

  • Optional options: CompilerOptionalParams

    The parameter options

  Returns Compiler

$host

api

• api(options?): Promise<ApiResponse>

• Get the Api description

  Parameters

  • Optional options: ApiOptionalParams

    The options parameters.

  Returns Promise<ApiResponse>

apiVersion

• apiVersion(options?): Promise<ApiVersion>

• Get the version of the API

  Parameters

  • Optional options: ApiVersionOptionalParams

    The options parameters.

  Returns Promise<ApiVersion>

compileContract

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

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

  Parameters

  • body: Contract

    contract code

  • Optional options: CompileContractOptionalParams

    The options parameters.

  Returns Promise<CompileResult>

decodeCallResult

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

• Decode the result of contract call

  Parameters

  • body: SophiaCallResultInput

    Binary data in Sophia ABI format

  • Optional options: DecodeCallResultOptionalParams

    The options parameters.

  Returns Promise<DecodeCallResultResponse>

decodeCallResultBytecode

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

• Decode the result of contract call from Bytecode

  Parameters

  • body: BytecodeCallResultInput

    Call result + compiled contract

  • Optional options: DecodeCallResultBytecodeOptionalParams

    The options parameters.

  Returns Promise<DecodedCallresult>

decodeCalldataBytecode

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

• Identify function name and arguments in Calldata for a compiled contract

  Parameters

  • body: DecodeCalldataBytecode

    Calldata + compiled contract

  • Optional options: DecodeCalldataBytecodeOptionalParams

    The options parameters.

  Returns Promise<DecodedCalldata>

decodeCalldataSource

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

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

  Parameters

  • body: DecodeCalldataSource

    Calldata + contract (stub) code

  • Optional options: DecodeCalldataSourceOptionalParams

    The options parameters.

  Returns Promise<DecodedCalldata>

encodeCalldata

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

• Encode Sophia function call according to sophia ABI.

  Parameters

  • body: FunctionCallInput

    Sophia function call - contract code + function name + arguments

  • Optional options: EncodeCalldataOptionalParams

    The options parameters.

  Returns Promise<Calldata>

generateACI

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

• Generate an Aeternity Contract Interface (ACI) for contract

  Parameters

  • body: Contract

    contract code

  • Optional options: GenerateACIOptionalParams

    The options parameters.

  Returns Promise<GenerateACIResponse>

getCompilerVersion

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

• Extract compiler version from bytecode

  Parameters

  • body: ByteCodeInput

    contract byte array

  • Optional options: GetCompilerVersionOptionalParams

    The options parameters.

  Returns Promise<CompilerVersion>

getFateAssemblerCode

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

• Get FATE assembler code from bytecode

  Parameters

  • body: ByteCodeInput

    contract byte array

  • Optional options: GetFateAssemblerCodeOptionalParams

    The options parameters.

  Returns Promise<FateAssembler>

validateByteCode

• validateByteCode(body, options?): 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

  • Optional options: ValidateByteCodeOptionalParams

    The options parameters.

  Returns Promise<void>

version

• version(options?): Promise<CompilerVersion>

• Get the version of the underlying Sophia compiler version

  Parameters

  • Optional options: VersionOptionalParams

    The options parameters.

  Returns Promise<CompilerVersion>