Struct forest_message::unsigned_message::UnsignedMessage

pub struct UnsignedMessage {
    pub version: i64,
    pub from: Address,
    pub to: Address,
    pub sequence: u64,
    pub value: TokenAmount,
    pub method_num: MethodNum,
    pub params: Serialized,
    pub gas_limit: i64,
    pub gas_fee_cap: TokenAmount,
    pub gas_premium: TokenAmount,
}

Default Unsigned VM message type which includes all data needed for a state transition

Usage:

use forest_message::{UnsignedMessage, Message};
use vm::{TokenAmount, Serialized, MethodNum};
use address::Address;

// Use the builder pattern to generate a message
let message = UnsignedMessage::builder()
    .to(Address::new_id(0))
    .from(Address::new_id(1))
    .sequence(0) // optional
    .value(TokenAmount::from(0u8)) // optional
    .method_num(MethodNum::default()) // optional
    .params(Serialized::default()) // optional
    .gas_limit(0) // optional
    .version(0) // optional
    .build()
    .unwrap();

let mut message_builder = UnsignedMessage::builder();
message_builder.sequence(1);
message_builder.from(Address::new_id(0));
message_builder.to(Address::new_id(1));
let msg = message_builder.build().unwrap();
assert_eq!(msg.sequence(), 1);

Fields

version: i64

from: Address

to: Address

sequence: u64

value: TokenAmount

method_num: MethodNum

params: Serialized

gas_limit: i64

gas_fee_cap: TokenAmount

gas_premium: TokenAmount

Implementations

impl UnsignedMessage

pub fn builder() -> MessageBuilder

pub fn to_signing_bytes(&self) -> Vec<u8>

Helper function to convert the message into signing bytes. This function returns the message Cid bytes.

pub fn valid_for_block_inclusion(
    &self,
    min_gas: i64,
    version: NetworkVersion
) -> Result<(), String>

Semantic validation and validates the message has enough gas.

Trait Implementations

impl Cbor for UnsignedMessage

pub fn marshal_cbor(&self) -> Result<Vec<u8, Global>, Error>

Marshalls cbor encodable object into cbor bytes

pub fn unmarshal_cbor(bz: &[u8]) -> Result<Self, Error>

Unmarshals cbor encoded bytes to object

pub fn cid(&self) -> Result<Cid, Error>

Returns the content identifier of the raw block of data Default is Blake2b256 hash

impl Clone for UnsignedMessage

fn clone(&self) -> UnsignedMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnsignedMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UnsignedMessage

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for UnsignedMessage

impl From<UnsignedMessage> for UnsignedMessageJson

fn from(wrapper: UnsignedMessage) -> Self

Performs the conversion.

impl From<UnsignedMessageJson> for UnsignedMessage

fn from(wrapper: UnsignedMessageJson) -> Self

Performs the conversion.

impl Hash for UnsignedMessage

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Message for UnsignedMessage

fn from(&self) -> &Address

Returns the from address of the message.

fn to(&self) -> &Address

Returns the destination address of the message.

fn sequence(&self) -> u64

Returns the message sequence or nonce.

fn value(&self) -> &TokenAmount

Returns the amount sent in message.

fn method_num(&self) -> MethodNum

Returns the method number to be called.

fn params(&self) -> &Serialized

Returns the encoded parameters for the method call.

fn set_sequence(&mut self, new_sequence: u64)

sets a new sequence to the message.

fn gas_limit(&self) -> i64

Returns the gas limit for the message.

fn gas_fee_cap(&self) -> &TokenAmount

gets gas fee cap for the message.

fn gas_premium(&self) -> &TokenAmount

gets gas premium for the message.

fn set_gas_limit(&mut self, token_amount: i64)

sets the gas limit for the message.

fn set_gas_fee_cap(&mut self, cap: TokenAmount)

sets the gas fee cap.

fn set_gas_premium(&mut self, prem: TokenAmount)

sets the gas premium.

fn required_funds(&self) -> TokenAmount

Returns the required funds for the message.

impl PartialEq<UnsignedMessage> for UnsignedMessage

fn eq(&self, other: &UnsignedMessage) -> bool

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

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

This method tests for !=.

impl Serialize for UnsignedMessage

fn serialize<S>(&self, s: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for UnsignedMessage

impl StructuralPartialEq for UnsignedMessage