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
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
use odra::named_keys::single_value_storage;
use odra::{args::Maybe, prelude::*, SubModule, UnwrapOrRevert};
use serde::{Deserialize, Serialize};

use super::{
    constants::{
        IDENTIFIER_MODE, JSON_SCHEMA, METADATA_MUTABILITY, NFT_METADATA_KIND, NFT_METADATA_KINDS
    },
    constants::{METADATA_CEP78, METADATA_CUSTOM_VALIDATED, METADATA_NFT721, METADATA_RAW},
    error::CEP78Error,
    modalities::{
        MetadataMutability, MetadataRequirement, NFTIdentifierMode, NFTMetadataKind, Requirement,
        TokenIdentifier
    }
};

single_value_storage!(
    Cep78MetadataRequirement,
    MetadataRequirement,
    NFT_METADATA_KINDS,
    CEP78Error::MissingNFTMetadataKind
);
single_value_storage!(
    Cep78NFTMetadataKind,
    NFTMetadataKind,
    NFT_METADATA_KIND,
    CEP78Error::MissingNFTMetadataKind
);
single_value_storage!(
    Cep78IdentifierMode,
    NFTIdentifierMode,
    IDENTIFIER_MODE,
    CEP78Error::MissingIdentifierMode
);
single_value_storage!(
    Cep78MetadataMutability,
    MetadataMutability,
    METADATA_MUTABILITY,
    CEP78Error::MissingMetadataMutability
);
single_value_storage!(
    Cep78JsonSchema,
    String,
    JSON_SCHEMA,
    CEP78Error::MissingJsonSchema
);

#[odra::module]
pub struct Cep78ValidatedMetadata;

#[odra::module]
impl Cep78ValidatedMetadata {
    #[allow(clippy::ptr_arg)]
    pub fn set(&self, kind: &NFTMetadataKind, token_id: &String, value: String) {
        let dictionary_name = get_metadata_key(kind);
        self.env()
            .set_dictionary_value(dictionary_name, token_id.as_bytes(), value);
    }
    #[allow(clippy::ptr_arg)]
    pub fn get(&self, kind: &NFTMetadataKind, token_id: &String) -> String {
        let dictionary_name = get_metadata_key(kind);
        let env = self.env();
        env.get_dictionary_value(dictionary_name, token_id.as_bytes())
            .unwrap_or_revert_with(&env, CEP78Error::InvalidTokenIdentifier)
    }
}

#[odra::module]
pub struct Metadata {
    requirements: SubModule<Cep78MetadataRequirement>,
    identifier_mode: SubModule<Cep78IdentifierMode>,
    mutability: SubModule<Cep78MetadataMutability>,
    json_schema: SubModule<Cep78JsonSchema>,
    validated_metadata: SubModule<Cep78ValidatedMetadata>,
    nft_metadata_kind: SubModule<Cep78NFTMetadataKind>
}

impl Metadata {
    pub fn init(
        &mut self,
        base_metadata_kind: NFTMetadataKind,
        additional_required_metadata: Maybe<Vec<NFTMetadataKind>>,
        optional_metadata: Maybe<Vec<NFTMetadataKind>>,
        metadata_mutability: MetadataMutability,
        identifier_mode: NFTIdentifierMode,
        json_schema: String
    ) {
        let mut requirements = MetadataRequirement::new();
        for optional in optional_metadata.unwrap_or_default() {
            requirements.insert(optional, Requirement::Optional);
        }
        for required in additional_required_metadata.unwrap_or_default() {
            requirements.insert(required, Requirement::Required);
        }
        requirements.insert(base_metadata_kind.clone(), Requirement::Required);

        // Attempt to parse the provided schema if the `CustomValidated` metadata kind is required or
        // optional and fail installation if the schema cannot be parsed.
        if let Some(req) = requirements.get(&NFTMetadataKind::CustomValidated) {
            if req == &Requirement::Required || req == &Requirement::Optional {
                serde_json_wasm::from_str::<CustomMetadataSchema>(&json_schema)
                    .map_err(|_| CEP78Error::InvalidJsonSchema)
                    .unwrap_or_revert(self);
            }
        }
        self.nft_metadata_kind.set(base_metadata_kind);
        self.requirements.set(requirements);
        self.identifier_mode.set(identifier_mode);
        self.mutability.set(metadata_mutability);
        self.json_schema.set(json_schema);
    }

    pub fn get_requirements(&self) -> MetadataRequirement {
        self.requirements.get()
    }

    pub fn get_identifier_mode(&self) -> NFTIdentifierMode {
        self.identifier_mode.get()
    }

    pub fn get_or_revert(&self, token_identifier: &TokenIdentifier) -> String {
        let env = self.env();
        let metadata_kind_list = self.get_requirements();

        for (metadata_kind, required) in metadata_kind_list {
            match required {
                Requirement::Required => {
                    let id = token_identifier.to_string();
                    let metadata = self.validated_metadata.get(&metadata_kind, &id);
                    return metadata;
                }
                _ => continue
            }
        }
        env.revert(CEP78Error::MissingTokenMetaData)
    }

    // test only
    pub fn get_metadata_by_kind(&self, token_identifier: String, kind: &NFTMetadataKind) -> String {
        self.validated_metadata.get(kind, &token_identifier)
    }

    pub fn get_metadata_kind(&self) -> NFTMetadataKind {
        self.nft_metadata_kind.get()
    }

    pub fn ensure_mutability(&self, error: CEP78Error) {
        let current_mutability = self.mutability.get();
        if current_mutability != MetadataMutability::Mutable {
            self.env().revert(error)
        }
    }

    pub fn update_or_revert(&mut self, token_metadata: &str, token_id: &String) {
        let requirements = self.get_requirements();
        for (metadata_kind, required) in requirements {
            if required == Requirement::Unneeded {
                continue;
            }
            let token_metadata_validation = self.validate(&metadata_kind, token_metadata);
            match token_metadata_validation {
                Ok(validated_token_metadata) => {
                    self.validated_metadata
                        .set(&metadata_kind, token_id, validated_token_metadata);
                }
                Err(err) => {
                    self.env().revert(err);
                }
            }
        }
    }

    fn validate(&self, kind: &NFTMetadataKind, metadata: &str) -> Result<String, CEP78Error> {
        let token_schema = self.get_metadata_schema(kind);
        match kind {
            NFTMetadataKind::CEP78 => {
                let metadata = serde_json_wasm::from_str::<MetadataCEP78>(metadata)
                    .map_err(|_| CEP78Error::FailedToParseCep78Metadata)?;

                if let Some(name_property) = token_schema.properties.get("name") {
                    if name_property.required && metadata.name.is_empty() {
                        self.env().revert(CEP78Error::InvalidCEP78Metadata)
                    }
                }
                if let Some(token_uri_property) = token_schema.properties.get("token_uri") {
                    if token_uri_property.required && metadata.token_uri.is_empty() {
                        self.env().revert(CEP78Error::InvalidCEP78Metadata)
                    }
                }
                if let Some(checksum_property) = token_schema.properties.get("checksum") {
                    if checksum_property.required && metadata.checksum.is_empty() {
                        self.env().revert(CEP78Error::InvalidCEP78Metadata)
                    }
                }
                serde_json::to_string_pretty(&metadata)
                    .map_err(|_| CEP78Error::FailedToJsonifyCEP78Metadata)
            }
            NFTMetadataKind::NFT721 => {
                let metadata = serde_json_wasm::from_str::<MetadataNFT721>(metadata)
                    .map_err(|_| CEP78Error::FailedToParse721Metadata)?;

                if let Some(name_property) = token_schema.properties.get("name") {
                    if name_property.required && metadata.name.is_empty() {
                        self.env().revert(CEP78Error::InvalidNFT721Metadata)
                    }
                }
                if let Some(token_uri_property) = token_schema.properties.get("token_uri") {
                    if token_uri_property.required && metadata.token_uri.is_empty() {
                        self.env().revert(CEP78Error::InvalidNFT721Metadata)
                    }
                }
                if let Some(symbol_property) = token_schema.properties.get("symbol") {
                    if symbol_property.required && metadata.symbol.is_empty() {
                        self.env().revert(CEP78Error::InvalidNFT721Metadata)
                    }
                }
                serde_json::to_string_pretty(&metadata)
                    .map_err(|_| CEP78Error::FailedToJsonifyNFT721Metadata)
            }
            NFTMetadataKind::Raw => Ok(metadata.to_owned()),
            NFTMetadataKind::CustomValidated => {
                let custom_metadata =
                    serde_json_wasm::from_str::<BTreeMap<String, String>>(metadata)
                        .map(|attributes| CustomMetadata { attributes })
                        .map_err(|_| CEP78Error::FailedToParseCustomMetadata)?;

                for (property_name, property_type) in token_schema.properties.iter() {
                    if property_type.required
                        && !custom_metadata.attributes.contains_key(property_name)
                    {
                        self.env().revert(CEP78Error::InvalidCustomMetadata)
                    }
                }
                serde_json::to_string_pretty(&custom_metadata.attributes)
                    .map_err(|_| CEP78Error::FailedToJsonifyCustomMetadata)
            }
        }
    }

    fn get_metadata_schema(&self, kind: &NFTMetadataKind) -> CustomMetadataSchema {
        match kind {
            NFTMetadataKind::Raw => CustomMetadataSchema {
                properties: BTreeMap::new()
            },
            NFTMetadataKind::NFT721 => {
                let mut properties = BTreeMap::new();
                properties.insert(
                    "name".to_string(),
                    MetadataSchemaProperty {
                        name: "name".to_string(),
                        description: "The name of the NFT".to_string(),
                        required: true
                    }
                );
                properties.insert(
                    "symbol".to_string(),
                    MetadataSchemaProperty {
                        name: "symbol".to_string(),
                        description: "The symbol of the NFT collection".to_string(),
                        required: true
                    }
                );
                properties.insert(
                    "token_uri".to_string(),
                    MetadataSchemaProperty {
                        name: "token_uri".to_string(),
                        description: "The URI pointing to an off chain resource".to_string(),
                        required: true
                    }
                );
                CustomMetadataSchema { properties }
            }
            NFTMetadataKind::CEP78 => {
                let mut properties = BTreeMap::new();
                properties.insert(
                    "name".to_string(),
                    MetadataSchemaProperty {
                        name: "name".to_string(),
                        description: "The name of the NFT".to_string(),
                        required: true
                    }
                );
                properties.insert(
                    "token_uri".to_string(),
                    MetadataSchemaProperty {
                        name: "token_uri".to_string(),
                        description: "The URI pointing to an off chain resource".to_string(),
                        required: true
                    }
                );
                properties.insert(
                    "checksum".to_string(),
                    MetadataSchemaProperty {
                        name: "checksum".to_string(),
                        description: "A SHA256 hash of the content at the token_uri".to_string(),
                        required: true
                    }
                );
                CustomMetadataSchema { properties }
            }
            NFTMetadataKind::CustomValidated => {
                serde_json_wasm::from_str::<CustomMetadataSchema>(&self.json_schema.get())
                    .map_err(|_| CEP78Error::InvalidJsonSchema)
                    .unwrap_or_revert(self)
            }
        }
    }
}

#[derive(Serialize, Deserialize)]
#[odra::odra_type]
pub(crate) struct MetadataSchemaProperty {
    pub name: String,
    pub description: String,
    pub required: bool
}

#[derive(Serialize, Deserialize, Clone)]
pub(crate) struct CustomMetadataSchema {
    pub properties: BTreeMap<String, MetadataSchemaProperty>
}

// Using a structure for the purposes of serialization formatting.
#[derive(Serialize, Deserialize)]
pub(crate) struct MetadataNFT721 {
    name: String,
    symbol: String,
    token_uri: String
}

#[derive(Serialize, Deserialize)]
pub(crate) struct MetadataCEP78 {
    name: String,
    token_uri: String,
    checksum: String
}

// Using a structure for the purposes of serialization formatting.
#[derive(Serialize, Deserialize)]
pub(crate) struct CustomMetadata {
    attributes: BTreeMap<String, String>
}

pub(crate) fn get_metadata_key(metadata_kind: &NFTMetadataKind) -> String {
    match metadata_kind {
        NFTMetadataKind::CEP78 => METADATA_CEP78,
        NFTMetadataKind::NFT721 => METADATA_NFT721,
        NFTMetadataKind::Raw => METADATA_RAW,
        NFTMetadataKind::CustomValidated => METADATA_CUSTOM_VALIDATED
    }
    .to_string()
}