Skip to content

docs(for-developer): overhaul — grouped by domain (contracts / API / SDK / overview)#10

Open
tyler-tsai wants to merge 4 commits into
enfrom
docs/for-developer-p0
Open

docs(for-developer): overhaul — grouped by domain (contracts / API / SDK / overview)#10
tyler-tsai wants to merge 4 commits into
enfrom
docs/for-developer-p0

Conversation

@tyler-tsai

@tyler-tsai tyler-tsai commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator

for-developer overhaul — commits grouped by domain

Organized into 4 commits by reviewer domain — review the commit that matches your area:

Commit Reviewer Pages
contract & protocol pages Contracts team CDP · V3 DEX · slisBNB · slisBNBx · Credit · Lending (interface / events+callbacks / IRM / StableSwap) · Multi-Oracle consuming-prices
REST API pages … + conventions Backend (lista-api) lending-api overall / vault / market / position-liquidation-emission + conventions
Moolah Lending SDK guide SDK / frontend sdk.md
Overview product-map hub + SUMMARY navigation Docs lead overview.md + SUMMARY.md

Per-page review checkpoints + source repos: utils/P0_REVIEW_ROUTING.md.

What this does

Rewrites the stale Overview, fills the two biggest gaps (SDK, V3 DEX), corrects factual errors found by diffing docs against source, and adds the missing contract-reference + integration layer for Lending and Oracle. Independently reviewed by Codex (0 confidentiality leaks / broken links / formatting issues); every technical claim verified against the contract / API / SDK source.

Key factual fixes

  • CDP: interest accrues via jug.drip (none at borrow time); rate clamped to maxDuty200% APY (was "20%"); real Abacus auction curves.
  • V3 DEX: fee tiers 0.05 / 0.30 / 1.00%; off-chain pool-address derivation needs Lista's own init-code hash.
  • Lending API: string chain (not numeric chainId), sort/order; order required on /borrow/markets; fictional endpoints replaced with real routes.
  • Oracle: peek() USD price vs Moolah getPrice() with the 10**(36+loanDec−collDec) scale — the two were conflated.
  • slisBNB: 2 stale OFT addresses. slisBNBx: delegation is changeable via delegateAllTo. Credit: penalty 15% (not 3%).

Out-of-scope follow-ups (not in this PR)

  • lista-api /borrow/markets has no default for order → 500 if omitted. Documented as required; backend may want to add a = 'desc' default.
  • The public intro AMO page also shows the wrong "20%" cap (under introduction/).

Auto-sync

No auto-synced address tables touched. The slisBNB smart-contract page is hand-maintained (not a sync target), confirmed against contract-page-map.json / gen-contract-map.mjs.

🤖 Generated with Claude Code

@tyler-tsai tyler-tsai force-pushed the docs/for-developer-p0 branch from 4e805dd to 8070473 Compare July 2, 2026 07:20
@tyler-tsai tyler-tsai changed the title docs(for-developer): P0 overhaul — Overview hub, SDK, V3 DEX, API & contract fixes docs(for-developer): overhaul — grouped by domain (contracts / API / SDK / overview) Jul 2, 2026
@tyler-tsai tyler-tsai force-pushed the docs/for-developer-p0 branch from 8070473 to 29ac46a Compare July 2, 2026 07:46
tyler-tsai and others added 4 commits July 2, 2026 16:01
…isBNBx, Credit, Lending, Oracle)

All contract-derived pages, for contract-team review:
- CDP mechanics: no interest at borrow, dynamic AMO duty clamped to maxDuty (~200% APY)/minDuty, Abacus auction curves, borrowed() +100 wei
- V3 DEX README + mechanics: Uniswap V3 fork; fee tiers 0.05/0.30/1.00%; Lista-specific pool init-code hash for off-chain address derivation
- slisBNB smart-contract: fix 2 stale OFT addresses (+ StakeHub/GovBNB)
- slisBNBx delegation: changeable per-account via SlisBNBxMinter.delegateAllTo
- Credit loan-lifecycle: penalty 15%; correct supplyAndBorrow signature
- Lending: contract-reference, events & onMoolah* callbacks, Adaptive Curve IRM, Smart Lending/StableSwap integration (+ README contents)
- Multi-Oracle: consuming-prices (peek USD vs Moolah getPrice 10**(36+loanDec-collDec) scale, raw-unit conversion)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…ntions

Moolah Lending REST API pages, for backend review:
- overall/vault/market/position-liquidation-emission rewritten to match the live NestJS controllers: string chain (not numeric chainId), sort/order; real endpoints; order required on /borrow/markets; totalBorrow history is protocol-wide; exact emission signature-message format
- new API Conventions page (response envelope, chain, pagination, signature-gated endpoints, caching)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
New canonical @lista-dao/moolah-lending-sdk + moolah-sdk-core page: install, MoolahSDK init, read methods, StepParam[] builder pattern, simulation, Decimal utility, MoolahApiClient. (Re-export scope: lending SDK re-exports a curated subset; simulate fns/ABIs come from sdk-core.)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- overview.md: rewritten from the legacy Helio-era narrative into a product map + audience routing + networks
- SUMMARY.md: navigation entries for all new/updated for-developer pages

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@tyler-tsai tyler-tsai force-pushed the docs/for-developer-p0 branch from 29ac46a to 3a61bb4 Compare July 2, 2026 08:01
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