-
Notifications
You must be signed in to change notification settings - Fork 5
chore: chain v1.20.3 release #188
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| [ | ||
| { | ||
| "Parameter": "market_id", | ||
| "Type": "string", | ||
| "Description": "DerivativeMarket ID is crypto.Keccak256Hash([]byte((oracleType.String() + ticker + quoteDenom + oracleBase + oracleQuote))) for perpetual markets and crypto.Keccak256Hash([]byte((oracleType.String() + ticker + quoteDenom + oracleBase + oracleQuote + strconv.Itoa(int(expiry))))) for expiry futures markets" | ||
| }, | ||
| { | ||
| "Parameter": "market_status", | ||
| "Type": "string", | ||
| "Description": "The status of the market" | ||
| }, | ||
| { | ||
| "Parameter": "ticker", | ||
| "Type": "string", | ||
| "Description": "A name of the pair in format AAA/BBB, where AAA is base asset, BBB is quote asset." | ||
| }, | ||
| { | ||
| "Parameter": "oracle_base", | ||
| "Type": "string", | ||
| "Description": "Oracle base currency" | ||
| }, | ||
| { | ||
| "Parameter": "oracle_quote", | ||
| "Type": "string", | ||
| "Description": "Oracle quote currency" | ||
| }, | ||
| { | ||
| "Parameter": "oracle_type", | ||
| "Type": "string", | ||
| "Description": "Oracle Type" | ||
| }, | ||
| { | ||
| "Parameter": "oracle_scale_factor", | ||
| "Type": "uint32", | ||
| "Description": "OracleScaleFactor" | ||
| }, | ||
| { | ||
| "Parameter": "initial_margin_ratio", | ||
| "Type": "string", | ||
| "Description": "Defines the initial margin ratio of a derivative market" | ||
| }, | ||
| { | ||
| "Parameter": "maintenance_margin_ratio", | ||
| "Type": "string", | ||
| "Description": "Defines the maintenance margin ratio of a derivative market" | ||
| }, | ||
| { | ||
| "Parameter": "quote_denom", | ||
| "Type": "string", | ||
| "Description": "Coin denom used for the quote asset." | ||
| }, | ||
| { | ||
| "Parameter": "quote_token_meta", | ||
| "Type": "TokenMeta", | ||
| "Description": "Token metadata for quote asset" | ||
| }, | ||
| { | ||
| "Parameter": "maker_fee_rate", | ||
| "Type": "string", | ||
| "Description": "Defines the fee percentage makers pay when trading (in quote asset)" | ||
| }, | ||
| { | ||
| "Parameter": "taker_fee_rate", | ||
| "Type": "string", | ||
| "Description": "Defines the fee percentage takers pay when trading (in quote asset)" | ||
| }, | ||
| { | ||
| "Parameter": "service_provider_fee", | ||
| "Type": "string", | ||
| "Description": "Percentage of the transaction fee shared with the service provider" | ||
| }, | ||
| { | ||
| "Parameter": "is_perpetual", | ||
| "Type": "bool", | ||
| "Description": "True if the market is a perpetual swap market" | ||
| }, | ||
| { | ||
| "Parameter": "min_price_tick_size", | ||
| "Type": "string", | ||
| "Description": "Defines the minimum required tick size for the order's price" | ||
| }, | ||
| { | ||
| "Parameter": "min_quantity_tick_size", | ||
| "Type": "string", | ||
| "Description": "Defines the minimum required tick size for the order's quantity" | ||
| }, | ||
| { | ||
| "Parameter": "perpetual_market_info", | ||
| "Type": "PerpetualMarketInfo", | ||
| "Description": "" | ||
| }, | ||
| { | ||
| "Parameter": "perpetual_market_funding", | ||
| "Type": "PerpetualMarketFunding", | ||
| "Description": "" | ||
| }, | ||
| { | ||
| "Parameter": "expiry_futures_market_info", | ||
| "Type": "ExpiryFuturesMarketInfo", | ||
| "Description": "" | ||
| }, | ||
| { | ||
| "Parameter": "min_notional", | ||
| "Type": "string", | ||
| "Description": "Minimum notional value for the order" | ||
| }, | ||
| { | ||
| "Parameter": "reduce_margin_ratio", | ||
| "Type": "string", | ||
| "Description": "Defines the reduce margin ratio of a derivative market" | ||
| }, | ||
| { | ||
| "Parameter": "open_notional_cap", | ||
| "Type": "OpenNotionalCap", | ||
| "Description": "The open notional cap of the market, if any" | ||
| } | ||
| ] |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| [ | ||
| { | ||
| "Parameter": "expiration_timestamp", | ||
| "Type": "int64", | ||
| "Description": "Defines the expiration time for a time expiry futures market in UNIX seconds." | ||
| }, | ||
| { | ||
| "Parameter": "settlement_price", | ||
| "Type": "string", | ||
| "Description": "Defines the settlement price for a time expiry futures market." | ||
| } | ||
| ] |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| [ | ||
| { | ||
| "Parameter": "market_status", | ||
| "Type": "string", | ||
| "Description": "Filter by market status", | ||
| "Required": "Yes" | ||
| }, | ||
| { | ||
| "Parameter": "quote_denom", | ||
| "Type": "string", | ||
| "Description": "Filter by the Coin denomination of the quote currency", | ||
| "Required": "Yes" | ||
| }, | ||
| { | ||
| "Parameter": "market_statuses", | ||
| "Type": "string array", | ||
| "Description": "Filter by multiple market statuses", | ||
| "Required": "Yes" | ||
| }, | ||
| { | ||
| "Parameter": "market_ids", | ||
| "Type": "string array", | ||
| "Description": "", | ||
| "Required": "Yes" | ||
| }, | ||
| { | ||
| "Parameter": "per_page", | ||
| "Type": "int32", | ||
| "Description": "Number of results per page", | ||
| "Required": "Yes" | ||
| }, | ||
| { | ||
| "Parameter": "token", | ||
| "Type": "string", | ||
| "Description": "Pagination token", | ||
| "Required": "Yes" | ||
| } | ||
| ] | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| [ | ||
| { | ||
| "Parameter": "markets", | ||
| "Type": "DerivativeMarketInfo array", | ||
| "Description": "Derivative Markets list" | ||
| }, | ||
| { | ||
| "Parameter": "next", | ||
| "Type": "string array", | ||
| "Description": "Next tokens for pagination" | ||
| } | ||
| ] |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| [ | ||
| { | ||
| "Parameter": "cap", | ||
| "Type": "string", | ||
| "Description": "The open notional cap of the market" | ||
| } | ||
| ] |
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,22 @@ | ||||||||||||||
| [ | ||||||||||||||
| { | ||||||||||||||
| "Parameter": "cumulative_funding", | ||||||||||||||
| "Type": "string", | ||||||||||||||
| "Description": "Defines the cumulative funding of a perpetual market." | ||||||||||||||
| }, | ||||||||||||||
| { | ||||||||||||||
| "Parameter": "cumulative_price", | ||||||||||||||
| "Type": "string", | ||||||||||||||
| "Description": "Defines defines the cumulative price for the current hour up to the last timestamp." | ||||||||||||||
|
Comment on lines
+8
to
+10
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win Fix the duplicated word in Line 10 renders “Defines defines”; change it to “Defines the cumulative price...” before generating the reference docs. 📝 Proposed fix- "Description": "Defines defines the cumulative price for the current hour up to the last timestamp."
+ "Description": "Defines the cumulative price for the current hour up to the last timestamp."📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||
| }, | ||||||||||||||
| { | ||||||||||||||
| "Parameter": "last_timestamp", | ||||||||||||||
| "Type": "int64", | ||||||||||||||
| "Description": "Defines the last funding timestamp in seconds of a perpetual market in UNIX seconds." | ||||||||||||||
| }, | ||||||||||||||
| { | ||||||||||||||
| "Parameter": "last_funding_rate", | ||||||||||||||
| "Type": "string", | ||||||||||||||
| "Description": "Defines the last funding rate of a perpetual market." | ||||||||||||||
| } | ||||||||||||||
| ] | ||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,22 @@ | ||||||||||||||
| [ | ||||||||||||||
| { | ||||||||||||||
| "Parameter": "hourly_funding_rate_cap", | ||||||||||||||
| "Type": "string", | ||||||||||||||
| "Description": "Defines the default maximum absolute value of the hourly funding rate of the perpetual market." | ||||||||||||||
| }, | ||||||||||||||
| { | ||||||||||||||
| "Parameter": "hourly_interest_rate", | ||||||||||||||
| "Type": "string", | ||||||||||||||
| "Description": "Defines the hourly interest rate of the perpetual market." | ||||||||||||||
| }, | ||||||||||||||
| { | ||||||||||||||
| "Parameter": "next_funding_timestamp", | ||||||||||||||
| "Type": "int64", | ||||||||||||||
| "Description": "Defines the next funding timestamp in seconds of a perpetual market in UNIX seconds." | ||||||||||||||
| }, | ||||||||||||||
| { | ||||||||||||||
| "Parameter": "funding_interval", | ||||||||||||||
| "Type": "int64", | ||||||||||||||
| "Description": "Defines the funding interval in seconds of a perpetual market in seconds." | ||||||||||||||
|
Comment on lines
+18
to
+20
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win Remove the duplicated unit phrase in Line 20 says “in seconds ... in seconds”; simplify it to “Defines the funding interval of a perpetual market in seconds.” 📝 Proposed fix- "Description": "Defines the funding interval in seconds of a perpetual market in seconds."
+ "Description": "Defines the funding interval of a perpetual market in seconds."📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||
| } | ||||||||||||||
| ] | ||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Document
market_ids.Line 23 is empty, so consumers cannot tell what the array filters. Add a description such as “Filter by market IDs.”
📝 Proposed fix
"Parameter": "market_ids", "Type": "string array", - "Description": "", + "Description": "Filter by market IDs", "Required": "Yes"📝 Committable suggestion
🤖 Prompt for AI Agents