Enum pallet_liquidity_pools::Message

pub enum Message<BatchContent = BatchMessages, ForwardContent = NonForwardMessage> {
    Invalid,
    MessageProof {
        hash: [u8; 32],
    },
    InitiateMessageRecovery {
        hash: [u8; 32],
        router: [u8; 32],
    },
    DisputeMessageRecovery {
        hash: [u8; 32],
        router: [u8; 32],
    },
    Batch(BatchContent),
    ScheduleUpgrade {
        contract: [u8; 20],
    },
    CancelUpgrade {
        contract: [u8; 20],
    },
    RecoverAssets {
        contract: [u8; 32],
        asset: [u8; 32],
        recipient: [u8; 32],
        amount: [u8; 32],
    },
    UpdateCentrifugeGasPrice {
        price: u128,
    },
    AddAsset {
        currency: u128,
        evm_address: [u8; 20],
    },
    AddPool {
        pool_id: u64,
    },
    AddTranche {
        pool_id: u64,
        tranche_id: [u8; 16],
        token_name: [u8; 128],
        token_symbol: [u8; 32],
        decimals: u8,
        hook: [u8; 32],
    },
    AllowAsset {
        pool_id: u64,
        currency: u128,
    },
    DisallowAsset {
        pool_id: u64,
        currency: u128,
    },
    UpdateTranchePrice {
        pool_id: u64,
        tranche_id: [u8; 16],
        currency: u128,
        price: u128,
        computed_at: Seconds,
    },
    UpdateTrancheMetadata {
        pool_id: u64,
        tranche_id: [u8; 16],
        token_name: [u8; 128],
        token_symbol: [u8; 32],
    },
    UpdateTrancheHook {
        pool_id: u64,
        tranche_id: [u8; 16],
        hook: [u8; 32],
    },
    TransferAssets {
        currency: u128,
        receiver: [u8; 32],
        amount: u128,
    },
    TransferTrancheTokens {
        pool_id: u64,
        tranche_id: [u8; 16],
        domain: SerializableDomain,
        receiver: [u8; 32],
        amount: u128,
    },
    UpdateRestriction {
        pool_id: u64,
        tranche_id: [u8; 16],
        update: UpdateRestrictionMessage,
    },
    DepositRequest {
        pool_id: u64,
        tranche_id: [u8; 16],
        investor: [u8; 32],
        currency: u128,
        amount: u128,
    },
    RedeemRequest {
        pool_id: u64,
        tranche_id: [u8; 16],
        investor: [u8; 32],
        currency: u128,
        amount: u128,
    },
    FulfilledDepositRequest {
        pool_id: u64,
        tranche_id: [u8; 16],
        investor: [u8; 32],
        currency: u128,
        currency_payout: u128,
        tranche_tokens_payout: u128,
    },
    FulfilledRedeemRequest {
        pool_id: u64,
        tranche_id: [u8; 16],
        investor: [u8; 32],
        currency: u128,
        currency_payout: u128,
        tranche_tokens_payout: u128,
    },
    CancelDepositRequest {
        pool_id: u64,
        tranche_id: [u8; 16],
        investor: [u8; 32],
        currency: u128,
    },
    CancelRedeemRequest {
        pool_id: u64,
        tranche_id: [u8; 16],
        investor: [u8; 32],
        currency: u128,
    },
    FulfilledCancelDepositRequest {
        pool_id: u64,
        tranche_id: [u8; 16],
        investor: [u8; 32],
        currency: u128,
        currency_payout: u128,
        fulfilled_invest_amount: u128,
    },
    FulfilledCancelRedeemRequest {
        pool_id: u64,
        tranche_id: [u8; 16],
        investor: [u8; 32],
        currency: u128,
        tranche_tokens_payout: u128,
    },
    TriggerRedeemRequest {
        pool_id: u64,
        tranche_id: [u8; 16],
        investor: [u8; 32],
        currency: u128,
        amount: u128,
    },
    Forwarded {
        source_domain: SerializableDomain,
        forwarding_contract: H160,
        message: ForwardContent,
    },
}

A LiquidityPools Message

Variants

Invalid

MessageProof

Fields

hash: [u8; 32]

Proof a message has been executed.

Directionality: Centrifuge <-> EVM Domain.

InitiateMessageRecovery

Fields

hash: [u8; 32]

The hash of the message which shall be recovered

router: [u8; 32]

The address of the router

Initiate the recovery of a message.

Must only be callable by root.

Directionality: Centrifuge -> EVM Domain.

DisputeMessageRecovery

Fields

hash: [u8; 32]

The hash of the message which shall be disputed

router: [u8; 32]

The address of the router

Dispute the recovery of a message.

Must only be callable by root.

Directionality: Centrifuge -> EVM Domain.

Batch(BatchContent)

A batch of ordered messages. Don’t allow nested batch messages.

ScheduleUpgrade

Fields

contract: [u8; 20]

The EVM contract address

Schedules an EVM address to become rely-able by the gateway. Intended to be used via governance to execute EVM spells.

Directionality: Centrifuge -> EVM Domain.

CancelUpgrade

Fields

contract: [u8; 20]

The EVM contract address

Cancel the scheduled process for an EVM address to become rely-able by the gateway. Intended to be used via governance to execute EVM spells.

Directionality: Centrifuge -> EVM Domain.

RecoverAssets

Fields

contract: [u8; 32]

The EVM contract address to which the tokens were wrongfully sent

asset: [u8; 32]

The ERC-20 asset to recover

recipient: [u8; 32]

The user address which receives the recovered tokens

amount: [u8; 32]

The amount of tokens to recover.

NOTE: Represents sp_core::U256 because EVM balances are u256.

Allows Governance to recover ERC-20 assets sent to the wrong contract by mistake.

Directionality: Centrifuge -> EVM Domain.

UpdateCentrifugeGasPrice

Fields

price: u128

The new gas price

Updates the gas price which should cover transaction fees on Centrifuge Chain side.

Directionality: Centrifuge -> EVM Domain.

AddAsset

Fields

currency: u128

evm_address: [u8; 20]

Add a currency to a domain, i.e, register the mapping of a currency id to the corresponding EVM Address.

Directionality: Centrifuge -> EVM Domain.

AddPool

Fields

pool_id: u64

Add a pool to a domain.

Directionality: Centrifuge -> EVM Domain.

AddTranche

Fields

pool_id: u64

tranche_id: [u8; 16]

token_name: [u8; 128]

token_symbol: [u8; 32]

decimals: u8

hook: [u8; 32]

The RestrictionManager implementation to be used for this tranche token on the domain it will be added and subsequently deployed in.

Add a tranche to an already existing pool on the target domain. The decimals of a tranche MUST be equal to the decimals of a pool. Thus, consuming domains MUST take care of storing the decimals upon receiving an AddPool message.

Directionality: Centrifuge -> EVM Domain.

AllowAsset

Fields

pool_id: u64

currency: u128

Allow a currency to be used as a pool currency and to invest in a pool.

Directionality: Centrifuge -> EVM Domain.

DisallowAsset

Fields

pool_id: u64

currency: u128

Disallow a currency to be used as a pool currency and to invest in a pool.

Directionality: Centrifuge -> EVM Domain.

UpdateTranchePrice

Fields

pool_id: u64

tranche_id: [u8; 16]

currency: u128

price: u128

computed_at: Seconds

The timestamp at which the price was computed

Update the price of a tranche token on the target domain.

Directionality: Centrifuge -> EVM Domain.

UpdateTrancheMetadata

Fields

pool_id: u64

tranche_id: [u8; 16]

token_name: [u8; 128]

token_symbol: [u8; 32]

Updates the name and symbol of a tranche token.

NOTE: We do not allow updating the decimals as this would require migrating all associated balances.

Directionality: Centrifuge -> EVM Domain.

UpdateTrancheHook

Fields

pool_id: u64

tranche_id: [u8; 16]

hook: [u8; 32]

The address to be used for this tranche token on the domain it will be added and subsequently deployed in.

TransferAssets

Fields

currency: u128

receiver: [u8; 32]

amount: u128

Transfer non-tranche tokens fungibles. For v2, it will only support stable-coins.

Directionality: Centrifuge <-> EVM Domain.

NOTE: Receiving domain must not accept every incoming token. For Centrifuge -> EVM Domain: AddAsset should have been called beforehand. For Centrifuge <- EVM Domain: We can assume AddAsset has been called for that domain already.

TransferTrancheTokens

Fields

pool_id: u64

tranche_id: [u8; 16]

domain: SerializableDomain

receiver: [u8; 32]

amount: u128

Transfer tranche tokens between domains.

Directionality: Centrifuge <-> EVM Domain.

UpdateRestriction

Fields

pool_id: u64

tranche_id: [u8; 16]

update: UpdateRestrictionMessage

Update the restriction on a foreign domain.

Directionality: Centrifuge -> EVM Domain.

DepositRequest

Fields

pool_id: u64

tranche_id: [u8; 16]

investor: [u8; 32]

currency: u128

amount: u128

Increase the invest order amount for the specified pair of pool and tranche token.

Directionality: Centrifuge <- EVM Domain.

RedeemRequest

Fields

pool_id: u64

tranche_id: [u8; 16]

investor: [u8; 32]

currency: u128

amount: u128

Increase the redeem order amount for the specified pair of pool and tranche token.

Directionality: Centrifuge <- EVM Domain.

FulfilledDepositRequest

Fields

pool_id: u64

The pool id

tranche_id: [u8; 16]

The tranche

investor: [u8; 32]

The investor’s address

currency: u128

The currency in which the investment was realised

currency_payout: u128

The amount that was actually collected, in currency units

tranche_tokens_payout: u128

The amount of tranche tokens received for the investment made

The message sent back to the domain from which a DepositRequest originated from after the deposit was fully processed during epoch execution. Ensures the investor gets the payout respective to their investment.

Directionality: Centrifuge -> EVM Domain.

FulfilledRedeemRequest

Fields

pool_id: u64

The pool id

tranche_id: [u8; 16]

The tranche id

investor: [u8; 32]

The investor’s address

currency: u128

The stable coin currency in which the payout takes place

currency_payout: u128

The amount of currency being paid out to the investor

tranche_tokens_payout: u128

How many tranche tokens were actually redeemed

The message sent back to the domain from which a RedeemRequest originated from after the redemption was fully processed during epoch execution. Ensures the investor gets the payout respective to their redemption.

Directionality: Centrifuge -> EVM Domain.

CancelDepositRequest

Fields

pool_id: u64

tranche_id: [u8; 16]

investor: [u8; 32]

currency: u128

Cancel an unprocessed invest order for the specified pair of pool and tranche token.

On success, triggers a message sent back to the sending domain. The message will take care of re-funding the investor with the given amount the order was reduced with. The investor address is used as the receiver of that tokens.

Directionality: Centrifuge <- EVM Domain.

CancelRedeemRequest

Fields

pool_id: u64

tranche_id: [u8; 16]

investor: [u8; 32]

currency: u128

Cancel an unprocessed redemption for the specified pair of pool and tranche token.

On success, triggers a message sent back to the sending domain. The message will take care of re-funding the investor with the given amount the order was reduced with. The investor address is used as the receiver of that tokens.

Directionality: Centrifuge <- EVM Domain.

FulfilledCancelDepositRequest

Fields

pool_id: u64

The pool id

tranche_id: [u8; 16]

The tranche id

investor: [u8; 32]

The investor’s address

currency: u128

The currency in which CancelDepositRequest was realised

currency_payout: u128

The amount of currency by which the investment order was actually decreased by.

fulfilled_invest_amount: u128

The fulfilled investment amount of currency. It reflects the amount of investments which were processed independent of whether they were collected.

The message sent back to the domain from which a CancelDepositRequest message was received, ensuring the correct state update on said domain and that the investor’s wallet is updated accordingly.

Directionality: Centrifuge -> EVM Domain.

FulfilledCancelRedeemRequest

Fields

pool_id: u64

The pool id

tranche_id: [u8; 16]

The tranche id

investor: [u8; 32]

The investor’s address

currency: u128

The currency in which CancelRedeemRequest was realised in.

tranche_tokens_payout: u128

The amount of tranche tokens by which the redeem order was actually decreased by.

The message sent back to the domain from which a CancelRedeemRequest message was received, ensuring the correct state update on said domain and that the investor’s wallet is updated accordingly.

Directionality: Centrifuge -> EVM Domain.

TriggerRedeemRequest

Fields

pool_id: u64

The pool id

tranche_id: [u8; 16]

The tranche id

investor: [u8; 32]

The investor’s address

currency: u128

The currency in which the redeem request should be realised in.

amount: u128

The amount of tranche tokens which should be redeemed.

Forwarded

Fields

source_domain: SerializableDomain

forwarding_contract: H160

message: ForwardContent

A wrapped Message which was forwarded from the source domain via the contract.

Directionality: Centrifuge <-> EVM Domain.

Trait Implementations

impl<BatchContent: Clone, ForwardContent: Clone> Clone for Message<BatchContent, ForwardContent>

fn clone(&self) -> Message<BatchContent, ForwardContent>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<BatchContent, ForwardContent> Debug for Message<BatchContent, ForwardContent>

where BatchContent: Debug, ForwardContent: Debug,

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

Formats the value using the given formatter.

impl<BatchContent, ForwardContent> Decode for Message<BatchContent, ForwardContent>

where BatchContent: Decode, ForwardContent: Decode,

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self> ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<BatchContent, ForwardContent> Default for Message<BatchContent, ForwardContent>

fn default() -> Message<BatchContent, ForwardContent>

Returns the “default value” for a type.

impl<'de, BatchContent, ForwardContent> Deserialize<'de> for Message<BatchContent, ForwardContent>

where BatchContent: Deserialize<'de>, ForwardContent: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<BatchContent, ForwardContent> Encode for Message<BatchContent, ForwardContent>

where BatchContent: Encode, ForwardContent: Encode,

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl LpMessageBatch for Message

fn pack_with(&mut self, other: Self) -> Result<(), DispatchError>

Extend this message with a new one

fn submessages(&self) -> Vec<Self>

Decompose the message into a list of messages If the message is not decomposable, it returns the own message.

fn empty() -> Message

Creates an empty message. It’s the identity message for composing messages with pack_with

impl LpMessageForwarded for Message

type Domain = Domain

fn is_forwarded(&self) -> bool

Checks whether a message is a forwarded one.

fn unwrap_forwarded(self) -> Option<(Domain, H160, Self)>

Unwraps a forwarded message.

fn try_wrap_forward( source_domain: Domain, forwarding_contract: H160, message: Self ) -> Result<Self, DispatchError>

Attempts to wrap into a forwarded message.

impl LpMessageHash for Message

fn get_message_hash(&self) -> MessageHash

Retrieves the message hash, if the message is a proof type.

impl LpMessageProof for Message

fn is_proof_message(&self) -> bool

Returns whether the message is a proof or not.

fn to_proof_message(&self) -> Self

Converts the message into a message proof type.

impl LpMessageRecovery for Message

fn initiate_recovery_message(hash: MessageHash, router: [u8; 32]) -> Self

Creates a message used for initiating message recovery.

fn dispute_recovery_message(hash: MessageHash, router: [u8; 32]) -> Self

Creates a message used for disputing message recovery.

impl LpMessageSerializer for Message

fn serialize(&self) -> Vec<u8>

Serialize the message

fn deserialize(data: &[u8]) -> Result<Self, DispatchError>

Deserialize the message

impl<BatchContent, ForwardContent> MaxEncodedLen for Message<BatchContent, ForwardContent>

where BatchContent: MaxEncodedLen, ForwardContent: MaxEncodedLen,

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<BatchContent: PartialEq, ForwardContent: PartialEq> PartialEq for Message<BatchContent, ForwardContent>

fn eq(&self, other: &Message<BatchContent, ForwardContent>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<BatchContent, ForwardContent> Serialize for Message<BatchContent, ForwardContent>

where BatchContent: Serialize, ForwardContent: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<BatchContent, ForwardContent> TypeInfo for Message<BatchContent, ForwardContent>

where BatchContent: TypeInfo + 'static, ForwardContent: TypeInfo + 'static,

type Identity = Message<BatchContent, ForwardContent>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<BatchContent, ForwardContent> EncodeLike for Message<BatchContent, ForwardContent>

where BatchContent: Encode, ForwardContent: Encode,

impl<BatchContent: Eq, ForwardContent: Eq> Eq for Message<BatchContent, ForwardContent>

impl<BatchContent, ForwardContent> StructuralPartialEq for Message<BatchContent, ForwardContent>