evm-deployment

Overview

End-to-end deployment workflow for Sablier EVM contracts. Supports Comptroller, Flow, Lockup, and Airdrops with protocol-specific adaptations.

Prerequisites

Version Check

Before proceeding, verify Foundry version:

forge -V

Stop if version is below 1.3.6.

Protocol Detection

Detect the current EVM protocol from package.json:

Extract version from package.json → "version": "x.y.z" → SDK version is v<x.y>

Workflow

Execute steps in order, tracking state between each:

Step 1: Deploy Contracts

Reference: ./references/deploy.md | Examples: ./references/examples.md

Deploy protocol contracts using Foundry. Handles:

• RPC configuration
• Deterministic (CREATE2) vs non-deterministic (CREATE) deployment
• Contract verification on block explorer

Step 2: Update SDK (optional)

Reference: ./references/copy-to-sdk.md

Copy broadcast artifacts to SDK repository:

• Broadcast JSON file
• Update README.md with deployment info
• Update deployments.ts with contract addresses

Step 3: Create Test Data (optional)

Reference: ./references/deploy-streams.md

For Flow and Lockup protocols only. Creates sample streams for testing:

• Mint or verify ERC20 token balance
• Run Init.s.sol script to create test streams

State Tracking

Track and carry forward between steps:

Protocol-Specific Scripts

Output Summary

After completion, provide:

• Protocol deployed
• Chain and deployment type
• Contract addresses (factories + campaigns if applicable)
• Verification status
• SDK files updated (if applicable)
• Test data created (if applicable)

Airdrops Campaign Contracts

When deploying Airdrops test data, campaigns are created via factory:

Campaign addresses are returned in broadcast returns field, not contractAddress.