Skip to content

Conversation

@MiguelLZPF
Copy link
Contributor

Summary

Updated the contracts deployment scripts DEVELOPER_GUIDE documentation to reflect the current Signer-based architecture and infrastructure organization.

Changes

New Sections Added

  • Architecture Overview: Explains the modular infrastructure/domain/workflows separation
  • Quick Start - Using the CLI: Documents Hardhat and Standalone deployment modes
  • Complete Deployment Workflows: Added examples for deploySystemWithNewBlr and deploySystemWithExistingBlr
  • Advanced Topics: Error handling patterns, custom registry generation, infrastructure extensibility

Updates to Existing Sections

  • Registry System: Added multi-registry support for custom facets alongside ATS facets
  • Signer-Based API: Clarified ethers.Signer usage with TypeChain type safety
  • Function Parameters: Updated createFundConfiguration documentation with new parameters (DEFAULT_BATCH_SIZE, confirmations)

Documentation Improvements

  • Registry documented as internal lookup mechanism (not passed as function parameter)
  • Clarified Signer-based API (no legacy Provider pattern)
  • Added import path conventions (@scripts/infrastructure, @scripts/domain, @contract-types)
  • TypeChain contract instances usage explained with full examples

Test Plan

  • Reviewed diff - 443 insertions, 10 deletions all documentation-focused
  • Verified commit message follows conventional commits format
  • Ensured documentation is accurate for current architecture
  • Checked for consistency with existing code patterns and examples

Related Documentation

  • Existing README.md is up-to-date and consistent with this guide
  • Architecture patterns documented in project CLAUDE.md

@MiguelLZPF MiguelLZPF requested review from a team as code owners November 19, 2025 14:24
@hedera-eng-infrastructure
Copy link

hedera-eng-infrastructure commented Nov 19, 2025

Snyk checks have passed. No issues have been found so far.

Status Scanner Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@MiguelLZPF MiguelLZPF force-pushed the docs/update-scripts-developer-guide branch 2 times, most recently from ac1fde1 to 928cfa1 Compare November 19, 2025 14:26
@MiguelLZPF MiguelLZPF self-assigned this Nov 19, 2025
Added comprehensive documentation updates to reflect the current state of the
deployment scripts architecture:

- Architecture Overview: Explains modular separation of
  infrastructure/domain/workflows
- Signer-Based API: Clarifies ethers.Signer usage and TypeChain
  integration
- Quick Start CLI: Added Hardhat and Standalone deployment modes with
  network options
- Complete Deployment Workflows: Added workflow examples for
  deploySystemWithNewBlr and deploySystemWithExistingBlr
- Resumable Deployments: Documented checkpoint-based deployment
  resumption
- Registry System: Updated with multi-registry support for custom
  facets
- Advanced Topics: Added error handling patterns, custom registry
  generation, and infrastructure extensibility
- Parameter Updates: Reflected createFundConfiguration parameter
  changes (DEFAULT_BATCH_SIZE, confirmations)

The documentation now accurately reflects:
- Registry as internal lookup mechanism (not passed as parameter)
- Signer-based API (no legacy Provider pattern)
- Full TypeChain type safety throughout
- Current facet batch deployment capabilities

Signed-off-by: Miguel_LZPF <[email protected]>
@MiguelLZPF MiguelLZPF force-pushed the docs/update-scripts-developer-guide branch from 928cfa1 to 8061a32 Compare November 19, 2025 14:38
@MiguelLZPF MiguelLZPF merged commit 3c0f0f5 into develop Nov 19, 2025
11 checks passed
@MiguelLZPF MiguelLZPF deleted the docs/update-scripts-developer-guide branch November 19, 2025 15:28
MiguelLZPF added a commit that referenced this pull request Nov 24, 2025
MiguelLZPF added a commit that referenced this pull request Nov 24, 2025
themariofrancia pushed a commit that referenced this pull request Dec 9, 2025
themariofrancia pushed a commit that referenced this pull request Dec 10, 2025
themariofrancia pushed a commit that referenced this pull request Dec 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants