Skip to content

Conversation

Thoralf-M
Copy link
Member

Fixes #297

@Thoralf-M Thoralf-M linked an issue Oct 14, 2025 that may be closed by this pull request
@Thoralf-M Thoralf-M changed the title docs: improve send_iota() docs feat: improve send_iota() docs Oct 14, 2025
@Thoralf-M Thoralf-M changed the title feat: improve send_iota() docs feat(iota-transaction-builder): improve send_iota() docs Oct 14, 2025
/// )?;
///
/// let mut builder = TransactionBuilder::new(from_address).with_client(client);
/// builder.send_iota::<u64>(to_address, 5000000000u64);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the explicit generic argument needed?

/// equals 1_000_000_000 NANOS.
/// If `amount` is provided, that amount is split from the gas coin and
/// sent.
/// If `amount` is `None`, the entire gas coin is transferred.
Copy link
Contributor

@Alex6323 Alex6323 Oct 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That feels dangerous, but probably you'll tell that it isnt bc of some good reason, right? So people forgetting in the bindings, where you can just leave it out, send the entire coin?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Tx builder: document TransactionBuilder::send_iota()

3 participants