Struct PrefixedDenom

pub struct PrefixedDenom {
    pub trace_path: TracePath,
    pub base_denom: BaseDenom,
}

A type that contains the base denomination for ICS20 and the source tracing information path.

Fields

trace_path: TracePath

A series of {port-id}/{channel-id}s for tracing the source of the token.

base_denom: BaseDenom

Base denomination of the relayed fungible token.

Implementations

impl PrefixedDenom

pub fn remove_trace_prefix(&mut self, prefix: &TracePrefix)

Removes the specified prefix from the trace path if there is a match, otherwise does nothing.

pub fn add_trace_prefix(&mut self, prefix: TracePrefix)

Adds the specified prefix to the trace path.

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for PrefixedDenom

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<PrefixedDenom, Error>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest( u: Unstructured<'arbitrary>, ) -> Result<PrefixedDenom, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl BorshDeserialize for PrefixedDenom

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

where __R: Read,

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 PrefixedDenom

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

where __W: Write,

impl Clone for PrefixedDenom

fn clone(&self) -> PrefixedDenom

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PrefixedDenom

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

Formats the value using the given formatter.

impl Decode for PrefixedDenom

fn decode<__CodecInputEdqy>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<PrefixedDenom, Error>

where __CodecInputEdqy: Input,

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<'de> Deserialize<'de> for PrefixedDenom

fn deserialize<__D>( __deserializer: __D, ) -> Result<PrefixedDenom, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PrefixedDenom

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

Formats the value using the given formatter.

impl Encode for PrefixedDenom

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

where __CodecOutputEdqy: Output + ?Sized,

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl From<BaseDenom> for PrefixedDenom

fn from(denom: BaseDenom) -> PrefixedDenom

Converts to this type from the input type.

impl From<PrefixedDenom> for DenomTrace

fn from(value: PrefixedDenom) -> DenomTrace

Converts to this type from the input type.

impl FromStr for PrefixedDenom

fn from_str(s: &str) -> Result<PrefixedDenom, <PrefixedDenom as FromStr>::Err>

Initializes a PrefixedDenom from a string that adheres to the format {nth-port-id/channel-<index>}/{(n-1)th-port-id/channel-<index>}/.../{1st-port-id/channel-<index>}/<base_denom>. A PrefixedDenom exhibits a sequence of {ith-port-id/channel-<index>} pairs. This sequence makes up the TracePath of the PrefixedDenom.

This PrefixedDenom::from_str implementation left-split-twice the argument string using / delimiter. Then it peeks into the first two segments and attempts to convert the first segment into a PortId and the second into a ChannelId. This continues on the third remaining segment in a loop until a {port-id/channel-id} pair cannot be created from the top two segments. The remaining parts of the string are then considered the BaseDenom.

For example, given the following denom trace: “transfer/channel-75/factory/stars16da2uus9zrsy83h23ur42v3lglg5rmyrpqnju4/dust”, the first two /-delimited segments are "transfer" and "channel-75". The first is a valid PortId, and the second is a valid ChannelId, so that becomes the first {port-id/channel-id} pair that gets added as part of the TracePath of the PrefixedDenom. The next two segments are "factory", a valid PortId, and "stars16da2uus9zrsy83h23ur42v3lglg5rmyrpqnju4", an invalid ChannelId. The loop breaks at this point, resulting in a TracePath of "transfer/channel-75" and a BaseDenom of "factory/stars16da2uus9zrsy83h23ur42v3lglg5rmyrpqnju4/dust".

type Err = DecodingError

The associated error which can be returned from parsing.

impl JsonSchema for PrefixedDenom

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Ord for PrefixedDenom

fn cmp(&self, other: &PrefixedDenom) -> 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,

Restrict a value to a certain interval.

impl PartialEq for PrefixedDenom

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for PrefixedDenom

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<DenomTrace> for PrefixedDenom

type Error = DecodingError

The type returned in the event of a conversion error.

fn try_from( value: DenomTrace, ) -> Result<PrefixedDenom, <PrefixedDenom as TryFrom<DenomTrace>>::Error>

Performs the conversion.

impl TypeInfo for PrefixedDenom

type Identity = PrefixedDenom

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl EncodeLike for PrefixedDenom

impl Eq for PrefixedDenom

impl StructuralPartialEq for PrefixedDenom