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
281
282
283
284
285
286
287
288
289
290
291
292
293
use crate::internal_prelude::*;

macro_rules! declare_payload_new_type {
    (
        content_trait: $content_trait:ident,
        payload_trait: $payload_trait:ident,
        ----
        $(#[$attributes:meta])*
        $vis:vis struct $payload_type_name:ident
            $(< $( $lt:tt $( : $clt:tt $(+ $dlt:tt )* )? $( = $deflt:tt)? ),+ >)?
            ($content_type:ty)$(;)?
    ) => {
        $(#[$attributes])*
        #[sbor(transparent)]
        /// This new type represents the payload of a particular field or collection.
        /// It is unique to this particular field/collection.
        ///
        /// Therefore, it can be used to disambiguate if the same content type is used
        /// by different blueprints (e.g. two different versions of the same blueprint)
        $vis struct $payload_type_name
        $(< $( $lt $( : $clt $(+ $dlt )* )? $( = $deflt)? ),+ >)?
        {
            content: $content_type
        }

        impl
        $(< $( $lt $( : $clt $(+ $dlt )* )? ),+ >)?
        $payload_type_name $(< $( $lt ),+ >)?
        {
            pub fn of(content: $content_type) -> Self {
                Self {
                    content,
                }
            }
        }


        impl $(< $( $lt $( : $clt $(+ $dlt )* )? ),+ >)?
            core::convert::From<$content_type>
            for $payload_type_name $(< $( $lt ),+ >)?
        {
            fn from(value: $content_type) -> Self {
                Self {
                    content: value,
                }
            }
        }

        impl $(< $( $lt $( : $clt $(+ $dlt )* )? ),+ >)?
            core::convert::AsRef<$content_type>
            for $payload_type_name $(< $( $lt ),+ >)?
        {
            fn as_ref(&self) -> &$content_type {
                &self.content
            }
        }

        impl $(< $( $lt $( : $clt $(+ $dlt )* )? ),+ >)?
            core::ops::Deref
            for $payload_type_name $(< $( $lt ),+ >)?
        {
            type Target = $content_type;

            fn deref(&self) -> &Self::Target {
                &self.content
            }
        }

        impl $(< $( $lt $( : $clt $(+ $dlt )* )? ),+ >)?
            core::convert::AsMut<$content_type>
            for $payload_type_name $(< $( $lt ),+ >)?
        {
            fn as_mut(&mut self) -> &mut $content_type {
                &mut self.content
            }
        }

        impl $(< $( $lt $( : $clt $(+ $dlt )* )? ),+ >)?
            core::ops::DerefMut
            for $payload_type_name $(< $( $lt ),+ >)?
        {
            fn deref_mut(&mut self) -> &mut Self::Target {
                &mut self.content
            }
        }

        impl $(< $( $lt $( : $clt $(+ $dlt )* )? ),+ >)?
            $payload_trait
            for $payload_type_name $(< $( $lt ),+ >)?
        {
            type Content = $content_type;

            fn into_content(self) -> Self::Content {
                self.content
            }
        }

        impl $(< $( $lt $( : $clt $(+ $dlt )* )? ),+ >)?
            $content_trait<$payload_type_name$(< $( $lt ),+ >)?>
            for $content_type
        {
            fn into_content(self) -> $content_type {
                self
            }
        }
    }
}
use crate::system::system_substates::FieldSubstate;
#[allow(unused)]
pub(crate) use declare_payload_new_type;

/// This trait is intended to be implemented by an explicit new type for for the given
/// `{ content: T }` payload of a particular field.
pub trait FieldPayload:
    Sized + AsRef<Self::Content> + AsMut<Self::Content> + From<Self::Content>
{
    type Content: FieldContentSource<Self>;

    fn into_content(self) -> Self::Content;

    fn from_content(content: Self::Content) -> Self {
        Self::from(content)
    }

    fn from_content_source<T: FieldContentSource<Self>>(content: T) -> Self {
        Self::from_content(content.into_content())
    }

    fn into_locked_substate(self) -> FieldSubstate<Self> {
        FieldSubstate::new_locked_field(self)
    }

    fn into_unlocked_substate(self) -> FieldSubstate<Self> {
        FieldSubstate::new_unlocked_field(self)
    }
}

/// This trait is intended to be implemented by types which embody the content
/// of a particular field payload.
///
/// Note:
/// * Multiple types might be mappable into the payload, and so implement this trait
/// * This trait is only one way - from value into content
/// * This trait uses a generic, because the same type might be usable as a payload for multiple
///   substates
pub trait FieldContentSource<Payload: FieldPayload>: Sized {
    fn into_content(self) -> Payload::Content;

    fn into_payload(self) -> Payload {
        Payload::from_content_source(self)
    }

    fn into_locked_substate(self) -> FieldSubstate<Payload> {
        self.into_payload().into_locked_substate()
    }

    fn into_unlocked_substate(self) -> FieldSubstate<Payload> {
        self.into_payload().into_unlocked_substate()
    }
}

/// This trait is intended to be implemented by an explicit new type for for the given
/// `{ content: T }` payload of a particular key value collection.
pub trait KeyValueEntryPayload:
    Sized + AsRef<Self::Content> + AsMut<Self::Content> + From<Self::Content>
{
    type Content: KeyValueEntryContentSource<Self>;

    fn into_content(self) -> Self::Content;

    fn from_content(inner_content: Self::Content) -> Self {
        Self::from(inner_content)
    }

    fn from_content_source<T: KeyValueEntryContentSource<Self>>(content: T) -> Self {
        Self::from_content(content.into_content())
    }

    fn into_locked_substate(self) -> KeyValueEntrySubstate<Self> {
        KeyValueEntrySubstate::locked_entry(self)
    }

    fn into_unlocked_substate(self) -> KeyValueEntrySubstate<Self> {
        KeyValueEntrySubstate::unlocked_entry(self)
    }
}

/// This trait is intended to be implemented by types which embody the content
/// of a particular key value entry payload.
///
/// Note:
/// * Multiple types might be mappable into the payload, and so implement this trait
/// * This trait is only one way - from value into content
/// * This trait uses a generic, because the same type might be usable as a payload for multiple
///   substates
pub trait KeyValueEntryContentSource<Payload: KeyValueEntryPayload>: Sized {
    fn into_content(self) -> Payload::Content;

    fn into_payload(self) -> Payload {
        Payload::from_content_source(self)
    }

    fn into_locked_substate(self) -> KeyValueEntrySubstate<Payload> {
        self.into_payload().into_locked_substate()
    }

    fn into_unlocked_substate(self) -> KeyValueEntrySubstate<Payload> {
        self.into_payload().into_unlocked_substate()
    }
}

/// This trait is intended to be implemented by an explicit new type for for the given
/// `{ content: T }` payload of a particular index collection.
pub trait IndexEntryPayload:
    Sized + AsRef<Self::Content> + AsMut<Self::Content> + From<Self::Content>
{
    type Content: IndexEntryContentSource<Self>;

    fn into_content(self) -> Self::Content;
    fn from_content(inner_content: Self::Content) -> Self {
        Self::from(inner_content)
    }

    fn from_content_source<T: IndexEntryContentSource<Self>>(content: T) -> Self {
        Self::from_content(content.into_content())
    }

    fn into_substate(self) -> IndexEntrySubstate<Self> {
        IndexEntrySubstate::entry(self)
    }
}

/// This trait is intended to be implemented by types which embody the content
/// of a particular index entry payload.
///
/// Note:
/// * Multiple types might be mappable into the payload, and so implement this trait
/// * This trait is only one way - from value into content
/// * This trait uses a generic, because the same type might be usable as a payload for multiple
///   substates
pub trait IndexEntryContentSource<Payload: IndexEntryPayload>: Sized {
    fn into_content(self) -> Payload::Content;

    fn into_payload(self) -> Payload {
        Payload::from_content_source(self)
    }

    fn into_substate(self) -> IndexEntrySubstate<Payload> {
        self.into_payload().into_substate()
    }
}

/// This trait is intended to be implemented by an explicit new type for for the given
/// `{ content: T }` payload of a particular sorted index collection.
pub trait SortedIndexEntryPayload:
    Sized + AsRef<Self::Content> + AsMut<Self::Content> + From<Self::Content>
{
    type Content: SortedIndexEntryContentSource<Self>;

    fn into_content(self) -> Self::Content;

    fn from_content(inner_content: Self::Content) -> Self {
        Self::from(inner_content)
    }

    fn from_content_source<T: SortedIndexEntryContentSource<Self>>(content: T) -> Self {
        Self::from_content(content.into_content())
    }

    fn into_substate(self) -> SortedIndexEntrySubstate<Self> {
        SortedIndexEntrySubstate::entry(self)
    }
}

/// This trait is intended to be implemented by types which embody the content
/// of a particular sorted index entry payload.
///
/// Note:
/// * Multiple types might be mappable into the payload, and so implement this trait
/// * This trait is only one way - from value into content
/// * This trait uses a generic, because the same type might be usable as a payload for multiple
///   substates
pub trait SortedIndexEntryContentSource<Payload: SortedIndexEntryPayload>: Sized {
    fn into_content(self) -> Payload::Content;

    fn into_payload(self) -> Payload {
        Payload::from_content_source(self)
    }

    fn into_substate(self) -> SortedIndexEntrySubstate<Payload> {
        self.into_payload().into_substate()
    }
}