fix(nibijs): examples up-to-date + more docs + test examples in CI

[Unique-Divine]

Context

• ci: Adds workflow step to run the examples against local Nibiru network
• docs(nibijs): Adds function and type docs to many symbols
• Updates the README to have up-to-date runnable examples and correct badges
• Brings main branch up to v0.21.42
• Symlink for README -> packages/nibijs/README : Rather than duplicating the file (easier to maintain)
• Symlink for packages/nibijs-examples -> ./examples : Runnable from top of repo but still easy to maintain)

Note

• [PR created without the generated markdown docs to see the diff more easily.]

Summary by CodeRabbit

• New Features

  • Search functionality with a new search bar for fetching and displaying results.
  • Development Quick Start section added to documentation.
  • New examples for wallet creation, querying, and sending funds.

• Documentation

  • Updated links to Nibiru documentation and test workflow badges.
  • Restructured examples section in documentation.
  • Added badges for NPM version, downloads, license, and Discord members.

• Bug Fixes

  • Corrected example code for creating a wallet, querying, and sending funds.

• Refactor

  • Improved background process for running the Nibiru network.
  • Updated job naming for better clarity.

• Style

  • Enhanced styles for the new search bar component.

• Tests

  • Added new step to run examples using ts-node in test workflows.

• Chores

  • Updated .github/workflows/test-ts-sdk.yaml with branch restrictions and additional steps.

[coderabbitai]

Walkthrough

The updates to the NibiJS TypeScript SDK and its documentation reflect a comprehensive effort to streamline the development experience, enhance maintainability, and improve clarity. Changes include branch restrictions, CLI tooling adjustments, new example executions, and job naming refinements. Documentation has been enriched with badges, updated links, and a new quick start section, while examples have been revised for consistency with the latest SDK practices.

Changes

File Pattern	Change Summary
.github/workflows/...	Updated branch restrictions, added steps for CLI tooling, new example execution, and job naming refinements.
README.md, packages/nibijs/docs/intro.md	Updated documentation links, added badges, revised examples, and added a development quick start section.
packages/nibijs-examples/..., packages/nibijs/src/..., packages/examples/...	Updated shared utilities, chain types, transaction handling, examples, chain configuration, parsing functions, test utilities, and documentation.
packages/nibijs/docs/...	Numerous updates to interfaces, classes, enums, and modules documentation reflecting changes in version numbers, formatting, method signatures, and added descriptions.
jest.config.js	Updated module path ignore patterns to exclude "packages/examples".

Related issues

• The issue titled "Make the NibiJS examples easier to maintain and keep up-to-date" could be linked to this PR as the changes include updates to examples and documentation, which align with the issue's objectives to keep examples up-to-date and improve documentation for third-party developers.

Poem

In the land of code where the NibiJS hops,
A flurry of changes, like raindrops non-stop.
With each leap and bound, the docs grow more clear,
A rabbit's proud work for devs far and near. 🐇💻✨

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• If you reply to a review comment from CodeRabbit, the bot will automatically respond.
• To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
• Note: Review comments are made on code diffs or files, not on the PR overview.
• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

[github-actions]

Lines	Statements	Branches	Functions
	95.8% (1326/1384)	98.27% (570/580)	88.4% (305/345)

[coderabbitai]

Review Status

Actionable comments generated: 5

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 8409d2a and 3e4aac2.

Files ignored due to filter (5)

• examples/package.json
• img/nibijs.png
• packages/nibijs-examples/package.json
• packages/nibijs-examples/yarn.lock
• yarn.lock

Files selected for processing (18)

• .github/workflows/test-ts-sdk.yaml (4 hunks)
• README.md (7 hunks)
• examples (1 hunks)
• packages/nibijs-examples/01_new-wallet.ts (1 hunks)
• packages/nibijs-examples/02_queries.ts (1 hunks)
• packages/nibijs-examples/03_messages.ts (1 hunks)
• packages/nibijs-examples/04_sending_funds.ts (1 hunks)
• packages/nibijs-examples/shared.ts (1 hunks)
• packages/nibijs/README.md (1 hunks)
• packages/nibijs/src/chain/parse.ts (3 hunks)
• packages/nibijs/src/chain/types.ts (2 hunks)
• packages/nibijs/src/msg/index.ts (1 hunks)
• packages/nibijs/src/msg/perp.ts (2 hunks)
• packages/nibijs/src/test/helpers.ts (4 hunks)
• packages/nibijs/src/tx/event.ts (1 hunks)
• packages/nibijs/src/tx/index.ts (1 hunks)
• packages/nibijs/src/tx/signer.ts (2 hunks)
• packages/nibijs/src/tx/signingClient.ts (5 hunks)

Files skipped from review due to trivial changes (3)

• examples
• packages/nibijs/README.md
• packages/nibijs/src/tx/signingClient.ts

Additional comments: 36

.github/workflows/test-ts-sdk.yaml (4)

• 3-9: The update to include the main branch in the CI workflow is consistent with the PR objectives to ensure examples are tested against the latest version of the network.

• 30-38: The addition of steps to install and check the nibid CLI ensures that the local Nibiru network is running the correct version for testing examples.

• 58-63: The new steps to run examples using ts-node are a good addition to the CI pipeline, ensuring that the examples are tested for compatibility with the actual blockchain network.

• 74-74: The job name "SonarQube Quality Gate" is now enclosed in quotes, which is a minor change for consistency in YAML syntax.

README.md (7)

• 18-19: The badge link for test workflows has been correctly updated to point to the new workflow file and branch.

• 54-54: The documentation link has been correctly updated to the new location.

• 74-79: The example for creating a wallet has been updated to use the new newRandomWallet function, which is in line with the latest SDK changes.

• 88-99: The example for querying has been updated to use the Localnet type and the new import structure, which aligns with the latest SDK changes.

• 112-127: The example for sending funds has been updated to use the Localnet type and the new import structure, which aligns with the latest SDK changes.

• 136-189: The example for a transaction with arbitrary messages has been updated to use the Localnet type and the new import structure, which aligns with the latest SDK changes.

• 208-232: The development quick start guide has been provided with clear instructions and no syntax errors.

packages/nibijs-examples/01_new-wallet.ts (1)

• 10-10: Ensure that logging the mnemonic is acceptable for example purposes, as mnemonics are sensitive information.

packages/nibijs-examples/03_messages.ts (1)

• 12-16: The use of TEST_MNEMONIC from test helpers in example code should be clearly documented to ensure users understand it's for demonstration purposes only and should be replaced with secure mnemonics in production.

packages/nibijs-examples/04_sending_funds.ts (1)

• 1-50: The example script 04_sending_funds.ts correctly demonstrates the usage of the updated nibijs package functions and types, including the use of promises and command-line arguments. It also follows best practices for example scripts by logging output and handling completion.

packages/nibijs-examples/shared.ts (1)

• 33-35: The usage of path.basename in logSuccess is correct and ensures cross-platform compatibility.

packages/nibijs/src/chain/parse.ts (3)

• 71-77: The updated error message in toSdkDec provides more clarity on the precision error, which is a good enhancement for debugging purposes.

• 96-116: The fromSdkDec function now includes an explicit return type and improved documentation, which enhances type safety and developer understanding of the code.

• 4-36: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [4-116]

Overall, the changes in parse.ts align with the PR objectives of updating documentation and improving type safety.

packages/nibijs/src/chain/types.ts (3)

• 1-4: The import and export modifications are consistent with the PR objectives and the summary provided.

• 36-37: The update to the TxLog interface to use ABCIEvent[] is consistent with the PR objectives and the summary provided.

• 1-6: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [1-38]

Verify that the removal of the Event and Attribute interfaces does not affect other parts of the codebase where they might be used.

---

Verification result:

The review of the nibijs package changes has been conducted with the following findings:

• The Event and Attribute interfaces have been removed from types.ts. The search within the packages/nibijs/src/chain/ directory indicates that Event is no longer used, and ABCIEvent has replaced it in TxLog.
• There is no usage of the Attribute interface in the packages/nibijs/src/chain/ directory.

Based on the provided context, there are no issues with the removal of the Event and Attribute interfaces from types.ts.

packages/nibijs/src/msg/index.ts (1)

• 3-7: The summary indicates that the perp assignment was removed from the MsgFactory class, but the hunk shows that it is still present. Please ensure that the summary aligns with the final state of the code.

packages/nibijs/src/msg/perp.ts (3)

• 86-90: The addition of a trailing comma in the function signature is a stylistic change that aligns with common TypeScript conventions.

• 103-111: The PerpMsgFactory class and its methods have been added to facilitate the creation of transaction messages. Ensure that the implementation of these methods aligns with the expected behavior of the Nibiru network's x/perp module.

• 107-107: Verify that the provided documentation link is correct and accessible to ensure that users can find additional information about Nibiru's x/perp module.

packages/nibijs/src/test/helpers.ts (4)

• 5-14: The changes to TEST_CHAIN and TEST_MNEMONIC and the addition of TEST_ADDRESS are consistent with the PR objectives to update examples and documentation to reflect the latest version of the Nibiru network.

• 22-30: The update to the validateBlockFromJsonRpc function's schema appears to be correct and ensures that the block JSON object has the expected structure.

• 51-54: The update to assertHasMsgType to accept an array of ABCIEvent instead of Event aligns with the PR's goal of improving type safety and clarity.

• 62-67: The update to assertHasEventType to accept an array of ABCIEvent instead of Event aligns with the PR's goal of improving type safety and clarity.

packages/nibijs/src/tx/event.ts (3)

• 3-50: The new interfaces EventAttribute, EventMapAttribute, ABCIEvent, and EventMap along with the function eventToMap are correctly implemented and documented. They provide a structured way to handle ABCI events.

• 52-57: The findEvent function is correctly implemented to filter events by type, which aligns with the PR objectives to enhance the developer experience with more robust functionalities.

• 59-68: The parseEventLogs function is correctly implemented to return a mutable and typed version of the events payload from a transaction response, which is in line with the PR objectives to improve the codebase with additional functionalities and improved type safety.

packages/nibijs/src/tx/index.ts (1)

• 1-1: The addition of export * from "./event" extends the public API of the module, making the event module's entities available for import from tx/index.ts.

packages/nibijs/src/tx/signer.ts (3)

• 29-33: The update to the newSignerFromMnemonic function correctly reflects the change to return a promise of DirectSecp256k1HdWallet, aligning with the PR objectives to update function signatures.

• 45-48: The newRandomWallet function has been updated to return a promise of DirectSecp256k1HdWallet, which is consistent with the PR objectives and the summary provided.

• 35-35: The explicit export of DirectSecp256k1HdWallet is a new addition that aligns with the PR objectives to introduce new and updated exported entities.

[coderabbitai]

Review Status

Actionable comments generated: 6

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 3e4aac2 and b17342a.

Files ignored due to filter (6)

• package-lock.json
• packages/examples/package.json
• packages/nibijs/package.json
• packages/nibijs/tsconfig.json
• tsconfig.json
• yarn.lock

Files selected for processing (55)

• README.md (7 hunks)
• packages/examples/.gitignore (1 hunks)
• packages/examples/README.md (1 hunks)
• packages/examples/examples.test.ts (1 hunks)
• packages/nibijs/docs/classes/CustomChain.md (10 hunks)
• packages/nibijs/docs/classes/MsgFactory.md (2 hunks)
• packages/nibijs/docs/classes/NibiruQueryClient.md (7 hunks)
• packages/nibijs/docs/classes/NibiruSigningClient.md (7 hunks)
• packages/nibijs/docs/classes/PerpMsgFactory.md (8 hunks)
• packages/nibijs/docs/classes/SpotMsgFactory.md (6 hunks)
• packages/nibijs/docs/classes/StableSwap.md (10 hunks)
• packages/nibijs/docs/enums/BECH32_PREFIX.md (1 hunks)
• packages/nibijs/docs/enums/Signer.md (2 hunks)
• packages/nibijs/docs/interfaces/ABCIEvent.md (1 hunks)
• packages/nibijs/docs/interfaces/Chain.md (7 hunks)
• packages/nibijs/docs/interfaces/ChainIdParts.md (2 hunks)
• packages/nibijs/docs/interfaces/CoinMap.md (1 hunks)
• packages/nibijs/docs/interfaces/EpochsExtension.md (2 hunks)
• packages/nibijs/docs/interfaces/EventAttribute.md (1 hunks)
• packages/nibijs/docs/interfaces/EventMap.md (1 hunks)
• packages/nibijs/docs/interfaces/EventMapAttribute.md (1 hunks)
• packages/nibijs/docs/interfaces/InflationExtension.md (2 hunks)
• packages/nibijs/docs/interfaces/MsgAddMarginEncodeObject.md (3 hunks)
• packages/nibijs/docs/interfaces/MsgClosePositionEncodeObject.md (3 hunks)
• packages/nibijs/docs/interfaces/MsgCreatePoolEncodeObject.md (3 hunks)
• packages/nibijs/docs/interfaces/MsgDonateToEcosystemFundEncodeObject.md (3 hunks)
• packages/nibijs/docs/interfaces/MsgExitPoolEncodeObject.md (3 hunks)
• packages/nibijs/docs/interfaces/MsgJoinPoolEncodeObject.md (3 hunks)
• packages/nibijs/docs/interfaces/MsgMultiLiquidateEncodeObject.md (3 hunks)
• packages/nibijs/docs/interfaces/MsgOpenPositionEncodeObject.md (3 hunks)
• packages/nibijs/docs/interfaces/MsgPartialCloseEncodeObject.md (3 hunks)
• packages/nibijs/docs/interfaces/MsgRemoveMarginEncodeObject.md (3 hunks)
• packages/nibijs/docs/interfaces/MsgSwapAssetsEncodeObject.md (3 hunks)
• packages/nibijs/docs/interfaces/MsgTypeUrls.md (1 hunks)
• packages/nibijs/docs/interfaces/OracleExtension.md (2 hunks)
• packages/nibijs/docs/interfaces/PageRequest.md (6 hunks)
• packages/nibijs/docs/interfaces/PerpExtension.md (2 hunks)
• packages/nibijs/docs/interfaces/SpotExtension.md (2 hunks)
• packages/nibijs/docs/interfaces/SudoExtension.md (2 hunks)
• packages/nibijs/docs/interfaces/TxLog.md (2 hunks)
• packages/nibijs/docs/interfaces/TxMessage.md (1 hunks)
• packages/nibijs/docs/intro.md (7 hunks)
• packages/nibijs/docs/modules.md (40 hunks)
• packages/nibijs/log-jsonrpc.txt (1 hunks)
• packages/nibijs/src/chain/chain.ts (5 hunks)
• packages/nibijs/src/chain/parse.ts (2 hunks)
• packages/nibijs/src/chain/types.ts (3 hunks)
• packages/nibijs/src/msg/perp.ts (1 hunks)
• packages/nibijs/src/test/chain.test.ts (2 hunks)
• packages/nibijs/src/test/faucet.test.ts (4 hunks)
• packages/nibijs/src/test/query.test.ts (7 hunks)
• packages/nibijs/src/testutil.ts (4 hunks)
• packages/nibijs/src/tx/event.ts (1 hunks)
• packages/nibijs/src/tx/signer.ts (2 hunks)
• packages/nibijs/src/tx/signingClient.ts (1 hunks)

Files not summarized due to errors (1)

• packages/nibijs/log-jsonrpc.txt: Error: Message exceeds token limit

Files skipped from review due to trivial changes (21)

• packages/examples/.gitignore
• packages/examples/README.md
• packages/nibijs/docs/classes/CustomChain.md
• packages/nibijs/docs/classes/NibiruQueryClient.md
• packages/nibijs/docs/enums/BECH32_PREFIX.md
• packages/nibijs/docs/interfaces/Chain.md
• packages/nibijs/docs/interfaces/CoinMap.md
• packages/nibijs/docs/interfaces/EventAttribute.md
• packages/nibijs/docs/interfaces/MsgCreatePoolEncodeObject.md
• packages/nibijs/docs/interfaces/MsgDonateToEcosystemFundEncodeObject.md
• packages/nibijs/docs/interfaces/MsgExitPoolEncodeObject.md
• packages/nibijs/docs/interfaces/MsgOpenPositionEncodeObject.md
• packages/nibijs/docs/interfaces/MsgSwapAssetsEncodeObject.md
• packages/nibijs/docs/interfaces/PageRequest.md
• packages/nibijs/docs/interfaces/PerpExtension.md
• packages/nibijs/docs/interfaces/SudoExtension.md
• packages/nibijs/docs/interfaces/TxLog.md
• packages/nibijs/docs/interfaces/TxMessage.md
• packages/nibijs/src/msg/perp.ts
• packages/nibijs/src/test/query.test.ts
• packages/nibijs/src/tx/signingClient.ts

Additional comments: 154

README.md (7)

• 2-35: The addition of badges and updates to the README are consistent with the PR objectives and summary.

• 49-54: The restructuring of the examples section and updates to the documentation links are consistent with the PR objectives and summary.

• 69-79: The updates to the "Creating a wallet" example, including the removal of WalletHD and the use of newRandomWallet, are consistent with the PR objectives and summary.

• 86-98: The updates to the "Querying" example, including the replacement of IncentivizedTestnet with Localnet and the introduction of a CHAIN constant, are consistent with the PR objectives and summary.

• 110-127: The updates to the "Sending funds" example, including the introduction of a CHAIN constant and the use of newSignerFromMnemonic and newCoins, are consistent with the PR objectives and summary.

• 134-189: The updates to the "Transaction with arbitrary messages" example, including the introduction of a CHAIN constant and the use of newSignerFromMnemonic, newCoin, and parseEventLogs, are consistent with the PR objectives and summary.

• 208-232: The addition of the "Development Quick Start" section with instructions for installing nvm and using yarn is consistent with the PR objectives and summary.

packages/examples/examples.test.ts (7)

• 1-16: The imports from @nibiruchain/nibijs and related packages appear to be updated to reflect the latest SDK changes, including the use of NibiruSigningClient, NibiruQueryClient, and various utility functions and types. This aligns with the PR objectives to update examples with the latest SDK version.

• 24-24: The CHAIN constant is set to Localnet, which is consistent with the summary mentioning the introduction of Localnet as a constant. This change should be verified across all examples to ensure consistency.

---

Verification result:

The CHAIN constant has been set to Localnet in the examples.test.ts file and is consistently used across various documentation files, including the README.md and intro.md within the nibijs package. This aligns with the PR's objective to update examples and documentation to reflect the latest SDK changes.

• 30-36: The getSigner function is using the TEST_MNEMONIC to create a signer, which is good for examples but should be clearly documented to prevent misuse in production environments.

• 87-96: The exampleNewWallet function demonstrates creating a new wallet, which is one of the new examples mentioned in the summary. It's important to ensure that the mnemonic is handled securely and not logged in production code.

• 98-114: The exampleQueries function showcases various query operations, aligning with the PR's goal to provide comprehensive examples. It's using TEST_ADDRESS which should be clearly marked for testing purposes only.

• 117-172: The exampleTxMsgs function demonstrates transaction broadcasting with multiple messages, which is part of the new examples added as per the summary. It's important to ensure that the sleep function is used appropriately and does not introduce unnecessary delays in the CI process.

• 174-206: The exampleSendFunds function is another new example that aligns with the PR objectives. It includes a call to hereDoc for formatting output, which is a nice touch for readability. Ensure that the sleep function is used judiciously.

packages/nibijs/docs/classes/MsgFactory.md (4)

• 1-4: The version number has been correctly updated to v0.21.42 in the documentation header.

• 30-30: The line number reference for the definition of MsgFactory property perp has been updated to line 6.

• 40-40: The line number reference for the definition of MsgFactory property spot has been updated to line 5.

• 30-40: The summary states that the definition location of MsgFactory changed from line 7 to line 6, but the hunks show perp at line 6 and spot at line 5. This discrepancy should be clarified.

packages/nibijs/docs/classes/NibiruSigningClient.md (5)

• 1-3: The version reference has been correctly updated to v0.21.42.

• 34-41: The parameter table formatting has been updated for clarity.

• 76-81: The method parameter lists have been reformatted for consistency.

• 49-49: The documentation has been updated with the correct source code links.

• 100-120: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [1-130]

The documentation updates in NibiruSigningClient.md are consistent with the PR objectives and the AI-generated summaries.

packages/nibijs/docs/classes/PerpMsgFactory.md (4)

• 115-158: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [1-184]

The summary indicates that a new method named PerpMsgFactory was added to the PerpMsgFactory class, but the provided hunks do not show this addition. Please verify if this method was indeed added and update the documentation accordingly.

• 122-144: The summary mentions reorganization of the parameter list for the openPosition method. The documentation appears to be in order, but please ensure that this reflects the most recent state of the codebase.

• 115-158: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [1-184]

The summary mentions updated method descriptions. While the provided hunks show the current descriptions, without the previous versions, it's not possible to assess the nature of these updates. Please ensure that the updates are accurate and provide the necessary information.

• 115-158: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [1-184]

The summary mentions updated line numbers for method definitions. The documentation includes the correct links to the source code, which is sufficient for users to find the method implementations.

packages/nibijs/docs/classes/SpotMsgFactory.md (5)

• 1-4: The version number in the documentation link has been updated to v0.21.42, which is consistent with the PR objective to update the main branch to this version.

• 29-36: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [29-42]

The parameter table formatting and the source file URLs have been updated for the createPool method.

• 39-56: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [48-62]

The parameter table formatting and the source file URLs have been updated for the exitPool method.

• 59-76: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [68-82]

The parameter table formatting and the source file URLs have been updated for the joinPool method.

• 79-96: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [88-102]

The parameter table formatting and the source file URLs have been updated for the swapAssets method.

packages/nibijs/docs/classes/StableSwap.md (7)

• 1-4: The version number has been correctly updated to v0.21.42 in the documentation header.

• 46-57: The constructor parameters are well-documented with their types, which aligns with the PR's objective to enhance documentation.

• 64-97: Properties are correctly documented with links to their definitions in the source code.

• 105-111: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [105-120]

The D method is documented with a detailed description of the invariant calculation, which is beneficial for users who need to understand the underlying mathematical model.

• 129-139: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [129-148]

The exchange method is documented with parameters and a description, providing useful context for its functionality.

• 165-168: The xp method is documented with a concise description of its return type, which is an array of total tokens.

• 178-195: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [178-204]

The y method is documented with a technical description of the calculation it performs, which is useful for users who need to understand the mathematical operations involved.

packages/nibijs/docs/enums/Signer.md (2)

• 16-16: The summary indicates that the value for Direct was updated, but the hunk shows that the value remains unchanged as "direct". The only changes are the version number and the line reference in the source file.

• 26-26: Similarly, the summary indicates that the value for Keplr was updated, but the hunk shows that the value remains unchanged as "keplr". The only changes are the version number and the line reference in the source file.

packages/nibijs/docs/interfaces/ABCIEvent.md (1)

• 1-36: The documentation for ABCIEvent correctly reflects the changes in the codebase, with the attributes property linking to EventAttribute. However, ensure that the EventAttribute documentation is also updated to reflect any changes made to the interface, especially since the Event and Attribute interfaces have been removed.

---

Verification result:

The documentation for ABCIEvent has been updated to reflect the latest codebase changes, and the EventAttribute documentation is present and linked correctly. Ensure that the content within EventAttribute.md is consistent with the codebase after the removal of the Event and Attribute interfaces.

packages/nibijs/docs/interfaces/ChainIdParts.md (1)

• 18-41: The summary provided does not accurately reflect the changes in the hunk. The number property is now at line 31, while prefix and shortName are at lines 29 and 30 respectively. The summary incorrectly states that only prefix and shortName had their line numbers decremented by 1.

packages/nibijs/docs/interfaces/EpochsExtension.md (3)

• 15-15: The summary indicates a change in spacing within the currentEpoch function signature, but the provided hunk does not show any such change. This might be an error in the summary or the change is too minor to be substantive.

• 1-1: The version number in the documentation link has been correctly updated to v0.21.42.

• 19-19: The source code link has been correctly updated to the new commit 3e2dcd7.

packages/nibijs/docs/interfaces/EventMap.md (1)

• 1-44: The documentation for the EventMap interface has been updated to reflect the new structure and usage of ABCI events in the SDK. The example provided shows how to extend the EventMap to create a custom event type, which is a useful illustration for developers.

packages/nibijs/docs/interfaces/EventMapAttribute.md (1)

• 5-6: The documentation mentions EventAttribute, which according to the PR summary, has been removed. Please verify if this reference should be updated or removed to reflect the current state of the SDK.

packages/nibijs/docs/interfaces/InflationExtension.md (2)

• 15-15: The summary indicates a change in the InflationExtension interface related to the removal of a semicolon, but the provided hunk does not reflect any such change. The code before and after appears identical, suggesting there might be an error in the summary.

• 1-1: The documentation version number has been updated to v0.21.42, which is consistent with the PR objective to update the main branch to this version.

packages/nibijs/docs/interfaces/MsgAddMarginEncodeObject.md (3)

• 1-4: The version reference in the documentation header has been updated to v0.21.42.

• 30-30: The typeUrl definition URL has been updated to point to the new commit hash 3e2dcd7.

• 44-44: The value definition URL has been updated to point to the new commit hash 3e2dcd7.

packages/nibijs/docs/interfaces/MsgClosePositionEncodeObject.md (2)

• 1-4: The version update in the documentation header is consistent with the PR objectives to bring the main branch up to version v0.21.42.

• 30-30: The file hash update in the GitHub URLs is correct and reflects changes in the source code files.

packages/nibijs/docs/interfaces/MsgJoinPoolEncodeObject.md (3)

• 1-4: The documentation header has been updated to reflect the new version v0.21.42.

• 30-30: The URL reference for the typeUrl property definition has been correctly updated to the new commit hash.

• 44-44: The URL reference for the value property definition has been correctly updated to the new commit hash.

packages/nibijs/docs/interfaces/MsgMultiLiquidateEncodeObject.md (3)

• 1-4: The documentation header has been updated to reflect the new version v0.21.42.

• 30-30: The typeUrl property documentation has been updated with the new commit hash 3e2dcd7.

• 44-44: The value property documentation has been updated with the new commit hash 3e2dcd7.

packages/nibijs/docs/interfaces/MsgPartialCloseEncodeObject.md (3)

• 1-4: The update to the documentation link version from v0.21.41 to v0.21.42 aligns with the PR objective to bring the main branch up to version v0.21.42.

• 30-30: The GitHub URL commit hash has been correctly updated to 3e2dcd7, which should correspond to the latest commit where these documentation changes were made.

• 27-35: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [30-44]

Ensure that the links to the source code in the documentation are correct and point to the exact locations where the MsgPartialCloseEncodeObject is defined.

---

Verification result:

The documentation links for the MsgPartialCloseEncodeObject interface in the msg/perp.ts file correctly point to the source code where the interface is defined:

• The typeUrl property is defined on line 93.
• The value property is defined on line 94.

packages/nibijs/docs/interfaces/MsgRemoveMarginEncodeObject.md (3)

• 1-4: The version number has been correctly updated to reflect the latest SDK version.

• 30-30: The GitHub URLs have been updated with the correct new commit hash.

• 44-44: The GitHub URLs have been updated with the correct new commit hash.

packages/nibijs/docs/interfaces/MsgTypeUrls.md (1)

• 1-4: The version update in the documentation for MsgTypeUrls from v0.21.41 to v0.21.42 aligns with the PR objectives and the AI-generated summaries.

packages/nibijs/docs/interfaces/OracleExtension.md (3)

• 1-4: The version update in the documentation header is correct and aligns with the PR objectives.

• 15-15: The summary mentions a modification to the voteTargets property, but the hunk does not provide details of the change. It would be helpful to know what the specific modification was to assess the impact and correctness of the change.

• 19-19: The updated link to the file where the OracleExtension interface is defined is correct and reflects the new version.

packages/nibijs/docs/interfaces/SpotExtension.md (2)

• 15-15: The summary indicates a change in the spotPrice method's signature, but the provided hunk shows no change. Please verify the accuracy of the summary or update the hunk to reflect the actual changes.

• 1-1: The documentation version number has been updated to v0.21.42, aligning with the PR objectives.

packages/nibijs/docs/intro.md (7)

• 4-37: The addition of badges for NPM version, test workflows, NPM downloads, NPM license, and Discord members is a good enhancement to the documentation, providing quick insights and links for users.

• 51-54: The update to the table of contents with the addition of "Transaction with arbitrary messages" is consistent with the new content being added to the documentation.

• 74-81: The new example for creating a wallet using newRandomWallet is a valuable addition to the documentation, making it easier for users to understand how to get started with the SDK.

• 88-100: The update in the querying example to use Localnet is in line with the changes mentioned in the PR objectives and the summary, which is to remove outdated references and introduce Localnet.

• 112-129: The update in the sending funds example to use newCoins and newSignerFromMnemonic is consistent with the PR's aim to update examples to be current with the latest SDK version.

• 136-191: The addition of a new example for "Transaction with arbitrary messages" is a significant enhancement to the documentation, providing users with guidance on more advanced SDK usage.

• 210-234: The new "Development Quick Start" section is a helpful addition for new contributors or developers getting started with the SDK, aligning with the PR's goal to add more comprehensive documentation.

packages/nibijs/docs/modules.md (49)

• 1-10: The documentation correctly reflects the updated version number and the addition of new enums as per the PR objectives and AI-generated summaries.

• 22-34: The interfaces section has been updated with new and renamed interfaces, which is consistent with the PR objectives and AI-generated summaries.

• 57-66: The variables section correctly shows the updated and new variables, aligning with the PR objectives and AI-generated summaries.

• 70-80: The functions section reflects the updates and new additions as described in the PR objectives and AI-generated summaries.

• 123-129: The INT_MULT variable is correctly defined and linked to its source code, which is a good practice for maintainability.

• 133-144: The Localnet variable is well-documented, providing a clear description of its purpose and usage.

• 148-154: The Msg variable is correctly defined and linked to its source code, which is a good practice for maintainability.

• 158-176: The PERP_MSG_TYPE_URLS variable is correctly defined with a type declaration, which is a good practice for maintainability.

• 180-195: The SPOT_MSG_TYPE_URLS variable is correctly defined with a type declaration, which is a good practice for maintainability.

• 229-243: The Devnet function is well-documented, providing a clear description of its purpose and usage.

• 253-274: The IncentivizedTestnet function is marked as deprecated, which is consistent with the PR objectives and AI-generated summaries.

• 282-302: The Testnet function is well-documented, providing a clear description of its purpose and usage.

• 314-322: The assert function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 340-347: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [335-345]

The chainToParts function is well-documented, providing a clear description of its purpose and usage.

• 359-369: The eventToMap function is well-documented, providing a clear description of its purpose and usage.

• 386-393: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [381-391]

The faucetUrlFromChain function is well-documented, providing a clear description of its purpose and usage.

• 403-415: The findEvent function is well-documented, providing a clear description of its purpose and usage.

• 427-450: The fromSdkDec function is well-documented, providing a clear description of its purpose and usage.

• 467-475: The fromSdkInt function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 494-546: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [487-511]

The getRegistry function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 501-524: The go function is well-documented, providing a clear description of its purpose and usage.

• 536-544: The isMsgAddMarginEncodeObject function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 556-564: The isMsgClosePositionEncodeObject function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 576-584: The isMsgCreatePoolEncodeObject function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 596-604: The isMsgDonateToEcosystemFundEncodeObject function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 616-624: The isMsgExitPoolEncodeObject function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 636-644: The isMsgJoinPoolEncodeObject function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 656-664: The isMsgMultiLiquidateEncodeObject function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 676-684: The isMsgOpenPositionEncodeObject function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 696-704: The isMsgPartialCloseEncodeObject function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 716-724: The isMsgRemoveMarginEncodeObject function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 736-744: The isMsgSwapAssetsEncodeObject function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 756-767: The isRestEndptLive function is well-documented, providing a clear description of its purpose and usage.

• 779-787: The newCoinMapFromCoins function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 804-813: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [799-810]

The newRandomWallet function is well-documented, providing a clear description of its purpose and usage.

• 831-840: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [826-837]

The newSignerFromMnemonic function is well-documented, providing a clear description of its purpose and usage.

• 853-864: The parseEventLogs function is well-documented, providing a clear description of its purpose and usage.

• 883-891: The queryChainIdWithRest function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 903-911: The setupEpochsExtension function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 923-931: The setupInflationExtension function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 943-951: The setupOracleExtension function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 963-971: The setupPerpExtension function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 983-991: The setupSpotExtension function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 1003-1011: The setupSudoExtension function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 1023-1048: The toSdkDec function is well-documented, providing a clear description of its purpose and usage.

• 1070-1078: The toSdkInt function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 1090-1098: The transformPool function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 1110-1118: The transformPoolParams function is correctly defined and linked to its source code, which is a good practice for maintainability.

• 1135-1155: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [1130-1140]

The useFaucet function is well-documented, providing a clear description of its purpose and usage.

packages/nibijs/src/chain/chain.ts (6)

• 4-15: The summary indicates that comments and variable names related to the Chain interface have been updated from "node" to "Nibiru," but this change is not reflected in the provided hunk. Please verify if this renaming has been applied elsewhere in the code.

• 78-87: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [81-92]

The addition of the Localnet configuration for a local Nibiru network is consistent with the PR objectives and the summary provided.

• 94-111: The introduction of the Testnet configuration function and the deprecation notice for IncentivizedTestnet align with the PR objectives and the summary provided.

• 120-126: The Devnet configuration function has been added as described in the summary.

• 145-150: The refactoring of the isRestEndptLive function, including the addition of a descriptive comment and a return type declaration, is consistent with the summary.

• 131-137: The queryChainIdWithRest function has been updated with a new implementation. This change was not mentioned in the summary.

packages/nibijs/src/chain/parse.ts (2)

• 4-34: The added comments and return type annotation in toSdkDec function enhance code clarity and maintainability.

• 113-116: The return type annotation in fromSdkDec function is consistent with the PR objectives and summary, but the extensive comments mentioned in the summary are not visible in the provided hunk. If the comments are located outside the hunk, this is acceptable; otherwise, it might be an oversight.

packages/nibijs/src/test/chain.test.ts (1)

• 43-45: The replacement of IncentivizedTestnet with Testnet aligns with the PR objectives to update the SDK with current information and remove outdated references.

packages/nibijs/src/test/faucet.test.ts (4)

• 15-15: The import path change from "./helpers" to "../testutil" is consistent with the PR objectives and summary provided.

• 31-50: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [31-63]

The test "faucet utility works" is well-structured and follows good practices by mocking external calls and checking the state before and after the operation. Ensure manual testing is conducted for skipped tests.

• 54-63: The timeout for the test "faucet utility works" is set to 60 seconds, which is a reasonable limit for such operations, and the comment adds clarity.

• 126-132: The faucetUrlFromChain helper function test ensures the correct URL is constructed from the chain object, which is a good unit test practice.

packages/nibijs/src/testutil.ts (5)

• 5-16: The changes to TEST_CHAIN, TEST_MNEMONIC, and TEST_ADDRESS align with the PR objectives to update examples and documentation to be current with the latest SDK version. The use of environment variables for TEST_MNEMONIC and TEST_ADDRESS provides flexibility for different testing environments.

• 24-33: The update to validateBlockFromJsonRpc function with a more comprehensive blockSchema is consistent with the PR's goal of enhancing the SDK's testability.

• 47-52: The validateBlock function has been correctly updated to take a Block and Chain as parameters, reflecting the updated Chain interface and improving the function's clarity and type safety.

• 55-58: The assertHasMsgType function has been correctly updated to work with the ABCIEvent type, which is part of the SDK's refactoring to handle ABCI events.

• 66-71: The assertHasEventType function has been correctly updated to work with the ABCIEvent type, aligning with the SDK's refactoring to handle ABCI events.

packages/nibijs/src/tx/event.ts (3)

• 3-7: The summary indicates that the Event and Attribute interfaces have been removed, but EventAttribute is still present in the code. Please verify if this is intentional or an oversight.

• 9-42: The introduction of EventMapAttribute, ABCIEvent, and EventMap interfaces aligns with the summary's mention of new interfaces to handle ABCI events.

• 43-68: The eventToMap, findEvent, and parseEventLogs functions are implemented as described in the summary and appear to be logically correct.

packages/nibijs/src/tx/signer.ts (4)

• 29-33: The addition of the return type Promise<DirectSecp256k1HdWallet> to newSignerFromMnemonic correctly reflects the asynchronous nature of the function.

• 45-49: The addition of the return type Promise<DirectSecp256k1HdWallet> to newRandomWallet correctly reflects the asynchronous nature of the function.

• 35-35: The standalone export of DirectSecp256k1HdWallet improves modularity and aligns with the changes described in the summary.

• 35-35: Consider the previous comment about not exporting third-party packages. If this export is intentional for SDK design, ensure it's clearly documented for users.

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between cd287eb and 8fe02e0.

Files selected for processing (3)

• README.md (6 hunks)
• packages/examples/examples.test.ts (1 hunks)
• packages/nibijs/src/chain/types.ts (3 hunks)

Additional comments: 21

README.md (7)

• 2-35: The addition of badges and comments enhances the visibility and provides quick access to relevant links for the Nibiru blockchain SDK.

• 49-52: The update to the table of contents and additional sections improve the structure and readability of the README.

• 74-79: The updated example for creating a wallet correctly reflects the latest API changes and usage.

• 86-98: The updated example for querying correctly reflects the latest API changes and usage.

• 110-131: The updated example for sending funds correctly reflects the latest API changes and usage.

• 134-189: The updated example for transactions with arbitrary messages correctly reflects the latest API changes and usage.

• 208-232: The addition of the "Development Quick Start" section provides useful information for developers and aligns with the PR objectives to enhance documentation.

packages/examples/examples.test.ts (12)

• 1-13: The imports from @nibiruchain/nibijs and related packages have been updated to reflect the latest API changes, which aligns with the PR objectives and summary points.

• 24-24: The CHAIN constant is correctly set to Localnet, which is consistent with the summary stating that IncentivizedTestnet has been deprecated in favor of Localnet.

• 30-36: The getSigner function is using a singleton pattern to ensure consistency when interacting with the live network, which is a good practice for maintainability and performance.

• 38-46: The getSigningClient function follows the same singleton pattern as getSigner, which is beneficial for the same reasons.

• 58-68: The hereDoc function is a utility to format multiline strings, which could be useful for logging and documentation purposes within the examples.

• 74-76: The logSuccess function provides a standardized way to log success messages, which can help with readability and consistency in the examples.

• 79-81: The sleep function is a simple utility for adding delays, which might be necessary for certain operations to complete in the examples, such as waiting for transactions to be processed.

• 87-96: The exampleNewWallet function demonstrates creating a new wallet, which is a practical example that aligns with the PR's goal of updating and testing examples.

• 98-114: The exampleQueries function showcases how to use the NibiruQueryClient to perform various queries, which is a valuable example for users to understand how to interact with the Nibiru network.

• 117-172: The exampleTxMsgs function demonstrates constructing and broadcasting transaction messages, which is a core functionality and a good inclusion in the examples.

• 174-206: The exampleSendFunds function provides an example of sending funds, which is a common operation and a useful example for users.

• 212-237: The main execution block checks if the file is being run directly and then executes all examples, logging success or catching errors. This is a good practice for testing the examples as part of the CI process.

packages/nibijs/src/chain/types.ts (2)

• 14-27: The changes to the go function and the introduction of GoSuccess and GoError types align with the PR objectives to update exported entities and improve error handling.

• 52-54: The update to the TxLog interface to use ABCIEvent instead of Event is correct and aligns with the PR objectives to reflect the latest API changes.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 8fe02e0 and 35531c1.

Files ignored due to filter (1)

• packages/nibijs/package.json

Files selected for processing (35)

• packages/nibijs/docs/classes/CustomChain.md (10 hunks)
• packages/nibijs/docs/classes/MsgFactory.md (2 hunks)
• packages/nibijs/docs/classes/NibiruQueryClient.md (7 hunks)
• packages/nibijs/docs/classes/NibiruSigningClient.md (7 hunks)
• packages/nibijs/docs/classes/PerpMsgFactory.md (8 hunks)
• packages/nibijs/docs/classes/SpotMsgFactory.md (6 hunks)
• packages/nibijs/docs/classes/StableSwap.md (10 hunks)
• packages/nibijs/docs/enums/BECH32_PREFIX.md (1 hunks)
• packages/nibijs/docs/enums/Signer.md (2 hunks)
• packages/nibijs/docs/interfaces/ABCIEvent.md (1 hunks)
• packages/nibijs/docs/interfaces/Chain.md (7 hunks)
• packages/nibijs/docs/interfaces/ChainIdParts.md (2 hunks)
• packages/nibijs/docs/interfaces/EpochsExtension.md (2 hunks)
• packages/nibijs/docs/interfaces/EventAttribute.md (1 hunks)
• packages/nibijs/docs/interfaces/EventMap.md (1 hunks)
• packages/nibijs/docs/interfaces/InflationExtension.md (2 hunks)
• packages/nibijs/docs/interfaces/MsgAddMarginEncodeObject.md (3 hunks)
• packages/nibijs/docs/interfaces/MsgClosePositionEncodeObject.md (3 hunks)
• packages/nibijs/docs/interfaces/MsgCreatePoolEncodeObject.md (3 hunks)
• packages/nibijs/docs/interfaces/MsgDonateToEcosystemFundEncodeObject.md (3 hunks)
• packages/nibijs/docs/interfaces/MsgExitPoolEncodeObject.md (3 hunks)
• packages/nibijs/docs/interfaces/MsgJoinPoolEncodeObject.md (3 hunks)
• packages/nibijs/docs/interfaces/MsgMultiLiquidateEncodeObject.md (3 hunks)
• packages/nibijs/docs/interfaces/MsgOpenPositionEncodeObject.md (3 hunks)
• packages/nibijs/docs/interfaces/MsgPartialCloseEncodeObject.md (3 hunks)
• packages/nibijs/docs/interfaces/MsgRemoveMarginEncodeObject.md (3 hunks)
• packages/nibijs/docs/interfaces/MsgSwapAssetsEncodeObject.md (3 hunks)
• packages/nibijs/docs/interfaces/OracleExtension.md (2 hunks)
• packages/nibijs/docs/interfaces/PageRequest.md (6 hunks)
• packages/nibijs/docs/interfaces/PerpExtension.md (2 hunks)
• packages/nibijs/docs/interfaces/SpotExtension.md (2 hunks)
• packages/nibijs/docs/interfaces/SudoExtension.md (2 hunks)
• packages/nibijs/docs/interfaces/TxLog.md (2 hunks)
• packages/nibijs/docs/intro.md (6 hunks)
• packages/nibijs/docs/modules.md (40 hunks)

Files skipped from review due to trivial changes (9)

• packages/nibijs/docs/classes/CustomChain.md
• packages/nibijs/docs/classes/NibiruQueryClient.md
• packages/nibijs/docs/classes/NibiruSigningClient.md
• packages/nibijs/docs/classes/SpotMsgFactory.md
• packages/nibijs/docs/interfaces/EventAttribute.md
• packages/nibijs/docs/interfaces/MsgExitPoolEncodeObject.md
• packages/nibijs/docs/interfaces/MsgJoinPoolEncodeObject.md
• packages/nibijs/docs/interfaces/MsgRemoveMarginEncodeObject.md
• packages/nibijs/docs/interfaces/MsgSwapAssetsEncodeObject.md

Additional comments: 99

packages/nibijs/docs/classes/MsgFactory.md (3)

• 1-4: The version update for the MsgFactory class documentation to v0.21.42 is correct and aligns with the PR objectives.

• 30-30: The update of the line number reference for the MsgFactory definition in msg/index.ts from line 7 to line 6 is correct.

• 40-40: The line number for the spot property definition has been updated to 5, which is not mentioned in the summary. This should be noted as it indicates a change in the codebase that may affect users who reference the documentation.

packages/nibijs/docs/classes/PerpMsgFactory.md (7)

• 122-144: The documentation for the openPosition method has been updated correctly to reflect the new parameters and their types. The source link also points to the correct line number in the source file.

• 58-58: The line number for the addMargin method definition in the source file has been updated correctly.

• 78-78: The line number for the closePosition method definition in the source file has been updated correctly.

• 98-98: The line number for the donateToPerpEF method definition in the source file has been updated correctly.

• 118-118: The line number for the liquidate method definition in the source file has been updated correctly.

• 164-164: The line number for the partialClosePosition method definition in the source file has been updated correctly.

• 184-184: The line number for the removeMargin method definition in the source file has been updated correctly.

packages/nibijs/docs/classes/StableSwap.md (7)

• 1-4: The version update in the documentation header is correct and aligns with the PR objectives.

• 46-57: The constructor parameters have been reformatted for clarity, with no changes to the types or names, which is consistent with the summary.

• 65-97: The defined locations for the properties Amplification, fee, totalTokenSupply, and totalTokensInPool have been updated to reflect the new commit hashes, which is consistent with the summary.

• 105-111: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [105-120]

The documentation for the D method has been updated to reflect the new location in the source code, and the description is present.

• 129-139: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [129-148]

The documentation for the exchange method has been updated to reflect the new location in the source code, and the description is present.

• 165-168: The documentation for the xp method has been updated to reflect the new location in the source code.

• 178-195: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [178-204]

The documentation for the y method has been updated to reflect the new location in the source code, and the description is present.

packages/nibijs/docs/enums/BECH32_PREFIX.md (12)

• 20-20: The change from double quotes to backticks for the ADDR enumeration value is correct and follows the summary provided.

• 26-26: The updated link to the source code definition for ADDR reflects the new commit hash, ensuring the documentation remains accurate.

• 32-32: The change from double quotes to backticks for the ADDR_VAL enumeration value is consistent with the summary and the changes made to other enumeration values.

• 38-38: The updated link to the source code definition for ADDR_VAL is correct.

• 44-44: The change from double quotes to backticks for the ADDR_VALCONS enumeration value is consistent with the summary and the changes made to other enumeration values.

• 50-50: The updated link to the source code definition for ADDR_VALCONS is correct.

• 56-56: The change from double quotes to backticks for the PUB enumeration value is consistent with the summary and the changes made to other enumeration values.

• 62-62: The updated link to the source code definition for PUB is correct.

• 68-68: The change from double quotes to backticks for the PUB_VAL enumeration value is consistent with the summary and the changes made to other enumeration values.

• 74-74: The updated link to the source code definition for PUB_VAL is correct.

• 80-80: The change from double quotes to backticks for the PUB_VALCONS enumeration value is consistent with the summary and the changes made to other enumeration values.

• 86-86: The updated link to the source code definition for PUB_VALCONS is correct.

packages/nibijs/docs/enums/Signer.md (4)

• 16-16: The change from double quotes to backticks for the Direct enumeration value is consistent with the summary.

• 26-26: The change from double quotes to backticks for the Keplr enumeration value is consistent with the summary.

• 20-20: The line number for the Direct enumeration value has been updated to 53, which is consistent with the summary.

• 30-30: The line number for the Keplr enumeration value has been updated to 52, which is consistent with the summary.

packages/nibijs/docs/interfaces/ABCIEvent.md (1)

• 1-36: The documentation for the ABCIEvent interface has been updated correctly to reflect the new version number and the updated file paths for the attributes and type properties.

packages/nibijs/docs/interfaces/Chain.md (6)

• 41-41: The line number provided for the definition of chainId in the source code seems to have been updated. Please verify that the line number 21 accurately reflects the location of chainId in the chain.ts file.

---

The line number for the chainId property in the chain.ts file is correctly documented as line 21.

• 53-53: The line number provided for the definition of chainName in the source code seems to have been updated. Please verify that the line number 23 accurately reflects the location of chainName in the chain.ts file.

---

The line number 23 correctly reflects the location of the chainName property in the chain.ts file.

• 65-65: The line number provided for the definition of endptGrpc in the source code seems to have been updated. Please verify that the line number 19 accurately reflects the location of endptGrpc in the chain.ts file.

---

The line number 19 correctly reflects the location of the endptGrpc property definition in the chain.ts file.

• 77-77: The line number provided for the definition of endptRest in the source code seems to have been updated. Please verify that the line number 17 accurately reflects the location of endptRest in the chain.ts file.

---

The line number 17 in the chain.ts file accurately reflects the location of the endptRest property definition within the Chain interface.

• 89-89: The line number provided for the definition of endptTm in the source code seems to have been updated. Please verify that the line number 15 accurately reflects the location of endptTm in the chain.ts file.

---

The line number 15 accurately reflects the location of the endptTm property definition in the chain.ts file.

• 101-101: The line number provided for the definition of feeDenom in the source code seems to have been updated. Please verify that the line number 25 accurately reflects the location of feeDenom in the chain.ts file.

---

The line number 25 accurately reflects the location of the feeDenom property in the chain.ts file.

packages/nibijs/docs/interfaces/ChainIdParts.md (1)

• 18-41: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [1-41]

The summary indicates that the line numbers for the prefix and shortName properties in the ChainIdParts interface have been decremented, but the hunk shows no change in line numbers for these properties. This discrepancy should be addressed.

packages/nibijs/docs/interfaces/EpochsExtension.md (3)

• 1-3: The documentation header correctly reflects the updated version number v0.21.42.

• 15-15: The interface definition for epochs matches the description provided in the summary, including the currentEpoch and epochsInfo functions.

• 19-19: The source file link has been correctly updated to the new commit hash "8fe02e0".

packages/nibijs/docs/interfaces/EventMap.md (1)

• 1-44: The documentation for the EventMap interface is well-structured, providing a clear hierarchy, an example of how to extend the interface, and a link to the source code definition. This aligns with the PR objectives of enhancing documentation and ensuring maintainability.

packages/nibijs/docs/interfaces/InflationExtension.md (3)

• 1-4: The documentation header has been updated to reflect the new version number v0.21.42.

• 15-19: The link to the source file for the inflation property has been updated to point to the new commit hash. Ensure that this link correctly points to the updated source code.

• 15-15: The summary incorrectly suggests a change in the method signature or implementation, but the actual content of the inflation property remains unchanged.

packages/nibijs/docs/interfaces/MsgAddMarginEncodeObject.md (3)

• 1-4: The version number has been correctly updated to v0.21.42 in the documentation header.

• 30-30: The URL reference in the Defined in section has been correctly updated to the new commit hash 8fe02e0.

• 44-44: The URL reference in the Defined in section for the value property has been correctly updated to the new commit hash 8fe02e0.

packages/nibijs/docs/interfaces/MsgClosePositionEncodeObject.md (2)

• 27-30: The documentation for the typeUrl property has been correctly updated to reflect the new line reference in the source code.

• 41-44: The documentation for the value property has been correctly updated to reflect the new line reference in the source code.

packages/nibijs/docs/interfaces/MsgCreatePoolEncodeObject.md (3)

• 1-4: The version reference in the documentation header has been correctly updated to v0.21.42.

• 30-30: The GitHub URL has been correctly updated to the new commit hash 8fe02e0.

• 44-44: The GitHub URL for the value property has also been correctly updated to the new commit hash 8fe02e0.

packages/nibijs/docs/interfaces/MsgDonateToEcosystemFundEncodeObject.md (4)

• 1-4: The documentation header correctly reflects the updated version number v0.21.42.

• 27-30: The "Defined in" section for the typeUrl property correctly links to the source code.

• 41-44: The "Defined in" section for the value property correctly links to the source code.

• 27-35: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [1-44]

The provided hunks do not show any changes in commit hashes for the MsgDonateToEcosystemFundEncodeObject interface as mentioned in the summary. It's possible that the summary refers to changes not visible in the provided hunks.

packages/nibijs/docs/interfaces/MsgMultiLiquidateEncodeObject.md (3)

• 1-4: The update to the documentation header to reflect the new version v0.21.42 is correct and aligns with the PR objectives.

• 30-30: The updated URL with the new commit hash 8fe02e0 in the documentation is correct and points to the appropriate line in the source code.

• 44-44: The updated URL for the value property with the new commit hash 8fe02e0 in the documentation is correct and points to the appropriate line in the source code.

packages/nibijs/docs/interfaces/MsgOpenPositionEncodeObject.md (2)

• 1-4: The version reference in the documentation header has been updated to v0.21.42.

• 30-30: The commit hash in the link to the source code has been updated to 8fe02e0.

packages/nibijs/docs/interfaces/MsgPartialCloseEncodeObject.md (3)

• 1-4: The documentation header has been updated to reflect the new version v0.21.42.

• 27-30: The commit hash in the URL for the typeUrl property definition has been updated to 8fe02e0.

• 41-44: The commit hash in the URL for the value property definition has been updated to 8fe02e0.

packages/nibijs/docs/interfaces/OracleExtension.md (2)

• 15-15: The summary indicates that a semicolon was removed from the OracleExtension interface, but the hunk shows no such change. This might be an inconsistency or an outdated summary.

• 12-19: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [1-19]

The documentation for the OracleExtension interface is updated correctly, with a clear list of properties and a link to the source code where it is defined.

packages/nibijs/docs/interfaces/PageRequest.md (11)

• 1-4: The documentation header has been updated to reflect the new version number v0.21.42.

• 27-33: The comment for countTotal has been clarified to specify when count_total is respected and when it is ignored.

• 37-37: The URL reference for countTotal has been updated to point to a specific commit.

• 41-41: The key property description remains unchanged.

• 51-51: The URL reference for key has been updated to point to a specific commit.

• 55-55: The limit property description remains unchanged.

• 64-64: The URL reference for limit has been updated to point to a specific commit.

• 68-68: The offset property description remains unchanged.

• 78-78: The URL reference for offset has been updated to point to a specific commit.

• 82-82: The reverse property description remains unchanged.

• 92-92: The URL reference for reverse has been updated to point to a specific commit.

packages/nibijs/docs/interfaces/PerpExtension.md (1)

• 15-19: The summary indicates changes to the position and positions functions, but the hunk shows no changes to their signatures. The line numbers and version references have been correctly updated to reflect the new version.

packages/nibijs/docs/interfaces/SpotExtension.md (2)

• 15-15: The method signature for estimateSwapExactAmountOut correctly includes the new optional parameter tokenOut? of type Coin, as per the PR objectives and the summary provided.

• 19-19: The documentation correctly references the updated source file link for the SpotExtension interface definition at query/spot.ts:58 in commit 8fe02e0.

packages/nibijs/docs/interfaces/SudoExtension.md (3)

• 1-3: The documentation version has been correctly updated to v0.21.42.

• 15-15: The sudo property within the SudoExtension interface remains unchanged, contrary to the summary which suggests a modification related to Promise handling.

• 19-19: The file path and line number for the SudoExtension definition have been correctly updated to reflect the latest commit hash and line reference.

packages/nibijs/docs/interfaces/TxLog.md (2)

• 1-3: The version update in the documentation header is correct and aligns with the PR objective to update examples to be current with the latest version of the Nibiru network.

• 13-19: The update to the TxLog interface's events property type in the documentation is correct and reflects the changes made in the source code as per the PR objectives.

packages/nibijs/docs/intro.md (5)

• 4-37: The addition of badges and the updated documentation link align with the PR objectives and the summary provided.

• 205-234: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [206-236]

The summary mentioned the removal of the "🔓 License" section, but it is still present in the file.

• 210-234: The "Development Quick Start" section has been added as described in the summary.

• 109-193: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [74-192]

The examples have been refactored, removing certain imports and changing constants, which aligns with the PR objectives and the summary provided.

• 109-193: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [74-192]

The examples in the documentation do not contain hardcoded sensitive information, which aligns with the user's previous security considerations.

packages/nibijs/docs/modules.md (5)

• 22-34: The summary indicates that the Attribute interface was renamed to ABCIEvent, but the hunk does not show any such change. Please verify if this change is reflected elsewhere in the codebase or if the summary is incorrect.

• 57-66: The summary suggests that variables like INT_MULT, BECH32_PREFIX, PERP_MSG_TYPE_URLS, and SPOT_MSG_TYPE_URLS were renamed, but the hunk shows no such changes. Please verify if these renamings occurred elsewhere in the codebase or if the summary is incorrect.

• 69-80: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [69-100]

The summary states that new functions like Testnet, eventToMap, findEvent, and parseEventLogs were added, but the hunk shows these functions already exist. Please verify if these functions were indeed newly added or if the summary is incorrect.

• 1135-1155: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [1130-1155]

The summary does not mention the addition of the useFaucet function, but it appears in the hunk. Please verify if this function is indeed a new addition and update the summary accordingly.

• 116-243: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [229-255]

The summary indicates updates to the Devnet and IncentivizedTestnet functions, but the hunk does not show any changes to these functions. Please verify if these updates occurred elsewhere in the codebase or if the summary is incorrect.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 35531c1 and 62ff960.

Files selected for processing (3)

• .github/workflows/test-ts-sdk.yaml (3 hunks)
• jest.config.js (1 hunks)
• packages/nibijs/src/tx/signingClient.ts (4 hunks)

Files skipped from review due to trivial changes (1)

• packages/nibijs/src/tx/signingClient.ts

Additional comments: 4

.github/workflows/test-ts-sdk.yaml (3)

• 30-38: The addition of the step to install nibid and start a local network is consistent with the PR objectives to enhance the CI process by running examples against a local Nibiru network.

• 58-62: The new step to run examples using tsx is a good addition, ensuring that examples are tested as part of the CI process.

• 73-73: Enclosing the task name "SonarQube Quality Gate" in quotes improves consistency in the naming convention of the workflow steps.

jest.config.js (1)

• 97-97: The update to modulePathIgnorePatterns aligns with the PR objectives to ensure examples are tested in the CI process and to maintain the examples more easily with symlinks. This change will prevent Jest from considering files in "packages/examples" during test runs.

[Unique-Divine]

@cgilbe27: I addressed all the PR comments and synced up with changes from develop

[coderabbitai]

Review Status

Actionable comments generated: 3

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 6b114a1 and bef5958.

Files selected for processing (1)

• packages/examples/examples.test.ts (1 hunks)

Additional comments: 4

packages/examples/examples.test.ts (4)

• 17-17: The use of TEST_ADDRESS and TEST_MNEMONIC should be verified to ensure they are not sensitive values and are intended for testing purposes only. If they are placeholders for actual sensitive data, consider using environment variables or a secure vault service.

• 182-182: The use of process.argv[2] to allow for command-line input is a good practice for flexibility in examples. Ensure that this is clearly documented for users who may run the examples.

• 211-215: The use of esMain to determine if the file is being run as a script is a good practice for example files.

• 91-91: Logging the mnemonic can be a security risk. Ensure that users are warned about the dangers of logging sensitive information and that this is intended for example purposes only.

[coderabbitai]

The use of sleep to avoid account sequence issues is a workaround. Consider implementing a more robust solution, such as a retry mechanism or checking the account sequence before attempting a transaction.

[coderabbitai]

The signAndBroadcast function is asynchronous and should be awaited to ensure the transaction response is received before proceeding.

- const txResp = await signingClient.signAndBroadcast(fromAddr, msgs, txFee)
+ const txResp = await signingClient.signAndBroadcast(fromAddr, msgs, txFee)

---

Committable suggestion

❗ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	const txResp = await signingClient.signAndBroadcast(fromAddr, msgs, txFee)
	`` const txResp = await signingClient.signAndBroadcast(fromAddr, msgs, txFee)

</details>
<!-- suggestion_end -->

<!-- This is an auto-generated comment by CodeRabbit -->

[coderabbitai]

The error handling in the main function only checks for "account sequence mismatch". Consider improving error handling to cover other potential errors or at least log them for the user's awareness.