icon-sdk-js

icon-sdk-js copied to clipboard

ICON SDK for JavaScript

ICON supports JavaScript SDK for 3rd party or user services development. You can integrate ICON JavaScript SDK into your project and utilize ICON’s functionality. This document provides you with an information of installation and API specification.

Table of Contents

• Installation
• API Specification - Introduction
• IconService
• IconService.IconWallet
• IconService.IconBuilder
• IconService.IconBuilder.IcxTransactionBuilder
• IconService.IconBuilder.MessageTransactionBuilder
• IconService.IconBuilder.DeployTransactionBuilder
• IconService.IconBuilder.CallTransactionBuilder
• IconService.IconBuilder.DepositTransactionBuilder
• IconService.IconBuilder.CallBuilder
• IconService.SignedTransaction
• IconService.HttpProvider
• IconService.IconAmount
• IconService.IconConverter
• IconService.IconHexadecimal
• IconService.IconValidator
• Error cases
• References

Installation

Usage in Node.js

Install icon-sdk-js module using yarn.

yarn add icon-sdk-js

Import icon-sdk-js module.

const IconService = require('icon-sdk-js');

Usage in browser

Install icon-sdk-js module using yarn,

yarn add icon-sdk-js

or using CDN.

<script src="https://cdn.jsdelivr.net/npm/icon-sdk-js@latest/build/icon-sdk-js.web.min.js"></script>

Then, import icon-sdk-js module. This module uses fetch internally. So if you use this in old browser, You should import whatwg-fetch.

import IconService from 'icon-sdk-js';

Usage in react-native environment

Install icon-sdk-js module using yarn,

yarn add icon-sdk-js

Then, import icon-sdk-js/build/icon-sdk-js.web.min.js module.

import IconService from 'icon-sdk-js/build/icon-sdk-js.web.min.js';

API Specification - Introduction

IconService is a root class of icon-sdk-js, which provides APIs to communicate with ICON nodes and contains different type of modules. Details of modules are as below:

IconService

IconService is a class which provides APIs to communicate with ICON nodes. It enables you to easily use ICON JSON-RPC APIs (version 3). All instance methods of IconService returns a HttpCall instance. To execute the request and get the result value, you need to run execute() function of HttpCall instance. All requests will be executed asynchronously. Synchronous request is not available.

Constructor

Creates an instance of IconService.

new IconService(provider: HttpProvider)

Parameters

Example

const httpProvider = new HttpProvider('https://ctz.solidwallet.io/api/v3');
const iconService = new IconService(httpProvider);

getTotalSupply()

Get the total number of issued coins.

.getTotalSupply(height: string|BigNumber|number) => HttpCall // .execute() => BigNumber

Parameters

Returns

HttpCall - The HttpCall instance for icx_getTotalSupply JSON-RPC API request. If execute() successfully, it returns a BigNumber value of total issued coins.

Example

/* Returns the total number of issued coins. */
const totalSupply = await iconService.getTotalSupply().execute();

getBalance()

Get the balance of the address.

.getBalance(address: string, height?: string|BigNumber|number) => HttpCall // .execute() => BigNumber

Parameters

Returns

HttpCall - The HttpCall instance for icx_getBalance JSON-RPC API request. If execute() successfully, it returns a BigNumber value of ICX balance.

Example

/* Returns the balance of a EOA address */
const balance = await iconService.getBalance('hx9d8a8376e7db9f00478feb9a46f44f0d051aab57').execute();

getBlockByHeight()

Get the block information by block height.

.getBlockByHeight(value: number|BigNumber) => HttpCall // .execute() => object

Parameters

Returns

HttpCall - The HttpCall instance for icx_getBlockByHeight JSON-RPC API request. If execute() successfully, it returns a block object.

Example

// Returns block information
const block = await iconService.getBlockByHeight(1000).execute();

getBlockByHash()

Get the block information by block hash.

.getBlockByHash(value: string) => HttpCall // .execute() => object

Parameters

Returns

HttpCall - The HttpCall instance for icx_getBlockByHash JSON-RPC API request. If execute() successfully, it returns a block object.

Example

// Returns block information
const block = await iconService.getBlockByHash('0xdb310dd653b2573fd673ccc7489477a0b697333f77b3cb34a940db67b994fd95').execute();

getLastBlock()

Get the latest block information.

.getLastBlock() => HttpCall // .execute() => object

Parameters

None

Returns

HttpCall - The HttpCall instance for icx_getLastBlock JSON-RPC API request. If execute() successfully, it returns a block object.

Example

// Returns block information
const block = await iconService.getLastBlock().execute();

getScoreApi()

Get the SCORE API list.

.getScoreApi(address: string, height?: Hash) => HttpCall // .execute() => array

Parameters

Returns

HttpCall - The HttpCall instance for icx_getScoreApi JSON-RPC API request. If execute() successfully, it returns a ScoreApiList instance, the API list of SCORE address.

ScoreApiList provides two instance methods, getList() and getMethod().

• getList() - Returns array of API list.

• getMethod(method: string) - Returns object of method information.

Example

// Returns the SCORE API list
const apiList = await iconService.getScoreApi('cx0000000000000000000000000000000000000001').execute();

// [ { type: 'function', name: 'acceptScore', inputs: [ [Object] ] outputs: [] }, ··· { type: 'eventlog', name: 'UpdateServiceConfigLog', inputs: [ [Object] ] }]
console.log(apiList.getList());

// { type: 'function', name: 'getStepCosts', inputs: [], outputs: [ { type: 'dict' } ], readonly: '0x1' }
console.log(apiList.getMethod('getStepCosts'));

getScoreStatus()

Get the SCORE status

.getScoreStatus(address: string, height?: Hash) => HttpCall

Parameters

Returns

HttpCall - The HttpCall instance for icx_getScoreStatus JSON-RPC API request. If execute() successfully, it returns a status of SCORE.

Example

// Returns Score Status
const status = await iconService.getScoreStatus('cxb903239f8543d04b5dc1ba6579132b143087c68d').execute();

getTransaction()

Get the transaction information.

.getTransaction(hash: string) => HttpCall // .execute() => object

Parameters

Returns

HttpCall - The HttpCall instance for icx_getTransactionByHash JSON-RPC API request. If execute() successfully, it returns a transaction object. For details of returned object, see here.

Example

// Returns the transaction object.
const txObject = await iconService.getTransaction('0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238').execute();

getTransactionResult()

Get the result of transaction by transaction hash.

.getTransactionResult(hash: string) => HttpCall // .execute() => object

Parameters

Returns

HttpCall - The HttpCall instance for icx_getTransactionResult JSON-RPC API request. If execute() successfully, it returns a transaction result object. For details of returned object, see here.

Example

// Returns the transaction result object.
const txObject = await iconService.getTransactionResult('0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238').execute();

getTrace()

Get the transaction trace. newly added from ICON2

.getTrace(hash: string) => HttpCall // .execute() => any

Parameters

Returns

HttpCall - The HttpCall instance for debug_getTrace JSON-RPC API request. If execute() successfully, it returns a BigNumber value of estimated step.

Example

// Returns the transaction trace.
const trace = await iconService.getTrace(hash).execute();

sendTransaction()

Send a transaction that changes the states of address.

.sendTransaction(signedTransaction: SignedTransaction) => HttpCall // .execute() => string

Parameters

Returns

HttpCall - The HttpCall instance for icx_sendTransaction JSON-RPC API request. If execute() successfully, it returns a string value of transaction hash.

Example

// Returns the tx hash of transaction.
const txHash = await iconService.sendTransaction(signedTransaction).execute();

estimateStep()

Returns an estimated step of how much step is necessary to allow the transaction to complete.

.estimateStep(transaction:IcxTransaction | MessageTransaction | DepositTransaction | DeployTransaction | CallTransaction) => HttpCall // .execute() => string

Parameters

Returns

HttpCall - The HttpCall instance for debug_estimateStep JSON-RPC API request. If execute() successfully, it returns a BigNumber value of estimated step.

Example

// Returns the estimated step to execute transaction.
const step = await iconService.estimateStep(transaction).execute();

sendTransactionAndWait()

It sends a transaction like icx_sendTransaction, then it will wait for the result.

.sendTransactionAndWait(signedTransaction: SignedTransaction) => HttpCall // .execute() => object

Parameters

Returns

HttpCall - The HttpCall instance for icx_sendTransactionAndWait JSON-RPC API request. If execute() successfully, it returns a object value of transaction result.

Example

// Returns the tx hash of transaction.
const result = await iconService.sendTransactionAndWait(signedTransaction).execute();

waitTransactionResult()

It will wait for the result of the transaction for specified time.

.waitTransactionResult(hash: string) => HttpCall // .execute() => object

Parameters

Returns

HttpCall - The HttpCall instance for icx_waitTransactionResult JSON-RPC API request. If execute() successfully, it returns a transaction result object. For details of returned object, see here.

Example

// Returns the tx hash of transaction.
const result = await iconService.waitTransactionResult(hash).execute();

getDataByHash()

Get data by hash.

It can be used to retrieve data based on the hash algorithm (SHA3-256).

Following data can be retrieved by a hash.

• BlockHeader with the hash of the block
• Validators with BlockHeader.NextValidatorsHash
• Votes with BlockHeader.VotesHash
• etc…

.getDataByHash(hash: string) => HttpCall // .execute() => string

Parameters

Returns

HttpCall - The HttpCall instance for icx_getDataByHash JSON-RPC API request. If execute() successfully, it returns base64 encoded data

Example

// Returns the tx hash of transaction.
const data = await iconService.getDataByHash(hash).execute();

getBlockHeaderByHeight()

Get block header for specified height.

.getBlockHeaderByHeight(height: string | BigNumber) => HttpCall // .execute() => string

Parameters

Returns

HttpCall - The HttpCall instance for icx_getBlockHeaderByHeight JSON-RPC API request. If execute() successfully, it returns base64 encoded data

Example

// Returns the tx hash of transaction.
const data = await iconService.getBlockHeaderByHeight(height).execute();

getVotesByHeight()

Get votes for the block specified by height.

.getVotesByHeight(height: string | BigNumber) => HttpCall // .execute() => string

Parameters

Returns

HttpCall - The HttpCall instance for icx_getVotesByHeight JSON-RPC API request. If execute() successfully, it returns base64 encoded votes data

Example

// Returns the tx hash of transaction.
const data = await iconService.getVotesByHeight(height).execute();

getProofForResult()

Get proof for the receipt. Proof, itself, may include the receipt.

.getProofForResult(hash: string | BigNumber, index: string | BigNumber) => HttpCall // .execute() => Array<string>

Parameters

Returns

HttpCall - The HttpCall instance for icx_getProofForResult JSON-RPC API request. If execute() successfully, it returns List of base64 encoded proof including the receipt

Example

// Returns the tx hash of transaction.
const data = await iconService.getProofForResult(hash, index).execute();

getProofForEvents()

Get proof for the receipt and the events in it. The proof may include the data itself.

.getProofForEvents(hash: string | BigNumber, index: string | BigNumber, events: Array<string | BigNumber>) => HttpCall // .execute() => Array<string>

Parameters

Returns

HttpCall - The HttpCall instance for icx_getProofForEvents JSON-RPC API request. If execute() successfully, it returns List of List of base64 encoded proof including the receipt and the events

Example

// Returns the tx hash of transaction.
const data = await iconService.getProofForEvents(hash, index, events).execute();

getBTPNetworkInfo()

Get BTP network information.

.getBTPNetworkInfo(id: string | BigNumber, height?: string | BigNumber) => HttpCall // .execute() => BTPNetworkInfo

Parameters

Returns

HttpCall - The HttpCall instance for btp_getNetworkInfo JSON-RPC API request.

Example

const data = await iconService.getBTPNetworkInfo(id, height).execute();

getBTPNetworkTypeInfo()

Get BTP network type information.

.getBTPNetworkTypeInfo(id: string | BigNumber, height?: string | BigNumber) => HttpCall // .execute() => BTPNetworkTypeInfo

Parameters

Returns

HttpCall - The HttpCall instance for btp_getNetworkTypeInfo JSON-RPC API request.

Example

const data = await iconService.getBTPNetworkTypeInfo(id, height).execute();

getBTPMessages()

Get BTP messages.

.getBTPMessages(id: string | BigNumber, height: string | BigNumber) => HttpCall // .execute() => Array<string>

Parameters

Returns

HttpCall - The HttpCall instance for btp_getMessages JSON-RPC API request.

Example

const data = await iconService.getBTPMessages(networkID, height).execute();

getBTPHeader()

Get BTP block header

.getBTPHeader(networkID: string | BigNumber, height: string | BigNumber) => HttpCall // .execute() => string

Parameters

Returns

HttpCall - The HttpCall instance for btp_getHeader JSON-RPC API request.

Example

const data = await iconService.getBTPHeader(networkID, height).execute();

getBTPProof()

Get BTP block proof

.getBTPProof(networkID: string | BigNumber, height: string | BigNumber) => HttpCall // .execute() => string

Parameters

Returns

HttpCall - The HttpCall instance for btp_getProof JSON-RPC API request.

Example

const data = await iconService.getBTPProof(networkID, height).execute();

getBTPSourceInformation()

Get source network information

.getBTPSourceInformation() => HttpCall // .execute() => BTPSourceInformation

Parameters

None

Returns

HttpCall - The HttpCall instance for btp_getSourceInformation JSON-RPC API request.

Example

const data = await iconService.getBTPSourceInformation().execute();

getNetworkInfo()

Get basic network Information

.getNetworkInfo() => HttpCall // .execute() => NetworkInfo

Parameters

None

Returns

HttpCall - The HttpCall instance for icx_getNetworkInfo JSON-RPC API request.

Example

const data = await iconService.getNetworkInfo().execute();

call()

Calls external function of SCORE.

.call(call: Call) => HttpCall // .execute() => any

Parameters

Returns

HttpCall - The HttpCall instance for icx_call JSON-RPC API request. If execute() successfully, it returns a any type of value returned by the executed SCORE function.

Example

// Returns the value returned by the executed SCORE function.
const result = await iconService.call(call).execute();

monitorBlock()

Monitor events for every blocks.

.monitorBlock(
  monitorSpec: BlockMonitorSpec,
  ondata: (notification: EventNotification) => void,
  onerror: (error: any) => void,
  onprogress?: (height: BigNumber) => void
): Monitor<BlockNotification>

Parameters

• BlockMonitorSpec
• BlockNotification

Returns

Monitor - Monitor instance for websocket monitoring. It can be used to call close() for stopping monitoring

• Monitor

monitorEvent()

Monitor events from the SCORE.

.monitorEvent(
  monitorSpec: EventMonitorSpec,
  ondata: (notification: EventNotification) => void,
  onerror: (error: any) => void,
  onprogress?: (height: BigNumber) => void
): Monitor<EventNotification>

Parameters

• EventMonitorSpec
• EventNotification

Returns

Monitor - Monitor instance for websocket monitoring. It can be used to call close() for stopping monitoring

Example

spec = new EventMonitorSpec(
  BigNumber("0xabc"),
  new EventFilter(
    "BTPEvent(str,int,str,str)",
    "cxf1b0808f09138fffdb890772315aeabb37072a8a",
  ),
  true,
  20,
)
on_data(ev) {
  console.log("Event", ev)
}
on_error(err) {
  console.log("Error", err)
}
on_progress(height) {
  console.log("Progress", height)
}
const monitor = iconservice.monitorEvent(spec,on_data,on_error,on_progress);

monitor.close();

monitorBTP()

Monitor BTP events related with the network

.monitorBTP(
  monitorSpec: BTPMonitorSpec,
  ondata: (notification: BTPNotification) => void
  onerror: (error: any) => void,
  onprogress?: (height: BigNumber) => void
): Monitor<BTPNotification>

Parameters

• BTPMonitorSpec
• BTPNotification

Returns

Monitor - Monitor instance for websocket monitoring. It can be used to call close() for stopping monitoring

Example

spec = new BTPMonitorSpec(
  BigNumber("0xabc"),
  BigNumber("0x1"),
  false,
  20
);
on_data(ev) {
  console.log("Event", ev)
}
on_error(err) {
  console.log("Error", err)
}
on_progress(height) {
  console.log("Progress", height)
}
const monitor = iconservice.monitorBTP(spec,on_data,on_error,on_progress);

monitor.close();

IconService.IconWallet (Wallet)

IconWallet is a class which provides EOA functions. It enables you to create, load, and store Wallet object.

Constructor

Creates an instance of Wallet class. To create wallet, please use create() static function instead of instantiating this class directly.

new Wallet(privKey: string, pubKey: string)

Parameters

static create()

Creates an instance of Wallet class.

IconWallet.create() => Wallet

Parameters

None

Returns

Wallet - Wallet instance. It contains a public key and a private key randomly generated by create() function.

Example

// Creates an instance of Wallet.
const wallet = IconWallet.create();

static loadPrivateKey()

Import existing wallet using private key.

IconWallet.loadPrivateKey(privKey: string) => Wallet

Parameters

Returns

Wallet - a Wallet instance.

Example

// Load wallet object
const wallet = IconWallet.loadPrivateKey('2ab···e4c');

static loadKeystore()

Import existing wallet using keystore object.

IconWallet.loadKeystore(keystore: object|string, password: string, nonStrict?: boolean) => Wallet

Parameters

Returns

Wallet - a Wallet instance.

Example

const testKeystore = { "version": 3, "id": "41fc1ddb-4faf-4c88-b494-8fe82a4bab63", "address": "hxd008c05cbc0e689f04a5bb729a66b42377a9a497", "crypto": { "ciphertext": "c4046f5a735403a963110d24f39120a102ad7bc462bf2a14ae334ba4a8c485f6", "cipherparams": { "iv": "441b5a5de3dd33de6f7838b6075702d2" }, "cipher": "aes-128-ctr", "kdf": "scrypt", "kdfparams": { "dklen": 32, "salt": "39d45ffead82d554e35a55efcc7a1f64afe73e9a8ab6b750d959f904e32294ba", "n": 16384, "r": 8, "p": 1 }, "mac": "9bca1f2e8750efb27b7357e1a6a727c596cb812f7a4c45792494a8b0890774d7" }, "coinType": "icx" }
const testPassword = 'qwer1234!'

// Load wallet object
const wallet = IconWallet.loadKeystore(testKeystore, testPassword)

store()

Get keystore object of an instance of a Wallet class.

.store(password: string, opts?: object) => object

Parameters

Returns

object - a keystore object.

Example

const wallet = IconWallet.create()
// Get keystore object of an instance of a `Wallet` class.
const keystore = wallet.store("qwer1234!")

sign()

Generate signature string by signing transaction object.

.sign(data: Buffer) => string

Parameters

Returns

string - a signature string.

Example

const wallet = IconWallet.create()
// Get keystore object of an instance of a `Wallet` class.
const signature = wallet.sign('ba4···f64')

getPrivateKey()

Get a private key of Wallet instance.

.getPrivateKey() => string

Parameters

None

Returns

string - a private key.

Example

const wallet = IconWallet.create()
// Get private key of `Wallet` instance.
const pk = wallet.getPrivateKey()

getPublicKey()

Get a public key of Wallet instance.

getPublicKey(compressed = false): string

Parameters

Returns

string - a public key.

Example

const wallet = IconWallet.create()
// Get public key of `Wallet` instance.
const pk = wallet.getPublicKey()

getAddress()

Get an address of Wallet instance.

.getAddress() => string

Parameters

None

Returns

string - an EOA address.

Example

const wallet = IconWallet.create()
// Get address of `Wallet` instance.
const pk = wallet.getAddress()

IconService.IconBuilder

IconBuilder is an object containing builder class for transaction object. Builder class enables you to make transaction object easily. There are 5 types of builder class as follows:

IconService.IconBuilder.IcxTransactionBuilder

Builder class for IcxTransaction instance. IcxTransaction is an object representing a transaction object used for sending ICX. The parameter details are as follows:

Constructor

Creates an instance of IcxTransactionBuilder class.

new IcxTransactionBuilder()

Parameters

None

to()

Setter method of 'to' property.

.to(to: string) => IcxTransactionBuilder

Parameters

Returns

IcxTransactionBuilder - Returns an instance of itself

Example

// Set `to` property.
const txObj = new IcxTransactionBuilder()
    .to('hx87a90bfe8ed49e1a25184ce77fa0d9c4b0484d6a')

from()

Setter method of 'from' property.

.from(from: string) => IcxTransactionBuilder

Parameters

Returns

IcxTransactionBuilder - Returns an instance of itself

Example

// Set `from` property.
const txObj = new IcxTransactionBuilder()
    .from('hx46293d558d3bd489c3715e7e3648de0e35086bfd')

value()

Setter method of 'value' property.

.value(value: string|BigNumber|number) => IcxTransactionBuilder

Parameters

Returns

IcxTransactionBuilder - Returns an instance of itself

Example

// Set `value` property.
const txObj = new IcxTransactionBuilder()
    .value(IconAmount.of(1, IconAmount.Unit.ICX).toLoop())

stepLimit()

Setter method of 'stepLimit' property.

.stepLimit(stepLimit: string|BigNumber|number) => IcxTransactionBuilder

Parameters

Returns

IcxTransactionBuilder - Returns an instance of itself

Example

// Set `value` property.
const txObj = new IcxTransactionBuilder()
    .stepLimit(IconConverter.toBigNumber(100000))

nid()

Setter method of 'nid' property.

.nid(nid: string|BigNumber|number) => IcxTransactionBuilder

Parameters

Returns

IcxTransactionBuilder - Returns an instance of itself

Example

// Set `nid` property.
const txObj = new IcxTransactionBuilder()
    .nid(IconConverter.toBigNumber(1))

nonce()

Setter method of 'nonce' property.

.nonce(nonce: string|BigNumber|number) => IcxTransactionBuilder

Parameters

Returns

IcxTransactionBuilder - Returns an instance of itself

Example

// Set `nonce` property.
const txObj = new IcxTransactionBuilder()
    .nonce(IconConverter.toBigNumber(1))

version()

Setter method of 'version' property.

.version(version: string|BigNumber|number) => IcxTransactionBuilder

Parameters

Returns

IcxTransactionBuilder - Returns an instance of itself

Example

// Set `version` property.
const txObj = new IcxTransactionBuilder()
    .version(IconConverter.toBigNumber(3))

timestamp()

Setter method of 'timestamp' property.

.timestamp(version: string|BigNumber|number) => IcxTransactionBuilder

Parameters

Returns

IcxTransactionBuilder - Returns an instance of itself

Example

// Set `timestamp` property.
const txObj = new IcxTransactionBuilder()
    .timestamp(1544596599371000)

build()

Returns an IcxTransaction instance which contains parameter you set.

.build() => IcxTransaction

Parameters

None

Returns

IcxTransaction - Returns an IcxTransaction instance.

Example

// Build `IcxTransaction` instance.
const txObj = new IcxTransactionBuilder()
    .from('hx46293d558d3bd489c3715e7e3648de0e35086bfd')
    .to('hx87a90bfe8ed49e1a25184ce77fa0d9c4b0484d6a')
    .value(IconAmount.of(7, IconAmount.Unit.ICX).toLoop())
    .stepLimit(IconConverter.toBigNumber(100000))
    .nid(IconConverter.toBigNumber(3))
    .nonce(IconConverter.toBigNumber(1))
    .version(IconConverter.toBigNumber(3))
    .timestamp(1544596599371000)
    .build()

IconService.IconBuilder.MessageTransactionBuilder

Builder class for MessageTransaction instance. MessageTransaction is an object representing a transaction object used for sending message data. It extends IcxTransaction class, so instance parameters and methods of builder class are mostly identical to IcxTransaction class, except for the following:

For details of extended parameters and methods, see IcxTransactionBuilder section.

Constructor

Creates an instance of MessageTransactionBuilder class.

new MessageTransactionBuilder()

Parameters

None

data()

Setter method of 'data' property.

.data(data: string) => MessageTransactionBuilder

Parameters

Returns

MessageTransactionBuilder - Returns an instance of itself

Example

// Set `data` property.
const txObj = new MessageTransactionBuilder()
    .data(IconConverter.fromUtf8('Hello'))

build()

Returns an MessageTransaction instance which contains parameter you set.

.build() => MessageTransaction

Parameters

None

Returns

MessageTransaction - Returns an MessageTransaction instance.

Example

// Build `MessageTransaction` instance.
const txObj = new MessageTransactionBuilder()
    .from('hx46293d558d3bd489c3715e7e3648de0e35086bfd')
    .to('hx87a90bfe8ed49e1a25184ce77fa0d9c4b0484d6a')
    .stepLimit(IconConverter.toBigNumber(100000))
    .nid(IconConverter.toBigNumber(3))
    .nonce(IconConverter.toBigNumber(1))
    .version(IconConverter.toBigNumber(3))
    .timestamp(1544596599371000)
    .data(IconConverter.fromUtf8('Hello'))
    .build()

IconService.IconBuilder.DeployTransactionBuilder

Builder class for DeployTransaction instance. DeployTransaction is an object representing a transaction object used for deploying SCORE. It extends IcxTransaction class, so instance parameters and methods of builder class are mostly identical to IcxTransaction class, except for the following:

For details of extended parameters and methods, see IcxTransactionBuilder section.

Constructor

Creates an instance of DeployTransactionBuilder class.

new DeployTransactionBuilder()

Parameters

None

contentType()

Setter method of 'contentType' property in 'data'.

.contentType(contentType: string) => DeployTransactionBuilder

Parameters

Returns

DeployTransactionBuilder - Returns an instance of itself

Example

// Set `contentType` property.
const txObj = new DeployTransactionBuilder()
    .contentType('application/zip')

content()

Setter method of 'content' property in 'data'.

.content(content: string) => DeployTransactionBuilder

Parameters

Returns

DeployTransactionBuilder - Returns an instance of itself

Example

// Set `content` property.
const txObj = new DeployTransactionBuilder()
    .content('0x504b03040a0000000000d3a68e4d000000000000000...')

params()

Setter method of 'params' property in 'data'.

.params(params: object) => DeployTransactionBuilder

Parameters

Returns

DeployTransactionBuilder - Returns an instance of itself

Example

// Set `params` property.
const txObj = new DeployTransactionBuilder()
    .params({
        initialSupply: IconConverter.toHex('100000000000'),
        decimals: IconConverter.toHex(18),
        name: 'StandardToken',
        symbol: 'ST',
    })

build()

Returns an DeployTransaction instance which contains parameter you set.

.build() => DeployTransaction

Parameters

None

Returns

DeployTransaction - Returns an DeployTransaction instance.

Example

// Build `DeployTransaction` instance.
const txObj = new DeployTransactionBuilder()
    .from('hx46293d558d3bd489c3715e7e3648de0e35086bfd')
    .to('cx0000000000000000000000000000000000000000')
    .stepLimit(IconConverter.toBigNumber(2500000))
    .nid(IconConverter.toBigNumber(3))
    .nonce(IconConverter.toBigNumber(1))
    .version(IconConverter.toBigNumber(3))
    .timestamp(1544596599371000)
    .contentType('application/zip')
    .content('0x504b03040a0000000000d3a68e4d000000000000000...')
    .params({
        initialSupply: IconConverter.toHex('100000000000'),
        decimals: IconConverter.toHex(18),
        name: 'StandardToken',
        symbol: 'ST',
    })
    .build()

IconService.IconBuilder.CallTransactionBuilder

Builder class for CallTransaction instance. CallTransaction is an object representing a transaction object used for invoking a state-transition function of SCORE. It extends IcxTransaction class, so instance parameters and methods are mostly identical to IcxTransaction class, except for the following:

For details of extended parameters and methods, see IcxTransactionBuilder section.

Constructor

Creates an instance of CallTransactionBuilder class.

new CallTransactionBuilder()

Parameters

None

method()

Setter method of 'method' property in 'data'.

.method(method: string) => CallTransactionBuilder

Parameters

Returns

CallTransactionBuilder - Returns an instance of itself

Example

// Set `method` property.
const txObj = new CallTransactionBuilder()
    .method('transfer')

params()

Setter method of 'params' property in 'data'.

.params(params: object) => CallTransactionBuilder

Parameters

Returns

CallTransactionBuilder - Returns an instance of itself

Example

// Set `params` property.
const txObj = new CallTransactionBuilder()
    .params({
        _to: 'hxd008c05cbc0e689f04a5bb729a66b42377a9a497',
        _value: IconConverter.toHex(IconAmount.of(1, IconAmount.Unit.ICX).toLoop()),
    })

build()

Returns an CallTransaction instance which contains parameter you set.

.build() => CallTransaction

Parameters

None

Returns

CallTransaction - Returns an CallTransaction instance.

Example

// Build `CallTransaction` instance.
const txObj = new CallTransactionBuilder()
    .from('hx902ecb51c109183ace539f247b4ea1347fbf23b5')
    .to('cx3502b4dadbfcd654d26d53d8463f2929c2c3948d')
    .stepLimit(IconConverter.toBigNumber('2000000'))
    .nid(IconConverter.toBigNumber('3'))
    .nonce(IconConverter.toBigNumber('1'))
    .version(IconConverter.toBigNumber('3'))
    .timestamp((new Date()).getTime() * 1000)
    .method('transfer')
    .params({
        _to: 'hxd008c05cbc0e689f04a5bb729a66b42377a9a497',
        _value: IconConverter.toHex(IconAmount.of(1, IconAmount.Unit.ICX).toLoop()),
    })
    .build()

IconService.IconBuilder.DepositTransactionBuilder

Builder class for DepositTransaction instance. DepositTransaction is an object representing a transaction object used for depositing/withdrawing SCORE. It extends IcxTransaction class, so instance parameters and methods are mostly identical to IcxTransaction class, except for the following:

For details of extended parameters and methods, see IcxTransactionBuilder section.

Constructor

Creates an instance of DepositTransactionBuilder class.

new DepositTransactionBuilder()

Parameters

None

action()

Setter method of 'action' property in 'data'.

.action(action: string) => DepositTransactionBuilder

Parameters

Returns

DepositTransactionBuilder - Returns an instance of itself

Example

// Set `action` property.
const txObj = new DepositTransactionBuilder()
    .action('add')

id()

Setter method of 'id' property in 'data'.

.id(params: string) => DepositTransactionBuilder

Parameters

Returns

DepositTransactionBuilder - Returns an instance of itself

Example

// Set `id` property.
const txObj = new DepositTransactionBuilder()
    .id("0x8ed676ca8aeef92159f5bb1223db1e8bcf65ea8ea3d6ae9ed23e006407aa9fda")

build()

Returns an DepositTransaction instance which contains parameter you set.

.build() => DepositTransaction

Parameters

None

Returns

DepositTransaction - Returns an DepositTransaction instance.

Example

// Build `DepositTransaction` instance.
const txObj = new DepositTransactionBuilder()
    .from('hx902ecb51c109183ace539f247b4ea1347fbf23b5')
    .to('cx3502b4dadbfcd654d26d53d8463f2929c2c3948d')
    .stepLimit(IconConverter.toBigNumber('2000000'))
    .nid(IconConverter.toBigNumber('3'))
    .nonce(IconConverter.toBigNumber('1'))
    .version(IconConverter.toBigNumber('3'))
    .timestamp((new Date()).getTime() * 1000)
    .action('withdraw')
    .id("0x8ed676ca8aeef92159f5bb1223db1e8bcf65ea8ea3d6ae9ed23e006407aa9fda")
    .build()

IconService.IconBuilder.CallBuilder

Builder class for Call instance. Call is an object representing a transaction object used for invoking a read-only function of SCORE. The parameter details are as follows:

Constructor

Creates an instance of CallBuilder class.

new CallBuilder()

Parameters

None

to()

Setter method of 'to' property.

.to(to: string) => CallBuilder

Parameters

Returns

CallBuilder - Returns an instance of itself

Example

// Set `to` property.
const txObj = new CallBuilder()
    .to('cxc248ee72f58f7ec0e9a382379d67399f45b596c7')

method()

Setter method of 'method' property in 'data'.

.method(method: string) => CallBuilder

Parameters

Returns

CallBuilder - Returns an instance of itself

Example

// Set `method` property.
const txObj = new CallBuilder()
    .method('balanceOf')

params()

Setter method of 'params' property in 'data'.

.params(params: object) => CallBuilder

Parameters

Returns

CallBuilder - Returns an instance of itself

Example

// Set `params` property.
const txObj = new CallBuilder()
    .params({ 
        _owner: 'hx87a90bfe8ed49e1a25184ce77fa0d9c4b0484d6a' 
    })

build()

Returns an Call instance which contains parameter you set.

.build() => Call

Parameters

None

Returns

Call - Returns an Call instance.

Example

// Build `Call` instance.
const txObj = new CallBuilder()
    .to('cxc248ee72f58f7ec0e9a382379d67399f45b596c7')
    .method('balanceOf')
    .params({ _owner: 'hx87a90bfe8ed49e1a25184ce77fa0d9c4b0484d6a' })
    .build()

IconService.SignedTransaction

SignedTransaction is a class for signing transaction object. It enables you to make signature, and signed transaction object by calling instance methods. Also, by passing SignedTransaction instance to sendTransaction(), it will automatically generate transaction object including signature, and send to ICON node.

Constructor

Creates an instance of SignedTransaction class.

new SignedTransaction(transaction: IcxTransaction|MessageTransaction|CallTransaction|DeployTransaction, wallet: Wallet)

Parameters

getSignature()

Get a signature string.

.getSignature() => string

Parameters

None

Returns

string - a signature string.

Example

/* Returns the signature */
const signature = new SignedTransaction(icxTransaction, wallet).getSignature() 
// 'YV3eNgVjLFwXS65Bk...+lC90KgRBh7FtwE='

getProperties()

Get a raw signed transaction object.

.getProperties() => object

Parameters

None

Returns

object - the raw signed transaction object.

Example

/* Returns the raw signed transaction object */
const signature = new SignedTransaction(icxTransaction, wallet).getProperties()
// {
// 	to: 'hx87a90bfe8ed49e1a25184ce77fa0d9c4b0484d6a',
// 	from: 'hx46293d558d3bd489c3715e7e3648de0e35086bfd',
// 	stepLimit: '0x186a0',
// 	nid: '0x3',
// 	version: '0x3',
// 	timestamp: '0x57ccd6ba074f8',
// 	value: '0x7',
// 	nonce: '0x1',
// 	signature: 'YV3eNgVjLFwXS65Bk...+lC90KgRBh7FtwE=',
// };

getRawTransaction()

Get a raw transaction object of transaction property.

.getRawTransaction() => object

Parameters

None

Returns

object - the raw transaction object of transaction property.

Example

/* Returns the signed transaction object */
const signature = new SignedTransaction(icxTransaction, wallet).getRawTransaction()
// {
// 	to: 'hx87a90bfe8ed49e1a25184ce77fa0d9c4b0484d6a',
// 	from: 'hx46293d558d3bd489c3715e7e3648de0e35086bfd',
// 	stepLimit: '0x186a0',
// 	nid: '0x3',
// 	version: '0x3',
// 	timestamp: '0x57ccd6ba074f8',
// 	value: '0x7',
// 	nonce: '0x1'
// };

IconService.HttpProvider

HttpProvider is a class representing HTTP-based provider. It is commonly used for setting provider url of IconService instance. For details of network and node url, see ICON Networks document.

Constructor

Creates an instance of HttpProvider class.

new HttpProvider(url: string)

Parameters

IconService.IconAmount

IconAmount is a class representing BigNumber value and unit data. It also provides unit conversion static functions. It enables you to manage different types of numeric data easily.

(IconAmount contains static class property called Unit, which has constant number value of different types of unit digit. IconAmount.Unit.LOOP is 0, and IconAmount.Unit.ICX is 18.)

Constructor

Creates an instance of IconAmount class.

new IconAmount(value: string|BigNumber|number, digit: string|BigNumber|number)

Parameters

Note: According to official document of BigNumber.js, it is recommended to create BigNumbers from string values rather than number values to avoid a potential loss of precision.

static of()

Creates an instance of IconAmount class.

IconAmount.of(value: string|BigNumber|number, digit: string|BigNumber|number) => IconAmount

Parameters

Note: According to official document of BigNumber.js, it is recommended to create BigNumbers from string values rather than number values to avoid a potential loss of precision.

Returns

IconAmount - IconAmount instance.

Example

// Returns IconAmount instance
const iconAmount = IconAmount.of('2', IconAmount.Unit.ICX);

toString()

Converts value property into string

.toString() => string

Parameters

None

Returns

string - The stringified value property of IconAmount instance.

Example

// Returns stringified value property
const value = IconAmount.of('2', IconAmount.Unit.ICX).toString();

getDigit()

Get digit property.

.getDigit() => number

Parameters

None

Returns

number - The digit property of IconAmount instance.

Example

// Returns digit property
const digit = IconAmount.of('2', IconAmount.Unit.ICX).getDigit();

toLoop()

Get value property converted into loop unit.

.toLoop() => BigNumber

Parameters

None

Returns

BigNumber - The value property converted into loop unit.

Example

// Returns value property converted into loop unit.
const value = IconAmount.of('2', IconAmount.Unit.ICX).toLoop();

convertUnit()

Converts value property into custom digit

.convertUnit(digit: string|BigNumber|number) => IconAmount

Parameters

Returns

IconAmount - The IconAmount instance converted into custom digit.

Example

// Returns IconAmount instance converted into custom digit.
const value = IconAmount.of('2', IconAmount.Unit.ICX).convertUnit(IconAmount.Unit.LOOP);

IconService.IconConverter

IconConverter is a utility module which contains conversion functions.

static fromUtf8()

Converts UTF-8 text to hex string with '0x' prefix.

IconConverter.fromUtf8(value: string) => string

Parameters

Returns

string - a hex string with '0x' prefix

Example

// Returns hex string
const value = IconConverter.fromUtf8('hello')

static toNumber()

Converts string, hex string or BigNumber value to number.

IconConverter.toNumber(value: string|BigNumber) => number

Parameters

Returns

number - a value converted to number type.

Example

// Returns number value
const value = IconConverter.toNumber('123')

static toBigNumber()

Converts string, hex string or number value to BigNumber.

IconConverter.toBigNumber(value: string|number) => BigNumber

Parameters

Returns

BigNumber - a value converted to BigNumber type.

Example

// Returns BigNumber value
const value = IconConverter.toBigNumber('123')

static toHex()

Converts string, number or BigNumber value to hex string.

IconConverter.toHex(value: string|number|BigNumber) => string

Parameters

Returns

string - a value converted to hex string with '0x' prefix.

Example

// Returns hex string
const value = IconConverter.toHex('123')

static toRawTransaction()

Converts transaction object to raw transaction object.

IconConverter.toRawTransaction(transaction: IcxTransaction|MessageTransaction|CallTransaction|DeployTransaction) => object

Parameters

Returns

object - a raw transaction object.

Example

const txObj = new IcxTransactionBuilder()
    .from('hx46293d558d3bd489c3715e7e3648de0e35086bfd')
    .to('hx87a90bfe8ed49e1a25184ce77fa0d9c4b0484d6a')
    .value(IconAmount.of(7, IconAmount.Unit.ICX).toLoop())
    .stepLimit(IconConverter.toBigNumber(100000))
    .nid(IconConverter.toBigNumber(3))
    .nonce(IconConverter.toBigNumber(1))
    .version(IconConverter.toBigNumber(3))
    .timestamp(1544596599371000)
    .build()
// Returns raw transaction object
const rawTxObj = IconConverter.toRawTransaction(txObj)

IconService.IconHexadecimal

IconHexadecimal is a utility module which contains functions related to hex prefix.

static is0xPrefix()

Check whether string starts with '0x' prefix.

IconHexadecimal.is0xPrefix(str: string) => boolean

Parameters

Returns

boolean - returns true if string starts with '0x' prefix.

Example

// Returns true if string starts with '0x' prefix
const value = IconHexadecimal.is0xPrefix('0x61')

static isHxPrefix()

Check whether string starts with 'hx' prefix.

IconHexadecimal.isHxPrefix(str: string) => boolean

Parameters

Returns

boolean - returns true if string starts with 'hx' prefix.

Example

// Returns true if string starts with 'hx' prefix
const value = IconHexadecimal.isHxPrefix('hx902ecb51c109183ace539f247b4ea1347fbf23b5')

static isCxPrefix()

Check whether string starts with 'cx' prefix.

IconHexadecimal.isCxPrefix(str: string) => boolean

Parameters

Returns

boolean - returns true if string starts with 'cx' prefix.

Example

// Returns true if string starts with 'cx' prefix
const value = IconHexadecimal.isCxPrefix('cxc248ee72f58f7ec0e9a382379d67399f45b596c7')

static add0xPrefix()

Add '0x' prefix to string.

IconHexadecimal.add0xPrefix(str: string) => string

Parameters

Returns

string - a string with '0x' prefix.

Example

// Returns a string with '0x' prefix.
const value = IconHexadecimal.add0xPrefix('1234')

static addHxPrefix()

Add 'hx' prefix to string.

IconHexadecimal.addHxPrefix(str: string) => string

Parameters

Returns

string - a string with 'hx' prefix.

Example

// Returns a string with 'hx' prefix.
const value = IconHexadecimal.addHxPrefix('902ecb51c109183ace539f247b4ea1347fbf23b5')

static addCxPrefix()

Add 'cx' prefix to string.

IconHexadecimal.addCxPrefix(str: string) => string

Parameters

Returns

string - a string with 'cx' prefix.

Example

// Returns a string with 'cx' prefix.
const value = IconHexadecimal.addCxPrefix('c248ee72f58f7ec0e9a382379d67399f45b596c7')

static remove0xPrefix()

Remove '0x' prefix from string.

IconHexadecimal.remove0xPrefix(str: string) => string

Parameters

Returns

string - a string without '0x' prefix.

Example

// Returns a string without '0x' prefix.
const value = IconHexadecimal.remove0xPrefix('0x61')

static removeHxPrefix()

Remove 'hx' prefix from string.

IconHexadecimal.removeHxPrefix(str: string) => string

Parameters

Returns

string - a string without 'hx' prefix.

Example

// Returns a string without 'hx' prefix.
const value = IconHexadecimal.removeHxPrefix('hx902ecb51c109183ace539f247b4ea1347fbf23b5')

static removeCxPrefix()

Remove 'cx' prefix from string.

IconHexadecimal.removeCxPrefix(str: string) => string

Parameters

Returns

string - a string without 'cx' prefix.

Example

// Returns a string without 'cx' prefix.
const value = IconHexadecimal.removeCxPrefix('cxc248ee72f58f7ec0e9a382379d67399f45b596c7')

IconService.IconValidator

IconValidator is a utility module which contains validation functions.

static isPrivateKey()

Check if input value is a private key type string.

IconValidator.isPrivateKey(privKey: any) => boolean

Parameters

Returns

boolean - Returns true if the input value is a private key type string.

Example

// Returns true if the input value is a private key type string.
const isPrivateKey = IconValidator.isPrivateKey('7abca1...20a9f1')

static isEoaAddress()

Check if input value is a EOA address type string.

IconValidator.isEoaAddress(address: any) => boolean

Parameters

Returns

boolean - Returns true if the input value is a EOA address type string.

Example

// Returns true if the input value is a EOA address type string.
const isEoaAddress = IconValidator.isEoaAddress('hxca12a...209f1')

static isScoreAddress()

Check if input value is a SCORE address type string.

IconValidator.isScoreAddress(address: any) => boolean

Parameters

Returns

boolean - Returns true if the input value is a SCORE address type string.

Example

// Returns true if the input value is a SCORE address type string.
const isScoreAddress = IconValidator.isScoreAddress('cx1b32a...99f01')

static isAddress()

Check if input value is a EOA or SCORE address type string.

IconValidator.isAddress(address: any) => boolean

Parameters

Returns

boolean - Returns true if the input value is a EOA or SCORE address type string.

Example

// Returns true if the input value is a EOA or SCORE address type string.
const isAddress = IconValidator.isAddress('cx1b32a...99f01')

BlockMonitorSpec

It's used in IconService.monitorBlock()

Constructor

Create BlockMonitorSpec for monitoring events of the contracts.

new BlockMonitorSpec(
  height: BigNumber,
  eventFilters?: EventFilter[]
)

Parameters

• EventFilter

EventMonitorSpec

It's used in IconService.monitorEvent()

Constructor

Create EventMonitorSpec for monitoring events of the contract.

new EventMonitorSpec(
  height: BigNumber,
  eventFilter: EventFilter|EventFilter[],
  logs?: boolean,
  progressInterval?: number,
);

Parameters

BTPMonitorSpec

It's used in IconService.monitorBTP()

Constructor

Create BTPMonitorSpec for monitoring events of the BTP blocks

new BTPMonitorSpec(
  height: BigNumber,
  networkID: BigNumber,
  proofFlag: boolean,
  progressInterval: number
);

Parameters

EventFilter

Constructor

Create EventFilter for monitoring events from the contract.

new EventFilter(
  event: string,
  addr?: string,
  indexed?: string[],
  data?: string[]
);

Parameters

If the addr is omitted(as undefined) then events of all contracts will be monitored. You may use null for ignoring values for indexed and data parameters.

Example

const filter = new EventFilter(
  "BTPEvent(str,int,str,str)",
  undefined,
  [ null, 0x1 ]
)

Monitor

Handle to the monitor returned by some APIs

• IconService.monitorEvent
• IconService.monitorBlock
• IconService.monitorBTP

close()

It closes opened monitor. Then, it stops sending notifications and reporting progress.

Error cases

There are 6 types of error cases. Details are as below:

References

• ICON JSON-RPC API v3
• IRC2 Specification