Closed justkawal closed 9 months ago
PR Description updated to latest commit (https://github.com/leonardocustodio/polkadart/commit/1757db1f8306cc9e0311192bd85bf11ee9311aeb)
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
.๐ก 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.
relevant file | packages/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 line | static Uint8List createMultiSigBytes( |
relevant file | packages/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 line | int uint8ListCompare(Uint8List a, Uint8List b) { |
Utilizing extra instructionsThe `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](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) 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-labelsThe `review` tool can auto-generate two specific types of labels for a PR: - a `possible security issue` label, that detects possible [security issues](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) (`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-toolsThe `review` tool provides a collection of possible feedbacks about a PR. It is recommended to review the [possible options](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md#enabledisable-features), 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 \ |
Suggestions | ||||
---|---|---|---|---|
best practice |
| |||
enhancement |
|
Enabling\disabling automationWhen you first install the app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) 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 instructionsExtra 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 :gem:](https://github.com/Codium-ai/pr-agent/blob/main/docs/CUSTOM_SUGGESTIONS.md) 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 \ |
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.
Looking into it.
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
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?
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
....
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 - 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.
analysis_options.yaml
Addition of new linting rule
packages/polkadart_keyring/analysis_options.yaml - Added a new rule `non_constant_identifier_names: false`.
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.
constants.dart
Addition of new constant
packages/polkadart_keyring/lib/utils/constants.dart - Added a constant `DEV_PHRASE`.
extensions.dart
Addition of KeyPairType enum
packages/polkadart_keyring/lib/utils/extensions.dart - Added a new enum `KeyPairType` with three types: `ed25519`, `sr25519`, `
`and `
``ecdsa`.
hashers.dart
Addition of new hashing function
packages/polkadart_keyring/lib/utils/hashers.dart - Added a new function `blake2bDigest` for hashing data.
utilities.dart
Addition of new utility functions
packages/polkadart_keyring/lib/utils/utilities.dart - Added several utility functions: `bnToU8a`, `_bigIntToBytes`, and `
``uint8ListCompare`.
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.
1 files
README.md
Updated README with MultiSig address creation example
packages/polkadart_keyring/README.md - Added a new section for creating MultiSig address.
1 files
pubspec.yaml
Addition of new dependency
packages/polkadart_keyring/pubspec.yaml - Added a new dependency `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](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) every time a new PR is opened, or can be invoked manually by commenting on a PR. When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L46) 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](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-app), use the following template: ``` [pr_description] some_config1=... some_config2=... ```
Enabling\disabling automation
- When you first install the app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) 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](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#handle-custom-labels-from-the-repos-labels-page-gem) 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: '
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 \