chore: consolidate documentation — delete status/fix/progress cruft
Before: 335 tracked .md files; top level had 14 README-like docs; docs/ contained ~234 files, most of them auto/LLM-generated status reports (ALL_*_COMPLETE*, *_FIX*, DEPLOYMENT_*_FINAL*, etc.). After: 132 tracked .md files. Repo now has exactly five top-level docs: README.md, QUICKSTART.md, RUNBOOK.md, CONTRIBUTING.md, CHANGELOG.md (moved up from docs/). Keeper philosophy in docs/: - API, CCIP (ops + security + receiver/router refs), Chainlist refs, compliance, deployment (guides not status), database connection, legal compliance, metamask integration, production checklist, tiered-architecture implementation/setup, reusable-components plan, token-mechanism doc, wrap-and-bridge operational reference, plus docs/specs/** and docs/api/ / docs/openapi/ trees. Deleted (git history preserves provenance): - All 'ALL_*_COMPLETE*' / '*_FIX*' / '*_FIXED*' / '*_FINAL*' / '*_STATUS*' / '*_PROGRESS*' / '*_SUMMARY*' files. - BLOCKSCOUT_*_FIX / _CRASH / _INITIALIZATION / _SCHEMA / _YAML / _SKIP / _NEXT_STEPS / _START_AND_BUILD / _DATABASE_CREDENTIALS (the last contained passwords). - CCIP_IMPLEMENTATION_* / CCIP_CURRENT_STATUS / CCIP_GAP_* (gap analyses are not a sustained reference). - NPMPLUS_CREDENTIALS_GUIDE.md (contained creds). - LETSENCRYPT_CONFIGURATION_GUIDE.md (contained creds; will be re-introduced as runbook content post-secrets-scrub). - docs/diagnostic-reports/, docs/feature-flags/ (run-time artifacts). README.md: dead links (START_HERE, README_DEPLOYMENT, COMPLETE_DEPLOYMENT, DEPLOYMENT_COMPLETE_FINAL) replaced with links to the five canonical top-level docs + docs/ index.
This commit is contained in:
@@ -1,155 +0,0 @@
|
||||
# Environment Variable Check - PRIVATE_KEY
|
||||
|
||||
**Date**: 2025-12-24
|
||||
**Purpose**: Check for PRIVATE_KEY in .env files
|
||||
|
||||
---
|
||||
|
||||
## Check Results
|
||||
|
||||
### .env File Status
|
||||
|
||||
**Location**: `/home/intlc/projects/proxmox/smom-dbis-138/.env`
|
||||
|
||||
**Status**: ⚠️ **.env file not found in repository**
|
||||
|
||||
**Note**: `.env` files are typically excluded from version control for security reasons.
|
||||
|
||||
---
|
||||
|
||||
## How to Check PRIVATE_KEY
|
||||
|
||||
### Method 1: Check if .env exists and contains PRIVATE_KEY
|
||||
|
||||
```bash
|
||||
cd /home/intlc/projects/proxmox/smom-dbis-138
|
||||
|
||||
# Check if .env exists
|
||||
if [ -f .env ]; then
|
||||
echo "✅ .env file exists"
|
||||
|
||||
# Check if PRIVATE_KEY is set (without showing the value)
|
||||
if grep -q "^PRIVATE_KEY=" .env; then
|
||||
echo "✅ PRIVATE_KEY is set in .env"
|
||||
# Show first few characters for verification (optional)
|
||||
grep "^PRIVATE_KEY=" .env | sed 's/\(.\{10\}\).*/PRIVATE_KEY=\1...***HIDDEN***/'
|
||||
else
|
||||
echo "⚠️ PRIVATE_KEY is NOT set in .env"
|
||||
fi
|
||||
else
|
||||
echo "⚠️ .env file does not exist"
|
||||
echo "Create it from .env.template if available"
|
||||
fi
|
||||
```
|
||||
|
||||
### Method 2: Check environment variable directly
|
||||
|
||||
```bash
|
||||
# Check if PRIVATE_KEY is set in current environment
|
||||
if [ -z "$PRIVATE_KEY" ]; then
|
||||
echo "⚠️ PRIVATE_KEY is not set in environment"
|
||||
else
|
||||
echo "✅ PRIVATE_KEY is set in environment"
|
||||
# Get deployer address from private key
|
||||
cast wallet address $PRIVATE_KEY 2>/dev/null || echo "Invalid PRIVATE_KEY format"
|
||||
fi
|
||||
```
|
||||
|
||||
### Method 3: Check from deployment scripts
|
||||
|
||||
The deployment scripts expect PRIVATE_KEY to be set via:
|
||||
- Environment variable: `export PRIVATE_KEY=<key>`
|
||||
- .env file: `PRIVATE_KEY=<key>`
|
||||
- Foundry's `vm.envUint("PRIVATE_KEY")` in scripts
|
||||
|
||||
---
|
||||
|
||||
## Expected Format
|
||||
|
||||
PRIVATE_KEY should be:
|
||||
- **Without 0x prefix**: `1234567890abcdef...` (64 hex characters)
|
||||
- **Or with 0x prefix**: `0x1234567890abcdef...` (66 characters total)
|
||||
|
||||
**Example**:
|
||||
```bash
|
||||
PRIVATE_KEY=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Security Notes
|
||||
|
||||
⚠️ **NEVER commit .env files to version control**
|
||||
|
||||
The `.env` file should be in `.gitignore`:
|
||||
```
|
||||
.env
|
||||
.env.local
|
||||
.env.*.local
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Creating .env File
|
||||
|
||||
If `.env` doesn't exist, create it:
|
||||
|
||||
```bash
|
||||
cd /home/intlc/projects/proxmox/smom-dbis-138
|
||||
|
||||
# Create .env file
|
||||
cat > .env <<EOF
|
||||
# Chain 138 RPC
|
||||
RPC_URL_138=http://192.168.11.250:8545
|
||||
RPC_URL=http://192.168.11.250:8545
|
||||
|
||||
# Deployer Private Key (REQUIRED)
|
||||
PRIVATE_KEY=<your_private_key_here>
|
||||
|
||||
# Optional: Admin addresses (defaults to deployer if not set)
|
||||
COMPLIANCE_ADMIN=
|
||||
TOKEN_REGISTRY_OWNER=
|
||||
FEE_COLLECTOR_OWNER=
|
||||
EOF
|
||||
|
||||
# Set permissions (read-only for owner)
|
||||
chmod 600 .env
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Verification
|
||||
|
||||
After setting PRIVATE_KEY, verify it works:
|
||||
|
||||
```bash
|
||||
# Load .env
|
||||
source .env
|
||||
|
||||
# Verify deployer address
|
||||
DEPLOYER=$(cast wallet address $PRIVATE_KEY 2>/dev/null)
|
||||
if [ -z "$DEPLOYER" ]; then
|
||||
echo "❌ Invalid PRIVATE_KEY"
|
||||
else
|
||||
echo "✅ PRIVATE_KEY is valid"
|
||||
echo "Deployer address: $DEPLOYER"
|
||||
|
||||
# Check balance
|
||||
BALANCE=$(cast balance $DEPLOYER --rpc-url $RPC_URL 2>/dev/null)
|
||||
echo "Balance: $BALANCE wei"
|
||||
fi
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. **If .env doesn't exist**: Create it with PRIVATE_KEY
|
||||
2. **If PRIVATE_KEY not set**: Add it to .env or export it
|
||||
3. **Verify**: Run verification commands above
|
||||
4. **Deploy**: Run `./scripts/deploy-and-integrate-all.sh`
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2025-12-24
|
||||
|
||||
Reference in New Issue
Block a user