Implement Grandpa warp syncing #270
Description
The sending side of Grandpa warp sync is paritytech/substrate#1208
This issue consists in implementing the "receiving" side, in other words sending a request, downloading the data, and syncing the chain.
There are two things to do:
- Add the system that analyzes the Grandpa warp sync payload and advances the chain.
- Add the networking code that lets you download that Grandpa warp sync payload.
Advancing the chain
The finalized state of the chain is represented in the code by a chain::chain_information::ChainInformation.
As a high level overview, advancing the chain would consist in updating this ChainInformation. In other words, some system that takes as input a ChainInformation and a warp sync payload, and outputs a new ChainInformation.
For logging purposes, it is important that we don't verify the entire warp sync payload at once, but step by step (one header and justification at a time).
As such, the API should look like:
pub struct Config {
pub start: ChainInformation,
pub warp_sync_payload: Vec<WarpSyncEntry>,
}
pub struct WarpSyncEntry {
pub scale_encoded_header: Vec<u8>, // please stick to Vec<u8>, no stronger typing
pub scale_encoded_justification: Vec<u8>, // same
}
pub enum Verification {
Done(ChainInformation),
InProgress(Verifier),
}
pub struct Verifier {
}
impl Verifier {
pub fn new(config: Config) -> Self { ... }
pub fn next(self) -> Verification { ... }
pub fn state(&self) -> ChainInformationRef { ... } // `Ref` as it's a reference to a ChainInformation
}This can be put in a new module chain::warp_sync.
As for the implementation, it could use the NonFinalizedTree type found in blocks_tree.rs.
Unfortunately, the NonFinalizedTree requires you to pass all headers, and doesn't support skipping headers yet. It's unclear to me how to implement this, because one of the important step when advancing the finalized block is scanning all the headers in between the previous and new finalized blocks in order to find the new values to put in the updated ChainInformation.
It is unclear how to implement .
Adding the networking code
The code that decodes the payload should be put in protocol.rs. Similar existing code can already be found there for block requests and storage proof requests.
In the same vain, a function to send out a warp sync request should be added to src/network/service.rs and full_node/src/network_service.rs, similar to the existing blocks_request and storage_proof_request.