feat: Implement Optimistic block grpc streams #1709

bharath-123 · 2024-10-22T06:44:37Z

Summary

This PR implements the Optimistic block grpc stream apis protos of which were defined in #1519. These stream apis are used by auctioneer in order to optimistically simulate incoming bundles which are competing to be placed at the top-of-block for the given rollup.

Background

We have use cases where users of a given rollup would want to simulate a bundle on top of the latest block. The issue with simulating for rollup users is that the sequencer block times are too small and it would be difficult to simulate a bundle on top of the current latest block and submit it to the sequencer in time to get the bundle included in the next subsequent block.

To increase the time available for bundle simulation, the rollup can simulate on top of a block which has not yet been committed yet i.e a block which has not yet been finalized and is undergoing consensus.

This PR provides two grpc streams in order to enable that:

getOptimisticBlockStream: This grpc method returns a stream given a rollup id. The returned stream produces the latest optimistic blocks which are blocks which have finished process_proposal.
getBlockCommitmentStream: This grpc methods returns a stream which produces the block hash and block height of the latest committed blocks. These are blocks which have finished finalize_block.

The Optimistic block grpc streams are flagged behind ASTRIA_SEQUENCER_NO_OPTIMISTIC_BLOCKS. Ideally the grpc streams would run on a dedicated full node which is not validating.

Changes

Add ASTRIA_SEQUENCER_NO_OPTIMISTIC_BLOCKS to the sequencer environment which feature flags the optimistic block grpc streams
Add an EventBus which can be subscribed to, to listen to blocks undergoing consensus in process_proposal and blocks being finalized in finalize_block.
Add EventReceivers and EventSender types which are generic types which contains watches over which the specified data can be sent.
Add OptimisticBlockFacade which is the struct over which the optimistic block service apis are implemented.
Add OptimisticBlockServiceInner which is a struct which contains a Joinset of the stream tasks. This struct defines a long lived task which in turn spawns stream tasks on the joinset when clients try to subscribe to the optimistic block api streams.
Move start_grpc_server to crate::grpc::mod.rs and renamed it to start_server

Testing

Deployed a sequencer network locally and wrote a grpc client to read from the stream.

Related Issues

closes #1563

bharath-123 · 2024-10-22T07:47:26Z

crates/astria-sequencer/src/app/mod.rs

+                    .wrap_err("failed to run post execute transactions handler")?;
+
+                if let Some(optimistic_block_channels) = &self.optimistic_block_channels {
+                    if let Err(e) = optimistic_block_channels


we do not want to fail process_proposal if sending on the watch fails.

bharath-123 · 2024-10-22T07:48:46Z

crates/astria-sequencer/src/app/mod.rs

@@ -892,7 +952,7 @@ impl App {
        proposer_address: account::Id,
        txs: Vec<bytes::Bytes>,
        tx_results: Vec<ExecTxResult>,
-    ) -> Result<()> {
+    ) -> Result<SequencerBlock> {


I believe this would be faster since we do not have again read the SequencerBlock from state when we want to send it via the optimistic block channels.

I'd rather not change this function, at least for now. As mentioned below, you are not in fact writing or reading to disk at this point.

@bharath-123 What was the decision for this? Why did we decide to keep it for now instead of just reading it from the ephemeral state?

bharath-123 · 2024-10-22T07:49:44Z

crates/astria-sequencer/src/app/mod.rs

@@ -942,7 +1002,7 @@ impl App {
        )
        .wrap_err("failed to convert block info and data to SequencerBlock")?;
        state_tx
-            .put_sequencer_block(sequencer_block)
+            .put_sequencer_block(sequencer_block.clone())


this may or may not be a bad idea, since we are cloning a potentially big struct? In my mind, reads and writes to memory are much faster than disk but I do not have a proper understanding on how the statedb works in our sequencer app.

You are not writing to disk. You are at most incurrring another deserialization step.

Same as for my comment above: we briefly discussed this, but I don't recall why we decided to clone the block here instead of reading it from the ephemeral state.

bharath-123 · 2024-10-22T13:02:00Z

crates/astria-sequencer/src/grpc/optimistic.rs

+        };
+
+        let (tx, rx) =
+            tokio::sync::mpsc::channel::<Result<GetOptimisticBlockStreamResponse, Status>>(128);


128 seems arbitrary, but what is the best way to decide this number?

bharath-123 · 2024-10-29T05:05:55Z

This PR is blocked on #1707

crates/astria-sequencer/src/grpc/optimistic.rs

bharath-123 · 2024-10-29T14:52:58Z

crates/astria-sequencer/src/grpc/optimistic.rs

+
+                    match tx.send(Ok(get_optimistic_block_stream_response)).await {
+                        Ok(()) => {
+                            debug!("sent optimistic block");


should we log this? this will log multiple times with each new listener of the stream.

bharath-123 · 2024-10-30T05:49:28Z

crates/astria-core/src/sequencerblock/v1/mod.rs

@@ -1,5 +1,6 @@
 pub mod block;
 pub mod celestia;
+pub mod optimistic_block;


Final proto definitions are being worked on at #1707

bharath-123 · 2024-10-30T05:59:05Z

crates/astria-sequencer/src/app/mod.rs

+    pub(crate) fn send_committed_block(&self, block: Option<SequencerBlockCommit>) {
+        if self.committed_block_sender().receiver_count() > 0 {
+            if let Err(e) = self.committed_block_sender.send(block) {
+                error!(error = %e, "failed to send committed block");


we should not error out process_proposal or finalize_block if sending a block on the watch fails

…ng to Result

github-actions bot added proto pertaining to the Astria Protobuf spec sequencer pertaining to the astria-sequencer crate labels Oct 22, 2024

bharath-123 temporarily deployed to BUF October 22, 2024 06:45 — with GitHub Actions Inactive

github-actions bot added the cd label Oct 22, 2024

bharath-123 temporarily deployed to BUF October 22, 2024 07:32 — with GitHub Actions Inactive

bharath-123 temporarily deployed to BUF October 22, 2024 07:44 — with GitHub Actions Inactive

bharath-123 temporarily deployed to BUF October 22, 2024 07:46 — with GitHub Actions Inactive

bharath-123 commented Oct 22, 2024

View reviewed changes

bharath-123 temporarily deployed to BUF October 22, 2024 08:53 — with GitHub Actions Inactive

bharath-123 temporarily deployed to BUF October 22, 2024 12:44 — with GitHub Actions Inactive

bharath-123 temporarily deployed to BUF October 22, 2024 12:58 — with GitHub Actions Inactive

bharath-123 commented Oct 22, 2024

View reviewed changes

bharath-123 temporarily deployed to BUF October 22, 2024 13:16 — with GitHub Actions Inactive

bharath-123 force-pushed the bharath/optimistic-sequencer-apis branch from 6359d42 to 28a62d9 Compare October 23, 2024 14:59

bharath-123 temporarily deployed to BUF October 23, 2024 15:00 — with GitHub Actions Inactive

bharath-123 commented Oct 29, 2024

View reviewed changes

crates/astria-sequencer/src/grpc/optimistic.rs Outdated Show resolved Hide resolved

bharath-123 commented Oct 29, 2024

View reviewed changes

bharath-123 force-pushed the bharath/optimistic-sequencer-apis branch from 28a62d9 to 61988df Compare October 29, 2024 17:06

bharath-123 temporarily deployed to BUF October 29, 2024 17:06 — with GitHub Actions Inactive

bharath-123 commented Oct 30, 2024

View reviewed changes

bharath-123 force-pushed the bharath/optimistic-sequencer-apis branch from 9ea11d9 to 1e06c3c Compare October 30, 2024 05:58

bharath-123 commented Oct 30, 2024

View reviewed changes

bharath-123 marked this pull request as ready for review October 30, 2024 06:16

bharath-123 requested review from a team as code owners October 30, 2024 06:16

bharath-123 requested a review from SuperFluffy October 30, 2024 06:16

bharath-123 added 29 commits December 12, 2024 23:51

send commited block from finalize_block

d25ab44

add ASTRIA_SEQUENCER_NO_OPTIMISTIC_BLOCK to configmaps

40b9cd1

fix lint issues

bde1443

remove debug trait from OptimisticBlockChannels

fcb0ca3

minor updates

f1718d8

update sequencer chart version

c9457ba

minor changes

2f98dee

just use Ok while sending data over grpc stream instead of type casti…

2a0c342

…ng to Result

update optimistic block imports

60a73b0

minor updates

715be7f

move optimistic block grpc wrappers to v1

7f98e48

rebase from pr 1707

b0f42db

address review comments

819341d

minor updates

776bc1f

address review comments

2ec212e

make task functions free standing

4e3a529

minor renaming

975fc5c

rebase protos

f781ffc

rename optimistic_block to optimistic

ac4ced8

address review comments

9d2fb0b

use in_scope to emit events under a specific span

81d91e4

add a comment

3db6a8b

add documentation to event bus

5479159

run fmt + lint

0347354

fix comment

04327a6

lint + fmt

b4191ba

only stream new values for the optimistic block and block commitment

61b98ed

add some comments

529c645

address review comments - 4

b356f59

bharath-123 force-pushed the bharath/optimistic-sequencer-apis branch from d066e78 to b356f59 Compare December 13, 2024 05:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Implement Optimistic block grpc streams #1709

feat: Implement Optimistic block grpc streams #1709

bharath-123 commented Oct 22, 2024 •

edited

Loading

bharath-123 Oct 22, 2024

bharath-123 Oct 22, 2024

SuperFluffy Nov 13, 2024

SuperFluffy Nov 20, 2024

bharath-123 Oct 22, 2024 •

edited

Loading

SuperFluffy Nov 13, 2024

SuperFluffy Nov 20, 2024

bharath-123 Oct 22, 2024

bharath-123 commented Oct 29, 2024

bharath-123 Oct 29, 2024

bharath-123 Oct 30, 2024

bharath-123 Oct 30, 2024

feat: Implement Optimistic block grpc streams #1709

Are you sure you want to change the base?

feat: Implement Optimistic block grpc streams #1709

Conversation

bharath-123 commented Oct 22, 2024 • edited Loading

Summary

Background

Changes

Testing

Related Issues

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bharath-123 Oct 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bharath-123 commented Oct 29, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bharath-123 commented Oct 22, 2024 •

edited

Loading

bharath-123 Oct 22, 2024 •

edited

Loading