BridgeJS - Documentation

Constructor

new BridgeJS(endpoint, pkey)

Source:

bridge.js, line 31

Parameters:

Name	Type	Description
`endpoint`	string	The Url to the node
`pkey`	string	The private key of the wallet

Methods

(static) setProvider(endpointopt, pkeyopt)

Source:

bridge.js, line 65

Initial the SDK

Parameters:

Name	Type	Attributes	Default	Description
`endpoint`	string	<optional>	`https://bridge.tomochain.com`	The Url to the node
`pkey`	string	<optional>	`random`	The private key of the coinbase

(async) getDepositTransaction(wrap) → {Object}

Source:

bridge.js, line 156

Get latest deposit transaction

Parameters:

Name Type Description

wrap

Object

The wrap information

Properties

Name	Type	Description
`tokenSymbol`	string	The token symbol
`userAddress`	string	The user address

Returns:

Transaction object(inner and outter networks)

Type: Object

(async) getTransactions(object) → {Object}

Source:

bridge.js, line 407

Get depositing and withdrawal transactions filtering by tokenSymbol

Parameters:

Name Type Description

object

Object

Input object

Properties

Name	Type	Description
`tokenSymbol`	String	Token symbol
`limit`	Number	Limit number of records per page
`page`	Number	Page number

Returns:

Transaction object(inner and outter networks)

Type: Object

(async) getUnwrapTransactions(object) → {Object}

Source:

bridge.js, line 362

Get withdrawal transactions

Parameters:

Name Type Description

object

Object

Input object

Properties

Name	Type	Description
`limit`	Number	Limit number of records per page
`page`	Number	Page number

wrap.userAddress

string

The user address

Returns:

Transaction object(inner and outter networks)

Type: Object

(async) getWithdrawTransaction(unwrap) → {Object}

Source:

bridge.js, line 194

Get latest withdraw transaction

Parameters:

Name Type Description

unwrap

Object

The unwrap information

Properties

Name	Type	Description
`tokenSymbol`	String	Token symbol

wrap.userAddress

string

The user address

Returns:

Transaction object(inner and outter networks)

Type: Object

(async) getWrapTransactions(object) → {Object}

Source:

bridge.js, line 317

Get depositing transactions

Parameters:

Name Type Description

object

Object

Input object

Properties

Name	Type	Description
`limit`	Number	Limit number of records per page
`page`	Number	Page number

wrap.userAddress

string

The user address

Returns:

Transaction object(inner and outter networks)

Type: Object

(async) unwrap(unwrap)

Source:

bridge.js, line 450

Unwrap TRC21 TOKEN

Parameters:

Name Type Description

unwrap

object

The unwrap information

Properties

Name	Type	Description
`tokenSymbol`	string	The token symbol
`amount`	string	The amount for unwrapping
`dest`	string	The destination address

(async) unwrapWatch(object) → {Object}

Source:

bridge.js, line 273

Watch withdrawal transaction

Parameters:

Name Type Description

object

Object

Input object

Properties

Name	Type	Description
`tokenSymbol`	String	Token symbol

Returns:

Transaction object(inner and outter networks)

Type: Object

(async) wrapGetAddress(wrap) → {Object}

Source:

bridge.js, line 113

Get depositing address

Parameters:

Name Type Description

wrap

object

The wrap information

Properties

Name	Type	Description
`tokenSymbol`	string	The token symbol
`userAddress`	string	The user address

Returns:

Depositing information object

Type: Object

(async) wrapWatch(object) → {Object}

Source:

bridge.js, line 231

Watch depositing transaction

Parameters:

Name Type Description

object

Object

Input object

Properties

Name	Type	Description
`tokenSymbol`	String	Token symbol

Returns:

Transaction object(inner and outter networks)

Type: Object