Struct Address 

pub struct Address { /* private fields */ }

An Ark address

Used to address VTXO payments in an Ark.

Example usage:

let srv_pubkey = "03d2e3205d9fd8fb2d441e9c3aa5e28ac895f7aae68c209ae918e2750861e8ffc1".parse().unwrap();
let vtxo_pubkey = "035c4def84a9883afe60ef72b37aaf8038dd74ed3d0ab1a1f30610acccd68d1cdd".parse().unwrap();

let addr = ark::Address::builder()
	.server_pubkey(srv_pubkey)
	.pubkey_policy(vtxo_pubkey)
	.into_address().unwrap();

assert_eq!(addr.to_string(),
	"ark1pndckx4ezqqp4cn00sj5cswh7vrhh9vm647qr3ht5a57s4vdp7vrpptxv66x3ehgpqqnevf3z",
);

Implementations

impl Address

pub fn builder() -> Builder

Start building an Address

pub fn new( testnet: bool, ark_id: impl Into<ArkId>, policy: VtxoPolicy, delivery: Vec<VtxoDelivery>, ) -> Address

Create a new Address

Note that it might be more convenient to use Address::builder instead.

pub fn is_testnet(&self) -> bool

Whether or not this Address is intended to be used in a test network

pub fn ark_id(&self) -> ArkId

The ArkId of the Ark in which the user wants to be paid

pub fn is_for_server(&self, server_pubkey: PublicKey) -> bool

Check whether this Address matches the given server pubkey

pub fn policy(&self) -> &VtxoPolicy

The VTXO policy the user wants to be paid in

pub fn delivery(&self) -> &[VtxoDelivery]

The different VTXO delivery options provided by the user

pub fn encode_payload<W: Write + ?Sized>( &self, writer: &mut W, ) -> Result<(), Error>

Write the address payload to the writer

pub fn decode_payload( testnet: bool, bytes: impl Iterator<Item = u8>, ) -> Result<Address, ParseAddressError>

Read the address payload from the byte iterator

Returns an address straight away given the testnet indicator.

Trait Implementations

impl Clone for Address

fn clone(&self) -> Address

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Address

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

Formats the value using the given formatter.

impl Display for Address

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

Formats the value using the given formatter.

impl FromStr for Address

type Err = ParseAddressError

The associated error which can be returned from parsing.

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

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

impl Hash for Address

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 Address

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

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

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

impl StructuralPartialEq for Address