package chainrpc

Get desktop application:
View/edit binary Protocol Buffers messages

ChainKit is a service that can be used to get information from the chain backend.

• rpc GetBlock (GetBlockRequest, GetBlockResponse)

  chainkit.proto:14

  lncli: `chain getblock` GetBlock returns a block given the corresponding block hash.

  message GetBlockRequest

  chainkit.proto:34

  • bytes block_hash = 1

    The hash of the requested block.

  message GetBlockResponse

  chainkit.proto:41

  TODO(ffranr): The neutrino GetBlock response includes many additional helpful fields. Consider adding them here also.

  • bytes raw_block = 1

    The raw bytes of the requested block.

• rpc GetBlockHeader (GetBlockHeaderRequest, GetBlockHeaderResponse)

  chainkit.proto:19

  lncli: `chain getblockheader` GetBlockHeader returns a block header with a particular block hash.

  message GetBlockHeaderRequest

  chainkit.proto:46

  • bytes block_hash = 1

    The hash of the block with the requested header.

  message GetBlockHeaderResponse

  chainkit.proto:51

  • bytes raw_block_header = 1

    The header of the block with the requested hash.

• rpc GetBestBlock (GetBestBlockRequest, GetBestBlockResponse)

  chainkit.proto:25

  lncli: `chain getbestblock` GetBestBlock returns the block hash and current height from the valid most-work chain.

  message GetBestBlockRequest

  chainkit.proto:56

  (message has no fields)

  message GetBestBlockResponse

  chainkit.proto:59

  • bytes block_hash = 1

    The hash of the best block.

  • int32 block_height = 2

    The height of the best block.

• rpc GetBlockHash (GetBlockHashRequest, GetBlockHashResponse)

  chainkit.proto:31

  lncli: `chain getblockhash` GetBlockHash returns the hash of the block in the best blockchain at the given height.

  message GetBlockHashRequest

  chainkit.proto:67

  • int64 block_height = 1

    Block height of the target best chain block.

  message GetBlockHashResponse

  chainkit.proto:72

  • bytes block_hash = 1

    The hash of the best block at the specified height.

ChainNotifier is a service that can be used to get information about the chain backend by registering notifiers for chain events.

• rpc RegisterConfirmationsNtfn (ConfRequest, stream ConfEvent)

  chainnotifier.proto:22

  RegisterConfirmationsNtfn is a synchronous response-streaming RPC that registers an intent for a client to be notified once a confirmation request has reached its required number of confirmations on-chain. A confirmation request must have a valid output script. It is also possible to give a transaction ID. If the transaction ID is not set, a notification is sent once the output script confirms. If the transaction ID is also set, a notification is sent once the output script confirms in the given transaction.

  message ConfRequest

  chainnotifier.proto:48

  • bytes txid = 1

    The transaction hash for which we should request a confirmation notification for. If set to a hash of all zeros, then the confirmation notification will be requested for the script instead.

  • bytes script = 2

    An output script within a transaction with the hash above which will be used by light clients to match block filters. If the transaction hash is set to a hash of all zeros, then a confirmation notification will be requested for this script instead.

  • uint32 num_confs = 3

    The number of desired confirmations the transaction/output script should reach before dispatching a confirmation notification.

  • uint32 height_hint = 4

    The earliest height in the chain for which the transaction/output script could have been included in a block. This should in most cases be set to the broadcast height of the transaction/output script.

  • bool include_block = 5

    If true, then the block that mines the specified txid/script will be included in eventual the notification event.

  message ConfEvent

  chainnotifier.proto:109

  • oneof event

    • ConfDetails conf = 1

      An event that includes the confirmation details of the request (txid/ouput script).

    • Reorg reorg = 2

      An event send when the transaction of the request is reorged out of the chain.

• rpc RegisterSpendNtfn (SpendRequest, stream SpendEvent)

  chainnotifier.proto:32

  RegisterSpendNtfn is a synchronous response-streaming RPC that registers an intent for a client to be notification once a spend request has been spent by a transaction that has confirmed on-chain. A client can specify whether the spend request should be for a particular outpoint or for an output script by specifying a zero outpoint.

  message SpendRequest

  chainnotifier.proto:133

  • optional Outpoint outpoint = 1

    The outpoint for which we should request a spend notification for. If set to a zero outpoint, then the spend notification will be requested for the script instead. A zero or nil outpoint is not supported for Taproot spends because the output script cannot reliably be computed from the witness alone and the spent output script is not always available in the rescan context. So an outpoint must _always_ be specified when registering a spend notification for a Taproot output.

  • bytes script = 2

    The output script for the outpoint above. This will be used by light clients to match block filters. If the outpoint is set to a zero outpoint, then a spend notification will be requested for this script instead.

  • uint32 height_hint = 3

    The earliest height in the chain for which the outpoint/output script could have been spent. This should in most cases be set to the broadcast height of the outpoint/output script.

  message SpendEvent

  chainnotifier.proto:179

  • oneof event

    • SpendDetails spend = 1

      An event that includes the details of the spending transaction of the request (outpoint/output script).

    • Reorg reorg = 2

      An event sent when the spending transaction of the request was reorged out of the chain.

• rpc RegisterBlockEpochNtfn (BlockEpoch, stream BlockEpoch)

  chainnotifier.proto:45

  RegisterBlockEpochNtfn is a synchronous response-streaming RPC that registers an intent for a client to be notified of blocks in the chain. The stream will return a hash and height tuple of a block for each new/stale block in the chain. It is the client's responsibility to determine whether the tuple returned is for a new or stale block in the chain. A client can also request a historical backlog of blocks from a particular point. This allows clients to be idempotent by ensuring that they do not missing processing a single block within the chain.

  message BlockEpoch

  chainnotifier.proto:195

  • bytes hash = 1

    The hash of the block.

  • uint32 height = 2

    The height of the block.

Used in: ConfEvent

• bytes raw_tx = 1

  The raw bytes of the confirmed transaction.

• bytes block_hash = 2

  The hash of the block in which the confirmed transaction was included in.

• uint32 block_height = 3

  The height of the block in which the confirmed transaction was included in.

• uint32 tx_index = 4

  The index of the confirmed transaction within the block.

• bytes raw_block = 5

  The raw bytes of the block that mined the transaction. Only included if include_block was set in the request.

Used in: SpendDetails, SpendRequest

• bytes hash = 1

  The hash of the transaction.

• uint32 index = 2

  The index of the output within the transaction.

TODO(wilmer): need to know how the client will use this first.

Used in: ConfEvent, SpendEvent

(message has no fields)

Used in: SpendEvent

• optional Outpoint spending_outpoint = 1

  The outpoint was that spent.

• bytes raw_spending_tx = 2

  The raw bytes of the spending transaction.

• bytes spending_tx_hash = 3

  The hash of the spending transaction.

• uint32 spending_input_index = 4

  The input of the spending transaction that fulfilled the spend request.

• uint32 spending_height = 5

  The height at which the spending transaction was included in a block.