Skip to content

Commit

Permalink
Extended Block proto entity
Browse files Browse the repository at this point in the history
  • Loading branch information
@AndriiDiachuk
AndriiDiachuk committed Sep 2, 2024
1 parent cdebe7f commit 7f1a499
Showing 1 changed file with 48 additions and 19 deletions.
67 changes: 48 additions & 19 deletions ...networks/node-ops/access-onchain-data/access-nodes/accessing-data/access-api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1165,25 +1165,33 @@ Below are in-depth descriptions of each of the data entities returned or accepte

```proto
message Block {
bytes id
bytes parent_id
uint64 height
google.protobuf.Timestamp timestamp
repeated CollectionGuarantee collection_guarantees
repeated BlockSeal block_seals
repeated bytes signatures
}
```

| Field | Description |
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id | SHA3-256 hash of the entire block payload |
| height | Height of the block in the chain |
| parent_id | ID of the previous block in the chain |
| timestamp | Timestamp of when the proposer claims it constructed the block. <br/> **NOTE**: It is included by the proposer, there are no guarantees on how much the time stamp can deviate from the true time the block was published. <br/> Consider observing blocks' status changes yourself to get a more reliable value. |
| collection_guarantees | List of [collection guarantees](#collection-guarantee) |
| block_seals | List of [block seals](#block-seal) |
| signatures | BLS signatures of consensus nodes |
bytes id = 1;
bytes parent_id = 2;
uint64 height = 3;
google.protobuf.Timestamp timestamp = 4;
repeated CollectionGuarantee collection_guarantees = 5;
repeated BlockSeal block_seals = 6;
repeated bytes signatures = 7;
repeated ExecutionReceiptMeta execution_receipt_metaList = 8;
repeated ExecutionResult execution_result_list = 9;
BlockHeader block_header = 10;
bytes protocol_state_id = 11;
}
```

| Field | Description |
|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| id | SHA3-256 hash of the entire block payload |
| height | Height of the block in the chain |
| parent_id | ID of the previous block in the chain |
| timestamp | Timestamp of when the proposer claims it constructed the block. <br/> **NOTE**: It is included by the proposer, there are no guarantees on how much the time stamp can deviate from the true time the block was published. <br/> Consider observing blocks' status changes yourself to get a more reliable value |
| collection_guarantees | List of [collection guarantees](#collection-guarantee) |
| block_seals | List of [block seals](#block-seal) |
| signatures | BLS signatures of consensus nodes |
| execution_receipt_metaList | List of [execution-receipt-meta](#execution-receipt-meta) |
| execution_result_list | List of [execution results](#execution-result) |
| block_header | A summary of a [block](#block-header) |
| protocol_state_id | The root hash of protocol state. |

The detailed semantics of block formation are covered in the [block formation guide](../../../../../build/basics/blocks.md).

Expand Down Expand Up @@ -1451,6 +1459,27 @@ message ExecutionResult {
| chunks | Zero or more chunks |
| service_events | Zero or more service events |

### Execution Receipt Meta

ExecutionReceiptMeta contains the fields from the Execution Receipts that vary from one executor to another
(assuming they commit to the same result).

```proto
message ExecutionReceiptMeta {
bytes executor_id = 1;
bytes result_id = 2;
repeated bytes spocks = 3;
bytes executor_signature = 4;
}
```

| Field | Description |
|----------------------|--------------------------------------|
| executor_id | Identifier of the executor node |
| result_id | Identifier of block execution result |
| spocks | SPoCK |
| executor_signature | Signature of the executor |

#### Chunk

Chunk described execution information for given collection in a block
Expand Down

0 comments on commit 7f1a499

Please sign in to comment.