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,189 +0,0 @@
|
||||
# Repository Update Analysis for ChainID 138
|
||||
|
||||
## Overview
|
||||
|
||||
This document analyzes three repositories that may need updates for ChainID 138:
|
||||
1. `app-ethereum` (Ledger hardware wallet support)
|
||||
2. `Cross-Chain-Mirroring` (Cross-chain bridge configuration)
|
||||
3. `ethereum-lists/chains` (Chainlist.org submission)
|
||||
|
||||
---
|
||||
|
||||
## 1. app-ethereum Repository
|
||||
|
||||
**Repository**: https://github.com/Defi-Oracle-Meta-Blockchain/app-ethereum.git
|
||||
**Purpose**: Ledger hardware wallet application for Ethereum and EVM-compatible chains
|
||||
**Status**: Forked from LedgerHQ/app-ethereum
|
||||
|
||||
### Analysis
|
||||
|
||||
**What it does**:
|
||||
- Provides Ledger device support for Ethereum and EVM chains
|
||||
- Allows users to sign transactions on Ledger hardware wallets
|
||||
- Supports custom chain configurations
|
||||
|
||||
**Does it need ChainID 138?**
|
||||
- ✅ **YES** - If users want to use Ledger devices with ChainID 138
|
||||
- Ledger devices need the chain configuration to be added to the app
|
||||
|
||||
**What needs to be updated**:
|
||||
1. **Chain configuration file** - Add ChainID 138 network definition
|
||||
2. **Network parameters** - RPC URLs, chain ID, currency symbol
|
||||
3. **Derivation path** - May need custom derivation path for ChainID 138
|
||||
|
||||
**Files to check/update**:
|
||||
- Network configuration files (typically in `src/` or `config/`)
|
||||
- Chain definitions
|
||||
- RPC endpoint configurations
|
||||
|
||||
**RPC URLs to use**:
|
||||
- Public: `https://rpc-http-pub.d-bis.org`
|
||||
- Permissioned: `https://rpc-http-prv.d-bis.org`
|
||||
|
||||
**Action Required**:
|
||||
- ⚠️ **NEEDS INVESTIGATION** - Check if ChainID 138 is already configured
|
||||
- If not, add ChainID 138 network configuration
|
||||
- Update RPC URLs to use public/permissioned endpoints
|
||||
|
||||
---
|
||||
|
||||
## 2. Cross-Chain-Mirroring Repository
|
||||
|
||||
**Repository**: https://github.com/Defi-Oracle-Meta-Blockchain/Cross-Chain-Mirroring.git
|
||||
**Purpose**: Cross-chain bridge and mirroring service configuration
|
||||
**Status**: Unknown (needs investigation)
|
||||
|
||||
### Analysis
|
||||
|
||||
**What it likely does**:
|
||||
- Configures cross-chain bridge services
|
||||
- Manages CCIP (Chainlink Cross-Chain Interoperability Protocol) settings
|
||||
- Handles transaction mirroring between chains
|
||||
|
||||
**Does it need ChainID 138?**
|
||||
- ✅ **LIKELY YES** - If it manages bridge configurations for ChainID 138
|
||||
- Cross-chain services need RPC endpoints to connect to ChainID 138
|
||||
|
||||
**What needs to be updated**:
|
||||
1. **RPC endpoint configurations** - Update to use public/permissioned RPCs
|
||||
2. **Chain metadata** - Ensure ChainID 138 is properly configured
|
||||
3. **Bridge contract addresses** - Verify CCIP router/sender addresses
|
||||
4. **Network parameters** - Chain ID, network ID, etc.
|
||||
|
||||
**RPC URLs to use**:
|
||||
- Public: `https://rpc-http-pub.d-bis.org` (for general bridge operations)
|
||||
- Permissioned: `https://rpc-http-prv.d-bis.org` (for authorized services)
|
||||
|
||||
**Action Required**:
|
||||
- ⚠️ **NEEDS INVESTIGATION** - Check repository contents
|
||||
- Update RPC endpoint references
|
||||
- Verify bridge contract addresses match current deployment
|
||||
|
||||
---
|
||||
|
||||
## 3. ethereum-lists/chains Repository
|
||||
|
||||
**Repository**: https://github.com/ethereum-lists/chains.git
|
||||
**File**: `_data/chains/eip155-138/chain.json`
|
||||
**Purpose**: Chainlist.org registry - public chain metadata for MetaMask and wallets
|
||||
|
||||
### Analysis
|
||||
|
||||
**Current Status**:
|
||||
- ✅ ChainID 138 **ALREADY EXISTS** in the repository
|
||||
- Current entry shows:
|
||||
```json
|
||||
{
|
||||
"name": "Defi Oracle Meta Mainnet",
|
||||
"chain": "dfiometa",
|
||||
"rpc": ["https://rpc.defi-oracle.io", "wss://wss.defi-oracle.io"]
|
||||
}
|
||||
```
|
||||
|
||||
**What needs to be updated**:
|
||||
1. **Chain name** - Update to "DBIS Chain" (or keep current if preferred)
|
||||
2. **RPC URLs** - Update to:
|
||||
- `https://rpc-http-pub.d-bis.org`
|
||||
- `https://rpc-http-prv.d-bis.org`
|
||||
3. **Explorer URL** - Ensure `https://explorer.d-bis.org` is listed
|
||||
4. **Chain metadata** - Verify all fields match our `chain-138.json`
|
||||
|
||||
**Comparison**:
|
||||
|
||||
**Current (in repository)**:
|
||||
```json
|
||||
{
|
||||
"name": "Defi Oracle Meta Mainnet",
|
||||
"chain": "dfiometa",
|
||||
"rpc": ["https://rpc.defi-oracle.io", "wss://wss.defi-oracle.io"]
|
||||
}
|
||||
```
|
||||
|
||||
**Our local config** (`token-lists/chainlists/chain-138.json`):
|
||||
```json
|
||||
{
|
||||
"name": "DBIS Chain",
|
||||
"chain": "DBIS",
|
||||
"rpc": [
|
||||
"https://rpc-http-pub.d-bis.org",
|
||||
"https://rpc-http-prv.d-bis.org"
|
||||
],
|
||||
"chainId": 138,
|
||||
"networkId": 138,
|
||||
"explorers": [{
|
||||
"name": "Blockscout",
|
||||
"url": "https://explorer.d-bis.org",
|
||||
"standard": "EIP3091"
|
||||
}],
|
||||
"nativeCurrency": {
|
||||
"name": "Ether",
|
||||
"symbol": "ETH",
|
||||
"decimals": 18
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Action Required**:
|
||||
- ✅ **UPDATE NEEDED** - RPC URLs are incorrect
|
||||
- ⚠️ **DECISION NEEDED** - Chain name: "Defi Oracle Meta Mainnet" vs "DBIS Chain"
|
||||
- Update RPC endpoints to match current infrastructure
|
||||
- Ensure explorer URL is correct
|
||||
|
||||
---
|
||||
|
||||
## Summary of Required Actions
|
||||
|
||||
### Priority 1: ethereum-lists/chains (Chainlist.org)
|
||||
- **Status**: ⚠️ **UPDATE REQUIRED**
|
||||
- **Action**: Update `_data/chains/eip155-138/chain.json` with correct RPC URLs
|
||||
- **Impact**: High - Affects MetaMask and wallet discovery
|
||||
- **PR Description**: Update ChainID 138 RPC endpoints to use public and permissioned endpoints
|
||||
|
||||
### Priority 2: Cross-Chain-Mirroring
|
||||
- **Status**: ⚠️ **INVESTIGATION REQUIRED**
|
||||
- **Action**: Check repository for ChainID 138 configurations
|
||||
- **Impact**: Medium - Affects cross-chain bridge operations
|
||||
- **PR Description**: Update RPC endpoints and verify bridge configurations
|
||||
|
||||
### Priority 3: app-ethereum (Ledger)
|
||||
- **Status**: ⚠️ **INVESTIGATION REQUIRED**
|
||||
- **Action**: Check if ChainID 138 is already supported, add if missing
|
||||
- **Impact**: Low-Medium - Affects Ledger hardware wallet users
|
||||
- **PR Description**: Add ChainID 138 support for Ledger devices
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. **Fork repositories** (if not already forked)
|
||||
2. **Clone locally** and investigate current state
|
||||
3. **Create branches** for updates
|
||||
4. **Make changes** according to analysis
|
||||
5. **Test changes** locally
|
||||
6. **Create pull requests** with clear descriptions
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2025-12-24
|
||||
**Status**: Analysis Complete - Ready for Repository Updates
|
||||
|
||||
Reference in New Issue
Block a user