icon-sdk-js

!node-current
---
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]
* [IconService.IconWallet][IconWallet]
* [IconService.IconBuilder][IconBuilder]
* [IconService.IconBuilder.IcxTransactionBuilder][IcxTransactionBuilder]
* [IconService.IconBuilder.MessageTransactionBuilder][MessageTransactionBuilder]
* [IconService.IconBuilder.DeployTransactionBuilder][DeployTransactionBuilder]
* [IconService.IconBuilder.CallTransactionBuilder][CallTransactionBuilder]
* [IconService.IconBuilder.DepositTransactionBuilder][DepositTransactionBuilder]
* [IconService.IconBuilder.CallBuilder][CallBuilder]
* [IconService.SignedTransaction][SignedTransaction]
* [IconService.HttpProvider][HttpProvider]
* [IconService.IconAmount][IconAmount]
* [IconService.IconConverter][IconConverter]
* [IconService.IconHexadecimal][IconHexadecimal]
* [IconService.IconValidator][IconValidator]
* [Error cases][Error cases]
* [References][References]

Installation

$3

Install icon-sdk-js module using yarn.

``bash
yarn add icon-sdk-js
`

Import icon-sdk-js module.

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

$3

Install icon-sdk-js module using yarn,

`bash
yarn add icon-sdk-js
`

or using CDN.

`html

`

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

`javascript
import IconService from 'icon-sdk-js';
`

$3

Install icon-sdk-js module using yarn,

`bash
yarn add icon-sdk-js
`

Then, import icon-sdk-js/build/icon-sdk-js.web.min.js module.
`javascript
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:

| Module | Description |
| ------------- | ----------- |
| [IconService] | Class which provides APIs to communicate with ICON nodes |
| [IconService.IconWallet] | Class which provides EOA functions. |
| [IconService.IconBuilder] | Builder class for transaction object. |
| [IconService.SignedTransaction] | Class representing the signed transaction object. |
| [IconService.HttpProvider] | Class representing HTTP-based provider |
| [IconService.IconAmount] | Class which provides unit conversion functions. |
| [IconService.IconConverter] | Util module contains conversion functions. |
| [IconService.IconHexadecimal] | Util module contains hex-prefix functions. |
| [IconService.IconValidator] | Util module contains validator functions. |

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.

$3

Creates an instance of IconService.

`javascript
new IconService(provider: HttpProvider)
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| provider | HttpProvider | [HttpProvider] instance. |

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

$3

Get the total number of issued coins.

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| height | string\|BigNumber\|number | block height. |

#### 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
`javascript
/ Returns the total number of issued coins. /
const totalSupply = await iconService.getTotalSupply().execute();
`




$3

Get the balance of the address.

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| address | string | an EOA address. |
| height | string\|BigNumber\|number | block height. |

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

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

$3

Get the block information by block height.

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

#### Parameters

| Parameter | Type | Description |
|-----------|-----------------------|----------------------------|
| value | number, BigNumber | the height value of block. |

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

#### Example
`javascript
// Returns block information
const block = await iconService.getBlockByHeight(1000).execute();
`

$3

Get the block information by block hash.

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

#### Parameters

| Parameter | Type | Description |
|-----------|----------|---------------|
| value | string | a block hash. |

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

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

$3

Get the latest block information.

`javascript
.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
`javascript
// Returns block information
const block = await iconService.getLastBlock().execute();
`




$3

Get the SCORE API list.

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| address | string | a SCORE address. |
| height | string\|BigNumber\|number | block height. |

#### 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
`javascript
// 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'));
`

$3

Get the SCORE status

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| address | string | a SCORE address. |
| height | string\|BigNumber\|number | block height. |

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

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

$3

Get the transaction information.

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| hash | string | a transaction hash. |

#### 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][icx_getTransactionByHash].

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

$3

Get the result of transaction by transaction hash.

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| hash | string | a transaction hash. |

#### 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][icx_getTransactionResult].

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

$3

Get the transaction trace. newly added from ICON2

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| hash | string | |

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

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

$3

Send a transaction that changes the states of address.

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| signedTransaction | SignedTransaction | an instance of [SignedTransaction] class. |

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

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

$3

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

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| transaction | IcxTransaction | an instance of [IcxTransaction | MessageTransaction | DepositTransaction | DeployTransaction | CallTransaction] class. |

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

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

$3

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

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| signedTransaction | SignedTransaction | an instance of [SignedTransaction] class. |

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

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

$3

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

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| hash | string | transaction hash |

#### 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][icx_getTransactionResult].

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

$3

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…

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| hash | string | The hash value of the data to retrieve |

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

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

$3

Get block header for specified height.

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| height | string\|BigNumber | The height of the block in hex string |

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

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

$3

Get votes for the block specified by height.

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| height | string\|BigNumber | The height of the block in hex string |

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

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

$3

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

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| hash | string | The hash value of the block including the result. |
| index | string\|BigNumber | Index of the receipt in the block.
0 for the first. |

#### 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
`javascript
// Returns the tx hash of transaction.
const data = await iconService.getProofForResult(hash, index).execute();
`

$3

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

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| hash | string | The hash value of the block including the result. |
| index | string \| BigNumber | Index of the receipt in the block.
0 for the first. |
| events | Array | List of indexes of the events in the receipt. |

#### 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
`javascript
// Returns the tx hash of transaction.
const data = await iconService.getProofForEvents(hash, index, events).execute();
`

$3

Get BTP network information.

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| id | string | BigNumber | Network ID |
| height | string\|BigNumber | Main block height(Optional) |

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

#### Example
`javascript
const data = await iconService.getBTPNetworkInfo(id, height).execute();
`

$3

Get BTP network type information.

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| id | string | BigNumber | Network ID |
| height | string\|BigNumber | Main block height(Optional) |

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

#### Example
`javascript
const data = await iconService.getBTPNetworkTypeInfo(id, height).execute();
`

$3

Get BTP messages.

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| networkID | string | BigNumber | BTP network ID |
| height | string\|BigNumber | Main block height |

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

#### Example
`javascript
const data = await iconService.getBTPMessages(networkID, height).execute();
`

$3

Get BTP block header

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| networkID | string | BigNumber | BTP network ID |
| height | string\|BigNumber | Main block height |

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

#### Example
`javascript
const data = await iconService.getBTPHeader(networkID, height).execute();
`

$3

Get BTP block proof

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| networkID | string | BigNumber | BTP network ID |
| height | string\|BigNumber | Main block height |

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

#### Example
`javascript
const data = await iconService.getBTPProof(networkID, height).execute();
`

$3

Get source network information

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

#### Parameters
None

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

#### Example
`javascript
const data = await iconService.getBTPSourceInformation().execute();
`

$3

Get basic network Information

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

#### Parameters
None

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

#### Example
`javascript
const data = await iconService.getNetworkInfo().execute();
`

$3

Calls external function of SCORE.

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| call | Call | an instance of Call class builded by [CallBuilder]. |

#### 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
`javascript
// Returns the value returned by the executed SCORE function.
const result = await iconService.call(call).execute();
`

$3

Monitor events for every blocks.

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

#### Parameters

| Parameter | Type | Description |
|:------------|:------------------------------------|:------------------------------------|
| monitorSpec | BlockMonitorSpec | Specification for monitoring events |
| ondata | function(event:BlockNotification) | Callback for receiving events |
| onerror | function(err:any) | Callback for receiving the error |
| onprogress | function(height:BigInteger) | Callback for receiving the progress |

* BlockMonitorSpec
* [BlockNotification]

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

$3

Monitor events from the SCORE.

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

#### Parameters

| Parameter | Type | Description |
|:------------|:------------------------------------|:------------------------------------|
| monitorSpec | EventMonitorSpec | Specification for monitoring events |
| ondata | function(event:EventNotification) | Callback for receiving events |
| onerror | function(err:any) | Callback for receiving the error |
| onprogress | function(height:BigInteger) | Callback for receiving the progress |

* EventMonitorSpec
* [EventNotification]

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

#### Example

`javascript
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();
`

$3

Monitor BTP events related with the network

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

#### Parameters

| Parameter | Type | Description |
|:------------|:----------------------------------|:------------------------------------|
| monitorSpec | BTPMonitorSpec | Specification for monitoring events |
| ondata | function(event:BTPNotification) | Callback for receiving events |
| onerror | function(err:any) | Callback for receiving the error |
| onprogress | function(height:BigInteger) | Callback for receiving the progress |

* BTPMonitorSpec
* [BTPNotification]

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

#### Example

`javascript
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.

$3

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

`javascript
new Wallet(privKey: string, pubKey: string)
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| privKey | string | a private key. |
| pubKey | string | a public key. |

$3

Creates an instance of Wallet class.

`javascript
IconWallet.create() => Wallet
`
#### Parameters

None

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

#### Example
`javascript
// Creates an instance of Wallet.
const wallet = IconWallet.create();
`

$3

Import existing wallet using private key.

`javascript
IconWallet.loadPrivateKey(privKey: string) => Wallet
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| privKey | string | a private key. |

#### Returns
Wallet - a Wallet instance.

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

$3

Import existing wallet using keystore object.

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

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| keystore | object, string | the keystore object (or stringified object.) |
| password | string | the password of keystore object. |
| nonStrict (optional) | boolean | set whether checking keystore file case-insensitive or not. _(affects when keystore param is string.)_ |

#### Returns
Wallet - a Wallet instance.

#### Example
`javascript
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)
`

$3

Get keystore object of an instance of a Wallet class.

`javascript
.store(password: string, opts?: object) => object
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| password | string | a new password for encryption. |
| opts (optional) | object | the custom options for encryption. |

#### Returns
object - a keystore object.

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

$3

Generate signature string by signing transaction object.

`javascript
.sign(data: Buffer) => string
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| data | Buffer | the serialized transaction object. |

#### Returns
string - a signature string.

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

$3

Get a private key of Wallet instance.

`javascript
.getPrivateKey() => string
`
#### Parameters

None

#### Returns
string - a private key.

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

$3

Get a public key of Wallet instance.

`typescript
getPublicKey(compressed = false): string
`
#### Parameters

| Parameter | Type | Description |
|------------|-----------|---------------|
| compressed | boolean | compressed flag |

#### Returns
string - a public key.

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

$3

Get an address of Wallet instance.

`javascript
.getAddress() => string
`
#### Parameters

None

#### Returns
string - an EOA address.

#### Example
`javascript
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:

| Module | Description |
| ------------- | ----------- |
| [IcxTransactionBuilder] | Builder class for IcxTransaction instance, which is for sending ICX. |
| [MessageTransactionBuilder] | Builder class for MessageTransaction instance, which is for sending message data. Extends IcxTransactionBuilder class. |
| [DeployTransactionBuilder] | Builder class for DeployTransaction instance, which is for deploying SCORE. Extends IcxTransactionBuilder class. |
| [CallTransactionBuilder] | Builder class for CallTransaction instance, which is for invoking a state-transition function of SCORE. Extends IcxTransactionBuilder class. |
| [DepositTransactionBuilder] | Builder class for DepositTransaction instance, which is for depositing to SCORE(or withdrawing from SCORE). Extends IcxTransactionBuilder class. |
| [CallBuilder] | Builder class for Call instance, which is for invoking a read-only function of SCORE. |

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:

| Parameter | Description |
| ------------- | ----------- |
| to | An EOA address to receive coins, or SCORE address to execute the transaction. |
| from | An EOA address that created the transaction |
| value (optional) | Amount of ICX coins in loop to transfer. When ommitted, assumes 0. (1 icx = 10 ^ 18 loop) |
| stepLimit | Maximum step allowance that can be used by the transaction. |
| nid | Network ID ("0x1" for Mainnet, "0x2" for Testnet, etc) |
| nonce | An arbitrary number used to prevent transaction hash collision. |
| version | Protocol version ("0x3" for V3) |
| timestamp | Transaction creation time. timestamp is in microsecond. |

$3

Creates an instance of IcxTransactionBuilder class.

`javascript
new IcxTransactionBuilder()
`
#### Parameters

None

$3

Setter method of 'to' property.

`javascript
.to(to: string) => IcxTransactionBuilder
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| to | string | an EOA or SCORE address. |

#### Returns
IcxTransactionBuilder - Returns an instance of itself

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

$3

Setter method of 'from' property.

`javascript
.from(from: string) => IcxTransactionBuilder
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| from | string | an EOA address. |

#### Returns
IcxTransactionBuilder - Returns an instance of itself

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

$3

Setter method of 'value' property.

`javascript
.value(value: string|BigNumber|number) => IcxTransactionBuilder
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| value | string, BigNumber, number | the sending amount of ICX in loop unit. |

#### Returns
IcxTransactionBuilder - Returns an instance of itself

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

$3

Setter method of 'stepLimit' property.

`javascript
.stepLimit(stepLimit: string|BigNumber|number) => IcxTransactionBuilder
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| stepLimit | string, BigNumber, number | the amount of step limit. |

#### Returns
IcxTransactionBuilder - Returns an instance of itself

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

$3

Setter method of 'nid' property.

`javascript
.nid(nid: string|BigNumber|number) => IcxTransactionBuilder
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| nid | string, BigNumber, number | a network ID. |

#### Returns
IcxTransactionBuilder - Returns an instance of itself

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

$3

Setter method of 'nonce' property.

`javascript
.nonce(nonce: string|BigNumber|number) => IcxTransactionBuilder
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| nonce | string, BigNumber, number | a nonce value. |

#### Returns
IcxTransactionBuilder - Returns an instance of itself

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

$3

Setter method of 'version' property.

`javascript
.version(version: string|BigNumber|number) => IcxTransactionBuilder
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| version | string, BigNumber, number | the version value. |

#### Returns
IcxTransactionBuilder - Returns an instance of itself

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

$3

Setter method of 'timestamp' property.

`javascript
.timestamp(version: string|BigNumber|number) => IcxTransactionBuilder
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| timestamp | string, BigNumber, number | timestamp value. (microsecond) |

#### Returns
IcxTransactionBuilder - Returns an instance of itself

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

$3

Returns an IcxTransaction instance which contains parameter you set.

`javascript
.build() => IcxTransaction
`
#### Parameters

None

#### Returns
IcxTransaction - Returns an IcxTransaction instance.

#### Example
`javascript
// 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:

| Parameter | Description |
| ------------- | ----------- |
| data | A message data. Data type of the data should be lowercase hex string prefixed with '0x'. |
| dataType | Data type of data. Fixed string message is in value. |

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

$3

Creates an instance of MessageTransactionBuilder class.

`javascript
new MessageTransactionBuilder()
`
#### Parameters

None

$3

Setter method of 'data' property.

`javascript
.data(data: string) => MessageTransactionBuilder
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| data | string | the data (hex string) to send. |

#### Returns
MessageTransactionBuilder - Returns an instance of itself

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

$3

Returns an MessageTransaction instance which contains parameter you set.

`javascript
.build() => MessageTransaction
`
#### Parameters

None

#### Returns
MessageTransaction - Returns an MessageTransaction instance.

#### Example
`javascript
// 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:

| Parameter | Description |
| ------------- | ----------- |
| data | A deploy object data. It contains 3 parameters: 1) contentType - Mime-type of the content. 2) content - Compressed SCORE data. 3) params (optional) - Function parameters delivered to on_install() or on_update() |
| dataType | Data type of data. Fixed string deploy is in value. |

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

$3

Creates an instance of DeployTransactionBuilder class.

`javascript
new DeployTransactionBuilder()
`
#### Parameters

None

$3

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

`javascript
.contentType(contentType: string) => DeployTransactionBuilder
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| contentType | string | the content type of content |

#### Returns
DeployTransactionBuilder - Returns an instance of itself

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

$3

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

`javascript
.content(content: string) => DeployTransactionBuilder
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| content | string | the content to deploy. |

#### Returns
DeployTransactionBuilder - Returns an instance of itself

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

$3

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

`javascript
.params(params: object) => DeployTransactionBuilder
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| params | object | Function parameters delivered to on_install() or on_update(). |

#### Returns
DeployTransactionBuilder - Returns an instance of itself

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

$3

Returns an DeployTransaction instance which contains parameter you set.

`javascript
.build() => DeployTransaction
`
#### Parameters

None

#### Returns
DeployTransaction - Returns an DeployTransaction instance.

#### Example
`javascript
// 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:

| Parameter | Description |
| ------------- | ----------- |
| data | An object data for calling method. It contains 2 parameters: 1) method - The method name of SCORE API. 2) params (optional) - The input params for method |
| dataType | Data type of data. Fixed string call is in value. |

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

$3

Creates an instance of CallTransactionBuilder class.

`javascript
new CallTransactionBuilder()
`
#### Parameters

None

$3

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

`javascript
.method(method: string) => CallTransactionBuilder
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| method | string | the method name of SCORE API. |

#### Returns
CallTransactionBuilder - Returns an instance of itself

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




$3

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

`javascript
.params(params: object) => CallTransactionBuilder
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| params | object | the input params for method. |

#### Returns
CallTransactionBuilder - Returns an instance of itself

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




$3

Returns an CallTransaction instance which contains parameter you set.

`javascript
.build() => CallTransaction
`
#### Parameters

None

#### Returns
CallTransaction - Returns an CallTransaction instance.

#### Example
`javascript
// 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:

| Parameter | Description |
| ------------- | ----------- |
| data | An object data for depositing to SCORE. It contains 2 parameters: 1) action - Whether to deposit or withdraw. When making a withdrawal, id is required. 2) id (optional) - deposit id to withdraw. needed when withdraw deposit |
| dataType | Data type of data. Fixed string deposit is in value. |

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

$3

Creates an instance of DepositTransactionBuilder class.

`javascript
new DepositTransactionBuilder()
`
#### Parameters

None

$3

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

`javascript
.action(action: string) => DepositTransactionBuilder
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| action | string | Whether to deposit or withdraw. (add or withdraw) |

#### Returns
DepositTransactionBuilder - Returns an instance of itself

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




$3

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

`javascript
.id(params: string) => DepositTransactionBuilder
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| id | string | Deposit id to withdraw |

#### Returns
DepositTransactionBuilder - Returns an instance of itself

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




$3

Returns an DepositTransaction instance which contains parameter you set.

`javascript
.build() => DepositTransaction
`
#### Parameters

None

#### Returns
DepositTransaction - Returns an DepositTransaction instance.

#### Example
`javascript
// 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:

| Parameter | Description |
| ------------- | ----------- |
| to | a SCORE address to execute the call. |
| data | an object data for calling method. It contains 2 parameters: 1) method - The method name of SCORE API. 2) params (optional) - The input params for method |
| dataType | Data type of data. Fixed string call is in value. |

$3

Creates an instance of CallBuilder class.

`javascript
new CallBuilder()
`
#### Parameters

None

$3

Setter method of 'to' property.

`javascript
.to(to: string) => CallBuilder
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| to | string | a SCORE address. |

#### Returns
CallBuilder - Returns an instance of itself

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




$3

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

`javascript
.method(method: string) => CallBuilder
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| method | string | the method name of SCORE API. |

#### Returns
CallBuilder - Returns an instance of itself

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




$3

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

`javascript
.params(params: object) => CallBuilder
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| params | object | the input params for method. |

#### Returns
CallBuilder - Returns an instance of itself

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




$3

Returns an Call instance which contains parameter you set.

`javascript
.build() => Call
`
#### Parameters

None

#### Returns
Call - Returns an Call instance.

#### Example
`javascript
// 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.

$3

Creates an instance of SignedTransaction class.

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| transaction | IcxTransaction, MessageTransaction, CallTransaction, DeployTransaction | a transaction object. |
| wallet | Wallet | wallet instance used for signing. |

$3

Get a signature string.

`javascript
.getSignature() => string
`

#### Parameters

None

#### Returns

string - a signature string.

#### Example
`javascript
/ Returns the signature /
const signature = new SignedTransaction(icxTransaction, wallet).getSignature()
// 'YV3eNgVjLFwXS65Bk...+lC90KgRBh7FtwE='
`

$3

Get a raw signed transaction object.

`javascript
.getProperties() => object
`

#### Parameters

None

#### Returns

object - the raw signed transaction object.

#### Example
`javascript
/ 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=',
// };
`




$3

Get a raw transaction object of transaction property.

`javascript
.getRawTransaction() => object
`

#### Parameters

None

#### Returns

object - the raw transaction object of transaction property.

#### Example
`javascript
/ 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.




$3

Creates an instance of HttpProvider class.

`javascript
new HttpProvider(url: string)
`

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| url | string | ICON node url |




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.)

$3

Creates an instance of IconAmount class.

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

#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| value | string, BigNumber, number | the value of amount. |
| digit | string, BigNumber, number | the digit of unit. |

> 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.

$3

Creates an instance of IconAmount class.

`javascript
IconAmount.of(value: string|BigNumber|number, digit: string|BigNumber|number) => IconAmount
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| value | string, BigNumber, number | the value of amount. |
| digit | string, BigNumber, number | the digit of unit. |

> 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
`javascript
// Returns IconAmount instance
const iconAmount = IconAmount.of('2', IconAmount.Unit.ICX);
`




$3

Converts value property into string

`javascript
.toString() => string
`
#### Parameters

None

#### Returns
string - The stringified value property of IconAmount instance.

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




$3

Get digit property.

`javascript
.getDigit() => number
`
#### Parameters

None

#### Returns
number - The digit property of IconAmount instance.

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




$3

Get value property converted into loop unit.

`javascript
.toLoop() => BigNumber
`
#### Parameters

None

#### Returns
BigNumber - The value property converted into loop unit.

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




$3

Converts value property into custom digit

`javascript
.convertUnit(digit: string|BigNumber|number) => IconAmount
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| digit | string, BigNumber, number | the digit of unit. |

#### Returns
IconAmount - The IconAmount instance converted into custom digit.

#### Example
`javascript
// 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.

$3

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

`javascript
IconConverter.fromUtf8(value: string) => string
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| value | string | an UTF-8 text string. |

#### Returns
string - a hex string with '0x' prefix

#### Example
`javascript
// Returns hex string
const value = IconConverter.fromUtf8('hello')
`




$3

Converts string, hex string or BigNumber value to number.

`javascript
IconConverter.toNumber(value: string|BigNumber) => number
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| value | string, BigNumber | a string, hex string or BigNumber type value |

#### Returns
number - a value converted to number type.

#### Example
`javascript
// Returns number value
const value = IconConverter.toNumber('123')
`

$3

Converts string, hex string or number value to BigNumber.

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

`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| value | string, number | a string, hex string or number type value |

#### Returns
BigNumber - a value converted to BigNumber type.

#### Example
`javascript
// Returns BigNumber value
const value = IconConverter.toBigNumber('123')
`

$3

Converts string, number or BigNumber value to hex string.

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

`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| value | string, number, BigNumber | a string, number or BigNumber type value |

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

#### Example
`javascript
// Returns hex string
const value = IconConverter.toHex('123')
`

$3

Converts transaction object to raw transaction object.

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

`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| transaction | IcxTransaction, MessageTransaction, CallTransaction, DeployTransaction | a transaction object |

#### Returns
object - a raw transaction object.

#### Example
`javascript
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.

$3

Check whether string starts with '0x' prefix.

`javascript
IconHexadecimal.is0xPrefix(str: string) => boolean
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| str | string | a string |

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

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

$3

Check whether string starts with 'hx' prefix.

`javascript
IconHexadecimal.isHxPrefix(str: string) => boolean
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| str | string | a string |

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

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

$3

Check whether string starts with 'cx' prefix.

`javascript
IconHexadecimal.isCxPrefix(str: string) => boolean
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| str | string | a string |

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

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

$3

Add '0x' prefix to string.

`javascript
IconHexadecimal.add0xPrefix(str: string) => string
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| str | string | a string |

#### Returns
string - a string with '0x' prefix.

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

$3

Add 'hx' prefix to string.

`javascript
IconHexadecimal.addHxPrefix(str: string) => string
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| str | string | a string |

#### Returns
string - a string with 'hx' prefix.

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

$3

Add 'cx' prefix to string.

`javascript
IconHexadecimal.addCxPrefix(str: string) => string
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| str | string | a string |

#### Returns
string - a string with 'cx' prefix.

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

$3

Remove '0x' prefix from string.

`javascript
IconHexadecimal.remove0xPrefix(str: string) => string
`
#### Parameters

| Parameter | Type | Description |
| ------------- | ----------- | ----------- |
| str | string | a string |

#### Returns
string - a string without '0x' prefix.

#### Example
``javascript
// Returns a string