@circle-fin/app-kit 1.6.0 → 1.7.0
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/CHANGELOG.md +16 -0
- package/README.md +6 -4
- package/earn.cjs +970 -172
- package/earn.mjs +970 -172
- package/index.cjs +739 -272
- package/index.d.ts +339 -5
- package/index.mjs +739 -272
- package/package.json +6 -6
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# @circle-fin/app-kit
|
|
2
2
|
|
|
3
|
+
## 1.7.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- EarnKit (exposed under `kit.earn`) now emits step-level events for multi-phase operations (`deposit`, `withdraw`, `claimRewards`) via `kit.earn.on()` / `kit.earn.off()`, and exposes `kit.earn.retry(error)` to resume an operation that failed after a prior phase (such as a token approval) already succeeded. Failed earn operations now throw a `KitError` carrying step progress and resume context, and `isRetryableError` recognizes `RESUMABLE` errors as retryable.
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- `kit.bridge` and `kit.unifiedBalance` operations (`deposit`, `depositFor`, `addDelegate`, `removeDelegate`, `initiateRemoveFund`, `removeFund`) no longer reject Gas Station-enabled smart-contract accounts (SCAs) with zero native balance. EOA wallets without native funds will still fail at simulation with the underlying RPC error.
|
|
12
|
+
|
|
13
|
+
## 1.6.1
|
|
14
|
+
|
|
15
|
+
### Patch Changes
|
|
16
|
+
|
|
17
|
+
- Add a "coming soon" disclosure to the Earn Kit product entry in the README, and replace placeholder vault addresses with the mock testnet vault address (`0xAabbeF1D3971c710276ed41eC791BbE14CdB8E88`) in all examples.
|
|
18
|
+
|
|
3
19
|
## 1.6.0
|
|
4
20
|
|
|
5
21
|
### Minor Changes
|
package/README.md
CHANGED
|
@@ -340,6 +340,8 @@ For the full Unified Balance API, see the [`@circle-fin/unified-balance-kit` REA
|
|
|
340
340
|
|
|
341
341
|
### 🏦 Earn
|
|
342
342
|
|
|
343
|
+
> **Note:** Earn Kit is coming soon. The APIs documented here are published for early integration and feedback; vault availability and production readiness will be announced ahead of general availability.
|
|
344
|
+
|
|
343
345
|
Deposit into and withdraw from DeFi lending vaults, claim rewards, and query positions:
|
|
344
346
|
|
|
345
347
|
```typescript
|
|
@@ -354,27 +356,27 @@ const adapter = createViemAdapterFromPrivateKey({
|
|
|
354
356
|
// Preview a deposit
|
|
355
357
|
const quote = await kit.earn.getDepositQuote({
|
|
356
358
|
from: { adapter, chain: EarnChain.Arc_Testnet },
|
|
357
|
-
vaultAddress: '
|
|
359
|
+
vaultAddress: '0xAabbeF1D3971c710276ed41eC791BbE14CdB8E88',
|
|
358
360
|
amount: '100.50',
|
|
359
361
|
})
|
|
360
362
|
|
|
361
363
|
// Execute the deposit
|
|
362
364
|
await kit.earn.deposit({
|
|
363
365
|
from: { adapter, chain: EarnChain.Arc_Testnet },
|
|
364
|
-
vaultAddress: '
|
|
366
|
+
vaultAddress: '0xAabbeF1D3971c710276ed41eC791BbE14CdB8E88',
|
|
365
367
|
amount: '100.50',
|
|
366
368
|
})
|
|
367
369
|
|
|
368
370
|
// Query a vault position
|
|
369
371
|
const position = await kit.earn.getPosition({
|
|
370
372
|
from: { adapter, chain: EarnChain.Arc_Testnet },
|
|
371
|
-
vaultAddress: '
|
|
373
|
+
vaultAddress: '0xAabbeF1D3971c710276ed41eC791BbE14CdB8E88',
|
|
372
374
|
})
|
|
373
375
|
|
|
374
376
|
// Claim accrued rewards
|
|
375
377
|
await kit.earn.claimRewards({
|
|
376
378
|
from: { adapter, chain: EarnChain.Arc_Testnet },
|
|
377
|
-
vaultAddress: '
|
|
379
|
+
vaultAddress: '0xAabbeF1D3971c710276ed41eC791BbE14CdB8E88',
|
|
378
380
|
})
|
|
379
381
|
```
|
|
380
382
|
|