Class Compiler

Hierarchy

ServiceClient
- Compiler

Index

Constructors

Properties

Methods

api apiVersion compileContract decodeCallResult decodeCallResultBytecode decodeCalldataBytecode decodeCalldataSource encodeCalldata generateACI getCompilerVersion getFateAssemblerCode validateByteCode version

Constructors

constructor

new Compiler($host: string, options?: CompilerOptionalParams): Compiler
Initializes a new instance of the Compiler class.
Parameters
- $host: string
  
  server parameter
- Optional options: CompilerOptionalParams
  
  The parameter options
Returns Compiler
Overrides coreClient.ServiceClient.constructor
- Defined in apis/compiler/compiler.ts:49

Properties

$host

$host: string

Methods

api

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

apiVersion

apiVersion(options?: ApiVersionOptionalParams): Promise<ApiVersion>
Get the version of the API
Parameters
- Optional options: ApiVersionOptionalParams
  
  The options parameters.
Returns Promise<ApiVersion>
- Defined in apis/compiler/compiler.ts:243

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
- Optional options: CompileContractOptionalParams
  
  The options parameters.
Returns Promise<CompileResult>
- Defined in apis/compiler/compiler.ts:101

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>
- Defined in apis/compiler/compiler.ts:116

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>
- Defined in apis/compiler/compiler.ts:131

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>
- Defined in apis/compiler/compiler.ts:161

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>
- Defined in apis/compiler/compiler.ts:176

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>
- Defined in apis/compiler/compiler.ts:146

generateACI

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

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>
- Defined in apis/compiler/compiler.ts:221

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>
- Defined in apis/compiler/compiler.ts:191

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>
- Defined in apis/compiler/compiler.ts:206

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>
- Defined in apis/compiler/compiler.ts:235

Generated using TypeDoc