Struct MessageHeader

pub struct MessageHeader(/* private fields */);

Describes the organization of a :class:Message’s account keys.

Every :class:~solders.instruction.Instruction specifies which accounts it may reference, or otherwise requires specific permissions of. Those specifications are: whether the account is read-only, or read-write; and whether the account must have signed the transaction containing the instruction.

Whereas an individual Instruction contains a list of all accounts they may access, along with their required permissions, a Message contains a single shared flat list of all accounts required by all instructions in a transaction. When building a Message, this flat list is created and each Instruction is converted to :class:~solders.instruction.CompiledInstruction. Each CompiledInstruction then references by index the accounts they require in the single shared account list.

The shared account list is ordered by the permissions required of the accounts:

• accounts that are writable and signers
• accounts that are read-only and signers
• accounts that are writable and not signers
• accounts that are read-only and not signers

Given this ordering, the fields of MessageHeader describe which accounts in a transaction require which permissions.

When multiple transactions access the same read-only accounts, the runtime may process them in parallel, in a single PoH <https://docs.solana.com/cluster/synchronization>_ entry. Transactions that access the same read-write accounts are processed sequentially.

Args: num_required_signatures (int): The number of signatures required for this message to be considered valid. The signers of those signatures must match the first num_required_signatures of :attr:Message.account_keys. num_readonly_signed_accounts (int): The last num_readonly_signed_accounts of the signed keys are read-only accounts. num_readonly_unsigned_accounts (int): The last num_readonly_unsigned_accounts of the unsigned keys are read-only accounts.

Implementations

impl MessageHeader

pub fn new( num_required_signatures: u8, num_readonly_signed_accounts: u8, num_readonly_unsigned_accounts: u8, ) -> Self

pub fn new_default() -> Self

Create a new default MessageHeader.

Returns: MessageHeader: default MessageHeader.

pub fn num_required_signatures(&self) -> u8

pub fn num_readonly_signed_accounts(&self) -> u8

pub fn num_readonly_unsigned_accounts(&self) -> u8

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 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 MessageHeader

fn clone(&self) -> MessageHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommonMethods<'_> for MessageHeader

fn py_to_json(&self) -> String

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

impl CommonMethodsCore for MessageHeader

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 MessageHeader

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

Formats the value using the given formatter.

impl Default for MessageHeader

fn default() -> MessageHeader

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MessageHeader

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MessageHeader

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

Formats the value using the given formatter.

impl From<MessageHeader> for MessageHeader

fn from(original: MessageHeaderOriginal) -> MessageHeader

Converts to this type from the input type.

impl From<MessageHeader> for MessageHeader

fn from(original: MessageHeader) -> Self

Converts to this type from the input type.

impl IntoPy<Py<PyAny>> for MessageHeader

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

Performs the conversion.

impl PartialEq for MessageHeader

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PyBytesBincode for MessageHeader

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

impl PyBytesGeneral for MessageHeader

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

impl PyClass for MessageHeader

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for MessageHeader

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 BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<MessageHeader>

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<MessageHeader> for PyClassImplCollector<MessageHeader>

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

impl PyFromBytesBincode<'_> for MessageHeader

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

impl PyFromBytesGeneral for MessageHeader

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

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

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

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

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

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

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

impl PyMethods<MessageHeader> for PyClassImplCollector<MessageHeader>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for MessageHeader

const NAME: &'static str = "MessageHeader"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

type AsRefTarget = PyCell<MessageHeader>

Utility type to make Py::as_ref work.

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 MessageHeader

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

impl Serialize for MessageHeader

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 MessageHeader

impl StructuralPartialEq for MessageHeader