Skip to content

Commit d87a807

Browse files
chris-mercerclaude
andcommitted
docs: update documentation to reflect PR hummingbot#594 submission
- Update PR-SUBMISSION-CHECKLIST.md with completed status and PR link - Update docs/README.md with current implementation status - Add upstream merge checklist to CLAUDE.md - Streamline ETCswap section in CLAUDE.md Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent e56342c commit d87a807

3 files changed

Lines changed: 91 additions & 73 deletions

File tree

CLAUDE.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -277,14 +277,24 @@ node scripts/test-helius-live.js
277277
## Hummingbot Gateway Endpoint Standardization
278278
- This repo standardized DEX and chain endpoints that are used by Hummingbot strategies. See this branch for the matching code, especially the Gateway connector classes https://github.com/hummingbot/hummingbot/tree/development
279279

280-
## ETCswap Integration (Current Focus)
280+
## ETCswap Integration
281281

282-
This fork is focused on adding ETCswap V2 and V3 connectors for Ethereum Classic.
282+
This fork adds ETCswap V2 and V3 connectors for Ethereum Classic.
283283

284-
### Contract Reference
285-
**Source of Truth:** [docs/ETCSWAP-CONTRACTS.md](docs/ETCSWAP-CONTRACTS.md) for all contract addresses.
284+
### Upstream PR Status
285+
**PR #594:** https://github.com/hummingbot/gateway/pull/594 (Submitted 2026-01-22)
286+
287+
### Upstream Merge Checklist
288+
1. [x] Create clean feature branch from `upstream/main`
289+
2. [x] Copy ETCswap-specific files only (no community docs)
290+
3. [x] Run full test suite (134 tests passing)
291+
4. [x] Submit PR to upstream
292+
5. [ ] Address review feedback
293+
6. [ ] PR merged
294+
7. [ ] Submit NCP (New Connector Proposal) on Snapshot
286295

287-
**CRITICAL:** Always verify addresses against the source of truth document. Never copy addresses from generated reports or other documentation without verification.
296+
### Contract Reference
297+
**Source of Truth:** [docs/ETCSWAP-CONTRACTS.md](docs/ETCSWAP-CONTRACTS.md)
288298

289299
### Networks Implemented
290300
| Network | Config Name | Chain ID | V2 (AMM) | V3 (CLMM) |
@@ -337,16 +347,12 @@ This fork is focused on adding ETCswap V2 and V3 connectors for Ethereum Classic
337347
- etc.
338348

339349
### ETCswap SDKs
340-
Use the official ETCswap SDK packages (NOT `@_etcswap/*` which are deprecated):
341-
342350
```bash
343351
pnpm add @etcswapv2/sdk-core @etcswapv2/sdk @etcswapv3/sdk @etcswapv3/router-sdk
344352
```
345353

346-
SDK Repository: https://github.com/etcswap/sdks
347-
348354
### ETCswap Links
355+
- Upstream PR: https://github.com/hummingbot/gateway/pull/594
356+
- SDKs Repository: https://github.com/etcswap/sdks
349357
- V2 App: https://v2.etcswap.org
350358
- V3 App: https://v3.etcswap.org
351-
- V2 Subgraph: https://v2-graph.etcswap.org/subgraphs/name/etcswap/graphql
352-
- V3 Subgraph: https://v3-graph.etcswap.org/subgraphs/name/etcswap/graphql

docs/PR-SUBMISSION-CHECKLIST.md

Lines changed: 51 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,21 @@
11
# ETCswap Connector PR Submission Checklist
22

3-
This checklist tracks all requirements for submitting the ETCswap V2 and V3 connector implementation to the official Hummingbot Gateway repository.
3+
This checklist tracks the status of the ETCswap V2 and V3 connector submission to the official Hummingbot Gateway repository.
44

5-
## PR Information
5+
## PR Status: SUBMITTED
66

7-
- **Target Repository:** https://github.com/hummingbot/gateway
8-
- **Target Branch:** `development`
9-
- **Source Branch:** `feat/etcswap-v28-upgrade` (clean PR branch)
10-
- **Connector Name:** ETCswap
11-
- **Networks:** Ethereum Classic (`classic`, Chain ID 61), Mordor Testnet (`mordor`, Chain ID 63)
12-
- **Trading Types:** Router, AMM (V2), CLMM (V3)
7+
**PR #594:** https://github.com/hummingbot/gateway/pull/594
8+
9+
| Field | Value |
10+
|-------|-------|
11+
| Target Repository | https://github.com/hummingbot/gateway |
12+
| Target Branch | `main` |
13+
| Source Branch | `feat/etcswap-connector` |
14+
| Connector Name | ETCswap |
15+
| Networks | Ethereum Classic (`classic`, Chain ID 61), Mordor Testnet (`mordor`, Chain ID 63) |
16+
| Trading Types | Router, AMM (V2), CLMM (V3) |
17+
| Tests Passing | 134/134 |
18+
| Submitted | 2026-01-22 |
1319

1420
---
1521

@@ -136,33 +142,31 @@ This checklist tracks all requirements for submitting the ETCswap V2 and V3 conn
136142

137143
---
138144

139-
## 5. PR Preparation
145+
## 5. PR Preparation - COMPLETED
140146

141147
### 5.1 Branch Setup
142-
- [ ] Fetch latest from upstream: `git fetch upstream`
143-
- [ ] Create clean branch from upstream/development
144-
- [ ] Cherry-pick only connector-related commits (exclude community docs)
145-
- [ ] Resolve any merge conflicts
148+
- [x] Fetch latest from upstream: `git fetch upstream`
149+
- [x] Create clean branch from upstream/main: `feat/etcswap-connector`
150+
- [x] Copy only ETCswap-specific files (no community docs)
151+
- [x] All 134 tests passing on clean branch
146152

147153
### 5.2 PR Content
148-
- [ ] Clear PR title: `feat: add ETCswap V2 and V3 connector for Ethereum Classic`
149-
- [ ] PR description includes:
154+
- [x] Clear PR title: `feat: add ETCswap V2 and V3 connector for Ethereum Classic`
155+
- [x] PR description includes:
150156
- Summary of changes
151157
- Networks supported (Classic, Mordor)
152158
- Trading types (Router, AMM, CLMM)
153159
- Test coverage percentage
154160
- Link to contract reference
155-
- [ ] Checklist in PR body per Hummingbot template
161+
- [x] PR submitted: https://github.com/hummingbot/gateway/pull/594
156162

157-
### 5.3 Pre-submission Verification
163+
### 5.3 Pre-submission Verification - PASSED
158164
```bash
159-
# Run all checks before submitting
160-
pnpm clean && pnpm install
161-
pnpm lint
162-
pnpm typecheck
163-
pnpm build
164-
pnpm test
165-
pnpm test:cov
165+
# All checks passed on feat/etcswap-connector branch
166+
pnpm lint # ✓ Passed
167+
pnpm typecheck # ✓ Passed
168+
pnpm build # ✓ Passed
169+
pnpm test # ✓ 134 tests passing
166170
```
167171

168172
---
@@ -241,26 +245,36 @@ gh pr create --base development
241245

242246
| Category | Status | Notes |
243247
|----------|--------|-------|
244-
| Code Implementation | Complete | All routes implemented |
245-
| Configuration | Complete | Both networks configured |
246-
| Unit Tests | Partial | Core tests done, need more coverage |
247-
| Integration Tests | Not Started | Requires live RPC testing |
248-
| Code Quality | In Progress | Lint/typecheck need verification |
249-
| Documentation | Complete | Contract reference complete |
250-
| PR Branch | Not Started | Clean branch needed |
251-
| NCP Proposal | Pending | After PR merge |
248+
| Code Implementation | ✅ Complete | All routes implemented |
249+
| Configuration | ✅ Complete | Both networks configured |
250+
| Unit Tests | ✅ Complete | 100 unit tests passing |
251+
| Live Tests | ✅ Complete | 34 live tests (16 Mordor + 18 Classic) |
252+
| Code Quality | ✅ Complete | Lint/typecheck/build passing |
253+
| Documentation | ✅ Complete | Contract reference complete |
254+
| PR Branch | ✅ Complete | `feat/etcswap-connector` |
255+
| PR Submitted | ✅ Complete | PR #594 |
256+
| NCP Proposal | ⏳ Pending | After PR merge |
257+
258+
---
259+
260+
## Next Steps
261+
262+
1. **PR Review:** Wait for Hummingbot team to review PR #594
263+
2. **Address Feedback:** Respond to any review comments
264+
3. **NCP Proposal:** After merge, submit New Connector Proposal on Snapshot
265+
- Requires 200,000 HBOT tokens
266+
- 7-day voting period
252267

253268
---
254269

255-
## Contact & Resources
270+
## Resources
256271

272+
- **Upstream PR:** https://github.com/hummingbot/gateway/pull/594
257273
- **ETCswap Website:** https://etcswap.org
258-
- **ETCswap V3 App:** https://v3.etcswap.org
259-
- **ETCswap V2 App:** https://v2.etcswap.org
260274
- **ETCswap SDKs:** https://github.com/etcswap/sdks
261275
- **Hummingbot Gateway:** https://github.com/hummingbot/gateway
262-
- **Hummingbot Docs:** https://hummingbot.org/gateway/
276+
- **NCP Snapshot Space:** https://snapshot.org/#/hbot-ncp.eth
263277

264278
---
265279

266-
Last updated: 2025-01-21
280+
Last updated: 2026-01-22

docs/README.md

Lines changed: 23 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,36 @@
1-
# Hummingbot Gateway Documentation
1+
# ETCswap Connector Documentation
22

3-
This folder contains documentation specific to the ETCswap integration.
3+
Documentation for the ETCswap V2/V3 connector integration with Hummingbot Gateway.
44

5-
## Documents
6-
7-
### [ETCSWAP-CONTRACTS.md](./ETCSWAP-CONTRACTS.md)
8-
Complete reference of all ETCswap contract addresses for:
9-
- Ethereum Classic (Chain ID: 61)
10-
- Mordor Testnet (Chain ID: 63)
5+
## PR Status
116

12-
Includes:
13-
- V2 contracts (Factory, Router, Multicall)
14-
- V3 contracts (Factory, SwapRouter, QuoterV2, NFT Position Manager, etc.)
15-
- Core tokens (WETC, USC)
16-
- Network configuration (RPC URLs, Chain IDs, Block Explorers)
7+
**Upstream PR #594:** https://github.com/hummingbot/gateway/pull/594
178

18-
## Implementation Status
9+
## Documents
1910

20-
| Feature | Ethereum Classic | Mordor Testnet |
21-
|---------|-------------|----------------|
22-
| Chain Config | Pending | Pending |
23-
| Token List | Pending | Pending |
24-
| ETCswap V2 (AMM) | Pending | Pending |
25-
| ETCswap V3 (CLMM) | Pending | TBD |
11+
| Document | Description |
12+
|----------|-------------|
13+
| [ETCSWAP-CONTRACTS.md](./ETCSWAP-CONTRACTS.md) | Contract addresses and configuration |
14+
| [PR-SUBMISSION-CHECKLIST.md](./PR-SUBMISSION-CHECKLIST.md) | PR submission tracking |
15+
| [reports/ETCSWAP-TEST-REPORT.md](./reports/ETCSWAP-TEST-REPORT.md) | Test results (134 tests) |
16+
| [etcswap/GETTING-STARTED.md](./etcswap/GETTING-STARTED.md) | User setup guide |
17+
| [etcswap/API-REFERENCE.md](./etcswap/API-REFERENCE.md) | API documentation |
2618

27-
## Quick Links
19+
## Implementation Status
2820

29-
- [Main README](../README.md) - Project overview
30-
- [CLAUDE.md](../CLAUDE.md) - AI agent instructions
31-
- [CONTRIBUTING.md](../CONTRIBUTING.md) - Contribution guidelines
21+
| Feature | Classic | Mordor | Status |
22+
|---------|---------|--------|--------|
23+
| Chain Config ||| Complete |
24+
| Token List ||| Complete |
25+
| V2 AMM ||| Complete |
26+
| V3 CLMM ||| Complete |
27+
| Router ||| Complete |
28+
| Unit Tests | 100 | - | Passing |
29+
| Live Tests | 18 | 16 | Passing |
3230

3331
## ETCswap Resources
3432

3533
- Website: https://etcswap.org
3634
- V2 App: https://v2.etcswap.org
3735
- V3 App: https://v3.etcswap.org
38-
- Twitter: https://x.com/ETCswap_org
36+
- SDKs: https://github.com/etcswap/sdks

0 commit comments

Comments
 (0)