feat(pd)!: migrate to cometbft v0.37

Bumps the rust imports for tendermint-rs and tower-abci to use the v037,
rather than v034, modules. The substantive change is the addition of two
new ABCI event types:

  * PrepareProposal
  * ProcessProposal

The consensus logic has been updated according to spec [0].

Refs #2263.

[0] https://github.com/cometbft/cometbft/blob/v0.37.2/spec/abci/abci%2B%2B_comet_expected_behavior.md#adapting-existing-applications-that-use-abci

.github/workflows/smoke.yml

@@ -25,17 +25,19 @@ jobs:
 
       - name: Install cometbft binary
         run: |
-          curl -L -O "https://github.com/cometbft/cometbft/releases/download/v0.34.27/cometbft_0.34.27_linux_amd64.tar.gz"
-          tar -xzf "cometbft_0.34.27_linux_amd64.tar.gz" cometbft
+          COMETBFT_VERSION="0.37.2"
+          curl -L -O "https://github.com/cometbft/cometbft/releases/download/v${COMETBFT_VERSION}/cometbft_${COMETBFT_VERSION}_linux_amd64.tar.gz"
+          tar -xzf "cometbft_${COMETBFT_VERSION}_linux_amd64.tar.gz" cometbft
           mkdir -p $HOME/bin
           cp cometbft $HOME/bin
           echo $PATH
           export PATH=$HOME/bin:$PATH
           which cometbft
+          cometbft version
 
       - name: Run the smoke test suite
         run: |
-          export PATH=$HOME/bin:$PATH
+          export PATH="$HOME/bin:$PATH"
           ./deployments/scripts/smoke-test.sh
         env:
           TESTNET_RUNTIME: 2m

crates/bin/pd/src/consensus.rs

@@ -3,7 +3,7 @@ use anyhow::Result;
 use penumbra_app::genesis;
 use penumbra_storage::Storage;
 use tendermint::abci::Event;
-use tendermint::v0_34::abci::{
+use tendermint::v0_37::abci::{
     request, response, ConsensusRequest as Request, ConsensusResponse as Response,
 };
 use tokio::sync::mpsc;
@@ -81,6 +81,18 @@ impl Consensus {
                         .await
                         .expect("commit must succeed"),
                 ),
+                Request::PrepareProposal(proposal) => Response::PrepareProposal(
+                    self.prepare_proposal(proposal)
+                        .instrument(span)
+                        .await
+                        .expect("prepare proposal must succeed"),
+                ),
+                Request::ProcessProposal(proposal) => Response::ProcessProposal(
+                    self.process_proposal(proposal)
+                        .instrument(span)
+                        .await
+                        .expect("process proposal must succeed"),
+                ),
             }));
         }
         Ok(())
@@ -203,4 +215,45 @@ impl Consensus {
             retain_height: 0u32.into(),
         })
     }
+
+    /// Ensures that a proposal is suitable for processing. Inspects
+    /// the transactions within the proposal, discarding any that would
+    /// exceed the maximum number of tx bytes for a proposal, and returns
+    /// a propoal with the remainder.
+    async fn prepare_proposal(
+        &mut self,
+        proposal: request::PrepareProposal,
+    ) -> Result<response::PrepareProposal> {
+        let mut txs: Vec<bytes::Bytes> = Vec::new();
+        let num_candidate_txs = proposal.txs.len();
+        tracing::debug!(
+            "processing PrepareProposal, found {} candidate transactions",
+            proposal.txs.len()
+        );
+        // Ensure that list of transactions doesn't exceed max tx bytes. See spec at
+        // https://github.com/cometbft/cometbft/blob/v0.37.2/spec/abci/abci%2B%2B_comet_expected_behavior.md#adapting-existing-applications-that-use-abci
+        for tx in proposal.txs {
+            if (tx.len() + txs.len()) <= proposal.max_tx_bytes.try_into()? {
+                txs.push(tx);
+            } else {
+                break;
+            }
+        }
+        tracing::debug!(
+            "finished processing PrepareProposal, including {}/{} candidate transactions",
+            txs.len(),
+            num_candidate_txs
+        );
+        Ok(response::PrepareProposal { txs: txs })
+    }
+
+    /// Mark the proposal as accepted. The [prepare_proposal] method ensures
+    /// that the number of tx bytes is within the acceptable limit.
+    async fn process_proposal(
+        &mut self,
+        proposal: request::ProcessProposal,
+    ) -> Result<response::ProcessProposal> {
+        tracing::debug!(?proposal, "processing proposal");
+        Ok(response::ProcessProposal::Accept)
+    }
 }

crates/bin/pd/src/events.rs

@@ -4,7 +4,7 @@ use anyhow::Result;
 use futures::FutureExt;
 use regex::RegexSet;
 use tendermint::abci::Event;
-use tendermint::v0_34::abci::{ConsensusRequest as Request, ConsensusResponse as Response};
+use tendermint::v0_37::abci::{ConsensusRequest as Request, ConsensusResponse as Response};
 use tower::{Layer, Service};
 
 #[derive(Debug, Clone)]
@@ -102,6 +102,8 @@ where
                 // No events.
                 Response::InitChain(_) => {}
                 Response::Commit(_) => {}
+                Response::PrepareProposal(_) => {}
+                Response::ProcessProposal(_) => {}
                 // These responses have events.
                 Response::BeginBlock(ref mut msg) => config.adjust_events(&mut msg.events),
                 Response::DeliverTx(ref mut msg) => config.adjust_events(&mut msg.events),

crates/bin/pd/src/info.rs

@@ -33,15 +33,15 @@ use penumbra_ibc::component::ConnectionStateReadExt as _;
 use penumbra_storage::Storage;
 use prost::Message;
 use std::str::FromStr;
-use tendermint::v0_34::abci::{
+use tendermint::v0_37::abci::{
     request,
     response::{self, Echo},
     InfoRequest, InfoResponse,
 };
 use tower_abci::BoxError;
 use tracing::Instrument;
 
-use penumbra_tower_trace::v034::RequestExt;
+use penumbra_tower_trace::v037::RequestExt;
 
 const ABCI_INFO_VERSION: &str = env!("VERGEN_GIT_SEMVER");
 
@@ -609,7 +609,6 @@ impl tower_service::Service<InfoRequest> for Info {
                 InfoRequest::Echo(echo) => Ok(InfoResponse::Echo(Echo {
                     message: echo.message,
                 })),
-                InfoRequest::SetOption(_) => todo!(),
             }
         }
         .instrument(span)

crates/bin/pd/src/main.rs

@@ -33,8 +33,8 @@ use tonic::transport::Server;
 use tracing_subscriber::{prelude::*, EnvFilter};
 use url::Url;
 
-use penumbra_tower_trace::v034::RequestExt;
-use tendermint::v0_34::abci::{ConsensusRequest, MempoolRequest};
+use penumbra_tower_trace::v037::RequestExt;
+use tendermint::v0_37::abci::{ConsensusRequest, MempoolRequest};
 
 #[derive(Debug, Parser)]
 #[clap(
@@ -318,7 +318,7 @@ async fn main() -> anyhow::Result<()> {
             let abci_server = tokio::task::Builder::new()
                 .name("abci_server")
                 .spawn(
-                    tower_abci::v034::Server::builder()
+                    tower_abci::v037::Server::builder()
                         .consensus(consensus)
                         .snapshot(snapshot)
                         .mempool(mempool)

crates/bin/pd/src/mempool.rs

@@ -2,7 +2,7 @@ use anyhow::Result;
 
 use penumbra_storage::{Snapshot, Storage};
 
-use tendermint::v0_34::abci::{
+use tendermint::v0_37::abci::{
     request::CheckTx as CheckTxReq, request::CheckTxKind, response::CheckTx as CheckTxRsp,
     MempoolRequest as Request, MempoolResponse as Response,
 };

crates/bin/pd/src/snapshot.rs

@@ -5,7 +5,7 @@ use std::{
 };
 
 use futures::FutureExt;
-use tendermint::v0_34::abci::{SnapshotRequest, SnapshotResponse};
+use tendermint::v0_37::abci::{SnapshotRequest, SnapshotResponse};
 use tower_abci::BoxError;
 
 #[derive(Clone, Debug)]

crates/core/component/dex/src/component/dex.rs

@@ -7,7 +7,7 @@ use penumbra_chain::component::StateReadExt as _;
 use penumbra_component::Component;
 use penumbra_proto::{StateReadProto, StateWriteProto};
 use penumbra_storage::{StateRead, StateWrite};
-use tendermint::v0_34::abci;
+use tendermint::v0_37::abci;
 use tracing::instrument;
 
 use crate::{

crates/core/component/governance/src/component.rs

@@ -3,7 +3,7 @@ use std::sync::Arc;
 use anyhow::{Context, Result};
 use async_trait::async_trait;
 use penumbra_storage::StateWrite;
-use tendermint::v0_34::abci;
+use tendermint::v0_37::abci;
 use tracing::instrument;
 
 use penumbra_component::Component;

crates/core/component/shielded-pool/src/component/shielded_pool.rs

@@ -9,7 +9,7 @@ use penumbra_proto::StateReadProto;
 use penumbra_sct::Nullifier;
 use penumbra_storage::StateRead;
 use penumbra_storage::StateWrite;
-use tendermint::v0_34::abci;
+use tendermint::v0_37::abci;
 use tracing::instrument;
 
 use crate::genesis::Content as GenesisContent;

crates/narsil/narsil/Cargo.toml

@@ -30,6 +30,7 @@ tower-actor = "0.1.0"
 # External dependencies
 anyhow = "1"
 async-stream = "0.2"
+bytes = "1"
 clap = { version = "3", features = ["derive", "env"] }
 console-subscriber = "0.1.8"
 futures = "0.3"

crates/narsil/narsil/src/bin/narsild.rs

@@ -7,8 +7,8 @@ use console_subscriber::ConsoleLayer;
 use metrics_tracing_context::{MetricsLayer, TracingContextLayer};
 use metrics_util::layers::Stack;
 use penumbra_tendermint_proxy::TendermintProxy;
-use penumbra_tower_trace::v034::RequestExt;
-use tendermint::v0_34::abci::{ConsensusRequest, MempoolRequest};
+use penumbra_tower_trace::v037::RequestExt;
+use tendermint::v0_37::abci::{ConsensusRequest, MempoolRequest};
 
 use narsil::{
     ledger::{consensus::Consensus, mempool::Mempool, snapshot::Snapshot, Info},
@@ -159,7 +159,7 @@ async fn main() -> anyhow::Result<()> {
             let abci_server = tokio::task::Builder::new()
                 .name("abci_server")
                 .spawn(
-                    tower_abci::v034::Server::builder()
+                    tower_abci::v037::Server::builder()
                         .consensus(consensus)
                         .snapshot(snapshot)
                         .mempool(mempool)

crates/narsil/narsil/src/ledger/consensus.rs

@@ -3,7 +3,7 @@ use anyhow::Result;
 use penumbra_app::genesis;
 use penumbra_storage::Storage;
 use tendermint::abci::Event;
-use tendermint::v0_34::abci::{
+use tendermint::v0_37::abci::{
     request, response, ConsensusRequest as Request, ConsensusResponse as Response,
 };
 use tokio::sync::mpsc;
@@ -81,6 +81,18 @@ impl Consensus {
                         .await
                         .expect("commit must succeed"),
                 ),
+                Request::PrepareProposal(proposal) => Response::PrepareProposal(
+                    self.prepare_proposal(proposal)
+                        .instrument(span)
+                        .await
+                        .expect("prepare proposal must succeed"),
+                ),
+                Request::ProcessProposal(proposal) => Response::ProcessProposal(
+                    self.process_proposal(proposal)
+                        .instrument(span)
+                        .await
+                        .expect("process proposal must succeed"),
+                ),
             }));
         }
         Ok(())
@@ -193,4 +205,45 @@ impl Consensus {
             retain_height: 0u32.into(),
         })
     }
+
+    /// Ensures that a proposal is suitable for processing. Inspects
+    /// the transactions within the proposal, discarding any that would
+    /// exceed the maximum number of tx bytes for a proposal, and returns
+    /// a propoal with the remainder.
+    async fn prepare_proposal(
+        &mut self,
+        proposal: request::PrepareProposal,
+    ) -> Result<response::PrepareProposal> {
+        let mut txs: Vec<bytes::Bytes> = Vec::new();
+        let num_candidate_txs = proposal.txs.len();
+        tracing::debug!(
+            "Processing PrepareProposal, found {} candidate transactions",
+            proposal.txs.len()
+        );
+        // Ensure that list of transactions doesn't exceed max tx bytes. See spec at
+        // https://github.com/cometbft/cometbft/blob/v0.37.2/spec/abci/abci%2B%2B_comet_expected_behavior.md#adapting-existing-applications-that-use-abci
+        for tx in proposal.txs {
+            if (tx.len() + txs.len()) <= proposal.max_tx_bytes.try_into()? {
+                txs.push(tx);
+            } else {
+                break;
+            }
+        }
+        tracing::debug!(
+            "Finished processing PrepareProposal, including {}/{} candidate transactions",
+            txs.len(),
+            num_candidate_txs
+        );
+        Ok(response::PrepareProposal { txs: txs })
+    }
+
+    /// Mark the proposal as accepted. The [prepare_proposal] method ensures
+    /// that the number of tx bytes is within the acceptable limit.
+    async fn process_proposal(
+        &mut self,
+        proposal: request::ProcessProposal,
+    ) -> Result<response::ProcessProposal> {
+        tracing::debug!(?proposal, "Processing proposal");
+        Ok(response::ProcessProposal::Accept)
+    }
 }

crates/narsil/narsil/src/ledger/info.rs

@@ -7,8 +7,8 @@ use std::{
 use futures::FutureExt;
 use penumbra_chain::component::{AppHashRead, StateReadExt};
 use penumbra_storage::Storage;
-use penumbra_tower_trace::v034::RequestExt;
-use tendermint::v0_34::abci::{self, response::Echo, InfoRequest, InfoResponse};
+use penumbra_tower_trace::v037::RequestExt;
+use tendermint::v0_37::abci::{self, response::Echo, InfoRequest, InfoResponse};
 use tower_abci::BoxError;
 use tracing::Instrument;
 
@@ -78,7 +78,6 @@ impl tower_service::Service<InfoRequest> for Info {
                 InfoRequest::Echo(echo) => Ok(InfoResponse::Echo(Echo {
                     message: echo.message,
                 })),
-                InfoRequest::SetOption(_) => todo!(),
             }
         }
         .instrument(span)

crates/narsil/narsil/src/ledger/mempool.rs

@@ -2,9 +2,9 @@ use anyhow::Result;
 
 use penumbra_storage::{Snapshot, Storage};
 
-use tendermint::v0_34::abci::request::{CheckTx as CheckTxReq, CheckTxKind};
-use tendermint::v0_34::abci::response::CheckTx as CheckTxRsp;
-use tendermint::v0_34::abci::{MempoolRequest as Request, MempoolResponse as Response};
+use tendermint::v0_37::abci::request::{CheckTx as CheckTxReq, CheckTxKind};
+use tendermint::v0_37::abci::response::CheckTx as CheckTxRsp;
+use tendermint::v0_37::abci::{MempoolRequest as Request, MempoolResponse as Response};
 
 use tokio::sync::{mpsc, watch};
 use tower_actor::Message;

crates/narsil/narsil/src/ledger/snapshot.rs

@@ -5,7 +5,7 @@ use std::{
 };
 
 use futures::FutureExt;
-use tendermint::v0_34::abci::{SnapshotRequest, SnapshotResponse};
+use tendermint::v0_37::abci::{SnapshotRequest, SnapshotResponse};
 use tower_abci::BoxError;
 
 #[derive(Clone, Debug)]

deployments/charts/penumbra-network/values.yaml

@@ -78,8 +78,7 @@ cometbft:
     repository: cometbft/cometbft
     pullPolicy: IfNotPresent
     # https://github.com/cometbft/cometbft#supported-versions
-    # https://github.com/cometbft/cometbft/blob/main/UPGRADING.md#v03427
-    tag: "v0.34.27"
+    tag: "v0.37.2"
   containerArgs:
     - start
     - --proxy_app=tcp://127.0.0.1:26658
@@ -106,17 +105,6 @@ securityContext: {}
   # runAsNonRoot: true
   # runAsUser: 1000
 
-cometbft:
-  image:
-    repository: cometbft/cometbft
-    pullPolicy: IfNotPresent
-    # https://github.com/cometbft/cometbft#supported-versions
-    # https://github.com/cometbft/cometbft/blob/main/UPGRADING.md#v03427
-    tag: "v0.34.27"
-  containerArgs:
-    - start
-    - --proxy_app=tcp://127.0.0.1:26658
-
 # N.B. Only `IngressRoute`, a custom CRD specific to Traefik ingress controller
 # is supported. This is because a traditional Ingress object doesn't allow us
 # to force a backend scheme of h2c, which is required for pd's gRPC service.

deployments/charts/penumbra-node/values.yaml

@@ -38,8 +38,7 @@ cometbft:
     repository: cometbft/cometbft
     pullPolicy: IfNotPresent
     # https://github.com/cometbft/cometbft#supported-versions
-    # https://github.com/cometbft/cometbft/blob/main/UPGRADING.md#v03427
-    tag: "v0.34.27"
+    tag: "v0.37.2"
 
 # Configure nodes. By default, only one is created.
 # Extend this list to add more. Valid node attributes are: