Sync 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. |
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 | |
| timestamp | uint64 | Block ms timestamp |
DumpHistoryRequest
Request to dump the block history.
| Field | Type | Label | Description |
|---|---|---|---|
| start_token | BlockRef | Starting point for the block history dump. | |
| max_items | uint32 | Maximum number of items to return. | |
| field_mask | google.protobuf.FieldMask | Field mask to selectively return fields. |
DumpHistoryResponse
Response containing the dumped block history.
| Field | Type | Label | Description |
|---|---|---|---|
| block | AnyChainBlock | repeated | List of blocks in the history. |
| next_token | BlockRef | Next token for pagination. |
FetchBlockRequest
Request to fetch a block by its reference.
| Field | Type | Label | Description |
|---|---|---|---|
| ref | BlockRef | repeated | List of block references. |
| field_mask | google.protobuf.FieldMask | Field mask to selectively return fields. |
FetchBlockResponse
Response containing the fetched blocks.
| Field | Type | Label | Description |
|---|---|---|---|
| block | AnyChainBlock | repeated | List of fetched blocks. |
FollowTipRequest
Request to follow the tip of the blockchain.
| Field | Type | Label | Description |
|---|---|---|---|
| intersect | BlockRef | repeated | List of block references to find the intersection. |
| field_mask | google.protobuf.FieldMask | Field mask to selectively return fields. |
FollowTipResponse
Response containing the action to perform while following the tip.
| Field | Type | Label | Description |
|---|---|---|---|
| apply | AnyChainBlock | Apply this block. | |
| undo | AnyChainBlock | Undo this block. | |
| reset | BlockRef | Reset to this block reference. | |
| tip | BlockRef | The current tip of the blockchain after this action. |
ReadTipRequest
Request to read the current tip of the blockchain.
ReadTipResponse
Response containing the current tip of the blockchain.
| Field | Type | Label | Description |
|---|---|---|---|
| tip | BlockRef | The current tip of the blockchain. |
SyncService
Service definition for syncing chain data.
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| FetchBlock | FetchBlockRequest | FetchBlockResponse | Fetch a block by its reference. |
| DumpHistory | DumpHistoryRequest | DumpHistoryResponse | Dump the block history. |
| FollowTip | FollowTipRequest | FollowTipResponse stream | Follow the tip of the blockchain. |
| ReadTip | ReadTipRequest | ReadTipResponse | Read the current tip of the blockchain. |