@sodax/sdk 2.0.0-rc.1 → 2.0.0-rc.11

package/README.md

@@ -98,73 +98,21 @@ How to setup local development
 
 ## AI agent docs
 
-`@sodax/sdk` ships an AI-ready documentation tree at `node_modules/@sodax/sdk/ai-exported/`. It's tool-neutral: any agent that can read files (Claude Code, Cursor, Aider, Copilot Chat, ChatGPT with file context, etc.) can use it without further setup.
+AI-readable docs for `@sodax/sdk` (and the other `@sodax/*` packages) are shipped via [`@sodax/skills`](https://github.com/icon-project/sodax-sdks/tree/main/packages/skills) — a separate npm package bundling Claude-Code SKILL.md files and a long-form knowledge tree.
 
-### Get started
+**Recommended: [`skills` CLI](https://github.com/vercel-labs/skills)** — from your project root:
 
-Point your agent at `node_modules/@sodax/sdk/ai-exported/AGENTS.md` — it routes to the rest. Three sample prompts covering the typical entry points:
-
-```
-> Read node_modules/@sodax/sdk/ai-exported/AGENTS.md and integrate
-> SODAX cross-chain swaps from Arbitrum to Stellar into my Node service.
-
-> Read node_modules/@sodax/sdk/ai-exported/AGENTS.md. My code uses
-> @sodax/sdk v1 — port my call sites to v2.
-
-> Look up the v2 SodaxError code for a relay timeout in
-> node_modules/@sodax/sdk/ai-exported/integration/reference/error-codes.md.
+```bash
+npx skills@latest add icon-project/sodax-sdks/packages/skills
 ```
 
-### What's inside
+**npm + `AGENTS.md` pointer** (fallback for web chats, or when you prefer a devDependency over the CLI):
 
+```bash
+pnpm add -D @sodax/skills
 ```
-ai-exported/
-├── AGENTS.md                          # Tool-neutral entry point — start here
-├── integration/                       # Building NEW v2 code
-│   ├── README.md, ai-rules.md         # Index + DO / DO NOT / workflow for agents
-│   ├── quickstart.md                  # Install + initialize + first-run troubleshooting
-│   ├── architecture.md                # Type system + design concepts (Result, ChainKeys, …)
-│   ├── chain-specifics.md             # Non-EVM quirks (Stellar, BTC, Solana, ICON, NEAR)
-│   ├── features/                      # 7 feature pages: swap, money-market, staking, bridge,
-│   │                                  #   dex, icx-bnusd-baln, auxiliary-services
-│   ├── recipes/                       # 8 copy-pasteable patterns: init, signed-/raw-tx flow,
-│   │                                  #   error handling, narrowing, testing, gas, backend init
-│   └── reference/                     # 5 lookup tables: chain keys, wallet providers,
-│                                      #   error codes, public API surface, glossary
-└── migration/                         # Porting EXISTING v1 code to v2
-    ├── README.md, ai-rules.md         # Index + workflow for porting agents
-    ├── checklist.md                   # 17-step cross-cutting checklist
-    ├── breaking-changes/              # 3 cross-cutting changes: type-system, architecture,
-    │                                  #   result-and-errors
-    ├── features/                      # 7 per-feature porting playbooks (same names as
-    │                                  #   integration/features/)
-    ├── recipes.md                     # Codemods + error-shape and Result adapters
-    └── reference/                     # 4 reference tables: deleted exports, sodax-config
-                                       #   reshape, error-code crosswalk, return-shape diffs
-```
-
-### Scope
-
-This tree documents `@sodax/sdk` (the Core SDK) only. It assumes:
-
-- **TypeScript** — examples are TS; the SDK ships dual ESM/CJS.
-- **Runtime-agnostic** — Node.js, browsers, bundled apps. **No React or Next.js content** — the SDK is UI-framework-agnostic and the docs reflect that.
-- **`@sodax/types` is re-exported** through `@sodax/sdk`'s barrel; consumers don't add it as a separate dependency.
-
-`@sodax/wallet-sdk-core` is **mentioned** in a few places as a pointer — it's a separate SODAX package that ships ready-made `I*WalletProvider` implementations for all 9 chain families. Consumers can install it separately or implement the wallet-provider interfaces themselves. React-layer packages (`@sodax/wallet-sdk-react`, `@sodax/dapp-kit`) are **out of scope here** and may have their own `ai-exported/` trees in their respective packages.
-
-### Integrity guarantees
-
-Every release passes four CI checks against `ai-exported/`:
-
-| Guard | What it catches |
-|---|---|
-| `check:ai-exported` | Each top-level `sodax.X` reference matches a real public member of the `Sodax` class in `src/shared/entities/Sodax.ts`. (Shallow — `sodax.partners.invented` would still pass.) |
-| `check:ai-scope` | No accidental sibling-package, React, or Next.js content leaks in. |
-| `check:ai-links` | Every relative link between markdown files resolves. |
-| `check:ai-imports` | Every `import … from '@sodax/sdk'` example in the docs typechecks against the SDK source. |
 
-If you're contributing to this repo, run them with `pnpm -C packages/sdk run check:ai-exported` (or `:scope`, `:links`, `:imports`).
+Then point your agent at `node_modules/@sodax/skills/AGENTS.md`. See [docs/ai-integration-guide.md](https://github.com/icon-project/sodax-sdks/blob/main/docs/ai-integration-guide.md) for all install modes and per-tool wiring.
 
 ***