DocStrap Class: Wallet

new Wallet(baseWallet)

Create a Wallet

Parameters:

Name	Type	Description
`baseWallet`	Object	underlying wallet object

Source:

wallet/index.js, line 22

Methods

<static> create()

Factory method to create a new wallet with a newly generated private key

Source:

wallet/index.js, line 28

Returns:

Type: Wallet

<static> fromKeyStoreFile(keyStorePath, password)

Factory method to create a wallet from the keystore file

Parameters:

Name	Type	Description
`keyStorePath`	String
`password`	String

Source:

wallet/index.js, line 60

Returns:

Type: Wallet

<static> fromKeyStoreObj(keyStoreObj, password)

Factory method to create a wallet from the keystore object

Parameters:

Name	Type	Description
`keyStoreObj`	Object \| String
`password`	String

Source:

wallet/index.js, line 49

Returns:

Type: Wallet

<static> fromPrivateKey(privateKeyString)

Factory method to create a wallet from the specified private key

Parameters:

Name	Type	Description
`privateKeyString`	String

Source:

wallet/index.js, line 38

Returns:

Type: Wallet

act(scoreAddress)

Return ACT score object with the specified score address

Parameters:

Name	Type	Description
`scoreAddress`	String	address of score

Source:

wallet/index.js, line 90

Returns:

score object of ACT

Type: ACT

<async> call(to, method, params)

Call a smart contract's external function for querying

Parameters:

Name	Type	Description
`to`	String
`method`	String
`params`	Object

Source:

wallet/index.js, line 328

Returns:

Type: Promise.<String>

<async> callContractTx(contractAddress, contractMethod, methodParams)

Send a transaction for calling a smart contract's method

Parameters:

Name	Type	Description
`contractAddress`	String
`contractMethod`	String
`methodParams`	Object

Source:

wallet/index.js, line 281

Returns:

hash of transacgtion

Type: Promise.<String>

<async> depositFeeSharing(contractAddress, amt)

deposit for fee sharing

Parameters:

Name	Type	Description
`contractAddress`	String
`amt`	Number

Source:

wallet/index.js, line 391

Returns:

hash of transaction

Type: Promise.<String>

donation(scoreAddress)

Return Donation score object with the specified score address

Parameters:

Name	Type	Description
`scoreAddress`	String	address of score

Source:

wallet/index.js, line 99

Returns:

score object of Donation

Type: Donation

getAddress()

Get the wallet address

Source:

wallet/index.js, line 160

Returns:

Type: Buffer

getAddressString()

Get the wallet address string

Source:

wallet/index.js, line 169

Returns:

Type: String

<async> getBalance()

Get balance of the wallet

Source:

wallet/index.js, line 235

Returns:

balance of the wallet owner

Type: Promise.<String>

<async> getBlockByHash(height)

Get block information by hash

Parameters:

Name	Type	Description
`height`	String	hash of block

Source:

wallet/index.js, line 217

Returns:

block information

Type: Promise.<Object>

<async> getBlockByHeight(height)

Get block information by height

Parameters:

Name	Type	Description
`height`	Number \| String	height of block

Source:

wallet/index.js, line 207

Returns:

block information

Type: Promise.<Object>

<async> getContractApi(address)

Get the smart contract's external API list

Parameters:

Name	Type	Description
`address`	String

Source:

wallet/index.js, line 337

Returns:

Type: Promise.<Object>

getEndPoint()

get endpoint

Source:

wallet/index.js, line 197

Returns:

endpoint information

Type: String

<async> getLastBlock()

Get a last block information

Source:

wallet/index.js, line 226

Returns:

block information

Type: Promise.<Object>

getPrivateKey()

Get the private key of the wallet

Source:

wallet/index.js, line 125

Returns:

Type: Buffer

getPrivateKeyString()

Get the private key string of the wallet

Source:

wallet/index.js, line 134

Returns:

Type: String

getPublicKey()

Get a public key of the wallet

Source:

wallet/index.js, line 143

Returns:

Type: Buffer

getPublicKeyString()

Get a public key string of the wallet

Source:

wallet/index.js, line 152

Returns:

Type: String

<async> getScoreStatus()

Returns symbol

Source:

wallet/index.js, line 417

Returns:

Type: Promise.<String>

<async> getTotalSupply()

Get total supply of ICX

Source:

wallet/index.js, line 244

Returns:

total supply of underlying network

Type: Promise.<String>

<async> getTransactionByHash(txHash)

Get the transaction information by txHash

Parameters:

Name	Type	Description
`txHash`	String

Source:

wallet/index.js, line 380

Returns:

Type: Promise.<Object>

<async> getTransactionResult(txHash, timeout)

Get the transaction result requested by transaction hash

Parameters:

Name	Type	Default	Description
`txHash`	String
`timeout`	Number	0	seconds to timeout. if not specified, it will be set to the default value of 0

Source:

wallet/index.js, line 348

Returns:

Type: Promise.<Object>

<async> installContract(contractPath, installParams)

Install a smart contract on the underlying blockchain

Parameters:

Name	Type	Description
`contractPath`	String
`installParams`	Object

Source:

wallet/index.js, line 296

Returns:

txHash

Type: Promise.<String>

setEndPoint(name)

set endpoint

Parameters:

Name	Type	Description
`name`	String	'mainnet' \| 'testnet'

Source:

wallet/index.js, line 188

stg(scoreAddress)

Return STG score object with the specified score address

Parameters:

Name	Type	Description
`scoreAddress`	String	address of score

Source:

wallet/index.js, line 80

Returns:

score object of STG

Type: STG

todaysidol(scoreAddress)

Return TodaysIdol score object with the specified score address

Parameters:

Name	Type	Description
`scoreAddress`	String	address of score

Source:

wallet/index.js, line 108

Returns:

score object of TodaysIdol

Type: ACT

toKeyStoreObj(password)

Convert a wallet to key store object

Parameters:

Name	Type	Description
`password`	String	password for the wallet

Source:

wallet/index.js, line 179

Returns:

Type: Object

<async> transferCoin(to, value)

Transfer coins

Parameters:

Name	Type	Description
`to`	String	address of recipient
`value`	Number	value to transfer

Source:

wallet/index.js, line 255

Returns:

hash of transaction

Type: Promise.<String>

<async> transferMessage(to, msg)

Transafer a message

Parameters:

Name	Type	Description
`to`	String	address of recipent
`msg`	String	message to transfer

Source:

wallet/index.js, line 266

Returns:

hash of transaction

Type: Promise.<String>

<async> updateContract(contractAddress, contractPath, updateParams)

Update the smart contract on the underlying blockchain

Parameters:

Name	Type	Description
`contractAddress`	type
`contractPath`	type
`updateParams`	type

Source:

wallet/index.js, line 310

Returns:

txHash

Type: Promise.<String>

<async> withdrawFeeSharing(contractAddress, amt)

withdraw the deposit for fee sharing

Parameters:

Name	Type	Description
`contractAddress`	String
`amt`	Number

Source:

wallet/index.js, line 405

Returns:

hash of transaction

Type: Promise.<String>

wok(scoreAddress)

Return WOK score object with the specified score address

Parameters:

Name	Type	Description
`scoreAddress`	String	address of score

Source:

wallet/index.js, line 117

Returns:

score object of WOK

Type: WOK