-
-
Notifications
You must be signed in to change notification settings - Fork 15
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
Conversation
PR Description updated to latest commit (1757db1) |
PR Analysis
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:
✨ Usage guide:Overview:
With a configuration file, use the following template:
See the review usage page for a comprehensive guide on using this tool. |
PR Code Suggestions
✨ Usage guide:Overview:
With a configuration file, use the following template:
See the improve usage page for a more comprehensive guide on using this tool. |
Codecov ReportAttention:
Additional details and impacted files@@ 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
Flags with carried forward coverage won't be shown. Click here to find out more.
|
Remove duplicate entry
There was a problem hiding this 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
packages/polkadart_keyring/README.md
Outdated
'5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY', | ||
'5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty', | ||
'5FLSigC9HGRKVhB9FiEo4Y3koPsNmBmLJbpXg2mp1hXcS59Y' | ||
], 2); |
There was a problem hiding this comment.
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
Looking into it. |
I researched the internet, but wasn't able to find a code sample or example to mimic/implement the multisig ( Whenever you find time, let me know. @leonardocustodio |
You can find the methods here: https://github.com/paritytech/txwrapper-core/tree/main/packages/txwrapper-substrate/src/methods/multisig |
@leonardocustodio I guess the PR looks good now.... |
Is this also for #359 or only multisig? |
Umm.... Yes, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
User description
MultiSig
ApproveAsMulti
AsMulti
CancelAsMulti
Type
Enhancement, Tests
Description
polkadart_keyring
package.MultiSig
with methods for creating multisig bytes and multisig addresses.bnToU8a
,_bigIntToBytes
, anduint8ListCompare
.KeyPairType
with three types:ed25519
,sr25519
, andecdsa
.blake2bDigest
for hashing data.polkadart_scale_codec: ^1.1.2
.Changes walkthrough
2 files
polkadart_keyring.dart
Reorganization of library structure and addition of new imports
packages/polkadart_keyring/lib/polkadart_keyring.dart
'package:polkadart_scale_codec/polkadart_scale_codec.dart'.
utility files.
directory.
analysis_options.yaml
Addition of new linting rule
packages/polkadart_keyring/analysis_options.yaml
non_constant_identifier_names: false
.5 files
multisig.dart
Implementation of MultiSig class
packages/polkadart_keyring/lib/src/multisig.dart
MultiSig
with methods for creating multisig bytesand multisig addresses.
constants.dart
Addition of new constant
packages/polkadart_keyring/lib/utils/constants.dart
DEV_PHRASE
.extensions.dart
Addition of KeyPairType enum
packages/polkadart_keyring/lib/utils/extensions.dart
KeyPairType
with three types:ed25519
,sr25519
,<br>
and<br> ``ecdsa
.hashers.dart
Addition of new hashing function
packages/polkadart_keyring/lib/utils/hashers.dart
blake2bDigest
for hashing data.utilities.dart
Addition of new utility functions
packages/polkadart_keyring/lib/utils/utilities.dart
bnToU8a
,_bigIntToBytes
, and<br> ``uint8ListCompare
.1 files
multisig_test.dart
Addition of new test cases for MultiSig
packages/polkadart_keyring/test/multisig_test.dart
multikey address.
1 files
README.md
Updated README with MultiSig address creation example
packages/polkadart_keyring/README.md
1 files
pubspec.yaml
Addition of new dependency
packages/polkadart_keyring/pubspec.yaml
polkadart_scale_codec: ^1.1.2
.✨ 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:With a configuration file, use the following template:
Enabling\disabling automation
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.the tool will replace every marker of the form
pr_agent:marker_name
in the PR description with the relevant content, wheremarker_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 performanceNew endpoint
- pr_agent:A new endpoint was added in this PRSQL query
- pr_agent:A new SQL query was added in this PRDockerfile changes
- pr_agent:The PR contains changes in the DockerfileThe 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:
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
More PR-Agent commands
See the describe usage page for a comprehensive guide on using this tool.