@owney/sdk 0.6.0-beta.0 → 0.6.0-beta.1

package/README.md

@@ -1,6 +1,6 @@
 # @owney/sdk
 
-A TypeScript SDK for interacting with DeFi yield agents. Supports multiple agent backends (Zyfai, Sail) through a unified interface.
+A TypeScript SDK for interacting with DeFi yield agents. Supports multiple agents through a unified interface.
 
 ## Installation
 
@@ -117,7 +117,7 @@ Activate the user's smart wallet for the specified agents, or all chain-compatib
 
 ```typescript
 // Activate specific agents on Base
-await sdk.activateAgent(8453, ["zyfai", "sail"]);
+await sdk.activateAgent(8453, ["zyfai"]);
 
 // Activate all agents that support Arbitrum
 await sdk.activateAgent(42161);
@@ -159,8 +159,7 @@ const results = await sdk.deposit({
     return await transferTokens(smartWallet, amount);
   },
 });
-console.log(results.agentResults.zyfai.amount); // "50000000"
-console.log(results.agentResults.sail.amount); // "50000000"
+console.log(results.agentResults.zyfai.amount); // "100000000"
 ```
 
 ### `withdraw(options)`
@@ -199,15 +198,13 @@ console.log(result.type); // "partial"
 console.log(result.amount); // "50000000"
 
 // Partial withdrawal split proportionally across all agents
-// e.g. zyfai=$5, sail=$2, amount=$4 → zyfai withdraws $3, sail withdraws $1
+// e.g. zyfai=$5, amount=$4 -> zyfai withdraws $4
 const split = await sdk.withdraw({ asset: "USDC", amount: "4000000" });
-console.log(split.agentResult.zyfai.amount); // "3000000"
-console.log(split.agentResult.sail.amount); // "1000000"
+console.log(split.agentResult.zyfai.amount); // "4000000"
 
 // Full withdrawal from all agents
 const results = await sdk.withdraw({ asset: "USDC" });
 console.log(results.agentResult.zyfai.type); // "full"
-console.log(results.agentResult.sail.type); // "full"
 ```
 
 ### `getBalances(agentId?)`
@@ -216,7 +213,7 @@ Get the user's balances for a specific agent, or aggregated across all agents.
 
 | Param     | Type                           | Description                          |
 | --------- | ------------------------------ | ------------------------------------ |
-| `agentId` | `"zyfai" \| "sail"` (optional) | Agent to query. Omit for all agents. |
+| `agentId` | `"zyfai"` (optional)          | Agent to query. Omit for all agents. |
 
 Returns: `AgentBalance` (single agent) or `OwneyBalances` (all agents)
 
@@ -229,9 +226,8 @@ console.log(balance.tokens); // [{ chain: "BASE", chainId: 8453, asset: "USDC",
 
 // All agents
 const allBalances = await sdk.getBalances();
-console.log(allBalances.totalBalance); // "300.50"
+console.log(allBalances.totalBalance); // "150.25"
 console.log(allBalances.agentBalances.zyfai.totalBalance); // "150.25"
-console.log(allBalances.agentBalances.sail.totalBalance); // "150.25"
 ```
 
 ### `getEarnings(agentId?)`
@@ -240,7 +236,7 @@ Get the user's on-chain earnings for a specific agent, or aggregated across all
 
 | Param     | Type                           | Description                          |
 | --------- | ------------------------------ | ------------------------------------ |
-| `agentId` | `"zyfai" \| "sail"` (optional) | Agent to query. Omit for all agents. |
+| `agentId` | `"zyfai"` (optional)          | Agent to query. Omit for all agents. |
 
 Returns: `AgentEarnings` (single agent) or `OwneyEarnings` (all agents)
 
@@ -268,7 +264,7 @@ Get the weighted APY for the user's account. When querying all agents, the total
 
 | Param     | Type                           | Description                                      |
 | --------- | ------------------------------ | ------------------------------------------------ |
-| `agentId` | `"zyfai" \| "sail"` (optional) | Agent to query. Omit for balance-weighted total. |
+| `agentId` | `"zyfai"` (optional)          | Agent to query. Omit for balance-weighted total. |
 | `days`    | `"7D" \| "14D" \| "30D"`       | Lookback period                                  |
 
 Returns: `AccountAgentApy` (single agent) or `OwneyAccountApy` (all agents)
@@ -287,7 +283,6 @@ console.log(apy.apyByChainAndAsset?.[8453]?.USDC); // 5.4
 const allApy = await sdk.getAccountApy({ days: "30D" });
 console.log(allApy.totalApy); // "5.6"
 console.log(allApy.agentApy.zyfai.weightedApyAfterFee); // 6.0
-console.log(allApy.agentApy.sail.weightedApyAfterFee); // 4.0
 // Per (chain, asset), balance-weighted across all agents.
 // Cells with 0/missing APY for a given agent are excluded from that cell.
 console.log(allApy.apyByChainAndAsset[8453]?.USDC); // 5.3
@@ -304,7 +299,7 @@ Results are **cursor-paginated**. The first call (no `cursor`) anchors a stable
 
 | Param              | Type                           | Description                                              |
 | ------------------ | ------------------------------ | -------------------------------------------------------- |
-| `agentId`          | `"zyfai" \| "sail"` (optional) | Agent to query. Omit for all agents.                     |
+| `agentId`          | `"zyfai"` (optional)          | Agent to query. Omit for all agents.                     |
 | `filters.fromDate` | `string` (optional)            | Start date (`YYYY-MM-DD`)                                |
 | `filters.toDate`   | `string` (optional)            | End date (`YYYY-MM-DD`)                                  |
 | `filters.limit`    | `number` (optional)            | Max entries returned per call. Defaults to `10`.         |
@@ -336,7 +331,7 @@ console.log(history.data[0].rebalanceLog[0].status); // "success"
 // All agents (merged and sorted by date)
 const allHistory = await sdk.getHistory();
 console.log(allHistory.hasMore); // true | false
-console.log(allHistory.data[0].agent); // "sail" (most recent entry)
+console.log(allHistory.data[0].agent); // "zyfai" (most recent entry)
 console.log(allHistory.data[0].action); // "Rebalance"
 
 // Paginate through all history (per-chain, anchored to a single snapshot)
@@ -351,44 +346,13 @@ do {
 } while (cursor);
 ```
 
-### `pauseAgent(agentId)`
-
-Pause an agent's automated operations. The agent will stop rebalancing until resumed.
-
-| Param     | Type                | Description    |
-| --------- | ------------------- | -------------- |
-| `agentId` | `"zyfai" \| "sail"` | Agent to pause |
-
-Returns: `OwneyAgentStatus`
-
-```typescript
-const status = await sdk.pauseAgent("zyfai");
-console.log(status.success); // true
-```
-
-### `resumeAgent(agentId)`
-
-Resume an agent's automated operations.
-
-| Param     | Type                | Description     |
-| --------- | ------------------- | --------------- |
-| `agentId` | `"zyfai" \| "sail"` | Agent to resume |
-
-Returns: `OwneyAgentStatus`
-
-```typescript
-const status = await sdk.resumeAgent("zyfai");
-console.log(status.success); // true
-console.log(status.protocols); // ["aave", "compound"]
-```
-
 ### `getUserProfile(agentId?)`
 
 Get the user's profile for a specific agent, or all agents.
 
 | Param     | Type                           | Description                          |
 | --------- | ------------------------------ | ------------------------------------ |
-| `agentId` | `"zyfai" \| "sail"` (optional) | Agent to query. Omit for all agents. |
+| `agentId` | `"zyfai"` (optional)          | Agent to query. Omit for all agents. |
 
 Returns: `AgentUserProfile` (single agent) or `OwneyUserProfile` (all agents)
 
@@ -404,7 +368,6 @@ console.log(profile.protocols); // ["aave", "compound"]
 // All agents
 const allProfiles = await sdk.getUserProfile();
 console.log(allProfiles.agentUserProfile.zyfai.smartWallet); // "0x..."
-console.log(allProfiles.agentUserProfile.sail.smartWallet); // "0x..."
 ```
 
 ### `getAgentApy({ agentId?, days, tokenSymbol?, chainId? })`
@@ -413,14 +376,14 @@ Get the agent's average APY performance over a time period. Does not require a w
 
 | Param         | Type                           | Description                                                                                                                                                                                    |
 | ------------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `agentId`     | `"zyfai" \| "sail"` (optional) | Agent to query. Omit for all agents.                                                                                                                                                           |
+| `agentId`     | `"zyfai"` (optional)          | Agent to query. Omit for all agents.                                                                                                                                                           |
 | `days`        | `"7D" \| "14D" \| "30D"`       | Lookback period                                                                                                                                                                                |
-| `tokenSymbol` | `string` (optional)            | Asset symbol (e.g. `"USDC"`, `"WETH"`). Scopes the upstream request to a specific asset when the agent's backend supports it. Zyfai forwards this; Sail currently ignores it at the API level. |
-| `chainId`     | `number` (optional)            | Chain id. Typically paired with `tokenSymbol` for per-asset+chain APY. Zyfai forwards this; Sail currently ignores it at the API level.                                                        |
+| `tokenSymbol` | `string` (optional)            | Asset symbol (e.g. `"USDC"`). Scopes the upstream request to a specific asset when the agent's backend supports it.                                                                      |
+| `chainId`     | `number` (optional)            | Chain id. Typically paired with `tokenSymbol` for per-asset+chain APY.                                                                       |
 
 Returns: `AgentApy` (single agent) or `OwneyAgentApy` (all agents)
 
-Both agents populate `detailedApys.apyPerAsset` with a per-chain, per-token
+ The agent populates `detailedApys.apyPerAsset` with a per-chain, per-token
 breakdown when available. `tokenSymbol` / `chainId` only affect whether the
 upstream query is scoped — the breakdown is built from whatever the agent
 returns.
@@ -434,10 +397,8 @@ console.log(apy.detailedApys?.apyPerAsset[8453]?.USDC); // 8.7
 // All agents
 const allApy = await sdk.getAgentApy({ days: "30D" });
 console.log(allApy.agentApy.zyfai.averageApy); // 8.5
-console.log(allApy.agentApy.sail.averageApy); // 6.2
-console.log(allApy.agentApy.sail.detailedApys?.apyPerAsset[42161]?.USDT); // 6.4
 
-// Scope the upstream query to USDC on Base (Zyfai-aware; Sail ignores the filter)
+// Scope the upstream query to USDC on Base
 const usdcBaseApy = await sdk.getAgentApy({
   days: "30D",
   tokenSymbol: "USDC",
@@ -454,7 +415,7 @@ Returns: `OwneyAgentAllocation`
 
 ```typescript
 const allocation = await sdk.getAgentAllocation();
-console.log(allocation.agentAllocation); // { zyfai: 75, sail: 25 }
+console.log(allocation.agentAllocation); // { zyfai: 100 }
 ```
 
 ## Types
@@ -462,7 +423,7 @@ console.log(allocation.agentAllocation); // { zyfai: 75, sail: 25 }
 ### Configuration
 
 ```typescript
-type AgentId = "zyfai" | "sail";
+type AgentId = "zyfai";
 type Asset = string;
 type DailyApyDays = "7D" | "14D" | "30D";
 type OwneySupportedChainId = 8453 | 42161;
@@ -639,12 +600,6 @@ interface OwneyAgentHistory {
   nextCursor?: string;
 }
 
-interface OwneyAgentStatus {
-  success: boolean;
-  strategy?: string;
-  protocols?: string[];
-}
-
 interface AgentUserProfile {
   address: string;
   smartWallet: string;
@@ -738,7 +693,7 @@ type OwneyErrorCode =
   | "ASSET_NO_COMPATIBLE_AGENTS" // No agents support the asset on the active chain
   // Deposit
   | "DEPOSIT_AMOUNT_BELOW_MINIMUM" // Amount below an agent's required minimum deposit for the chain+asset
-  | "DEPOSIT_CALLBACK_REQUIRED" // Sail agent requires a depositCallback
+  | "DEPOSIT_CALLBACK_REQUIRED" // Agent requires a depositCallback
   | "DEPOSIT_CALLBACK_INVALID" // depositCallback didn't return a tx hash
   | "DEPOSIT_NO_PERMITTED_TOKENS" // No permitted tokens available for deposit
   // Withdraw
@@ -750,8 +705,6 @@ type OwneyErrorCode =
   // API
   | "API_ROUTING_ERROR" // Routing API returned a non-OK HTTP status
   | "API_ROUTING_FAILED" // Routing API returned { success: false }
-  | "API_SAIL_ERROR" // Sail API returned a non-OK HTTP status
-  | "API_SAIL_TIMEOUT" // Sail API request timed out
   | "API_NO_AGENTS" // No supported agents returned by routing API
   // Aggregation
   | "BALANCE_ALL_FAILED" // All agents failed to return balances