Merge pull request #1 from leonardocustodio/milestone4

Create polkadart-milestone_4.md
w3f · Feb 23, 2024 · 0563fc1 · 0563fc1
2 parents b7d5b74 + 8358803
commit 0563fc1
Showing 1 changed file with 283 additions and 0 deletions.
diff --git a/deliveries/polkadart-milestone_4.md b/deliveries/polkadart-milestone_4.md
@@ -0,0 +1,283 @@
+# Milestone Delivery :mailbox:
+
+**The delivery is according to the official [milestone delivery guidelines](https://github.com/w3f/Grants-Program/blob/master/docs/Support%20Docs/milestone-deliverables-guidelines.md).**  
+
+* **Application Document:** https://github.com/w3f/Grants-Program/blob/master/applications/Polkadart.md
+* **Milestone Number:** 4
+
+**Context**
+
+
+This milestone was focused on allowing any developer using Dart and/or Flutter to be able to use sr25519 and ecdsa to create a wallet, sign extrinsics or messages, and send them to the chain. We have also add support for multisig, custom RPC calls and custom signed extensions.
+
+**Little example**
+
+You can create a new Dart project running `dart create demo` and load the following dependencies on `pubspec.yaml`
+```yaml
+  convert: ^3.1.1
+  polkadart: ^0.4.2
+  polkadart_cli: ^0.4.1
+  polkadart_keyring: ^0.4.2
+  polkadart_scale_codec: ^1.2.0
+  ss58: ^1.1.2
+  substrate_bip39: ^0.4.0
+  substrate_metadata: ^1.2.0
+```
+
+Run `dart pub get` to fetch the dependencies and at the end of the file, you may add the RPC endpoint that you want to connect like the following:
+```yaml
+polkadart:
+  output_dir: lib/generated
+  chains:
+    astar: wss://rpc.astar.network
+    westend: wss://westend-rpc.polkadot.io
+    assethub: wss://westend-asset-hub-rpc.polkadot.io
+```
+
+Now you can use our generator to fetch the metadata, parse it, and generate all typed classes with the following command:
+`dart run polkadart_cli:generate -v`
+
+After that, you can play with most of the stuff made on this milestone with the following snippet that can be placed under `bin/demo.dart` and running `dart run bin/demo.dart`
+```dart
+import 'dart:typed_data';
+
+import 'package:convert/convert.dart';
+import 'package:polkadart/polkadart.dart'
+    show
+        AuthorApi,
+        ExtrinsicPayload,
+        Provider,
+        SignatureType,
+        SigningPayload,
+        StateApi;
+import 'package:polkadart_example/generated/assethub/assethub.dart';
+import 'package:polkadart_example/generated/assethub/types/sp_runtime/multiaddress/multi_address.dart'
+    as asset_hub;
+import 'package:polkadart_example/generated/westend/types/sp_runtime/multiaddress/multi_address.dart';
+import 'package:polkadart_example/generated/westend/westend.dart';
+import 'package:polkadart_keyring/polkadart_keyring.dart';
+import 'package:polkadart_scale_codec/polkadart_scale_codec.dart'
+    as scale_codec;
+import 'package:polkadart_scale_codec/polkadart_scale_codec.dart';
+import 'package:ss58/ss58.dart';
+
+Future<void> main(List<String> arguments) async {
+  final westProvider =
+      Provider.fromUri(Uri.parse('wss://westend-rpc.polkadot.io'));
+  final westApi = Westend(westProvider);
+
+  // Create sr25519 wallet
+  final sr25519Wallet = await KeyPair.sr25519.fromMnemonic(
+      "resource mirror lecture smooth midnight muffin position cup pepper fruit vanish also//10");
+  print('Sr25519 Wallet: ${sr25519Wallet.address}');
+
+  // Create ecdsa wallet
+  final ecdsaWallet = await KeyPair.ecdsa.fromMnemonic(
+      "mushroom grab answer fork ripple virus swamp food excess old client arena//10");
+  print('Ecdsa Wallet: ${ecdsaWallet.address}');
+
+  // Random destination address
+  final dest = '5GP3LivcsffRZXZhJ6EMxe4kYXYdhs3aLjgHFz3Ap2iLxcSw';
+  final multiDest = $MultiAddress().id(Address.decode(dest).pubkey);
+  print('Destination: $dest');
+
+  // Get info necessary to build an extrinsic
+  final stateApi = StateApi(westProvider);
+  final runtimeVersion = await stateApi.getRuntimeVersion();
+  final specVersion = runtimeVersion.specVersion;
+  final transactionVersion = runtimeVersion.transactionVersion;
+  final block = await westProvider.send('chain_getBlock', []);
+  final blockNumber = int.parse(block.result['block']['header']['number']);
+  print('Block Number: $blockNumber');
+  final blockHash = (await westProvider.send('chain_getBlockHash', []))
+      .result
+      .replaceAll('0x', '');
+  final genesisHash = (await westProvider.send('chain_getBlockHash', [0]))
+      .result
+      .replaceAll('0x', '');
+
+  // Encode call
+  final runtimeCall =
+      westApi.tx.balances.transferAll(dest: multiDest, keepAlive: false);
+  final encodedCall = runtimeCall.encode();
+
+  final payloadToSign = SigningPayload(
+    method: encodedCall,
+    specVersion: specVersion,
+    transactionVersion: transactionVersion,
+    genesisHash: genesisHash,
+    blockHash: blockHash,
+    blockNumber: blockNumber,
+    eraPeriod: 64,
+    nonce: 0, // Supposing it is this wallet first transaction
+    tip: 0,
+  );
+
+  // Build payload and sign with sr25519 wallet
+  final srPayload = payloadToSign.encode(westApi.registry);
+  print('Payload: ${hex.encode(srPayload)}');
+
+  final srSignature = sr25519Wallet.sign(srPayload);
+  print('Signature: ${hex.encode(srSignature)}');
+
+  // Build extrinsic with sr25519 wallet
+  final srExtrinsic = ExtrinsicPayload(
+    signer: Uint8List.fromList(sr25519Wallet.publicKey.bytes),
+    method: encodedCall,
+    signature: srSignature,
+    eraPeriod: 64,
+    blockNumber: blockNumber,
+    nonce: 0,
+    tip: 0,
+  ).encode(westApi.registry, SignatureType.sr25519);
+  print('sr25519 wallet extrinsic: ${hex.encode(srExtrinsic)}');
+
+  // Build payload and sign with ecdsa wallet
+  final ecPayload = payloadToSign.encode(westApi.registry);
+  print('Payload: ${hex.encode(ecPayload)}');
+
+  final ecSignature = ecdsaWallet.sign(ecPayload);
+  print('Signature: ${hex.encode(ecSignature)}');
+
+  // Build extrinsic with ecdsa wallet
+  final ecExtrinsic = ExtrinsicPayload(
+    signer: Uint8List.fromList(ecdsaWallet.publicKey.bytes),
+    method: encodedCall,
+    signature: ecSignature,
+    eraPeriod: 64,
+    blockNumber: blockNumber,
+    nonce: 0,
+    tip: 0,
+  ).encode(westApi.registry, SignatureType.ecdsa);
+  print('ecdsa wallet extrinsic: ${hex.encode(ecExtrinsic)}');
+
+  // Send both extrinsic
+  final author = AuthorApi(westProvider);
+  final srHash = await author.submitExtrinsic(srExtrinsic);
+  print('Sr25519 extrinsic hash: ${hex.encode(srHash)}');
+  final ecHash = await author.submitExtrinsic(ecExtrinsic);
+  print('Ecdsa extrinsic hash: ${hex.encode(ecHash)}');
+
+  // Custom RPC call
+  final astarProvider = Provider.fromUri(Uri.parse('wss://rpc.astar.network'));
+  final gasPrice = await astarProvider.send('eth_gasPrice', []);
+  print('Gas Price: ${gasPrice.result}');
+
+  // Custom Signed Extension with TypeRegistry
+  final assetProvider =
+      Provider.fromUri(Uri.parse('wss://westend-asset-hub-rpc.polkadot.io'));
+  final assetApi = Assethub(assetProvider);
+  final assetState = StateApi(assetProvider);
+
+  final assetRuntimeVersion = await assetState.getRuntimeVersion();
+  final assetSpecVersion = assetRuntimeVersion.specVersion;
+  final assetTransactionVersion = assetRuntimeVersion.transactionVersion;
+  final assetBlock = await assetProvider.send('chain_getBlock', []);
+  final assetBlockNumber =
+      int.parse(assetBlock.result['block']['header']['number']);
+  final assetBlockHash = (await assetProvider.send('chain_getBlockHash', []))
+      .result
+      .replaceAll('0x', '');
+  final assetGenesisHash = (await assetProvider.send('chain_getBlockHash', [0]))
+      .result
+      .replaceAll('0x', '');
+
+  final customDest = asset_hub.$MultiAddress().id(Address.decode(dest).pubkey);
+  final customCall =
+      assetApi.tx.balances.transferAll(dest: customDest, keepAlive: false);
+  final customEncodedCall = customCall.encode();
+
+  // Get Metadata
+  final customMetadata = await assetState.getMetadata();
+  // Get Registry
+  final scale_codec.Registry registry =
+      customMetadata.chainInfo.scaleCodec.registry;
+
+  // Get SignedExtensions mapped with codecs Map<String, Codec<dynamic>>
+  final Map<String, scale_codec.Codec<dynamic>> signedExtensions =
+      registry.getSignedExtensionTypes();
+  print('Signed Extensions Keys: ${signedExtensions.keys.toList()}');
+
+  final payloadWithExtension = SigningPayload(
+    method: customEncodedCall,
+    specVersion: assetSpecVersion,
+    transactionVersion: assetTransactionVersion,
+    genesisHash: assetGenesisHash,
+    blockHash: assetBlockHash,
+    blockNumber: assetBlockNumber,
+    eraPeriod: 64,
+    nonce: 0, // Supposing it is this wallet first transaction
+    tip: 0,
+    customSignedExtensions: <String, dynamic>{
+      'ChargeAssetTxPayment': {
+        "tip": BigInt.zero,
+        "asset_id": Option.some({
+          "parents": 1,
+          "interior": MapEntry("Here", null),
+        }),
+      }, // A custom Signed Extensions
+    },
+  );
+
+  final customExtensionPayload = payloadWithExtension.encode(registry);
+  print('Payload: ${hex.encode(customExtensionPayload)}');
+
+  final customSignature = sr25519Wallet.sign(customExtensionPayload);
+  print('Signature: ${hex.encode(customSignature)}');
+
+  final customExtrinsic = ExtrinsicPayload(
+    signer: Uint8List.fromList(sr25519Wallet.publicKey.bytes),
+    method: customEncodedCall,
+    signature: customSignature,
+    eraPeriod: 64,
+    blockNumber: assetBlockNumber,
+    nonce: 0,
+    tip: 0,
+    customSignedExtensions: <String, dynamic>{
+      'ChargeAssetTxPayment': {
+        "tip": BigInt.zero,
+        "asset_id": Option.some({
+          "parents": 1,
+          "interior": MapEntry("Here", null),
+        }),
+      }, // A custom Signed Extensions
+    },
+  ).encode(registry, SignatureType.sr25519);
+  print('custom signed extension extrinsic: ${hex.encode(customExtrinsic)}');
+
+  final authorAssetHub = AuthorApi(assetProvider);
+  authorAssetHub.submitExtrinsic(customExtrinsic);
+}
+```
+
+
+**Deliverables**
+
+|Number|Deliverable|Link|Notes|
+|:---: |  ---      | -- |---  |
+| 0a.  | License       | [Apache 2.0](https://github.com/leonardocustodio/polkadart/blob/main/packages/sr25519/LICENSE) |
+| 0c.  | Testing Guide | [Example](https://github.com/leonardocustodio/polkadart/tree/main/examples) |
+| 0d.  | Docker        | [Docker](https://github.com/leonardocustodio/polkadart/blob/main/docker-compose.yml) |
+| 4a.  | sr25519 | [sr25519](https://github.com/leonardocustodio/polkadart/tree/main/packages/sr25519) |
+| 4b.  | Ecdsa/Secp256k1  | [ecdsa](https://github.com/leonardocustodio/polkadart/tree/main/packages/secp256k1_ecdsa) |
+| 4c.  | Sign & Verify    | [Sign&Verify](https://github.com/leonardocustodio/polkadart/blob/main/packages/sr25519/example/example.dart) |
+| 4e.  | Custom RPC | [RPC](https://github.com/leonardocustodio/polkadart/blob/main/packages/polkadart/lib/provider.dart) |
+| 4f.  | Custom Signed Extensions | [SignedExtension](https://github.com/leonardocustodio/polkadart/blob/main/examples/bin/extrinsic_demo.dart) |
+| 4g.  | Multisig Account | [MultiSig](https://github.com/leonardocustodio/polkadart/blob/main/packages/polkadart/example/multisig_example.dart) |
+| 4h.  | Tests            | [Tests](https://github.com/leonardocustodio/polkadart/tree/main/packages/sr25519/test) |
+| 4i.  | Pub.dev          | [Pub](https://pub.dev/publishers/polkadart.dev/packages) |
+
+
+**Additional Information**
+
+Documentation & guides & examples are spread through each package readme, you can find the link for each one here:
+
+https://github.com/leonardocustodio/polkadart/tree/main/packages/polkadart
+https://github.com/leonardocustodio/polkadart/tree/main/packages/polkadart_cli
+https://github.com/leonardocustodio/polkadart/tree/main/packages/polkadart_keyring
+https://github.com/leonardocustodio/polkadart/tree/main/packages/polkadart_scale_codec
+https://github.com/leonardocustodio/polkadart/tree/main/packages/secp256k1_ecdsa
+https://github.com/leonardocustodio/polkadart/tree/main/packages/sr25519
+https://github.com/leonardocustodio/polkadart/tree/main/packages/ss58
+https://github.com/leonardocustodio/polkadart/tree/main/packages/substrate_bip39
+https://github.com/leonardocustodio/polkadart/tree/main/packages/substrate_metadata