From 16ff7cd9130199b113a5344bee478467ed7454ac Mon Sep 17 00:00:00 2001 From: srdtrk Date: Sat, 30 Dec 2023 12:37:39 +0300 Subject: [PATCH 1/3] docs: added Releases to readme --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 60fad557..d54d4df8 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,7 @@ This contract was originally written to test the `proto3json` encoding/decoding - [Testing](#testing) - [Unit tests](#unit-tests) - [End to end tests](#end-to-end-tests) + - [Releases](#releases) - [Limitations](#limitations) - [Acknowledgements](#acknowledgements) @@ -283,6 +284,13 @@ In general, the unit tests are for testing the verification functions for the ha The end to end tests are for testing the contract's functionality in an environment mimicking production. To see whether or not it can perform the channel handshake, send packets, and execute callbacks. We achieve this by running two local chains, one for the contract, and one for the host chain. The relayer is then used to perform the channel handshake, and send packets. The contract then executes callbacks based on the result of the packet. To learn more about the end to end tests, see the [Readme](./e2e/Readme.md) in the `e2e` directory. +## Releases + +This contract follows [semantic versioning](https://semver.org/), but with the following deviations: + +- A major version will not be tagged until the contract is audited. +- Any API breaking changes or state-machine breaking changes will result in a minor version bump. + ## Limitations This contract is not meant to be used in production. It is meant to be used as a reference implementation for how to build a CosmWasm contract that can communicate with the golang ica/host module. The following are some of the limitations of this contract: From 3937451566e0555c0bcf6f0013067993fffac6b4 Mon Sep 17 00:00:00 2001 From: srdtrk Date: Sat, 30 Dec 2023 12:54:02 +0300 Subject: [PATCH 2/3] docs: created CHANGELOG.md --- CHANGELOG.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..1483ae4d --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,35 @@ +# Changelog + +## v0.1.1 (2023-10-21) + +Initial release. + +### Features + +- Relayer initiated channel opening. +- Added `ExecuteMsg::SendCustomIcaMessages` to send custom ICA messages. +- Added `ExecuteMsg::SendPredefinedAction` to send predefined ICA messages for testing. +- Added a `CallbackCounter` to count the number of ICA callbacks. + +## v0.1.2 (2023-10-25) + +### Features + +- Added `helpers.rs` for external contracts. (https://github.com/srdtrk/cw-ica-controller/commit/bef4d34cc674892725c36c5fcbb467aaa38c38c8) + +## v0.1.3 (2023-10-28) + +### Features + +- Added contract instantiated channel opening. (https://github.com/srdtrk/cw-ica-controller/pull/13) + +## v0.2.0 (2023-11-09) + +### Features + +- Added callbacks to external contracts. (https://github.com/srdtrk/cw-ica-controller/pull/16) + +### API Breaking Changes + +- Removed `ExecuteMsg::SendPredefinedAction` (https://github.com/srdtrk/cw-ica-controller/pull/16) +- Removed `library` feature. (https://github.com/srdtrk/cw-ica-controller/pull/20) From 18adb20bf53a4a7aeece9ae26a5cf9b0bb8378bf Mon Sep 17 00:00:00 2001 From: srdtrk Date: Sat, 30 Dec 2023 13:08:58 +0300 Subject: [PATCH 3/3] docs: added CHANGELOG.md --- CHANGELOG.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1483ae4d..37397208 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -33,3 +33,14 @@ Initial release. - Removed `ExecuteMsg::SendPredefinedAction` (https://github.com/srdtrk/cw-ica-controller/pull/16) - Removed `library` feature. (https://github.com/srdtrk/cw-ica-controller/pull/20) + +## v0.3.0 (2023-12-30) + +### Features + +- Added `CosmosMsg` support. (https://github.com/srdtrk/cw-ica-controller/pull/28) + +### API Breaking Changes + +- Removed stargate query fallback in the contract. (https://github.com/srdtrk/cw-ica-controller/pull/31) +- Switched to `cw-ownable` for contract's admin management. (https://github.com/srdtrk/cw-ica-controller/pull/25)