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

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

//! a decorator type which is used to generate a spending condition
use std::sync::Arc;

use crate::contract::CompilationError;

use super::Context;

use sapio_base::{
    simp::{GuardLT, SIMPAttachableAt},
    Clause,
};
/// A Guard is a function which generates some condition that must be met to unlock a script.
/// If bool = true, the computation of the guard is cached, which is useful if e.g. Guard
/// must contact a remote server or it should be the same across calls *for a given contract
/// instance*.
pub enum Guard<ContractSelf> {
    /// Cache Variant should only be called one time per contract and the result saved
    Cache(
        fn(&ContractSelf, Context) -> Clause,
        Option<SimpGen<ContractSelf>>,
    ),
    /// Fresh Variant may be called repeatedly
    Fresh(
        fn(&ContractSelf, Context) -> Clause,
        Option<SimpGen<ContractSelf>>,
    ),
}

/// A Function that can be used to generate metadata for a Guard
pub type SimpGen<ContractSelf> =
    fn(
        cself: &ContractSelf,
        ctx: Context,
    ) -> Result<Vec<Arc<dyn SIMPAttachableAt<GuardLT>>>, CompilationError>;

/// A List of Guards, for convenience
pub type GuardList<'a, T> = &'a [fn() -> Option<Guard<T>>];