CollateralBalance

Documentation for eth_defi.derive.account.CollateralBalance Python class.

class CollateralBalance

Bases: object

Single collateral balance in a Derive account.

#: Token symbol (e.g., “USDC”, “WETH”) token: str

#: Available balance (not used in positions) available: Decimal

#: Total balance including locked total: Decimal

#: Balance locked in positions locked: Decimal

#: Token contract address on Derive Chain token_address: HexAddress | None = None

Attributes summary

token
available
total
locked
token_address

Methods summary

__init__(token, available, total, locked[, ...])

__init__(token, available, total, locked, token_address=None)

Parameters

• token (str) –

• available (decimal.Decimal) –

• total (decimal.Decimal) –

• locked (decimal.Decimal) –

• token_address (Optional[eth_typing.evm.HexAddress]) –

Return type

None