Skip to content

Commit

Permalink
Some fixes to "maintain-guides-async-backing.md" (#5506)
Browse files Browse the repository at this point in the history
* Some fixes to "maintain-guides-async-backing.md"

* format fix

---------

Co-authored-by: Radha <[email protected]>
  • Loading branch information
mrcnski and DrW3RK authored Jan 12, 2024
1 parent 2420975 commit af3e633
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
Binary file modified docs/assets/async/async-backing-unincluded-segment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 6 additions & 3 deletions docs/maintain/maintain-guides-async-backing.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,8 @@ This phase involves configuring your parachain’s runtime to make use of async

5. Configure `pallet_aura` in `runtime/src/lib.rs`

- Set `AllowMultipleBlocksPerSlot` to false
- Set `AllowMultipleBlocksPerSlot` to `false` (don't worry, we will set it to `true` when we
activate async backing in step 3).
- Define `pallet_aura::SlotDuration` using our constant `SLOT_DURATION`

![Aura-config](../assets/async/async-backing-config-aura.png)
Expand All @@ -118,13 +119,15 @@ This phase involves configuring your parachain’s runtime to make use of async

![Aura-spi](../assets/async/async-backing-aura-api.png)

7. Implement the AuraUnincludedSegmentApi, which allows the collator client to query its runtime to
7. Implement the `AuraUnincludedSegmentApi`, which allows the collator client to query its runtime to
determine whether it should author a block.

- Add the dependency `cumulus-primitives-aura` to the `runtime/Cargo.toml` file for your runtime

![cargo-toml](../assets/async/async-backing-cargo.png)

- In the same file, add `"cumulus-primitives-aura/std",` to the `std` feature.

- Inside the `impl_runtime_apis!` block for your runtime, implement the
`AuraUnincludedSegmentApi` as shown below.

Expand Down Expand Up @@ -190,7 +193,7 @@ This phase consists of changes to your parachain’s runtime that activate async

![Aura-allow-multiple-blocks](../assets/async/async-backing-allow-multiple.png)

2. Increase the maximum unincluded segment capacity in `runtime/src/lib.rs`.
1. Increase the maximum `UNINCLUDED_SEGMENT_CAPACITY` in `runtime/src/lib.rs`.

![Unincluded-segment-capacity](../assets/async/async-backing-unincluded-segment.png)

Expand Down

0 comments on commit af3e633

Please sign in to comment.