feat/update_for_release_v1_16_4 #181
Conversation
WalkthroughThe PR updates version constants in Makefile, adjusts oracle_scale_factor values in docs, adds/updates numerous auto-generated documentation blocks, and introduces many new JSON table schemas for Indexer RPCs (auctions, megavault), exchange params/messages, downtime detector, and orderbook v2 fields. It also adds a changelog entry and refines funding descriptions. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant C as Client
participant IDX as Indexer RPC
participant DB as Storage
rect rgba(200,235,255,0.3)
Note over C,IDX: Auctions V2
C->>IDX: AuctionV2Request(round)
IDX->>DB: Fetch Auction by round
DB-->>IDX: Auction
IDX-->>C: AuctionV2Response(auction)
end
rect rgba(200,255,200,0.3)
Note over C,IDX: AccountAuctions V2 (paginated)
C->>IDX: AccountAuctionsV2Request(address, per_page, token)
IDX->>DB: Query Account Auctions (page token)
DB-->>IDX: [AccountAuctionV2], next_token
IDX-->>C: AccountAuctionsV2Response(auctions, next)
alt more pages
C->>IDX: AccountAuctionsV2Request(..., token=next)
IDX-->>C: Next page
end
end
rect rgba(255,240,200,0.3)
Note over C,IDX: Megavault stats/history
C->>IDX: GetVaultRequest(vault_address)
IDX->>DB: Read Vault, Stats, APR, PnL
DB-->>IDX: Vault{operators,incentives,target_apr,stats,...}
IDX-->>C: GetVaultResponse(vault)
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
Comment |
There was a problem hiding this comment.
Pull Request Overview
Updates documentation to reflect changes in chain version 1.16.4 and indexer version 1.16.91, including new API endpoints, parameter updates, and protocol documentation improvements.
Key changes:
- Added new MegaVault RPC endpoints and data structures for vault management
- Introduced downtime detector module with duration enums and API endpoints
- Enhanced auction module with bidders whitelist functionality and new indexer endpoints
Reviewed Changes
Copilot reviewed 62 out of 62 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| Makefile | Updates SDK versions to reflect v1.11.2 (Python) and v1.58.3 (Go) with chain v1.16.4 |
| source/includes/_changelog.md | Adds changelog entry for 2025-09-24 release documenting version updates |
| source/json_tables/injective/exchange/v2/ | Updates parameter descriptions and adds new message definitions for exchange module |
| source/json_tables/injective/downtimedetector/v1beta1/ | Adds complete downtime detector module with duration enums and API structures |
| source/json_tables/injective/auction/ | Enhances auction module with bidders whitelist parameter |
| source/json_tables/indexer_new/injective_megavault_rpc/ | Introduces comprehensive MegaVault API with vault management, statistics, and user operations |
| source/json_tables/indexer_new/injective_*_exchange_rpc/ | Adds height parameter to orderbook responses for better tracking |
| source/json_tables/indexer_new/injective_auction_rpc/ | Adds new auction endpoints and contract structure definitions |
| source/includes/_derivatives.md | Updates oracle scale factor examples from 6 to 0 |
| source/includes/_binaryoptions.md | Updates oracle scale factor example from 6 to 0 |
| source/includes/_chainstream.md | Updates chain stream documentation with v2 endpoint references and improved descriptions |
| source/includes/_chainexchange.md | Adds missing parameter documentation for subaccount queries |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| { | ||
| "Parameter": "human_readable_upgrade_block_height", | ||
| "Type": "int64", | ||
| "Description": "DO NOT USE THIS FIELD. It was introduced for a temporary bug fix." |
There was a problem hiding this comment.
This warning message should include more context about when this field will be deprecated or removed, and what developers should use instead.
| "Description": "DO NOT USE THIS FIELD. It was introduced for a temporary bug fix." | |
| "Description": "DEPRECATED: This field was introduced for a temporary bug fix and will be removed in a future release (expected removal: v2.0.0). Do not use this field in new code. There is no replacement for this field." |
| { | ||
| "Parameter": "successfully_recovered", | ||
| "Type": "bool", | ||
| "Description": "" |
There was a problem hiding this comment.
The Description field is empty and should provide meaningful information about what this boolean parameter represents.
| "Description": "" | |
| "Description": "Indicates whether the system has successfully recovered since the specified downtime period." |
| "Description": "", | ||
| "Required": "Yes" | ||
| }, | ||
| { | ||
| "Parameter": "recovery", | ||
| "Type": "time.Duration", | ||
| "Description": "", |
There was a problem hiding this comment.
Both Description fields are empty and should provide meaningful information about the downtime and recovery parameters.
| "Description": "", | |
| "Required": "Yes" | |
| }, | |
| { | |
| "Parameter": "recovery", | |
| "Type": "time.Duration", | |
| "Description": "", | |
| "Description": "The type or category of downtime to check for recovery.", | |
| "Required": "Yes" | |
| }, | |
| { | |
| "Parameter": "recovery", | |
| "Type": "time.Duration", | |
| "Description": "The minimum duration since recovery from the specified downtime.", |
| "Description": "", | ||
| "Required": "Yes" | ||
| }, | ||
| { | ||
| "Parameter": "recovery", | ||
| "Type": "time.Duration", | ||
| "Description": "", |
There was a problem hiding this comment.
Both Description fields are empty and should provide meaningful information about the downtime and recovery parameters.
| "Description": "", | |
| "Required": "Yes" | |
| }, | |
| { | |
| "Parameter": "recovery", | |
| "Type": "time.Duration", | |
| "Description": "", | |
| "Description": "The type or category of downtime to check for recovery.", | |
| "Required": "Yes" | |
| }, | |
| { | |
| "Parameter": "recovery", | |
| "Type": "time.Duration", | |
| "Description": "The minimum duration since recovery from the specified downtime.", |
| "Description": "" | ||
| }, | ||
| { | ||
| "Parameter": "last_block_time", | ||
| "Type": "time.Time", | ||
| "Description": "" |
There was a problem hiding this comment.
Both Description fields are empty and should provide meaningful information about the downtimes array and last_block_time parameters.
| "Description": "" | |
| }, | |
| { | |
| "Parameter": "last_block_time", | |
| "Type": "time.Time", | |
| "Description": "" | |
| "Description": "An array of downtime entries, each representing a period when the system experienced downtime." | |
| }, | |
| { | |
| "Parameter": "last_block_time", | |
| "Type": "time.Time", | |
| "Description": "The timestamp of the last processed block." |
| "Description": "" | ||
| }, | ||
| { | ||
| "Parameter": "last_block_time", | ||
| "Type": "time.Time", | ||
| "Description": "" |
There was a problem hiding this comment.
Both Description fields are empty and should provide meaningful information about the downtimes array and last_block_time parameters.
| "Description": "" | |
| }, | |
| { | |
| "Parameter": "last_block_time", | |
| "Type": "time.Time", | |
| "Description": "" | |
| "Description": "An array of downtime entries representing periods when the system was unavailable." | |
| }, | |
| { | |
| "Parameter": "last_block_time", | |
| "Type": "time.Time", | |
| "Description": "The timestamp of the last block processed before the genesis state was exported." |
| "Description": "" | ||
| }, | ||
| { | ||
| "Parameter": "last_downtime", | ||
| "Type": "time.Time", | ||
| "Description": "" |
There was a problem hiding this comment.
Both Description fields are empty and should provide meaningful information about the duration and last_downtime parameters.
| "Description": "" | |
| }, | |
| { | |
| "Parameter": "last_downtime", | |
| "Type": "time.Time", | |
| "Description": "" | |
| "Description": "The total length of the downtime period." | |
| }, | |
| { | |
| "Parameter": "last_downtime", | |
| "Type": "time.Time", | |
| "Description": "The timestamp of the most recent downtime event." |
| "Description": "" | ||
| }, | ||
| { | ||
| "Parameter": "last_downtime", | ||
| "Type": "time.Time", | ||
| "Description": "" |
There was a problem hiding this comment.
Both Description fields are empty and should provide meaningful information about the duration and last_downtime parameters.
| "Description": "" | |
| }, | |
| { | |
| "Parameter": "last_downtime", | |
| "Type": "time.Time", | |
| "Description": "" | |
| "Description": "The total length of the downtime event." | |
| }, | |
| { | |
| "Parameter": "last_downtime", | |
| "Type": "time.Time", | |
| "Description": "The timestamp of the most recent downtime occurrence." |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 12
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (8)
source/includes/_derivatives.md (8)
274-275: Typo: “bet bid/ask price” → “best buy/sell price”Fix user‑facing text.
Apply this diff:
-<tr ><td class="parameter-td td_text">best_buy_price</td><td class="type-td td_text">Decimal</td><td class="description-td td_text">Market's bet bid price</td></tr> -<tr ><td class="parameter-td td_text">best_sell_price</td><td class="type-td td_text">Decimal</td><td class="description-td td_text">Market's bet ask price</td></tr> +<tr ><td class="parameter-td td_text">best_buy_price</td><td class="type-td td_text">Decimal</td><td class="description-td td_text">Market's best buy price</td></tr> +<tr ><td class="parameter-td td_text">best_sell_price</td><td class="type-td td_text">Decimal</td><td class="description-td td_text">Market's best sell price</td></tr>
1536-1536: Typo: “marke ID” → “market ID”User‑facing text.
Apply this diff:
-<td class="description-td td_text">The marke ID to query for</td> +<td class="description-td td_text">The market ID to query for</td>
1841-1841: Typo: “marke ID” → “market ID”Same correction here.
Apply this diff:
-<td class="description-td td_text">The marke ID to query for</td> +<td class="description-td td_text">The market ID to query for</td>
2143-2146: Wrong table embedded under PositionsInMarketThe section “PositionsInMarket” includes QuerySubaccountPositionInMarketRequest (requires subaccount_id), which contradicts the section purpose (“all positions in market”). Use the correct request table (market_id only).
2180-2181: Response shape mismatch: array vs single itemExample shows "state" as an array, but table lists type Position. Make it “DerivativePosition Array”.
Apply this diff:
-<td class="type-td td_text">Position</td> +<td class="type-td td_text">DerivativePosition Array</td>
3547-3554: Parameter description error: quote_denom is quote, not baseFix “base currency” → “quote currency”.
Apply this diff:
-<td class="description-td td_text">type of coin to use as the base currency</td> +<td class="description-td td_text">type of coin to use as the quote currency</td>
138-139: Replace “human redable format” with “human readable format”
Occurs in all generated tables undersource/includes/**/*.mdand insource/json_tables/**/*.json.
3415-3417: Correctreduce_margin_ratiounits in Python examples Changereduce_margin_ratio=Decimal("3")toDecimal("0.3"), and updatenew_reduce_margin_ratio=Decimal("3.5")toDecimal("0.35")to match the Go example and on-chain values.
🧹 Nitpick comments (60)
source/json_tables/indexer_new/injective_megavault_rpc/Apr.json (2)
3-6: Clarify the field name “value” to be explicit“value” is ambiguous. Consider renaming to “apr” or “apr_value” for self-descriptiveness.
Proposed change:
- "Parameter": "value", - "Type": "string", - "Description": "APR value" + "Parameter": "apr", + "Type": "string", + "Description": "Annual Percentage Rate (APR) value"Please verify the actual Indexer RPC payload uses this field name (or update the table to mirror it exactly).
8-16: Confirm types for numeric-looking fields (string vs number)LP prices and APR are typed as string. That’s often correct for on-chain/indexer decimals, but please confirm these are indeed string-encoded decimals in the Indexer response to avoid mismatches.
If they are decimals, keeping Type as "string" is fine; otherwise:
- "Type": "string", + "Type": "number",Optional description improvements for clarity:
- "Description": "Original LP price" + "Description": "Original LP token price (string-encoded decimal)" - "Description": "Current LP price" + "Description": "Current LP token price (string-encoded decimal)"source/json_tables/indexer_new/injective_megavault_rpc/GetVaultRequest.json (1)
5-5: Clarify address format in description (non-breaking doc improvement).Add a brief format hint and example to reduce ambiguity for users.
Apply this diff:
- "Description": "Vault address", + "Description": "Vault address (bech32 inj..., e.g., inj1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx)",source/json_tables/indexer_new/injective_megavault_rpc/GetUserRequest.json (1)
3-13: Clarify address format (bech32).Recommend specifying the expected address format to reduce ambiguity.
Apply this diff to make it explicit:
- "Description": "Vault address", + "Description": "Vault address (Injective bech32, e.g. inj1...)", @@ - "Description": "User address", + "Description": "User address (Injective bech32, e.g. inj1...)",source/includes/_changelog.md (1)
3-6: Add explicit Indexer version for traceability.Consider including the exact Indexer version (e.g., 1.16.91) to match the PR description and improve auditability.
Example:
- Updated all messages to reflect chain v1.16.4 and Indexer v1.16.91
source/json_tables/injective/exchange/v2/MsgCancelPostOnlyMode.json (1)
3-6: Clarify sender format (bech32).Make the address format explicit.
- "Description": "the sender's Injective address", + "Description": "the sender's Injective address (bech32, e.g. inj1...)",source/includes/_binaryoptions.md (1)
319-319: Fix markdownlint MD010 (hard tabs) in code block.markdownlint flagged a hard tab on this line. Replace the tab with spaces to satisfy MD010 or configure the linter to ignore code blocks.
- OracleScaleFactor: 0, + OracleScaleFactor: 0,source/json_tables/indexer_new/injective_megavault_rpc/TvlHistoryRequest.json (1)
3-19: Tighten parameter descriptions (format and wording).
- Make address format explicit (bech32).
- Clarify “max_data_points” phrasing.
- "Description": "Vault address", + "Description": "Vault address (Injective bech32, e.g. inj1...)", @@ - "Description": "timestamp from which to start the query in milliseconds (UTC)", + "Description": "Epoch timestamp (UTC) in milliseconds from which to start the query", @@ - "Description": "amount of data points to return", + "Description": "Maximum number of data points to return",source/json_tables/indexer_new/injective_megavault_rpc/Pnl.json (1)
3-26: Clarify numeric string semantics and units.These appear to be decimal numbers serialized as strings; clarify scale/units for consumers.
- "Description": "PnL value" + "Description": "PnL value (decimal string)" @@ - "Description": "PnL percentage" + "Description": "PnL percentage (decimal string, e.g., 0.0123 for 1.23%)" @@ - "Description": "Total amount subscribed" + "Description": "Total amount subscribed (decimal string; quote currency unless specified)" @@ - "Description": "Total amount redeemed" + "Description": "Total amount redeemed (decimal string; quote currency unless specified)" @@ - "Description": "Current amount" + "Description": "Current amount (decimal string; quote currency unless specified)"source/includes/_derivatives.md (2)
3511-3526: Go example updated to OracleScaleFactor: 0; fix lint warning for hard tabsMarkdown linter flags MD010 on this code block (hard tabs). Consider disabling MD010 for code blocks or adding a local markdownlint override.
3517-3517: markdownlint MD010 (hard tabs) — suppress for code blocksEither configure markdownlint to ignore code blocks or wrap blocks with disable/enable comments.
Also applies to: 3792-3792
Makefile (1)
87-89: .PHONY lists update-all-docs which doesn’t existEither remove it or add an alias.
Apply this diff to add an alias:
+# Alias for backwards compatibility +update-all-docs: update-all-proto-related-files + .PHONY: refresh-examples update-errors-documentation update-proto-json clone-repos clean-repos clone-sdk-repos clean-sdk-repos update-all-docs _update-errors _update-proto update-all-proto-related-filessource/json_tables/indexer_new/injective_auction_rpc/ClaimedAssets.json (1)
1-12: Fill missing descriptions for schema fieldsAdd concise descriptions and units for clarity.
Apply this diff:
[ { "Parameter": "denom", "Type": "string", - "Description": "" + "Description": "Asset denom (e.g., INJ, factory denom, IBC denom)" }, { "Parameter": "amount", "Type": "string", - "Description": "" + "Description": "Amount as string, in base units" } ]source/json_tables/indexer_new/injective_auction_rpc/AuctionsHistoryV2Response.json (1)
1-12: Type naming and pagination shape
- Use consistent “Array” capitalization (matches other tables).
- Verify if “next” should be a single token (string) rather than “string array”.
Apply this diff if a single token:
{ "Parameter": "auctions", - "Type": "Auction array", + "Type": "Auction Array", "Description": "The historical auctions" }, { "Parameter": "next", - "Type": "string array", - "Description": "Next tokens for pagination" + "Type": "string", + "Description": "Next token for pagination" }source/json_tables/indexer_new/injective_auction_rpc/AuctionsHistoryV2Request.json (1)
1-20: Pagination fields likely optional; add per_page descriptionTypically, token is optional for the first page; add a description for per_page.
Apply this diff if confirmed:
{ "Parameter": "per_page", "Type": "int32", - "Description": "", + "Description": "Page size (number of items per page)", "Required": "Yes" }, { "Parameter": "token", "Type": "string", "Description": "Pagination token", - "Required": "Yes" + "Required": "No" }source/json_tables/indexer_new/injective_auction_rpc/AccountAuctionsV2Response.json (1)
3-6: Tighten phrasing for clarityConsider simplifying the description to read more naturally.
- "Description": "The historical auctions" + "Description": "Historical auctions"source/json_tables/injective/exchange/v2/MsgSetDelegationTransferReceivers.json (1)
5-6: Polish descriptions and capitalization for consistencyMinor copyedits for consistency with surrounding docs.
- "Description": "the sender's Injective address (must be exchange admin)", + "Description": "The sender's Injective address (must be exchange admin).", @@ - "Description": "list of receiver addresses to set as delegation transfer receivers", + "Description": "List of receiver addresses to set as delegation transfer receivers.",Also applies to: 11-12
source/json_tables/indexer_new/injective_megavault_rpc/RedemptionBucket.json (1)
3-21: Improve grammar and end punctuation for descriptionsMinor wording and punctuation tweaks improve readability.
- "Description": "Bucket" + "Description": "Bucket." @@ - "Description": "Amount of LP tokens to redeem" + "Description": "Amount of LP tokens to redeem." @@ - "Description": "Amount needed to cover all the redemptions in the bucket" + "Description": "Amount needed to cover all redemptions in the bucket." @@ - "Description": "Amount of liquidity missing needed to cover all the redemptions in the bucket" + "Description": "Amount of missing liquidity needed to cover all redemptions in the bucket."source/json_tables/indexer_new/injective_megavault_rpc/Subscription.json (1)
8-11: Clarify field semantics; avoid token-specific wording
- “User” → “User address” clarifies content.
- “Amount in USDT” may be too specific if other vaults don’t use USDT. Prefer a denom‑agnostic description.
- "Description": "User" + "Description": "User address" @@ - "Description": "Amount in USDT the user gave for the subscription" + "Description": "Amount of quote asset deposited for the subscription"Is USDT guaranteed for all subscriptions across megavaults? If not, the denom‑agnostic phrasing above avoids misleading specificity.
Also applies to: 23-26
source/includes/_chainexchange.md (1)
139-141: Use a heading instead of bold to satisfy markdownlint (MD036).Replace emphasized label with a real heading for consistency and lint compliance.
-**Subaccount** +### Subaccountsource/json_tables/indexer_new/injective_megavault_rpc/UnrealizedPnl.json (1)
1-12: Clarify units/format for percentage and value.Explicitly state formats to avoid ambiguity (fraction vs percent; human‑readable decimals).
- "Description": "Unrealized PnL value" + "Description": "Unrealized PnL value (human-readable decimal string)" - "Description": "Unrealized PnL percentage" + "Description": "Unrealized PnL percentage as a fractional decimal string (e.g., 0.123 for 12.3%)"source/json_tables/injective/auction/Params.json (1)
16-21: Punctuation/clarity fix for bidders_whitelist description.Improve readability.
- "Description": "bidders_whitelist defines the list of addresses that are allowed to bid if empty, any address can bid; if populated, only whitelisted addresses can bid" + "Description": "bidders_whitelist defines the list of addresses that are allowed to bid; if empty, any address can bid; if populated, only whitelisted addresses can bid."source/json_tables/indexer_new/injective_auction_rpc/AccountAuctionsV2Request.json (2)
9-13: Fill missing description for per_page.- "Description": "", + "Description": "Number of records per page",
14-19: Confirmtokenrequiredness in pagination.If token-based pagination is cursor-style,
tokenis commonly optional on the first page. Consider making Required = "No" unless API mandates it.- "Required": "Yes" + "Required": "No"source/json_tables/injective/exchange/v2/PerpetualMarketFunding.json (1)
8-11: Minor wording polish for description.Add needed punctuation and consistent terminology.
- "Description": "cumulative_price defines the running time-integral of the perp premium ((VWAP - mark_price) / mark_price) i.e., sum(premium * seconds) used to compute the interval’s average premium for funding" + "Description": "cumulative_price defines the running time-integral of the perpetual premium ((VWAP - mark_price) / mark_price); i.e., sum(premium * seconds) used to compute the interval’s average premium for funding."source/json_tables/injective/exchange/v2/Params.json (2)
158-161: Mark the temporary field as deprecated/internal-use.Make intent explicit to avoid consumer reliance.
- "Description": "DO NOT USE THIS FIELD. It was introduced for a temporary bug fix." + "Description": "[Deprecated] Internal-use only for a temporary bug fix. Do not rely on this field."
168-171: Reference accepted enum values for downtime duration.Link or enumerate valid values to reduce guesswork.
- "Description": "min_post_only_mode_downtime_duration defines the minimum downtime duration that must pass before the post only mode is automatically enabled. The accepted values are the Downtime enum values from the downtime_duration module" + "Description": "Minimum downtime duration before post-only mode is automatically enabled. Accepted values are the Downtime enum values from the downtime_duration module (e.g., TEN_MINUTES, THIRTY_MINUTES, ...)."source/json_tables/indexer_new/injective_auction_rpc/Auction.json (1)
32-36: Add a meaningful description forcontract.Provide a short description to aid consumers.
- "Description": "" + "Description": "Associated auction contract metadata (present for contract-backed auctions)"source/json_tables/injective/downtime-detector/RecoveredSinceDowntimeOfLengthResponse.json (1)
1-7: Fill in the missing description for clarity.Describe the boolean’s semantics to avoid ambiguity.
{ "Parameter": "successfully_recovered", "Type": "bool", - "Description": "" + "Description": "True if the chain has successfully recovered since the specified downtime duration" }source/json_tables/indexer_new/injective_megavault_rpc/ListSubscriptionsResponse.json (1)
8-11: Tighten description wording.Minor wording improvement.
- "Description": "Next tokens for pagination" + "Description": "Next page tokens for pagination"source/json_tables/indexer_new/injective_megavault_rpc/VolatilityStats.json (1)
1-7: Grammar nit and future-proofing.
- Use “30-day” (singular) as a modifier.
- If additional windows (e.g., seven_days) exist or are planned, consider listing them here for completeness.
{ "Parameter": "thirty_days", "Type": "Volatility", - "Description": "30-days volatility" + "Description": "30-day volatility" }source/json_tables/indexer_new/injective_megavault_rpc/GetOperatorRedemptionBucketsResponse.json (1)
1-7: Polish description punctuation.Tiny copy edit.
{ "Parameter": "buckets", "Type": "RedemptionBucket array", - "Description": "The redemption buckets" + "Description": "The redemption buckets." }source/json_tables/indexer_new/injective_megavault_rpc/GetUserResponse.json (1)
1-7: Minor copy edit.End description with a period for consistency with adjacent docs.
{ "Parameter": "user", "Type": "User", - "Description": "The user" + "Description": "The user." }source/json_tables/indexer_new/injective_megavault_rpc/PnlHistoryResponse.json (1)
1-7: Add description for history parameter
Clarify what each HistoricalPnL entry represents and its default ordering.{ "Parameter": "history", "Type": "HistoricalPnL array", - "Description": "" + "Description": "Historical profit-and-loss entries (ordered from oldest to newest unless specified otherwise)" }source/json_tables/indexer_new/injective_megavault_rpc/TvlHistoryResponse.json (1)
1-7: Add description forhistoryparameter
Insource/json_tables/indexer_new/injective_megavault_rpc/TvlHistoryResponse.json, replace:- "Description": "" + "Description": "Historical total value locked entries (ordered from oldest to newest unless specified otherwise)"The referenced
HistoricalTVLtype is defined inHistoricalTVL.json.source/json_tables/injective/downtime-detector/GenesisState.json (1)
1-12: Fill missing descriptions and clarify time encoding.Both fields lack descriptions. Please specify what “downtimes” represents and how “time.Time” is encoded (e.g., RFC3339 UTC).
Apply:
[ { "Parameter": "downtimes", "Type": "GenesisDowntimeEntry array", - "Description": "" + "Description": "List of recorded downtime entries at genesis." }, { "Parameter": "last_block_time", "Type": "time.Time", - "Description": "" + "Description": "Timestamp of the last observed block (RFC3339, UTC)." } ]source/json_tables/indexer_new/injective_megavault_rpc/Incentives.json (1)
1-22: Standardize timestamp phrasing and unit.“UNIX millis” is ambiguous; prefer “Unix timestamp in milliseconds” for consistency.
{ "Parameter": "updated_at", "Type": "int64", - "Description": "UpdatedAt timestamp in UNIX millis." + "Description": "Unix timestamp in milliseconds when the target APR was updated." }source/json_tables/indexer_new/injective_megavault_rpc/GetOperatorRedemptionBucketsRequest.json (1)
1-14: Align “Required” field convention across tables.Only this file marks fields as “Required”. Either:
- add “Required” consistently to request schemas, or
- remove and document requiredness in surrounding text.
If keeping, prefer boolean true/false to “Yes”.
{ "Parameter": "vault_address", "Type": "string", "Description": "Vault address", - "Required": "Yes" + "Required": true }, { "Parameter": "operator_address", "Type": "string", "Description": "Operator address", - "Required": "Yes" + "Required": true }source/json_tables/injective/downtime-detector/RecoveredSinceDowntimeOfLengthRequest.json (1)
1-14: Add descriptions and define duration encoding/units.Empty descriptions reduce usability; “time.Duration” must specify encoding (e.g., Go duration string “300s”, or int64 ns).
{ "Parameter": "downtime", "Type": "Downtime", - "Description": "", + "Description": "Downtime enum value representing the outage length to check.", "Required": "Yes" }, { "Parameter": "recovery", "Type": "time.Duration", - "Description": "", + "Description": "Recovery window duration (Go duration format, e.g., \"300s\").", "Required": "Yes" }source/json_tables/injective/downtime-detector/GenesisDowntimeEntry.json (1)
1-12: Provide concise field descriptions and time format.Clarify what “duration” represents and how “time.Time” is encoded.
{ "Parameter": "duration", "Type": "Downtime", - "Description": "" + "Description": "Downtime enum indicating the outage length bucket." }, { "Parameter": "last_downtime", "Type": "time.Time", - "Description": "" + "Description": "Timestamp of the last occurrence of this downtime (RFC3339, UTC)." }source/json_tables/indexer_new/injective_megavault_rpc/UserStats.json (1)
1-17: Clarify numeric encoding for string fields.Amounts are strings; state they’re string-encoded decimals to avoid consumer confusion.
{ "Parameter": "current_amount", "Type": "string", - "Description": "Current subscribed amount in the vault" + "Description": "Current subscribed amount in the vault (string-encoded decimal)." }, { "Parameter": "current_lp_amount", "Type": "string", - "Description": "Current amount of LP tokens in the vault" + "Description": "Current amount of LP tokens in the vault (string-encoded decimal)." }source/json_tables/indexer_new/injective_megavault_rpc/PnlHistoryRequest.json (1)
1-20: LGTM; consider clarifying bounds and inclusivityLooks good. Optionally document whether "since" is inclusive/exclusive and typical bounds/defaults for "max_data_points" (e.g., max allowed).
source/json_tables/indexer_new/injective_megavault_rpc/Operator.json (1)
8-16: Descriptions OK; clarify units/denom for amountsTo avoid ambiguity, consider noting the unit/denom and formatting for amounts (e.g., base units vs human-readable decimals).
source/json_tables/indexer_new/injective_megavault_rpc/ListRedemptionsRequest.json (1)
21-25: Fill missing descriptions; verify pagination token optionalityAdd descriptions for "per_page" and "token". Also, confirm whether "token" is required for the first page.
{ "Parameter": "per_page", "Type": "int32", - "Description": "", + "Description": "Maximum number of items per page", "Required": "Yes" }, { "Parameter": "token", "Type": "string", - "Description": "", + "Description": "Page token for pagination", "Required": "Yes" }Also applies to: 27-31
source/json_tables/indexer_new/injective_megavault_rpc/TargetApr.json (2)
3-16: Clarify units/format for APR and thresholds.Please specify whether apr, upper_threshold, and lower_threshold are decimals (e.g., 0.12) or percentages (e.g., 12), and if they’re scaled (bps). This prevents misinterpretation by API consumers.
23-25: Standardize timestamp descriptions.Consider using “Updated at timestamp in UNIX millis.” to match the phrasing used elsewhere (e.g., “CreatedAt” vs “Created at”).
- "Description": "UpdatedAt timestamp in UNIX millis." + "Description": "Updated at timestamp in UNIX millis."source/json_tables/indexer_new/injective_auction_rpc/AuctionContract.json (1)
3-6: Fill missing description for id.Provide a concise description to avoid an empty cell in the generated docs.
- "Description": "" + "Description": "Auction identifier."source/json_tables/indexer_new/injective_megavault_rpc/Vault.json (1)
43-46: Polish description casing.Minor style nit: human-friendly description for target_apr.
- "Description": "TargetApr" + "Description": "Target APR"source/includes/_chainstream.md (12)
9-13: Grammar: “It’s” with apostrophe.Improve readability of intro text.
-Its possible to specify multiple filters to customize the stream. +It's possible to specify multiple filters to customize the stream.
97-201: Suppress MD010 for Go code block with tabs.markdownlint flags hard tabs in the Go example. Either replace tabs or disable the rule around the block.
-<!-- MARKDOWN-AUTO-DOCS:START (CODE:src=../../tmp-go-sdk/examples/chain/12_ChainStream/example.go) --> +<!-- markdownlint-disable MD010 --> +<!-- MARKDOWN-AUTO-DOCS:START (CODE:src=../../tmp-go-sdk/examples/chain/12_ChainStream/example.go) --> @@ -<!-- MARKDOWN-AUTO-DOCS:END --> +<!-- MARKDOWN-AUTO-DOCS:END --> +<!-- markdownlint-enable MD010 -->
218-219: Use headings instead of emphasis.markdownlint MD036: replace emphasis with proper headings for section titles.
-**BankBalancesFilter** +### BankBalancesFilter
226-227: Use headings instead of emphasis.-**SubaccountDepositsFilter** +### SubaccountDepositsFilter
234-235: Use headings instead of emphasis.-**TradesFilter** +### TradesFilter
243-244: Use headings instead of emphasis.-**OrdersFilter** +### OrdersFilter
252-253: Use headings instead of emphasis.-**OrderbookFilter** +### OrderbookFilter
260-261: Use headings instead of emphasis.-**PositionsFilter** +### PositionsFilter
269-270: Use headings instead of emphasis.-**OraclePriceFilter** +### OraclePriceFilter
298-299: Use headings instead of emphasis.-**BankBalance** +### BankBalance
281-287: Type name should be singular.In StreamResponse table, use “SubaccountDeposit array” (singular type).
-<tr ><td class="parameter-td td_text">subaccount_deposits</td><td class="type-td td_text">SubaccountDeposits array</td><td class="description-td td_text">list of subaccount deposits updates</td></tr> +<tr ><td class="parameter-td td_text">subaccount_deposits</td><td class="type-td td_text">SubaccountDeposit array</td><td class="description-td td_text">list of subaccount deposits updates</td></tr>
336-343: Consistent “human readable” notes.These are clear; ensure the generator consistently appends “(in human readable format)” for all decimal fields across v2 types.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (62)
Makefile(1 hunks)source/includes/_binaryoptions.md(1 hunks)source/includes/_chainexchange.md(1 hunks)source/includes/_chainstream.md(5 hunks)source/includes/_changelog.md(1 hunks)source/includes/_derivatives.md(4 hunks)source/json_tables/indexer_new/injective_auction_rpc/AccountAuctionV2.json(1 hunks)source/json_tables/indexer_new/injective_auction_rpc/AccountAuctionsV2Request.json(1 hunks)source/json_tables/indexer_new/injective_auction_rpc/AccountAuctionsV2Response.json(1 hunks)source/json_tables/indexer_new/injective_auction_rpc/Auction.json(1 hunks)source/json_tables/indexer_new/injective_auction_rpc/AuctionContract.json(1 hunks)source/json_tables/indexer_new/injective_auction_rpc/AuctionV2Request.json(1 hunks)source/json_tables/indexer_new/injective_auction_rpc/AuctionV2Response.json(1 hunks)source/json_tables/indexer_new/injective_auction_rpc/AuctionsHistoryV2Request.json(1 hunks)source/json_tables/indexer_new/injective_auction_rpc/AuctionsHistoryV2Response.json(1 hunks)source/json_tables/indexer_new/injective_auction_rpc/ClaimedAssets.json(1 hunks)source/json_tables/indexer_new/injective_derivative_exchange_rpc/DerivativeLimitOrderbookV2.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/Apr.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/AprStats.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/GetOperatorRedemptionBucketsRequest.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/GetOperatorRedemptionBucketsResponse.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/GetUserRequest.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/GetUserResponse.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/GetVaultRequest.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/HistoricalPnL.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/HistoricalTVL.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/Incentives.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/ListRedemptionsRequest.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/ListRedemptionsResponse.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/ListSubscriptionsRequest.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/ListSubscriptionsResponse.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/MaxDrawdown.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/Operator.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/Pnl.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/PnlHistoryRequest.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/PnlHistoryResponse.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/PnlStats.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/Redemption.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/RedemptionBucket.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/Subscription.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/TargetApr.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/TvlHistoryRequest.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/TvlHistoryResponse.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/UnrealizedPnl.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/User.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/UserStats.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/Vault.json(2 hunks)source/json_tables/indexer_new/injective_megavault_rpc/VaultStats.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/Volatility.json(1 hunks)source/json_tables/indexer_new/injective_megavault_rpc/VolatilityStats.json(1 hunks)source/json_tables/indexer_new/injective_spot_exchange_rpc/SpotLimitOrderbookV2.json(1 hunks)source/json_tables/injective/auction/Params.json(1 hunks)source/json_tables/injective/downtime-detector/GenesisDowntimeEntry.json(1 hunks)source/json_tables/injective/downtime-detector/GenesisState.json(1 hunks)source/json_tables/injective/downtime-detector/RecoveredSinceDowntimeOfLengthRequest.json(1 hunks)source/json_tables/injective/downtime-detector/RecoveredSinceDowntimeOfLengthResponse.json(1 hunks)source/json_tables/injective/downtimedetector/v1beta1/Downtime.json(1 hunks)source/json_tables/injective/exchange/PerpetualMarketFunding.json(1 hunks)source/json_tables/injective/exchange/v2/MsgCancelPostOnlyMode.json(1 hunks)source/json_tables/injective/exchange/v2/MsgSetDelegationTransferReceivers.json(1 hunks)source/json_tables/injective/exchange/v2/Params.json(1 hunks)source/json_tables/injective/exchange/v2/PerpetualMarketFunding.json(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
source/includes/_chainexchange.md
139-139: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
source/includes/_chainstream.md
221-221: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
246-246: Hard tabs
Column: 1
(MD010, no-hard-tabs)
247-247: Hard tabs
Column: 1
(MD010, no-hard-tabs)
248-248: Hard tabs
Column: 1
(MD010, no-hard-tabs)
249-249: Hard tabs
Column: 1
(MD010, no-hard-tabs)
250-250: Hard tabs
Column: 1
(MD010, no-hard-tabs)
252-252: Hard tabs
Column: 1
(MD010, no-hard-tabs)
253-253: Hard tabs
Column: 1
(MD010, no-hard-tabs)
255-255: Hard tabs
Column: 1
(MD010, no-hard-tabs)
256-256: Hard tabs
Column: 1
(MD010, no-hard-tabs)
257-257: Hard tabs
Column: 1
(MD010, no-hard-tabs)
258-258: Hard tabs
Column: 1
(MD010, no-hard-tabs)
262-262: Hard tabs
Column: 1
(MD010, no-hard-tabs)
263-263: Hard tabs
Column: 1
(MD010, no-hard-tabs)
264-264: Hard tabs
Column: 1
(MD010, no-hard-tabs)
265-265: Hard tabs
Column: 1
(MD010, no-hard-tabs)
266-266: Hard tabs
Column: 1
(MD010, no-hard-tabs)
268-268: Hard tabs
Column: 1
(MD010, no-hard-tabs)
269-269: Hard tabs
Column: 1
(MD010, no-hard-tabs)
270-270: Hard tabs
Column: 1
(MD010, no-hard-tabs)
271-271: Hard tabs
Column: 1
(MD010, no-hard-tabs)
272-272: Hard tabs
Column: 1
(MD010, no-hard-tabs)
273-273: Hard tabs
Column: 1
(MD010, no-hard-tabs)
274-274: Hard tabs
Column: 1
(MD010, no-hard-tabs)
275-275: Hard tabs
Column: 1
(MD010, no-hard-tabs)
276-276: Hard tabs
Column: 1
(MD010, no-hard-tabs)
278-278: Hard tabs
Column: 1
(MD010, no-hard-tabs)
279-279: Hard tabs
Column: 1
(MD010, no-hard-tabs)
280-280: Hard tabs
Column: 1
(MD010, no-hard-tabs)
282-282: Hard tabs
Column: 1
(MD010, no-hard-tabs)
283-283: Hard tabs
Column: 1
(MD010, no-hard-tabs)
284-284: Hard tabs
Column: 1
(MD010, no-hard-tabs)
285-285: Hard tabs
Column: 1
(MD010, no-hard-tabs)
286-286: Hard tabs
Column: 1
(MD010, no-hard-tabs)
288-288: Hard tabs
Column: 1
(MD010, no-hard-tabs)
289-289: Hard tabs
Column: 1
(MD010, no-hard-tabs)
290-290: Hard tabs
Column: 1
(MD010, no-hard-tabs)
292-292: Hard tabs
Column: 1
(MD010, no-hard-tabs)
294-294: Hard tabs
Column: 1
(MD010, no-hard-tabs)
295-295: Hard tabs
Column: 1
(MD010, no-hard-tabs)
296-296: Hard tabs
Column: 1
(MD010, no-hard-tabs)
297-297: Hard tabs
Column: 1
(MD010, no-hard-tabs)
298-298: Hard tabs
Column: 1
(MD010, no-hard-tabs)
299-299: Hard tabs
Column: 1
(MD010, no-hard-tabs)
300-300: Hard tabs
Column: 1
(MD010, no-hard-tabs)
302-302: Hard tabs
Column: 1
(MD010, no-hard-tabs)
303-303: Hard tabs
Column: 1
(MD010, no-hard-tabs)
305-305: Hard tabs
Column: 1
(MD010, no-hard-tabs)
306-306: Hard tabs
Column: 1
(MD010, no-hard-tabs)
307-307: Hard tabs
Column: 1
(MD010, no-hard-tabs)
308-308: Hard tabs
Column: 1
(MD010, no-hard-tabs)
310-310: Hard tabs
Column: 1
(MD010, no-hard-tabs)
311-311: Hard tabs
Column: 1
(MD010, no-hard-tabs)
313-313: Hard tabs
Column: 1
(MD010, no-hard-tabs)
314-314: Hard tabs
Column: 1
(MD010, no-hard-tabs)
315-315: Hard tabs
Column: 1
(MD010, no-hard-tabs)
316-316: Hard tabs
Column: 1
(MD010, no-hard-tabs)
317-317: Hard tabs
Column: 1
(MD010, no-hard-tabs)
318-318: Hard tabs
Column: 1
(MD010, no-hard-tabs)
319-319: Hard tabs
Column: 1
(MD010, no-hard-tabs)
320-320: Hard tabs
Column: 1
(MD010, no-hard-tabs)
321-321: Hard tabs
Column: 1
(MD010, no-hard-tabs)
322-322: Hard tabs
Column: 1
(MD010, no-hard-tabs)
323-323: Hard tabs
Column: 1
(MD010, no-hard-tabs)
324-324: Hard tabs
Column: 1
(MD010, no-hard-tabs)
325-325: Hard tabs
Column: 1
(MD010, no-hard-tabs)
337-337: Hard tabs
Column: 1
(MD010, no-hard-tabs)
338-338: Hard tabs
Column: 1
(MD010, no-hard-tabs)
340-340: Hard tabs
Column: 1
(MD010, no-hard-tabs)
341-341: Hard tabs
Column: 1
(MD010, no-hard-tabs)
342-342: Hard tabs
Column: 1
(MD010, no-hard-tabs)
343-343: Hard tabs
Column: 1
(MD010, no-hard-tabs)
368-368: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
399-399: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
source/includes/_derivatives.md
3517-3517: Hard tabs
Column: 1
(MD010, no-hard-tabs)
3792-3792: Hard tabs
Column: 1
(MD010, no-hard-tabs)
source/includes/_binaryoptions.md
319-319: Hard tabs
Column: 1
(MD010, no-hard-tabs)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: Redirect rules - injective-docs
- GitHub Check: test (3.2)
- GitHub Check: test (2.7)
- GitHub Check: Header rules - injective-docs
- GitHub Check: Pages changed - injective-docs
🔇 Additional comments (24)
source/json_tables/indexer_new/injective_megavault_rpc/Apr.json (1)
1-17: LGTM: valid JSON and clear structureSchema reads cleanly and matches the established table format.
source/json_tables/indexer_new/injective_megavault_rpc/GetVaultRequest.json (2)
1-8: LGTM for initial schema.Well-formed JSON; fields align with the typical Parameter/Type/Description/Required layout.
3-7: Megavault RPC docs consistently use snake_casevault_address, lowercase"string"and"Yes"for Required; no changes needed.source/json_tables/injective/exchange/PerpetualMarketFunding.json (1)
10-10: LGTM: clearer definition of cumulative_price.The time-integral description is precise and aligns with usage for interval averaging.
Please ensure the same wording is applied in v2 (source/json_tables/injective/exchange/v2/PerpetualMarketFunding.json) for consistency.
source/json_tables/indexer_new/injective_megavault_rpc/AprStats.json (1)
3-5: Confirm “Apr” type linkage.If “Apr” is a structured type (not a primitive), ensure Apr.json exists and is linked consistently across stats schemas.
source/includes/_binaryoptions.md (1)
319-319: LGTM: OracleScaleFactor updated to 0.Update matches chain/indexer changes.
source/includes/_derivatives.md (2)
3410-3411: Oracle scale factor set to 0 — looks good; confirm chain behaviorThe examples now use oracle_scale_factor=0. Please verify this matches chain v1.16.4 defaults across all launch flows (perpetual and expiry).
1254-1269: Field casing in examples (“Info” vs “info”) may be incorrectConfirm JSON key casing matches actual API (likely “info”).
source/json_tables/indexer_new/injective_spot_exchange_rpc/SpotLimitOrderbookV2.json (1)
21-25: LGTM: height added and clearly describedThe new height field mirrors the derivative orderbook change and is clearly documented.
source/json_tables/indexer_new/injective_derivative_exchange_rpc/DerivativeLimitOrderbookV2.json (1)
21-25: LGTM: height added and clearly describedMatches the spot orderbook schema update; description is clear.
Confirm whether any stream/WebSocket orderbook v2 schemas also expose height and need parallel updates.
source/json_tables/indexer_new/injective_auction_rpc/AccountAuctionsV2Response.json (1)
8-11: No changes needed — “next” should remain a string array
All Injective RPC responses (including AuctionsHistoryV2 and others) document “next” as a string array, so this is consistent with the rest of the API.source/includes/_chainexchange.md (2)
132-135: Verify request schema: shouldsubaccountbe part of the request?QuerySubaccountDepositsRequest usually needs just
subaccount_id. Including an embeddedSubaccountobject in the request is atypical. Please confirm against the v2 proto; if incorrect, remove from the request schema source so the generated table excludes it.
142-144: Subaccount table addition looks good.Field names and types align with common v2 schema conventions.
source/json_tables/indexer_new/injective_auction_rpc/AuctionV2Response.json (1)
1-7: LGTM.Schema clearly wraps Auction in a top-level response.
source/json_tables/indexer_new/injective_megavault_rpc/Volatility.json (1)
1-7: Clarify decimal string format and unitsUpdate the description to specify that “value” is encoded as a decimal string (ratio vs percentage), for example:
- "Type": "string", - "Description": "Volatility value" + "Type": "string", + "Description": "Volatility value as a decimal string (ratio), e.g., \"0.1234\" = 12.34%"Manually verify consistency with how other numeric fields are documented elsewhere in the repo.
source/json_tables/indexer_new/injective_megavault_rpc/ListSubscriptionsResponse.json (1)
1-12: Pagination field name and type are correct: “next” (string array) matches ListRedemptionsResponse.json and aligns with existing RPC conventions; no change required.source/json_tables/indexer_new/injective_megavault_rpc/PnlStats.json (1)
1-12: Verify referenced types exist (UnrealizedPnl, Pnl).Ensure these type tables are defined and published so cross-links render correctly.
Run:
source/json_tables/injective/downtimedetector/v1beta1/Downtime.json (1)
1-102: LGTM; confirm type of Code matches enum usage elsewhereLooks consistent and complete. Please verify whether "Code" should be numeric (int) or string to match how other enum tables in the docs are represented/consumed.
source/json_tables/indexer_new/injective_megavault_rpc/ListSubscriptionsRequest.json (1)
15-19: Fix incorrect/missing descriptions and verify pagination token optionality
- Change “status” description to “Status of the subscription”
- Set “per_page” description to “Maximum number of items per page”
- Set “token” description to “Page token for pagination” and confirm if it should be optional on the first request (if so, change Required to "No")
Apply to source/json_tables/indexer_new/injective_megavault_rpc/ListSubscriptionsRequest.json (lines 15-19, 21-25, 27-31):
{ "Parameter": "status", "Type": "string", - "Description": "Status of the redemption", + "Description": "Status of the subscription", "Required": "Yes" }, { "Parameter": "per_page", "Type": "int32", - "Description": "", + "Description": "Maximum number of items per page", "Required": "Yes" }, { "Parameter": "token", "Type": "string", - "Description": "", + "Description": "Page token for pagination", "Required": "Yes" }source/json_tables/indexer_new/injective_auction_rpc/AuctionContract.json (1)
23-26: Clarify units for max_user_allocation.Indicate currency/denom and whether it’s an absolute amount or percentage.
source/json_tables/indexer_new/injective_megavault_rpc/VaultStats.json (1)
33-51: LGTM. Verify referenced types exist.The cross-references to PnlStats, VolatilityStats, AprStats, and MaxDrawdown look correct; ensure these schema files are present and exported in this PR to avoid broken tables.
source/includes/_chainstream.md (3)
271-273: Grammar: pluralize “symbol”.Adjust description in the OraclePriceFilter schema to “list of symbols…”. Since this block is generated, fix the description in source JSON.
-<td class="description-td td_text">list of symbol to filter by</td> +<td class="description-td td_text">list of symbols to filter by</td>
318-323: Field naming consistency.SpotTrade shows executionType (camelCase) while other fields use snake_case. Confirm the intended casing in the v2 schema to avoid confusion.
466-470: Type path prefixes.Orderbook uses v2.Level array, while other tables reference exchange v2 under different roots. Confirm cross-links resolve correctly in the site build.
| COSMOS_SDK_VERSION := v0.50.13-evm-comet1-inj.6 | ||
| COSMOS_SDK_REPO := https://github.com/InjectiveLabs/cosmos-sdk.git | ||
|
|
||
| INJECTIVE_CORE_VERSION := v1.16.0 | ||
| INJECTIVE_CORE_VERSION := v1.16.4 | ||
| INJECTIVE_CORE_REPO := https://github.com/InjectiveLabs/injective-core.git | ||
|
|
||
| INDEXER_VERSION := v1.16.54 | ||
| INDEXER_VERSION := v1.16.91 | ||
| INDEXER_REPO := https://github.com/InjectiveLabs/injective-indexer.git | ||
|
|
||
| PYTHON_SDK_VERSION := v1.11.0 | ||
| PYTHON_SDK_VERSION := v1.11.2 | ||
| PYTHON_SDK_REPO := https://github.com/InjectiveLabs/sdk-python.git | ||
|
|
||
| GO_SDK_VERSION := v1.58.0 | ||
| GO_SDK_VERSION := v1.58.3 | ||
| GO_SDK_REPO := https://github.com/InjectiveLabs/sdk-go.git |
There was a problem hiding this comment.
🧩 Analysis chain
Version bumps LGTM; verify tags exist
Confirm these tags exist and are published.
🏁 Script executed:
#!/bin/bash
echo "Checking tags..."
for repo ver in \
"https://github.com/InjectiveLabs/cosmos-sdk.git v0.50.13-evm-comet1-inj.6" \
"https://github.com/InjectiveLabs/injective-core.git v1.16.4" \
"https://github.com/InjectiveLabs/injective-indexer.git v1.16.91" \
"https://github.com/InjectiveLabs/sdk-python.git v1.11.2" \
"https://github.com/InjectiveLabs/sdk-go.git v1.58.3"
do
set -- $repo $ver
doneLength of output: 123
🏁 Script executed:
#!/bin/bash
echo "Checking tags..."
repos=(
"https://github.com/InjectiveLabs/cosmos-sdk.git v0.50.13-evm-comet1-inj.6"
"https://github.com/InjectiveLabs/injective-core.git v1.16.4"
"https://github.com/InjectiveLabs/injective-indexer.git v1.16.91"
"https://github.com/InjectiveLabs/sdk-python.git v1.11.2"
"https://github.com/InjectiveLabs/sdk-go.git v1.58.3"
)
for entry in "${repos[@]}"; do
url=${entry% *}
tag=${entry##* }
echo -n " $tag in $url: "
if git ls-remote --exit-code --tags "$url" "refs/tags/$tag" >/dev/null 2>&1; then
echo "found"
else
echo "missing"
fi
doneLength of output: 386
Publish missing tags
injective-core v1.16.4 and injective-indexer v1.16.91 aren’t found in their GitHub repos. Ensure those tags are created or update the Makefile to reference existing versions.
🤖 Prompt for AI Agents
In Makefile around lines 2 to 15, the referenced tags injective-core v1.16.4 and
injective-indexer v1.16.91 do not exist in their GitHub repos; either create and
push those missing tags in the respective repos or update the Makefile to point
to valid, existing release tags (verify with git ls-remote or the GitHub
releases API), then update the INJECTIVE_CORE_VERSION and INDEXER_VERSION
variables to the confirmed tags and run the build to ensure the references
resolve.
| **SubaccountDeposits** | ||
|
|
||
| <!-- MARKDOWN-AUTO-DOCS:START (JSON_TO_HTML_TABLE:src=./source/json_tables/injective/stream/SubaccountDeposit.json) --> | ||
| <!-- MARKDOWN-AUTO-DOCS:START (JSON_TO_HTML_TABLE:src=./source/json_tables/injective/stream/v2/SubaccountDeposit.json) --> |
There was a problem hiding this comment.
Pluralization and missing descriptions.
- Section title should match the type SubaccountDeposit (singular).
- The table shows empty descriptions for denom and deposit; populate them in the source JSON.
-**SubaccountDeposits**
+### SubaccountDepositFollow-up: update source JSON (injective/stream/v2/SubaccountDeposit.json):
- denom: “token denomination”
- deposit: “Deposit balance details”
📝 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. Thoroughly test & benchmark the code to ensure it meets the requirements.
| **SubaccountDeposits** | |
| <!-- MARKDOWN-AUTO-DOCS:START (JSON_TO_HTML_TABLE:src=./source/json_tables/injective/stream/SubaccountDeposit.json) --> | |
| <!-- MARKDOWN-AUTO-DOCS:START (JSON_TO_HTML_TABLE:src=./source/json_tables/injective/stream/v2/SubaccountDeposit.json) --> | |
| ### SubaccountDeposit | |
| <!-- MARKDOWN-AUTO-DOCS:START (JSON_TO_HTML_TABLE:src=./source/json_tables/injective/stream/v2/SubaccountDeposit.json) --> |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
307-307: Hard tabs
Column: 1
(MD010, no-hard-tabs)
308-308: Hard tabs
Column: 1
(MD010, no-hard-tabs)
🤖 Prompt for AI Agents
In source/includes/_chainstream.md around lines 307 to 309, the section title is
incorrectly pluralized and the referenced JSON table has empty field
descriptions; change the heading from "SubaccountDeposits" to
"SubaccountDeposit" and update the source JSON file at
source/json_tables/injective/stream/v2/SubaccountDeposit.json to add
descriptions: set the denom field description to "token denomination" and the
deposit field description to "Deposit balance details", then regenerate or
ensure the markdown table is rebuilt from that JSON.
| "Parameter": "id", | ||
| "Type": "uint64", | ||
| "Description": "" | ||
| }, | ||
| { | ||
| "Parameter": "round", | ||
| "Type": "uint64", | ||
| "Description": "" | ||
| }, | ||
| { | ||
| "Parameter": "amount_deposited", | ||
| "Type": "string", | ||
| "Description": "" | ||
| }, | ||
| { | ||
| "Parameter": "is_claimable", | ||
| "Type": "bool", | ||
| "Description": "Whether the auction rewards can be claimed." | ||
| }, | ||
| { | ||
| "Parameter": "claimed_assets", | ||
| "Type": "ClaimedAssets array", | ||
| "Description": "" | ||
| } |
There was a problem hiding this comment.
Fill missing descriptions and align terminology
Several descriptions are empty, which degrades the docs. Propose concise, informative text.
{
"Parameter": "id",
"Type": "uint64",
- "Description": ""
+ "Description": "Unique identifier of the account’s auction participation."
},
{
"Parameter": "round",
"Type": "uint64",
- "Description": ""
+ "Description": "Auction round number."
},
{
"Parameter": "amount_deposited",
"Type": "string",
- "Description": ""
+ "Description": "Amount deposited by the account (string‑encoded)."
},
{
"Parameter": "is_claimable",
"Type": "bool",
"Description": "Whether the auction rewards can be claimed."
},
{
"Parameter": "claimed_assets",
"Type": "ClaimedAssets array",
- "Description": ""
+ "Description": "List of assets already claimed by the account."
}Also ensure the request type for round matches this file (see note in AuctionV2Request.json).
📝 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. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "Parameter": "id", | |
| "Type": "uint64", | |
| "Description": "" | |
| }, | |
| { | |
| "Parameter": "round", | |
| "Type": "uint64", | |
| "Description": "" | |
| }, | |
| { | |
| "Parameter": "amount_deposited", | |
| "Type": "string", | |
| "Description": "" | |
| }, | |
| { | |
| "Parameter": "is_claimable", | |
| "Type": "bool", | |
| "Description": "Whether the auction rewards can be claimed." | |
| }, | |
| { | |
| "Parameter": "claimed_assets", | |
| "Type": "ClaimedAssets array", | |
| "Description": "" | |
| } | |
| { | |
| "Parameter": "id", | |
| "Type": "uint64", | |
| "Description": "Unique identifier of the account’s auction participation." | |
| }, | |
| { | |
| "Parameter": "round", | |
| "Type": "uint64", | |
| "Description": "Auction round number." | |
| }, | |
| { | |
| "Parameter": "amount_deposited", | |
| "Type": "string", | |
| "Description": "Amount deposited by the account (string-encoded)." | |
| }, | |
| { | |
| "Parameter": "is_claimable", | |
| "Type": "bool", | |
| "Description": "Whether the auction rewards can be claimed." | |
| }, | |
| { | |
| "Parameter": "claimed_assets", | |
| "Type": "ClaimedAssets array", | |
| "Description": "List of assets already claimed by the account." | |
| } |
| "Parameter": "current_slots", | ||
| "Type": "uint64", | ||
| "Description": "Total slots of the auction" | ||
| }, | ||
| { | ||
| "Parameter": "total_slots", | ||
| "Type": "uint64", | ||
| "Description": "Total slots of the auction" | ||
| }, |
There was a problem hiding this comment.
Fix mismatch in slots descriptions.
current_slots should not have the same description as total_slots.
- "Description": "Total slots of the auction"
+ "Description": "Current filled slots of the auction"
@@
- "Description": "Total slots of the auction"
+ "Description": "Total available slots of the auction"📝 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. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "Parameter": "current_slots", | |
| "Type": "uint64", | |
| "Description": "Total slots of the auction" | |
| }, | |
| { | |
| "Parameter": "total_slots", | |
| "Type": "uint64", | |
| "Description": "Total slots of the auction" | |
| }, | |
| "Parameter": "current_slots", | |
| "Type": "uint64", | |
| "Description": "Current filled slots of the auction" | |
| }, | |
| { | |
| "Parameter": "total_slots", | |
| "Type": "uint64", | |
| "Description": "Total available slots of the auction" | |
| }, |
🤖 Prompt for AI Agents
In source/json_tables/indexer_new/injective_auction_rpc/AuctionContract.json
around lines 13 to 21, the "Description" for "current_slots" incorrectly
duplicates the "total_slots" text; update the "current_slots" description to
reflect its actual meaning (e.g., indicate current filled or available slots in
the auction such as "Number of slots currently filled" or "Number of slots
currently allocated") so it differs from "total_slots" which should remain
"Total slots of the auction".
| "Parameter": "round", | ||
| "Type": "int64", | ||
| "Description": "The auction round number.", | ||
| "Required": "Yes" | ||
| } |
There was a problem hiding this comment.
Type mismatch with AccountAuctionV2.round (uint64 vs int64)
AccountAuctionV2.json defines round as uint64, but this request uses int64. Align types to avoid client confusion and codegen inconsistencies.
{
"Parameter": "round",
- "Type": "int64",
+ "Type": "uint64",
"Description": "The auction round number.",
"Required": "Yes"
}📝 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. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "Parameter": "round", | |
| "Type": "int64", | |
| "Description": "The auction round number.", | |
| "Required": "Yes" | |
| } | |
| { | |
| "Parameter": "round", | |
| "Type": "uint64", | |
| "Description": "The auction round number.", | |
| "Required": "Yes" | |
| } |
🤖 Prompt for AI Agents
In source/json_tables/indexer_new/injective_auction_rpc/AuctionV2Request.json
around lines 3 to 7, the "Type" for the "round" parameter is declared as "int64"
while AccountAuctionV2.json uses "uint64"; change the "Type" to "uint64" to
match AccountAuctionV2.round, ensure the "Description" and "Required" fields
remain accurate, and scan other related request/response schema files for any
similar mismatches; after updating, run the schema validation/codegen and tests
to confirm no downstream breakage.
| "Parameter": "redemptions", | ||
| "Type": "Redemption array", | ||
| "Description": "List of subscriptions" | ||
| }, |
There was a problem hiding this comment.
Correct description: "subscriptions" → "redemptions"
{
"Parameter": "redemptions",
"Type": "Redemption array",
- "Description": "List of subscriptions"
+ "Description": "List of redemptions"
},📝 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. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "Parameter": "redemptions", | |
| "Type": "Redemption array", | |
| "Description": "List of subscriptions" | |
| }, | |
| { | |
| "Parameter": "redemptions", | |
| "Type": "Redemption array", | |
| "Description": "List of redemptions" | |
| }, |
🤖 Prompt for AI Agents
In
source/json_tables/indexer_new/injective_megavault_rpc/ListRedemptionsResponse.json
around lines 3 to 6, the "Description" currently reads "List of subscriptions"
but should describe redemptions; change the Description value to "List of
redemptions" (or similar wording like "Array of redemptions") so it correctly
reflects the Parameter "redemptions".
| [ | ||
| { | ||
| "Parameter": "value", | ||
| "Type": "string", | ||
| "Description": "Max drawdown value" | ||
| }, | ||
| { | ||
| "Parameter": "latest_pn_l_peak", | ||
| "Type": "string", | ||
| "Description": "Latest PnL peak" | ||
| } | ||
| ] |
There was a problem hiding this comment.
Probable typo in field name: use latest_pnl_peak (not latest_pn_l_peak).
The underscore split suggests “pnl” got split as “pn_l”. This will mislead API consumers.
Apply:
[
{
"Parameter": "value",
"Type": "string",
- "Description": "Max drawdown value"
+ "Description": "Max drawdown value (string-encoded decimal)."
},
{
- "Parameter": "latest_pn_l_peak",
+ "Parameter": "latest_pnl_peak",
"Type": "string",
- "Description": "Latest PnL peak"
+ "Description": "Latest PnL peak (string-encoded decimal)."
}
]📝 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. Thoroughly test & benchmark the code to ensure it meets the requirements.
| [ | |
| { | |
| "Parameter": "value", | |
| "Type": "string", | |
| "Description": "Max drawdown value" | |
| }, | |
| { | |
| "Parameter": "latest_pn_l_peak", | |
| "Type": "string", | |
| "Description": "Latest PnL peak" | |
| } | |
| ] | |
| [ | |
| { | |
| "Parameter": "value", | |
| "Type": "string", | |
| "Description": "Max drawdown value (string-encoded decimal)." | |
| }, | |
| { | |
| "Parameter": "latest_pnl_peak", | |
| "Type": "string", | |
| "Description": "Latest PnL peak (string-encoded decimal)." | |
| } | |
| ] |
🤖 Prompt for AI Agents
In source/json_tables/indexer_new/injective_megavault_rpc/MaxDrawdown.json
around lines 1 to 12, the field name "latest_pn_l_peak" is a typo and should be
"latest_pnl_peak"; update the JSON key accordingly, keep the Type and
Description intact (or adjust Description to "Latest PnL peak" if needed), and
then search and update any code, schema references, tests, or docs that consume
this JSON to use "latest_pnl_peak" to maintain consistency.
| "Parameter": "status", | ||
| "Type": "string", | ||
| "Description": "Status of the subscription" | ||
| }, |
There was a problem hiding this comment.
Fix copy errors: references to subscription should be redemption
Several descriptions incorrectly say "subscription".
{
"Parameter": "status",
"Type": "string",
- "Description": "Status of the subscription"
+ "Description": "Status of the redemption"
},
{
"Parameter": "created_height",
"Type": "int64",
- "Description": "Block height when the subscription was created."
+ "Description": "Block height when the redemption was created."
},
{
"Parameter": "executed_height",
"Type": "int64",
- "Description": "Block height when the subscription was executed."
+ "Description": "Block height when the redemption was executed."
},Also applies to: 38-41, 48-51
🤖 Prompt for AI Agents
In source/json_tables/indexer_new/injective_megavault_rpc/Redemption.json around
lines 28-31 (and similarly at 38-41 and 48-51), the Description fields
incorrectly refer to "subscription"; update those descriptions to say
"redemption" instead, ensuring the wording matches the schema context (e.g.,
"Status of the redemption" and any other instances replace "subscription" with
"redemption").
| "Parameter": "updated_height", | ||
| "Type": "int64", | ||
| "Description": "Block height when the vault was updated." | ||
| }, |
There was a problem hiding this comment.
Correct description: vault vs user
"updated_height" description should reference the user, not the vault.
{
"Parameter": "updated_height",
"Type": "int64",
- "Description": "Block height when the vault was updated."
+ "Description": "Block height when the user was updated."
},📝 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. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "Parameter": "updated_height", | |
| "Type": "int64", | |
| "Description": "Block height when the vault was updated." | |
| }, | |
| { | |
| "Parameter": "updated_height", | |
| "Type": "int64", | |
| "Description": "Block height when the user was updated." | |
| }, |
🤖 Prompt for AI Agents
In source/json_tables/indexer_new/injective_megavault_rpc/User.json around lines
18 to 21, the Description for "updated_height" incorrectly refers to the vault;
change the wording to reference the user instead (e.g., "Block height when the
user was updated.") so the field description correctly describes the user update
height.
| "Parameter": "stats", | ||
| "Type": "VaultStats", | ||
| "Description": "Operators" | ||
| }, |
There was a problem hiding this comment.
Fix copy/paste description for stats.
Description says “Operators” but the field is stats: Vault statistics.
- "Description": "Operators"
+ "Description": "Vault statistics"📝 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. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "Parameter": "stats", | |
| "Type": "VaultStats", | |
| "Description": "Operators" | |
| }, | |
| "Parameter": "stats", | |
| "Type": "VaultStats", | |
| "Description": "Vault statistics" | |
| }, |
🤖 Prompt for AI Agents
In source/json_tables/indexer_new/injective_megavault_rpc/Vault.json around
lines 48 to 51, the "Description" for the "stats" parameter is incorrect
("Operators"); update the description to accurately describe the field (e.g.,
"Vault statistics" or a slightly more detailed phrase like "Statistics for the
vault (balances, counts, etc.)"). Ensure the new description is concise and
matches the schema's style and punctuation.
Summary by CodeRabbit
Documentation
Chores