Struct iota_client::api::ClientMessageBuilder

pub struct ClientMessageBuilder<'a> { /* fields omitted */ }

Builder of the message API

Implementations

impl<'a> ClientMessageBuilder<'a>

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

Create message builder

pub fn with_seed(self, seed: &'a Seed) -> Self

Sets the seed.

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

Sets the account index.

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

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

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

Set a custom input(transaction output)

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

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

pub fn with_output(self, address: &str, amount: u64) -> Result<Self>

Set a transfer to the builder

pub fn with_dust_allowance_output(
    self,
    address: &str,
    amount: u64
) -> Result<Self>

Set a dust allowance transfer to the builder, address needs to be Bech32 encoded

pub fn with_output_hex(self, address: &str, amount: u64) -> Result<Self>

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

pub fn with_index<I: AsRef<[u8]>>(self, index: I) -> Self

Set indexation to the builder

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

Set data to the builder

pub fn with_parents(self, parent_ids: Vec<MessageId>) -> Result<Self>

Set 1-8 custom parent message ids

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

Consume the builder and get the API result

pub fn get_output_amount_and_address(
    output: &OutputDto
) -> Result<(u64, Address, bool)>

Get output amount and address from an OutputDto (bool true == SignatureLockedSingle, false == SignatureLockedDustAllowance)

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

Prepare a transaction

pub async fn sign_transaction(
    &self,
    prepared_transaction_data: PreparedTransactionData,
    seed: Option<&'a Seed>,
    inputs_range: Option<Range<usize>>
) -> Result<Payload>

Sign the transaction

pub async fn finish_indexation(self) -> Result<Message>

Consume the builder and get the API result

pub async fn finish_message(self, payload: Option<Payload>) -> Result<Message>

Builds the final message and posts it to the node