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.

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

Update 08-wasm documentation and migration docs for v0.4.x #6139

Closed
crodriguezvega opened this issue Apr 10, 2024 · 3 comments · Fixed by #6845
Closed

Update 08-wasm documentation and migration docs for v0.4.x #6139

crodriguezvega opened this issue Apr 10, 2024 · 3 comments · Fixed by #6845
Assignees
Labels
08-wasm docs Improvements or additions to documentation
Milestone

Comments

@crodriguezvega
Copy link
Contributor

crodriguezvega commented Apr 10, 2024

Documentation for 08-wasm and migration docs for v0.4.x with ibc-go v9.0 should be updated/added with changes from #6088, #6164, #6176, #6177.

@crodriguezvega crodriguezvega added the docs Improvements or additions to documentation label Apr 10, 2024
@crodriguezvega crodriguezvega moved this to Backlog 🕐 in ibc-go Apr 10, 2024
@crodriguezvega crodriguezvega added this to the v9.0.0 milestone Apr 10, 2024
@crodriguezvega crodriguezvega moved this from Backlog 🕐 to Todo 🏃 in ibc-go Apr 11, 2024
@DimitrisJim
Copy link
Contributor

Some notes:

  • Many of the types in ibcwasm don't need to be mentioned, they were already private.
  • Types moved to internal/store were previously private in types.

Additions:

  • Wasm(*) functions on the keeper (contract_keeper.go), these were previously private in types/. Using them in light_client_module necessitated they be made public.
  • types.CostJSONDeserialization has been made public. (we could possibly move this in keeper?)
  • MaxWasmSize has been added (removing MaxWasmByteSize function that simply returned it)

Modifications:

  • Keeper struct has new GetVM, GetChecksums, Logger methods.
  • InitializePinnedCodes was made a keeper method from a standalone function.
  • Accessing state has moved from types/ to keeper/. Keeper object now has HasChecksums and GetAllChecksums methods
  • querier.go has been moved to keeper/ pkg from types/. NewDefaultQueryPlugins and QueryPlugins are moved there.
  • AcceptListStargateQuerier has an additional argument for the queryRouter.
  • Signature of WithQueryPlugins has changed, argument is now QueryPlugins struct in keeper/.
  • VMGasRegister has moved from the types/ package to the keeper/ package.

Removals:

  • All the client state methods that were moved to light client module interface.
  • Logger standalone function in types/ (has been moved on Keeper).
  • MaxWasmByteSize has been removed.

Doc changes noticed (reading https://ibc.cosmos.network/main/ibc/light-clients/wasm/overview):

  • Documentation on Integration needs updating to modify call to initialize pinned codes (now defined on keeper) in the given example for app.go.

@crodriguezvega
Copy link
Contributor Author

Document also the change of Path to commitmenttypesv2.MerklePath if we finally decide to make it (ref).

@damiannolan
Copy link
Member

Document also the change of Path to commitmenttypesv2.MerklePath if we finally decide to make it (ref).

We can use this as reference: #6757

@crodriguezvega crodriguezvega changed the title Update 08-wasm documentation and migration docs for v0.3.x Update 08-wasm documentation and migration docs for v0.4.x Jul 8, 2024
@gjermundgaraba gjermundgaraba self-assigned this Jul 15, 2024
@gjermundgaraba gjermundgaraba moved this from Todo 🏃 to In progress 👷 in ibc-go Jul 16, 2024
@gjermundgaraba gjermundgaraba linked a pull request Jul 16, 2024 that will close this issue
10 tasks
@crodriguezvega crodriguezvega moved this from In progress 👷 to In review 👀 in ibc-go Jul 17, 2024
@github-project-automation github-project-automation bot moved this from In review 👀 to Done 🥳 in ibc-go Jul 19, 2024
@gjermundgaraba gjermundgaraba moved this from Done 🥳 to In progress 👷 in ibc-go Jul 19, 2024
@github-project-automation github-project-automation bot moved this from In progress 👷 to Done 🥳 in ibc-go Jul 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
08-wasm docs Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants