Merge branch 'main' into tuan/formatting-enum

notional-labs · May 24, 2024 · aed1de9 · aed1de9
2 parents 07f6f13 + 0834229
commit aed1de9
Show file tree

Hide file tree

Showing 8 changed files with 114 additions and 6 deletions.
diff --git a/.github/workflows/callbacks.yml b/.github/workflows/callbacks.yml
@@ -56,7 +56,7 @@ jobs:
     steps:
       - name: sonarcloud
         if: ${{ env.GIT_DIFF && !github.event.pull_request.draft && env.SONAR_TOKEN != null }}
-        uses: SonarSource/sonarcloud-github-action@v2.1.1
+        uses: SonarSource/sonarcloud-github-action@v2.2.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

diff --git a/.github/workflows/capability.yml b/.github/workflows/capability.yml
@@ -42,7 +42,7 @@ jobs:
     steps:
       - name: sonarcloud
         if: ${{ env.GIT_DIFF && !github.event.pull_request.draft && env.SONAR_TOKEN != null }}
-        uses: SonarSource/sonarcloud-github-action@v2.1.1
+        uses: SonarSource/sonarcloud-github-action@v2.2.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -142,7 +142,7 @@ jobs:
           name: '${{ github.sha }}-03-coverage'
       - name: sonarcloud
         if: ${{ env.GIT_DIFF && !github.event.pull_request.draft }}
-        uses: SonarSource/sonarcloud-github-action@v2.1.1
+        uses: SonarSource/sonarcloud-github-action@v2.2.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
diff --git a/.github/workflows/wasm-client.yml b/.github/workflows/wasm-client.yml
@@ -63,7 +63,7 @@ jobs:
     steps:
       - name: sonarcloud
         if: ${{ env.GIT_DIFF && !github.event.pull_request.draft && env.SONAR_TOKEN != null }}
-        uses: SonarSource/sonarcloud-github-action@v2.1.1
+        uses: SonarSource/sonarcloud-github-action@v2.2.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

diff --git a/docs/docs/03-light-clients/04-wasm/03-integration.md b/docs/docs/03-light-clients/04-wasm/03-integration.md
@@ -21,6 +21,7 @@ The following table shows the compatibility matrix between the `08-wasm` module,
 
 |            **Version**           |         **Git commit to import**         |
 |:--------------------------------:|:----------------------------------------:|
+| `v0.2.0+ibc-go-v8.3-wasmvm-v2.0` | 4b45d1822fb6a0698e7621112b92c13679061c40 |
 | `v0.1.1+ibc-go-v7.3-wasmvm-v1.5` | 7ee2a2452b79d0bc8316dc622a1243afa058e8cb |
 | `v0.1.0+ibc-go-v8.0-wasmvm-v1.5` | 57fcdb9a9a9db9b206f7df2f955866dc4e10fef4 |
 | `v0.1.0+ibc-go-v7.3-wasmvm-v1.5` | b306e7a706e1f84a5e11af0540987bd68de9bae5 |
@@ -283,7 +284,7 @@ Currently the only option available is the `WithQueryPlugins` option, which allo
 
 #### `WithQueryPlugins`
 
-By default, the `08-wasm` module does not configure any querier options for light client contracts. However, it is possible to register custom query plugins for [`QueryRequest::Custom`](https://github.com/CosmWasm/cosmwasm/blob/v1.5.0/packages/std/src/query/mod.rs#L45) and [`QueryRequest::Stargate`](https://github.com/CosmWasm/cosmwasm/blob/v1.5.0/packages/std/src/query/mod.rs#L54-L61).
+By default, the `08-wasm` module does not configure any querier options for light client contracts. However, it is possible to register custom query plugins for [`QueryRequest::Custom`](https://github.com/CosmWasm/cosmwasm/blob/v2.0.1/packages/std/src/query/mod.rs#L48) and [`QueryRequest::Stargate`](https://github.com/CosmWasm/cosmwasm/blob/v2.0.1/packages/std/src/query/mod.rs#L57-L65).
 
 Assuming that the keeper is not yet instantiated, the following sample code shows how to register query plugins for the `08-wasm` module.
 

diff --git a/docs/versioned_docs/version-v8.3.x/03-light-clients/04-wasm/03-integration.md b/docs/versioned_docs/version-v8.3.x/03-light-clients/04-wasm/03-integration.md
@@ -272,7 +272,7 @@ Currently the only option available is the `WithQueryPlugins` option, which allo
 
 #### `WithQueryPlugins`
 
-By default, the `08-wasm` module does not support any queries. However, it is possible to register custom query plugins for [`QueryRequest::Custom`](https://github.com/CosmWasm/cosmwasm/blob/v1.5.0/packages/std/src/query/mod.rs#L45) and [`QueryRequest::Stargate`](https://github.com/CosmWasm/cosmwasm/blob/v1.5.0/packages/std/src/query/mod.rs#L54-L61).
+By default, the `08-wasm` module does not configure any querier options for light client contracts. However, it is possible to register custom query plugins for [`QueryRequest::Custom`](https://github.com/CosmWasm/cosmwasm/blob/v2.0.1/packages/std/src/query/mod.rs#L48) and [`QueryRequest::Stargate`](https://github.com/CosmWasm/cosmwasm/blob/v2.0.1/packages/std/src/query/mod.rs#L57-L65).
 
 Assuming that the keeper is not yet instantiated, the following sample code shows how to register query plugins for the `08-wasm` module.
 
@@ -289,6 +289,16 @@ queryPlugins := ibcwasmtypes.QueryPlugins {
 }
 ```
 
+Note that the `Stargate` querier appends the user defined accept list of query routes to a default list defined by the `08-wasm` module.
+The `defaultAcceptList` defines a single query route: `"/ibc.core.client.v1.Query/VerifyMembership"`. This allows for light client smart contracts to delegate parts of their workflow to other light clients for auxiliary proof verification. For example, proof of inclusion of block and tx data by a data availability provider.
+
+```go
+// defaultAcceptList defines a set of default allowed queries made available to the Querier.
+var defaultAcceptList = []string{
+  "/ibc.core.client.v1.Query/VerifyMembership",
+}
+```
+
 You may leave any of the fields in the `QueryPlugins` object as `nil` if you do not want to register a query plugin for that query type.
 
 Then, we pass the `QueryPlugins` object to the `WithQueryPlugins` option:

diff --git a/docs/versioned_docs/version-v8.3.x/03-light-clients/04-wasm/08-client.md b/docs/versioned_docs/version-v8.3.x/03-light-clients/04-wasm/08-client.md
@@ -29,6 +29,16 @@ simd tx ibc-wasm store-code [path/to/wasm-file] [flags]
 
 `path/to/wasm-file` is the path to the `.wasm` or `.wasm.gz` file.
 
+#### `migrate-contract`
+
+The `migrate-contract` command allows users to broadcast a transaction with a `MsgMigrateContract` to migrate the contract for a given light client to a new byte code denoted by the given checksum.
+
+```shell
+simd tx ibc-wasm migrate-contract [client-id] [checksum] [migrate-msg]
+```
+
+The migrate message must not be empty and is expected to be a JSON-encoded string.
+
 ### Query
 
 The `query` commands allow users to query `08-wasm` state.

diff --git a/docs/versioned_docs/version-v8.3.x/03-light-clients/04-wasm/09-migrations.md b/docs/versioned_docs/version-v8.3.x/03-light-clients/04-wasm/09-migrations.md
@@ -14,3 +14,90 @@ This guide provides instructions for migrating 08-wasm versions.
 ## Chains
 
 In the 08-wasm versions compatible with ibc-go v7.3.x and above from the v7 release line, the checksums of the uploaded Wasm bytecodes are all stored under a single key. From ibc-go v8.0.x the checksums are stored using [`collections.KeySet`](https://docs.cosmos.network/v0.50/build/packages/collections#keyset), whose full functionality became available in Cosmos SDK v0.50. There is therefore an [automatic migration handler](https://github.com/cosmos/ibc-go/blob/57fcdb9a9a9db9b206f7df2f955866dc4e10fef4/modules/light-clients/08-wasm/module.go#L115-L118) configured in the 08-wasm module to migrate the stored checksums to `collections.KeySet`.
+
+## From v0.1.0+ibc-go-v8.0-wasmvm-v1.5 to v0.2.0-ibc-go-v8.3-wasmvm-v2.0
+
+The `WasmEngine` interface has been updated to reflect changes in the function signatures of Wasm VM:
+
+```diff
+type WasmEngine interface {
+- StoreCode(code wasmvm.WasmCode) (wasmvm.Checksum, error)
++ StoreCode(code wasmvm.WasmCode, gasLimit uint64) (wasmvmtypes.Checksum, uint64, error)
+
+  StoreCodeUnchecked(code wasmvm.WasmCode) (wasmvm.Checksum, error)
+
+  Instantiate(
+    checksum wasmvm.Checksum,
+    env wasmvmtypes.Env,
+    info wasmvmtypes.MessageInfo,
+    initMsg []byte,
+    store wasmvm.KVStore,
+    goapi wasmvm.GoAPI,
+    querier wasmvm.Querier,
+    gasMeter wasmvm.GasMeter,
+    gasLimit uint64,
+    deserCost wasmvmtypes.UFraction,
+- ) (*wasmvmtypes.Response, uint64, error)
++ ) (*wasmvmtypes.ContractResult, uint64, error)
+
+  Query(
+    checksum wasmvm.Checksum,
+    env wasmvmtypes.Env,
+    queryMsg []byte,
+    store wasmvm.KVStore,
+    goapi wasmvm.GoAPI,
+    querier wasmvm.Querier,
+    gasMeter wasmvm.GasMeter,
+    gasLimit uint64,
+    deserCost wasmvmtypes.UFraction,
+- ) ([]byte, uint64, error)
++ ) (*wasmvmtypes.QueryResult, uint64, error)
+
+  Migrate(
+    checksum wasmvm.Checksum,
+    env wasmvmtypes.Env,
+    migrateMsg []byte,
+    store wasmvm.KVStore,
+    goapi wasmvm.GoAPI,
+    querier wasmvm.Querier,
+    gasMeter wasmvm.GasMeter,
+    gasLimit uint64,
+    deserCost wasmvmtypes.UFraction,
+- ) (*wasmvmtypes.Response, uint64, error)
++ ) (*wasmvmtypes.ContractResult, uint64, error)
+
+  Sudo(
+    checksum wasmvm.Checksum,
+    env wasmvmtypes.Env,
+    sudoMsg []byte,
+    store wasmvm.KVStore,
+    goapi wasmvm.GoAPI,
+    querier wasmvm.Querier,
+    gasMeter wasmvm.GasMeter,
+    gasLimit uint64,
+    deserCost wasmvmtypes.UFraction,
+- ) (*wasmvmtypes.Response, uint64, error)
++ ) (*wasmvmtypes.ContractResult, uint64, error)
+
+  GetCode(checksum wasmvm.Checksum) (wasmvm.WasmCode, error)
+
+  Pin(checksum wasmvm.Checksum) error
+
+  Unpin(checksum wasmvm.Checksum) error
+}
+```
+
+Similar changes were required in the functions of the `MockWasmEngine` interface.
+
+### Chains
+
+The `SupportedCapabilities` field of `WasmConfig` is now of type `[]string`:
+
+```diff
+type WasmConfig struct {
+  DataDir string
+- SupportedCapabilities string
++ SupportedCapabilities []string
+  ContractDebugMode bool
+}
+```