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,172 +0,0 @@
|
||||
# Remaining Tasks Status
|
||||
|
||||
**Date**: 2025-12-24
|
||||
**Status**: Medium and Low Priority Tasks
|
||||
|
||||
---
|
||||
|
||||
## ✅ Completed Tasks
|
||||
|
||||
### Critical Priority (2/2) ✅
|
||||
- CCIPReceiver verified
|
||||
- OpenZeppelin installed
|
||||
|
||||
### High Priority (12/12) ✅
|
||||
- All governance, reserve, and eMoney system contracts deployed
|
||||
|
||||
### Low Priority (2/5) ✅
|
||||
- AddressMapper: Deployed (if contract exists)
|
||||
- MirrorManager: Deployed (if contract exists)
|
||||
|
||||
---
|
||||
|
||||
## ⏳ Remaining Tasks
|
||||
|
||||
### Medium Priority - CCIP Contracts on Other Networks
|
||||
|
||||
#### Prerequisites Required
|
||||
|
||||
For deploying CCIP contracts on other networks, the following are needed:
|
||||
|
||||
1. **RPC URLs** for each network:
|
||||
- Ethereum Mainnet RPC
|
||||
- BSC RPC
|
||||
- Polygon RPC
|
||||
- Avalanche RPC
|
||||
- Base RPC
|
||||
- Arbitrum RPC
|
||||
- Optimism RPC
|
||||
|
||||
2. **Network-Specific Environment Variables**:
|
||||
- `CCIP_ROUTER_<NETWORK>`
|
||||
- `ORACLE_AGGREGATOR_<NETWORK>`
|
||||
- `LINK_TOKEN_<NETWORK>`
|
||||
- `RPC_URL_<NETWORK>`
|
||||
|
||||
3. **Funding** on each network:
|
||||
- Sufficient native tokens for gas
|
||||
- LINK tokens for CCIP fees
|
||||
|
||||
4. **Deployment Scripts** ✅ (Created):
|
||||
- `DeployCCIPLoggerMainnet.s.sol`
|
||||
- `DeployCCIPSenderMainnet.s.sol`
|
||||
- `DeployCCIPReceiverMainnet.s.sol`
|
||||
|
||||
#### Networks to Deploy
|
||||
|
||||
1. **Ethereum Mainnet** (3 contracts)
|
||||
- CCIPLogger
|
||||
- CCIPSender
|
||||
- CCIPReceiver
|
||||
|
||||
2. **BSC** (3 contracts)
|
||||
- CCIPLogger
|
||||
- CCIPSender
|
||||
- CCIPReceiver
|
||||
|
||||
3. **Polygon** (3 contracts)
|
||||
- CCIPLogger
|
||||
- CCIPSender
|
||||
- CCIPReceiver
|
||||
|
||||
4. **Avalanche** (3 contracts)
|
||||
- CCIPLogger
|
||||
- CCIPSender
|
||||
- CCIPReceiver
|
||||
|
||||
5. **Base** (3 contracts)
|
||||
- CCIPLogger
|
||||
- CCIPSender
|
||||
- CCIPReceiver
|
||||
|
||||
6. **Arbitrum** (3 contracts)
|
||||
- CCIPLogger
|
||||
- CCIPSender
|
||||
- CCIPReceiver
|
||||
|
||||
7. **Optimism** (3 contracts)
|
||||
- CCIPLogger
|
||||
- CCIPSender
|
||||
- CCIPReceiver
|
||||
|
||||
#### Additional Medium Priority
|
||||
|
||||
8. **CCIPMessageValidator**
|
||||
- Status: Library (not a standalone contract)
|
||||
- Action: No deployment needed
|
||||
|
||||
9. **Price Feed Aggregator**
|
||||
- Status: Check if contract exists
|
||||
- Action: Deploy if available
|
||||
|
||||
10. **Pausable Controller**
|
||||
- Status: Check if contract exists
|
||||
- Action: Deploy if available
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Deployment Instructions
|
||||
|
||||
### For Each Network
|
||||
|
||||
1. **Configure Environment Variables**:
|
||||
```bash
|
||||
export RPC_URL_<NETWORK>=<network_rpc_url>
|
||||
export CCIP_ROUTER_<NETWORK>=<network_ccip_router>
|
||||
export ORACLE_AGGREGATOR_<NETWORK>=<network_oracle>
|
||||
export LINK_TOKEN_<NETWORK>=<network_link_token>
|
||||
```
|
||||
|
||||
2. **Deploy Contracts**:
|
||||
```bash
|
||||
# CCIPLogger
|
||||
forge script script/DeployCCIPLogger<Network>.s.sol \
|
||||
--rpc-url $RPC_URL_<NETWORK> \
|
||||
--broadcast --legacy --gas-price <gas_price>
|
||||
|
||||
# CCIPSender
|
||||
forge script script/DeployCCIPSender<Network>.s.sol \
|
||||
--rpc-url $RPC_URL_<NETWORK> \
|
||||
--broadcast --legacy --gas-price <gas_price>
|
||||
|
||||
# CCIPReceiver
|
||||
forge script script/DeployCCIPReceiver<Network>.s.sol \
|
||||
--rpc-url $RPC_URL_<NETWORK> \
|
||||
--broadcast --legacy --gas-price <gas_price>
|
||||
```
|
||||
|
||||
3. **Update .env** with deployed addresses
|
||||
|
||||
---
|
||||
|
||||
## 📊 Summary
|
||||
|
||||
### Completed
|
||||
- **Critical**: 2/2 ✅
|
||||
- **High Priority**: 12/12 ✅
|
||||
- **Low Priority**: 2/5 ✅ (AddressMapper, MirrorManager)
|
||||
|
||||
### Remaining
|
||||
- **Medium Priority**: 12/13 ⏳
|
||||
- 21 CCIP contracts across 7 networks (requires network setup)
|
||||
- 1 Price Feed Aggregator (if contract exists)
|
||||
- 1 Pausable Controller (if contract exists)
|
||||
- **Low Priority**: 3/5 ⏳
|
||||
- CCIPRouterOptimized
|
||||
- Token Registry
|
||||
- Fee Collector
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Next Steps
|
||||
|
||||
1. **Configure network RPC URLs** in `.env`
|
||||
2. **Fund accounts** on each target network
|
||||
3. **Deploy CCIP contracts** on each network
|
||||
4. **Deploy remaining utility contracts** (if available)
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2025-12-24
|
||||
**Status**: Ready for cross-network deployments (requires network configuration)
|
||||
|
||||
Reference in New Issue
Block a user