Common Types

Overview

This is a collection of types which are commonly used in Astroport contracts.

Links

• Github: https://github.com/astroport-fi/astroport-core/tree/main/packages/astroport
• asset.rs: https://github.com/astroport-fi/astroport-core/blob/main/packages/astroport/src/asset.rs
• common.rs https://github.com/astroport-fi/astroport-core/blob/main/packages/astroport/src/common.rs

Data Types

AssetInfo

AssetInfo is a convenience wrapper to represent whether a token is the native one (from a specific chain, like LUNA for Terra) or not. It also returns the contract address of that token.

asset.rs

_4

pub enum AssetInfo {

_4

Token { contract_addr: Addr },

_4

NativeToken { denom: String },

_4

}

Variants	Description
Token	Non-native Token
NativeToken	Native token

Asset

This enum contains asset info and a token amount.

json

asset.rs

_8

{

_8

"info": {

_8

"token": {

_8

"contract_addr": "..."

_8

}

_8

},

_8

"amount": "100000"

_8

}

Params	Type	Description
info	AssetInfo	Information about an asset stored in a [AssetInfo] struct
amount	Uint128	A token amount

DecimalAsset

This struct describes an asset as decimal.

json

asset.rs

_8

{

_8

"info": {

_8

"token": {

_8

"contract_addr": "..."

_8

}

_8

},

_8

"amount": "0.12345"

_8

}

Params	Type	Description
info	AssetInfo	Information about an asset stored in a [AssetInfo] struct
amount	Decimal256	A token decimal amount

PairInfo

It is used to represent response data coming from a Pair-Info-Querier.

json

asset.rs

_19

{

_19

"asset_infos": [

_19

{

_19

"token": {

_19

"contract_addr": "..."

_19

}

_19

},

_19

{

_19

"native_token": {

_19

"denom": "..."

_19

}

_19

}

_19

],

_19

"contract_addr": "...",

_19

"liquidity_token": "...",

_19

"pair_type": {

_19

"xyk": {}

_19

}

_19

}

Params	Type	Description
asset_infos	Vec<AssetInfo>	Asset information for the assets in the pool
contract_addr	Addr	Pair contract address
liquidity_token	Addr	Pair LP token address
pair_type	PairType	The pool type (xyk, stableswap, etc) available in [PairType]

OwnershipProposal

This structure describes the parameters used for creating a request for a change of contract ownership.

json

common.rs

_4

{

_4

"owner": "...",

_4

"ttl": 123456

_4

}

Params	Type	Description
owner	Addr	The newly proposed contract owner
ttl	u64	Time until the proposal to change ownership expires