Enum linera_execution::system::SystemMessage

pub enum SystemMessage {
    Credit {
        target: Option<Owner>,
        amount: Amount,
        source: Option<Owner>,
    },
    Withdraw {
        owner: Owner,
        amount: Amount,
        recipient: Recipient,
        user_data: UserData,
    },
    OpenChain(OpenChainConfig),
    SetCommittees {
        epoch: Epoch,
        committees: BTreeMap<Epoch, Committee>,
    },
    Subscribe {
        id: ChainId,
        subscription: ChannelSubscription,
    },
    Unsubscribe {
        id: ChainId,
        subscription: ChannelSubscription,
    },
    BytecodePublished {
        operation_index: u32,
    },
    ApplicationCreated,
    BytecodeLocations {
        locations: Vec<(BytecodeId, BytecodeLocation)>,
    },
    RegisterApplications {
        applications: Vec<UserApplicationDescription>,
    },
    Notify {
        id: ChainId,
    },
    RequestApplication(UserApplicationId),
}

A system message meant to be executed on a remote chain.

Variants

Credit

Credits amount units of value to the account target – unless the message is bouncing, in which case source is credited instead.

Fields

target: Option<Owner>

amount: Amount

source: Option<Owner>

Withdraw

Withdraws amount units of value from the account and starts a transfer to credit the recipient. The message must be properly authenticated. Receiver chains may refuse it depending on their configuration.

Fields

owner: Owner

amount: Amount

recipient: Recipient

user_data: UserData

OpenChain(OpenChainConfig)

Creates (or activates) a new chain.

SetCommittees

Sets the current epoch and the recognized committees.

Fields

epoch: Epoch

committees: BTreeMap<Epoch, Committee>

Subscribe

Subscribes to a channel.

Fields

id: ChainId

subscription: ChannelSubscription

Unsubscribe

Unsubscribes from a channel.

Fields

id: ChainId

subscription: ChannelSubscription

BytecodePublished

Notifies that a new application bytecode was published.

Fields

operation_index: u32

ApplicationCreated

Notifies that a new application was created.

BytecodeLocations

Shares the locations of published bytecodes.

Fields

locations: Vec<(BytecodeId, BytecodeLocation)>

RegisterApplications

Shares information about some applications to help the recipient use them. Applications must be registered after their dependencies.

Fields

applications: Vec<UserApplicationDescription>

Notify

Does nothing. Used to debug the intended recipients of a block.

Fields

id: ChainId

RequestApplication(UserApplicationId)

Requests a RegisterApplication message from the target chain to register the specified application on the sender chain.

Implementations

impl SystemMessage

pub fn bytecode_locations( &self, certificate_hash: CryptoHash ) -> Box<dyn Iterator<Item = BytecodeLocation> + '_>

Returns an iterator over all bytecode locations this message introduces to the receiving chain, given the hash of the certificate that it originates from.

Trait Implementations

impl Clone for SystemMessage

fn clone(&self) -> SystemMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SystemMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SystemMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SystemMessage> for Message

fn from(message: SystemMessage) -> Self

Converts to this type from the input type.

impl Hash for SystemMessage

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SystemMessage

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SystemMessage

impl StructuralPartialEq for SystemMessage