Class CompilerHttpNode

Contract Compiler over HTTP for Nodejs

Inherits CompilerHttp and implements compile, validate methods

Example

CompilerHttpNode('COMPILER_URL')

Hierarchy

CompilerHttp
- CompilerHttpNode

Index

Constructors

constructor

new CompilerHttpNode(compilerUrl: string, options?: {
ignoreVersion?: boolean;
}): CompilerHttpNode
Parameters
- compilerUrl: string
  
  Url for compiler API
- options: {
  ignoreVersion?: boolean;
  } = {}
  
  Options
  - Optional ignoreVersion?: boolean
    
    Don't check compiler version
Returns CompilerHttpNode
Inherited from CompilerHttp.constructor
- Defined in contract/compiler/Http.ts:32

Properties

`Readonly` api

api: Compiler

Methods

compile

compile(path: string): Promise<{
aci: Aci;
bytecode: `cb_${string}`;
}>
Compile contract by contract's path Available only in Node.js

Returns
ACI and bytecode
Parameters
- path: string
  
  Path to contract source code
Returns Promise<{
aci: Aci;
bytecode: `cb_${string}`;
}>
Overrides CompilerHttp.compile
- Defined in contract/compiler/HttpNode.ts:15

compileBySourceCode

compileBySourceCode(sourceCode: string, fileSystem?: Record<string, string>): Promise<{
aci: Aci;
bytecode: `cb_${string}`;
}>
Compile contract by contract's source code

Example
```
{
  'library.aes': 'namespace TestLib =\n  function sum(x: int, y: int) : int = x + y'
}
```
Returns
ACI and bytecode
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}`;
}>
Inherited from CompilerHttp.compileBySourceCode
- Defined in contract/compiler/Http.ts:63

validate

validate(bytecode: `cb_${string}`, path: string): Promise<boolean>
Verify that a contract bytecode is the result of compiling the given source code Available only in Node.js

Returns
ACI and bytecode
Parameters
- bytecode: `cb_${string}`
  
  Contract bytecode to verify
- path: string
  
  Path to contract source code
Returns Promise<boolean>
Overrides CompilerHttp.validate
- Defined in contract/compiler/HttpNode.ts:21

validateBySourceCode

validateBySourceCode(bytecode: `cb_${string}`, sourceCode: string, fileSystem?: Record<string, string>): Promise<boolean>
Verify that a contract bytecode is the result of compiling the given source code

Example
```
{
  'library.aes': 'namespace TestLib =\n  function sum(x: int, y: int) : int = x + y'
}
```
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>
Inherited from CompilerHttp.validateBySourceCode
- Defined in contract/compiler/Http.ts:84

version

version(): Promise<string>
Returns
Compiler version

Returns Promise<string>
Inherited from CompilerHttp.version
- Defined in contract/compiler/Http.ts:102

Class CompilerHttpNode

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

compilerUrl: string

options: { ignoreVersion?: boolean; } = {}

Optional ignoreVersion?: boolean

Returns CompilerHttpNode

Properties

Readonly api

Methods

compile

Returns

Parameters

path: string

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

compileBySourceCode

Example

Returns

Parameters

sourceCode: string

Optional fileSystem: Record<string, string>

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

validate

Returns

Parameters

bytecode: `cb_${string}`

path: string

Returns Promise<boolean>

validateBySourceCode

Example

Parameters

bytecode: `cb_${string}`

sourceCode: string

Optional fileSystem: Record<string, string>

Returns Promise<boolean>

version

Returns

Returns Promise<string>

Settings

Member Visibility

Theme

options: {
ignoreVersion?: boolean;
} = {}

`Optional` ignoreVersion?: boolean

`Readonly` api

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

`Optional` fileSystem: Record<string, string>

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

`Optional` fileSystem: Record<string, string>