@neuraiproject/neurai-rpc 0.2.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.
@@ -0,0 +1,4580 @@
1
+ # Neurai remote procedure calls/methods
2
+ [Home](README.md)
3
+ &nbsp;<br> &nbsp;<br/>
4
+ ## abandontransaction
5
+ &nbsp;<br/> abandontransaction "txid"
6
+
7
+ Mark in-wallet transaction <txid> as abandoned
8
+ This will mark this transaction and all its in-wallet descendants as abandoned which will allow
9
+ for their inputs to be respent. It can be used to replace "stuck" or evicted transactions.
10
+ It only works on transactions which are not included in a block and are not currently in the mempool.
11
+ It has no effect on transactions which are already conflicted or abandoned.
12
+
13
+ Arguments:
14
+ 1. "txid" (string, required) The transaction id
15
+
16
+ Result:
17
+
18
+ Examples:
19
+ > raven-cli abandontransaction "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"
20
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "abandontransaction", "params": ["1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
21
+
22
+ &nbsp;<br> &nbsp;<br/>
23
+ ## abortrescan
24
+ &nbsp;<br/> abortrescan
25
+
26
+ Stops current wallet rescan triggered e.g. by an importprivkey call.
27
+
28
+ Examples:
29
+
30
+ Import a private key
31
+ > raven-cli importprivkey "mykey"
32
+
33
+ Abort the running wallet rescan
34
+ > raven-cli abortrescan
35
+
36
+ As a JSON-RPC call
37
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "abortrescan", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
38
+
39
+ &nbsp;<br> &nbsp;<br/>
40
+ ## addmultisigaddress
41
+ &nbsp;<br/> addmultisigaddress nrequired ["key",...] ( "account" )
42
+
43
+ Add a nrequired-to-sign multisignature address to the wallet.
44
+ Each key is a Raven address or hex-encoded public key.
45
+ If 'account' is specified (DEPRECATED), assign address to that account.
46
+
47
+ Arguments:
48
+ 1. nrequired (numeric, required) The number of required signatures out of the n keys or addresses.
49
+ 2. "keys" (string, required) A json array of raven addresses or hex-encoded public keys
50
+ [
51
+ "address" (string) raven address or hex-encoded public key
52
+ ...,
53
+ ]
54
+ 3. "account" (string, optional) DEPRECATED. An account to assign the addresses to.
55
+
56
+ Result:
57
+ "address" (string) A raven address associated with the keys.
58
+
59
+ Examples:
60
+
61
+ Add a multisig address from 2 addresses
62
+ > raven-cli addmultisigaddress 2 "[\"16sSauSf5pF2UkUwvKGq4qjNRzBZYqgEL5\",\"171sgjn4YtPu27adkKGrdDwzRTxnRkBfKV\"]"
63
+
64
+ As json rpc call
65
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "addmultisigaddress", "params": [2, "[\"16sSauSf5pF2UkUwvKGq4qjNRzBZYqgEL5\",\"171sgjn4YtPu27adkKGrdDwzRTxnRkBfKV\"]"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
66
+
67
+ &nbsp;<br> &nbsp;<br/>
68
+ ## addnode
69
+ &nbsp;<br/> addnode "node" "add|remove|onetry"
70
+
71
+ Attempts to add or remove a node from the addnode list.
72
+ Or try a connection to a node once.
73
+ Nodes added using addnode (or -connect) are protected from DoS disconnection and are not required to be
74
+ full nodes/support SegWit as other outbound peers are (though such peers will not be synced from).
75
+
76
+ Arguments:
77
+ 1. "node" (string, required) The node (see getpeerinfo for nodes)
78
+ 2. "command" (string, required) 'add' to add a node to the list, 'remove' to remove a node from the list, 'onetry' to try a connection to the node once
79
+
80
+ Examples:
81
+ > raven-cli addnode "192.168.0.6:8767" "onetry"
82
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "addnode", "params": ["192.168.0.6:8767", "onetry"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
83
+
84
+ &nbsp;<br> &nbsp;<br/>
85
+ ## addtagtoaddress
86
+ &nbsp;<br/> addtagtoaddress tag_name to_address (change_address) (asset_data)
87
+
88
+ Assign a tag to a address
89
+
90
+ Arguments:
91
+ 1. "tag_name" (string, required) the name of the tag you are assigning to the address, if it doens't have '#' at the front it will be added
92
+ 2. "to_address" (string, required) the address that will be assigned the tag
93
+ 3. "change_address" (string, optional) The change address for the qualifier token to be sent to
94
+ 4. "asset_data" (string, optional) The asset data (ipfs or a hash) to be applied to the transfer of the qualifier token
95
+
96
+ Result:
97
+ "txid" (string) The transaction id
98
+
99
+ Examples:
100
+ > raven-cli addtagtoaddress "#TAG" "to_address"
101
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "addtagtoaddress", "params": ["#TAG" "to_address"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
102
+ > raven-cli addtagtoaddress "#TAG" "to_address" "change_address"
103
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "addtagtoaddress", "params": ["#TAG" "to_address" "change_address"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
104
+
105
+ &nbsp;<br> &nbsp;<br/>
106
+ ## addwitnessaddress
107
+ &nbsp;<br/> addwitnessaddress "address"
108
+
109
+ Add a witness address for a script (with pubkey or redeemscript known).
110
+ It returns the witness script.
111
+
112
+ Arguments:
113
+ 1. "address" (string, required) An address known to the wallet
114
+
115
+ Result:
116
+ "witnessaddress", (string) The value of the new address (P2SH of witness script).
117
+ }
118
+
119
+ &nbsp;<br> &nbsp;<br/>
120
+ ## backupwallet
121
+ &nbsp;<br/> backupwallet "destination"
122
+
123
+ Safely copies current wallet file to destination, which can be a directory or a path with filename.
124
+
125
+ Arguments:
126
+ 1. "destination" (string) The destination directory or file
127
+
128
+ Examples:
129
+ > raven-cli backupwallet "backup.dat"
130
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "backupwallet", "params": ["backup.dat"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
131
+
132
+ &nbsp;<br> &nbsp;<br/>
133
+ ## bumpfee
134
+ &nbsp;<br/> bumpfee has been deprecated on the XNA Wallet.
135
+ &nbsp;<br> &nbsp;<br/>
136
+ ## cancelsnapshotrequest
137
+ &nbsp;<br/> cancelsnapshotrequest "asset_name" block_height
138
+
139
+ Cancels the specified snapshot request.
140
+
141
+ Arguments:
142
+ 1. "asset_name" (string, required) The asset name for which the snapshot will be taken
143
+ 2. "block_height" (number, required) The block height at which the snapshot will be take
144
+
145
+ Result:
146
+ {
147
+ request_status: (string),
148
+ }
149
+
150
+ Examples:
151
+ > raven-cli cancelsnapshotrequest "TRONCO" 12345
152
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "cancelsnapshotrequest", "params": ["PHATSTACKS" 34987] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
153
+
154
+ &nbsp;<br> &nbsp;<br/>
155
+ ## checkaddressrestriction
156
+ &nbsp;<br/> checkaddressrestriction address restricted_name
157
+
158
+ Checks to see if an address has been frozen by the given restricted asset
159
+
160
+ Arguments:
161
+ 1. "address" (string, required) the XNA address to search
162
+ 1. "restricted_name" (string, required) the restricted asset to search
163
+
164
+ Result:
165
+ "true/false", (boolean) If the address is frozen
166
+
167
+ Examples:
168
+ > raven-cli checkaddressrestriction "address" "restricted_name"
169
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "checkaddressrestriction", "params": ["address" "restricted_name"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
170
+
171
+ &nbsp;<br> &nbsp;<br/>
172
+ ## checkaddresstag
173
+ &nbsp;<br/> checkaddresstag address tag_name
174
+
175
+ Checks to see if an address has the given tag
176
+
177
+ Arguments:
178
+ 1. "address" (string, required) the XNA address to search
179
+ 1. "tag_name" (string, required) the tag to search
180
+
181
+ Result:
182
+ "true/false", (boolean) If the address has the tag
183
+
184
+ Examples:
185
+ > raven-cli checkaddresstag "address" "tag_name"
186
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "checkaddresstag", "params": ["address" "tag_name"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
187
+
188
+ &nbsp;<br> &nbsp;<br/>
189
+ ## checkglobalrestriction
190
+ &nbsp;<br/> checkglobalrestriction restricted_name
191
+
192
+ Checks to see if a restricted asset is globally frozen
193
+
194
+ Arguments:
195
+ 1. "restricted_name" (string, required) the restricted asset to search
196
+
197
+ Result:
198
+ "true/false", (boolean) If the restricted asset is frozen globally
199
+
200
+ Examples:
201
+ > raven-cli checkglobalrestriction "restricted_name"
202
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "checkglobalrestriction", "params": ["restricted_name"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
203
+
204
+ &nbsp;<br> &nbsp;<br/>
205
+ ## clearbanned
206
+ &nbsp;<br/> clearbanned
207
+
208
+ Clear all banned IPs.
209
+
210
+ Examples:
211
+ > raven-cli clearbanned
212
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "clearbanned", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
213
+
214
+ &nbsp;<br> &nbsp;<br/>
215
+ ## clearmempool
216
+ &nbsp;<br/> clearmempool
217
+
218
+ Removes all transaction from the mempool
219
+
220
+ Examples:
221
+ > raven-cli clearmempool
222
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "clearmempool", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
223
+
224
+ &nbsp;<br> &nbsp;<br/>
225
+ ## clearmessages
226
+ &nbsp;<br/> clearmessages
227
+
228
+ Delete current database of messages
229
+
230
+ Result:[
231
+
232
+ ]
233
+
234
+ Examples:
235
+ > raven-cli clearmessages
236
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "clearmessages", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
237
+
238
+ &nbsp;<br> &nbsp;<br/>
239
+ ## combinerawtransaction
240
+ &nbsp;<br/> combinerawtransaction ["hexstring",...]
241
+
242
+ Combine multiple partially signed transactions into one transaction.
243
+ The combined transaction may be another partially signed transaction or a
244
+ fully signed transaction.
245
+ Arguments:
246
+ 1. "txs" (string) A json array of hex strings of partially signed transactions
247
+ [
248
+ "hexstring" (string) A transaction hash
249
+ ,...
250
+ ]
251
+
252
+ Result:
253
+ "hex" (string) The hex-encoded raw transaction with signature(s)
254
+
255
+ Examples:
256
+ > raven-cli combinerawtransaction ["myhex1", "myhex2", "myhex3"]
257
+
258
+ &nbsp;<br> &nbsp;<br/>
259
+ ## createmultisig
260
+ &nbsp;<br/> createmultisig nrequired ["key",...]
261
+
262
+ Creates a multi-signature address with n signature of m keys required.
263
+ It returns a json object with the address and redeemScript.
264
+
265
+ Arguments:
266
+ 1. nrequired (numeric, required) The number of required signatures out of the n keys or addresses.
267
+ 2. "keys" (string, required) A json array of keys which are raven addresses or hex-encoded public keys
268
+ [
269
+ "key" (string) raven address or hex-encoded public key
270
+ ,...
271
+ ]
272
+
273
+ Result:
274
+ {
275
+ "address":"multisigaddress", (string) The value of the new multisig address.
276
+ "redeemScript":"script" (string) The string value of the hex-encoded redemption script.
277
+ }
278
+
279
+ Examples:
280
+
281
+ Create a multisig address from 2 addresses
282
+ > raven-cli createmultisig 2 "[\"16sSauSf5pF2UkUwvKGq4qjNRzBZYqgEL5\",\"171sgjn4YtPu27adkKGrdDwzRTxnRkBfKV\"]"
283
+
284
+ As a json rpc call
285
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "createmultisig", "params": [2, "[\"16sSauSf5pF2UkUwvKGq4qjNRzBZYqgEL5\",\"171sgjn4YtPu27adkKGrdDwzRTxnRkBfKV\"]"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
286
+
287
+ &nbsp;<br> &nbsp;<br/>
288
+ ## createrawtransaction
289
+ &nbsp;<br/> createrawtransaction [{"txid":"id","vout":n},...] {"address":(amount or object),"data":"hex",...}
290
+ ( locktime ) ( replaceable )
291
+
292
+ Create a transaction spending the given inputs and creating new outputs.
293
+ Outputs are addresses (paired with a XNA amount, data or object specifying an asset operation) or data.
294
+ Returns hex-encoded raw transaction.
295
+ Note that the transaction's inputs are not signed, and
296
+ it is not stored in the wallet or transmitted to the network.
297
+
298
+ Paying for Asset Operations:
299
+ Some operations require an amount of XNA to be sent to a burn address:
300
+
301
+ Operation Amount + Burn Address
302
+ transfer 0
303
+ transferwithmessage 0
304
+ issue 500 to RXissueAssetXXXXXXXXXXXXXXXXXhhZGt
305
+ issue (subasset) 100 to RXissueSubAssetXXXXXXXXXXXXXWcwhwL
306
+ issue_unique 5 to RXissueUniqueAssetXXXXXXXXXXWEAe58
307
+ reissue 100 to RXReissueAssetXXXXXXXXXXXXXXVEFAWu
308
+ issue_restricted 1500 to RXissueRestrictedXXXXXXXXXXXXzJZ1q
309
+ reissue_restricted 100 to RXReissueAssetXXXXXXXXXXXXXXVEFAWu
310
+ issue_qualifier 1000 to RXissueQuaLifierXXXXXXXXXXXXUgEDbC
311
+ issue_qualifier (sub) 100 to RXissueSubQuaLifierXXXXXXXXXVTzvv5
312
+ tag_addresses 0.1 to RXaddTagBurnXXXXXXXXXXXXXXXXZQm5ya (per address)
313
+ untag_addresses 0.1 to RXaddTagBurnXXXXXXXXXXXXXXXXZQm5ya (per address)
314
+ freeze_addresses 0
315
+ unfreeze_addresses 0
316
+ freeze_asset 0
317
+ unfreeze_asset 0
318
+
319
+ Assets For Authorization:
320
+ These operations require a specific asset input for authorization:
321
+ Root Owner Token:
322
+ reissue
323
+ issue_unique
324
+ issue_restricted
325
+ reissue_restricted
326
+ freeze_addresses
327
+ unfreeze_addresses
328
+ freeze_asset
329
+ unfreeze_asset
330
+ Root Qualifier Token:
331
+ issue_qualifier (when issuing subqualifier)
332
+ Qualifier Token:
333
+ tag_addresses
334
+ untag_addresses
335
+
336
+ Output Ordering:
337
+ Asset operations require the following:
338
+ 1) All coin outputs come first (including the burn output).
339
+ 2) The owner token change output comes next (if required).
340
+ 3) An issue, reissue, or any number of transfers comes last
341
+ (different types can't be mixed in a single transaction).
342
+
343
+ Arguments:
344
+ 1. "inputs" (array, required) A json array of json objects
345
+ [
346
+ {
347
+ "txid":"id", (string, required) The transaction id
348
+ "vout":n, (number, required) The output number
349
+ "sequence":n (number, optional) The sequence number
350
+ }
351
+ ,...
352
+ ]
353
+ 2. "outputs" (object, required) a json object with outputs
354
+ {
355
+ "address": (string, required) The destination raven address.
356
+ Each output must have a different address.
357
+ x.xxx (number or string, required) The XNA amount
358
+ or
359
+ { (object) A json object of assets to send
360
+ "transfer":
361
+ {
362
+ "asset-name": (string, required) asset name
363
+ asset-quantity (number, required) the number of raw units to transfer
364
+ ,...
365
+ }
366
+ }
367
+ or
368
+ { (object) A json object of describing the transfer and message contents to send
369
+ "transferwithmessage":
370
+ {
371
+ "asset-name": (string, required) asset name
372
+ asset-quantity, (number, required) the number of raw units to transfer
373
+ "message":"hash", (string, required) ipfs hash or a txid hash
374
+ "expire_time": n (number, required) utc time in seconds to expire the message
375
+ }
376
+ }
377
+ or
378
+ { (object) A json object describing new assets to issue
379
+ "issue":
380
+ {
381
+ "asset_name":"asset-name", (string, required) new asset name
382
+ "asset_quantity":n, (number, required) the number of raw units to issue
383
+ "units":[1-8], (number, required) display units, between 1 (integral) to 8 (max precision)
384
+ "reissuable":[0-1], (number, required) 1=reissuable asset
385
+ "has_ipfs":[0-1], (number, required) 1=passing ipfs_hash
386
+ "ipfs_hash":"hash" (string, optional) an ipfs hash for discovering asset metadata
387
+ }
388
+ }
389
+ or
390
+ { (object) A json object describing new unique assets to issue
391
+ "issue_unique":
392
+ {
393
+ "root_name":"root-name", (string, required) name of the asset the unique asset(s)
394
+ are being issued under
395
+ "asset_tags":["asset_tag", ...], (array, required) the unique tag for each asset which is to be issued
396
+ "ipfs_hashes":["hash", ...], (array, optional) ipfs hashes corresponding to each supplied tag
397
+ (should be same size as "asset_tags")
398
+ }
399
+ }
400
+ or
401
+ { (object) A json object describing follow-on asset issue.
402
+ "reissue":
403
+ {
404
+ "asset_name":"asset-name", (string, required) name of asset to be reissued
405
+ "asset_quantity":n, (number, required) the number of raw units to issue
406
+ "reissuable":[0-1], (number, optional) default is 1, 1=reissuable asset
407
+ "ipfs_hash":"hash", (string, optional) An ipfs hash for discovering asset metadata,
408
+ Overrides the current ipfs hash if given
409
+ "owner_change_address" (string, optional) the address where the owner token will be sent to.
410
+ If not given, it will be sent to the output address
411
+ }
412
+ }
413
+ or
414
+ { (object) A json object describing how restricted asset to issue
415
+ "issue_restricted":
416
+ {
417
+ "asset_name":"asset-name",(string, required) new asset name
418
+ "asset_quantity":n, (number, required) the number of raw units to issue
419
+ "verifier_string":"text", (string, required) the verifier string to be used for a restricted
420
+ asset transfer verification
421
+ "units":[0-8], (number, required) display units, between 0 (integral) and 8 (max precision)
422
+ "reissuable":[0-1], (number, required) 1=reissuable asset
423
+ "has_ipfs":[0-1], (number, required) 1=passing ipfs_hash
424
+ "ipfs_hash":"hash", (string, optional) an ipfs hash for discovering asset metadata
425
+ "owner_change_address" (string, optional) the address where the owner token will be sent to.
426
+ If not given, it will be sent to the output address
427
+ }
428
+ }
429
+ or
430
+ { (object) A json object describing follow-on asset issue.
431
+ "reissue_restricted":
432
+ {
433
+ "asset_name":"asset-name", (string, required) name of asset to be reissued
434
+ "asset_quantity":n, (number, required) the number of raw units to issue
435
+ "reissuable":[0-1], (number, optional) default is 1, 1=reissuable asset
436
+ "verifier_string":"text", (string, optional) the verifier string to be used for a restricted asset
437
+ transfer verification
438
+ "ipfs_hash":"hash", (string, optional) An ipfs hash for discovering asset metadata,
439
+ Overrides the current ipfs hash if given
440
+ "owner_change_address" (string, optional) the address where the owner token will be sent to.
441
+ If not given, it will be sent to the output address
442
+ }
443
+ }
444
+ or
445
+ { (object) A json object describing a new qualifier to issue.
446
+ "issue_qualifier":
447
+ {
448
+ "asset_name":"asset_name", (string, required) a qualifier name (starts with '#')
449
+ "asset_quantity":n, (numeric, optional, default=1) the number of units to be issued (1 to 10)
450
+ "has_ipfs":[0-1], (boolean, optional, default=false), whether ifps hash is going
451
+ to be added to the asset
452
+ "ipfs_hash":"hash", (string, optional but required if has_ipfs = 1), an ipfs hash or a
453
+ txid hash once RIP5 is activated
454
+ "root_change_address" (string, optional) Only applies when issuing subqualifiers.
455
+ The address where the root qualifier will be sent.
456
+ If not specified, it will be sent to the output address.
457
+ "change_quantity":"qty" (numeric, optional) the asset change amount (defaults to 1)
458
+ }
459
+ }
460
+ or
461
+ { (object) A json object describing addresses to be tagged.
462
+ The address in the key will used as the asset change address.
463
+ "tag_addresses":
464
+ {
465
+ "qualifier":"qualifier", (string, required) a qualifier name (starts with '#')
466
+ "addresses":["addr", ...], (array, required) the addresses to be tagged (up to 10)
467
+ "change_quantity":"qty", (numeric, optional) the asset change amount (defaults to 1)
468
+ }
469
+ }
470
+ or
471
+ { (object) A json object describing addresses to be untagged.
472
+ The address in the key will be used as the asset change address.
473
+ "untag_addresses":
474
+ {
475
+ "qualifier":"qualifier", (string, required) a qualifier name (starts with '#')
476
+ "addresses":["addr", ...], (array, required) the addresses to be untagged (up to 10)
477
+ "change_quantity":"qty", (numeric, optional) the asset change amount (defaults to 1)
478
+ }
479
+ }
480
+ or
481
+ { (object) A json object describing addresses to be frozen.
482
+ The address in the key will used as the owner change address.
483
+ "freeze_addresses":
484
+ {
485
+ "asset_name":"asset_name", (string, required) a restricted asset name (starts with '$')
486
+ "addresses":["addr", ...], (array, required) the addresses to be frozen (up to 10)
487
+ }
488
+ }
489
+ or
490
+ { (object) A json object describing addresses to be frozen.
491
+ The address in the key will be used as the owner change address.
492
+ "unfreeze_addresses":
493
+ {
494
+ "asset_name":"asset_name", (string, required) a restricted asset name (starts with '$')
495
+ "addresses":["addr", ...], (array, required) the addresses to be untagged (up to 10)
496
+ }
497
+ }
498
+ or
499
+ { (object) A json object describing an asset to be frozen.
500
+ The address in the key will used as the owner change address.
501
+ "freeze_asset":
502
+ {
503
+ "asset_name":"asset_name", (string, required) a restricted asset name (starts with '$')
504
+ }
505
+ }
506
+ or
507
+ { (object) A json object describing an asset to be frozen.
508
+ The address in the key will be used as the owner change address.
509
+ "unfreeze_asset":
510
+ {
511
+ "asset_name":"asset_name", (string, required) a restricted asset name (starts with '$')
512
+ }
513
+ }
514
+ or
515
+ "data": "hex" (string, required) The key is "data", the value is hex encoded data
516
+ ,...
517
+ }
518
+ 3. locktime (numeric, optional, default=0) Raw locktime. Non-0 value also locktime-activates inputs
519
+
520
+ Result:
521
+ "transaction" (string) hex string of the transaction
522
+
523
+ Examples:
524
+ > raven-cli createrawtransaction "[{\"txid\":\"mycoin\",\"vout\":0}]" "{\"address\":0.01}"
525
+ > raven-cli createrawtransaction "[{\"txid\":\"mycoin\",\"vout\":0}]" "{\"data\":\"00010203\"}"
526
+ > raven-cli createrawtransaction "[{\"txid\":\"mycoin\",\"vout\":0}]" "{\"RXissueAssetXXXXXXXXXXXXXXXXXhhZGt\":500,\"change_address\":change_amount,\"issuer_address\":{\"issue\":{\"asset_name\":\"MYASSET\",\"asset_quantity\":1000000,\"units\":1,\"reissuable\":0,\"has_ipfs\":1,\"ipfs_hash\":\"43f81c6f2c0593bde5a85e09ae662816eca80797\"}}}"
527
+ > raven-cli createrawtransaction "[{\"txid\":\"mycoin\",\"vout\":0}]" "{\"RXissueRestrictedXXXXXXXXXXXXzJZ1q\":1500,\"change_address\":change_amount,\"issuer_address\":{\"issue_restricted\":{\"asset_name\":\"$MYASSET\",\"asset_quantity\":1000000,\"verifier_string\":\"#TAG & !KYC\",\"units\":1,\"reissuable\":0,\"has_ipfs\":1,\"ipfs_hash\":\"43f81c6f2c0593bde5a85e09ae662816eca80797\"}}}"
528
+ > raven-cli createrawtransaction "[{\"txid\":\"mycoin\",\"vout\":0}]" "{\"RXissueUniqueAssetXXXXXXXXXXWEAe58\":20,\"change_address\":change_amount,\"issuer_address\":{\"issue_unique\":{\"root_name\":\"MYASSET\",\"asset_tags\":[\"ALPHA\",\"BETA\"],\"ipfs_hashes\":[\"43f81c6f2c0593bde5a85e09ae662816eca80797\",\"43f81c6f2c0593bde5a85e09ae662816eca80797\"]}}}"
529
+ > raven-cli createrawtransaction "[{\"txid\":\"mycoin\",\"vout\":0},{\"txid\":\"myasset\",\"vout\":0}]" "{\"address\":{\"transfer\":{\"MYASSET\":50}}}"
530
+ > raven-cli createrawtransaction "[{\"txid\":\"mycoin\",\"vout\":0},{\"txid\":\"myasset\",\"vout\":0}]" "{\"address\":{\"transferwithmessage\":{\"MYASSET\":50,\"message\":\"hash\",\"expire_time\": utc_time}}}"
531
+ > raven-cli createrawtransaction "[{\"txid\":\"mycoin\",\"vout\":0},{\"txid\":\"myownership\",\"vout\":0}]" "{\"issuer_address\":{\"reissue\":{\"asset_name\":\"MYASSET\",\"asset_quantity\":2000000}}}"
532
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "createrawtransaction", "params": ["[{\"txid\":\"mycoin\",\"vout\":0}]", "{\"data\":\"00010203\"}"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
533
+
534
+ &nbsp;<br> &nbsp;<br/>
535
+ ## decodeblock
536
+ &nbsp;<br/> decodeblock "blockhex"
537
+
538
+ Arguments:
539
+ 1. "blockhex" (string, required) The block hex
540
+
541
+ Result:
542
+ {
543
+ "hash" : "hash", (string) the block hash (same as provided)
544
+ "size" : n, (numeric) The block size
545
+ "strippedsize" : n, (numeric) The block size excluding witness data
546
+ "weight" : n (numeric) The block weight as defined in BIP 141
547
+ "height" : n, (numeric) The block height or index
548
+ "version" : n, (numeric) The block version
549
+ "versionHex" : "00000000", (string) The block version formatted in hexadecimal
550
+ "merkleroot" : "xxxx", (string) The merkle root
551
+ "tx" : [ (array of string) The transaction ids
552
+ "transactionid" (string) The transaction id
553
+ ,...
554
+ ],
555
+ "time" : ttt, (numeric) The block time in seconds since epoch (Jan 1 1970 GMT)
556
+ "nonce" : n, (numeric) The nonce
557
+ "bits" : "1d00ffff", (string) The bits
558
+ }
559
+
560
+ Examples:
561
+ > raven-cli decodeblock "xxxx"
562
+ > 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/
563
+
564
+ &nbsp;<br> &nbsp;<br/>
565
+ ## decoderawtransaction
566
+ &nbsp;<br/> decoderawtransaction "hexstring"
567
+
568
+ Return a JSON object representing the serialized, hex-encoded transaction.
569
+
570
+ Arguments:
571
+ 1. "hexstring" (string, required) The transaction hex string
572
+
573
+ Result:
574
+ {
575
+ "txid" : "id", (string) The transaction id
576
+ "hash" : "id", (string) The transaction hash (differs from txid for witness transactions)
577
+ "size" : n, (numeric) The transaction size
578
+ "vsize" : n, (numeric) The virtual transaction size (differs from size for witness transactions)
579
+ "version" : n, (numeric) The version
580
+ "locktime" : ttt, (numeric) The lock time
581
+ "vin" : [ (array of json objects)
582
+ {
583
+ "txid": "id", (string) The transaction id
584
+ "vout": n, (numeric) The output number
585
+ "scriptSig": { (json object) The script
586
+ "asm": "asm", (string) asm
587
+ "hex": "hex" (string) hex
588
+ },
589
+ "txinwitness": ["hex", ...] (array of string) hex-encoded witness data (if any)
590
+ "sequence": n (numeric) The script sequence number
591
+ }
592
+ ,...
593
+ ],
594
+ "vout" : [ (array of json objects)
595
+ {
596
+ "value" : x.xxx, (numeric) The value in XNA
597
+ "n" : n, (numeric) index
598
+ "scriptPubKey" : { (json object)
599
+ "asm" : "asm", (string) the asm
600
+ "hex" : "hex", (string) the hex
601
+ "reqSigs" : n, (numeric) The required sigs
602
+ "type" : "pubkeyhash", (string) The type, eg 'pubkeyhash'
603
+ "asset" : { (json object) optional
604
+ "name" : "name", (string) the asset name
605
+ "amount" : n, (numeric) the amount of asset that was sent
606
+ "message" : "message", (string optional) the message if one was sent
607
+ "expire_time" : n, (numeric optional) the message epoch expiration time if one was set
608
+ "addresses" : [ (json array of string)
609
+ "12tvKAXCxZjSmdNbao16dKXC8tRWfcF5oc" (string) raven address
610
+ ,...
611
+ ]
612
+ }
613
+ }
614
+ ,...
615
+ ],
616
+ }
617
+
618
+ Examples:
619
+ > raven-cli decoderawtransaction "hexstring"
620
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "decoderawtransaction", "params": ["hexstring"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
621
+
622
+ &nbsp;<br> &nbsp;<br/>
623
+ ## decodescript
624
+ &nbsp;<br/> decodescript "hexstring"
625
+
626
+ Decode a hex-encoded script.
627
+
628
+ Arguments:
629
+ 1. "hexstring" (string) the hex encoded script
630
+
631
+ Result:
632
+ {
633
+ "asm":"asm", (string) Script public key
634
+ "hex":"hex", (string) hex encoded public key
635
+ "type":"type", (string) The output type
636
+ "asset" : { (json object) optional
637
+ "name" : "name", (string) the asset name
638
+ "amount" : n, (numeric) the amount of asset that was sent
639
+ "message" : "message", (string optional) the message if one was sent
640
+ "expire_time" : n, (numeric optional ) the message epoch expiration time if one was set
641
+ "reqSigs": n, (numeric) The required signatures
642
+ "addresses": [ (json array of string)
643
+ "address" (string) raven address
644
+ ,...
645
+ ],
646
+ "p2sh":"address", (string) address of P2SH script wrapping this redeem script (not returned if the script is already a P2SH).
647
+ "(The following only appears if the script is an asset script)
648
+ "asset_name":"name", (string) Name of the asset.
649
+ "amount":"x.xx", (numeric) The amount of assets interacted with.
650
+ "units": n, (numeric) The units of the asset. (Only appears in the type (new_asset))
651
+ "reissuable": true|false, (boolean) If this asset is reissuable. (Only appears in type (new_asset|reissue_asset))
652
+ "hasIPFS": true|false, (boolean) If this asset has an IPFS hash. (Only appears in type (new_asset if hasIPFS is true))
653
+ "ipfs_hash": "hash", (string) The ipfs hash for the new asset. (Only appears in type (new_asset))
654
+ "new_ipfs_hash":"hash", (string) If new ipfs hash (Only appears in type. (reissue_asset))
655
+ }
656
+
657
+ Examples:
658
+ > raven-cli decodescript "hexstring"
659
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "decodescript", "params": ["hexstring"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
660
+
661
+ &nbsp;<br> &nbsp;<br/>
662
+ ## disconnectnode
663
+ &nbsp;<br/> disconnectnode "[address]" [nodeid]
664
+
665
+ Immediately disconnects from the specified peer node.
666
+
667
+ Strictly one out of 'address' and 'nodeid' can be provided to identify the node.
668
+
669
+ To disconnect by nodeid, either set 'address' to the empty string, or call using the named 'nodeid' argument only.
670
+
671
+ Arguments:
672
+ 1. "address" (string, optional) The IP address/port of the node
673
+ 2. "nodeid" (number, optional) The node ID (see getpeerinfo for node IDs)
674
+
675
+ Examples:
676
+ > raven-cli disconnectnode "192.168.0.6:8767"
677
+ > raven-cli disconnectnode "" 1
678
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "disconnectnode", "params": ["192.168.0.6:8767"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
679
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "disconnectnode", "params": ["", 1] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
680
+
681
+ &nbsp;<br> &nbsp;<br/>
682
+ ## distributereward
683
+ &nbsp;<br/> distributereward "asset_name" snapshot_height "distribution_asset_name" gross_distribution_amount ( "exception_addresses" ) ("change_address") ("dry_run")
684
+
685
+ Splits the specified amount of the distribution asset to all owners of asset_name that are not in the optional exclusion_addresses
686
+
687
+ Arguments:
688
+ 1. "asset_name" (string, required) The reward will be distributed all owners of this asset
689
+ 2. "snapshot_height" (number, required) The block height of the ownership snapshot
690
+ 3. "distribution_asset_name" (string, required) The name of the asset that will be distributed, or XNA
691
+ 4. "gross_distribution_amount" (number, required) The amount of the distribution asset that will be split amongst all owners
692
+ 5. "exception_addresses" (string, optional) Ownership addresses that should be excluded
693
+ 6. "change_address" (string, optional) If the rewards can't be fully distributed. The change will be sent to this address
694
+
695
+ Result:
696
+ {
697
+ error_txn_gen_failed: (string),
698
+ error_nsf: (string),
699
+ error_rejects: (string),
700
+ error_db_update: (string),
701
+ batch_results: [
702
+ {
703
+ transaction_id: (string),
704
+ error_txn_rejected: (string),
705
+ total_amount: (number),
706
+ fee: (number),
707
+ expected_count: (number),
708
+ actual_count: (number),
709
+ }
710
+ ]
711
+ }
712
+
713
+ Examples:
714
+ > raven-cli distributereward "TRONCO" 12345 "XNA" 1000
715
+ > raven-cli distributereward "PHATSTACKS" 12345 "DIVIDENDS" 1000 "mwN7xC3yomYdvJuVXkVC7ymY9wNBjWNduD,n4Rf18edydDaRBh7t6gHUbuByLbWEoWUTg"
716
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "distributereward", "params": ["TRONCO" 34987 "DIVIDENDS" 100000] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
717
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "distributereward", "params": ["PHATSTACKS" 34987 "XNA" 100000 "mwN7xC3yomYdvJuVXkVC7ymY9wNBjWNduD,n4Rf18edydDaRBh7t6gHUbuByLbWEoWUTg"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
718
+
719
+ &nbsp;<br> &nbsp;<br/>
720
+ ## dumpprivkey
721
+ &nbsp;<br/> dumpprivkey "address"
722
+
723
+ Reveals the private key corresponding to 'address'.
724
+ Then the importprivkey can be used with this output
725
+
726
+ Arguments:
727
+ 1. "address" (string, required) The raven address for the private key
728
+
729
+ Result:
730
+ "key" (string) The private key
731
+
732
+ Examples:
733
+ > raven-cli dumpprivkey "myaddress"
734
+ > raven-cli importprivkey "mykey"
735
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "dumpprivkey", "params": ["myaddress"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
736
+
737
+ &nbsp;<br> &nbsp;<br/>
738
+ ## dumpwallet
739
+ &nbsp;<br/> dumpwallet "filename"
740
+
741
+ Dumps all wallet keys in a human-readable format to a server-side file. This does not allow overwriting existing files.
742
+
743
+ Arguments:
744
+ 1. "filename" (string, required) The filename with path (either absolute or relative to ravend)
745
+
746
+ Result:
747
+ { (json object)
748
+ "filename" : { (string) The filename with full absolute path
749
+ }
750
+
751
+ Examples:
752
+ > raven-cli dumpwallet "test"
753
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "dumpwallet", "params": ["test"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
754
+
755
+ &nbsp;<br> &nbsp;<br/>
756
+ ## encryptwallet
757
+ &nbsp;<br/> encryptwallet "passphrase"
758
+
759
+ Encrypts the wallet with 'passphrase'. This is for first time encryption.
760
+ After this, any calls that interact with private keys such as sending or signing
761
+ will require the passphrase to be set prior the making these calls.
762
+ Use the walletpassphrase call for this, and then walletlock call.
763
+ If the wallet is already encrypted, use the walletpassphrasechange call.
764
+ Note that this will shutdown the server.
765
+
766
+ Arguments:
767
+ 1. "passphrase" (string) The pass phrase to encrypt the wallet with. It must be at least 1 character, but should be long.
768
+
769
+ Examples:
770
+
771
+ Encrypt your wallet
772
+ > raven-cli encryptwallet "my pass phrase"
773
+
774
+ Now set the passphrase to use the wallet, such as for signing or sending raven
775
+ > raven-cli walletpassphrase "my pass phrase"
776
+
777
+ Now we can do something like sign
778
+ > raven-cli signmessage "address" "test message"
779
+
780
+ Now lock the wallet again by removing the passphrase
781
+ > raven-cli walletlock
782
+
783
+ As a json rpc call
784
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "encryptwallet", "params": ["my pass phrase"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
785
+
786
+ &nbsp;<br> &nbsp;<br/>
787
+ ## estimatefee
788
+ &nbsp;<br/> estimatefee nblocks
789
+
790
+ DEPRECATED. Please use estimatesmartfee for more intelligent estimates.
791
+ Estimates the approximate fee per kilobyte needed for a transaction to begin
792
+ confirmation within nblocks blocks. Uses virtual transaction size of transaction
793
+ as defined in BIP 141 (witness data is discounted).
794
+
795
+ Arguments:
796
+ 1. nblocks (numeric, required)
797
+
798
+ Result:
799
+ n (numeric) estimated fee-per-kilobyte
800
+
801
+ A negative value is returned if not enough transactions and blocks
802
+ have been observed to make an estimate.
803
+ -1 is always returned for nblocks == 1 as it is impossible to calculate
804
+ a fee that is high enough to get reliably included in the next block.
805
+
806
+ Example:
807
+ > raven-cli estimatefee 6
808
+
809
+ &nbsp;<br> &nbsp;<br/>
810
+ ## estimatesmartfee
811
+ &nbsp;<br/> estimatesmartfee conf_target ("estimate_mode")
812
+
813
+ Estimates the approximate fee per kilobyte needed for a transaction to begin
814
+ confirmation within conf_target blocks if possible and return the number of blocks
815
+ for which the estimate is valid. Uses virtual transaction size as defined
816
+ in BIP 141 (witness data is discounted).
817
+
818
+ Arguments:
819
+ 1. conf_target (numeric) Confirmation target in blocks (1 - 1008)
820
+ 2. "estimate_mode" (string, optional, default=CONSERVATIVE) The fee estimate mode.
821
+ Whether to return a more conservative estimate which also satisfies
822
+ a longer history. A conservative estimate potentially returns a
823
+ higher feerate and is more likely to be sufficient for the desired
824
+ target, but is not as responsive to short term drops in the
825
+ prevailing fee market. Must be one of:
826
+ "UNSET" (defaults to CONSERVATIVE)
827
+ "ECONOMICAL"
828
+ "CONSERVATIVE"
829
+
830
+ Result:
831
+ {
832
+ "feerate" : x.x, (numeric, optional) estimate fee rate in XNA/kB
833
+ "errors": [ str... ] (json array of strings, optional) Errors encountered during processing
834
+ "blocks" : n (numeric) block number where estimate was found
835
+ }
836
+
837
+ The request target will be clamped between 2 and the highest target
838
+ fee estimation is able to return based on how long it has been running.
839
+ An error is returned if not enough transactions and blocks
840
+ have been observed to make an estimate for any number of blocks.
841
+
842
+ Example:
843
+ > raven-cli estimatesmartfee 6
844
+
845
+ &nbsp;<br> &nbsp;<br/>
846
+ ## freezeaddress
847
+ &nbsp;<br/> freezeaddress asset_name address (change_address) (asset_data)
848
+
849
+ Freeze an address from transferring a restricted asset
850
+
851
+ Arguments:
852
+ 1. "asset_name" (string, required) the name of the restricted asset you want to freeze
853
+ 2. "address" (string, required) the address that will be frozen
854
+ 3. "change_address" (string, optional) The change address for the owner token of the restricted asset
855
+ 4. "asset_data" (string, optional) The asset data (ipfs or a hash) to be applied to the transfer of the owner token
856
+
857
+ Result:
858
+ "txid" (string) The transaction id
859
+
860
+ Examples:
861
+ > raven-cli freezeaddress "$RESTRICTED_ASSET" "address"
862
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "freezeaddress", "params": ["$RESTRICTED_ASSET" "address"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
863
+ > raven-cli freezeaddress "$RESTRICTED_ASSET" "address" "change_address"
864
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "freezeaddress", "params": ["$RESTRICTED_ASSET" "address" "change_address"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
865
+
866
+ &nbsp;<br> &nbsp;<br/>
867
+ ## freezerestrictedasset
868
+ &nbsp;<br/> freezerestrictedasset asset_name (change_address) (asset_data)
869
+
870
+ Freeze all trading for a specific restricted asset
871
+
872
+ Arguments:
873
+ 1. "asset_name" (string, required) the name of the restricted asset you want to unfreeze
874
+ 2. "change_address" (string, optional) The change address for the owner token of the restricted asset
875
+ 3. "asset_data" (string, optional) The asset data (ipfs or a hash) to be applied to the transfer of the owner token
876
+
877
+ Result:
878
+ "txid" (string) The transaction id
879
+
880
+ Examples:
881
+ > raven-cli freezerestrictedasset "$RESTRICTED_ASSET"
882
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "freezerestrictedasset", "params": ["$RESTRICTED_ASSET"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
883
+ > raven-cli freezerestrictedasset "$RESTRICTED_ASSET" "change_address"
884
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "freezerestrictedasset", "params": ["$RESTRICTED_ASSET" "change_address"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
885
+
886
+ &nbsp;<br> &nbsp;<br/>
887
+ ## fundrawtransaction
888
+ &nbsp;<br/> fundrawtransaction "hexstring" ( options )
889
+
890
+ Add inputs to a transaction until it has enough in value to meet its out value.
891
+ This will not modify existing inputs, and will add at most one change output to the outputs.
892
+ No existing outputs will be modified unless "subtractFeeFromOutputs" is specified.
893
+ Note that inputs which were signed may need to be resigned after completion since in/outputs have been added.
894
+ The inputs added will not be signed, use signrawtransaction for that.
895
+ Note that all existing inputs must have their previous output transaction be in the wallet.
896
+ Note that all inputs selected must be of standard form and P2SH scripts must be
897
+ in the wallet using importaddress or addmultisigaddress (to calculate fees).
898
+ You can see whether this is the case by checking the "solvable" field in the listunspent output.
899
+ Only pay-to-pubkey, multisig, and P2SH versions thereof are currently supported for watch-only
900
+
901
+ Arguments:
902
+ 1. "hexstring" (string, required) The hex string of the raw transaction
903
+ 2. options (object, optional)
904
+ {
905
+ "changeAddress" (string, optional, default pool address) The raven address to receive the change
906
+ "changePosition" (numeric, optional, default random) The index of the change output
907
+ "includeWatching" (boolean, optional, default false) Also select inputs which are watch only
908
+ "lockUnspents" (boolean, optional, default false) Lock selected unspent outputs
909
+ "feeRate" (numeric, optional, default not set: makes wallet determine the fee) Set a specific fee rate in XNA/kB
910
+ "subtractFeeFromOutputs" (array, optional) A json array of integers.
911
+ The fee will be equally deducted from the amount of each specified output.
912
+ The outputs are specified by their zero-based index, before any change output is added.
913
+ Those recipients will receive less ravens than you enter in their corresponding amount field.
914
+ If no outputs are specified here, the sender pays the fee.
915
+ [vout_index,...]
916
+ Allows this transaction to be replaced by a transaction with higher fees
917
+ "conf_target" (numeric, optional) Confirmation target (in blocks)
918
+ "estimate_mode" (string, optional, default=UNSET) The fee estimate mode, must be one of:
919
+ "UNSET"
920
+ "ECONOMICAL"
921
+ "CONSERVATIVE"
922
+ }
923
+ for backward compatibility: passing in a true instead of an object will result in {"includeWatching":true}
924
+
925
+ Result:
926
+ {
927
+ "hex": "value", (string) The resulting raw transaction (hex-encoded string)
928
+ "fee": n, (numeric) Fee in XNA the resulting transaction pays
929
+ "changepos": n (numeric) The position of the added change output, or -1
930
+ }
931
+
932
+ Examples:
933
+
934
+ Create a transaction with no inputs
935
+ > raven-cli createrawtransaction "[]" "{\"myaddress\":0.01}"
936
+
937
+ Add sufficient unsigned inputs to meet the output value
938
+ > raven-cli fundrawtransaction "rawtransactionhex"
939
+
940
+ Sign the transaction
941
+ > raven-cli signrawtransaction "fundedtransactionhex"
942
+
943
+ Send the transaction
944
+ > raven-cli sendrawtransaction "signedtransactionhex"
945
+
946
+ &nbsp;<br> &nbsp;<br/>
947
+ ## generate
948
+ &nbsp;<br/> generate nblocks ( maxtries )
949
+
950
+ Mine up to nblocks blocks immediately (before the RPC call returns) to an address in the wallet.
951
+
952
+ Arguments:
953
+ 1. nblocks (numeric, required) How many blocks are generated immediately.
954
+ 2. maxtries (numeric, optional) How many iterations to try (default = 1000000).
955
+
956
+ Result:
957
+ [ blockhashes ] (array) hashes of blocks generated
958
+
959
+ Examples:
960
+
961
+ Generate 11 blocks
962
+ > raven-cli generate 11
963
+
964
+ &nbsp;<br> &nbsp;<br/>
965
+ ## generatetoaddress
966
+ &nbsp;<br/> generatetoaddress nblocks address (maxtries)
967
+
968
+ Mine blocks immediately to a specified address (before the RPC call returns)
969
+
970
+ Arguments:
971
+ 1. nblocks (numeric, required) How many blocks are generated immediately.
972
+ 2. address (string, required) The address to send the newly generated raven to.
973
+ 3. maxtries (numeric, optional) How many iterations to try (default = 1000000).
974
+
975
+ Result:
976
+ [ blockhashes ] (array) hashes of blocks generated
977
+
978
+ Examples:
979
+
980
+ Generate 11 blocks to myaddress
981
+ > raven-cli generatetoaddress 11 "myaddress"
982
+
983
+ &nbsp;<br> &nbsp;<br/>
984
+ ## getaccount
985
+ &nbsp;<br/> getaccount "address"
986
+
987
+ DEPRECATED. Returns the account associated with the given address.
988
+
989
+ Arguments:
990
+ 1. "address" (string, required) The raven address for account lookup.
991
+
992
+ Result:
993
+ "accountname" (string) the account address
994
+
995
+ Examples:
996
+ > raven-cli getaccount "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX"
997
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaccount", "params": ["1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
998
+
999
+ &nbsp;<br> &nbsp;<br/>
1000
+ ## getaccountaddress
1001
+ &nbsp;<br/> getaccountaddress "account"
1002
+
1003
+ DEPRECATED. Returns the current Raven address for receiving payments to this account.
1004
+
1005
+ Arguments:
1006
+ 1. "account" (string, required) The account name for the address. It can also be set to the empty string "" to represent the default account. The account does not need to exist, it will be created and a new address created if there is no account by the given name.
1007
+
1008
+ Result:
1009
+ "address" (string) The account raven address
1010
+
1011
+ Examples:
1012
+ > raven-cli getaccountaddress
1013
+ > raven-cli getaccountaddress ""
1014
+ > raven-cli getaccountaddress "myaccount"
1015
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaccountaddress", "params": ["myaccount"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1016
+
1017
+ &nbsp;<br> &nbsp;<br/>
1018
+ ## getaddednodeinfo
1019
+ &nbsp;<br/> getaddednodeinfo ( "node" )
1020
+
1021
+ Returns information about the given added node, or all added nodes
1022
+ (note that onetry addnodes are not listed here)
1023
+
1024
+ Arguments:
1025
+ 1. "node" (string, optional) If provided, return information about this specific node, otherwise all nodes are returned.
1026
+
1027
+ Result:
1028
+ [
1029
+ {
1030
+ "addednode" : "192.168.0.201", (string) The node IP address or name (as provided to addnode)
1031
+ "connected" : true|false, (boolean) If connected
1032
+ "addresses" : [ (list of objects) Only when connected = true
1033
+ {
1034
+ "address" : "192.168.0.201:8767", (string) The raven server IP and port we're connected to
1035
+ "connected" : "outbound" (string) connection, inbound or outbound
1036
+ }
1037
+ ]
1038
+ }
1039
+ ,...
1040
+ ]
1041
+
1042
+ Examples:
1043
+ > raven-cli getaddednodeinfo "192.168.0.201"
1044
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaddednodeinfo", "params": ["192.168.0.201"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1045
+
1046
+ &nbsp;<br> &nbsp;<br/>
1047
+ ## getaddressbalance
1048
+ &nbsp;<br/> getaddressbalance
1049
+
1050
+ Returns the balance for an address(es) (requires addressindex to be enabled).
1051
+
1052
+ Arguments:
1053
+ {
1054
+ "addresses:"
1055
+ [
1056
+ "address" (string) The base58check encoded address
1057
+ ,...
1058
+ ]
1059
+ },
1060
+ "includeAssets" (boolean, optional, default false) If true this will return an expanded result which includes asset balances
1061
+
1062
+
1063
+ Result:
1064
+ {
1065
+ "balance" (string) The current balance in satoshis
1066
+ "received" (string) The total number of satoshis received (including change)
1067
+ }
1068
+ OR
1069
+ [
1070
+ {
1071
+ "assetName" (string) The asset associated with the balance (XNA for Neurai)
1072
+ "balance" (string) The current balance in satoshis
1073
+ "received" (string) The total number of satoshis received (including change)
1074
+ },...
1075
+
1076
+ ]
1077
+ Examples:
1078
+ > raven-cli getaddressbalance '{"addresses": ["12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX"]}'
1079
+ > raven-cli getaddressbalance '{"addresses": ["12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX"]}', true
1080
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaddressbalance", "params": [{"addresses": ["12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX"]}] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1081
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaddressbalance", "params": [{"addresses": ["12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX"]}, true] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1082
+
1083
+ &nbsp;<br> &nbsp;<br/>
1084
+ ## getaddressdeltas
1085
+ &nbsp;<br/> getaddressdeltas
1086
+
1087
+ Returns all changes for an address (requires addressindex to be enabled).
1088
+
1089
+ Arguments:
1090
+ {
1091
+ "addresses"
1092
+ [
1093
+ "address" (string) The base58check encoded address
1094
+ ,...
1095
+ ]
1096
+ "start" (number) The start block height
1097
+ "end" (number) The end block height
1098
+ "chainInfo" (boolean) Include chain info in results, only applies if start and end specified
1099
+ "assetName" (string, optional) Get deltas for a particular asset instead of XNA.
1100
+ }
1101
+
1102
+ Result:
1103
+ [
1104
+ {
1105
+ "assetName" (string) The asset associated with the deltas (XNA for Neurai)
1106
+ "satoshis" (number) The difference of satoshis
1107
+ "txid" (string) The related txid
1108
+ "index" (number) The related input or output index
1109
+ "height" (number) The block height
1110
+ "address" (string) The base58check encoded address
1111
+ }
1112
+ ]
1113
+
1114
+ Examples:
1115
+ > raven-cli getaddressdeltas '{"addresses": ["12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX"]}'
1116
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaddressdeltas", "params": [{"addresses": ["12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX"]}] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1117
+ > raven-cli getaddressdeltas '{"addresses": ["12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX"],"assetName":"MY_ASSET"}'
1118
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaddressdeltas", "params": [{"addresses": ["12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX"],"assetName":"MY_ASSET"}] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1119
+
1120
+ &nbsp;<br> &nbsp;<br/>
1121
+ ## getaddressesbyaccount
1122
+ &nbsp;<br/> getaddressesbyaccount "account"
1123
+
1124
+ DEPRECATED. Returns the list of addresses for the given account.
1125
+
1126
+ Arguments:
1127
+ 1. "account" (string, required) The account name.
1128
+
1129
+ Result:
1130
+ [ (json array of string)
1131
+ "address" (string) a raven address associated with the given account
1132
+ ,...
1133
+ ]
1134
+
1135
+ Examples:
1136
+ > raven-cli getaddressesbyaccount "tabby"
1137
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaddressesbyaccount", "params": ["tabby"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1138
+
1139
+ &nbsp;<br> &nbsp;<br/>
1140
+ ## getaddressmempool
1141
+ &nbsp;<br/> getaddressmempool
1142
+
1143
+ Returns all mempool deltas for an address (requires addressindex to be enabled).
1144
+
1145
+ Arguments:
1146
+ {
1147
+ "addresses"
1148
+ [
1149
+ "address" (string) The base58check encoded address
1150
+ ,...
1151
+ ]
1152
+ },
1153
+ "includeAssets" (boolean, optional, default false) If true this will return an expanded result which includes asset deltas
1154
+
1155
+ Result:
1156
+ [
1157
+ {
1158
+ "address" (string) The base58check encoded address
1159
+ "assetName" (string) The name of the associated asset (XNA for Neurai)
1160
+ "txid" (string) The related txid
1161
+ "index" (number) The related input or output index
1162
+ "satoshis" (number) The difference of satoshis
1163
+ "timestamp" (number) The time the transaction entered the mempool (seconds)
1164
+ "prevtxid" (string) The previous txid (if spending)
1165
+ "prevout" (string) The previous transaction output index (if spending)
1166
+ }
1167
+ ]
1168
+
1169
+ Examples:
1170
+ > raven-cli getaddressmempool '{"addresses": ["12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX"]}'
1171
+ > 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/
1172
+ > raven-cli getaddressmempool '{"addresses": ["12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX"]}', true
1173
+ > 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/
1174
+
1175
+ &nbsp;<br> &nbsp;<br/>
1176
+ ## getaddresstxids
1177
+ &nbsp;<br/> getaddresstxids
1178
+
1179
+ Returns the txids for an address(es) (requires addressindex to be enabled).
1180
+
1181
+ Arguments:
1182
+ {
1183
+ "addresses"
1184
+ [
1185
+ "address" (string) The base58check encoded address
1186
+ ,...
1187
+ ]
1188
+ "start" (number, optional) The start block height
1189
+ "end" (number, optional) The end block height
1190
+ },
1191
+ "includeAssets" (boolean, optional, default false) If true this will return an expanded result which includes asset transactions
1192
+
1193
+ Result:
1194
+ [
1195
+ "transactionid" (string) The transaction id
1196
+ ,...
1197
+ ]
1198
+
1199
+ Examples:
1200
+ > raven-cli getaddresstxids '{"addresses": ["12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX"]}'
1201
+ > 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/
1202
+ > raven-cli getaddresstxids '{"addresses": ["12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX"]}', true
1203
+ > 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/
1204
+
1205
+ &nbsp;<br> &nbsp;<br/>
1206
+ ## getaddressutxos
1207
+ &nbsp;<br/> getaddressutxos
1208
+
1209
+ Returns all unspent outputs for an address (requires addressindex to be enabled).
1210
+
1211
+ Arguments:
1212
+ {
1213
+ "addresses"
1214
+ [
1215
+ "address" (string) The base58check encoded address
1216
+ ,...
1217
+ ],
1218
+ "chainInfo", (boolean, optional, default false) Include chain info with results
1219
+ "assetName" (string, optional) Get UTXOs for a particular asset instead of XNA ('*' for all assets).
1220
+ }
1221
+
1222
+ Result
1223
+ [
1224
+ {
1225
+ "address" (string) The address base58check encoded
1226
+ "assetName" (string) The asset associated with the UTXOs (XNA for Neurai)
1227
+ "txid" (string) The output txid
1228
+ "height" (number) The block height
1229
+ "outputIndex" (number) The output index
1230
+ "script" (strin) The script hex encoded
1231
+ "satoshis" (number) The number of satoshis of the output
1232
+ }
1233
+ ]
1234
+
1235
+ Examples:
1236
+ > raven-cli getaddressutxos '{"addresses": ["12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX"]}'
1237
+ > 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/
1238
+ > raven-cli getaddressutxos '{"addresses": ["12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX"],"assetName":"MY_ASSET"}'
1239
+ > 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/
1240
+
1241
+ &nbsp;<br> &nbsp;<br/>
1242
+ ## getassetdata
1243
+ &nbsp;<br/> getassetdata "asset_name"
1244
+
1245
+ Returns assets metadata if that asset exists
1246
+
1247
+ Arguments:
1248
+ 1. "asset_name" (string, required) the name of the asset
1249
+
1250
+ Result:
1251
+ {
1252
+ name: (string),
1253
+ amount: (number),
1254
+ units: (number),
1255
+ reissuable: (number),
1256
+ has_ipfs: (number),
1257
+ ipfs_hash: (hash), (only if has_ipfs = 1 and that data is a ipfs hash)
1258
+ txid_hash: (hash), (only if has_ipfs = 1 and that data is a txid hash)
1259
+ verifier_string: (string)
1260
+ }
1261
+
1262
+ Examples:
1263
+ > raven-cli getassetdata "ASSET_NAME"
1264
+ > 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/
1265
+
1266
+ &nbsp;<br> &nbsp;<br/>
1267
+ ## getbalance
1268
+ &nbsp;<br/> getbalance ( "account" minconf include_watchonly )
1269
+
1270
+ If account is not specified, returns the server's total available balance.
1271
+ If account is specified (DEPRECATED), returns the balance in the account.
1272
+ Note that the account "" is not the same as leaving the parameter out.
1273
+ The server total may be different to the balance in the default "" account.
1274
+
1275
+ Arguments:
1276
+ 1. "account" (string, optional) DEPRECATED. The account string may be given as a
1277
+ specific account name to find the balance associated with wallet keys in
1278
+ a named account, or as the empty string ("") to find the balance
1279
+ associated with wallet keys not in any named account, or as "*" to find
1280
+ the balance associated with all wallet keys regardless of account.
1281
+ When this option is specified, it calculates the balance in a different
1282
+ way than when it is not specified, and which can count spends twice when
1283
+ there are conflicting pending transactions (such as those created by
1284
+ the bumpfee command), temporarily resulting in low or even negative
1285
+ balances. In general, account balance calculation is not considered
1286
+ reliable and has resulted in confusing outcomes, so it is recommended to
1287
+ avoid passing this argument.
1288
+ 2. minconf (numeric, optional, default=1) Only include transactions confirmed at least this many times.
1289
+ 3. include_watchonly (bool, optional, default=false) Also include balance in watch-only addresses (see 'importaddress')
1290
+
1291
+ Result:
1292
+ amount (numeric) The total amount in XNA received for this account.
1293
+
1294
+ Examples:
1295
+
1296
+ The total amount in the wallet with 1 or more confirmations
1297
+ > raven-cli getbalance
1298
+
1299
+ The total amount in the wallet at least 6 blocks confirmed
1300
+ > raven-cli getbalance "*" 6
1301
+
1302
+ As a json rpc call
1303
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getbalance", "params": ["*", 6] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1304
+
1305
+ &nbsp;<br> &nbsp;<br/>
1306
+ ## getbestblockhash
1307
+ &nbsp;<br/> getbestblockhash
1308
+
1309
+ Returns the hash of the best (tip) block in the longest blockchain.
1310
+
1311
+ Result:
1312
+ "hex" (string) the block hash hex encoded
1313
+
1314
+ Examples:
1315
+ > raven-cli getbestblockhash
1316
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getbestblockhash", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1317
+
1318
+ &nbsp;<br> &nbsp;<br/>
1319
+ ## getblock
1320
+ &nbsp;<br/> getblock "blockhash" ( verbosity )
1321
+
1322
+ If verbosity is 0, returns a string that is serialized, hex-encoded data for block 'hash'.
1323
+ If verbosity is 1, returns an Object with information about block <hash>.
1324
+ If verbosity is 2, returns an Object with information about block <hash> and information about each transaction.
1325
+
1326
+ Arguments:
1327
+ 1. "blockhash" (string, required) The block hash
1328
+ 2. verbosity (numeric, optional, default=1) 0 for hex encoded data, 1 for a json object, and 2 for json object with transaction data
1329
+
1330
+ Result (for verbosity = 0):
1331
+ "data" (string) A string that is serialized, hex-encoded data for block 'hash'.
1332
+
1333
+ Result (for verbosity = 1):
1334
+ {
1335
+ "hash" : "hash", (string) the block hash (same as provided)
1336
+ "confirmations" : n, (numeric) The number of confirmations, or -1 if the block is not on the main chain
1337
+ "size" : n, (numeric) The block size
1338
+ "strippedsize" : n, (numeric) The block size excluding witness data
1339
+ "weight" : n (numeric) The block weight as defined in BIP 141
1340
+ "height" : n, (numeric) The block height or index
1341
+ "version" : n, (numeric) The block version
1342
+ "versionHex" : "00000000", (string) The block version formatted in hexadecimal
1343
+ "merkleroot" : "xxxx", (string) The merkle root
1344
+ "tx" : [ (array of string) The transaction ids
1345
+ "transactionid" (string) The transaction id
1346
+ ,...
1347
+ ],
1348
+ "time" : ttt, (numeric) The block time in seconds since epoch (Jan 1 1970 GMT)
1349
+ "mediantime" : ttt, (numeric) The median block time in seconds since epoch (Jan 1 1970 GMT)
1350
+ "nonce" : n, (numeric) The nonce
1351
+ "bits" : "1d00ffff", (string) The bits
1352
+ "difficulty" : x.xxx, (numeric) The difficulty
1353
+ "chainwork" : "xxxx", (string) Expected number of hashes required to produce the chain up to this block (in hex)
1354
+ "previousblockhash" : "hash", (string) The hash of the previous block
1355
+ "nextblockhash" : "hash" (string) The hash of the next block
1356
+ }
1357
+
1358
+ Result (for verbosity = 2):
1359
+ {
1360
+ ..., Same output as verbosity = 1.
1361
+ "tx" : [ (array of Objects) The transactions in the format of the getrawtransaction RPC. Different from verbosity = 1 "tx" result.
1362
+ ,...
1363
+ ],
1364
+ ,... Same output as verbosity = 1.
1365
+ }
1366
+
1367
+ Examples:
1368
+ > raven-cli getblock "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"
1369
+ > 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/
1370
+
1371
+ &nbsp;<br> &nbsp;<br/>
1372
+ ## getblockchaininfo
1373
+ &nbsp;<br/> getblockchaininfo
1374
+ Returns an object containing various state info regarding blockchain processing.
1375
+
1376
+ Result:
1377
+ {
1378
+ "chain": "xxxx", (string) current network name as defined in BIP70 (main, test, regtest)
1379
+ "blocks": xxxxxx, (numeric) the current number of blocks processed in the server
1380
+ "headers": xxxxxx, (numeric) the current number of headers we have validated
1381
+ "bestblockhash": "...", (string) the hash of the currently best block
1382
+ "difficulty": xxxxxx, (numeric) the current difficulty
1383
+ "mediantime": xxxxxx, (numeric) median time for the current best block
1384
+ "verificationprogress": xxxx, (numeric) estimate of verification progress [0..1]
1385
+ "chainwork": "xxxx" (string) total amount of work in active chain, in hexadecimal
1386
+ "size_on_disk": xxxxxx, (numeric) the estimated size of the block and undo files on disk
1387
+ "pruned": xx, (boolean) if the blocks are subject to pruning
1388
+ "pruneheight": xxxxxx, (numeric) lowest-height complete block stored (only present if pruning is enabled)
1389
+ "automatic_pruning": xx, (boolean) whether automatic pruning is enabled (only present if pruning is enabled)
1390
+ "prune_target_size": xxxxxx, (numeric) the target size used by pruning (only present if automatic pruning is enabled)
1391
+ "softforks": [ (array) status of softforks in progress
1392
+ {
1393
+ "id": "xxxx", (string) name of softfork
1394
+ "version": xx, (numeric) block version
1395
+ "reject": { (object) progress toward rejecting pre-softfork blocks
1396
+ "status": xx, (boolean) true if threshold reached
1397
+ },
1398
+ }, ...
1399
+ ],
1400
+ "bip9_softforks": { (object) status of BIP9 softforks in progress
1401
+ "xxxx" : { (string) name of the softfork
1402
+ "status": "xxxx", (string) one of "defined", "started", "locked_in", "active", "failed"
1403
+ "bit": xx, (numeric) the bit (0-28) in the block version field used to signal this softfork (only for "started" status)
1404
+ "startTime": xx, (numeric) the minimum median time past of a block at which the bit gains its meaning
1405
+ "timeout": xx, (numeric) the median time past of a block at which the deployment is considered failed if not yet locked in
1406
+ "since": xx, (numeric) height of the first block to which the status applies
1407
+ "statistics": { (object) numeric statistics about BIP9 signalling for a softfork (only for "started" status)
1408
+ "period": xx, (numeric) the length in blocks of the BIP9 signalling period
1409
+ "threshold": xx, (numeric) the number of blocks with the version bit set required to activate the feature
1410
+ "elapsed": xx, (numeric) the number of blocks elapsed since the beginning of the current period
1411
+ "count": xx, (numeric) the number of blocks with the version bit set in the current period
1412
+ "possible": xx (boolean) returns false if there are not enough blocks left in this period to pass activation threshold
1413
+ }
1414
+ }
1415
+ }
1416
+ "warnings" : "...", (string) any network and blockchain warnings.
1417
+ }
1418
+
1419
+ Examples:
1420
+ > raven-cli getblockchaininfo
1421
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblockchaininfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1422
+
1423
+ &nbsp;<br> &nbsp;<br/>
1424
+ ## getblockcount
1425
+ &nbsp;<br/> getblockcount
1426
+
1427
+ Returns the number of blocks in the longest blockchain.
1428
+
1429
+ Result:
1430
+ n (numeric) The current block count
1431
+
1432
+ Examples:
1433
+ > raven-cli getblockcount
1434
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblockcount", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1435
+
1436
+ &nbsp;<br> &nbsp;<br/>
1437
+ ## getblockhash
1438
+ &nbsp;<br/> getblockhash height
1439
+
1440
+ Returns hash of block in best-block-chain at height provided.
1441
+
1442
+ Arguments:
1443
+ 1. height (numeric, required) The height index
1444
+
1445
+ Result:
1446
+ "hash" (string) The block hash
1447
+
1448
+ Examples:
1449
+ > raven-cli getblockhash 1000
1450
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblockhash", "params": [1000] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1451
+
1452
+ &nbsp;<br> &nbsp;<br/>
1453
+ ## getblockhashes
1454
+ &nbsp;<br/> getblockhashes timestamp
1455
+
1456
+ Returns array of hashes of blocks within the timestamp range provided.
1457
+
1458
+ Arguments:
1459
+ 1. high (numeric, required) The newer block timestamp
1460
+ 2. low (numeric, required) The older block timestamp
1461
+ 3. options (string, required) A json object
1462
+ {
1463
+ "noOrphans":true (boolean) will only include blocks on the main chain
1464
+ "logicalTimes":true (boolean) will include logical timestamps with hashes
1465
+ }
1466
+
1467
+ Result:
1468
+ [
1469
+ "hash" (string) The block hash
1470
+ ]
1471
+ [
1472
+ {
1473
+ "blockhash": (string) The block hash
1474
+ "logicalts": (numeric) The logical timestamp
1475
+ }
1476
+ ]
1477
+
1478
+ Examples:
1479
+ > raven-cli getblockhashes 1231614698 1231024505
1480
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblockhashes", "params": [1231614698, 1231024505] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1481
+ > raven-cli getblockhashes 1231614698 1231024505 '{"noOrphans":false, "logicalTimes":true}'
1482
+
1483
+ &nbsp;<br> &nbsp;<br/>
1484
+ ## getblockheader
1485
+ &nbsp;<br/> getblockheader "hash" ( verbose )
1486
+
1487
+ If verbose is false, returns a string that is serialized, hex-encoded data for blockheader 'hash'.
1488
+ If verbose is true, returns an Object with information about blockheader <hash>.
1489
+
1490
+ Arguments:
1491
+ 1. "hash" (string, required) The block hash
1492
+ 2. verbose (boolean, optional, default=true) true for a json object, false for the hex encoded data
1493
+
1494
+ Result (for verbose = true):
1495
+ {
1496
+ "hash" : "hash", (string) the block hash (same as provided)
1497
+ "confirmations" : n, (numeric) The number of confirmations, or -1 if the block is not on the main chain
1498
+ "height" : n, (numeric) The block height or index
1499
+ "version" : n, (numeric) The block version
1500
+ "versionHex" : "00000000", (string) The block version formatted in hexadecimal
1501
+ "merkleroot" : "xxxx", (string) The merkle root
1502
+ "time" : ttt, (numeric) The block time in seconds since epoch (Jan 1 1970 GMT)
1503
+ "mediantime" : ttt, (numeric) The median block time in seconds since epoch (Jan 1 1970 GMT)
1504
+ "nonce" : n, (numeric) The nonce
1505
+ "bits" : "1d00ffff", (string) The bits
1506
+ "difficulty" : x.xxx, (numeric) The difficulty
1507
+ "chainwork" : "0000...1f3" (string) Expected number of hashes required to produce the current chain (in hex)
1508
+ "previousblockhash" : "hash", (string) The hash of the previous block
1509
+ "nextblockhash" : "hash", (string) The hash of the next block
1510
+ }
1511
+
1512
+ Result (for verbose=false):
1513
+ "data" (string) A string that is serialized, hex-encoded data for block 'hash'.
1514
+
1515
+ Examples:
1516
+ > raven-cli getblockheader "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"
1517
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblockheader", "params": ["00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1518
+
1519
+ &nbsp;<br> &nbsp;<br/>
1520
+ ## getblocktemplate
1521
+ &nbsp;<br/> getblocktemplate ( TemplateRequest )
1522
+
1523
+ If the request parameters include a 'mode' key, that is used to explicitly select between the default 'template' request or a 'proposal'.
1524
+ It returns data needed to construct a block to work on.
1525
+ For full specification, see BIPs 22, 23, 9, and 145:
1526
+ https://github.com/raven/bips/blob/master/bip-0022.mediawiki
1527
+ https://github.com/raven/bips/blob/master/bip-0023.mediawiki
1528
+ https://github.com/raven/bips/blob/master/bip-0009.mediawiki#getblocktemplate_changes
1529
+ https://github.com/raven/bips/blob/master/bip-0145.mediawiki
1530
+
1531
+ Arguments:
1532
+ 1. template_request (json object, optional) A json object in the following spec
1533
+ {
1534
+ "mode":"template" (string, optional) This must be set to "template", "proposal" (see BIP 23), or omitted
1535
+ "capabilities":[ (array, optional) A list of strings
1536
+ "support" (string) client side supported feature, 'longpoll', 'coinbasetxn', 'coinbasevalue', 'proposal', 'serverlist', 'workid'
1537
+ ,...
1538
+ ],
1539
+ "rules":[ (array, optional) A list of strings
1540
+ "support" (string) client side supported softfork deployment
1541
+ ,...
1542
+ ]
1543
+ }
1544
+
1545
+
1546
+ Result:
1547
+ {
1548
+ "version" : n, (numeric) The preferred block version
1549
+ "rules" : [ "rulename", ... ], (array of strings) specific block rules that are to be enforced
1550
+ "vbavailable" : { (json object) set of pending, supported versionbit (BIP 9) softfork deployments
1551
+ "rulename" : bitnumber (numeric) identifies the bit number as indicating acceptance and readiness for the named softfork rule
1552
+ ,...
1553
+ },
1554
+ "vbrequired" : n, (numeric) bit mask of versionbits the server requires set in submissions
1555
+ "previousblockhash" : "xxxx", (string) The hash of current highest block
1556
+ "transactions" : [ (array) contents of non-coinbase transactions that should be included in the next block
1557
+ {
1558
+ "data" : "xxxx", (string) transaction data encoded in hexadecimal (byte-for-byte)
1559
+ "txid" : "xxxx", (string) transaction id encoded in little-endian hexadecimal
1560
+ "hash" : "xxxx", (string) hash encoded in little-endian hexadecimal (including witness data)
1561
+ "depends" : [ (array) array of numbers
1562
+ n (numeric) transactions before this one (by 1-based index in 'transactions' list) that must be present in the final block if this one is
1563
+ ,...
1564
+ ],
1565
+ "fee": n, (numeric) difference in value between transaction inputs and outputs (in satoshis); for coinbase transactions, this is a negative Number of the total collected block fees (ie, not including the block subsidy); if key is not present, fee is unknown and clients MUST NOT assume there isn't one
1566
+ "sigops" : n, (numeric) total SigOps cost, as counted for purposes of block limits; if key is not present, sigop cost is unknown and clients MUST NOT assume it is zero
1567
+ "weight" : n, (numeric) total transaction weight, as counted for purposes of block limits
1568
+ "required" : true|false (boolean) if provided and true, this transaction must be in the final block
1569
+ }
1570
+ ,...
1571
+ ],
1572
+ "coinbaseaux" : { (json object) data that should be included in the coinbase's scriptSig content
1573
+ "flags" : "xx" (string) key name is to be ignored, and value included in scriptSig
1574
+ },
1575
+ "coinbasevalue" : n, (numeric) maximum allowable input to coinbase transaction, including the generation award and transaction fees (in satoshis)
1576
+ "coinbasetxn" : { ... }, (json object) information for coinbase transaction
1577
+ "target" : "xxxx", (string) The hash target
1578
+ "mintime" : xxx, (numeric) The minimum timestamp appropriate for next block time in seconds since epoch (Jan 1 1970 GMT)
1579
+ "mutable" : [ (array of string) list of ways the block template may be changed
1580
+ "value" (string) A way the block template may be changed, e.g. 'time', 'transactions', 'prevblock'
1581
+ ,...
1582
+ ],
1583
+ "noncerange" : "00000000ffffffff",(string) A range of valid nonces
1584
+ "sigoplimit" : n, (numeric) limit of sigops in blocks
1585
+ "sizelimit" : n, (numeric) limit of block size
1586
+ "weightlimit" : n, (numeric) limit of block weight
1587
+ "curtime" : ttt, (numeric) current timestamp in seconds since epoch (Jan 1 1970 GMT)
1588
+ "bits" : "xxxxxxxx", (string) compressed target of next block
1589
+ "height" : n (numeric) The height of the next block
1590
+ }
1591
+
1592
+ Examples:
1593
+ > raven-cli getblocktemplate
1594
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblocktemplate", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1595
+
1596
+ &nbsp;<br> &nbsp;<br/>
1597
+ ## getcacheinfo
1598
+ &nbsp;<br/> getcacheinfo
1599
+
1600
+ Result:
1601
+ [
1602
+ uxto cache size:
1603
+ asset total (exclude dirty):
1604
+ asset address map:
1605
+ asset address balance:
1606
+ my unspent asset:
1607
+ reissue data:
1608
+ asset metadata map:
1609
+ asset metadata list (est):
1610
+ dirty cache (est):
1611
+ ]
1612
+
1613
+ Examples:
1614
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getcacheinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1615
+ > raven-cli getcacheinfo
1616
+
1617
+ &nbsp;<br> &nbsp;<br/>
1618
+ ## getchaintips
1619
+ &nbsp;<br/> getchaintips
1620
+ Return information about all known tips in the block tree, including the main chain as well as orphaned branches.
1621
+
1622
+ Result:
1623
+ [
1624
+ {
1625
+ "height": xxxx, (numeric) height of the chain tip
1626
+ "hash": "xxxx", (string) block hash of the tip
1627
+ "branchlen": 0 (numeric) zero for main chain
1628
+ "status": "active" (string) "active" for the main chain
1629
+ },
1630
+ {
1631
+ "height": xxxx,
1632
+ "hash": "xxxx",
1633
+ "branchlen": 1 (numeric) length of branch connecting the tip to the main chain
1634
+ "status": "xxxx" (string) status of the chain (active, valid-fork, valid-headers, headers-only, invalid)
1635
+ }
1636
+ ]
1637
+ Possible values for status:
1638
+ 1. "invalid" This branch contains at least one invalid block
1639
+ 2. "headers-only" Not all blocks for this branch are available, but the headers are valid
1640
+ 3. "valid-headers" All blocks are available for this branch, but they were never fully validated
1641
+ 4. "valid-fork" This branch is not part of the active chain, but is fully validated
1642
+ 5. "active" This is the tip of the active main chain, which is certainly valid
1643
+
1644
+ Examples:
1645
+ > raven-cli getchaintips
1646
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getchaintips", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1647
+
1648
+ &nbsp;<br> &nbsp;<br/>
1649
+ ## getchaintxstats
1650
+ &nbsp;<br/> getchaintxstats ( nblocks blockhash )
1651
+
1652
+ Compute statistics about the total number and rate of transactions in the chain.
1653
+
1654
+ Arguments:
1655
+ 1. nblocks (numeric, optional) Size of the window in number of blocks (default: one month).
1656
+ 2. "blockhash" (string, optional) The hash of the block that ends the window.
1657
+
1658
+ Result:
1659
+ {
1660
+ "time": xxxxx, (numeric) The timestamp for the final block in the window in UNIX format.
1661
+ "txcount": xxxxx, (numeric) The total number of transactions in the chain up to that point.
1662
+ "window_block_count": xxxxx, (numeric) Size of the window in number of blocks.
1663
+ "window_tx_count": xxxxx, (numeric) The number of transactions in the window. Only returned if "window_block_count" is > 0.
1664
+ "window_interval": xxxxx, (numeric) The elapsed time in the window in seconds. Only returned if "window_block_count" is > 0.
1665
+ "txrate": x.xx, (numeric) The average rate of transactions per second in the window. Only returned if "window_interval" is > 0.
1666
+ }
1667
+
1668
+ Examples:
1669
+ > raven-cli getchaintxstats
1670
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getchaintxstats", "params": [2016] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1671
+
1672
+ &nbsp;<br> &nbsp;<br/>
1673
+ ## getconnectioncount
1674
+ &nbsp;<br/> getconnectioncount
1675
+
1676
+ Returns the number of connections to other nodes.
1677
+
1678
+ Result:
1679
+ n (numeric) The connection count
1680
+
1681
+ Examples:
1682
+ > raven-cli getconnectioncount
1683
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getconnectioncount", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1684
+
1685
+ &nbsp;<br> &nbsp;<br/>
1686
+ ## getdifficulty
1687
+ &nbsp;<br/> getdifficulty
1688
+
1689
+ Returns the proof-of-work difficulty as a multiple of the minimum difficulty.
1690
+
1691
+ Result:
1692
+ n.nnn (numeric) the proof-of-work difficulty as a multiple of the minimum difficulty.
1693
+
1694
+ Examples:
1695
+ > raven-cli getdifficulty
1696
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getdifficulty", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1697
+
1698
+ &nbsp;<br> &nbsp;<br/>
1699
+ ## getdistributestatus
1700
+ &nbsp;<br/> getdistributestatus "asset_name" snapshot_height "distribution_asset_name" gross_distribution_amount ( "exception_addresses" )
1701
+
1702
+ Give information about the status of the distribution
1703
+
1704
+ Arguments:
1705
+ 1. "asset_name" (string, required) The reward will be distributed all owners of this asset
1706
+ 2. "snapshot_height" (number, required) The block height of the ownership snapshot
1707
+ 3. "distribution_asset_name" (string, required) The name of the asset that will be distributed, or XNA
1708
+ 4. "gross_distribution_amount" (number, required) The amount of the distribution asset that will be split amongst all owners
1709
+ 5. "exception_addresses" (string, optional) Ownership addresses that should be excluded
1710
+
1711
+ Examples:
1712
+ > raven-cli getdistributestatus "TRONCO" 12345 "XNA" 1000
1713
+ > raven-cli getdistributestatus "PHATSTACKS" 12345 "DIVIDENDS" 1000 "mwN7xC3yomYdvJuVXkVC7ymY9wNBjWNduD,n4Rf18edydDaRBh7t6gHUbuByLbWEoWUTg"
1714
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getdistributestatus", "params": ["TRONCO" 34987 "DIVIDENDS" 100000] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1715
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getdistributestatus", "params": ["PHATSTACKS" 34987 "XNA" 100000 "mwN7xC3yomYdvJuVXkVC7ymY9wNBjWNduD,n4Rf18edydDaRBh7t6gHUbuByLbWEoWUTg"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1716
+
1717
+ &nbsp;<br> &nbsp;<br/>
1718
+ ## getgenerate
1719
+ &nbsp;<br/> getgenerate
1720
+
1721
+ Return if the server is set to generate coins or not. The default is false.
1722
+ It is set with the command line argument -gen (or raven.conf setting gen)
1723
+ It can also be set with the setgenerate call.
1724
+
1725
+ Result
1726
+ true|false (boolean) If the server is set to generate coins or not
1727
+
1728
+ Examples:
1729
+ > raven-cli getgenerate
1730
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getgenerate", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1731
+
1732
+ &nbsp;<br> &nbsp;<br/>
1733
+ ## getinfo
1734
+ &nbsp;<br/> getinfo
1735
+
1736
+ DEPRECATED. Returns an object containing various state info.
1737
+
1738
+ Result:
1739
+ {
1740
+ "deprecation-warning": "..." (string) warning that the getinfo command is deprecated and will be removed in 0.16
1741
+ "version": xxxxx, (numeric) the server version
1742
+ "protocolversion": xxxxx, (numeric) the protocol version
1743
+ "walletversion": xxxxx, (numeric) the wallet version
1744
+ "balance": xxxxxxx, (numeric) the total Neurai balance of the wallet
1745
+ "blocks": xxxxxx, (numeric) the current number of blocks processed in the server
1746
+ "timeoffset": xxxxx, (numeric) the time offset
1747
+ "connections": xxxxx, (numeric) the number of connections
1748
+ "proxy": "host:port", (string, optional) the proxy used by the server
1749
+ "difficulty": xxxxxx, (numeric) the current difficulty
1750
+ "testnet": true|false, (boolean) if the server is using testnet or not
1751
+ "keypoololdest": xxxxxx, (numeric) the timestamp (seconds since Unix epoch) of the oldest pre-generated key in the key pool
1752
+ "keypoolsize": xxxx, (numeric) how many new keys are pre-generated
1753
+ "unlocked_until": ttt, (numeric) the timestamp in seconds since epoch (midnight Jan 1 1970 GMT) that the wallet is unlocked for transfers, or 0 if the wallet is locked
1754
+ "paytxfee": x.xxxx, (numeric) the transaction fee set in XNA/kB
1755
+ "relayfee": x.xxxx, (numeric) minimum relay fee for transactions in XNA/kB
1756
+ "errors": "..." (string) any error messages
1757
+ }
1758
+
1759
+ Examples:
1760
+ > raven-cli getinfo
1761
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1762
+
1763
+ &nbsp;<br> &nbsp;<br/>
1764
+ ## getkawpowhash
1765
+ &nbsp;<br/> getkawpowhash "header_hash" "mix_hash" nonce, height, "target"
1766
+
1767
+ Get the kawpow hash for a block given its block data
1768
+
1769
+ Arguments
1770
+ 1. "header_hash" (string, required) the prow_pow header hash that was given to the gpu miner from this rpc client
1771
+ 2. "mix_hash" (string, required) the mix hash that was mined by the gpu miner via rpc
1772
+ 3. "nonce" (string, required) the hex nonce of the block that hashed the valid block
1773
+ 4. "height" (number, required) the height of the block data that is being hashed
1774
+ 5. "target" (string, optional) the target of the block that is hash is trying to meet
1775
+
1776
+ Result:
1777
+
1778
+ Examples:
1779
+ > raven-cli getkawpowhash "header_hash" "mix_hash" "0x100000" 2456
1780
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getkawpowhash", "params": ["header_hash" "mix_hash" "0x100000" 2456] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1781
+
1782
+ &nbsp;<br> &nbsp;<br/>
1783
+ ## getmasterkeyinfo
1784
+ &nbsp;<br/> getmasterkeyinfo
1785
+
1786
+ Fetches and displays the master private key and the master public key.
1787
+
1788
+ Result:
1789
+ { (json object)
1790
+ "bip32_root_private" : (string) extended master private key,
1791
+ "bip32_root_public" : (string) extended master public key,
1792
+ "account_derivation_path" : (string) The derivation path to the account public/private keys
1793
+ "account_extended_private_key" : (string) extended account private key,
1794
+ "account_extended_public_key" : (string) extended account public key,
1795
+ }
1796
+
1797
+ Examples:
1798
+ > raven-cli getmasterkeyinfo
1799
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getmasterkeyinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1800
+
1801
+ &nbsp;<br> &nbsp;<br/>
1802
+ ## getmemoryinfo
1803
+ &nbsp;<br/> getmemoryinfo ("mode")
1804
+ Returns an object containing information about memory usage.
1805
+ Arguments:
1806
+ 1. "mode" determines what kind of information is returned. This argument is optional, the default mode is "stats".
1807
+ - "stats" returns general statistics about memory usage in the daemon.
1808
+ - "mallocinfo" returns an XML string describing low-level heap state (only available if compiled with glibc 2.10+).
1809
+
1810
+ Result (mode "stats"):
1811
+ {
1812
+ "locked": { (json object) Information about locked memory manager
1813
+ "used": xxxxx, (numeric) Number of bytes used
1814
+ "free": xxxxx, (numeric) Number of bytes available in current arenas
1815
+ "total": xxxxxxx, (numeric) Total number of bytes managed
1816
+ "locked": xxxxxx, (numeric) Amount of bytes that succeeded locking. If this number is smaller than total, locking pages failed at some point and key data could be swapped to disk.
1817
+ "chunks_used": xxxxx, (numeric) Number allocated chunks
1818
+ "chunks_free": xxxxx, (numeric) Number unused chunks
1819
+ }
1820
+ }
1821
+
1822
+ Result (mode "mallocinfo"):
1823
+ "<malloc version="1">..."
1824
+
1825
+ Examples:
1826
+ > raven-cli getmemoryinfo
1827
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getmemoryinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1828
+
1829
+ &nbsp;<br> &nbsp;<br/>
1830
+ ## getmempoolancestors
1831
+ &nbsp;<br/> getmempoolancestors txid (verbose)
1832
+
1833
+ If txid is in the mempool, returns all in-mempool ancestors.
1834
+
1835
+ Arguments:
1836
+ 1. "txid" (string, required) The transaction id (must be in mempool)
1837
+ 2. verbose (boolean, optional, default=false) True for a json object, false for array of transaction ids
1838
+
1839
+ Result (for verbose=false):
1840
+ [ (json array of strings)
1841
+ "transactionid" (string) The transaction id of an in-mempool ancestor transaction
1842
+ ,...
1843
+ ]
1844
+
1845
+ Result (for verbose=true):
1846
+ { (json object)
1847
+ "transactionid" : { (json object)
1848
+ "size" : n, (numeric) virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted.
1849
+ "fee" : n, (numeric) transaction fee in XNA
1850
+ "modifiedfee" : n, (numeric) transaction fee with fee deltas used for mining priority
1851
+ "time" : n, (numeric) local time transaction entered pool in seconds since 1 Jan 1970 GMT
1852
+ "height" : n, (numeric) block height when transaction entered pool
1853
+ "descendantcount" : n, (numeric) number of in-mempool descendant transactions (including this one)
1854
+ "descendantsize" : n, (numeric) virtual transaction size of in-mempool descendants (including this one)
1855
+ "descendantfees" : n, (numeric) modified fees (see above) of in-mempool descendants (including this one)
1856
+ "ancestorcount" : n, (numeric) number of in-mempool ancestor transactions (including this one)
1857
+ "ancestorsize" : n, (numeric) virtual transaction size of in-mempool ancestors (including this one)
1858
+ "ancestorfees" : n, (numeric) modified fees (see above) of in-mempool ancestors (including this one)
1859
+ "wtxid" : hash, (string) hash of serialized transaction, including witness data
1860
+ "depends" : [ (array) unconfirmed transactions used as inputs for this transaction
1861
+ "transactionid", (string) parent transaction id
1862
+ ... ]
1863
+ }, ...
1864
+ }
1865
+
1866
+ Examples:
1867
+ > raven-cli getmempoolancestors "mytxid"
1868
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getmempoolancestors", "params": ["mytxid"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1869
+
1870
+ &nbsp;<br> &nbsp;<br/>
1871
+ ## getmempooldescendants
1872
+ &nbsp;<br/> getmempooldescendants txid (verbose)
1873
+
1874
+ If txid is in the mempool, returns all in-mempool descendants.
1875
+
1876
+ Arguments:
1877
+ 1. "txid" (string, required) The transaction id (must be in mempool)
1878
+ 2. verbose (boolean, optional, default=false) True for a json object, false for array of transaction ids
1879
+
1880
+ Result (for verbose=false):
1881
+ [ (json array of strings)
1882
+ "transactionid" (string) The transaction id of an in-mempool descendant transaction
1883
+ ,...
1884
+ ]
1885
+
1886
+ Result (for verbose=true):
1887
+ { (json object)
1888
+ "transactionid" : { (json object)
1889
+ "size" : n, (numeric) virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted.
1890
+ "fee" : n, (numeric) transaction fee in XNA
1891
+ "modifiedfee" : n, (numeric) transaction fee with fee deltas used for mining priority
1892
+ "time" : n, (numeric) local time transaction entered pool in seconds since 1 Jan 1970 GMT
1893
+ "height" : n, (numeric) block height when transaction entered pool
1894
+ "descendantcount" : n, (numeric) number of in-mempool descendant transactions (including this one)
1895
+ "descendantsize" : n, (numeric) virtual transaction size of in-mempool descendants (including this one)
1896
+ "descendantfees" : n, (numeric) modified fees (see above) of in-mempool descendants (including this one)
1897
+ "ancestorcount" : n, (numeric) number of in-mempool ancestor transactions (including this one)
1898
+ "ancestorsize" : n, (numeric) virtual transaction size of in-mempool ancestors (including this one)
1899
+ "ancestorfees" : n, (numeric) modified fees (see above) of in-mempool ancestors (including this one)
1900
+ "wtxid" : hash, (string) hash of serialized transaction, including witness data
1901
+ "depends" : [ (array) unconfirmed transactions used as inputs for this transaction
1902
+ "transactionid", (string) parent transaction id
1903
+ ... ]
1904
+ }, ...
1905
+ }
1906
+
1907
+ Examples:
1908
+ > raven-cli getmempooldescendants "mytxid"
1909
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getmempooldescendants", "params": ["mytxid"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1910
+
1911
+ &nbsp;<br> &nbsp;<br/>
1912
+ ## getmempoolentry
1913
+ &nbsp;<br/> getmempoolentry txid
1914
+
1915
+ Returns mempool data for given transaction
1916
+
1917
+ Arguments:
1918
+ 1. "txid" (string, required) The transaction id (must be in mempool)
1919
+
1920
+ Result:
1921
+ { (json object)
1922
+ "size" : n, (numeric) virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted.
1923
+ "fee" : n, (numeric) transaction fee in XNA
1924
+ "modifiedfee" : n, (numeric) transaction fee with fee deltas used for mining priority
1925
+ "time" : n, (numeric) local time transaction entered pool in seconds since 1 Jan 1970 GMT
1926
+ "height" : n, (numeric) block height when transaction entered pool
1927
+ "descendantcount" : n, (numeric) number of in-mempool descendant transactions (including this one)
1928
+ "descendantsize" : n, (numeric) virtual transaction size of in-mempool descendants (including this one)
1929
+ "descendantfees" : n, (numeric) modified fees (see above) of in-mempool descendants (including this one)
1930
+ "ancestorcount" : n, (numeric) number of in-mempool ancestor transactions (including this one)
1931
+ "ancestorsize" : n, (numeric) virtual transaction size of in-mempool ancestors (including this one)
1932
+ "ancestorfees" : n, (numeric) modified fees (see above) of in-mempool ancestors (including this one)
1933
+ "wtxid" : hash, (string) hash of serialized transaction, including witness data
1934
+ "depends" : [ (array) unconfirmed transactions used as inputs for this transaction
1935
+ "transactionid", (string) parent transaction id
1936
+ ... ]
1937
+ }
1938
+
1939
+ Examples:
1940
+ > raven-cli getmempoolentry "mytxid"
1941
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getmempoolentry", "params": ["mytxid"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1942
+
1943
+ &nbsp;<br> &nbsp;<br/>
1944
+ ## getmempoolinfo
1945
+ &nbsp;<br/> getmempoolinfo
1946
+
1947
+ Returns details on the active state of the TX memory pool.
1948
+
1949
+ Result:
1950
+ {
1951
+ "size": xxxxx, (numeric) Current tx count
1952
+ "bytes": xxxxx, (numeric) Sum of all virtual transaction sizes as defined in BIP 141. Differs from actual serialized size because witness data is discounted
1953
+ "usage": xxxxx, (numeric) Total memory usage for the mempool
1954
+ "maxmempool": xxxxx, (numeric) Maximum memory usage for the mempool
1955
+ "mempoolminfee": xxxxx (numeric) Minimum fee rate in XNA/kB for tx to be accepted
1956
+ }
1957
+
1958
+ Examples:
1959
+ > raven-cli getmempoolinfo
1960
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getmempoolinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1961
+
1962
+ &nbsp;<br> &nbsp;<br/>
1963
+ ## getmininginfo
1964
+ &nbsp;<br/> getmininginfo
1965
+
1966
+ Returns a json object containing mining-related information.
1967
+ Result:
1968
+ {
1969
+ "blocks": nnn, (numeric) The current block
1970
+ "currentblockweight": nnn, (numeric) The last block weight
1971
+ "currentblocktx": nnn, (numeric) The last block transaction
1972
+ "difficulty": xxx.xxxxx (numeric) The current difficulty
1973
+ "networkhashps": nnn, (numeric) The network hashes per second
1974
+ "hashespersec": nnn, (numeric) The hashes per second of built-in miner
1975
+ "pooledtx": n (numeric) The size of the mempool
1976
+ "chain": "xxxx", (string) current network name as defined in BIP70 (main, test, regtest)
1977
+ "warnings": "..." (string) any network and blockchain warnings
1978
+ "errors": "..." (string) DEPRECATED. Same as warnings. Only shown when ravend is started with -deprecatedrpc=getmininginfo
1979
+ }
1980
+
1981
+ Examples:
1982
+ > raven-cli getmininginfo
1983
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getmininginfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1984
+
1985
+ &nbsp;<br> &nbsp;<br/>
1986
+ ## getmywords
1987
+ &nbsp;<br/> getmywords ( "account" )
1988
+
1989
+ Returns the 12 words and passphrase used by BIP39 to generate the wallets private keys
1990
+ Only returns value if wallet was created by the 12 words import/generation
1991
+
1992
+ Result:
1993
+ "word_list:" (string) A string of words separated by spaces
1994
+ "passphrase:" (optional) Only show if passphrase was used when creating the wallet
1995
+
1996
+ Examples:
1997
+ > raven-cli getmywords
1998
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getmywords", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
1999
+
2000
+ &nbsp;<br> &nbsp;<br/>
2001
+ ## getnettotals
2002
+ &nbsp;<br/> getnettotals
2003
+
2004
+ Returns information about network traffic, including bytes in, bytes out,
2005
+ and current time.
2006
+
2007
+ Result:
2008
+ {
2009
+ "totalbytesrecv": n, (numeric) Total bytes received
2010
+ "totalbytessent": n, (numeric) Total bytes sent
2011
+ "timemillis": t, (numeric) Current UNIX time in milliseconds
2012
+ "uploadtarget":
2013
+ {
2014
+ "timeframe": n, (numeric) Length of the measuring timeframe in seconds
2015
+ "target": n, (numeric) Target in bytes
2016
+ "target_reached": true|false, (boolean) True if target is reached
2017
+ "serve_historical_blocks": true|false, (boolean) True if serving historical blocks
2018
+ "bytes_left_in_cycle": t, (numeric) Bytes left in current time cycle
2019
+ "time_left_in_cycle": t (numeric) Seconds left in current time cycle
2020
+ }
2021
+ }
2022
+
2023
+ Examples:
2024
+ > raven-cli getnettotals
2025
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getnettotals", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2026
+
2027
+ &nbsp;<br> &nbsp;<br/>
2028
+ ## getnetworkhashps
2029
+ &nbsp;<br/> getnetworkhashps ( nblocks height )
2030
+
2031
+ Returns the estimated network hashes per second based on the last n blocks.
2032
+ Pass in [blocks] to override # of blocks, -1 specifies since last difficulty change.
2033
+ Pass in [height] to estimate the network speed at the time when a certain block was found.
2034
+
2035
+ Arguments:
2036
+ 1. nblocks (numeric, optional, default=120) The number of blocks, or -1 for blocks since last difficulty change.
2037
+ 2. height (numeric, optional, default=-1) To estimate at the time of the given height.
2038
+
2039
+ Result:
2040
+ x (numeric) Hashes per second estimated
2041
+
2042
+ Examples:
2043
+ > raven-cli getnetworkhashps
2044
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getnetworkhashps", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2045
+
2046
+ &nbsp;<br> &nbsp;<br/>
2047
+ ## getnetworkinfo
2048
+ &nbsp;<br/> getnetworkinfo
2049
+ Returns an object containing various state info regarding P2P networking.
2050
+
2051
+ Result:
2052
+ {
2053
+ "version": xxxxx, (numeric) the server version
2054
+ "subversion": "/Satoshi:x.x.x/", (string) the server subversion string
2055
+ "protocolversion": xxxxx, (numeric) the protocol version
2056
+ "localservices": "xxxxxxxxxxxxxxxx", (string) the services we offer to the network
2057
+ "localrelay": true|false, (bool) true if transaction relay is requested from peers
2058
+ "timeoffset": xxxxx, (numeric) the time offset
2059
+ "connections": xxxxx, (numeric) the number of connections
2060
+ "networkactive": true|false, (bool) whether p2p networking is enabled
2061
+ "networks": [ (array) information per network
2062
+ {
2063
+ "name": "xxx", (string) network (ipv4, ipv6 or onion)
2064
+ "limited": true|false, (boolean) is the network limited using -onlynet?
2065
+ "reachable": true|false, (boolean) is the network reachable?
2066
+ "proxy": "host:port" (string) the proxy that is used for this network, or empty if none
2067
+ "proxy_randomize_credentials": true|false, (string) Whether randomized credentials are used
2068
+ }
2069
+ ,...
2070
+ ],
2071
+ "relayfee": x.xxxxxxxx, (numeric) minimum relay fee for transactions in XNA/kB
2072
+ "incrementalfee": x.xxxxxxxx, (numeric) minimum fee increment for mempool limiting or BIP 125 replacement in XNA/kB
2073
+ "localaddresses": [ (array) list of local addresses
2074
+ {
2075
+ "address": "xxxx", (string) network address
2076
+ "port": xxx, (numeric) network port
2077
+ "score": xxx (numeric) relative score
2078
+ }
2079
+ ,...
2080
+ ]
2081
+ "warnings": "..." (string) any network and blockchain warnings
2082
+ }
2083
+
2084
+ Examples:
2085
+ > raven-cli getnetworkinfo
2086
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getnetworkinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2087
+
2088
+ &nbsp;<br> &nbsp;<br/>
2089
+ ## getnewaddress
2090
+ &nbsp;<br/> getnewaddress ( "account" )
2091
+
2092
+ Returns a new Raven address for receiving payments.
2093
+ If 'account' is specified (DEPRECATED), it is added to the address book
2094
+ so payments received with the address will be credited to 'account'.
2095
+
2096
+ Arguments:
2097
+ 1. "account" (string, optional) DEPRECATED. The account name for the address to be linked to. If not provided, the default account "" is used. It can also be set to the empty string "" to represent the default account. The account does not need to exist, it will be created if there is no account by the given name.
2098
+
2099
+ Result:
2100
+ "address" (string) The new raven address
2101
+
2102
+ Examples:
2103
+ > raven-cli getnewaddress
2104
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getnewaddress", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2105
+
2106
+ &nbsp;<br> &nbsp;<br/>
2107
+ ## getpeerinfo
2108
+ &nbsp;<br/> getpeerinfo
2109
+
2110
+ Returns data about each connected network node as a json array of objects.
2111
+
2112
+ Result:
2113
+ [
2114
+ {
2115
+ "id": n, (numeric) Peer index
2116
+ "addr":"host:port", (string) The IP address and port of the peer
2117
+ "addrbind":"ip:port", (string) Bind address of the connection to the peer
2118
+ "addrlocal":"ip:port", (string) Local address as reported by the peer
2119
+ "services":"xxxxxxxxxxxxxxxx", (string) The services offered
2120
+ "relaytxes":true|false, (boolean) Whether peer has asked us to relay transactions to it
2121
+ "lastsend": ttt, (numeric) The time in seconds since epoch (Jan 1 1970 GMT) of the last send
2122
+ "lastrecv": ttt, (numeric) The time in seconds since epoch (Jan 1 1970 GMT) of the last receive
2123
+ "bytessent": n, (numeric) The total bytes sent
2124
+ "bytesrecv": n, (numeric) The total bytes received
2125
+ "conntime": ttt, (numeric) The connection time in seconds since epoch (Jan 1 1970 GMT)
2126
+ "timeoffset": ttt, (numeric) The time offset in seconds
2127
+ "pingtime": n, (numeric) ping time (if available)
2128
+ "minping": n, (numeric) minimum observed ping time (if any at all)
2129
+ "pingwait": n, (numeric) ping wait (if non-zero)
2130
+ "version": v, (numeric) The peer version, such as 7001
2131
+ "subver": "/Satoshi:0.8.5/", (string) The string version
2132
+ "inbound": true|false, (boolean) Inbound (true) or Outbound (false)
2133
+ "addnode": true|false, (boolean) Whether connection was due to addnode/-connect or if it was an automatic/inbound connection
2134
+ "startingheight": n, (numeric) The starting height (block) of the peer
2135
+ "banscore": n, (numeric) The ban score
2136
+ "synced_headers": n, (numeric) The last header we have in common with this peer
2137
+ "synced_blocks": n, (numeric) The last block we have in common with this peer
2138
+ "inflight": [
2139
+ n, (numeric) The heights of blocks we're currently asking from this peer
2140
+ ...
2141
+ ],
2142
+ "whitelisted": true|false, (boolean) Whether the peer is whitelisted
2143
+ "bytessent_per_msg": {
2144
+ "addr": n, (numeric) The total bytes sent aggregated by message type
2145
+ ...
2146
+ },
2147
+ "bytesrecv_per_msg": {
2148
+ "addr": n, (numeric) The total bytes received aggregated by message type
2149
+ ...
2150
+ }
2151
+ }
2152
+ ,...
2153
+ ]
2154
+
2155
+ Examples:
2156
+ > raven-cli getpeerinfo
2157
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getpeerinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2158
+
2159
+ &nbsp;<br> &nbsp;<br/>
2160
+ ## getrawchangeaddress
2161
+ &nbsp;<br/> getrawchangeaddress
2162
+
2163
+ Returns a new Raven address, for receiving change.
2164
+ This is for use with raw transactions, NOT normal use.
2165
+
2166
+ Result:
2167
+ "address" (string) The address
2168
+
2169
+ Examples:
2170
+ > raven-cli getrawchangeaddress
2171
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getrawchangeaddress", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2172
+
2173
+ &nbsp;<br> &nbsp;<br/>
2174
+ ## getrawmempool
2175
+ &nbsp;<br/> getrawmempool ( verbose )
2176
+
2177
+ Returns all transaction ids in memory pool as a json array of string transaction ids.
2178
+
2179
+ Hint: use getmempoolentry to fetch a specific transaction from the mempool.
2180
+
2181
+ Arguments:
2182
+ 1. verbose (boolean, optional, default=false) True for a json object, false for array of transaction ids
2183
+
2184
+ Result: (for verbose = false):
2185
+ [ (json array of string)
2186
+ "transactionid" (string) The transaction id
2187
+ ,...
2188
+ ]
2189
+
2190
+ Result: (for verbose = true):
2191
+ { (json object)
2192
+ "transactionid" : { (json object)
2193
+ "size" : n, (numeric) virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted.
2194
+ "fee" : n, (numeric) transaction fee in XNA
2195
+ "modifiedfee" : n, (numeric) transaction fee with fee deltas used for mining priority
2196
+ "time" : n, (numeric) local time transaction entered pool in seconds since 1 Jan 1970 GMT
2197
+ "height" : n, (numeric) block height when transaction entered pool
2198
+ "descendantcount" : n, (numeric) number of in-mempool descendant transactions (including this one)
2199
+ "descendantsize" : n, (numeric) virtual transaction size of in-mempool descendants (including this one)
2200
+ "descendantfees" : n, (numeric) modified fees (see above) of in-mempool descendants (including this one)
2201
+ "ancestorcount" : n, (numeric) number of in-mempool ancestor transactions (including this one)
2202
+ "ancestorsize" : n, (numeric) virtual transaction size of in-mempool ancestors (including this one)
2203
+ "ancestorfees" : n, (numeric) modified fees (see above) of in-mempool ancestors (including this one)
2204
+ "wtxid" : hash, (string) hash of serialized transaction, including witness data
2205
+ "depends" : [ (array) unconfirmed transactions used as inputs for this transaction
2206
+ "transactionid", (string) parent transaction id
2207
+ ... ]
2208
+ }, ...
2209
+ }
2210
+
2211
+ Examples:
2212
+ > raven-cli getrawmempool true
2213
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getrawmempool", "params": [true] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2214
+
2215
+ &nbsp;<br> &nbsp;<br/>
2216
+ ## getrawtransaction
2217
+ &nbsp;<br/> getrawtransaction "txid" ( verbose )
2218
+
2219
+ NOTE: By default this function only works for mempool transactions. If the -txindex option is
2220
+ enabled, it also works for blockchain transactions.
2221
+ DEPRECATED: for now, it also works for transactions with unspent outputs.
2222
+
2223
+ Return the raw transaction data.
2224
+
2225
+ If verbose is 'true', returns an Object with information about 'txid'.
2226
+ If verbose is 'false' or omitted, returns a string that is serialized, hex-encoded data for 'txid'.
2227
+
2228
+ Arguments:
2229
+ 1. "txid" (string, required) The transaction id
2230
+ 2. verbose (bool, optional, default=false) If false, return a string, otherwise return a json object
2231
+
2232
+ Result (if verbose is not set or set to false):
2233
+ "data" (string) The serialized, hex-encoded data for 'txid'
2234
+
2235
+ Result (if verbose is set to true):
2236
+ {
2237
+ "hex" : "data", (string) The serialized, hex-encoded data for 'txid'
2238
+ "txid" : "id", (string) The transaction id (same as provided)
2239
+ "hash" : "id", (string) The transaction hash (differs from txid for witness transactions)
2240
+ "size" : n, (numeric) The serialized transaction size
2241
+ "vsize" : n, (numeric) The virtual transaction size (differs from size for witness transactions)
2242
+ "version" : n, (numeric) The version
2243
+ "locktime" : ttt, (numeric) The lock time
2244
+ "vin" : [ (array of json objects)
2245
+ {
2246
+ "txid": "id", (string) The transaction id
2247
+ "vout": n, (numeric)
2248
+ "scriptSig": { (json object) The script
2249
+ "asm": "asm", (string) asm
2250
+ "hex": "hex" (string) hex
2251
+ },
2252
+ "sequence": n (numeric) The script sequence number
2253
+ "txinwitness": ["hex", ...] (array of string) hex-encoded witness data (if any)
2254
+ }
2255
+ ,...
2256
+ ],
2257
+ "vout" : [ (array of json objects)
2258
+ {
2259
+ "value" : x.xxx, (numeric) The value in XNA
2260
+ "n" : n, (numeric) index
2261
+ "scriptPubKey" : { (json object)
2262
+ "asm" : "asm", (string) the asm
2263
+ "hex" : "hex", (string) the hex
2264
+ "reqSigs" : n, (numeric) The required sigs
2265
+ "type" : "pubkeyhash", (string) The type, eg 'pubkeyhash'
2266
+ "addresses" : [ (json array of string)
2267
+ "address" (string) raven address
2268
+ ,...
2269
+ ]
2270
+ }
2271
+ }
2272
+ ,...
2273
+ ],
2274
+ "blockhash" : "hash", (string) the block hash
2275
+ "confirmations" : n, (numeric) The confirmations
2276
+ "time" : ttt, (numeric) The transaction time in seconds since epoch (Jan 1 1970 GMT)
2277
+ "blocktime" : ttt (numeric) The block time in seconds since epoch (Jan 1 1970 GMT)
2278
+ }
2279
+
2280
+ Examples:
2281
+ > raven-cli getrawtransaction "mytxid"
2282
+ > raven-cli getrawtransaction "mytxid" true
2283
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getrawtransaction", "params": ["mytxid", true] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2284
+
2285
+ &nbsp;<br> &nbsp;<br/>
2286
+ ## getreceivedbyaccount
2287
+ &nbsp;<br/> getreceivedbyaccount "account" ( minconf )
2288
+
2289
+ DEPRECATED. Returns the total amount received by addresses with <account> in transactions with at least [minconf] confirmations.
2290
+
2291
+ Arguments:
2292
+ 1. "account" (string, required) The selected account, may be the default account using "".
2293
+ 2. minconf (numeric, optional, default=1) Only include transactions confirmed at least this many times.
2294
+
2295
+ Result:
2296
+ amount (numeric) The total amount in XNA received for this account.
2297
+
2298
+ Examples:
2299
+
2300
+ Amount received by the default account with at least 1 confirmation
2301
+ > raven-cli getreceivedbyaccount ""
2302
+
2303
+ Amount received at the tabby account including unconfirmed amounts with zero confirmations
2304
+ > raven-cli getreceivedbyaccount "tabby" 0
2305
+
2306
+ The amount with at least 6 confirmations
2307
+ > raven-cli getreceivedbyaccount "tabby" 6
2308
+
2309
+ As a json rpc call
2310
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getreceivedbyaccount", "params": ["tabby", 6] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2311
+
2312
+ &nbsp;<br> &nbsp;<br/>
2313
+ ## getreceivedbyaddress
2314
+ &nbsp;<br/> getreceivedbyaddress "address" ( minconf )
2315
+
2316
+ Returns the total amount received by the given address in transactions with at least minconf confirmations.
2317
+
2318
+ Arguments:
2319
+ 1. "address" (string, required) The raven address for transactions.
2320
+ 2. minconf (numeric, optional, default=1) Only include transactions confirmed at least this many times.
2321
+
2322
+ Result:
2323
+ amount (numeric) The total amount in XNA received at this address.
2324
+
2325
+ Examples:
2326
+
2327
+ The amount from transactions with at least 1 confirmation
2328
+ > raven-cli getreceivedbyaddress "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX"
2329
+
2330
+ The amount including unconfirmed transactions, zero confirmations
2331
+ > raven-cli getreceivedbyaddress "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" 0
2332
+
2333
+ The amount with at least 6 confirmations
2334
+ > raven-cli getreceivedbyaddress "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" 6
2335
+
2336
+ As a json rpc call
2337
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getreceivedbyaddress", "params": ["1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX", 6] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2338
+
2339
+ &nbsp;<br> &nbsp;<br/>
2340
+ ## getrpcinfo
2341
+ &nbsp;<br/> getrpcinfo
2342
+ Returns details of the RPC server.
2343
+
2344
+ Result:
2345
+ {
2346
+ "active_commands" (array) All active commands
2347
+ [
2348
+ { (object) Information about an active command
2349
+ "method" (string) The name of the RPC command
2350
+ "duration" (numeric) The running time in microseconds
2351
+ },...
2352
+ ],
2353
+ }
2354
+ > raven-cli getrpcinfo
2355
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getrpcinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2356
+
2357
+ &nbsp;<br> &nbsp;<br/>
2358
+ ## getsnapshot
2359
+ &nbsp;<br/> getsnapshot "asset_name" block_height
2360
+
2361
+ Returns details for the asset snapshot, at the specified height
2362
+
2363
+ Arguments:
2364
+ 1. "asset_name" (string, required) the name of the asset
2365
+ 2. block_height (int, required) the block height of the snapshot
2366
+
2367
+ Result:
2368
+ {
2369
+ name: (string),
2370
+ height: (number),
2371
+ owners: [
2372
+ {
2373
+ address: (string),
2374
+ amount_owned: (number),
2375
+ }
2376
+ }
2377
+
2378
+ Examples:
2379
+ > 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/
2380
+
2381
+ &nbsp;<br> &nbsp;<br/>
2382
+ ## getsnapshotrequest
2383
+ &nbsp;<br/> getsnapshotrequest "asset_name" block_height
2384
+
2385
+ Retrieves the specified snapshot request details.
2386
+
2387
+ Arguments:
2388
+ 1. "asset_name" (string, required) The asset name for which the snapshot will be taken
2389
+ 2. "block_height" (number, required) The block height at which the snapshot will be take
2390
+
2391
+ Result:
2392
+ {
2393
+ asset_name: (string),
2394
+ block_height: (number),
2395
+ }
2396
+
2397
+ Examples:
2398
+ > raven-cli getsnapshotrequest "TRONCO" 12345
2399
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getsnapshotrequest", "params": ["PHATSTACKS" 34987] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2400
+
2401
+ &nbsp;<br> &nbsp;<br/>
2402
+ ## getspentinfo
2403
+ &nbsp;<br/> getspentinfo
2404
+
2405
+ Returns the txid and index where an output is spent.
2406
+
2407
+ Arguments:
2408
+ {
2409
+ "txid" (string) The hex string of the txid
2410
+ "index" (number) The start block height
2411
+ }
2412
+
2413
+ Result:
2414
+ {
2415
+ "txid" (string) The transaction id
2416
+ "index" (number) The spending input index
2417
+ ,...
2418
+ }
2419
+
2420
+ Examples:
2421
+ > raven-cli getspentinfo '{"txid": "0437cd7f8525ceed2324359c2d0ba26006d92d856a9c20fa0241106ee5a597c9", "index": 0}'
2422
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getspentinfo", "params": [{"txid": "0437cd7f8525ceed2324359c2d0ba26006d92d856a9c20fa0241106ee5a597c9", "index": 0}] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2423
+
2424
+ &nbsp;<br> &nbsp;<br/>
2425
+ ## gettransaction
2426
+ &nbsp;<br/> gettransaction "txid" ( include_watchonly )
2427
+
2428
+ Get detailed information about in-wallet transaction <txid>
2429
+
2430
+ Arguments:
2431
+ 1. "txid" (string, required) The transaction id
2432
+ 2. "include_watchonly" (bool, optional, default=false) Whether to include watch-only addresses in balance calculation and details[]
2433
+
2434
+ Result:
2435
+ {
2436
+ "amount" : x.xxx, (numeric) The transaction amount in XNA
2437
+ "fee": x.xxx, (numeric) The amount of the fee in XNA. This is negative and only available for the
2438
+ 'send' category of transactions.
2439
+ "confirmations" : n, (numeric) The number of confirmations
2440
+ "blockhash" : "hash", (string) The block hash
2441
+ "blockindex" : xx, (numeric) The index of the transaction in the block that includes it
2442
+ "blocktime" : ttt, (numeric) The time in seconds since epoch (1 Jan 1970 GMT)
2443
+ "txid" : "transactionid", (string) The transaction id.
2444
+ "time" : ttt, (numeric) The transaction time in seconds since epoch (1 Jan 1970 GMT)
2445
+ "timereceived" : ttt, (numeric) The time received in seconds since epoch (1 Jan 1970 GMT)
2446
+ "bip125-replaceable": "yes|no|unknown", (string) Whether this transaction could be replaced due to BIP125 (replace-by-fee);
2447
+ may be unknown for unconfirmed transactions not in the mempool
2448
+ "details" : [
2449
+ {
2450
+ "account" : "accountname", (string) DEPRECATED. The account name involved in the transaction, can be "" for the default account.
2451
+ "address" : "address", (string) The raven address involved in the transaction
2452
+ "category" : "send|receive", (string) The category, either 'send' or 'receive'
2453
+ "amount" : x.xxx, (numeric) The amount in XNA
2454
+ "label" : "label", (string) A comment for the address/transaction, if any
2455
+ "vout" : n, (numeric) the vout value
2456
+ "fee": x.xxx, (numeric) The amount of the fee in XNA. This is negative and only available for the
2457
+ 'send' category of transactions.
2458
+ "abandoned": xxx (bool) 'true' if the transaction has been abandoned (inputs are respendable). Only available for the
2459
+ 'send' category of transactions.
2460
+ }
2461
+ ,...
2462
+ ],
2463
+ "asset_details" : [
2464
+ {
2465
+ "asset_type" : "new_asset|transfer_asset|reissue_asset", (string) The type of asset transaction
2466
+ "asset_name" : "asset_name", (string) The name of the asset
2467
+ "amount" : x.xxx, (numeric) The amount in XNA
2468
+ "address" : "address", (string) The raven address involved in the transaction
2469
+ "vout" : n, (numeric) the vout value
2470
+ "category" : "send|receive", (string) The category, either 'send' or 'receive'
2471
+ }
2472
+ ,...
2473
+ ],
2474
+ "hex" : "data" (string) Raw data for transaction
2475
+ }
2476
+
2477
+ Examples:
2478
+ > raven-cli gettransaction "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"
2479
+ > raven-cli gettransaction "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" true
2480
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "gettransaction", "params": ["1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2481
+
2482
+ &nbsp;<br> &nbsp;<br/>
2483
+ ## gettxout
2484
+ &nbsp;<br/> gettxout "txid" n ( include_mempool )
2485
+
2486
+ Returns details about an unspent transaction output.
2487
+
2488
+ Arguments:
2489
+ 1. "txid" (string, required) The transaction id
2490
+ 2. "n" (numeric, required) vout number
2491
+ 3. "include_mempool" (boolean, optional) Whether to include the mempool. Default: true. Note that an unspent output that is spent in the mempool won't appear.
2492
+
2493
+ Result:
2494
+ {
2495
+ "bestblock" : "hash", (string) the block hash
2496
+ "confirmations" : n, (numeric) The number of confirmations
2497
+ "value" : x.xxx, (numeric) The transaction value in XNA
2498
+ "scriptPubKey" : { (json object)
2499
+ "asm" : "code", (string)
2500
+ "hex" : "hex", (string)
2501
+ "reqSigs" : n, (numeric) Number of required signatures
2502
+ "type" : "pubkeyhash", (string) The type, eg pubkeyhash
2503
+ "addresses" : [ (array of string) array of raven addresses
2504
+ "address" (string) raven address
2505
+ ,...
2506
+ ]
2507
+ },
2508
+ "coinbase" : true|false (boolean) Coinbase or not
2509
+ }
2510
+
2511
+ Examples:
2512
+
2513
+ Get unspent transactions
2514
+ > raven-cli listunspent
2515
+
2516
+ View the details
2517
+ > raven-cli gettxout "txid" 1
2518
+
2519
+ As a json rpc call
2520
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "gettxout", "params": ["txid", 1] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2521
+
2522
+ &nbsp;<br> &nbsp;<br/>
2523
+ ## gettxoutproof
2524
+ &nbsp;<br/> gettxoutproof ["txid",...] ( blockhash )
2525
+
2526
+ Returns a hex-encoded proof that "txid" was included in a block.
2527
+
2528
+ NOTE: By default this function only works sometimes. This is when there is an
2529
+ unspent output in the utxo for this transaction. To make it always work,
2530
+ you need to maintain a transaction index, using the -txindex command line option or
2531
+ specify the block in which the transaction is included manually (by blockhash).
2532
+
2533
+ Arguments:
2534
+ 1. "txids" (string) A json array of txids to filter
2535
+ [
2536
+ "txid" (string) A transaction hash
2537
+ ,...
2538
+ ]
2539
+ 2. "blockhash" (string, optional) If specified, looks for txid in the block with this hash
2540
+
2541
+ Result:
2542
+ "data" (string) A string that is a serialized, hex-encoded data for the proof.
2543
+
2544
+ &nbsp;<br> &nbsp;<br/>
2545
+ ## gettxoutsetinfo
2546
+ &nbsp;<br/> gettxoutsetinfo
2547
+
2548
+ Returns statistics about the unspent transaction output set.
2549
+ Note this call may take some time.
2550
+
2551
+ Result:
2552
+ {
2553
+ "height":n, (numeric) The current block height (index)
2554
+ "bestblock": "hex", (string) the best block hash hex
2555
+ "transactions": n, (numeric) The number of transactions
2556
+ "txouts": n, (numeric) The number of output transactions
2557
+ "bogosize": n, (numeric) A meaningless metric for UTXO set size
2558
+ "hash_serialized_2": "hash", (string) The serialized hash
2559
+ "disk_size": n, (numeric) The estimated size of the chainstate on disk
2560
+ "total_amount": x.xxx (numeric) The total amount
2561
+ }
2562
+
2563
+ Examples:
2564
+ > raven-cli gettxoutsetinfo
2565
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "gettxoutsetinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2566
+
2567
+ &nbsp;<br> &nbsp;<br/>
2568
+ ## getunconfirmedbalance
2569
+ &nbsp;<br/> getunconfirmedbalance
2570
+ Returns the server's total unconfirmed balance
2571
+
2572
+ &nbsp;<br> &nbsp;<br/>
2573
+ ## getverifierstring
2574
+ &nbsp;<br/> getverifierstring restricted_name
2575
+
2576
+ Retrieve the verifier string that belongs to the given restricted asset
2577
+
2578
+ Arguments:
2579
+ 1. "restricted_name" (string, required) the asset_name
2580
+
2581
+ Result:
2582
+ "verifier_string", (string) The verifier for the asset
2583
+
2584
+ Examples:
2585
+ > raven-cli getverifierstring "restricted_name"
2586
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getverifierstring", "params": ["restricted_name"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2587
+
2588
+ &nbsp;<br> &nbsp;<br/>
2589
+ ## getwalletinfo
2590
+ &nbsp;<br/> getwalletinfo
2591
+ Returns an object containing various wallet state info.
2592
+
2593
+ Result:
2594
+ {
2595
+ "walletname": xxxxx, (string) the wallet name
2596
+ "walletversion": xxxxx, (numeric) the wallet version
2597
+ "balance": xxxxxxx, (numeric) the total confirmed balance of the wallet in XNA
2598
+ "unconfirmed_balance": xxx, (numeric) the total unconfirmed balance of the wallet in XNA
2599
+ "immature_balance": xxxxxx, (numeric) the total immature balance of the wallet in XNA
2600
+ "txcount": xxxxxxx, (numeric) the total number of transactions in the wallet
2601
+ "keypoololdest": xxxxxx, (numeric) the timestamp (seconds since Unix epoch) of the oldest pre-generated key in the key pool
2602
+ "keypoolsize": xxxx, (numeric) how many new keys are pre-generated (only counts external keys)
2603
+ "keypoolsize_hd_internal": xxxx, (numeric) how many new keys are pre-generated for internal use (used for change outputs, only appears if the wallet is using this feature, otherwise external keys are used)
2604
+ "unlocked_until": ttt, (numeric) the timestamp in seconds since epoch (midnight Jan 1 1970 GMT) that the wallet is unlocked for transfers, or 0 if the wallet is locked
2605
+ "paytxfee": x.xxxx, (numeric) the transaction fee configuration, set in XNA/kB
2606
+ "hdseedid": "<hash160>" (string, optional) the Hash160 of the HD seed (only present when HD is enabled)
2607
+ "hdmasterkeyid": "<hash160>" (string, optional) alias for hdseedid retained for backwards-compatibility. Will be removed in V0.18.
2608
+ }
2609
+
2610
+ Examples:
2611
+ > raven-cli getwalletinfo
2612
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getwalletinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2613
+
2614
+ &nbsp;<br> &nbsp;<br/>
2615
+ ## help
2616
+ &nbsp;<br/> help ( "command" )
2617
+
2618
+ List all commands, or get help for a specified command.
2619
+
2620
+ Arguments:
2621
+ 1. "command" (string, optional) The command to get help on
2622
+
2623
+ Result:
2624
+ "text" (string) The help text
2625
+
2626
+ &nbsp;<br> &nbsp;<br/>
2627
+ ## importaddress
2628
+ &nbsp;<br/> importaddress "address" ( "label" rescan p2sh )
2629
+
2630
+ Adds a script (in hex) or address that can be watched as if it were in your wallet but cannot be used to spend.
2631
+
2632
+ Arguments:
2633
+ 1. "script" (string, required) The hex-encoded script (or address)
2634
+ 2. "label" (string, optional, default="") An optional label
2635
+ 3. rescan (boolean, optional, default=true) Rescan the wallet for transactions
2636
+ 4. p2sh (boolean, optional, default=false) Add the P2SH version of the script as well
2637
+
2638
+ Note: This call can take minutes to complete if rescan is true.
2639
+ If you have the full public key, you should call importpubkey instead of this.
2640
+
2641
+ Note: If you import a non-standard raw script in hex form, outputs sending to it will be treated
2642
+ as change, and not show up in many RPCs.
2643
+
2644
+ Examples:
2645
+
2646
+ Import a script with rescan
2647
+ > raven-cli importaddress "myscript"
2648
+
2649
+ Import using a label without rescan
2650
+ > raven-cli importaddress "myscript" "testing" false
2651
+
2652
+ As a JSON-RPC call
2653
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "importaddress", "params": ["myscript", "testing", false] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2654
+
2655
+ &nbsp;<br> &nbsp;<br/>
2656
+ ## importmulti
2657
+ &nbsp;<br/> importmulti "requests" ( "options" )
2658
+
2659
+ Import addresses/scripts (with private or public keys, redeem script (P2SH)), rescanning all addresses in one-shot-only (rescan can be disabled via options).
2660
+
2661
+ Arguments:
2662
+ 1. requests (array, required) Data to be imported
2663
+ [ (array of json objects)
2664
+ {
2665
+ "scriptPubKey": "<script>" | { "address":"<address>" }, (string / json, required) Type of scriptPubKey (string for script, json for address)
2666
+ "timestamp": timestamp | "now" , (integer / string, required) Creation time of the key in seconds since epoch (Jan 1 1970 GMT),
2667
+ or the string "now" to substitute the current synced blockchain time. The timestamp of the oldest
2668
+ key will determine how far back blockchain rescans need to begin for missing wallet transactions.
2669
+ "now" can be specified to bypass scanning, for keys which are known to never have been used, and
2670
+ 0 can be specified to scan the entire blockchain. Blocks up to 2 hours before the earliest key
2671
+ creation time of all keys being imported by the importmulti call will be scanned.
2672
+ "redeemscript": "<script>" , (string, optional) Allowed only if the scriptPubKey is a P2SH address or a P2SH scriptPubKey
2673
+ "pubkeys": ["<pubKey>", ... ] , (array, optional) Array of strings giving pubkeys that must occur in the output or redeemscript
2674
+ "keys": ["<key>", ... ] , (array, optional) Array of strings giving private keys whose corresponding public keys must occur in the output or redeemscript
2675
+ "internal": <true> , (boolean, optional, default: false) Stating whether matching outputs should be treated as not incoming payments
2676
+ "watchonly": <true> , (boolean, optional, default: false) Stating whether matching outputs should be considered watched even when they're not spendable, only allowed if keys are empty
2677
+ "label": <label> , (string, optional, default: '') Label to assign to the address (aka account name, for now), only allowed with internal=false
2678
+ }
2679
+ ,...
2680
+ ]
2681
+ 2. options (json, optional)
2682
+ {
2683
+ "rescan": <false>, (boolean, optional, default: true) Stating if should rescan the blockchain after all imports
2684
+ }
2685
+
2686
+ Examples:
2687
+ > raven-cli importmulti '[{ "scriptPubKey": { "address": "<my address>" }, "timestamp":1455191478 }, { "scriptPubKey": { "address": "<my 2nd address>" }, "label": "example 2", "timestamp": 1455191480 }]'
2688
+ > raven-cli importmulti '[{ "scriptPubKey": { "address": "<my address>" }, "timestamp":1455191478 }]' '{ "rescan": false}'
2689
+
2690
+ Response is an array with the same size as the input that has the execution result :
2691
+ [{ "success": true } , { "success": false, "error": { "code": -1, "message": "Internal Server Error"} }, ... ]
2692
+
2693
+ &nbsp;<br> &nbsp;<br/>
2694
+ ## importprivkey
2695
+ &nbsp;<br/> importprivkey "privkey" ( "label" ) ( rescan )
2696
+
2697
+ Adds a private key (as returned by dumpprivkey) to your wallet.
2698
+
2699
+ Arguments:
2700
+ 1. "privkey" (string, required) The private key (see dumpprivkey)
2701
+ 2. "label" (string, optional, default="") An optional label
2702
+ 3. rescan (boolean, optional, default=true) Rescan the wallet for transactions
2703
+
2704
+ Note: This call can take minutes to complete if rescan is true.
2705
+
2706
+ Examples:
2707
+
2708
+ Dump a private key
2709
+ > raven-cli dumpprivkey "myaddress"
2710
+
2711
+ Import the private key with rescan
2712
+ > raven-cli importprivkey "mykey"
2713
+
2714
+ Import using a label and without rescan
2715
+ > raven-cli importprivkey "mykey" "testing" false
2716
+
2717
+ Import using default blank label and without rescan
2718
+ > raven-cli importprivkey "mykey" "" false
2719
+
2720
+ As a JSON-RPC call
2721
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "importprivkey", "params": ["mykey", "testing", false] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2722
+
2723
+ &nbsp;<br> &nbsp;<br/>
2724
+ ## importprunedfunds
2725
+ &nbsp;<br/> importprunedfunds
2726
+
2727
+ Imports funds without rescan. Corresponding address or script must previously be included in wallet. Aimed towards pruned wallets. The end-user is responsible to import additional transactions that subsequently spend the imported outputs or rescan after the point in the blockchain the transaction is included.
2728
+
2729
+ Arguments:
2730
+ 1. "rawtransaction" (string, required) A raw transaction in hex funding an already-existing address in wallet
2731
+ 2. "txoutproof" (string, required) The hex output from gettxoutproof that contains the transaction
2732
+
2733
+ &nbsp;<br> &nbsp;<br/>
2734
+ ## importpubkey
2735
+ &nbsp;<br/> importpubkey "pubkey" ( "label" rescan )
2736
+
2737
+ Adds a public key (in hex) that can be watched as if it were in your wallet but cannot be used to spend.
2738
+
2739
+ Arguments:
2740
+ 1. "pubkey" (string, required) The hex-encoded public key
2741
+ 2. "label" (string, optional, default="") An optional label
2742
+ 3. rescan (boolean, optional, default=true) Rescan the wallet for transactions
2743
+
2744
+ Note: This call can take minutes to complete if rescan is true.
2745
+
2746
+ Examples:
2747
+
2748
+ Import a public key with rescan
2749
+ > raven-cli importpubkey "mypubkey"
2750
+
2751
+ Import using a label without rescan
2752
+ > raven-cli importpubkey "mypubkey" "testing" false
2753
+
2754
+ As a JSON-RPC call
2755
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "importpubkey", "params": ["mypubkey", "testing", false] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2756
+
2757
+ &nbsp;<br> &nbsp;<br/>
2758
+ ## importwallet
2759
+ &nbsp;<br/> importwallet "filename"
2760
+
2761
+ Imports keys from a wallet dump file (see dumpwallet).
2762
+
2763
+ Arguments:
2764
+ 1. "filename" (string, required) The wallet file
2765
+
2766
+ Examples:
2767
+
2768
+ Dump the wallet
2769
+ > raven-cli dumpwallet "test"
2770
+
2771
+ Import the wallet
2772
+ > raven-cli importwallet "test"
2773
+
2774
+ Import using the json rpc call
2775
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "importwallet", "params": ["test"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2776
+
2777
+ &nbsp;<br> &nbsp;<br/>
2778
+ ## issue
2779
+ &nbsp;<br/> issue "asset_name" qty "( to_address )" "( change_address )" ( units ) ( reissuable ) ( has_ipfs ) "( ipfs_hash )"
2780
+
2781
+ Issue an asset, subasset or unique asset.
2782
+ Asset name must not conflict with any existing asset.
2783
+ Unit as the number of decimals precision for the asset (0 for whole units ("1"), 8 for max precision ("1.00000000")
2784
+ Reissuable is true/false for whether additional units can be issued by the original issuer.
2785
+ If issuing a unique asset these values are required (and will be defaulted to): qty=1, units=0, reissuable=false.
2786
+
2787
+ Arguments:
2788
+ 1. "asset_name" (string, required) a unique name
2789
+ 2. "qty" (numeric, optional, default=1) the number of units to be issued
2790
+ 3. "to_address" (string), optional, default=""), address asset will be sent to, if it is empty, address will be generated for you
2791
+ 4. "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
2792
+ 5. "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")
2793
+ 6. "reissuable" (boolean, optional, default=true (false for unique assets)), whether future reissuance is allowed
2794
+ 7. "has_ipfs" (boolean, optional, default=false), whether ipfs hash is going to be added to the asset
2795
+ 8. "ipfs_hash" (string, optional but required if has_ipfs = 1), an ipfs hash or a txid hash once RIP5 is activated
2796
+
2797
+ Result:
2798
+ "txid" (string) The transaction id
2799
+
2800
+ Examples:
2801
+ > raven-cli issue "ASSET_NAME" 1000
2802
+ > raven-cli issue "ASSET_NAME" 1000 "myaddress"
2803
+ > raven-cli issue "ASSET_NAME" 1000 "myaddress" "changeaddress" 4
2804
+ > raven-cli issue "ASSET_NAME" 1000 "myaddress" "changeaddress" 2 true
2805
+ > raven-cli issue "ASSET_NAME" 1000 "myaddress" "changeaddress" 8 false true QmTqu3Lk3gmTsQVtjU7rYYM37EAW4xNmbuEAp2Mjr4AV7E
2806
+ > raven-cli issue "ASSET_NAME/SUB_ASSET" 1000 "myaddress" "changeaddress" 2 true
2807
+ > raven-cli issue "ASSET_NAME#uniquetag"
2808
+
2809
+ &nbsp;<br> &nbsp;<br/>
2810
+ ## issuequalifierasset
2811
+ &nbsp;<br/> issuequalifierasset "asset_name" qty "( to_address )" "( change_address )" ( has_ipfs ) "( ipfs_hash )"
2812
+
2813
+ Issue an qualifier or sub qualifier asset
2814
+ If the '#' character isn't added, it will be added automatically
2815
+ Amount is a number between 1 and 10
2816
+ Asset name must not conflict with any existing asset.
2817
+ Unit is always set to Zero (0) for qualifier assets
2818
+ Reissuable is always set to false for qualifier assets
2819
+
2820
+ Arguments:
2821
+ 1. "asset_name" (string, required) a unique name
2822
+ 2. "qty" (numeric, optional, default=1) the number of units to be issued
2823
+ 3. "to_address" (string), optional, default=""), address asset will be sent to, if it is empty, address will be generated for you
2824
+ 4. "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
2825
+ 5. "has_ipfs" (boolean, optional, default=false), whether ipfs hash is going to be added to the asset
2826
+ 6. "ipfs_hash" (string, optional but required if has_ipfs = 1), an ipfs hash or a txid hash once RIP5 is activated
2827
+
2828
+ Result:
2829
+ "txid" (string) The transaction id
2830
+
2831
+ Examples:
2832
+ > raven-cli issuequalifierasset "#ASSET_NAME" 1000
2833
+ > raven-cli issuequalifierasset "ASSET_NAME" 1000 "myaddress"
2834
+ > raven-cli issuequalifierasset "#ASSET_NAME" 1000 "myaddress" "changeaddress"
2835
+ > raven-cli issuequalifierasset "ASSET_NAME" 1000 "myaddress" "changeaddress"
2836
+ > raven-cli issuequalifierasset "#ASSET_NAME" 1000 "myaddress" "changeaddress" true QmTqu3Lk3gmTsQVtjU7rYYM37EAW4xNmbuEAp2Mjr4AV7E
2837
+ > raven-cli issuequalifierasset "ASSET_NAME/SUB_QUALIFIER" 1000 "myaddress" "changeaddress"
2838
+ > raven-cli issuequalifierasset "#ASSET_NAME"
2839
+
2840
+ &nbsp;<br> &nbsp;<br/>
2841
+ ## issuerestrictedasset
2842
+ &nbsp;<br/> issuerestrictedasset "asset_name" qty "verifier" "to_address" "( change_address )" (units) ( reissuable ) ( has_ipfs ) "( ipfs_hash )"
2843
+
2844
+ Issue a restricted asset.
2845
+ Restricted asset names must not conflict with any existing restricted asset.
2846
+ Restricted assets have units set to 0.
2847
+ Reissuable is true/false for whether additional asset quantity can be created and if the verifier string can be changed
2848
+
2849
+ Arguments:
2850
+ 1. "asset_name" (string, required) a unique name, starts with '$', if '$' is not there it will be added automatically
2851
+ 2. "qty" (numeric, required) the quantity of the asset to be issued
2852
+ 3. "verifier" (string, required) the verifier string that will be evaluated when restricted asset transfers are made
2853
+ 4. "to_address" (string, required) address asset will be sent to, this address must meet the verifier string requirements
2854
+ 5. "change_address" (string, optional, default="") address that the xna change will be sent to, if it is empty, change address will be generated for you
2855
+ 6. "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")
2856
+ 7. "reissuable" (boolean, optional, default=true (false for unique assets)) whether future reissuance is allowed
2857
+ 8. "has_ipfs" (boolean, optional, default=false) whether an ipfs hash or txid hash is going to be added to the asset
2858
+ 9. "ipfs_hash" (string, optional but required if has_ipfs = 1) an ipfs hash or a txid hash once RIP5 is activated
2859
+
2860
+ Result:
2861
+ "txid" (string) The transaction id
2862
+
2863
+ Examples:
2864
+ > raven-cli issuerestrictedasset "$ASSET_NAME" 1000 "#KYC & !#AML" "myaddress"
2865
+ > raven-cli issuerestrictedasset "$ASSET_NAME" 1000 "#KYC & !#AML" "myaddress"
2866
+ > raven-cli issuerestrictedasset "$ASSET_NAME" 1000 "#KYC & !#AML" "myaddress" "changeaddress" 5
2867
+ > raven-cli issuerestrictedasset "$ASSET_NAME" 1000 "#KYC & !#AML" "myaddress" "changeaddress" 8 true
2868
+ > raven-cli issuerestrictedasset "$ASSET_NAME" 1000 "#KYC & !#AML" "myaddress" "changeaddress" 0 false true QmTqu3Lk3gmTsQVtjU7rYYM37EAW4xNmbuEAp2Mjr4AV7E
2869
+
2870
+ &nbsp;<br> &nbsp;<br/>
2871
+ ## issueunique
2872
+ &nbsp;<br/> issueunique "root_name" [asset_tags] ( [ipfs_hashes] ) "( to_address )" "( change_address )"
2873
+
2874
+ Issue unique asset(s).
2875
+ root_name must be an asset you own.
2876
+ An asset will be created for each element of asset_tags.
2877
+ If provided ipfs_hashes must be the same length as asset_tags.
2878
+ Five (5) XNA will be burned for each asset created.
2879
+
2880
+ Arguments:
2881
+ 1. "root_name" (string, required) name of the asset the unique asset(s) are being issued under
2882
+ 2. "asset_tags" (array, required) the unique tag for each asset which is to be issued
2883
+ 3. "ipfs_hashes" (array, optional) ipfs hashes or txid hashes corresponding to each supplied tag (should be same size as "asset_tags")
2884
+ 4. "to_address" (string, optional, default=""), address assets will be sent to, if it is empty, address will be generated for you
2885
+ 5. "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
2886
+
2887
+ Result:
2888
+ "txid" (string) The transaction id
2889
+
2890
+ Examples:
2891
+ > raven-cli issueunique "MY_ASSET" '["primo","secundo"]'
2892
+ > raven-cli issueunique "MY_ASSET" '["primo","secundo"]' '["first_hash","second_hash"]'
2893
+
2894
+ &nbsp;<br> &nbsp;<br/>
2895
+ ## isvalidverifierstring
2896
+ &nbsp;<br/> isvalidverifierstring verifier_string
2897
+
2898
+ Checks to see if the given verifier string is valid
2899
+
2900
+ Arguments:
2901
+ 1. "verifier_string" (string, required) the verifier string to check
2902
+
2903
+ Result:
2904
+ "xxxxxxx", (string) If the verifier string is valid, and the reason
2905
+
2906
+ Examples:
2907
+ > raven-cli isvalidverifierstring "verifier_string"
2908
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "isvalidverifierstring", "params": ["verifier_string"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2909
+
2910
+ &nbsp;<br> &nbsp;<br/>
2911
+ ## keypoolrefill
2912
+ &nbsp;<br/> keypoolrefill ( newsize )
2913
+
2914
+ Fills the keypool.
2915
+
2916
+ Arguments
2917
+ 1. newsize (numeric, optional, default=100) The new keypool size
2918
+
2919
+ Examples:
2920
+ > raven-cli keypoolrefill
2921
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "keypoolrefill", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2922
+
2923
+ &nbsp;<br> &nbsp;<br/>
2924
+ ## listaccounts
2925
+ &nbsp;<br/> listaccounts ( minconf include_watchonly)
2926
+
2927
+ DEPRECATED. Returns Object that has account names as keys, account balances as values.
2928
+
2929
+ Arguments:
2930
+ 1. minconf (numeric, optional, default=1) Only include transactions with at least this many confirmations
2931
+ 2. include_watchonly (bool, optional, default=false) Include balances in watch-only addresses (see 'importaddress')
2932
+
2933
+ Result:
2934
+ { (json object where keys are account names, and values are numeric balances
2935
+ "account": x.xxx, (numeric) The property name is the account name, and the value is the total balance for the account.
2936
+ ...
2937
+ }
2938
+
2939
+ Examples:
2940
+
2941
+ List account balances where there at least 1 confirmation
2942
+ > raven-cli listaccounts
2943
+
2944
+ List account balances including zero confirmation transactions
2945
+ > raven-cli listaccounts 0
2946
+
2947
+ List account balances for 6 or more confirmations
2948
+ > raven-cli listaccounts 6
2949
+
2950
+ As json rpc call
2951
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listaccounts", "params": [6] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2952
+
2953
+ &nbsp;<br> &nbsp;<br/>
2954
+ ## listaddressesbyasset
2955
+ &nbsp;<br/> listaddressesbyasset "asset_name" (onlytotal) (count) (start)
2956
+
2957
+ Returns a list of all address that own the given asset (with balances)
2958
+ Or returns the total size of how many address own the given asset
2959
+ Arguments:
2960
+ 1. "asset_name" (string, required) name of asset
2961
+ 2. "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
2962
+ 3. "count" (integer, optional, default=50000, MAX=50000) truncates results to include only the first _count_ assets found
2963
+ 4. "start" (integer, optional, default=0) results skip over the first _start_ assets found (if negative it skips back from the end)
2964
+
2965
+ Result:
2966
+ [ (address): balance,
2967
+ ...
2968
+ ]
2969
+
2970
+ Examples:
2971
+ > raven-cli listaddressesbyasset "ASSET_NAME" false 2 0
2972
+ > raven-cli listaddressesbyasset "ASSET_NAME" true
2973
+ > raven-cli listaddressesbyasset "ASSET_NAME"
2974
+
2975
+ &nbsp;<br> &nbsp;<br/>
2976
+ ## listaddressesfortag
2977
+ &nbsp;<br/> listaddressesfortag tag_name
2978
+
2979
+ List all addresses that have been assigned a given tag
2980
+
2981
+ Arguments:
2982
+ 1. "tag_name" (string, required) the tag asset name to search for
2983
+
2984
+ Result:
2985
+ ["address", (string) The address
2986
+ ...,
2987
+ ]
2988
+
2989
+ Examples:
2990
+ > raven-cli listaddressesfortag "#TAG"
2991
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listaddressesfortag", "params": ["#TAG"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
2992
+
2993
+ &nbsp;<br> &nbsp;<br/>
2994
+ ## listaddressgroupings
2995
+ &nbsp;<br/> listaddressgroupings
2996
+
2997
+ Lists groups of addresses which have had their common ownership
2998
+ made public by common use as inputs or as the resulting change
2999
+ in past transactions
3000
+
3001
+ Result:
3002
+ [
3003
+ [
3004
+ [
3005
+ "address", (string) The raven address
3006
+ amount, (numeric) The amount in XNA
3007
+ "account" (string, optional) DEPRECATED. The account
3008
+ ]
3009
+ ,...
3010
+ ]
3011
+ ,...
3012
+ ]
3013
+
3014
+ Examples:
3015
+ > raven-cli listaddressgroupings
3016
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listaddressgroupings", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3017
+
3018
+ &nbsp;<br> &nbsp;<br/>
3019
+ ## listaddressrestrictions
3020
+ &nbsp;<br/> listaddressrestrictions address
3021
+
3022
+ List all assets that have frozen this address
3023
+
3024
+ Arguments:
3025
+ 1. "address" (string), required) the address to list restrictions for
3026
+
3027
+ Result:
3028
+ ["asset_name", (string) The restriction name
3029
+ ...,
3030
+ ]
3031
+
3032
+ Examples:
3033
+ > raven-cli listaddressrestrictions "address"
3034
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listaddressrestrictions", "params": ["address"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3035
+
3036
+ &nbsp;<br> &nbsp;<br/>
3037
+ ## listassetbalancesbyaddress
3038
+ &nbsp;<br/> listassetbalancesbyaddress "address" (onlytotal) (count) (start)
3039
+
3040
+ Returns a list of all asset balances for an address.
3041
+
3042
+ Arguments:
3043
+ 1. "address" (string, required) a raven address
3044
+ 2. "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
3045
+ 3. "count" (integer, optional, default=50000, MAX=50000) truncates results to include only the first _count_ assets found
3046
+ 4. "start" (integer, optional, default=0) results skip over the first _start_ assets found (if negative it skips back from the end)
3047
+
3048
+ Result:
3049
+ {
3050
+ (asset_name) : (quantity),
3051
+ ...
3052
+ }
3053
+
3054
+ Examples:
3055
+ > raven-cli listassetbalancesbyaddress "myaddress" false 2 0
3056
+ > raven-cli listassetbalancesbyaddress "myaddress" true
3057
+ > raven-cli listassetbalancesbyaddress "myaddress"
3058
+
3059
+ &nbsp;<br> &nbsp;<br/>
3060
+ ## listassets
3061
+ &nbsp;<br/> listassets "( asset )" ( verbose ) ( count ) ( start )
3062
+
3063
+ Returns a list of all assets
3064
+
3065
+ This could be a slow/expensive operation as it reads from the database
3066
+
3067
+ Arguments:
3068
+ 1. "asset" (string, optional, default="*") filters results -- must be an asset name or a partial asset name followed by '*' ('*' matches all trailing characters)
3069
+ 2. "verbose" (boolean, optional, default=false) when false result is just a list of asset names -- when true results are asset name mapped to metadata
3070
+ 3. "count" (integer, optional, default=ALL) truncates results to include only the first _count_ assets found
3071
+ 4. "start" (integer, optional, default=0) results skip over the first _start_ assets found (if negative it skips back from the end)
3072
+
3073
+ Result (verbose=false):
3074
+ [
3075
+ asset_name,
3076
+ ...
3077
+ ]
3078
+
3079
+ Result (verbose=true):
3080
+ {
3081
+ (asset_name):
3082
+ {
3083
+ amount: (number),
3084
+ units: (number),
3085
+ reissuable: (number),
3086
+ has_ipfs: (number),
3087
+ ipfs_hash: (hash) (only if has_ipfs = 1 and data is a ipfs hash)
3088
+ ipfs_hash: (hash) (only if has_ipfs = 1 and data is a txid hash)
3089
+ },
3090
+ {...}, {...}
3091
+ }
3092
+
3093
+ Examples:
3094
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listassets", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3095
+ > raven-cli listassets ASSET
3096
+ > raven-cli listassets "ASSET*" true 10 20
3097
+
3098
+ &nbsp;<br> &nbsp;<br/>
3099
+ ## listbanned
3100
+ &nbsp;<br/> listbanned
3101
+
3102
+ List all banned IPs/Subnets.
3103
+
3104
+ Examples:
3105
+ > raven-cli listbanned
3106
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listbanned", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3107
+
3108
+ &nbsp;<br> &nbsp;<br/>
3109
+ ## listglobalrestrictions
3110
+ &nbsp;<br/> listglobalrestrictions
3111
+
3112
+ List all global restricted assets
3113
+
3114
+ Result:
3115
+ ["asset_name", (string) The asset name
3116
+ ...,
3117
+ ]
3118
+
3119
+ Examples:
3120
+ > raven-cli listglobalrestrictions
3121
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listglobalrestrictions", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3122
+
3123
+ &nbsp;<br> &nbsp;<br/>
3124
+ ## listlockunspent
3125
+ &nbsp;<br/> listlockunspent
3126
+
3127
+ Returns list of temporarily unspendable outputs.
3128
+ See the lockunspent call to lock and unlock transactions for spending.
3129
+
3130
+ Result:
3131
+ [
3132
+ {
3133
+ "txid" : "transactionid", (string) The transaction id locked
3134
+ "vout" : n (numeric) The vout value
3135
+ }
3136
+ ,...
3137
+ ]
3138
+
3139
+ Examples:
3140
+
3141
+ List the unspent transactions
3142
+ > raven-cli listunspent
3143
+
3144
+ Lock an unspent transaction
3145
+ > raven-cli lockunspent false "[{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\",\"vout\":1}]"
3146
+
3147
+ List the locked transactions
3148
+ > raven-cli listlockunspent
3149
+
3150
+ Unlock the transaction again
3151
+ > raven-cli lockunspent true "[{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\",\"vout\":1}]"
3152
+
3153
+ As a json rpc call
3154
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listlockunspent", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3155
+
3156
+ &nbsp;<br> &nbsp;<br/>
3157
+ ## listmyassets
3158
+ &nbsp;<br/> listmyassets "( asset )" ( verbose ) ( count ) ( start ) (confs)
3159
+
3160
+ Returns a list of all asset that are owned by this wallet
3161
+
3162
+ Arguments:
3163
+ 1. "asset" (string, optional, default="*") filters results -- must be an asset name or a partial asset name followed by '*' ('*' matches all trailing characters)
3164
+ 2. "verbose" (boolean, optional, default=false) when false results only contain balances -- when true results include outpoints
3165
+ 3. "count" (integer, optional, default=ALL) truncates results to include only the first _count_ assets found
3166
+ 4. "start" (integer, optional, default=0) results skip over the first _start_ assets found (if negative it skips back from the end)
3167
+ 5. "confs" (integet, optional, default=0) results are skipped if they don't have this number of confirmations
3168
+
3169
+ Result (verbose=false):
3170
+ {
3171
+ (asset_name): balance,
3172
+ ...
3173
+ }
3174
+
3175
+ Result (verbose=true):
3176
+ {
3177
+ (asset_name):
3178
+ {
3179
+ "balance": balance,
3180
+ "outpoints":
3181
+ [
3182
+ {
3183
+ "txid": txid,
3184
+ "vout": vout,
3185
+ "amount": amount
3186
+ }
3187
+ {...}, {...}
3188
+ ]
3189
+ }
3190
+ }
3191
+ {...}, {...}
3192
+
3193
+ Examples:
3194
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listmyassets", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3195
+ > raven-cli listmyassets ASSET
3196
+ > raven-cli listmyassets "ASSET*" true 10 20
3197
+ > raven-cli listmyassets "ASSET*" true 10 20 1
3198
+
3199
+ &nbsp;<br> &nbsp;<br/>
3200
+ ## listreceivedbyaccount
3201
+ &nbsp;<br/> listreceivedbyaccount ( minconf include_empty include_watchonly)
3202
+
3203
+ DEPRECATED. List balances by account.
3204
+
3205
+ Arguments:
3206
+ 1. minconf (numeric, optional, default=1) The minimum number of confirmations before payments are included.
3207
+ 2. include_empty (bool, optional, default=false) Whether to include accounts that haven't received any payments.
3208
+ 3. include_watchonly (bool, optional, default=false) Whether to include watch-only addresses (see 'importaddress').
3209
+
3210
+ Result:
3211
+ [
3212
+ {
3213
+ "involvesWatchonly" : true, (bool) Only returned if imported addresses were involved in transaction
3214
+ "account" : "accountname", (string) The account name of the receiving account
3215
+ "amount" : x.xxx, (numeric) The total amount received by addresses with this account
3216
+ "confirmations" : n, (numeric) The number of confirmations of the most recent transaction included
3217
+ "label" : "label" (string) A comment for the address/transaction, if any
3218
+ }
3219
+ ,...
3220
+ ]
3221
+
3222
+ Examples:
3223
+ > raven-cli listreceivedbyaccount
3224
+ > raven-cli listreceivedbyaccount 6 true
3225
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listreceivedbyaccount", "params": [6, true, true] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3226
+
3227
+ &nbsp;<br> &nbsp;<br/>
3228
+ ## listreceivedbyaddress
3229
+ &nbsp;<br/> listreceivedbyaddress ( minconf include_empty include_watchonly)
3230
+
3231
+ List balances by receiving address.
3232
+
3233
+ Arguments:
3234
+ 1. minconf (numeric, optional, default=1) The minimum number of confirmations before payments are included.
3235
+ 2. include_empty (bool, optional, default=false) Whether to include addresses that haven't received any payments.
3236
+ 3. include_watchonly (bool, optional, default=false) Whether to include watch-only addresses (see 'importaddress').
3237
+
3238
+ Result:
3239
+ [
3240
+ {
3241
+ "involvesWatchonly" : true, (bool) Only returned if imported addresses were involved in transaction
3242
+ "address" : "receivingaddress", (string) The receiving address
3243
+ "account" : "accountname", (string) DEPRECATED. The account of the receiving address. The default account is "".
3244
+ "amount" : x.xxx, (numeric) The total amount in XNA received by the address
3245
+ "confirmations" : n, (numeric) The number of confirmations of the most recent transaction included
3246
+ "label" : "label", (string) A comment for the address/transaction, if any
3247
+ "txids": [
3248
+ n, (numeric) The ids of transactions received with the address
3249
+ ...
3250
+ ]
3251
+ }
3252
+ ,...
3253
+ ]
3254
+
3255
+ Examples:
3256
+ > raven-cli listreceivedbyaddress
3257
+ > raven-cli listreceivedbyaddress 6 true
3258
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listreceivedbyaddress", "params": [6, true, true] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3259
+
3260
+ &nbsp;<br> &nbsp;<br/>
3261
+ ## listsinceblock
3262
+ &nbsp;<br/> listsinceblock ( "blockhash" target_confirmations include_watchonly include_removed )
3263
+
3264
+ Get all transactions in blocks since block [blockhash], or all transactions if omitted.
3265
+ If "blockhash" is no longer a part of the main chain, transactions from the fork point onward are included.
3266
+ Additionally, if include_removed is set, transactions affecting the wallet which were removed are returned in the "removed" array.
3267
+
3268
+ Arguments:
3269
+ 1. "blockhash" (string, optional) The block hash to list transactions since
3270
+ 2. target_confirmations: (numeric, optional, default=1) Return the nth block hash from the main chain. e.g. 1 would mean the best block hash. Note: this is not used as a filter, but only affects [lastblock] in the return value
3271
+ 3. include_watchonly: (bool, optional, default=false) Include transactions to watch-only addresses (see 'importaddress')
3272
+ 4. include_removed: (bool, optional, default=true) Show transactions that were removed due to a reorg in the "removed" array
3273
+ (not guaranteed to work on pruned nodes)
3274
+
3275
+ Result:
3276
+ {
3277
+ "transactions": [
3278
+ "account":"accountname", (string) DEPRECATED. The account name associated with the transaction. Will be "" for the default account.
3279
+ "address":"address", (string) The raven address of the transaction. Not present for move transactions (category = move).
3280
+ "category":"send|receive", (string) The transaction category. 'send' has negative amounts, 'receive' has positive amounts.
3281
+ "amount": x.xxx, (numeric) The amount in XNA. This is negative for the 'send' category, and for the 'move' category for moves
3282
+ outbound. It is positive for the 'receive' category, and for the 'move' category for inbound funds.
3283
+ "vout" : n, (numeric) the vout value
3284
+ "fee": x.xxx, (numeric) The amount of the fee in XNA. This is negative and only available for the 'send' category of transactions.
3285
+ "confirmations": n, (numeric) The number of confirmations for the transaction. Available for 'send' and 'receive' category of transactions.
3286
+ When it's < 0, it means the transaction conflicted that many blocks ago.
3287
+ "blockhash": "hashvalue", (string) The block hash containing the transaction. Available for 'send' and 'receive' category of transactions.
3288
+ "blockindex": n, (numeric) The index of the transaction in the block that includes it. Available for 'send' and 'receive' category of transactions.
3289
+ "blocktime": xxx, (numeric) The block time in seconds since epoch (1 Jan 1970 GMT).
3290
+ "txid": "transactionid", (string) The transaction id. Available for 'send' and 'receive' category of transactions.
3291
+ "time": xxx, (numeric) The transaction time in seconds since epoch (Jan 1 1970 GMT).
3292
+ "timereceived": xxx, (numeric) The time received in seconds since epoch (Jan 1 1970 GMT). Available for 'send' and 'receive' category of transactions.
3293
+ "bip125-replaceable": "yes|no|unknown", (string) Whether this transaction could be replaced due to BIP125 (replace-by-fee);
3294
+ may be unknown for unconfirmed transactions not in the mempool
3295
+ "abandoned": xxx, (bool) 'true' if the transaction has been abandoned (inputs are respendable). Only available for the 'send' category of transactions.
3296
+ "comment": "...", (string) If a comment is associated with the transaction.
3297
+ "label" : "label" (string) A comment for the address/transaction, if any
3298
+ "to": "...", (string) If a comment to is associated with the transaction.
3299
+ ],
3300
+ "removed": [
3301
+ <structure is the same as "transactions" above, only present if include_removed=true>
3302
+ Note: transactions that were readded in the active chain will appear as-is in this array, and may thus have a positive confirmation count.
3303
+ ],
3304
+ "lastblock": "lastblockhash" (string) The hash of the block (target_confirmations-1) from the best block on the main chain. This is typically used to feed back into listsinceblock the next time you call it. So you would generally use a target_confirmations of say 6, so you will be continually re-notified of transactions until they've reached 6 confirmations plus any new ones
3305
+ }
3306
+
3307
+ Examples:
3308
+ > raven-cli listsinceblock
3309
+ > raven-cli listsinceblock "000000000000000bacf66f7497b7dc45ef753ee9a7d38571037cdb1a57f663ad" 6
3310
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listsinceblock", "params": ["000000000000000bacf66f7497b7dc45ef753ee9a7d38571037cdb1a57f663ad", 6] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3311
+
3312
+ &nbsp;<br> &nbsp;<br/>
3313
+ ## listsnapshotrequests
3314
+ &nbsp;<br/> listsnapshotrequests ["asset_name" [block_height]]
3315
+
3316
+ List snapshot request details.
3317
+
3318
+ Arguments:
3319
+ asset_name: (string, optional) List only requests for a specific asset (default is "" for ALL)
3320
+ block_height: (number, optional) List only requests for a particular block height (default is 0 for ALL)
3321
+
3322
+ Result:
3323
+ [
3324
+ {
3325
+ asset_name: (string),
3326
+ block_height: (number)
3327
+ }
3328
+ ]
3329
+
3330
+ Examples:
3331
+ > raven-cli listsnapshotrequests
3332
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listsnapshotrequests", "params": ["TRONCO" 345333] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3333
+
3334
+ &nbsp;<br> &nbsp;<br/>
3335
+ ## listtagsforaddress
3336
+ &nbsp;<br/> listtagsforaddress address
3337
+
3338
+ List all tags assigned to an address
3339
+
3340
+ Arguments:
3341
+ 1. "address" (string, required) the address to list tags for
3342
+
3343
+ Result:
3344
+ ["tag_name", (string) The tag name
3345
+ ...,
3346
+ ]
3347
+
3348
+ Examples:
3349
+ > raven-cli listtagsforaddress "address"
3350
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listtagsforaddress", "params": ["address"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3351
+
3352
+ &nbsp;<br> &nbsp;<br/>
3353
+ ## listtransactions
3354
+ &nbsp;<br/> listtransactions ( "account" count skip include_watchonly)
3355
+
3356
+ Returns up to 'count' most recent transactions skipping the first 'from' transactions for account 'account'.
3357
+
3358
+ Arguments:
3359
+ 1. "account" (string, optional) DEPRECATED. The account name. Should be "*".
3360
+ 2. count (numeric, optional, default=10) The number of transactions to return
3361
+ 3. skip (numeric, optional, default=0) The number of transactions to skip
3362
+ 4. include_watchonly (bool, optional, default=false) Include transactions to watch-only addresses (see 'importaddress')
3363
+
3364
+ Result:
3365
+ [
3366
+ {
3367
+ "account":"accountname", (string) DEPRECATED. The account name associated with the transaction.
3368
+ It will be "" for the default account.
3369
+ "address":"address", (string) The raven address of the transaction. Not present for
3370
+ move transactions (category = move).
3371
+ "category":"send|receive|move", (string) The transaction category. 'move' is a local (off blockchain)
3372
+ transaction between accounts, and not associated with an address,
3373
+ transaction id or block. 'send' and 'receive' transactions are
3374
+ associated with an address, transaction id and block details
3375
+ "amount": x.xxx, (numeric) The amount in XNA. This is negative for the 'send' category, and for the
3376
+ 'move' category for moves outbound. It is positive for the 'receive' category,
3377
+ and for the 'move' category for inbound funds.
3378
+ "label": "label", (string) A comment for the address/transaction, if any
3379
+ "vout": n, (numeric) the vout value
3380
+ "fee": x.xxx, (numeric) The amount of the fee in XNA. This is negative and only available for the
3381
+ 'send' category of transactions.
3382
+ "confirmations": n, (numeric) The number of confirmations for the transaction. Available for 'send' and
3383
+ 'receive' category of transactions. Negative confirmations indicate the
3384
+ transaction conflicts with the block chain
3385
+ "trusted": xxx, (bool) Whether we consider the outputs of this unconfirmed transaction safe to spend.
3386
+ "blockhash": "hashvalue", (string) The block hash containing the transaction. Available for 'send' and 'receive'
3387
+ category of transactions.
3388
+ "blockindex": n, (numeric) The index of the transaction in the block that includes it. Available for 'send' and 'receive'
3389
+ category of transactions.
3390
+ "blocktime": xxx, (numeric) The block time in seconds since epoch (1 Jan 1970 GMT).
3391
+ "txid": "transactionid", (string) The transaction id. Available for 'send' and 'receive' category of transactions.
3392
+ "time": xxx, (numeric) The transaction time in seconds since epoch (midnight Jan 1 1970 GMT).
3393
+ "timereceived": xxx, (numeric) The time received in seconds since epoch (midnight Jan 1 1970 GMT). Available
3394
+ for 'send' and 'receive' category of transactions.
3395
+ "comment": "...", (string) If a comment is associated with the transaction.
3396
+ "otheraccount": "accountname", (string) DEPRECATED. For the 'move' category of transactions, the account the funds came
3397
+ from (for receiving funds, positive amounts), or went to (for sending funds,
3398
+ negative amounts).
3399
+ "bip125-replaceable": "yes|no|unknown", (string) Whether this transaction could be replaced due to BIP125 (replace-by-fee);
3400
+ may be unknown for unconfirmed transactions not in the mempool
3401
+ "abandoned": xxx (bool) 'true' if the transaction has been abandoned (inputs are respendable). Only available for the
3402
+ 'send' category of transactions.
3403
+ }
3404
+ ]
3405
+
3406
+ Examples:
3407
+
3408
+ List the most recent 10 transactions in the systems
3409
+ > raven-cli listtransactions
3410
+
3411
+ List transactions 100 to 120
3412
+ > raven-cli listtransactions "*" 20 100
3413
+
3414
+ As a json rpc call
3415
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listtransactions", "params": ["*", 20, 100] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3416
+
3417
+ &nbsp;<br> &nbsp;<br/>
3418
+ ## listunspent
3419
+ &nbsp;<br/> listunspent ( minconf maxconf ["addresses",...] [include_unsafe] [query_options])
3420
+
3421
+ Returns array of unspent transaction outputs
3422
+ with between minconf and maxconf (inclusive) confirmations.
3423
+ Optionally filter to only include txouts paid to specified addresses.
3424
+
3425
+ Arguments:
3426
+ 1. minconf (numeric, optional, default=1) The minimum confirmations to filter
3427
+ 2. maxconf (numeric, optional, default=9999999) The maximum confirmations to filter
3428
+ 3. "addresses" (string) A json array of raven addresses to filter
3429
+ [
3430
+ "address" (string) raven address
3431
+ ,...
3432
+ ]
3433
+ 4. include_unsafe (bool, optional, default=true) Include outputs that are not safe to spend
3434
+ See description of "safe" attribute below.
3435
+ 5. query_options (json, optional) JSON with query options
3436
+ {
3437
+ "minimumAmount" (numeric or string, default=0) Minimum value of each UTXO in XNA
3438
+ "maximumAmount" (numeric or string, default=unlimited) Maximum value of each UTXO in XNA
3439
+ "maximumCount" (numeric or string, default=unlimited) Maximum number of UTXOs
3440
+ "minimumSumAmount" (numeric or string, default=unlimited) Minimum sum value of all UTXOs in XNA
3441
+ }
3442
+
3443
+ Result
3444
+ [ (array of json object)
3445
+ {
3446
+ "txid" : "txid", (string) the transaction id
3447
+ "vout" : n, (numeric) the vout value
3448
+ "address" : "address", (string) the raven address
3449
+ "account" : "account", (string) DEPRECATED. The associated account, or "" for the default account
3450
+ "scriptPubKey" : "key", (string) the script key
3451
+ "amount" : x.xxx, (numeric) the transaction output amount in XNA
3452
+ "confirmations" : n, (numeric) The number of confirmations
3453
+ "redeemScript" : n (string) The redeemScript if scriptPubKey is P2SH
3454
+ "spendable" : xxx, (bool) Whether we have the private keys to spend this output
3455
+ "solvable" : xxx, (bool) Whether we know how to spend this output, ignoring the lack of keys
3456
+ "safe" : xxx (bool) Whether this output is considered safe to spend. Unconfirmed transactions
3457
+ from outside keys and unconfirmed replacement transactions are considered unsafe
3458
+ and are not eligible for spending by fundrawtransaction and sendtoaddress.
3459
+ }
3460
+ ,...
3461
+ ]
3462
+
3463
+ Examples
3464
+ > raven-cli listunspent
3465
+ > raven-cli listunspent 6 9999999 "[\"1PGFqEzfmQch1gKD3ra4k18PNj3tTUUSqg\",\"1LtvqCaApEdUGFkpKMM4MstjcaL4dKg8SP\"]"
3466
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listunspent", "params": [6, 9999999 "[\"1PGFqEzfmQch1gKD3ra4k18PNj3tTUUSqg\",\"1LtvqCaApEdUGFkpKMM4MstjcaL4dKg8SP\"]"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3467
+ > raven-cli listunspent 6 9999999 '[]' true '{ "minimumAmount": 0.005 }'
3468
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listunspent", "params": [6, 9999999, [] , true, { "minimumAmount": 0.005 } ] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3469
+
3470
+ &nbsp;<br> &nbsp;<br/>
3471
+ ## listwallets
3472
+ &nbsp;<br/> listwallets
3473
+ Returns a list of currently loaded wallets.
3474
+ For full information on the wallet, use "getwalletinfo"
3475
+
3476
+ Result:
3477
+ [ (json array of strings)
3478
+ "walletname" (string) the wallet name
3479
+ ...
3480
+ ]
3481
+
3482
+ Examples:
3483
+ > raven-cli listwallets
3484
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listwallets", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3485
+
3486
+ &nbsp;<br> &nbsp;<br/>
3487
+ ## lockunspent
3488
+ &nbsp;<br/> lockunspent unlock ([{"txid":"txid","vout":n},...])
3489
+
3490
+ Updates list of temporarily unspendable outputs.
3491
+ Temporarily lock (unlock=false) or unlock (unlock=true) specified transaction outputs.
3492
+ If no transaction outputs are specified when unlocking then all current locked transaction outputs are unlocked.
3493
+ A locked transaction output will not be chosen by automatic coin selection, when spending ravens.
3494
+ Locks are stored in memory only. Nodes start with zero locked outputs, and the locked output list
3495
+ is always cleared (by virtue of process exit) when a node stops or fails.
3496
+ Also see the listunspent call
3497
+
3498
+ Arguments:
3499
+ 1. unlock (boolean, required) Whether to unlock (true) or lock (false) the specified transactions
3500
+ 2. "transactions" (string, optional) A json array of objects. Each object the txid (string) vout (numeric)
3501
+ [ (json array of json objects)
3502
+ {
3503
+ "txid":"id", (string) The transaction id
3504
+ "vout": n (numeric) The output number
3505
+ }
3506
+ ,...
3507
+ ]
3508
+
3509
+ Result:
3510
+ true|false (boolean) Whether the command was successful or not
3511
+
3512
+ Examples:
3513
+
3514
+ List the unspent transactions
3515
+ > raven-cli listunspent
3516
+
3517
+ Lock an unspent transaction
3518
+ > raven-cli lockunspent false "[{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\",\"vout\":1}]"
3519
+
3520
+ List the locked transactions
3521
+ > raven-cli listlockunspent
3522
+
3523
+ Unlock the transaction again
3524
+ > raven-cli lockunspent true "[{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\",\"vout\":1}]"
3525
+
3526
+ As a json rpc call
3527
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "lockunspent", "params": [false, "[{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\",\"vout\":1}]"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3528
+
3529
+ &nbsp;<br> &nbsp;<br/>
3530
+ ## move
3531
+ &nbsp;<br/> move "fromaccount" "toaccount" amount ( minconf "comment" )
3532
+
3533
+ DEPRECATED. Move a specified amount from one account in your wallet to another.
3534
+
3535
+ Arguments:
3536
+ 1. "fromaccount" (string, required) The name of the account to move funds from. May be the default account using "".
3537
+ 2. "toaccount" (string, required) The name of the account to move funds to. May be the default account using "".
3538
+ 3. amount (numeric) Quantity of XNA to move between accounts.
3539
+ 4. (dummy) (numeric, optional) Ignored. Remains for backward compatibility.
3540
+ 5. "comment" (string, optional) An optional comment, stored in the wallet only.
3541
+
3542
+ Result:
3543
+ true|false (boolean) true if successful.
3544
+
3545
+ Examples:
3546
+
3547
+ Move 0.01 XNA from the default account to the account named tabby
3548
+ > raven-cli move "" "tabby" 0.01
3549
+
3550
+ Move 0.01 XNA timotei to akiko with a comment and funds have 6 confirmations
3551
+ > raven-cli move "timotei" "akiko" 0.01 6 "happy birthday!"
3552
+
3553
+ As a json rpc call
3554
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "move", "params": ["timotei", "akiko", 0.01, 6, "happy birthday!"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3555
+
3556
+ &nbsp;<br> &nbsp;<br/>
3557
+ ## ping
3558
+ &nbsp;<br/> ping
3559
+
3560
+ Requests that a ping be sent to all other nodes, to measure ping time.
3561
+ Results provided in getpeerinfo, pingtime and pingwait fields are decimal seconds.
3562
+ Ping command is handled in queue with all other commands, so it measures processing backlog, not just network ping.
3563
+
3564
+ Examples:
3565
+ > raven-cli ping
3566
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "ping", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3567
+
3568
+ &nbsp;<br> &nbsp;<br/>
3569
+ ## pprpcsb
3570
+ &nbsp;<br/> pprpcsb "header_hash" "mix_hash" "nonce"
3571
+
3572
+ Attempts to submit new block to network mined by kawpow gpu miner via rpc.
3573
+
3574
+ Arguments
3575
+ 1. "header_hash" (string, required) the prow_pow header hash that was given to the gpu miner from this rpc client
3576
+ 2. "mix_hash" (string, required) the mix hash that was mined by the gpu miner via rpc
3577
+ 3. "nonce" (string, required) the nonce of the block that hashed the valid block
3578
+
3579
+ Result:
3580
+
3581
+ Examples:
3582
+ > raven-cli pprpcsb "header_hash" "mix_hash" 100000
3583
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "pprpcsb", "params": ["header_hash" "mix_hash" 100000] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3584
+
3585
+ &nbsp;<br> &nbsp;<br/>
3586
+ ## preciousblock
3587
+ &nbsp;<br/> preciousblock "blockhash"
3588
+
3589
+ Treats a block as if it were received before others with the same work.
3590
+
3591
+ A later preciousblock call can override the effect of an earlier one.
3592
+
3593
+ The effects of preciousblock are not retained across restarts.
3594
+
3595
+ Arguments:
3596
+ 1. "blockhash" (string, required) the hash of the block to mark as precious
3597
+
3598
+ Result:
3599
+
3600
+ Examples:
3601
+ > raven-cli preciousblock "blockhash"
3602
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "preciousblock", "params": ["blockhash"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3603
+
3604
+ &nbsp;<br> &nbsp;<br/>
3605
+ ## prioritisetransaction
3606
+ &nbsp;<br/> prioritisetransaction <txid> <dummy value> <fee delta>
3607
+ Accepts the transaction into mined blocks at a higher (or lower) priority
3608
+
3609
+ Arguments:
3610
+ 1. "txid" (string, required) The transaction id.
3611
+ 2. dummy (numeric, optional) API-Compatibility for previous API. Must be zero or null.
3612
+ DEPRECATED. For forward compatibility use named arguments and omit this parameter.
3613
+ 3. fee_delta (numeric, required) The fee value (in satoshis) to add (or subtract, if negative).
3614
+ The fee is not actually paid, only the algorithm for selecting transactions into a block
3615
+ considers the transaction as it would have paid a higher (or lower) fee.
3616
+
3617
+ Result:
3618
+ true (boolean) Returns true
3619
+
3620
+ Examples:
3621
+ > raven-cli prioritisetransaction "txid" 0.0 10000
3622
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "prioritisetransaction", "params": ["txid", 0.0, 10000] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3623
+
3624
+ &nbsp;<br> &nbsp;<br/>
3625
+ ## pruneblockchain
3626
+ &nbsp;<br/> pruneblockchain
3627
+
3628
+ Arguments:
3629
+ 1. "height" (numeric, required) The block height to prune up to. May be set to a discrete height, or a unix timestamp
3630
+ to prune blocks whose block time is at least 2 hours older than the provided timestamp.
3631
+
3632
+ Result:
3633
+ n (numeric) Height of the last block pruned.
3634
+
3635
+ Examples:
3636
+ > raven-cli pruneblockchain 1000
3637
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "pruneblockchain", "params": [1000] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3638
+
3639
+ &nbsp;<br> &nbsp;<br/>
3640
+ ## purgesnapshot
3641
+ &nbsp;<br/> purgesnapshot "asset_name" block_height
3642
+
3643
+ Removes details for the asset snapshot, at the specified height
3644
+
3645
+ Arguments:
3646
+ 1. "asset_name" (string, required) the name of the asset
3647
+ 2. block_height (int, required) the block height of the snapshot
3648
+
3649
+ Result:
3650
+ {
3651
+ name: (string),
3652
+ height: (number),
3653
+ }
3654
+
3655
+ Examples:
3656
+ > raven-cli purgesnapshot "ASSET_NAME" 28546
3657
+ > 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/
3658
+
3659
+ &nbsp;<br> &nbsp;<br/>
3660
+ ## reissue
3661
+ &nbsp;<br/> reissue "asset_name" qty "to_address" "change_address" ( reissuable ) ( new_units) "( new_ipfs )"
3662
+
3663
+ Reissues a quantity of an asset to an owned address if you own the Owner Token
3664
+ Can change the reissuable flag during reissuance
3665
+ Can change the ipfs hash during reissuance
3666
+ Arguments:
3667
+ 1. "asset_name" (string, required) name of asset that is being reissued
3668
+ 2. "qty" (numeric, required) number of assets to reissue
3669
+ 3. "to_address" (string, required) address to send the asset to
3670
+ 4. "change_address" (string, optional) address that the change of the transaction will be sent to
3671
+ 5. "reissuable" (boolean, optional, default=true), whether future reissuance is allowed
3672
+ 6. "new_units" (numeric, optional, default=-1), the new units that will be associated with the asset
3673
+ 7. "new_ipfs" (string, optional, default=""), whether to update the current ipfs hash or txid once RIP5 is active
3674
+
3675
+ Result:
3676
+ "txid" (string) The transaction id
3677
+
3678
+ Examples:
3679
+ > raven-cli reissue "ASSET_NAME" 20 "address"
3680
+ > 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/
3681
+
3682
+ &nbsp;<br> &nbsp;<br/>
3683
+ ## reissuerestrictedasset
3684
+ &nbsp;<br/> reissuerestrictedasset "asset_name" qty to_address ( change_verifier ) ( "new_verifier" ) "( change_address )" ( new_units ) ( reissuable ) "( new_ipfs )"
3685
+
3686
+ Reissue an already created restricted asset
3687
+ Reissuable is true/false for whether additional asset quantity can be created and if the verifier string can be changed
3688
+
3689
+ Arguments:
3690
+ 1. "asset_name" (string, required) a unique name, starts with '$'
3691
+ 2. "qty" (numeric, required) the additional quantity of the asset to be issued
3692
+ 3. "to_address" (string, required) address asset will be sent to, this address must meet the verifier string requirements
3693
+ 4. "change_verifier" (boolean, optional, default=false) if the verifier string will get changed
3694
+ 5. "new_verifier" (string, optional, default="") the new verifier string that will be evaluated when restricted asset transfers are made
3695
+ 6. "change_address" (string, optional, default="") address that the xna change will be sent to, if it is empty, change address will be generated for you
3696
+ 7. "new_units" (numeric, optional, default=-1) the new units that will be associated with the asset
3697
+ 8. "reissuable" (boolean, optional, default=true (false for unique assets)) whether future reissuance is allowed
3698
+ 9. "new_ipfs" (string, optional, default="") whether to update the current ipfs hash or txid once RIP5 is active
3699
+
3700
+ Result:
3701
+ "txid" (string) The transaction id
3702
+
3703
+ Examples:
3704
+ > raven-cli reissuerestrictedasset "$ASSET_NAME" 1000 "myaddress" true "KYC & !AML"
3705
+ > raven-cli reissuerestrictedasset "$ASSET_NAME" 1000 "myaddress" true "KYC & !AML"
3706
+ > raven-cli reissuerestrictedasset "$ASSET_NAME" 1000 "myaddress" true "KYC & !AML" "changeaddress"
3707
+ > raven-cli reissuerestrictedasset "$ASSET_NAME" 1000 "myaddress" true "KYC & !AML" "changeaddress" -1 true
3708
+ > raven-cli reissuerestrictedasset "$ASSET_NAME" 1000 "myaddress" false "" "changeaddress" -1 false QmTqu3Lk3gmTsQVtjU7rYYM37EAW4xNmbuEAp2Mjr4AV7E
3709
+
3710
+ &nbsp;<br> &nbsp;<br/>
3711
+ ## removeprunedfunds
3712
+ &nbsp;<br/> removeprunedfunds "txid"
3713
+
3714
+ Deletes the specified transaction from the wallet. Meant for use with pruned wallets and as a companion to importprunedfunds. This will affect wallet balances.
3715
+
3716
+ Arguments:
3717
+ 1. "txid" (string, required) The hex-encoded id of the transaction you are deleting
3718
+
3719
+ Examples:
3720
+ > raven-cli removeprunedfunds "a8d0c0184dde994a09ec054286f1ce581bebf46446a512166eae7628734ea0a5"
3721
+
3722
+ As a JSON-RPC call
3723
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "removeprunedfunds", "params": ["a8d0c0184dde994a09ec054286f1ce581bebf46446a512166eae7628734ea0a5"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3724
+
3725
+ &nbsp;<br> &nbsp;<br/>
3726
+ ## removetagfromaddress
3727
+ &nbsp;<br/> removetagfromaddress tag_name to_address (change_address) (asset_data)
3728
+
3729
+ Remove a tag from a address
3730
+
3731
+ Arguments:
3732
+ 1. "tag_name" (string, required) the name of the tag you are removing from the address
3733
+ 2. "to_address" (string, required) the address that the tag will be removed from
3734
+ 3. "change_address" (string, optional) The change address for the qualifier token to be sent to
3735
+ 4. "asset_data" (string, optional) The asset data (ipfs or a hash) to be applied to the transfer of the qualifier token
3736
+
3737
+ Result:
3738
+ "txid" (string) The transaction id
3739
+
3740
+ Examples:
3741
+ > raven-cli removetagfromaddress "#TAG" "to_address"
3742
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "removetagfromaddress", "params": ["#TAG" "to_address"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3743
+ > raven-cli removetagfromaddress "#TAG" "to_address" "change_address"
3744
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "removetagfromaddress", "params": ["#TAG" "to_address" "change_address"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3745
+
3746
+ &nbsp;<br> &nbsp;<br/>
3747
+ ## requestsnapshot
3748
+ &nbsp;<br/> requestsnapshot "asset_name" block_height
3749
+
3750
+ Schedules a snapshot of the specified asset at the specified block height.
3751
+
3752
+ Arguments:
3753
+ 1. "asset_name" (string, required) The asset name for which the snapshot will be taken
3754
+ 2. "block_height" (number, required) The block height at which the snapshot will be take
3755
+
3756
+ Result:
3757
+ {
3758
+ request_status: "Added",
3759
+ }
3760
+
3761
+ Examples:
3762
+ > raven-cli requestsnapshot "TRONCO" 12345
3763
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "requestsnapshot", "params": ["PHATSTACKS" 34987] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3764
+
3765
+ &nbsp;<br> &nbsp;<br/>
3766
+ ## rescanblockchain
3767
+ &nbsp;<br/> rescanblockchain ("start_height") ("stop_height")
3768
+
3769
+ Rescan the local blockchain for wallet related transactions.
3770
+
3771
+ Arguments:
3772
+ 1. "start_height" (numeric, optional) block height where the rescan should start
3773
+ 2. "stop_height" (numeric, optional) the last block height that should be scanned
3774
+
3775
+ Result:
3776
+ {
3777
+ "start_height" (numeric) The block height where the rescan has started. If omitted, rescan started from the genesis block.
3778
+ "stop_height" (numeric) The height of the last rescanned block. If omitted, rescan stopped at the chain tip.
3779
+ }
3780
+
3781
+ Examples:
3782
+ > raven-cli rescanblockchain 100000 120000
3783
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "rescanblockchain", "params": [100000, 120000] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3784
+
3785
+ &nbsp;<br> &nbsp;<br/>
3786
+ ## savemempool
3787
+ &nbsp;<br/> savemempool
3788
+
3789
+ Dumps the mempool to disk.
3790
+
3791
+ Examples:
3792
+ > raven-cli savemempool
3793
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "savemempool", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3794
+
3795
+ &nbsp;<br> &nbsp;<br/>
3796
+ ## sendfrom
3797
+ &nbsp;<br/> sendfrom "fromaccount" "toaddress" amount ( minconf "comment" "comment_to" )
3798
+
3799
+ DEPRECATED (use sendtoaddress). Sent an amount from an account to a raven address.
3800
+
3801
+ Arguments:
3802
+ 1. "fromaccount" (string, required) The name of the account to send funds from. May be the default account using "".
3803
+ Specifying an account does not influence coin selection, but it does associate the newly created
3804
+ transaction with the account, so the account's balance computation and transaction history can reflect
3805
+ the spend.
3806
+ 2. "toaddress" (string, required) The raven address to send funds to.
3807
+ 3. amount (numeric or string, required) The amount in XNA (transaction fee is added on top).
3808
+ 4. minconf (numeric, optional, default=1) Only use funds with at least this many confirmations.
3809
+ 5. "comment" (string, optional) A comment used to store what the transaction is for.
3810
+ This is not part of the transaction, just kept in your wallet.
3811
+ 6. "comment_to" (string, optional) An optional comment to store the name of the person or organization
3812
+ to which you're sending the transaction. This is not part of the transaction,
3813
+ it is just kept in your wallet.
3814
+
3815
+ Result:
3816
+ "txid" (string) The transaction id.
3817
+
3818
+ Examples:
3819
+
3820
+ Send 0.01 XNA from the default account to the address, must have at least 1 confirmation
3821
+ > raven-cli sendfrom "" "1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd" 0.01
3822
+
3823
+ Send 0.01 from the tabby account to the given address, funds must have at least 6 confirmations
3824
+ > raven-cli sendfrom "tabby" "1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd" 0.01 6 "donation" "seans outpost"
3825
+
3826
+ As a json rpc call
3827
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendfrom", "params": ["tabby", "1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd", 0.01, 6, "donation", "seans outpost"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3828
+
3829
+ &nbsp;<br> &nbsp;<br/>
3830
+ ## sendfromaddress
3831
+ &nbsp;<br/> sendfromaddress "from_address" "to_address" amount ( "comment" "comment_to" subtractfeefromamount replaceable conf_target "estimate_mode")
3832
+
3833
+ Send an amount from a specific address to a given address. All xna change will get sent back to the from_address
3834
+
3835
+ Arguments:
3836
+ 1. "from_address" (string, required) The raven address to send from.
3837
+ 2. "to_address" (string, required) The raven address to send to.
3838
+ 3. "amount" (numeric or string, required) The amount in XNA to send. eg 0.1
3839
+ 4. "comment" (string, optional) A comment used to store what the transaction is for.
3840
+ This is not part of the transaction, just kept in your wallet.
3841
+ 5. "comment_to" (string, optional) A comment to store the name of the person or organization
3842
+ to which you're sending the transaction. This is not part of the
3843
+ transaction, just kept in your wallet.
3844
+ 6. subtractfeefromamount (boolean, optional, default=false) The fee will be deducted from the amount being sent.
3845
+ The recipient will receive less ravens than you enter in the amount field.
3846
+ 7. conf_target (numeric, optional) Confirmation target (in blocks)
3847
+ 8. "estimate_mode" (string, optional, default=UNSET) The fee estimate mode, must be one of:
3848
+ "UNSET"
3849
+ "ECONOMICAL"
3850
+ "CONSERVATIVE"
3851
+
3852
+ Result:
3853
+ "txid" (string) The transaction id.
3854
+
3855
+ Examples:
3856
+ > raven-cli sendfromaddress "1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd" "1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd" 0.1
3857
+ > raven-cli sendfromaddress "1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd" "1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd" 0.1 "donation" "seans outpost"
3858
+ > raven-cli sendfromaddress "1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd" "1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd" 0.1 "" "" true
3859
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendfromaddress", "params": ["1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd" "1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd", 0.1, "donation", "seans outpost"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3860
+
3861
+ &nbsp;<br> &nbsp;<br/>
3862
+ ## sendmany
3863
+ &nbsp;<br/> sendmany "fromaccount" {"address":amount,...} ( minconf "comment" ["address",...] replaceable conf_target "estimate_mode")
3864
+
3865
+ Send multiple times. Amounts are double-precision floating point numbers.
3866
+
3867
+ Arguments:
3868
+ 1. "fromaccount" (string, required) DEPRECATED. The account to send the funds from. Should be "" for the default account
3869
+ 2. "amounts" (string, required) A json object with addresses and amounts
3870
+ {
3871
+ "address":amount (numeric or string) The raven address is the key, the numeric amount (can be string) in XNA is the value
3872
+ ,...
3873
+ }
3874
+ 3. minconf (numeric, optional, default=1) Only use the balance confirmed at least this many times.
3875
+ 4. "comment" (string, optional) A comment
3876
+ 5. subtractfeefrom (array, optional) A json array with addresses.
3877
+ The fee will be equally deducted from the amount of each selected address.
3878
+ Those recipients will receive less ravens than you enter in their corresponding amount field.
3879
+ If no addresses are specified here, the sender pays the fee.
3880
+ [
3881
+ "address" (string) Subtract fee from this address
3882
+ ,...
3883
+ ]
3884
+ 6. conf_target (numeric, optional) Confirmation target (in blocks)
3885
+ 7. "estimate_mode" (string, optional, default=UNSET) The fee estimate mode, must be one of:
3886
+ "UNSET"
3887
+ "ECONOMICAL"
3888
+ "CONSERVATIVE"
3889
+
3890
+ Result:
3891
+ "txid" (string) The transaction id for the send. Only 1 transaction is created regardless of
3892
+ the number of addresses.
3893
+
3894
+ Examples:
3895
+
3896
+ Send two amounts to two different addresses:
3897
+ > raven-cli sendmany "" "{\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\":0.01,\"1353tsE8YMTA4EuV7dgUXGjNFf9KpVvKHz\":0.02}"
3898
+
3899
+ Send two amounts to two different addresses setting the confirmation and comment:
3900
+ > raven-cli sendmany "" "{\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\":0.01,\"1353tsE8YMTA4EuV7dgUXGjNFf9KpVvKHz\":0.02}" 6 "testing"
3901
+
3902
+ Send two amounts to two different addresses, subtract fee from amount:
3903
+ > raven-cli sendmany "" "{\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\":0.01,\"1353tsE8YMTA4EuV7dgUXGjNFf9KpVvKHz\":0.02}" 1 "" "[\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\",\"1353tsE8YMTA4EuV7dgUXGjNFf9KpVvKHz\"]"
3904
+
3905
+ As a json rpc call
3906
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendmany", "params": ["", "{\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\":0.01,\"1353tsE8YMTA4EuV7dgUXGjNFf9KpVvKHz\":0.02}", 6, "testing"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3907
+
3908
+ &nbsp;<br> &nbsp;<br/>
3909
+ ## sendmessage
3910
+ &nbsp;<br/> sendmessage "channel_name" "ipfs_hash" (expire_time)
3911
+
3912
+ Creates and broadcasts a message transaction to the network for a channel this wallet owns
3913
+ Arguments:
3914
+ 1. "channel_name" (string, required) Name of the channel that you want to send a message with (message channel, administrator asset), if a non administrator asset name is given, the administrator '!' will be added to it
3915
+ 2. "ipfs_hash" (string, required) The IPFS hash of the message
3916
+ 3. "expire_time" (numeric, optional) UTC timestamp of when the message expires
3917
+
3918
+ Result:[
3919
+ txid
3920
+ ]
3921
+
3922
+ Examples:
3923
+ > raven-cli sendmessage "ASSET_NAME!" "QmTqu3Lk3gmTsQVtjU7rYYM37EAW4xNmbuEAp2Mjr4AV7E" 15863654
3924
+ > raven-cli sendmessage "ASSET_NAME!" "QmTqu3Lk3gmTsQVtjU7rYYM37EAW4xNmbuEAp2Mjr4AV7E" 15863654
3925
+
3926
+ &nbsp;<br> &nbsp;<br/>
3927
+ ## sendrawtransaction
3928
+ &nbsp;<br/> sendrawtransaction "hexstring" ( allowhighfees )
3929
+
3930
+ Submits raw transaction (serialized, hex-encoded) to local node and network.
3931
+
3932
+ Also see createrawtransaction and signrawtransaction calls.
3933
+
3934
+ Arguments:
3935
+ 1. "hexstring" (string, required) The hex string of the raw transaction)
3936
+ 2. allowhighfees (boolean, optional, default=false) Allow high fees
3937
+
3938
+ Result:
3939
+ "hex" (string) The transaction hash in hex
3940
+
3941
+ Examples:
3942
+
3943
+ Create a transaction
3944
+ > raven-cli createrawtransaction "[{\"txid\" : \"mytxid\",\"vout\":0}]" "{\"myaddress\":0.01}"
3945
+ Sign the transaction, and get back the hex
3946
+ > raven-cli signrawtransaction "myhex"
3947
+
3948
+ Send the transaction (signed hex)
3949
+ > raven-cli sendrawtransaction "signedhex"
3950
+
3951
+ As a json rpc call
3952
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendrawtransaction", "params": ["signedhex"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3953
+
3954
+ &nbsp;<br> &nbsp;<br/>
3955
+ ## sendtoaddress
3956
+ &nbsp;<br/> sendtoaddress "address" amount ( "comment" "comment_to" subtractfeefromamount replaceable conf_target "estimate_mode")
3957
+
3958
+ Send an amount to a given address.
3959
+
3960
+ Arguments:
3961
+ 1. "address" (string, required) The raven address to send to.
3962
+ 2. "amount" (numeric or string, required) The amount in XNA to send. eg 0.1
3963
+ 3. "comment" (string, optional) A comment used to store what the transaction is for.
3964
+ This is not part of the transaction, just kept in your wallet.
3965
+ 4. "comment_to" (string, optional) A comment to store the name of the person or organization
3966
+ to which you're sending the transaction. This is not part of the
3967
+ transaction, just kept in your wallet.
3968
+ 5. subtractfeefromamount (boolean, optional, default=false) The fee will be deducted from the amount being sent.
3969
+ The recipient will receive less ravens than you enter in the amount field.
3970
+ 6. conf_target (numeric, optional) Confirmation target (in blocks)
3971
+ 7. "estimate_mode" (string, optional, default=UNSET) The fee estimate mode, must be one of:
3972
+ "UNSET"
3973
+ "ECONOMICAL"
3974
+ "CONSERVATIVE"
3975
+
3976
+ Result:
3977
+ "txid" (string) The transaction id.
3978
+
3979
+ Examples:
3980
+ > raven-cli sendtoaddress "1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd" 0.1
3981
+ > raven-cli sendtoaddress "1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd" 0.1 "donation" "seans outpost"
3982
+ > raven-cli sendtoaddress "1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd" 0.1 "" "" true
3983
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendtoaddress", "params": ["1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd", 0.1, "donation", "seans outpost"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3984
+
3985
+ &nbsp;<br> &nbsp;<br/>
3986
+ ## setaccount
3987
+ &nbsp;<br/> setaccount "address" "account"
3988
+
3989
+ DEPRECATED. Sets the account associated with the given address.
3990
+
3991
+ Arguments:
3992
+ 1. "address" (string, required) The raven address to be associated with an account.
3993
+ 2. "account" (string, required) The account to assign the address to.
3994
+
3995
+ Examples:
3996
+ > raven-cli setaccount "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" "tabby"
3997
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "setaccount", "params": ["1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX", "tabby"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
3998
+
3999
+ &nbsp;<br> &nbsp;<br/>
4000
+ ## setban
4001
+ &nbsp;<br/> setban "subnet" "add|remove" (bantime) (absolute)
4002
+
4003
+ Attempts to add or remove an IP/Subnet from the banned list.
4004
+
4005
+ Arguments:
4006
+ 1. "subnet" (string, required) The IP/Subnet (see getpeerinfo for nodes IP) with an optional netmask (default is /32 = single IP)
4007
+ 2. "command" (string, required) 'add' to add an IP/Subnet to the list, 'remove' to remove an IP/Subnet from the list
4008
+ 3. "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)
4009
+ 4. "absolute" (boolean, optional) If set, the bantime must be an absolute timestamp in seconds since epoch (Jan 1 1970 GMT)
4010
+
4011
+ Examples:
4012
+ > raven-cli setban "192.168.0.6" "add" 86400
4013
+ > raven-cli setban "192.168.0.0/24" "add"
4014
+ > 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/
4015
+
4016
+ &nbsp;<br> &nbsp;<br/>
4017
+ ## setgenerate
4018
+ &nbsp;<br/> setgenerate generate ( genproclimit )
4019
+
4020
+ Set 'generate' true or false to turn generation on or off.
4021
+ Generation is limited to 'genproclimit' processors, -1 is unlimited.
4022
+ See the getgenerate call for the current setting.
4023
+
4024
+ Arguments:
4025
+ 1. generate (boolean, required) Set to true to turn on generation, false to turn off.
4026
+ 2. genproclimit (numeric, optional) Set the processor limit for when generation is on. Can be -1 for unlimited.
4027
+
4028
+ Examples:
4029
+
4030
+ Set the generation on with a limit of one processor
4031
+ > raven-cli setgenerate true 1
4032
+
4033
+ Check the setting
4034
+ > raven-cli getgenerate
4035
+
4036
+ Turn off generation
4037
+ > raven-cli setgenerate false
4038
+
4039
+ Using json rpc
4040
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "setgenerate", "params": [true, 1] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
4041
+
4042
+ &nbsp;<br> &nbsp;<br/>
4043
+ ## setnetworkactive
4044
+ &nbsp;<br/> setnetworkactive true|false
4045
+
4046
+ Disable/enable all p2p network activity.
4047
+
4048
+ Arguments:
4049
+ 1. "state" (boolean, required) true to enable networking, false to disable
4050
+
4051
+ &nbsp;<br> &nbsp;<br/>
4052
+ ## settxfee
4053
+ &nbsp;<br/> settxfee amount
4054
+
4055
+ Set the transaction fee per kB. Overwrites the paytxfee parameter.
4056
+
4057
+ Arguments:
4058
+ 1. amount (numeric or string, required) The transaction fee in XNA/kB
4059
+
4060
+ Result
4061
+ true|false (boolean) Returns true if successful
4062
+
4063
+ Examples:
4064
+ > raven-cli settxfee 0.00001
4065
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "settxfee", "params": [0.00001] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
4066
+
4067
+ &nbsp;<br> &nbsp;<br/>
4068
+ ## signmessage
4069
+ &nbsp;<br/> signmessage "address" "message"
4070
+
4071
+ Sign a message with the private key of an address
4072
+
4073
+ Arguments:
4074
+ 1. "address" (string, required) The raven address to use for the private key.
4075
+ 2. "message" (string, required) The message to create a signature of.
4076
+
4077
+ Result:
4078
+ "signature" (string) The signature of the message encoded in base 64
4079
+
4080
+ Examples:
4081
+
4082
+ Unlock the wallet for 30 seconds
4083
+ > raven-cli walletpassphrase "mypassphrase" 30
4084
+
4085
+ Create the signature
4086
+ > raven-cli signmessage "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" "my message"
4087
+
4088
+ Verify the signature
4089
+ > raven-cli verifymessage "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" "signature" "my message"
4090
+
4091
+ As json rpc
4092
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "signmessage", "params": ["1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX", "my message"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
4093
+
4094
+ &nbsp;<br> &nbsp;<br/>
4095
+ ## signmessagewithprivkey
4096
+ &nbsp;<br/> signmessagewithprivkey "privkey" "message"
4097
+
4098
+ Sign a message with the private key of an address
4099
+
4100
+ Arguments:
4101
+ 1. "privkey" (string, required) The private key to sign the message with.
4102
+ 2. "message" (string, required) The message to create a signature of.
4103
+
4104
+ Result:
4105
+ "signature" (string) The signature of the message encoded in base 64
4106
+
4107
+ Examples:
4108
+
4109
+ Create the signature
4110
+ > raven-cli signmessagewithprivkey "privkey" "my message"
4111
+
4112
+ Verify the signature
4113
+ > raven-cli verifymessage "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" "signature" "my message"
4114
+
4115
+ As json rpc
4116
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "signmessagewithprivkey", "params": ["privkey", "my message"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
4117
+
4118
+ &nbsp;<br> &nbsp;<br/>
4119
+ ## signrawtransaction
4120
+ &nbsp;<br/> signrawtransaction "hexstring" ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] ["privatekey1",...] sighashtype )
4121
+
4122
+ Sign inputs for raw transaction (serialized, hex-encoded).
4123
+ The second optional argument (may be null) is an array of previous transaction outputs that
4124
+ this transaction depends on but may not yet be in the block chain.
4125
+ The third optional argument (may be null) is an array of base58-encoded private
4126
+ keys that, if given, will be the only keys used to sign the transaction.
4127
+
4128
+
4129
+ Arguments:
4130
+ 1. "hexstring" (string, required) The transaction hex string
4131
+ 2. "prevtxs" (string, optional) An json array of previous dependent transaction outputs
4132
+ [ (json array of json objects, or 'null' if none provided)
4133
+ {
4134
+ "txid":"id", (string, required) The transaction id
4135
+ "vout":n, (numeric, required) The output number
4136
+ "scriptPubKey": "hex", (string, required) script key
4137
+ "redeemScript": "hex", (string, required for P2SH or P2WSH) redeem script
4138
+ "amount": value (numeric, required) The amount spent
4139
+ }
4140
+ ,...
4141
+ ]
4142
+ 3. "privkeys" (string, optional) A json array of base58-encoded private keys for signing
4143
+ [ (json array of strings, or 'null' if none provided)
4144
+ "privatekey" (string) private key in base58-encoding
4145
+ ,...
4146
+ ]
4147
+ 4. "sighashtype" (string, optional, default=ALL) The signature hash type. Must be one of
4148
+ "ALL"
4149
+ "NONE"
4150
+ "SINGLE"
4151
+ "ALL|ANYONECANPAY"
4152
+ "NONE|ANYONECANPAY"
4153
+ "SINGLE|ANYONECANPAY"
4154
+
4155
+ Result:
4156
+ {
4157
+ "hex" : "value", (string) The hex-encoded raw transaction with signature(s)
4158
+ "complete" : true|false, (boolean) If the transaction has a complete set of signatures
4159
+ "errors" : [ (json array of objects) Script verification errors (if there are any)
4160
+ {
4161
+ "txid" : "hash", (string) The hash of the referenced, previous transaction
4162
+ "vout" : n, (numeric) The index of the output to spent and used as input
4163
+ "scriptSig" : "hex", (string) The hex-encoded signature script
4164
+ "sequence" : n, (numeric) Script sequence number
4165
+ "error" : "text" (string) Verification or signing error related to the input
4166
+ }
4167
+ ,...
4168
+ ]
4169
+ }
4170
+
4171
+ Examples:
4172
+ > raven-cli signrawtransaction "myhex"
4173
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "signrawtransaction", "params": ["myhex"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
4174
+
4175
+ &nbsp;<br> &nbsp;<br/>
4176
+ ## stop
4177
+ &nbsp;<br/> stop
4178
+
4179
+ Stop Raven server.
4180
+ &nbsp;<br> &nbsp;<br/>
4181
+ ## submitblock
4182
+ &nbsp;<br/> submitblock "hexdata" ( "dummy" )
4183
+
4184
+ Attempts to submit new block to network.
4185
+ See https://en.raven.it/wiki/BIP_0022 for full specification.
4186
+
4187
+ Arguments
4188
+ 1. "hexdata" (string, required) the hex-encoded block data to submit
4189
+ 2. "dummy" (optional) dummy value, for compatibility with BIP22. This value is ignored.
4190
+
4191
+ Result:
4192
+
4193
+ Examples:
4194
+ > raven-cli submitblock "mydata"
4195
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "submitblock", "params": ["mydata"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
4196
+
4197
+ &nbsp;<br> &nbsp;<br/>
4198
+ ## subscribetochannel
4199
+ &nbsp;<br/> subscribetochannel
4200
+
4201
+ Subscribe to a certain message channel
4202
+
4203
+ Arguments:
4204
+ 1. "channel_name" (string, required) The channel name to subscribe to, it must end with '!' or have an '~' in the name
4205
+
4206
+ Result:[
4207
+
4208
+ ]
4209
+
4210
+ Examples:
4211
+ > raven-cli subscribetochannel "ASSET_NAME!"
4212
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "subscribetochannel", "params": ["ASSET_NAME!"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
4213
+
4214
+ &nbsp;<br> &nbsp;<br/>
4215
+ ## testmempoolaccept
4216
+ &nbsp;<br/> testmempoolaccept ["rawtxs"] ( allowhighfees )
4217
+
4218
+ Returns if raw transaction (serialized, hex-encoded) would be accepted by mempool.
4219
+
4220
+ This checks if the transaction violates the consensus or policy rules.
4221
+
4222
+ See sendrawtransaction call.
4223
+
4224
+ Arguments:
4225
+ 1. ["rawtxs"] (array, required) An array of hex strings of raw transactions.
4226
+ Length must be one for now.
4227
+ 2. allowhighfees (boolean, optional, default=false) Allow high fees
4228
+
4229
+ Result:
4230
+ [ (array) The result of the mempool acceptance test for each raw transaction in the input array.
4231
+ Length is exactly one for now.
4232
+ {
4233
+ "txid" (string) The transaction hash in hex
4234
+ "allowed" (boolean) If the mempool allows this tx to be inserted
4235
+ "reject-reason" (string) Rejection string (only present when 'allowed' is false)
4236
+ }
4237
+ ]
4238
+
4239
+ Examples:
4240
+
4241
+ Create a transaction
4242
+ > raven-cli createrawtransaction "[{\"txid\" : \"mytxid\",\"vout\":0}]" "{\"myaddress\":0.01}"
4243
+ Sign the transaction, and get back the hex
4244
+ > raven-cli signrawtransaction "myhex"
4245
+
4246
+ Test acceptance of the transaction (signed hex)
4247
+ > raven-cli testmempoolaccept "signedhex"
4248
+
4249
+ As a json rpc call
4250
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "testmempoolaccept", "params": [["signedhex"]] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
4251
+
4252
+ &nbsp;<br> &nbsp;<br/>
4253
+ ## transfer
4254
+ &nbsp;<br/> transfer "asset_name" qty "to_address" "message" expire_time "change_address" "asset_change_address"
4255
+
4256
+ Transfers a quantity of an owned asset to a given address
4257
+ Arguments:
4258
+ 1. "asset_name" (string, required) name of asset
4259
+ 2. "qty" (numeric, required) number of assets you want to send to the address
4260
+ 3. "to_address" (string, required) address to send the asset to
4261
+ 4. "message" (string, optional) Once RIP5 is voted in ipfs hash or txid hash to send along with the transfer
4262
+ 5. "expire_time" (numeric, optional) UTC timestamp of when the message expires
4263
+ 6. "change_address" (string, optional, default = "") the transactions XNA change will be sent to this address
4264
+ 7. "asset_change_address" (string, optional, default = "") the transactions Asset change will be sent to this address
4265
+
4266
+ Result:
4267
+ txid[
4268
+ txid
4269
+ ]
4270
+
4271
+ Examples:
4272
+ > raven-cli transfer "ASSET_NAME" 20 "address" "" "QmTqu3Lk3gmTsQVtjU7rYYM37EAW4xNmbuEAp2Mjr4AV7E" 15863654
4273
+ > raven-cli transfer "ASSET_NAME" 20 "address" "" "QmTqu3Lk3gmTsQVtjU7rYYM37EAW4xNmbuEAp2Mjr4AV7E" 15863654
4274
+
4275
+ &nbsp;<br> &nbsp;<br/>
4276
+ ## transferfromaddress
4277
+ &nbsp;<br/> transferfromaddress "asset_name" "from_address" qty "to_address" "message" expire_time "xna_change_address" "asset_change_address"
4278
+
4279
+ Transfer a quantity of an owned asset in a specific address to a given address
4280
+ Arguments:
4281
+ 1. "asset_name" (string, required) name of asset
4282
+ 2. "from_address" (string, required) address that the asset will be transferred from
4283
+ 3. "qty" (numeric, required) number of assets you want to send to the address
4284
+ 4. "to_address" (string, required) address to send the asset to
4285
+ 5. "message" (string, optional) Once RIP5 is voted in ipfs hash or txid hash to send along with the transfer
4286
+ 6. "expire_time" (numeric, optional) UTC timestamp of when the message expires
4287
+ 7. "xna_change_address" (string, optional, default = "") the transaction XNA change will be sent to this address
4288
+ 8. "asset_change_address" (string, optional, default = "") the transaction Asset change will be sent to this address
4289
+
4290
+ Result:
4291
+ txid[
4292
+ txid
4293
+ ]
4294
+
4295
+ Examples:
4296
+ > raven-cli transferfromaddress "ASSET_NAME" "fromaddress" 20 "address" "QmTqu3Lk3gmTsQVtjU7rYYM37EAW4xNmbuEAp2Mjr4AV7E", 156545652
4297
+ > 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/
4298
+
4299
+ &nbsp;<br> &nbsp;<br/>
4300
+ ## transferfromaddresses
4301
+ &nbsp;<br/> transferfromaddresses "asset_name" ["from_addresses"] qty "to_address" "message" expire_time "xna_change_address" "asset_change_address"
4302
+
4303
+ Transfer a quantity of an owned asset in specific address(es) to a given address
4304
+ Arguments:
4305
+ 1. "asset_name" (string, required) name of asset
4306
+ 2. "from_addresses" (array, required) list of from addresses to send from
4307
+ 3. "qty" (numeric, required) number of assets you want to send to the address
4308
+ 4. "to_address" (string, required) address to send the asset to
4309
+ 5. "message" (string, optional) Once RIP5 is voted in ipfs hash or txid hash to send along with the transfer
4310
+ 6. "expire_time" (numeric, optional) UTC timestamp of when the message expires
4311
+ 7. "xna_change_address" (string, optional, default = "") the transactions XNA change will be sent to this address
4312
+ 8. "asset_change_address" (string, optional, default = "") the transactions Asset change will be sent to this address
4313
+
4314
+ Result:
4315
+ txid[
4316
+ txid
4317
+ ]
4318
+
4319
+ Examples:
4320
+ > raven-cli transferfromaddresses "ASSET_NAME" '["fromaddress1", "fromaddress2"]' 20 "to_address" "QmTqu3Lk3gmTsQVtjU7rYYM37EAW4xNmbuEAp2Mjr4AV7E" 154652365
4321
+ > 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/
4322
+
4323
+ &nbsp;<br> &nbsp;<br/>
4324
+ ## transferqualifier
4325
+ &nbsp;<br/> transferqualifier "qualifier_name" qty "to_address" ("change_address") ("message") (expire_time)
4326
+
4327
+ Transfer a qualifier asset owned by this wallet to the given address
4328
+ Arguments:
4329
+ 1. "qualifier_name" (string, required) name of qualifier asset
4330
+ 2. "qty" (numeric, required) number of assets you want to send to the address
4331
+ 3. "to_address" (string, required) address to send the asset to
4332
+ 4. "change_address" (string, optional, default = "") the transaction change will be sent to this address
4333
+ 5. "message" (string, optional) Once RIP5 is voted in ipfs hash or txid hash to send along with the transfer
4334
+ 6. "expire_time" (numeric, optional) UTC timestamp of when the message expires
4335
+
4336
+ Result:
4337
+ txid[
4338
+ txid
4339
+ ]
4340
+
4341
+ Examples:
4342
+ > raven-cli transferqualifier "#QUALIFIER" 20 "to_address" "" "QmTqu3Lk3gmTsQVtjU7rYYM37EAW4xNmbuEAp2Mjr4AV7E" 15863654
4343
+ > raven-cli transferqualifier "#QUALIFIER" 20 "to_address" "change_address" "QmTqu3Lk3gmTsQVtjU7rYYM37EAW4xNmbuEAp2Mjr4AV7E" 15863654
4344
+
4345
+ &nbsp;<br> &nbsp;<br/>
4346
+ ## unfreezeaddress
4347
+ &nbsp;<br/> unfreezeaddress asset_name address (change_address) (asset_data)
4348
+
4349
+ Unfreeze an address from transferring a restricted asset
4350
+
4351
+ Arguments:
4352
+ 1. "asset_name" (string, required) the name of the restricted asset you want to unfreeze
4353
+ 2. "address" (string, required) the address that will be unfrozen
4354
+ 3. "change_address" (string, optional) The change address for the owner token of the restricted asset
4355
+ 4. "asset_data" (string, optional) The asset data (ipfs or a hash) to be applied to the transfer of the owner token
4356
+
4357
+ Result:
4358
+ "txid" (string) The transaction id
4359
+
4360
+ Examples:
4361
+ > raven-cli unfreezeaddress "$RESTRICTED_ASSET" "address"
4362
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "unfreezeaddress", "params": ["$RESTRICTED_ASSET" "address"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
4363
+ > raven-cli unfreezeaddress "$RESTRICTED_ASSET" "address" "change_address"
4364
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "unfreezeaddress", "params": ["$RESTRICTED_ASSET" "address" "change_address"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
4365
+
4366
+ &nbsp;<br> &nbsp;<br/>
4367
+ ## unfreezerestrictedasset
4368
+ &nbsp;<br/> unfreezerestrictedasset asset_name (change_address) (asset_data)
4369
+
4370
+ Unfreeze all trading for a specific restricted asset
4371
+
4372
+ Arguments:
4373
+ 1. "asset_name" (string, required) the name of the restricted asset you want to unfreeze
4374
+ 2. "change_address" (string, optional) The change address for the owner token of the restricted asset
4375
+ 4. "asset_data" (string, optional) The asset data (ipfs or a hash) to be applied to the transfer of the owner token
4376
+
4377
+ Result:
4378
+ "txid" (string) The transaction id
4379
+
4380
+ Examples:
4381
+ > raven-cli unfreezerestrictedasset "$RESTRICTED_ASSET"
4382
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "unfreezerestrictedasset", "params": ["$RESTRICTED_ASSET"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
4383
+ > raven-cli unfreezerestrictedasset "$RESTRICTED_ASSET" "change_address"
4384
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "unfreezerestrictedasset", "params": ["$RESTRICTED_ASSET" "change_address"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
4385
+
4386
+ &nbsp;<br> &nbsp;<br/>
4387
+ ## unsubscribefromchannel
4388
+ &nbsp;<br/> unsubscribefromchannel
4389
+
4390
+ Unsubscribe from a certain message channel
4391
+
4392
+ Arguments:
4393
+ 1. "channel_name" (string, required) The channel name to unsubscribe from, must end with '!' or have an '~' in the name
4394
+
4395
+ Result:[
4396
+
4397
+ ]
4398
+
4399
+ Examples:
4400
+ > raven-cli unsubscribefromchannel "ASSET_NAME!"
4401
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "unsubscribefromchannel", "params": ["ASSET_NAME!"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
4402
+
4403
+ &nbsp;<br> &nbsp;<br/>
4404
+ ## uptime
4405
+ &nbsp;<br/> uptime
4406
+
4407
+ Returns the total uptime of the server.
4408
+
4409
+ Result:
4410
+ ttt (numeric) The number of seconds that the server has been running
4411
+
4412
+ Examples:
4413
+ > raven-cli uptime
4414
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "uptime", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
4415
+
4416
+ &nbsp;<br> &nbsp;<br/>
4417
+ ## validateaddress
4418
+ &nbsp;<br/> validateaddress "address"
4419
+
4420
+ Return information about the given raven address.
4421
+
4422
+ Arguments:
4423
+ 1. "address" (string, required) The raven address to validate
4424
+
4425
+ Result:
4426
+ {
4427
+ "isvalid" : true|false, (boolean) If the address is valid or not. If not, this is the only property returned.
4428
+ "address" : "address", (string) The raven address validated
4429
+ "scriptPubKey" : "hex", (string) The hex encoded scriptPubKey generated by the address
4430
+ "ismine" : true|false, (boolean) If the address is yours or not
4431
+ "iswatchonly" : true|false, (boolean) If the address is watchonly
4432
+ "isscript" : true|false, (boolean) If the key is a script
4433
+ "script" : "type" (string, optional) The output script type. Possible types: nonstandard, pubkey, pubkeyhash, scripthash, multisig, nulldata, witness_v0_keyhash, witness_v0_scripthash
4434
+ "hex" : "hex", (string, optional) The redeemscript for the p2sh address
4435
+ "addresses" (string, optional) Array of addresses associated with the known redeemscript
4436
+ [
4437
+ "address"
4438
+ ,...
4439
+ ]
4440
+ "sigsrequired" : xxxxx (numeric, optional) Number of signatures required to spend multisig output
4441
+ "pubkey" : "publickeyhex", (string) The hex value of the raw public key
4442
+ "iscompressed" : true|false, (boolean) If the address is compressed
4443
+ "account" : "account" (string) DEPRECATED. The account associated with the address, "" is the default account
4444
+ "timestamp" : timestamp, (number, optional) The creation time of the key if available in seconds since epoch (Jan 1 1970 GMT)
4445
+ "hdkeypath" : "keypath" (string, optional) The HD keypath if the key is HD and available
4446
+ "hdmasterkeyid" : "<hash160>" (string, optional) The Hash160 of the HD master pubkey
4447
+ }
4448
+
4449
+ Examples:
4450
+ > raven-cli validateaddress "1PSSGeFHDnKNxiEyFrD1wcEaHr9hrQDDWc"
4451
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "validateaddress", "params": ["1PSSGeFHDnKNxiEyFrD1wcEaHr9hrQDDWc"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
4452
+
4453
+ &nbsp;<br> &nbsp;<br/>
4454
+ ## verifychain
4455
+ &nbsp;<br/> verifychain ( checklevel nblocks )
4456
+
4457
+ Verifies blockchain database.
4458
+
4459
+ Arguments:
4460
+ 1. checklevel (numeric, optional, 0-4, default=3) How thorough the block verification is.
4461
+ 2. nblocks (numeric, optional, default=6, 0=all) The number of blocks to check.
4462
+
4463
+ Result:
4464
+ true|false (boolean) Verified or not
4465
+
4466
+ Examples:
4467
+ > raven-cli verifychain
4468
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "verifychain", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
4469
+
4470
+ &nbsp;<br> &nbsp;<br/>
4471
+ ## verifymessage
4472
+ &nbsp;<br/> verifymessage "address" "signature" "message"
4473
+
4474
+ Verify a signed message
4475
+
4476
+ Arguments:
4477
+ 1. "address" (string, required) The raven address to use for the signature.
4478
+ 2. "signature" (string, required) The signature provided by the signer in base 64 encoding (see signmessage).
4479
+ 3. "message" (string, required) The message that was signed.
4480
+
4481
+ Result:
4482
+ true|false (boolean) If the signature is verified or not.
4483
+
4484
+ Examples:
4485
+
4486
+ Unlock the wallet for 30 seconds
4487
+ > raven-cli walletpassphrase "mypassphrase" 30
4488
+
4489
+ Create the signature
4490
+ > raven-cli signmessage "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" "my message"
4491
+
4492
+ Verify the signature
4493
+ > raven-cli verifymessage "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" "signature" "my message"
4494
+
4495
+ As json rpc
4496
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "verifymessage", "params": ["1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX", "signature", "my message"] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
4497
+
4498
+ &nbsp;<br> &nbsp;<br/>
4499
+ ## verifytxoutproof
4500
+ &nbsp;<br/> verifytxoutproof "proof"
4501
+
4502
+ Verifies that a proof points to a transaction in a block, returning the transaction it commits to
4503
+ and throwing an RPC error if the block is not in our best chain
4504
+
4505
+ Arguments:
4506
+ 1. "proof" (string, required) The hex-encoded proof generated by gettxoutproof
4507
+
4508
+ Result:
4509
+ ["txid"] (array, strings) The txid(s) which the proof commits to, or empty array if the proof is invalid
4510
+
4511
+ &nbsp;<br> &nbsp;<br/>
4512
+ ## viewallmessagechannels
4513
+ &nbsp;<br/> viewallmessagechannels
4514
+
4515
+ View all message channels the wallet is subscribed to
4516
+
4517
+ Result:[
4518
+ "Asset Name" (string) The asset channel name
4519
+
4520
+ ]
4521
+
4522
+ Examples:
4523
+ > raven-cli viewallmessagechannels
4524
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "viewallmessagechannels", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
4525
+
4526
+ &nbsp;<br> &nbsp;<br/>
4527
+ ## viewallmessages
4528
+ &nbsp;<br/> viewallmessages
4529
+
4530
+ View all messages that the wallet contains
4531
+
4532
+ Result:
4533
+ "Asset Name:" (string) The name of the asset the message was sent on
4534
+ "Message:" (string) The IPFS hash of the message
4535
+ "Time:" (Date) The time as a date in the format (YY-mm-dd Hour-minute-second)
4536
+ "Block Height:" (number) The height of the block the message was included in
4537
+ "Status:" (string) Status of the message (READ, UNREAD, ORPHAN, EXPIRED, SPAM, HIDDEN, ERROR)
4538
+ "Expire Time:" (Date, optional) If the message had an expiration date assigned, it will be shown here in the format (YY-mm-dd Hour-minute-second)
4539
+ "Expire UTC Time:" (Date, optional) If the message contains an expire date that is too large, the UTC number will be displayed
4540
+
4541
+ Examples:
4542
+ > raven-cli viewallmessages
4543
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "viewallmessages", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
4544
+
4545
+ &nbsp;<br> &nbsp;<br/>
4546
+ ## viewmyrestrictedaddresses
4547
+ &nbsp;<br/> viewmyrestrictedaddresses
4548
+
4549
+ View all addresses this wallet owns that have been restricted
4550
+
4551
+ Result:
4552
+ {
4553
+ "Address:" (string) The address that was restricted
4554
+ "Asset Name:" (string) The asset that the restriction applies to
4555
+ "[Restricted|Derestricted]:" (Date) The UTC datetime of the restriction or derestriction in the format (YY-mm-dd HH:MM:SS))
4556
+ (Only the most recent restriction/derestriction event will be returned for each address)
4557
+ }...
4558
+
4559
+ Examples:
4560
+ > raven-cli viewmyrestrictedaddresses
4561
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "viewmyrestrictedaddresses", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
4562
+
4563
+ &nbsp;<br> &nbsp;<br/>
4564
+ ## viewmytaggedaddresses
4565
+ &nbsp;<br/> viewmytaggedaddresses
4566
+
4567
+ View all addresses this wallet owns that have been tagged
4568
+
4569
+ Result:
4570
+ {
4571
+ "Address:" (string) The address that was tagged
4572
+ "Tag Name:" (string) The asset name
4573
+ "[Assigned|Removed]:" (Date) The UTC datetime of the assignment or removal of the tag in the format (YY-mm-dd HH:MM:SS)
4574
+ (Only the most recent tagging/untagging event will be returned for each address)
4575
+ }...
4576
+
4577
+ Examples:
4578
+ > raven-cli viewmytaggedaddresses
4579
+ > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "viewmytaggedaddresses", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8766/
4580
+