Class Compiler

Contract Compiler

This class include api call's related to contract compiler functionality.

Example

Compiler('COMPILER_URL')

Hierarchy

<internal>.Compiler
- Compiler

Index

Constructors

constructor

new Compiler(compilerUrl: string, options?: { ignoreVersion?: boolean }): Compiler
Parameters
- compilerUrl: string
  
  Url for compiler API
- options: { ignoreVersion?: boolean } = {}
  
  Options
  - Optional ignoreVersion?: boolean
    
    Don't check compiler version
Returns Compiler
Overrides Compiler.constructor
- Defined in contract/Compiler.ts:38

Properties

$host

$host: string

Methods

aPIVersion

aPIVersion(options?: APIVersionOptionalParams): Promise<APIVersion>
Get the version of the API
Parameters
- Optional options: APIVersionOptionalParams
  
  The options parameters.
Returns Promise<APIVersion>
Inherited from Compiler.aPIVersion
- Defined in apis/compiler/compiler.ts:135

api

api(options?: ApiOptionalParams): Promise<ApiResponse>
Get the Api description
Parameters
- Optional options: ApiOptionalParams
  
  The options parameters.
Returns Promise<ApiResponse>
Inherited from Compiler.api
- Defined in apis/compiler/compiler.ts:127

compileContract

compileContract(body: <internal>.Contract, options?: CompileContractOptionalParams): Promise<<internal>.ByteCode>
Compile a sophia contract from source and return byte code
Parameters
- body: <internal>.Contract
  
  contract code
- Optional options: CompileContractOptionalParams
  
  The options parameters.
Returns Promise<<internal>.ByteCode>
Inherited from Compiler.compileContract
- Defined in apis/compiler/compiler.ts:144

decodeCallResult

decodeCallResult(body: SophiaCallResultInput, options?: DecodeCallResultOptionalParams): 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>
Inherited from Compiler.decodeCallResult
- Defined in apis/compiler/compiler.ts:174

decodeCallResultBytecode

decodeCallResultBytecode(body: BytecodeCallResultInput, options?: DecodeCallResultBytecodeOptionalParams): 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>
Inherited from Compiler.decodeCallResultBytecode
- Defined in apis/compiler/compiler.ts:189

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
- Optional options: DecodeCalldataBytecodeOptionalParams
  
  The options parameters.
Returns Promise<DecodedCalldata>
Inherited from Compiler.decodeCalldataBytecode
- Defined in apis/compiler/compiler.ts:204

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
- Optional options: DecodeCalldataSourceOptionalParams
  
  The options parameters.
Returns Promise<DecodedCalldata>
Inherited from Compiler.decodeCalldataSource
- Defined in apis/compiler/compiler.ts:219

decodeData

decodeData(body: SophiaBinaryData, options?: DecodeDataOptionalParams): Promise<SophiaJsonData>
Decode data as retuned by a contract call. - Legacy decoding
Parameters
- body: SophiaBinaryData
  
  Binary data in Sophia ABI format
- Optional options: DecodeDataOptionalParams
  
  The options parameters.
Returns Promise<SophiaJsonData>
Inherited from Compiler.decodeData
- Defined in apis/compiler/compiler.ts:234

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
- Optional options: EncodeCalldataOptionalParams
  
  The options parameters.
Returns Promise<Calldata>
Inherited from Compiler.encodeCalldata
- Defined in apis/compiler/compiler.ts:249

generateACI

generateACI(body: <internal>.Contract, options?: GenerateACIOptionalParams): Promise<<internal>.Aci>
Generate an Aeternity Contract Interface (ACI) for contract
Parameters
- body: <internal>.Contract
  
  contract code
- Optional options: GenerateACIOptionalParams
  
  The options parameters.
Returns Promise<<internal>.Aci>
Inherited from Compiler.generateACI
- Defined in apis/compiler/compiler.ts:113

getCompilerVersion

getCompilerVersion(body: ByteCodeInput, options?: GetCompilerVersionOptionalParams): Promise<CompilerVersion>
Extract compiler version from bytecode
Parameters
- body: ByteCodeInput
  
  contract byte array
- Optional options: GetCompilerVersionOptionalParams
  
  The options parameters.
Returns Promise<CompilerVersion>
Inherited from Compiler.getCompilerVersion
- Defined in apis/compiler/compiler.ts:159

getFateAssemblerCode

getFateAssemblerCode(body: ByteCodeInput, options?: GetFateAssemblerCodeOptionalParams): Promise<FateAssembler>
Get FATE assembler code from bytecode
Parameters
- body: ByteCodeInput
  
  contract byte array
- Optional options: GetFateAssemblerCodeOptionalParams
  
  The options parameters.
Returns Promise<FateAssembler>
Inherited from Compiler.getFateAssemblerCode
- Defined in apis/compiler/compiler.ts:264

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
- Optional options: ValidateByteCodeOptionalParams
  
  The options parameters.
Returns Promise<void>
Inherited from Compiler.validateByteCode
- Defined in apis/compiler/compiler.ts:279

version

version(options?: VersionOptionalParams): Promise<CompilerVersion>
Get the version of the underlying Sophia compiler version
Parameters
- Optional options: VersionOptionalParams
  
  The options parameters.
Returns Promise<CompilerVersion>
Inherited from Compiler.version
- Defined in apis/compiler/compiler.ts:293

Class Compiler

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

compilerUrl: string

options: { ignoreVersion?: boolean } = {}

Optional ignoreVersion?: boolean

Returns Compiler

Properties

$host

Methods

aPIVersion

Parameters

Optional options: APIVersionOptionalParams

Returns Promise<APIVersion>

api

Parameters

Optional options: ApiOptionalParams

Returns Promise<ApiResponse>

compileContract

Parameters

body: <internal>.Contract

Optional options: CompileContractOptionalParams

Returns Promise<<internal>.ByteCode>

decodeCallResult

Parameters

body: SophiaCallResultInput

Optional options: DecodeCallResultOptionalParams

Returns Promise<DecodeCallResultResponse>

decodeCallResultBytecode

Parameters

body: BytecodeCallResultInput

Optional options: DecodeCallResultBytecodeOptionalParams

Returns Promise<DecodedCallresult>

decodeCalldataBytecode

Parameters

body: DecodeCalldataBytecode

Optional options: DecodeCalldataBytecodeOptionalParams

Returns Promise<DecodedCalldata>

decodeCalldataSource

Parameters

body: DecodeCalldataSource

Optional options: DecodeCalldataSourceOptionalParams

Returns Promise<DecodedCalldata>

decodeData

Parameters

body: SophiaBinaryData

Optional options: DecodeDataOptionalParams

Returns Promise<SophiaJsonData>

encodeCalldata

Parameters

body: FunctionCallInput

Optional options: EncodeCalldataOptionalParams

Returns Promise<Calldata>

generateACI

Parameters

body: <internal>.Contract

Optional options: GenerateACIOptionalParams

Returns Promise<<internal>.Aci>

getCompilerVersion

Parameters

body: ByteCodeInput

Optional options: GetCompilerVersionOptionalParams

Returns Promise<CompilerVersion>

getFateAssemblerCode

Parameters

body: ByteCodeInput

Optional options: GetFateAssemblerCodeOptionalParams

Returns Promise<FateAssembler>

validateByteCode

Parameters

body: ValidateByteCodeInput

Optional options: ValidateByteCodeOptionalParams

Returns Promise<void>

`Optional` ignoreVersion?: boolean

`Optional` options: APIVersionOptionalParams

`Optional` options: ApiOptionalParams

`Optional` options: CompileContractOptionalParams

`Optional` options: DecodeCallResultOptionalParams

`Optional` options: DecodeCallResultBytecodeOptionalParams

`Optional` options: DecodeCalldataBytecodeOptionalParams

`Optional` options: DecodeCalldataSourceOptionalParams

`Optional` options: DecodeDataOptionalParams

`Optional` options: EncodeCalldataOptionalParams

`Optional` options: GenerateACIOptionalParams

`Optional` options: GetCompilerVersionOptionalParams

`Optional` options: GetFateAssemblerCodeOptionalParams

`Optional` options: ValidateByteCodeOptionalParams

`Optional` options: VersionOptionalParams