Struct solders_message::MessageV0

pub struct MessageV0(pub Message);

A Solana transaction message (v0).

This message format supports succinct account loading with on-chain address lookup tables

Args: header (MessageHeader): The message header, identifying signed and read-only account_keys. Header values only describe static account_keys, they do not describe any additional account keys loaded via address table lookups. account_keys (SequencePubkey): List of accounts loaded by this transaction. recent_blockhash (Hash): Hash of a recent block. instructions (SequenceInstruction): The instructions to include in the message. address_table_lookups (SequenceMessageAddressTableLookup): List of address table lookups used to load additional accounts for this transaction.

Example: >>> from solders.message import MessageV0, MessageHeader, MessageAddressTableLookup >>> from solders.instruction import CompiledInstruction >>> from solders.hash import Hash >>> from solders.pubkey import Pubkey >>> program_id = Pubkey.default() >>> arbitrary_instruction_data = bytes([1]) >>> accounts = [] >>> instructions=[CompiledInstruction(program_id_index=4, accounts=bytes([1, 2, 3, 5, 6]), data=bytes([]))] >>> account_keys = [Pubkey.new_unique()] >>> header = MessageHeader(1, 0, 0) >>> lookups = [MessageAddressTableLookup(Pubkey.new_unique(), bytes([1, 2, 3]), bytes([0]))] >>> blockhash = Hash.default() # replace with a real blockhash >>> message = MessageV0(header, account_keys, blockhash, instructions, lookups)

Tuple Fields

0: Message

Implementations

impl MessageV0

pub fn new( header: MessageHeader, account_keys: Vec<Pubkey>, recent_blockhash: SolderHash, instructions: Vec<CompiledInstruction>, address_table_lookups: Vec<MessageAddressTableLookup> ) -> Self

pub fn header(&self) -> MessageHeader

pub fn account_keys(&self) -> Vec<Pubkey>

pub fn recent_blockhash(&self) -> SolderHash

pub fn instructions(&self) -> Vec<CompiledInstruction>

pub fn address_table_lookups(&self) -> Vec<MessageAddressTableLookup>

pub fn try_compile( payer: &Pubkey, instructions: Vec<Instruction>, address_lookup_table_accounts: Vec<AddressLookupTableAccount>, recent_blockhash: SolderHash ) -> PyResult<Self>

Create a signable transaction message from a payer public key, recent_blockhash, list of instructions, and a list of address_lookup_table_accounts.

Args: payer (Pubkey): The fee payer. instructions (SequenceInstruction): The instructions to include in the message. address_table_lookups (SequenceMessageAddressTableLookup): List of address table lookups used to load additional accounts for this transaction. recent_blockhash (Hash): Hash of a recent block.

Example: >>> from solders.pubkey import Pubkey >>> from solders.instruction import Instruction, AccountMeta >>> from solders.message import Message >>> from solders.address_lookup_table_account import AddressLookupTableAccount >>> from solders.hash import Hash >>> keys = [Pubkey.new_unique() for i in range(7)] >>> payer = keys[0] >>> program_id = keys[6] >>> ix_accounts = [AccountMeta(keys[1], True, True), AccountMeta(keys[2], True, False), AccountMeta(keys[3], False, True),AccountMeta(keys[4], False, True),AccountMeta(keys[5], False, False),] >>> instructions = [Instruction(program_id, bytes([]), ix_accounts)] >>> lookup_acc0 = AddressLookupTableAccount(key=Pubkey.new_unique(), addresses=[keys[4], keys[5], keys[6]]) >>> lookup_acc1 = AddressLookupTableAccount(key=Pubkey.new_unique(), addresses=[]) >>> lookup_accs = [lookup_acc0, lookup_acc1] >>> recent_blockhash = Hash.new_unique() >>> msg = MessageV0.try_compile(payer, instructions, lookup_accs, recent_blockhash)

pub fn sanitize(&self) -> PyResult<()>

Sanitize message fields and compiled instruction indexes.

pub fn is_key_called_as_program(&self, key_index: usize) -> bool

Returns true if the account at the specified index is called as a program by an instruction

pub fn is_maybe_writable(&self, key_index: usize) -> bool

Returns true if the account at the specified index was requested as writable. Before loading addresses, we can’t demote write locks for dynamically loaded addresses so this should not be used by the runtime.

pub fn is_signer(&self, index: usize) -> bool

Returns true if the account at the specified index signed this message.

pub fn is_non_loader_key(&self, key_index: usize) -> bool

Returns true if the account at the specified index is not invoked as a program or, if invoked, is passed to a program.

pub fn hash(&self) -> SolderHash

Compute the blake3 hash of this transaction’s message.

Returns: Hash: The blake3 hash.

pub fn hash_raw_message(message_bytes: &[u8]) -> SolderHash

Compute the blake3 hash of a raw transaction message.

Returns: Hash: The blake3 hash.

pub fn new_default() -> Self

Create a new default MessageV0.

Returns: MessageV0: default MessageV0.

pub fn __richcmp__(&self, other: &Self, op: CompareOp) -> PyResult<bool>

pub fn __bytes__<'a>(&self, py: Python<'a>) -> &'a PyBytes

pub fn __str__(&self) -> String

pub fn __repr__(&self) -> String

pub fn __reduce__(&self) -> PyResult<(PyObject, PyObject)>

pub fn from_bytes(data: &[u8]) -> PyResult<Self>

Deserialize from bytes.

Args: data (bytes): the serialized object.

Returns: the deserialized object.

pub fn to_json(&self) -> String

Convert to a JSON string.

pub fn from_json(raw: &str) -> PyResult<Self>

Build from a JSON string.

Trait Implementations

impl Clone for MessageV0

fn clone(&self) -> MessageV0

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommonMethods<'_> for MessageV0

fn py_to_json(&self) -> String

fn py_from_json(raw: &'a str) -> Result<Self, PyErr>

impl CommonMethodsCore for MessageV0

fn pybytes<'b>(&self, py: Python<'b>) -> &'b PyBytes

fn pystr(&self) -> String

fn pyrepr(&self) -> String

fn py_from_bytes(raw: &[u8]) -> Result<Self, PyErr>

fn pyreduce(&self) -> Result<(Py<PyAny>, Py<PyAny>), PyErr>

impl Debug for MessageV0

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

Formats the value using the given formatter.

impl Default for MessageV0

fn default() -> MessageV0

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MessageV0

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MessageV0

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

Formats the value using the given formatter.

impl From<Message> for MessageV0

fn from(original: MessageV0Original) -> MessageV0

Converts to this type from the input type.

impl From<MessageV0> for Message

fn from(original: MessageV0) -> Self

Converts to this type from the input type.

impl From<MessageV0> for VersionedMessage

fn from(m: MessageV0) -> Self

Converts to this type from the input type.

impl From<MessageV0> for VersionedMessage

fn from(m: MessageV0) -> Self

Converts to this type from the input type.

impl From<VersionedMessage> for MessageV0

fn from(v: VersionedMessage) -> Self

Converts to this type from the input type.

impl From<VersionedMessage> for MessageV0

fn from(v: VersionedMessageOriginal) -> Self

Converts to this type from the input type.

impl IntoPy<Py<PyAny>> for MessageV0

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl PartialEq for MessageV0

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

fn pybytes_bincode<'a>(&self, py: Python<'a>) -> &'a PyBytes

impl PyBytesGeneral for MessageV0

fn pybytes_general<'a>(&self, py: Python<'a>) -> &'a PyBytes

impl PyClass for MessageV0

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for MessageV0

const IS_BASETYPE: bool = true

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

type Layout = PyCell<MessageV0>

Layout

type BaseType = PyAny

Base class

type ThreadChecker = ThreadCheckerStub<MessageV0>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<MessageV0> for PyClassImplCollector<MessageV0>

fn new_text_signature(self) -> Option<&'static str>

impl PyFromBytesBincode<'_> for MessageV0

fn py_from_bytes_bincode(raw: &'b [u8]) -> Result<Self, PyErr>

impl PyFromBytesGeneral for MessageV0

fn py_from_bytes_general(raw: &[u8]) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a MessageV0

type Holder = Option<PyRef<'py, MessageV0>>

fn extract(obj: &'py PyAny, holder: &'a mut Self::Holder) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut MessageV0

type Holder = Option<PyRefMut<'py, MessageV0>>

fn extract(obj: &'py PyAny, holder: &'a mut Self::Holder) -> PyResult<Self>

impl PyMethods<MessageV0> for PyClassImplCollector<MessageV0>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for MessageV0

type AsRefTarget = PyCell<MessageV0>

Utility type to make Py::as_ref work.

const NAME: &'static str = "MessageV0"

Class name.

const MODULE: Option<&'static str> = _

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> &PyType

Returns the safe abstraction over the type object.

fn is_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type.

impl RichcmpEqualityOnly for MessageV0

fn richcmp(&self, other: &Self, op: CompareOp) -> Result<bool, PyErr>

impl Serialize for MessageV0

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 MessageV0

impl StructuralEq for MessageV0

impl StructuralPartialEq for MessageV0