Skip to content

Commit

Permalink
docs: added table of content
Browse files Browse the repository at this point in the history
  • Loading branch information
srdtrk committed Dec 30, 2023
1 parent fcfdbd7 commit 0c4672c
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 0c4672c

Please sign in to comment.