-
Notifications
You must be signed in to change notification settings - Fork 30
/
package.spec.json
379 lines (379 loc) · 10.1 KB
/
package.spec.json
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
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
{
"title": "Package Manifest",
"description": "EthPM Manifest Specification",
"type": "object",
"required": [
"manifest_version",
"package_name",
"version"
],
"version": "2",
"properties": {
"manifest_version": {
"type": "string",
"title": "Manifest Version",
"description": "EthPM Manifest Version",
"default": "2",
"enum": ["2"]
},
"package_name": {
"title": "Package Name",
"description": "The name of the package that this release is for",
"type": "string",
"pattern": "^[a-z][-a-z0-9]{0,254}$"
},
"meta": {
"$ref": "#/definitions/PackageMeta"
},
"version": {
"title": "Version",
"type": "string"
},
"sources": {
"title": "Sources",
"type": "object",
"patternProperties": {
"\\.\\/.*": {
"anyOf": [
{
"title": "Source code",
"type": "string"
},
{
"$ref": "#/definitions/ContentURI"
}
]
}
}
},
"contract_types": {
"title": "Contract Types",
"description": "The contract types included in this release",
"type": "object",
"patternProperties": {
"[a-zA-Z][-a-zA-Z0-9_]{0,254}(?:\\[[-a-zA-Z0-9]{1,256}\\])?$": {
"$ref": "#/definitions/ContractType"
}
}
},
"deployments": {
"title": "Deployments",
"description": "The deployed contract instances in this release",
"type": "object",
"patternProperties": {
"^blockchain\\://[0-9a-zA-Z]{64}/block/[0-9a-zA-Z]{64}$": {
"$ref": "#/definitions/Deployment"
}
}
},
"build_dependencies": {
"title": "Build Dependencies",
"type": "object",
"patternProperties": {
"^[a-z][-a-z0-9]{0,254}$": {
"$ref": "#/definitions/ContentURI"
}
}
}
},
"definitions": {
"PackageMeta": {
"title": "Package Meta",
"description": "Metadata about the package",
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "Authors of this package",
"type": "array",
"items": {
"type": "string"
}
},
"license": {
"title": "License",
"description": "The license that this package and it's source are released under",
"type": "string"
},
"description": {
"title": "Description",
"description": "Description of this package",
"type": "string"
},
"keywords": {
"title": "Keywords",
"description": "Keywords that apply to this package",
"type": "array",
"items": {
"type": "string"
}
},
"links": {
"title": "Links",
"descriptions": "URIs for resources related to this package",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uri"
}
}
}
},
"ContractType": {
"title": "Contract Type",
"description": "Data for a contract type included in this package",
"type": "object",
"properties":{
"contract_name": {
"title": "Contract Name",
"description": "The name for this contract type as found in the project source code.",
"type": "string",
"pattern": "[a-zA-Z][a-zA-Z0-9_]{0,254}"
},
"deployment_bytecode": {
"$ref": "#/definitions/BytecodeObject"
},
"runtime_bytecode": {
"$ref": "#/definitions/BytecodeObject"
},
"abi": {
"title": "ABI",
"description": "The ABI for this contract type",
"type": "array"
},
"natspec": {
"title": "NatSpec",
"description": "The combined user-doc and dev-doc for this contract",
"type": "object"
},
"compiler": {
"$ref": "#/definitions/CompilerInformation"
}
}
},
"ContractInstance": {
"title": "Contract Instance",
"description": "Data for a deployed instance of a contract",
"type": "object",
"required": [
"contract_type",
"address"
],
"properties": {
"contract_type": {
"title": "Contract Type Name",
"description": "The contract type of this contract instance",
"type": "string",
"pattern": "^(?:[a-z][-a-z0-9]{0,254}\\:)?[a-zA-Z][-a-zA-Z0-9_]{0,254}(?:\\[[-a-zA-Z0-9]{1,256}\\])?$"
},
"address": {
"$ref": "#/definitions/Address"
},
"transaction": {
"$ref": "#/definitions/TransactionHash"
},
"block": {
"$ref": "#/definitions/BlockHash"
},
"runtime_bytecode": {
"$ref": "#/definitions/BytecodeObject"
},
"compiler": {
"$ref": "#/definitions/CompilerInformation"
},
"link_dependencies": {
"title": "Link Dependencies",
"description": "The values for the link references found within this contract instances runtime bytecode",
"type": "array",
"items": {
"$ref": "#/definitions/LinkValue"
}
}
}
},
"ByteString": {
"title": "Byte String",
"description": "0x-prefixed hexadecimal string representing bytes",
"type": "string",
"pattern": "^0x([0-9a-fA-F]{2})*$"
},
"BytecodeObject": {
"title": "Bytecode Object",
"type": "object",
"anyOf": [
{"required": ["bytecode"]},
{"required": ["link_dependencies"]}
],
"properties": {
"bytecode": {
"$ref": "#/definitions/ByteString"
},
"link_references": {
"type": "array",
"items": {
"$ref": "#/definitions/LinkReference"
}
},
"link_dependencies": {
"type": "array",
"items": {
"$ref": "#/definitions/LinkValue"
}
}
}
},
"LinkReference": {
"title": "Link Reference",
"description": "A defined location in some bytecode which requires linking",
"type": "object",
"required": [
"offsets",
"length",
"name"
],
"properties": {
"offsets": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0
}
},
"length": {
"type": "integer",
"minimum": 1
},
"name": {
"$ref": "#/definitions/Identifier"
}
}
},
"LinkValue": {
"title": "Link Value",
"description": "A value for an individual link reference in a contract's bytecode",
"type": "object",
"required": [
"offsets",
"type",
"value"
],
"properties": {
"offsets": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0
}
},
"type": {
"description": "The type of link value",
"type": "string"
},
"value": {
"description": "The value for the link reference"
}
},
"oneOf": [{
"properties": {
"type": {
"enum": ["literal"]
},
"value": {
"$ref": "#/definitions/ByteString"
}
}
}, {
"properties": {
"type": {
"enum": ["reference"]
},
"value": {
"anyOf": [
{"$ref": "#/definitions/ContractInstanceName"},
{"$ref": "#/definitions/PackageContractInstanceName"}
]
}
}
}]
},
"Identifier": {
"title": "Identifier",
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,254}$"
},
"ContractInstanceName": {
"title": "Contract Instance Name",
"description": "The name of the deployed contract instance",
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,254}$"
},
"Deployment": {
"title": "Deployment",
"type": "object",
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9_]{0,254}$": {
"$ref": "#/definitions/ContractInstance"
}
}
},
"PackageContractInstanceName": {
"title": "Package Contract Instance Name",
"description": "The path to a deployed contract instance somewhere down the dependency tree",
"type": "string",
"pattern": "^([a-z][-a-z0-9]{0,254}\\:)+[a-zA-Z][a-zA-Z0-9_]{0,254}$"
},
"CompilerInformation": {
"title": "Compiler Information",
"description": "Information about the software that was used to compile a contract type or instance",
"type": "object",
"required": [
"name",
"version"
],
"properties": {
"name": {
"description": "The name of the compiler",
"type": "string"
},
"version": {
"description": "The version string for the compiler",
"type": "string"
},
"settings": {
"description": "The settings used for compilation",
"type": "object"
}
}
},
"Address": {
"title": "Address",
"description": "An Ethereum address",
"allOf": [
{ "$ref": "#/definitions/ByteString" },
{ "minLength": 42, "maxLength": 42 }
]
},
"TransactionHash": {
"title": "Transaction Hash",
"description": "An Ethereum transaction hash",
"allOf": [
{ "$ref": "#/definitions/ByteString" },
{ "minLength": 66, "maxLength": 66 }
]
},
"BlockHash": {
"title": "Block Hash",
"description": "An Ethereum block hash",
"allOf": [
{ "$ref": "#/definitions/ByteString" },
{ "minLength": 66, "maxLength": 66 }
]
},
"ContentURI": {
"title": "Content URI",
"description": "An content addressable URI",
"type": "string",
"format": "uri"
}
}
}