rgb-std 0.10.9

RGB standard library for working with smart contracts on Bitcoin & Lightning
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

// RGB standard library for working with smart contracts on Bitcoin & Lightning
//
// SPDX-License-Identifier: Apache-2.0
//
// Written in 2019-2023 by
//     Dr Maxim Orlovsky <orlovsky@lnp-bp.org>
//
// Copyright (C) 2019-2023 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.

#![deny(
    non_upper_case_globals,
    non_camel_case_types,
    non_snake_case,
    unused_mut,
    unused_imports,
    dead_code,
    // missing_docs
)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

// CORE LIB:
// issue    :: Schema, Metadata, {GlobalState}, {Assignments} -> Genesis
//
// STD LIB:
// import   :: Stash, (Schema | Interface) -> Stash
// state    :: Inventory, ContractId -> ContractState
// interpret :: ContractState, Interface -> InterpretedState
//
// issue    :: Schema, State, Interface -> Consignment -- calls `core::issue`
//                                                     -- internally
// extract  :: Inventory, ContractId, Interface -> Consignment
//          -- contract transfer
//
// compose  :: Inventory, ContractId, Interface, [Outpoint] -> Consignment
//          -- base for state transfer describing existing state
// transfer :: Consignment, (...) -> StateTransition -- prepares transition
// preserve :: Stash, [Outpoint], StateTransition -> [StateTransition]
//          -- creates blank state transitions
// consign  :: Stash, StateTransition -> Consignment -- extracts history data
//
// reveal   :: Consignment, RevealInfo -> Consignment -- removes blinding from
//                                                    -- known UTXOs
// validate :: Consignment -> (Validity, ContractUpdate)
// enclose  :: Inventory, Disclosure -> Inventory !!
// consume  :: Inventory, Consignment -> Inventory !! -- for both transfers and
//                                                    -- contracts
//
// endpoints :: Consignment -> [Outpoint] -- used to construct initial PSBT

// WALLET LIB:
// embed     :: Psbt, ContractId -> Psbt -- adds contract information to PSBT
// commit    :: Psbt, ContractId, Transition -> Psbt -- adds transition
//                                                   -- information to the PSBT
// bundle    :: Psbt -> Psbt -- takes individual transitions and bundles them
// finalize  :: Psbt -> Psbt -- should be performed by BP; converts individual
//                           -- commitments into tapret

extern crate core;
#[macro_use]
extern crate amplify;
#[macro_use]
extern crate strict_encoding;
#[cfg(feature = "serde")]
#[macro_use]
extern crate serde_crate as serde;

pub use rgb::{contract, schema, validation, vm};

pub mod stl;
pub mod interface;
pub mod containers;
pub mod persistence;
pub mod resolvers;
pub mod accessors;
mod reserved;

pub use bp::{Chain, Outpoint, Txid};
use reserved::ReservedBytes;
pub use stl::{LIB_NAME_RGB_CONTRACT, LIB_NAME_RGB_STD};