Merge pull request #1144 from dsm-w3f/polkadart_4_eval

Polkadart M4 evaluation
w3f · Mar 6, 2024 · ed8e619 · ed8e619
2 parents 33e8071 + 4a845c0
commit ed8e619
Showing 1 changed file with 257 additions and 0 deletions.
diff --git a/evaluations/polkadart_4_dsm-w3f.md b/evaluations/polkadart_4_dsm-w3f.md
@@ -0,0 +1,257 @@
+# Evaluation
+
+- **Status:** Accepted
+- **Application Document:** https://github.com/w3f/Grants-Program/blob/master/applications/Polkadart.md
+- **Milestone:** 4
+- **Kusama Identity:** Address
+- **Previously successfully merged evaluation:** N/A
+
+| Number | Deliverable | Accepted | Link | Evaluation Notes |
+| ------ | ----------- | -------- | ---- |----------------- |
+| 0a.  | License       | <ul><li>[x] </li></ul>| [Apache 2.0](https://github.com/leonardocustodio/polkadart/blob/main/packages/sr25519/LICENSE) | |
+| 0b.  | Documentation | <ul><li>[x] </li></ul>| | |
+| 0c.  | Testing Guide | <ul><li>[x] </li></ul>| [Example](https://github.com/leonardocustodio/polkadart/tree/main/examples) |  |
+| 0d.  | Docker        | <ul><li>[x] </li></ul>| [Docker](https://github.com/leonardocustodio/polkadart/blob/main/docker-compose.yml) |  |
+| 4a.  | sr25519 | <ul><li>[x] </li></ul>| [sr25519](https://github.com/leonardocustodio/polkadart/tree/main/packages/sr25519) |  |
+| 4b.  | Ecdsa/Secp256k1  | <ul><li>[x] </li></ul>| [ecdsa](https://github.com/leonardocustodio/polkadart/tree/main/packages/secp256k1_ecdsa) | | 
+| 4c.  | Sign & Verify    | <ul><li>[x] </li></ul>| [Sign&Verify](https://github.com/leonardocustodio/polkadart/blob/main/packages/sr25519/example/example.dart) |  |
+| 4e.  | Custom RPC | <ul><li>[x] </li></ul>| [RPC](https://github.com/leonardocustodio/polkadart/blob/main/packages/polkadart/lib/provider.dart) | |
+| 4f.  | Custom Signed Extensions | <ul><li>[x] </li></ul>| [SignedExtension](https://github.com/leonardocustodio/polkadart/blob/main/examples/bin/extrinsic_demo.dart) |  |
+| 4g.  | Multisig Account | <ul><li>[x] </li></ul>| [MultiSig](https://github.com/leonardocustodio/polkadart/blob/main/packages/polkadart/example/multisig_example.dart) |  |
+| 4h.  | Tests            | <ul><li>[x] </li></ul>| [Tests](https://github.com/leonardocustodio/polkadart/tree/main/packages/sr25519/test) |  |
+| 4i.  | Pub.dev          | <ul><li>[x] </li></ul>| [Pub](https://pub.dev/publishers/polkadart.dev/packages) | |
+
+## Evaluation V4
+
+### Tests
+
+I ran the tests successfully this time without memory problems running with Docker and without Docker. I noticed the tests using Docker are running during the image build. I think it could continue to run when running the container because it is easier to see the logs. I made some changes in the Dockerfile to do this, and I didn't have memory problems.
+
+```
+FROM dart:stable
+
+RUN apt-get update
+RUN apt-get clean
+RUN apt-get install -y curl git wget unzip libglu1-mesa
+
+RUN dart pub global activate melos
+
+COPY . .
+
+ENV PATH="$PATH":"/root/.pub-cache/bin"
+
+RUN melos fetch_dependencies
+CMD ["melos", "test"]
+```
+
+The tests used close to 50% to 60% of the memory with other processes and released some memory after some time. It is working now.
+
+![image (57)](https://github.com/dsm-w3f/Grant-Milestone-Delivery/assets/112647953/a5d09a45-808c-4b7d-84dc-71b0baf52caa)
+
+
+## Evaluation V3
+
+### Multisig Account
+
+I ran the [example](https://github.com/leonardocustodio/polkadart/blob/main/packages/polkadart/example/multisig_example.dart) using the command `dart pub get` and after that, I ran the `multisig_example.dart` as instructed in this [comment](https://github.com/w3f/Grant-Milestone-Delivery/pull/1138#issuecomment-1977146180). Before, I was doing like instructed in [testing guide](https://github.com/leonardocustodio/polkadart/blob/main/examples/README.md) and I needed to add the package `polkadart_cli` and the `polkadart` section. It would be nice to have the  instructions to run the multisig example in the package.
+
+## Evaluation V2
+
+### sr25519
+
+The explanation about Rewrite Schnorrkel in Dart to give support sr25519 is in this [comment](https://github.com/w3f/Grant-Milestone-Delivery/pull/1138#issuecomment-1974140579).
+
+### Custom Signed Extensions
+
+I was able to run the example.
+
+```
+user@localhost:~/Documents/polkadart/examples$ dart run bin/extrinsic_demo.dart
+Sr25519 Wallet: 5Cabw1zd5pK8CbuPFHQYX7Ac9BVSumfw5BkiNQajstFdYDJq
+Ecdsa Wallet: 5Hft7aSusEA1vFX43VZFbKmxiiujRnP7RUk87B66VVzqbpyY
+Block Number: 19816766
+Destination: 5Hft7aSusEA1vFX43VZFbKmxiiujRnP7RUk87B66VVzqbpyY
+Payload: 040400f80148e326bf3826758422b95c9806105ba5f82dbb210abafb1b2e8e249e620e00e503000080610f0018000000e143f23803ac50e8f6f8e62695d1ce9e4e1d68aa36c1cd2cfd15340213f3423e40962801858809fa1a6944bea50f2fd746695087250cc380d489b5dfd62903ac
+Signature: 9ab730aaf31339d1d938e5a6b15ff7e3f5c5fd7f81a497ce0ff1b567a712df172c8481ea537b65770a665ed5e21fdad53473a2ccfd5e6572300e7c7f7077fb86
+sr25519 wallet extrinsic: 2d02840016cd6ab0878d5078dd14fe714e87ea77e77583cec4cbb9d95f2f06db2a86df5f019ab730aaf31339d1d938e5a6b15ff7e3f5c5fd7f81a497ce0ff1b567a712df172c8481ea537b65770a665ed5e21fdad53473a2ccfd5e6572300e7c7f7077fb86e5030000040400f80148e326bf3826758422b95c9806105ba5f82dbb210abafb1b2e8e249e620e00
+Sr25519 extrinsic hash: 055a2bbd56aa3ec36735784ae455e242f14e26ffce668674bd6b32d9651a76a4
+Destination: 5Cabw1zd5pK8CbuPFHQYX7Ac9BVSumfw5BkiNQajstFdYDJq
+Payload: 04040016cd6ab0878d5078dd14fe714e87ea77e77583cec4cbb9d95f2f06db2a86df5f00e503000080610f0018000000e143f23803ac50e8f6f8e62695d1ce9e4e1d68aa36c1cd2cfd15340213f3423e40962801858809fa1a6944bea50f2fd746695087250cc380d489b5dfd62903ac
+Signature: 985c8be23b1a695af546ecea8513fe7e3b82d70a7e39873eaf71b77d3d7f53fa2d25b4e17a65e4065bb1dd286b6777564640d131960ac93958ef7afe8e3f82ec00
+Ecdsa wallet extrinsic: 31028400f80148e326bf3826758422b95c9806105ba5f82dbb210abafb1b2e8e249e620e02985c8be23b1a695af546ecea8513fe7e3b82d70a7e39873eaf71b77d3d7f53fa2d25b4e17a65e4065bb1dd286b6777564640d131960ac93958ef7afe8e3f82ec00e503000004040016cd6ab0878d5078dd14fe714e87ea77e77583cec4cbb9d95f2f06db2a86df5f00
+Ecdsa extrinsic hash: a3c1c8191cc261f8c9421f5f2272a24bb3d6593e0e46d89474673c4367b3ab20
+Gas Price: 0xb576270823
+Custom Destination: Instance of 'Id'
+Custom Encoded Call: 0a0400f80148e326bf3826758422b95c9806105ba5f82dbb210abafb1b2e8e249e620e00
+Signed Extensions Keys: [CheckNonZeroSender, CheckSpecVersion, CheckTxVersion, CheckGenesis, CheckMortality, CheckNonce, CheckWeight, ChargeAssetTxPayment]
+sr25519 assethub address: 5Cabw1zd5pK8CbuPFHQYX7Ac9BVSumfw5BkiNQajstFdYDJq
+Nonce: 0
+Encoded Payload: 0a0400f80148e326bf3826758422b95c9806105ba5f82dbb210abafb1b2e8e249e620e00f50000000080610f000e00000067f9723393ef76214df0118c34bbbd3dbebc8ed46a10973a8c969d48fe7598c9ea9a9a282c52d8849085b245e52feddae4ad4dd96735e06cebdee2516ab5a222
+Signature: 706c6bbf6b0d2cfc7544d61d3cce32d97445b54e6423f05fb0a1ef9939593d7d71e050e7230531dafeebd0597af6ca0dfcfdfa8e11d6f83bc8410761dd0e0482
+custom signed extension extrinsic: 3102840016cd6ab0878d5078dd14fe714e87ea77e77583cec4cbb9d95f2f06db2a86df5f01706c6bbf6b0d2cfc7544d61d3cce32d97445b54e6423f05fb0a1ef9939593d7d71e050e7230531dafeebd0597af6ca0dfcfdfa8e11d6f83bc8410761dd0e0482f5000000000a0400f80148e326bf3826758422b95c9806105ba5f82dbb210abafb1b2e8e249e620e00
+Custom Signed Extension Extrinsic Hash: cea297b379c34a7911940bfa104c2a4e880713b2ab591da4b1359d0576fa914b
+```
+
+### Multisig Account
+
+I ran the example. However, I needed to add the package `polkadart_cli` and the `polkadart` section. Could you add this to the `pubspec.yaml`?
+
+```
+user@localhost:~/Documents/polkadart/packages/polkadart$ dart run example/multisig_example.dart 
+Calling ApproveAsMulti by TeslaS2
+Calling AsMulti by TeslaS3
+```
+
+### Test
+
+I'm using a machine with the SO Debian. As shown in the image on Evaluation V1, the container used all memory and swap of the computer. I can't give higher resources to the container. I tried to use the flag `--oom-kill-disable` but my kernel doesn't support this. Could you give more information about your machine resources (RAM, CPU), your SO, and maybe a print showing the memory usage in your machine during the tests in the substrate_metadata?
+
+## Evaluation V1
+
+### sr25519 and Sign & Verify 
+
+The [application](https://github.com/w3f/Grants-Program/blob/master/applications/Polkadart.md#milestone-4-) especify a research to decide the best way to support sr25519. Could you provide the explanation and the conclusion of this research? 
+
+The example provided to sr25519 and Sign & Verify worked.
+
+```dart
+void main() {
+ final msg = utf8.encode('hello friends');
+ final signingCtx = utf8.encode('example');
+ final merlin.Transcript signingTranscript =
+     Sr25519.newSigningContext(signingCtx, msg);
+ final merlin.Transcript verifyTranscript =
+     Sr25519.newSigningContext(signingCtx, msg);
+ final keypair = Sr25519.generateKeyPair();
+ final (priv, pub) = (keypair.secretKey, keypair.publicKey);
+ final Signature sig = priv.sign(signingTranscript);
+ final (ok, _) = pub.verify(sig, verifyTranscript);
+ assert(ok == true);
+ print(ok);
+}
+```
+
+```
+user@localhost:~/Documents/test/demo$ dart run bin/demo.dart
+true
+```
+
+### Custom Signed Extensions
+
+I tried to run the example, but I received an error related to balance.
+
+```
+user@localhost:~/Documents/polkadart/examples$ dart run bin/extrinsic_demo.dart
+Sr25519 Wallet: 5Cabw1zd5pK8CbuPFHQYX7Ac9BVSumfw5BkiNQajstFdYDJq
+Ecdsa Wallet: 5Hft7aSusEA1vFX43VZFbKmxiiujRnP7RUk87B66VVzqbpyY
+Destination: 5GP3LivcsffRZXZhJ6EMxe4kYXYdhs3aLjgHFz3Ap2iLxcSw
+Block Number: 19775146
+Payload: 040400beecf0681cf7e50992bdd7016c956c2b667fcd69d6143b0daec416501758623700a502000080610f0018000000e143f23803ac50e8f6f8e62695d1ce9e4e1d68aa36c1cd2cfd15340213f3423efc8ab83daa13ca693d71f69a02c229102986891fd16969f1e86a2e4dccef9e80
+Signature: e8a5ed2ff482106a8bf83ad2451605f897816d7da163bf2dda3ca9f84014502526d3a11a377d63c69e1306a761d62bacaa2b28c47c7340b6e1511042999b6680
+sr25519 wallet extrinsic: 2d02840016cd6ab0878d5078dd14fe714e87ea77e77583cec4cbb9d95f2f06db2a86df5f01e8a5ed2ff482106a8bf83ad2451605f897816d7da163bf2dda3ca9f84014502526d3a11a377d63c69e1306a761d62bacaa2b28c47c7340b6e1511042999b6680a5020000040400beecf0681cf7e50992bdd7016c956c2b667fcd69d6143b0daec416501758623700
+Payload: 040400beecf0681cf7e50992bdd7016c956c2b667fcd69d6143b0daec416501758623700a502000080610f0018000000e143f23803ac50e8f6f8e62695d1ce9e4e1d68aa36c1cd2cfd15340213f3423efc8ab83daa13ca693d71f69a02c229102986891fd16969f1e86a2e4dccef9e80
+Signature: 20537461a72984f03a574024ac3ce78fdeca101e3375bff5c9987c62b41526bb6507eaf0c639b5b1bbd2f51bf297e1c462729ae540630aca9344c66e364085e200
+ecdsa wallet extrinsic: 31028400f80148e326bf3826758422b95c9806105ba5f82dbb210abafb1b2e8e249e620e0220537461a72984f03a574024ac3ce78fdeca101e3375bff5c9987c62b41526bb6507eaf0c639b5b1bbd2f51bf297e1c462729ae540630aca9344c66e364085e200a5020000040400beecf0681cf7e50992bdd7016c956c2b667fcd69d6143b0daec416501758623700
+Unhandled exception:
+Exception: {code: 1010, message: Invalid Transaction, data: Inability to pay some fees (e.g. account balance too low)}
+#0  	AuthorApi.submitExtrinsic (package:polkadart/apis/author.dart:17:7)
+<asynchronous suspension>
+#1  	main (file:///home/user/Documents/polkadart/examples/bin/extrinsic_demo.dart:115:18)
+<asynchronous suspension>
+```
+
+With balance, I received two different errors:
+
+```
+ecdsa wallet extrinsic: 31028400f80148e326bf3826758422b95c9806105ba5f82dbb210abafb1b2e8e249e620e02fa51cc85e9e75bd606ca8f3356a6689eafcea1151b69a9eafbf2b0200be650dc43b335c16dc4e58c6c5041cc58413d9c277d0828fc18c1e2beda1243bc85bd7800b5030000040400beecf0681cf7e50992bdd7016c956c2b667fcd69d6143b0daec416501758623700
+Unhandled exception:
+Exception: {code: 1010, message: Invalid Transaction, data: Transaction is outdated}
+#0  	AuthorApi.submitExtrinsic (package:polkadart/apis/author.dart:17:7)
+<asynchronous suspension>
+#1  	main (file:///home/user/Documents/polkadart/examples/bin/extrinsic_demo.dart:115:18)
+<asynchronous suspension>
+```
+
+```
+ecdsa wallet extrinsic: 31028400f80148e326bf3826758422b95c9806105ba5f82dbb210abafb1b2e8e249e620e02c383f561a6f66f423623d1e764fe76cc4d9d14b23d4d81cd2a997ce6a59937403da7ee39a750ca80433cd11304a31d745574a78739ce705a1f924ed724a5b8240015000000040400beecf0681cf7e50992bdd7016c956c2b667fcd69d6143b0daec416501758623700
+Unhandled exception:
+Exception: {code: 1010, message: Invalid Transaction, data: Transaction has a bad signature}
+#0  	AuthorApi.submitExtrinsic (package:polkadart/apis/author.dart:17:7)
+<asynchronous suspension>
+#1  	main (file:///home/user/Documents/polkadart/examples/bin/extrinsic_demo.dart:115:18)
+<asynchronous suspension>
+```
+
+### Multisig Account
+
+In this example, I needed to add the package `polkadart_cli`.
+
+```
+user@localhost:~/Documents/polkadart/packages/polkadart$ dart run polkadart_cli:generate -v
+Could not find package `polkadart_cli` or file `polkadart_cli:generate`
+```
+
+After that, I needed to add the `polkadart` section.
+
+```
+user@localhost:~/Documents/polkadart/packages/polkadart$ dart run polkadart_cli:generate -v
+Building package executable... (11.2s)
+Built polkadart_cli:generate.
+Unhandled exception:
+ConfigException: Failed to extract config from the 'pubspec.yaml' file.
+Can't find 'polkadart' section.
+#0  	new PubspecConfig.fromYAML (package:polkadart_cli/src/config/pubspec_config.dart:45:7)
+#1  	new PubspecConfig.fromPubspecFile (package:polkadart_cli/src/config/pubspec_config.dart:30:26)
+#2  	main (file:///home/user/.pub-cache/hosted/pub.dev/polkadart_cli-0.4.2/bin/generate.dart:52:32)
+#3  	_delayEntrypointInvocation.<anonymous closure> (dart:isolate-patch/isolate_patch.dart:295:33)
+#4  	_RawReceivePort._handleMessage (dart:isolate-patch/isolate_patch.dart:184:12) 
+```
+
+After that, I received an error related to balance. 
+
+```
+user@localhost:~/Documents/polkadart/packages/polkadart$ dart run example/multisig_example.dart
+Unhandled exception:
+Exception: {code: 1010, message: Invalid Transaction, data: Inability to pay some fees (e.g. account balance too low)}
+#0  	AuthorApi.submitExtrinsic (package:polkadart/apis/author.dart:17:7)
+<asynchronous suspension>
+#1  	Multisig.submitExtrinsic (package:polkadart/multisig/multisig.dart:421:12)
+<asynchronous suspension>
+#2  	Multisig._createAndSubmitPayload (package:polkadart/multisig/multisig.dart:128:24)
+<asynchronous suspension>
+#3  	Multisig.createAndFundMultisig (package:polkadart/multisig/multisig.dart:26:7)
+<asynchronous suspension>
+#4  	main (file:///home/user/Documents/polkadart/packages/polkadart/example/multisig_example.dart:26:28)
+<asynchronous suspension>
+```
+
+I couldn't find the seed or the address to give some balance. Could you help me with that?
+
+### Tests
+
+I tried to run the tests using Docker. All tests passed until the tests in the package substrate_metadata killed the program.
+
+```
+polkadart-tests-1  | substrate_metadata:
+polkadart-tests-1  | Killed
+polkadart-tests-1  |
+polkadart-tests-1  |
+02:06 +13583: test/chains/kusama/spec_version_test.dart: Spec Versions Test init spec version file                                                                                                 	--------------------------------------------------------------------------------
+polkadart-tests-1  |
+polkadart-tests-1  | $ melos exec
+polkadart-tests-1  |   └> dart test --coverage="coverage"
+polkadart-tests-1  |  	└> FAILED (in 1 packages)
+polkadart-tests-1  |     	└> substrate_metadata (with exit code 137)
+polkadart-tests-1  |
+polkadart-tests-1  | melos run test
+polkadart-tests-1  |   └> dart run melos exec --scope="${SCOPE:-*}" -c 1 --fail-fast -- 'dart test --coverage="coverage"'
+polkadart-tests-1  |  	└> FAILED
+polkadart-tests-1  | ScriptException: The script test failed to execute.
+polkadart-tests-1 exited with code 1
+```
+
+I ran again, monitoring the resources. When the substrate_metadata tests started, memory usage increased until use all the memory. I stopped the test because it had frozen my computer before. It seems to be a memory leak problem or do I need more memory to run these tests?
+
+![Captura de tela de 2024-03-01 08-59-04](https://github.com/dsm-w3f/Grant-Milestone-Delivery/assets/112647953/4313a5cf-65c2-483e-be8a-2fc3692b15bd)
+
+![Captura de tela de 2024-03-01 09-00-05](https://github.com/dsm-w3f/Grant-Milestone-Delivery/assets/112647953/0928dce3-9bb6-4e48-96b1-bc8efbe56a36)