Skip to content

Commit 016ba0b

Browse files
chore: readme updates (#3664)
* readme updates * remove link
1 parent b1301e7 commit 016ba0b

File tree

3 files changed

+4
-84
lines changed

3 files changed

+4
-84
lines changed

CONTRIBUTING.md

-2
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,6 @@ New features or improvements should be written in an issue using the [new featur
2323
- discarding the suggestion if deemed not aligned with the objectives of ibc-go;
2424
- or proposing (in the case of applications or light clients) to be developed and maintained in a separate repository.
2525

26-
Please check out also our [Request For Maintainership](./MAINTAINERSHIP.md) process, which contains information relevant to this.
27-
2826
### Architecture Decision Records (ADR)
2927

3028
When proposing an architecture decision for the ibc-go, please create an [ADR](./docs/architecture/README.md) so further discussions can be made. We are following this process so all involved parties are in agreement before any party begins coding the proposed implementation. Please use the [ADR template](./docs/architecture/adr-template.md) to scaffold any new ADR. If you would like to see some examples of how these are written refer to ibc-go's [ADRs](./docs/architecture/). Solidified designs that will be implemented in ibc-go (and do not have a spec). They should document the architecture that will be built. Most design feedback should be gathered before the initial draft of the ADR. ADR's can/should be written for any design decisions we make which may be changed at some point in the future.

MAINTAINERSHIP.md

-62
This file was deleted.

README.md

+4-20
Original file line numberDiff line numberDiff line change
@@ -59,21 +59,7 @@ Please refer to our [versioning guide](https://github.com/cosmos/ibc-go/blob/mai
5959

6060
## Ecosystem
6161

62-
Discover the applications, middleware and light clients developed by other awesome teams in the ecosystem:
63-
64-
In the table below
65-
`app` refers to IBC application modules for custom use cases and
66-
`middleware` refers to modules that wrap an IBC application enabling custom logic to be executed.
67-
68-
|Description|Repository|Type|
69-
|----------|----------|----|
70-
|An application that enables on chain querying of another IBC enabled chain utilizing `baseapp.Query`. Both chains must have implemented the query application and ICA (for queries requiring consensus).|[async-icq](https://github.com/strangelove-ventures/async-icq)|`app`|
71-
|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.|[interchain-queries](https://github.com/ingenuity-build/interchain-queries)|`app`|
72-
|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.|[query](https://github.com/defund-labs/defund/tree/main/x/query)|`app`|
73-
|An application that enables cross chain NFT transfer.|[NFT Transfer (ICS 721)](https://github.com/bianjieai/nft-transfer)|`app`|
74-
|Middleware enabling a packet to be sent to a destination chain via an intermediate chain, e.g. going from Juno to Osmosis via the Hub.|[packet-forward-middleware](https://github.com/strangelove-ventures/packet-forward-middleware)|`middleware`|
75-
|Middleware enabling the recovery of tokens sent to unsupported addresses.|[recovery](https://github.com/evmos/evmos/tree/main/x/recovery)|`middleware`|
76-
|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|[ibc-rate-limit](https://github.com/osmosis-labs/osmosis/tree/main/x/ibc-rate-limit)|`middleware`|
62+
Discover more applications and middleware in the [cosmos/ibc-apps repository](https://github.com/cosmos/ibc-apps#-bonus-content).
7763

7864
## Support
7965

@@ -98,13 +84,9 @@ If you are interested in working on an issue, please comment on it; then we will
9884

9985
If you have any general questions or feedback, please reach out to us in the [IBC Gang Discord server](https://discord.com/channels/955868717269516318/955883113484013578).
10086

101-
## Request for maintainership
102-
103-
We have a document that describes the process for [submitting a feature for maintainership](./MAINTAINERSHIP.md) in the ibc-go codebase.
104-
10587
## Security
10688

107-
To report a security vulnerability, see our [bug bounty program](https://hackerone.com/cosmos).
89+
To report a security vulnerability, see our [Coordinated Vulnerability Disclosure Policy](./SECURITY.md).
10890

10991
## Audits
11092

@@ -144,6 +126,8 @@ The following audits have been performed on the `ibc-go` source code:
144126

145127
4.2 [ICS 06 Solo Machine](https://github.com/cosmos/ibc-go/tree/main/modules/light-clients/06-solomachine)
146128

129+
4.3 [ICS 09 Localhost](https://github.com/cosmos/ibc-go/tree/main/modules/light-clients/09-localhost)
130+
147131
5. **[E2E Integration Tests](https://github.com/cosmos/ibc-go/tree/main/e2e)**
148132

149133
## Documentation and Resources

0 commit comments

Comments
 (0)