"summary":"Create a transaction which issues a claim assigning a value to a name. The claim will be authoritative if the transaction amount is greater than the transaction amount of all other unspent transactions which issue a claim over the same name, and it will remain authoritative as long as it remains unspent and there are no other greater unspent transactions issuing a claim over the same name. The amount is a real and is rounded to the nearest 0.00000001",
"description":[],
"tags":[
"Claimtrie"
],
"params":{
"type":"object",
"properties":{
"name":{
"type":"string",
"description":"The name to be assigned the value."
},
"value":{
"type":"string",
"description":"The value to assign to the name encoded in hexadecimal."
},
"amount":{
"type":"number",
"description":"The amount in LBRYcrd to send. eg 0.1"
"description":"get the value associated with the name at the block specified by this block hash. If none is given, the latest active block will be used."
"description":"the value of the name, if it exists \"claimId\" (string) the claimId for this name claim \"txid\" (string) the hash of the transaction which successfully claimed the name \"n\" (numeric) vout value \"amount\" (numeric) txout amount \"effective amount\" (numeric) txout amount plus amount from all supports associated with the claim \"height\" (numeric) the height of the block in which this transaction is located \"name\" (string) the original name of this claim (before normalization)"
"summary":"Increase the value of a claim. Whichever claim has the greatest value, including all support values, will be the authoritative claim, according to the rest of the rules. The name is the name which is claimed by the claim that will be supported, the txid is the txid of the claim that will be supported, nout is the transaction output which contains the claim to be supported, and amount is the amount which will be added to the value of the claim. If the claim is currently the authoritative claim, this support will go into effect immediately . Otherwise, it will go into effect after 100 blocks. The support will be in effect until it is spent, and will lose its effect when the claim is spent or expires. The amount is a real and is rounded to the nearest .00000001",
"description":"The transaction id of the support."
}
},
"updateclaim":{
"summary":"Create a transaction which issues a claim assigning a value to a name, spending the previous txout which issued a claim over the same name and therefore superseding that claim. The claim will be authoritative if the transaction amount is greater than the transaction amount of all other unspent transactions which issue a claim over the same name, and it will remain authoritative as long as it remains unspent and there are no greater unspent transactions issuing a claim over the same name.",
"description":[],
"tags":[
"Claimtrie"
],
"params":{
"type":"object",
"properties":{
"txid":{
"type":"string",
"description":"The transaction containing the unspent txout which should be spent."
},
"value":{
"type":"string",
"description":"The value to assign to the name encoded in hexadecimal."
},
"amount":{
"type":"number",
"description":"The amount in LBRYcrd to use to bid for the name. eg 0.1"
"summary":"If verbosity is 0, returns a string that is serialized, hex-encoded data for block 'hash'. If verbosity is 1, returns an Object with information about block <hash>. If verbosity is 2, returns an Object with information about block <hash> and information about each transaction.",
"description":"A string that is serialized, hex-encoded data for block 'hash'. Result (for verbosity = 1): { \"hash\" : \"hash\", (string) the block hash (same as provided) \"confirmations\" : n, (numeric) The number of confirmations, or -1 if the block is not on the main chain \"size\" : n, (numeric) The block size \"strippedsize\" : n, (numeric) The block size excluding witness data \"weight\" : n (numeric) The block weight as defined in BIP 141 \"height\" : n, (numeric) The block height or index \"version\" : n, (numeric) The block version \"versionHex\" : \"00000000\", (string) The block version formatted in hexadecimal \"merkleroot\" : \"xxxx\", (string) The merkle root \"nameclaimroot\" : \"xxxx\", (string) The hash of the root of the name claim trie \"tx\" : [ (array of string) The transaction ids \"transactionid\" (string) The transaction id ,... ], \"time\" : ttt, (numeric) The block time in seconds since epoch (Jan 1 1970 GMT) \"mediantime\" : ttt, (numeric) The median block time in seconds since epoch (Jan 1 1970 GMT) \"nonce\" : n, (numeric) The nonce \"bits\" : \"1d00ffff\", (string) The bits \"difficulty\" : x.xxx, (numeric) The difficulty \"chainwork\" : \"xxxx\", (string) Expected number of hashes required to produce the chain up to this block (in hex) \"nTx\" : n, (numeric) The number of transactions in the block. \"previousblockhash\" : \"hash\", (string) The hash of the previous block \"nextblockhash\" : \"hash\" (string) The hash of the next block } Result (for verbosity = 2): { ..., Same output as verbosity = 1. \"tx\" : [ (array of Objects) The transactions in the format of the getrawtransaction RPC. Different from verbosity = 1 \"tx\" result. ,... ], ,... Same output as verbosity = 1. }"
"summary":"If verbose is false, returns a string that is serialized, hex-encoded data for blockheader 'hash'. If verbose is true, returns an Object with information about blockheader <hash>.",
"summary":"Compute per block statistics for a given window. All amounts are in satoshis. It won't work for some heights with pruning. It won't work without -txindex for utxo_size_inc, *fee or *feerate stats.",
"description":"Values to plot, by default all values (see result below)\n [\n \"height\", (string, optional) Selected statistic\n \"time\", (string, optional) Selected statistic\n ,...\n ]"
}
},
"required":[
"hash_or_height"
]
},
"result":{
"type":"object",
"properties":{
"avgfee":{
"type":"number",
"description":"Average fee in the block"
},
"avgfeerate":{
"type":"number",
"description":"Average feerate (in satoshis per virtual byte)"
"description":"virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted."
"description":"The transaction id of an in-mempool descendant transaction"
}
}
},
"properties":{
"transactionid":{
"type":"object",
"properties":{
"size":{
"type":"number",
"description":"virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted."
},
"fee":{
"type":"number",
"description":"transaction fee in LBC (DEPRECATED)"
},
"modifiedfee":{
"type":"number",
"description":"transaction fee with fee deltas used for mining priority (DEPRECATED)"
},
"time":{
"type":"number",
"description":"local time transaction entered pool in seconds since 1 Jan 1970 GMT"
},
"height":{
"type":"number",
"description":"block height when transaction entered pool"
},
"descendantcount":{
"type":"number",
"description":"number of in-mempool descendant transactions (including this one)"
},
"descendantsize":{
"type":"number",
"description":"virtual transaction size of in-mempool descendants (including this one)"
},
"descendantfees":{
"type":"number",
"description":"modified fees (see above) of in-mempool descendants (including this one) (DEPRECATED)"
},
"ancestorcount":{
"type":"number",
"description":"number of in-mempool ancestor transactions (including this one)"
},
"ancestorsize":{
"type":"number",
"description":"virtual transaction size of in-mempool ancestors (including this one)"
},
"ancestorfees":{
"type":"number",
"description":"modified fees (see above) of in-mempool ancestors (including this one) (DEPRECATED)"
},
"wtxid":{
"type":"string",
"description":"hash of serialized transaction, including witness data"
},
"fees":{
"type":"object",
"properties":{
"base":{
"type":"number",
"description":"transaction fee in LBC"
},
"modified":{
"type":"number",
"description":"transaction fee with fee deltas used for mining priority in LBC"
},
"ancestor":{
"type":"number",
"description":"modified fees (see above) of in-mempool ancestors (including this one) in LBC"
},
"descendant":{
"type":"number",
"description":"modified fees (see above) of in-mempool descendants (including this one) in LBC"
"description":"virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted."
},
"fee":{
"type":"number",
"description":"transaction fee in LBC (DEPRECATED)"
},
"modifiedfee":{
"type":"number",
"description":"transaction fee with fee deltas used for mining priority (DEPRECATED)"
},
"time":{
"type":"number",
"description":"local time transaction entered pool in seconds since 1 Jan 1970 GMT"
"summary":"Returns all transaction ids in memory pool as a json array of string transaction ids. Hint: use getmempoolentry to fetch a specific transaction from the mempool.",
"description":"virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted."
},
"fee":{
"type":"number",
"description":"transaction fee in LBC (DEPRECATED)"
},
"modifiedfee":{
"type":"number",
"description":"transaction fee with fee deltas used for mining priority (DEPRECATED)"
},
"time":{
"type":"number",
"description":"local time transaction entered pool in seconds since 1 Jan 1970 GMT"
},
"height":{
"type":"number",
"description":"block height when transaction entered pool"
},
"descendantcount":{
"type":"number",
"description":"number of in-mempool descendant transactions (including this one)"
},
"descendantsize":{
"type":"number",
"description":"virtual transaction size of in-mempool descendants (including this one)"
},
"descendantfees":{
"type":"number",
"description":"modified fees (see above) of in-mempool descendants (including this one) (DEPRECATED)"
},
"ancestorcount":{
"type":"number",
"description":"number of in-mempool ancestor transactions (including this one)"
},
"ancestorsize":{
"type":"number",
"description":"virtual transaction size of in-mempool ancestors (including this one)"
},
"ancestorfees":{
"type":"number",
"description":"modified fees (see above) of in-mempool ancestors (including this one) (DEPRECATED)"
},
"wtxid":{
"type":"string",
"description":"hash of serialized transaction, including witness data"
},
"fees":{
"type":"object",
"properties":{
"base":{
"type":"number",
"description":"transaction fee in LBC"
},
"modified":{
"type":"number",
"description":"transaction fee with fee deltas used for mining priority in LBC"
},
"ancestor":{
"type":"number",
"description":"modified fees (see above) of in-mempool ancestors (including this one) in LBC"
},
"descendant":{
"type":"number",
"description":"modified fees (see above) of in-mempool descendants (including this one) in LBC"
}
}
},
"depends":{
"type":"array",
"items":{
"type":"array"
}
},
"spentby":{
"type":"array",
"items":{
"type":"array"
}
}
}
}
}
}
},
"gettxout":{
"summary":"Returns details about an unspent transaction output.",
"summary":"Returns a hex-encoded proof that \"txid\" was included in a block. NOTE: By default this function only works sometimes. This is when there is an unspent output in the utxo for this transaction. To make it always work, you need to maintain a transaction index, using the -txindex command line option or specify the block in which the transaction is included manually (by blockhash).",
"summary":"Treats a block as if it were received before others with the same work. A later preciousblock call can override the effect of an earlier one. The effects of preciousblock are not retained across restarts.",
"description":"The block height to prune up to. May be set to a discrete height, or a unix timestamp to prune blocks whose block time is at least 2 hours older than the provided timestamp."
"summary":"EXPERIMENTAL warning: this call may be removed or changed in future releases. Scans the unspent transaction output set for entries that match certain output descriptors.",
"summary":"Verifies that a proof points to a transaction in a block, returning the transaction it commits to and throwing an RPC error if the block is not in our best chain",
"description":[],
"tags":[
"Blockchain"
],
"params":{
"type":"object",
"properties":{
"proof":{
"type":"string",
"description":"The hex-encoded proof generated by gettxoutproof"
}
},
"required":[
"proof"
]
}
},
"getmemoryinfo":{
"summary":"Returns an object containing information about memory usage.",
"description":"\"mode\" determines what kind of information is returned. This argument is optional, the default mode is \"stats\".\n - \"stats\" returns general statistics about memory usage in the daemon.\n - \"mallocinfo\" returns an XML string describing low-level heap state (only available if compiled with glibc 2.10+)."
"description":"Number of bytes available in current arenas"
},
"total":{
"type":"number",
"description":"Total number of bytes managed"
},
"locked":{
"type":"number",
"description":"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."
"summary":"Gets and sets the logging configuration. When called without an argument, returns the list of categories with status that are currently being debug logged or not. When called with arguments, adds or removes categories from debug logging and return the lists above. The arguments are evaluated in order \"include\", \"exclude\". If an item is both included and excluded, it will thus end up being excluded. The valid logging categories are: net, tor, mempool, http, bench, zmq, db, rpc, estimatefee, addrman, selectcoins, reindex, cmpctblock, rand, prune, proxy, mempoolrej, libevent, coindb, qt, leveldb In addition, the following are available as category names with special meanings: - \"all\", \"1\" : represent all logging categories. - \"none\", \"0\" : even if other logging categories are specified, ignore all of them.",
"summary":"If the request parameters include a 'mode' key, that is used to explicitly select between the default 'template' request or a 'proposal'. It returns data needed to construct a block to work on. For full specification, see BIPs 22, 23, 9, and 145: https://github.com/bitcoin/bips/blob/master/bip-0022.mediawiki https://github.com/bitcoin/bips/blob/master/bip-0023.mediawiki https://github.com/bitcoin/bips/blob/master/bip-0009.mediawiki#getblocktemplate_changes https://github.com/bitcoin/bips/blob/master/bip-0145.mediawiki",
"description":"hash encoded in little-endian hexadecimal (including witness data)"
},
"depends":{
"type":"array",
"items":{
"type":"array",
"properties":{
"n":{
"type":"number",
"description":"transactions before this one (by 1-based index in 'transactions' list) that must be present in the final block if this one is"
}
}
}
},
"fee":{
"type":"number",
"description":"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"
},
"sigops":{
"type":"number",
"description":"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"
},
"weight":{
"type":"number",
"description":"total transaction weight, as counted for purposes of block limits"
"description":"current network name as defined in BIP70 (main, test, regtest)"
},
"warnings":{
"type":"string",
"description":"any network and blockchain warnings"
}
}
}
},
"getnetworkhashps":{
"summary":"Returns the estimated network hashes per second based on the last n blocks. Pass in [blocks] to override # of blocks, -1 specifies since last difficulty change. Pass in [height] to estimate the network speed at the time when a certain block was found.",
"description":"API-Compatibility for previous API. Must be zero or null. DEPRECATED. For forward compatibility use named arguments and omit this parameter."
},
"fee_delta":{
"type":"number",
"description":"The fee value (in satoshis) to add (or subtract, if negative). Note, that this value is not a fee rate. It is a value to modify absolute fee of the TX. The fee is not actually paid, only the algorithm for selecting transactions into a block considers the transaction as it would have paid a higher (or lower) fee."
}
},
"required":[
"txid",
"fee_delta"
]
},
"result":{
"type":"boolean",
"description":"Returns true"
}
},
"submitblock":{
"summary":"Attempts to submit new block to network. See https://en.bitcoin.it/wiki/BIP_0022 for full specification.",
"description":"the hex-encoded block data to submit"
},
"dummy":{
"type":"optional",
"description":"dummy value, for compatibility with BIP"
},
"null":{
"type":"object",
"description":"This value is ignored."
}
},
"required":[
"hexdata",
null
]
}
},
"addnode":{
"summary":"Attempts to add or remove a node from the addnode list. Or try a connection to a node once. Nodes added using addnode (or -connect) are protected from DoS disconnection and are not required to be full nodes/support SegWit as other outbound peers are (though such peers will not be synced from).",
"summary":"Immediately disconnects from the specified peer node. Strictly one out of 'address' and 'nodeid' can be provided to identify the node. To disconnect by nodeid, either set 'address' to the empty string, or call using the named 'nodeid' argument only.",
"summary":"Requests that a ping be sent to all other nodes, to measure ping time. Results provided in getpeerinfo, pingtime and pingwait fields are decimal seconds. Ping command is handled in queue with all other commands, so it measures processing backlog, not just network ping.",
"description":"The IP/Subnet (see getpeerinfo for nodes IP) with an optional netmask (default is /32 = single IP)"
},
"command":{
"type":"string",
"description":"'add' to add an IP/Subnet to the list, 'remove' to remove an IP/Subnet from the list"
},
"bantime":{
"type":"number",
"description":"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)"
},
"absolute":{
"type":"boolean",
"description":"If set, the bantime must be an absolute timestamp in seconds since epoch (Jan 1 1970 GMT)"
}
},
"required":[
"subnet",
"command"
]
}
},
"setnetworkactive":{
"summary":"Disable/enable all p2p network activity.",
"description":[],
"tags":[
"Network"
],
"params":{
"type":"object",
"properties":{
"state":{
"type":"boolean",
"description":"true to enable networking, false to disable"
}
},
"required":[
"state"
]
}
},
"combinepsbt":{
"summary":"Combine multiple partially signed LBRY transactions into one transaction. Implements the Combiner role.",
"description":"A json array of base64 strings of partially signed transactions [ \"psbt\" (string) A base64 string of a PSBT ,... ]"
}
},
"required":[
"txs"
]
},
"result":{
"type":"string",
"description":"The base64-encoded partially signed transaction"
}
},
"combinerawtransaction":{
"summary":"Combine multiple partially signed transactions into one transaction. The combined transaction may be another partially signed transaction or a fully signed transaction.",
"description":"A json array of hex strings of partially signed transactions [ \"hexstring\" (string) A transaction hash ,... ]"
}
},
"required":[
"txs"
]
},
"result":{
"type":"string",
"description":"The hex-encoded raw transaction with signature(s)"
}
},
"converttopsbt":{
"summary":"Converts a network serialized transaction to a PSBT. This should be used only with createrawtransaction and fundrawtransaction createpsbt and walletcreatefundedpsbt should be used for new applications.",
"description":"The hex string of a raw transaction"
},
"permitsigdata":{
"type":"boolean",
"description":"If true, any signatures in the input will be discarded and conversion. will continue. If false, RPC will fail if any signatures are present.",
"default":false
},
"iswitness":{
"type":"boolean",
"description":"Whether the transaction hex is a serialized witness transaction. If iswitness is not present, heuristic tests will be used in decoding. If true, only witness deserializaion will be tried. If false, only non-witness deserialization wil be tried. Only has an effect if permitsigdata is true."
}
},
"required":[
"hexstring"
]
},
"result":{
"type":"string",
"description":"The resulting raw transaction (base64-encoded string)"
}
},
"createpsbt":{
"summary":"Creates a transaction in the Partially Signed Transaction format. Implements the Creator role.",
"description":"A json array of json objects\n [\n {\n \"txid\":\"id\", (string, required) The transaction id\n \"vout\":n, (numeric, required) The output number\n \"sequence\":n (numeric, optional) The sequence number\n } \n ,...\n ]"
},
"outputs":{
"type":"array",
"description":"a json array with outputs (key-value pairs), where none of the keys are duplicated.\nThat is, each address can only appear once and there can only be one 'data' object.\n [\n {\n \"address\": x.xxx, (obj, optional) A key-value pair. The key (string) is the lbry address, the value (float or string) is the amount in LBC\n },\n {\n \"data\": \"hex\" (obj, optional) A key-value pair. The key must be \"data\", the value is hex encoded data\n }\n ,... More key-value pairs of the above form. For compatibility reasons, a dictionary, which holds the key-value pairs directly, is also\n accepted as second parameter.\n ]"
},
"locktime":{
"type":"number",
"description":"Raw locktime. Non-0 value also locktime-activates inputs",
"default":0
},
"replaceable":{
"type":"boolean",
"description":"Marks this transaction as BIP125 replaceable. Allows this transaction to be replaced by a transaction with higher fees. If provided, it is an error if explicit sequence numbers are incompatible.",
"default":false
}
},
"required":[
"inputs",
"outputs"
]
},
"result":{
"type":"string",
"description":"The resulting raw transaction (base64-encoded string)"
}
},
"createrawtransaction":{
"summary":"Create a transaction spending the given inputs and creating new outputs. Outputs can be addresses or data. Returns hex-encoded raw transaction. Note that the transaction's inputs are not signed, and it is not stored in the wallet or transmitted to the network.",
"description":"A json array of json objects\n [\n {\n \"txid\":\"id\", (string, required) The transaction id\n \"vout\":n, (numeric, required) The output number\n \"sequence\":n (numeric, optional) The sequence number\n } \n ,...\n ]"
},
"outputs":{
"type":"array",
"description":"a json array with outputs (key-value pairs), where none of the keys are duplicated.\nThat is, each address can only appear once and there can only be one 'data' object.\n [\n {\n \"address\": x.xxx, (obj, optional) A key-value pair. The key (string) is the lbry address, the value (float or string) is the amount in LBC\n },\n {\n \"data\": \"hex\" (obj, optional) A key-value pair. The key must be \"data\", the value is hex encoded data\n }\n ,... More key-value pairs of the above form. For compatibility reasons, a dictionary, which holds the key-value pairs directly, is also\n accepted as second parameter.\n ]"
},
"locktime":{
"type":"number",
"description":"Raw locktime. Non-0 value also locktime-activates inputs",
"default":0
},
"replaceable":{
"type":"boolean",
"description":"Marks this transaction as BIP125 replaceable. Allows this transaction to be replaced by a transaction with higher fees. If provided, it is an error if explicit sequence numbers are incompatible.",
"default":false
}
},
"required":[
"inputs",
"outputs"
]
},
"result":{
"type":"string",
"description":"hex string of the transaction"
}
},
"decodepsbt":{
"summary":"Return a JSON object representing the serialized, base64-encoded partially signed LBRY transaction.",
"description":[
"",
"> lbrycrd-cli decodepsbt \"psbt\"",
""
],
"tags":[
"Rawtransactions"
],
"params":{
"type":"object",
"properties":{
"psbt":{
"type":"string",
"description":"The PSBT base64 string"
}
},
"required":[
"psbt"
]
},
"result":{
"type":"object",
"properties":{
"tx":{
"type":"object"
},
"unknown":{
"type":"object",
"properties":{
"key":{
"type":null,
"description":"An unknown key-value pair"
}
}
},
"inputs":{
"type":"array",
"items":{
"type":"object",
"properties":{
"non_witness_utxo":{
"type":"object"
},
"witness_utxo":{
"type":"object",
"properties":{
"amount":{
"type":"number",
"description":"The value in LBC"
},
"scriptPubKey":{
"type":"object",
"properties":{
"asm":{
"type":"string",
"description":"The asm"
},
"hex":{
"type":"string",
"description":"The hex"
},
"type":{
"type":"string",
"description":"The type, eg 'pubkeyhash'"
},
"address":{
"type":"string",
"description":"LBRY address if there is one"
}
}
}
}
},
"partial_signatures":{
"type":"object",
"properties":{
"pubkey":{
"type":"string",
"description":"The public key and signature that corresponds to it."
}
}
},
"sighash":{
"type":"string",
"description":"The sighash type to be used"
},
"redeem_script":{
"type":"object",
"properties":{
"asm":{
"type":"string",
"description":"The asm"
},
"hex":{
"type":"string",
"description":"The hex"
},
"type":{
"type":"string",
"description":"The type, eg 'pubkeyhash'"
}
}
},
"witness_script":{
"type":"object",
"properties":{
"asm":{
"type":"string",
"description":"The asm"
},
"hex":{
"type":"string",
"description":"The hex"
},
"type":{
"type":"string",
"description":"The type, eg 'pubkeyhash'"
}
}
},
"bip32_derivs":{
"type":"object",
"properties":{
"pubkey":{
"type":"object",
"properties":{
"master_fingerprint":{
"type":"string",
"description":"The fingerprint of the master key"
},
"path":{
"type":"string",
"description":"The path"
}
}
}
}
},
"final_scriptsig":{
"type":"object",
"properties":{
"asm":{
"type":"string",
"description":"The asm"
},
"hex":{
"type":"string",
"description":"The hex"
}
}
},
"unknown":{
"type":"object",
"properties":{
"key":{
"type":null,
"description":"An unknown key-value pair"
}
}
}
}
}
},
"outputs":{
"type":"array",
"items":{
"type":"object",
"properties":{
"key":{
"type":null,
"description":"An unknown key-value pair"
}
}
}
}
}
}
},
"decoderawtransaction":{
"summary":"Return a JSON object representing the serialized, hex-encoded transaction.",
"description":"address of P2SH script wrapping this redeem script (not returned if the script is already a P2SH)."
}
}
}
},
"finalizepsbt":{
"summary":"Finalize the inputs of a PSBT. If the transaction is fully signed, it will produce a network serialized transaction which can be broadcast with sendrawtransaction. Otherwise a PSBT will be created which has the final_scriptSig and final_scriptWitness fields filled for inputs that are complete. Implements the Finalizer and Extractor roles.",
"description":[
"",
"> lbrycrd-cli finalizepsbt \"psbt\"",
""
],
"tags":[
"Rawtransactions"
],
"params":{
"type":"object",
"properties":{
"psbt":{
"type":"string",
"description":"A base64 string of a PSBT"
},
"extract":{
"type":"boolean",
"description":"If true and the transaction is complete, extract and return the complete transaction in normal network serialization instead of the PSBT.",
"default":true
}
},
"required":[
"psbt"
]
},
"result":{
"type":"object",
"properties":{
"psbt":{
"type":"string",
"description":"The base64-encoded partially signed transaction if not extracted"
},
"hex":{
"type":"string",
"description":"The hex-encoded network transaction if extracted"
},
"complete":{
"type":"boolean",
"description":"If the transaction has a complete set of signatures"
}
}
}
},
"fundrawtransaction":{
"summary":"Add inputs to a transaction until it has enough in value to meet its out value. This will not modify existing inputs, and will add at most one change output to the outputs. No existing outputs will be modified unless \"subtractFeeFromOutputs\" is specified. Note that inputs which were signed may need to be resigned after completion since in/outputs have been added. The inputs added will not be signed, use signrawtransaction for that. Note that all existing inputs must have their previous output transaction be in the wallet. Note that all inputs selected must be of standard form and P2SH scripts must be in the wallet using importaddress or addmultisigaddress (to calculate fees). You can see whether this is the case by checking the \"solvable\" field in the listunspent output. Only pay-to-pubkey, multisig, and P2SH versions thereof are currently supported for watch-only",
"description":"The hex string of the raw transaction"
},
"options":{
"type":"object",
"properties":{
"changeAddress":{
"type":"string",
"description":"The bitcoin address to receive the change"
},
"changePosition":{
"type":"number",
"description":"The index of the change output"
},
"change_type":{
"type":"string",
"description":"The output type to use. Only valid if changeAddress is not specified. Options are \"legacy\", \"p2sh-segwit\", and \"bech32\". Default is set by -changetype."
},
"includeWatching":{
"type":"boolean",
"description":"Also select inputs which are watch only"
},
"lockUnspents":{
"type":"boolean",
"description":"Lock selected unspent outputs"
},
"feeRate":{
"type":"number",
"description":"Set a specific fee rate in LBC/kB"
},
"replaceable":{
"type":"boolean",
"description":"Marks this transaction as BIP125 replaceable."
},
"conf_target":{
"type":"number",
"description":"Confirmation target (in blocks)"
},
"estimate_mode":{
"type":"string",
"description":"The fee estimate mode, must be one of:"
}
}
},
"iswitness":{
"type":"boolean",
"description":"Whether the transaction hex is a serialized witness transaction If iswitness is not present, heuristic tests will be used in decoding"
}
},
"required":[
"hexstring"
]
},
"result":{
"type":"object",
"properties":{
"hex":{
"type":"string",
"description":"The resulting raw transaction (hex-encoded string)"
},
"fee":{
"type":"number",
"description":"Fee in LBC the resulting transaction pays"
},
"changepos":{
"type":"number",
"description":"The position of the added change output, or -1"
}
}
}
},
"getrawtransaction":{
"summary":"NOTE: By default this function only works for mempool transactions. If the -txindex option is enabled, it also works for blockchain transactions. If the block which contains the transaction is known, its hash can be provided even for nodes without -txindex. Note that if a blockhash is provided, only that block will be searched and if the transaction is in the mempool or other blocks, or if this node does not have the given block available, the transaction will not be found. DEPRECATED: for now, it also works for transactions with unspent outputs. Return the raw transaction data. If verbose is 'true', returns an Object with information about 'txid'. If verbose is 'false' or omitted, returns a string that is serialized, hex-encoded data for 'txid'.",
"description":"If false, return a string, otherwise return a json object",
"default":false
},
"blockhash":{
"type":"string",
"description":"The block in which to look for the transaction"
}
},
"required":[
"txid"
]
},
"result":{
"type":"string",
"description":"The serialized, hex-encoded data for 'txid' Result (if verbose is set to true): { \"in_active_chain\": b, (bool) Whether specified block is in the active chain or not (only present with explicit \"blockhash\" argument) \"hex\" : \"data\", (string) The serialized, hex-encoded data for 'txid' \"txid\" : \"id\", (string) The transaction id (same as provided) \"hash\" : \"id\", (string) The transaction hash (differs from txid for witness transactions) \"size\" : n, (numeric) The serialized transaction size \"vsize\" : n, (numeric) The virtual transaction size (differs from size for witness transactions) \"weight\" : n, (numeric) The transaction's weight (between vsize*4-3 and vsize*4) \"version\" : n, (numeric) The version \"locktime\" : ttt, (numeric) The lock time \"vin\" : [ (array of json objects) { \"txid\": \"id\", (string) The transaction id \"vout\": n, (numeric) \"scriptSig\": { (json object) The script \"asm\": \"asm\", (string) asm \"hex\": \"hex\" (string) hex }, \"sequence\": n (numeric) The script sequence number \"txinwitness\": [\"hex\", ...] (array of string) hex-encoded witness data (if any) } ,... ], \"vout\" : [ (array of json objects) { \"value\" : x.xxx, (numeric) The value in LBC \"n\" : n, (numeric) index \"scriptPubKey\" : { (json object) \"asm\" : \"asm\", (string) the asm \"hex\" : \"hex\", (string) the hex \"reqSigs\" : n, (numeric) The required sigs \"type\" : \"pubkeyhash\", (string) The type, eg 'pubkeyhash' \"addresses\" : [ (json array of string) \"address\" (string) lbry address ,... ] } } ,... ], \"blockhash\" : \"hash\", (string) the block hash \"confirmations\" : n, (numeric) The confirmations \"time\" : ttt, (numeric) The transaction time in seconds since epoch (Jan 1 1970 GMT) \"blocktime\" : ttt (numeric) The block time in seconds since epoch (Jan 1 1970 GMT) }"
}
},
"sendrawtransaction":{
"summary":"Submits raw transaction (serialized, hex-encoded) to local node and network. Also see createrawtransaction and signrawtransaction calls.",
"description":"The hex string of the raw transaction)"
},
"allowhighfees":{
"type":"boolean",
"description":"Allow high fees",
"default":false
}
},
"required":[
"hexstring"
]
},
"result":{
"type":"string",
"description":"The transaction hash in hex"
}
},
"signrawtransaction":{
"summary":"DEPRECATED. Sign inputs for raw transaction (serialized, hex-encoded). The second optional argument (may be null) is an array of previous transaction outputs that this transaction depends on but may not yet be in the block chain. The third optional argument (may be null) is an array of base58-encoded private keys that, if given, will be the only keys used to sign the transaction.",
"description":"An json array of previous dependent transaction outputs [ (json array of json objects, or 'null' if none provided) { \"txid\":\"id\", (string, required) The transaction id \"vout\":n, (numeric, required) The output number \"scriptPubKey\": \"hex\", (string, required) script key \"redeemScript\": \"hex\", (string, required for P2SH or P2WSH) redeem script \"amount\": value (numeric, required) The amount spent } ,... ]"
},
"privkeys":{
"type":"string",
"description":"A json array of base58-encoded private keys for signing [ (json array of strings, or 'null' if none provided) \"privatekey\" (string) private key in base58-encoding ,... ]"
},
"sighashtype":{
"type":"string",
"description":"The signature hash type. Must be one of \"ALL\" \"NONE\" \"SINGLE\" \"ALL|ANYONECANPAY\" \"NONE|ANYONECANPAY\" \"SINGLE|ANYONECANPAY\"",
"default":"ALL"
}
},
"required":[
"hexstring"
]
},
"result":{
"type":"object",
"properties":{
"hex":{
"type":"string",
"description":"The hex-encoded raw transaction with signature(s)"
},
"complete":{
"type":"boolean",
"description":"If the transaction has a complete set of signatures"
},
"errors":{
"type":"array",
"items":{
"type":"object",
"properties":{
"txid":{
"type":"string",
"description":"The hash of the referenced, previous transaction"
},
"vout":{
"type":"number",
"description":"The index of the output to spent and used as input"
},
"scriptSig":{
"type":"string",
"description":"The hex-encoded signature script"
},
"sequence":{
"type":"number",
"description":"Script sequence number"
},
"error":{
"type":"string",
"description":"Verification or signing error related to the input"
}
}
}
}
}
}
},
"signrawtransactionwithkey":{
"summary":"Sign inputs for raw transaction (serialized, hex-encoded). The second argument is an array of base58-encoded private keys that will be the only keys used to sign the transaction. The third optional argument (may be null) is an array of previous transaction outputs that this transaction depends on but may not yet be in the block chain.",
"description":"A json array of base58-encoded private keys for signing [ (json array of strings) \"privatekey\" (string) private key in base58-encoding ,... ]"
},
"prevtxs":{
"type":"string",
"description":"An json array of previous dependent transaction outputs [ (json array of json objects, or 'null' if none provided) { \"txid\":\"id\", (string, required) The transaction id \"vout\":n, (numeric, required) The output number \"scriptPubKey\": \"hex\", (string, required) script key \"redeemScript\": \"hex\", (string, required for P2SH or P2WSH) redeem script \"amount\": value (numeric, required) The amount spent } ,... ]"
},
"sighashtype":{
"type":"string",
"description":"The signature hash type. Must be one of \"ALL\" \"NONE\" \"SINGLE\" \"ALL|ANYONECANPAY\" \"NONE|ANYONECANPAY\" \"SINGLE|ANYONECANPAY\"",
"default":"ALL"
}
},
"required":[
"hexstring",
"privkeys"
]
},
"result":{
"type":"object",
"properties":{
"hex":{
"type":"string",
"description":"The hex-encoded raw transaction with signature(s)"
},
"complete":{
"type":"boolean",
"description":"If the transaction has a complete set of signatures"
},
"errors":{
"type":"array",
"items":{
"type":"object",
"properties":{
"txid":{
"type":"string",
"description":"The hash of the referenced, previous transaction"
},
"vout":{
"type":"number",
"description":"The index of the output to spent and used as input"
},
"scriptSig":{
"type":"string",
"description":"The hex-encoded signature script"
},
"sequence":{
"type":"number",
"description":"Script sequence number"
},
"error":{
"type":"string",
"description":"Verification or signing error related to the input"
}
}
}
}
}
}
},
"testmempoolaccept":{
"summary":"Returns if raw transaction (serialized, hex-encoded) would be accepted by mempool. This checks if the transaction violates the consensus or policy rules. See sendrawtransaction call.",
"description":"The number of required signatures out of the n keys."
},
"keys":{
"type":"string",
"description":"A json array of hex-encoded public keys [ \"key\" (string) The hex-encoded public key ,... ]"
},
"address_type":{
"type":"string",
"description":"The address type to use. Options are \"legacy\", \"p2sh-segwit\", and \"bech32\". Default is legacy."
}
},
"required":[
"nrequired",
"keys"
]
},
"result":{
"type":"object",
"properties":{
"address":{
"type":"string",
"description":"The value of the new multisig address."
},
"redeemScript":{
"type":"string",
"description":"The string value of the hex-encoded redemption script."
}
}
}
},
"estimatesmartfee":{
"summary":"Estimates the approximate fee per kilobyte needed for a transaction to begin confirmation within conf_target blocks if possible and return the number of blocks for which the estimate is valid. Uses virtual transaction size as defined in BIP 141 (witness data is discounted).",
"description":[
"",
"> lbrycrd-cli estimatesmartfee 6",
""
],
"tags":[
"Util"
],
"params":{
"type":"object",
"properties":{
"conf_target":{
"type":"number",
"description":"Confirmation target in blocks (1 - 1008)"
},
"estimate_mode":{
"type":"string",
"description":"The fee estimate mode. Whether to return a more conservative estimate which also satisfies a longer history. A conservative estimate potentially returns a higher feerate and is more likely to be sufficient for the desired target, but is not as responsive to short term drops in the prevailing fee market. Must be one of: \"UNSET\" (defaults to CONSERVATIVE) \"ECONOMICAL\" \"CONSERVATIVE\"",
"default":"CONSERVATIVE"
}
},
"required":[
"conf_target"
]
},
"result":{
"type":"object",
"properties":{
"feerate":{
"type":"number",
"description":"estimate fee rate in LBC/kB"
},
"blocks":{
"type":"number",
"description":"block number where estimate was found"
}
}
}
},
"signmessagewithprivkey":{
"summary":"Sign a message with the private key of an address",
"description":"The private key to sign the message with."
},
"message":{
"type":"string",
"description":"The message to create a signature of."
}
},
"required":[
"privkey",
"message"
]
},
"result":{
"type":"string",
"description":"The signature of the message encoded in base 64"
}
},
"validateaddress":{
"summary":"Return information about the given lbry address. DEPRECATION WARNING: Parts of this command have been deprecated and moved to getaddressinfo. Clients must transition to using getaddressinfo to access this information before upgrading to v0.18. The following deprecated fields have moved to getaddressinfo and will only be shown here with -deprecatedrpc=validateaddress: ismine, iswatchonly, script, hex, pubkeys, sigsrequired, pubkey, addresses, embedded, iscompressed, account, timestamp, hdkeypath, kdmasterkeyid.",
"description":"The lbry address to use for the signature."
},
"signature":{
"type":"string",
"description":"The signature provided by the signer in base 64 encoding (see signmessage)."
},
"message":{
"type":"string",
"description":"The message that was signed."
}
},
"required":[
"address",
"signature",
"message"
]
},
"result":{
"type":"boolean",
"description":"If the signature is verified or not."
}
},
"abandontransaction":{
"summary":"Mark in-wallet transaction <txid> as abandoned This will mark this transaction and all its in-wallet descendants as abandoned which will allow for their inputs to be respent. It can be used to replace \"stuck\" or evicted transactions. It only works on transactions which are not included in a block and are not currently in the mempool. It has no effect on transactions which are already abandoned.",
"summary":"Add a nrequired-to-sign multisignature address to the wallet. Requires a new wallet backup. Each key is a Bitcoin address or hex-encoded public key. This functionality is only intended for use with non-watchonly addresses. See `importaddress` for watchonly p2sh address support. If 'label' is specified, assign address to that label.",
"summary":"Bumps the fee of an opt-in-RBF transaction T, replacing it with a new transaction B. An opt-in RBF transaction with the given txid must be in the wallet. The command will pay the additional fee by decreasing (or perhaps removing) its change output. If the change output is not big enough to cover the increased fee, the command will currently fail instead of adding new inputs to compensate. (A future implementation could improve this.) The command will fail if the wallet or mempool contains a transaction that spends one of T's outputs. By default, the new fee will be calculated automatically using estimatesmartfee. The user can specify a confirmation target for estimatesmartfee. Alternatively, the user can specify totalFee, or use RPC settxfee to set a higher fee rate. At a minimum, the new fee rate must be high enough to pay an additional new relay fee (incrementalfee returned by getnetworkinfo) to enter the node's mempool.",
"description":"The bitcoin address for the private key"
}
},
"required":[
"address"
]
},
"result":{
"type":"string",
"description":"The private key"
}
},
"dumpwallet":{
"summary":"Dumps all wallet keys in a human-readable format to a server-side file. This does not allow overwriting existing files. Imported scripts are included in the dumpfile, but corresponding BIP173 addresses, etc. may not be added automatically by importwallet. Note that if your wallet contains keys which are not derived from your HD seed (e.g. imported keys), these are not covered by only backing up the seed itself, and must be backed up too (e.g. ensure you back up the whole dumpfile).",
"summary":"Encrypts the wallet with 'passphrase'. This is for first time encryption. After this, any calls that interact with private keys such as sending or signing will require the passphrase to be set prior the making these calls. Use the walletpassphrase call for this, and then walletlock call. If the wallet is already encrypted, use the walletpassphrasechange call.",
"description":"The account 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."
"summary":"If account is not specified, returns the server's total available balance. The available balance is what the wallet considers currently spendable, and is thus affected by options which limit spendability such as -spendzeroconfchange. If account is specified (DEPRECATED), returns the balance in the account. Note that the account \"\" is not the same as leaving the parameter out. The server total may be different to the balance in the default \"\" account.",
"description":[
"",
"",
"The total amount in the wallet with 1 or more confirmations",
"> lbrycrd-cli getbalance ",
"",
"The total amount in the wallet at least 6 blocks confirmed",
"To use this deprecated argument, start bitcoind with -deprecatedrpc=accounts. The account string may be given as a\n specific account name to find the balance associated with wallet keys in\n a named account, or as the empty string":{
"type":null,
"description":"to find the balance associated with wallet keys not in any named account, or as \"*\" to find the balance associated with all wallet keys regardless of account. When this option is specified, it calculates the balance in a different way than when it is not specified, and which can count spends twice when there are conflicting pending transactions (such as those created by the bumpfee command), temporarily resulting in low or even negative balances. In general, account balance calculation is not considered reliable and has resulted in confusing outcomes, so it is recommended to avoid passing this argument."
},
"minconf":{
"type":"number",
"description":"Only include transactions confirmed at least this many times. The default is 1 if an account is provided or 0 if no account is provided"
},
"include_watchonly":{
"type":"boolean",
"description":"Also include balance in watch-only addresses (see 'importaddress')",
"summary":"Returns a new Bitcoin address for receiving payments. If 'label' is specified, it is added to the address book so payments received with the address will be associated with 'label'.",
"description":"The label name for the address to be linked to. If not provided, the default label \"\" is used. It can also be set to the empty string \"\" to represent the default label. The label does not need to exist, it will be created if there is no label by the given name."
},
"address_type":{
"type":"string",
"description":"The address type to use. Options are \"legacy\", \"p2sh-segwit\", and \"bech32\". Default is set by -addresstype."
"description":"Whether this transaction could be replaced due to BIP125 (replace-by-fee); may be unknown for unconfirmed transactions not in the mempool"
"description":"DEPRECATED. This field will be removed in a V0.18. To see this deprecated field, start bitcoind with -deprecatedrpc=accounts. The account name involved in the transaction, can be \"\" for the default account."
},
"address":{
"type":"string",
"description":"The bitcoin address involved in the transaction"
},
"category":{
"type":"string",
"description":"The category, either 'send' or 'receive'"
},
"amount":{
"type":"number",
"description":"The amount in LBC"
},
"label":{
"type":"string",
"description":"A comment for the address/transaction, if any"
},
"vout":{
"type":"number",
"description":"the vout value"
},
"fee":{
"type":"number",
"description":"The amount of the fee in LBC. This is negative and only available for the 'send' category of transactions."
},
"abandoned":{
"type":"boolean",
"description":"'true' if the transaction has been abandoned (inputs are respendable). Only available for the 'send' category of transactions."
"description":"the total confirmed balance of the wallet in LBC"
},
"unconfirmed_balance":{
"type":"number",
"description":"the total unconfirmed balance of the wallet in LBC"
},
"immature_balance":{
"type":"number",
"description":"the total immature balance of the wallet in LBC"
},
"txcount":{
"type":"number",
"description":"the total number of transactions in the wallet"
},
"keypoololdest":{
"type":"number",
"description":"the timestamp (seconds since Unix epoch) of the oldest pre-generated key in the key pool"
},
"keypoolsize":{
"type":"number",
"description":"how many new keys are pre-generated (only counts external keys)"
},
"keypoolsize_hd_internal":{
"type":"number",
"description":"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)"
},
"unlocked_until":{
"type":"number",
"description":"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"
"summary":"Adds an address or script (in hex) that can be watched as if it were in your wallet but cannot be used to spend. Requires a new wallet backup.",
"description":"Rescan the wallet for transactions",
"default":true
},
"p2sh":{
"type":"boolean",
"description":"Add the P2SH version of the script as well Note: This call can take over an hour to complete if rescan is true, during that time, other rpc calls may report that the imported address exists but related transactions are still missing, leading to temporarily incorrect/bogus balances and unspent outputs until rescan completes. If you have the full public key, you should call importpubkey instead of this. Note: If you import a non-standard raw script in hex form, outputs sending to it will be treated as change, and not show up in many RPCs.",
"summary":"Import addresses/scripts (with private or public keys, redeem script (P2SH)), rescanning all addresses in one-shot-only (rescan can be disabled via options). Requires a new wallet backup.",
"description":"Data to be imported\n [ (array of json objects)\n {\n \"scriptPubKey\": \"<script>\" | { \"address\":\"<address>\" }, (string / json, required) Type of scriptPubKey (string for script, json for address)\n \"timestamp\": timestamp | \"now\" , (integer / string, required) Creation time of the key in seconds since epoch (Jan 1 1970 GMT),\n or the string \"now\" to substitute the current synced blockchain time. The timestamp of the oldest\n key will determine how far back blockchain rescans need to begin for missing wallet transactions.\n \"now\" can be specified to bypass scanning, for keys which are known to never have been used, and\n 0 can be specified to scan the entire blockchain. Blocks up to 2 hours before the earliest key\n creation time of all keys being imported by the importmulti call will be scanned.\n \"redeemscript\": \"<script>\" , (string, optional) Allowed only if the scriptPubKey is a P2SH address or a P2SH scriptPubKey\n \"pubkeys\": [\"<pubKey>\", ... ] , (array, optional) Array of strings giving pubkeys that must occur in the output or redeemscript\n \"keys\": [\"<key>\", ... ] , (array, optional) Array of strings giving private keys whose corresponding public keys must occur in the output or redeemscript\n \"internal\": <true> , (boolean, optional, default: false) Stating whether matching outputs should be treated as not incoming payments aka change\n \"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\n \"label\": <label> , (string, optional, default: '') Label to assign to the address (aka account name, for now), only allowed with internal=false\n }\n ,...\n ]"
},
"options":{
"type":"json",
"description":"{ \"rescan\": <false>, (boolean, optional, default: true) Stating if should rescan the blockchain after all imports } Note: This call can take over an hour to complete if rescan is true, during that time, other rpc calls may report that the imported keys, addresses or scripts exists but related transactions are still missing."
"summary":"Adds a private key (as returned by dumpprivkey) to your wallet. Requires a new wallet backup. Hint: use importmulti to import more than one private key.",
"description":"Rescan the wallet for transactions Note: This call can take over an hour to complete if rescan is true, during that time, other rpc calls may report that the imported key exists but related transactions are still missing, leading to temporarily incorrect/bogus balances and unspent outputs until rescan completes.",
"summary":"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.",
"description":"Rescan the wallet for transactions Note: This call can take over an hour to complete if rescan is true, during that time, other rpc calls may report that the imported pubkey exists but related transactions are still missing, leading to temporarily incorrect/bogus balances and unspent outputs until rescan completes.",
"summary":"Lists groups of addresses which have had their common ownership made public by common use as inputs or as the resulting change in past transactions",
"description":"Only returned if imported addresses were involved in transaction"
},
"account":{
"type":"string",
"description":"DEPRECATED. Backwards compatible alias for label."
},
"amount":{
"type":"number",
"description":"The total amount received by addresses with this label"
},
"confirmations":{
"type":"number",
"description":"The number of confirmations of the most recent transaction included"
},
"label":{
"type":"string",
"description":"The label of the receiving address. The default label is \"\"."
}
}
}
}
},
"listsinceblock":{
"summary":"Get all transactions in blocks since block [blockhash], or all transactions if omitted. If \"blockhash\" is no longer a part of the main chain, transactions from the fork point onward are included. Additionally, if include_removed is set, transactions affecting the wallet which were removed are returned in the \"removed\" array.",
"description":"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",
"description":"DEPRECATED. This field will be removed in V0.18. To see this deprecated field, start bitcoind with -deprecatedrpc=accounts. The account name associated with the transaction. Will be \"\" for the default account."
"description":"The amount in LBC. This is negative for the 'send' category, and for the 'move' category for moves outbound. It is positive for the 'receive' category, and for the 'move' category for inbound funds."
},
"vout":{
"type":"number",
"description":"the vout value"
},
"fee":{
"type":"number",
"description":"The amount of the fee in LBC. This is negative and only available for the 'send' category of transactions."
},
"confirmations":{
"type":"number",
"description":"The number of confirmations for the transaction. Available for 'send' and 'receive' category of transactions. When it's < 0, it means the transaction conflicted that many blocks ago."
},
"blockhash":{
"type":"string",
"description":"The block hash containing the transaction. Available for 'send' and 'receive' category of transactions."
},
"blockindex":{
"type":"number",
"description":"The index of the transaction in the block that includes it. Available for 'send' and 'receive' category of transactions."
},
"blocktime":{
"type":"number",
"description":"The block time in seconds since epoch (1 Jan 1970 GMT)."
},
"txid":{
"type":"string",
"description":"The transaction id. Available for 'send' and 'receive' category of transactions."
},
"time":{
"type":"number",
"description":"The transaction time in seconds since epoch (Jan 1 1970 GMT)."
},
"timereceived":{
"type":"number",
"description":"The time received in seconds since epoch (Jan 1 1970 GMT). Available for 'send' and 'receive' category of transactions."
},
"bip125-replaceable":{
"type":"string",
"description":"Whether this transaction could be replaced due to BIP125 (replace-by-fee); may be unknown for unconfirmed transactions not in the mempool"
},
"abandoned":{
"type":"boolean",
"description":"'true' if the transaction has been abandoned (inputs are respendable). Only available for the 'send' category of transactions."
},
"comment":{
"type":"string",
"description":"If a comment is associated with the transaction."
"description":"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"
"description":"DEPRECATED. This field will be removed in V0.18. The account name associated with the transaction. It will be \"\" for the default account."
},
"address":{
"type":"string",
"description":"The bitcoin address of the transaction. Not present for move transactions (category = move)."
},
"category":{
"type":"string",
"description":"The transaction category. 'move' is a local (off blockchain) transaction between accounts, and not associated with an address, transaction id or block. 'send' and 'receive' transactions are associated with an address, transaction id and block details"
},
"amount":{
"type":"number",
"description":"The amount in LBC. This is negative for the 'send' category, and for the 'move' category for moves outbound. It is positive for the 'receive' category, and for the 'move' category for inbound funds."
},
"label":{
"type":"string",
"description":"A comment for the address/transaction, if any"
},
"vout":{
"type":"number",
"description":"the vout value"
},
"fee":{
"type":"number",
"description":"The amount of the fee in LBC. This is negative and only available for the 'send' category of transactions."
},
"confirmations":{
"type":"number",
"description":"The number of confirmations for the transaction. Available for 'send' and 'receive' category of transactions. Negative confirmations indicate the transaction conflicts with the block chain"
},
"trusted":{
"type":"boolean",
"description":"Whether we consider the outputs of this unconfirmed transaction safe to spend."
},
"blockhash":{
"type":"string",
"description":"The block hash containing the transaction. Available for 'send' and 'receive' category of transactions."
},
"blockindex":{
"type":"number",
"description":"The index of the transaction in the block that includes it. Available for 'send' and 'receive' category of transactions."
},
"blocktime":{
"type":"number",
"description":"The block time in seconds since epoch (1 Jan 1970 GMT)."
},
"txid":{
"type":"string",
"description":"The transaction id. Available for 'send' and 'receive' category of transactions."
},
"time":{
"type":"number",
"description":"The transaction time in seconds since epoch (midnight Jan 1 1970 GMT)."
},
"timereceived":{
"type":"number",
"description":"The time received in seconds since epoch (midnight Jan 1 1970 GMT). Available for 'send' and 'receive' category of transactions."
},
"comment":{
"type":"string",
"description":"If a comment is associated with the transaction."
},
"otheraccount":{
"type":"string",
"description":"DEPRECATED. This field will be removed in V0.18. For the 'move' category of transactions, the account the funds came from (for receiving funds, positive amounts), or went to (for sending funds, negative amounts)."
},
"bip125-replaceable":{
"type":"string",
"description":"Whether this transaction could be replaced due to BIP125 (replace-by-fee); may be unknown for unconfirmed transactions not in the mempool"
},
"abandoned":{
"type":"boolean",
"description":"'true' if the transaction has been abandoned (inputs are respendable). Only available for the 'send' category of transactions."
"summary":"Returns array of unspent transaction outputs with between minconf and maxconf (inclusive) confirmations. Optionally filter to only include txouts paid to specified addresses.",
"description":"JSON with query options { \"minimumAmount\" (numeric or string, default=0) Minimum value of each UTXO in LBC \"maximumAmount\" (numeric or string, default=unlimited) Maximum value of each UTXO in LBC \"maximumCount\" (numeric or string, default=unlimited) Maximum number of UTXOs \"minimumSumAmount\" (numeric or string, default=unlimited) Minimum sum value of all UTXOs in LBC } Result [ (array of json object) { \"txid\" : \"txid\", (string) the transaction id \"vout\" : n, (numeric) the vout value \"address\" : \"address\", (string) the bitcoin address \"label\" : \"label\", (string) The associated label, or \"\" for the default label \"account\" : \"account\", (string) DEPRECATED. This field will be removed in V0."
"To see this deprecated field, start bitcoind with -deprecatedrpc=accounts. The associated account, or \"\" for the default account\n \"scriptPubKey\"":{
"description":"the script key \"amount\" : x.xxx, (numeric) the transaction output amount in LBC \"confirmations\" : n, (numeric) The number of confirmations \"redeemScript\" : n (string) The redeemScript if scriptPubKey is P2SH \"spendable\" : xxx, (bool) Whether we have the private keys to spend this output \"solvable\" : xxx, (bool) Whether we know how to spend this output, ignoring the lack of keys \"safe\" : xxx (bool) Whether this output is considered safe to spend. Unconfirmed transactions from outside keys and unconfirmed replacement transactions are considered unsafe and are not eligible for spending by fundrawtransaction and sendtoaddress. } ,... ]"
"To see this deprecated field, start bitcoind with -deprecatedrpc=accounts. The associated account, or \"\" for the default account\n \"scriptPubKey\""
"summary":"Loads a wallet from a wallet file or directory. Note that all wallet command-line options used when starting bitcoind will be applied to the new wallet (eg -zapwallettxes, upgradewallet, rescan, etc).",
"summary":"Updates list of temporarily unspendable outputs. Temporarily lock (unlock=false) or unlock (unlock=true) specified transaction outputs. If no transaction outputs are specified when unlocking then all current locked transaction outputs are unlocked. A locked transaction output will not be chosen by automatic coin selection, when spending bitcoins. Locks are stored in memory only. Nodes start with zero locked outputs, and the locked output list is always cleared (by virtue of process exit) when a node stops or fails. Also see the listunspent call",
"description":"Whether to unlock (true) or lock (false) the specified transactions"
},
"transactions":{
"type":"string",
"description":"A json array of objects. Each object the txid (string) vout (numeric) [ (json array of json objects) { \"txid\":\"id\", (string) The transaction id \"vout\": n (numeric) The output number } ,... ]"
"summary":"Deletes the specified transaction from the wallet. Meant for use with pruned wallets and as a companion to importprunedfunds. This will affect wallet balances.",
"description":"The name of the account to send funds from. May be the default account using \"\". Specifying an account does not influence coin selection, but it does associate the newly created transaction with the account, so the account's balance computation and transaction history can reflect the spend."
},
"toaddress":{
"type":"string",
"description":"The bitcoin address to send funds to."
},
"amount":{
"type":"number",
"description":"The amount in LBC (transaction fee is added on top)."
"description":"An optional comment to store the name of the person or organization to which you're sending the transaction. This is not part of the transaction, it is just kept in your wallet."
"description":"DEPRECATED. The account to send the funds from. Should be \"\" for the default account"
},
"amounts":{
"type":"string",
"description":"A json object with addresses and amounts { \"address\":amount (numeric or string) The bitcoin address is the key, the numeric amount (can be string) in LBC is the value ,... }"
"description":"A json array with addresses.\n The fee will be equally deducted from the amount of each selected address.\n Those recipients will receive less bitcoins than you enter in their corresponding amount field.\n If no addresses are specified here, the sender pays the fee.\n [\n \"address\" (string) Subtract fee from this address\n ,...\n ]"
"description":"A comment used to store what the transaction is for. This is not part of the transaction, just kept in your wallet."
},
"comment_to":{
"type":"string",
"description":"A comment to store the name of the person or organization to which you're sending the transaction. This is not part of the transaction, just kept in your wallet."
"summary":"Set or generate a new HD wallet seed. Non-HD wallets will not be upgraded to being a HD wallet. Wallets that are already HD will have a new HD seed set so that new keys added to the keypool will be derived from this new seed. Note that you will need to MAKE A NEW BACKUP of your wallet after setting the HD wallet seed.",
"description":"Whether to flush old unused addresses, including change addresses, from the keypool and regenerate it. If true, the next address from getnewaddress and change address from getrawchangeaddress will be from this new seed. If false, addresses (including change addresses if the wallet already had HD Chain Split enabled) from the existing keypool will be used until it has been depleted.",
"description":"The WIF private key to use as the new HD seed; if not provided a random seed will be used. The seed value can be retrieved using the dumpwallet command. It is the private key marked hdseed=1"
}
},
"required":[]
}
},
"setlabel":{
"summary":"Sets the label associated with the given address.",
"summary":"Sign inputs for raw transaction (serialized, hex-encoded). The second optional argument (may be null) is an array of previous transaction outputs that this transaction depends on but may not yet be in the block chain.",
"description":"An json array of previous dependent transaction outputs [ (json array of json objects, or 'null' if none provided) { \"txid\":\"id\", (string, required) The transaction id \"vout\":n, (numeric, required) The output number \"scriptPubKey\": \"hex\", (string, required) script key \"redeemScript\": \"hex\", (string, required for P2SH or P2WSH) redeem script \"amount\": value (numeric, required) The amount spent } ,... ]"
"description":"The signature hash type. Must be one of \"ALL\" \"NONE\" \"SINGLE\" \"ALL|ANYONECANPAY\" \"NONE|ANYONECANPAY\" \"SINGLE|ANYONECANPAY\"",
"default":"ALL"
}
},
"required":[
"hexstring"
]
},
"result":{
"type":"object",
"properties":{
"hex":{
"type":"string",
"description":"The hex-encoded raw transaction with signature(s)"
"summary":"Unloads the wallet referenced by the request endpoint otherwise unloads the wallet specified in the argument. Specifying the wallet name on a wallet endpoint is invalid.",
"summary":"Creates and funds a transaction in the Partially Signed Transaction format. Inputs will be added if supplied inputs are not enough Implements the Creator and Updater roles.",
"description":"a json array with outputs (key-value pairs), where none of the keys are duplicated.\nThat is, each address can only appear once and there can only be one 'data' object.\n [\n {\n \"address\": x.xxx, (obj, optional) A key-value pair. The key (string) is the bitcoin address, the value (float or string) is the amount in LBC\n },\n {\n \"data\": \"hex\" (obj, optional) A key-value pair. The key must be \"data\", the value is hex encoded data\n }\n ,... More key-value pairs of the above form. For compatibility reasons, a dictionary, which holds the key-value pairs directly, is also\n accepted as second parameter.\n ]"
"description":"The bitcoin address to receive the change"
},
"changePosition":{
"type":"number",
"description":"The index of the change output"
},
"change_type":{
"type":"string",
"description":"The output type to use. Only valid if changeAddress is not specified. Options are \"legacy\", \"p2sh-segwit\", and \"bech32\". Default is set by -changetype."
},
"includeWatching":{
"type":"boolean",
"description":"Also select inputs which are watch only"
},
"lockUnspents":{
"type":"boolean",
"description":"Lock selected unspent outputs"
},
"feeRate":{
"type":"number",
"description":"Set a specific fee rate in LBC/kB"
},
"replaceable":{
"type":"boolean",
"description":"Marks this transaction as BIP125 replaceable."
},
"conf_target":{
"type":"number",
"description":"Confirmation target (in blocks)"
},
"estimate_mode":{
"type":"string",
"description":"The fee estimate mode, must be one of:"
"summary":"Removes the wallet encryption key from memory, locking the wallet. After calling this method, you will need to call walletpassphrase again before being able to call any methods which require the wallet to be unlocked.",
"summary":"Stores the wallet decryption key in memory for 'timeout' seconds. This is needed prior to performing transactions related to private keys such as sending bitcoins",
"description":"The time to keep the decryption key in seconds; capped at 100000000 (~3 years). Note: Issuing the walletpassphrase command while the wallet is already unlocked will set a new unlock time that overrides the old one."
"description":"Also sign the transaction when updating",
"default":true
},
"sighashtype":{
"type":"string",
"description":"The signature hash type to sign with if not specified by the PSBT. Must be one of \"ALL\" \"NONE\" \"SINGLE\" \"ALL|ANYONECANPAY\" \"NONE|ANYONECANPAY\" \"SINGLE|ANYONECANPAY\"",
"default":"ALL"
},
"bip32derivs":{
"type":"boolean",
"description":"If true, includes the BIP 32 derivation paths for public keys if we know them",
