Trait Message

Source

pub trait Message {
Show 15 methods    // Required methods
    fn from(&self) -> Address;
    fn to(&self) -> Address;
    fn sequence(&self) -> u64;
    fn value(&self) -> TokenAmount;
    fn method_num(&self) -> u64;
    fn params(&self) -> &RawBytes;
    fn set_gas_limit(&mut self, amount: u64);
    fn set_sequence(&mut self, sequence: u64);
    fn gas_limit(&self) -> u64;
    fn required_funds(&self) -> TokenAmount;
    fn gas_fee_cap(&self) -> TokenAmount;
    fn gas_premium(&self) -> TokenAmount;
    fn set_gas_fee_cap(&mut self, cap: TokenAmount);
    fn set_gas_premium(&mut self, prem: TokenAmount);

    // Provided method
    fn effective_gas_premium(&self, base_fee: &TokenAmount) -> TokenAmount { ... }
}

Expand description

Message interface to interact with Signed and unsigned messages in a generic context.

Required Methods§

Source

fn from(&self) -> Address

Returns the from address of the message.

Source

fn to(&self) -> Address

Returns the destination address of the message.

Source

fn sequence(&self) -> u64

Returns the message sequence or nonce.

Source

fn value(&self) -> TokenAmount

Returns the amount sent in message.

Source

fn method_num(&self) -> u64

Returns the method number to be called.

Source

fn params(&self) -> &RawBytes

Returns the encoded parameters for the method call.

Source

fn set_gas_limit(&mut self, amount: u64)

sets the gas limit for the message.

Source

fn set_sequence(&mut self, sequence: u64)

sets a new sequence to the message.

Source

fn gas_limit(&self) -> u64

Returns the gas limit for the message.

Source

fn required_funds(&self) -> TokenAmount

Returns the required funds for the message.

Source

fn gas_fee_cap(&self) -> TokenAmount

gets gas fee cap for the message.

Source

fn gas_premium(&self) -> TokenAmount

gets gas premium for the message.

Source

fn set_gas_fee_cap(&mut self, cap: TokenAmount)

sets the gas fee cap.

Source

fn set_gas_premium(&mut self, prem: TokenAmount)

sets the gas premium.

Provided Methods§

Source

fn effective_gas_premium(&self, base_fee: &TokenAmount) -> TokenAmount

This method returns the effective gas premium claimable by the miner given the supplied base fee. This method is not used anywhere except the Eth API.

Filecoin clamps the gas premium at gas_fee_cap - base_fee, if lower than the specified premium. Returns 0 if gas_fee_cap is less than base_fee.