Struct NetworkId 

pub struct NetworkId {
    pub network_type: NetworkType,
    pub suffix: Option<u32>,
}

NetworkId is a unique identifier for a kaspa network instance. It is composed of a network type and an optional suffix.

@category Consensus

Fields

network_type: NetworkType

suffix: Option<u32>

Implementations

impl NetworkId

pub const fn new(network_type: NetworkType) -> Self

pub fn try_new(network_type: NetworkType) -> Result<Self, NetworkIdError>

pub const fn with_suffix(network_type: NetworkType, suffix: u32) -> Self

pub fn network_type(&self) -> NetworkType

pub fn is_mainnet(&self) -> bool

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

pub fn default_p2p_port(&self) -> u16

pub fn iter() -> impl Iterator<Item = Self>

pub fn to_prefixed(&self) -> String

Returns a textual description of the network prefixed with kaspa-

pub fn from_prefixed(prefixed: &str) -> Result<Self, NetworkIdError>

impl NetworkId

pub fn ctor(value: &JsValue) -> Result<NetworkId, NetworkIdError>

pub fn js_id(&self) -> String

pub fn js_to_string(&self) -> String

pub fn js_address_prefix(&self) -> String

Methods from Deref<Target = NetworkType>

pub fn default_rpc_port(&self) -> u16

pub fn default_borsh_rpc_port(&self) -> u16

pub fn default_json_rpc_port(&self) -> u16

Trait Implementations

impl BorshDeserialize for NetworkId

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 NetworkId

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

impl CastFromJs for NetworkId

fn try_ref_from_js_value<'a, R>( js: &'a R, ) -> Result<<Self as RefFromWasmAbi>::Anchor, Error>

where R: AsRef<JsValue> + 'a,

Obtain safe reference from JsValue

fn try_long_ref_from_js_value<'a, R>( js: &'a R, ) -> Result<<Self as RefFromWasmAbi>::Anchor, Error>

where R: AsRef<JsValue> + 'a,

Obtain safe long reference from JsValue

fn try_ref_from_js_value_as_cast<'a, R>( js_value: &'a R, ) -> Result<Cast<'a, Self>, Error>

where R: AsRef<JsValue> + 'a,

fn try_long_ref_from_js_value_as_cast<'a, R>( js: &'a R, ) -> Result<Cast<'a, Self>, Error>

where R: AsRef<JsValue> + 'a,

impl Clone for NetworkId

fn clone(&self) -> NetworkId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NetworkId

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

Formats the value using the given formatter.

impl Deref for NetworkId

type Target = NetworkType

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for NetworkId

fn deserialize<D>(deserializer: D) -> Result<NetworkId, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for NetworkId

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

Formats the value using the given formatter.

impl From<NetworkId> for JsValue

fn from(value: NetworkId) -> Self

Converts to this type from the input type.

impl From<NetworkId> for NetworkType

fn from(net: NetworkId) -> Self

Converts to this type from the input type.

impl From<NetworkId> for Params

fn from(value: NetworkId) -> Self

Converts to this type from the input type.

impl From<NetworkId> for Prefix

fn from(net: NetworkId) -> Self

Converts to this type from the input type.

impl FromStr for NetworkId

type Err = NetworkIdError

The associated error which can be returned from parsing.

fn from_str(network_name: &str) -> Result<Self, Self::Err>

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

impl FromWasmAbi for NetworkId

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl Hash for NetworkId

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 IntoWasmAbi for NetworkId

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for NetworkId

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<NetworkId>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for NetworkId

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for NetworkId

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl Ord for NetworkId

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

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

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

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<NetworkId>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for NetworkId

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<NetworkId>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl Serialize for NetworkId

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryCastFromJs for NetworkId

type Error = NetworkIdError

fn try_cast_from<'a, R>(value: &'a R) -> Result<Cast<'_, Self>, Self::Error>

where R: AsRef<JsValue> + 'a,

Try to cast a JsValue into a Rust object. This should be user-defined function that attempts to cast a JsValue into a Rust object or interpret a source data and create a temporary struct owned by by the Cast.

fn try_owned_from(value: impl AsRef<JsValue>) -> Result<Self, Self::Error>

Perform a user cast and consume the Cast container. This function will return a temporary user-created object created during [try_cast_from] or a clone of the casted reference.

fn try_captured_cast_from( js_value: impl AsRef<JsValue>, ) -> Result<Cast<'static, Self>, Self::Error>

fn resolve<'a, R>( js: &'a R, create: impl FnOnce() -> Result<Self, Self::Error>, ) -> Result<Cast<'a, Self>, Self::Error>

where R: AsRef<JsValue> + 'a,

Try to cast a JsValue into a Rust object, in cast of failure invoke a user-supplied closure that can try to create an instance of the object based on the supplied JsValue.

fn resolve_cast<'a, R>( js: &'a R, create: impl FnOnce() -> Result<Cast<'a, Self>, Self::Error>, ) -> Result<Cast<'a, Self>, Self::Error>

where R: AsRef<JsValue> + 'a,

Try to cast a JsValue into a Rust object, in cast of failure invoke a user-supplied closure that can try to create an instance of the object based on the supplied JsValue. Unlike the [resolve] function, this function expects create closure to return a Cast. This is useful when routing the creation of the object to another function that is capable of creating a compatible Cast wrapper.

impl TryFrom<&JsValue> for NetworkId

type Error = NetworkIdError

The type returned in the event of a conversion error.

fn try_from(value: &JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<JsValue> for NetworkId

type Error = NetworkIdError

The type returned in the event of a conversion error.

fn try_from(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NetworkType> for NetworkId

type Error = NetworkIdError

The type returned in the event of a conversion error.

fn try_from(value: NetworkType) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFromJsValue for NetworkId

fn try_from_js_value(value: JsValue) -> Result<Self, JsValue>

Performs the conversion.

fn try_from_js_value_ref(value: &JsValue) -> Option<Self>

Performs the conversion.

impl VectorFromWasmAbi for NetworkId

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[NetworkId]>

impl VectorIntoWasmAbi for NetworkId

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[NetworkId]>) -> Self::Abi

impl WasmDescribe for NetworkId

fn describe()

impl WasmDescribeVector for NetworkId

fn describe_vector()

impl Copy for NetworkId

impl Eq for NetworkId

impl StructuralPartialEq for NetworkId

impl SupportsConstructor for NetworkId

impl SupportsInstanceProperty for NetworkId

impl SupportsStaticProperty for NetworkId