Skip to content

Correct the doc comment and add a test for Builder::value_balance #359

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nuttycom merged 2 commits into from
Oct 10, 2022
Merged

Correct the doc comment and add a test for Builder::value_balance #359

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fbfc8f9
Correct the doc comment for the `Builder::value_balance` method added…
daira Sep 19, 2022
6458e27
Add minimal test that `Builder::value_balance` works.
daira Sep 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion src/builder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,12 @@ impl Builder {
/// minus the value of all outputs.
///
/// Useful for balancing a transaction, as the value balance of an individual bundle
/// can be non-zero, but a transaction may not have a positive total value balance.
/// can be non-zero. Each bundle's value balance is [added] to the transparent
/// transaction value pool, which [must not have a negative value]. (If it were
/// negative, the transaction would output more value than it receives in inputs.)
///
/// [added]: https://zips.z.cash/protocol/protocol.pdf#orchardbalance
/// [must not have a negative value]: https://zips.z.cash/protocol/protocol.pdf#transactions
pub fn value_balance<V: TryFrom<i64>>(&self) -> Result<V, value::OverflowError> {
let value_balance = self
.spends
Expand Down Expand Up @@ -827,6 +832,9 @@ mod tests {
builder
.add_recipient(None, recipient, NoteValue::from_raw(5000), None)
.unwrap();
let balance: i64 = builder.value_balance().unwrap();
assert_eq!(balance, -5000);

let bundle: Bundle<Authorized, i64> = builder
.build(&mut rng)
.unwrap()
Expand Down