Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make client events compatible with ibc-go v5.0.0 #138

Merged
merged 29 commits into from
Oct 11, 2022
Merged

Make client events compatible with ibc-go v5.0.0 #138

merged 29 commits into from
Oct 11, 2022

Conversation

plafer
Copy link
Contributor

@plafer plafer commented Oct 4, 2022 •
edited
Loading

Closes: #144

Description

Left to do:

PR author checklist:

  • Added changelog entry, using unclog.
  • Added tests.
  • Linked to GitHub issue.
  • Updated code comments and documentation (e.g., docs/).
  • Tagged one reviewer who will be the one responsible for shepherding this PR.

Reviewer checklist:

  • Reviewed Files changed in the GitHub PR explorer.
  • Manually tested (in case integration/unit/mock tests are absent).

@plafer plafer marked this pull request as draft October 4, 2022 20:00
@plafer plafer changed the title Makes events compatible with ibc-go v5.0.0 Make client events compatible with ibc-go v5.0.0 Oct 5, 2022
plafer and others added 14 commits October 5, 2022 15:47
@plafer
Add EventMessage
6fe8436
@plafer
client handlers emit ibcevent message
322393e
@plafer @hu55a1n1
Copy relevant ADRs from hermes repository (#147)
6689952 
* Add ADRs

* Update docs/architecture/adr-002-error.md

Co-authored-by: Shoaib Ahmed <[email protected]>
Signed-off-by: Philippe Laferrière <[email protected]>

* Update docs/architecture/adr-003-ics20-implementation.md

Co-authored-by: Shoaib Ahmed <[email protected]>
Signed-off-by: Philippe Laferrière <[email protected]>

* Update docs/architecture/adr-004-light-client-crates-extraction.md

Co-authored-by: Shoaib Ahmed <[email protected]>
Signed-off-by: Philippe Laferrière <[email protected]>

* Update docs/architecture/adr-001-handler-implementation.md

Co-authored-by: Shoaib Ahmed <[email protected]>
Signed-off-by: Philippe Laferrière <[email protected]>

* Update docs/architecture/adr-004-light-client-crates-extraction.md

Co-authored-by: Shoaib Ahmed <[email protected]>
Signed-off-by: Philippe Laferrière <[email protected]>

Signed-off-by: Philippe Laferrière <[email protected]>
Co-authored-by: Shoaib Ahmed <[email protected]>
@plafer
Fix CI (#151)
0e21771 
* std crate enabled for tests

* clippy no-default-features: still use clock feature

* patch ibc-proto to not use latest

* fix ibc-proto patch properly

* Allow deprecated (for crossing hellos fields)

* Remove ibc-proto rev for no-std

* fix no-std ibc-proto patch

* Remove comment
@plafer
fmt
69cc4a1
@plafer
Fix tests
ebd70cb 
Events will be tested in their own test rather than spread across
all tests.
@hu55a1n1 @plafer @seanchen1991
ADR 012: Handlers validation and execution separation (#153)
8c27778 
* init adr 12

* Host based API

* Add appendices

* Add section on event logging

* Add .changelog entry

* Fix TypedStore associated type (syntax only)

* Update docs/architecture/adr-012-handlers-redesign.md

Co-authored-by: Philippe Laferrière <[email protected]>

* validation vs execution clarifications

* Move ValidationContext and ExecutionContext methods to appendix

* Context clarification

* Rework Host-based API section

* ValidationContext and ExecutionContext clarification

* Move Event logging section + misc

* typo

* Remove statement. Was mentioned earlier already.

* IbcStore blanket implementation

* IbcValueForPath rework

* Remove IbcSerde from main ADR

* TypedStore -> SubStore

* diagram

* Update docs/architecture/adr-012-handlers-redesign.md

Co-authored-by: Sean Chen <[email protected]>

* Update docs/architecture/adr-012-handlers-redesign.md

Co-authored-by: Sean Chen <[email protected]>

* Update docs/architecture/adr-012-handlers-redesign.md

Co-authored-by: Sean Chen <[email protected]>

* add context for why the validation/execution split is necessary

* add trait bounds

* Rename ADR012 -> ADR005

* Apply suggestions from code review

Change ADR status from Proposed to Accepted

Co-authored-by: Philippe Laferrière <[email protected]>
Signed-off-by: Shoaib Ahmed <[email protected]>

Signed-off-by: Shoaib Ahmed <[email protected]>
Co-authored-by: Philippe Laferriere <[email protected]>
Co-authored-by: Sean Chen <[email protected]>
@hu55a1n1 @plafer
Setup unclog based changelog (#152)
1162a04 
* Add filtered changelog with ibc relevant entries

* Init unclog

* Add unreleased changelog entries
@plafer
clippy
a75d338
@plafer
Remove "message" ibc event
759a678
@plafer
update_client event test
687c3a0
@plafer
Remove unused function
66459cc
@plafer
upgrade client event
dcb1d60
@plafer
changelog
4a6f249
@plafer plafer marked this pull request as ready for review October 6, 2022 20:20
@plafer plafer requested a review from hu55a1n1 October 6, 2022 20:20
hu55a1n1
hu55a1n1 approved these changes Oct 11, 2022
View reviewed changes
Copy link
Member

@hu55a1n1 hu55a1n1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great stuff! Preapproved with some minor suggestions.

crates/ibc/src/events.rs Outdated Show resolved Hide resolved
crates/ibc/src/core/ics02_client/events.rs Outdated Show resolved Hide resolved
crates/ibc/src/core/ics02_client/events.rs Outdated Show resolved Hide resolved
crates/ibc/src/core/ics02_client/events.rs Show resolved Hide resolved
@plafer plafer mentioned this pull request Oct 11, 2022
Closed
@plafer plafer merged commit 0b9a4ae into main Oct 11, 2022
@plafer plafer deleted the plafer/ibcevent-go-compatible branch October 11, 2022 15:11
Farhad-Shabani pushed a commit that referenced this pull request Sep 9, 2024
@plafer @hu55a1n1 @seanchen1991
Make client events compatible with ibc-go v5.0.0 (#138)
05da0bb 
* client_id IbcEvent refactor

* Remove NewBlock and ChainError events

* Refactor update_client event

* clippy

* Improve CreateClient event type

* Improve UpdateClient event type

* refactor ClientMisbehaviour event

* UpgradeClient event refactor

* Remove Client Attributes

* Add EventMessage

* client handlers emit ibcevent message

* Copy relevant ADRs from hermes repository (#147)

* Add ADRs

* Update docs/architecture/adr-002-error.md

Co-authored-by: Shoaib Ahmed <[email protected]>
Signed-off-by: Philippe Laferrière <[email protected]>

* Update docs/architecture/adr-003-ics20-implementation.md

Co-authored-by: Shoaib Ahmed <[email protected]>
Signed-off-by: Philippe Laferrière <[email protected]>

* Update docs/architecture/adr-004-light-client-crates-extraction.md

Co-authored-by: Shoaib Ahmed <[email protected]>
Signed-off-by: Philippe Laferrière <[email protected]>

* Update docs/architecture/adr-001-handler-implementation.md

Co-authored-by: Shoaib Ahmed <[email protected]>
Signed-off-by: Philippe Laferrière <[email protected]>

* Update docs/architecture/adr-004-light-client-crates-extraction.md

Co-authored-by: Shoaib Ahmed <[email protected]>
Signed-off-by: Philippe Laferrière <[email protected]>

Signed-off-by: Philippe Laferrière <[email protected]>
Co-authored-by: Shoaib Ahmed <[email protected]>

* Fix CI (#151)

* std crate enabled for tests

* clippy no-default-features: still use clock feature

* patch ibc-proto to not use latest

* fix ibc-proto patch properly

* Allow deprecated (for crossing hellos fields)

* Remove ibc-proto rev for no-std

* fix no-std ibc-proto patch

* Remove comment

* fmt

* Fix tests

Events will be tested in their own test rather than spread across
all tests.

* ADR 012: Handlers validation and execution separation (#153)

* init adr 12

* Host based API

* Add appendices

* Add section on event logging

* Add .changelog entry

* Fix TypedStore associated type (syntax only)

* Update docs/architecture/adr-012-handlers-redesign.md

Co-authored-by: Philippe Laferrière <[email protected]>

* validation vs execution clarifications

* Move ValidationContext and ExecutionContext methods to appendix

* Context clarification

* Rework Host-based API section

* ValidationContext and ExecutionContext clarification

* Move Event logging section + misc

* typo

* Remove statement. Was mentioned earlier already.

* IbcStore blanket implementation

* IbcValueForPath rework

* Remove IbcSerde from main ADR

* TypedStore -> SubStore

* diagram

* Update docs/architecture/adr-012-handlers-redesign.md

Co-authored-by: Sean Chen <[email protected]>

* Update docs/architecture/adr-012-handlers-redesign.md

Co-authored-by: Sean Chen <[email protected]>

* Update docs/architecture/adr-012-handlers-redesign.md

Co-authored-by: Sean Chen <[email protected]>

* add context for why the validation/execution split is necessary

* add trait bounds

* Rename ADR012 -> ADR005

* Apply suggestions from code review

Change ADR status from Proposed to Accepted

Co-authored-by: Philippe Laferrière <[email protected]>
Signed-off-by: Shoaib Ahmed <[email protected]>

Signed-off-by: Shoaib Ahmed <[email protected]>
Co-authored-by: Philippe Laferriere <[email protected]>
Co-authored-by: Sean Chen <[email protected]>

* Setup unclog based changelog (#152)

* Add filtered changelog with ibc relevant entries

* Init unclog

* Add unreleased changelog entries

* clippy

* Remove "message" ibc event

* update_client event test

* Remove unused function

* upgrade client event

* changelog

* Revert "Remove unused function"

This reverts commit 66459cc.

* Remove EMPTY event

* Use derive_more::From

* Remove Display from IbcEvent

* changelog

Signed-off-by: Philippe Laferrière <[email protected]>
Signed-off-by: Shoaib Ahmed <[email protected]>
Co-authored-by: Shoaib Ahmed <[email protected]>
Co-authored-by: Sean Chen <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hu55a1n1 hu55a1n1 hu55a1n1 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Make client events compatible with ibc-go v5.0.0
2 participants
@plafer @hu55a1n1