chore: fix 08-wasm light client documentation #5439
Conversation
| memoryCacheSize, | ||
| dataDir, | ||
| availableCapabilities, | ||
| contractMemoryLimit, // default of 32 |
There was a problem hiding this comment.
wasmvm does not expose this in any way, just a nice to have to let others know the default
| @@ -276,7 +276,7 @@ You may leave any of the fields in the `QueryPlugins` object as `nil` if you do | |||
| Then, we pass the `QueryPlugins` object to the `WithQueryPlugins` option: | |||
|
|
|||
| ```go | |||
| querierOption := ibcwasmtypes.WithQueryPlugins(queryPlugins) | |||
| querierOption := ibcwasmkeeper.WithQueryPlugins(&queryPlugins) | |||
There was a problem hiding this comment.
looks like this reference is required for both v7 & v8
Reecepbcups
requested review from
colin-axner,
AdityaSripal,
crodriguezvega,
charleenfei,
damiannolan,
chatton,
DimitrisJim and
srdtrk
as code owners
| dataDir, | ||
| availableCapabilities, | ||
| contractMemoryLimit, // default of 32 | ||
| wasmConfig.ContractDebugMode, |
There was a problem hiding this comment.
since this is in the If x/wasm is present section, it can be used here
There was a problem hiding this comment.
I guess maybe not using the defaults specified in wasmConfig would be better? Having these as was done previously should force folks to ideally look it up and specify something sensible for their case instead of relying on defaults we specified for the case where we create the VM (i.e not x/wasm present). wdyt?
There was a problem hiding this comment.
Thank you @Reecepbcups! LGTM!
If using x/wasm, do we register both x/wasm NewWasmSnapshotter and the ibc WasmSnapshoter?
Yes, x/wasm loads contract info from snapshots into CodeInfos and stores the bytecode in the vm. The 08-wasm module doesn't use CodeInfo rather stores a collection of checksums directly for an allow list.
Same question for InitializePinnedCodes ^^
Yes, both would be required afaik.
Using wasmtypes import namespace is kind of a pain for x/wasm users, can wasmlctypes or ibcwasmtypes be used instead?
Agree! I'd recommend going for ibcwasmtypes personally!
| if upgradeInfo.Name == UpgradeName && !app.UpgradeKeeper.IsSkipHeight(upgradeInfo.Height) { | ||
| storeUpgrades := storetypes.StoreUpgrades{ | ||
| Added: []string{ | ||
| ibcwasmtypes.ModuleName, | ||
| }, | ||
| } | ||
|
|
||
|
|
||
| // configure store loader that checks if version == upgradeHeight and applies store upgrades | ||
| app.SetStoreLoader(upgradetypes.UpgradeStoreLoader(upgradeInfo.Height, &storeUpgrades)) |
| @@ -116,7 +116,7 @@ func NewSimApp( | |||
| ctx := app.BaseApp.NewUncachedContext(true, cmtproto.Header{}) | |||
|
|
|||
| // Initialize pinned codes in wasmvm as they are not persisted there | |||
| if err := wasmkeeper.InitializePinnedCodes(ctx); err != nil { | |||
| if err := wasmkeeper.InitializePinnedCodes(ctx); err != nil { // appCodec is required in v7 | |||
There was a problem hiding this comment.
I will update this when creating the versioned docs for v7.3.x. Thanks for noticing!
| @@ -237,8 +237,8 @@ wasmConfig := wasmtypes.WasmConfig{ | |||
| } | |||
| app.WasmClientKeeper = wasmkeeper.NewKeeperWithConfig( | |||
| appCodec, | |||
| runtime.NewKVStoreService(keys[wasmtypes.StoreKey]), | |||
| app.IBCKeeper.ClientKeeper, | |||
| runtime.NewKVStoreService(keys[wasmtypes.StoreKey]), // v7 use app.keys[wasmtypes.StoreKey] | |||
There was a problem hiding this comment.
I will also fix this when creating the versioned docs.
Description
Fixes some differences from documentation & v7.3 chain integration (ref: CosmosContracts/juno#921). It looks like documentation is only in main & not the v7.3 08-wasm branch? lmk if there is a better place to target this PR.
InitializePinnedCodes^^wasmtypesimport namespace is kind of a pain for x/wasm users, canwasmlctypesoribcwasmtypesbe used instead?Commit Message / Changelog Entry
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.
docs/) or specification (x/<module>/spec/).godoccomments.Files changedin the Github PR explorer.Codecov Reportin the comment section below once CI passes.