fix(fix): unhide spot/perp protojs

[cgilbe27]

Reverts https://github.com/NibiruChain/ts-sdk/pull/247/files

Summary by CodeRabbit

• New Features

  • Search functionality now available with a new search bar.
  • Users can now fetch and display search results within the app.

• Enhancements

  • Improved mathematical expression accuracy in documentation.
  • Streamlined message creation with updated MsgFactory class structure.
  • Enhanced querying capabilities for market data.

• Refactor

  • Optimized import statements for better code organization.
  • Renamed request and response types for clarity in epochs querying.
  • Reorganized extension types for improved code readability.

• Bug Fixes

  • Fixed incorrect multiplication and exponentiation operators in documentation.

• Style

  • Updated styles for a more intuitive search bar appearance.

• Documentation

  • Corrected and clarified mathematical expressions in StableSwap documentation.

• Tests

  • Added new test cases for the perpetual protocol message factory.
  • Expanded test coverage for querying functionality.

Please note that these changes are part of an ongoing effort to enhance user experience and improve the functionality of our platform.

[coderabbitai]

Warning

Rate Limit Exceeded

@cgilbe27 has exceeded the limit for the number of files or commits that can be reviewed per hour. Please wait 10 minutes and 25 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 69ccefa and eb961c0.

Walkthrough

The updates across various TypeScript files reflect a series of corrections, enhancements, and reorganizations within a codebase related to a financial or trading platform. Mathematical expressions have been fixed, import/export structures have been optimized, and naming conventions have been standardized. New interfaces and functions have been added to handle events, state, and queries, while obsolete code has been removed, indicating a significant refactoring effort to improve the system's functionality and maintainability.

Changes

File Path	Change Summary
StableSwap.md msg/index.ts msg/perp.ts msg/spot.ts	Corrected mathematical expressions and operators. Un-commented imports, updated class properties, and export statements. Renamed request/response types, updated function signatures, and modified import/export statements. Added new interfaces, enums, and functions for events, state, genesis, params, and queries. Removed obsolete code.
query/epochs.ts query/index.ts query/perp.ts query/query.ts query/spot.ts	Renamed request/response types, updated function signatures, and modified import/export statements. Added new interfaces, enums, and functions for queries.
test/query.test.ts test/query.tests/epochs.test.ts test/query.tests/perp.test.ts test/query.tests/spot.test.ts	Added new test suites and mock behaviors for query functions.
tx/signingClient.test.ts tx/signingClient.ts	Added new imports, updated test cases, and modified method signatures.
protojs/src/nibiru/...	Introduced new interfaces, enums, and functions for encoding/decoding.

"In the code where bugs did creep,
A rabbit hopped in, no time to sleep.
With a flip and a skip, refactor complete,
Now the code hops along, oh so neat! 🐇💻✨"

---

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

[coderabbitai]

Review Status

Actionable comments generated: 24

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 19eb616 and 1c9cf0d.

Files selected for processing (32)

• packages/nibijs/docs/classes/StableSwap.md (1 hunks)
• packages/nibijs/src/msg/index.ts (1 hunks)
• packages/nibijs/src/msg/perp.ts (1 hunks)
• packages/nibijs/src/msg/spot.ts (1 hunks)
• packages/nibijs/src/query/epochs.ts (2 hunks)
• packages/nibijs/src/query/index.ts (1 hunks)
• packages/nibijs/src/query/perp.ts (1 hunks)
• packages/nibijs/src/query/query.ts (2 hunks)
• packages/nibijs/src/query/spot.ts (1 hunks)
• packages/nibijs/src/test/query.test.ts (1 hunks)
• packages/nibijs/src/test/query.tests/epochs.test.ts (1 hunks)
• packages/nibijs/src/test/query.tests/perp.test.ts (1 hunks)
• packages/nibijs/src/test/query.tests/spot.test.ts (1 hunks)
• packages/nibijs/src/tx/signingClient.test.ts (2 hunks)
• packages/nibijs/src/tx/signingClient.ts (2 hunks)
• packages/protojs/src/nibiru/epochs/v1/query.ts (9 hunks)
• packages/protojs/src/nibiru/oracle/v1/tx.ts (6 hunks)
• packages/protojs/src/nibiru/perp/v2/event.ts (1 hunks)
• packages/protojs/src/nibiru/perp/v2/genesis.ts (1 hunks)
• packages/protojs/src/nibiru/perp/v2/query.ts (1 hunks)
• packages/protojs/src/nibiru/perp/v2/state.ts (1 hunks)
• packages/protojs/src/nibiru/perp/v2/tx.ts (1 hunks)
• packages/protojs/src/nibiru/spot/v1/event.ts (1 hunks)
• packages/protojs/src/nibiru/spot/v1/genesis.ts (1 hunks)
• packages/protojs/src/nibiru/spot/v1/params.ts (1 hunks)
• packages/protojs/src/nibiru/spot/v1/pool.ts (1 hunks)
• packages/protojs/src/nibiru/spot/v1/query.ts (1 hunks)
• packages/protojs/src/nibiru/spot/v1/tx.ts (1 hunks)
• packages/protojs/src/nibiru/stablecoin/v1/events.ts (1 hunks)
• packages/protojs/src/nibiru/stablecoin/v1/genesis.ts (1 hunks)
• packages/protojs/src/nibiru/stablecoin/v1/params.ts (1 hunks)
• packages/protojs/src/nibiru/stablecoin/v1/query.ts (1 hunks)

Files not summarized due to errors (2)

• packages/protojs/src/nibiru/perp/v2/tx.ts: Error: Message exceeds token limit
• packages/protojs/src/nibiru/spot/v1/query.ts: Error: Message exceeds token limit

Files skipped from review due to trivial changes (6)

• packages/nibijs/src/msg/index.ts
• packages/nibijs/src/msg/spot.ts
• packages/nibijs/src/query/index.ts
• packages/nibijs/src/query/query.ts
• packages/nibijs/src/query/spot.ts
• packages/nibijs/src/test/query.test.ts

Additional comments: 66

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

• 1-24: The import statements and PERP_MSG_TYPE_URLS have been updated to include new message types and utilities. Ensure that these changes are consistent with the intended use cases and that all necessary message types are included.

• 26-33: The perpTypes array has been updated to match the new message types. Verify that all message types are correctly paired with their URLs and that no types are missing or incorrectly included.

• 36-173: The interfaces and functions for encode objects have been updated to include new message types. Ensure that these changes are consistent with the protocol's requirements and that the typeUrl and value properties are correctly assigned for each message type.

• 103-174: The PerpMsgFactory class has been updated with new methods for creating transaction messages. Ensure that these methods correctly implement the message creation logic, including proper handling of partial objects and typeUrl assignments.

packages/nibijs/src/query/epochs.ts (3)

• 3-7: The import statements have been correctly updated to reflect the renaming of the request and response types.

• 15-15: The function signature for epochsInfo has been correctly updated to return a Promise of QueryEpochsInfoResponse.

• 32-32: The method called on the queryService object should be updated to match the new naming convention.

- const resp = await queryService.EpochInfos(req)
+ const resp = await queryService.EpochsInfo(req)

packages/nibijs/src/test/query.tests/epochs.test.ts (1)

• 42-49: The test case has been updated to reflect the change in the method call from QueryEpochInfosRequest to QueryEpochsInfoRequest. This is consistent with the summary provided and the changes in the SDK.

packages/nibijs/src/test/query.tests/spot.test.ts (2)

• 191-193: Verify the intended behavior for the tokenIn field in the estimateSwapExactAmountIn test. If undefined is not expected, this could be a mistake in the test setup.

• 316-316: Verify if the pagination field should be undefined in the pools test. If pagination is expected, this could be an oversight.

packages/nibijs/src/tx/signingClient.test.ts (5)

• 1-24: The import statements have been updated to include necessary modules and remove unused ones, which is good for maintainability and avoiding bloat.

• 58-232: The test suite "nibid tx perp" has been expanded to include comprehensive tests for perp-related transactions, which is a good practice for ensuring the robustness of the code.

• 61-166: The test "open-position, add-margin, remove-margin" correctly uses the new imports and modified signatures, ensuring that the test cases are up to date with the latest code changes.

• 168-181: The test "nibid query perp positions" is well-structured to query perp positions and assert that the necessary fields are defined, which is crucial for validating the query functionality.

• 183-232: The test "nibid tx perp close-position" correctly uses the new imports and modified signatures, ensuring that the test cases are up to date with the latest code changes.

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

• 19-20: The import statements for perpTypes and spotTypes have been uncommented and are now included in the nibiruRegistryTypes array.

• 50-57: The NibiruSigningClient class constructor has been updated to include setupPerpExtension and setupSpotExtension functions.

• 50-57: Ensure that the order of extension setup functions in the withExtensions call does not affect the functionality or expected behavior of the extensions.

• 17-37: > Note: This review was outside the patches, and no patch overlapping with it was found. Original lines [58-76]

Consider whether the hardcoded gas price in connectWithSigner should be configurable to accommodate different network conditions or user preferences.

packages/protojs/src/nibiru/epochs/v1/query.ts (7)

• 7-12: The renaming of QueryEpochInfosRequest to QueryEpochsInfoRequest and QueryEpochInfosResponse to QueryEpochsInfoResponse is consistent with the summary and correctly implemented in the code.

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

The renaming of functions such as createBaseQueryEpochInfosRequest to createBaseQueryEpochsInfoRequest and the update of input and return types are consistent with the summary and correctly implemented in the code.

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

The renaming within the export const blocks and within the encode and decode functions is consistent with the summary and correctly implemented in the code.

• 54-73: The renaming within the fromJSON and toJSON functions' input and return types is consistent with the summary and correctly implemented in the code.

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

The renaming within the create and fromPartial functions' input and return types is consistent with the summary and correctly implemented in the code.

• 298-304: The renaming of the EpochInfos function's input and return types is consistent with the summary and correctly implemented in the code.

• 316-326: The renaming within the QueryClientImpl class is consistent with the summary and correctly implemented in the code.

packages/protojs/src/nibiru/oracle/v1/tx.ts (4)

• 1-6: The summary indicates the removal of the Duration import, MsgEditOracleParams interface, and OracleParamsMsg interface, but the provided file content does not show these elements, confirming their removal.

• 517-522: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [520-543]

The Msg interface no longer includes the EditOracleParams function, aligning with the changes described in the summary.

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

The MsgClientImpl class no longer includes the EditOracleParams function, which is consistent with the summary's description of the changes.

• 1-6: > Note: This review was outside the patches, and no patch overlapping with it was found. Original lines [7-63]

The interfaces MsgAggregateExchangeRatePrevote, MsgAggregateExchangeRateVote, MsgDelegateFeedConsent, and their associated response interfaces are present and unchanged, which is consistent with the summary's lack of mention of any changes to them.

packages/protojs/src/nibiru/perp/v2/event.ts (1)

• 1-1187: The code in the provided hunk appears to be well-structured and follows good practices for defining event interfaces, encoding/decoding functions, and utility methods for working with protobuf and JSON. No issues were found.

packages/protojs/src/nibiru/perp/v2/genesis.ts (1)

• 1-186: The changes in the genesis.ts file for the protojs package appear to be correctly implemented, with proper encoding and decoding functions, JSON conversion methods, and partial object creation for the GenesisState interface. The protobuf field numbers are consistent with the properties of the GenesisState interface, and the Long library check ensures compatibility with protobufjs.

packages/protojs/src/nibiru/perp/v2/query.ts (1)

• 1-970: The code appears to be well-structured and follows standard practices for TypeScript and gRPC. There are no obvious logic errors, security issues, or performance concerns. The use of utility functions and types is appropriate, and the encoding/decoding logic is consistent with the protobufjs library's usage.

packages/protojs/src/nibiru/perp/v2/state.ts (2)

• 920-921: The isSet function is used to check for non-null and non-undefined values. It's a good practice to have such utility functions to simplify checks throughout the codebase.

• 1-918: The code is well-structured, follows best practices for TypeScript and protobuf-related operations, and includes utility functions for serialization and deserialization. The use of Long for large integers and the configuration to ensure compatibility with protobufjs are appropriate.

packages/protojs/src/nibiru/perp/v2/tx.ts (4)

• 2070-2072: The isSet utility function is used throughout the file to check for non-null and non-undefined values. It's a good practice to have such utility functions to simplify checks and improve code readability.

• 164-167: The MsgDonateToEcosystemFund interface has an optional donation field, which is good practice for fields that may not always be provided. This aligns with the protobuf optional field semantics.

• 1936-1947: The Msg service interface is well-defined with clear method signatures for each operation. This provides a good contract for the implementation of the service.

• 1950-2027: The MsgClientImpl class provides a clean implementation of the Msg service interface, with proper encoding and decoding of messages and handling of RPC requests and responses.

packages/protojs/src/nibiru/spot/v1/event.ts (1)

• 744-746: The isSet function is a utility to check for non-null and non-undefined values. It's important to ensure that this function is used consistently throughout the codebase to prevent any discrepancies in how 'set' values are determined.

packages/protojs/src/nibiru/spot/v1/genesis.ts (1)

• 1-141: The code in the provided hunk appears to be correctly implemented with proper handling of the GenesisState type and associated methods for encoding, decoding, and JSON conversion. The utility functions and types are also well-defined.

packages/protojs/src/nibiru/spot/v1/params.ts (1)

• 1-169: The code for handling parameters in the spot/v1/params.ts file is well-structured and follows TypeScript best practices for defining types and interfaces. The use of Long for handling large integers and the utility functions for encoding and decoding protobuf messages are appropriate.

packages/protojs/src/nibiru/spot/v1/pool.ts (1)

• 463-465: The compatibility check for the Long type with protobufjs is good practice to ensure that the Long type from the "long" package is used consistently throughout the codebase.

packages/protojs/src/nibiru/spot/v1/query.ts (1)

• 1-2945: The file appears to be well-structured and follows a consistent pattern for defining request and response interfaces, as well as encoding and decoding logic. Without specific changes highlighted, it's difficult to pinpoint any issues, but overall, the file seems to adhere to the expected standards for a TypeScript module in a gRPC service context.

packages/protojs/src/nibiru/spot/v1/tx.ts (16)

• 2-5: The import statements at the top of the file are correct and necessary for the types and functions defined in this file.

• 9-17: The MsgCreatePool and MsgCreatePoolResponse interfaces are well-defined and match the expected structure for a message and its response in a protocol buffer based system.

• 58-164: The encoding and decoding functions for MsgCreatePool are correctly implemented, ensuring that all fields are handled appropriately, including optional fields with conditional checks.

• 19-35: The MsgJoinPool and MsgJoinPoolResponse interfaces are well-defined. The comments provide clear explanations of the purpose of each message.

• 240-353: The encoding and decoding functions for MsgJoinPool are correctly implemented, with appropriate handling of all fields, including repeated fields and boolean flags.

• 37-45: The MsgExitPool and MsgExitPoolResponse interfaces are well-defined. The structure of these messages is consistent with the other message types in the file.

• 470-568: The encoding and decoding functions for MsgExitPool are correctly implemented, with appropriate handling of optional fields and ensuring that Long types are handled correctly.

• 47-56: The MsgSwapAssets and MsgSwapAssetsResponse interfaces are well-defined. The structure of these messages is consistent with the other message types in the file.

• 646-765: The encoding and decoding functions for MsgSwapAssets are correctly implemented, with appropriate handling of optional fields and ensuring that Long types are handled correctly.

• 846-856: The Msg service interface is correctly defined with methods that match the message types defined earlier in the file. This interface will be used to implement the actual service logic.

• 858-901: The MsgClientImpl class is correctly implemented, providing the necessary bindings for the service methods and utilizing the encoding and decoding functions defined for each message type.

• 903-909: The Rpc interface is correctly defined, providing a generic request method that can be implemented by an actual RPC client.

• 920-930: The DeepPartial type is a utility type that allows for partial objects to be defined, which is useful for creating partial message objects for the fromPartial methods.

• 932-937: The Exact type is a utility type that ensures that an object exactly matches a particular shape, which is useful for type safety when creating messages from partial objects.

• 939-942: The conditional check and configuration for the Long type from protobufjs is necessary to ensure compatibility with the Long type used in the rest of the file.

• 944-946: The isSet utility function is correctly implemented and used throughout the file to check for non-null and non-undefined values.

packages/protojs/src/nibiru/stablecoin/v1/query.ts (6)

• 2-3: The imports of Long and _m0 are correct and necessary for the encoding and decoding functions.

• 7-861: The structure of the file, including the interfaces and their corresponding encode/decode functions, is consistent and follows the conventions of the protobufjs library.

• 957-959: The utility function isSet is correctly implemented to check for non-null and non-undefined values.

• 861-914: The QueryClientImpl class is correctly implemented to bind the query methods and make RPC requests using the provided Rpc interface.

• 952-955: The conditional configuration for the Long type from protobufjs is correctly set up to ensure compatibility with the Long type imported from the long package.

• 1-955: Overall, the file is well-structured and the changes align with the summary provided. The interfaces, type definitions, and encoding/decoding functions are consistent with the protobufjs usage patterns and TypeScript type definitions.

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 1c9cf0d and 5690d98.

Files selected for processing (1)

• packages/nibijs/src/chain/chain.ts (1 hunks)

[github-actions]

Lines	Statements	Branches	Functions
	96.69% (1289/1333)	99.11% (562/567)	90.93% (301/331)

[coderabbitai]

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 5690d98 and 69ccefa.

Files selected for processing (4)

• packages/nibijs/docs/classes/StableSwap.md (1 hunks)
• packages/nibijs/src/query/perp.ts (1 hunks)
• packages/nibijs/src/test/query.tests/perp.test.ts (1 hunks)
• packages/nibijs/src/tx/signingClient.test.ts (2 hunks)

Files skipped from review due to trivial changes (1)

• packages/nibijs/docs/classes/StableSwap.md

Additional comments: 7

packages/nibijs/src/query/perp.ts (4)

• 1-12: The updated import statements using named imports are a good practice for clarity and potentially better bundling when tree shaking is used.

• 15-20: The transformPosition function correctly converts the fields from SDK decimals to strings, which is likely necessary for the consuming code to work with these values.

• 35-42: The transformPositions function is correctly implemented to map over each position in the array and apply the transformPosition transformation to it.

• 45-73: The setupPerpExtension function is correctly updated to use the new transformPositions function and the QueryClientImpl and createProtobufRpcClient for setting up the PerpExtension.

packages/nibijs/src/tx/signingClient.test.ts (3)

• 1-24: The changes to the imports and updates to the import paths align with the summary provided.

• 58-232: The test cases have been expanded with additional logic to test various transaction types and error handling. Ensure that the new logic correctly reflects the intended use cases and error scenarios.

• 158-164: Verify that the error object structure is consistent with the expected type when using type assertion in error handling.

[nibibot]

🎉 This PR is included in version @nibiruchain/protojs-v0.21.16 🎉

The release is available on:

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

Your semantic-release bot 📦🚀

[nibibot]

🎉 This PR is included in version @nibiruchain/nibijs-v0.21.42 🎉

The release is available on:

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

Your semantic-release bot 📦🚀