zeth.core.utils.EtherValue Class Reference

Public Member Functions
def	__init__ (self, Union[str, int, float] val, str units='ether')
str	__str__ (self)
EtherValue	__add__ (self, EtherValue other)
EtherValue	__sub__ (self, EtherValue other)
bool	__eq__ (self, Any other)
bool	__ne__ (self, Any other)
bool	__lt__ (self, EtherValue other)
bool	__le__ (self, EtherValue other)
bool	__gt__ (self, EtherValue other)
bool	__ge__ (self, EtherValue other)
bool	__bool__ (self)
str	ether (self)

Public Attributes
	wei

Detailed Description

Representation of some amount of Ether (or any token) in terms of Wei.
Disambiguates Ether values from other units such as zeth_units.

Definition at line 46 of file utils.py.

Constructor & Destructor Documentation

__init__()

def zeth.core.utils.EtherValue.__init__	(		self,
		Union[str, int, float]	val,
		str	units = 'ether'
	)

Definition at line 51 of file utils.py.

    def __init__(self, val: Union[str, int, float], units: str = 'ether'):
        self.wei = Web3.toWei(val, units)
 

Member Function Documentation

__add__()

EtherValue zeth.core.utils.EtherValue.__add__	(		self,
		EtherValue	other
	)

Definition at line 57 of file utils.py.

    def __add__(self, other: EtherValue) -> EtherValue:
        return EtherValue(self.wei + other.wei, 'wei')
 

__bool__()

bool zeth.core.utils.EtherValue.__bool__

(

self

)

Definition at line 83 of file utils.py.

    def __bool__(self) -> bool:
        return int(self.wei) != 0
 

__eq__()

bool zeth.core.utils.EtherValue.__eq__	(		self,
		Any	other
	)

Definition at line 63 of file utils.py.

    def __eq__(self, other: Any) -> bool:
        if not isinstance(other, EtherValue):
            return False
        return self.wei == other.wei
 

Here is the caller graph for this function:

__ge__()

bool zeth.core.utils.EtherValue.__ge__	(		self,
		EtherValue	other
	)

Definition at line 80 of file utils.py.

    def __ge__(self, other: EtherValue) -> bool:
        return self.wei >= other.wei
 

__gt__()

bool zeth.core.utils.EtherValue.__gt__	(		self,
		EtherValue	other
	)

Definition at line 77 of file utils.py.

    def __gt__(self, other: EtherValue) -> bool:
        return self.wei > other.wei
 

__le__()

bool zeth.core.utils.EtherValue.__le__	(		self,
		EtherValue	other
	)

Definition at line 74 of file utils.py.

    def __le__(self, other: EtherValue) -> bool:
        return self.wei <= other.wei
 

__lt__()

bool zeth.core.utils.EtherValue.__lt__	(		self,
		EtherValue	other
	)

Definition at line 71 of file utils.py.

    def __lt__(self, other: EtherValue) -> bool:
        return self.wei < other.wei
 

__ne__()

bool zeth.core.utils.EtherValue.__ne__	(		self,
		Any	other
	)

Definition at line 68 of file utils.py.

    def __ne__(self, other: Any) -> bool:
        return not self.__eq__(other)
 

Here is the call graph for this function:

__str__()

str zeth.core.utils.EtherValue.__str__

(

self

)

Definition at line 54 of file utils.py.

    def __str__(self) -> str:
        return str(self.wei)
 

__sub__()

EtherValue zeth.core.utils.EtherValue.__sub__	(		self,
		EtherValue	other
	)

Definition at line 60 of file utils.py.

    def __sub__(self, other: EtherValue) -> EtherValue:
        return EtherValue(self.wei - other.wei, 'wei')
 

ether()

str zeth.core.utils.EtherValue.ether

(

self

)

Definition at line 86 of file utils.py.

    def ether(self) -> str:
        return str(Web3.fromWei(self.wei, 'ether'))
 
 

Member Data Documentation

wei

zeth.core.utils.EtherValue.wei

Definition at line 52 of file utils.py.

---

The documentation for this class was generated from the following file:

• /home/runner/work/zeth/zeth/client/zeth/core/utils.py