Struct Dex 

pub struct Dex {
    pub chain: Chain,
    pub name: DexType,
    pub factory: Address,
    pub factory_creation_block: u64,
    pub pool_created_event: Cow<'static, str>,
    pub initialize_event: Option<Cow<'static, str>>,
    pub swap_created_event: Cow<'static, str>,
    pub mint_created_event: Cow<'static, str>,
    pub burn_created_event: Cow<'static, str>,
    pub collect_created_event: Cow<'static, str>,
    pub flash_created_event: Option<Cow<'static, str>>,
    pub amm_type: AmmType,
    /* private fields */
}

Represents a decentralized exchange (DEX) in a blockchain ecosystem.

Fields

chain: Chain

The blockchain network where this DEX operates.

name: DexType

The variant of the DEX protocol.

factory: Address

The blockchain address of the DEX factory contract.

factory_creation_block: u64

The block number at which the DEX factory contract was deployed.

pool_created_event: Cow<'static, str>

The event signature or identifier used to detect pool creation events.

initialize_event: Option<Cow<'static, str>>

swap_created_event: Cow<'static, str>

The event signature or identifier used to detect swap events.

mint_created_event: Cow<'static, str>

The event signature or identifier used to detect mint events.

burn_created_event: Cow<'static, str>

The event signature or identifier used to detect burn events.

collect_created_event: Cow<'static, str>

The event signature or identifier used to detect collect fee events.

flash_created_event: Option<Cow<'static, str>>

amm_type: AmmType

The type of automated market maker (AMM) algorithm used by this DEX.

Implementations

impl Dex

pub fn new( chain: Chain, name: DexType, factory: &str, factory_creation_block: u64, amm_type: AmmType, pool_created_event: &str, swap_event: &str, mint_event: &str, burn_event: &str, collect_event: &str, ) -> Self

Creates a new Dex instance with the specified properties.

Panics

Panics if the provided factory address is invalid.

pub fn id(&self) -> String

Returns a unique identifier for this DEX, combining chain and protocol name.

pub fn set_initialize_event(&mut self, event: &str)

Sets the pool initialization event signature by hashing and encoding the provided event string.

pub fn set_flash_event(&mut self, event: &str)

Sets the flash loan event signature by hashing and encoding the provided event string.

Trait Implementations

impl Clone for Dex

fn clone(&self) -> Dex

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Dex

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Dex

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Dex

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'py> IntoPyObject<'py> for Dex

type Target = Dex

The Python output type

type Output = Bound<'py, <Dex as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PartialEq for Dex

fn eq(&self, other: &Dex) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PyClass for Dex

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Dex

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Represents a decentralized exchange (DEX) in a blockchain ecosystem.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<Dex>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for Dex

const TEXT_SIGNATURE: &'static str = "(chain, name, factory, factory_creation_block, amm_type, pool_created_event, swap_event, mint_event, burn_event, collect_event)"

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder Dex

type Holder = Option<PyClassGuard<'a, Dex>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder mut Dex

type Holder = Option<PyClassGuardMut<'a, Dex>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<Dex> for PyClassImplCollector<Dex>

fn py_methods(self) -> &'static PyClassItems

impl PyStubType for Dex

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for Dex

const NAME: &'static str = "Dex"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for Dex

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl DerefToPyAny for Dex

impl StructuralPartialEq for Dex