Submit Module Spec
AnyChainEval
Report containing the result of evaluating a particular transaction
| Field | Type | Label | Description |
|---|---|---|---|
| cardano | utxorpc.v1alpha.cardano.TxEval | A Cardano tx evaluation report. |
AnyChainTx
Represents a transaction from any supported blockchain.
| Field | Type | Label | Description |
|---|---|---|---|
| raw | bytes | Raw transaction data. |
AnyChainTxPattern
Represents a tx pattern from any supported blockchain.
| Field | Type | Label | Description |
|---|---|---|---|
| cardano | utxorpc.v1alpha.cardano.TxPattern | A Cardano tx pattern. |
EvalTxRequest
Request to evaluate transactions without submitting.
| Field | Type | Label | Description |
|---|---|---|---|
| tx | AnyChainTx | repeated | List of transactions to evaluate. |
EvalTxResponse
Response containing the reports form the transaction evaluation.
| Field | Type | Label | Description |
|---|---|---|---|
| report | AnyChainEval | repeated |
ReadMempoolRequest
Request to check the status of submitted transactions.
ReadMempoolResponse
Response containing the stage of the submitted transactions.
| Field | Type | Label | Description |
|---|---|---|---|
| items | TxInMempool | repeated | List of transaction currently on the mempool. |
SubmitTxRequest
Request to submit transactions to the blockchain.
| Field | Type | Label | Description |
|---|---|---|---|
| tx | AnyChainTx | repeated | List of transactions to submit. |
SubmitTxResponse
Response containing references to the submitted transactions.
| Field | Type | Label | Description |
|---|---|---|---|
| ref | bytes | repeated | List of transaction references. |
TxInMempool
| Field | Type | Label | Description |
|---|---|---|---|
| ref | bytes | The transaction reference. | |
| native_bytes | bytes | Original bytes as defined by the chain | |
| stage | Stage | The current stage of the tx | |
| cardano | utxorpc.v1alpha.cardano.Tx | A Cardano transaction. |
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. |
WaitForTxRequest
Request to wait for transactions to reach a certain stage.
| Field | Type | Label | Description |
|---|---|---|---|
| ref | bytes | repeated | List of transaction references to wait for. |
WaitForTxResponse
Response containing the transaction reference and stage once it has been reached.
| Field | Type | Label | Description |
|---|---|---|---|
| ref | bytes | Transaction reference. | |
| stage | Stage | Stage reached by the transaction. |
WatchMempoolRequest
Request to watch changes of specific mempool txs.
| Field | Type | Label | Description |
|---|---|---|---|
| predicate | TxPredicate | A predicate to filter transactions by. | |
| field_mask | google.protobuf.FieldMask | Field mask to selectively return fields. |
WatchMempoolResponse
Response that represents a change in a mempool tx.
| Field | Type | Label | Description |
|---|---|---|---|
| tx | TxInMempool | The content and stage of the tx that has changed |
Stage
Enum representing the various stages of a transaction's lifecycle.
| Name | Number | Description |
|---|---|---|
| STAGE_UNSPECIFIED | 0 | Unspecified stage. |
| STAGE_ACKNOWLEDGED | 1 | Transaction has been acknowledged by the node. |
| STAGE_MEMPOOL | 2 | Transaction is in the mempool. |
| STAGE_NETWORK | 3 | Transaction has been propagated across the network. |
| STAGE_CONFIRMED | 4 | Transaction has been confirmed on the blockchain. |
SubmitService
Service definition for submitting transactions and checking their status.
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| EvalTx | EvalTxRequest | EvalTxResponse | Evaluates a transaction without submitting it. |
| SubmitTx | SubmitTxRequest | SubmitTxResponse | Submit transactions to the blockchain. |
| WaitForTx | WaitForTxRequest | WaitForTxResponse stream | Wait for transactions to reach a certain stage and stream the updates. |
| ReadMempool | ReadMempoolRequest | ReadMempoolResponse | Returns a point-in-time snapshot of the mempool. |
| WatchMempool | WatchMempoolRequest | WatchMempoolResponse stream | Stream transactions from the mempool matching the specified predicates. |