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

use parity_scale_codec::{Compact, Decode, Encode};
use scale_info::prelude::vec::Vec;

#[cfg(not(feature = "std"))]
type String = Vec<u8>;

#[cfg(feature = "std")]
use serde::{Deserialize, Serialize};

#[derive(Encode, Decode, Copy, Clone, PartialEq, Debug, Eq, scale_info::TypeInfo)]
#[cfg_attr(
    feature = "std",
    derive(Serialize, Deserialize),
    serde(rename_all = "camelCase")
)]
pub struct ShardsTrait(Compact<u32>);

#[derive(Encode, Decode, Copy, Clone, PartialEq, Debug, Eq, scale_info::TypeInfo)]
#[cfg_attr(
    feature = "std",
    derive(Serialize, Deserialize),
    serde(rename_all = "camelCase")
)]
pub enum ShardsFormat {
    /// Canonical textual format interpreted by the Shards runtime
    Edn,
    /// Serialized binary format
    Binary,
}

// serde(rename_all = "camelCase") is needed or polkadot.js will not be able to deserialize

#[derive(Encode, Decode, Copy, Clone, PartialEq, Debug, Eq, scale_info::TypeInfo)]
#[cfg_attr(
    feature = "std",
    derive(Serialize, Deserialize),
    serde(rename_all = "camelCase")
)]
pub enum AudioCategories {
    /// A compressed audio file in the ogg container format
    OggFile,
    /// A compressed audio file in the mp3 format
    Mp3File,
}

#[derive(Encode, Decode, Copy, Clone, PartialEq, Debug, Eq, scale_info::TypeInfo)]
#[cfg_attr(
    feature = "std",
    derive(Serialize, Deserialize),
    serde(rename_all = "camelCase")
)]
pub enum ModelCategories {
    /// A GLTF binary model
    GltfFile,
    /// 🤫😄
    Sdf,
    /// A physics collision model
    PhysicsCollider,
}

#[derive(Encode, Decode, Copy, Clone, PartialEq, Debug, Eq, scale_info::TypeInfo)]
#[cfg_attr(
    feature = "std",
    derive(Serialize, Deserialize),
    serde(rename_all = "camelCase")
)]
pub enum TextureCategories {
    PngFile,
    JpgFile,
}

#[derive(Encode, Decode, Copy, Clone, PartialEq, Debug, Eq, scale_info::TypeInfo)]
#[cfg_attr(
    feature = "std",
    derive(Serialize, Deserialize),
    serde(rename_all = "camelCase")
)]
pub enum VectorCategories {
    SvgFile,
    /// A TrueType font file
    TtfFile,
}

#[derive(Encode, Decode, Copy, Clone, PartialEq, Debug, Eq, scale_info::TypeInfo)]
#[cfg_attr(
    feature = "std",
    derive(Serialize, Deserialize),
    serde(rename_all = "camelCase")
)]
pub enum VideoCategories {
    MkvFile,
    Mp4File,
}

#[derive(Encode, Decode, Copy, Clone, PartialEq, Debug, Eq, scale_info::TypeInfo)]
#[cfg_attr(
    feature = "std",
    derive(Serialize, Deserialize),
    serde(rename_all = "camelCase")
)]
pub enum TextCategories {
    /// Plain Text
    Plain,
    /// Json String
    Json,
}

#[derive(Encode, Decode, Copy, Clone, PartialEq, Debug, Eq, scale_info::TypeInfo)]
#[cfg_attr(
    feature = "std",
    derive(Serialize, Deserialize),
    serde(rename_all = "camelCase")
)]
pub enum BinaryCategories {
    /// A generic wasm program, compiled to run on a WASI runtime
    WasmProgram,
    /// A generic wasm reactor, compiled to run on a WASI runtime
    WasmReactor,
    /// A blender file. Royalties distribution of blender files derived protos will always allocate a % to the Blender Foundation
    BlendFile,
}

/// Types of categories that can be attached to a Proto-Fragment to describe it (e.g Code, Audio, Video etc.)
#[derive(Encode, Decode, Clone, PartialEq, Debug, Eq, scale_info::TypeInfo)]
#[cfg_attr(
    feature = "std",
    derive(Serialize, Deserialize),
    serde(rename_all = "camelCase")
)]
pub enum Categories {
    /// Text of the supported sub-categories
    Text(TextCategories),
    /// A Scripting Trait declaration, traits are unique, and are used to describe how Shards work (Scripts)
    /// Name, Description, and unique trait ID
    Trait(String, String, ShardsTrait),
    /// Shards scripts of various sub-categories
    /// Shards use interoperability traits to describe how they can be used in other shards
    Shards(ShardsFormat, Vec<ShardsTrait>),
    /// Audio files and effects
    Audio(AudioCategories),
    /// Textures of the supported sub-categories
    Texture(TextureCategories),
    /// Vectors of the supported sub-categories (e.g. SVG, Font)
    Vector(VectorCategories),
    /// Video file of the supported formats
    Video(VideoCategories),
    /// 2d/3d models of the supported formats
    Model(ModelCategories),
    /// Binary of the supported sub-categories
    Binary(BinaryCategories),
}