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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

// RGB Core Library: consensus layer for RGB smart contracts.
//
// 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.
// Copyright (C) 2019-2023 Dr Maxim Orlovsky. 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.

use core::fmt::Debug;
use core::hash::Hash;

use commit_verify::{CommitEncode, Conceal};
use strict_encoding::{StrictDecode, StrictDumb, StrictEncode};

use crate::{
    ConcealedAttach, ConcealedData, ConcealedValue, RevealedAttach, RevealedData, RevealedValue,
    LIB_NAME_RGB,
};

/// Marker trait for types of state which are just a commitment to the actual
/// state data.
pub trait ConfidentialState:
    Debug + Hash + StrictDumb + StrictEncode + StrictDecode + CommitEncode + Eq + Copy
{
    fn state_type(&self) -> StateType;
    fn state_commitment(&self) -> StateCommitment;
}

/// Marker trait for types of state holding explicit state data.
pub trait ExposedState:
    Debug
    + StrictDumb
    + StrictEncode
    + StrictDecode
    + Conceal<Concealed = Self::Confidential>
    + CommitEncode
    + Eq
    + Ord
    + Clone
{
    type Confidential: ConfidentialState;
    fn state_type(&self) -> StateType;
    fn state_data(&self) -> StateData;
}

/// Categories of the state
#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug, Display)]
#[cfg_attr(
    feature = "serde",
    derive(Serialize, Deserialize),
    serde(crate = "serde_crate", rename_all = "camelCase")
)]
#[display(lowercase)]
pub enum StateType {
    /// No state data
    Void,

    /// Value-based state, i.e. which can be committed to with a Pedersen
    /// commitment
    Fungible,

    /// State defined with custom data
    Structured,

    /// Attached data container
    Attachment,
}

/// Categories of the state
#[derive(Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug)]
#[derive(StrictType, StrictDumb, StrictEncode, StrictDecode)]
#[strict_type(lib = LIB_NAME_RGB, tags = custom)]
#[derive(CommitEncode)]
#[cfg_attr(
    feature = "serde",
    derive(Serialize, Deserialize),
    serde(crate = "serde_crate", rename_all = "camelCase")
)]
pub enum StateData {
    #[strict_type(tag = 0x00, dumb)]
    Void,
    #[strict_type(tag = 0x01)]
    Fungible(RevealedValue),
    #[strict_type(tag = 0x02)]
    Structured(RevealedData),
    #[strict_type(tag = 0xFF)]
    Attachment(RevealedAttach),
}

impl ExposedState for StateData {
    type Confidential = StateCommitment;
    fn state_type(&self) -> StateType {
        match self {
            StateData::Void => StateType::Void,
            StateData::Fungible(_) => StateType::Fungible,
            StateData::Structured(_) => StateType::Structured,
            StateData::Attachment(_) => StateType::Attachment,
        }
    }
    fn state_data(&self) -> StateData { self.clone() }
}

impl Conceal for StateData {
    type Concealed = StateCommitment;
    fn conceal(&self) -> Self::Concealed {
        match self {
            StateData::Void => StateCommitment::Void,
            StateData::Fungible(value) => StateCommitment::Fungible(value.conceal()),
            StateData::Structured(data) => StateCommitment::Structured(data.conceal()),
            StateData::Attachment(attach) => StateCommitment::Attachment(attach.conceal()),
        }
    }
}

#[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
#[derive(StrictType, StrictDumb, StrictEncode, StrictDecode)]
#[strict_type(lib = LIB_NAME_RGB, tags = custom)]
#[derive(CommitEncode)]
#[cfg_attr(
    feature = "serde",
    derive(Serialize, Deserialize),
    serde(crate = "serde_crate", rename_all = "camelCase")
)]
pub enum StateCommitment {
    #[strict_type(tag = 0x00, dumb)]
    Void,
    #[strict_type(tag = 0x01)]
    Fungible(ConcealedValue),
    #[strict_type(tag = 0x02)]
    Structured(ConcealedData),
    #[strict_type(tag = 0xFF)]
    Attachment(ConcealedAttach),
}

impl ConfidentialState for StateCommitment {
    fn state_type(&self) -> StateType {
        match self {
            StateCommitment::Void => StateType::Void,
            StateCommitment::Fungible(_) => StateType::Fungible,
            StateCommitment::Structured(_) => StateType::Structured,
            StateCommitment::Attachment(_) => StateType::Attachment,
        }
    }
    fn state_commitment(&self) -> StateCommitment { *self }
}