y.classes package

Submodules

y.classes.common module

class y.classes.common.ContractBase[source]

Bases: ASyncGenericBase

__eq__(_ContractBase__o)[source]

Return self==value.

Parameters:

_ContractBase__o (object)

Return type:

bool

__init__(address, asynchronous=False, _deploy_block=None)[source]
Parameters:
Return type:

None

__str__()[source]

Return the contract address as a string.

Returns:

The contract address as a string.

Return type:

str

__build_name__: HiddenMethodDescriptor[Self, str]

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

The original docstring for get() is shown below:

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

Parameters:

  • instance (I)

  • owner (Type[I] | None)

Return type:

T

address
asynchronous: bool = False
build_name[source]

Get the contract’s build name.

Returns:

The contract’s build name.

property contract: Contract
deploy_block: ASyncBoundMethod[Self, Any, int][source]
Parameters:

when_no_history_return_0 (bool)

Return type:

int

has_method[source]
Parameters:

  • method (str)

  • return_response (bool)

Return type:

bool | Any

class y.classes.common.ERC20[source]

Bases: ContractBase

Represents an ERC20 token.

ASyncFunction_decimals(block: int | eth_typing.evm.BlockNumber | NoneType = None) → int[source]

used to fetch decimals at specific block

Since _decimals is an ASyncFunctionAsyncDefault, you can optionally pass sync=True or asynchronous=False to force it to run synchronously and return a value. Without either kwarg, it will return a coroutine for you to await.

Parameters:

block (int | BlockNumber | None)

Return type:

int

ASyncFunction_scale(block: int | eth_typing.evm.BlockNumber | NoneType = None) → int[source]

Since _scale is an ASyncFunctionAsyncDefault, you can optionally pass sync=True or asynchronous=False to force it to run synchronously and return a value. Without either kwarg, it will return a coroutine for you to await.

Parameters:

block (int | BlockNumber | None)

Return type:

int

__eq__(_ContractBase__o)

Return self==value.

Parameters:

_ContractBase__o (object)

Return type:

bool

__init__(address, asynchronous=False, _deploy_block=None)
Parameters:
Return type:

None

__str__()

Return the contract address as a string.

Returns:

The contract address as a string.

Return type:

str

__build_name__: HiddenMethodDescriptor[Self, str]

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

The original docstring for get() is shown below:

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

Parameters:

  • instance (I)

  • owner (Type[I] | None)

Return type:

T

__decimals__: HiddenMethodDescriptor[Self, int]

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

The original docstring for get() is shown below:

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

Parameters:

  • instance (I)

  • owner (Type[I] | None)

Return type:

T

__name__: HiddenMethodDescriptor[Self, str] = 'ERC20'
__scale__: HiddenMethodDescriptor[Self, int]

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

The original docstring for get() is shown below:

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

Parameters:

  • instance (I)

  • owner (Type[I] | None)

Return type:

T

__symbol__: HiddenMethodDescriptor[Self, str]

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

The original docstring for get() is shown below:

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

Parameters:

  • instance (I)

  • owner (Type[I] | None)

Return type:

T

address: str | HexBytes | AnyAddress | EthAddress

The contract address of the token.

asynchronous: bool = False
balance_of[source]

Query the balance of the token for a given address at a specific block.

Parameters:
Returns:

The balance of the token held by address at block block.

Return type:

int

balance_of_readable[source]
Parameters:
Return type:

float

build_name

Get the contract’s build name.

Returns:

The contract’s build name.

property contract: Contract
decimals[source]

The number of decimal places for the token.

Returns:

The number of decimal places for the token.

deploy_block: ASyncBoundMethod[Self, Any, int]
Parameters:

when_no_history_return_0 (bool)

Return type:

int

has_method
Parameters:

  • method (str)

  • return_response (bool)

Return type:

bool | Any

name[source]

The token’s name.

Returns:

The token’s name.

price[source]

Get the price of the token in USD.

Parameters:

  • block (optional) – The block number to query. Defaults to latest block.

  • return_None_on_failure (bool) – If True, return None instead of raising a yPriceMagicError on failure.

  • skip_cache (bool) – If True, skip using the cache while fetching price data.

  • ignore_pools (Tuple[UniswapV2Pool | CurvePool, ...]) – An optional tuple of pools to ignore when calculating the price.

Returns:

The price of the token in USD, or None if return_None_on_failure is True and the price cannot be retrieved.

Raises:

yPriceMagicError – If return_None_on_failure is False and the price cannot be retrieved.

Return type:

UsdPrice | None

scale[source]

Get the scaling factor for the token.

Returns:

The scaling factor for the token.

symbol[source]

The token’s symbol.

Returns:

The token’s symbol.

total_supply[source]

Get the total supply of the token.

Parameters:

block (optional) – The block number to query. Defaults to latest block.

Returns:

The total supply of the token.

Return type:

int

total_supply_readable[source]

Get the total supply of the token scaled to a human-readable decimal.

Parameters:

block (optional) – The block number to query.

Returns:

The total supply of the token scaled to a decimal.

Return type:

float

final class y.classes.common.WeiBalance[source]

Bases: ASyncGenericBase

Represents a balance of a token in wei.

This class provides utility methods for working with token balances in wei, including converting to readable format, getting the price in USD, and performing arithmetic operations.

__add__(_WeiBalance__o)[source]
Parameters:

_WeiBalance__o (WeiBalance)

Return type:

WeiBalance

__bool__()[source]

Check if the balance is non-zero.

Returns:

True if the balance is non-zero, False otherwise.

Return type:

bool

__eq__(_WeiBalance__o)[source]

Check if two WeiBalance objects are equal.

Parameters:

  • __o – The object to compare with.

  • _WeiBalance__o (object)

Returns:

True if the objects are equal, False otherwise.

Return type:

bool

__ge__(_WeiBalance__o)[source]

Check if one WeiBalance object is greater than or equal to another.

Parameters:

  • __o – The object to compare with.

  • _WeiBalance__o (object)

Returns:

True if the current object is greater than or equal to the other object, False otherwise.

Raises:

TypeError – If the objects are not of the same type.

Return type:

bool

__init__(balance, token, block=None, *, skip_cache=<EnvironmentVariable[name=`YPRICEMAGIC_SKIP_CACHE`, type=bool, default_value=False, current_value=False, using_default=True]>, ignore_pools=(), asynchronous=False)[source]

Initialize a WeiBalance object.

Parameters:

  • balance (int) – The balance in wei.

  • token (str | HexBytes | AnyAddress | EthAddress | Contract | int) – The token address.

  • block (int | BlockNumber | None) – The block number for the balance (optional).

  • skip_cache (bool) – If True, skip using the local cache for price data.

  • ignore_pools (Tuple[UniswapV2Pool | CurvePool, ...]) – A tuple of pools to ignore when calculating the price.

  • asynchronous (bool) – True if this object will be used with its asynchronous API, False for its sync API.

Return type:

None

__lt__(_WeiBalance__o)[source]

Return self<value.

Parameters:

_WeiBalance__o (object)

Return type:

bool

__mul__(_WeiBalance__o)[source]

Multiply a WeiBalance object by a scalar value.

Parameters:

  • __o – The scalar value to multiply by.

  • _WeiBalance__o (int | float | Decimal)

Returns:

A new WeiBalance object representing the product.

Raises:

TypeError – If the scalar value is not a number.

Return type:

WeiBalance

__radd__(_WeiBalance__o)[source]
Parameters:

_WeiBalance__o (WeiBalance | Literal[0])

Return type:

WeiBalance

__str__()[source]

Return the balance in wei as a string.

Returns:

The balance in wei as a string.

Return type:

str

__sub__(_WeiBalance__o)[source]
Parameters:

_WeiBalance__o (WeiBalance)

Return type:

WeiBalance

__truediv__(_WeiBalance__o)[source]

Divide a WeiBalance object by a scalar value.

Parameters:

  • __o – The scalar value to divide by.

  • _WeiBalance__o (int | float | Decimal)

Returns:

A new WeiBalance object representing the quotient.

Raises:

TypeError – If the scalar value is not a number.

Return type:

WeiBalance

__price__: HiddenMethodDescriptor[Self, Decimal]

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

The original docstring for get() is shown below:

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

Parameters:

  • instance (I)

  • owner (Type[I] | None)

Return type:

T

__readable__: HiddenMethodDescriptor[Self, Decimal]

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

The original docstring for get() is shown below:

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

Parameters:

  • instance (I)

  • owner (Type[I] | None)

Return type:

T

__value_usd__: HiddenMethodDescriptor[Self, Decimal]

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

The original docstring for get() is shown below:

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

Parameters:

  • instance (I)

  • owner (Type[I] | None)

Return type:

T

asynchronous: bool = False
block: int | BlockNumber | None = None
price[source]

Get the price of the token in USD.

Returns:

The price of the token in USD.

readable[source]

Get the balance scaled to a human-readable decimal.

Returns:

The balance scaled to a decimal.

value_usd[source]

Get the value of the balance in USD.

Returns:

The value of the balance in USD.

y.classes.common.hex_to_string(h)[source]

Convert a HexString to a string.

Parameters:

h (HexString) – The HexString to convert.

Returns:

The converted string.

Return type:

str

y.classes.singleton module

class y.classes.singleton.ChecksumASyncSingletonMeta[source]

Bases: ASyncMeta, Generic[T]

__base__

alias of ASyncMeta

__call__(address, *args, **kwargs)[source]

Call self as a function.

Parameters:

address (AnyAddress)

Return type:

T

__dir__()

Specialized __dir__ implementation for types.

__getattribute__(name, /)

Return getattr(self, name).

__init__(name, bases, namespace)[source]
__instancecheck__(instance)

Override for isinstance(instance, cls).

__or__(value, /)

Return self|value.

__prepare__() → dict

used to create the namespace for the class statement

__ror__(value, /)

Return value|self.

__sizeof__()

Return memory consumption of the type object.

__subclasscheck__(subclass)

Override for issubclass(subclass, cls).

__subclasses__()

Return a list of immediate subclasses.

mro()

Return a type’s method resolution order.

register(subclass)

Register a virtual subclass of an ABC.

Returns the subclass, to allow usage as a class decorator.

__bases__ = (<class 'a_sync.a_sync._meta.ASyncMeta'>, <class 'typing.Generic'>)
__basicsize__ = 888
__dictoffset__ = 264
__flags__ = 2148029952
__itemsize__ = 40
__mro__ = (<class 'y.classes.singleton.ChecksumASyncSingletonMeta'>, <class 'a_sync.a_sync._meta.ASyncMeta'>, <class 'abc.ABCMeta'>, <class 'type'>, <class 'typing.Generic'>, <class 'object'>)
__name__ = 'ChecksumASyncSingletonMeta'
__qualname__ = 'ChecksumASyncSingletonMeta'
__text_signature__ = None
__weakrefoffset__ = 368

Module contents

class y.classes.ERC20[source]

Bases: ContractBase

Represents an ERC20 token.

ASyncFunction_decimals(block: int | eth_typing.evm.BlockNumber | NoneType = None) → int[source]

used to fetch decimals at specific block

Since _decimals is an ASyncFunctionAsyncDefault, you can optionally pass sync=True or asynchronous=False to force it to run synchronously and return a value. Without either kwarg, it will return a coroutine for you to await.

Parameters:

block (int | BlockNumber | None)

Return type:

int

ASyncFunction_scale(block: int | eth_typing.evm.BlockNumber | NoneType = None) → int[source]

Since _scale is an ASyncFunctionAsyncDefault, you can optionally pass sync=True or asynchronous=False to force it to run synchronously and return a value. Without either kwarg, it will return a coroutine for you to await.

Parameters:

block (int | BlockNumber | None)

Return type:

int

__eq__(_ContractBase__o)

Return self==value.

Parameters:

_ContractBase__o (object)

Return type:

bool

__init__(address, asynchronous=False, _deploy_block=None)
Parameters:
Return type:

None

__str__()

Return the contract address as a string.

Returns:

The contract address as a string.

Return type:

str

__build_name__: HiddenMethodDescriptor[Self, str]

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

The original docstring for get() is shown below:

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

Parameters:

  • instance (I)

  • owner (Type[I] | None)

Return type:

T

__decimals__: HiddenMethodDescriptor[Self, int]

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

The original docstring for get() is shown below:

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

Parameters:

  • instance (I)

  • owner (Type[I] | None)

Return type:

T

__name__: HiddenMethodDescriptor[Self, str] = 'ERC20'
__scale__: HiddenMethodDescriptor[Self, int]

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

The original docstring for get() is shown below:

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

Parameters:

  • instance (I)

  • owner (Type[I] | None)

Return type:

T

__symbol__: HiddenMethodDescriptor[Self, str]

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

The original docstring for get() is shown below:

Asynchronously retrieves the property value.

Args:

instance: The instance from which the property is accessed. owner: The owner class of the property.

Returns:

The property value.

Parameters:

  • instance (I)

  • owner (Type[I] | None)

Return type:

T

address: str | HexBytes | AnyAddress | EthAddress

The contract address of the token.

asynchronous: bool = False
balance_of[source]

Query the balance of the token for a given address at a specific block.

Parameters:
Returns:

The balance of the token held by address at block block.

Return type:

int

balance_of_readable[source]
Parameters:
Return type:

float

build_name

Get the contract’s build name.

Returns:

The contract’s build name.

property contract: Contract
decimals[source]

The number of decimal places for the token.

Returns:

The number of decimal places for the token.

deploy_block: ASyncBoundMethod[Self, Any, int]
Parameters:

when_no_history_return_0 (bool)

Return type:

int

has_method
Parameters:

  • method (str)

  • return_response (bool)

Return type:

bool | Any

name[source]

The token’s name.

Returns:

The token’s name.

price[source]

Get the price of the token in USD.

Parameters:

  • block (optional) – The block number to query. Defaults to latest block.

  • return_None_on_failure (bool) – If True, return None instead of raising a yPriceMagicError on failure.

  • skip_cache (bool) – If True, skip using the cache while fetching price data.

  • ignore_pools (Tuple[UniswapV2Pool | CurvePool, ...]) – An optional tuple of pools to ignore when calculating the price.

Returns:

The price of the token in USD, or None if return_None_on_failure is True and the price cannot be retrieved.

Raises:

yPriceMagicError – If return_None_on_failure is False and the price cannot be retrieved.

Return type:

UsdPrice | None

scale[source]

Get the scaling factor for the token.

Returns:

The scaling factor for the token.

symbol[source]

The token’s symbol.

Returns:

The token’s symbol.

total_supply[source]

Get the total supply of the token.

Parameters:

block (optional) – The block number to query. Defaults to latest block.

Returns:

The total supply of the token.

Return type:

int

total_supply_readable[source]

Get the total supply of the token scaled to a human-readable decimal.

Parameters:

block (optional) – The block number to query.

Returns:

The total supply of the token scaled to a decimal.

Return type:

float