Skip to content

Latest commit

 

History

History
97 lines (60 loc) · 3.13 KB

README.md

File metadata and controls

97 lines (60 loc) · 3.13 KB

🚨 DEPRECATED 🚨

This repo has been deprecated. Development work continues as the "abci" crate of informalsystems/tendermint-rs. Please reference that repository in the future.


Rust ABCI

Tendermint ABCI server, written in the Rust programming language.

Current Version CircleCI

This library implements the ABCI protocol and can be used to write ABCI applications for Tendermint.

Supported Version

  • Tendermint 0.33.6
  • ABCI 0.16.2

Installation

Dependencies

Make sure that you have Rust and Cargo installed. The easiest way is to follow the instructions on rustup.

To test the examples, please clone this repository.

git clone https://github.com/tendermint/rust-abci.git

The empty_app example, found under the examples folder, is a good demonstration/bare minimum foundation for a Rust ABCI app.

To use this library to build your own ABCI apps in Rust you have to include the following in your Cargo.toml file.

[dependencies]
abci = "0.7.2"

Development

This crate already contains the compiled ABCI protobuf messages. If you want to update protobuf messages to a newer version of Tendermint. Run make update-proto

Running the examples

Tendermint

To run either of the example apps you have to have Tendermint installed and initialised (Remember to run tendermint init!). Please install it according to these instructions. After initializing and configuring the node, Tendermint can be run with:

tendermint node

After the node is online, you can run the empty_app example using cargo run --example empty_app.

To run the counter_app run cargo run --example counter_app and send transaction to Tendermint via:

curl localhost:26657/broadcast_tx_commit?tx=0x01
curl localhost:26657/broadcast_tx_commit?tx=0x02

For a real life example of an ABCI application you can checkout Cosmos SDK or Ethermint.

Tendermint Compatibility Table

Tendermint Rust-abci
0.33.6 0.7.2
0.33.5 0.7.1
0.33.1 0.7.0
0.32.9 0.6.5
0.31.7 0.5.4

Documentation

Coming soon!

Join the Community

Find us through a variety of channels here.

Code of Conduct

Please read, understand and adhere to our code of conduct.

Credits

Original rust-tsp made by Adrian Brink.