user - Documentation

This module allows you to access both personal information of the node runner. The module is accessed from the global variable user.
getKeys
1
user.getKeys()
Copied!
Gets the address of all keys stored on the keystore of the node.
Returns
Array<String>: A list of addresses.
Example
JavaScript
Output
1
user.getKeys()
Copied!
1
[
2
   "os1qfrysysaawvjlgfz5ecqv569adkkw7sxudy36u",
3
   "os1wfx7vp8qfyv98cctvamqwec5xjrj48tpklxklh"
4
]
Copied!
getKey
1
user.getKey(addrOrIndex, [passphrase])
Copied!
Gets the private key of a key by its address or keystore index. If the key exists, it will be unlocked using the provided passphrase. If passphrase is not provided, an interactive prompt will be launched to ask for it.
Parameters
1.addrOrIndex - String|Number: The address or keystore index of the key
2.passphrase - String: (Optional) The passphrase to use to unlock the key. If not provided, you will be prompted to provide it. 
Returns
String: The base58 encoded private key.
Example
JavaScript
Output
1
user.getKey("os1qfrysysaawvjlgfz5ecqv569adkkw7sxudy36u")
Copied!
1
"wXVFmgEmKumxVnQGSnL67krnWkBj4Q...W711b7UnmARiUWtSNSJ6pVhmk1ppiPQPGrD8F3"
Copied!
getPublicKey
1
user.getPublicKey(addrOrIndex, [passphrase])
Copied!
Gets the public key of a key by its address or keystore index. If the key exists, it will be unlocked using the provided passphrase. If passphrase is not provided, an interactive prompt will be launched to ask for it.
Parameters
1.addrOrIndex - String|Number: The address or keystore index of the key
2.passphrase - String: (Optional) The passphrase to use to unlock the key. If not provided, you will be prompted to provide it. 
Returns
String: The base58 encoded public key.
Example
JavaScript
Output
1
chain.getPublicKey("os1qfrysysaawvjlgfz5ecqv569adkkw7sxudy36u")
Copied!
1
"48hpSpVR39MX947pHPSxRzKHoe65rLWzLWuC14sBU1n6tu7Jg5x"
Copied!
getNonce
1
user.getNonce(address, [height])
Copied!
Gets the current nonce of a user account.
Parameters
1.address - String: The address of the target user account.
2.height - String|Number: (Optional) The block height to query (Default: latest).
Returns
String: The current nonce.
Example
JavaScript
Output
1
user.getNonce("os1qfrysysaawvjlgfz5ecqv569adkkw7sxudy36u")
Copied!
1
"12"
Copied!
get
1
user.get(address, [height])
Copied!
Gets a user account by its address.
Parameters
1.address - String: The address of the target user account.
2.height - String|Number: (Optional) The block height to query (Default: latest).
Returns
Object: The account object balance - String: The native coin balance. nonce - String: The account nonce. stakes - Object: Staked coin information delegatorCommission - String: Commission to receive from delegators.
Example
JavaScript
Output
1
user.get("os1qfrysysaawvjlgfz5ecqv569adkkw7sxudy36u")
Copied!
1
{
2
  "balance": "1984872.35",
3
  "nonce": "91"
4
}
Copied!
getBalance
1
user.getBalance(address, [height])
Copied!
Gets the coin balance of a user account.
Parameters
1.address - String: The address of the target user account.
2.height - String|Number: (Optional) The block height to query (Default: latest).
Returns
String: The coin balance.
Example
JavaScript
Output
1
user.getBalance("os1qfrysysaawvjlgfz5ecqv569adkkw7sxudy36u")
Copied!
1
"12.3"
Copied!
getStakedBalance
1
user.getStakedBalance(address, [height])
Copied!
Gets the total amount of the native coin a user account has staked.
Parameters
1.address - String: The address of the target user account.
2.height - String|Number: (Optional) The block height to query (Default: latest).
Returns
String: The coin balance.
Example
JavaScript
Output
1
user.getStakedBalance("os1qfrysysaawvjlgfz5ecqv569adkkw7sxudy36u")
Copied!
1
"12.3"
Copied!
getValidator
1
user.getValidator(includePrivKey)
Copied!
Gets the node’s validator key.
Parameters
1.includePrivKey - Boolean: When true, the private key is included in the result.
Returns
Object: The validator key information.
Example
JavaScript
Output
1
user.getValidator(true)
Copied!
1
{
2
    "address": "os174vnayvd6teyzcfze5z7xsdmzg4kxk8l6jry7n",
3
    "privateKey": "wnrZynYB6837qB5mRN7V4To1MDB...nYZxaU9qQZPWhsFUPHefAdQEyRUu",
4
    "publicKey": "48J1NrCGHu4D8qkbsGYKRRaVhJgPt3gfFmgwmSeNjMcrsX1fuas",
5
    "tmAddress": "5CFFB08E0403EF88770EBAEA3499324779D0FB06"
6
}
Copied!
setCommission
1
user.setCommission(txObject, [signingKey | payloadOnly | [signingKey, payloadOnly]])
Copied!
Create a transaction that updates the delegator commission percentage of a validator account.
Parameters
1.txObject - Object: The transaction object
commission - String:  The percentage of reward to receive from delegators.
nonce - Number|String : The signing account’s next nonce. 
fee - String: The network fee to be paid by the signing account. 
timestamp - String: (optional) The unix timestamp of the transaction.
sig - String : (optional) The transaction signature. If not provided, the transaction will be signed using the signingKey.
2.signingKey - String: (optional) The private key to use to sign the transaction. 
3.payloadOnly - Boolean: (optional) When true, the transaction payload is returned instead of being sent to the network.
Returns
Object - The result object
hash - String: A 32 bytes transaction hash.
Example
1
user.setCommission({ 
2
    commission: "100",
3
    fee: "1"
4
}, user.getKey(accounts[0]))
Copied!
send
1
user.send(txObject, [signingKey | payloadOnly | [signingKey, payloadOnly]])
Copied!
Create a transaction that sends coins from the signers account to another account or repository.
Parameters
1.txObject - Object: The transaction object
value - Number|String:  The amount of native coin to be sent.
to - String: The address of the recipient; A user address or a repository name prefixed with r/.
nonce - Number|String : The signing account’s next nonce. 
fee - String: The network fee to be paid by the signing account. 
timestamp - String: (optional) The unix timestamp of the transaction.
sig - String : (optional) The transaction signature. If not provided, the transaction will be signed using the signingKey.
2.signingKey - String: (optional) The private key to use to sign the transaction. 
3.payloadOnly - Boolean: (optional) When true, the transaction payload is returned instead of being sent to the network.
Returns
Object - The result object
hash - String: A 32 bytes transaction hash.
Example
1
user.send({ 
2
    to: "os1qfrysysaawvjlgfz5ecqv569adkkw7sxudy36u", 
3
    value:"5000", 
4
    fee: "1" 
5
}, user.getKey(accounts[0]))
Copied!
JavaScript Console API - Previous
node
Next - JavaScript Console API
transaction
Last modified 1yr ago