zingolib 7.0.0

Zingo backend library.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

//! Record-fabrication rig shared by this crate's integration tests.
#![allow(dead_code)]

use std::str::FromStr as _;

use pepper_sync::wallet::{IronwoodNote, OutgoingIronwoodNote, OutputId, WalletTransaction};
use zcash_primitives::transaction::TxId;
use zcash_protocol::memo::Memo;
use zingo_common_components::protocol::ActivationHeights;
use zingo_status::confirmation_status::ConfirmationStatus;
use zingolib::config::ChainType;
use zingolib::mocks::orchard_note::OrchardCryptoNoteBuilder;
use zingolib::testutils::synthetic_wallet::SyntheticWalletBuilder;
use zingolib::wallet::LightWallet;

pub fn regtest_wallet(mnemonic_phrase: &str) -> LightWallet {
    SyntheticWalletBuilder::new(mnemonic_phrase).build()
}

/// The wallet's first orchard receiver.
pub fn own_orchard_receiver(wallet: &LightWallet) -> orchard::Address {
    *wallet
        .unified_addresses()
        .values()
        .next()
        .unwrap()
        .orchard()
        .unwrap()
}

/// The Zennies-for-Zingo unified address for the regtest chain.
pub fn zfz_unified_address() -> zcash_client_backend::address::UnifiedAddress {
    let network = ChainType::Regtest(ActivationHeights::default());
    let zcash_client_backend::address::Address::Unified(address) =
        zcash_client_backend::address::Address::decode(
            &network,
            zingolib::get_zennies_for_zingo_address(network),
        )
        .unwrap()
    else {
        panic!("ZFZ address must be unified");
    };
    *address
}

pub fn received(txid_byte: u8, height: u32, memos: &[Memo]) -> WalletTransaction {
    let txid = TxId::from_bytes([txid_byte; 32]);
    WalletTransaction::new_for_test_with_ironwood_notes(
        txid,
        ConfirmationStatus::Confirmed(height.into()),
        memos
            .iter()
            .enumerate()
            .map(|(index, memo)| {
                IronwoodNote::new_for_test(
                    OutputId::new(txid, index as u32),
                    zip32::AccountId::ZERO,
                    zip32::Scope::External,
                    OrchardCryptoNoteBuilder::default().build(),
                    memo.clone(),
                    None,
                )
            })
            .collect(),
        vec![],
    )
}

/// As [`received`], but taking plain strings, as the pre-extraction test
/// rig did.
pub fn received_texts(txid_byte: u8, height: u32, memos: &[&str]) -> WalletTransaction {
    let memos = memos
        .iter()
        .map(|memo| Memo::from_str(memo).unwrap())
        .collect::<Vec<_>>();
    received(txid_byte, height, &memos)
}

pub fn sent(
    txid_byte: u8,
    height: u32,
    recipient: &zcash_client_backend::address::UnifiedAddress,
    memo: &str,
) -> WalletTransaction {
    let txid = TxId::from_bytes([txid_byte; 32]);
    WalletTransaction::new_for_test_with_ironwood_notes(
        txid,
        ConfirmationStatus::Confirmed(height.into()),
        vec![],
        vec![OutgoingIronwoodNote::new_for_test(
            OutputId::new(txid, 0),
            zip32::AccountId::ZERO,
            zip32::Scope::External,
            OrchardCryptoNoteBuilder::default().build(),
            Memo::from_str(memo).unwrap(),
            Some(recipient.clone()),
        )],
    )
}

/// A basic send-to-self: one internally self-received note whose outgoing
/// view is addressed to `own_receiver`.
pub fn self_send(txid_byte: u8, height: u32, own_receiver: orchard::Address) -> WalletTransaction {
    let txid = TxId::from_bytes([txid_byte; 32]);
    WalletTransaction::new_for_test_with_ironwood_notes(
        txid,
        ConfirmationStatus::Confirmed(height.into()),
        vec![IronwoodNote::new_for_test(
            OutputId::new(txid, 0),
            zip32::AccountId::ZERO,
            zip32::Scope::Internal,
            OrchardCryptoNoteBuilder::default().build(),
            Memo::Empty,
            None,
        )],
        vec![OutgoingIronwoodNote::new_for_test(
            OutputId::new(txid, 0),
            zip32::AccountId::ZERO,
            zip32::Scope::External,
            OrchardCryptoNoteBuilder::default()
                .recipient(own_receiver)
                .build(),
            Memo::Empty,
            None,
        )],
    )
}

/// The Zennies-for-Zingo dual-output pattern: a send-to-self output to
/// `own_receiver` plus a send to the ZFZ address in one transaction.
pub fn zfz_self_send(
    txid_byte: u8,
    height: u32,
    own_receiver: orchard::Address,
) -> WalletTransaction {
    let txid = TxId::from_bytes([txid_byte; 32]);
    WalletTransaction::new_for_test_with_ironwood_notes(
        txid,
        ConfirmationStatus::Confirmed(height.into()),
        vec![],
        vec![
            OutgoingIronwoodNote::new_for_test(
                OutputId::new(txid, 0),
                zip32::AccountId::ZERO,
                zip32::Scope::External,
                OrchardCryptoNoteBuilder::default()
                    .recipient(own_receiver)
                    .build(),
                Memo::Empty,
                None,
            ),
            OutgoingIronwoodNote::new_for_test(
                OutputId::new(txid, 1),
                zip32::AccountId::ZERO,
                zip32::Scope::External,
                OrchardCryptoNoteBuilder::default().build(),
                Memo::Empty,
                Some(zfz_unified_address()),
            ),
        ],
    )
}