descriptors/
factory.rs

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
// Modern, minimalistic & standard-compliant cold wallet library.
//
// SPDX-License-Identifier: Apache-2.0
//
// Written in 2020-2024 by
//     Dr Maxim Orlovsky <orlovsky@lnp-bp.org>
//
// Copyright (C) 2020-2024 LNP/BP Standards Association. All rights reserved.
// Copyright (C) 2020-2024 Dr Maxim Orlovsky. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use std::collections::VecDeque;

use derive::{Address, AddressNetwork, DeriveScripts, Idx, Keychain, NormalIndex};

pub struct AddressFactory<D: DeriveScripts> {
    pub descriptor: D,
    pub network: AddressNetwork,
    pub keychain: Keychain,
    pub unused_tip: NormalIndex,
    pub remnants: VecDeque<Address>,
}

impl<D: DeriveScripts> Iterator for AddressFactory<D> {
    type Item = Address;

    fn next(&mut self) -> Option<Self::Item> {
        loop {
            if let Some(addr) = self.remnants.pop_front() {
                return Some(addr);
            }
            self.unused_tip.checked_inc_assign()?;
            self.remnants = self
                .descriptor
                .derive_address(self.network, self.keychain, self.unused_tip)
                .collect();
        }
    }
}

impl<D: DeriveScripts> AddressFactory<D> {
    pub fn address(&self, index: NormalIndex) -> impl Iterator<Item = Address> + use<'_, D> {
        self.descriptor.derive_address(self.network, self.keychain, index)
    }
}