-
Notifications
You must be signed in to change notification settings - Fork 174
/
metadataV10.go
451 lines (400 loc) · 9.32 KB
/
metadataV10.go
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
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
// Go Substrate RPC Client (GSRPC) provides APIs and types around Polkadot and any Substrate-based chain RPC calls
//
// Copyright 2019 Centrifuge GmbH
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package types
import (
"errors"
"fmt"
"hash"
"strings"
ghash "github.com/centrifuge/go-substrate-rpc-client/v4/hash"
"github.com/centrifuge/go-substrate-rpc-client/v4/scale"
"github.com/centrifuge/go-substrate-rpc-client/v4/xxhash"
)
// Modelled after packages/types/src/Metadata/v10/Metadata.ts
type MetadataV10 struct {
Modules []ModuleMetadataV10
}
func (m *MetadataV10) Decode(decoder scale.Decoder) error {
err := decoder.Decode(&m.Modules)
if err != nil {
return err
}
return nil
}
func (m MetadataV10) Encode(encoder scale.Encoder) error {
err := encoder.Encode(m.Modules)
if err != nil {
return err
}
return nil
}
func (m *MetadataV10) FindCallIndex(call string) (CallIndex, error) {
s := strings.Split(call, ".")
mi := uint8(0)
for _, mod := range m.Modules {
if !mod.HasCalls {
continue
}
if string(mod.Name) != s[0] {
mi++
continue
}
for ci, f := range mod.Calls {
if string(f.Name) == s[1] {
return CallIndex{mi, uint8(ci)}, nil
}
}
return CallIndex{}, fmt.Errorf("method %v not found within module %v for call %v", s[1], mod.Name, call)
}
return CallIndex{}, fmt.Errorf("module %v not found in metadata for call %v", s[0], call)
}
func (m *MetadataV10) FindEventNamesForEventID(eventID EventID) (Text, Text, error) {
mi := uint8(0)
for _, mod := range m.Modules {
if !mod.HasEvents {
continue
}
if mi != eventID[0] {
mi++
continue
}
if int(eventID[1]) >= len(mod.Events) {
return "", "", fmt.Errorf("event index %v for module %v out of range", eventID[1], mod.Name)
}
return mod.Name, mod.Events[eventID[1]].Name, nil
}
return "", "", fmt.Errorf("module index %v out of range", eventID[0])
}
func (m *MetadataV10) FindConstantValue(module Text, constant Text) ([]byte, error) {
for _, mod := range m.Modules {
if mod.Name == module {
value, err := mod.FindConstantValue(constant)
if err == nil {
return value, nil
}
}
}
return nil, fmt.Errorf("could not find constant %s.%s", module, constant)
}
func (m *MetadataV10) FindStorageEntryMetadata(module string, fn string) (StorageEntryMetadata, error) {
for _, mod := range m.Modules {
if !mod.HasStorage {
continue
}
if string(mod.Storage.Prefix) != module {
continue
}
for _, s := range mod.Storage.Items {
if string(s.Name) != fn {
continue
}
return s, nil
}
return nil, fmt.Errorf("storage %v not found within module %v", fn, module)
}
return nil, fmt.Errorf("module %v not found in metadata", module)
}
func (m *MetadataV10) ExistsModuleMetadata(module string) bool {
for _, mod := range m.Modules {
if string(mod.Name) == module {
return true
}
}
return false
}
type ModuleMetadataV10 struct {
Name Text
HasStorage bool
Storage StorageMetadataV10
HasCalls bool
Calls []FunctionMetadataV4
HasEvents bool
Events []EventMetadataV4
Constants []ModuleConstantMetadataV6
Errors []ErrorMetadataV8
}
func (m *ModuleMetadataV10) Decode(decoder scale.Decoder) error {
err := decoder.Decode(&m.Name)
if err != nil {
return err
}
err = decoder.DecodeOption(&m.HasStorage, &m.Storage)
if err != nil {
return err
}
err = decoder.DecodeOption(&m.HasCalls, &m.Calls)
if err != nil {
return err
}
err = decoder.DecodeOption(&m.HasEvents, &m.Events)
if err != nil {
return err
}
err = decoder.Decode(&m.Constants)
if err != nil {
return err
}
return decoder.Decode(&m.Errors)
}
func (m ModuleMetadataV10) Encode(encoder scale.Encoder) error {
err := encoder.Encode(m.Name)
if err != nil {
return err
}
err = encoder.EncodeOption(m.HasStorage, m.Storage)
if err != nil {
return err
}
err = encoder.EncodeOption(m.HasCalls, m.Calls)
if err != nil {
return err
}
err = encoder.EncodeOption(m.HasEvents, m.Events)
if err != nil {
return err
}
err = encoder.Encode(m.Constants)
if err != nil {
return err
}
return encoder.Encode(m.Errors)
}
func (m *ModuleMetadataV10) FindConstantValue(constant Text) ([]byte, error) {
for _, cons := range m.Constants {
if cons.Name == constant {
return cons.Value, nil
}
}
return nil, fmt.Errorf("could not find constant %s", constant)
}
type StorageMetadataV10 struct {
Prefix Text
Items []StorageFunctionMetadataV10
}
type StorageFunctionMetadataV10 struct {
Name Text
Modifier StorageFunctionModifierV0
Type StorageFunctionTypeV10
Fallback Bytes
Documentation []Text
}
func (s StorageFunctionMetadataV10) IsPlain() bool {
return s.Type.IsType
}
func (s StorageFunctionMetadataV10) Hasher() (hash.Hash, error) {
return DefaultPlainHasher(s)
}
func (s StorageFunctionMetadataV10) IsMap() bool {
return s.Type.IsMap || s.Type.IsDoubleMap
}
func (s StorageFunctionMetadataV10) Hashers() ([]hash.Hash, error) {
if !s.IsMap() {
return nil, fmt.Errorf("Hashers() is only to be called on Maps")
}
var hashers = collectHashersV10(s.Type)
hasherFns := make([]hash.Hash, len(hashers))
for i, hasher := range hashers {
hasherFn, err := hasher.HashFunc()
if err != nil {
return nil, err
}
hasherFns[i] = hasherFn
}
return hasherFns, nil
}
func collectHashersV10(x StorageFunctionTypeV10) []StorageHasherV10 {
switch {
case x.IsMap:
return []StorageHasherV10{x.AsMap.Hasher}
case x.IsDoubleMap:
return []StorageHasherV10{x.AsDoubleMap.Hasher, x.AsDoubleMap.Key2Hasher}
default:
panic("Unexpexted type")
}
}
type StorageFunctionTypeV10 struct {
IsType bool
AsType Type // 0
IsMap bool
AsMap MapTypeV10 // 1
IsDoubleMap bool
AsDoubleMap DoubleMapTypeV10 // 2
}
func (s *StorageFunctionTypeV10) Decode(decoder scale.Decoder) error {
var t uint8
err := decoder.Decode(&t)
if err != nil {
return err
}
switch t {
case 0:
s.IsType = true
err = decoder.Decode(&s.AsType)
if err != nil {
return err
}
case 1:
s.IsMap = true
err = decoder.Decode(&s.AsMap)
if err != nil {
return err
}
case 2:
s.IsDoubleMap = true
err = decoder.Decode(&s.AsDoubleMap)
if err != nil {
return err
}
default:
return fmt.Errorf("received unexpected type %v", t)
}
return nil
}
func (s StorageFunctionTypeV10) Encode(encoder scale.Encoder) error {
switch {
case s.IsType:
err := encoder.PushByte(0)
if err != nil {
return err
}
err = encoder.Encode(s.AsType)
if err != nil {
return err
}
case s.IsMap:
err := encoder.PushByte(1)
if err != nil {
return err
}
err = encoder.Encode(s.AsMap)
if err != nil {
return err
}
case s.IsDoubleMap:
err := encoder.PushByte(2)
if err != nil {
return err
}
err = encoder.Encode(s.AsDoubleMap)
if err != nil {
return err
}
default:
return fmt.Errorf("expected to be either type, map or double map, but none was set: %v", s)
}
return nil
}
type MapTypeV10 struct {
Hasher StorageHasherV10
Key Type
Value Type
Linked bool
}
type DoubleMapTypeV10 struct {
Hasher StorageHasherV10
Key1 Type
Key2 Type
Value Type
Key2Hasher StorageHasherV10
}
type StorageHasherV10 struct {
IsBlake2_128 bool // 0
IsBlake2_256 bool // 1
IsBlake2_128Concat bool // 2
IsTwox128 bool // 3
IsTwox256 bool // 4
IsTwox64Concat bool // 5
IsIdentity bool // 6
}
func (s *StorageHasherV10) Decode(decoder scale.Decoder) error {
var t uint8
err := decoder.Decode(&t)
if err != nil {
return err
}
switch t {
case 0:
s.IsBlake2_128 = true
case 1:
s.IsBlake2_256 = true
case 2:
s.IsBlake2_128Concat = true
case 3:
s.IsTwox128 = true
case 4:
s.IsTwox256 = true
case 5:
s.IsTwox64Concat = true
case 6:
s.IsIdentity = true
default:
return fmt.Errorf("received unexpected storage hasher type %v", t)
}
return nil
}
func (s StorageHasherV10) Encode(encoder scale.Encoder) error {
var t uint8
switch {
case s.IsBlake2_128:
t = 0
case s.IsBlake2_256:
t = 1
case s.IsBlake2_128Concat:
t = 2
case s.IsTwox128:
t = 3
case s.IsTwox256:
t = 4
case s.IsTwox64Concat:
t = 5
case s.IsIdentity:
t = 6
default:
return fmt.Errorf("expected storage hasher, but none was set: %v", s)
}
return encoder.PushByte(t)
}
func (s StorageHasherV10) HashFunc() (hash.Hash, error) {
// Blake2_128
if s.IsBlake2_128 {
return ghash.NewBlake2b128(nil)
}
// Blake2_256
if s.IsBlake2_256 {
return ghash.NewBlake2b256(nil)
}
// Blake2_128Concat
if s.IsBlake2_128Concat {
return ghash.NewBlake2b128Concat(nil)
}
// Twox128
if s.IsTwox128 {
return xxhash.New128(nil), nil
}
// Twox256
if s.IsTwox256 {
return xxhash.New256(nil), nil
}
// Twox64Concat
if s.IsTwox64Concat {
return xxhash.New64Concat(nil), nil
}
// Identity
if s.IsIdentity {
return ghash.NewIdentity(nil), nil
}
return nil, errors.New("hash function type not yet supported")
}