d-bis/explorer-monorepo
4
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

chore: consolidate documentation — delete status/fix/progress cruft

Browse Source 
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:
Devin
2026-04-18 18:56:17 +00:00
parent e1c3b40cb0
commit 40c9af678f
205 changed files with 8 additions and 37633 deletions
Download Patch File Download Diff File Expand all files Collapse all files

192
docs/ENV_LINES_3_4_REFERENCE.md
View File

@@ -1,192 +0,0 @@
# .env File Lines 3-4 Reference
**Date**: 2025-12-24
**Purpose**: Reference for what should be on lines 3-4 of the .env file
---
## Typical .env File Structure
Based on the project structure, a typical `.env` file should look like:
```bash
# Chain 138 RPC Configuration
RPC_URL_138=http://192.168.11.250:8545
RPC_URL=http://192.168.11.250:8545
PRIVATE_KEY=<your_private_key_here>
```
**Lines 3-4 would typically be**:
- **Line 3**: `RPC_URL=http://192.168.11.250:8545`
- **Line 4**: `PRIVATE_KEY=<your_private_key_here>`
---
## Expected Content for Lines 3-4
### Line 3: RPC_URL
```bash
RPC_URL=http://192.168.11.250:8545
```
**Purpose**: Sets the RPC endpoint for ChainID 138
**Format**: `RPC_URL=<http_or_https_url>`
**Default**: `http://192.168.11.250:8545`
### Line 4: PRIVATE_KEY
```bash
PRIVATE_KEY=<your_64_character_hex_private_key>
```
**Purpose**: Deployer private key for contract deployments
**Format**:
- Without 0x prefix: `1234567890abcdef...` (64 hex characters)
- With 0x prefix: `0x1234567890abcdef...` (66 characters total)
**Example**:
```bash
PRIVATE_KEY=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```
---
## Verification Commands
### Check Line 3 (RPC_URL)
```bash
cd /home/intlc/projects/proxmox/smom-dbis-138
sed -n '3p' .env
# Should output: RPC_URL=http://192.168.11.250:8545
```
### Check Line 4 (PRIVATE_KEY)
```bash
cd /home/intlc/projects/proxmox/smom-dbis-138
sed -n '4p' .env | sed 's/PRIVATE_KEY=\(.\{10\}\).*/PRIVATE_KEY=\1...***HIDDEN***/'
# Should show: PRIVATE_KEY=<first_10_chars>...***HIDDEN***
```
### Verify Both Lines
```bash
cd /home/intlc/projects/proxmox/smom-dbis-138
echo "Line 3:"
sed -n '3p' .env
echo ""
echo "Line 4 (hidden):"
sed -n '4p' .env | sed 's/\(.\{15\}\).*/\1...***HIDDEN***/'
```
---
## Common Issues
### Issue 1: PRIVATE_KEY Missing or Empty
**Symptom**: Deployment fails with "PRIVATE_KEY not found"
**Fix**:
```bash
# Check if line 4 has PRIVATE_KEY
sed -n '4p' .env | grep -q "^PRIVATE_KEY=" && echo "✅ Set" || echo "❌ Missing"
# If missing, add it:
echo "PRIVATE_KEY=<your_key>" >> .env
```
### Issue 2: Invalid PRIVATE_KEY Format
**Symptom**: "Invalid PRIVATE_KEY format" error
**Fix**:
```bash
# Verify format (should be 64 hex chars, with or without 0x)
PRIVATE_KEY=$(sed -n '4p' .env | cut -d'=' -f2)
if [[ "$PRIVATE_KEY" =~ ^0x[0-9a-fA-F]{64}$ ]] || [[ "$PRIVATE_KEY" =~ ^[0-9a-fA-F]{64}$ ]]; then
echo "✅ Valid format"
else
echo "❌ Invalid format - should be 64 hex characters"
fi
```
### Issue 3: RPC_URL Incorrect
**Symptom**: Cannot connect to RPC
**Fix**:
```bash
# Check line 3
RPC_URL=$(sed -n '3p' .env | cut -d'=' -f2)
echo "RPC_URL: $RPC_URL"
# Test connection
cast block-number --rpc-url "$RPC_URL" || echo "❌ Cannot connect"
```
---
## Quick Check Script
```bash
#!/bin/bash
cd /home/intlc/projects/proxmox/smom-dbis-138
echo "Checking .env lines 3-4..."
echo ""
# Line 3: RPC_URL
echo "Line 3 (RPC_URL):"
LINE3=$(sed -n '3p' .env)
if [[ "$LINE3" =~ ^RPC_URL= ]]; then
echo "✅ $LINE3"
else
echo "❌ Expected: RPC_URL=http://192.168.11.250:8545"
echo " Found: $LINE3"
fi
echo ""
# Line 4: PRIVATE_KEY
echo "Line 4 (PRIVATE_KEY):"
LINE4=$(sed -n '4p' .env)
if [[ "$LINE4" =~ ^PRIVATE_KEY= ]]; then
KEY_VALUE=$(echo "$LINE4" | cut -d'=' -f2-)
if [ -z "${KEY_VALUE// }" ]; then
echo "❌ PRIVATE_KEY is set but empty"
else
KEY_PREFIX=$(echo "$KEY_VALUE" | cut -c1-10)
KEY_LENGTH=${#KEY_VALUE}
echo "✅ PRIVATE_KEY is set (prefix: ${KEY_PREFIX}..., length: $KEY_LENGTH)"
# Validate format
if [[ "$KEY_VALUE" =~ ^0x[0-9a-fA-F]{64}$ ]] || [[ "$KEY_VALUE" =~ ^[0-9a-fA-F]{64}$ ]]; then
echo " ✅ Format is valid"
else
echo " ⚠️ Format may be invalid (expected 64 hex chars)"
fi
fi
else
echo "❌ PRIVATE_KEY not found on line 4"
echo " Found: $LINE4"
fi
```
---
## Update Lines 3-4
If you need to update these lines:
```bash
cd /home/intlc/projects/proxmox/smom-dbis-138
# Update line 3 (RPC_URL)
sed -i '3s|.*|RPC_URL=http://192.168.11.250:8545|' .env
# Update line 4 (PRIVATE_KEY) - REPLACE <your_key> with actual key
sed -i '4s|.*|PRIVATE_KEY=<your_private_key>|' .env
# Verify changes
echo "Updated lines 3-4:"
sed -n '3,4p' .env
```
---
**Last Updated**: 2025-12-24