Closed RnkSngh closed 3 months ago
The recent changes to the documentation of the vibc-core-smart-contracts
package provide a clearer and more structured guide for users. Enhancements include a comprehensive package overview, detailed command descriptions, and a focus on multisig account deployment, alongside improved handling of sensitive information. These updates aim to facilitate better understanding and usability for developers working with smart contracts.
Files | Change Summary |
---|---|
README.md |
Improved documentation structure with an overview, enhanced command descriptions, argument hierarchy, and details on accounts and contract updates. Emphasized fork testing for reliability. |
(Commands) | Renamed npx deploy-vibc-core-smart-contracts and npx setup-vibc-core-dispatcher to npx update-vibc-core-smart-contracts . Kept npx vibc-core-deploy-multisig and npx vibc-core-execute-multisig-tx unchanged. |
sequenceDiagram
participant User
participant CLI
participant SmartContract
participant MultisigAccount
User->>CLI: Deploy Contract
CLI->>SmartContract: Initiate Deployment
SmartContract->>CLI: Return Deployment Status
CLI->>User: Notify Deployment Success
User->>CLI: Execute Multisig Transaction
CLI->>MultisigAccount: Authorize Transaction
MultisigAccount->>SmartContract: Execute Transaction
SmartContract->>MultisigAccount: Return Execution Status
MultisigAccount->>CLI: Confirm Transaction Executed
CLI->>User: Notify Transaction Success
π In the garden of code, we hop and play,
With contracts and commands, brightening the day.
Changes abound, like flowers in bloom,
Our tools now more clear, dispelling the gloom.
Letβs deploy with delight, and toast to our fun,
With multisig magic, our work has begun! πΌβ¨
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?
Pr to update docs for the npm package
Summary by CodeRabbit
vibc-core-smart-contracts
package, including improved command descriptions and an argument hierarchy.