fix: readme code examples adjusted

[onikonychev]

Summary by CodeRabbit

• Documentation
  • Updated examples for querying and sending funds, and transactions with arbitrary messages in the blockchain interaction library documentation.

[coderabbitai]

Important

Auto Review Skipped

Review was skipped due to path filters

Walkthrough

The update to the Nibiru blockchain library constitutes a comprehensive overhaul of its interaction mechanisms. It includes modifications to the way the library handles both queries and transactions, with updated configurations and a new approach to constructing and dispatching messages. This reflects a pivot in the library's functionality, enhancing its capability to interact with the blockchain.

Changes

File(s)	Change Summary
README.md	Introduces significant changes to the logic and control flow of the Nibiru blockchain interaction library.
src/query/..., src/send/..., src/transaction/...	Modifies examples for querying, sending funds, and transaction message construction and broadcasting.
.github/workflows/test-ts-sdk.yaml	Removes a block that ran examples and a comment about a TS script executor, and adds a step for Jest coverage comment.
src/config/...	Updates the chain configuration details.
src/utils/..., src/helpers/...	Adjusts utility and helper functions for new logic.

Poem

🐇✨
In the burrow of code, a rabbit did leap,
To the blockchain's tune, a new dance did seep.
With a hop and a skip, the bytes align,
Nibiru's new rhythm, crafted so fine. 🎶🌌

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>.
  • Generate unit-tests for this file.
• 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 tests 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 generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between c0dea51 and 3284d7d.

Files ignored due to filter (3)

• examples/package.json
• examples/tsconfig.json
• examples/yarn.lock

Files selected for processing (1)

• README.md (3 hunks)

Additional comments: 3

README.md (3)

• 89-110: The update from Localnet to Testnet(2) in the querying example is consistent with the PR objectives. The additional queries for block, PERP markets, and SPOT pools are added, which aligns with the aim to enhance querying capabilities. Ensure that the Testnet class and its methods like endptTm are correctly implemented and that the new queries are valid and return the expected results.

• 119-151: The sending funds example has been updated to include Testnet imports, initialization of mnemonic, and querying balances before and after sending tokens. The addition of a delay function suggests an asynchronous operation, possibly to wait for transaction confirmation. Verify that the Testnet class, newSignerFromMnemonic function, and sendTokens method are correctly implemented and that the delay function is appropriate for the expected transaction confirmation time.

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

The transaction with arbitrary messages example has been updated to include Testnet imports and changes in the CHAIN declaration. Unused code related to mnemonic and signer initialization has been removed, and new transaction message construction and querying open PERP positions after broadcasting the transaction have been added. Verify that the Testnet class, newSignerFromMnemonic function, and the new transaction message construction are correctly implemented and that the querying of open PERP positions is valid.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 3284d7d and 9715f6a.

Files selected for processing (1)

• .github/workflows/test-ts-sdk.yaml (1 hunks)

Files skipped from review due to trivial changes (1)

• .github/workflows/test-ts-sdk.yaml

[github-actions]

Lines	Statements	Branches	Functions
	95.47% (1371/1436)	97.8% (578/591)	88.21% (322/365)

[cgilbe27]

Not sure if we should be deleting examples folder