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
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
// Copyright 2019-2023 Parity Technologies (UK) Ltd.
// This file is dual-licensed as Apache-2.0 or GPL-3.0.
// see LICENSE for license details.

use std::collections::HashMap;

use super::TryFromError;
use crate::Metadata;
use frame_metadata::{v14, v15};

impl TryFrom<v14::RuntimeMetadataV14> for Metadata {
    type Error = TryFromError;
    fn try_from(value: v14::RuntimeMetadataV14) -> Result<Self, Self::Error> {
        // Convert to v15 and then convert that into Metadata.
        v14_to_v15(value).try_into()
    }
}

impl From<Metadata> for v14::RuntimeMetadataV14 {
    fn from(val: Metadata) -> Self {
        let v15 = val.into();
        v15_to_v14(v15)
    }
}

fn v15_to_v14(mut metadata: v15::RuntimeMetadataV15) -> v14::RuntimeMetadataV14 {
    let types = &mut metadata.types;

    // In subxt we care about the `Address`, `Call`, `Signature` and `Extra` types.
    let extrinsic_type = scale_info::Type {
        path: scale_info::Path {
            segments: vec![
                "primitives".to_string(),
                "runtime".to_string(),
                "generic".to_string(),
                "UncheckedExtrinsic".to_string(),
            ],
        },
        type_params: vec![
            scale_info::TypeParameter::<scale_info::form::PortableForm> {
                name: "Address".to_string(),
                ty: Some(metadata.extrinsic.address_ty),
            },
            scale_info::TypeParameter::<scale_info::form::PortableForm> {
                name: "Call".to_string(),
                ty: Some(metadata.extrinsic.call_ty),
            },
            scale_info::TypeParameter::<scale_info::form::PortableForm> {
                name: "Signature".to_string(),
                ty: Some(metadata.extrinsic.signature_ty),
            },
            scale_info::TypeParameter::<scale_info::form::PortableForm> {
                name: "Extra".to_string(),
                ty: Some(metadata.extrinsic.extra_ty),
            },
        ],
        type_def: scale_info::TypeDef::Composite(scale_info::TypeDefComposite { fields: vec![] }),
        docs: vec![],
    };
    let extrinsic_type_id = types.types.len() as u32;

    types.types.push(scale_info::PortableType {
        id: extrinsic_type_id,
        ty: extrinsic_type,
    });

    v14::RuntimeMetadataV14 {
        types: metadata.types,
        pallets: metadata
            .pallets
            .into_iter()
            .map(|pallet| frame_metadata::v14::PalletMetadata {
                name: pallet.name,
                storage: pallet
                    .storage
                    .map(|storage| frame_metadata::v14::PalletStorageMetadata {
                        prefix: storage.prefix,
                        entries: storage
                            .entries
                            .into_iter()
                            .map(|entry| {
                                let modifier = match entry.modifier {
                                    frame_metadata::v15::StorageEntryModifier::Optional => {
                                        frame_metadata::v14::StorageEntryModifier::Optional
                                    }
                                    frame_metadata::v15::StorageEntryModifier::Default => {
                                        frame_metadata::v14::StorageEntryModifier::Default
                                    }
                                };

                                let ty = match entry.ty {
                                    frame_metadata::v15::StorageEntryType::Plain(ty) => {
                                        frame_metadata::v14::StorageEntryType::Plain(ty)
                                    },
                                    frame_metadata::v15::StorageEntryType::Map {
                                        hashers,
                                        key,
                                        value,
                                    } => frame_metadata::v14::StorageEntryType::Map {
                                        hashers: hashers.into_iter().map(|hasher| match hasher {
                                            frame_metadata::v15::StorageHasher::Blake2_128 => frame_metadata::v14::StorageHasher::Blake2_128,
                                            frame_metadata::v15::StorageHasher::Blake2_256 => frame_metadata::v14::StorageHasher::Blake2_256,
                                            frame_metadata::v15::StorageHasher::Blake2_128Concat  => frame_metadata::v14::StorageHasher::Blake2_128Concat ,
                                            frame_metadata::v15::StorageHasher::Twox128 => frame_metadata::v14::StorageHasher::Twox128,
                                            frame_metadata::v15::StorageHasher::Twox256 => frame_metadata::v14::StorageHasher::Twox256,
                                            frame_metadata::v15::StorageHasher::Twox64Concat => frame_metadata::v14::StorageHasher::Twox64Concat,
                                            frame_metadata::v15::StorageHasher::Identity=> frame_metadata::v14::StorageHasher::Identity,
                                        }).collect(),
                                        key,
                                        value,
                                    },
                                };

                                frame_metadata::v14::StorageEntryMetadata {
                                    name: entry.name,
                                    modifier,
                                    ty,
                                    default: entry.default,
                                    docs: entry.docs,
                                }
                            })
                            .collect(),
                    }),
                calls: pallet.calls.map(|calls| frame_metadata::v14::PalletCallMetadata { ty: calls.ty } ),
                event: pallet.event.map(|event| frame_metadata::v14::PalletEventMetadata { ty: event.ty } ),
                constants: pallet.constants.into_iter().map(|constant| frame_metadata::v14::PalletConstantMetadata {
                    name: constant.name,
                    ty: constant.ty,
                    value: constant.value,
                    docs: constant.docs,
                } ).collect(),
                error: pallet.error.map(|error| frame_metadata::v14::PalletErrorMetadata { ty: error.ty } ),
                index: pallet.index,
            })
            .collect(),
        extrinsic: frame_metadata::v14::ExtrinsicMetadata {
            ty: extrinsic_type_id.into(),
            version: metadata.extrinsic.version,
            signed_extensions: metadata.extrinsic.signed_extensions.into_iter().map(|ext| {
                frame_metadata::v14::SignedExtensionMetadata {
                    identifier: ext.identifier,
                    ty: ext.ty,
                    additional_signed: ext.additional_signed,
                }
            }).collect()
        },
        ty: metadata.ty,
    }
}

fn v14_to_v15(mut metadata: v14::RuntimeMetadataV14) -> v15::RuntimeMetadataV15 {
    // Find the extrinsic types.
    let extrinsic_parts = ExtrinsicPartTypeIds::new(&metadata)
        .expect("Extrinsic types are always present on V14; qed");

    let outer_enums = generate_outer_enums(&mut metadata);

    v15::RuntimeMetadataV15 {
        types: metadata.types,
        pallets: metadata
            .pallets
            .into_iter()
            .map(|pallet| frame_metadata::v15::PalletMetadata {
                name: pallet.name,
                storage: pallet
                    .storage
                    .map(|storage| frame_metadata::v15::PalletStorageMetadata {
                        prefix: storage.prefix,
                        entries: storage
                            .entries
                            .into_iter()
                            .map(|entry| {
                                let modifier = match entry.modifier {
                                    frame_metadata::v14::StorageEntryModifier::Optional => {
                                        frame_metadata::v15::StorageEntryModifier::Optional
                                    }
                                    frame_metadata::v14::StorageEntryModifier::Default => {
                                        frame_metadata::v15::StorageEntryModifier::Default
                                    }
                                };

                                let ty = match entry.ty {
                                    frame_metadata::v14::StorageEntryType::Plain(ty) => {
                                        frame_metadata::v15::StorageEntryType::Plain(ty)
                                    },
                                    frame_metadata::v14::StorageEntryType::Map {
                                        hashers,
                                        key,
                                        value,
                                    } => frame_metadata::v15::StorageEntryType::Map {
                                        hashers: hashers.into_iter().map(|hasher| match hasher {
                                            frame_metadata::v14::StorageHasher::Blake2_128 => frame_metadata::v15::StorageHasher::Blake2_128,
                                            frame_metadata::v14::StorageHasher::Blake2_256 => frame_metadata::v15::StorageHasher::Blake2_256,
                                            frame_metadata::v14::StorageHasher::Blake2_128Concat  => frame_metadata::v15::StorageHasher::Blake2_128Concat ,
                                            frame_metadata::v14::StorageHasher::Twox128 => frame_metadata::v15::StorageHasher::Twox128,
                                            frame_metadata::v14::StorageHasher::Twox256 => frame_metadata::v15::StorageHasher::Twox256,
                                            frame_metadata::v14::StorageHasher::Twox64Concat => frame_metadata::v15::StorageHasher::Twox64Concat,
                                            frame_metadata::v14::StorageHasher::Identity=> frame_metadata::v15::StorageHasher::Identity,
                                        }).collect(),
                                        key,
                                        value,
                                    },
                                };

                                frame_metadata::v15::StorageEntryMetadata {
                                    name: entry.name,
                                    modifier,
                                    ty,
                                    default: entry.default,
                                    docs: entry.docs,
                                }
                            })
                            .collect(),
                    }),
                calls: pallet.calls.map(|calls| frame_metadata::v15::PalletCallMetadata { ty: calls.ty } ),
                event: pallet.event.map(|event| frame_metadata::v15::PalletEventMetadata { ty: event.ty } ),
                constants: pallet.constants.into_iter().map(|constant| frame_metadata::v15::PalletConstantMetadata {
                    name: constant.name,
                    ty: constant.ty,
                    value: constant.value,
                    docs: constant.docs,
                } ).collect(),
                error: pallet.error.map(|error| frame_metadata::v15::PalletErrorMetadata { ty: error.ty } ),
                index: pallet.index,
                docs: Default::default(),
            })
            .collect(),
        extrinsic: frame_metadata::v15::ExtrinsicMetadata {
            version: metadata.extrinsic.version,
            signed_extensions: metadata.extrinsic.signed_extensions.into_iter().map(|ext| {
                frame_metadata::v15::SignedExtensionMetadata {
                    identifier: ext.identifier,
                    ty: ext.ty,
                    additional_signed: ext.additional_signed,
                }
            }).collect(),
            address_ty: extrinsic_parts.address.into(),
            call_ty: extrinsic_parts.call.into(),
            signature_ty: extrinsic_parts.signature.into(),
            extra_ty: extrinsic_parts.extra.into(),
        },
        ty: metadata.ty,
        apis: Default::default(),
        outer_enums,
        custom: v15::CustomMetadata {
            map: Default::default(),
        },
    }
}

/// The type IDs extracted from the metadata that represent the
/// generic type parameters passed to the `UncheckedExtrinsic` from
/// the substrate-based chain.
struct ExtrinsicPartTypeIds {
    address: u32,
    call: u32,
    signature: u32,
    extra: u32,
}

impl ExtrinsicPartTypeIds {
    /// Extract the generic type parameters IDs from the extrinsic type.
    fn new(metadata: &v14::RuntimeMetadataV14) -> Result<Self, String> {
        const ADDRESS: &str = "Address";
        const CALL: &str = "Call";
        const SIGNATURE: &str = "Signature";
        const EXTRA: &str = "Extra";

        let extrinsic_id = metadata.extrinsic.ty.id;
        let Some(extrinsic_ty) = metadata.types.resolve(extrinsic_id) else {
            return Err("Missing extrinsic type".into())
        };

        let params: HashMap<_, _> = extrinsic_ty
            .type_params
            .iter()
            .map(|ty_param| {
                let Some(ty) = ty_param.ty else {
                    return Err("Missing type param type from extrinsic".to_string());
                };

                Ok((ty_param.name.as_str(), ty.id))
            })
            .collect::<Result<_, _>>()?;

        let Some(address) = params.get(ADDRESS) else {
            return Err("Missing address type from extrinsic".into());
        };
        let Some(call) = params.get(CALL) else {
            return Err("Missing call type from extrinsic".into());
        };
        let Some(signature) = params.get(SIGNATURE) else {
            return Err("Missing signature type from extrinsic".into());
        };
        let Some(extra) = params.get(EXTRA) else {
            return Err("Missing extra type from extrinsic".into());
        };

        Ok(ExtrinsicPartTypeIds {
            address: *address,
            call: *call,
            signature: *signature,
            extra: *extra,
        })
    }
}

fn generate_outer_enums(
    metadata: &mut v14::RuntimeMetadataV14,
) -> v15::OuterEnums<scale_info::form::PortableForm> {
    let call_enum = metadata
        .types
        .types
        .iter()
        .find(|ty| {
            let Some(ident) = ty.ty.path.ident() else { return false };
            ident == "RuntimeCall"
        })
        .expect("RuntimeCall exists in V14; qed");

    let event_enum = metadata
        .types
        .types
        .iter()
        .find(|ty| {
            let Some(ident) = ty.ty.path.ident() else { return false };
            ident == "RuntimeEvent"
        })
        .expect("RuntimeEvent exists in V14; qed");

    let call_ty = call_enum.id.into();
    let event_ty = event_enum.id.into();

    let mut path_segments = call_enum.ty.path.segments.clone();
    let last = path_segments
        .last_mut()
        .expect("Should have at least one segment checked above; qed");
    *last = "RuntimeError".to_string();

    let error_ty_id = generate_runtime_error_type(metadata, path_segments);

    v15::OuterEnums {
        call_enum_ty: call_ty,
        event_enum_ty: event_ty,
        error_enum_ty: error_ty_id.into(),
    }
}

/// Generate the `RuntimeError` type and add it to the metadata.
///
/// Returns the `RuntimeError` Id from the registry.
fn generate_runtime_error_type(
    metadata: &mut v14::RuntimeMetadataV14,
    path_segments: Vec<String>,
) -> u32 {
    let variants: Vec<_> = metadata
        .pallets
        .iter()
        .filter_map(|pallet| {
            let Some(pallet_error) = &pallet.error else { return None };
            let path = format!("{}Error", pallet.name);

            Some(scale_info::Variant {
                name: pallet.name.clone(),
                fields: vec![scale_info::Field {
                    name: None,
                    ty: pallet_error.ty.id.into(),
                    type_name: Some(path),
                    docs: vec![],
                }],
                index: pallet.index,
                docs: vec![],
            })
        })
        .collect();

    let error_type = scale_info::Type {
        path: scale_info::Path {
            segments: path_segments,
        },
        type_params: vec![],
        type_def: scale_info::TypeDef::Variant(scale_info::TypeDefVariant { variants }),
        docs: vec![],
    };

    let error_type_id = metadata.types.types.len() as u32;

    metadata.types.types.push(scale_info::PortableType {
        id: error_type_id,
        ty: error_type,
    });

    error_type_id
}

#[cfg(test)]
mod tests {
    use super::*;
    use codec::Decode;
    use frame_metadata::{v15::RuntimeMetadataV15, RuntimeMetadata, RuntimeMetadataPrefixed};
    use scale_info::TypeDef;
    use std::{fs, path::Path};

    fn load_v15_metadata() -> RuntimeMetadataV15 {
        let bytes = fs::read(Path::new("../artifacts/polkadot_metadata_full.scale"))
            .expect("Cannot read metadata blob");
        let meta: RuntimeMetadataPrefixed =
            Decode::decode(&mut &*bytes).expect("Cannot decode scale metadata");

        match meta.1 {
            RuntimeMetadata::V15(v15) => v15,
            _ => panic!("Unsupported metadata version {:?}", meta.1),
        }
    }

    #[test]
    fn test_extrinsic_id_generation() {
        let v15 = load_v15_metadata();
        let v14 = v15_to_v14(v15.clone());

        let ext_ty = v14.types.resolve(v14.extrinsic.ty.id).unwrap();
        let addr_id = ext_ty
            .type_params
            .iter()
            .find_map(|ty| {
                if ty.name == "Address" {
                    Some(ty.ty.unwrap().id)
                } else {
                    None
                }
            })
            .unwrap();
        let call_id = ext_ty
            .type_params
            .iter()
            .find_map(|ty| {
                if ty.name == "Call" {
                    Some(ty.ty.unwrap().id)
                } else {
                    None
                }
            })
            .unwrap();
        let extra_id = ext_ty
            .type_params
            .iter()
            .find_map(|ty| {
                if ty.name == "Extra" {
                    Some(ty.ty.unwrap().id)
                } else {
                    None
                }
            })
            .unwrap();
        let signature_id = ext_ty
            .type_params
            .iter()
            .find_map(|ty| {
                if ty.name == "Signature" {
                    Some(ty.ty.unwrap().id)
                } else {
                    None
                }
            })
            .unwrap();

        // Position in type registry shouldn't change.
        assert_eq!(v15.extrinsic.address_ty.id, addr_id);
        assert_eq!(v15.extrinsic.call_ty.id, call_id);
        assert_eq!(v15.extrinsic.extra_ty.id, extra_id);
        assert_eq!(v15.extrinsic.signature_ty.id, signature_id);

        let v15_addr = v15.types.resolve(v15.extrinsic.address_ty.id).unwrap();
        let v14_addr = v14.types.resolve(addr_id).unwrap();
        assert_eq!(v15_addr, v14_addr);

        let v15_call = v15.types.resolve(v15.extrinsic.call_ty.id).unwrap();
        let v14_call = v14.types.resolve(call_id).unwrap();
        assert_eq!(v15_call, v14_call);

        let v15_extra = v15.types.resolve(v15.extrinsic.extra_ty.id).unwrap();
        let v14_extra = v14.types.resolve(extra_id).unwrap();
        assert_eq!(v15_extra, v14_extra);

        let v15_sign = v15.types.resolve(v15.extrinsic.signature_ty.id).unwrap();
        let v14_sign = v14.types.resolve(signature_id).unwrap();
        assert_eq!(v15_sign, v14_sign);

        // Ensure we don't lose the information when converting back to v15.
        let converted_v15 = v14_to_v15(v14);

        let v15_addr = v15.types.resolve(v15.extrinsic.address_ty.id).unwrap();
        let converted_v15_addr = converted_v15
            .types
            .resolve(converted_v15.extrinsic.address_ty.id)
            .unwrap();
        assert_eq!(v15_addr, converted_v15_addr);

        let v15_call = v15.types.resolve(v15.extrinsic.call_ty.id).unwrap();
        let converted_v15_call = converted_v15
            .types
            .resolve(converted_v15.extrinsic.call_ty.id)
            .unwrap();
        assert_eq!(v15_call, converted_v15_call);

        let v15_extra = v15.types.resolve(v15.extrinsic.extra_ty.id).unwrap();
        let converted_v15_extra = converted_v15
            .types
            .resolve(converted_v15.extrinsic.extra_ty.id)
            .unwrap();
        assert_eq!(v15_extra, converted_v15_extra);

        let v15_sign = v15.types.resolve(v15.extrinsic.signature_ty.id).unwrap();
        let converted_v15_sign = converted_v15
            .types
            .resolve(converted_v15.extrinsic.signature_ty.id)
            .unwrap();
        assert_eq!(v15_sign, converted_v15_sign);
    }

    #[test]
    fn test_outer_enums_generation() {
        let v15 = load_v15_metadata();
        let v14 = v15_to_v14(v15.clone());

        // Convert back to v15 and expect to have the enum types properly generated.
        let converted_v15 = v14_to_v15(v14);

        // RuntimeCall and RuntimeEvent were already present in the metadata v14.
        let v15_call = v15.types.resolve(v15.outer_enums.call_enum_ty.id).unwrap();
        let converted_v15_call = converted_v15
            .types
            .resolve(converted_v15.outer_enums.call_enum_ty.id)
            .unwrap();
        assert_eq!(v15_call, converted_v15_call);

        let v15_event = v15.types.resolve(v15.outer_enums.event_enum_ty.id).unwrap();
        let converted_v15_event = converted_v15
            .types
            .resolve(converted_v15.outer_enums.event_enum_ty.id)
            .unwrap();
        assert_eq!(v15_event, converted_v15_event);

        let v15_error = v15.types.resolve(v15.outer_enums.error_enum_ty.id).unwrap();
        let converted_v15_error = converted_v15
            .types
            .resolve(converted_v15.outer_enums.error_enum_ty.id)
            .unwrap();

        // Ensure they match in terms of variants and fields ids.
        assert_eq!(v15_error.path, converted_v15_error.path);

        let TypeDef::Variant(v15_variant) = &v15_error.type_def else {
            panic!("V15 error must be a variant");
        };

        let TypeDef::Variant(converted_v15_variant) = &converted_v15_error.type_def else {
            panic!("Converted V15 error must be a variant");
        };

        assert_eq!(
            v15_variant.variants.len(),
            converted_v15_variant.variants.len()
        );

        for (v15_var, converted_v15_var) in v15_variant
            .variants
            .iter()
            .zip(converted_v15_variant.variants.iter())
        {
            // Variant name must match.
            assert_eq!(v15_var.name, converted_v15_var.name);
            assert_eq!(v15_var.fields.len(), converted_v15_var.fields.len());

            // Fields must have the same type.
            for (v15_field, converted_v15_field) in
                v15_var.fields.iter().zip(converted_v15_var.fields.iter())
            {
                assert_eq!(v15_field.ty.id, converted_v15_field.ty.id);

                let ty = v15.types.resolve(v15_field.ty.id).unwrap();
                let converted_ty = converted_v15
                    .types
                    .resolve(converted_v15_field.ty.id)
                    .unwrap();
                assert_eq!(ty, converted_ty);
            }
        }
    }
}