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,105 +0,0 @@
|
||||
# Deployment Script Fix
|
||||
|
||||
**Date**: 2025-01-12
|
||||
**Issue**: Deployment scripts running in dry-run mode
|
||||
**Status**: ✅ **FIXED**
|
||||
|
||||
---
|
||||
|
||||
## Problem
|
||||
|
||||
The deployment scripts were reporting "SUCCESS" but no transactions were actually being broadcast to the network. The scripts were running in dry-run/simulation mode by default.
|
||||
|
||||
### Root Cause
|
||||
|
||||
1. **forge script**: Required `--broadcast` flag (was present but may not have been effective)
|
||||
2. **forge create**: Missing `--broadcast` flag entirely
|
||||
3. No verification that broadcast actually occurred
|
||||
|
||||
---
|
||||
|
||||
## Solution
|
||||
|
||||
### Fix 1: Added --broadcast to forge create
|
||||
|
||||
**File**: `scripts/force-deploy-link.sh`
|
||||
|
||||
**Method 2** (forge create) now includes `--broadcast`:
|
||||
|
||||
```bash
|
||||
forge create src/MockLinkToken.sol:MockLinkToken \
|
||||
--rpc-url "$RPC_URL" \
|
||||
--private-key "$PRIVATE_KEY" \
|
||||
--gas-price "$FORCE_GAS" \
|
||||
--legacy \
|
||||
--broadcast \ # ← ADDED
|
||||
2>&1
|
||||
```
|
||||
|
||||
### Fix 2: Added Broadcast Verification
|
||||
|
||||
**Method 1** (forge script) now includes verification:
|
||||
|
||||
```bash
|
||||
# Verify broadcast actually happened
|
||||
if echo "$DEPLOY_OUTPUT" | grep -qi "dry run\|simulation only\|not broadcasting"; then
|
||||
echo "⚠️ WARNING: Script may have run in dry-run mode despite --broadcast flag"
|
||||
echo "Output contains dry-run indicators"
|
||||
fi
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Direct Deployment Command
|
||||
|
||||
For immediate deployment, use:
|
||||
|
||||
```bash
|
||||
forge create src/MockLinkToken.sol:MockLinkToken \
|
||||
--rpc-url $RPC_URL \
|
||||
--private-key $PRIVATE_KEY \
|
||||
--gas-price 20000000000 \
|
||||
--legacy \
|
||||
--broadcast
|
||||
```
|
||||
|
||||
**Required Flags**:
|
||||
- `--rpc-url`: Network RPC endpoint
|
||||
- `--private-key`: Deployer private key
|
||||
- `--gas-price`: Gas price in wei (20 gwei = 20000000000)
|
||||
- `--legacy`: Use legacy transaction format
|
||||
- `--broadcast`: **CRITICAL** - Actually broadcast the transaction
|
||||
|
||||
---
|
||||
|
||||
## Verification
|
||||
|
||||
After deployment, verify:
|
||||
|
||||
1. **Check contract bytecode**:
|
||||
```bash
|
||||
cast code <DEPLOYED_ADDRESS> --rpc-url $RPC_URL
|
||||
```
|
||||
|
||||
2. **Check token functions**:
|
||||
```bash
|
||||
cast call <DEPLOYED_ADDRESS> "name()" --rpc-url $RPC_URL
|
||||
cast call <DEPLOYED_ADDRESS> "symbol()" --rpc-url $RPC_URL
|
||||
```
|
||||
|
||||
3. **Check block explorer**:
|
||||
- Visit: https://explorer.d-bis.org/address/<DEPLOYED_ADDRESS>
|
||||
- Verify contract exists and is confirmed
|
||||
|
||||
---
|
||||
|
||||
## Status
|
||||
|
||||
✅ **Script Fixed**: `force-deploy-link.sh` now includes `--broadcast` for all methods
|
||||
✅ **Verification Added**: Script now checks for dry-run indicators
|
||||
✅ **Direct Command**: Provided for immediate deployment
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2025-01-12
|
||||
|
||||
Reference in New Issue
Block a user