-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathenv.example
More file actions
117 lines (106 loc) · 4.56 KB
/
Copy pathenv.example
File metadata and controls
117 lines (106 loc) · 4.56 KB
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# Bloxchain Protocol
# Copy this file to .env and update for your target environment.
# Recommended for remote Nethermind testing: NETWORK_NAME=remote_evm + TEST_MODE=manual.
# Test Mode Configuration
# MANUAL MODE: Uses explicit contract addresses + private keys from env (recommended for remote_evm).
# AUTO MODE: Legacy mode that discovers addresses from Truffle artifacts.
TEST_MODE=manual
# Network Configuration
GUARDIAN_NETWORK=remote_evm
NETWORK_NAME=remote_evm
# RPC Network Configuration
# Option A (recommended): set RPC_URL directly.
RPC_URL=http://127.0.0.1:8545
# Option B: use REMOTE_* parts (ignored when RPC_URL is set).
REMOTE_HOST=your-remote-evm-host.com
REMOTE_PORT=8545
REMOTE_PROTOCOL=http
REMOTE_NETWORK_ID=1337
REMOTE_GAS=8000000
REMOTE_GAS_PRICE=20000000000
REMOTE_FROM=
# Contract Addresses (optional for TEST_MODE=manual when NETWORK_NAME matches deployed-addresses.json)
# Sanity tests (scripts/sanity and scripts/sanity-sdk) resolve AccountBlox from env or deployed-addresses.json.
# Regenerate a remote_evm profile after deploy: npm run generate:sanity-env -- --out .env
ACCOUNTBLOX_ADDRESS=
SIMPLE_VAULT_ADDRESS=
SIMPLE_RWA20_ADDRESS=
COPYBLOX_ADDRESS=
# Alternative RPC Configuration (if using custom network)
# CUSTOM_RPC_URL=https://your-custom-rpc-url:8545
# CUSTOM_NETWORK_ID=1337
# CUSTOM_NETWORK_NAME=custom_network
# Testing Wallet Private Keys (for MANUAL mode)
# These are test wallets - DO NOT use in production
# Replace with your own test wallet private keys
# These wallets can be assigned different roles during testing for flexibility
# NOTE: In remote_evm manual mode these should match funded deterministic accounts.
TEST_WALLET_1_PRIVATE_KEY=
TEST_WALLET_2_PRIVATE_KEY=
TEST_WALLET_3_PRIVATE_KEY=
TEST_WALLET_4_PRIVATE_KEY=
TEST_WALLET_5_PRIVATE_KEY=
# Deployment Configuration Flags
# Guardian contract: AccountBlox only. Set DEPLOY_ACCOUNTBLOX=false to skip.
DEPLOY_ACCOUNTBLOX=true
# Example Contract Deployment Flags
# Set to 'true' to deploy; default: false
DEPLOY_SIMPLE_VAULT=false
DEPLOY_SIMPLE_RWA20=false
DEPLOY_COPYBLOX=false
# Definition Library Addresses (per network)
# Populated by npm run generate:sanity-env -- --out .env after deploy (internal sanity)
SECURE_OWNABLE_DEFINITIONS_ADDRESS=
RUNTIME_RBAC_DEFINITIONS_ADDRESS=
GUARD_CONTROLLER_DEFINITIONS_ADDRESS=
# Alias to GuardControllerDefinitions when a single schema-refresh address is needed
DEFINITION_CONTRACT_ADDRESS=
# =============================================================================
# DEPLOYMENT CONFIGURATION GUIDE
# =============================================================================
#
# GUARDIAN CONTRACT:
# DEPLOY_ACCOUNTBLOX=true/false - Deploy AccountBlox (default: true). Set false to skip.
#
# EXAMPLE CONTRACT FLAGS:
# DEPLOY_SIMPLE_VAULT=true/false - Deploy SimpleVault example contract
# DEPLOY_SIMPLE_RWA20=true/false - Deploy SimpleRWA20 example contract
# DEPLOY_COPYBLOX=true/false - Deploy CopyBlox (clone blox via EIP-1167, event forwarding)
#
# DEPLOYMENT SCENARIOS:
# 🏗️ Guardian only: DEPLOY_ACCOUNTBLOX=true, example flags=false (default)
# 🏦 Examples: Set example flags=true (for example contract testing)
#
# EXAMPLE CONTRACTS:
# 🏦 SimpleVault: Example vault contract with Bloxchain integration
# 🏦 SimpleRWA20: Example RWA token contract with Bloxchain integration
# 📋 CopyBlox: Clone any IBaseStateMachine blox, centralize events from clones
#
# =============================================================================
# TEST MODE USAGE GUIDE
# =============================================================================
#
# AUTO MODE (TEST_MODE=auto):
# ⚠️ Legacy mode for Truffle artifact discovery
# ❌ Not recommended for remote_evm sanity alignment
#
# MANUAL MODE (TEST_MODE=manual):
# ✅ Best for: remote_evm, custom networks, deterministic wallet alignment
# ✅ Full control over contract addresses and private keys
# ✅ Works with any Ethereum network (local or remote)
# ✅ Requires: Manual setup of all contract addresses and private keys
# ✅ Can be generated by helper scripts (see sanity roadmap doc)
#
# QUICK START (remote_evm):
# 1. Set TEST_MODE=manual, NETWORK_NAME=remote_evm, RPC_URL
# 2. Fill ACCOUNTBLOX_ADDRESS and TEST_WALLET_1..5_PRIVATE_KEY
# 3. Run tests: npm run test:sanity-sdk:core
#
# DEPLOYMENT EXAMPLES:
# Deploy guardian only (default):
# truffle migrate
#
# Deploy with examples:
# DEPLOY_SIMPLE_VAULT=true DEPLOY_SIMPLE_RWA20=true DEPLOY_COPYBLOX=true truffle migrate
#
# =============================================================================