Feat/foundry verification docs by gboigwe · Pull Request #363 · rsksmart/devportal

gboigwe · 2025-07-11T17:12:14Z

Add Comprehensive Foundry Smart Contract Verification Documentation

Title

Add comprehensive Foundry smart contract verification and advanced development guides for Rootstock

Description

Purpose: Resolves GitHub Issue Add Documentation for Verifying Smart Contracts Using Foundry Script on Rootstock #308 by providing complete documentation for smart contract verification using Foundry scripts on Rootstock Explorer and Blockscout.
Issue Resolved: GitHub Issue Add Documentation for Verifying Smart Contracts Using Foundry Script on Rootstock #308 - "Verify Smart Contract Using Foundry Script" - addresses the gap in scripted verification documentation for Rootstock developers.
Specific Changes Made:
- NEW: docs/02-developers/05-smart-contracts/05-foundry/verify-smart-contracts.md - Comprehensive verification guide with CLI commands, automated scripts, constructor argument handling, error troubleshooting, and CI/CD integration
- NEW: docs/02-developers/05-smart-contracts/05-foundry/advanced-smart-contracts.md - Advanced smart contract development patterns including upgradeable contracts, factory patterns, multi-contract systems, and comprehensive testing strategies
- Enhanced: Integration with existing Foundry documentation structure with proper cross-referencing
- Added: 12+ complete smart contract examples with production-ready deployment and verification scripts
- Included: Comprehensive testing suites, error handling, and best practices for Rootstock development
Key Features:
- Step-by-step verification for both Rootstock Testnet and Mainnet
- Automated verification scripts with environment variable handling
- Advanced constructor argument encoding for complex types (arrays, structs, multiple parameters)
- Production-ready deployment workflows with integrated verification
- Comprehensive error troubleshooting and status monitoring
- CI/CD integration examples for automated verification pipelines

Screenshots/GIFs

N/A - Documentation changes only

Testing

Documentation Structure: Verified proper markdown formatting and internal link structure
Code Examples: All Solidity contracts compile successfully with Foundry
Cross-References: Validated all internal links point to existing documentation
Content Accuracy: Verified all API endpoints, chain IDs, and command syntax for Rootstock networks
Example Scripts: Tested deployment and verification script patterns with sample contracts
Build Testing: Documentation builds successfully without broken links or formatting issues

Checklist

I have read and understood the contributing guidelines.
I have followed the style guide and formatting guidelines.
I have added appropriate comments to explain the changes.
I have tested my changes thoroughly.

Refs

Related Issue: GitHub Issue Add Documentation for Verifying Smart Contracts Using Foundry Script on Rootstock #308 - "Verify Smart Contract Using Foundry Script"
Documentation Structure: Follows existing Rootstock Developer Portal patterns in /docs/02-developers/05-smart-contracts/05-foundry/
Cross-Referenced Guides:
External Resources:

vercel · 2025-07-11T17:12:37Z

@gboigwe is attempting to deploy a commit to the IOV Labs Team on Vercel.

A member of the Team first needs to authorize it.

ezequiel-rodriguez

Great work @gboigwe!
The new Foundry verification guide is clear, well-structured, and fully aligned with the requirements:

proper forge verify-contract usage for Testnet/Mainnet
automated script (Verify.s.sol)
env/RPC setup
troubleshooting
CI/CD examples

Overall, excellent addition, thanks!

vercel · 2025-07-22T11:22:25Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
devportal-rootstock	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 22, 2025 11:26am

owans · 2025-07-22T11:36:08Z

docs/02-developers/05-smart-contracts/05-foundry/advanced-development-patterns.md

@@ -0,0 +1,951 @@
+# Advanced Smart Contract Development and Deployment with Foundry on Rootstock
+
+---


@gboigwe Metadata is not formatted properly: https://devportal-rootstock-git-fork-gboigwe-feat-f-74737b-iov-labs-mkt.vercel.app/developers/smart-contracts/foundry/advanced-development-patterns/

Kindly refer to existing pages for the right metadata values, and remove location in the metadata

owans · 2025-07-22T11:38:10Z

docs/02-developers/05-smart-contracts/05-foundry/advanced-development-patterns.md

+
+### 2. Multi-Contract System with Factory Pattern
+
+Complex DApps often require multiple interacting contracts. This pattern demonstrates a factory-vault system:


Suggested change

Complex DApps often require multiple interacting contracts. This pattern demonstrates a factory-vault system:

Complex dApps often require multiple interacting contracts. This pattern demonstrates a factory-vault system:

owans · 2025-07-22T11:39:07Z

docs/02-developers/05-smart-contracts/05-foundry/advanced-development-patterns.md

+
+## Testing Advanced Contracts
+
+### Comprehensive Test Suite


Add summary

owans · 2025-07-22T11:42:51Z

docs/02-developers/05-smart-contracts/05-foundry/advanced-development-patterns.md

+
+## Integration with Verification System
+
+This advanced smart contract system integrates seamlessly with the verification workflow documented in [Verify Smart Contracts Using Foundry Script](/developers/smart-contracts/foundry/verify-smart-contracts/). Key integration points include:


Suggested change

This advanced smart contract system integrates seamlessly with the verification workflow documented in [Verify Smart Contracts Using Foundry Script](/developers/smart-contracts/foundry/verify-smart-contracts/). Key integration points include:

This advanced smart contract system integrates seamlessly with the verification workflow documented in [Verify Smart Contracts Using Foundry Script](/developers/smart-contracts/foundry/verify-smart-contracts/).

Key integration points include:

owans · 2025-07-22T11:44:23Z

docs/02-developers/05-smart-contracts/05-foundry/advanced-development-patterns.md

+
+### 1. Automated Verification Integration
+
+The deployment scripts generate verification commands automatically, as demonstrated in the `_generateVerificationCommands()` function. This ensures that complex multi-contract systems are properly verified.


Hyper link to Comprehensive Deployment Script with Verification section

owans · 2025-07-22T11:51:28Z

docs/02-developers/05-smart-contracts/05-foundry/verify-smart-contracts.md

+- **Constructor Arguments**: Documentation of all constructor parameters used during deployment
+- **Environment Setup**: Properly configured `.env` file with necessary API keys and RPC URLs
+
+> **Important**: This guide assumes familiarity with Foundry basics. For foundational knowledge, review the [Foundry Project Creation](/developers/smart-contracts/foundry/create-foundry-project/) and [Smart Contract Development](/developers/smart-contracts/foundry/smart-contracts/) guides.


Use the admonition components for TIP or Info: https://dev.rootstock.io/components/#admonitions

owans · 2025-07-22T11:52:32Z

docs/02-developers/05-smart-contracts/05-foundry/advanced-development-patterns.md

+- **Testing Knowledge**: Experience with [Testing Smart Contracts](/developers/smart-contracts/foundry/test-smart-contracts/)
+- **Deployment Experience**: Successful completion of [Deploy Smart Contracts](/developers/smart-contracts/foundry/deploy-smart-contracts/)
+
+> **Note**: This guide assumes intermediate to advanced Solidity knowledge. For basic Solidity concepts, refer to the [Solidity Documentation](https://docs.soliditylang.org/).


Use the admonition component for Note or Info: https://dev.rootstock.io/components/#admonitions

Hi @gboigwe Any update on this?

gboigwe added 3 commits July 11, 2025 17:57

feat: add verify smart contract using foundry script

73a5c3f

feat: add verify smart contract on foundry with blockscout

7e9d998

feat: updated with comprehensive Foundry verification docs

8829635

ezequiel-rodriguez reviewed Jul 21, 2025

View reviewed changes

vercel bot deployed to Preview July 22, 2025 11:26 View deployment

owans reviewed Jul 22, 2025

View reviewed changes

owans assigned gboigwe Jul 23, 2025

owans added the hacktivator Use this label for submissions to the Rootstock hacktivator. label Jul 23, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat/foundry verification docs#363

Feat/foundry verification docs#363
gboigwe wants to merge 3 commits intorsksmart:mainfrom
gboigwe:feat/foundry-verification-docs

gboigwe commented Jul 11, 2025

Uh oh!

vercel bot commented Jul 11, 2025

Uh oh!

ezequiel-rodriguez left a comment

Uh oh!

vercel bot commented Jul 22, 2025 •

edited

Loading

Uh oh!

owans Jul 22, 2025

Uh oh!

owans Jul 22, 2025

Uh oh!

owans Jul 22, 2025

Uh oh!

owans Jul 22, 2025

Uh oh!

owans Jul 22, 2025

Uh oh!

owans Jul 22, 2025

Uh oh!

owans Jul 22, 2025

Uh oh!

owans Aug 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		@@ -0,0 +1,951 @@
		# Advanced Smart Contract Development and Deployment with Foundry on Rootstock

		---


		### 2. Multi-Contract System with Factory Pattern

		Complex DApps often require multiple interacting contracts. This pattern demonstrates a factory-vault system:


		## Integration with Verification System

		This advanced smart contract system integrates seamlessly with the verification workflow documented in [Verify Smart Contracts Using Foundry Script](/developers/smart-contracts/foundry/verify-smart-contracts/). Key integration points include:


		### 1. Automated Verification Integration

		The deployment scripts generate verification commands automatically, as demonstrated in the `_generateVerificationCommands()` function. This ensures that complex multi-contract systems are properly verified.

Conversation

gboigwe commented Jul 11, 2025

Add Comprehensive Foundry Smart Contract Verification Documentation

Title

Description

Screenshots/GIFs

Testing

Checklist

Refs

Uh oh!

vercel bot commented Jul 11, 2025

Uh oh!

ezequiel-rodriguez left a comment

Choose a reason for hiding this comment

Uh oh!

vercel bot commented Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

vercel bot commented Jul 22, 2025 •

edited

Loading