Skip to content
  • Bastian Köcher's avatar
    `sc-block-builder`: Remove `BlockBuilderProvider` (#2099) · ca5f1056
    Bastian Köcher authored
    The `BlockBuilderProvider` was a trait that was defined in
    `sc-block-builder`. The trait was implemented for `Client`. This
    basically meant that you needed to import `sc-block-builder` any way to
    have access to the block builder. So, this trait was not providing any
    real value. This pull request is removing the said trait. Instead of the
    trait it introduces a builder for creating a `BlockBuilder`. The builder
    currently has the quite fabulous name `BlockBuilderBuilder` (I'm open to
    any better name 😅
    
    ). The rest of the pull request is about
    replacing the old trait with the new builder.
    
    # Downstream code changes
    
    If you used `new_block` or `new_block_at` before you now need to switch
    it over to the new `BlockBuilderBuilder` pattern:
    
    ```rust
    // `new` requires a type that implements `CallApiAt`. 
    let mut block_builder = BlockBuilderBuilder::new(client)
                    // Then you need to specify the hash of the parent block the block will be build on top of
    		.on_parent_block(at)
                    // The block builder also needs the block number of the parent block. 
                    // Here it is fetched from the given `client` using the `HeaderBackend`
                    // However, there also exists `with_parent_block_number` for directly passing the number
    		.fetch_parent_block_number(client)
    		.unwrap()
                    // Enable proof recording if required. This call is optional.
    		.enable_proof_recording()
                    // Pass the digests. This call is optional.
                    .with_inherent_digests(digests)
    		.build()
    		.expect("Creates new block builder");
    ```
    
    ---------
    
    Co-authored-by: default avatarSebastian Kunert <[email protected]>
    Co-authored-by: command-bot <>
    ca5f1056