Protocol-Contracts/.env.example at main · Deed3Labs/Protocol-Contracts · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# =============================================================================
# HARDHAT CONFIGURATION - EXAMPLE FILE
# =============================================================================
# Copy this file to .env and replace the placeholder values with your actual values
# This file is safe to commit to version control

# =============================================================================
# REQUIRED VARIABLES
# =============================================================================

# Deployer Private Key (REQUIRED)
# Get this from your wallet (MetaMask, etc.) - this is the private key of the
# account that will deploy contracts and perform transactions
# Format: 0x followed by 64 hexadecimal characters
DEPLOYER_PRIVATE_KEY=0x0000000000000000000000000000000000000000000000000000000000000000

# Deployer Account Address (REQUIRED)
# The Ethereum address corresponding to the private key above
# Format: 0x followed by 40 hexadecimal characters
DEPLOYER_ACCOUNT=0x0000000000000000000000000000000000000000

# =============================================================================
# API KEYS (OPTIONAL - defaults provided in hardhat.config.ts)
# =============================================================================

# Alchemy API Key (for Ethereum, Polygon, Arbitrum, Optimism)
# Get your free API key at: https://dashboard.alchemyapi.io
# Default: oKxs-03sij-U_N0iOlrSsZFr29-IqbuF (shared key)
ALCHEMY_API_KEY=your_alchemy_api_key_here

# Etherscan API Key (for contract verification on Ethereum/Sepolia)
# Get your free API key at: https://etherscan.io/apis
# Default: DNXJA8RX2Q3VZ4URQIWP7Z68CJXQZSC6AW (shared key)
ETHERSCAN_API_KEY=your_etherscan_api_key_here

# Polygonscan API Key (for contract verification on Polygon)
# Get your free API key at: https://polygonscan.com/apis
# Default: DNXJA8RX2Q3VZ4URQIWP7Z68CJXQZSC6AW (shared key)
POLYGONSCAN_API_KEY=your_polygonscan_api_key_here

# Arbiscan API Key (for contract verification on Arbitrum)
# Get your free API key at: https://arbiscan.io/apis
# Default: DNXJA8RX2Q3VZ4URQIWP7Z68CJXQZSC6AW (shared key)
ARBISCAN_API_KEY=your_arbiscan_api_key_here

# =============================================================================
# GAS REPORTING (OPTIONAL)
# =============================================================================

# Enable gas reporting (set to 'true' to enable)
# When enabled, generates gas-report.txt with gas usage statistics
REPORT_GAS=false

# CoinMarketCap API Key (for gas cost reporting in USD)
# Get your free API key at: https://coinmarketcap.com/api/
# Uncomment and set your key to get USD gas cost estimates
# COINMARKETCAP_API_KEY=your_coinmarketcap_api_key_here

# Send Funds deployment vars
# Treasury address used by deploy/11_deploy_ClaimEscrow.ts
SEND_PAYOUT_TREASURY=0x52e6102B7C22eeC7A68B11Dd71faC7D6D9AEcf50

# =============================================================================
# CLRUSD + ESA VAULT (OPTIONAL)
# =============================================================================

# Admin for CLRUSD and ESA vault roles
CLRUSD_ADMIN=0x0000000000000000000000000000000000000000

# Supply config is denominated in human CLRUSD units (6 decimals)
# Use "0" for unlimited max supply and zero premint.
CLRUSD_MAX_SUPPLY=0
CLRUSD_PREMINT=0

# CREATE2 deployment config
CLRUSD_USE_CREATE2=true
CLRUSD_CREATE2_SALT=CLRUSD_V1
# Optional existing CREATE2 deployer/factory address. If omitted, deploy script can deploy Create2Deployer.
CLRUSD_CREATE2_FACTORY_ADDRESS=

# Optional explicit addresses (otherwise deployment artifacts are used)
CLRUSD_ADDRESS=
ESA_VAULT_ADDRESS=
ESA_VAULT_DEPOSIT_TOKEN=

# Token registry integration
TOKEN_REGISTRY_ADDRESS=
CLRUSD_REMOTE_CHAIN_ID=
CLRUSD_REMOTE_ADDRESS=

# CCIP integration inputs
CCIP_ROUTER=
CCIP_RMN_PROXY=
CCIP_TOKEN_ADMIN_REGISTRY=
CCIP_REGISTRY_MODULE_OWNER_CUSTOM=
CLRUSD_TOKEN_POOL_ADDRESS=
CCIP_REMOTE_CHAIN_SELECTOR=
CCIP_REMOTE_TOKEN_ADDRESS=
CCIP_REMOTE_POOL_ADDRESS=