Struct ChainId

pub struct ChainId {
    pub id: String,
    pub version: u64,
}

This type is subject to future changes.

TODO: ChainId validation is not standardized yet. is_epoch_format will most likely be replaced by validate_chain_id()-style function. See: https://github.com/informalsystems/ibc-rs/pull/304#discussion_r503917283.

Also, contrast with tendermint-rs ChainId type.

Fields

id: String

version: u64

Implementations

impl ChainId

pub fn new(name: String, version: u64) -> ChainId

Creates a new ChainId given a chain name and an epoch number.

The returned ChainId will have the format: {chain name}-{epoch number}.

let epoch_number = 10;
let id = ChainId::new("chainA".to_string(), epoch_number);
assert_eq!(id.version(), epoch_number);

pub fn from_string(id: &str) -> ChainId

pub fn as_str(&self) -> &str

Get a reference to the underlying string.

pub fn version(&self) -> u64

Extract the version from this chain identifier.

pub fn chain_version(chain_id: &str) -> u64

Extract the version from the given chain identifier.

assert_eq!(ChainId::chain_version("chain--a-0"), 0);
assert_eq!(ChainId::chain_version("ibc-10"), 10);
assert_eq!(ChainId::chain_version("cosmos-hub-97"), 97);
assert_eq!(ChainId::chain_version("testnet-helloworld-2"), 2);

pub fn is_epoch_format(chain_id: &str) -> bool

is_epoch_format() checks if a chain_id is in the format required for parsing epochs The chainID must be in the form: {chainID}-{version}

assert_eq!(ChainId::is_epoch_format("chainA-0"), false);
assert_eq!(ChainId::is_epoch_format("chainA"), false);
assert_eq!(ChainId::is_epoch_format("chainA-1"), true);
assert_eq!(ChainId::is_epoch_format("c-1"), true);

pub fn with_version(self, version: u64) -> ChainId

with_version() checks if a chain_id is in the format required for parsing epochs, and if so replaces it’s version with the specified version

assert_eq!(ChainId::new("chainA".to_string(), 1).with_version(2), ChainId::new("chainA".to_string(), 2));
assert_eq!("chain1".parse::<ChainId>().unwrap().with_version(2), "chain1".parse::<ChainId>().unwrap());

Trait Implementations

impl Clone for ChainId

fn clone(&self) -> ChainId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChainId

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

Formats the value using the given formatter.

impl Default for ChainId

fn default() -> ChainId

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChainId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ChainId

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

Formats the value using the given formatter.

impl From<Id> for ChainId

fn from(id: Id) -> ChainId

Converts to this type from the input type.

impl From<String> for ChainId

fn from(value: String) -> ChainId

Converts to this type from the input type.

impl FromStr for ChainId

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(id: &str) -> Result<ChainId, <ChainId as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for ChainId

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

where __H: Hasher,

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 ChainId

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

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

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

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 Eq for ChainId

impl StructuralPartialEq for ChainId