-
Notifications
You must be signed in to change notification settings - Fork 96
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: migrate
applications module under the ibc crate into `ibc-a…
…pps` (#967) * feat: restructure and split off applications codebase into ibc-apps dir * imp: rename transfer dir to ics20_transfer * feat: add ibc-apps crate * fix: remove redundant dep + fix cargo doc * docs: add README and descriptions * docs: update main README page * nit: docstrings * nit: docstrings * imp: rename folder to ics20-transfer * chore: move serializers into ics20-transfer/types * fix: apply reviewer comments * imp: add docstring for cosmos_adr028_escrow_address * fix: add missing features + use workspace deps for ibc crates * imp: place re-exports under mod * nit: apply suggestions from code review Co-authored-by: Sean Chen <[email protected]> Signed-off-by: Farhad Shabani <[email protected]> * fix: cargo fmt --------- Signed-off-by: Farhad Shabani <[email protected]> Co-authored-by: Sean Chen <[email protected]> feat: restructure and split off applications codebase into ibc-apps dir refactor: nits from nightly clippy (#962) * use enum tuple variants directly * use first() over get(0) * use infallible conversion * rm redundant export * cargo fmt ci: spell check on GitHub workflows (#964) * typos github action * cutom config for typos * fix spelling to counterparty * fix spelling to transfer imp: rename transfer dir to ics20_transfer feat: add ibc-apps crate fix: remove redundant dep + fix cargo doc docs: add README and descriptions docs: update main README page nit: docstrings nit: docstrings imp: rename folder to ics20-transfer chore: move serializers into ics20-transfer/types fix: apply reviewer comments imp: add docstring for cosmos_adr028_escrow_address fix: add missing features + use workspace deps for ibc crates imp: place re-exports under mod
- Loading branch information
1 parent
bf77378
commit 0dffc81
Showing
40 changed files
with
674 additions
and
403 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| disallowed-types = [ | ||
| # { path = "usize", reason = "variable size" }, # cannot on now, because mocks use it and serde, even if there is no usize in type | ||
| { path = "f64", reason = "not supported in CosmWasm" }, | ||
| { path = "f32", reason = "not supported in CosmWasm" }, | ||
| ] | ||
|
|
||
| disallowed-methods = [ | ||
| "std::time::Duration::as_secs_f64", | ||
| ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| [package] | ||
| name = "ibc-apps" | ||
| version = { workspace = true } | ||
| authors = { workspace = true } | ||
| edition = { workspace = true } | ||
| rust-version = { workspace = true } | ||
| license = { workspace = true } | ||
| repository = { workspace = true } | ||
| keywords = ["blockchain", "cosmos", "ibc", "applications"] | ||
| readme = "README.md" | ||
| description = """ | ||
| `ibc-apps` provides a comprehensive set of libraries for IBC applications, | ||
| facilitating seamless integration of IBC business logic into any blockchain system. | ||
| """ | ||
|
|
||
| [package.metadata.docs.rs] | ||
| all-features = true | ||
|
|
||
| [dependencies] | ||
| ibc-app-transfer = { workspace = true } | ||
|
|
||
| [features] | ||
| default = ["std"] | ||
| std = [ | ||
| "ibc-app-transfer/std", | ||
| ] | ||
| serde = [ | ||
| "ibc-app-transfer/serde", | ||
| ] | ||
| schema = [ | ||
| "ibc-app-transfer/schema", | ||
| "serde", | ||
| "std", | ||
| ] | ||
| borsh = [ | ||
| "ibc-app-transfer/borsh", | ||
| ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| # `ibc-apps` | ||
|
|
||
| This crate is a top-level library that re-exports Inter-Blockchain | ||
| Communication (IBC) applications implemented in Rust. It serves as a centralized hub, | ||
| simplifying the process of importing and integrating various IBC applications | ||
| into your blockchain. IBC is a distributed protocol that enables communication | ||
| between distinct sovereign blockchains. IBC applications abstract away the core | ||
| transport and authentication layers, letter blockchain app developers | ||
| focus solely on business logic implementation. | ||
|
|
||
| The structure within the `ibc-apps` crate is designed to provide flexibility for | ||
| external users. It allows users to either utilize the entire `ibc-apps` crate, | ||
| or selectively import specific sub-crates, whether you need a certain IBC | ||
| application (e.g. `ibc-app-transfer` crate) or only their associated data | ||
| structures (e.g. `ibc-app-transfer-types`). This versatility empowers hosts, | ||
| including chain integrators, relayers, or any IBC tooling projects, to build | ||
| their solutions on top of the layers that best suit their requirements. | ||
|
|
||
| ## Libraries | ||
|
|
||
| Currently, the `ibc-apps` crate contains the implementation of the following IBC | ||
| applications: | ||
|
|
||
| ### ICS-20: Fungible Token Transfer Application | ||
|
|
||
| - [ibc-app-transfer](crates/ibc-apps/ics20-transfer) | ||
| - [ibc-app-transfer-types](crates/ibc-apps/ics20-transfer/types) | ||
|
|
||
| ## Contributing | ||
|
|
||
| IBC is specified in English in the [cosmos/ibc repo][ibc]. Any | ||
| protocol changes or clarifications should be contributed there. | ||
|
|
||
| If you're interested in contributing, please comment on an issue or open a new | ||
| one! | ||
|
|
||
| See also [CONTRIBUTING.md](./../../CONTRIBUTING.md). | ||
|
|
||
| ## Resources | ||
|
|
||
| - [IBC Website][ibc-homepage] | ||
| - [IBC Specification][ibc] | ||
| - [IBC Go implementation][ibc-go] | ||
|
|
||
| [//]: # (general links) | ||
| [ibc]: https://github.com/cosmos/ibc | ||
| [ibc-go]: https://github.com/cosmos/ibc-go | ||
| [ibc-homepage]: https://cosmos.network/ibc |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| [package] | ||
| name = "ibc-app-transfer" | ||
| version = { workspace = true } | ||
| authors = { workspace = true } | ||
| edition = { workspace = true } | ||
| rust-version = { workspace = true } | ||
| license = { workspace = true } | ||
| repository = { workspace = true } | ||
| keywords = ["blockchain", "cosmos", "ibc", "transfer", "ics20"] | ||
| readme = "./../README.md" | ||
| description = """ | ||
| Contains the core implementation of the ICS-20 token transfer application logic | ||
| along with re-exporting the data structures from `ibc-app-transfer-types` crate. | ||
| """ | ||
|
|
||
| [package.metadata.docs.rs] | ||
| all-features = true | ||
|
|
||
| [dependencies] | ||
| # external dependencies | ||
| serde_json = { workspace = true, optional = true } | ||
| sha2 = { workspace = true } | ||
|
|
||
| # ibc dependencies | ||
| ibc = { workspace = true } | ||
| ibc-app-transfer-types = { workspace = true } | ||
|
|
||
| [dev-dependencies] | ||
| subtle-encoding = { workspace = true } | ||
|
|
||
| [features] | ||
| default = ["std"] | ||
| std = [ | ||
| "ibc-app-transfer-types/std", | ||
| "ibc/std", | ||
| "serde_json/std", | ||
| "sha2/std", | ||
| ] | ||
| serde = [ | ||
| "ibc-app-transfer-types/serde", | ||
| "ibc/serde", | ||
| "serde_json" | ||
| ] | ||
| schema = [ | ||
| "ibc-app-transfer-types/schema", | ||
| "ibc/schema", | ||
| "serde", | ||
| "std", | ||
| ] | ||
| borsh = [ | ||
| "ibc-app-transfer-types/borsh", | ||
| "ibc/borsh", | ||
| ] | ||
| parity-scale-codec = [ | ||
| "ibc-app-transfer-types/parity-scale-codec", | ||
| "ibc/parity-scale-codec", | ||
| ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| //! Defines the main context traits and IBC module callbacks | ||
| use ibc::core::ics24_host::identifier::{ChannelId, PortId}; | ||
| use ibc::prelude::*; | ||
| use ibc::Signer; | ||
| use ibc_app_transfer_types::error::TokenTransferError; | ||
| use ibc_app_transfer_types::{PrefixedCoin, PrefixedDenom, VERSION}; | ||
| use sha2::{Digest, Sha256}; | ||
|
|
||
| /// Methods required in token transfer validation, to be implemented by the host | ||
| pub trait TokenTransferValidationContext { | ||
| type AccountId: TryFrom<Signer>; | ||
|
|
||
| /// get_port returns the portID for the transfer module. | ||
| fn get_port(&self) -> Result<PortId, TokenTransferError>; | ||
|
|
||
| /// Returns the escrow account id for a port and channel combination | ||
| fn get_escrow_account( | ||
| &self, | ||
| port_id: &PortId, | ||
| channel_id: &ChannelId, | ||
| ) -> Result<Self::AccountId, TokenTransferError>; | ||
|
|
||
| /// Returns Ok() if the host chain supports sending coins. | ||
| fn can_send_coins(&self) -> Result<(), TokenTransferError>; | ||
|
|
||
| /// Returns Ok() if the host chain supports receiving coins. | ||
| fn can_receive_coins(&self) -> Result<(), TokenTransferError>; | ||
|
|
||
| /// Validates the sender and receiver accounts and the coin inputs | ||
| fn send_coins_validate( | ||
| &self, | ||
| from_account: &Self::AccountId, | ||
| to_account: &Self::AccountId, | ||
| coin: &PrefixedCoin, | ||
| ) -> Result<(), TokenTransferError>; | ||
|
|
||
| /// Validates the receiver account and the coin input | ||
| fn mint_coins_validate( | ||
| &self, | ||
| account: &Self::AccountId, | ||
| coin: &PrefixedCoin, | ||
| ) -> Result<(), TokenTransferError>; | ||
|
|
||
| /// Validates the sender account and the coin input | ||
| fn burn_coins_validate( | ||
| &self, | ||
| account: &Self::AccountId, | ||
| coin: &PrefixedCoin, | ||
| ) -> Result<(), TokenTransferError>; | ||
|
|
||
| /// Returns a hash of the prefixed denom. | ||
| /// Implement only if the host chain supports hashed denominations. | ||
| fn denom_hash_string(&self, _denom: &PrefixedDenom) -> Option<String> { | ||
| None | ||
| } | ||
| } | ||
|
|
||
| /// Methods required in token transfer execution, to be implemented by the host | ||
| pub trait TokenTransferExecutionContext: TokenTransferValidationContext { | ||
| /// This function should enable sending ibc fungible tokens from one account to another | ||
| fn send_coins_execute( | ||
| &mut self, | ||
| from_account: &Self::AccountId, | ||
| to_account: &Self::AccountId, | ||
| coin: &PrefixedCoin, | ||
| ) -> Result<(), TokenTransferError>; | ||
|
|
||
| /// This function to enable minting ibc tokens to a user account | ||
| fn mint_coins_execute( | ||
| &mut self, | ||
| account: &Self::AccountId, | ||
| coin: &PrefixedCoin, | ||
| ) -> Result<(), TokenTransferError>; | ||
|
|
||
| /// This function should enable burning of minted tokens in a user account | ||
| fn burn_coins_execute( | ||
| &mut self, | ||
| account: &Self::AccountId, | ||
| coin: &PrefixedCoin, | ||
| ) -> Result<(), TokenTransferError>; | ||
| } | ||
|
|
||
| /// Helper function to generate an escrow address for a given port and channel | ||
| /// ids according to the format specified in the Cosmos SDK | ||
| /// [`ADR-028`](https://github.com/cosmos/cosmos-sdk/blob/master/docs/architecture/adr-028-public-key-addresses.md) | ||
| pub fn cosmos_adr028_escrow_address(port_id: &PortId, channel_id: &ChannelId) -> Vec<u8> { | ||
| let contents = format!("{port_id}/{channel_id}"); | ||
|
|
||
| let mut hasher = Sha256::new(); | ||
| hasher.update(VERSION.as_bytes()); | ||
| hasher.update([0]); | ||
| hasher.update(contents.as_bytes()); | ||
|
|
||
| let mut hash = hasher.finalize().to_vec(); | ||
| hash.truncate(20); | ||
| hash | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use subtle_encoding::bech32; | ||
|
|
||
| use super::*; | ||
| use crate::context::cosmos_adr028_escrow_address; | ||
|
|
||
| #[test] | ||
| fn test_cosmos_escrow_address() { | ||
| fn assert_eq_escrow_address(port_id: &str, channel_id: &str, address: &str) { | ||
| let port_id = port_id.parse().unwrap(); | ||
| let channel_id = channel_id.parse().unwrap(); | ||
| let gen_address = { | ||
| let addr = cosmos_adr028_escrow_address(&port_id, &channel_id); | ||
| bech32::encode("cosmos", addr) | ||
| }; | ||
| assert_eq!(gen_address, address.to_owned()) | ||
| } | ||
|
|
||
| // addresses obtained using `gaiad query ibc-transfer escrow-address [port-id] [channel-id]` | ||
| assert_eq_escrow_address( | ||
| "transfer", | ||
| "channel-141", | ||
| "cosmos1x54ltnyg88k0ejmk8ytwrhd3ltm84xehrnlslf", | ||
| ); | ||
| assert_eq_escrow_address( | ||
| "transfer", | ||
| "channel-207", | ||
| "cosmos1ju6tlfclulxumtt2kglvnxduj5d93a64r5czge", | ||
| ); | ||
| assert_eq_escrow_address( | ||
| "transfer", | ||
| "channel-187", | ||
| "cosmos177x69sver58mcfs74x6dg0tv6ls4s3xmmcaw53", | ||
| ); | ||
| } | ||
| } |
16 changes: 8 additions & 8 deletions
16
...es/ibc/src/applications/transfer/relay.rs → ...bc-apps/ics20-transfer/src/handler/mod.rs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
17 changes: 9 additions & 8 deletions
17
...ications/transfer/relay/on_recv_packet.rs → ...20-transfer/src/handler/on_recv_packet.rs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
27 changes: 12 additions & 15 deletions
27
...lications/transfer/relay/send_transfer.rs → ...s20-transfer/src/handler/send_transfer.rs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.