Skip to content

Commit

Permalink
cometbft: rename doc links in abci
Browse files Browse the repository at this point in the history
  • Loading branch information
mzabaluev committed Dec 11, 2023
1 parent cc012cd commit af8011e
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions cometbft/src/abci.rs
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
//! Application BlockChain Interface ([ABCI]) is the interface between Tendermint
//! Application BlockChain Interface ([ABCI]) is the interface between CometBFT
//! (a consensus engine for Byzantine-fault-tolerant replication of a state
//! machine) and an application (the state machine to be replicated).
//!
//! Using ABCI involves writing an application driven by ABCI methods, exposing
//! that application as an ABCI server, and having Tendermint connect to the
//! that application as an ABCI server, and having CometBFT connect to the
//! server as an ABCI client.
//!
//! This module does not include an ABCI server implementation itself. Instead,
//! it provides a common set of Rust domain types that model the ABCI protocol,
//! which can be used by both ABCI applications and ABCI server implementations.
//!
//! One ABCI server implementation is provided by the [`tendermint_abci`][tmabci]
//! One ABCI server implementation is provided by the [`cometbft_abci`][tmabci]
//! crate.
//!
//! Each ABCI method corresponds to a request/response pair. ABCI requests are
//! modeled by the [`Request`] enum, and responses are modeled by the
//! [`Response`] enum. As described in the [methods and types][mat] page, ABCI
//! methods are split into four categories. Tendermint opens one ABCI connection
//! methods are split into four categories. CometBFT opens one ABCI connection
//! for each category of messages. These categories are modeled by the
//! [`MethodKind`] enum and by per-category request and response enums:
//!
Expand All @@ -26,15 +26,15 @@
//! * [`SnapshotRequest`] / [`SnapshotResponse`] for [`MethodKind::Snapshot`] methods.
//!
//! The domain types in this module have conversions to and from the Protobuf
//! types defined in the [`tendermint_proto`] crate. These conversions are
//! types defined in the [`cometbft_proto`] crate. These conversions are
//! required for ABCI server implementations, which use the protobufs to
//! communicate with Tendermint, but should not be required for ABCI
//! communicate with CometBFT, but should not be required for ABCI
//! applications, which should use the domain types in an interface defined by
//! their choice of ABCI server implementation.
//!
//! [ABCI]: https://docs.tendermint.com/master/spec/abci/
//! [mat]: https://docs.tendermint.com/master/spec/abci/abci.html
//! [tmabci]: https://github.com/informalsystems/tendermint-rs/tree/master/abci
//! [ABCI]: https://docs.cometbft.com/v1.0/spec/abci/
//! [mat]: https://docs.cometbft.com/v1.0/spec/abci/abci.html
//! [tmabci]: https://github.com/cometbft/cometbft-rs/tree/master/abci
mod code;
mod event;
Expand Down

0 comments on commit af8011e

Please sign in to comment.