feat: base64 decoder for cw3 wasm messages #1731
Conversation
WalkthroughThe introduced changes provide a feature to decode base64-encoded protobuf messages, specifically for cw3 wasm messages in the stargate format. The update adds a new CLI command along with necessary functions and types to parse and reveal the contents of these messages, making it easier for users to understand the actions being taken by smart contracts within a blockchain context. Changes
Assessment against linked issues
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChat with CodeRabbit Bot (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 2
Configuration used: CodeRabbit UI
Files selected for processing (3)
- cmd/nibid/cmd/decode_base64.go (1 hunks)
- cmd/nibid/cmd/decode_base64_test.go (1 hunks)
- cmd/nibid/cmd/root.go (1 hunks)
Additional comments: 1
cmd/nibid/cmd/root.go (1)
- 139-145: The integration of
DecodeBase64Cmdinto the root command's initialization process is done correctly. It is added as a subcommand, which will allow it to be invoked as part of the CLI.
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files selected for processing (2)
- cmd/nibid/cmd/decode_base64.go (1 hunks)
- cmd/nibid/cmd/decode_base64_test.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- cmd/nibid/cmd/decode_base64_test.go
Additional comments: 5
cmd/nibid/cmd/decode_base64.go (5)
3-54: The import block includes a large number of dependencies. Verify that all imported packages are used within the file to avoid unnecessary imports which can lead to increased compilation time and binary size.
56-189: The
MakeMapfunction initializes a map with string keys andproto.Messagevalues. Ensure that all message types are correctly mapped to their respective protobuf message types and that the map is used appropriately in the decoding process.192-223: The recursive function
parseStargateMsgsis used to parse nested JSON structures intowasmvm.StargateMsgobjects. Ensure that the recursion is well-defined and terminates correctly to prevent potential stack overflow errors.225-228: The
StargateMsgDecodedstruct is defined with JSON tags, which suggests it's used for JSON marshaling/unmarshaling. Verify that the fields and tags align with the expected JSON structure for decoded messages.277-296: The
DecodeBase64Cmdfunction sets up a Cobra command for decoding base64 messages. Ensure that the command line arguments are correctly handled and that the command's help text is clear and informative.
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #1731 +/- ##
==========================================
- Coverage 73.89% 73.88% -0.01%
==========================================
Files 192 193 +1
Lines 15142 15226 +84
==========================================
+ Hits 11189 11250 +61
- Misses 3297 3314 +17
- Partials 656 662 +6
|
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files selected for processing (2)
- cmd/nibid/cmd/decode_base64.go (1 hunks)
- cmd/nibid/cmd/decode_base64_test.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- cmd/nibid/cmd/decode_base64_test.go
Additional comments: 6
cmd/nibid/cmd/decode_base64.go (6)
3-54: The import block includes a large number of dependencies. Verify that all these imports are necessary for this file, as unused imports should be removed to keep the code clean and maintainable.
192-202: The
YieldStargateMsgsfunction correctly unmarshals JSON bytes and delegates the parsing of messages to theparseStargateMsgsfunction. Ensure that the error handling is consistent and that the function performs as expected with various JSON inputs.204-223: The recursive function
parseStargateMsgsparses JSON data and constructswasmvm.StargateMsgobjects. Verify that the recursion is correctly handling all possible JSON structures and that there are no potential stack overflow issues with deeply nested JSON. Additionally, consider the performance implications of recursion for large JSON inputs.225-228: The
StargateMsgDecodedstruct is simple and correctly annotated for JSON serialization. This struct should be sufficient for holding the decoded message data.230-275: The
DecodeBase64StargateMsgsfunction decodes base64-encoded protobuf messages. Ensure that the base64 decoding is correctly handled and that the function is resilient to malformed input. Additionally, the error handling should be consistent, and the function should fail early if an error is encountered to avoid unnecessary processing.277-296: The
DecodeBase64Cmdfunction sets up a Cobra command for decoding base64-encoded protobuf messages. Verify that the command setup is correct, including flag definitions and error handling. Ensure that the command's help text is clear and that the command behaves correctly when invoked with various arguments.
Co-authored-by: Kevin Yang <[email protected]>
There was a problem hiding this comment.
Review Status
Actionable comments generated: 5
Configuration used: CodeRabbit UI
Files selected for processing (1)
- cmd/nibid/cmd/decode_base64.go (1 hunks)
Additional comments: 1
cmd/nibid/cmd/decode_base64.go (1)
- 3-53: The import statements are extensive and include a variety of types from different packages. Ensure that all imported packages are used within the file to avoid unnecessary imports which can lead to increased compilation time and binary size.
| // YieldStargateMsgs parses the JSON and sends wasmvm.StargateMsg objects to a channel | ||
| func YieldStargateMsgs(jsonBz []byte) ([]wasmvm.StargateMsg, error) { | ||
| var data interface{} | ||
| if err := json.Unmarshal(jsonBz, &data); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| var msgs []wasmvm.StargateMsg | ||
| parseStargateMsgs(data, &msgs) | ||
| return msgs, nil | ||
| } |
There was a problem hiding this comment.
The YieldStargateMsgs function correctly unmarshals JSON bytes into an interface and then parses the messages. However, there is no error handling for the parseStargateMsgs function call. Ensure that any errors during parsing are properly handled.
| func parseStargateMsgs(jsonData any, msgs *[]wasmvm.StargateMsg) { | ||
| switch v := jsonData.(type) { | ||
| case map[string]interface{}: | ||
| if typeURL, ok := v["type_url"].(string); ok { | ||
| if value, ok := v["value"].(string); ok { | ||
| *msgs = append(*msgs, wasmvm.StargateMsg{ | ||
| TypeURL: typeURL, | ||
| Value: []byte(value), | ||
| }) | ||
| } | ||
| } | ||
| for _, value := range v { | ||
| parseStargateMsgs(value, msgs) | ||
| } | ||
| case []interface{}: | ||
| for _, value := range v { | ||
| parseStargateMsgs(value, msgs) | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
The recursive function parseStargateMsgs lacks error handling. If any of the type assertions fail, it will result in a runtime panic. It's important to handle these cases gracefully and return an error if the JSON structure does not meet the expected format.
…com:NibiruChain/nibiru into mat/decode-base64
There was a problem hiding this comment.
Review Status
Actionable comments generated: 2
Configuration used: CodeRabbit UI
Files selected for processing (2)
- cmd/nibid/cmd/decode_base64.go (1 hunks)
- cmd/nibid/cmd/decode_base64_test.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- cmd/nibid/cmd/decode_base64.go
Additional comments: 2
cmd/nibid/cmd/decode_base64_test.go (2)
62-115: The test cases cover a range of scenarios, including valid and invalid JSON messages. However, the test case named "empty message" (lines 100-107) is marked to not expect an error, which might be misleading if the functionality is supposed to handle empty messages without errors. Clarification or adjustment of the test case might be needed.
117-119: The loop for executing test cases is correctly set up and follows best practices for table-driven tests in Go.
| func TestBase64Decode(t *testing.T) { | ||
| type TestCase struct { | ||
| name string | ||
| json_message string | ||
| expectError bool | ||
| } |
There was a problem hiding this comment.
The TestCase struct is well-defined with relevant fields for the test's purpose. However, it's good practice to include a field for the expected result to compare against the actual result in tests, not just an error expectation.
| executeTest := func(t *testing.T, testCase TestCase) { | ||
| tc := testCase | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| home := t.TempDir() | ||
| logger := log.NewNopLogger() | ||
| cfg, err := genutiltest.CreateDefaultTendermintConfig(home) | ||
| require.NoError(t, err) | ||
|
|
||
| appCodec := app.MakeEncodingConfig().Marshaler | ||
| err = genutiltest.ExecInitCmd( | ||
| testModuleBasicManager, home, appCodec) | ||
| require.NoError(t, err) | ||
|
|
||
| serverCtx := server.NewContext(viper.New(), cfg, logger) | ||
| clientCtx := (client.Context{}. | ||
| WithCodec(appCodec). | ||
| WithHomeDir(home). | ||
| WithInterfaceRegistry(app.MakeEncodingConfig().InterfaceRegistry)) | ||
|
|
||
| ctx := context.Background() | ||
| ctx = context.WithValue(ctx, client.ClientContextKey, &clientCtx) | ||
| ctx = context.WithValue(ctx, server.ServerContextKey, serverCtx) | ||
|
|
||
| cmd := nibid.DecodeBase64Cmd(home) | ||
| cmd.SetArgs([]string{ | ||
| tc.json_message, | ||
| }) | ||
|
|
||
| if tc.expectError { | ||
| require.Error(t, cmd.ExecuteContext(ctx)) | ||
| } else { | ||
| require.NoError(t, cmd.ExecuteContext(ctx)) | ||
| } | ||
| }) | ||
| } |
There was a problem hiding this comment.
The executeTest function is well-structured and uses subtests, which is a good practice for clarity and isolation of test cases. However, the use of context.WithValue should be accompanied by a comment explaining why it's necessary to store clientCtx and serverCtx in the context, as this is not a common practice for contexts in tests.
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (1)
- CHANGELOG.md (1 hunks)
Additional comments: 1
CHANGELOG.md (1)
- 53-53: The changelog entry for the new CLI command to decode Stargate base64 messages is clear and follows the established format.
| clientCtx := client.GetClientContextFromCmd(cmd) | ||
|
|
||
| outMessage, err := DecodeBase64StargateMsgs([]byte(args[0]), clientCtx) | ||
| fmt.Println(outMessage) |
There was a problem hiding this comment.
Would put if err == nil, print so that it only runs on success
* wip * feat: have a dirty funny looking solution * chore: changelog * fix: fix replace usage * Update cmd/nibid/cmd/decode_base64.go Co-authored-by: Kevin Yang <[email protected]> * fix: turns out InterfaceRegistry.Resolve does the trick * chore: changelog * fix: remove unused import --------- Co-authored-by: Kevin Yang <[email protected]>
* chore(perp): remove perp * chore(perp): remove perp protos * chore(stablecoin): remove stablecoin * chore(spot): remove spot * chore: use large ubuntu runner for goreleaser workflow * fix(ledger): bump the hid package to v0.9.2 which fixes ledger on new… (#1649) * fix(ledger): bump the hid package to v0.9.2 which fixes ledger on new macos versions * chore: update changelog * chore: update changelog * feat(wasmbinding)!: whitelisted stargate queries for QueryRequest::Stargate: auth, bank, gov, tokenfactory, epochs, inflation, oracle, sudo, devgas (#1646) * fix(tokenfactory)!: Fix bug in MsgBurn on total supply tracking * chore: rm stablecoin. How does this keep getting merged lol * test: add export statements for the gRPC query service descriptions in each module * feat(wasmbinding): whitelisted stargate queries for QueryRequest::Stargate * changelog * fix changelog * refactor!: make the epoch infos name consistent * docs,test(stargate_query): leave an in-depth explainer above the function * refactor: pR comments: earlier return + remove duplicate hardcoded paths * test: proto package may have more than 3 'parts'. Use len - 1 instead * docs: fix small documentation typos * chore: reset module consensus versions * fix(inflation): enable inflationary NIBI (#1655) * chore(epochs): add day epoch and remove 15min epoch from default genesis * chore(epochs): remove 15min epoch from default genesis * fix(inflation): inflate strategic reserves to sudo root account * fix(inflation): test inflation amounts * chore: update changelog * fix(keeper): inflation keeper instantiation * feat(oracle): edit oracle params msg (#1658) * chore: update changelog * Update CHANGELOG.md * chore(oracle): curate default oracle whitelist (#1659) * chore(oracle): curate default oracle whitelist * update changelog * chore(deps): Bump github.com/CosmWasm/wasmvm from 1.4.1 to 1.5.0 (#1657) Bumps [github.com/CosmWasm/wasmvm](https://github.com/CosmWasm/wasmvm) from 1.4.1 to 1.5.0. - [Release notes](https://github.com/CosmWasm/wasmvm/releases) - [Changelog](https://github.com/CosmWasm/wasmvm/blob/main/CHANGELOG.md) - [Commits](CosmWasm/wasmvm@v1.4.1...v1.5.0) --- updated-dependencies: - dependency-name: github.com/CosmWasm/wasmvm dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: Unique-Divine <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Unique Divine <[email protected]> * chore(deps): Bump google.golang.org/grpc from 1.58.3 to 1.59.0 (#1643) * chore(deps): Bump google.golang.org/grpc from 1.58.3 to 1.59.0 Bumps [google.golang.org/grpc](https://github.com/grpc/grpc-go) from 1.58.3 to 1.59.0. - [Release notes](https://github.com/grpc/grpc-go/releases) - [Commits](grpc/grpc-go@v1.58.3...v1.59.0) --- updated-dependencies: - dependency-name: google.golang.org/grpc dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * Updated changelog - dependabot --------- Signed-off-by: Unique-Divine <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Unique Divine <[email protected]> Co-authored-by: Unique-Divine <[email protected]> Co-authored-by: Unique-Divine <[email protected]> * chore(deps): Bump github.com/cosmos/ibc-go/v7 from 7.3.0 to 7.3.1 (#1647) * chore(oracle): remove bnb:usd from default whitelist * chore(epochs): add month default epoch * chore(wasm): bump wasmd dependency to v0.43.0 (#1660) * chore(wasm): bump wasmd dependency to v0.43.0 * Update CHANGELOG.md * fix: fix linter issues --------- Co-authored-by: Matthias <[email protected]> * fix(epochs): fix epoch tests broken by adding month epoch into default genesis * feat: update wasmd to v0.44.0 (#1666) * feat: update wasmd to v0.44.0 * chore: lint * chore(inflation)!: remove x/inflation module (#1667) * chore(inflation): remove x/inflation and inflation proto files * fix: wasmbinding imports * chore(inflation): remove inflation from app keepers * update changelog * feat(inflation)!: make inflation follow a polynomial distribution (#1670) * feat: make inflation follow a polynomial distribution * chore: changelog * fix: fix inflation test * fix: fix epoch/period confusion * chore: update changelog * feat: add inflation events detailed distribution (#1695) * feat: add inflation events detailed distribution * chore: changelog * fix: improve error handling * fix: broken unit test + make x/sudo safer by making blank genesis invalid * refactor: run gofumpt formatter --------- Co-authored-by: Unique-Divine <[email protected]> * fix(inflation): fix default inflation allocation params (#1688) * fix: fix default inflation allocation * chore: changelog * fix: fix tests --------- Co-authored-by: Unique Divine <[email protected]> * feat: add upgrade handler for inflation module (#1684) * upgrade handler * make lint * update changelog * fix changelog * use orderedModuleNames() function for upgrade --------- Co-authored-by: Unique Divine <[email protected]> * fix: upgrade handler for v1.1.0 (#1706) * fix: upgrade handler for v1.1.0 * chore: update changelog * refactor(inflation): make inflation disabled by default (#1712) * refactor(inflation): make inflation disabled by default * chore: update changelog * chore: bump librocksdb to v8.9.1 (#1778) Co-authored-by: Unique Divine <[email protected]> * chore: update changelog * ci: fix go mod * ci: remove go toolchain directive * feat: make inflation params a collection and add commands to update them (#1776) * feat: make inflation params a collection and add commands to update them * fix: more tests * chore: changelog * Update x/inflation/keeper/grpc_query.go Co-authored-by: Unique Divine <[email protected]> * Update x/inflation/keeper/grpc_query.go Co-authored-by: Unique Divine <[email protected]> * Update x/inflation/keeper/sudo.go Co-authored-by: Unique Divine <[email protected]> * fix: fix tests and improve function * fix: add test for queryserver --------- Co-authored-by: Unique Divine <[email protected]> * ci: bump grocksdb to 1.8.12 * fix: remove verify-dist-temp * ci: use new goreleaser image * ci: update make build commands * fix(inflation): fix first epoch's inflation distribution (#1786) * fix: fix inflation start bug * fix: fix off by 2 on inflation start * fix: make test more random * chore: changelog * fix: use sdkmath.Int instead of sdk.Int * comments + var names --------- Co-authored-by: Unique-Divine <[email protected]> * ci: update goreleaser config file * feat: upgrade handler for v1.0.1 * feat(inflation): add inflation tx cmds (#1795) * feat(inflation): add toggle-inflation cli command * feat(inflation): add edit-params command and update validate-basic * chore: update changelog * feat: uncomment amino registering on register legacy amino codec for inflation module (#1792) * uncomment amino registering on register legacy amino codec * add changelog entry --------- Co-authored-by: Unique-Divine <[email protected]> * feat: handle case where skip epoch not aligned with epoch passed (#1796) * fix(inflation): num skipped epochs tracking (#1797) * fix: fix bug on inflation * chore: changelog * fix: add bool to see wether inflation ever started * fix: epoch off by one error * chore: unwire epochs keeper from inflation keeper * fix: off by one tests --------- Co-authored-by: Kevin Yang <[email protected]> * chore: bump cosmos-sdk to v0.47.9 (#1808) * chore: bump cosmos-sdk to v0.47.9 * chore: update changelog * chore: add v1.0.2 upgrade handler * fix(inflation-docs): ① Document inflation + ② delete unused code + ③ fix CI (#1799) * refactor,docs(inflation): Document everything + delete unused code * changelog * feat(localnet): make perp and spot modules optional features * fix(e2e-wasm.yml-ci): Use consistent command runner * wip! move nibid to path after downlaoding release * wip! fix syntax error in localnet.sh * wip!: what version is running? * wip! try: simplify and use fresh build * wip! fix param space * wip!: fix source path in chaosnet and localnet * wip!: fix source path in chaosnet and localnet * wip!: fix source path in chaosnet and localnet * fix(localent.sh): missing prices in oralce genesis * wait a bit since localnet is fixed now * fix(deploy-wasm): using wrong binary name * ci: Runs well but needs a better name * ci: fix chaosnet build (#1806) * ci: fix chaosnet build * fix(scripts): use better current absolute path directory fn * refactor(e2e-localnet): remove unused script * fix(justfile): handle case where stop is called without anything running --------- Co-authored-by: Unique-Divine <[email protected]> * chore: bump cosmos-sdk to v0.47.9 (#1808) * chore: bump cosmos-sdk to v0.47.9 * chore: update changelog * feat: update default inflation rate (#1804) * feat: update default inflation rate * chore: changelog * fix: fix rounding issue * ci: remove go toolchain in go.mod file * ci: revert back to cosmos sdk v0.47.5 * ci: bump to cosmos-sdk v0.47.6 * ci: bump to cosmos-sdk v0.47.7 * ci: bump to cosmos-sdk v0.47.8 * ci: bump to cosmos-sdk v0.47.9 * ci: revert to cosmos sdk v0.47.5 * chore: bump cosmos-sdk to v0.47.10 * chore: add back v1.0.1 files * fix: add back v1.0.2 upgrade handler * fix: wasm ibc transaction panic (#1816) * fix wasm ibc transaction panic * include upgrade 1.0.3 * linter * update and fix changelog * feat: base64 decoder for cw3 wasm messages (#1731) * wip * feat: have a dirty funny looking solution * chore: changelog * fix: fix replace usage * Update cmd/nibid/cmd/decode_base64.go Co-authored-by: Kevin Yang <[email protected]> * fix: turns out InterfaceRegistry.Resolve does the trick * chore: changelog * fix: remove unused import --------- Co-authored-by: Kevin Yang <[email protected]> * refactor(decode-base64): clean code improvements and fn docs (#1754) * add date into changelog for release * chore: finalize v1.1.0 changelog * feat(inflation): add burn method (#1823) * feat(inflation): add burn method * Update CHANGELOG.md * chore: fix changelog (#1824) * test(inflation): add additional burn test cases (#1828) * test(inflation): add negative burn tests * test(inflation): add total supply check to burn tests * Update CHANGELOG.md * feat(tokenfactory): burn native method (#1832) * refactor: move Burn rpc method to x/tokenfactory * Update tx_msgs.go * feat: add burn native method to tokenfactory msg server * feat: add cli cmd * fix: validate msg * feat: add v1.2.0 upgrade handler * Update CHANGELOG.md * fix: register codec for MsgBurnNative * fix: test --------- Co-authored-by: Unique-Divine <[email protected]> * revert: remove x/inflation burn method * feat(ica): ICA Host / Controller integration (#1820) * ICA Host / Controller integration. Added upgrade constants. Added make format command * Fixed required message URLs * Code import fix * Fixed upgrade name * Fixed upgrade target * Changed version number * Update CHANGELOG.md --------- Co-authored-by: Jonathan Gimeno <[email protected]> Co-authored-by: Kevin Yang <[email protected]> * refactor(oracle): add oracle slashing events (#1859) * refactor(oracle): add oracle slashing events * Update CHANGELOG.md * fix(ica): add controller stack (#1864) * fix(ica): add controller stack * chore: update changelog * fix: linter issues * Update CHANGELOG.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * feat(wasm)!: increase contract size limit to 3MB (#1906) * feat(wasm): increase contract size limit to 3MB * chore: update changelog * feat: add pebbledb support (#1818) * chore: make default db backend PebbleDB * chore: update changelog * chore: add v1.4.0 upgrade handler * feat(ibc): add wasm stack to ibc router (#1931) * feat(ibc): add wasm stack to ibc router * Update CHANGELOG.md * feat: add v1.5.0 upgrade handler * chore: update changelog * feat: add pebbledb support * chore: remove wasmbinding folder and nibiru/v1 dependency * fix: remove extra overrideWasmVariables * fix: upgrades * fix: oracle keeper * fix: epochs tests * feat: add v2.0.0 upgrade handler * linter * fix: upgrade handlers had wrong function type * Revert "feat: enable wasm light clients on IBC (08-wasm) (#2068)" This reverts commit ee5e29f. * fix: remove v2.1.0 upgrade handler * chore: update changelog for v2 EVM release * fix: revert testnet-1 chain id to 7210 * fix: revert wasmvm to v1.5.0 * feat(ibc): add back 08-wasm client * chore: minor refactors to resemble main branch --------- Signed-off-by: Unique-Divine <[email protected]> Signed-off-by: Unique-Divine <[email protected]> Co-authored-by: Unique Divine <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Unique-Divine <[email protected]> Co-authored-by: Unique-Divine <[email protected]> Co-authored-by: Matthias <[email protected]> Co-authored-by: Matthias <[email protected]> Co-authored-by: Jonathan Gimeno <[email protected]> Co-authored-by: Helder Moreira <[email protected]> Co-authored-by: Segfault <[email protected]> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Oleg Nikonychev <[email protected]>
Purpose / Abstract
Summary by CodeRabbit
New Features
Tests
Documentation