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

126
docs/COMPILATION_ERRORS_FIXED.md
View File

@@ -1,126 +0,0 @@
# Compilation Errors Fixed
**Date**: 2025-12-24
**Status**: ✅ All compilation errors fixed
---
## ✅ Fixed Errors
### 1. TransactionMirror.sol:222 - Variable Shadowing
**Error**: `tx` shadows builtin symbol
**Fix**: Renamed return variable from `tx` to `mirroredTx`
```solidity
// Before
function getTransaction(bytes32 txHash) external view returns (MirroredTransaction memory tx)
// After
function getTransaction(bytes32 txHash) external view returns (MirroredTransaction memory mirroredTx)
```
### 2. OraclePriceFeed.sol:119 - Parameter Name Conflict
**Error**: Return variable `needsUpdate` has same name as function
**Fix**: Renamed return variable to `updateNeeded`
```solidity
// Before
function needsUpdate(address asset) external view returns (bool needsUpdate)
// After
function needsUpdate(address asset) external view returns (bool updateNeeded)
```
### 3. PriceFeedKeeper.sol:86 - Return Variable Name Conflict
**Error**: Return variable `needsUpdate` conflicts with function name
**Fix**: Renamed return variable to `updateNeeded`
```solidity
// Before
function checkUpkeep() public view returns (bool needsUpdate, address[] memory assets)
// After
function checkUpkeep() public view returns (bool updateNeeded, address[] memory assets)
```
**Also updated**: `CheckUpkeep.s.sol` to use new variable name
### 4. TokenRegistryTest.t.sol:9 - Constructor Parameter Shadowing
**Error**: Constructor parameter `decimals` shadows function `decimals()`
**Fix**: Renamed parameter to `decimalsValue`
```solidity
// Before
constructor(string memory name, string memory symbol, uint8 decimals)
// After
constructor(string memory name, string memory symbol, uint8 decimalsValue)
```
### 5. DeployWETH9WithCREATE.s.sol:118 - Missing Override
**Error**: Overriding function is missing "override" specifier
**Fix**: Added `override` keyword
```solidity
// Before
function computeCreateAddress(address deployer, uint256 nonce) internal pure returns (address)
// After
function computeCreateAddress(address deployer, uint256 nonce) internal pure override returns (address)
```
### 6. DeployCCIPSender.s.sol:24 - Wrong Argument Count
**Error**: Wrong argument count: 1 given but expected 3
**Fix**: Added missing constructor parameters (`oracleAggregator`, `feeToken`)
```solidity
// Before
CCIPSender sender = new CCIPSender(ccipRouter);
// After
address oracleAggregator = vm.envAddress("ORACLE_AGGREGATOR_ADDRESS");
address feeToken = vm.envOr("LINK_TOKEN_ADDRESS", address(0));
CCIPSender sender = new CCIPSender(ccipRouter, oracleAggregator, feeToken);
```
### 7. CheckUpkeep.s.sol:32 - Console.log Syntax
**Error**: Member "log" not found
**Fix**: Changed to proper console.log format
```solidity
// Before
console.log(" ", i + 1, ":", assets[i], "- Needs Update:", assetNeedsUpdate);
// After
console.log("Asset %s: %s - Needs Update: %s", i + 1, assets[i], assetNeedsUpdate);
```
---
## ✅ Verification
All errors should now be fixed. Test compilation:
```bash
cd /home/intlc/projects/proxmox/smom-dbis-138
forge build --via-ir
```
Expected: ✅ Compilation successful
---
## 📋 Files Modified
1. `contracts/mirror/TransactionMirror.sol`
2. `contracts/reserve/OraclePriceFeed.sol`
3. `contracts/reserve/PriceFeedKeeper.sol`
4. `test/utils/TokenRegistryTest.t.sol`
5. `script/DeployWETH9WithCREATE.s.sol`
6. `script/DeployCCIPSender.s.sol`
7. `script/reserve/CheckUpkeep.s.sol`
---
**Last Updated**: 2025-12-24