@neuraiproject/neurai-rpc 0.4.6 → 0.4.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/docs.json CHANGED
@@ -4,23 +4,23 @@
4
4
  "getaddressmempool": "getaddressmempool\n\nReturns all mempool deltas for an address (requires addressindex to be enabled).\n\nArguments:\n{\n \"addresses\"\n [\n \"address\" (string) The base58check encoded address\n ,...\n ]\n},\n\"includeAssets\" (boolean, optional, default false) If true this will return an expanded result which includes asset deltas\n\nResult:\n[\n {\n \"address\" (string) The base58check encoded address\n \"assetName\" (string) The name of the associated asset (XNA for Neurai)\n \"txid\" (string) The related txid\n \"index\" (number) The related input or output index\n \"satoshis\" (number) The difference of satoshis\n \"timestamp\" (number) The time the transaction entered the mempool (seconds)\n \"prevtxid\" (string) The previous txid (if spending)\n \"prevout\" (string) The previous transaction output index (if spending)\n }\n]\n\nExamples:\n> neurai-cli getaddressmempool '{\"addresses\": [\"12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX\"]}'\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"getaddressmempool\", \"params\": [{\"addresses\": [\"12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX\"]}] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n> neurai-cli getaddressmempool '{\"addresses\": [\"12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX\"]}', true\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"getaddressmempool\", \"params\": [{\"addresses\": [\"12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX\"]}, true] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
5
5
  "getaddresstxids": "getaddresstxids\n\nReturns the txids for an address(es) (requires addressindex to be enabled).\n\nArguments:\n{\n \"addresses\"\n [\n \"address\" (string) The base58check encoded address\n ,...\n ]\n \"start\" (number, optional) The start block height\n \"end\" (number, optional) The end block height\n},\n\"includeAssets\" (boolean, optional, default false) If true this will return an expanded result which includes asset transactions\n\nResult:\n[\n \"transactionid\" (string) The transaction id\n ,...\n]\n\nExamples:\n> neurai-cli getaddresstxids '{\"addresses\": [\"12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX\"]}'\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"getaddresstxids\", \"params\": [{\"addresses\": [\"12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX\"]}] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n> neurai-cli getaddresstxids '{\"addresses\": [\"12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX\"]}', true\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"getaddresstxids\", \"params\": [{\"addresses\": [\"12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX\"]}, true] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
6
6
  "getaddressutxos": "getaddressutxos\n\nReturns all unspent outputs for an address (requires addressindex to be enabled).\n\nArguments:\n{\n \"addresses\"\n [\n \"address\" (string) The base58check encoded address\n ,...\n ],\n \"chainInfo\", (boolean, optional, default false) Include chain info with results\n \"assetName\" (string, optional) Get UTXOs for a particular asset instead of XNA ('*' for all assets).\n}\n\nResult\n[\n {\n \"address\" (string) The address base58check encoded\n \"assetName\" (string) The asset associated with the UTXOs (XNA for Neurai)\n \"txid\" (string) The output txid\n \"height\" (number) The block height\n \"outputIndex\" (number) The output index\n \"script\" (strin) The script hex encoded\n \"satoshis\" (number) The number of satoshis of the output\n }\n]\n\nExamples:\n> neurai-cli getaddressutxos '{\"addresses\": [\"12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX\"]}'\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"getaddressutxos\", \"params\": [{\"addresses\": [\"12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX\"]}] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n> neurai-cli getaddressutxos '{\"addresses\": [\"12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX\"],\"assetName\":\"MY_ASSET\"}'\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"getaddressutxos\", \"params\": [{\"addresses\": [\"12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX\"],\"assetName\":\"MY_ASSET\"}] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
7
- "": "== Addressindex ==\ngetaddressbalance\ngetaddressdeltas\ngetaddressmempool\ngetaddresstxids\ngetaddressutxos\n\n== Assets ==\ngetassetdata \"asset_name\"\ngetcacheinfo \ngetsnapshot \"asset_name\" block_height\nissue \"asset_name\" qty \"( to_address )\" \"( change_address )\" ( units ) ( reissuable ) ( has_ipfs ) \"( ipfs_hash )\"\nissueunique \"root_name\" [asset_tags] ( [ipfs_hashes] ) \"( to_address )\" \"( change_address )\"\nlistaddressesbyasset \"asset_name\" (onlytotal) (count) (start)\nlistassetbalancesbyaddress \"address\" (onlytotal) (count) (start)\nlistassets \"( asset )\" ( verbose ) ( count ) ( start )\nlistmyassets \"( asset )\" ( verbose ) ( count ) ( start ) (confs) \npurgesnapshot \"asset_name\" block_height\nreissue \"asset_name\" qty \"to_address\" \"change_address\" ( reissuable ) ( new_units) \"( new_ipfs )\" \ntransfer \"asset_name\" qty \"to_address\" \"message\" expire_time \"change_address\" \"asset_change_address\"\ntransferfromaddress \"asset_name\" \"from_address\" qty \"to_address\" \"message\" expire_time \"xna_change_address\" \"asset_change_address\"\ntransferfromaddresses \"asset_name\" [\"from_addresses\"] qty \"to_address\" \"message\" expire_time \"xna_change_address\" \"asset_change_address\"\n\n== Blockchain ==\nclearmempool\ndecodeblock \"blockhex\"\ngetbestblockhash\ngetblock \"blockhash\" ( verbosity ) \ngetblockchaininfo\ngetblockcount\n\ngetblockhash height\ngetblockhashes timestamp\ngetblockheader \"hash\" ( verbose )\ngetchaintips\ngetchaintxstats ( nblocks blockhash )\ngetdifficulty\ngetmempoolancestors txid (verbose)\ngetmempooldescendants txid (verbose)\ngetmempoolentry txid\ngetmempoolinfo\ngetrawmempool ( verbose )\ngetspentinfo\ngettxout \"txid\" n ( include_mempool )\ngettxoutproof [\"txid\",...] ( blockhash )\ngettxoutsetinfo\npreciousblock \"blockhash\"\npruneblockchain\nsavemempool\nverifychain ( checklevel nblocks )\nverifytxoutproof \"proof\"\n\n== Control ==\ngetinfo\ngetmemoryinfo (\"mode\")\ngetrpcinfo\nhelp ( \"command\" )\nstop\nuptime\n\n== Generating ==\ngenerate nblocks ( maxtries )\ngeneratetoaddress nblocks address (maxtries)\ngetgenerate\nsetgenerate generate ( genproclimit )\n\n== Messages ==\nclearmessages \nsendmessage \"channel_name\" \"ipfs_hash\" (expire_time)\nsubscribetochannel \nunsubscribefromchannel \nviewallmessagechannels \nviewallmessages \n\n== Mining ==\ngetblocktemplate ( TemplateRequest )\ngetkawpowhash \"header_hash\" \"mix_hash\" nonce, height, \"target\"\ngetmininginfo\ngetnetworkhashps ( nblocks height )\npprpcsb \"header_hash\" \"mix_hash\" \"nonce\"\nprioritisetransaction <txid> <dummy value> <fee delta>\nsubmitblock \"hexdata\" ( \"dummy\" )\n\n== Network ==\naddnode \"node\" \"add|remove|onetry\"\nclearbanned\ndisconnectnode \"[address]\" [nodeid]\ngetaddednodeinfo ( \"node\" )\ngetconnectioncount\ngetnettotals\ngetnetworkinfo\ngetpeerinfo\nlistbanned\nping\nsetban \"subnet\" \"add|remove\" (bantime) (absolute)\nsetnetworkactive true|false\n\n== Rawtransactions ==\ncombinerawtransaction [\"hexstring\",...]\ncreaterawtransaction [{\"txid\":\"id\",\"vout\":n},...] {\"address\":(amount or object),\"data\":\"hex\",...}\ndecoderawtransaction \"hexstring\"\ndecodescript \"hexstring\"\nfundrawtransaction \"hexstring\" ( options )\ngetrawtransaction \"txid\" ( verbose )\nsendrawtransaction \"hexstring\" ( allowhighfees )\nsignrawtransaction \"hexstring\" ( [{\"txid\":\"id\",\"vout\":n,\"scriptPubKey\":\"hex\",\"redeemScript\":\"hex\"},...] [\"privatekey1\",...] sighashtype )\ntestmempoolaccept [\"rawtxs\"] ( allowhighfees )\n\n== Restricted assets ==\naddtagtoaddress tag_name to_address (change_address) (asset_data)\ncheckaddressrestriction address restricted_name\ncheckaddresstag address tag_name\ncheckglobalrestriction restricted_name\nfreezeaddress asset_name address (change_address) (asset_data)\nfreezerestrictedasset asset_name (change_address) (asset_data)\ngetverifierstring restricted_name\nissuequalifierasset \"asset_name\" qty \"( to_address )\" \"( change_address )\" ( has_ipfs ) \"( ipfs_hash )\"\nissuerestrictedasset \"asset_name\" qty \"verifier\" \"to_address\" \"( change_address )\" (units) ( reissuable ) ( has_ipfs ) \"( ipfs_hash )\"\nisvalidverifierstring verifier_string\nlistaddressesfortag tag_name\nlistaddressrestrictions address\nlistglobalrestrictions\nlisttagsforaddress address\nreissuerestrictedasset \"asset_name\" qty to_address ( change_verifier ) ( \"new_verifier\" ) \"( change_address )\" ( new_units ) ( reissuable ) \"( new_ipfs )\"\nremovetagfromaddress tag_name to_address (change_address) (asset_data)\ntransferqualifier \"qualifier_name\" qty \"to_address\" (\"change_address\") (\"message\") (expire_time) \nunfreezeaddress asset_name address (change_address) (asset_data)\nunfreezerestrictedasset asset_name (change_address) (asset_data)\n\n== Restricted ==\nviewmyrestrictedaddresses \nviewmytaggedaddresses \n\n== Rewards ==\ncancelsnapshotrequest \"asset_name\" block_height\ndistributereward \"asset_name\" snapshot_height \"distribution_asset_name\" gross_distribution_amount ( \"exception_addresses\" ) (\"change_address\") (\"dry_run\")\ngetdistributestatus \"asset_name\" snapshot_height \"distribution_asset_name\" gross_distribution_amount ( \"exception_addresses\" )\ngetsnapshotrequest \"asset_name\" block_height\nlistsnapshotrequests [\"asset_name\" [block_height]]\nrequestsnapshot \"asset_name\" block_height\n\n== Util ==\ncreatemultisig nrequired [\"key\",...]\nestimatefee nblocks\nestimatesmartfee conf_target (\"estimate_mode\")\nsignmessagewithprivkey \"privkey\" \"message\"\nvalidateaddress \"address\"\nverifymessage \"address\" \"signature\" \"message\"\n\n== Wallet ==\nabandontransaction \"txid\"\nabortrescan\naddmultisigaddress nrequired [\"key\",...] ( \"account\" )\naddwitnessaddress \"address\"\nbackupwallet \"destination\"\nbumpfee has been deprecated on the XNA Wallet.\ndumpprivkey \"address\"\ndumpwallet \"filename\"\nencryptwallet \"passphrase\"\ngetaccount \"address\"\ngetaccountaddress \"account\"\ngetaddressesbyaccount \"account\"\ngetbalance ( \"account\" minconf include_watchonly )\ngetmasterkeyinfo\ngetmywords ( \"account\" )\ngetnewaddress ( \"account\" )\ngetrawchangeaddress\ngetreceivedbyaccount \"account\" ( minconf )\ngetreceivedbyaddress \"address\" ( minconf )\ngettransaction \"txid\" ( include_watchonly )\ngetunconfirmedbalance\ngetwalletinfo\nimportaddress \"address\" ( \"label\" rescan p2sh )\nimportmulti \"requests\" ( \"options\" )\nimportprivkey \"privkey\" ( \"label\" ) ( rescan )\nimportprunedfunds\nimportpubkey \"pubkey\" ( \"label\" rescan )\nimportwallet \"filename\"\nkeypoolrefill ( newsize )\nlistaccounts ( minconf include_watchonly)\nlistaddressgroupings\nlistlockunspent\nlistreceivedbyaccount ( minconf include_empty include_watchonly)\nlistreceivedbyaddress ( minconf include_empty include_watchonly)\nlistsinceblock ( \"blockhash\" target_confirmations include_watchonly include_removed )\nlisttransactions ( \"account\" count skip include_watchonly)\nlistunspent ( minconf maxconf [\"addresses\",...] [include_unsafe] [query_options])\nlistwallets\nlockunspent unlock ([{\"txid\":\"txid\",\"vout\":n},...])\nmove \"fromaccount\" \"toaccount\" amount ( minconf \"comment\" )\nremoveprunedfunds \"txid\"\nrescanblockchain (\"start_height\") (\"stop_height\")\nsendfrom \"fromaccount\" \"toaddress\" amount ( minconf \"comment\" \"comment_to\" )\nsendfromaddress \"from_address\" \"to_address\" amount ( \"comment\" \"comment_to\" subtractfeefromamount replaceable conf_target \"estimate_mode\")\nsendmany \"fromaccount\" {\"address\":amount,...} ( minconf \"comment\" [\"address\",...] replaceable conf_target \"estimate_mode\")\nsendtoaddress \"address\" amount ( \"comment\" \"comment_to\" subtractfeefromamount replaceable conf_target \"estimate_mode\")\nsetaccount \"address\" \"account\"\nsettxfee amount\nsignmessage \"address\" \"message\"",
7
+ "": "== Addressindex ==\ngetaddressbalance\ngetaddressdeltas\ngetaddressmempool\ngetaddresstxids\ngetaddressutxos\n\n== Assets ==\ncheckdepinvalidity \"asset_name\" \"address\"\nfreezedepin \"asset_name\" \"address\" (\"change_address\")\ngetassetdata \"asset_name\"\ngetcacheinfo \ngetsnapshot \"asset_name\" block_height\nissue \"asset_name\" qty \"( to_address )\" \"( change_address )\" ( units ) ( reissuable ) ( has_ipfs ) \"( ipfs_hash )\"\nissueunique \"root_name\" [asset_tags] ( [ipfs_hashes] ) \"( to_address )\" \"( change_address )\"\nlistaddressesbyasset \"asset_name\" (onlytotal) (count) (start)\nlistassetbalancesbyaddress \"address\" (onlytotal) (count) (start)\nlistassets \"( asset )\" ( verbose ) ( count ) ( start )\nlistdepinaddresses \"asset_name\" (count) (start)\nlistdepinholders \"asset_name\"\nlistmyassets \"( asset )\" ( verbose ) ( count ) ( start ) (confs) \npurgesnapshot \"asset_name\" block_height\nreissue \"asset_name\" qty \"to_address\" \"change_address\" ( reissuable ) ( new_units) \"( new_ipfs )\" \nselfrevokedepin \"asset_name\"\ntransfer \"asset_name\" qty \"to_address\" \"message\" expire_time \"change_address\" \"asset_change_address\"\ntransferfromaddress \"asset_name\" \"from_address\" qty \"to_address\" \"message\" expire_time \"xna_change_address\" \"asset_change_address\"\ntransferfromaddresses \"asset_name\" [\"from_addresses\"] qty \"to_address\" \"message\" expire_time \"xna_change_address\" \"asset_change_address\"\nunfreezedepin \"asset_name\" \"address\" (\"change_address\")\n\n== Blockchain ==\nclearmempool\ndecodeblock \"blockhex\"\ngetbestblockhash\ngetblock \"blockhash\" ( verbosity ) \ngetblockchaininfo\ngetblockcount\n\ngetblockhash height\ngetblockhashes timestamp\ngetblockheader \"hash\" ( verbose )\ngetchaintips\ngetchaintxstats ( nblocks blockhash )\ngetdifficulty\ngetmempoolancestors txid (verbose)\ngetmempooldescendants txid (verbose)\ngetmempoolentry txid\ngetmempoolinfo\ngetrawmempool ( verbose )\ngetspentinfo\ngettxout \"txid\" n ( include_mempool )\ngettxoutproof [\"txid\",...] ( blockhash )\ngettxoutsetinfo\npreciousblock \"blockhash\"\npruneblockchain\nsavemempool\nverifychain ( checklevel nblocks )\nverifytxoutproof \"proof\"\n\n== Control ==\ngetinfo\ngetmemoryinfo (\"mode\")\ngetrpcinfo\nhelp ( \"command\" )\nstop\nuptime\n\n== Generating ==\ngenerate nblocks ( maxtries )\ngeneratetoaddress nblocks address (maxtries)\ngetgenerate\nsetgenerate generate ( genproclimit )\n\n== Messages ==\nclearmessages \nsendmessage \"channel_name\" \"ipfs_hash\" (expire_time)\nsubscribetochannel \nunsubscribefromchannel \nviewallmessagechannels \nviewallmessages \n\n== Mining ==\ngetblocktemplate ( TemplateRequest )\ngetkawpowhash \"header_hash\" \"mix_hash\" nonce, height, \"target\"\ngetmininginfo\ngetnetworkhashps ( nblocks height )\npprpcsb \"header_hash\" \"mix_hash\" \"nonce\"\nprioritisetransaction <txid> <dummy value> <fee delta>\nsubmitblock \"hexdata\" ( \"dummy\" )\n\n== Network ==\naddnode \"node\" \"add|remove|onetry\"\nclearbanned\ndisconnectnode \"[address]\" [nodeid]\ngetaddednodeinfo ( \"node\" )\ngetconnectioncount\ngetnettotals\ngetnetworkinfo\ngetpeerinfo\ngetpubkey \"address\"\nlistbanned\nping\nsetban \"subnet\" \"add|remove\" (bantime) (absolute)\nsetnetworkactive true|false\n\n== Rawtransactions ==\ncombinerawtransaction [\"hexstring\",...]\ncreaterawtransaction [{\"txid\":\"id\",\"vout\":n},...] {\"address\":(amount or object),\"data\":\"hex\",...}\ndecoderawtransaction \"hexstring\"\ndecodescript \"hexstring\"\nfundrawtransaction \"hexstring\" ( options )\ngetrawtransaction \"txid\" ( verbose )\nsendrawtransaction \"hexstring\" ( allowhighfees )\nsignrawtransaction \"hexstring\" ( [{\"txid\":\"id\",\"vout\":n,\"scriptPubKey\":\"hex\",\"redeemScript\":\"hex\"},...] [\"privatekey1\",...] sighashtype )\ntestmempoolaccept [\"rawtxs\"] ( allowhighfees )\n\n== Restricted assets ==\naddtagtoaddress tag_name to_address (change_address) (asset_data)\ncheckaddressrestriction address restricted_name\ncheckaddresstag address tag_name\ncheckglobalrestriction restricted_name\nfreezeaddress asset_name address (change_address) (asset_data)\nfreezerestrictedasset asset_name (change_address) (asset_data)\ngetverifierstring restricted_name\nissuequalifierasset \"asset_name\" qty \"( to_address )\" \"( change_address )\" ( has_ipfs ) \"( ipfs_hash )\"\nissuerestrictedasset \"asset_name\" qty \"verifier\" \"to_address\" \"( change_address )\" (units) ( reissuable ) ( has_ipfs ) \"( ipfs_hash )\"\nisvalidverifierstring verifier_string\nlistaddressesfortag tag_name\nlistaddressrestrictions address\nlistglobalrestrictions\nlisttagsforaddress address\nreissuerestrictedasset \"asset_name\" qty to_address ( change_verifier ) ( \"new_verifier\" ) \"( change_address )\" ( new_units ) ( reissuable ) \"( new_ipfs )\"\nremovetagfromaddress tag_name to_address (change_address) (asset_data)\ntransferqualifier \"qualifier_name\" qty \"to_address\" (\"change_address\") (\"message\") (expire_time) \nunfreezeaddress asset_name address (change_address) (asset_data)\nunfreezerestrictedasset asset_name (change_address) (asset_data)\n\n== Restricted ==\nviewmyrestrictedaddresses \nviewmytaggedaddresses \n\n== Rewards ==\ncancelsnapshotrequest \"asset_name\" block_height\ndistributereward \"asset_name\" snapshot_height \"distribution_asset_name\" gross_distribution_amount ( \"exception_addresses\" ) (\"change_address\") (\"dry_run\")\ngetdistributestatus \"asset_name\" snapshot_height \"distribution_asset_name\" gross_distribution_amount ( \"exception_addresses\" )\ngetsnapshotrequest \"asset_name\" block_height\nlistsnapshotrequests [\"asset_name\" [block_height]]\nrequestsnapshot \"asset_name\" block_height\n\n== Util ==\ncreatemultisig nrequired [\"key\",...]\nestimatefee nblocks\nestimatesmartfee conf_target (\"estimate_mode\")\nsignmessagewithprivkey \"privkey\" \"message\"\nvalidateaddress \"address\"\nverifymessage \"address\" \"signature\" \"message\"\n\n== Wallet ==\nabandontransaction \"txid\"\nabortrescan\naddmultisigaddress nrequired [\"key\",...] ( \"account\" )\naddwitnessaddress \"address\"\nbackupwallet \"destination\"\nbumpfee has been deprecated on the XNA Wallet.\ndumpprivkey \"address\"\ndumpwallet \"filename\"\nencryptwallet \"passphrase\"\ngetaccount \"address\"\ngetaccountaddress \"account\"\ngetaddressesbyaccount \"account\"\ngetbalance ( \"account\" minconf include_watchonly )\ngetmasterkeyinfo\ngetmywords ( \"account\" )\ngetnewaddress ( \"account\" )\ngetrawchangeaddress\ngetreceivedbyaccount \"account\" ( minconf )\ngetreceivedbyaddress \"address\" ( minconf )\ngettransaction \"txid\" ( include_watchonly )\ngetunconfirmedbalance\ngetwalletinfo\nimportaddress \"address\" ( \"label\" rescan p2sh )\nimportmulti \"requests\" ( \"options\" )\nimportprivkey \"privkey\" ( \"label\" ) ( rescan )\nimportprunedfunds\nimportpubkey \"pubkey\" ( \"label\" rescan )\nimportwallet \"filename\"\nkeypoolrefill ( newsize )\nlistaccounts ( minconf include_watchonly)\nlistaddressgroupings\nlistlockunspent\nlistpqaddresses\nlistreceivedbyaccount ( minconf include_empty include_watchonly)\nlistreceivedbyaddress ( minconf include_empty include_watchonly)\nlistsinceblock ( \"blockhash\" target_confirmations include_watchonly include_removed )\nlisttransactions ( \"account\" count skip include_watchonly)\nlistunspent ( minconf maxconf [\"addresses\",...] [include_unsafe] [query_options])\nlistwallets\nlockunspent unlock ([{\"txid\":\"txid\",\"vout\":n},...])\nmove \"fromaccount\" \"toaccount\" amount ( minconf \"comment\" )\nremoveprunedfunds \"txid\"\nrescanblockchain (\"start_height\") (\"stop_height\")\nsendfrom \"fromaccount\" \"toaddress\" amount ( minconf \"comment\" \"comment_to\" )\nsendfromaddress \"from_address\" \"to_address\" amount ( \"comment\" \"comment_to\" subtractfeefromamount replaceable conf_target \"estimate_mode\")\nsendmany \"fromaccount\" {\"address\":amount,...} ( minconf \"comment\" [\"address\",...] replaceable conf_target \"estimate_mode\")\nsendtoaddress \"address\" amount ( \"comment\" \"comment_to\" subtractfeefromamount replaceable conf_target \"estimate_mode\")\nsetaccount \"address\" \"account\"\nsettxfee amount\nsignmessage \"address\" \"message\"",
8
8
  "getassetdata": "getassetdata \"asset_name\"\n\nReturns assets metadata if that asset exists\n\nArguments:\n1. \"asset_name\" (string, required) the name of the asset\n\nResult:\n{\n name: (string),\n amount: (number),\n units: (number),\n reissuable: (number),\n has_ipfs: (number),\n ipfs_hash: (hash), (only if has_ipfs = 1 and that data is a ipfs hash)\n txid_hash: (hash), (only if has_ipfs = 1 and that data is a txid hash)\n verifier_string: (string)\n}\n\nExamples:\n> neurai-cli getassetdata \"ASSET_NAME\"\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"getassetdata\", \"params\": [\"ASSET_NAME\"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
9
9
  "getcacheinfo": "getcacheinfo \n\nResult:\n[\n uxto cache size:\n asset total (exclude dirty):\n asset address map:\n asset address balance:\n my unspent asset:\n reissue data:\n asset metadata map:\n asset metadata list (est):\n dirty cache (est):\n]\n\nExamples:\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"getcacheinfo\", \"params\": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n> neurai-cli getcacheinfo \n",
10
10
  "getsnapshot": "getsnapshot \"asset_name\" block_height\n\nReturns details for the asset snapshot, at the specified height\n\nArguments:\n1. \"asset_name\" (string, required) the name of the asset\n2. block_height (int, required) the block height of the snapshot\n\nResult:\n{\n name: (string),\n height: (number),\n owners: [\n {\n address: (string),\n amount_owned: (number),\n }\n}\n\nExamples:\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"getsnapshot\", \"params\": [\"ASSET_NAME\" 28546] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
11
- "issue": "issue \"asset_name\" qty \"( to_address )\" \"( change_address )\" ( units ) ( reissuable ) ( has_ipfs ) \"( ipfs_hash )\"\n\nIssue an asset, subasset or unique asset.\nAsset name must not conflict with any existing asset.\nUnit as the number of decimals precision for the asset (0 for whole units (\"1\"), 8 for max precision (\"1.00000000\")\nReissuable is true/false for whether additional units can be issued by the original issuer.\nIf issuing a unique asset these values are required (and will be defaulted to): qty=1, units=0, reissuable=false.\n\nArguments:\n1. \"asset_name\" (string, required) a unique name\n2. \"qty\" (numeric, optional, default=1) the number of units to be issued\n3. \"to_address\" (string), optional, default=\"\"), address asset will be sent to, if it is empty, address will be generated for you\n4. \"change_address\" (string), optional, default=\"\"), address the the xna change will be sent to, if it is empty, change address will be generated for you\n5. \"units\" (integer, optional, default=0, min=0, max=8), the number of decimals precision for the asset (0 for whole units (\"1\"), 8 for max precision (\"1.00000000\")\n6. \"reissuable\" (boolean, optional, default=true (false for unique assets)), whether future reissuance is allowed\n7. \"has_ipfs\" (boolean, optional, default=false), whether ipfs hash is going to be added to the asset\n8. \"ipfs_hash\" (string, optional but required if has_ipfs = 1), an ipfs hash or a txid hash once RIP5 is activated\n\nResult:\n\"txid\" (string) The transaction id\n\nExamples:\n> neurai-cli issue \"ASSET_NAME\" 1000\n> neurai-cli issue \"ASSET_NAME\" 1000 \"myaddress\"\n> neurai-cli issue \"ASSET_NAME\" 1000 \"myaddress\" \"changeaddress\" 4\n> neurai-cli issue \"ASSET_NAME\" 1000 \"myaddress\" \"changeaddress\" 2 true\n> neurai-cli issue \"ASSET_NAME\" 1000 \"myaddress\" \"changeaddress\" 8 false true QmTqu3Lk3gmTsQVtjU7rYYM37EAW4xNmbuEAp2Mjr4AV7E\n> neurai-cli issue \"ASSET_NAME/SUB_ASSET\" 1000 \"myaddress\" \"changeaddress\" 2 true\n> neurai-cli issue \"ASSET_NAME#uniquetag\"\n",
11
+ "issue": "issue \"asset_name\" qty \"( to_address )\" \"( change_address )\" ( units ) ( reissuable ) ( has_ipfs ) \"( ipfs_hash )\"\n\nIssue an asset, subasset or unique asset.\nAsset name must not conflict with any existing asset.\nUnit as the number of decimals precision for the asset (0 for whole units (\"1\"), 8 for max precision (\"1.00000000\")\nReissuable is true/false for whether additional units can be issued by the original issuer.\nIf issuing a unique asset these values are required (and will be defaulted to): qty=1, units=0, reissuable=false.\nDedicated DePIN assets (name starts with '&') are documented here as enabled for mainnet and testnet, with qty > 0 and units=0.\n\nArguments:\n1. \"asset_name\" (string, required) a unique name\n2. \"qty\" (numeric, optional, default=1) the number of units to be issued\n3. \"to_address\" (string), optional, default=\"\"), address asset will be sent to, if it is empty, address will be generated for you\n4. \"change_address\" (string), optional, default=\"\"), address the the xna change will be sent to, if it is empty, change address will be generated for you\n5. \"units\" (integer, optional, default=0, min=0, max=8), the number of decimals precision for the asset (0 for whole units (\"1\"), 8 for max precision (\"1.00000000\")\n6. \"reissuable\" (boolean, optional, default=true (false for unique assets)), whether future reissuance is allowed\n7. \"has_ipfs\" (boolean, optional, default=false), whether ipfs hash is going to be added to the asset\n8. \"ipfs_hash\" (string, optional but required if has_ipfs = 1), an ipfs hash or a txid hash once RIP5 is activated\n\nResult:\n\"txid\" (string) The transaction id\n\nExamples:\n> neurai-cli issue \"ASSET_NAME\" 1000\n> neurai-cli issue \"ASSET_NAME\" 1000 \"myaddress\"\n> neurai-cli issue \"ASSET_NAME\" 1000 \"myaddress\" \"changeaddress\" 4\n> neurai-cli issue \"ASSET_NAME\" 1000 \"myaddress\" \"changeaddress\" 2 true\n> neurai-cli issue \"ASSET_NAME\" 1000 \"myaddress\" \"changeaddress\" 8 false true QmTqu3Lk3gmTsQVtjU7rYYM37EAW4xNmbuEAp2Mjr4AV7E\n> neurai-cli issue \"ASSET_NAME/SUB_ASSET\" 1000 \"myaddress\" \"changeaddress\" 2 true\n> neurai-cli issue \"ASSET_NAME#uniquetag\"\n",
12
12
  "issueunique": "issueunique \"root_name\" [asset_tags] ( [ipfs_hashes] ) \"( to_address )\" \"( change_address )\"\n\nIssue unique asset(s).\nroot_name must be an asset you own.\nAn asset will be created for each element of asset_tags.\nIf provided ipfs_hashes must be the same length as asset_tags.\nFive (5) XNA will be burned for each asset created.\n\nArguments:\n1. \"root_name\" (string, required) name of the asset the unique asset(s) are being issued under\n2. \"asset_tags\" (array, required) the unique tag for each asset which is to be issued\n3. \"ipfs_hashes\" (array, optional) ipfs hashes or txid hashes corresponding to each supplied tag (should be same size as \"asset_tags\")\n4. \"to_address\" (string, optional, default=\"\"), address assets will be sent to, if it is empty, address will be generated for you\n5. \"change_address\" (string, optional, default=\"\"), address the the xna change will be sent to, if it is empty, change address will be generated for you\n\nResult:\n\"txid\" (string) The transaction id\n\nExamples:\n> neurai-cli issueunique \"MY_ASSET\" '[\"primo\",\"secundo\"]'\n> neurai-cli issueunique \"MY_ASSET\" '[\"primo\",\"secundo\"]' '[\"first_hash\",\"second_hash\"]'\n",
13
13
  "listaddressesbyasset": "listaddressesbyasset \"asset_name\" (onlytotal) (count) (start)\n\nReturns a list of all address that own the given asset (with balances)\nOr returns the total size of how many address own the given asset\nArguments:\n1. \"asset_name\" (string, required) name of asset\n2. \"onlytotal\" (boolean, optional, default=false) when false result is just a list of addresses with balances -- when true the result is just a single number representing the number of addresses\n3. \"count\" (integer, optional, default=50000, MAX=50000) truncates results to include only the first _count_ assets found\n4. \"start\" (integer, optional, default=0) results skip over the first _start_ assets found (if negative it skips back from the end)\n\nResult:\n[ (address): balance,\n ...\n]\n\nExamples:\n> neurai-cli listaddressesbyasset \"ASSET_NAME\" false 2 0\n> neurai-cli listaddressesbyasset \"ASSET_NAME\" true\n> neurai-cli listaddressesbyasset \"ASSET_NAME\"\n",
14
14
  "listassetbalancesbyaddress": "listassetbalancesbyaddress \"address\" (onlytotal) (count) (start)\n\nReturns a list of all asset balances for an address.\n\nArguments:\n1. \"address\" (string, required) a neurai address\n2. \"onlytotal\" (boolean, optional, default=false) when false result is just a list of assets balances -- when true the result is just a single number representing the number of assets\n3. \"count\" (integer, optional, default=50000, MAX=50000) truncates results to include only the first _count_ assets found\n4. \"start\" (integer, optional, default=0) results skip over the first _start_ assets found (if negative it skips back from the end)\n\nResult:\n{\n (asset_name) : (quantity),\n ...\n}\n\nExamples:\n> neurai-cli listassetbalancesbyaddress \"myaddress\" false 2 0\n> neurai-cli listassetbalancesbyaddress \"myaddress\" true\n> neurai-cli listassetbalancesbyaddress \"myaddress\"\n",
15
15
  "listassets": "listassets \"( asset )\" ( verbose ) ( count ) ( start )\n\nReturns a list of all assets\n\nThis could be a slow/expensive operation as it reads from the database\n\nArguments:\n1. \"asset\" (string, optional, default=\"*\") filters results -- must be an asset name or a partial asset name followed by '*' ('*' matches all trailing characters)\n2. \"verbose\" (boolean, optional, default=false) when false result is just a list of asset names -- when true results are asset name mapped to metadata\n3. \"count\" (integer, optional, default=ALL) truncates results to include only the first _count_ assets found\n4. \"start\" (integer, optional, default=0) results skip over the first _start_ assets found (if negative it skips back from the end)\n\nResult (verbose=false):\n[\n asset_name,\n ...\n]\n\nResult (verbose=true):\n{\n (asset_name):\n {\n amount: (number),\n units: (number),\n reissuable: (number),\n has_ipfs: (number),\n ipfs_hash: (hash) (only if has_ipfs = 1 and data is a ipfs hash)\n ipfs_hash: (hash) (only if has_ipfs = 1 and data is a txid hash)\n },\n {...}, {...}\n}\n\nExamples:\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"listassets\", \"params\": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n> neurai-cli listassets ASSET\n> neurai-cli listassets \"ASSET*\" true 10 20\n",
16
16
  "listmyassets": "listmyassets \"( asset )\" ( verbose ) ( count ) ( start ) (confs) \n\nReturns a list of all asset that are owned by this wallet\n\nArguments:\n1. \"asset\" (string, optional, default=\"*\") filters results -- must be an asset name or a partial asset name followed by '*' ('*' matches all trailing characters)\n2. \"verbose\" (boolean, optional, default=false) when false results only contain balances -- when true results include outpoints\n3. \"count\" (integer, optional, default=ALL) truncates results to include only the first _count_ assets found\n4. \"start\" (integer, optional, default=0) results skip over the first _start_ assets found (if negative it skips back from the end)\n5. \"confs\" (integet, optional, default=0) results are skipped if they don't have this number of confirmations\n\nResult (verbose=false):\n{\n (asset_name): balance,\n ...\n}\n\nResult (verbose=true):\n{\n (asset_name):\n {\n \"balance\": balance,\n \"outpoints\":\n [\n {\n \"txid\": txid,\n \"vout\": vout,\n \"amount\": amount\n }\n {...}, {...}\n ]\n }\n}\n{...}, {...}\n\nExamples:\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"listmyassets\", \"params\": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n> neurai-cli listmyassets ASSET\n> neurai-cli listmyassets \"ASSET*\" true 10 20\n> neurai-cli listmyassets \"ASSET*\" true 10 20 1\n",
17
17
  "purgesnapshot": "purgesnapshot \"asset_name\" block_height\n\nRemoves details for the asset snapshot, at the specified height\n\nArguments:\n1. \"asset_name\" (string, required) the name of the asset\n2. block_height (int, required) the block height of the snapshot\n\nResult:\n{\n name: (string),\n height: (number),\n}\n\nExamples:\n> neurai-cli purgesnapshot \"ASSET_NAME\" 28546\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"purgesnapshot\", \"params\": [\"ASSET_NAME\" 28546] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
18
- "reissue": "reissue \"asset_name\" qty \"to_address\" \"change_address\" ( reissuable ) ( new_units) \"( new_ipfs )\" \n\nReissues a quantity of an asset to an owned address if you own the Owner Token\nCan change the reissuable flag during reissuance\nCan change the ipfs hash during reissuance\nArguments:\n1. \"asset_name\" (string, required) name of asset that is being reissued\n2. \"qty\" (numeric, required) number of assets to reissue\n3. \"to_address\" (string, required) address to send the asset to\n4. \"change_address\" (string, optional) address that the change of the transaction will be sent to\n5. \"reissuable\" (boolean, optional, default=true), whether future reissuance is allowed\n6. \"new_units\" (numeric, optional, default=-1), the new units that will be associated with the asset\n7. \"new_ipfs\" (string, optional, default=\"\"), whether to update the current ipfs hash or txid once RIP5 is active\n\nResult:\n\"txid\" (string) The transaction id\n\nExamples:\n> neurai-cli reissue \"ASSET_NAME\" 20 \"address\"\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"reissue\", \"params\": [\"ASSET_NAME\" 20 \"address\" \"change_address\" \"true\" 8 \"Qmd286K6pohQcTKYqnS1YhWrCiS4gz7Xi34sdwMe9USZ7u\"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
18
+ "reissue": "reissue \"asset_name\" qty \"to_address\" \"change_address\" ( reissuable ) ( new_units) \"( new_ipfs )\" \n\nReissues a quantity of an asset to an owned address if you own the Owner Token\nCan change the reissuable flag during reissuance\nCan change the ipfs hash during reissuance\nFor dedicated DePIN assets (name starts with '&'), qty must stay positive and units must remain 0.\nArguments:\n1. \"asset_name\" (string, required) name of asset that is being reissued\n2. \"qty\" (numeric, required) number of assets to reissue\n3. \"to_address\" (string, required) address to send the asset to\n4. \"change_address\" (string, optional) address that the change of the transaction will be sent to\n5. \"reissuable\" (boolean, optional, default=true), whether future reissuance is allowed\n6. \"new_units\" (numeric, optional, default=-1), the new units that will be associated with the asset\n7. \"new_ipfs\" (string, optional, default=\"\"), whether to update the current ipfs hash or txid once RIP5 is active\n\nResult:\n\"txid\" (string) The transaction id\n\nExamples:\n> neurai-cli reissue \"ASSET_NAME\" 20 \"address\"\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"reissue\", \"params\": [\"ASSET_NAME\" 20 \"address\" \"change_address\" \"true\" 8 \"Qmd286K6pohQcTKYqnS1YhWrCiS4gz7Xi34sdwMe9USZ7u\"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
19
19
  "transfer": "transfer \"asset_name\" qty \"to_address\" \"message\" expire_time \"change_address\" \"asset_change_address\"\n\nTransfers a quantity of an owned asset to a given address\nArguments:\n1. \"asset_name\" (string, required) name of asset\n2. \"qty\" (numeric, required) number of assets you want to send to the address\n3. \"to_address\" (string, required) address to send the asset to\n4. \"message\" (string, optional) Once RIP5 is voted in ipfs hash or txid hash to send along with the transfer\n5. \"expire_time\" (numeric, optional) UTC timestamp of when the message expires\n6. \"change_address\" (string, optional, default = \"\") the transactions XNA change will be sent to this address\n7. \"asset_change_address\" (string, optional, default = \"\") the transactions Asset change will be sent to this address\n\nResult:\ntxid[ \ntxid\n]\n\nExamples:\n> neurai-cli transfer \"ASSET_NAME\" 20 \"address\" \"\" \"QmTqu3Lk3gmTsQVtjU7rYYM37EAW4xNmbuEAp2Mjr4AV7E\" 15863654\n> neurai-cli transfer \"ASSET_NAME\" 20 \"address\" \"\" \"QmTqu3Lk3gmTsQVtjU7rYYM37EAW4xNmbuEAp2Mjr4AV7E\" 15863654\n",
20
20
  "transferfromaddress": "transferfromaddress \"asset_name\" \"from_address\" qty \"to_address\" \"message\" expire_time \"xna_change_address\" \"asset_change_address\"\n\nTransfer a quantity of an owned asset in a specific address to a given address\nArguments:\n1. \"asset_name\" (string, required) name of asset\n2. \"from_address\" (string, required) address that the asset will be transferred from\n3. \"qty\" (numeric, required) number of assets you want to send to the address\n4. \"to_address\" (string, required) address to send the asset to\n5. \"message\" (string, optional) Once RIP5 is voted in ipfs hash or txid hash to send along with the transfer\n6. \"expire_time\" (numeric, optional) UTC timestamp of when the message expires\n7. \"xna_change_address\" (string, optional, default = \"\") the transaction XNA change will be sent to this address\n8. \"asset_change_address\" (string, optional, default = \"\") the transaction Asset change will be sent to this address\n\nResult:\ntxid[ \ntxid\n]\n\nExamples:\n> neurai-cli transferfromaddress \"ASSET_NAME\" \"fromaddress\" 20 \"address\" \"QmTqu3Lk3gmTsQVtjU7rYYM37EAW4xNmbuEAp2Mjr4AV7E\", 156545652\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"transferfromaddress\", \"params\": [\"ASSET_NAME\" \"fromaddress\" 20 \"address\" \"QmTqu3Lk3gmTsQVtjU7rYYM37EAW4xNmbuEAp2Mjr4AV7E\", 156545652] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
21
21
  "transferfromaddresses": "transferfromaddresses \"asset_name\" [\"from_addresses\"] qty \"to_address\" \"message\" expire_time \"xna_change_address\" \"asset_change_address\"\n\nTransfer a quantity of an owned asset in specific address(es) to a given address\nArguments:\n1. \"asset_name\" (string, required) name of asset\n2. \"from_addresses\" (array, required) list of from addresses to send from\n3. \"qty\" (numeric, required) number of assets you want to send to the address\n4. \"to_address\" (string, required) address to send the asset to\n5. \"message\" (string, optional) Once RIP5 is voted in ipfs hash or txid hash to send along with the transfer\n6. \"expire_time\" (numeric, optional) UTC timestamp of when the message expires\n7. \"xna_change_address\" (string, optional, default = \"\") the transactions XNA change will be sent to this address\n8. \"asset_change_address\" (string, optional, default = \"\") the transactions Asset change will be sent to this address\n\nResult:\ntxid[ \ntxid\n]\n\nExamples:\n> neurai-cli transferfromaddresses \"ASSET_NAME\" '[\"fromaddress1\", \"fromaddress2\"]' 20 \"to_address\" \"QmTqu3Lk3gmTsQVtjU7rYYM37EAW4xNmbuEAp2Mjr4AV7E\" 154652365\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"transferfromaddresses\", \"params\": [\"ASSET_NAME\" '[\"fromaddress1\", \"fromaddress2\"]' 20 \"to_address\" \"QmTqu3Lk3gmTsQVtjU7rYYM37EAW4xNmbuEAp2Mjr4AV7E\" 154652365] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
22
22
  "clearmempool": "clearmempool\n\nRemoves all transaction from the mempool\n\nExamples:\n> neurai-cli clearmempool \n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"clearmempool\", \"params\": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
23
- "checkdepinvalidity": "checkdepinvalidity \"asset_name\" \"address\"\n\nCheck if a DEPIN asset is valid/active for a specific address\n\nArguments:\n1. \"asset_name\" (string, required) The DEPIN asset name\n2. \"address\" (string, required) The address to check\n\nResult:\n{\n \"has_asset\": true|false, (boolean) Whether the address holds the asset\n \"amount\": n, (numeric) The amount (if has_asset is true)\n \"valid\": 1|0, (numeric) 1 = active/valid, 0 = blocked/revoked (if has_asset is true)\n \"blocked\": true|false (boolean) Whether the asset is blocked (if has_asset is true)\n}\n\nExamples:\n> neurai-cli checkdepinvalidity \"&FRANCE\" \"address\"\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"checkdepinvalidity\", \"params\": [\"&FRANCE\", \"address\"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
23
+ "checkdepinvalidity": "checkdepinvalidity \"asset_name\" \"address\"\n\nCheck if a dedicated DePIN asset is valid/active for a specific address. Dedicated DePIN assets currently use the '&' prefix.\n\nArguments:\n1. \"asset_name\" (string, required) The DePIN asset name\n2. \"address\" (string, required) The address to check\n\nResult:\n{\n \"has_asset\": true|false, (boolean) Whether the address holds the asset\n \"amount\": n, (numeric) The amount (if has_asset is true)\n \"valid\": 1|0, (numeric) 1 = active/valid, 0 = blocked/revoked (if has_asset is true)\n \"blocked\": true|false (boolean) Whether the asset is blocked (if has_asset is true)\n}\n\nExamples:\n> neurai-cli checkdepinvalidity \"&FRANCE\" \"address\"\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"checkdepinvalidity\", \"params\": [\"&FRANCE\", \"address\"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
24
24
  "depinclearmsg": "depinclearmsg ( \"all\" | hours )\n\nRemove messages from DePIN messaging pool\n\nArguments:\n1. mode (string or numeric, optional) Cleanup mode:\n - omitted: Remove only expired messages (default)\n - \"all\": Remove ALL messages from pool\n - <hours>: Remove messages older than specified hours (numeric)\n\nResult:\n{\n \"removed\": n, (numeric) Number of messages removed\n \"remaining\": n (numeric) Number of messages remaining\n}\n\nExamples:\n> neurai-cli depinclearmsg\n> neurai-cli depinclearmsg \"all\"\n> neurai-cli depinclearmsg 7\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"depinclearmsg\", \"params\": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
25
25
  "depingetmsg": "depingetmsg \"token\" (\"ip[:port]\"|\"fromaddress\") (\"fromaddress\")\n\nRetrieve and decrypt DePIN messages for your addresses\n\nArguments:\n1. \"token\" (string, required) Token name\n2. \"ip[:port]\" OR \"fromaddress\" (string, optional)\n - IP address with optional port (e.g., \"192.168.1.31\" or \"192.168.1.31:19002\")\n - OR Neurai address for local query with specific address\n - Omit for local query with all addresses\n3. \"fromaddress\" (string, optional) Specific address to decrypt with (only if arg 2 is an IP)\n\nResult:\n[\n {\n \"recipient\": \"address\", (string) Recipient address (your address)\n \"sender\": \"address\", (string) Sender address\n \"message\": \"text\", (string) Decrypted message\n \"timestamp\": n, (numeric) Unix timestamp\n \"date\": \"YYYY-MM-DD HH:MM:SS\", (string) Formatted date\n \"expires\": \"YYYY-MM-DD HH:MM:SS\" (string) Expiration date\n },\n ...\n]\n\nExamples:\n> neurai-cli depingetmsg \"MYTOKEN\"\n> neurai-cli depingetmsg \"MYTOKEN\" \"NXyouraddress...\"\n> neurai-cli depingetmsg \"MYTOKEN\" \"192.168.1.78\"\n> neurai-cli depingetmsg \"MYTOKEN\" \"192.168.1.78:19002\" \"NXyouraddress...\"\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"depingetmsg\", \"params\": [\"MYTOKEN\"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
26
26
  "depingetmsginfo": "depingetmsginfo\n\nReturns information about the DePIN messaging system\n\nResult:\n{\n \"enabled\": true|false, (boolean) Whether DePIN messaging is enabled\n \"token\": \"name\", (string) Active token name\n \"port\": n, (numeric) Listening port\n \"maxrecipients\": n, (numeric) Maximum recipients per message\n \"maxmessagesize\": n, (numeric) Maximum message size in bytes\n \"messageexpiryhours\": n, (numeric) Message expiry time in hours\n \"maxpoolsizemb\": n, (numeric) Maximum pool size in MB\n \"messages\": n, (numeric) Number of messages in mempool\n \"memoryusage\": n, (numeric) Memory usage in bytes\n \"memoryusagemb\": n, (numeric) Memory usage in MB\n \"oldestmessage\": \"time\", (string) Timestamp of oldest message\n \"newestmessage\": \"time\" (string) Timestamp of newest message\n}\n\nExamples:\n> neurai-cli depingetmsginfo\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"depingetmsginfo\", \"params\": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
@@ -29,10 +29,11 @@
29
29
  "depinpoolstats": "depinpoolstats\n\nGet statistical analysis of the DePIN message pool.\n\nResult:\n{\n \"enabled\": true|false,\n \"token\": \"string\",\n \"total_messages\": n,\n \"total_size_bytes\": n,\n \"memory_usage_bytes\": n,\n \"oldest_message\": \"YYYY-MM-DD HH:MM:SS\",\n \"newest_message\": \"YYYY-MM-DD HH:MM:SS\",\n \"messages_by_age\": {\n \"last_hour\": n,\n \"last_day\": n,\n \"last_week\": n\n },\n \"unique_senders\": n,\n \"avg_message_size\": n,\n \"expiring_in_24h\": n\n}\n\nExamples:\n> neurai-cli depinpoolstats\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"depinpoolstats\", \"params\": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
30
30
  "depinsendmsg": "depinsendmsg \"token\" \"ip[:port]\" \"message\" \"fromaddress\" (port)\n\nSend an encrypted message through a remote DePIN gateway (challenge/response)\n\nArguments:\n1. \"token\" (string, required) Token name\n2. \"ip[:port]\" (string, required) Target node address (optional :port to contact remote gateway)\n3. \"message\" (string, required) Message to send (max 1KB)\n4. \"fromaddress\" (string, required) Wallet address used for signing/encryption\n5. port (numeric, optional) Destination message port (defaults to 19002). Only used when specified after fromaddress\n\nResult:\n{\n \"result\": \"success\", (string) Status\n \"hash\": \"hash\", (string) Message hash\n \"recipients\": n, (numeric) Number of recipients\n \"timestamp\": n (numeric) Message timestamp\n}\n\nExamples:\n> neurai-cli depinsendmsg \"MYTOKEN\" \"192.168.1.100\" \"Hello team!\" \"NXsender...\"\n> neurai-cli depinsendmsg \"MYTOKEN\" \"192.168.1.100:19005\" \"Hello team!\" \"NXsender...\" 19005\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"depinsendmsg\", \"params\": [\"MYTOKEN\", \"192.168.1.100\", \"Hello team!\", \"NXsender...\"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
31
31
  "depinsubmitmsg": "depinsubmitmsg \"hexmessage\"\n\nSubmit a pre-encrypted and signed DePIN message to the pool\n\nThis is the secure protocol where the client prepares the complete message\n(encryption + signature) and the server only validates and stores it.\n\nArguments:\n1. \"hexmessage\" (string, required) Hex-encoded serialized CDepinMessage\n\nResult:\n{\n \"result\": \"success\", (string) Status\n \"hash\": \"hash\", (string) Message hash\n \"timestamp\": n (numeric) Unix timestamp\n}\n\nNote: This endpoint is typically called by remote nodes after challenge/response authentication.\n\nExamples:\n> neurai-cli depinsubmitmsg \"0a3f2e...\"\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"depinsubmitmsg\", \"params\": [\"0a3f2e...\"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
32
- "freezedepin": "freezedepin \"asset_name\" \"address\" (\"change_address\")\n\nFreeze a DEPIN asset for a specific address (owner only)\n\nThe address will still hold the asset but it will be marked as invalid\n\nRequires the owner token (ASSET!) in the wallet\n\nArguments:\n1. \"asset_name\" (string, required) The DEPIN asset name\n2. \"address\" (string, required) The address to freeze\n3. \"change_address\" (string, optional) The change address for the owner token\n\nResult:\n\"txid\" (string) The transaction id\n\nExamples:\n> neurai-cli freezedepin \"&FRANCE\" \"address\"\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"freezedepin\", \"params\": [\"&FRANCE\", \"address\"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
33
- "listdepinholders": "listdepinholders \"asset_name\"\n\nReturns all addresses holding a DEPIN asset with validity status\n\nDEPIN assets are soulbound (non-transferable except by owner) and can be frozen/revoked\n\nArguments:\n1. \"asset_name\" (string, required) The DEPIN asset name\n\nResult:\n[\n {\n \"address\": \"address\", (string) The address\n \"amount\": n, (numeric) The amount (always 1 for DEPIN)\n \"valid\": 1|0 (numeric) 1 = active/valid, 0 = blocked/revoked\n },\n ...\n]\n\nExamples:\n> neurai-cli listdepinholders \"&FRANCE\"\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"listdepinholders\", \"params\": [\"&FRANCE\"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
34
- "selfrevokedepin": "selfrevokedepin \"asset_name\"\n\nSelf-revoke a DEPIN asset held in this wallet\n\nThe asset will be marked as invalid but will remain in the address\n\nThis action can only be undone by the asset owner\n\nArguments:\n1. \"asset_name\" (string, required) The DEPIN asset name\n\nResult:\n\"txid\" (string) The transaction id\n\nExamples:\n> neurai-cli selfrevokedepin \"&FRANCE\"\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"selfrevokedepin\", \"params\": [\"&FRANCE\"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
35
- "unfreezedepin": "unfreezedepin \"asset_name\" \"address\" (\"change_address\")\n\nUnfreeze a DEPIN asset for a specific address (owner only)\n\nThe asset will be marked as valid again\n\nRequires the owner token (ASSET!) in the wallet\n\nArguments:\n1. \"asset_name\" (string, required) The DEPIN asset name\n2. \"address\" (string, required) The address to unfreeze\n3. \"change_address\" (string, optional) The change address for the owner token\n\nResult:\n\"txid\" (string) The transaction id\n\nExamples:\n> neurai-cli unfreezedepin \"&FRANCE\" \"address\"\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"unfreezedepin\", \"params\": [\"&FRANCE\", \"address\"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
32
+ "freezedepin": "freezedepin \"asset_name\" \"address\" (\"change_address\")\n\nFreeze a dedicated DePIN asset for a specific address (owner only)\n\nThe address will still hold the asset but it will be marked as invalid\n\nRequires the owner token for the DePIN asset (for example, '&FRANCE!' for '&FRANCE') in the wallet\n\nArguments:\n1. \"asset_name\" (string, required) The DePIN asset name\n2. \"address\" (string, required) The address to freeze\n3. \"change_address\" (string, optional) The change address for the owner token\n\nResult:\n\"txid\" (string) The transaction id\n\nExamples:\n> neurai-cli freezedepin \"&FRANCE\" \"address\"\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"freezedepin\", \"params\": [\"&FRANCE\", \"address\"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
33
+ "listdepinholders": "listdepinholders \"asset_name\"\n\nReturns all addresses holding a dedicated DePIN asset with validity status\n\nDedicated DePIN assets are soulbound and can be frozen/revoked. They currently use the '&' prefix.\n\nArguments:\n1. \"asset_name\" (string, required) The DePIN asset name\n\nResult:\n[\n {\n \"address\": \"address\", (string) The address\n \"amount\": n, (numeric) The amount held\n \"valid\": 1|0 (numeric) 1 = active/valid, 0 = blocked/revoked\n },\n ...\n]\n\nExamples:\n> neurai-cli listdepinholders \"&FRANCE\"\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"listdepinholders\", \"params\": [\"&FRANCE\"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
34
+ "listdepinaddresses": "listdepinaddresses \"asset_name\" (count) (start)\n\nReturns a list of addresses that own the given asset and have a revealed public key on-chain.\nUseful for DePIN messaging recipient discovery. Requires -assetindex and -pubkeyindex.\n\nArguments:\n1. \"asset_name\" (string, required) name of asset\n2. \"count\" (integer, optional, default=50000, MAX=50000) truncates results to include only the first _count_ addresses found\n3. \"start\" (integer, optional, default=0) results skip over the first _start_ addresses found (if negative it skips back from the end)\n\nResult:\n[\n {\n \"address\": \"address\", (string) The address\n \"pubkey\": \"pubkey_hex\" (string) The revealed public key in hex\n },\n ...\n]\n\nExamples:\n> neurai-cli listdepinaddresses \"&FRANCE\"\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"listdepinaddresses\", \"params\": [\"&FRANCE\"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
35
+ "selfrevokedepin": "selfrevokedepin \"asset_name\"\n\nSelf-revoke a dedicated DePIN asset held in this wallet\n\nThe asset will be marked as invalid but will remain in the address\n\nThis action can only be undone by the asset owner\n\nArguments:\n1. \"asset_name\" (string, required) The DePIN asset name\n\nResult:\n\"txid\" (string) The transaction id\n\nExamples:\n> neurai-cli selfrevokedepin \"&FRANCE\"\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"selfrevokedepin\", \"params\": [\"&FRANCE\"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
36
+ "unfreezedepin": "unfreezedepin \"asset_name\" \"address\" (\"change_address\")\n\nUnfreeze a dedicated DePIN asset for a specific address (owner only)\n\nThe asset will be marked as valid again\n\nRequires the owner token for the DePIN asset (for example, '&FRANCE!' for '&FRANCE') in the wallet\n\nArguments:\n1. \"asset_name\" (string, required) The DePIN asset name\n2. \"address\" (string, required) The address to unfreeze\n3. \"change_address\" (string, optional) The change address for the owner token\n\nResult:\n\"txid\" (string) The transaction id\n\nExamples:\n> neurai-cli unfreezedepin \"&FRANCE\" \"address\"\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"unfreezedepin\", \"params\": [\"&FRANCE\", \"address\"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
36
37
  "decodeblock": "decodeblock \"blockhex\"\n\nArguments:\n1. \"blockhex\" (string, required) The block hex\n\nResult:\n{\n \"hash\" : \"hash\", (string) the block hash (same as provided)\n \"size\" : n, (numeric) The block size\n \"strippedsize\" : n, (numeric) The block size excluding witness data\n \"weight\" : n (numeric) The block weight as defined in BIP 141\n \"height\" : n, (numeric) The block height or index\n \"version\" : n, (numeric) The block version\n \"versionHex\" : \"00000000\", (string) The block version formatted in hexadecimal\n \"merkleroot\" : \"xxxx\", (string) The merkle root\n \"tx\" : [ (array of string) The transaction ids\n \"transactionid\" (string) The transaction id\n ,...\n ],\n \"time\" : ttt, (numeric) The block time in seconds since epoch (Jan 1 1970 GMT)\n \"nonce\" : n, (numeric) The nonce\n \"bits\" : \"1d00ffff\", (string) The bits\n}\n\nExamples:\n> neurai-cli decodeblock \"xxxx\"\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"decodeblock\", \"params\": [\"xxxx\"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
37
38
  "getbestblockhash": "getbestblockhash\n\nReturns the hash of the best (tip) block in the longest blockchain.\n\nResult:\n\"hex\" (string) the block hash hex encoded\n\nExamples:\n> neurai-cli getbestblockhash \n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"getbestblockhash\", \"params\": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
38
39
  "getblock": "getblock \"blockhash\" ( verbosity ) \n\nIf verbosity is 0, returns a string that is serialized, hex-encoded data for block 'hash'.\nIf verbosity is 1, returns an Object with information about block <hash>.\nIf verbosity is 2, returns an Object with information about block <hash> and information about each transaction. \n\nArguments:\n1. \"blockhash\" (string, required) The block hash\n2. verbosity (numeric, optional, default=1) 0 for hex encoded data, 1 for a json object, and 2 for json object with transaction data\n\nResult (for verbosity = 0):\n\"data\" (string) A string that is serialized, hex-encoded data for block 'hash'.\n\nResult (for verbosity = 1):\n{\n \"hash\" : \"hash\", (string) the block hash (same as provided)\n \"confirmations\" : n, (numeric) The number of confirmations, or -1 if the block is not on the main chain\n \"size\" : n, (numeric) The block size\n \"strippedsize\" : n, (numeric) The block size excluding witness data\n \"weight\" : n (numeric) The block weight as defined in BIP 141\n \"height\" : n, (numeric) The block height or index\n \"version\" : n, (numeric) The block version\n \"versionHex\" : \"00000000\", (string) The block version formatted in hexadecimal\n \"merkleroot\" : \"xxxx\", (string) The merkle root\n \"tx\" : [ (array of string) The transaction ids\n \"transactionid\" (string) The transaction id\n ,...\n ],\n \"time\" : ttt, (numeric) The block time in seconds since epoch (Jan 1 1970 GMT)\n \"mediantime\" : ttt, (numeric) The median block time in seconds since epoch (Jan 1 1970 GMT)\n \"nonce\" : n, (numeric) The nonce\n \"bits\" : \"1d00ffff\", (string) The bits\n \"difficulty\" : x.xxx, (numeric) The difficulty\n \"chainwork\" : \"xxxx\", (string) Expected number of hashes required to produce the chain up to this block (in hex)\n \"previousblockhash\" : \"hash\", (string) The hash of the previous block\n \"nextblockhash\" : \"hash\" (string) The hash of the next block\n}\n\nResult (for verbosity = 2):\n{\n ..., Same output as verbosity = 1.\n \"tx\" : [ (array of Objects) The transactions in the format of the getrawtransaction RPC. Different from verbosity = 1 \"tx\" result.\n ,...\n ],\n ,... Same output as verbosity = 1.\n}\n\nExamples:\n> neurai-cli getblock \"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\"\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"getblock\", \"params\": [\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
@@ -90,6 +91,7 @@
90
91
  "getnetworkinfo": "getnetworkinfo\nReturns an object containing various state info regarding P2P networking.\n\nResult:\n{\n \"version\": xxxxx, (numeric) the server version\n \"subversion\": \"/Satoshi:x.x.x/\", (string) the server subversion string\n \"protocolversion\": xxxxx, (numeric) the protocol version\n \"localservices\": \"xxxxxxxxxxxxxxxx\", (string) the services we offer to the network\n \"localrelay\": true|false, (bool) true if transaction relay is requested from peers\n \"timeoffset\": xxxxx, (numeric) the time offset\n \"connections\": xxxxx, (numeric) the number of connections\n \"networkactive\": true|false, (bool) whether p2p networking is enabled\n \"networks\": [ (array) information per network\n {\n \"name\": \"xxx\", (string) network (ipv4, ipv6 or onion)\n \"limited\": true|false, (boolean) is the network limited using -onlynet?\n \"reachable\": true|false, (boolean) is the network reachable?\n \"proxy\": \"host:port\" (string) the proxy that is used for this network, or empty if none\n \"proxy_randomize_credentials\": true|false, (string) Whether randomized credentials are used\n }\n ,...\n ],\n \"relayfee\": x.xxxxxxxx, (numeric) minimum relay fee for transactions in XNA/kB\n \"incrementalfee\": x.xxxxxxxx, (numeric) minimum fee increment for mempool limiting or BIP 125 replacement in XNA/kB\n \"localaddresses\": [ (array) list of local addresses\n {\n \"address\": \"xxxx\", (string) network address\n \"port\": xxx, (numeric) network port\n \"score\": xxx (numeric) relative score\n }\n ,...\n ]\n \"warnings\": \"...\" (string) any network and blockchain warnings\n}\n\nExamples:\n> neurai-cli getnetworkinfo \n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"getnetworkinfo\", \"params\": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
91
92
  "getpeerinfo": "getpeerinfo\n\nReturns data about each connected network node as a json array of objects.\n\nResult:\n[\n {\n \"id\": n, (numeric) Peer index\n \"addr\":\"host:port\", (string) The IP address and port of the peer\n \"addrbind\":\"ip:port\", (string) Bind address of the connection to the peer\n \"addrlocal\":\"ip:port\", (string) Local address as reported by the peer\n \"services\":\"xxxxxxxxxxxxxxxx\", (string) The services offered\n \"relaytxes\":true|false, (boolean) Whether peer has asked us to relay transactions to it\n \"lastsend\": ttt, (numeric) The time in seconds since epoch (Jan 1 1970 GMT) of the last send\n \"lastrecv\": ttt, (numeric) The time in seconds since epoch (Jan 1 1970 GMT) of the last receive\n \"bytessent\": n, (numeric) The total bytes sent\n \"bytesrecv\": n, (numeric) The total bytes received\n \"conntime\": ttt, (numeric) The connection time in seconds since epoch (Jan 1 1970 GMT)\n \"timeoffset\": ttt, (numeric) The time offset in seconds\n \"pingtime\": n, (numeric) ping time (if available)\n \"minping\": n, (numeric) minimum observed ping time (if any at all)\n \"pingwait\": n, (numeric) ping wait (if non-zero)\n \"version\": v, (numeric) The peer version, such as 7001\n \"subver\": \"/Satoshi:0.8.5/\", (string) The string version\n \"inbound\": true|false, (boolean) Inbound (true) or Outbound (false)\n \"addnode\": true|false, (boolean) Whether connection was due to addnode/-connect or if it was an automatic/inbound connection\n \"startingheight\": n, (numeric) The starting height (block) of the peer\n \"banscore\": n, (numeric) The ban score\n \"synced_headers\": n, (numeric) The last header we have in common with this peer\n \"synced_blocks\": n, (numeric) The last block we have in common with this peer\n \"inflight\": [\n n, (numeric) The heights of blocks we're currently asking from this peer\n ...\n ],\n \"whitelisted\": true|false, (boolean) Whether the peer is whitelisted\n \"bytessent_per_msg\": {\n \"addr\": n, (numeric) The total bytes sent aggregated by message type\n ...\n },\n \"bytesrecv_per_msg\": {\n \"addr\": n, (numeric) The total bytes received aggregated by message type\n ...\n }\n }\n ,...\n]\n\nExamples:\n> neurai-cli getpeerinfo \n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"getpeerinfo\", \"params\": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
92
93
  "getpubkey": "getpubkey \"address\"\n\nReturns the public key for an address that has revealed it by spending (requires pubkeyindex to be enabled).\n\nArguments:\n1. \"address\" (string, required) The Neurai address\n\nResult:\n{\n \"address\": \"address\", (string) The Neurai address\n \"pubkey\": \"hex\", (string) The public key in hex format\n \"revealed\": true|false, (boolean) Whether the public key has been revealed\n \"height\": n, (numeric) Block height where it was revealed\n \"txid\": \"hash\" (string) Transaction ID where it was revealed\n}\n\nExamples:\n> neurai-cli getpubkey \"NXa1b2c3d4e5f6...\"\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"getpubkey\", \"params\": [\"NXa1b2c3d4e5f6...\"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
94
+ "listpqaddresses": "listpqaddresses\n\nReturns post-quantum (ML-DSA-44) Bech32m addresses in the wallet.\n\nResult:\n[\n \"nq1...\", (string) A post-quantum wallet address\n ...\n]\n\nExamples:\n> neurai-cli listpqaddresses\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"listpqaddresses\", \"params\": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
93
95
  "listbanned": "listbanned\n\nList all banned IPs/Subnets.\n\nExamples:\n> neurai-cli listbanned \n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"listbanned\", \"params\": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
94
96
  "ping": "ping\n\nRequests that a ping be sent to all other nodes, to measure ping time.\nResults provided in getpeerinfo, pingtime and pingwait fields are decimal seconds.\nPing command is handled in queue with all other commands, so it measures processing backlog, not just network ping.\n\nExamples:\n> neurai-cli ping \n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"ping\", \"params\": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
95
97
  "setban": "setban \"subnet\" \"add|remove\" (bantime) (absolute)\n\nAttempts to add or remove an IP/Subnet from the banned list.\n\nArguments:\n1. \"subnet\" (string, required) The IP/Subnet (see getpeerinfo for nodes IP) with an optional netmask (default is /32 = single IP)\n2. \"command\" (string, required) 'add' to add an IP/Subnet to the list, 'remove' to remove an IP/Subnet from the list\n3. \"bantime\" (numeric, optional) time in seconds how long (or until when if [absolute] is set) the IP is banned (0 or empty means using the default time of 24h which can also be overwritten by the -bantime startup argument)\n4. \"absolute\" (boolean, optional) If set, the bantime must be an absolute timestamp in seconds since epoch (Jan 1 1970 GMT)\n\nExamples:\n> neurai-cli setban \"192.168.0.6\" \"add\" 86400\n> neurai-cli setban \"192.168.0.0/24\" \"add\"\n> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", \"method\": \"setban\", \"params\": [\"192.168.0.6\", \"add\", 86400] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/\n",
package/docs.ts CHANGED
@@ -122,10 +122,12 @@ listaddressrestrictions: string;
122
122
  listassetbalancesbyaddress: string;
123
123
  listassets: string;
124
124
  listbanned: string;
125
+ listdepinaddresses: string;
125
126
  listdepinholders: string;
126
127
  listglobalrestrictions: string;
127
128
  listlockunspent: string;
128
129
  listmyassets: string;
130
+ listpqaddresses: string;
129
131
  listreceivedbyaccount: string;
130
132
  listreceivedbyaddress: string;
131
133
  listsinceblock: string;
@@ -425,10 +427,10 @@ checkaddresstag:'checkaddresstag',
425
427
 
426
428
  /** checkdepinvalidity "asset_name" "address"
427
429
 
428
- Check if a DEPIN asset is valid/active for a specific address
430
+ Check if a dedicated DePIN asset is valid/active for a specific address. Dedicated DePIN assets currently use the '&' prefix.
429
431
 
430
432
  Arguments:
431
- 1. "asset_name" (string, required) The DEPIN asset name
433
+ 1. "asset_name" (string, required) The DePIN asset name
432
434
  2. "address" (string, required) The address to check
433
435
 
434
436
  Result:
@@ -1456,14 +1458,14 @@ freezeaddress:'freezeaddress',
1456
1458
 
1457
1459
  /** freezedepin "asset_name" "address" ("change_address")
1458
1460
 
1459
- Freeze a DEPIN asset for a specific address (owner only)
1461
+ Freeze a dedicated DePIN asset for a specific address (owner only)
1460
1462
 
1461
1463
  The address will still hold the asset but it will be marked as invalid
1462
1464
 
1463
- Requires the owner token (ASSET!) in the wallet
1465
+ Requires the owner token for the DePIN asset (for example, '&FRANCE!' for '&FRANCE') in the wallet
1464
1466
 
1465
1467
  Arguments:
1466
- 1. "asset_name" (string, required) The DEPIN asset name
1468
+ 1. "asset_name" (string, required) The DePIN asset name
1467
1469
  2. "address" (string, required) The address to freeze
1468
1470
  3. "change_address" (string, optional) The change address for the owner token
1469
1471
 
@@ -3696,6 +3698,7 @@ Asset name must not conflict with any existing asset.
3696
3698
  Unit as the number of decimals precision for the asset (0 for whole units ("1"), 8 for max precision ("1.00000000")
3697
3699
  Reissuable is true/false for whether additional units can be issued by the original issuer.
3698
3700
  If issuing a unique asset these values are required (and will be defaulted to): qty=1, units=0, reissuable=false.
3701
+ Dedicated DePIN assets (name starts with '&') are documented here as enabled for mainnet and testnet, with qty > 0 and units=0.
3699
3702
 
3700
3703
  Arguments:
3701
3704
  1. "asset_name" (string, required) a unique name
@@ -4076,20 +4079,49 @@ listbanned:'listbanned',
4076
4079
 
4077
4080
 
4078
4081
 
4082
+ /** listdepinaddresses "asset_name" (count) (start)
4083
+
4084
+ Returns a list of addresses that own the given asset and have a revealed public key on-chain.
4085
+ Useful for DePIN messaging recipient discovery. Requires -assetindex and -pubkeyindex.
4086
+
4087
+ Arguments:
4088
+ 1. "asset_name" (string, required) name of asset
4089
+ 2. "count" (integer, optional, default=50000, MAX=50000) truncates results to include only the first _count_ addresses found
4090
+ 3. "start" (integer, optional, default=0) results skip over the first _start_ addresses found (if negative it skips back from the end)
4091
+
4092
+ Result:
4093
+ [
4094
+ {
4095
+ "address": "address", (string) The address
4096
+ "pubkey": "pubkey_hex" (string) The revealed public key in hex
4097
+ },
4098
+ ...
4099
+ ]
4100
+
4101
+ Examples:
4102
+ > neurai-cli listdepinaddresses "&FRANCE"
4103
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listdepinaddresses", "params": ["&FRANCE"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
4104
+ **/
4105
+ listdepinaddresses:'listdepinaddresses',
4106
+
4107
+
4108
+
4109
+
4110
+
4079
4111
  /** listdepinholders "asset_name"
4080
4112
 
4081
- Returns all addresses holding a DEPIN asset with validity status
4113
+ Returns all addresses holding a dedicated DePIN asset with validity status
4082
4114
 
4083
- DEPIN assets are soulbound (non-transferable except by owner) and can be frozen/revoked
4115
+ Dedicated DePIN assets are soulbound and can be frozen/revoked. They currently use the '&' prefix.
4084
4116
 
4085
4117
  Arguments:
4086
- 1. "asset_name" (string, required) The DEPIN asset name
4118
+ 1. "asset_name" (string, required) The DePIN asset name
4087
4119
 
4088
4120
  Result:
4089
4121
  [
4090
4122
  {
4091
4123
  "address": "address", (string) The address
4092
- "amount": n, (numeric) The amount (always 1 for DEPIN)
4124
+ "amount": n, (numeric) The amount held
4093
4125
  "valid": 1|0 (numeric) 1 = active/valid, 0 = blocked/revoked
4094
4126
  },
4095
4127
  ...
@@ -4208,6 +4240,26 @@ listmyassets:'listmyassets',
4208
4240
 
4209
4241
 
4210
4242
 
4243
+ /** listpqaddresses
4244
+
4245
+ Returns post-quantum (ML-DSA-44) Bech32m addresses in the wallet.
4246
+
4247
+ Result:
4248
+ [
4249
+ "nq1...", (string) A post-quantum wallet address
4250
+ ...
4251
+ ]
4252
+
4253
+ Examples:
4254
+ > neurai-cli listpqaddresses
4255
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listpqaddresses", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
4256
+ **/
4257
+ listpqaddresses:'listpqaddresses',
4258
+
4259
+
4260
+
4261
+
4262
+
4211
4263
  /** listreceivedbyaccount ( minconf include_empty include_watchonly)
4212
4264
 
4213
4265
  DEPRECATED. List balances by account.
@@ -4737,6 +4789,7 @@ purgesnapshot:'purgesnapshot',
4737
4789
  Reissues a quantity of an asset to an owned address if you own the Owner Token
4738
4790
  Can change the reissuable flag during reissuance
4739
4791
  Can change the ipfs hash during reissuance
4792
+ For dedicated DePIN assets (name starts with '&'), qty must stay positive and units must remain 0.
4740
4793
  Arguments:
4741
4794
  1. "asset_name" (string, required) name of asset that is being reissued
4742
4795
  2. "qty" (numeric, required) number of assets to reissue
@@ -4898,14 +4951,14 @@ savemempool:'savemempool',
4898
4951
 
4899
4952
  /** selfrevokedepin "asset_name"
4900
4953
 
4901
- Self-revoke a DEPIN asset held in this wallet
4954
+ Self-revoke a dedicated DePIN asset held in this wallet
4902
4955
 
4903
4956
  The asset will be marked as invalid but will remain in the address
4904
4957
 
4905
4958
  This action can only be undone by the asset owner
4906
4959
 
4907
4960
  Arguments:
4908
- 1. "asset_name" (string, required) The DEPIN asset name
4961
+ 1. "asset_name" (string, required) The DePIN asset name
4909
4962
 
4910
4963
  Result:
4911
4964
  "txid" (string) The transaction id
@@ -5585,14 +5638,14 @@ unfreezeaddress:'unfreezeaddress',
5585
5638
 
5586
5639
  /** unfreezedepin "asset_name" "address" ("change_address")
5587
5640
 
5588
- Unfreeze a DEPIN asset for a specific address (owner only)
5641
+ Unfreeze a dedicated DePIN asset for a specific address (owner only)
5589
5642
 
5590
5643
  The asset will be marked as valid again
5591
5644
 
5592
- Requires the owner token (ASSET!) in the wallet
5645
+ Requires the owner token for the DePIN asset (for example, '&FRANCE!' for '&FRANCE') in the wallet
5593
5646
 
5594
5647
  Arguments:
5595
- 1. "asset_name" (string, required) The DEPIN asset name
5648
+ 1. "asset_name" (string, required) The DePIN asset name
5596
5649
  2. "address" (string, required) The address to unfreeze
5597
5650
  3. "change_address" (string, optional) The change address for the owner token
5598
5651
 
package/neurai_methods.md CHANGED
@@ -189,10 +189,10 @@ Examples:
189
189
  ## checkdepinvalidity
190
190
  &nbsp;<br/> checkdepinvalidity "asset_name" "address"
191
191
 
192
- Check if a DEPIN asset is valid/active for a specific address
192
+ Check if a dedicated DePIN asset is valid/active for a specific address. Dedicated DePIN assets currently use the '&' prefix.
193
193
 
194
194
  Arguments:
195
- 1. "asset_name" (string, required) The DEPIN asset name
195
+ 1. "asset_name" (string, required) The DePIN asset name
196
196
  2. "address" (string, required) The address to check
197
197
 
198
198
  Result:
@@ -1112,14 +1112,14 @@ Examples:
1112
1112
  ## freezedepin
1113
1113
  &nbsp;<br/> freezedepin "asset_name" "address" ("change_address")
1114
1114
 
1115
- Freeze a DEPIN asset for a specific address (owner only)
1115
+ Freeze a dedicated DePIN asset for a specific address (owner only)
1116
1116
 
1117
1117
  The address will still hold the asset but it will be marked as invalid
1118
1118
 
1119
- Requires the owner token (ASSET!) in the wallet
1119
+ Requires the owner token for the DePIN asset (for example, '&FRANCE!' for '&FRANCE') in the wallet
1120
1120
 
1121
1121
  Arguments:
1122
- 1. "asset_name" (string, required) The DEPIN asset name
1122
+ 1. "asset_name" (string, required) The DePIN asset name
1123
1123
  2. "address" (string, required) The address to freeze
1124
1124
  3. "change_address" (string, optional) The change address for the owner token
1125
1125
 
@@ -3072,6 +3072,7 @@ Asset name must not conflict with any existing asset.
3072
3072
  Unit as the number of decimals precision for the asset (0 for whole units ("1"), 8 for max precision ("1.00000000")
3073
3073
  Reissuable is true/false for whether additional units can be issued by the original issuer.
3074
3074
  If issuing a unique asset these values are required (and will be defaulted to): qty=1, units=0, reissuable=false.
3075
+ Dedicated DePIN assets (name starts with '&') are documented here as enabled for mainnet and testnet, with qty > 0 and units=0.
3075
3076
 
3076
3077
  Arguments:
3077
3078
  1. "asset_name" (string, required) a unique name
@@ -3394,22 +3395,47 @@ Examples:
3394
3395
  > neurai-cli listbanned
3395
3396
  > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listbanned", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3396
3397
 
3398
+ &nbsp;<br> &nbsp;<br/>
3399
+ ## listdepinaddresses
3400
+ &nbsp;<br/> listdepinaddresses "asset_name" (count) (start)
3401
+
3402
+ Returns a list of addresses that own the given asset and have a revealed public key on-chain.
3403
+ Useful for DePIN messaging recipient discovery. Requires -assetindex and -pubkeyindex.
3404
+
3405
+ Arguments:
3406
+ 1. "asset_name" (string, required) name of asset
3407
+ 2. "count" (integer, optional, default=50000, MAX=50000) truncates results to include only the first _count_ addresses found
3408
+ 3. "start" (integer, optional, default=0) results skip over the first _start_ addresses found (if negative it skips back from the end)
3409
+
3410
+ Result:
3411
+ [
3412
+ {
3413
+ "address": "address", (string) The address
3414
+ "pubkey": "pubkey_hex" (string) The revealed public key in hex
3415
+ },
3416
+ ...
3417
+ ]
3418
+
3419
+ Examples:
3420
+ > neurai-cli listdepinaddresses "&FRANCE"
3421
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listdepinaddresses", "params": ["&FRANCE"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3422
+
3397
3423
  &nbsp;<br> &nbsp;<br/>
3398
3424
  ## listdepinholders
3399
3425
  &nbsp;<br/> listdepinholders "asset_name"
3400
3426
 
3401
- Returns all addresses holding a DEPIN asset with validity status
3427
+ Returns all addresses holding a dedicated DePIN asset with validity status
3402
3428
 
3403
- DEPIN assets are soulbound (non-transferable except by owner) and can be frozen/revoked
3429
+ Dedicated DePIN assets are soulbound and can be frozen/revoked. They currently use the '&' prefix.
3404
3430
 
3405
3431
  Arguments:
3406
- 1. "asset_name" (string, required) The DEPIN asset name
3432
+ 1. "asset_name" (string, required) The DePIN asset name
3407
3433
 
3408
3434
  Result:
3409
3435
  [
3410
3436
  {
3411
3437
  "address": "address", (string) The address
3412
- "amount": n, (numeric) The amount (always 1 for DEPIN)
3438
+ "amount": n, (numeric) The amount held
3413
3439
  "valid": 1|0 (numeric) 1 = active/valid, 0 = blocked/revoked
3414
3440
  },
3415
3441
  ...
@@ -3510,6 +3536,22 @@ Examples:
3510
3536
  > neurai-cli listmyassets "ASSET*" true 10 20
3511
3537
  > neurai-cli listmyassets "ASSET*" true 10 20 1
3512
3538
 
3539
+ &nbsp;<br> &nbsp;<br/>
3540
+ ## listpqaddresses
3541
+ &nbsp;<br/> listpqaddresses
3542
+
3543
+ Returns post-quantum (ML-DSA-44) Bech32m addresses in the wallet.
3544
+
3545
+ Result:
3546
+ [
3547
+ "nq1...", (string) A post-quantum wallet address
3548
+ ...
3549
+ ]
3550
+
3551
+ Examples:
3552
+ > neurai-cli listpqaddresses
3553
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listpqaddresses", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3554
+
3513
3555
  &nbsp;<br> &nbsp;<br/>
3514
3556
  ## listreceivedbyaccount
3515
3557
  &nbsp;<br/> listreceivedbyaccount ( minconf include_empty include_watchonly)
@@ -3977,6 +4019,7 @@ Examples:
3977
4019
  Reissues a quantity of an asset to an owned address if you own the Owner Token
3978
4020
  Can change the reissuable flag during reissuance
3979
4021
  Can change the ipfs hash during reissuance
4022
+ For dedicated DePIN assets (name starts with '&'), qty must stay positive and units must remain 0.
3980
4023
  Arguments:
3981
4024
  1. "asset_name" (string, required) name of asset that is being reissued
3982
4025
  2. "qty" (numeric, required) number of assets to reissue
@@ -4110,14 +4153,14 @@ Examples:
4110
4153
  ## selfrevokedepin
4111
4154
  &nbsp;<br/> selfrevokedepin "asset_name"
4112
4155
 
4113
- Self-revoke a DEPIN asset held in this wallet
4156
+ Self-revoke a dedicated DePIN asset held in this wallet
4114
4157
 
4115
4158
  The asset will be marked as invalid but will remain in the address
4116
4159
 
4117
4160
  This action can only be undone by the asset owner
4118
4161
 
4119
4162
  Arguments:
4120
- 1. "asset_name" (string, required) The DEPIN asset name
4163
+ 1. "asset_name" (string, required) The DePIN asset name
4121
4164
 
4122
4165
  Result:
4123
4166
  "txid" (string) The transaction id
@@ -4701,14 +4744,14 @@ Examples:
4701
4744
  ## unfreezedepin
4702
4745
  &nbsp;<br/> unfreezedepin "asset_name" "address" ("change_address")
4703
4746
 
4704
- Unfreeze a DEPIN asset for a specific address (owner only)
4747
+ Unfreeze a dedicated DePIN asset for a specific address (owner only)
4705
4748
 
4706
4749
  The asset will be marked as valid again
4707
4750
 
4708
- Requires the owner token (ASSET!) in the wallet
4751
+ Requires the owner token for the DePIN asset (for example, '&FRANCE!' for '&FRANCE') in the wallet
4709
4752
 
4710
4753
  Arguments:
4711
- 1. "asset_name" (string, required) The DEPIN asset name
4754
+ 1. "asset_name" (string, required) The DePIN asset name
4712
4755
  2. "address" (string, required) The address to unfreeze
4713
4756
  3. "change_address" (string, optional) The change address for the owner token
4714
4757
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@neuraiproject/neurai-rpc",
3
- "version": "0.4.6",
3
+ "version": "0.4.7",
4
4
  "description": "Helps you access your Neurai full node using RPC from JavaScript",
5
5
  "types": "dist/types.d.ts",
6
6
  "type": "module",