Struct near_primitives::signable_message::MessageDiscriminant

pub struct MessageDiscriminant { /* private fields */ }

Used to distinguish message types that are sign by account keys, to avoid an abuse of signed messages as something else.

This prefix must be be at the first four bytes of a message body that is signed under this signature scheme.

The scheme is a draft introduced to avoid security issues with the implementation of meta transactions (NEP-366) but will eventually be standardized with NEP-461 that solves the problem more generally.

Implementations

impl MessageDiscriminant

pub fn new_on_chain(nep: u32) -> Result<Self, CreateDiscriminantError>

Create a discriminant for an on-chain actionable message that was introduced in the specified NEP.

Allows creating discriminants currently unknown in this crate, which can be useful to prototype new standards. For example, when the client project still relies on an older version of this crate while nightly nearcore already supports a new NEP.

pub fn new_off_chain(nep: u32) -> Result<Self, CreateDiscriminantError>

Create a discriminant for an off-chain message that was introduced in the specified NEP.

Allows creating discriminants currently unknown in this crate, which can be useful to prototype new standards. For example, when the client project still relies on an older version of this crate while nightly nearcore already supports a new NEP.

pub fn raw_discriminant(&self) -> u32

Returns the raw integer value of the discriminant as an integer value.

pub fn is_transaction(&self) -> bool

Whether this discriminant marks a traditional SignedTransaction.

pub fn on_chain_nep(&self) -> Option<u32>

If this discriminant marks a message intended for on-chain use, return the NEP in which the message type was introduced.

pub fn off_chain_nep(&self) -> Option<u32>

If this discriminant marks a message intended for off-chain use, return the NEP in which the message type was introduced.

clippy: MAX_OFF_CHAIN_DISCRIMINANT currently is u32::MAX which makes the comparison pointless, however I think it helps code readability to have it spelled out anyway

Trait Implementations

impl BorshDeserialize for MessageDiscriminant

fn deserialize_reader<__R: Read>(reader: &mut __R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for MessageDiscriminant

fn serialize<__W: Write>(&self, writer: &mut __W) -> Result<(), Error>

impl Clone for MessageDiscriminant

fn clone(&self) -> MessageDiscriminant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MessageDiscriminant

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MessageDiscriminant

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SignableMessageType> for MessageDiscriminant

fn from(ty: SignableMessageType) -> Self

Converts to this type from the input type.

impl Hash for MessageDiscriminant

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MessageDiscriminant

fn cmp(&self, other: &MessageDiscriminant) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for MessageDiscriminant

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

fn partial_cmp(&self, other: &MessageDiscriminant) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for MessageDiscriminant

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<MessageDiscriminant> for SignableMessageType

type Error = ReadDiscriminantError

The type returned in the event of a conversion error.

fn try_from(discriminant: MessageDiscriminant) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for MessageDiscriminant

impl Eq for MessageDiscriminant

impl StructuralPartialEq for MessageDiscriminant