package pb
Get desktop application:
View/edit binary Protocol Buffers messages
service bchrpc
bchrpc.proto:10bchrpc contains a set of RPCs that can be exposed publicly via the command line options. This service could be authenticated or unauthenticated.
rpc GetMempoolInfo (, )
bchrpc.proto:13GetMempoolInfo returns the state of the current mempool.
message
bchrpc.proto:143(message has no fields)
message
bchrpc.proto:144uint32 size = 1
The count of transactions in the mempool
uint32 bytes = 2
The size in bytes of all transactions in the mempool
rpc GetMempool (, )
bchrpc.proto:17GetMempool returns information about all transactions currently in the memory pool. Offers an option to return full transactions or just transactions hashes.
message
bchrpc.proto:151bool full_transactions = 1
When `full_transactions` is true, full transaction data is provided instead of just transaction hashes. Default is false.
message
bchrpc.proto:157repeated transaction_data = 1
List of unconfirmed transactions.
rpc GetBlockchainInfo (, )
bchrpc.proto:21GetBlockchainInfo returns data about the blockchain including the most recent block hash and height.
message
bchrpc.proto:172(message has no fields)
message
bchrpc.proto:173GetBlockchainInfoResponse.BitcoinNet bitcoin_net = 1
Which network the node is operating on.
int32 best_height = 2
The current number of blocks on the longest chain.
bytes best_block_hash = 3
The hash of the best (tip) block in the most-work fully-validated chain, little-endian.
double difficulty = 4
Threshold for adding new blocks.
int64 median_time = 5
Median time of the last 11 blocks.
bool tx_index = 6
When `tx_index` is true, the node has full transaction index enabled.
bool addr_index = 7
When `addr_index` is true, the node has address index enabled and may be used with call related by address.
bool slp_index = 8
When `slp_index` is true, the node has the slp index enabled and may be used with slp related rpc methods and also causes slp metadata to be added in some of the existing rpc methods.
bool slp_graphsearch = 9
When `slp_graphsearch` is true, the node is able to handle calls to slp graph search
rpc GetBlockInfo (, )
bchrpc.proto:24GetBlockInfo returns metadata and info for a specified block.
message
bchrpc.proto:216oneof hash_or_height
bytes hash = 1
The block hash as a byte array or base64 encoded string, little-endian.
int32 height = 2
The block number.
message
bchrpc.proto:224optional info = 1
Marshaled block header data, as well as metadata.
rpc GetBlock (, )
bchrpc.proto:27GetBlock returns detailed data for a block.
message
bchrpc.proto:229oneof hash_or_height
bytes hash = 1
The block hash as a byte array or base64 encoded string, little-endian.
int32 height = 2
The block number.
bool full_transactions = 3
When `full_transactions` is true, full transactions are returned instead of just hashes. Default is false.
message
bchrpc.proto:240optional block = 1
A marshaled block.
rpc GetRawBlock (, )
bchrpc.proto:30GetRawBlock returns a block in a serialized format.
message
bchrpc.proto:245oneof hash_or_height
bytes hash = 1
The block hash as a byte array or base64 encoded string, little-endian.
int32 height = 2
The block number.
message
bchrpc.proto:253bytes block = 1
Raw block data (with header) serialized according the the bitcoin block protocol.
rpc GetBlockFilter (, )
bchrpc.proto:35GetBlockFilter returns the compact filter (cf) of a block as a Golomb-Rice encoded set. **Requires CfIndex**
message
bchrpc.proto:258oneof hash_or_height
bytes hash = 1
The block hash as a byte array or base64 encoded string, little-endian.
int32 height = 2
The block number.
message
bchrpc.proto:267bytes filter = 1
A compact filter matching input outpoints and public key scripts contained in a block (encoded according to BIP158).
rpc GetHeaders (, )
bchrpc.proto:43GetHeaders takes a block locator object and returns a batch of no more than 2000 headers. Upon parsing the block locator, if the server concludes there has been a fork, it will send headers starting at the fork point, or genesis if no blocks in the locator are in the best chain. If the locator is already at the tip no headers will be returned. see: bchd/bchrpc/documentation/wallet_operation.md
message
bchrpc.proto:274Request headers using a list of known block hashes.
repeated bytes block_locator_hashes = 1
A list of block hashes known to the client (most recent first) which is exponentially sparser toward the genesis block (0), little-endian. Common practice is to include all of the last 10 blocks, and then 9 blocks for each order of ten thereafter.
bytes stop_hash = 2
hash of the latest desired block header, little-endian; only blocks occurring before the stop will be returned.
message
bchrpc.proto:284repeated headers = 1
List of block headers.
rpc GetTransaction (, )
bchrpc.proto:49GetTransaction returns a transaction given a transaction hash. **Requires TxIndex** **Requires SlpIndex for slp related information **
message
bchrpc.proto:290Get a transaction from a transaction hash.
bytes hash = 1
A transaction hash, little-endian.
bool include_token_metadata = 2
message
bchrpc.proto:296optional transaction = 1
A marshaled transaction.
optional token_metadata = 2
rpc GetRawTransaction (, )
bchrpc.proto:54GetRawTransaction returns a serialized transaction given a transaction hash. **Requires TxIndex**
message
bchrpc.proto:304Get an encoded transaction from a transaction hash.
bytes hash = 1
A transaction hash, little-endian.
message
bchrpc.proto:308bytes transaction = 1
Raw transaction in bytes.
GetAddressTransactions returns the transactions for the given address. Offers offset, limit, and from block options. **Requires AddressIndex** **Requires SlpIndex for slp related information **
message
bchrpc.proto:328Get marshaled transactions related to a specific address. RECOMMENDED: Parameters have been provided to query without creating performance issues on the node or client. - The number of transactions to skip and fetch allow for iterating over a large set of transactions, if necessary. - A starting block parameter (either `hash` or `height`) may then be used to filter results to those occurring after a certain time. This approach will reduce network traffic and response processing for the client, as well as reduce workload on the node.
string address = 1
The address to query transactions, in lowercase cashaddr format. The network prefix is optional (i.e. "cashaddress:").
uint32 nb_skip = 2
The number of confirmed transactions to skip, starting with the oldest first. Does not affect results of unconfirmed transactions.
uint32 nb_fetch = 3
Specify the number of transactions to fetch.
oneof start_block
bytes hash = 4
Recommended. Only get transactions after (or within) a starting block identified by hash, little-endian.
int32 height = 5
Recommended. Only get transactions after (or within) a starting block identified by block number.
message
bchrpc.proto:349repeated confirmed_transactions = 1
Transactions that have been included in a block.
repeated unconfirmed_transactions = 2
Transactions in mempool which have not been included in a block.
GetRawAddressTransactions returns the serialized raw transactions for the given address. Offers offset, limit, and from block options. **Requires AddressIndex**
message
bchrpc.proto:371Get encoded transactions related to a specific address. RECOMMENDED: Parameters have been provided to query without creating performance issues on the node or client. - The number of transactions to skip and fetch allow for iterating over a large set of transactions, if necessary. - A starting block parameter (either `hash` or `height`) may then be used to filter results to those occurring after a certain time. This approach will reduce network traffic and response processing for the client, as well as reduce workload on the node.
string address = 1
The address to query transactions, in lowercase cashaddr format. The network prefix is optional (i.e. "cashaddress:").
uint32 nb_skip = 2
The number of confirmed transactions to skip, starting with the oldest first. Does not affect results of unconfirmed transactions.
uint32 nb_fetch = 3
Specify the number of transactions to fetch.
oneof start_block
bytes hash = 4
Recommended. Only return transactions after some starting block identified by hash, little-endian.
int32 height = 5
Recommended. Only return transactions after some starting block identified by block number.
message
bchrpc.proto:391repeated bytes confirmed_transactions = 1
Transactions that have been included in a block.
repeated bytes unconfirmed_transactions = 2
Transactions in mempool which have not been included in a block.
GetAddressUnspentOutputs returns all the unspent transaction outputs for the given address. **Requires AddressIndex** **Requires SlpIndex for slp related information **
message
bchrpc.proto:398string address = 1
The address to query transactions, in lowercase cashaddr format. The network identifier is optional (i.e. "cashaddress:").
bool include_mempool = 2
When `include_mempool` is true, unconfirmed transactions from mempool are returned. Default is false.
bool include_token_metadata = 3
message
bchrpc.proto:407repeated outputs = 1
List of unspent outputs.
repeated token_metadata = 2
rpc GetUnspentOutput (, )
bchrpc.proto:80GetUnspentOutput takes an unspent output in the utxo set and returns the utxo metadata or not found. **Requires SlpIndex for slp related information **
message
bchrpc.proto:413bytes hash = 1
The hash of the transaction, little-endian.
uint32 index = 2
The number of the output, starting from zero.
bool include_mempool = 3
When include_mempool is true, unconfirmed transactions from mempool are returned. Default is false.
bool include_token_metadata = 4
message
bchrpc.proto:423optional outpoint = 1
A reference to the related input.
bytes pubkey_script = 2
Locking script dictating how funds can be spent in the future
int64 value = 3
Amount in satoshi.
bool is_coinbase = 4
When is_coinbase is true, the transaction was the first in a block, created by a miner, and used to pay the block reward
int32 block_height = 5
The index number of the block containing the transaction creating the output.
optional slp_token = 6
optional token_metadata = 7
optional cash_token = 8
rpc GetMerkleProof (, )
bchrpc.proto:86GetMerkleProof returns a Merkle (SPV) proof for a specific transaction in the provided block. **Requires TxIndex**
message
bchrpc.proto:442bytes transaction_hash = 1
A transaction hash, little-endian.
message
bchrpc.proto:446optional block = 1
Block header information for the corresponding transaction
repeated bytes hashes = 2
A list containing the transaction hash, the adjacent leaf transaction hash and the hashes of the highest nodes in the merkle tree not built with the transaction. Proof hashes are ordered following transaction order, or left to right on the merkle tree
bytes flags = 3
Binary representing the location of the matching transaction in the full merkle tree, starting with the root (`1`) at position/level 0, where `1` corresponds to a left branch and `01` is a right branch.
rpc GetSlpTokenMetadata (, )
bchrpc.proto:91GetSlpTokenMetadata return slp token metadata for one or more tokens. **Requires SlpIndex**
message
bchrpc.proto:553repeated bytes token_ids = 1
message
bchrpc.proto:557repeated token_metadata = 1
rpc GetSlpParsedScript (, )
bchrpc.proto:95GetSlpParsedScript returns marshalled object from parsing an slp pubKeyScript using goslp package. This endpoint does not require SlpIndex.
message
bchrpc.proto:561bytes slp_opreturn_script = 1
message
bchrpc.proto:565string parsing_error = 1
bytes token_id = 2
SlpAction slp_action = 3
SlpTokenType token_type = 4
oneof slp_metadata
v1_genesis = 5
NFT1 Group also uses this
v1_mint = 6
NFT1 Group also uses this
v1_send = 7
NFT1 Group also uses this
v1_nft1_child_genesis = 8
v1_nft1_child_send = 9
GetSlpTrustedValidation returns slp validity related information for one or more transactions. **Requires SlpIndex**
message
bchrpc.proto:579repeated queries = 1
bool include_graphsearch_count = 2
message
bchrpc.proto:589repeated results = 1
rpc GetSlpGraphSearch (, )
bchrpc.proto:105GraphSearch returns all the transactions needed for a client to validate an SLP graph **Requires SlpIndex and SlpGraphSearch**
message
bchrpc.proto:607bytes hash = 1
repeated bytes valid_hashes = 2
message
bchrpc.proto:612repeated bytes txdata = 1
rpc CheckSlpTransaction (, )
bchrpc.proto:108CheckSlpTransaction checks the validity of a supposed slp transaction before it is broadcasted.
message
bchrpc.proto:470bytes transaction = 1
repeated required_slp_burns = 2
bool use_spec_validity_judgement = 3
Using the slp specification as a basis for validity judgement can lead to confusion for new users and result in accidental token burns. use_spec_validity_judgement will cause the response's is_valid property to be returned according to the slp specification. Therefore, use_spec_validity_judgement is false by default in order to avoid accidental token burns. When use_spec_validity_judgement is false we return invalid in any case which would result in a burned token, unless the burn is explicitly included as an item in required_slp_burns property. When use_spec_validity_judgement is true, there are three cases where the is_valid response property will be returned as valid, instead of invalid, as per the slp specification. 1) inputs > outputs 2) missing transaction outputs 3) burned inputs from other tokens required_slp_burns is not used when use_spec_validity_judgement is set to true.
message
bchrpc.proto:492bool is_valid = 1
string invalid_reason = 2
int32 best_height = 3
rpc SubmitTransaction (, )
bchrpc.proto:111Submit a transaction to all connected peers.
message
bchrpc.proto:459bytes transaction = 1
The encoded transaction.
bool skip_slp_validity_check = 2
repeated required_slp_burns = 3
message
bchrpc.proto:465bytes hash = 1
Transaction hash, little-endian.
rpc SubscribeTransactions (, stream )
bchrpc.proto:123SubscribeTransactions creates subscription to all relevant transactions based on the subscription filter. This RPC does not use bidirectional streams and therefore can be used with grpc-web. You will need to close and reopen the stream whenever you want to update the subscription filter. If you are not using grpc-web then SubscribeTransactionStream is more appropriate. **Requires TxIndex to receive input metadata** **Requires SlpIndex to receive slp input/output metadata, or SlpTokenMetadata**
rpc SubscribeTransactionStream (stream , stream )
bchrpc.proto:133SubscribeTransactionStream subscribes to relevant transactions based on the subscription requests. The parameters to filter transactions on can be updated by sending new SubscribeTransactionsRequest objects on the stream. NOTE: Because this RPC is using bi-directional streaming it cannot be used with grpc-web. **Requires TxIndex to receive input metadata**
rpc SubscribeBlocks (, stream )
bchrpc.proto:137SubscribeBlocks creates a subscription for notifications of new blocks being connected to the blockchain or blocks being disconnected.
message
bchrpc.proto:537Options to define data structure to be sent by SubscribeBlock stream: - BlockInfo (block metadata): `BlockInfo` - SubscribeBlocksRequest {} - Marshaled Block (with transaction hashes): `Block` - SubscribeBlocksRequest { full_block = true } - Marshaled Block (with full transaction data): `Block` - SubscribeBlocksRequest { full_block = true full_transactions = true } - Serialized Block acccording to bitcoin protocol encoding: `bytes` - SubscribeBlocksRequest { serialize_block = true }
bool full_block = 1
When full_block is true, a complete marshaled block is sent. See `Block`. Default is false, block metadata is sent. See `BlockInfo`.
bool full_transactions = 2
When full_transactions is true, provide full transaction info for a marshaled block. Default is false, only the transaction hashes are included for a marshaled block. See `TransactionData`.
bool serialize_block = 3
When serialize_block is true, blocks are serialized using bitcoin protocol encoding. Default is false, block will be Marshaled (see `BlockInfo` and `BlockNotification`)
message
bchrpc.proto:618BlockNotification.Type type = 1
Whether the block is connected to the chain.
oneof block
block_info = 2
Marshaled block header data, as well as metadata stored by the node.
marshaled_block = 3
A Block.
bytes serialized_block = 4
Binary block, serialized using bitcoin protocol encoding.
message
bchrpc.proto:702Used in: ,
optional info = 1
Block header data, as well as metadata stored by the node.
repeated transaction_data = 2
List of transactions or transaction hashes.
message
bchrpc.proto:703Used in:
oneof txids_or_txs
bytes transaction_hash = 1
Just the transaction hash, little-endian.
transaction = 2
A marshaled transaction.
message
bchrpc.proto:662Metadata for identifying and validating a block
Identification.
Used in: , , , ,
bytes hash = 1
The double sha256 hash of the six header fields in the first 80 bytes of the block, when encoded according the bitcoin protocol, little-endian. sha256(sha256(encoded_header))
int32 height = 2
The block number, an incremental index for each block mined.
int32 version = 3
A version number to track software/protocol upgrades.
bytes previous_block = 4
Hash of the previous block, little-endian.
bytes merkle_root = 5
The root of the Merkle Tree built from all transactions in the block, little-endian.
int64 timestamp = 6
When mining of the block started, expressed in seconds since 1970-01-01.
uint32 bits = 7
Difficulty in Compressed Target Format.
uint32 nonce = 8
A random value that was generated during block mining which happened to result in a computed block hash below the difficulty target at the time.
int32 confirmations = 9
Number of blocks in a chain, including the block itself upon creation.
double difficulty = 10
Difficulty target at time of creation.
bytes next_block_hash = 11
Hash of the next block in this chain, little-endian.
int32 size = 12
Size of the block in bytes.
int64 median_time = 13
The median block time of the latest 11 block timestamps.
State of the block in relation to the chain.
Used in:
CONNECTED = 0
DISCONNECTED = 1
message
bchrpc.proto:853CashToken info used in transaction inputs / outputs WARNING: Some languages (e.g., JavaScript) may not properly handle the 'uint64' for large amounts. For this reason, an annotation has been added for JS to return a string for the amount field instead of casting uint64 to the JS 'number' type. Other languages may require similar treatment.
Used in: , , ,
bytes category_id = 1
uint64 amount = 2
bytes commitment = 3
bytes bitfield = 4
Bitcoin network types
Used in:
MAINNET = 0
Live public network with monetary value.
REGTEST = 1
An isolated environment for automated testing.
TESTNET3 = 2
A public environment where monetary value is agreed to be zero, and some checks for transaction conformity are disabled.
SIMNET = 3
Private testnets for large scale simulations (or stress testing), where a specified list of nodes is used, rather than node discovery.
TESTNET4 = 4
Latest Testnet.
message
bchrpc.proto:158Used in:
oneof txids_or_txs
Either one of the two following is provided, depending on the request.
bytes transaction_hash = 1
The transaction hash, little-endian.
transaction = 2
The transaction data.
message
bchrpc.proto:580Used in:
bytes prev_out_hash = 1
uint32 prev_out_vout = 2
repeated bytes graphsearch_valid_hashes = 3
message
bchrpc.proto:590Used in:
bytes prev_out_hash = 1
uint32 prev_out_vout = 2
bytes token_id = 3
SlpAction slp_action = 4
SlpTokenType token_type = 5
oneof validity_result_type
uint64 v1_token_amount = 6
bool v1_mint_baton = 7
bytes slp_txn_opreturn = 8
uint32 graphsearch_txn_count = 9
message
bchrpc.proto:793Used in: ,
optional transaction = 1
int64 added_time = 2
The time when the transaction was added too the pool.
int32 added_height = 3
The block height when the transaction was added to the pool.
int64 fee = 4
The total fee in satoshi the transaction pays.
int64 fee_per_kb = 5
The fee in satoshi per kilobyte the transaction pays.
double starting_priority = 6
The priority of the transaction when it was added to the pool.
SlpAction is used to allow clients to identify the type of slp transaction from this single field. NOTE: All enum types except for "NON_SLP" may be annotated with one or more BurnFlags.
Used in: , , ,
NON_SLP = 0
NON_SLP_BURN = 1
SLP_PARSE_ERROR = 2
SLP_UNSUPPORTED_VERSION = 3
SLP_V1_GENESIS = 4
SLP_V1_MINT = 5
SLP_V1_SEND = 6
SLP_V1_NFT1_GROUP_GENESIS = 7
SLP_V1_NFT1_GROUP_MINT = 8
SLP_V1_NFT1_GROUP_SEND = 9
SLP_V1_NFT1_UNIQUE_CHILD_GENESIS = 10
SLP_V1_NFT1_UNIQUE_CHILD_SEND = 11
message
bchrpc.proto:1010SlpRequiredBurn is used by clients to allow token burning
Used in: ,
optional outpoint = 1
bytes token_id = 2
SlpTokenType token_type = 3
oneof burn_intention
uint64 amount = 4
uint32 mint_baton_vout = 5
message
bchrpc.proto:867SlpToken info used in transaction inputs / outputs WARNING: Some languages (e.g., JavaScript) may not properly handle the 'uint64' for large amounts. For this reason, an annotation has been added for JS to return a string for the amount field instead of casting uint64 to the JS 'number' type. Other languages may require similar treatment.
Used in: , , ,
bytes token_id = 1
uint64 amount = 2
bool is_mint_baton = 3
string address = 4
uint32 decimals = 5
SlpAction slp_action = 6
SlpTokenType token_type = 7
message
bchrpc.proto:968SlpTokenMetadata is used to marshal metadata about a specific TokenID
Used in: , , ,
bytes token_id = 1
SlpTokenType token_type = 2
oneof type_metadata
v1_fungible = 3
v1_nft1_group = 4
v1_nft1_child = 5
message
bchrpc.proto:978V1Fungible is used to marshal metadata specific to Type 1 token IDs
Used in:
string token_ticker = 1
string token_name = 2
string token_document_url = 3
bytes token_document_hash = 4
uint32 decimals = 5
bytes mint_baton_hash = 6
uint32 mint_baton_vout = 7
message
bchrpc.proto:1000V1NFT1Child is used to marshal metadata specific to NFT1 Child token IDs
Used in:
string token_ticker = 1
string token_name = 2
string token_document_url = 3
bytes token_document_hash = 4
bytes group_id = 5
message
bchrpc.proto:989V1NFT1Group is used to marshal metadata specific to NFT1 Group token IDs
Used in:
string token_ticker = 1
string token_name = 2
string token_document_url = 3
bytes token_document_hash = 4
uint32 decimals = 5
bytes mint_baton_hash = 6
uint32 mint_baton_vout = 7
Used in: , , , ,
VERSION_NOT_SET = 0
V1_FUNGIBLE = 1
V1_NFT1_CHILD = 65
V1_NFT1_GROUP = 129
message
bchrpc.proto:885SlpTransactionInfo is used inside the Transaction message type.
Used in:
SlpAction slp_action = 1
SlpTransactionInfo.ValidityJudgement validity_judgement = 2
string parse_error = 3
bytes token_id = 4
repeated SlpTransactionInfo.BurnFlags burn_flags = 5
oneof tx_metadata
v1_genesis = 6
NFT1 Group also uses this
v1_mint = 7
NFT1 Group also uses this
v1_send = 8
NFT1 Group also uses this
v1_nft1_child_genesis = 9
v1_nft1_child_send = 10
Used in:
BURNED_INPUTS_OUTPUTS_TOO_HIGH = 0
BURNED_INPUTS_BAD_OPRETURN = 1
BURNED_INPUTS_OTHER_TOKEN = 2
BURNED_OUTPUTS_MISSING_BCH_VOUT = 3
BURNED_INPUTS_GREATER_THAN_OUTPUTS = 4
Used in:
UNKNOWN_OR_INVALID = 0
VALID = 1
message
bchrpc.proto:912SlpV1GenesisMetadata is used to marshal type 1 and NFT1 Group GENESIS OP_RETURN scriptPubKey
Used in: ,
bytes name = 1
bytes ticker = 2
bytes document_url = 3
bytes document_hash = 4
uint32 decimals = 5
uint32 mint_baton_vout = 6
uint64 mint_amount = 7
message
bchrpc.proto:923SlpV1MintMetadata is used to marshal type 1 MINT OP_RETURN scriptPubKey
Used in: ,
uint32 mint_baton_vout = 1
uint64 mint_amount = 2
message
bchrpc.proto:934SlpV1Nft1ChildGenesisMetadata is used to marshal NFT1 Child GENESIS OP_RETURN scriptPubKey
Used in: ,
bytes name = 1
bytes ticker = 2
bytes document_url = 3
bytes document_hash = 4
uint32 decimals = 5
bytes group_token_id = 6
message
bchrpc.proto:944SlpV1Nft1ChildSendMetadata is used to marshal NFT1 Child SEND OP_RETURN scriptPubKey
Used in: ,
bytes group_token_id = 1
message
bchrpc.proto:929SlpV1SendMetadata is used to marshal type 1 and NFT1 Group SEND OP_RETURN scriptPubKey
Used in: ,
repeated uint64 amounts = 1
message
bchrpc.proto:499Request to subscribe or unsubscribe from a stream of transactions.
Used as request type in: bchrpc.SubscribeTransactionStream, bchrpc.SubscribeTransactions
optional subscribe = 1
Subscribe to a filter. add items to a filter
optional unsubscribe = 2
Unsubscribe to a filter, remove items from a filter
bool include_mempool = 3
When include_mempool is true, new unconfirmed transactions from mempool are included apart from the ones confirmed in a block.
bool include_in_block = 4
When include_in_block is true, transactions are included when they are confirmed. This notification is sent in addition to any requested mempool notifications.
bool serialize_tx = 5
When serialize_tx is true, transactions are serialized using bitcoin protocol encoding. Default is false, transaction will be Marshaled (see `Transaction`, `MempoolTransaction` and `TransactionNotification`)
message
bchrpc.proto:717Used in: , , , , ,
bytes hash = 1
The double sha256 hash of the encoded transaction, little-endian. sha256(sha256(encoded_transaction))
int32 version = 2
The version of the transaction format.
repeated inputs = 3
List of inputs.
repeated outputs = 4
List of outputs.
uint32 lock_time = 5
The block height or timestamp after which this transaction is allowed. If value is greater than 500 million, it is assumed to be an epoch timestamp, otherwise it is treated as a block-height. Default is zero, or lock.
int32 size = 8
The size of the transaction in bytes.
int64 timestamp = 9
When the transaction was included in a block, in epoch time.
int32 confirmations = 10
Number of blocks including proof of the transaction, including the block it appeared.
int32 block_height = 11
Number of the block containing the transaction.
bytes block_hash = 12
Hash of the block the transaction was recorded in, little-endian.
optional slp_transaction_info = 13
message
bchrpc.proto:718Used in:
uint32 index = 1
The number of the input, starting from zero.
optional outpoint = 2
The related outpoint.
bytes signature_script = 3
An unlocking script asserting a transaction is permitted to spend the Outpoint (UTXO)
uint32 sequence = 4
As of BIP-68, the sequence number is interpreted as a relative lock-time for the input.
int64 value = 5
Amount in satoshi.
bytes previous_script = 6
The pubkey_script of the previous output that is being spent.
string address = 7
The bitcoin addresses associated with this input.
optional slp_token = 8
optional cash_token = 9
message
bchrpc.proto:719Used in: , , , ,
bytes hash = 1
The hash of the transaction containing the output to be spent, little-endian
uint32 index = 2
The index of specific output on the transaction.
message
bchrpc.proto:745Used in:
uint32 index = 1
The number of the output, starting from zero.
int64 value = 2
The number of satoshis to be transferred.
bytes pubkey_script = 3
The public key script used to pay coins.
string address = 4
The bitcoin addresses associated with this output.
string script_class = 5
The type of script.
string disassembled_script = 6
The script expressed in Bitcoin Cash Script.
optional slp_token = 7
optional cash_token = 8
message
bchrpc.proto:824Used in:
repeated string addresses = 1
Filter by address(es)
repeated outpoints = 2
Filter by output hash and index.
repeated bytes data_elements = 3
Filter by data elements contained in pubkey scripts.
bool all_transactions = 4
Subscribed/Unsubscribe to everything. Other filters will be ignored.
bool all_slp_transactions = 5
Subscribed/Unsubscribe to everything slp. Other filters will be ignored, except this filter will be overriden by all_transactions=true
repeated bytes slp_token_ids = 6
only transactions associated with the included tokenIds
message
bchrpc.proto:637Used as response type in: bchrpc.SubscribeTransactionStream, bchrpc.SubscribeTransactions
TransactionNotification.Type type = 1
Whether or not the transaction has been included in a block.
oneof transaction
confirmed_transaction = 2
A transaction included in a block.
unconfirmed_transaction = 3
A transaction in mempool.
bytes serialized_transaction = 4
Binary transaction, serialized using bitcoin protocol encoding.
State of the transaction acceptance.
Used in:
UNCONFIRMED = 0
A transaction in mempool.
CONFIRMED = 1
A transaction in a block.
message
bchrpc.proto:807Used in:
optional outpoint = 1
A reference to the output given by transaction hash and index.
bytes pubkey_script = 2
The public key script used to pay coins.
int64 value = 3
The amount in satoshis
bool is_coinbase = 4
When is_coinbase is true, the output is the first in the block, a generation transaction, the result of mining.
int32 block_height = 5
The block number containing the UXTO.
optional slp_token = 6
optional cash_token = 7