Enum gear_core_processor::common::JournalNote

pub enum JournalNote {
    MessageDispatched {
        message_id: MessageId,
        source: ProgramId,
        outcome: DispatchOutcome,
    },
    GasBurned {
        message_id: MessageId,
        amount: u64,
    },
    ExitDispatch {
        id_exited: ProgramId,
        value_destination: ProgramId,
    },
    MessageConsumed(MessageId),
    SendDispatch {
        message_id: MessageId,
        dispatch: Dispatch,
        delay: u32,
        reservation: Option<ReservationId>,
    },
    WaitDispatch {
        dispatch: StoredDispatch,
        duration: Option<u32>,
        waited_type: MessageWaitedType,
    },
    WakeMessage {
        message_id: MessageId,
        program_id: ProgramId,
        awakening_id: MessageId,
        delay: u32,
    },
    UpdatePage {
        program_id: ProgramId,
        page_number: GearPage,
        data: PageBuf,
    },
    UpdateAllocations {
        program_id: ProgramId,
        allocations: IntervalsTree<WasmPage>,
    },
    SendValue {
        from: ProgramId,
        to: Option<ProgramId>,
        value: u128,
    },
    StoreNewPrograms {
        program_id: ProgramId,
        code_id: CodeId,
        candidates: Vec<(MessageId, ProgramId)>,
    },
    StopProcessing {
        dispatch: StoredDispatch,
        gas_burned: u64,
    },
    ReserveGas {
        message_id: MessageId,
        reservation_id: ReservationId,
        program_id: ProgramId,
        amount: u64,
        duration: u32,
    },
    UnreserveGas {
        reservation_id: ReservationId,
        program_id: ProgramId,
        expiration: u32,
    },
    UpdateGasReservations {
        program_id: ProgramId,
        reserver: GasReserver,
    },
    SystemReserveGas {
        message_id: MessageId,
        amount: u64,
    },
    SystemUnreserveGas {
        message_id: MessageId,
    },
    SendSignal {
        message_id: MessageId,
        destination: ProgramId,
        code: SignalCode,
    },
    ReplyDeposit {
        message_id: MessageId,
        future_reply_id: MessageId,
        amount: u64,
    },
}

Journal record for the state update.

Variants

MessageDispatched

Message was successfully dispatched.

Fields

message_id: MessageId

Message id of dispatched message.

source: ProgramId

Source of the dispatched message.

outcome: DispatchOutcome

Outcome of the processing.

GasBurned

Some gas was burned.

Fields

message_id: MessageId

Message id in which gas was burned.

amount: u64

Amount of gas burned.

ExitDispatch

Exit the program.

Fields

id_exited: ProgramId

Id of the program called exit.

value_destination: ProgramId

Address where all remaining value of the program should be transferred to.

MessageConsumed(MessageId)

Message was handled and no longer exists.

This should be the last update involving this message id.

SendDispatch

Message was generated.

Fields

message_id: MessageId

Message id of the message that generated this message.

dispatch: Dispatch

New message with entry point that was generated.

delay: u32

Amount of blocks to wait before sending.

reservation: Option<ReservationId>

Whether use supply from reservation or current message.

WaitDispatch

Put this dispatch in the wait list.

Fields

dispatch: StoredDispatch

Stored dispatch to be inserted into Waitlist.

duration: Option<u32>

Expected duration of holding.

waited_type: MessageWaitedType

If this message is waiting for its reincarnation.

WakeMessage

Wake particular message.

Fields

message_id: MessageId

Message which has initiated wake.

program_id: ProgramId

Program which has initiated wake.

awakening_id: MessageId

Message that should be woken.

delay: u32

Amount of blocks to wait before waking.

UpdatePage

Update page.

Fields

program_id: ProgramId

Program that owns the page.

page_number: GearPage

Number of the page.

data: PageBuf

New data of the page.

UpdateAllocations

Update allocations set note. And also removes data for pages which is not in allocations set now.

Fields

program_id: ProgramId

Program id.

allocations: IntervalsTree<WasmPage>

New allocations set for the program.

SendValue

Send value

Fields

from: ProgramId

Value sender

to: Option<ProgramId>

Value beneficiary,

value: u128

Value amount

StoreNewPrograms

Store programs requested by user to be initialized later

Fields

program_id: ProgramId

Current program id.

code_id: CodeId

Code hash used to create new programs with ids in candidates field

candidates: Vec<(MessageId, ProgramId)>

Collection of program candidate ids and their init message ids.

StopProcessing

Stop processing queue.

Fields

dispatch: StoredDispatch

Pushes StoredDispatch back to the top of the queue.

gas_burned: u64

Decreases gas allowance by that amount, burned for processing try.

ReserveGas

Reserve gas.

Fields

message_id: MessageId

Message from which gas is reserved.

reservation_id: ReservationId

Reservation ID

program_id: ProgramId

Program which contains reservation.

amount: u64

Amount of reserved gas.

duration: u32

How many blocks reservation will live.

UnreserveGas

Unreserve gas.

Fields

reservation_id: ReservationId

Reservation ID

program_id: ProgramId

Program which contains reservation.

expiration: u32

Block number until reservation will live.

UpdateGasReservations

Update gas reservation map in program.

Fields

program_id: ProgramId

Program whose map will be updated.

reserver: GasReserver

Map with reservations.

SystemReserveGas

Do system reservation.

Fields

message_id: MessageId

Message ID which system reservation will be made from.

amount: u64

Amount of reserved gas.

SystemUnreserveGas

Do system unreservation in case it is created but not used.

Fields

message_id: MessageId

Message ID which system reservation was made from.

SendSignal

Send signal.

Fields

message_id: MessageId

Message ID which system reservation was made from.

destination: ProgramId

Program ID which signal will be sent to.

code: SignalCode

Simple signal error.

ReplyDeposit

Create deposit for future reply.

Fields

message_id: MessageId

Message id of the message that generated this message.

future_reply_id: MessageId

Future reply id to be sponsored.

amount: u64

Amount of gas for reply.

Trait Implementations

impl Clone for JournalNote

fn clone(&self) -> JournalNote

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JournalNote

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

Formats the value using the given formatter.

impl Decode for JournalNote

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 Encode for JournalNote

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 EncodeLike for JournalNote