Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: bump nibiru submodule and unhide protojs and gql so we can tra… #393

Merged
merged 2 commits into from
Dec 3, 2024

Conversation

cgilbe27
Copy link
Contributor

@cgilbe27 cgilbe27 commented Dec 2, 2024

…ck changes to external APIs

Summary by CodeRabbit

  • New Features

    • Introduced multiple TypeScript interfaces for managing various modules including inflation, oracle, and devgas, enhancing the framework for blockchain interactions.
    • Added comprehensive query capabilities for inflation-related data and oracle events.
    • Implemented encoding and decoding methods for efficient data handling across different modules.
    • Added event handling for inflation distribution and epoch management.
  • Documentation

    • Improved structure and clarity of interfaces and methods across multiple files, ensuring better maintainability and usability.

Copy link
Contributor

coderabbitai bot commented Dec 2, 2024

Walkthrough

This pull request introduces multiple changes across various files, primarily focusing on TypeScript interfaces and functionalities related to blockchain modules, particularly for Nibiru and Ethereum. Key modifications include the addition of new interfaces for handling events, queries, and genesis states in the Nibiru ecosystem, as well as updates to the .gitignore file to manage ignored files and directories more effectively. The changes also involve restructuring and re-exporting entities to streamline access and organization within the codebase.

Changes

File Path Change Summary
.gitignore Added and removed entries for various ignored files and directories, focusing on IDE and Node.js artifacts.
src/gql/utils/generated.ts Introduced TypeScript type definitions for a GraphQL schema, enhancing type safety and structure.
src/gql/utils/schema.graphql Added a comprehensive GraphQL schema defining various types, inputs, enums, and directives.
src/protojs/cosmos/auth/v1beta1/auth.ts Created interfaces for account management in Cosmos SDK, including encoding/decoding functions.
src/protojs/cosmos/bank/v1beta1/bank.ts Introduced interfaces for bank module operations, including transaction inputs and outputs.
src/protojs/cosmos/base/query/v1beta1/pagination.ts Added pagination interfaces for efficient gRPC request handling.
src/protojs/cosmos/base/v1beta1/coin.ts Defined interfaces for handling token representations in protobuf format.
src/protojs/cosmos_proto/cosmos.ts Introduced scalar types and interface descriptors for protocol buffers.
src/protojs/eth/evm/v1/events.ts Created interfaces for Ethereum-related events with encoding/decoding logic.
src/protojs/eth/evm/v1/evm.ts Defined interfaces for managing Ethereum Virtual Machine related data structures and operations.
src/protojs/eth/evm/v1/genesis.ts Introduced interfaces for the genesis state of the EVM module.
src/protojs/eth/evm/v1/query.ts Defined request and response types for querying Ethereum-related data.
src/protojs/eth/evm/v1/tx.ts Introduced interfaces for handling Ethereum transactions with encoding/decoding logic.
src/protojs/eth/types/v1/account.ts Created the EthAccount interface, implementing the authtypes.AccountI interface.
src/protojs/nibiru/devgas/v1/devgas.ts Introduced the FeeShare interface for organizing fee distribution conditions.
src/protojs/nibiru/devgas/v1/event.ts Defined interfaces for events related to developer gas royalties.
src/protojs/nibiru/devgas/v1/genesis.ts Created interfaces for the genesis state and parameters of the devgas module.
src/protojs/nibiru/devgas/v1/query.ts Introduced query interfaces for handling fee shares.
src/protojs/nibiru/devgas/v1/tx.ts Defined message interfaces for managing fee share operations.
src/protojs/nibiru/epochs/v1/event.ts Created interfaces for epoch start and end events.
src/protojs/nibiru/epochs/v1/genesis.ts Defined the genesis state for the epochs module.
src/protojs/nibiru/epochs/v1/query.ts Introduced query interfaces for handling epoch-related data.
src/protojs/nibiru/epochs/v1/state.ts Created the EpochInfo interface for managing epoch-related data.
src/protojs/nibiru/genmsg/v1/genmsg.ts Introduced the GenesisState interface for the genmsg module.
src/protojs/nibiru/inflation/v1/event.ts Defined the EventInflationDistribution interface for inflation events.
src/protojs/nibiru/inflation/v1/genesis.ts Created interfaces for the genesis state and parameters of the inflation module.
src/protojs/nibiru/inflation/v1/inflation.ts Introduced the InflationDistribution interface for managing inflation allocation.
src/protojs/nibiru/inflation/v1/query.ts Defined query interfaces for handling inflation-related data.
src/protojs/nibiru/inflation/v1/tx.ts Created message interfaces for managing inflation-related transactions.
src/protojs/nibiru/oracle/v1/event.ts Introduced interfaces for handling oracle-related events.
src/protojs/nibiru/oracle/v1/genesis.ts Created the GenesisState interface for the oracle module's genesis state.
src/protojs/nibiru/oracle/v1/oracle.ts Defined parameters and structures for managing oracle data.
src/protojs/nibiru/oracle/v1/query.ts Introduced query interfaces for handling exchange rates and related data.
src/protojs/nibiru/oracle/v1/state.ts Created the PriceSnapshot interface for managing price data.
src/protojs/index.cosmos.auth.ts Added export statement for v1beta1 namespace from the auth module.
src/protojs/index.cosmos.bank.ts Added export statement for v1beta1 namespace from the bank module.
src/protojs/index.cosmos.base.query.ts Added export statement for v1beta1 namespace from the base query module.
src/protojs/index.cosmos.base.ts Added export statement for v1beta1 namespace from the base module.
src/protojs/index.eth.evm.ts Added export statement for v1 namespace from the Ethereum EVM module.
src/protojs/index.eth.ts Added export statement for types namespace from the Ethereum types module.
src/protojs/index.ts Introduced an entry point for exporting various modules with namespaces.

Possibly related PRs

  • feat: staking extension and git submodules #360: The changes in the .gitignore file include ignoring directories like /nibiru, which is related to the modifications made in this PR that also involve changes to the .gitignore file.
  • feat: eth protos #366: This PR includes updates to the .gitignore file, which aligns with the changes made in the main PR regarding ignored paths and files.
  • chore: main to develop #375: While this PR focuses on general maintenance and updates, it does not directly relate to the changes in the .gitignore file.
  • chore: upgrade graphql #387: This PR does not have a direct connection to the changes in the .gitignore file, as it primarily addresses dependency upgrades.

Suggested labels

released

"In the burrow where changes hop,
New types and paths, we can't stop.
With GraphQL and Ethereum in sight,
Our code's now clearer, oh what a delight!
From dev gas to epochs, we refine,
In this code garden, all will be 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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

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

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

CodeRabbit Commands (Invoked using PR comments)

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

Other keywords and placeholders

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

CodeRabbit Configuration File (.coderabbit.yaml)

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

Documentation and Community

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

Copy link

github-actions bot commented Dec 2, 2024

Lines Statements Branches Functions
Coverage: 95%
95.51% (895/937) 80.66% (171/212) 89.82% (300/334)

coderabbitai[bot]

This comment was marked as outdated.

@cgilbe27
Copy link
Contributor Author

cgilbe27 commented Dec 2, 2024

@coderabbitai ignore /src/protojs changes as these are generated

Copy link
Contributor

coderabbitai bot commented Dec 2, 2024

Tip

For best results, initiate chat on the files or code changes.

@cgilbe27 Understood. To have CodeRabbit ignore the /src/protojs directory, you can update your CodeRabbit configuration by adding the path to the exclude section under path_filters. This will ensure that generated files in this directory are not reviewed.

@cgilbe27
Copy link
Contributor Author

cgilbe27 commented Dec 2, 2024

@coderabbitai make a committable suggestion with details for the project

Copy link
Contributor

coderabbitai bot commented Dec 2, 2024

Tip

For best results, initiate chat on the files or code changes.

@cgilbe27 To have CodeRabbit ignore the src/protojs directory, you can update your CodeRabbit configuration file by adding the exclude path under path_filters. Here's how you can specify it:

path_filters:
  exclude:
    - 'src/protojs/**'

This configuration will ensure that CodeRabbit does not review any files within the src/protojs directory.

@cgilbe27
Copy link
Contributor Author

cgilbe27 commented Dec 2, 2024

@coderabbitai what is the file name of this called and where does it go?

Copy link
Contributor

coderabbitai bot commented Dec 2, 2024

Tip

For best results, initiate chat on the files or code changes.

@cgilbe27 The configuration file is named coderabbit.yaml and it should be placed in the root directory of your repository. By adding the configuration I provided to this file, CodeRabbit will ignore the src/protojs directory when reviewing your code.

@cgilbe27
Copy link
Contributor Author

cgilbe27 commented Dec 2, 2024

@coderabbitai I've commited those changes, please re-review this MR

Copy link
Contributor

coderabbitai bot commented Dec 2, 2024

@cgilbe27 Thank you for updating the configuration. I will review the merge request.

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@cgilbe27 cgilbe27 merged commit a4b52d0 into develop Dec 3, 2024
3 checks passed
@cgilbe27 cgilbe27 deleted the chore/bump-nibi-submodule-unhide-proto-and-gql branch December 3, 2024 15:09
github-actions bot pushed a commit that referenced this pull request Dec 3, 2024
### [6.0.1](v6.0.0...v6.0.1) (2024-12-03)

### Miscellaneous Chores

* bump nibiru submodule and unhide protojs and gql so we can tra… ([#393](#393)) ([a4b52d0](a4b52d0))

 [skip ci]
@nibibot
Copy link

nibibot commented Dec 3, 2024

🎉 This PR is included in version 6.0.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants