-
Notifications
You must be signed in to change notification settings - Fork 0
feat: update deploying a contract section #127
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
feat: update deploying a contract section #127
Conversation
ENG-2146 Update deploying a contract section
|
Reviewer's Guide by SourceryThis PR updates the documentation for deploying a contract to clarify the process and provide updated screenshots. It clarifies how to deploy smart contracts using the Task Manager and the terminal, adds instructions for compiling contracts using Hardhat and Foundry, and includes steps for deploying to a local network and a network created in the platform. Sequence diagram for deploying to platform networksequenceDiagram
actor Developer
participant TM as Task Manager
participant Platform as SettleMint Platform
participant Network as Blockchain Network
Developer->>TM: Run 'SettleMint - Login' task
TM->>Platform: Authenticate
Platform-->>TM: Return authentication token
Developer->>TM: Run 'Deploy to platform network' task
TM->>Platform: Request available nodes
Platform-->>TM: Return node list
Developer->>TM: Select node
TM->>Platform: Request private keys
Platform-->>TM: Return private key list
Developer->>TM: Select private key
TM->>Network: Deploy contract
Network-->>TM: Return deployment status
TM-->>Developer: Show deployment confirmation
Sequence diagram for deploying to local networksequenceDiagram
actor Developer
participant TM as Task Manager
participant Local as Local Network
Developer->>TM: Run 'Start local network' task
TM->>Local: Start Hardhat network
Local-->>TM: Network started
Developer->>TM: Run 'Deploy to local network' task
TM->>Local: Deploy contract
Local-->>TM: Return deployment status
TM-->>Developer: Show deployment confirmation
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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.
Hey @snigdha920 - I've reviewed your changes - here's some feedback:
Overall Comments:
- The documentation shows how to compile with Foundry but doesn't include instructions for deploying with Foundry. Consider either adding Foundry deployment instructions or removing the Foundry compilation section if Foundry deployment isn't supported.
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Review instructions: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
docs/using-platform/15_dev-tools/0_code-studio/1_smart-contract-sets/4_deploying-a-contract.md
Show resolved
Hide resolved
* main: feat: update deploying a contract section (#127)
Branches off #127, moves https://github.com/settlemint/docs/pull/123/files#diff-cd9af8f677658ff9c6841ebfb7674e32be902ea86f0f2e200cddddf9ea053881L36-L52 to it's own page ## Summary by Sourcery New Features: - Integrate an OpenAI GPT plugin into the Smart Contract Set IDE to provide automated code suggestions, smart contract templates, and code completion capabilities, along with interactive debugging and explanation features. --------- Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Summary by Sourcery
Documentation: