open-ibc / vibc-core-smart-contracts

Apache License 2.0
30 stars 24 forks source link

add npx script for creating multisig and saving to accounts spec #168

Closed RnkSngh closed 3 months ago

RnkSngh commented 3 months ago

PR to add a npx vibc-core-deploy-multisig command which: 1.) deploys a new multisig using Gnosis safe's sdk to a given rpc url, accounts spec, owners list, and account name (which references a private key from accounts spec) 2.)appends the account spec to presist multisig accounts between multisig calls & contract deploys so that they can be used in subsequent txs, e.g. a created multisig account looks like this:

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The recent updates significantly enhance the project's multi-signature wallet functionalities, introducing new scripts for deployment and transaction management. Key features include the deployment of multi-signature wallets, transaction proposals, and execution capabilities, along with improved handling of YAML files. These changes collectively streamline development and integration with the Safe Global ecosystem, ensuring robust management of smart contracts on Ethereum.

Changes

File Change Summary
package.json Added a script for deploying multisig contracts and included dependencies related to the Safe Global ecosystem, along with a development dependency for improved YAML type safety.
src/deploy.ts, src/tx.ts Updated nonce handling logic in the updateNoncesForSender function and redefined the sendTx function to distinguish between single account and multisig wallet transactions.
src/multisig/safe.ts Introduced functionalities for creating and managing multi-signature wallets, including initialization, transaction proposals, execution, and nonce retrieval.
src/utils/io.ts Added functions for writing YAML files, parsing command-line arguments for multisig initialization, and updating account specifications with new safe addresses, along with minor formatting adjustments for readability.
tsup.config.ts Updated the build configuration to include deploy-multisig.ts and execute-multisig-tx.ts scripts, ensuring they are part of the build process.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DeployScript
    participant MultiSigWallet
    participant SafeAPI

    User->>DeployScript: Provide parameters (RPC URL, owners, etc.)
    DeployScript->>MultiSigWallet: Initialize new multi-signature wallet
    MultiSigWallet->>DeployScript: Return new wallet address
    DeployScript->>SafeAPI: Save wallet address to specifications
    SafeAPI-->>DeployScript: Confirm save
    DeployScript-->>User: Deployment complete

🐇 In the meadow where code does play,
New wallets bloom, bright as the day.
With functions to dance and scripts that sway,
In Safe Global’s realm, we hop and stay.
YAML flows like a gentle stream,
In this world of code, we live the dream! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.