Merge pull request #1125 from Oscar-Pepper/zip317_send_all

Zip317 send all

libtonode-tests/Cargo.toml

@@ -16,6 +16,7 @@ zingoconfig = { path = "../zingoconfig" }
 
 zcash_primitives = { workspace = true }
 orchard = { workspace = true }
+sapling-crypto = { workspace = true }
 zcash_address = { workspace = true }
 zcash_client_backend = { workspace = true }
 shardtree = { workspace = true }

libtonode-tests/tests/legacy.rs

@@ -1,22 +1,28 @@
 #![forbid(unsafe_code)]
 
 use json::JsonValue;
+use orchard::note_encryption::OrchardDomain;
 use orchard::tree::MerkleHashOrchard;
+use sapling_crypto::note_encryption::SaplingDomain;
 use shardtree::store::memory::MemoryShardStore;
 use shardtree::ShardTree;
 use std::{fs::File, path::Path, time::Duration};
 use zcash_address::unified::Fvk;
 use zcash_client_backend::encoding::encode_payment_address;
+use zcash_primitives::transaction::components::amount::NonNegativeAmount;
 use zcash_primitives::zip339::Mnemonic;
 use zcash_primitives::{
     consensus::{BlockHeight, Parameters},
     transaction::fees::zip317::MINIMUM_FEE,
 };
+use zingo_testutils::lightclient::from_inputs;
 use zingo_testutils::{
     self, build_fvk_client, check_client_balances, check_transaction_equality,
     get_base_address_macro, increase_height_and_wait_for_client, paths::get_cargo_manifest_dir,
     scenarios,
 };
+use zingolib::lightclient::propose::ProposeSendError;
+use zingolib::utils::conversion::address_from_str;
 
 use zingo_testvectors::{
     block_rewards,
@@ -4244,3 +4250,138 @@ mod basic_transactions {
 async fn proxy_server_worky() {
     zingo_testutils::check_proxy_server_works().await
 }
+
+#[tokio::test]
+async fn zip317_send_all() {
+    let (regtest_manager, _cph, faucet, recipient, _) =
+        scenarios::faucet_funded_recipient_default(100_000).await;
+
+    from_inputs::send(
+        &faucet,
+        vec![(&get_base_address_macro!(&recipient, "unified"), 5_000, None)],
+    )
+    .await
+    .unwrap();
+    increase_height_and_wait_for_client(&regtest_manager, &faucet, 1)
+        .await
+        .unwrap();
+    from_inputs::send(
+        &faucet,
+        vec![(
+            &get_base_address_macro!(&recipient, "sapling"),
+            50_000,
+            None,
+        )],
+    )
+    .await
+    .unwrap();
+    increase_height_and_wait_for_client(&regtest_manager, &faucet, 1)
+        .await
+        .unwrap();
+    from_inputs::send(
+        &faucet,
+        vec![(&get_base_address_macro!(&recipient, "sapling"), 4_000, None)],
+    )
+    .await
+    .unwrap();
+    increase_height_and_wait_for_client(&regtest_manager, &faucet, 1)
+        .await
+        .unwrap();
+    from_inputs::send(
+        &faucet,
+        vec![(&get_base_address_macro!(&recipient, "unified"), 4_000, None)],
+    )
+    .await
+    .unwrap();
+    increase_height_and_wait_for_client(&regtest_manager, &faucet, 1)
+        .await
+        .unwrap();
+    recipient.do_sync(false).await.unwrap();
+
+    recipient
+        .propose_send_all(
+            address_from_str(
+                &get_base_address_macro!(faucet, "sapling"),
+                &recipient.config().chain,
+            )
+            .unwrap(),
+            None,
+        )
+        .await
+        .unwrap();
+    recipient
+        .complete_and_broadcast_stored_proposal()
+        .await
+        .unwrap();
+    increase_height_and_wait_for_client(&regtest_manager, &recipient, 1)
+        .await
+        .unwrap();
+    faucet.do_sync(false).await.unwrap();
+
+    assert_eq!(
+        recipient
+            .wallet
+            .confirmed_balance_excluding_dust::<SaplingDomain>(None)
+            .await,
+        Some(0)
+    );
+    assert_eq!(
+        recipient
+            .wallet
+            .confirmed_balance_excluding_dust::<OrchardDomain>(None)
+            .await,
+        Some(0)
+    );
+}
+
+#[tokio::test]
+async fn zip317_send_all_insufficient_funds() {
+    let (_regtest_manager, _cph, faucet, recipient, _) =
+        scenarios::faucet_funded_recipient_default(10_000).await;
+
+    let proposal_error = recipient
+        .propose_send_all(
+            address_from_str(
+                &get_base_address_macro!(faucet, "sapling"),
+                &recipient.config().chain,
+            )
+            .unwrap(),
+            None,
+        )
+        .await;
+
+    match proposal_error {
+        Err(ProposeSendError::Proposal(
+            zcash_client_backend::data_api::error::Error::InsufficientFunds {
+                available: a,
+                required: r,
+            },
+        )) => {
+            assert_eq!(a, NonNegativeAmount::const_from_u64(10_000));
+            assert_eq!(r, NonNegativeAmount::const_from_u64(20_000));
+        }
+        _ => panic!("expected an InsufficientFunds error"),
+    }
+}
+
+#[tokio::test]
+async fn zip317_send_all_zero_value() {
+    let (_regtest_manager, _cph, faucet, recipient, _) =
+        scenarios::faucet_funded_recipient_default(10_000).await;
+
+    let proposal_error = recipient
+        .propose_send_all(
+            address_from_str(
+                &get_base_address_macro!(faucet, "unified"),
+                &recipient.config().chain,
+            )
+            .unwrap(),
+            None,
+        )
+        .await;
+
+    assert!(matches!(
+        proposal_error,
+        Err(ProposeSendError::ZeroValueSendAll)
+    ))
+}

zingolib/src/commands.rs

@@ -1,6 +1,7 @@
 //! An interface that passes strings (e.g. from a cli, into zingolib)
 //! upgrade-or-replace
 
+use crate::data::proposal;
 use crate::wallet::MemoDownloadOption;
 use crate::{lightclient::LightClient, wallet};
 use indoc::indoc;
@@ -892,11 +893,13 @@ impl Command for SendCommand {
             }
         };
         RT.block_on(async move {
-            match lightclient
-                .propose_send(request)
-                .await {
+            match lightclient.propose_send(request).await {
                 Ok(proposal) => {
-                    object! { "fee" => proposal.steps().iter().fold(0, |acc, step| acc + u64::from(step.balance().fee_required())) }
+                    let fee = match proposal::total_fee(&proposal) {
+                        Ok(fee) => fee,
+                        Err(e) => return object! { "error" => e.to_string() }.pretty(2),
+                    };
+                    object! { "fee" => fee.into_u64() }
                 }
                 Err(e) => {
                     object! { "error" => e.to_string() }
@@ -907,8 +910,6 @@ impl Command for SendCommand {
     }
 }
 
-/*
-// Unimplemented
 #[cfg(feature = "zip317")]
 struct SendAllCommand {}
 #[cfg(feature = "zip317")]
@@ -947,24 +948,30 @@ impl Command for SendAllCommand {
             }
         };
         RT.block_on(async move {
-            match lightclient
-                .propose_send_all(address, memo)
-                .await {
+            match lightclient.propose_send_all(address, memo).await {
                 Ok(proposal) => {
+                    let amount = match proposal::total_payment_amount(&proposal) {
+                        Ok(amount) => amount,
+                        Err(e) => return object! { "error" => e.to_string() }.pretty(2),
+                    };
+                    let fee = match proposal::total_fee(&proposal) {
+                        Ok(fee) => fee,
+                        Err(e) => return object! { "error" => e.to_string() }.pretty(2),
+                    };
                     object! {
-                        "amount" => proposal.steps().iter().fold(0, |acc, step| acc + step.shielded_inputs().unwrap().notes().iter().fold(0, |acc, note| acc + u64::from(note.note().value()))),
-                        "fee" => proposal.steps().iter().fold(0, |acc, step| acc + u64::from(step.balance().fee_required())),
+                        "amount" => amount.into_u64(),
+                        "fee" => fee.into_u64(),
                     }
                 }
                 Err(e) => {
-                    object! { "error" => e }
+                    object! { "error" => e.to_string() }
                 }
             }
             .pretty(2)
         })
     }
 }
-*/
+
 #[cfg(feature = "zip317")]
 struct QuickSendCommand {}
 #[cfg(feature = "zip317")]
@@ -1762,7 +1769,7 @@ pub fn get_commands() -> HashMap<&'static str, Box<dyn Command>> {
     }
     #[cfg(feature = "zip317")]
     {
-        //entries.push(("sendall", Box::new(SendAllCommand {})));
+        entries.push(("sendall", Box::new(SendAllCommand {})));
         entries.push(("quicksend", Box::new(QuickSendCommand {})));
         entries.push(("quickshield", Box::new(QuickShieldCommand {})));
         entries.push(("confirm", Box::new(ConfirmCommand {})));

zingolib/src/commands/utils.rs

@@ -102,8 +102,7 @@ pub(super) fn parse_send_args(args: &[&str], chain: &ChainType) -> Result<Receiv
     Ok(send_args)
 }
 
-/*
-// Parse the send arguments for `do_send` when sending all funds from shielded pools.
+// Parse the send arguments for `propose_send` when sending all funds from shielded pools.
 // The send arguments have two possible formats:
 // - 1 argument in the form of a JSON string (single address only). '[{"address":"<address>", "memo":"<optional memo>"}]'
 // - 2 (+1 optional) arguments for a single address send. &["<address>", "<optional memo>"]
@@ -156,7 +155,7 @@ pub(super) fn parse_send_all_args(
 
     Ok((address, memo))
 }
-*/
+
 // Checks send inputs do not contain memo's to transparent addresses.
 fn check_memo_compatibility(
     address: &Address,
@@ -420,7 +419,6 @@ mod tests {
         }
     }
 
-    /*
     #[test]
     #[cfg(feature = "zip317")]
     fn parse_send_all_args() {
@@ -453,7 +451,7 @@ mod tests {
             Err(CommandError::MultipleReceivers)
         ));
     }
-    */
+
     #[test]
     fn check_memo_compatibility() {
         let chain = ChainType::Regtest(RegtestNetwork::all_upgrades_active());

zingolib/src/data/proposal.rs

@@ -1,8 +1,12 @@
 //! The types of transaction Proposal that Zingo! uses.
+
 use std::convert::Infallible;
 
 use zcash_client_backend::proposal::Proposal;
-use zcash_primitives::transaction::fees::zip317::FeeRule;
+use zcash_primitives::transaction::{
+    components::amount::{BalanceError, NonNegativeAmount},
+    fees::zip317::FeeRule,
+};
 
 /// A proposed send to addresses.
 /// Identifies the notes to spend by txid, pool, and output_index.
@@ -25,3 +29,53 @@ pub(crate) enum ZingoProposal {
     #[allow(dead_code)] // TOdo construct it
     Shield(ShieldProposal),
 }
+
+/// total sum of all transaction request payment amounts in a proposal
+/// TODO: test for multi-step, zip320 currently unsupported.
+pub fn total_payment_amount(
+    proposal: &TransferProposal,
+) -> Result<NonNegativeAmount, BalanceError> {
+    proposal
+        .steps()
+        .iter()
+        .map(|step| step.transaction_request())
+        .try_fold(NonNegativeAmount::ZERO, |acc, request| {
+            (acc + request.total()?).ok_or(BalanceError::Overflow)
+        })
+}
+
+/// total sum of all fees in a proposal
+/// TODO: test for multi-step, zip320 currently unsupported.
+pub fn total_fee(proposal: &TransferProposal) -> Result<NonNegativeAmount, BalanceError> {
+    proposal
+        .steps()
+        .iter()
+        .map(|step| step.balance().fee_required())
+        .try_fold(NonNegativeAmount::ZERO, |acc, fee| {
+            (acc + fee).ok_or(BalanceError::Overflow)
+        })
+}
+
+#[cfg(test)]
+mod tests {
+    use zcash_primitives::transaction::components::amount::NonNegativeAmount;
+
+    use crate::mocks;
+
+    #[test]
+    fn total_payment_amount() {
+        let proposal = mocks::proposal::ProposalBuilder::default().build();
+        assert_eq!(
+            super::total_payment_amount(&proposal).unwrap(),
+            NonNegativeAmount::from_u64(100_000).unwrap()
+        );
+    }
+    #[test]
+    fn total_fee() {
+        let proposal = mocks::proposal::ProposalBuilder::default().build();
+        assert_eq!(
+            super::total_fee(&proposal).unwrap(),
+            NonNegativeAmount::from_u64(20_000).unwrap()
+        );
+    }
+}