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

nit: add documentation for store/migrate contract on Keeper #6162

Merged
merged 3 commits into from
Apr 16, 2024
Merged

nit: add documentation for store/migrate contract on Keeper #6162

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0577a58
nit: add documentation for private methods that are too spicy (re: co…
DimitrisJim Apr 15, 2024
e25a8db
Update modules/light-clients/08-wasm/keeper/keeper.go
DimitrisJim Apr 16, 2024
0a1cbdb
Merge branch 'main' into jim/document-store-migrate
DimitrisJim Apr 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions modules/light-clients/08-wasm/keeper/keeper.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,11 @@ func (k Keeper) newQueryHandler(ctx sdk.Context, callerID string) *queryHandler
return newQueryHandler(ctx, k.GetQueryPlugins(), callerID)
}

// storeWasmCode stores the contract to the VM, pins the checksum in the VM's in memory cache and stores the checksum
// in store. The checksum identifying it is returned if successful. The following checks are made to the
DimitrisJim marked this conversation as resolved.
Show resolved Hide resolved
// contract code before storing:
// - Size bounds are checked. Contract length must not be 0 or exceed a specific size (maxWasmSize).
// - The contract must not have already been stored in store.
func (k Keeper) storeWasmCode(ctx sdk.Context, code []byte, storeFn func(code wasmvm.WasmCode, gasLimit uint64) (wasmvm.Checksum, uint64, error)) ([]byte, error) {
var err error
if types.IsGzip(code) {
Expand Down Expand Up @@ -134,6 +139,8 @@ func (k Keeper) storeWasmCode(ctx sdk.Context, code []byte, storeFn func(code wa
return checksum, nil
}

// migrateContractCode migrates the contract for a given light client to one denoted by the given new checksum. The checksum we
// are migrating to must first be stored using storeWasmCode and must not match the checksum currently stored for this light client.
func (k Keeper) migrateContractCode(ctx sdk.Context, clientID string, newChecksum, migrateMsg []byte) error {
wasmClientState, err := k.GetWasmClientState(ctx, clientID)
if err != nil {
Expand Down
Loading