v0_9

Documentation

Index

• Constants
• type CurrentPrice
  • func NewCurrentPrice(marketID string, price sdk.Dec) CurrentPrice
  • func (cp CurrentPrice) String() string
• type CurrentPrices
• type GenesisState
  • func NewGenesisState(p Params, pp []PostedPrice) GenesisState
• type Market
  • func (m Market) String() string
  • func (m Market) Validate() error
• type Markets
  • func (ms Markets) String() string
  • func (ms Markets) Validate() error
• type Params
• type PostedPrice
  • func NewPostedPrice(marketID string, oracle sdk.AccAddress, price sdk.Dec, expiry time.Time) PostedPrice
  • func (pp PostedPrice) String() string
  • func (pp PostedPrice) Validate() error
• type PostedPrices
  • func (ps PostedPrices) String() string
  • func (pps PostedPrices) Validate() error

Constants

const (
	ModuleName = "pricefeed"
)

Types

type CurrentPrice

type CurrentPrice struct {
	MarketID string  `json:"market_id" yaml:"market_id"`
	Price    sdk.Dec `json:"price" yaml:"price"`
}

CurrentPrice struct that contains the metadata of a current price for a particular market in the pricefeed module.

func NewCurrentPrice

func NewCurrentPrice(marketID string, price sdk.Dec) CurrentPrice

NewCurrentPrice returns an instance of CurrentPrice

func (CurrentPrice) String

func (cp CurrentPrice) String() string

implement fmt.Stringer

type CurrentPrices

type CurrentPrices []CurrentPrice

CurrentPrices type for an array of CurrentPrice

type GenesisState

type GenesisState struct {
	Params       Params       `json:"params" yaml:"params"`
	PostedPrices PostedPrices `json:"posted_prices" yaml:"posted_prices"`
}

GenesisState - pricefeed state that must be provided at genesis

func NewGenesisState

func NewGenesisState(p Params, pp []PostedPrice) GenesisState

NewGenesisState creates a new genesis state for the pricefeed module

type Market

type Market struct {
	// TODO: rename to ID
	MarketID   string           `json:"market_id" yaml:"market_id"`
	BaseAsset  string           `json:"base_asset" yaml:"base_asset"`
	QuoteAsset string           `json:"quote_asset" yaml:"quote_asset"`
	Oracles    []sdk.AccAddress `json:"oracles" yaml:"oracles"`
	Active     bool             `json:"active" yaml:"active"`
}

func (Market) String

func (m Market) String() string

String implement fmt.Stringer

func (Market) Validate

func (m Market) Validate() error

Validate performs a basic validation of the market params

type Markets

type Markets []Market

Markets array type for oracle

func (Markets) String

func (ms Markets) String() string

String implements fmt.Stringer

func (Markets) Validate

func (ms Markets) Validate() error

Validate checks if all the markets are valid and there are no duplicated entries.

type Params

type Params struct {
	Markets Markets `json:"markets" yaml:"markets"` //  Array containing the markets supported by the pricefeed
}

type PostedPrice

type PostedPrice struct {
	MarketID      string         `json:"market_id" yaml:"market_id"`
	OracleAddress sdk.AccAddress `json:"oracle_address" yaml:"oracle_address"`
	Price         sdk.Dec        `json:"price" yaml:"price"`
	Expiry        time.Time      `json:"expiry" yaml:"expiry"`
}

PostedPrice price for market posted by a specific oracle

func NewPostedPrice

func NewPostedPrice(marketID string, oracle sdk.AccAddress, price sdk.Dec, expiry time.Time) PostedPrice

NewPostedPrice returns a new PostedPrice

func (PostedPrice) String

func (pp PostedPrice) String() string

implement fmt.Stringer

func (PostedPrice) Validate

func (pp PostedPrice) Validate() error

Validate performs a basic check of a PostedPrice params.

type PostedPrices

type PostedPrices []PostedPrice

PostedPrices type for an array of PostedPrice

func (PostedPrices) String

func (ps PostedPrices) String() string

String implements fmt.Stringer

func (PostedPrices) Validate

func (pps PostedPrices) Validate() error

Validate checks if all the posted prices are valid and there are no duplicated entries.