@aegis-engine/core 0.1.1 → 0.1.2

package/README.md

@@ -99,6 +99,68 @@ For production integrations, prefer passing your own viem `PublicClient` backed
 by your RPC provider. `createSwapPublicClient` is a convenience fallback for
 simple integrations and demos.
 
+## Backend V1 API
+
+The V1 backend/indexer contract is exposed as typed REST helpers. This is the
+public boundary for widget/core integrations once the backend service is live:
+AppSync, DynamoDB, indexer reads, provider adapters, quote storage, route hashes,
+allowlists, and final simulation stay behind the backend.
+
+```ts
+import { createAegisBackendApiClient } from '@aegis-engine/core'
+
+const aegisApi = createAegisBackendApiClient({
+  baseUrl: 'https://api.aegis.markets'
+})
+
+const config = await aegisApi.config()
+const tokens = await aegisApi.tokens({ chainId: 1 })
+const markets = await aegisApi.markets({ chainId: 1 })
+
+const quote = await aegisApi.quote({
+  chainId: 1,
+  provider: 'aegis-direct-v4',
+  marketId: 'WATER_USDC',
+  mode: 'exactIn',
+  tokenIn: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
+  tokenOut: '0x828B22c9ea1c20B551EeFC6198174C4bb7a8CBF6',
+  amountIn: '1000000',
+  slippageBps: config.quote.defaultSlippageBps,
+  account
+})
+
+const build = await aegisApi.build({
+  quoteId: quote.quoteId,
+  account,
+  recipient: account
+})
+```
+
+The backend endpoints are:
+
+- `GET /v1/health`
+- `GET /v1/config`
+- `GET /v1/tokens?chainId=1`
+- `GET /v1/tokens/by-address?chainId=1&addresses=0x...,0x...`
+- `GET /v1/markets?chainId=1`
+- `POST /v1/swap/quote`
+- `POST /v1/swap/build`
+- `GET /v1/status/tx/:chainId/:txHash`
+
+`quote` returns a short-lived `quoteId`, `quoteHash`, `routeHash`, expiry, gas,
+approval, and normalized fee data. `build` accepts only `quoteId`, `account`,
+`recipient`, and an optional Permit2 signature; token amounts, slippage, provider
+route data, router addresses, and spender addresses are not accepted in the
+build request. The backend must reject expired or tampered quotes, validate the
+chain/router/spender/pool allowlists, and simulate the unsigned transaction
+before returning wallet-ready `tx` data.
+
+Core still includes direct-pool and Kyber client-side helpers for the current
+widget flow. Those helpers are transitional for swap execution: once the backend
+service is available, production widget paths should fetch config, tokens,
+markets, quotes, builds, and transaction status through this REST client while
+wallet signing and transaction sending remain client-side.
+
 ## Direct Pool Market Config
 
 The direct pool operations take an `AegisSwapMarket`. Hosts can build one from

package/dist/actions/allowance.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Polls an ERC-20 allowance read until it covers `minimum`, then asserts it did.
+ * Shared by the direct-pool and KyberSwap approval flows after they submit an
+ * approval transaction: a confirmed approval whose allowance is still short means
+ * the wallet approved a smaller amount, so the swap must not proceed.
+ */
+export declare function confirmAllowanceReached(read: () => Promise<bigint>, minimum: bigint): Promise<bigint>;