base

Chain-agnostic logics for the Oracle contract.

Links

• Contract repo: https://github.com/mars-protocol/outposts/tree/master/contracts/oracle/base
• Audits: https://github.com/mars-protocol/mars-audits/tree/main/red-bank

InstantiateMsg

json

oracle.rs

_4

{

_4

"owner": "...",

_4

"base_denom": "..."

_4

}

Params	Type	Description
owner	String	The contract's owner, who can update config and price sources
base_denom	String	The asset in which prices are denominated in

ExecuteMsg

set_price_source

Specifies the price source to be used for a coin.

NOTE

The input parameters for method are chain-specific.

json

oracle.rs

_8

{

_8

"set_price_source": {

_8

"denom": "...",

_8

"price_source": {

_8

// PriceSource (chain-specific)

_8

}

_8

}

_8

}

Params	Type	Description
denom	String	Denom of the asset
price_source	T	Coin's price source. See OsmosisPriceSource for an example of a chain specific integration.

remove_price_source

Removes price source for a coin.

json

oracle.rs

_5

{

_5

"remove_price_source": {

_5

"denom": "..."

_5

}

_5

}

Params	Type	Description
denom	String	Denom of the asset

update_owner

Manages admin role state.

json

address_provider.rs

_7

{

_7

"update_owner": {

_7

"propose_new_owner": {

_7

"proposed": "..."

_7

}

_7

}

_7

}

QueryMsg

config

Queries contract config.

json

oracle.rs

_3

{

_3

"config": {}

_3

}

Returns a Config<String> response.

price_source

Queries a coin's price source.

NOTE

The response type of this query is chain-specific.

json

oracle.rs

_5

{

_5

"price_source": {

_5

"denom": "..."

_5

}

_5

}

Params	Type	Description
denom	String	Denom of the asset

PriceSourceResponse<String>

json

oracle.rs

_6

{

_6

"denom": "...",

_6

"price_source": {

_6

// PriceSource (chain-specific)

_6

}

_6

}

Params	Type	Description
denom	String	Denom of the asset
price_source	T	Coin's price source. See OsmosisPriceSource for an example of a chain specific integration.

price_sources

Enumerates all coins' price sources.

NOTE

The response type of this query is chain-specific.

json

oracle.rs

_6

{

_6

"price_sources": {

_6

"start_after": "...",

_6

"limit": 5

_6

}

_6

}

Params	Type	Description
start_after	Option<String>	Denom to start after.
limit	Option<u32>	Amount of price sources to list.

Returns a vector that contains objects of type PriceSourceResponse<String>.

price

Queries a coin's price.

NOTE

This query may be dependent on block time (e.g. if the price source is TWAP), so may not work properly with time travel queries on archive nodes.

json

oracle.rs

_5

{

_5

"price": {

_5

"denom": "..."

_5

}

_5

}

Params	Type	Description
denom	String	Denom of the asset

PriceResponse

json

oracle.rs

_4

{

_4

"denom": "...",

_4

"price": "1.27"

_4

}

Params	Type	Description
denom	String	Denom of the asset
price	Decimal	Price of the asset

prices

Enumerates all coins' prices.

NOTE

This query may be dependent on block time (e.g. if the price source is TWAP), so may not work properly with time travel queries on archive nodes.

json

oracle.rs

_6

{

_6

"prices": {

_6

"start_after": "...",

_6

"limit": 5

_6

}

_6

}

Params	Type	Description
start_after	Option<String>	Price to start after.
limit	Option<u32>	Amount of prices to list.

Returns a vector that contains objects of type PriceResponse.