@owney/sdk 0.7.25-beta.4 → 0.7.26-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -9
- package/dist/index.cjs +1500 -2513
- package/dist/index.d.cts +415 -146
- package/dist/index.d.ts +415 -146
- package/dist/index.js +1492 -2520
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -19,7 +19,7 @@ const sdk = new OwneySDK({ apiKey: "your-owney-api-key" });
|
|
|
19
19
|
// Connect with an EIP-1193 wallet provider
|
|
20
20
|
await sdk.connect(provider);
|
|
21
21
|
|
|
22
|
-
// Activate agents on Base (
|
|
22
|
+
// Activate agents on Base (fetches agent keys on first call)
|
|
23
23
|
await sdk.activateAgent(8453);
|
|
24
24
|
|
|
25
25
|
// Get balances across all agents
|
|
@@ -32,10 +32,10 @@ const balances = await sdk.getBalances();
|
|
|
32
32
|
|
|
33
33
|
Create a new SDK instance.
|
|
34
34
|
|
|
35
|
-
| Param
|
|
36
|
-
|
|
|
37
|
-
| `config.apiKey`
|
|
38
|
-
| `config.zyfaiRpcUrls`
|
|
35
|
+
| Param | Type | Description |
|
|
36
|
+
| --------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
|
37
|
+
| `config.apiKey` | `string` | Your Owney API key, used to authenticate with the routing API and fetch agent-specific keys |
|
|
38
|
+
| `config.zyfaiRpcUrls` | `{ 8453?: string; 42161?: string }` (optional) | Per-chain RPC URL overrides used by Zyfai SDK network calls |
|
|
39
39
|
|
|
40
40
|
```typescript
|
|
41
41
|
import { OwneySDK } from "@owney/sdk";
|
|
@@ -108,7 +108,7 @@ if (chainId) {
|
|
|
108
108
|
|
|
109
109
|
### `activateAgent(chainId, agentId?)`
|
|
110
110
|
|
|
111
|
-
Activate the user's smart wallet for the specified agents, or all chain-compatible agents if omitted.
|
|
111
|
+
Activate the user's smart wallet for the specified agents, or all chain-compatible agents if omitted. Smart wallets are pre-deployed by the underlying providers, so activation only performs authentication and profile syncing — no deploy or session-key signatures. Saves the chainId for use by all subsequent SDK calls.
|
|
112
112
|
|
|
113
113
|
| Param | Type | Description |
|
|
114
114
|
| --------- | ---------------------- | ----------------------------------------------------------------------------- |
|
|
@@ -125,7 +125,7 @@ await sdk.activateAgent(42161);
|
|
|
125
125
|
|
|
126
126
|
### `deposit(options)`
|
|
127
127
|
|
|
128
|
-
Deposit funds into a specific agent, or split equally across all agents if `agentId` is omitted. Validates that the asset is supported by the target agent(s) on the active chain, and per-agent minimum deposit amounts (defined per chain+asset on `agent.supportedAssets[].assets[].minDepositAmount`) are taken into account.
|
|
128
|
+
Deposit funds into a specific agent, or split equally across all agents if `agentId` is omitted. Validates that the asset is supported by the target agent(s) on the active chain, and per-agent minimum deposit amounts (defined per chain+asset on `agent.supportedAssets[].assets[].minDepositAmount`) are taken into account. When splitting across agents, `depositCallback` is invoked once per final valid agent with that agent's split amount and smart wallet address — expect multiple wallet prompts.
|
|
129
129
|
|
|
130
130
|
| Param | Type | Description |
|
|
131
131
|
| ------------------------- | -------------------- | --------------------------------------------------------------- |
|
|
@@ -572,14 +572,12 @@ interface AccountAgentApy {
|
|
|
572
572
|
weightedApyAfterFee?: number;
|
|
573
573
|
weightedApyAfterFeeDetails?: AgentApyDetails;
|
|
574
574
|
apyByChainAndAsset?: ApyByChainAndAsset;
|
|
575
|
-
history?: ApyHistoryPoint[];
|
|
576
575
|
}
|
|
577
576
|
|
|
578
577
|
interface OwneyAccountApy {
|
|
579
578
|
totalApy: string;
|
|
580
579
|
agentApy: Record<AgentId, AccountAgentApy>;
|
|
581
580
|
apyByChainAndAsset: ApyByChainAndAsset;
|
|
582
|
-
history?: ApyHistoryPoint[]; // balance-weighted aggregate daily series
|
|
583
581
|
}
|
|
584
582
|
|
|
585
583
|
type HistoryAction = "Rebalance" | "Deposit" | "Top up" | "Withdraw" | "Earned";
|