chainrpc
package chainrpc
- Alphabetic
- Public
- Protected
Type Members
- final case class BlockEpoch(hash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, height: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[BlockEpoch] with Product with Serializable
- hash
The hash of the block.
- height
The height of the block.
- Annotations
- @SerialVersionUID()
- trait ChainKit extends AnyRef
ChainKit is a service that can be used to get information from the chain backend.
ChainKit is a service that can be used to get information from the chain backend.
- Annotations
- @PekkoGrpcGenerated()
- trait ChainKitClient extends ChainKit with ChainKitClientPowerApi with PekkoGrpcClient
- Annotations
- @PekkoGrpcGenerated()
- trait ChainKitClientPowerApi extends AnyRef
- Annotations
- @PekkoGrpcGenerated()
- trait ChainNotifier extends AnyRef
ChainNotifier is a service that can be used to get information about the chain backend by registering notifiers for chain events.
ChainNotifier is a service that can be used to get information about the chain backend by registering notifiers for chain events.
- Annotations
- @PekkoGrpcGenerated()
- trait ChainNotifierClient extends ChainNotifier with ChainNotifierClientPowerApi with PekkoGrpcClient
- Annotations
- @PekkoGrpcGenerated()
- trait ChainNotifierClientPowerApi extends AnyRef
- Annotations
- @PekkoGrpcGenerated()
- final case class ConfDetails(rawTx: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, blockHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, blockHeight: Int = 0, txIndex: Int = 0, rawBlock: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ConfDetails] with Product with Serializable
- rawTx
The raw bytes of the confirmed transaction.
- blockHash
The hash of the block in which the confirmed transaction was included in.
- blockHeight
The height of the block in which the confirmed transaction was included in.
- txIndex
The index of the confirmed transaction within the block.
- rawBlock
The raw bytes of the block that mined the transaction. Only included if include_block was set in the request.
- Annotations
- @SerialVersionUID()
- final case class ConfEvent(event: Event = chainrpc.ConfEvent.Event.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ConfEvent] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class ConfRequest(txid: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, script: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, numConfs: Int = 0, heightHint: Int = 0, includeBlock: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ConfRequest] with Product with Serializable
- txid
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.
- script
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.
- numConfs
The number of desired confirmations the transaction/output script should reach before dispatching a confirmation notification.
- heightHint
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.
- includeBlock
If true, then the block that mines the specified txid/script will be included in eventual the notification event.
- Annotations
- @SerialVersionUID()
- final case class GetBestBlockRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetBestBlockRequest] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class GetBestBlockResponse(blockHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, blockHeight: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetBestBlockResponse] with Product with Serializable
- blockHash
The hash of the best block.
- blockHeight
The height of the best block.
- Annotations
- @SerialVersionUID()
- final case class GetBlockHashRequest(blockHeight: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetBlockHashRequest] with Product with Serializable
- blockHeight
Block height of the target best chain block.
- Annotations
- @SerialVersionUID()
- final case class GetBlockHashResponse(blockHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetBlockHashResponse] with Product with Serializable
- blockHash
The hash of the best block at the specified height.
- Annotations
- @SerialVersionUID()
- final case class GetBlockHeaderRequest(blockHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetBlockHeaderRequest] with Product with Serializable
- blockHash
The hash of the block with the requested header.
- Annotations
- @SerialVersionUID()
- final case class GetBlockHeaderResponse(rawBlockHeader: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetBlockHeaderResponse] with Product with Serializable
- rawBlockHeader
The header of the block with the requested hash.
- Annotations
- @SerialVersionUID()
- final case class GetBlockRequest(blockHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetBlockRequest] with Product with Serializable
- blockHash
The hash of the requested block.
- Annotations
- @SerialVersionUID()
- final case class GetBlockResponse(rawBlock: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetBlockResponse] with Product with Serializable
TODO(ffranr): The neutrino GetBlock response includes many additional helpful fields.
TODO(ffranr): The neutrino GetBlock response includes many additional helpful fields. Consider adding them here also.
- rawBlock
The raw bytes of the requested block.
- Annotations
- @SerialVersionUID()
- final case class Outpoint(hash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, index: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Outpoint] with Product with Serializable
- hash
The hash of the transaction.
- index
The index of the output within the transaction.
- Annotations
- @SerialVersionUID()
- final case class Reorg(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Reorg] with Product with Serializable
TODO(wilmer): need to know how the client will use this first.
TODO(wilmer): need to know how the client will use this first.
- Annotations
- @SerialVersionUID()
- final case class SpendDetails(spendingOutpoint: Option[Outpoint] = _root_.scala.None, rawSpendingTx: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, spendingTxHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, spendingInputIndex: Int = 0, spendingHeight: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SpendDetails] with Product with Serializable
- spendingOutpoint
The outpoint was that spent.
- rawSpendingTx
The raw bytes of the spending transaction.
- spendingTxHash
The hash of the spending transaction.
- spendingInputIndex
The input of the spending transaction that fulfilled the spend request.
- spendingHeight
The height at which the spending transaction was included in a block.
- Annotations
- @SerialVersionUID()
- final case class SpendEvent(event: Event = chainrpc.SpendEvent.Event.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SpendEvent] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class SpendRequest(outpoint: Option[Outpoint] = _root_.scala.None, script: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, heightHint: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SpendRequest] with Product with Serializable
- outpoint
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.
- script
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.
- heightHint
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.
- Annotations
- @SerialVersionUID()
Value Members
- object BlockEpoch extends GeneratedMessageCompanion[BlockEpoch]
- object ChainKit extends ServiceDescription
- Annotations
- @PekkoGrpcGenerated()
- object ChainKitClient
- Annotations
- @PekkoGrpcGenerated()
- object ChainKitHandler
- Annotations
- @ApiMayChange() @PekkoGrpcGenerated()
- object ChainNotifier extends ServiceDescription
- Annotations
- @PekkoGrpcGenerated()
- object ChainNotifierClient
- Annotations
- @PekkoGrpcGenerated()
- object ChainNotifierHandler
- Annotations
- @ApiMayChange() @PekkoGrpcGenerated()
- object ChainkitProto extends GeneratedFileObject
- object ChainnotifierProto extends GeneratedFileObject
- object ConfDetails extends GeneratedMessageCompanion[ConfDetails]
- object ConfEvent extends GeneratedMessageCompanion[ConfEvent]
- object ConfRequest extends GeneratedMessageCompanion[ConfRequest]
- object GetBestBlockRequest extends GeneratedMessageCompanion[GetBestBlockRequest]
- object GetBestBlockResponse extends GeneratedMessageCompanion[GetBestBlockResponse]
- object GetBlockHashRequest extends GeneratedMessageCompanion[GetBlockHashRequest]
- object GetBlockHashResponse extends GeneratedMessageCompanion[GetBlockHashResponse]
- object GetBlockHeaderRequest extends GeneratedMessageCompanion[GetBlockHeaderRequest]
- object GetBlockHeaderResponse extends GeneratedMessageCompanion[GetBlockHeaderResponse]
- object GetBlockRequest extends GeneratedMessageCompanion[GetBlockRequest]
- object GetBlockResponse extends GeneratedMessageCompanion[GetBlockResponse]
- object Outpoint extends GeneratedMessageCompanion[Outpoint]
- object Reorg extends GeneratedMessageCompanion[Reorg]
- object SpendDetails extends GeneratedMessageCompanion[SpendDetails]
- object SpendEvent extends GeneratedMessageCompanion[SpendEvent]
- object SpendRequest extends GeneratedMessageCompanion[SpendRequest]