search

InjectiveLabs / docs

Injective Protocol Documentation
Apache License 2.0
16 stars 4 forks source link

feat/add_exchange_messages_from_v1_13 #172

Closed aarmoa closed 1 month ago

aarmoa commented 1 month ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The recent changes enhance the trading ecosystem by introducing new message types and parameters that improve the management of stake grants, position margins, and market updates. Notable inclusions are the min_notional attribute across various market classes and new JSON schemas for structured message formats. These adjustments bolster operational integrity and ensure better transaction validation, ultimately refining the user experience within the Injective protocol.

Changes

File Change Summary
.../_binaryoptions.md Updated denom variable in main to include a min_notional parameter for transaction thresholds.
.../_chainexchange.md Added MsgAuthorizeStakeGrants and MsgActivateStakeGrant message structures for stake management.
.../_changelog.md Introduced new message types for market management and updated SDKs to include min_notional.
.../_derivatives.md Added MsgDecreasePositionMargin and MsgUpdateDerivativeMarket for margin adjustments and market updates.
.../_spot.md Introduced minNotional for order validation and a new MsgUpdateSpotMarket for market configurations.
.../grantAuthorization.json New JSON structure for defining parameters related to stake grants.
.../msgActivateStakeGrant.json New JSON file for activating stake grants with structured parameters.
.../msgAuthorizeStakeGrants.json New JSON format for authorizing stake grants with sender and grants parameters.
.../msgDecreasePositionMargin.json New schema for decreasing margin position with necessary parameters.
.../msgUpdateDerivativeMarket.json New schema for updating derivative market configurations.
.../msgUpdateSpotMarket.json New schema for updating spot market parameters including min_notional.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant StakeGranter
    participant GrantSystem

    User->>StakeGranter: Request stake grant
    StakeGranter->>GrantSystem: Authorize grant (MsgAuthorizeStakeGrants)
    GrantSystem->>User: Notification of authorization
sequenceDiagram
    participant User
    participant MarketAdmin
    participant MarketSystem

    User->>MarketAdmin: Request market update
    MarketAdmin->>MarketSystem: Submit update (MsgUpdateSpotMarket)
    MarketSystem->>User: Confirm update completion

Poem

🐰 In fields of code, a change we weave,
New messages dance, as we believe.
With min_notional, our trades align,
In rabbit's heart, these updates shine!
Hops of joy for markets anew,
Together we'll trade, just me and you! 🌼

Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.