Paralism Node RPC Interface

  2. Home
  4. Docs
  6. Paralism Node RPC Interface
  8. RPC Method List

RPC Method List

Node Basic RPC Method

help

Function: Query RPC methods supported by nodes

Parameter: None

Return result: List of RPC methods supported by the node

Call example:

{
  "method":"help",
  "params":[],
  "id":xxx
}

Sample return results:

{
  "result": "
  backupwallet <destination>
  encryptwallet <passphrase>
  getaccount <address>
  getaccountaddress <account>
  getaddressesbyaccount <account>
  getbalance [account] [minconf=1]
  getblockcount
  getblocknumber
  getcoininfo <hyperblockId> <chainId> <localblockId> 
  getconnectioncount
  getdifficulty
  getgenerate
  getinfo
  getnewaddress [account]
  getreceivedbyaccount <account> [minconf=1]
  getreceivedbyaddress <address> [minconf=1]
  gettransaction <txid>
  gettransactionaddr <txid>
  gid2rid {GID}
  importcoin <hyperblockId> <chainId> <localblockId> 
  issuecoin <Name> [Genesis block message] [Model] [Logo]
  keypoolrefill
  listaccounts [minconf=1]
  listreceivedbyaccount [minconf=1] [includeempty=false]
  listreceivedbyaddress [minconf=1] [includeempty=false]
  listtransactions [account] [count=10] [from=0]
  move <fromaccount> <toaccount> <amount> [minconf=1] [comment]
  querygenesisblock <GID>
  queryminingstatus
  sendfrom <fromaccount> <toaddress> <amount> [minconf=1] [comment] [comment-to]
  sendmany <fromaccount> {address:amount,...} [minconf=1] [comment]
  sendtoaddress <ledgeraddress> <amount> [comment] [comment-to]
  setaccount <address> <account>
  setgenerate <generate> [genproclimit]
  settxfee <amount>
  startmining [<name> | <hyperblockId> <chainId> <localblockId>]
  stopmining
  validateaddress <ledgeraddress>",
  "error": null,
  "id": xxx
}

getblockcount

Function: Returns the block height in the local optimal chain of the node

Parameter: None

Return Result: Returns an integer value representing the height of the block in the local optimal chain

Call example:

{
  "method":"getblockcount",
  "params":[],
  "id":xxx
}

Sample return results:

{
    "result": 572,
    "error": null,
    "id": xxx
}

getblocknumber

Same as getblockcount

getconnectioncount

Function: Query the number of online neighbor nodes of a node

Parameter: None

Return Result: Returns an integer value indicating the number of online neighbor nodes of the node

Call example:

{
  "method":" getconnectioncount",
  "params":[],
  "id":xxx
}

Sample return results:

{
    "result": 5,
    "error": null,
    "id": xxx
}

getinfo

Function: Query node operation status information

Parameter: None

Return result: return the running status Property list of the current node

Call example:

{
  "method":" getinfo",
  "params":[],
  "id":xxx
}

Sample return results:

{
    "result": {
        "version": 40000, //Node software version
        "balance": 864.00000000,//he total balance of all addresses in the node wallet
        "blocks": 572,//Number of local blocks in the node
        "connections": 1,//Number of neighbor nodes
        "proxy ": "",
        "generate": true,//Whether the mining function is enabled
        "difficulty": 0.00000095,//The current block difficulty of the node
        "hashespersec": 0,//Node example, hash count per second
        "testnet": false, //Whether to test the network node
        "keypoololdest": 1603867377, //Node wallet keypool age
        "keypoolsize": 101,//Node keypool size
        "paytxfee": 0.00000000, //Transaction fee settings
        "errors": "" //什么错误信息？
    },
    "error": null,
    "id": xxx
}

getnewaddress

Function: Generate a new address for the specified account

Parameter:, account is the account name string

Return Result: Returns the new address generated for the specified account

Remarks:

  • If the account name is empty [“], a new address will be generated for the node’s default account.
  • If the entered account name does not exist, the node will automatically generate the account and associate the generated new address with the account. The generated accounts can be viewed through the listaccounts method.

Call example:

{
  "method":"getnewaddress",
  "params":["yage"],
  "id":xxx
}

Sample return results:

{
    "result": "1ae9CcbE49TnpFygKt7udeP5NbZ7REcC2",
    "error": null,
    "id": xxx
}

getaccountaddress

Function: Obtain wallet addresses available for the specified account

Parameter: <account>, account name string

Return Result: Returns an account’s available wallet address

Note: If there is no available address for the entered account, the node will automatically generate and return a new address.

Call example:

{
  "method":"getnewaddress",
  "params":["yage"],
  "id":xxx
}

Sample return results:

{
    "result": "1ae9CcbE49TnpFygKt7udeP5NbZ7REcC2",
    "error": null,
    "id": xxx
}

getaccountaddress

Function: Obtain wallet addresses available for the specified account

Parameter: <account>, account name string

Return Result: Returns an account’s available wallet address

Note: If there is no available address for the entered account, the node will automatically generate and return a new address.

Call example:

{
  "method":"getaccountaddress",
  "params":[“yage”],
  "id":xxx
}

Sample return results:

{
    "result": {
        "yage": "15yKypansKe1voCJWHZBdYhVsBVbQx6rZv"
    },
    "error": null,
    "id": xxx
}

setaccount

Function: Associate address to designated account

Parameter:<address>, wallet address string

<account>, account name string

Return result: If the association is successful, result returns null, and if it fails, error error information is returned.

Call example:

{
  "method":"setaccount",
  "params":["15yKypansKe1voCJWHZBdYhVsBVbQx6rZv", "yage"],
  "id":xxx
}

Sample return results:

{
    "result": null,
    "error": null,
    "id": xxx
}

getaccount

Function: Query the account associated with the wallet address

Parameter: <address> , wallet address string

Return Result: Returns the account name string associated with the address

Call example:

{
  "method":"getaccount",
  "params":["15yKypansKe1voCJWHZBdYhVsBVbQx6rZv"],
  "id":xxx
}

Sample return results:

{
    "result": "yage",
    "error": null,
    "id": xxx
}

getaddressesbyaccount

Function: Query all wallet addresses associated with a specified account

Parameter:<account>, account name string

Return Result: Returns a list of all wallet addresses associated with the account

Call method:

{
  "method": "getaddressesbyaccount",
  "params":["yage"],
  "id":xxx
}

Sample return results:

{
    "result": [
        "1ae9CcbE49TnpFygKt7udeP5NbZ7REcC2",
        "14R5qXbGCANCbvi4z7JZGLZxQ9VHdDM7TU",
        "15yKypansKe1voCJWHZBdYhVsBVbQx6rZv"
    ],
    "error": null,
    "id": xxx
}

sendtoaddress

Function: Transfer to the designated wallet address

Parameter:<address-to>, payment wallet address

<amount>, transfer amount

[comment], transfer note

[comment to], a note to the recipient

Return Result: Returns the identification of the transfer transaction.

Call method:

{
  "method":"sendtoaddress",
  "params":["1ae9CcbE49TnpFygKt7udeP5NbZ7REcC2",100],
  "id":xxx
}

Sample return results:

{
    "result": {
        "txid": "3d56953163e3c66bb56a5996690dcc1a625b26c4e42b53aa9360a43b299f2e41"
    },
    "error": null,
    "id": xxx
}

getreceivedbyaddress

Function: Obtain the total amount of all coins received on the specified wallet address

Parameter:<address>, wallet address

[minconf=1], minimum currency age, default value is 1

Return Result: Returns the total amount of all coins received at the address

Call example:

{
  "method":"getreceivedbyaddress",
  "params":["1ae9CcbE49TnpFygKt7udeP5NbZ7REcC2 "],
  "id":xxx
}

Sample return results:

{
    "result": 100.00000000,
    "error": null,
    "id": xxx
}

getreceivedbyaccount

Parameter:<account>, account name

[minconf=1], minimum currency age, default value is 1

Return Result: Returns the total amount of currency received on all addresses of the account

Call method:

{
  "method":"getreceivedbyaccount",
  "params":["yage"],
  "id":xxx
}

Sample return results:

{
    "result": 100.00000000,
    "error": null,
    "id": xxx
}

listreceivedbyaddress

Function: List the total amount of received coins by wallet address

Parameter: [minconf=1], minimum currency age, default value is 1

[includeempty=false], whether to list addresses that did not receive coins, default not to list

Return Result: Returns a list of wallet addresses and corresponding currency receipts

Call example:

{
  "method":"listreceivedbyaddress",
  "params":[""],
  "id":xxx
}

Sample return results:

{
    "result": [
        {
            "address": "1ae9CcbE49TnpFygKt7udeP5NbZ7REcC2",
            "account": "yage",
            "label": "yage",
            "amount": 100.00000000,
            "confirmations": 18
        }
    ],
    "error": null,
    "id": 77
}

listreceivedbyaccount

Function: List the total amount of related recorded transactions by wallet account

Parameter: [minconf=1], minimum currency age, default value is 1

[includeempty=false], whether to list accounts that have not received coins, default not to list

Return Result: Returns a list of total transaction amounts related to wallet accounts

Call example:

{
  "method":"listreceivedbyaccount",
  "params":[],
  "id":xxx
}

Sample return results:

{
    "result": [
        {
            "account": "yage",
            "label": "yage",
            "amount": 100.00000000,
            "confirmations": 14
        },
        {
            "account": "yage1",
            "label": "yage1",
            "amount": 100.00000000,
            "confirmations": 14
        }

    ],
    "error": null,
    "id": 77
}

keypoolrefill

Function: Generate new key pairs to fill the key pool, generating 100 keys at a time

Parameter: None

Return result: If successful, result returns null, and if unsuccessful, error error information is returned.

Call example:

{
  "method":"keypoolrefill",
  "params":[],
  "id":xxx
}

Sample return results:

{
    "result": null,
    "error": null,
    "id": xxx
}

walletpassphrase

Function: Enter a password to unlock an encrypted wallet and specify the effective unlocking time. Within the unlocking time, you can operate the wallet without password.

Parameter: <passphrase>,Wallet unlocking password

<timeout>,Unlocking effective time, in seconds

Return result: If successful, result returns null, and if unsuccessful, error error information is returned.

Call example:

{
  "method":" walletpassphrase ",
  "params":["xxxxyyyyzzzz",10],
  "id":xxx
}

Sample return results:

{
    "result": null,
    "error": null,
    "id": xxx
}

walletlock

Function: Lock the wallet. To operate an encrypted wallet, you need to provide a password to unlock it first.

Parameter: None

Return result: If successful, result returns null, and if unsuccessful, error error information is returned.

Call example:

{
  "method":"walletlock",
  "params":[],
  "id":xxx
}

Sample return results:

{
    "result": null,
    "error": null,
    "id": xxx
}

encryptwallet

Function: Encrypt the wallet, and unlock the encrypted wallet by entering a password first

Parameter:<passphrase>, password

Return result: If successful, result returns null, and if unsuccessful, error error information is returned.

Call method:

{
  "method":"encryptwallet",
  "params":["xxxxyyyyzzzz"],
  "id":xxx
}

Sample return results:

{
    "result": null,
    "error": null,
    "id": xxx
}

validateaddress

Function: Verify whether the wallet address is legal

Parameter:<address>, wallet address

Return Result: Returns the address and legal information.

Call example:

{
  "method":"validateaddress",
  "params":["1ae9CcbE49TnpFygKt7udeP5NbZ7REcC2"],
  "id":xxx
}

Sample return results:

{
    "result": {
        "isvalid": true,//Is the address legal
        "address": "1ae9CcbE49TnpFygKt7udeP5NbZ7REcC2",//Verified address
        "ismine":  false 
    },
    "error": null,
    "id": 12
}

getbalance

Function: Query the available balance of a specified account

Parameter: [account], wallet account

[minconf=1], minimum coin age, default value is 1

Return Result: Returns the total available balance of all addresses in the account

Call example:

{
  "method":"getbalance",
  "params":["yage"],
  "id":xxx
}

Sample return results:

{
    "result": 520.00000000,
    "error": null,
    "id": 12
}

move

Function: Transfer between internal addresses of node wallets

Parameter:<fromacount>, sender account name, account name “” represents the default wallet account

<toaddress>, recipient address

<amount>, amount

[comment], remarks

Return result: If successful, result returns true, while if unsuccessful, false and error error information are returned.

Call example:

{
  "method":"move",
  "params":["","1ae9CcbE49TnpFygKt7udeP5NbZ7REcC2",0.02],
  "id":xxx
}

Sample return results:

{
    "result": true,
    "error": null,
    "id": 12
}

sendfrom

Function: Transfer funds from the local wallet account of the node to any address

Parameter:<fromacount>, sender account name, account name “” represents the default wallet account

<toaddress>, recipient address

<amount>, amount

[comment], remarks

[comment to], a note to the recipient

Return Result: Returns the transaction identifier txid sent by the node to the blockchain network.

Call example:

{
  "method":"sendfrom",
  "params":["","1ae9CcbE49TnpFygKt7udeP5NbZ7REcC2",0.02],
  "id":xxx
}

Sample return results:

{
    "result": "37399f8cfd5cd6746065973b33e4955380804cc39ec11e22914521eac99250da",
    "error": null,
    "id": 12
}

sendmany

Function: Transfer funds to multiple people

Parameter:<fromaccount>, sender account name, account name “” represents the default wallet account

{address: amount,…}, recipient address and amount tuple

[minconf=1], minimum coin age, default value is 1

[comment], remarks

Return Result: Returns the transaction identifier txid sent by the node to the blockchain network

Call example:

{
  "method":"sendmany",
  "params":[
    "",
    {
      "1ae9CcbE49TnpFygKt7udeP5NbZ7REcC2": 12.8, 
      "14R5qXbGCANCbvi4z7JZGLZxQ9VHdDM7TU": 23
    }
  ],
  "id":xxx
}

Sample return results:

{
    "result": "fcafcfe9e680e24475416989426f3fc96f5d1fd6a85c6aed63a0822b9cfc9307",
    "error": null,
    "id": xxx
}

gettransaction

Function: Query transaction information

Parameter:<txid>, Transaction ID

Return Result: Return transaction details

Call example:

{
  "method":"gettransaction",
  "params":["37399f8cfd5cd6746065973b33e4955380804cc39ec11e22914521eac99250da"],
  "id":133
}

Sample return results:

{
  "result": {
    "amount": -0.02000000, //发送金额
    "fee": 0.00000000,//交易手续费
    "confirmations": 10, //币龄
    "txid": "37399f8cfd5cd6746065973b33e4955380804cc39ec11e22914521eac99250da",
    "time": 1603963924,
    "details": [
      {
        "account": "",
        "address": "1ae9CcbE49TnpFygKt7udeP5NbZ7REcC2",
        "category": "send",
        "amount": -0.02000000,
        "fee": 0.00000000
      }
    ]
  },
  "error": null,
  "id": 133
}

gettransactionaddr

Function: Query the super blockchain triple address of the exchange in the sub chain block

Parameter:<txid>,Transaction ID

Return Result: Returns the super blockchain triplet address of the exchange in the sub chain block

Call example:

{
  "method":"gettransactionaddr",
  "params":["37399f8cfd5cd6746065973b33e4955380804cc39ec11e22914521eac99250da"],
  "id":133
}

Sample return results:

{
    "result": {
        "address  ": [13,2,1] //超块链三元组地址
    },
    "error": null,
    "id": 133
}

listtransactions

Function: List recent transactions related to node wallet accounts

Parameter: [account], wallet account

[count=10], the number of request records, defaults to 10

[from=0], request record starting point, default to 0

Return Result: Returns the list of recent transaction records for the wallet account

Call example:

{
  "method":"listtransactions",
  "params":[],
  "id":133
}

Sample return results:

{
  "result": [
    {
      "account": "",
      "category": "generate", 
      "amount": 8.00000000,
      "confirmations": 21,
      "txid": "43941624bc17ffae87fca66c3272fd305377ec0b9a0b9877c430170a8f0e6914",
      "time": 1603964054
    },
    {
      "account": "",
      "category": "immature",
      "amount": 8.00000000,
      "confirmations": 20,
      "txid": "0ca69b6be62e76a47a83f385c136f7f9531dfe0b661c7cc53974c21738be1dbe",
      "time": 1603964098
    },                     
    {
      "account": "",
      "address": "1ae9CcbE49TnpFygKt7udeP5NbZ7REcC2",
      "category": "send",
      "amount": -12.80000000,
      "fee": 0.00000000,
      "confirmations": 9,
      "txid": "fcafcfe9e680e24475416989426f3fc96f5d1fd6a85c6aed63a0822b9cfc9307",
      "time": 1603965018
    },
    {
      "account": "",
      "category": "immature",
      "amount": 8.00000000,
      "confirmations": 5,
      "txid": "adaec471c7bfe421bdce6ca5275c9b0391d91d41642ee08dae4b2a147754bd05",
      "time": 1603965175
    },
    {
      "account": "",
      "category": "immature",
      "amount": 8.00000000,
      "confirmations": 3,
      "txid": "e88849df751ccf5c3d1c3f6a42036f1b8be51b8d3f5d3f253f2f9e4d656e95cd",
      "time": 1603965309
    },
    {
      "account": "",
      "category": "immature",
      "amount": 8.00000000,
      "confirmations": 2,
      "txid": "0cdf4eddce6517a315178c00ab3c78c4a6d048e88fccaca0cb7dc2e18d18d20e",
      "time": 1603965336
    },
    {
      "account": "",
      "category": "orphan",
      "amount": 8.00000000,
      "confirmations": 0,
      "txid": "e64d4fa0abcb7937e0c093d3a43e42474fe6229bd52d1c6936ce494fdb012eb1",
      "time": 1603965341
    }
  ],
  "error": null,
  "id": 133
}

listaccounts

Function: List all account balances in node wallets

Parameter: [minconf=1], currency age, default value is 1

Return Result: Return the balance list of each wallet account

Call method:

{
  "method":" listaccounts",
  "params":[""],
  "id":xxx
}

Sample return results:

{
  "result": {
    "": [
        952.00000000, //Total wallet account amount
        864.00000000  //Number of mature para coins, distinguished by currency age parameter values
    ]
    "yage" : [
      10.00000000,
      10.00000000
    ]
  },
  "error": null,
  "id": xxx
}

settxfee

Function: set the service rate per Kilobyte used for wallet transaction payment

Parameter:<FeePerKB>, rate per Kilobyte

Return result: Setting successfully returns true, while failure returns false and error information

Call example:

{
  "method":"settxfee",
  "params":[0.00002],
  "id":xxx
}

Sample return results:

{
    "result": "true",
    "error": null,
    "id": xxx
}

Coin related RPC methods

issuecoin

Function: Issuing digital currency

Parameter:<Name>, name of digital currency

[Genesis block description], Genesis block description information

[Model], mining algorithm model, default to PARA

[Logo], digital currency identification logo

Return Result: Returns the online transaction ID gid of the digital currency creation block

Note: Issuing digital currency refers to sending digital currency creation block information online. Gid is a hash of digital currency creation block metadata. Before the successful chain up of the Genesis block, the application can obtain the transaction status query handle rid of the chain up transaction at the transaction submission node through the gid2rid method. After the creation block is successfully linked, the application can obtain the creation block information through the query genes isblock method and gid.

Call example:

{
  "method":"issuecoin",
  "params":[
    "NewCoin", 
    "Hello NewCoin..."
  ],
  "id":11222
}

Sample return results:

{
  "result": {
      "gid": "a66798466b70a34bc50b3ada1b2b5c7bbc72e7e3d556aabe6287cda7fec2d25e"
  },
  "error": null,
  "id": 11222
}

gid2rid

Function: Obtain the uplink transaction request rid corresponding to the gid

Parameter: {GID}, query ID for Chuangshi Block online transaction

Return Result: Returns the request ID corresponding to the gid

Note: After obtaining the request ID, the application can use the RestAPI interface GetOnchainState to query the status of the Genesis block on the chain

Call example:

{
  "method":"gid2rid",
  "params":[" a66798466b70a34bc50b3ada1b2b5c7bbc72e7e3d556aabe6287cda7fec2d25e"],
  "id":16
}

Sample return results:

{
    "result": {
        "requestid": "4WeQfbxqidFTN85mqV2ZXuDQ6cvH"
    },
    "error": null,
    "id": 16
}

querygenesisblock

Function: Query the triple address of the Genesis block for a certain coin

Parameter: {GID}

Return Result: Returns the triple address of the Genesis block

Call method:

{
  "method":"querygenesisblock",
  "params":[" a66798466b70a34bc50b3ada1b2b5c7bbc72e7e3d556aabe6287cda7fec2d25e"],
  "id":16
}

Sample return results:

{
    "result": {
        "hyperblockId": 952,
        "chainNum": 1,
        "localblockId": 2
    },
    "error": null,
    "id": 16
}

getcoininfo

Function: Obtain basic information of digital currency

Parameter:<hyperblockId, LocalchainId, localblockId>, Digital Currency Genesis Block Triple Address

Return Result: Returns the meta information of the digital currency Genesis block

Call example:

{
  "method":"getcoininfo",
  "params":[
    "952",
    "1",
    "2"
  ],
  "id":16
}

Sample return results:

{
    "result": {
        "name": "NewCoin",
        "message": "Hello NewCoin...",
        "model": "PARA",
        "logo": ""
    },
    "error": null,
    "id": 16
}

importcoin

Function: Import digital currency information locally to the node

Parameter:<hyperblockId, LocalchainId, localblockId>, Digital Currency Genesis Block Triple Address

Return Result: Returns the meta information of the digital currency Genesis block

Note: After the import is completed, the application can operate the node to start mining on the digital currency

Call example:

{
  "method":"importcoin",
  "params":[
    "952",
    "1",
    "2"
  ],
  "id":16
}

Sample return results:

{
    "result": {
        "name": "NewCoin",
        "message": "Hello NewCoin...",
        "model": "PARA",
        "logo": ""
    },
    "error": null,
    "id": 16
}

startmining

Function: Specify digital currency to enable mining

Parameter: [name | [hyperblockId, localchainId, localblockId]], digital currency name or Genesis block triplet

Return result: Return mining status

Note: When multiple digital currencies are running on a node, only one currency can be exclusively mined. Calling this method can automatically switch mining currencies. When there are no input parameters, the currency of the most recent mining will be activated by default.

Call example:

{
  "method":"startmining",
  "params":[],
  "id":16
}

Sample return results:

{
    "result": null,
    "error": {
        "code": -2,
        "message": "paracoin is mining"
    },
    "id": 16
}

stopmining

Function: Stop digital currency mining

Parameter: None

Return result: Return mining status

Call example:

{
  "method":"stopmining",
  "params":[],
  "id":16
}

Sample return results:

{
    "result": {
        "result": "ok, stopped"
    },
    "error": null,
    "id": 16
}

queryminingstatus

Function: Query the operational status of digital currency mining

Parameter: None

Return Result: Mining Status Information

Note: The status code and status information are as follows

  • Mining = 1,
  • MiningWithWarning1 = 2, // Warning: Seed server’s block information is unknown
  • MiningWithWarning2 = 3,// Block height less than seed server’s
  • MiningWithWarning3 = 4,// Block hash different from seed server’s
  • Switching = 0,// Switching to the best chain
  • GenDisabled = -1, // Stopped or disabled, Specify \”-gen\” option to enable
  • HyperBlockNotReady = -2,
  • NoAnyNeighbor = -3,
  • InvalidGenesisBlock = -4,
  • MiningSettingClosed= -5,
  • ManyBlocksNonChained= -6,
  • ChainIncomplete = -7,

Call example:

{
  "method":"queryminingstatus",
  "params":[],
  "id":16
}

Sample return results:

{
    "result": {
        "status": "mining",
        "statuscode": 1,
        "currentheight": 1652,
        "statusdesc": "Mining"
    },
    "error": null,
    "id": 16
}
or
{
    "result": {
        "status": "stopped",
        "statuscode": -5,
        "currentheight": 1652,
        "statusdesc": "Coin's mining setting is closed"
    },
    "error": null,
    "id": 16
}

getdifficulty

Function: Obtain the ratio of node mining block difficulty to minimum difficulty

Parameter: None

Return result: Mining difficulty ratio.

Call example:

{
  "method":"getdifficulty",
  "params":[],
  "id":xxx
}

Sample return results:

{
    "result": 1.00000000,
    "error": null,
    "id": 2
}

getgenerate

Function: Is the mining function of the current node enabled

Parameter: None

Return result: true indicates that the node mining function is enabled, while false indicates that it is not enabled

Call example:

{
  "method":"getgenerate",
  "params":[],
  "id":xxx
}

Sample return results:

{
    "result": true,
    "error": null,
    "id": xxx
}

setgenerate

Function: Start/stop para node mining function

Parameter: [true | false]

Return result: If successful, result returns null, and if unsuccessful, error error information is returned.

Call example:

{
  "method": "setgenerate",
  "params":[true/false],
  "id":xxx
}

Sample return results:

{
    "result": null,
    "error": null,
    "id": xxx
}

Coin related RPC methods

issuetoken

Function: Issue new tokens

Parameter:<Name>, Token Name

[Genesis Block Description], token description information

[Initial Supply], Issue Amount

[Logo], token icon

[Address], the address where the token is stored

Return Result: Returns the request for the uplink transaction of the token creation block

Note: Issuing a token will send the token creation block information up the chain. Applications can query the on chain status of the creation block through the RestAPI interface GetOnchainState.

Call example:

{
  "method":"issuetoken",
  "params":[
    "NewToken",
    "NewToken...",
    "200000000"
  ],
  "id":11222
}

Sample return results:

{
    "result": {
        "requestid": "28eh4gAeQv8uDou4qh7Zj3bRaR3G"
    },
    "error": null,
    "id": 11222
}

queryfundblock

Function: Query the super blockchain triplet address of the token creator block

Parameter:<requested>, initiator block online transaction query identifier

Return Result: Returns the super blockchain triple address of the token’s creator block

Call example:

{
  "method":"queryfundblock",
  "params":["28eh4gAeQv8uDou4qh7Zj3bRaR3G"],
  "id":16
}

Sample return results:

{
    "result": {
        "hyperblockId": 993,
        "chainNum": 1,
        "localblockId": 1
    },
    "error": null,
    "id": 16
}

gettokeninfo

Function: Obtain the description information of the specified token

Parameters: [hyperblockId, localchainId, localblockId], Token creator block hyperblockchain triplet address

Return result: Token creation block meta information

Call example:

{
  "method":"gettokeninfo",
  "params":[
    "993",
    "1",
    "1"
  ],
  "id":16
}

Sample return results:

{
    "result": {
        "name": "NewToken",
        "message": "Hello NewToken...",
        "logo": "",
        "supply": 200000000,
        "address": "1Kh9uYqFnUjSa9r7x746m2GfxBDpW3havT"
    },
    "error": null,
    "id": 16
}

importtoken

Function: Import Token information on the blockchain to local nodes

Parameters: [hyperblockId, localchainId, localblockId], Token creator block hyperblockchain triplet address

Result returned: Successfully imported, token creation block meta information returned

Call example:

{
  "method":"importtoken",
  "params":[
    "993",
    "1",
    "1"
  ],
  "id":16
}

Sample return results:

{
    "result": {
        "name": "NewToken",
        "message": "Hello NewToken...",
        "logo": "",
        "supply": 200000000,
        "address": "1Kh9uYqFnUjSa9r7x746m2GfxBDpW3havT"
    },
    "error": null,
    "id": 16
}

starttoken

Function: Enable the specified Token related functions locally on the node

Parameter: [[name | [hyperblockId, localchainId, localblockId]], Token name or initiator blockchain triplet address

Return result: Token function activation status information

Call example:

{
  "method":"starttoken",
  "params":[],
  "id":16
}

Sample return results:

{
    "result": null,
    "error": {
        "code": -2,
        "message": "Already started: ledger"
    },
    "id": 16
}
Was this article helpful to you? Yes No