Skip to content

docs: community-enhanced API docs with endpoint index, SDKs, and CI#104

Open
Valisthea wants to merge 5 commits intoasterdex:masterfrom
Valisthea:main
Open

docs: community-enhanced API docs with endpoint index, SDKs, and CI#104
Valisthea wants to merge 5 commits intoasterdex:masterfrom
Valisthea:main

Conversation

@Valisthea
Copy link
Copy Markdown

@Valisthea Valisthea commented Apr 5, 2026

Community Enhancement — Kairos Lab

What this PR adds

Documentation:

  • Restructured README with navigable endpoint index (51+ V3 endpoints)
  • community-notes.md: undocumented endpoints (openInterest, 8 Agent/Builder endpoints, Solana flow)
  • Known gaps documented: no rebalance API, no per-wallet builder fees, private referral endpoints

SDKs:

  • Python SDK: EIP-712 V3 signing, 50+ methods, 26 unit tests, ruff-clean
  • JavaScript SDK: ethers.js v6, ESM, full coverage

DevOps:

  • GitHub Actions CI (lint, secret scan, CodeQL, tests)
  • Issue templates, SECURITY.md, CONTRIBUTING.md

Why

Recurring community pain points from Discord #api-dev:

  1. Endpoints exist but aren't discoverable (leverageBracket, openInterest)
  2. Agent/Builder endpoints in demo code but not in docs
  3. No SDK — everyone re-implements EIP-712 signing from scratch
  4. No CI, no issue templates, no contribution flow

Zero breaking changes to existing docs.

Verification

  • ruff check: 0 errors
  • pytest: 26/26 passed
  • Secret scan: 0 hardcoded credentials
  • CodeQL sim: 0 injection vectors

Maintained by Kairos Lab

Valisthea added 5 commits April 5, 2026 12:40
- Complete endpoint index table (51+ V3 endpoints categorized)
- Document undocumented endpoints: openInterest, Agent/Builder, Solana flow
- Add community-notes.md with known API gaps
- Fix broken v3-demo/ link from original README
- Full client: 50+ methods covering all public, trade, account, agent/builder endpoints
- EIP-712 signing compatible with eth_account <0.13 and >=0.13
- Typed exceptions: AsterDexError, AsterDexAuthError, AsterDexRateLimitError
- 26 unit tests, ruff-clean, zero hardcoded secrets
- ESM module, full endpoint coverage, EIP-712 signing
- Async/await API, typed errors, ESLint config
- CI: markdown lint, link check, TruffleHog secret scan, Python tests, CodeQL
- 3 issue templates, SECURITY.md, CONTRIBUTING.md, LICENSE MIT
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant