Skip to content

Commit

Permalink
Small doc improvements (#133)
Browse files Browse the repository at this point in the history
* Add some additional context

* Add some additional context
  • Loading branch information
seanchen1991 authored Sep 28, 2023
1 parent 1787492 commit 1a520ce
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# basecoin-rs
A rudimentary Tendermint ABCI application that implements the following functionality in the form of modules -
At a high level, basecoin implements the application logic that sits between the Tendermint consensus layer and ibc-rs.
It is a rudimentary Tendermint ABCI application that implements the following functionality in the form of modules -
* `bank` - keeps track of different accounts' balances and facilitates transactions between those accounts.
* `ibc` - enables support for IBC (clients, connections & channels)

Its main use-cases are serving as a testing ground and mock implementation for verifying the correctness and behaviour
of the ibc-rs modules.

## Requirements
So far this app has been tested with:
* Rust >v1.52.1
Expand Down
7 changes: 7 additions & 0 deletions crates/app/src/modules/ibc/impls.rs
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,13 @@ where
self.router.deref().clone()
}

// Given a message of type `Any`, this function attempts to parse the message as
// either a `MsgEnvelope` or a `MsgTransfer`.
//
// Note: `MsgEnvelope`s contain messages that need to be dispatched to one of the
// core IBC modules, i.e., client, connection, channel, or packet. `MsgTransfer`
// messages are handled separately then because the ICS20 token transfer application
// is not a core IBC module.
pub fn process_message(&mut self, message: Any) -> Result<Vec<IbcEvent>, AppError> {
if let Ok(msg) = MsgEnvelope::try_from(message.clone()) {
debug!("Dispatching IBC message: {:?}", msg);
Expand Down

0 comments on commit 1a520ce

Please sign in to comment.