hypersonic 0.12.0

Formally-verifiable distributed software
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

// SONIC: Standard library for formally-verifiable distributed contracts
//
// SPDX-License-Identifier: Apache-2.0
//
// Designed in 2019-2025 by Dr Maxim Orlovsky <orlovsky@ubideco.org>
// Written in 2024-2025 by Dr Maxim Orlovsky <orlovsky@ubideco.org>
//
// Copyright (C) 2019-2024 LNP/BP Standards Association, Switzerland.
// Copyright (C) 2024-2025 Laboratories for Ubiquitous Deterministic Computing (UBIDECO),
//                         Institute for Distributed and Cognitive Systems (InDCS), Switzerland.
// Copyright (C) 2019-2025 Dr Maxim Orlovsky.
// All rights under the above copyrights are 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::BTreeMap;

use amplify::MultiError;
use sonic_callreq::StateName;
use sonicapi::{CoreParams, OpBuilder};
use strict_types::StrictVal;
use ultrasonic::{AuthToken, CellAddr, CellLock, Opid};

use crate::{AcceptError, Ledger, Stock};

#[derive(Clone, Debug)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Satisfaction {
    pub name: StateName,
    pub witness: StrictVal,
}

#[derive(Clone, Debug)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct CallParams {
    #[cfg_attr(feature = "serde", serde(flatten))]
    pub core: CoreParams,
    pub using: BTreeMap<CellAddr, Option<Satisfaction>>,
    pub reading: Vec<CellAddr>,
}

pub struct DeedBuilder<'c, S: Stock> {
    pub(super) builder: OpBuilder,
    pub(super) ledger: &'c mut Ledger<S>,
}

impl<S: Stock> DeedBuilder<'_, S> {
    pub fn reading(mut self, addr: CellAddr) -> Self {
        self.builder = self.builder.access(addr);
        self
    }

    pub fn using(mut self, addr: CellAddr) -> Self {
        self.builder = self.builder.destroy(addr);
        self
    }

    pub fn satisfying(mut self, addr: CellAddr, name: impl Into<StateName>, witness: StrictVal) -> Self {
        let api = &self.ledger.articles().default_api();
        let types = &self.ledger.articles().types();
        self.builder = self
            .builder
            .destroy_satisfy(addr, name, witness, api, types);
        self
    }

    pub fn append(mut self, name: impl Into<StateName>, data: StrictVal, raw: Option<StrictVal>) -> Self {
        let api = &self.ledger.articles().default_api();
        let types = &self.ledger.articles().types();
        self.builder = self.builder.add_global(name, data, raw, api, types);
        self
    }

    pub fn assign(
        mut self,
        name: impl Into<StateName>,
        auth: AuthToken,
        data: StrictVal,
        lock: Option<CellLock>,
    ) -> Self {
        let api = &self.ledger.articles().default_api();
        let types = &self.ledger.articles().types();
        self.builder = self.builder.add_owned(name, auth, data, lock, api, types);
        self
    }

    pub fn commit<'a>(self) -> Result<Opid, MultiError<AcceptError, S::Error>>
    where Self: 'a {
        let deed = self.builder.finalize();
        let opid = deed.opid();
        self.ledger.apply_verify(deed, true)?;
        self.ledger.commit_transaction();
        Ok(opid)
    }
}