@stableflow/core 3.0.0-beta-02a59f37a0-20260515

package/README.md

@@ -0,0 +1,60 @@
+# @stableflow/core
+
+StableFlow core: HTTP client, API models, token/chain configuration, and shared utilities.
+
+All API requests use the production endpoint **`https://api.stableflow.ai`** by default. No endpoint configuration is required for normal integration.
+
+## Installation
+
+```bash
+pnpm add @stableflow/core
+```
+
+## When to use
+
+- You need direct access to the StableFlow HTTP API (`SFA`).
+- You need shared types (`TokenConfig`, `WalletConfig`), bridge `Service` enums, or chain/token registries.
+- You are building on top of `@stableflow/bridges` or `@stableflow/wallet-*` (they depend on this package).
+
+For full cross-chain bridge flows (multi-route quote, send, status), use [`@stableflow/bridges`](../bridges/README.md) instead of calling `SFA` alone.
+
+## Main exports
+
+| Category | Symbols |
+|----------|---------|
+| HTTP API | `SFA`, `OpenAPI`, `request`, `ApiError`, `CancelablePromise` |
+| Bridge types | `Service`, `ServiceBackend`, `TransactionStatus`, `SendType` |
+| Models | `QuoteRequest`, `QuoteResponse`, `TokenResponse`, `TokenConfig`, `WalletConfig`, … |
+| Token / chain config | `tokens`, `usdtChains`, `usdcChains`, `frxusdChains`, `usdt0Chains` |
+| RPC | `setRpcUrls`, `getRpcUrls`, `getChainRpcUrl`, `NetworkRpcUrlsMap` |
+| Utilities | `formatQuoteError`, `getRouteStatus`, `getPrice`, `addressToBytes32`, `quoteSignature`, … |
+
+See `dist/index.d.ts` after running `pnpm build`.
+
+## Authentication (optional)
+
+If your integration requires JWT authentication:
+
+```ts
+import { OpenAPI } from '@stableflow/core';
+
+OpenAPI.TOKEN = 'your-jwt-token';
+```
+
+## RPC configuration (optional)
+
+Override or extend chain RPC URLs when the built-in defaults are insufficient:
+
+```ts
+import { setRpcUrls } from '@stableflow/core';
+
+setRpcUrls({
+  eth: ['https://your-eth-rpc.example.com'],
+  arb: ['https://your-arb-rpc.example.com'],
+});
+```
+
+## See also
+
+- [Developer Guide](../../DEVELOPER_GUIDE.md)
+- [@stableflow/bridges](../bridges/README.md)