AssetIdentifier

API documentation for tradeexecutor.state.identifier.AssetIdentifier Python class in Trading Strategy framework.

class AssetIdentifier

Bases: object

Identify a blockchain asset for trade execution.

This is pass-by-copy (as opposite to pass-by-reference) asset identifier we use across the persistent state. Because we copy a lot of information about asset, not just its id, this makes data reads and diagnosing problems simpler.

As internal token_ids and pair_ids may be unstable, trading pairs and tokens are explicitly referred by their smart contract addresses when a strategy decision moves to the execution. We duplicate data here to make sure we have a persistent record that helps to diagnose the sisues.

__init__(chain_id, address, token_symbol, decimals, internal_id=None, info_url=None, underlying=None, type=None, liquidation_threshold=None)

Parameters:

• chain_id (int) –

• address (str) –

• token_symbol (str) –

• decimals (int) –

• internal_id (Optional[int]) –

• info_url (Optional[str]) –

• underlying (Optional[AssetIdentifier]) –

• type (Optional[AssetType]) –

• liquidation_threshold (float | None) –

Return type:

None

Methods

__init__(chain_id, address, token_symbol, ...)
convert_to_decimal(raw_amount)
convert_to_raw_amount(amount)	Return any amount in token native units.
from_dict(kvs, *[, infer_missing])
from_json(s, *[, parse_float, parse_int, ...])
get_identifier()	Assets are identified by their smart contract address.
get_pricing_asset()	Get the asset that delivers price for this asset.
is_credit()	Is this a credit asset that accrue interest for us
is_debt()	Is this a credit asset that accrue interest for us
is_interest_accruing()	Will this token gain on-chain interest thru rebase
is_stablecoin()	Do we think this asset reprents a stablecoin
schema(*[, infer_missing, only, exclude, ...])
to_dict([encode_json])
to_json(*[, skipkeys, ensure_ascii, ...])

Attributes

checksum_address	Ethereum madness.
info_url	Info page URL for this asset
internal_id	How this asset is referred in the internal database
liquidation_threshold	Aave liquidation threhold for this asset
type	What kind of asset is this
underlying	The underlying asset for aTokens, vTokens and such
chain_id	See https://chainlist.org/
address	Smart contract address of the asset.
token_symbol	The ticker symbol of this token.
decimals	How many tokens this decimals.

chain_id: int

See https://chainlist.org/

address: str

Smart contract address of the asset. Always lowercase.

token_symbol: str

The ticker symbol of this token.

decimals: int

How many tokens this decimals. Must be always set and non-negative.

internal_id: Optional[int] = None

How this asset is referred in the internal database

info_url: Optional[str] = None

Info page URL for this asset

underlying: Optional[AssetIdentifier] = None

The underlying asset for aTokens, vTokens and such

type: Optional[AssetType] = None

What kind of asset is this

Legacy data will default to None.

liquidation_threshold: float | None = None

Aave liquidation threhold for this asset

Set on aTokens that are used as collateral.

get_identifier()

Assets are identified by their smart contract address.

JSON/Human friendly format to give hash keys to assets, in the format chain id-address.

Returns:

JSON friendly hask key

Return type:

str

property checksum_address: HexAddress

Ethereum madness.

convert_to_raw_amount(amount)

Return any amount in token native units.

Convert decimal to fixed point integer.

Parameters:

amount (Decimal) –

Return type:

int

is_stablecoin()

Do we think this asset reprents a stablecoin

Return type:

bool

is_interest_accruing()

Will this token gain on-chain interest thru rebase

Return type:

bool

is_credit()

Is this a credit asset that accrue interest for us

Return type:

bool

is_debt()

Is this a credit asset that accrue interest for us

Return type:

bool

get_pricing_asset()

Get the asset that delivers price for this asset.

Returns:

If this asset is a derivative of another, then get the underlying, otherwise return self.

Return type:

AssetIdentifier

__init__(chain_id, address, token_symbol, decimals, internal_id=None, info_url=None, underlying=None, type=None, liquidation_threshold=None)

Parameters:

• chain_id (int) –

• address (str) –

• token_symbol (str) –

• decimals (int) –

• internal_id (Optional[int]) –

• info_url (Optional[str]) –

• underlying (Optional[AssetIdentifier]) –

• type (Optional[AssetType]) –

• liquidation_threshold (float | None) –

Return type:

None