Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MultiSig Implementation #417

Merged
merged 22 commits into from
Feb 20, 2024
Merged

MultiSig Implementation #417

merged 22 commits into from
Feb 20, 2024

Conversation

justkawal
Copy link
Collaborator

@justkawal justkawal commented Jan 30, 2024

User description

MultiSig

  • Implements MultiSig Address Creation
    • ExcludeMe method from sorted address
  • Implement Calls for multisig
    • ApproveAsMulti
    • AsMulti
    • CancelAsMulti
  • Test Cases
  • Closes Multisig Account #360

Type

Enhancement, Tests


Description

  • Implemented MultiSig address creation functionality in the polkadart_keyring package.
  • Added a new class MultiSig with methods for creating multisig bytes and multisig addresses.
  • Added several utility functions: bnToU8a, _bigIntToBytes, and uint8ListCompare.
  • Added a new enum KeyPairType with three types: ed25519, sr25519, and ecdsa.
  • Added a new function blake2bDigest for hashing data.
  • Added two new test cases for validating the creation of multikey and multikey address.
  • Updated README with MultiSig address creation example.
  • Added a new dependency polkadart_scale_codec: ^1.1.2.

Changes walkthrough

Relevant files
Configuration changes
2 files
polkadart_keyring.dart
Reorganization of library structure and addition of new imports   

packages/polkadart_keyring/lib/polkadart_keyring.dart

  • Added import for 'dart:convert' and
    'package:polkadart_scale_codec/polkadart_scale_codec.dart'.
  • Reorganized the structure of the library by separating source code and
    utility files.
  • Added 'src/multisig.dart' to the part directive.
  • Moved 'src/extensions.dart' and 'src/constants.dart' to the 'utils'
    directory.
+11/-2   
analysis_options.yaml
Addition of new linting rule                                                                         

packages/polkadart_keyring/analysis_options.yaml

  • Added a new rule non_constant_identifier_names: false.
+1/-0     
Enhancement
5 files
multisig.dart
Implementation of MultiSig class                                                                 

packages/polkadart_keyring/lib/src/multisig.dart

  • Added a new class MultiSig with methods for creating multisig bytes
    and multisig addresses.
+43/-0   
constants.dart
Addition of new constant                                                                                 

packages/polkadart_keyring/lib/utils/constants.dart

  • Added a constant DEV_PHRASE.
+5/-1     
extensions.dart
Addition of KeyPairType enum                                                                         

packages/polkadart_keyring/lib/utils/extensions.dart

  • Added a new enum KeyPairType with three types: ed25519, sr25519, <br> and <br> ``ecdsa.
+14/-1   
hashers.dart
Addition of new hashing function                                                                 

packages/polkadart_keyring/lib/utils/hashers.dart

  • Added a new function blake2bDigest for hashing data.
+9/-0     
utilities.dart
Addition of new utility functions                                                               

packages/polkadart_keyring/lib/utils/utilities.dart

  • Added several utility functions: bnToU8a, _bigIntToBytes, and <br> ``uint8ListCompare.
+59/-0   
Tests
1 files
multisig_test.dart
Addition of new test cases for MultiSig                                                   

packages/polkadart_keyring/test/multisig_test.dart

  • Added two new test cases for validating the creation of multikey and
    multikey address.
+60/-0   
Documentation
1 files
README.md
Updated README with MultiSig address creation example                       

packages/polkadart_keyring/README.md

  • Added a new section for creating MultiSig address.
+11/-0   
Dependencies
1 files
pubspec.yaml
Addition of new dependency                                                                             

packages/polkadart_keyring/pubspec.yaml

  • Added a new dependency polkadart_scale_codec: ^1.1.2.
+1/-0     

✨ Usage guide:

Overview:
The describe tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

When commenting, to edit configurations related to the describe tool (pr_description section), use the following template:

/describe --pr_description.some_config1=... --pr_description.some_config2=...

With a configuration file, use the following template:

[pr_description]
some_config1=...
some_config2=...
Enabling\disabling automation
  • When you first install the app, the default mode for the describe tool is:
pr_commands = ["/describe --pr_description.add_original_user_description=true" 
                         "--pr_description.keep_original_user_title=true", ...]

meaning the describe tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description.

  • Markers are an alternative way to control the generated description, to give maximal control to the user. If you set:
pr_commands = ["/describe --pr_description.use_description_markers=true", ...]

the tool will replace every marker of the form pr_agent:marker_name in the PR description with the relevant content, where marker_name is one of the following:

  • type: the PR type.
  • summary: the PR summary.
  • walkthrough: the PR walkthrough.

Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.

Custom labels

The default labels of the describe tool are quite generic: [Bug fix, Tests, Enhancement, Documentation, Other].

If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases.
Examples for custom labels:

  • Main topic:performance - pr_agent:The main topic of this PR is performance
  • New endpoint - pr_agent:A new endpoint was added in this PR
  • SQL query - pr_agent:A new SQL query was added in this PR
  • Dockerfile changes - pr_agent:The PR contains changes in the Dockerfile
  • ...

The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases.
Note that Labels are not mutually exclusive, so you can add multiple label categories.
Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.

Inline File Walkthrough 💎

For enhanced user experience, the describe tool can add file summaries directly to the "Files changed" tab in the PR page.
This will enable you to quickly understand the changes in each file, while reviewing the code changes (diffs).

To enable inline file summary, set pr_description.inline_file_summary in the configuration file, possible values are:

  • 'table': File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab.
  • true: A collapsable file comment with changes title and a changes summary for each file in the PR.
  • false (default): File changes walkthrough will be added only to the "Conversation" tab.
Utilizing extra instructions

The describe tool can be configured with extra instructions, to guide the model to a feedback tailored to the needs of your project.

Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description.

Examples for extra instructions:

[pr_description] 
extra_instructions="""
- The PR title should be in the format: '<PR type>: <title>'
- The title should be short and concise (up to 10 words)
- ...
"""

Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

More PR-Agent commands

To invoke the PR-Agent, add a comment using one of the following commands:

  • /review: Request a review of your Pull Request.
  • /describe: Update the PR title and description based on the contents of the PR.
  • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
  • /ask <QUESTION>: Ask a question about the PR.
  • /update_changelog: Update the changelog based on the PR's contents.
  • /add_docs 💎: Generate docstring for new components introduced in the PR.
  • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
  • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

See the tools guide for more details.
To list the possible configuration parameters, add a /config comment.

See the describe usage page for a comprehensive guide on using this tool.

Copy link

PR Description updated to latest commit (1757db1)

Copy link

PR Analysis

  • 🎯 Main theme: Implementation of MultiSig Address Creation
  • 📝 PR summary: This PR introduces the functionality to create MultiSig addresses in the polkadart_keyring package. It includes the implementation of new utility functions, a new class MultiSig, and new test cases. The PR also includes some reorganization of the library structure and the addition of a new dependency polkadart_scale_codec: ^1.1.2.
  • 📌 Type of PR: Enhancement
  • 🧪 Relevant tests added: Yes
  • ⏱️ Estimated effort to review [1-5]: 3, because the PR includes new functionality and several changes to the existing codebase. It also introduces a new dependency which needs to be evaluated.
  • 🔒 Security concerns: No

PR Feedback

💡 General suggestions: The PR is well-structured and includes relevant test cases. However, it would be beneficial to include more comments in the code to explain the logic and functionality of the new methods and utility functions. This would make the code easier to understand for other developers. Also, consider handling potential exceptions that might occur during the execution of the new methods.

🤖 Code feedback:
relevant filepackages/polkadart_keyring/lib/src/multisig.dart
suggestion      

Consider adding error handling for potential exceptions that might occur during the execution of the createMultiSigBytes and createMultiSigAddress methods. For example, you could add a try-catch block to handle any exceptions and provide a meaningful error message to the user. [important]

relevant linestatic Uint8List createMultiSigBytes(

relevant filepackages/polkadart_keyring/lib/utils/utilities.dart
suggestion      

The function uint8ListCompare could be optimized by breaking the loop as soon as a difference is found between the two lists. This would avoid unnecessary iterations and improve the performance of the function. [medium]

relevant lineint uint8ListCompare(Uint8List a, Uint8List b) {


✨ Usage guide:

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...
Utilizing extra instructions

The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project.

Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.

Examples for extra instructions:

[pr_reviewer] # /review #
extra_instructions="""
In the 'general suggestions' section, emphasize the following:
- Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand?
- Is the code logic efficient?
...
"""

Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

How to enable\disable automation
  • When you first install PR-Agent app, the default mode for the review tool is:
pr_commands = ["/review", ...]

meaning the review tool will run automatically on every PR, with the default configuration.
Edit this field to enable/disable the tool, or to change the used configurations

Auto-labels

The review tool can auto-generate two specific types of labels for a PR:

  • a possible security issue label, that detects possible security issues (enable_review_labels_security flag)
  • a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)
Extra sub-tools

The review tool provides a collection of possible feedbacks about a PR.
It is recommended to review the possible options, and choose the ones relevant for your use case.
Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example:
require_score_review, require_soc2_ticket, and more.

More PR-Agent commands

To invoke the PR-Agent, add a comment using one of the following commands:

  • /review: Request a review of your Pull Request.
  • /describe: Update the PR title and description based on the contents of the PR.
  • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
  • /ask <QUESTION>: Ask a question about the PR.
  • /update_changelog: Update the changelog based on the PR's contents.
  • /add_docs 💎: Generate docstring for new components introduced in the PR.
  • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
  • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

See the tools guide for more details.
To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

Copy link

PR Code Suggestions

Suggestions                                                                                                                                                         
best practice
Replace generic Exception with a more specific ArgumentError.

In the createMultiSigBytes method, you are directly throwing an Exception when no
signatories are provided. It would be better to throw a more specific exception, like
ArgumentError, to make it clear what the problem is.

packages/polkadart_keyring/lib/src/multisig.dart [8-10]

 if (signatories.isEmpty) {
-  throw Exception('No signatories provided.');
+  throw ArgumentError('No signatories provided.');
 }
 
Make value a required parameter in bnToU8a function and throw an ArgumentError if null is passed.

The bnToU8a function currently accepts null as a valid input for value, and handles <br> it <br> by <br> returning <br> an <br> empty <br> ``Uint8List. <br> It <br> would <br> be <br> better <br> to <br> make <br> ``value
a required parameter and throw an ArgumentError if null is passed.

packages/polkadart_keyring/lib/utils/utilities.dart [4-8]

-Uint8List bnToU8a(int? value,
+Uint8List bnToU8a(int value,
   {int bitLength = -1, bool isLittleEndian = true, bool isNegative = false}) {
   if (value == null) {
-    return bitLength == -1 ? Uint8List(1) : Uint8List((bitLength + 7) >> 3);
+    throw ArgumentError('value cannot be null');
   }
 
Avoid modifying input lists in-place by creating and sorting a copy instead. 

The createMultiSigBytes method currently sorts the signatories list in-place. This
modifies the input list, which can lead to unexpected side effects. Consider creating a
copy of the list and sorting that instead.

packages/polkadart_keyring/lib/src/multisig.dart [13]

-signatories.sort(uint8ListCompare);
+final sortedSignatories = List<Uint8List>.from(signatories)..sort(uint8ListCompare);
 
enhancement
Simplify the uint8ListCompare function by using Iterable.zip and a for-each loop.

The uint8ListCompare function currently uses a while loop to iterate over the elements
of the lists. This could be simplified by using the Iterable.zip method to create pairs
of corresponding elements, and then using a for-each loop to iterate over these pairs.

packages/polkadart_keyring/lib/utils/utilities.dart [39-58]

-int i = 0;
-while (true) {
-  final overA = i >= a.length;
-  final overB = i >= b.length;
-  if (overA && overB) {
-    // both ends reached
-    return 0;
-  } else if (overA) {
-    // a has no more data, b has data
-    return -1;
-  } else if (overB) {
-    // b has no more data, a has data
-    return 1;
-  } else if (a[i] != b[i]) {
-    // the number in this index doesn't match
-    // (we don't use u8aa[i] - u8ab[i] since that doesn't match with localeCompare)
-    return a[i] > b[i] ? 1 : -1;
+for (final pair in a.zip(b)) {
+  if (pair.first != pair.second) {
+    return pair.first > pair.second ? 1 : -1;
   }
-  i++;
 }
+if (a.length != b.length) {
+  return a.length > b.length ? 1 : -1;
+}
+return 0;
 

✨ Usage guide:

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...
Enabling\disabling automation

When you first install the app, the default mode for the improve tool is:

pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...]

meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.

Utilizing extra instructions

Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project.

Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on.

Examples for extra instructions:

[pr_code_suggestions] # /improve #
extra_instructions="""
Emphasize the following aspects:
- Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand?
- Is the code logic efficient?
...
"""

Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

A note on code suggestions quality
  • While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically.
  • Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base.
  • Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool
  • With large PRs, best quality will be obtained by using 'improve --extended' mode.
More PR-Agent commands

To invoke the PR-Agent, add a comment using one of the following commands:

  • /review: Request a review of your Pull Request.
  • /describe: Update the PR title and description based on the contents of the PR.
  • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
  • /ask <QUESTION>: Ask a question about the PR.
  • /update_changelog: Update the changelog based on the PR's contents.
  • /add_docs 💎: Generate docstring for new components introduced in the PR.
  • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
  • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

See the tools guide for more details.
To list the possible configuration parameters, add a /config comment.

See the improve usage page for a more comprehensive guide on using this tool.

Copy link

codecov bot commented Jan 30, 2024

Codecov Report

Attention: 121 lines in your changes are missing coverage. Please review.

Comparison is base (b59e22a) 48.84% compared to head (daee509) 48.66%.
Report is 2 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #417      +/-   ##
==========================================
- Coverage   48.84%   48.66%   -0.18%     
==========================================
  Files         177      181       +4     
  Lines        9445     9527      +82     
==========================================
+ Hits         4613     4636      +23     
- Misses       4832     4891      +59     
Flag Coverage Δ
polkadart 16.41% <0.00%> (-0.42%) ⬇️
polkadart_cli 12.04% <ø> (ø)
polkadart_keyring 65.12% <0.00%> (-6.65%) ⬇️
polkadart_scale_codec 55.02% <88.88%> (+0.09%) ⬆️
secp256k1_ecdsa 90.00% <ø> (ø)
sr25519 85.91% <ø> (ø)
ss58 96.87% <ø> (ø)
substrate_bip39 56.37% <ø> (ø)
substrate_metadata 87.74% <100.00%> (+0.12%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
packages/polkadart_keyring/lib/src/sr25519.dart 55.88% <ø> (+0.80%) ⬆️
...ges/polkadart_scale_codec/lib/primitives/enum.dart 70.96% <100.00%> (+2.54%) ⬆️
...ges/substrate_metadata/lib/parsers/v14_parser.dart 99.29% <100.00%> (+0.05%) ⬆️
...es/substrate_metadata/lib/types/era_extrinsic.dart 97.61% <100.00%> (+3.17%) ⬆️
...kages/substrate_metadata/lib/types/extrinsics.dart 94.28% <100.00%> (+0.16%) ⬆️
packages/polkadart/lib/provider.dart 1.92% <0.00%> (ø)
packages/polkadart/lib/substrate/era.dart 2.56% <0.00%> (ø)
...art/lib/extrinsic/signed_extensions/asset_hub.dart 0.00% <0.00%> (ø)
...art/lib/extrinsic/signed_extensions/substrate.dart 0.00% <0.00%> (ø)
...kages/polkadart_scale_codec/lib/core/registry.dart 67.10% <0.00%> (-0.44%) ⬇️
... and 7 more

justkawal and others added 2 commits January 30, 2024 17:23
Remove duplicate entry
Copy link
Owner

@leonardocustodio leonardocustodio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, it is important to note that the scope of this ticket isn't only multisig account creation. We also need to be able to send the call, decode the call, make the deposit, cancel the call.

You can find more information in the following links:
https://wiki.polkadot.network/docs/learn-guides-accounts-multisig
https://support.polkadot.network/support/solutions/articles/65000181826-how-to-create-and-use-a-multisig-account

Comment on lines 20 to 23
'5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY',
'5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty',
'5FLSigC9HGRKVhB9FiEo4Y3koPsNmBmLJbpXg2mp1hXcS59Y'
], 2);
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be nice to put here in the docs that 2 is the threshold and what it means, here you can find a reference text: https://wiki.polkadot.network/docs/learn-account-multisig

@justkawal
Copy link
Collaborator Author

Looking into it.

@justkawal
Copy link
Collaborator Author

Also, it is important to note that the scope of this ticket isn't only multisig account creation. We also need to be able to send the call, decode the call, make the deposit, cancel the call.

You can find more information in the following links: https://wiki.polkadot.network/docs/learn-guides-accounts-multisig https://support.polkadot.network/support/solutions/articles/65000181826-how-to-create-and-use-a-multisig-account

I researched the internet, but wasn't able to find a code sample or example to mimic/implement the multisig (initiate, approveAsMulti, asMulti, and cancel).

Whenever you find time, let me know. @leonardocustodio

@leonardocustodio
Copy link
Owner

You can find the methods here: https://github.com/paritytech/txwrapper-core/tree/main/packages/txwrapper-substrate/src/methods/multisig

@justkawal justkawal marked this pull request as draft February 13, 2024 14:01
@justkawal justkawal marked this pull request as ready for review February 19, 2024 00:17
@justkawal
Copy link
Collaborator Author

@leonardocustodio I guess the PR looks good now....

@leonardocustodio
Copy link
Owner

Is this also for #359 or only multisig?

@justkawal
Copy link
Collaborator Author

Is this also for #359 or only multisig?

Umm.... Yes,
I have added functionality to get and parse every signedExtensions from the chain metadata even the custom as well and provide access to that from TypeRegistry....

Copy link
Owner

@leonardocustodio leonardocustodio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@leonardocustodio leonardocustodio merged commit 017cb28 into main Feb 20, 2024
12 checks passed
@leonardocustodio leonardocustodio deleted the justkawal/multisig branch February 20, 2024 02:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Multisig Account
2 participants