sapio 0.2.4

A programming framework for bitcoin smart contracts.
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
102
103
104

// Copyright Judica, Inc 2021
//
// This Source Code Form is subject to the terms of the Mozilla Public
//  License, v. 2.0. If a copy of the MPL was not distributed with this
//  file, You can obtain one at https://mozilla.org/MPL/2.0/.

//! Because Addresses cannot address the case unknown or OP_RETURN we use a
//! custom type as a standin that is a superset but plays nice with existing
//! stuff.

use crate::contract::object::ObjectError;
use bitcoin::{Address, Script, XOnlyPublicKey};
use miniscript::{Descriptor, DescriptorTrait};
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use std::convert::TryFrom;

/// A type that handles (gracefully) the fact that certain widely used
/// output types do not have an address
#[derive(Serialize, Deserialize, JsonSchema, Clone, Debug)]
#[serde(untagged)]
pub enum ExtendedAddress {
    /// A regular standard address type
    Address(Address),
    /// When we know the descriptor
    Descriptor(Descriptor<XOnlyPublicKey>),
    /// An OP_RETURN
    OpReturn(OpReturn),
    /// Unknown
    Unknown(bitcoin::Script),
}
impl ExtendedAddress {
    /// create an OP_RETURN address type
    pub fn make_op_return<'a, I: ?Sized>(data: &'a I) -> Result<Self, ObjectError>
    where
        &'a [u8]: From<&'a I>,
    {
        let slice: &[u8] = data.into();
        if slice.len() > 40 {
            return Err(ObjectError::OpReturnTooLong);
        }
        Ok(ExtendedAddress::OpReturn(OpReturn(
            bitcoin::Script::new_op_return(slice),
        )))
    }
}

/// Internal type for processing OpReturn through serde
#[derive(Serialize, Deserialize, JsonSchema, Clone, Debug)]
#[serde(try_from = "Script")]
#[serde(into = "Script")]
pub struct OpReturn(Script);

impl TryFrom<Script> for OpReturn {
    type Error = &'static str;
    fn try_from(s: Script) -> std::result::Result<Self, Self::Error> {
        if s.is_op_return() {
            Ok(OpReturn(s))
        } else {
            Err("Not an Op Return")
        }
    }
}

impl From<OpReturn> for Script {
    fn from(o: OpReturn) -> Self {
        o.0
    }
}
impl From<Address> for ExtendedAddress {
    fn from(a: Address) -> Self {
        ExtendedAddress::Address(a)
    }
}
impl From<Descriptor<XOnlyPublicKey>> for ExtendedAddress {
    fn from(a: Descriptor<XOnlyPublicKey>) -> Self {
        ExtendedAddress::Descriptor(a)
    }
}

impl From<ExtendedAddress> for Script {
    fn from(s: ExtendedAddress) -> Self {
        match s {
            ExtendedAddress::Address(a) => a.script_pubkey(),
            ExtendedAddress::OpReturn(OpReturn(s)) => s,
            ExtendedAddress::Unknown(s) => s,
            ExtendedAddress::Descriptor(d) => d.script_pubkey(),
        }
    }
}

impl From<&ExtendedAddress> for Script {
    fn from(s: &ExtendedAddress) -> Self {
        match s {
            ExtendedAddress::Address(a) => a.script_pubkey(),
            ExtendedAddress::OpReturn(OpReturn(s)) => s.clone(),
            ExtendedAddress::Unknown(s) => s.clone(),
            ExtendedAddress::Descriptor(d) => {
                let r = d.script_pubkey();
                r
            }
        }
    }
}