feat: add light client module for Celestia DA light client #6053

crodriguezvega · 2024-03-22T14:04:31Z

Description

closes: #5965

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.

coderabbitai · 2024-03-22T14:04:37Z

Important

Auto Review Skipped

Auto reviews are disabled on base/target branches other than the default branch. Please add the base/target branch pattern to the list of additional branches to be reviewed in the settings.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

To trigger a single review, invoke the @coderabbitai review command.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

crodriguezvega

The test I added is failing because of this check when trying to create a 07-celestia light client. Currently we have a custom 07-celestia ClientState but we reuse 07-tendermint ConsensusState, so maybe we need to create a custom 07-celestia ConsensusState` as well?

crodriguezvega · 2024-03-22T14:05:41Z

modules/light-clients/07-celestia/client_state.go

@@ -20,26 +20,6 @@ func (*ClientState) ClientType() string {
 	return ModuleName
 }

-// GetLatestHeight implements exported.ClientState.
-func (cs *ClientState) GetLatestHeight() exported.Height {


I removed these functions from ClientState and call instead .BaseClient directly in the light client module. I think it is cleaner that way, but the drawback is that the backport to v8.2.x will require more work.

Will we need to backport this feature?

Yes, we will have to backport these changes to the release branch of the DA light client that is compatible with ibc-go v8.3.x (and that version doesn't include the 02-client routing refactor).

It might be less overhead to take whats on the target branch now and separate that to a different branch for v8.3.x before merging this PR. It's no harm at least to replicate the feat/celestia-da-client before this PR is merged in case that might be helpful.

crodriguezvega · 2024-03-22T14:06:06Z

modules/light-clients/07-celestia/light_client_module.go

+	upgradeClientProof,
+	upgradeConsensusStateProof []byte,
+) error {
+	// TODO: do we need to implement this?


Question: do we need to implement this functionality?

We can add an issue for this and discuss later with celestia team

testing/simapp/app.go

crodriguezvega · 2024-03-25T08:14:35Z

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

-	if clientState.ClientType() != consensusState.ClientType() {
-		return errorsmod.Wrap(ErrInvalidClientType, "client type for client state and consensus state do not match")
-	}
+	// if clientState.ClientType() != consensusState.ClientType() {


Temporary hack to be able to run the tests.

Opened #6061.

…s state should match

crodriguezvega · 2024-03-26T08:42:23Z

I made this r4r although the check in MsgCreateClient ValidateBasic is commented out, but since this PR is going to a feat branch we can merge this and discuss in the meantime how to deal with it.

…dule # Conflicts: # modules/light-clients/07-celestia/celestia_test.go # modules/light-clients/07-celestia/client_state.go # modules/light-clients/07-celestia/update_test.go

AdityaSripal

Approved.

Just a question why did nmt need to be added to every single go.mod file event the ones in app/?

modules/light-clients/07-celestia/light_client_module.go

AdityaSripal · 2024-04-02T13:17:59Z

modules/light-clients/07-celestia/light_client_module.go

+	upgradeClientProof,
+	upgradeConsensusStateProof []byte,
+) error {
+	// TODO: do we need to implement this?


We can add an issue for this and discuss later with celestia team

chatton · 2024-04-03T13:47:36Z

Approved.

Just a question why did nmt need to be added to every single go.mod file event the ones in app/?

@AdityaSripal looks like these are being pulled in as indirect dependencies due to the local pin of ibc-go, not explicitly added to each go.mod.

damiannolan · 2024-04-03T20:20:27Z

Approved.
Just a question why did nmt need to be added to every single go.mod file event the ones in app/?

@AdityaSripal looks like these are being pulled in as indirect dependencies due to the local pin of ibc-go, not explicitly added to each go.mod.

I think they can be removed if feat/celestia-da-client is merged back into this branch witht the separate go module.

sonarqubecloud · 2024-04-09T21:36:48Z

Quality Gate passed for 'ibc-go'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

damiannolan

Happy to merge this now and continue with follow ups.

We should make a decision soon about what to do about queries etc, as client state and consensus state queries will 07-tendermint types as that's what's actually being stored on disk. Maybe this isn't a problem but its kinda unexpected behaviour unless its explicitly marked as something that is expected - seeing as 07-celestia should be a light weight wrapper around 07-tendermint. cc @AdityaSripal

crodriguezvega · 2024-04-10T10:04:33Z

Happy to merge this now and continue with follow ups.

We should make a decision soon about what to do about queries etc, as client state and consensus state queries will 07-tendermint types as that's what's actually being stored on disk. Maybe this isn't a problem but its kinda unexpected behaviour unless its explicitly marked as something that is expected - seeing as 07-celestia should be a light weight wrapper around 07-tendermint. cc @AdityaSripal

I will open an issue to keep track of this.

wip: light client module + tests

50be2ee

rename import

e9483b3

crodriguezvega commented Mar 22, 2024

View reviewed changes

Carlos Rodriguez added 7 commits March 22, 2024 15:19

error formating

72732f9

add light client module tests + temporary work around to make tests pass

840fa84

add tests for client state update state implementation

47640c1

gofumpt

f79727f

lint

c37bd64

go mod tidy

62f901a

more go mod tidy

5948289

crodriguezvega commented Mar 25, 2024

View reviewed changes

crodriguezvega added the priority PRs that need prompt reviews label Mar 25, 2024

Carlos Rodriguez added 2 commits March 25, 2024 10:18

update godocs

f4b8a0c

e2e: go mod tidy

1e2702d

crodriguezvega mentioned this pull request Mar 26, 2024

imp: add go.mod for 07-celestia #6056

Merged

10 tasks

comment out test that checks client type of client state and consensu…

62a5dc7

…s state should match

crodriguezvega marked this pull request as ready for review March 26, 2024 08:41

crodriguezvega requested review from colin-axner, AdityaSripal, damiannolan, srdtrk, chatton, charleenfei and DimitrisJim as code owners March 26, 2024 08:41

Merge branch 'feat/celestia-da-client' into carlos/da-light-client-mo…

c0bec40

…dule # Conflicts: # modules/light-clients/07-celestia/celestia_test.go # modules/light-clients/07-celestia/client_state.go # modules/light-clients/07-celestia/update_test.go

crodriguezvega mentioned this pull request Mar 26, 2024

Mismatch of client type returned by ClientState and ConsensusState in 07-celestia #6061

Closed

AdityaSripal reviewed Apr 2, 2024

View reviewed changes

Carlos Rodriguez and others added 2 commits April 4, 2024 10:28

add comments

cfbe313

chore: make tidy-all

4c05af6

AdityaSripal approved these changes Apr 10, 2024

View reviewed changes

damiannolan approved these changes Apr 10, 2024

View reviewed changes

crodriguezvega merged commit d57f8d4 into feat/celestia-da-client Apr 10, 2024
83 checks passed

crodriguezvega deleted the carlos/da-light-client-module branch April 10, 2024 10:03

crodriguezvega mentioned this pull request Apr 10, 2024

Implement LightClientModule interface for Celestia DA light client #5965

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add light client module for Celestia DA light client #6053

feat: add light client module for Celestia DA light client #6053

crodriguezvega commented Mar 22, 2024 •

edited

Loading

coderabbitai bot commented Mar 22, 2024 •

edited

Loading

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

crodriguezvega left a comment

crodriguezvega Mar 22, 2024 •

edited

Loading

AdityaSripal Apr 2, 2024

crodriguezvega Apr 4, 2024

damiannolan Apr 9, 2024

crodriguezvega Mar 22, 2024

AdityaSripal Apr 2, 2024

crodriguezvega Mar 25, 2024

crodriguezvega Mar 26, 2024

crodriguezvega commented Mar 26, 2024

AdityaSripal left a comment

AdityaSripal Apr 2, 2024

chatton commented Apr 3, 2024

damiannolan commented Apr 3, 2024

sonarqubecloud bot commented Apr 9, 2024

damiannolan left a comment

crodriguezvega commented Apr 10, 2024

feat: add light client module for Celestia DA light client #6053

feat: add light client module for Celestia DA light client #6053

Conversation

crodriguezvega commented Mar 22, 2024 • edited Loading

Description

coderabbitai bot commented Mar 22, 2024 • edited Loading

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

crodriguezvega left a comment

Choose a reason for hiding this comment

crodriguezvega Mar 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

crodriguezvega commented Mar 26, 2024

AdityaSripal left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chatton commented Apr 3, 2024

damiannolan commented Apr 3, 2024

sonarqubecloud bot commented Apr 9, 2024

Quality Gate passed for 'ibc-go'

damiannolan left a comment

Choose a reason for hiding this comment

crodriguezvega commented Apr 10, 2024

crodriguezvega commented Mar 22, 2024 •

edited

Loading

coderabbitai bot commented Mar 22, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

crodriguezvega Mar 22, 2024 •

edited

Loading