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

// 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/.

//! Formats for Sapio Studio
use crate::contract::abi::continuation::ContinuationPoint;
use crate::contract::object::ObjectMetadata;
use crate::template::output::OutputMeta;
use crate::template::TemplateMetadata;
use ::miniscript::*;
use bitcoin::consensus::serialize;
use bitcoin::util::psbt::PartiallySignedTransaction;
use bitcoin::OutPoint;
use sapio_base::effects::EffectPath;
use sapio_base::serialization_helpers::SArc;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use std::collections::BTreeMap;

/// Container for data from  `Object::bind_psbt`.
#[derive(Serialize, Deserialize)]
#[serde(rename = "linked_psbt")]
pub struct LinkedPSBT {
    /// a PSBT
    pub psbt: PartiallySignedTransaction,
    /// tx level metadata
    pub metadata: TemplateMetadata,
    /// output specific metadata
    pub output_metadata: Vec<ObjectMetadata>,
    /// added metadata
    pub added_output_metadata: Vec<OutputMeta>,
}

/// Format for a Linked PSBT in Sapio Studio
#[derive(Serialize, Deserialize, JsonSchema, Debug)]
pub enum SapioStudioFormat {
    /// Used for PSBT Return Values
    #[serde(rename = "linked_psbt")]
    LinkedPSBT {
        /// Base 64 Encoded PSBT
        psbt: String,
        /// Hex encoded TXN
        hex: String,
        /// tx level metadata
        metadata: TemplateMetadata,
        /// output specific metadata
        output_metadata: Vec<ObjectMetadata>,
        /// added metadata
        added_output_metadata: Vec<OutputMeta>,
    },
}

impl From<LinkedPSBT> for SapioStudioFormat {
    fn from(l: LinkedPSBT) -> SapioStudioFormat {
        let psbt = {
            let bytes = serialize(&l.psbt);
            base64::encode(bytes)
        };
        let hex = bitcoin::consensus::encode::serialize_hex(&l.psbt.extract_tx());
        SapioStudioFormat::LinkedPSBT {
            psbt,
            hex,
            metadata: l.metadata,
            output_metadata: l.output_metadata,
            added_output_metadata: l.added_output_metadata,
        }
    }
}

/// A `Program` is a wrapper type for a list of
/// JSON objects that should be of form:
/// ```json
/// {
///     "hex" : Hex Encoded Transaction
///     "color" : HTML Color,
///     "metadata" : JSON Value,
///     "utxo_metadata" : {
///         "key" : "value",
///         ...
///     }
/// }
/// ```
#[derive(Serialize, Deserialize, Debug, JsonSchema)]
pub struct Program {
    /// program contains the list of SapioStudio PSBTs
    pub program: BTreeMap<SArc<EffectPath>, SapioStudioObject>,
}

/// A `SapioStudioObject` is a json-friendly format for a `Object` for use in Sapio Studio
#[derive(Serialize, Deserialize, Debug, JsonSchema)]
pub struct SapioStudioObject {
    /// The object's metadata
    pub metadata: ObjectMetadata,
    /// The main covenant OutPoint
    pub out: OutPoint,
    /// List of SapioStudioFormat PSBTs
    pub txs: Vec<SapioStudioFormat>,
    /// List of continue APIs from this point.
    pub continue_apis: BTreeMap<SArc<EffectPath>, ContinuationPoint>,
}