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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
#![cfg_attr(not(feature = "std"), no_std)]

#[cfg(not(any(feature = "std", feature = "alloc")))]
compile_error!("Either feature `std` or `alloc` must be enabled for this crate.");
#[cfg(all(feature = "std", feature = "alloc"))]
compile_error!("Feature `std` and `alloc` can't be enabled at the same time.");

use bitflags::bitflags;
use radix_common::prelude::*;

#[derive(Debug, Clone, PartialEq, Eq, ScryptoSbor, ManifestSbor)]
pub struct KeyValueStoreGenericSubstitutions {
    pub key_generic_substitution: GenericSubstitution,
    pub value_generic_substitution: GenericSubstitution,
    pub allow_ownership: bool, // TODO: Can this be integrated with ScryptoSchema?
}

#[derive(Debug, Clone, PartialEq, Eq, ScryptoSbor, ManifestSbor)]
pub enum GenericBound {
    Any,
}

#[derive(Copy, Debug, Clone, PartialEq, Eq, Hash, Ord, PartialOrd, ScryptoSbor, ManifestSbor)]
pub enum BlueprintHook {
    OnVirtualize,
    OnMove,
    OnDrop,
}

#[derive(Debug, Clone, PartialEq, Eq, ScryptoSbor, ManifestSbor)]
pub struct BlueprintSchemaInit {
    pub generics: Vec<GenericBound>,
    pub schema: VersionedScryptoSchema,
    pub state: BlueprintStateSchemaInit,
    pub events: BlueprintEventSchemaInit,
    /// Registered types for generic substitution
    pub types: BlueprintTypeSchemaInit,
    pub functions: BlueprintFunctionsSchemaInit,
    pub hooks: BlueprintHooksInit,
}

impl Default for BlueprintSchemaInit {
    fn default() -> Self {
        Self {
            generics: Vec::new(),
            schema: Schema {
                type_kinds: Vec::new(),
                type_metadata: Vec::new(),
                type_validations: Vec::new(),
            }
            .into_versioned(),
            state: BlueprintStateSchemaInit::default(),
            events: BlueprintEventSchemaInit::default(),
            types: BlueprintTypeSchemaInit::default(),
            functions: BlueprintFunctionsSchemaInit::default(),
            hooks: BlueprintHooksInit::default(),
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Default, ScryptoSbor, ManifestSbor)]
pub struct BlueprintStateSchemaInit {
    pub fields: Vec<FieldSchema<TypeRef<LocalTypeId>>>,
    pub collections: Vec<BlueprintCollectionSchema<TypeRef<LocalTypeId>>>,
}

#[derive(Debug, Clone, PartialEq, Eq, Default, ScryptoSbor, ManifestSbor)]
#[sbor(transparent)]
pub struct BlueprintEventSchemaInit {
    pub event_schema: IndexMap<String, TypeRef<LocalTypeId>>,
}

#[derive(Debug, Clone, PartialEq, Eq, Default, ScryptoSbor, ManifestSbor)]
#[sbor(transparent)]
pub struct BlueprintTypeSchemaInit {
    pub type_schema: IndexMap<String, LocalTypeId>,
}

#[derive(Debug, Clone, PartialEq, Eq, ScryptoSbor, ManifestSbor)]
pub struct FunctionSchemaInit {
    pub receiver: Option<ReceiverInfo>,
    pub input: TypeRef<LocalTypeId>,
    pub output: TypeRef<LocalTypeId>,
    pub export: String,
}

#[derive(Debug, Clone, PartialEq, Eq, Default, ScryptoSbor, ManifestSbor)]
pub struct BlueprintFunctionsSchemaInit {
    pub functions: IndexMap<String, FunctionSchemaInit>,
}

#[derive(Debug, Clone, PartialEq, Eq, Default, ScryptoSbor, ManifestSbor)]
pub struct BlueprintHooksInit {
    // TODO: allow registration of variant count if we make virtualizable entity type fully dynamic
    pub hooks: IndexMap<BlueprintHook, String>,
}

impl BlueprintSchemaInit {
    pub fn exports(&self) -> Vec<String> {
        self.functions
            .functions
            .values()
            .map(|t| t.export.clone())
            .chain(self.hooks.hooks.values().cloned())
            .collect()
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, ScryptoSbor, ManifestSbor)]
pub enum TypeRef<T> {
    Static(T), // Fully Resolved type is defined in package
    Generic(u8), // Fully Resolved type is mapped directly to a generic
               // TODO: How to represent a structure containing a generic?
}

impl<T> TypeRef<T> {
    pub fn into_static(self) -> Option<T> {
        let Self::Static(value) = self else {
            return None;
        };
        Some(value)
    }

    pub fn assert_static(self) -> T {
        self.into_static().expect("Must be static")
    }
}

#[derive(Debug, Clone, PartialEq, Eq, ScryptoSbor, ManifestSbor)]
pub struct BlueprintKeyValueSchema<T> {
    pub key: T,
    pub value: T,
    pub allow_ownership: bool,
}

impl<T> BlueprintKeyValueSchema<T> {
    pub fn map<U, F: Fn(T) -> U + Copy>(self, f: F) -> BlueprintKeyValueSchema<U> {
        BlueprintKeyValueSchema {
            key: f(self.key),
            value: f(self.value),
            allow_ownership: self.allow_ownership,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, ScryptoSbor, ManifestSbor)]
pub enum BlueprintCollectionSchema<T> {
    KeyValueStore(BlueprintKeyValueSchema<T>),
    Index(BlueprintKeyValueSchema<T>),
    SortedIndex(BlueprintKeyValueSchema<T>),
}

impl<T> BlueprintCollectionSchema<T> {
    pub fn map<U, F: Fn(T) -> U + Copy>(self, f: F) -> BlueprintCollectionSchema<U> {
        match self {
            BlueprintCollectionSchema::Index(schema) => {
                BlueprintCollectionSchema::Index(schema.map(f))
            }
            BlueprintCollectionSchema::SortedIndex(schema) => {
                BlueprintCollectionSchema::SortedIndex(schema.map(f))
            }
            BlueprintCollectionSchema::KeyValueStore(schema) => {
                BlueprintCollectionSchema::KeyValueStore(schema.map(f))
            }
        }
    }
}

pub trait BlueprintFeature {
    fn feature_name(&self) -> &'static str;
}

#[derive(Debug, Clone, PartialEq, Eq, Sbor)]
pub enum Condition {
    Always,
    IfFeature(String),
    IfOuterFeature(String),
}

impl Condition {
    pub fn if_feature(feature: impl BlueprintFeature) -> Self {
        Self::IfFeature(feature.feature_name().into())
    }

    pub fn if_outer_feature(feature: impl BlueprintFeature) -> Self {
        Self::IfOuterFeature(feature.feature_name().into())
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Sbor)]
pub enum FieldTransience {
    NotTransient,
    // TODO: Will need to change this Vec<u8> to ScryptoValue to support default values with global references
    TransientStatic {
        /// The default value a transient substate will have on first read
        default_value: Vec<u8>,
    },
}

#[derive(Debug, Clone, PartialEq, Eq, ScryptoSbor, ManifestSbor)]
pub struct FieldSchema<V> {
    pub field: V,
    pub condition: Condition,
    pub transience: FieldTransience,
}

impl FieldSchema<TypeRef<LocalTypeId>> {
    pub fn if_feature<I: Into<LocalTypeId>, S: ToString>(value: I, feature: S) -> Self {
        FieldSchema {
            field: TypeRef::Static(value.into()),
            condition: Condition::IfFeature(feature.to_string()),
            transience: FieldTransience::NotTransient,
        }
    }

    pub fn if_outer_feature<I: Into<LocalTypeId>, S: ToString>(value: I, feature: S) -> Self {
        FieldSchema {
            field: TypeRef::Static(value.into()),
            condition: Condition::IfOuterFeature(feature.to_string()),
            transience: FieldTransience::NotTransient,
        }
    }

    pub fn static_field<I: Into<LocalTypeId>>(value: I) -> Self {
        FieldSchema {
            field: TypeRef::Static(value.into()),
            condition: Condition::Always,
            transience: FieldTransience::NotTransient,
        }
    }

    pub fn transient_field<I: Into<LocalTypeId>, E: ScryptoEncode>(
        value: I,
        default_value: E,
    ) -> Self {
        FieldSchema {
            field: TypeRef::Static(value.into()),
            condition: Condition::Always,
            transience: FieldTransience::TransientStatic {
                default_value: scrypto_encode(&default_value).unwrap(),
            },
        }
    }
}

bitflags! {
    #[derive(Sbor)]
    pub struct RefTypes: u32 {
        const NORMAL = 0b00000001;
        const DIRECT_ACCESS = 0b00000010;
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Sbor)]
pub struct ReceiverInfo {
    pub receiver: Receiver,
    pub ref_types: RefTypes,
}

impl ReceiverInfo {
    pub fn normal_ref() -> Self {
        Self {
            receiver: Receiver::SelfRef,
            ref_types: RefTypes::NORMAL,
        }
    }

    pub fn normal_ref_mut() -> Self {
        Self {
            receiver: Receiver::SelfRefMut,
            ref_types: RefTypes::NORMAL,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Sbor)]
pub enum Receiver {
    SelfRef,
    SelfRefMut,
}