bp-seals 0.12.0

Bitcoin protocol single-use-seals library
Documentation 
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

// Bitcoin protocol single-use-seals library.
//
// SPDX-License-Identifier: Apache-2.0
//
// Written in 2019-2024 by
//     Dr Maxim Orlovsky <orlovsky@lnp-bp.org>
//
// Copyright (C) 2019-2024 LNP/BP Standards Association. 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.

//! Witness-output enabled TxO-seals allow constructing graphs of seals, useful in protocols like
//! RGB.

use bc::{Outpoint, Vout};
use commit_verify::{Sha256, StrictHash};

use crate::{Noise, TxoSealExt};

/// A single-use seal definition type allowing seals to point to the output of the same transaction
/// (witness transaction) which commits to the message defining the seals.
#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug, Display)]
#[derive(StrictType, StrictDumb, StrictEncode, StrictDecode)]
#[strict_type(lib = dbc::LIB_NAME_BPCORE, tags = custom, dumb = Self::Wout(strict_dumb!()))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize), serde(untagged))]
pub enum WOutpoint {
    /// A seal definition pointing to an output of a not-yet-existing witness transaction closing
    /// some other seals, which will contain a commitment to this seal definition (witness
    /// transaction).
    #[display("~:{0}")]
    #[strict_type(tag = 0)]
    Wout(Vout),

    /// A seal definition pointing to an output of an already existing transaction.
    #[display(inner)]
    #[strict_type(tag = 1)]
    Extern(Outpoint),
}

/// A composed single-use seal definition type, which includes a primary and a fallback seal.
///
/// The type allows creation of seals pointing to the output of the same transaction (witness
/// transaction) which commits to the message defining the seals.
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Display)]
#[display("{primary}/{secondary}")]
#[derive(StrictType, StrictDumb, StrictEncode, StrictDecode)]
#[strict_type(lib = dbc::LIB_NAME_BPCORE)]
#[derive(CommitEncode)]
#[commit_encode(strategy = strict, id = StrictHash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct WTxoSeal {
    /// A primary seal definition.
    pub primary: WOutpoint,
    /// A fallback seal definition.
    pub secondary: TxoSealExt,
}

impl WTxoSeal {
    /// Creates a new witness-output-based seal definition without a fallback.
    ///
    /// # Arguments
    ///
    /// `nonce` is a deterministic incremental number, preventing from creating the same seal if the
    /// same output is used.
    pub fn vout_no_fallback(vout: Vout, noise_engine: Sha256, nonce: u64) -> Self {
        Self::with(WOutpoint::Wout(vout), noise_engine, nonce)
    }

    /// Creates a new external outpoint-based seal definition without a fallback.
    ///
    /// # Arguments
    ///
    /// `nonce` is a deterministic incremental number, preventing from creating the same seal if the
    /// same output is used.
    pub fn no_fallback(outpoint: Outpoint, noise_engine: Sha256, nonce: u64) -> Self {
        Self::with(WOutpoint::Extern(outpoint), noise_engine, nonce)
    }

    /// Creates a new seal definition without a fallback.
    ///
    /// # Arguments
    ///
    /// `nonce` is a deterministic incremental number, preventing from creating the same seal if the
    /// same output is used.
    pub fn with(outpoint: WOutpoint, noise_engine: Sha256, nonce: u64) -> Self {
        Self {
            primary: outpoint,
            secondary: TxoSealExt::Noise(Noise::with(outpoint, noise_engine, nonce)),
        }
    }
}