Struct ClientBlockBuilder

pub struct ClientBlockBuilder<'a> { /* private fields */ }

Available on crate feature client only.

Builder of the block API

Implementations

impl<'a> ClientBlockBuilder<'a>

pub async fn prepare_transaction(&self) -> Result<PreparedTransactionData>

Prepare a transaction

pub async fn sign_transaction( &self, prepared_transaction_data: PreparedTransactionData, ) -> Result<TransactionPayload>

Sign the transaction

impl<'a> ClientBlockBuilder<'a>

pub fn new(client: &'a Client) -> Self

Create block builder

pub fn with_burn(self, burn: impl Into<Option<Burn>>) -> Self

Sets explicit burning of aliases, nfts, foundries and native tokens.

pub fn with_secret_manager(self, manager: &'a SecretManager) -> Self

Sets the seed.

pub fn with_coin_type(self, coin_type: u32) -> Self

Sets the coin type.

pub fn with_account_index(self, account_index: u32) -> Self

Sets the account index.

pub fn with_initial_address_index(self, initial_address_index: u32) -> Self

Sets the index of the address to start looking for balance.

pub fn with_input(self, input: UtxoInput) -> Result<Self>

Set a custom input(transaction output)

pub fn with_input_range(self, range: Range<u32>) -> Self

Set a custom range in which to search for addresses for custom provided inputs. Default: 0..100

pub async fn with_output( self, address: impl ConvertTo<Bech32Address>, amount: u64, ) -> Result<ClientBlockBuilder<'a>>

Set a transfer to the builder

pub fn with_outputs( self, outputs: impl IntoIterator<Item = Output>, ) -> Result<Self>

Set outputs to the builder

pub async fn with_output_hex( self, address: &str, amount: u64, ) -> Result<ClientBlockBuilder<'a>>

Set a transfer to the builder, address needs to be hex encoded

pub fn with_custom_remainder_address( self, address: impl ConvertTo<Bech32Address>, ) -> Result<Self>

Set a custom remainder address

pub fn with_tag(self, tag: impl Into<Option<Vec<u8>>>) -> Self

Set tagged_data to the builder

pub fn with_data(self, data: impl Into<Option<Vec<u8>>>) -> Self

Set data to the builder

pub fn with_parents( self, parent_ids: impl Into<Option<Vec<BlockId>>>, ) -> Result<Self>

Set 1-8 custom parent block ids

pub async fn set_options( self, options: ClientBlockBuilderOptions, ) -> Result<ClientBlockBuilder<'a>>

Set multiple options from client block builder options type Useful for bindings

pub async fn finish(self) -> Result<Block>

Consume the builder, post the block to the node and get the API result

pub async fn finish_tagged_data(self) -> Result<Block>

Consume the builder and get the API result

pub async fn finish_block(self, payload: Option<Payload>) -> Result<Block>

Builds the final block and posts it to the node