feat: account parser

[CalicoNino]

• Relates to Getting error Unsupported type: '/eth.types.v1.EthAccount' with brand new keplr wallet  #371

This is the first step in closing #371. Since we support Eth accounts, we need to add a custom Account Parser into both the SigningCosmWasmClient and SigningStargateClient. Luckily, there is already an option for injecting custom a Account Parser into SigningStargateClient (PR for reference).

We would also need to make a change to SigningCosmWasmClientOptions in cosmjs/cosmwasm-stargate, to also accept custom parsers cosmos/cosmjs#1610. Until then, in a separate PR, we would expose a signWithKeplrEVM to mitigate developers facing #371.

Summary by CodeRabbit

Release Notes for Version 4.5.2

• New Features

  • Introduced automatic labeling of newly opened issues with the "S-triage" label for better organization.
  • Added a GitHub Actions workflow to automate the addition of issues to a project board for triage and assignment.
  • Enhanced account handling by adding functions to convert Ethereum accounts to Cosmos accounts.
  • Introduced a new JSON configuration for the "cataclysm-1" blockchain, detailing network parameters.

• Chores

  • Updated CHANGELOG to reflect changes and version bump to 4.5.2.
  • Updated package version from 4.5.1 to 4.5.2.

[coderabbitai]

Walkthrough

This pull request introduces several changes aimed at improving issue management and account handling within the project. A new GitHub Actions workflow is created to automate the addition of newly opened issues to a project board and to apply a specific label. Additionally, new functions for converting Ethereum accounts to Cosmos accounts are added, along with corresponding unit tests. The versioning in the package.json and CHANGELOG.md files is updated to reflect these changes, and a new configuration file for a blockchain network is introduced.

Changes

File	Change Summary
.github/issue-labeler-config.yml	Added new label S-triage for automatic tagging of issues.
.github/workflows/gh-issues.yml	Introduced new workflow for automating issue management, with jobs for adding to project and labeling.
CHANGELOG.md	Added entry for version 4.5.2, noting updates and changes since 4.5.1.
package.json	Updated version from 4.5.1 to 4.5.2.
src/sdk/tx/account.test.ts	Added unit tests for accountFromEthAccount and accountFromNibiru functions.
src/sdk/tx/account.ts	Introduced accountFromEthAccount and accountFromNibiru functions for account conversion.
src/sdk/tx/txClient.ts	Updated NibiruTxClient to include accountParser option using accountFromNibiru.
src/sdk/utils/t.json	Added new JSON configuration for blockchain network "cataclysm-1".

Possibly related PRs

• chore: main to develop #375: This PR directly relates to the main PR as it introduces the same label configuration and workflow changes in the .github/issue-labeler-config.yml and .github/workflows/gh-issues.yml files, specifically adding the "S-triage" label and automating issue management.

Suggested labels

type: enhance

Suggested reviewers

• cgilbe27

Poem

🐰 In the garden of code where the issues bloom,
A label of triage now clears the room.
With workflows to guide and tests that ensure,
Our Cosmos accounts find their way, secure.
So hop with delight, let the changes take flight,
For a brighter tomorrow, our future is bright! 🌼

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 1b81bf6 and ec9bdca.

📒 Files selected for processing (1)

• src/sdk/tx/account.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/sdk/tx/account.ts

---

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.

[coderabbitai]

Actionable comments posted: 4

🧹 Outside diff range and nitpick comments (11)

.github/issue-labeler-config.yml (3)

1-3: LGTM with minor suggestions for improvement

The implementation of the issue labeler configuration is correct and will successfully add the "S-triage" label to all new issues. However, I have a few minor suggestions to improve the code:

1. Fix the typo in the comment (see separate comment).
2. Simplify the regular expression (see separate comment).
3. Consider adding more context about the purpose of the "S-triage" label and how it fits into your issue management workflow. This could help other team members understand the labeling strategy.

---

1-1: Fix typo in the comment

There's a small typo in the comment.

Please apply this change:

- # Adds the "S-triage" label ot any issue that gets opened.
+ # Adds the "S-triage" label to any issue that gets opened.

---

3-3: Simplify the regular expression

The current regular expression has an unnecessary trailing forward slash.

Consider simplifying it as follows:

-  - "/.*/"
+  - ".*"

This change removes the forward slashes, which are typically used as delimiters in many regex engines but are not needed in this YAML configuration. The simplified version ".*" will still match any string, effectively labeling all issues.

src/sdk/utils/t.json (1)

1-41: Overall, the configuration looks well-structured and follows Cosmos standards.

The JSON configuration for the "cataclysm-1" chain is comprehensive and follows the standard practices for Cosmos-based chains. All necessary sections are present and consistently configured.

To ensure the reliability and correctness of this configuration:

1. Thoroughly test this configuration in a staging environment before deploying to production.
2. Verify that all parameters align with the intended design and economics of the "cataclysm-1" chain.
3. Consider creating a separate documentation file explaining the rationale behind key configuration choices, which will be helpful for future maintenance and audits.

As the project evolves, consider implementing a process for managing and updating these configurations across different environments (e.g., testnet, mainnet). This could involve creating templates or using a configuration management tool to ensure consistency and ease of updates.

.github/workflows/gh-issues.yml (1)

16-23: LGTM with a suggestion: 'add-to-project' job is well-configured.

The job is correctly set up to add issues to the specified project board. The use of a secret for the GitHub token is a good security practice.

Consider using a repository variable for the project URL instead of hardcoding it. This would improve maintainability and make it easier to update if the project board changes in the future. For example:

with:
  project-url: ${{ vars.PROJECT_BOARD_URL }}
  github-token: ${{ secrets.NIBIRU_PM }}

Then, set the PROJECT_BOARD_URL variable in your repository settings.

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

21-21: Consider grouping related imports together.

The new import statement for accountFromNibiru is related to the Nibiru-specific functionality. Consider moving this import statement to be grouped with other Nibiru-related imports for better code organization.

---

73-73: Consider adding documentation for the new accountParser option.

To improve code maintainability and ease of use, consider adding a comment or documentation explaining the purpose and expected behavior of the accountParser option. This will help other developers understand when and how to use this new feature.

src/sdk/tx/account.test.ts (4)

7-30: LGTM: Well-structured test case for accountFromEthAccount.

This test case effectively covers the happy path scenario for accountFromEthAccount. It creates a mock EthAccount object with specific values and verifies that the returned account matches these values.

Consider adding more edge cases to increase test coverage, such as:

1. Testing with very large Long values for accountNumber and sequence.
2. Testing with an empty public key.
3. Testing with a different typeUrl for the public key.

---

32-41: LGTM: Good edge case coverage for accountFromEthAccount.

This test case effectively handles the scenario where baseAccount is undefined, which is an important edge case to consider.

Consider adding the following assertions to make the test more robust:

1. Verify that account.pubkey is explicitly null (not just falsy).
2. Check that account.address is an empty string (not just falsy).
3. Ensure that account.accountNumber and account.sequence are explicitly of type Long.

---

45-71: LGTM: Comprehensive test case for accountFromNibiru with EthAccount typeUrl.

This test case effectively covers the scenario of parsing an EthAccount from the Any type. It creates a mock Any object with EthAccount typeUrl and verifies that the returned account matches the input values.

Consider adding the following assertions to make the test more robust:

1. Verify that the returned account object is not null or undefined.
2. Check that account.pubkey is not null and is of the expected type.
3. Ensure that account.accountNumber and account.sequence are explicitly of type Long.

---

1-83: Overall, well-structured and comprehensive test suite.

The test file provides good coverage for the accountFromEthAccount and accountFromNibiru functions, including both happy path scenarios and some edge cases. The use of Jest as the testing framework is appropriate, and the test structure is clear and easy to follow.

To further improve the test suite:

1. Consider adding more edge cases and boundary conditions to increase test coverage.
2. Enhance assertions in some test cases as suggested in previous comments.
3. Use mocking for external dependencies to isolate the units under test.
4. Add error handling test cases to ensure robustness.

These improvements will make the test suite more comprehensive and resilient to future changes.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 1e6b7df and 0b44443.

📒 Files selected for processing (8)

• .github/issue-labeler-config.yml (1 hunks)
• .github/workflows/gh-issues.yml (1 hunks)
• CHANGELOG.md (1 hunks)
• package.json (1 hunks)
• src/sdk/tx/account.test.ts (1 hunks)
• src/sdk/tx/account.ts (1 hunks)
• src/sdk/tx/txClient.ts (2 hunks)
• src/sdk/utils/t.json (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• package.json

🧰 Additional context used

🪛 Markdownlint

CHANGELOG.md

6-6: null
Bare URL used

(MD034, no-bare-urls)

---

1-1: null
First line in a file should be a top-level heading

(MD041, first-line-heading, first-line-h1)

🔇 Additional comments (12)

src/sdk/utils/t.json (5)

6-10: Stake currency configuration looks good.

The stake currency configuration follows the standard format for Cosmos-based chains. The use of "unibi" as the minimal denomination (representing micro-NIBI) is consistent with common practices.

---

11-13: BIP44 configuration is correct.

The coin type 118 is the standard for Cosmos-based chains in the BIP44 specification, so this configuration is correct.

---

14-21: Bech32 configuration is consistent and follows standards.

The bech32 address prefixes are consistently based on "nibi", which aligns with the chain name. The configuration follows the standard format for Cosmos-based chains, defining prefixes for account, validator, and consensus addresses and their public keys.

---

22-28: Verify if single currency configuration is intended.

The currencies section defines only NIBI, which is consistent with the stake currency configuration. This is common for many chains, but some networks support multiple currencies.

Please confirm:

1. Is it intentional to have only NIBI as the supported currency?
2. Are there plans to add more currencies in the future?

If additional currencies are planned, consider adding a TODO comment or creating a separate issue to track this task.

---

1-5: Verify chain identification and endpoints.

The chain identification and network endpoints look good. However, please confirm:

1. Is it intentional that both chainId and chainName are set to "cataclysm-1"?
2. Are the RPC and REST endpoints correct and operational?

To verify the endpoints, you can run the following curl commands:

Both commands should return "cataclysm-1" if the endpoints are correct and operational.

✅ Verification successful

Chain identification and endpoints verified.

All configurations are correct for "cataclysm-1".

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify RPC endpoint
curl -s https://rpc.nibiru.fi/status | jq '.result.node_info.network'

# Verify REST endpoint
curl -s https://lcd.nibiru.fi/cosmos/base/tendermint/v1beta1/node_info | jq '.default_node_info.network'

Length of output: 202

.github/workflows/gh-issues.yml (3)

1-8: LGTM: Workflow name and trigger events are well-defined.

The workflow name "Auto-add GH issues to project" clearly describes its purpose. The trigger events are correctly set to run on issue creation and labeling, which aligns with the workflow's objectives.

---

10-12: LGTM: Permissions are correctly set.

The permissions are appropriately configured with the principle of least privilege. Write access to issues and read access to contents are the minimum required for the workflow's tasks.

---

25-38: LGTM with questions: 'label-triage' job is well-configured, but clarification needed.

The job is set up correctly to label new issues using a configuration file. The condition to run only on newly opened issues without labels is appropriate.

1. The 'not-before' date is set to May 1, 2024. Is this intentional? This will prevent the action from running until that date, which is several months in the future.

2. The job name (line 26) seems to be incorrect. It's currently set to "Add GH ticket to project", which is the same as the previous job and doesn't reflect its actual function of labeling issues.

Consider updating the job name to better reflect its purpose:

-    name: "Add GH ticket to project"
+    name: "Label new issues"

To check if there are any other instances of potentially incorrect job names or dates, let's run the following script:

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

73-73: LGTM: Enhanced flexibility with account parser option.

The addition of the accountParser option with accountFromNibiru enhances the flexibility of the NibiruTxClient. This change allows for custom account parsing specific to Nibiru accounts.

---

Line range hint 1-99: Summary of changes and suggestions

The changes to src/sdk/tx/txClient.ts enhance the NibiruTxClient by adding a custom account parser option. While the implementation looks correct, consider the following suggestions:

1. Group the new import statement with other related imports.
2. Add documentation for the new accountParser option to improve code maintainability.
3. Verify the impact of this change on other parts of the codebase that use NibiruTxClient or connectWithSigner.

These improvements will enhance code organization, maintainability, and ensure the change doesn't introduce unexpected behavior in other parts of the codebase.

---

73-73: Verify the impact of the new accountParser option.

The addition of the accountParser option might affect other parts of the codebase that interact with NibiruTxClient. Let's verify its usage and potential impact.

✅ Verification successful

The impact of the new accountParser option has been verified and is contained within the expected areas of the codebase. No unintended effects were found.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for usage of NibiruTxClient and potential impacts of the new accountParser option.

# Search for NibiruTxClient usage
echo "Searching for NibiruTxClient usage:"
rg --type typescript "NibiruTxClient" -A 5

# Search for connectWithSigner method calls
echo "\nSearching for connectWithSigner method calls:"
rg --type typescript "connectWithSigner" -A 5

# Search for accountFromNibiru usage
echo "\nSearching for accountFromNibiru usage:"
rg --type typescript "accountFromNibiru"

Length of output: 511

---

Script:

#!/bin/bash
# Description: Check for usage of NibiruTxClient and potential impacts of the new accountParser option.

# Search for NibiruTxClient usage
echo "Searching for NibiruTxClient usage:"
rg --type ts "NibiruTxClient" -A 5

# Search for connectWithSigner method calls
echo "\nSearching for connectWithSigner method calls:"
rg --type ts "connectWithSigner" -A 5

# Search for accountFromNibiru usage
echo "\nSearching for accountFromNibiru usage:"
rg --type ts "accountFromNibiru"

Length of output: 6471

src/sdk/tx/account.test.ts (1)

1-5: LGTM: Import statements are well-organized and relevant.

The import statements are logically ordered and include all necessary dependencies for the tests.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0b44443 and b948462.

📒 Files selected for processing (2)

• src/sdk/tx/account.test.ts (1 hunks)
• src/sdk/tx/account.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/sdk/tx/account.test.ts

🔇 Additional comments (2)

src/sdk/tx/account.ts (2)

12-25: LGTM! Undefined baseAccount handling implemented.

The function now properly checks for undefined baseAccount and throws an error if it's undefined. This addresses the concern raised in the previous review. The rest of the implementation looks correct and efficient.

---

1-11: Well-structured code with good documentation

The file is well-organized with appropriate imports and clear JSDoc comments for both functions. This improves code readability and maintainability.

Also applies to: 26-32

[github-actions]

Lines	Statements	Branches	Functions
	95.59% (911/953)	83.4% (206/247)	94.02% (299/318)

[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 📦🚀