diff --git a/doc/elements-api.md b/doc/elements-api.md new file mode 100644 index 0000000000..b3871d147f --- /dev/null +++ b/doc/elements-api.md @@ -0,0 +1,10118 @@ +# Elements RPC reference + + + + + + + + + + + + + + + + + + + + + + + + + +Elements includes many of the same Remote Procedure Calls (RPCs) as +Bitcoin Core. This document only describes Elements RPCs that differ +from Bitcoin Core or that are entirely new. For any RPCs not +referenced here, please see [Bitcoin.org's Developer +Reference](https://bitcoin.org/en/developer-reference). The search box +at the top of that page provides a search with auto-completion. + +For any RPC in either Elements or Bitcoin Core, you may obtain help at +the command line using the `help` RPC. For example, + +```text +elements-cli help getblockchaininfo +bitcoin-cli help getblockchaininfo +``` + +## Quick reference + +The following short sections categorize the RPCs in this document. For +a list of RPCs available in Bitcoin Core and which are not changed in +Elements, please see the [Bitcoin.org RPC quick reference][]. +The methods in italics exist in Bitcoin Core, but are modified for elements. + +### Generating +- [combineblocksigs][] +- [getnewblockhex][] +- [testproposedblock][] + +### Raw transactions +- [blindrawtransaction][] +- *[createrawtransaction][]* +- *[decoderawtransaction][]* +- [rawblindrawtransaction][] +- *[sendrawtransaction][]* + +### Utility +- [createblindedaddress][] +- [getblockstats][] +- *[getrawtransaction][]* +- *[validateaddress][]* +- [tweakfedpegscript][] + +### Wallet +- [claimpegin][] +- [destroyamount][] +- [dumpassetlabels][] +- [dumpblindingkey][] +- [dumpissuanceblindingkey][] +- *[getbalance][]* +- [getpeginaddress][] +- *[gettransaction][]* +- *[getunconfirmedbalance][]* +- *[getwalletinfo][]* +- [importissuanceblindingkey][] +- [issueasset][] +- [listissuances][] +- *[listtransactions][]* +- *[listunspent][]* +- [reissueasset][] +- *[sendtoaddress][]* +- [sendtomainchain][] +- [signblock][] + + +The following RPCs are listed in alphabetical order. + +## blindrawtransaction + +The `blindrawtransaction` RPC takes a raw transaction and converts one or +more of its outputs into a [blinded output][]. It returns the modified +raw transaction. The blinding of outputs will be balanced against +any input blinding factors the wallet knows about. + +*Parameter #1---the hex string of the raw transaction* + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| hexstring | +string (hex) | +Required (exactly 1) |
+ + + The hex string of the [raw transaction][] + + | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| ignoreblindfail | +bool | +Optional (0 or 1) |
+ Whether to return a transaction (rather than fail) when the blinding attempt fails due to the number of blinded inputs or outputs | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| Generators | +array | +Optional (0 or 1) |
+ Input asset generators. Must be empty in the case the wallet knows all transaction inputs, or match the final input commitment list (including ordering) when one or more inputs is not known to the wallet. These are used to prove there are no assets being created out of thin air. Must not include generators for issuances as those assets are inherently unblinded. | +
| → assetcommitment |
+ string (hex) | +Optional (1 or more) |
+ + + A hex-encoded asset commitment, one for each input. Null commitments must be `""` + + | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | +string | +Required (exactly 1) |
+ + + The resulting unsigned raw transaction in serialized + transaction format, encoded as hex. If the transaction couldn't be + blinded, this will be set to JSON `null` and the JSON-RPC `error` + field may contain an error message + + | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| Bitcoin transaction | +string (hex) | +Required (exactly 1) |
+ The hex-encoded serialized transaction from the + mainchain that pays the peg-in address (script) | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| Transaction output proof | +string (hex) | +Required (exactly 1) |
+ + + The proof that the deposit transaction output exists + on the mainchain. This can be generated by bitcoind's + `gettxoutproof` RPC for the deposit transaction + + | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | +string (hex) | +Required (exactly 1) |
+ The hex-encoded serialized transaction on the sidechain | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| Block | +string (hex) | +Required (exactly 1) |
+ The hex-encoded block to which signatures should be + added. This is the entire block, not just the header | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| Signatures | +array | +Required (exactly 1) |
+ An array of signatures to add to the block | +
| → signature |
+ string (hex) | +Required (1 or more) |
+ A signature to add to the block. The format is a + hex-encoded scriptSig that satisfies the sidechain's block signing + conditions | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | +object | +Required (exactly 1) |
+ An object containing the results of the + operation | +
|
+
+ → `hex` + + |
+ string (hex) | +Required (exactly 1) |
+ The signed block | +
|
+
+ → `complete` + + |
+ bool | +Required (exactly 1) |
+ + + `true` if the block is fully signed. Otherwise, `false` + + | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| address | +string (base58) | +Required (exactly 1) |
+ The unblinded address to be blinded | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| key | +string (hex) | +Required (exactly 1) |
+ The key to use for the blinding | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | +string (base58) | +Required (exactly 1) |
+ The blinded address | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| hash_or_height | +numeric or string (hex) | +Required (exactly 1) |
+ The block hash or height of the target block. If height, negative values + count back from the current tip | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| stats | +array | +optional | +Array of values to plot, by default all values. Array of strings, see + results for possible values. | +
| Name | +Type | +Description | +
|---|---|---|
| + + `result` + + | +json object | +A JSON object with all the block statistics. | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Inputs + + | + ++ + array + + | + +
+
+ Required (exactly 1) + + |
+
+ + + An array of objects, each one to be used as an input to the transaction + + | + +
| + + → Input + + | + ++ + object + + | + +
+
+ Required (1 or more) + + |
+
+ + + An object describing a particular input + + | + +
|
+
+ → → `txid` + + |
+
+ + + string (hex) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The TXID of the outpoint to be spent encoded as hex in RPC byte order + + | + +
|
+
+ → → `vout` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The output index number (vout) of the outpoint to be spent; the first output in a transaction is index `0` + + | + +
|
+
+ → → `Sequence` + + |
+
+ + + number (int) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The sequence number to use for the input + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Outputs + + | + ++ + object + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The addresses and amounts to pay + + | + +
|
+
+ → Address/Amount + + |
+
+ + + string : number (bitcoins) + + | + +
+
+ Required (1 or more) + + |
+
+ + + A key/value pair with the address to pay as a string (key) and the amount to pay that address (value) in bitcoins. Address can be CT or non-CT. + + | + +
|
+
+ **→ `data`** + + |
+
+ + + **string (hex)** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + A key/value pair with the value being hex-encoded data to push into OP_RETURN output. + + | + +
|
+
+ **→ `fee`** + + |
+
+ + + **number ([value amount][])** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **The value of the fee output that you want to add** + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Locktime + + | + ++ + numeric (int) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + Indicates the earliest time (in block height or Unix epoch time) a transaction can be added to the block chain + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + **Output assets** + + | + ++ + **object** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **A mapping of output addresses to the asset type to be transferred** + + | + +
|
+
+ **→ pairing** + + |
+
+ + + **string (address) : asset (hex)** + + | + +
+
+ **Optional (0 or more)** + + |
+
+ + + **A pairing of the address listed in the Outputs object and the asset to be paid** + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | + ++ + string + + | + +
+
+ Required (Exactly 1) + + |
+
+ + + The resulting unsigned raw transaction in serialized transaction format, encoded as hex. If the transaction couldn't be generated, this will be set to JSON `null` and the JSON-RPC error field may contain an error message + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Serialized Transaction + + | + ++ + string (hex) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The transaction to decode in serialized transaction format + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | + ++ + object + + | + +
+
+ Required (exactly 1) + + |
+
+ + + An object describing the decoded transaction, or JSON `null` if the transaction could not be decoded + + | + +
|
+
+ → `txid` + + |
+
+ + + string (hex) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The transaction's TXID, encoded as hex in RPC byte order + + | + +
|
+
+ → `hash` + + |
+
+ + + string (hex) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The transaction hash. Differs from txid for witness transactions + + | + +
|
+
+ ** → `withash`** + + |
+
+ + + **string (hex)** + + | + +
+
+ **Required (exactly 1)** + + |
+
+ + + **The witness hash. May be the same as `hash`** + + | + +
|
+
+ → `size` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The serialized transaction size + + | + +
|
+
+ → `vsize` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The virtual transaction size. Differs from size for witness transactions + + | + +
|
+
+ → `version` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The transaction format version number + + | + +
|
+
+ → `locktime` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The transaction's locktime: either a Unix epoch date or block height + + | + +
|
+
+ → `vin` + + |
+
+ + + array + + | + +
+
+ Required (exactly 1) + + |
+
+ + + An array of objects with each object being an input vector (vin) for this transaction. Input objects will have the same order within the array as they have in the transaction, so the first input listed will be input 0 + + | + +
|
+
+ → → Input + + |
+
+ + + object + + | + +
+
+ Required (1 or more) + + |
+
+ + + An object describing one of this transaction's inputs. May be a regular input or a coinbase + + | + +
|
+
+ → → → `txid` + + |
+
+ + + string + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The TXID of the outpoint being spent, encoded as hex in RPC byte order. Not present if this is a coinbase transaction + + | + +
|
+
+ → → → `vout` + + |
+
+ + + number (int) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The output index number (vout) of the outpoint being spent. The first output in a transaction has an index of `0`. Not present if this is a coinbase transaction + + | + +
|
+
+ → → → `scriptSig` + + |
+
+ + + object + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + An object describing the signature script of this input. Not present if this is a coinbase transaction + + | + +
|
+
+ → → → → `asm` + + |
+
+ + + string + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The signature script in decoded form with non-data-pushing opcodes listed + + | + +
|
+
+ → → → → `hex` + + |
+
+ + + string (hex) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The signature script, encoded as hex + + | + +
|
+
+ → → → `sequence` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The input sequence number + + | + +
|
+
+ → → → `txinwitness` + + |
+
+ + + string : array + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + Hex-encoded witness data. Only for segregated witness transactions + + | + +
|
+
+ → `vout` + + |
+
+ + + array + + | + +
+
+ Required (exactly 1) + + |
+
+ + + An array of objects each describing an output vector (vout) for this transaction. Output objects will have the same order within the array as they have in the transaction, so the first output listed will be output 0 + + | + +
|
+
+ → → Output + + |
+
+ + + object + + | + +
+
+ Required (1 or more) + + |
+
+ + + An object describing one of this transaction's outputs + + | + +
|
+
+ → → → `value` + + |
+
+ + + number ([value amount][]) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The amount paid to this output. May be `0`. **Only returned for unblinded outputs** + + | + +
|
+
+ ** → → → `value-minimum`** + + |
+
+ + + **number ([value amount][])** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **The minimum amount paid in this output. Only returned for blinded outputs** + + | + +
|
+
+ ** → → → `value-maximum`** + + |
+
+ + + **number ([value amount][])** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **The maximum amount paid in this output. Only returned for blinded outputs** + + | + +
|
+
+ ** → → → `ct-exponent`** + + |
+
+ + + **number ([value amount][])** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **The exponent used in the blinded output** + + | + +
|
+
+ ** → → → `ct-bits`** + + |
+
+ + + **number (int)** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **The number of bits used in the blinded output** + + | + +
|
+
+ ** → → → `asset`** + + |
+
+ + + **string (hex)** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **The asset identifier, if the asset is unblinded** + + | + +
|
+
+ ** → → → `assetcommitment`** + + |
+
+ + + **string (hex)** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **The asset tag, if the asset is blinded** + + | + +
|
+
+ ** → → → `serValue`** + + |
+
+ + + **string (hex)** + + | + +
+
+ **Required (exactly 1)** + + |
+
+ + + **The output's value commitment** + + | + +
|
+
+ → → → `n` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The output index number of this output within this transaction + + | + +
|
+
+ → → → `scriptPubKey` + + |
+
+ + + object + + | + +
+
+ Required (exactly 1) + + |
+
+ + + An object describing the pubkey script + + | + +
|
+
+ → → → → `asm` + + |
+
+ + + string + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The pubkey script in decoded form with non-data-pushing opcodes listed + + | + +
|
+
+ → → → → `hex` + + |
+
+ + + string (hex) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The pubkey script, encoded as hex + + | + +
|
+
+ → → → → `reqSigs` + + |
+
+ + + number (int) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The number of signatures required; this is always `1` for P2PK, P2PKH, and P2SH (including P2SH multisig because the redeem script is not available in the pubkey script). It may be greater than 1 for bare multisig. This value will not be returned for `nulldata` or `nonstandard` script types (see the `type` key below) + + | + +
|
+
+ → → → → `type` + + |
+
+ + + string + + | + +
+
+ Optional (0 or 1) + + |
+
+
+
+ The type of script. This will be one of the following: `pubkey` for a P2PK script `pubkeyhash` for a P2PKH script `scripthash` for a P2SH script `multisig` for a bare multisig script `nulldata` for nulldata scripts `nonstandard` for unknown scripts + + |
+
+
|
+
+ → → → → `addresses` + + |
+
+ + + string : array + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The P2PKH or P2SH addresses used in this transaction, or the computed P2PKH address of any pubkeys in this transaction. This array will not be returned for `nulldata` or `nonstandard` script types + + | + +
|
+
+ → → → → → Address + + |
+
+ + + string + + | + +
+
+ Required (1 or more) + + |
+
+ + + A P2PKH or P2SH address + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| asset | +string | +Required (exactly 1) |
+ The hexadecimal asset identifier or the asset's label | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| amount | ++ + [value amount][] + + | +Required (exactly 1) |
+ The amount to be destroyed in its normal denomination, which is + 100 millions greater than the minimum unit. For example, Bitcoin's + normal unit is a bitcoin and its minimum unit is 0.00000001 bitcoins | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| comment | +string | +Optional (0 or 1) |
+ A comment to associate with this transaction in your + wallet. This is only part of your wallet; it does not become part of + the transaction | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | +string (hex) | +Required (exactly 1) |
+ The transaction identifier | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | +object | +Required (exactly 1) |
+ The results of the dump. | +
| → label |
+ string : string (hex) | +Optional (0 or more) |
+ The asset label in Unicode paired with the asset identifier + in hex | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| address | +string (base58) | +Required (exactly 1) |
+ The public CT address corresponding to the private blinding key to retrun. | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| key | +string (hex) | +Required (exactly 1) |
+ The private blinding key | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| txid | +string (hex) | +Required (exactly 1) |
+ The txid of the issuance transaction | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| vin | +number (int) | +Required (exactly 1) |
+ + + Within the asset issuance transaction, this is the + input index number (vin), with the first input being `0` + + | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| key | +string (hex) | +Required (exactly 1) |
+ The private blinding key | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Account + + | + ++ + string + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The name of an account to get the balance for. An empty string ("") is the default account. The string `*` will get the balance for all accounts (this is the default behavior) + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Confirmations + + | + ++ + number (int) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The minimum number of confirmations an externally-generated transaction must have before it is counted towards the balance. Transactions generated by this node are counted immediately. Typically, externally-generated transactions are payments to this wallet and transactions generated by this node are payments to other wallets. Use `0` to count unconfirmed transactions. Default is `1` + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Include Watch-Only + + | + ++ + bool + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + If set to `true`, include watch-only addresses in details and calculations as if they were regular addresses belonging to the wallet. If set to `false` (the default), treat watch-only addresses as if they didn't belong to this wallet + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + **Asset identifier** + + | + ++ + **string** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **The asset identifier or label of the asset to return. If this is used, the account argument is ignored. Note that this also changes the output from a JSON object to a number** + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + **`result`** + + | + ++ + **object** + + | + +
+
+ **Required (exactly 1)** + + |
+
+ + + **An object holding pairs of asset ids and balance amounts** + + | + +
|
+
+ **→ amount** + + |
+
+ + + **string : [value amount][]** + + | + +
+
+ **Required (1 or more)** + + |
+
+ + + **An asset identifier or label paired with the balance of that asset. At a minimum, the `bitcoin` asset will be returned** + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | + ++ + number ([value amount][]) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + **The balance of all accounts in the requested asset** + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | +string (hex) | +Required (exactly 1) |
+ A hex-encoded serialized block ready to be added to the + block chain. It will contain any transactions in the local node's + memory pool | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| account | +string | +Optional (0 or 1) |
+ + + An account into which the sidechain address should + be placed. If no account is provided, the default account (`""`) is + used. + + | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | +object | +Required (exactly 1) |
+ An object containing the mainchain and sidechain addresses | +
|
+
+ → `mainchain_address` + + |
+ string (base58) | +Required (exactly 1) |
+ The address to pay on the mainchain | +
|
+
+ → `sidechain_address` + + |
+ string (base58) | +Required (exactly 1) |
+ + + The address on the sidechain which will receive the funds sent by `claimpegin` + + | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + TXID + + | + ++ + string (hex) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The TXID of the transaction to get, encoded as hex in RPC byte order + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Format + + | + ++ + bool + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + Set to `false` (the default) to return the serialized transaction as hex. Set to `true` to return a decoded transaction as a JSON object. Before 0.14.0, use `0` and `1`, respectively + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | + ++ + null + + | + +
+
+ Required (exactly 1) + + |
+
+ + + If the transaction wasn't found, the result will be JSON `null`. This can occur because the transaction doesn't exist in the block chain or memory pool, or because it isn't part of the transaction index. See the Bitcoin Core `-help` entry for `-txindex` + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | + ++ + string (hex) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + If the transaction was found, this will be the serialized transaction, encoded as hex + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | + ++ + object + + | + +
+
+ Required (exactly 1) + + |
+
+ + + If the transaction was found, this will be an object describing it + + | + +
|
+
+ → `hex` + + |
+
+ + + string (hex) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The serialized, hex-encoded data for the provided `txid` + + | + +
|
+
+ → `txid` + + |
+
+ + + string (hex) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The transaction's TXID, encoded as hex in RPC byte order + + | + +
|
+
+ → `hash` + + |
+
+ + + string (hex) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The transaction hash. Differs from txid for witness transactions + + | + +
|
+
+ ** → `withash`** + + |
+
+ + + **string (hex)** + + | + +
+
+ **Required (exactly 1)** + + |
+
+ + + **The witness hash. May be the same as `hash`** + + | + +
|
+
+ → `size` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The serialized transaction size + + | + +
|
+
+ → `vsize` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The virtual transaction size. Differs from size for witness transactions + + | + +
|
+
+ → `version` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The transaction format version number + + | + +
|
+
+ → `locktime` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The transaction's locktime: either a Unix epoch date or block height + + | + +
|
+
+ → `vin` + + |
+
+ + + array + + | + +
+
+ Required (exactly 1) + + |
+
+ + + An array of objects with each object being an input vector (vin) for this transaction. Input objects will have the same order within the array as they have in the transaction, so the first input listed will be input 0 + + | + +
|
+
+ → → Input + + |
+
+ + + object + + | + +
+
+ Required (1 or more) + + |
+
+ + + An object describing one of this transaction's inputs. May be a regular input or a coinbase + + | + +
|
+
+ → → → `txid` + + |
+
+ + + string + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The TXID of the outpoint being spent, encoded as hex in RPC byte order. Not present if this is a coinbase transaction + + | + +
|
+
+ → → → `vout` + + |
+
+ + + number (int) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The output index number (vout) of the outpoint being spent. The first output in a transaction has an index of `0`. Not present if this is a coinbase transaction + + | + +
|
+
+ → → → `scriptSig` + + |
+
+ + + object + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + An object describing the signature script of this input. Not present if this is a coinbase transaction + + | + +
|
+
+ → → → → `asm` + + |
+
+ + + string + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The signature script in decoded form with non-data-pushing opcodes listed + + | + +
|
+
+ → → → → `hex` + + |
+
+ + + string (hex) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The signature script, encoded as hex + + | + +
|
+
+ → → → `sequence` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The input sequence number + + | + +
|
+
+ → → → `txinwitness` + + |
+
+ + + string : array + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + Hex-encoded witness data. Only for segregated witness transactions + + | + +
|
+
+ → `vout` + + |
+
+ + + array + + | + +
+
+ Required (exactly 1) + + |
+
+ + + An array of objects each describing an output vector (vout) for this transaction. Output objects will have the same order within the array as they have in the transaction, so the first output listed will be output 0 + + | + +
|
+
+ → → Output + + |
+
+ + + object + + | + +
+
+ Required (1 or more) + + |
+
+ + + An object describing one of this transaction's outputs + + | + +
|
+
+ → → → `value` + + |
+
+ + + number ([value amount][]) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The amount paid to this output. May be `0`. **Only returned for unblinded outputs** + + | + +
|
+
+ ** → → → `value-minimum`** + + |
+
+ + + **number ([value amount][])** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **The minimum amount paid in this output. Only returned for blinded outputs** + + | + +
|
+
+ ** → → → `value-maximum`** + + |
+
+ + + **number ([value amount][])** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **The maximum amount paid in this output. Only returned for blinded outputs** + + | + +
|
+
+ ** → → → `ct-exponent`** + + |
+
+ + + **number ([value amount][])** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **The exponent used in the blinded output** + + | + +
|
+
+ ** → → → `ct-bits`** + + |
+
+ + + **number (int)** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **The number of bits used in the blinded output** + + | + +
|
+
+ ** → → → `asset`** + + |
+
+ + + **string (hex)** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **The asset identifier, if the asset is unblinded** + + | + +
|
+
+ ** → → → `assetcommitment`** + + |
+
+ + + **string (hex)** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **The asset tag, if the asset is blinded** + + | + +
|
+
+ ** → → → `serValue`** + + |
+
+ + + **string (hex)** + + | + +
+
+ **Required (exactly 1)** + + |
+
+ + + **The output's value commitment** + + | + +
|
+
+ → → → `n` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The output index number of this output within this transaction + + | + +
|
+
+ → → → `scriptPubKey` + + |
+
+ + + object + + | + +
+
+ Required (exactly 1) + + |
+
+ + + An object describing the pubkey script + + | + +
|
+
+ → → → → `asm` + + |
+
+ + + string + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The pubkey script in decoded form with non-data-pushing opcodes listed + + | + +
|
+
+ → → → → `hex` + + |
+
+ + + string (hex) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The pubkey script, encoded as hex + + | + +
|
+
+ → → → → `reqSigs` + + |
+
+ + + number (int) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The number of signatures required; this is always `1` for P2PK, P2PKH, and P2SH (including P2SH multisig because the redeem script is not available in the pubkey script). It may be greater than 1 for bare multisig. This value will not be returned for `nulldata` or `nonstandard` script types (see the `type` key below) + + | + +
|
+
+ → → → → `type` + + |
+
+ + + string + + | + +
+
+ Optional (0 or 1) + + |
+
+
+
+ The type of script. This will be one of the following: `pubkey` for a P2PK script `pubkeyhash` for a P2PKH script `scripthash` for a P2SH script `multisig` for a bare multisig script `nulldata` for nulldata scripts `nonstandard` for unknown scripts + + |
+
+
|
+
+ → → → → `addresses` + + |
+
+ + + string : array + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The P2PKH or P2SH addresses used in this transaction, or the computed P2PKH address of any pubkeys in this transaction. This array will not be returned for `nulldata` or `nonstandard` script types + + | + +
|
+
+ → → → → → Address + + |
+
+ + + string + + | + +
+
+ Required (1 or more) + + |
+
+ + + A P2PKH or P2SH address + + | + +
|
+
+ → `blockhash` + + |
+
+ + + string (hex) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + If the transaction has been included in a block on the local best block chain, this is the hash of that block encoded as hex in RPC byte order + + | + +
|
+
+ → `confirmations` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + If the transaction has been included in a block on the local best block chain, this is how many confirmations it has. Otherwise, this is `0` + + | + +
|
+
+ → `time` + + |
+
+ + + number (int) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + If the transaction has been included in a block on the local best block chain, this is the block header time of that block (may be in the future) + + | + +
|
+
+ → `blocktime` + + |
+
+ + + number (int) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + This field is currently identical to the time field described above + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + TXID + + | + ++ + string (hex) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The TXID of the transaction to get details about. The TXID must be encoded as hex in RPC byte order + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Include Watch-Only + + | + ++ + bool + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + If set to `true`, include watch-only addresses in details and calculations as if they were regular addresses belonging to the wallet. If set to `false` (the default), treat watch-only addresses as if they didn't belong to this wallet + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + **Asset identifier** + + | + ++ + **string** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **An asset identifier or label to restrict the `amount` field in the results to that particular asset** + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | + ++ + object + + | + +
+
+ Required (exactly 1) + + |
+
+ + + An object describing how the transaction affects the wallet + + | + +
|
+
+ → `amount` + + |
+
+ + + **object or number** + + | + +
+
+ Required (exactly 1) + + |
+
+ + + **If parameter #3 is specified, this is a positive number if this transaction increased the total wallet balance of that asset; a negative number if this transaction decreased the total wallet balance of that asset, or `0` if the transaction had no net effect on wallet balance of that asset. If Parameter #3 was not specified, this is a JSON object containing pairs of asset names and balance change amounts as described in the previous sentence.** + + | + +
|
+
+ → `fee` + + |
+
+ + + number (bitcoins) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + If an outgoing transaction, this is the fee paid by the transaction, reported as negative bitcoins + + | + +
|
+
+ → `confirmations` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The number of confirmations the transaction has received. Will be `0` for unconfirmed and `-1` for conflicted + + | + +
|
+
+ → `generated` + + |
+
+ + + bool + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + Set to `true` if the transaction is a coinbase. Not returned for regular transactions + + | + +
|
+
+ → `blockhash` + + |
+
+ + + string (hex) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The hash of the block on the local best block chain that includes this transaction, encoded as hex in RPC byte order. Only returned for confirmed transactions + + | + +
|
+
+ → `blockindex` + + |
+
+ + + number (int) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The index of the transaction in the block that includes it. Only returned for confirmed transactions + + | + +
|
+
+ → `blocktime` + + |
+
+ + + number (int) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The block header time (Unix epoch time) of the block on the local best block chain that includes this transaction. Only returned for confirmed transactions + + | + +
|
+
+ → `txid` + + |
+
+ + + string (hex) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The TXID of the transaction, encoded as hex in RPC byte order + + | + +
|
+
+ → `walletconflicts` + + |
+
+ + + array + + | + +
+
+ Required (exactly 1) + + |
+
+ + + An array containing the TXIDs of other transactions that spend the same inputs (UTXOs) as this transaction. Array may be empty + + | + +
|
+
+ → → TXID + + |
+
+ + + string (hex) + + | + +
+
+ Optional (0 or more) + + |
+
+ + + The TXID of a conflicting transaction, encoded as hex in RPC byte order + + | + +
|
+
+ → `time` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + A Unix epoch time when the transaction was added to the wallet + + | + +
|
+
+ → `timereceived` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + A Unix epoch time when the transaction was detected by the local node, or the time of the block on the local best block chain that included the transaction + + | + +
|
+
+ → `bip125-replaceable` + + |
+
+ + + string + + | + +
+
+ Required (exactly 1) + + |
+
+
+
+ Indicates if a transaction is replaceable under BIP 125: `yes` is replaceable `no` not replaceable `unknown` for unconfirmed transactions not in the mempool + + |
+
+
|
+
+ → `comment` + + |
+
+ + + string + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + For transaction originating with this wallet, a locally-stored comment added to the transaction. Only returned if a comment was added + + | + +
|
+
+ → `to` + + |
+
+ + + string + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + For transaction originating with this wallet, a locally-stored comment added to the transaction identifying who the transaction was sent to. Only returned if a comment-to was added + + | + +
|
+
+ → `details` + + |
+
+ + + array + + | + +
+
+ Required (exactly 1) + + |
+
+ + + An array containing one object for each input or output in the transaction that affected the wallet + + | + +
|
+
+ → → `involvesWatchonly` + + |
+
+ + + bool + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + Set to `true` if the input or output involves a watch-only address. Otherwise not returned + + | + +
|
+
+ → → `account` + + |
+
+ + + string + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The account which the payment was credited to or debited from. May be an empty string ("") for the default account + + | + +
|
+
+ → → `address` + + |
+
+ + + string (base58) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + If an output, the address paid (may be someone else's address not belonging to this wallet). If an input, the address paid in the previous output. May be empty if the address is unknown, such as when paying to a non-standard pubkey script + + | + +
|
+
+ → → `category` + + |
+
+ + + string + + | + +
+
+ Required (exactly 1) + + |
+
+
+
+ Set to one of the following values: `send` if sending payment `receive` if this wallet received payment in a regular transaction `generate` if a matured and spendable coinbase `immature` if a coinbase that is not spendable yet `orphan` if a coinbase from a block that's not in the local best block chain + + |
+
+
|
+
+ → → `amount` + + |
+
+ + + number ([value amount][]) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + A negative amount if sending payment; a positive amount if receiving payment (including coinbases) + + | + +
|
+
+ **→ → `amountblinder`** + + |
+
+ + + **string (hex)** + + | + +
+
+ **Required (exactly 1)** + + |
+
+ + + **The amount blinding factor. May be 32-byte zero** + + | + +
|
+
+ **→ → `asset`** + + |
+
+ + + **string (hex)** + + | + +
+
+ **Required (exactly 1)** + + |
+
+ + + **The hexadecimal asset identifier or the asset's label** + + | + +
|
+
+ **→ → `assetblinder`** + + |
+
+ + + **string (hex)** + + | + +
+
+ **Required (exactly 1)** + + |
+
+ + + **The asset blinders that prevent outside parties from discovering which assets each input spends** + + | + +
|
+
+ → → `vout` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + For an output, the output index (vout) for this output in this transaction. For an input, the output index for the output being spent in its transaction. Because inputs list the output indexes from previous transactions, more than one entry in the details array may have the same output index + + | + +
|
+
+ → → `fee` + + |
+
+ + + number (bitcoins) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + If sending payment, the fee paid as a negative bitcoins value. May be `0`. Not returned if receiving payment + + | + +
|
+
+ → → `abandoned` + + |
+
+ + + bool + + | + +
+
+ Optional (0 or 1) + + |
+
+
+
+ Indicates if a transaction was abandoned: `true` if it was abandoned (inputs are respendable) `false` if it was not abandoned Only returned by *send* category payments + + |
+
+
|
+
+ → `hex` + + |
+
+ + + string (hex) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The transaction in serialized transaction format + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + **Asset identifier** + + | + ++ + **string** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **An asset identifier or label to restrict the `amount` field in the results to that particular asset** + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + **`result`** + + | + ++ + **object** + + | + +
+
+ **Required (exactly 1)** + + |
+
+ + + **An object holding pairs of asset ids and balance amounts** + + | + +
|
+
+ **→ amount** + + |
+
+ + + **string : [value amount][]** + + | + +
+
+ **Required (1 or more)** + + |
+
+ + + **An asset identifier or label paired with the balance of that asset. At a minimum, the `bitcoin` asset will be returned** + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | + ++ + number ([value amount][]) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + **The balance of all accounts in the requested asset** + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + **Asset identifier** + + | + ++ + **string** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **An asset identifier or label to restrict the `amount` field in the results to that particular asset** + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | + ++ + object + + | + +
+
+ Required (exactly 1) + + |
+
+ + + An object describing the wallet + + | + +
|
+
+ → `walletversion` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The version number of the wallet + + | + +
|
+
+ → `balance` + + |
+
+ + + **number or object** + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The balance of the wallet. **The same as returned by the `getbalance` RPC with the provided parameter** + + | + +
|
+
+ → `unconfirmed_balance` + + |
+
+ + + **number or object** + + | + +
+
+ Required (exactly 1) + + |
+
+ + + **The unconfirmed balance of the wallet. The same as returned by the `getunconfirmedbalance` RPC with the provided parameter** + + | + +
|
+
+ → `immature_balance` + + |
+
+ + + number or object + + | + +
+
+ Optional (exactly 1) + + |
+
+ + + **The balance of the wallet in coins that need more confirmation. Uses the same rules as the `getbalance` RPC with the provided parameter. Only returned if there's an immature balance** + + | + +
|
+
+ → `txcount` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The total number of transactions in the wallet (both spends and receives) + + | + +
|
+
+ → `keypoololdest` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The date as Unix epoch time when the oldest key in the wallet key pool was created; useful for only scanning blocks created since this date for transactions + + | + +
|
+
+ → `keypoolsize` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The number of keys in the wallet keypool + + | + +
|
+
+ → `unlocked_until` + + |
+
+ + + number (int) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + Only returned if the wallet was encrypted with the `encryptwallet` RPC. A Unix epoch date when the wallet will be locked, or `0` if the wallet is currently locked + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| address | +string (base58) | +Required (exactly 1) |
+ + + The address to which the private blinding key + belongs. This is sometimes referred to as the `confidential_key` + + | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| hexkey | +string (hex) | +Required (exactly 1) |
+ The blinding key in hexadecimal | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| txid | +string (hex) | +Required (exactly 1) |
+ The txid of the asset issuance. The issuance + transaction must be in the wallet | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| vin | +number (int) | +Required (exactly 1) |
+ + + Within the asset issuance transaction, this is the + input index number (vin), with the first input being `0` + + | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| hexkey | +string (hex) | +Required (exactly 1) |
+ The blinding key in hexadecimal | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| assetamount | ++ + [value amount][] + + | +Required (exactly 1) |
+ The amount of the asset to generate. Each unit of + this asset will be sub-divisible into 100 million parts just as each + bitcoin is subdivisible into 100 million base units | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| tokenamount | ++ + [value amount][] + + | +Required (exactly 1) |
+ + + The amount of [reissuance token][] to generate. May + be 0 to generate no token (preventing reissuance) or any value equal + to or above 0.00000001 to allow someone with a reissuance token to + reissue the asset. No token amount is consumed during the reissuance, so + you may use any arbitrary value above 0 to allow reissuance + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| blind | +bool | +Optional (0 or 1) |
+ Whether to blind the issuance amount. Default is true | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | +object | +Required (exactly 1) |
+ The results of the issuance | +
|
+
+ → `txid` + + |
+ string (hex) | +Required (exactly 1) |
+ The txid of the issuance | +
|
+
+ → `vin` + + |
+ number (int) | +Required (exactly 1) |
+ + + Within the asset issuance transaction, this is the + input index number (vin), with the first input being `0` + + | +
|
+
+ → `entropy` + + |
+ string (hex) | +Required (exactly 1) |
+ + + The [entropy][] value + + | +
|
+
+ → `asset` + + |
+ string (hex) | +Required (exactly 1) |
+ The asset type | +
|
+
+ → `token` + + |
+ string (hex) | +Required (exactly 1) |
+ + + The [reissuance token][] value + + | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| asset | +string | +Optional (0 or 1) |
+ The hex id of the asset you want to list | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | +array | +Required (exactly 1) |
+ An array containing JSON objects that describe each + asset issuance. The array may be empty if the wallet doesn't know of + any asset issuances, or if none of the issuances match the asset + searched for | +
| → issuance |
+ object | +Optional (0 or more) |
+ An object containing details about a particular + asset issuance or reissuance. | +
|
+
+ → → `isreissuance` + + |
+ bool | +Required (exactly 1) |
+ True if this is a reissuance; false if this is an original + issuance. | +
|
+
+ → → `token` + + |
+ string (hex) | +Optional (0 or 1) |
+ + + The identifier for the [reissuance token][] that allows issuing + more of the asset. Returned even if the token amount is 0 + (forbidding reissuance), but not returned for reissuances (to reissue, + use the token from the original issuance) + + | +
|
+
+ → → `tokenamount` + + |
+ + + number ([value amount][]) + + | +Optional (0 or 1) |
+ The number of reissuance tokens created when the + asset was first issued, or -1 if the number of tokens is unknown to + the wallet. Not returned for reissuances | +
|
+
+ → → `tokenblinds` + + |
+ string (hex) | +Optional (0 or 1) |
+ The blinding factor used for the reissuance tokens Set to 32-byte zero if the reissuance token amount is 0 | +
|
+
+ → → `entropy` + + |
+ string (hex) | +Required (exactly 1) |
+ + + The [entropy][] value + + | +
|
+
+ → → `txid` + + |
+ string (hex) | +Required (exactly 1) |
+ The txid of the issuance or reissuance | +
|
+
+ → → `vin` + + |
+ number (int) | +Required (exactly 1) |
+ + + Within the asset issuance transaction, this is the + input index number (vin), with the first input being `0` + + | +
|
+
+ → → `asset` + + |
+ string (hex) | +Required (exactly 1) |
+ The asset's hex identifier | +
|
+
+ → → `assetlabel` + + |
+ string | +Optional (0 or 1) |
+ The asset's label, if known. Otherwise not returned | +
|
+
+ → → `assetamount` + + |
+ + + number ([value amount][]) + + | +Required (exactly 1) |
+ + + The amount of the asset issued or reissued. Set to `-1` if the + amount was blinded and is unknown to the wallet + + | +
|
+
+ → → `assetblinds` + + |
+ string (hex) | +Required (exactly 1) |
+ The blinding factor used for the issued or reissued asset. | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Account + + | + ++ + string + + | + +
+
+ Optional (0 or 1) + + |
+
+
+
+ *Deprecated: will be removed in a later version of Bitcoin Core* The name of an account to get transactions from. Use an empty string ("") to get transactions for the default account. Default is `*` to get transactions for all accounts. + + |
+
+
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Count + + | + ++ + number (int) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The number of the most recent transactions to list. Default is `10` + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Skip + + | + ++ + number (int) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The number of the most recent transactions which should not be returned. Allows for pagination of results. Default is `0` + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Include Watch-Only + + | + ++ + bool + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + If set to `true`, include watch-only addresses in details and calculations as if they were regular addresses belonging to the wallet. If set to `false` (the default), treat watch-only addresses as if they didn't belong to this wallet + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | + ++ + array + + | + +
+
+ Required (exactly 1) + + |
+
+ + + An array containing objects, with each object describing a **payment** or internal accounting entry (not a transaction). More than one object in this array may come from a single transaction. Array may be empty + + | + +
|
+
+ → Payment + + |
+
+ + + object + + | + +
+
+ Optional (0 or more) + + |
+
+ + + A payment or internal accounting entry + + | + +
|
+
+ → → `account` + + |
+
+ + + string + + | + +
+
+ Required (exactly 1) + + |
+
+
+
+ *Deprecated: will be removed in a later version of Bitcoin Core* The account which the payment was credited to or debited from. May be an empty string ("") for the default account + + |
+
+
|
+
+ → → `address` + + |
+
+ + + string (base58) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The address paid in this payment, which may be someone else's address not belonging to this wallet. May be empty if the address is unknown, such as when paying to a non-standard pubkey script or if this is in the *move* category + + | + +
|
+
+ → → `category` + + |
+
+ + + string + + | + +
+
+ Required (exactly 1) + + |
+
+
+
+ Set to one of the following values: `send` if sending payment `receive` if this wallet received payment in a regular transaction `generate` if a matured and spendable coinbase `immature` if a coinbase that is not spendable yet `orphan` if a coinbase from a block that's not in the local best block chain `move` if an off-block-chain move made with the `move` RPC + + |
+
+
|
+
+ → → `amount` + + |
+
+ + + number ([value amount][]) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + A negative amount if sending payment; a positive amount if receiving payment (including coinbases) + + | + +
|
+
+ **→ → amountblinder** + + |
+
+ + + **string (hex)** + + | + +
+
+ **Required (exactly 1)** + + |
+
+ + + **The amount blinding factor. May be 32-byte zero** + + | + +
|
+
+ **→ → asset** + + |
+
+ + + **string** + + | + +
+
+ **Required (exactly 1)** + + |
+
+ + + **The hexadecimal asset identifier or the asset's label** + + | + +
|
+
+ **→ → assetblinder** + + |
+
+ + + **string (hex)** + + | + +
+
+ **Required (exactly 1)** + + |
+
+ + + **The asset blinders that prevent outside parties from discovering which assets each input spends** + + | + +
|
+
+ → → `label` + + |
+
+ + + string + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + A comment for the address/transaction + + | + +
|
+
+ → → `vout` + + |
+
+ + + number (int) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + For an output, the output index (vout) for this output in this transaction. For an input, the output index for the output being spent in its transaction. Because inputs list the output indexes from previous transactions, more than one entry in the details array may have the same output index. Not returned for *move* category payments + + | + +
|
+
+ → → `fee` + + |
+
+ + + number (bitcoins) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + If sending payment, the fee paid as a negative bitcoins value. May be `0`. Not returned if receiving payment or for *move* category payments + + | + +
|
+
+ → → `confirmations` + + |
+
+ + + number (int) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The number of confirmations the transaction has received. Will be `0` for unconfirmed and `-1` for conflicted. Not returned for *move* category payments + + | + +
|
+
+ → → `trusted` + + |
+
+ + + bool + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + Indicates whether we consider the outputs of this unconfirmed transaction safe to spend. Only returned for unconfirmed transactions + + | + +
|
+
+ → → `generated` + + |
+
+ + + bool + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + Set to `true` if the transaction is a coinbase. Not returned for regular transactions or *move* category payments + + | + +
|
+
+ → → `blockhash` + + |
+
+ + + string (hex) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The hash of the block on the local best block chain that includes this transaction, encoded as hex in RPC byte order. Only returned for confirmed transactions + + | + +
|
+
+ → → `blockindex` + + |
+
+ + + number (int) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The index of the transaction in the block that includes it. Only returned for confirmed transactions + + | + +
|
+
+ → → `blocktime` + + |
+
+ + + number (int) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The block header time (Unix epoch time) of the block on the local best block chain that includes this transaction. Only returned for confirmed transactions + + | + +
|
+
+ → → `txid` + + |
+
+ + + string (hex) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The TXID of the transaction, encoded as hex in RPC byte order. Not returned for *move* category payments + + | + +
|
+
+ → → `walletconflicts` + + |
+
+ + + array + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + An array containing the TXIDs of other transactions that spend the same inputs (UTXOs) as this transaction. Array may be empty. Not returned for *move* category payments + + | + +
|
+
+ → → → TXID + + |
+
+ + + string (hex) + + | + +
+
+ Optional (0 or more) + + |
+
+ + + The TXID of a conflicting transaction, encoded as hex in RPC byte order + + | + +
|
+
+ → → `time` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + A Unix epoch time when the transaction was added to the wallet + + | + +
|
+
+ → → `timereceived` + + |
+
+ + + number (int) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + A Unix epoch time when the transaction was detected by the local node, or the time of the block on the local best block chain that included the transaction. Not returned for *move* category payments + + | + +
|
+
+ → → `comment` + + |
+
+ + + string + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + For transaction originating with this wallet, a locally-stored comment added to the transaction. Only returned in regular payments if a comment was added. Always returned in *move* category payments. May be an empty string + + | + +
|
+
+ → → `to` + + |
+
+ + + string + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + For transaction originating with this wallet, a locally-stored comment added to the transaction identifying who the transaction was sent to. Only returned if a comment-to was added. Never returned by *move* category payments. May be an empty string + + | + +
|
+
+ → → `otheraccount` + + |
+
+ + + string + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + This is the account the value were moved from or moved to, as indicated by a negative or positive *amount* field in this payment. Only returned by *move* category payments + + | + +
|
+
+ → → `bip125-replaceable` + + |
+
+ + + string + + | + +
+
+ Required (exactly 1) + + |
+
+
+
+ Indicates if a transaction is replaceable under BIP125: `yes` replaceable `no` not replaceable `unknown` for unconfirmed transactions not in the mempool + + |
+
+
|
+
+ → → `abandoned` + + |
+
+ + + bool + + | + +
+
+ Optional (0 or 1) + + |
+
+
+
+ Indicates if a transaction is was abandoned: `true` if it was abandoned (inputs are respendable) `false` if it was not abandoned Only returned by *send* category payments + + |
+
+
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Minimum Confirmations + + | + ++ + number (int) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The minimum number of confirmations the transaction containing an output must have in order to be returned. Use `0` to return outputs from unconfirmed transactions. Default is `1` + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Maximum Confirmations + + | + ++ + number (int) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The maximum number of confirmations the transaction containing an output may have in order to be returned. Default is `9999999` (~10 million) + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Addresses + + | + ++ + array + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + If present, only outputs which pay an address in this array will be returned. To return everything, pass an empty array: `[]` + + | + +
|
+
+ → Address + + |
+
+ + + string (base58) + + | + +
+
+ Required (1 or more) + + |
+
+ + + A P2PKH or P2SH address + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Include unsafe + + | + ++ + boolean + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + If true, Include outputs that are not safe to spend, because they come from unconfirmed untrusted transactions or unconfirmed replacement transactions (cases where we are less sure that a conflictingtransaction won't be mined). + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + **Asset identifier** + + | + ++ + **string** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **An asset identifier or label to only return entries for that asset. The default is blank which lists all assets** + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | + ++ + array + + | + +
+
+ Required (exactly 1) + + |
+
+ + + An array of objects each describing an unspent output. May be empty + + | + +
|
+
+ → Unspent Output + + |
+
+ + + object + + | + +
+
+ Optional (0 or more) + + |
+
+ + + An object describing a particular unspent output belonging to this wallet + + | + +
|
+
+ → → `txid` + + |
+
+ + + string (hex) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The TXID of the transaction containing the output, encoded as hex in RPC byte order + + | + +
|
+
+ → → `vout` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The output index number (vout) of the output within its containing transaction + + | + +
|
+
+ → → `address` + + |
+
+ + + string (base58) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The P2PKH or P2SH address the output paid. Only returned for P2PKH or P2SH output scripts + + | + +
|
+
+ → → `account` + + |
+
+ + + string + + | + +
+
+ Optional (0 or 1) + + |
+
+
+
+ *Deprecated: will be removed in a later version of Bitcoin Core* If the address returned belongs to an account, this is the account. Otherwise not returned + + |
+
+
|
+
+ → → `scriptPubKey` + + |
+
+ + + string (hex) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The output script paid, encoded as hex + + | + +
|
+
+ → → `redeemScript` + + |
+
+ + + string (hex) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + If the output is a P2SH whose script belongs to this wallet, this is the redeem script + + | + +
|
+
+ → → `amount` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The amount paid to the output + + | + +
|
+
+ **→ → `asset`** + + |
+
+ + + **string (hex)** + + | + +
+
+ **Required (exactly 1)** + + |
+
+ + + **The asset identifier in hex** + + | + +
|
+
+ **→ → `assetcommitment`** + + |
+
+ + + **string (hex)** + + | + +
+
+ **Optional (1 or more)** + + |
+
+ + + **A hex-encoded asset commitment, one for each input.** + + | + +
|
+
+ **→ → `assetlabel`** + + |
+
+ + + **string (hex)** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **The asset label, if known. Otherwise not returned** + + | + +
|
+
+ → → `confirmations` + + |
+
+ + + number (int) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The number of confirmations received for the transaction containing this output + + | + +
|
+
+ → → `spendable` + + |
+
+ + + bool + + | + +
+
+ Required (exactly 1) + + |
+
+ + + Set to `true` if the private key or keys needed to spend this output are part of the wallet. Set to `false` if not (such as for watch-only addresses) + + | + +
|
+
+ → → `solvable` + + |
+
+ + + bool + + | + +
+
+ Required (exactly 1) + + |
+
+ + + Set to `true` if the wallet knows how to spend this output. Set to `false` if the wallet does not know how to spend the output. It is ignored if the private keys are available + + | + +
|
+
+ **→ → → `serValue`** + + |
+
+ + + **string (hex)** + + | + +
+
+ **Required (exactly 1)** + + |
+
+ + + **The output's value commitment** + + | + +
|
+
+ **→ → `blinder`** + + |
+
+ + + **string (hex)** + + | + +
+
+ **Required (0 or 1)** + + |
+
+ + + **The output's value blinding factor. May be 32-byte zero if there's no blinding factor** + + | + +
|
+
+ **→ → `assetblinder`** + + |
+
+ + + **string (hex)** + + | + +
+
+ **Required (0 or 1)** + + |
+
+ + + **The output's asset blinding factor. May be 32-byte zero if there's no blinding factor** + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| Transaction | +string (hex) | +Required (exactly 1) |
+ + + The hex-encoded serialized transaction whose outputs + should be blinded. The output keys to be used can be specified by + using a confidential address in the `createrawtransaction` RPC. The + transaction must not already have blinded outputs + + | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| Input Blinders | +array | +Required (exactly 1) |
+ An array containing the input blinders to use as + strings. | +
| → Blinder |
+ string (hex) | +Required (1 or more) |
+ + + The input's blinding factor. There must be one for each input + and they must appear in the same order as the inputs. The blinding + factor is the `blinder` field returned by the `listunspent` RPC + + | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| Input amounts | +array | +Required (exactly 1) |
+ + + An array containing the amount of each input to use as a [value + amount][]. + + | +
| → amount |
+ + + number ([value amount][]) + + | +Required (1 or more) |
+ The amount of the input at the same index as this field. | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| Asset Identifiers | +array | +Required (exactly 1) |
+ An array containing the input asset identifiers as + strings | +
| → Asset id |
+ string (hex) | +Required (0 or more) |
+ + + An asset identifier (hex, not a label). There must + be one for each input and they must appear in the same order as the + inputs. The identifier is the `asset` field returned by the + `listunspent` RPC + + | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| Asset Blinders | +array | +Required (exactly 1) |
+ An array containing the asset blinders that prevent + outside parties from discovering which assets each input spends | +
| → asset blind |
+ string (hex) | +Required (0 or more) |
+ An asset blind. There must be one for each input and they must appear in the same order as the inputs. | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| ignoreblindfail | +bool | +Optional (0 or 1) |
+ Whether to return a transaction (rather than fail) when any blinding attempt fails due to the number of blinded inputs or outputs | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | +string | +Required (exactly 1) |
+ + + The resulting unsigned raw transaction in serialized + transaction format, encoded as hex. If the transaction couldn't be + blinded, this will be set to JSON `null` and the JSON-RPC `error` + field may contain an error message. + + | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| Asset | +string (hex) | +Required (exactly 1) |
+ + + The asset identifier (in hex). You must have the + reissuance token in your wallet (check with the `listissuances` + RPC) + + | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| Amount | ++ + number ([value amount][]) + + | +Required (exactly 1) |
+ The amount of additional asset to generate | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | +object | +Required (exactly 1) |
+ An object containing the txid and vout of the reissuance output | +
|
+
+ → `txid` + + |
+
+ string (hex) | +Required (exactly 1) |
+ The txid of the transaction that issues the new value | +
|
+
+ → `vout` + + |
+
+ string (hex) | +Required (exactly 1) |
+ The output index (vout) of the reissuance from the transaction that issues the new value | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Transaction + + | + ++ + string (hex) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The serialized transaction to broadcast, encoded as hex + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Allow High Fees + + | + ++ + bool + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + Set to `true` to allow the transaction to pay a high transaction fee. Set to `false` (the default) to prevent Bitcoin Core from broadcasting the transaction if it includes a high fee. Transaction fees are the sum of the inputs minus the sum of the outputs, so this high fees check helps ensures user including a change address to return most of the difference back to themselves + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + **Allow blind fails** + + | + ++ + **bool** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **If `true`, the transaction will be broadcast even if not all outputs are blinded using CT. If `false` (the default), an error will be printed if any outputs are unblinded** + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | + ++ + null/string (hex) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + If the transaction was accepted by the node for broadcast, this will be the TXID of the transaction encoded as hex in RPC byte order. If the transaction was rejected by the node, this will set to `null`, the JSON-RPC error field will be set to a code, and the JSON-RPC message field may contain an informative error message + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + To Address + + | + ++ + string + + | + +
+
+ Required (exactly 1) + + |
+
+ + + A P2PKH or P2SH address to pay + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Amount + + | + ++ + number (**[value amount][]**) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The amount to spent + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Comment + + | + ++ + string + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + A locally-stored (not broadcast) comment assigned to this transaction. Default is no comment + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Comment To + + | + ++ + string + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + A locally-stored (not broadcast) comment assigned to this transaction. Meant to be used for describing who the payment was sent to. Default is no comment + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Subtract Fee From Amount + + | + ++ + boolean + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The fee will be deducted from the amount being sent. The recipient will receive less bitcoins than you enter in the amount field. Default is `false` + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + **Asset identifier** + + | + ++ + **string** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **The asset identifier or label of the asset to send. Defaults to `bitcoin`** + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + **Allow blind fails** + + | + ++ + **bool** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **If `true`, the transaction will be broadcast even if not all outputs are blinded using CT. If `false` (the default), an error will be printed if any outputs are unblinded** + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | + ++ + string + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The TXID of the sent transaction, encoded as hex in RPC byte order + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| Address | +string (base58) | +Required (exactly 1) |
+ The mainchain address to which the the bitcoins should + be sent. | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| Amount | +number (amount) | +Required (exactly 1) |
+ The amount of bitcoins to send to the mainchain address specified in the previous parameter | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| Subtract Fee From Amount | +boolean | +Optional (0 or 1) | +The fee will be deducted from the amount being sent. The recipient will receive less bitcoins than you enter in the amount field. Default is false |
+
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | +string (hex) | +Required (exactly 1) |
+ The txid of the sidechain transaction requesting + that functionaries spend the specified amount of bitcoins to the + specified mainchain address | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| Proposed block | +string (hex) | +Required (exactly 1) |
+ The hex-encoded serialized block to validate and + sign | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| Signature | +string (hex) | +Required (exactly 1) |
+ The hex-encoded signature for the block from this daemon. | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| Proposed block | +string (hex) | +Required (exactly 1) |
+ The hex-encoded serialized block to validate and + sign. | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | +null | +Required (exactly 1) |
+ + + A `null` if the block is either currently valid (has signatures) + or would be valid if signed. An + error if the block is not valid, is already part of the best block + chain, or does not extend the best block + chain. + + | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| Claim script | +string | +Required (exactly 1) |
+ Script to tweak the fedpegscript with. For example obtained as a result of getpeginaddress. | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | +object | +Required (exactly 1) |
+ An object containing the results of the + operation | +
|
+
+ → `script` + + |
+ string (hex) | +Required (exactly 1) |
+ The fedpegscript tweaked with claim_script | +
|
+
+ → `address` + + |
+ string | +Required (exactly 1) |
+ The address corresponding to the tweaked fedpegscript | +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + Address + + | + ++ + string (base58) + + | + +
+
+ Required (exactly 1) + + |
+
+ + + The P2PKH or P2SH address to validate, encoded in base58check format + + | + +
| Name | +Type | +Presence | +Description | +
|---|---|---|---|
| + + `result` + + | + ++ + object + + | + +
+
+ Required (exactly 1) + + |
+
+ + + Information about the address + + | + +
|
+
+ → `isvalid` + + |
+
+ + + bool + + | + +
+
+ Required (exactly 1) + + |
+
+ + + Set to `true` if the address is a valid P2PKH or P2SH address; set to `false` otherwise + + | + +
|
+
+ → `address` + + |
+
+ + + string (base58) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The address given as parameter + + | + +
|
+
+ → `scriptPubKey` + + |
+
+ + + string (hex) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The hex-encoded scriptPubKey generated by the address + + | + +
|
+
+ **→ `confidential_key`** + + |
+
+ + + **string (hex)** + + | + +
+
+ **Required (exactly 1)** + + |
+
+ + + **The confidentiality pubkey for the address. If there is none, this is an empty string** + + | + +
|
+
+ **→ `unconfidential`** + + |
+
+ + + **string (base58)** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **The non-confidential form of this address.** + + | + +
|
+
+ → `ismine` + + |
+
+ + + bool + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + Set to `true` if the address belongs to the wallet; set to false if it does not. Only returned if wallet support enabled + + | + +
|
+
+ → `iswatchonly` + + |
+
+ + + bool + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + Set to `true` if the address is watch-only. Otherwise set to `false`. Only returned if address is in the wallet + + | + +
|
+
+ **→ `confidential`** + + |
+
+ + + **string (base58)** + + | + +
+
+ **Optional (0 or 1)** + + |
+
+ + + **The confidential form of this address. Only returned if this is a local wallet key and you passed in the unconfidential form** + + | + +
|
+
+ → `isscript` + + |
+
+ + + bool + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + Set to `true` if a P2SH address; otherwise set to `false`. Only returned if the address is in the wallet + + | + +
|
+
+ → `script` + + |
+
+ + + string + + | + +
+
+ Optional (0 or 1) + + |
+
+
+
+ Only returned for P2SH addresses belonging to this wallet. This is the type of script: `pubkey` for a P2PK script inside P2SH `pubkeyhash` for a P2PKH script inside P2SH `multisig` for a multisig script inside P2SH `nonstandard` for unknown scripts + + |
+
+
|
+
+ → `hex` + + |
+
+ + + string (hex) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + Only returned for P2SH addresses belonging to this wallet. This is the redeem script encoded as hex + + | + +
|
+
+ → `addresses` + + |
+
+ + + array + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + Only returned for P2SH addresses belonging to the wallet. A P2PKH addresses used in this script, or the computed P2PKH addresses of any pubkeys in this script. This array will be empty for `nonstandard` script types + + | + +
|
+
+ → → Address + + |
+
+ + + string + + | + +
+
+ Optional (0 or more) + + |
+
+ + + A P2PKH address + + | + +
|
+
+ → `sigrequired` + + |
+
+ + + number (int) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + Only returned for multisig P2SH addresses belonging to the wallet. The number of signatures required by this script + + | + +
|
+
+ → `pubkey` + + |
+
+ + + string (hex) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The public key corresponding to this address. Only returned if the address is a P2PKH address in the wallet + + | + +
|
+
+ → `iscompressed` + + |
+
+ + + bool + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + Set to `true` if a compressed public key or set to `false` if an uncompressed public key. Only returned if the address is a P2PKH address in the wallet + + | + +
|
+
+ → `account` + + |
+
+ + + string + + | + +
+
+ Optional (0 or 1) + + |
+
+
+
+ *Deprecated: will be removed in a later version of Bitcoin Core* The account this address belong to. May be an empty string for the default account. Only returned if the address belongs to the wallet + + |
+
+
|
+
+ → `hdkeypath` + + |
+
+ + + string + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The HD keypath if the key is HD and available + + | + +
|
+
+ → `hdmasterkeyid` + + |
+
+ + + string (hash160) + + | + +
+
+ Optional (0 or 1) + + |
+
+ + + The Hash160 of the HD master public key + + | + +