From d50aa0f3cb5b8d89f637c50890a528ed19f50038 Mon Sep 17 00:00:00 2001 From: Reece Williams Date: Wed, 20 Mar 2024 23:02:34 -0500 Subject: [PATCH] fix broken links --- .github/workflows/mispell.yml | 5 +++-- CONTRIBUTING.md | 2 +- README.md | 23 ++++++++++------------- 3 files changed, 14 insertions(+), 16 deletions(-) diff --git a/.github/workflows/mispell.yml b/.github/workflows/mispell.yml index 98f50201..1e4524a7 100644 --- a/.github/workflows/mispell.yml +++ b/.github/workflows/mispell.yml @@ -4,7 +4,7 @@ on: pull_request: jobs: - build: + fix: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 @@ -13,4 +13,5 @@ jobs: run: | # .codespellrc is used sudo apt-get install codespell -y - codespell -w --config .codespellrc \ No newline at end of file + codespell -w --config .codespellrc + exit $? \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d0e53ce1..ca0adf44 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,7 +28,7 @@ For modules, ensure full test coverage and compatibility with the main branch. - [ ] After approval, write privileges will be granted to a member of an external team. - [ ] Merging PRs will require approval from more than one team -Privileges will be revoked in case of failure to comply with the [Code of Conduct](../CODE_OF_CONDUCT.md) +Privileges will be revoked in case of failure to comply with the [Code of Conduct](./CODE_OF_CONDUCT.md) ## Versioning diff --git a/README.md b/README.md index befca7f1..717a5ae1 100644 --- a/README.md +++ b/README.md @@ -7,17 +7,17 @@ IBC applications and middleware for Cosmos SDK blockchains 🌌 Why have an ibc-apps repo? ================================ -Early IBC work started in the [ibc-go](https://github.com/cosmos/ibc-go) repo. As the repo grew, the need arose to parallelize the work among many teams. +Early IBC work started in the [ibc-go](https://github.com/cosmos/ibc-go) repo. As the repo grew, the need arose to parallelize the work among many teams. The ibc-apps repo is meant to be an easily discoverable, navigable, central place for modules and middleware. 🌌🌌 Who's it for? =================== -IBC-Apps is for: +IBC-Apps is for: - _Core **ibc-go** contributors_; it frees them from having to maintain IBC Apps, -- _Publishers of **ibc apps**_, so their apps can be easily found, and +- _Publishers of **ibc apps**_, so their apps can be easily found, and - _Everyone who uses IBC_ and wants to benefit from the full range of its capabilities. @@ -40,7 +40,7 @@ IBC apps can be split into two categories - modules and middleware. IBC Modules are self-contained applications that enable packets to be sent to and received from other IBC-enabled chains. IBC application developers do not need to concern themselves with the low-level details of clients, connections, and proof verification. -IBC Middleware are self-contained modules that sit between core IBC and an underlying IBC application. This allows developers to customize lower-level packet handling. Multiple middleware modules can be chained together. +IBC Middleware are self-contained modules that sit between core IBC and an underlying IBC application. This allows developers to customize lower-level packet handling. Multiple middleware modules can be chained together. 🌌🌌🌌🌌 How to Use this repo @@ -51,10 +51,6 @@ If you'd like to include software in this repo, please see [contributing](../ibc 🌌🌌🌌🌌🌌 Bonus Content ============================= -## Hello World - -An [example IBC app](./examples/hello-world/) - ## Maintained Branches | **Branch Name** | **IBC-Go** | @@ -68,7 +64,7 @@ An [example IBC app](./examples/hello-world/) ## List of Apps | Name | Type | Example | Stakeholders | Description | -| ---- | ---- | ------- | ------------ | ----------- | +| ---- | ---- | ------- | ------------ | ----------- | | [Async Interchain Query](./modules/async-icq/) | Module | Link | [Strangelove](https://github.com/strangelove-ventures/) | Interchain Queries enable blockchains to query the state of an account on another chain without the need for ICA auth. | | [IBC Hooks](./modules/ibc-hooks/) | Module | [Link](./modules/ibc-hooks/simapp/app.go) | [Osmosis](https://github.com/osmosis-labs) | The IBC hooks module is an IBC middleware that enables ICS-20 token transfers to initiate contract calls. | | [Packet Forward Middleware](./middleware/packet-forward-middleware) | Middleware | Link | [Strangelove](https://github.com/strangelove-ventures/) | Middleware for forwarding IBC packets. | @@ -78,12 +74,13 @@ An [example IBC app](./examples/hello-world/) Modules and middleware developed by other awesome teams in the ecosystem: | Name | Type | Stakeholders | Description | -| ---- | ---- | ------------ | ----------- | +| ---- | ---- | ------------ | ----------- | | [Interchain KV Queries](https://github.com/ingenuity-build/interchain-queries) | Module | [Ingenuity](https://github.com/ingenuity-build) | An application that enables on chain querying of another IBC enabled chains state without the need for the chain being queried to implement the application. | | [query](https://github.com/defund-labs/defund/tree/main/x/query) | Module | [Defund Labs](https://github.com/defund-labs) | An application that enables on chain querying of another IBC enabled chains state without the need for the chain being queried to implement the application. Similar to the interchain-queries application in the row above but without callbacks. | | [NFT Transfer (ICS 721)](https://github.com/bianjieai/nft-transfer) | Module | [Bianjieai](https://github.com/bianjieai) | An application that enables cross chain NFT transfer. | -| [CosmWasm NFT Transfer (ICS 721)](https://github.com/public-awesome/cw-ics721) | WASM Contract | [Public Awesome (Stargaze)](https://github.com/public-awesome), [Ark Protocol](https://twitter.com/ArkProtocol) | An application that enables cross chain NFT transfer. CosmWasm implementation of the above, written in Rust. | -| [recovery](https://github.com/evmos/evmos/tree/main/x/recovery) | Middleware | [Evmos](https://github.com/evmos) | Middleware enabling the recovery of tokens sent to unsupported addresses. | + +| [CosmWasm NFT Transfer (ICS 721)](https://github.com/public-awesome/cw-ics721) | WASM Contract | [Public Awesome (Stargaze)](https://github.com/public-awesome), [Ark Protocol](https://x.com/ArkProtocol) | An application that enables cross chain NFT transfer. CosmWasm implementation of the above, written in Rust. | +| [recovery](https://github.com/evmos/evmos/tree/v15.0.0/x/recovery) | Middleware | [Evmos](https://github.com/evmos) | Middleware enabling the recovery of tokens sent to unsupported addresses. | | [ibc-rate-limit](https://github.com/osmosis-labs/osmosis/tree/main/x/ibc-rate-limit) | Middleware | [Osmosis Labs](https://github.com/osmosis-labs) | Middleware that limits the in or out flow of an asset in a certain time period to minimise the risks of cross chain token transfers. This is implemented as a middleware wrapping ICS20 with the rate limiting logic implemented by cosmwasm contracts. | -| [Interchain Atomic Swap](https://github.com/sideprotocol/ibcswap-wasm/tree/main/contracts/ics100) | WASM Contract | [Side Labs](https://github.com/sideprotocol) | An application that facilitates inter-blockchain peer-to-peer asset swaps. | +| [Interchain Atomic Swap](https://github.com/sideprotocol/mesh-liquidity-wasm/tree/v0.1.0/contracts/ics100) | WASM Contract | [Side Labs](https://github.com/sideprotocol) | An application that facilitates inter-blockchain peer-to-peer asset swaps. | | [Interchain Liquidity](https://github.com/sideprotocol/ibcswap-wasm/tree/main/contracts/ics101) | WASM Contract | [Side Labs](https://github.com/sideprotocol) | An application that splits the state of a weighted liquidity pool between two chains, enabling inter-blockchain automated asset swaps. |