nimiq_address - v1.0.0

nimiq/address

Types

Address

opaque </> 
pub opaque type Address

Values

deserialize

</> 
pub fn deserialize(
  buf: BitArray,
) -> Result(#(Address, BitArray), String)

Deserializes an Address from a BitArray.

deserialize_all

</> 
pub fn deserialize_all(buf: BitArray) -> Result(Address, String)

Deserializes an Address from a BitArray, ensuring that all bytes are consumed.

from_base64

</> 
pub fn from_base64(base64: String) -> Result(Address, String)

Creates an Address from a base64 string. The string must represent exactly 20 bytes.

from_base64_url

</> 
pub fn from_base64_url(
  base64_url: String,
) -> Result(Address, String)

Creates an Address from a base64-url string. The string must represent exactly 20 bytes.

from_hash

</> 
pub fn from_hash(hash: BitArray) -> Result(Address, String)

Creates an Address from a hash (BitArray). The hash must be at least 20 bytes long.

from_hex

</> 
pub fn from_hex(hex: String) -> Result(Address, String)

Creates an Address from a hex string. The string must represent exactly 20 bytes.

from_string

</> 
pub fn from_string(str: String) -> Result(Address, String)

Creates an Address from a string in any supported format.

from_user_friendly_address

</> 
pub fn from_user_friendly_address(
  str: String,
) -> Result(Address, String)

Creates an Address from a user friendly address string.

from_user_friendly_address_ccode

</> 
pub fn from_user_friendly_address_ccode(
  str: String,
  ccode: String,
) -> Result(Address, String)

Creates an Address from a user friendly address string with a custom country code.

serialize

</> 
pub fn serialize(
  builder: bytes_tree.BytesTree,
  address: Address,
) -> bytes_tree.BytesTree

Serializes an Address into a BytesTree.

serialize_to_bits

</> 
pub fn serialize_to_bits(address: Address) -> BitArray

Serializes an Address to a BitArray.

staking_contract

</> 
pub fn staking_contract() -> Address

Creates the staking contract address (all bytes zero except the last byte set to 1).

to_base64

</> 
pub fn to_base64(address: Address) -> String

Converts an Address to its base64 representation.

to_base64_url

</> 
pub fn to_base64_url(address: Address) -> String

Converts an Address to its base64-url representation.

to_hex

</> 
pub fn to_hex(address: Address) -> String

Converts an Address to its hex representation.

to_user_friendly_address

</> 
pub fn to_user_friendly_address(address: Address) -> String

Converts an Address to its user friendly address representation.

to_user_friendly_address_ccode

</> 
pub fn to_user_friendly_address_ccode(
  address: Address,
  ccode: String,
) -> String

Converts an Address to its user friendly address representation with a custom country code.

zero

</> 
pub fn zero() -> Address

Creates an Address with all bytes set to zero (burn address).

✨ Search Document