feat: adding 09-localhost loopback client module #3229

damiannolan · 2023-03-02T12:27:25Z

Description

The following PR adds v2 of the 09-localhost light client module.

closes: #3034

Commit Message / Changelog Entry

feat: adding 09-localhost loopback client module [\#3034](https://github.com/cosmos/ibc-go/issues/3034). Please see the 09-localhost documentation [here](https://ibc.cosmos.network/main/ibc/light-clients/localhost/overview.html).
feat: AllowedClients on-chain param allows chains to pause usage of specific client types by removing the client type from the param.
imp: Update all channel events to use `connection_id` attribute. The `packet_connection` attribute has been deprecated.

see the guidelines for commit messages. (view raw markdown for examples)

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

Targeted PR against correct branch (see CONTRIBUTING.md).
Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
Code follows the module structure standards and Go style guide.
Wrote unit and integration tests.
Updated relevant documentation (docs/) or specification (x/<module>/spec/).
Added relevant godoc comments.
Provide a commit message to be used for the changelog entry in the PR description for review.
Re-reviewed Files changed in the Github PR explorer.
Review Codecov Report in the comment section below once CI passes.

…e core IBC store for localhost clients (#3083)

* adding localhost AppModuleBasic to app.go. adding localhost client to InitGenesis. Fixing update localhost client * renmaing variable * adding migration handler for enabling localhost client * updating to use clienttypes.GetSelfHeight()

* adding initial localhost client testing scaffolding * add testing placeholders, adapt initialise code, wire AppModuleBasic * adding happy path test cases, fixing store prefixing in verify membership/non-membership * formatting * adding additional test cases * adding remaining test cases * adding inline comments

* return an error from 09-localhost client VerifyClientMessage * fix typo --------- Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* disallow localhost client creation, adapt tests * adapting logic to accomodate usage of allowed clients in InitGenesis * move localhost check to separate conditional

* use temporary relayer tag for e2e testing localhost * WIP commiting * updating codec and handling txResp * WIP scaffold happy path out * adding some temporary todos * adding msg response unmarshalling, and adding interchain accounts handshake test * adding ica send packet testing, cleanup..etc * adding separate test suite for localhost transfer tests (#3144) * add separate test suite struct for ICA localhost * fixing testsuite embedding * review suggestions - events func and nits * testcase naming --------- Co-authored-by: Cian Hatton <cian@interchain.io>

* use temporary relayer tag for e2e testing localhost * WIP commiting * updating codec and handling txResp * WIP scaffold happy path out * adding some temporary todos * adding msg response unmarshalling, and adding interchain accounts handshake test * adding ica send packet testing, cleanup..etc * adding separate test suite for localhost transfer tests (#3144) * add separate test suite struct for ICA localhost * fixing testsuite embedding * adding test for ica channel close and reopen --------- Co-authored-by: Cian Hatton <cian@interchain.io>

) * imp: change validateHeight function name to validateConsensusHeight and improve code documentation * revert: change code back to how it is on main Revert code changes as they were unnecessary given that a localhost connection cannot be created via the connection handshake

damiannolan · 2023-03-02T12:52:38Z

e2e/relayer/relayer.go

@@ -15,8 +15,8 @@ const (
 	Rly    = "rly"
 	Hermes = "hermes"

-	cosmosRelayerRepository = "ghcr.io/cosmos/relayer"
-	cosmosRelayerUser       = "100:1000" // docker run -it --rm --entrypoint echo ghcr.io/cosmos/relayer "$(id -u):$(id -g)"
+	cosmosRelayerRepository = "damiannolan/rly" //"ghcr.io/cosmos/relayer"


cosmos/relayer#1102

chatton

Maybe we can add a link to where the docs will be in the commit message?

And link to the localhost issue with a breakdown of all sub issues

Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com> Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

colin-axner

:)

colin-axner · 2023-03-08T15:46:06Z

.github/workflows/e2e-upgrade.yaml

+      chain-a-tag: pr-3136 # TODO: needs v7.0.0 (with simapp fixes) when cut
+      chain-b-tag: pr-3136 # TODO: needs v7.0.0 (with simapp fixes) when cut


Is there an issue for this?

colin-axner · 2023-03-08T15:56:03Z

modules/core/02-client/types/keys.go

+	if clientID == exported.LocalhostClientID {
+		return clientID, 0, nil
+	}


Regrets of not starting client identifiers at 1 😅 Would have been very clean with localhost being 0

I kind of think we should consider making this function private (or separating functionality) if it's possible two different client identifiers return 0 for the sequence. Not a concern to handle right now, but in non-test code this is used only to verify the identifier is parseable or to validate the NextClientSequence in 02-client/types/genesis.go#Validate. I would propose only parsing the identifier within that function

#3173 might make this easier to handle

chatton

LGTM 🥳 🥳 🎈

chatton · 2023-03-08T16:01:28Z

docs/migrations/v7-to-v7_1.md

+
+In the previous release of ibc-go, the localhost `v1` light client module was deprecated and removed. The ibc-go `v7.1.0` release introduces `v2` of the 09-localhost light client module.
+
+<!-- TODO: Update the links to use release version instead of feat branch -->


is there an issue for this? This will be a dead link as soon as the branch is deleted.

will create one for this so we don't lose it if it doesn't exist.

feat: adding 09-localhost loopback client module [\#3034](#3034). Please see the 09-localhost documentation [here](https://ibc.cosmos.network/main/ibc/light-clients/localhost/overview.html). feat: AllowedClients on-chain param allows chains to pause usage of specific client types by removing the client type from the param. imp: Update all channel events to use `connection_id` attribute. The `packet_connection` attribute has been deprecated. (cherry picked from commit d840c69) # Conflicts: # .github/workflows/e2e-upgrade.yaml # docs/ibc/events.md # e2e/relayer/relayer.go # e2e/testconfig/testconfig.go # e2e/tests/upgrades/upgrade_test.go # e2e/testsuite/codec.go # e2e/testsuite/grpc_query.go # e2e/testsuite/testsuite.go # modules/core/02-client/keeper/client.go # modules/core/02-client/keeper/proposal.go # modules/core/02-client/types/errors.go # modules/core/03-connection/keeper/verify.go # modules/core/03-connection/types/msgs_test.go # modules/core/04-channel/keeper/packet.go # modules/core/04-channel/types/msgs.go

) * Adding 09-localhost loopback client module (#3229) feat: adding 09-localhost loopback client module [\#3034](#3034). Please see the 09-localhost documentation [here](https://ibc.cosmos.network/main/ibc/light-clients/localhost/overview.html). feat: AllowedClients on-chain param allows chains to pause usage of specific client types by removing the client type from the param. imp: Update all channel events to use `connection_id` attribute. The `packet_connection` attribute has been deprecated. (cherry picked from commit d840c69) # Conflicts: # .github/workflows/e2e-upgrade.yaml # docs/ibc/events.md # e2e/relayer/relayer.go # e2e/testconfig/testconfig.go # e2e/tests/upgrades/upgrade_test.go # e2e/testsuite/codec.go # e2e/testsuite/grpc_query.go # e2e/testsuite/testsuite.go # modules/core/02-client/keeper/client.go # modules/core/02-client/keeper/proposal.go # modules/core/02-client/types/errors.go # modules/core/03-connection/keeper/verify.go # modules/core/03-connection/types/msgs_test.go # modules/core/04-channel/keeper/packet.go # modules/core/04-channel/types/msgs.go * rm -rf e2e * rm .github/workflows/e2e-upgrade.yaml * fix errorsmod -> sdkerrors * ibcerror -> sdkerror in localhost client_state.go --------- Co-authored-by: Damian Nolan <damiannolan@gmail.com>

damiannolan and others added 30 commits January 18, 2023 20:20

add EnableLocalhost to 03-connection

b996c6c

adding godoc and temp comment

b080ff9

dumping 09-localhost client state boilerplate

ccfb9fb

adding codec and app module basic

3416304

rearrange code in client_state.go

6b85352

adding conditional checks for localhost client

8f13c75

adding localhost connection id const

a679368

updating client state for localhost

f5d0abd

adding abci call to update localhost client state

2dee015

add basic update method, update godocs

6c33d2e

Merge branch 'main' into 09-localhost

da61d3a

Add sentinel localhost connection end to genesis state (#3040)

42cb750

adding getClientStateAndKVStore to 03-connection verify.go to retriev…

bf26904

…e core IBC store for localhost clients (#3083)

Remove ProofHeight and Proof Validation in msg.ValidateBasic (#3061)

3715153

updating errors returns in 09-localhost (#3105)

badc331

remove chain id from localhost client (#3103)

0e72157

Merge branch 'main' into 09-localhost

fdd332e

return error in 09-localhost VerifyClientMessage (#3115)

40ca344

* return an error from 09-localhost client VerifyClientMessage * fix typo --------- Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

disallow localhost client creation in 02-client (#3114)

c7d798b

* disallow localhost client creation, adapt tests * adapting logic to accomodate usage of allowed clients in InitGenesis * move localhost check to separate conditional

Merge branch 'main' into 09-localhost

9681f65

Merge branch 'main' into 09-localhost

4557d2d

Merge branch 'main' into 09-localhost

8e11eb1

revert: unnecessary code change for localhost (#3170)

d4e24d1

adding localhost client ID checks to init and try validate basic (#3169)

fe24586

Bumping localhost light client proto to v2 (#3168)

69e1a51

damiannolan requested review from AdityaSripal, crodriguezvega, charleenfei, chatton and tmsdkeys as code owners March 2, 2023 12:51

damiannolan commented Mar 2, 2023

View reviewed changes

AdityaSripal approved these changes Mar 2, 2023

View reviewed changes

chatton reviewed Mar 2, 2023

View reviewed changes

crodriguezvega added the backport-to-v7.1.x label Mar 2, 2023

crodriguezvega and others added 10 commits March 2, 2023 16:01

chore: client state key nit (#3226)

0ec6aad

indentation

5145187

indentation

9a41fe1

add 09-locahost to default list

1e131c7

update events.md

5c0fc8b

Merge branch 'main' into 09-localhost

4bad6d2

adding migration doc for v7.1 localhost client (#3210)

78cdc69

Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com> Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

ran go mod tidy

38f7d99

changed tendermint to cometbft

12bd5b8

chore: add in-code comment

b67680f

colin-axner approved these changes Mar 8, 2023

View reviewed changes

Merge branch 'main' into 09-localhost

3290689

chatton approved these changes Mar 8, 2023

View reviewed changes

colin-axner mentioned this pull request Mar 8, 2023

Update e2e-upgrade workflow with release tags for v7.1.0-rc #3261

Closed

3 tasks

chatton merged commit d840c69 into main Mar 8, 2023

chatton deleted the 09-localhost branch March 8, 2023 16:31

mergify bot mentioned this pull request Mar 8, 2023

feat: adding 09-localhost loopback client module (backport #3229) #3262

Merged

chatton mentioned this pull request Mar 8, 2023

Update the links to use release version instead of feature branch #3263

Closed

3 tasks

faddat mentioned this pull request Jun 23, 2023

v7.2.0 for sdk 50 #3948

Closed

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: adding 09-localhost loopback client module #3229

feat: adding 09-localhost loopback client module #3229

damiannolan commented Mar 2, 2023 •

edited by colin-axner

Loading

damiannolan Mar 2, 2023

chatton left a comment •

edited

Loading

colin-axner left a comment

colin-axner Mar 8, 2023

colin-axner Mar 8, 2023

colin-axner Mar 8, 2023

chatton left a comment

chatton Mar 8, 2023

chatton Mar 8, 2023

		chain-a-tag: pr-3136 # TODO: needs v7.0.0 (with simapp fixes) when cut
		chain-b-tag: pr-3136 # TODO: needs v7.0.0 (with simapp fixes) when cut


		In the previous release of ibc-go, the localhost `v1` light client module was deprecated and removed. The ibc-go `v7.1.0` release introduces `v2` of the 09-localhost light client module.

		<!-- TODO: Update the links to use release version instead of feat branch -->

feat: adding 09-localhost loopback client module #3229

feat: adding 09-localhost loopback client module #3229

Conversation

damiannolan commented Mar 2, 2023 • edited by colin-axner Loading

Description

Commit Message / Changelog Entry

damiannolan Mar 2, 2023

Choose a reason for hiding this comment

chatton left a comment • edited Loading

Choose a reason for hiding this comment

colin-axner left a comment

Choose a reason for hiding this comment

colin-axner Mar 8, 2023

Choose a reason for hiding this comment

colin-axner Mar 8, 2023

Choose a reason for hiding this comment

colin-axner Mar 8, 2023

Choose a reason for hiding this comment

chatton left a comment

Choose a reason for hiding this comment

chatton Mar 8, 2023

Choose a reason for hiding this comment

chatton Mar 8, 2023

Choose a reason for hiding this comment

damiannolan commented Mar 2, 2023 •

edited by colin-axner

Loading

chatton left a comment •

edited

Loading