From 0c4672cd831fdedc3d54487fcd736ea53f22b6d5 Mon Sep 17 00:00:00 2001 From: srdtrk Date: Sat, 30 Dec 2023 12:24:21 +0300 Subject: [PATCH] docs: added table of content --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 5e0c0b19..60fad557 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,25 @@ This is a CosmWasm smart contract that communicates with the golang ica/host mod This contract was originally written to test the `proto3json` encoding/decoding [feature added to interchain accounts](https://github.com/cosmos/ibc-go/pull/3796). This contract now supports both `proto3json` and protobuf encoding/decoding. **The recommended encoding is protobuf.** If no encoding is specified, then the contract will default to protobuf encoding. +## Table of Contents + +- [CosmWasm ICA Controller Contract](#cosmwasm-ica-controller-contract) + - [Table of Contents](#table-of-contents) + - [Usage](#usage) + - [Create an interchain account](#create-an-interchain-account) + - [Using `InstantiateMsg` and/or `ExecuteMsg::CreateChannel`](#using-instantiatemsg-andor-executemsgcreatechannel) + - [Using the Relayer](#using-the-relayer) + - [Execute an interchain account transaction](#execute-an-interchain-account-transaction) + - [`SendCosmosMsgs`](#sendcosmosmsgs) + - [`SendCustomIcaMessages`](#sendcustomicamessages) + - [Execute a callback](#execute-a-callback) + - [Channel Closing and Reopening](#channel-closing-and-reopening) + - [Testing](#testing) + - [Unit tests](#unit-tests) + - [End to end tests](#end-to-end-tests) + - [Limitations](#limitations) + - [Acknowledgements](#acknowledgements) + ## Usage The following is a brief overview of the contract's functionality. You can also see the various ways this contract can be used in the end to end tests in the `e2e` directory.