feat: cosmwasmclient extension & signingcosmwasmclient implementation

[CalicoNino]

• Closes Extend CosmWasmSigningClient with options so we inject a custom AccountParser #377
• Closes Getting error Unsupported type: '/eth.types.v1.EthAccount' with brand new keplr wallet  #371

Mitigating cosmos/cosmjs#1610 in NibiJs.

Summary by CodeRabbit

• New Features

  • Introduced NibiCosmWasmClient and NibiSigningCosmWasmClient classes for enhanced interaction with CosmWasm smart contracts, including account management and transaction handling.
  • Added methods for connecting to the blockchain, uploading contracts, executing instructions, and managing tokens.

• Dependencies

  • Added pako and @types/pako as new dependencies in the project.

• Configuration Updates

  • Refined coverage collection criteria in Jest configuration.

[coderabbitai]

Walkthrough

The pull request introduces several modifications across multiple files. It updates the Jest configuration to exclude specific files from coverage collection, adds new dependencies in the package.json, and introduces two new classes: NibiCosmWasmClient and NibiSigningCosmWasmClient, which enhance interactions with CosmWasm smart contracts. Additionally, modifications to the NibiruTxClient class reflect the integration of the new signing client.

Changes

File	Change Summary
jest.config.ts	Added patterns to collectCoverageFrom to exclude cosmwasmclient.ts and signingcosmwasmclient.ts.
package.json	Added dependency pako and development dependency @types/pako.
src/sdk/core/cosmwasmclient.ts	Introduced NibiCosmWasmClient class with methods for account management and connection.
src/sdk/core/signingcosmwasmclient.ts	Introduced NibiSigningCosmWasmClient class with methods for contract operations and transaction management.
src/sdk/tx/txClient.ts	Updated NibiruTxClient to utilize NibiSigningCosmWasmClient for handling transactions.

Assessment against linked issues

Objective	Addressed	Explanation
Extend CosmWasmSigningClient with options for custom AccountParser (#377)	✅
Resolve error with new Keplr wallet (#371)	✅

Possibly related PRs

• feat: account parser #374: Introduces a custom Account Parser that integrates with the SigningCosmWasmClient, relevant to the updates in NibiruTxClient.

Suggested reviewers

• cgilbe27

🐇 In the code, we hop and play,
New classes added, hip-hip-hooray!
With coverage refined, we leap with glee,
For smart contracts, we’re now fancy-free!
Hopping through code, with joy we sing,
In the world of Nibiru, let’s see what we bring! 🌟

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Lines	Statements	Branches	Functions
	95.43% (879/921)	80.66% (171/212)	93.92% (294/313)

[coderabbitai]

Actionable comments posted: 7

🧹 Outside diff range and nitpick comments (4)

src/sdk/core/cosmwasmclient.ts (1)

53-56: Use specific error classes instead of generic Error

Throwing a generic Error makes it difficult to handle specific error cases downstream. Consider using a more specific error class or creating a custom error to provide better context.

src/sdk/core/signingcosmwasmclient.ts (3)

577-592: Consider default gas multiplier for fee calculation

In the signAndBroadcast method, when calculating the fee with auto gas, you're using this.defaultGasMultiplier. Ensure that this multiplier is appropriate for the transactions you are broadcasting. Adjusting it may improve the accuracy of gas estimation and transaction success rates.

---

707-713: Simplify account retrieval from signer

In the signAmino method, the logic to retrieve the account from the signer can be streamlined for better readability.

Apply this diff to simplify the account retrieval:

 const accountFromSigner = (await this.signer.getAccounts()).find(
   (account) => account.address === signerAddress
 )
-if (!accountFromSigner) {
-  throw new Error("Failed to retrieve account from signer")
-}
+assert(accountFromSigner, "Failed to retrieve account from signer")

---

771-772: Simplify public key encoding in direct signing

In the signDirect method, the encoding of the public key can be simplified for clarity.

Apply this diff to simplify the public key encoding:

 const pubkey = encodePubkey(encodeSecp256k1Pubkey(accountFromSigner.pubkey))
+const pubkey = encodePubkey({
+  type: "tendermint/PubKeySecp256k1",
+  value: toBase64(accountFromSigner.pubkey),
+})

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between d7e324d and 440e314.

⛔ Files ignored due to path filters (1)

• yarn.lock is excluded by !**/yarn.lock, !**/*.lock

📒 Files selected for processing (5)

• jest.config.ts (1 hunks)
• package.json (2 hunks)
• src/sdk/core/cosmwasmclient.ts (1 hunks)
• src/sdk/core/signingcosmwasmclient.ts (1 hunks)
• src/sdk/tx/txClient.ts (2 hunks)

🧰 Additional context used

🔇 Additional comments (15)

jest.config.ts (1)

25-26: LGTM: Appropriate exclusions for external implementations.

The addition of these two lines to exclude cosmwasmclient.ts and signingcosmwasmclient.ts from coverage collection is appropriate. These files are implementations from Cosmjs, as indicated by the comments, and excluding them from coverage allows the project to focus on its custom extensions and implementations.

This change aligns well with the PR objectives, particularly the implementation of a new SigningCosmWasmClient. By excluding the base implementation from coverage, it ensures that the coverage reports will more accurately reflect the custom work done in this project.

package.json (2)

50-50: LGTM: Addition of pako dependency is justified.

The addition of the pako package (version ^2.1.0) is appropriate for the implementation of SigningCosmWasmClient. This addresses the previous comment about unused packages, as it provides necessary functionality for compression/decompression operations likely used in the new client implementation.

---

71-71: LGTM: Addition of @types/pako dev dependency.

The inclusion of @types/pako (version ^2.0.3) as a dev dependency is a good practice. It provides TypeScript type definitions for the pako package, ensuring type safety and improving developer experience with better IDE support.

src/sdk/core/cosmwasmclient.ts (2)

18-22: Ensure correct parameters are passed to the super constructor

Verify that passing cometClient to the super constructor of CosmWasmClient is appropriate. The base class may expect different parameters or initialization logic. Consult the CosmWasmClient constructor documentation to ensure compatibility.

---

9-9: Verify if CometClient is the correct client to use

Ensure that CometClient is the appropriate client class imported from @cosmjs/tendermint-rpc. Depending on the version, the client might be named differently (e.g., TmClient or TendermintClient). Confirm that CometClient is correctly imported and compatible with CosmWasmClient.

Run the following script to check for the correct import of CometClient:

src/sdk/tx/txClient.ts (8)

15-15: Importing setupWasmExtension

The addition of setupWasmExtension from "@cosmjs/cosmwasm-stargate" ensures that the WASM functionalities are extended properly in the client.

---

18-21: Importing Nibiru-specific Signing Clients

The import statements for NibiSigningCosmWasmClient and NibiSigningCosmWasmClientOptions from "../core/signingcosmwasmclient" correctly bring in the Nibiru-specific implementations needed for customized account handling.

---

29-29: Updating wasmClient to Nibiru Implementation

The wasmClient property type has been updated to NibiSigningCosmWasmClient, aligning with the shift to the Nibiru-specific signing client. This ensures compatibility with the custom account parser and addresses the issues outlined in the PR objectives.

---

35-35: Constructor Parameter Update

The constructor now accepts a wasm parameter of type NibiSigningCosmWasmClient. This change is consistent with the updated wasmClient property and supports the new client implementation.

---

55-55: Updating WASM Options Type

The wasmOptions parameter type in connectWithSigner has been updated to NibiSigningCosmWasmClientOptions, which is appropriate for the Nibiru-specific client configuration.

---

58-62: Connecting with Nibiru Signing CosmWasm Client

The method NibiSigningCosmWasmClient.connectWithSigner is correctly used to create a new instance of the signing client. This replaces the standard CosmWasm client with the Nibiru-specific implementation.

---

63-63: Ensuring Override Order in Options Spread

In the options object passed to NibiSigningCosmWasmClient.connectWithSigner, the spread operator ...wasmOptions comes after the default accountParser and gasPrice. This means if wasmOptions contains accountParser or gasPrice, it will override the default settings. Ensure this behavior is intentional.

---

63-63: Consistent Account Parser Configuration

The addition of accountParser: accountFromNibiru ensures that the custom account parser is used, addressing the issue of handling Ethereum account types. This change is crucial for resolving the errors encountered with new Keplr wallets.

src/sdk/core/signingcosmwasmclient.ts (2)

715-716: Ensure correct signMode is used in Amino signing

In the signAmino method, verify that the signMode used matches the intended signing mode for Amino transactions. Using an incorrect signMode can lead to signature verification failures.

Check that SignMode.SIGN_MODE_LEGACY_AMINO_JSON is appropriate for your use case and compatible with the network's requirements.

---

576-589: ⚠️ Potential issue

Ensure gasPrice is defined when using auto gas calculation

In the signAndBroadcast method, when fee is set to "auto" or a number, you assert that this.gasPrice is defined. If this.gasPrice is undefined, an error will be thrown. To improve user experience, consider providing a more descriptive error message or setting a default gasPrice.

Run the following script to verify if instances of NibiSigningCosmWasmClient always have gasPrice set when auto gas is used:

✅ Verification successful

Let's re-run the verification with the corrected scripts to ensure gasPrice is properly defined when using auto gas.

---

gasPrice is consistently defined when using auto gas calculation. No issues found.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if NibiSigningCosmWasmClient instances have gasPrice defined when auto gas is used

# Test: Search for constructor calls without gasPrice. Expect: No matches.
rg --type ts 'new NibiSigningCosmWasmClient\((.*), (.*), \{(?!.*gasPrice)' -A 5

# Test: Search for signAndBroadcast calls with 'auto' or number fee without gasPrice. Expect: No matches.
rg --type ts 'signAndBroadcast\(([^,]+), ([^,]+), (("auto")|(\d+)), [^,]+\)' -A 5

Length of output: 473

---

Script:

#!/bin/bash
# Description: Check if NibiSigningCosmWasmClient instances have gasPrice defined when auto gas is used

# Test: Search for constructor calls without gasPrice. Expect: No matches.
rg --type ts --pcre2 'new NibiSigningCosmWasmClient\((.*), (.*), \{(?!.*gasPrice)' -A 5

# Test: Search for signAndBroadcast calls with "auto" or number fee without gasPrice. Expect: No matches.
rg --type ts --pcre2 'signAndBroadcast\(([^,]+), ([^,]+), ("auto"|\d+), [^,]+\)' -A 5

Length of output: 177

[nibibot]

🎉 This PR is included in version 5.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀