Skip to content

Commit

Permalink
add celestia ADRs
Browse files Browse the repository at this point in the history
  • Loading branch information
evan-forbes authored and williambanfield committed Jul 14, 2022
1 parent fd4174b commit 44fd454
Show file tree
Hide file tree
Showing 13 changed files with 1,451 additions and 0 deletions.
37 changes: 37 additions & 0 deletions docs/celestia-architecture/README copy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
order: 1
parent:
order: false
---

# Architecture Decision Records (ADR)

This is a location to record all high-level architecture decisions in this repository.

You can read more about the ADR concept in this [blog post](https://product.reverb.com/documenting-architecture-decisions-the-reverb-way-a3563bb24bd0#.78xhdix6t).

An ADR should provide:

- Context on the relevant goals and the current state
- Proposed changes to achieve the goals
- Summary of pros and cons
- References
- Changelog

Note the distinction between an ADR and a spec. The ADR provides the context, intuition, reasoning, and
justification for a change in architecture, or for the architecture of something
new. The spec is much more compressed and streamlined summary of everything as
it stands today.

If recorded decisions turned out to be lacking, convene a discussion, record the new decisions here, and then modify the code to match.

Note the context/background should be written in the present tense.

To start a new ADR, you can use this template: [adr-template.md](./adr-template.md)

### Table of Contents:

- [ADR 001: Erasure Coding Block Propagation](./adr-001-block-propagation.md)
- [ADR 002: Sampling erasure coded Block chunks](./adr-002-ipld-da-sampling.md)
- [ADR 003: Retrieving Application messages](./adr-003-application-data-retrieval.md)
- [ADR 004: Data Availability Sampling Light Client](./adr-004-mvp-light-client.md)
22 changes: 22 additions & 0 deletions docs/celestia-architecture/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Tendermint and Celestia

celestia-core is not meant to be used as a general purpose framework.
Instead, its main purpose is to provide certain components (mainly consensus but also a p2p layer for Tx gossiping) for the Celestia main chain.
Hence, we do not provide any extensive documentation here.

Instead of keeping a copy of the Tendermint documentation, we refer to the existing extensive and maintained documentation and specification:

- https://docs.tendermint.com/
- https://github.com/tendermint/tendermint/tree/master/docs/
- https://github.com/tendermint/spec

Reading these will give you a lot of background and context on Tendermint which will also help you understand how celestia-core and [celestia-app](https://github.com/celestiaorg/celestia-app) interact with each other.

# Celestia

As mentioned above, celestia-core aims to be more focused on the Celestia use-case than vanilla Tendermint.
Moving forward we might provide a clear overview on the changes we incorporated.
For now, we refer to the Celestia specific [ADRs](./adr) in this repository as well as to the Celestia specification:

- [celestia-adr](./adr)
- [celestia-specs](https://github.com/celestiaorg/celestia-specs)
124 changes: 124 additions & 0 deletions docs/celestia-architecture/adr-001-block-propagation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
# ADR 001: Erasure Coding Block Propagation

## Changelog

- 16-2-2021: Created

## Context

Block propagation is currently done by splitting the block into arbitrary chunks and gossiping them to validators via a gossip routine. While this does not have downsides it does not meet the needs of the Celestia chain. The celestia chain requires blocks to be encoded in a different way and for the proposer to not propagate the chunks to peers.

Celestia wants validators to pull the block from a IPFS network. What does this mean? As I touched on earlier the proposer pushes the block to the network, this in turn means that each validator downloads and reconstructs the block each time to verify it. Instead Celestia will encode and split up the block via erasure codes, stored locally in the nodes IPFS daemon. After the proposer has sent the block to IPFS and received the CIDs it will include them into the proposal. This proposal will be gossiped to other validators, once a validator receives the proposal it will begin requesting the CIDs included in the proposal.

There are two forms of a validator, one that downloads the block and one that samples it. What does sampling mean? Sampling is the act of checking that a portion or entire block is available for download.

## Detailed Design

The proposed design is as follows.

### Types

The proposal and vote types have a BlockID, this will be replaced with a header hash. The proposal will contain add fields.

The current proposal will be updated to include required fields. The entirety of the message will be reworked at a later date. To see the extent of the needed changes you can visit the [spec repo](https://github.com/celestiaorg/celestia-specs/blob/master/specs/proto/consensus.proto#L19)

```proto
message Proposal {
SignedMsgType type = 1;
int64 height = 2;
int32 round = 3;
int32 pol_round = 4;
+++
// 32-byte hash
bytes last_header_hash = 5;
// 32-byte hash
bytes last_commit_hash = 6;
// 32-byte hash
bytes consensus_root = 7;
FeeHeader fee_header = 8;
// 32-byte hash
bytes state_commitment = 9;
uint64 available_data_original_shares_used = 10;
AvailableDataHeader available_data_header = 11;
+++
google.protobuf.Timestamp timestamp = 12
[(gogoproto.nullable) = false, (gogoproto.stdtime) = true];
bytes signature = 12;
}
```

```proto
// Vote represents a prevote, precommit, or commit vote from validators for
// consensus.
message Vote {
SignedMsgType type = 1;
int64 height = 2;
int32 round = 3;
+++
bytes header_hash = 4;
+++
google.protobuf.Timestamp timestamp = 5
[(gogoproto.nullable) = false, (gogoproto.stdtime) = true];
bytes validator_address = 6;
int32 validator_index = 7;
bytes signature = 8;
}
```

See [specs](https://github.com/celestiaorg/celestia-specs/blob/master/specs/data_structures.md#vote) for more details on the vote.

### Disk Storage

Currently celestia-core stores all blocks in its store. Going forward only the headers of the blocks within the unbonding period will be stored. This will drastically reduce the amount of storage required by a celestia-core node. After the unbonding period all headers will have the option of being pruned.

Proposed amendment to `BlockStore` interface

```go
type BlockStore interface {
Base() int64
Height() int64
Size() int64

LoadBlockMeta(height int64) *types.BlockMeta
LoadHeader(height int64) *types.Header
LoadDAHeader(height int64) *types.DataAvailabilityHeader

SaveHeaders(header *types.Header, daHeader *types.DataAvailabilityHeader, seenCommit *types.Commit)

PruneHeaders(height int64) (uint64, error)

LoadBlockCommit(height int64) *types.Commit
LoadSeenCommit(height int64) *types.Commit
}
```

Along side these changes the rpc layer will need to change. Instead of querying the LL-core store, the node will redirect the query through IPFS.

Example:

When a user requests a block from the LL node, the request will be set to the IPLD plugin. If the IPLD does not have the requested block, it will make a request to the celestia IPFS network for the required CIDs. If the full node does not have the DAheader they will not be able to request the block data.

![user request flow](./assets/user-request.png)

The goal is to not change the public interface for RPC's. It is yet to be seen if this possible. This means that CIDs will need to be set and loaded from the store in order to get all the related block information an user requires.

## Status

Proposed


### Positive

- Minimal breakage to public interface
- Only store the block in a single place (IPFS)
- Reduce the public interface of the storage within Celestia.

### Negative

- User requests may take more time to process

### Neutral

## References
Loading

0 comments on commit 44fd454

Please sign in to comment.