Skip to content

Commit

Permalink
Merge branch 'main' into farhad/interchain-accounts
Browse files Browse the repository at this point in the history
  • Loading branch information
Farhad-Shabani committed Jul 6, 2023
2 parents 75e6387 + ce53256 commit 16aef3a
Show file tree
Hide file tree
Showing 92 changed files with 2,941 additions and 1,462 deletions.
3 changes: 3 additions & 0 deletions .changelog/v0.42.0/breaking-changes/296-static-clientstate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- Implement ADR 7, where `ClientState` objects are now statically dispatched instead
of dynamically dispatched.
([#296](https://github.com/cosmos/ibc-rs/issues/296))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Revise the `ChainId::new` method so that rather than taking String argument
it borrows a str. ([#721](https://github.com/cosmos/ibc-rs/issues/721))
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- Modify `MsgUpgradeClient` struct to utilize `CommitmentProofBytes` and
apply some refinements around upgrade client methods and impls respectively.
([#739](https://github.com/cosmos/ibc-rs/issues/739))
2 changes: 2 additions & 0 deletions .changelog/v0.42.0/bug/503-update-unclog-instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Remove Router::has_route
([\#503](https://github.com/cosmos/ibc-rs/issues/503))
1 change: 1 addition & 0 deletions .changelog/v0.42.0/improvement/617-remove-header-trait.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Remove Header trait ([#617](https://github.com/cosmos/ibc-rs/issues/617))
2 changes: 2 additions & 0 deletions .changelog/v0.42.0/improvement/655-remove-unwrap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Deny use of unwrap() throughout the crate
([#655](https://github.com/cosmos/ibc-rs/issues/655))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- ChainId should serialize itself without using tendermint::chain::Id
([#729](https://github.com/cosmos/ibc-rs/issues/729))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- feat: use FromStr in client_type functions to construct ClientType
([#731](https://github.com/cosmos/ibc-rs/pull/731))
3 changes: 3 additions & 0 deletions .changelog/v0.42.0/summary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
This release primarily implements ADR 7. It also includes a number of miscellaneous improvements.

There are no consensus-breaking changes.
23 changes: 0 additions & 23 deletions .github/workflows/release.yml

This file was deleted.

40 changes: 40 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,45 @@
# CHANGELOG

## v0.42.0

*July 5, 2023*

This release primarily implements ADR 7. It also includes a number of miscellaneous improvements.

There are no consensus-breaking changes.

### BREAKING CHANGES

- Implement ADR 7, where `ClientState` objects are now statically dispatched instead
of dynamically dispatched.
([#296](https://github.com/cosmos/ibc-rs/issues/296))
- Revise the `verify_upgrade_client` method to utilize the domain-specific
`MerkleProof` type
([#691](https://github.com/cosmos/ibc-rs/issues/691))
- Revise the `ChainId::new` method so that rather than taking String argument
it borrows a str. ([#721](https://github.com/cosmos/ibc-rs/issues/721))
- Modify `MsgUpgradeClient` struct to utilize `CommitmentProofBytes` and
apply some refinements around upgrade client methods and impls respectively.
([#739](https://github.com/cosmos/ibc-rs/issues/739))
- Remove `Router::has_route`
([#503](https://github.com/cosmos/ibc-rs/issues/503))

### FEATURES

- Upgrade to tendermint v0.32, ibc-proto-rs v0.32, ics23 v0.10, and get
prehash_key_before_comparison field available for the `ProofSpec`
([#640](https://github.com/cosmos/ibc-rs/issues/640))

### IMPROVEMENT

- Remove Header trait ([#617](https://github.com/cosmos/ibc-rs/issues/617))
- Deny use of `unwrap()` throughout the crate
([#655](https://github.com/cosmos/ibc-rs/issues/655))
- `ChainId` should serialize itself without using `tendermint::chain::Id`
([#729](https://github.com/cosmos/ibc-rs/issues/729))
- use `FromStr` in client_type functions to construct `ClientType`
([#731](https://github.com/cosmos/ibc-rs/pull/731))

## v0.41.0

*May 23, 2023*
Expand Down
29 changes: 16 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,22 +251,25 @@ Our release process is as follows:
3. Committing the updated `CHANGELOG.md` file and `.changelog` directory to the repo.
2. Push this to a branch `release/vX.Y.Z` according to the version number of
the anticipated release (e.g. `release/v0.18.0`) and open a **draft PR**.
3. Bump all relevant versions in the `crates/ibc/Cargo.toml` file (making sure
dependencies' versions are updated too) to the new version and push these
changes to the release PR.
4. In the `crates/ibc/` directory, run `cargo doc --all-features --open` locally to double-check that all the
3. If there were changes in the `ibc-derive` crate, we need to publish a new version of that crate.
1. bump the version in `crates/ibc-derive/Cargo.toml`
2. Publish `ibc-derive` with `cargo publish -p ibc-derive`
4. Bump all relevant versions in `crates/ibc/Cargo.toml` to the new version and
push these changes to the release PR.
+ If you released a new version of `ibc-derive` in step 3, make sure to update that dependency.
5. Run `cargo doc -p ibc --all-features --open` locally to double-check that all the
documentation compiles and seems up-to-date and coherent. Fix any potential
issues here and push them to the release PR.
5. In the `crates/ibc/` directory, run `cargo publish --dry-run` to double-check that publishing will work. Fix
6. Run `cargo publish -p ibc --dry-run` to double-check that publishing will work. Fix
any potential issues here and push them to the release PR.
6. Mark the PR as **Ready for Review** and incorporate feedback on the release.
7. Once approved, merge the PR, and pull the `main` branch.
8. Once all crates have been successfully released, create a signed tag and push it to
GitHub: `git tag -s -a vX.Y.Z`. In the tag message, write the version and the link
to the corresponding section of the changelog. Pushing the tag will trigger the [Release workflow](https://github.com/cosmos/ibc-rs/actions/workflows/release.yml),
which publishes the crate on crates.io.
9. Once the tag is pushed, create a GitHub release and append
7. Mark the PR as **Ready for Review** and incorporate feedback on the release.
8. Once approved, merge the PR, and pull the `main` branch.
9. Run `cargo publish -p ibc`
9. Create a signed tag and push it to GitHub: `git tag -s -a vX.Y.Z`. In the tag
message, write the version and the link to the corresponding section of the
changelog.
+ Push the tag with `git push --tags`
10. Once the tag is pushed, create a GitHub release and append
`[📖CHANGELOG](https://github.com/cosmos/ibc-rs/blob/main/CHANGELOG.md#vXYZ)`
to the release description.
10. Make sure that the [Release workflow](https://github.com/cosmos/ibc-rs/actions/workflows/release.yml) to crates.io has completed successfully.
11. All done! 🎉
3 changes: 2 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ resolver = "2"

members = [
"crates/ibc",
"crates/ibc-derive",
]

exclude = [
"ci/no-std-check",
]
]
65 changes: 37 additions & 28 deletions ci/no-std-check/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ci/no-std-check/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resolver = "2"

[dependencies]
ibc = { path = "../../crates/ibc", default-features = false }
ibc-proto = { version = "0.31.0", default-features = false, features = [
ibc-proto = { version = "0.32.0", default-features = false, features = [
"parity-scale-codec",
"borsh",
] }
Expand Down
17 changes: 17 additions & 0 deletions crates/ibc-derive/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[package]
name = "ibc-derive"
version = "0.1.0"
license = "Apache-2.0"
readme = "README.md"
description = "Macros implementation of #[derive(ClientState)] and #[derive(ConsensusState)]"
repository = "https://github.com/cosmos/ibc-rs"
edition = "2021"

[lib]
proc-macro = true

[dependencies]
syn = "2"
proc-macro2 = "1"
quote = "1"
darling = "0.20"
Loading

0 comments on commit 16aef3a

Please sign in to comment.