Struct Builder 

pub struct Builder { /* private fields */ }

Builder used to create Address instances

By default, when no VTXO delivery mechanism is provided by the user, the builder will add the built-in VtxoDelivery::ServerBuiltin. To prevent this, use Builder::no_delivery.

Implementations

impl Builder

pub fn new() -> Self

Create a new Builder

pub fn testnet(self, testnet: bool) -> Self

Set the address to be used for test networks

Default is false.

pub fn server_pubkey(self, server_pubkey: PublicKey) -> Self

Set the Ark server pubkey

pub fn policy(self, policy: VtxoPolicy) -> Self

Set the VTXO policy

pub fn pubkey_policy(self, user_pubkey: PublicKey) -> Self

Set the VTXO policy to the given PublicKey.

pub fn delivery(self, delivery: VtxoDelivery) -> Self

Add the given delivery method

pub fn no_delivery(self) -> Self

Prevent the builder from adding the built-in delivery when no delivery is set.

pub fn mailbox( self, mailbox: MailboxIdentifier, vtxo_key: &Keypair, ) -> Result<Self, AddressBuilderError>

Set the mailbox identifier of the server mailbox to use

This will also disable adding the built-in delivery mechanism.

Errors if no server pubkey was provided yet or if the vtxo key is incorrect.

pub fn into_address(self) -> Result<Address, AddressBuilderError>

Finish by building an Address

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.