protos 0.1.21

Protos common library including cateogires and traits
Documentation 
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

module.exports = {
    rpc: {
        protos: {
            getProtos: {
                description: "Query and Return Proto-Fragment(s) based on `params`. The return type is a JSON string", type: "String",
                params: [
                    { name: "params", type: "GetProtosParams" },
                    { name: "at", type: "BlockHash", isOptional: true }
                ]
            },
            getGenealogy: {
                description: "Query the Genealogy of a Proto-Fragment based on `params`. The return type is a JSON string that represents an Adjacency List.", type: "String",
                params: [
                    { name: "params", type: "GetGenealogyParams" },
                    { name: "at", type: "BlockHash", isOptional: true }
                ]
            },
        },
        fragments: {
            getDefinitions: {
                description: "Query and Return Fragment Definition(s) based on `params`", type: "String",
                params: [
                    { name: "params", type: "GetDefinitionsParams" },
                    { name: "at", type: "BlockHash", isOptional: true }
                ]
            },
            getInstances: {
                description: "Query and Return Fragment Instance(s) based on `params`", type: "String",
                params: [
                    { name: "params", type: "GetInstancesParams" },
                    { name: "at", type: "BlockHash", isOptional: true }
                ]
            },
            getInstanceOwner: {
                description: "Query the owner of a Fragment Instance. The return type is a String", type: "String",
                params: [
                    { name: "params", type: "GetInstanceOwnerParams" },
                    { name: "at", type: "BlockHash", isOptional: true }
                ]
            },
        },
    },
    types: {
        Categories: {
            _enum: {
                "text": "TextCategories",
                "trait": "Option<ShardsTrait>",
                "shards": "ShardsScriptInfo",
                "audio": "AudioCategories",
                "texture": "TextureCategories",
                "vector": "VectorCategories",
                "video": "VideoCategories",
                "model": "ModelCategories",
                "binary": "BinaryCategories",
            }
        },
        AudioCategories: {
            _enum: [
                "oggFile",
                "mp3File",
            ]
        },
        ModelCategories: {
            _enum: [
                "gltfFile",
                "sdf",
                "physicsCollider"
            ]
        },
        TextureCategories: {
            _enum: [
                "pngFile",
                "jpgFile"
            ]
        },
        VectorCategories: {
            _enum: [
                "svgFile",
                "ttfFile"
            ]
        },
        VideoCategories: {
            _enum: [
                "mkvFile",
                "mp4File"
            ]
        },
        TextCategories: {
            _enum: [
                "plain",
                "json",
                "wgsl"
            ]
        },
        BinaryCategories: {
            _enum: [
                "wasmProgram",
                "wasmReactor",
                "blendFile",
                "onnxModel",
                "safeTensors"
            ]
        },
        ShardsScriptInfo: {
            format: "ShardsFormat",
            requiring: "Vec<ShardsTrait>",
            implementing: "Vec<ShardsTrait>"
        },
        ShardsTrait: "Vec<u16>",
        ShardsFormat: {
            _enum: [
                "edn",
                "binary",
            ]
        },
        UsageLicense: {
            _enum: {
                "Closed": null,
                "Open": null,
                "Tickets": "Compact<u64>",
                "Contract": "AccountId",
            }
        },
        BlockHash: "Hash",
        Hash128: "[u8; 16]",
        FragmentMetadata: {
            name: "Vec<u8>",
            currency: "Option<AssetId>",
        },
        UniqueOptions: {
            mutable: "bool",
        },
        GetProtosParams: {
            desc: 'bool',
            from: 'u32',
            limit: 'u32',
            metadata_keys: 'Vec<String>',
            owner: 'Option<AccountId>',
            return_owners: 'bool',
            categories: 'Vec<Categories>',
            tags: 'Vec<String>',
            exclude_tags: 'Vec<String>',
            available: 'Option<bool>',
        },
        GetGenealogyParams: {
            proto_hash: "String",
            get_ancestors: "bool",
        },
        GetDefinitionsParams: {
            desc: "bool",
            from: "u64",
            limit: "u64",
            metadata_keys: "Vec<String>",
            owner: "Option<AccountId>",
            return_owners: "bool",
        },
        GetInstancesParams: {
            desc: "bool",
            from: "u64",
            limit: "u64",
            definition_hash: "String", // "Hash128",  // using `String` because Polkadot-JS has a problem fixed-sized arrays: https://github.com/encointer/pallets/pull/86
            metadata_keys: "Vec<String>",
            owner: "Option<AccountId>",
            only_return_first_copies: "bool",
        },
        GetInstanceOwnerParams: {
            definition_hash: 'String', // "Hash128", // using `String` because Polkadot-JS has a problem fixed-sized arrays: https://github.com/encointer/pallets/pull/86
            edition_id: "Unit",
            copy_id: "Unit",
        },
        "Unit": "u64",
    }
};