Watch Module Spec
This reference covers v1beta, generated from spec v0.19.2.
AnyChainBlock
| Field | Type | Label | Description |
|---|---|---|---|
| native_bytes | bytes | Original bytes as defined by the chain | |
| cardano | utxorpc.v1beta.cardano.Block | A parsed Cardano block. |
AnyChainTx
Represents a transaction from any supported blockchain.
| Field | Type | Label | Description |
|---|---|---|---|
| cardano | utxorpc.v1beta.cardano.Tx | A Cardano transaction. | |
| block | AnyChainBlock | Block containing the transaction |
AnyChainTxPattern
Represents a tx pattern from any supported blockchain.
| Field | Type | Label | Description |
|---|---|---|---|
| cardano | utxorpc.v1beta.cardano.TxPattern | A Cardano tx pattern. |
BlockRef
Represents a reference to a specific block by a chosen combination of fields
| Field | Type | Label | Description |
|---|---|---|---|
| slot | uint64 | Height or slot number (depending on the blockchain) | |
| hash | bytes | Hash of the content of the block | |
| height | uint64 | Block height |
TxPredicate
Represents a simple tx predicate that can composed to create more complex ones
| Field | Type | Label | Description |
|---|---|---|---|
| match | AnyChainTxPattern | Predicate is true if tx exhibits pattern. | |
| not | TxPredicate | repeated | Predicate is true if tx doesn't exhibit pattern. |
| all_of | TxPredicate | repeated | Predicate is true if tx exhibits all of the patterns. |
| any_of | TxPredicate | repeated | Predicate is true if tx exhibits any of the patterns. |
WatchTxRequest
Request to watch transactions from the chain based on a set of predicates.
| Field | Type | Label | Description |
|---|---|---|---|
| predicate | TxPredicate | Predicate to filter transactions by. | |
| field_mask | google.protobuf.FieldMask | Field mask to selectively return fields. | |
| intersect | BlockRef | repeated | List of block references to find the intersection. |
WatchTxResponse
Response containing the matching chain transactions or block progress signals.
| Field | Type | Label | Description |
|---|---|---|---|
| apply | AnyChainTx | Apply this transaction. | |
| undo | AnyChainTx | Undo this transaction. | |
| idle | BlockRef | No-match signal for a block. |
WatchService
Service definition for watching transactions based on predicates.
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| WatchTx | WatchTxRequest | WatchTxResponse stream | Stream transactions from the chain matching the specified predicates. |