Struct ProtocolComponent 

pub struct ProtocolComponent<Token: Into<Address> + Clone = Address> {
    pub id: ComponentId,
    pub protocol_system: String,
    pub protocol_type_name: String,
    pub chain: Chain,
    pub tokens: Vec<Token>,
    pub contract_addresses: Vec<Address>,
    pub static_attributes: HashMap<AttrStoreKey, StoreVal>,
    pub change: ChangeType,
    pub creation_tx: TxHash,
    pub created_at: NaiveDateTime,
}

ProtocolComponent provides detailed descriptions of a component of a protocol, for example, swap pools that enables the exchange of two tokens.

A ProtocolComponent can be associated with an Account, and it has an identifier (id) that can be either the on-chain address or a custom one. It belongs to a specific ProtocolSystem and has a ProtocolTypeID that associates it with a ProtocolType that describes its behaviour e.g., swap, lend, bridge. The component is associated with a specific Chain and holds information about tradable tokens, related contract IDs, and static attributes.

Every values of a ProtocolComponent must be static, they can’t ever be changed after creation. The dynamic values associated to a component must be given using ProtocolComponentState.

Fields

id: ComponentId

protocol_system: String

protocol_type_name: String

chain: Chain

tokens: Vec<Token>

contract_addresses: Vec<Address>

static_attributes: HashMap<AttrStoreKey, StoreVal>

change: ChangeType

creation_tx: TxHash

created_at: NaiveDateTime

Implementations

impl<T> ProtocolComponent<T>

where T: Into<Address> + Clone,

pub fn new( id: &str, protocol_system: &str, protocol_type_name: &str, chain: Chain, tokens: Vec<T>, contract_addresses: Vec<Address>, static_attributes: HashMap<AttrStoreKey, StoreVal>, change: ChangeType, creation_tx: TxHash, created_at: NaiveDateTime, ) -> Self

impl ProtocolComponent<Arc<Token>>

pub fn get_token(&self, address: &Address) -> Option<Arc<Token>>

Trait Implementations

impl<Token: Clone + Into<Address> + Clone> Clone for ProtocolComponent<Token>

fn clone(&self) -> ProtocolComponent<Token>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Token: Debug + Into<Address> + Clone> Debug for ProtocolComponent<Token>

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

Formats the value using the given formatter.

impl DeepSizeOf for ProtocolComponent

fn deep_size_of_children(&self, ctx: &mut Context) -> usize

Returns an estimation of the heap-managed storage of this object. This does not include the size of the object itself.

fn deep_size_of(&self) -> usize

Returns an estimation of a total size of memory owned by the object, including heap-managed storage.

impl<Token: Default + Into<Address> + Clone> Default for ProtocolComponent<Token>

fn default() -> ProtocolComponent<Token>

Returns the “default value” for a type.

impl<'de, Token> Deserialize<'de> for ProtocolComponent<Token>

where Token: Deserialize<'de> + Into<Address> + Clone,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<ProtocolComponent<T>> for ProtocolComponent

where T: Into<Address> + Clone,

fn from(value: ProtocolComponent<T>) -> Self

Converts to this type from the input type.

impl<Token: PartialEq + Into<Address> + Clone> PartialEq for ProtocolComponent<Token>

fn eq(&self, other: &ProtocolComponent<Token>) -> 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<Token> Serialize for ProtocolComponent<Token>

where Token: Serialize + Into<Address> + Clone,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Token: Eq + Into<Address> + Clone> Eq for ProtocolComponent<Token>

impl<Token: Into<Address> + Clone> StructuralPartialEq for ProtocolComponent<Token>