Skip to content

Latest commit

 

History

History
289 lines (190 loc) · 5.3 KB

modules.md

File metadata and controls

289 lines (190 loc) · 5.3 KB

iexec / Exports

iexec

Table of contents

References

Modules

Namespaces

Classes

Interfaces

Type Aliases

References

BN

Re-exports BN

Type Aliases

Address

Ƭ Address: string

ethereum address

example:

const address = '0xF048eF3d7E3B33A465E0599E641BB29421f7Df92';

Addressish

Ƭ Addressish: Address | ENS

ethereum address or ENS


AnyRecord

Ƭ AnyRecord: Record<string, any>


BNish

Ƭ BNish: BN | bigint | string | number

big number like


Bytes

Ƭ Bytes: string

bytes hex string

example:

const NULL_BYTES = '0x';

Bytes32

Ƭ Bytes32: string

bytes 32 hex string

example:

const bytes32 = '0x800e8dca929fd7b6ced10b5f84487c49f7be79b2eed662827eccba258ef883c6';

Dealid

Ƭ Dealid: Bytes32

id of a deal


ENS

Ƭ ENS: string

ENS

example:

const ensName = 'iexec.eth';

HumanSingleTag

Ƭ HumanSingleTag: string

human redable task tag

example:

const teeTag = 'tee';

Multiaddress

Ƭ Multiaddress: string | Buffer

multiaddress

example:

const url = 'https://example.com/foo.bar'
const ipfs = '/ipfs/QmW2WQi7j6c7UgJTarActp7tDNikE4B2qXtFCfLPdsgaTQ'

NRLCAmount

Ƭ NRLCAmount: number | string | BN

nRLC amount (nRLC stands for nano RLC, the smallest sub-division of the RLC token: 1 RLC = 1,000,000,000 nRLC).

named units ('nRLC', 'RLC') can be used with the format ${amount} ${unit}

examples:

// number
const oneNRLC = 1;
const tenRLC = 1000000000;
// string (works for amounts above `Number.MAX_SAFE_INTEGER`)
const tenMillionRLC = '10000000000000000';
// string with unit
const fiveRLC = '5 RLC';
const zeroPointOneRLC = '0.1 RLC';
// BN (from utils)
const tenNRLC = new BN(10);

OrderHash

Ƭ OrderHash: Bytes32

order hash


Tag

Ƭ Tag: Bytes32 | HumanSingleTag[]

task tag used to specify the runtime

example:

const gpuTag = ['gpu'];
const sconeTeeTag = ['tee', 'scone'];
const gramineTeeTag = ['tee', 'gramine'];

TaskIndex

Ƭ TaskIndex: number

index of a task in a bag of tasks


Taskid

Ƭ Taskid: Bytes32

id of a task


TeeFramework

Ƭ TeeFramework: "scone" | "gramine"

Trusted Execution Environment name


TxHash

Ƭ TxHash: Bytes32

transaction hash


WeiAmount

Ƭ WeiAmount: number | string | BN

wei amount (wei is the smallest sub-division of ether: 1 ether = 1,000,000,000,000,000,000 wei).

named units ('wei', 'kwei', 'mwei', 'gwei', 'szabo', 'finney', 'ether' or 'eth') can be used with the format ${amount} ${unit}

examples:

// number
const oneWei = 1;
const tenGigaWei = 1000000000;
// string (works for amounts above `Number.MAX_SAFE_INTEGER`)
const oneEth = '1000000000000000000';
// string with unit
const fiveGigaWei = '5 gwei';
const zeroPointOneEth = '0.1 ether';
// BN (from utils)
const tenWei = new BN(10);