@aave/client 4.0.0-next.2 → 4.0.0-next.21
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 +6 -3
- package/dist/{AaveClient-L3v8kWvn.d.cts → AaveClient-BIfAdE-4.d.cts} +2 -1
- package/dist/{AaveClient-CgHY2iS9.d.ts → AaveClient-C36zcfbL.d.ts} +2 -1
- package/dist/actions/index.cjs +1 -1
- package/dist/actions/index.cjs.map +1 -1
- package/dist/actions/index.d.cts +228 -135
- package/dist/actions/index.d.ts +228 -135
- package/dist/actions/index.js +1 -1
- package/dist/chunk-3HZQC3YV.js +3 -0
- package/dist/chunk-3HZQC3YV.js.map +1 -0
- package/dist/chunk-MKZBFAXA.js +2 -0
- package/dist/chunk-MKZBFAXA.js.map +1 -0
- package/dist/ethers.cjs +1 -1
- package/dist/ethers.cjs.map +1 -1
- package/dist/ethers.d.cts +5 -7
- package/dist/ethers.d.ts +5 -7
- package/dist/ethers.js +1 -1
- package/dist/ethers.js.map +1 -1
- package/dist/index.cjs +2 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/dist/{options-vB2peXdE.d.cts → options-BX6n3sbh.d.cts} +17 -1
- package/dist/{options-vB2peXdE.d.ts → options-BX6n3sbh.d.ts} +17 -1
- package/dist/privy.cjs +2 -2
- package/dist/privy.cjs.map +1 -1
- package/dist/privy.d.cts +3 -5
- package/dist/privy.d.ts +3 -5
- package/dist/privy.js +1 -1
- package/dist/privy.js.map +1 -1
- package/dist/testing.d.ts +3840 -0
- package/dist/testing.js +546 -0
- package/dist/testing.js.map +1 -0
- package/dist/thirdweb.cjs +1 -2
- package/dist/thirdweb.cjs.map +1 -1
- package/dist/thirdweb.d.cts +15 -11
- package/dist/thirdweb.d.ts +15 -11
- package/dist/thirdweb.js +1 -2
- package/dist/thirdweb.js.map +1 -1
- package/dist/{types-Bu63z0x6.d.cts → types-CQvue0x0.d.cts} +4 -4
- package/dist/{types-Bu63z0x6.d.ts → types-CQvue0x0.d.ts} +4 -4
- package/dist/viem.cjs +2 -2
- package/dist/viem.cjs.map +1 -1
- package/dist/viem.d.cts +23 -10
- package/dist/viem.d.ts +23 -10
- package/dist/viem.js +1 -1
- package/package.json +11 -12
- package/dist/chunk-2TNQ52OQ.js +0 -3
- package/dist/chunk-2TNQ52OQ.js.map +0 -1
- package/dist/chunk-BQFM5RT3.js +0 -2
- package/dist/chunk-BQFM5RT3.js.map +0 -1
- package/dist/chunk-BQNVAUS6.js +0 -3
- package/dist/chunk-BQNVAUS6.js.map +0 -1
- package/dist/test-utils.cjs +0 -3
- package/dist/test-utils.cjs.map +0 -1
- package/dist/test-utils.d.cts +0 -49
- package/dist/test-utils.d.ts +0 -49
- package/dist/test-utils.js +0 -3
- package/dist/test-utils.js.map +0 -1
package/dist/actions/index.d.cts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
import { UnexpectedError, TimeoutError } from '@aave/core';
|
|
2
|
-
import { HubRequest, Hub, HubsRequest, HubAssetsRequest, HubAsset, ChainRequest, Chain,
|
|
1
|
+
import { UnexpectedError, ValidationError, TimeoutError } from '@aave/core';
|
|
2
|
+
import { HubRequest, Hub, HubsRequest, HubAssetsRequest, HubAsset, HubSummaryHistoryRequest, HubSummarySample, ChainRequest, Chain, ChainsRequest, HasProcessedKnownTransactionRequest, ExchangeRateRequest, ExchangeAmount, PermitRequest, PermitTypedDataResponse, AssetRequest, Asset, AssetPriceHistoryRequest, AssetPriceSample, AssetSupplyHistoryRequest, AssetSupplySample, AssetBorrowHistoryRequest, AssetBorrowSample, ProtocolHistoryRequest, ProtocolHistorySample, ReserveRequest, Reserve, ReservesRequest, BorrowApyHistoryRequest, ApySample, SupplyApyHistoryRequest, SpokeRequest, Spoke, SpokesRequest, SpokePositionManagersRequest, PaginatedSpokePositionManagerResult, SpokeUserPositionManagersRequest, PaginatedSpokeUserPositionManagerResult, TokenSwapQuoteRequest, TokenSwapQuoteResult, SwappableTokensRequest, Token, PrepareTokenSwapRequest, PrepareSwapOrder, InsufficientBalanceError, SupplySwapQuoteRequest, PositionSwapByIntentApprovalsRequired, BorrowSwapQuoteRequest, RepayWithSupplyQuoteRequest, WithdrawSwapQuoteRequest, PreparePositionSwapRequest, SwapStatusRequest, SwapStatus, SwapCancelled, SwapExpired, SwapFulfilled, SwapReceipt, SwapRequest, SwapTransactionRequest, PrepareSwapCancelRequest, PrepareSwapCancelResult, CancelSwapRequest, CancelSwapExecutionPlan, UserSwapsRequest, PaginatedUserSwapsResult, BorrowRequest, ExecutionPlan, SupplyRequest, RepayRequest, WithdrawRequest, RenounceSpokeUserPositionManagerRequest, TransactionRequest, UpdateUserPositionConditionsRequest, LiquidatePositionRequest, SetSpokeUserPositionManagerRequest, PreviewRequest, PreviewUserPosition, SetUserSuppliesAsCollateralRequest, ActivitiesRequest, PaginatedActivitiesResult, UserSuppliesRequest, UserSupplyItem, UserBorrowsRequest, UserBorrowItem, UserSummaryRequest, UserSummary, UserPositionsRequest, UserPosition, UserPositionRequest, UserBalancesRequest, UserBalance, UserSummaryHistoryRequest, UserSummaryHistoryItem, UserRiskPremiumBreakdownRequest, UserRiskPremiumBreakdownItem } from '@aave/graphql';
|
|
3
3
|
import { ResultAsync, Prettify } from '@aave/types';
|
|
4
|
-
import { A as AaveClient } from '../AaveClient-
|
|
5
|
-
import { C as CurrencyQueryOptions, R as RequestPolicyOptions,
|
|
4
|
+
import { A as AaveClient } from '../AaveClient-BIfAdE-4.cjs';
|
|
5
|
+
import { C as CurrencyQueryOptions, T as TimeWindowQueryOptions, R as RequestPolicyOptions, B as BatchOptions } from '../options-BX6n3sbh.cjs';
|
|
6
6
|
import '@urql/core';
|
|
7
|
-
import '../types-
|
|
7
|
+
import '../types-CQvue0x0.cjs';
|
|
8
8
|
|
|
9
9
|
/**
|
|
10
10
|
* Fetches a specific hub by ID or by address and chain ID.
|
|
@@ -20,7 +20,7 @@ import '../types-Bu63z0x6.cjs';
|
|
|
20
20
|
* @param options - The query options.
|
|
21
21
|
* @returns The hub data, or null if not found.
|
|
22
22
|
*/
|
|
23
|
-
declare function hub(client: AaveClient, request: HubRequest, options?: CurrencyQueryOptions & RequestPolicyOptions): ResultAsync<Hub | null, UnexpectedError>;
|
|
23
|
+
declare function hub(client: AaveClient, request: HubRequest, options?: CurrencyQueryOptions & TimeWindowQueryOptions & RequestPolicyOptions): ResultAsync<Hub | null, UnexpectedError>;
|
|
24
24
|
/**
|
|
25
25
|
* Fetches multiple hubs based on specified criteria.
|
|
26
26
|
*
|
|
@@ -37,7 +37,7 @@ declare function hub(client: AaveClient, request: HubRequest, options?: Currency
|
|
|
37
37
|
* @param options - The query options.
|
|
38
38
|
* @returns Array of hub data.
|
|
39
39
|
*/
|
|
40
|
-
declare function hubs(client: AaveClient, request: HubsRequest,
|
|
40
|
+
declare function hubs(client: AaveClient, request: HubsRequest, { currency, timeWindow, }?: CurrencyQueryOptions & TimeWindowQueryOptions): ResultAsync<Hub[], UnexpectedError>;
|
|
41
41
|
/**
|
|
42
42
|
* Fetches hub assets for a specific hub by ID or by address and chain ID.
|
|
43
43
|
*
|
|
@@ -52,7 +52,23 @@ declare function hubs(client: AaveClient, request: HubsRequest, options?: Requir
|
|
|
52
52
|
* @param options - The query options.
|
|
53
53
|
* @returns The hub assets array.
|
|
54
54
|
*/
|
|
55
|
-
declare function hubAssets(client: AaveClient, request: HubAssetsRequest,
|
|
55
|
+
declare function hubAssets(client: AaveClient, request: HubAssetsRequest, { currency, timeWindow, }?: CurrencyQueryOptions & TimeWindowQueryOptions): ResultAsync<HubAsset[], UnexpectedError>;
|
|
56
|
+
/**
|
|
57
|
+
* Fetches historical summary data for a specific hub.
|
|
58
|
+
*
|
|
59
|
+
* ```ts
|
|
60
|
+
* const result = await hubSummaryHistory(client, {
|
|
61
|
+
* query: { hubId: hubId('SGVsbG8h') },
|
|
62
|
+
* currency: Currency.Usd,
|
|
63
|
+
* window: TimeWindow.LastWeek,
|
|
64
|
+
* });
|
|
65
|
+
* ```
|
|
66
|
+
*
|
|
67
|
+
* @param client - Aave client.
|
|
68
|
+
* @param request - The hub summary history request parameters.
|
|
69
|
+
* @returns Array of hub summary samples over time.
|
|
70
|
+
*/
|
|
71
|
+
declare function hubSummaryHistory(client: AaveClient, request: HubSummaryHistoryRequest): ResultAsync<HubSummarySample[], UnexpectedError>;
|
|
56
72
|
|
|
57
73
|
/**
|
|
58
74
|
* Fetches a specific chain by chain ID.
|
|
@@ -68,18 +84,30 @@ declare function hubAssets(client: AaveClient, request: HubAssetsRequest, option
|
|
|
68
84
|
* @returns The chain data, or null if not found.
|
|
69
85
|
*/
|
|
70
86
|
declare function chain(client: AaveClient, request: ChainRequest): ResultAsync<Chain | null, UnexpectedError>;
|
|
87
|
+
/**
|
|
88
|
+
* @internal
|
|
89
|
+
*/
|
|
90
|
+
declare function chain(client: AaveClient, request: ChainRequest, options: BatchOptions): ResultAsync<Chain | null, UnexpectedError>;
|
|
71
91
|
/**
|
|
72
92
|
* Fetches the list of supported chains.
|
|
73
93
|
*
|
|
74
94
|
* ```ts
|
|
75
|
-
* const chains = await chains(client, {
|
|
95
|
+
* const chains = await chains(client, {
|
|
96
|
+
* query: { filter: ChainsFilter.ALL }
|
|
97
|
+
* });
|
|
98
|
+
* ```
|
|
99
|
+
*
|
|
100
|
+
* ```ts
|
|
101
|
+
* const chains = await chains(client, {
|
|
102
|
+
* query: { chainIds: [chainId(1), chainId(137)] }
|
|
103
|
+
* });
|
|
76
104
|
* ```
|
|
77
105
|
*
|
|
78
106
|
* @param client - Aave client.
|
|
79
|
-
* @param
|
|
107
|
+
* @param request - The chains request parameters.
|
|
80
108
|
* @returns Array of supported chains.
|
|
81
109
|
*/
|
|
82
|
-
declare function chains(client: AaveClient,
|
|
110
|
+
declare function chains(client: AaveClient, request: ChainsRequest): ResultAsync<Chain[], UnexpectedError>;
|
|
83
111
|
/**
|
|
84
112
|
* Check if a transaction has been processed by the Aave API.
|
|
85
113
|
*
|
|
@@ -102,7 +130,7 @@ declare function hasProcessedKnownTransaction(client: AaveClient, request: HasPr
|
|
|
102
130
|
* @param request - The exchange rate request parameters.
|
|
103
131
|
* @returns The exchange rate information as a fiat amount.
|
|
104
132
|
*/
|
|
105
|
-
declare function exchangeRate(client: AaveClient, request: ExchangeRateRequest): ResultAsync<
|
|
133
|
+
declare function exchangeRate(client: AaveClient, request: ExchangeRateRequest): ResultAsync<ExchangeAmount, UnexpectedError>;
|
|
106
134
|
|
|
107
135
|
/**
|
|
108
136
|
* Generates EIP-712 typed data for permit signatures.
|
|
@@ -140,13 +168,15 @@ declare function permitTypedData(client: AaveClient, request: PermitRequest): Re
|
|
|
140
168
|
* @param options - The query options including currency and time window.
|
|
141
169
|
* @returns The asset data, or null if not found.
|
|
142
170
|
*/
|
|
143
|
-
declare function asset(client: AaveClient, request: AssetRequest,
|
|
171
|
+
declare function asset(client: AaveClient, request: AssetRequest, { currency, timeWindow, requestPolicy, }?: CurrencyQueryOptions & TimeWindowQueryOptions & RequestPolicyOptions): ResultAsync<Asset | null, UnexpectedError>;
|
|
144
172
|
/**
|
|
145
173
|
* Fetches historical price data for a specific asset.
|
|
146
174
|
*
|
|
147
175
|
* ```ts
|
|
148
176
|
* const result = await assetPriceHistory(client, {
|
|
149
|
-
*
|
|
177
|
+
* query: {
|
|
178
|
+
* token: { chainId: chainId(1), address: evmAddress('0x123…') },
|
|
179
|
+
* },
|
|
150
180
|
* currency: Currency.Usd,
|
|
151
181
|
* window: TimeWindow.LastWeek,
|
|
152
182
|
* });
|
|
@@ -163,7 +193,9 @@ declare function assetPriceHistory(client: AaveClient, request: AssetPriceHistor
|
|
|
163
193
|
*
|
|
164
194
|
* ```ts
|
|
165
195
|
* const result = await assetSupplyHistory(client, {
|
|
166
|
-
*
|
|
196
|
+
* query: {
|
|
197
|
+
* token: { chainId: chainId(1), address: evmAddress('0x123…') },
|
|
198
|
+
* },
|
|
167
199
|
* window: TimeWindow.LastWeek,
|
|
168
200
|
* });
|
|
169
201
|
* ```
|
|
@@ -179,7 +211,9 @@ declare function assetSupplyHistory(client: AaveClient, request: AssetSupplyHist
|
|
|
179
211
|
*
|
|
180
212
|
* ```ts
|
|
181
213
|
* const result = await assetBorrowHistory(client, {
|
|
182
|
-
*
|
|
214
|
+
* query: {
|
|
215
|
+
* token: { chainId: chainId(1), address: evmAddress('0x123…') },
|
|
216
|
+
* },
|
|
183
217
|
* window: TimeWindow.LastWeek,
|
|
184
218
|
* });
|
|
185
219
|
* ```
|
|
@@ -190,6 +224,22 @@ declare function assetSupplyHistory(client: AaveClient, request: AssetSupplyHist
|
|
|
190
224
|
* @returns Array of asset borrow samples over time.
|
|
191
225
|
*/
|
|
192
226
|
declare function assetBorrowHistory(client: AaveClient, request: AssetBorrowHistoryRequest, options?: Required<RequestPolicyOptions>): ResultAsync<AssetBorrowSample[], UnexpectedError>;
|
|
227
|
+
/**
|
|
228
|
+
* Fetches historical protocol-wide data (deposits, borrows, earnings).
|
|
229
|
+
*
|
|
230
|
+
* ```ts
|
|
231
|
+
* const result = await protocolHistory(client, {
|
|
232
|
+
* currency: Currency.Usd,
|
|
233
|
+
* window: TimeWindow.LastWeek,
|
|
234
|
+
* });
|
|
235
|
+
* ```
|
|
236
|
+
*
|
|
237
|
+
* @param client - Aave client.
|
|
238
|
+
* @param request - The protocol history request parameters.
|
|
239
|
+
* @param options - The query options.
|
|
240
|
+
* @returns Array of protocol history samples over time.
|
|
241
|
+
*/
|
|
242
|
+
declare function protocolHistory(client: AaveClient, request: ProtocolHistoryRequest, options?: Required<RequestPolicyOptions>): ResultAsync<ProtocolHistorySample[], UnexpectedError>;
|
|
193
243
|
|
|
194
244
|
/**
|
|
195
245
|
* Fetches a specific reserve by reserve ID, spoke, and chain.
|
|
@@ -206,7 +256,7 @@ declare function assetBorrowHistory(client: AaveClient, request: AssetBorrowHist
|
|
|
206
256
|
* @param options - The query options.
|
|
207
257
|
* @returns The reserve data, or null if not found.
|
|
208
258
|
*/
|
|
209
|
-
declare function reserve(client: AaveClient, request: ReserveRequest,
|
|
259
|
+
declare function reserve(client: AaveClient, request: ReserveRequest, { currency, timeWindow, }?: CurrencyQueryOptions & TimeWindowQueryOptions): ResultAsync<Reserve | null, UnexpectedError>;
|
|
210
260
|
/**
|
|
211
261
|
* Fetches reserves based on specified criteria.
|
|
212
262
|
*
|
|
@@ -228,7 +278,7 @@ declare function reserve(client: AaveClient, request: ReserveRequest, options?:
|
|
|
228
278
|
* @param options - The query options.
|
|
229
279
|
* @returns Array of reserves matching the criteria.
|
|
230
280
|
*/
|
|
231
|
-
declare function reserves(client: AaveClient, request: ReservesRequest,
|
|
281
|
+
declare function reserves(client: AaveClient, request: ReservesRequest, { currency, timeWindow, }?: CurrencyQueryOptions & TimeWindowQueryOptions): ResultAsync<Reserve[], UnexpectedError>;
|
|
232
282
|
/**
|
|
233
283
|
* Fetches borrow APY history for a specific reserve over time.
|
|
234
284
|
*
|
|
@@ -243,7 +293,7 @@ declare function reserves(client: AaveClient, request: ReservesRequest, options?
|
|
|
243
293
|
* @param request - The borrow APY history request parameters.
|
|
244
294
|
* @returns The borrow APY history samples.
|
|
245
295
|
*/
|
|
246
|
-
declare function borrowApyHistory(client: AaveClient, request:
|
|
296
|
+
declare function borrowApyHistory(client: AaveClient, request: BorrowApyHistoryRequest): ResultAsync<ApySample[], UnexpectedError>;
|
|
247
297
|
/**
|
|
248
298
|
* Fetches supply APY history for a specific reserve over time.
|
|
249
299
|
*
|
|
@@ -258,7 +308,7 @@ declare function borrowApyHistory(client: AaveClient, request: BorrowAPYHistoryR
|
|
|
258
308
|
* @param request - The supply APY history request parameters.
|
|
259
309
|
* @returns The supply APY history samples.
|
|
260
310
|
*/
|
|
261
|
-
declare function supplyApyHistory(client: AaveClient, request:
|
|
311
|
+
declare function supplyApyHistory(client: AaveClient, request: SupplyApyHistoryRequest): ResultAsync<ApySample[], UnexpectedError>;
|
|
262
312
|
|
|
263
313
|
/**
|
|
264
314
|
* Fetches a specific spoke.
|
|
@@ -319,28 +369,28 @@ declare function spokePositionManagers(client: AaveClient, request: SpokePositio
|
|
|
319
369
|
declare function spokeUserPositionManagers(client: AaveClient, request: SpokeUserPositionManagersRequest): ResultAsync<PaginatedSpokeUserPositionManagerResult, UnexpectedError>;
|
|
320
370
|
|
|
321
371
|
/**
|
|
322
|
-
* @internal
|
|
323
372
|
* Fetches a swap quote for the specified trade parameters.
|
|
324
373
|
*
|
|
325
374
|
* ```ts
|
|
326
|
-
* const result = await
|
|
327
|
-
*
|
|
328
|
-
*
|
|
329
|
-
*
|
|
330
|
-
*
|
|
331
|
-
*
|
|
332
|
-
*
|
|
375
|
+
* const result = await tokenSwapQuote(client, {
|
|
376
|
+
* market: {
|
|
377
|
+
* chainId: chainId(1),
|
|
378
|
+
* buy: { erc20: evmAddress('0xA0b86a33E6...') },
|
|
379
|
+
* sell: { erc20: evmAddress('0x6B175474E...') },
|
|
380
|
+
* amount: bigDecimal('1000'),
|
|
381
|
+
* kind: SwapKind.Sell,
|
|
382
|
+
* user: evmAddress('0x742d35cc...'),
|
|
383
|
+
* },
|
|
333
384
|
* });
|
|
334
385
|
* ```
|
|
335
386
|
*
|
|
336
387
|
* @param client - Aave client.
|
|
337
388
|
* @param request - The swap quote request parameters.
|
|
338
389
|
* @param options - The query options.
|
|
339
|
-
* @returns The swap quote including pricing and cost information.
|
|
390
|
+
* @returns The swap quote including pricing and cost information and plan to start executing the swap.
|
|
340
391
|
*/
|
|
341
|
-
declare function
|
|
392
|
+
declare function tokenSwapQuote(client: AaveClient, request: TokenSwapQuoteRequest, options?: Required<CurrencyQueryOptions>): ResultAsync<TokenSwapQuoteResult, UnexpectedError>;
|
|
342
393
|
/**
|
|
343
|
-
* @internal
|
|
344
394
|
* Fetches the list of tokens available for swapping on a specific chain.
|
|
345
395
|
*
|
|
346
396
|
* ```ts
|
|
@@ -355,59 +405,121 @@ declare function swapQuote(client: AaveClient, request: SwapQuoteRequest, option
|
|
|
355
405
|
*/
|
|
356
406
|
declare function swappableTokens(client: AaveClient, request: SwappableTokensRequest): ResultAsync<Token[], UnexpectedError>;
|
|
357
407
|
/**
|
|
358
|
-
* @internal
|
|
359
408
|
* Prepares a swap for the specified trade parameters.
|
|
360
409
|
*
|
|
361
410
|
* ```ts
|
|
362
|
-
* const result = await
|
|
411
|
+
* const result = await prepareTokenSwap(client, {
|
|
412
|
+
* quoteId: quote.quoteId,
|
|
413
|
+
* }).andThen(order => {
|
|
414
|
+
* return signSwapTypedDataWith(wallet, order.data)
|
|
415
|
+
* .andThen((signature) =>
|
|
416
|
+
* swap({ intent: { quoteId: order.newQuoteId, signature } }),
|
|
417
|
+
* );
|
|
418
|
+
* });
|
|
419
|
+
* ```
|
|
420
|
+
*
|
|
421
|
+
* @param client - Aave client.
|
|
422
|
+
* @param request - The prepare swap request parameters.
|
|
423
|
+
* @returns The prepared swap result containing details of the swap.
|
|
424
|
+
*/
|
|
425
|
+
declare function prepareTokenSwap(client: AaveClient, request: PrepareTokenSwapRequest): ResultAsync<PrepareSwapOrder, ValidationError<InsufficientBalanceError> | UnexpectedError>;
|
|
426
|
+
/**
|
|
427
|
+
* Fetches a supply swap quote for swapping deposited funds.
|
|
428
|
+
*
|
|
429
|
+
* ```ts
|
|
430
|
+
* const result = await supplySwapQuote(client, {
|
|
363
431
|
* market: {
|
|
364
|
-
*
|
|
365
|
-
*
|
|
366
|
-
* sell: { erc20: evmAddress('0x6B175474E...') },
|
|
432
|
+
* sellPosition: userSupplyItemId('position_123'),
|
|
433
|
+
* buyReserve: reserveId('reserve_456'),
|
|
367
434
|
* amount: bigDecimal('1000'),
|
|
368
|
-
* kind: SwapKind.SELL,
|
|
369
435
|
* user: evmAddress('0x742d35cc...'),
|
|
370
436
|
* },
|
|
371
|
-
* }).andThen(plan => {
|
|
372
|
-
* switch (plan.__typename) {
|
|
373
|
-
* case 'SwapByIntent':
|
|
374
|
-
* return signSwapByIntentWith(plan.data)
|
|
375
|
-
* .andThen((signature) => swap({ intent: { quoteId: quote.quoteId, signature } }))
|
|
376
|
-
* .andThen((plan) => {
|
|
377
|
-
* // …
|
|
378
|
-
* });
|
|
379
|
-
* );
|
|
380
|
-
*
|
|
381
|
-
* case 'SwapByIntentWithApprovalRequired':
|
|
382
|
-
* return sendTransaction(plan.transaction)
|
|
383
|
-
* .andThen(signSwapByIntentWith(plan.data))
|
|
384
|
-
* .andThen((signature) => swap({ intent: { quoteId: quote.quoteId, signature } }))
|
|
385
|
-
* .andThen((plan) => {
|
|
386
|
-
* // …
|
|
387
|
-
* });
|
|
388
|
-
* );
|
|
389
|
-
*
|
|
390
|
-
* case 'SwapByTransaction':
|
|
391
|
-
* return swap({ transaction: { quoteId: quote.quoteId } })
|
|
392
|
-
* .andThen((plan) => {
|
|
393
|
-
* // …
|
|
394
|
-
* });
|
|
395
|
-
* );
|
|
396
|
-
*
|
|
397
|
-
* case 'InsufficientBalanceError':
|
|
398
|
-
* return errAsync(new Error(`Insufficient balance: ${plan.required.value} required.`));
|
|
399
|
-
* }
|
|
400
437
|
* });
|
|
401
438
|
* ```
|
|
402
439
|
*
|
|
403
440
|
* @param client - Aave client.
|
|
404
|
-
* @param request - The
|
|
441
|
+
* @param request - The supply swap request parameters.
|
|
405
442
|
* @param options - The query options.
|
|
406
|
-
* @returns The
|
|
443
|
+
* @returns The supply swap result with quote, approvals, and preview.
|
|
407
444
|
*/
|
|
408
|
-
declare function
|
|
445
|
+
declare function supplySwapQuote(client: AaveClient, request: SupplySwapQuoteRequest, options?: Required<CurrencyQueryOptions>): ResultAsync<PositionSwapByIntentApprovalsRequired, UnexpectedError>;
|
|
446
|
+
/**
|
|
447
|
+
* Fetches a borrow swap quote for swapping debt positions.
|
|
448
|
+
*
|
|
449
|
+
* ```ts
|
|
450
|
+
* const result = await borrowSwapQuote(client, {
|
|
451
|
+
* market: {
|
|
452
|
+
* sellPosition: userBorrowItemId('position_123'),
|
|
453
|
+
* buyReserve: reserveId('reserve_456'),
|
|
454
|
+
* amount: bigDecimal('1000'),
|
|
455
|
+
* user: evmAddress('0x742d35cc...'),
|
|
456
|
+
* },
|
|
457
|
+
* });
|
|
458
|
+
* ```
|
|
459
|
+
*
|
|
460
|
+
* @param client - Aave client.
|
|
461
|
+
* @param request - The borrow swap request parameters.
|
|
462
|
+
* @param options - The query options.
|
|
463
|
+
* @returns The borrow swap result with quote, approvals, and preview.
|
|
464
|
+
*/
|
|
465
|
+
declare function borrowSwapQuote(client: AaveClient, request: BorrowSwapQuoteRequest, options?: Required<CurrencyQueryOptions>): ResultAsync<PositionSwapByIntentApprovalsRequired, UnexpectedError>;
|
|
466
|
+
/**
|
|
467
|
+
* Fetches a repay with supply quote for repaying debt using collateral.
|
|
468
|
+
*
|
|
469
|
+
* ```ts
|
|
470
|
+
* const result = await repayWithSupplyQuote(client, {
|
|
471
|
+
* market: {
|
|
472
|
+
* sellPosition: userSupplyItemId('collateral_123'),
|
|
473
|
+
* buyPosition: userBorrowItemId('debt_456'),
|
|
474
|
+
* amount: bigDecimal('1000'),
|
|
475
|
+
* user: evmAddress('0x742d35cc...'),
|
|
476
|
+
* },
|
|
477
|
+
* });
|
|
478
|
+
* ```
|
|
479
|
+
*
|
|
480
|
+
* @param client - Aave client.
|
|
481
|
+
* @param request - The repay with supply request parameters.
|
|
482
|
+
* @param options - The query options.
|
|
483
|
+
* @returns The repay with supply result with quote, approvals, and preview.
|
|
484
|
+
*/
|
|
485
|
+
declare function repayWithSupplyQuote(client: AaveClient, request: RepayWithSupplyQuoteRequest, options?: Required<CurrencyQueryOptions>): ResultAsync<PositionSwapByIntentApprovalsRequired, UnexpectedError>;
|
|
486
|
+
/**
|
|
487
|
+
* Fetches a withdraw swap quote for withdrawing deposits and swapping on the fly.
|
|
488
|
+
*
|
|
489
|
+
* ```ts
|
|
490
|
+
* const result = await withdrawSwapQuote(client, {
|
|
491
|
+
* market: {
|
|
492
|
+
* position: userSupplyItemId('position_123'),
|
|
493
|
+
* buyReserve: reserveId('reserve_456'),
|
|
494
|
+
* amount: bigDecimal('1000'),
|
|
495
|
+
* user: evmAddress('0x742d35cc...'),
|
|
496
|
+
* },
|
|
497
|
+
* });
|
|
498
|
+
* ```
|
|
499
|
+
*
|
|
500
|
+
* @param client - Aave client.
|
|
501
|
+
* @param request - The withdraw swap request parameters.
|
|
502
|
+
* @param options - The query options.
|
|
503
|
+
* @returns The withdraw swap result with quote, approvals, and preview.
|
|
504
|
+
*/
|
|
505
|
+
declare function withdrawSwapQuote(client: AaveClient, request: WithdrawSwapQuoteRequest, options?: Required<CurrencyQueryOptions>): ResultAsync<PositionSwapByIntentApprovalsRequired, UnexpectedError>;
|
|
506
|
+
/**
|
|
507
|
+
* Prepares a position swap by obtaining the typed data for signing.
|
|
508
|
+
*
|
|
509
|
+
* ```ts
|
|
510
|
+
* const result = await preparePositionSwap(client, {
|
|
511
|
+
* quoteId: quote.quoteId,
|
|
512
|
+
* adapterContractSignature: signature('0x456...'),
|
|
513
|
+
* positionManagerSignature: signature('0x789...'),
|
|
514
|
+
* });
|
|
515
|
+
* ```
|
|
516
|
+
*
|
|
517
|
+
* @param client - Aave client.
|
|
518
|
+
* @param request - The position swap request with quote ID and signatures.
|
|
519
|
+
* @returns The position swap result with intent data for execution.
|
|
520
|
+
*/
|
|
521
|
+
declare function preparePositionSwap(client: AaveClient, request: PreparePositionSwapRequest): ResultAsync<PrepareSwapOrder, ValidationError<InsufficientBalanceError> | UnexpectedError>;
|
|
409
522
|
/**
|
|
410
|
-
* @internal
|
|
411
523
|
* Fetches the status of a specific swap.
|
|
412
524
|
*
|
|
413
525
|
* ```ts
|
|
@@ -421,10 +533,9 @@ declare function prepareSwap(client: AaveClient, request: PrepareSwapRequest, op
|
|
|
421
533
|
* @param options - The query options.
|
|
422
534
|
* @returns The current status of the swap.
|
|
423
535
|
*/
|
|
424
|
-
declare function swapStatus(client: AaveClient, request: SwapStatusRequest,
|
|
536
|
+
declare function swapStatus(client: AaveClient, request: SwapStatusRequest, { currency, timeWindow, }?: CurrencyQueryOptions & TimeWindowQueryOptions): ResultAsync<SwapStatus, UnexpectedError>;
|
|
425
537
|
type SwapOutcome = SwapCancelled | SwapExpired | SwapFulfilled;
|
|
426
538
|
/**
|
|
427
|
-
* @internal
|
|
428
539
|
* Waits for a swap to reach a final outcome (cancelled, expired, or fulfilled).
|
|
429
540
|
*
|
|
430
541
|
* ```ts
|
|
@@ -451,17 +562,13 @@ type SwapOutcome = SwapCancelled | SwapExpired | SwapFulfilled;
|
|
|
451
562
|
*/
|
|
452
563
|
declare function waitForSwapOutcome(client: AaveClient): (receipt: SwapReceipt) => ResultAsync<SwapOutcome, TimeoutError | UnexpectedError>;
|
|
453
564
|
/**
|
|
454
|
-
* @internal
|
|
455
565
|
* Executes a swap for the specified request parameters.
|
|
456
566
|
*
|
|
457
567
|
* ```ts
|
|
458
568
|
* const result = await swap(client, {
|
|
459
569
|
* intent: {
|
|
460
|
-
* quoteId:
|
|
461
|
-
* signature:
|
|
462
|
-
* value: signature('0x456...'),
|
|
463
|
-
* deadline: 1234567890,
|
|
464
|
-
* },
|
|
570
|
+
* quoteId: quote.quoteId,
|
|
571
|
+
* signature: signature('0x456...'),
|
|
465
572
|
* },
|
|
466
573
|
* }).andThen((plan) => {
|
|
467
574
|
* switch (plan.__typename) {
|
|
@@ -469,16 +576,8 @@ declare function waitForSwapOutcome(client: AaveClient): (receipt: SwapReceipt)
|
|
|
469
576
|
* return sendTransaction(plan.transaction)
|
|
470
577
|
* .map(() => plan.orderReceipt);
|
|
471
578
|
*
|
|
472
|
-
* case 'SwapApprovalRequired':
|
|
473
|
-
* return sendTransaction(plan.transaction)
|
|
474
|
-
* .andThen(() => sendTransaction(plan.originalTransaction))
|
|
475
|
-
* .map(() => plan.originalTransaction.orderReceipt);
|
|
476
|
-
*
|
|
477
579
|
* case 'SwapReceipt':
|
|
478
|
-
* return okAsync(plan
|
|
479
|
-
*
|
|
480
|
-
* case 'InsufficientBalanceError':
|
|
481
|
-
* return errAsync(new Error(`Insufficient balance: ${plan.required.value} required.`));
|
|
580
|
+
* return okAsync(plan);
|
|
482
581
|
* }
|
|
483
582
|
* });
|
|
484
583
|
*
|
|
@@ -494,9 +593,8 @@ declare function waitForSwapOutcome(client: AaveClient): (receipt: SwapReceipt)
|
|
|
494
593
|
* @param request - The swap request parameters.
|
|
495
594
|
* @returns The swap execution plan containing transaction details or receipt.
|
|
496
595
|
*/
|
|
497
|
-
declare function swap(client: AaveClient, request: SwapRequest): ResultAsync<
|
|
596
|
+
declare function swap(client: AaveClient, request: SwapRequest): ResultAsync<SwapTransactionRequest | SwapReceipt, ValidationError<InsufficientBalanceError> | UnexpectedError>;
|
|
498
597
|
/**
|
|
499
|
-
* @internal
|
|
500
598
|
* Prepares a swap cancellation for the specified swap ID.
|
|
501
599
|
*
|
|
502
600
|
* ```ts
|
|
@@ -511,7 +609,6 @@ declare function swap(client: AaveClient, request: SwapRequest): ResultAsync<Swa
|
|
|
511
609
|
*/
|
|
512
610
|
declare function prepareSwapCancel(client: AaveClient, request: PrepareSwapCancelRequest): ResultAsync<PrepareSwapCancelResult, UnexpectedError>;
|
|
513
611
|
/**
|
|
514
|
-
* @internal
|
|
515
612
|
* Executes a swap cancellation for the specified request parameters.
|
|
516
613
|
*
|
|
517
614
|
* ```ts
|
|
@@ -526,8 +623,7 @@ declare function prepareSwapCancel(client: AaveClient, request: PrepareSwapCance
|
|
|
526
623
|
* }).andThen((plan) => {
|
|
527
624
|
* switch (plan.__typename) {
|
|
528
625
|
* case 'TransactionRequest':
|
|
529
|
-
* return sendTransaction(plan)
|
|
530
|
-
* .map(() => ({ success: true }));
|
|
626
|
+
* return sendTransaction(plan);
|
|
531
627
|
*
|
|
532
628
|
* case 'SwapCancelled':
|
|
533
629
|
* return okAsync(plan);
|
|
@@ -541,7 +637,6 @@ declare function prepareSwapCancel(client: AaveClient, request: PrepareSwapCance
|
|
|
541
637
|
*/
|
|
542
638
|
declare function cancelSwap(client: AaveClient, request: CancelSwapRequest): ResultAsync<CancelSwapExecutionPlan, UnexpectedError>;
|
|
543
639
|
/**
|
|
544
|
-
* @internal
|
|
545
640
|
* Fetches the user's swap history for a specific chain.
|
|
546
641
|
*
|
|
547
642
|
* ```ts
|
|
@@ -557,7 +652,7 @@ declare function cancelSwap(client: AaveClient, request: CancelSwapRequest): Res
|
|
|
557
652
|
* @param options - The query options.
|
|
558
653
|
* @returns The paginated list of user swaps with their status information.
|
|
559
654
|
*/
|
|
560
|
-
declare function userSwaps(client: AaveClient, request: UserSwapsRequest,
|
|
655
|
+
declare function userSwaps(client: AaveClient, request: UserSwapsRequest, { currency, timeWindow, }?: CurrencyQueryOptions & TimeWindowQueryOptions): ResultAsync<PaginatedUserSwapsResult, UnexpectedError>;
|
|
561
656
|
|
|
562
657
|
/**
|
|
563
658
|
* Creates a transaction to borrow from a market.
|
|
@@ -724,35 +819,12 @@ declare function withdraw(client: AaveClient, request: WithdrawRequest): ResultA
|
|
|
724
819
|
*/
|
|
725
820
|
declare function renounceSpokeUserPositionManager(client: AaveClient, request: RenounceSpokeUserPositionManagerRequest): ResultAsync<TransactionRequest, UnexpectedError>;
|
|
726
821
|
/**
|
|
727
|
-
* Creates a transaction to update user dynamic config
|
|
728
|
-
*
|
|
729
|
-
* ```ts
|
|
730
|
-
* const result = await updateUserDynamicConfig(client, {
|
|
731
|
-
* sender: evmAddress('0x9abc…'),
|
|
732
|
-
* spoke: spokeId('SGVsbG8h'),
|
|
733
|
-
* }).andThen(sendWith(wallet)).andThen(client.waitForTransaction);
|
|
734
|
-
*
|
|
735
|
-
* if (result.isErr()) {
|
|
736
|
-
* // Handle error
|
|
737
|
-
* return;
|
|
738
|
-
* }
|
|
739
|
-
*
|
|
740
|
-
* // result.value: TxHash
|
|
741
|
-
* ```
|
|
742
|
-
*
|
|
743
|
-
*
|
|
744
|
-
* @param client - Aave client.
|
|
745
|
-
* @param request - The update user dynamic config request parameters.
|
|
746
|
-
* @returns The transaction data.
|
|
747
|
-
*/
|
|
748
|
-
declare function updateUserDynamicConfig(client: AaveClient, request: UpdateUserDynamicConfigRequest): ResultAsync<TransactionRequest, UnexpectedError>;
|
|
749
|
-
/**
|
|
750
|
-
* Creates a transaction to update user risk premium for a specific spoke.
|
|
822
|
+
* Creates a transaction to update user position conditions (dynamic config and/or risk premium).
|
|
751
823
|
*
|
|
752
824
|
* ```ts
|
|
753
|
-
* const result = await
|
|
754
|
-
*
|
|
755
|
-
*
|
|
825
|
+
* const result = await updateUserPositionConditions(client, {
|
|
826
|
+
* userPositionId: userPositionId('SGVsbG8h'),
|
|
827
|
+
* update: UserPositionConditionsUpdate.AllDynamicConfig,
|
|
756
828
|
* }).andThen(sendWith(wallet)).andThen(client.waitForTransaction);
|
|
757
829
|
*
|
|
758
830
|
* if (result.isErr()) {
|
|
@@ -765,10 +837,10 @@ declare function updateUserDynamicConfig(client: AaveClient, request: UpdateUser
|
|
|
765
837
|
*
|
|
766
838
|
*
|
|
767
839
|
* @param client - Aave client.
|
|
768
|
-
* @param request - The update user
|
|
840
|
+
* @param request - The update user position conditions request parameters.
|
|
769
841
|
* @returns The transaction data.
|
|
770
842
|
*/
|
|
771
|
-
declare function
|
|
843
|
+
declare function updateUserPositionConditions(client: AaveClient, request: UpdateUserPositionConditionsRequest): ResultAsync<TransactionRequest, UnexpectedError>;
|
|
772
844
|
/**
|
|
773
845
|
* Creates a transaction to liquidate a user's position.
|
|
774
846
|
*
|
|
@@ -861,21 +933,25 @@ declare function setSpokeUserPositionManager(client: AaveClient, request: SetSpo
|
|
|
861
933
|
*/
|
|
862
934
|
declare function preview(client: AaveClient, request: PreviewRequest, options?: Required<CurrencyQueryOptions>): ResultAsync<PreviewUserPosition, UnexpectedError>;
|
|
863
935
|
/**
|
|
864
|
-
*
|
|
936
|
+
* Updates the collateral status of user's supplies.
|
|
865
937
|
*
|
|
866
938
|
* ```ts
|
|
867
|
-
* const result = await
|
|
868
|
-
*
|
|
869
|
-
*
|
|
870
|
-
*
|
|
939
|
+
* const result = await setUserSuppliesAsCollateral(client, {
|
|
940
|
+
* changes: [
|
|
941
|
+
* {
|
|
942
|
+
* reserve: reserveId('SGVsbG8h'),
|
|
943
|
+
* enableCollateral: true
|
|
944
|
+
* }
|
|
945
|
+
* ],
|
|
946
|
+
* sender: evmAddress('0x456...')
|
|
871
947
|
* });
|
|
872
948
|
* ```
|
|
873
949
|
*
|
|
874
950
|
* @param client - Aave client.
|
|
875
|
-
* @param request - The
|
|
876
|
-
* @returns The transaction request to
|
|
951
|
+
* @param request - The request parameters.
|
|
952
|
+
* @returns The transaction request to update collateral status.
|
|
877
953
|
*/
|
|
878
|
-
declare function
|
|
954
|
+
declare function setUserSuppliesAsCollateral(client: AaveClient, request: SetUserSuppliesAsCollateralRequest): ResultAsync<TransactionRequest, UnexpectedError>;
|
|
879
955
|
/**
|
|
880
956
|
* Fetches paginated list of activities.
|
|
881
957
|
*
|
|
@@ -894,7 +970,7 @@ declare function setUserSupplyAsCollateral(client: AaveClient, request: SetUserS
|
|
|
894
970
|
* @param options - The query options.
|
|
895
971
|
* @returns The paginated list of activities.
|
|
896
972
|
*/
|
|
897
|
-
declare function activities(client: AaveClient, request: ActivitiesRequest,
|
|
973
|
+
declare function activities(client: AaveClient, request: ActivitiesRequest, { currency, timeWindow, requestPolicy, }?: CurrencyQueryOptions & TimeWindowQueryOptions & RequestPolicyOptions): ResultAsync<PaginatedActivitiesResult, UnexpectedError>;
|
|
898
974
|
|
|
899
975
|
/**
|
|
900
976
|
* Fetches all user supply positions across the specified spoke.
|
|
@@ -916,7 +992,7 @@ declare function activities(client: AaveClient, request: ActivitiesRequest, opti
|
|
|
916
992
|
* @param options - The query options.
|
|
917
993
|
* @returns The user's supply positions.
|
|
918
994
|
*/
|
|
919
|
-
declare function userSupplies(client: AaveClient, request: UserSuppliesRequest,
|
|
995
|
+
declare function userSupplies(client: AaveClient, request: UserSuppliesRequest, { currency, timeWindow, }?: CurrencyQueryOptions & TimeWindowQueryOptions): ResultAsync<UserSupplyItem[], UnexpectedError>;
|
|
920
996
|
/**
|
|
921
997
|
* Fetches all user borrow positions across the specified spoke.
|
|
922
998
|
*
|
|
@@ -937,7 +1013,7 @@ declare function userSupplies(client: AaveClient, request: UserSuppliesRequest,
|
|
|
937
1013
|
* @param options - The query options.
|
|
938
1014
|
* @returns The user's borrow positions.
|
|
939
1015
|
*/
|
|
940
|
-
declare function userBorrows(client: AaveClient, request: UserBorrowsRequest,
|
|
1016
|
+
declare function userBorrows(client: AaveClient, request: UserBorrowsRequest, { currency, timeWindow, }?: CurrencyQueryOptions & TimeWindowQueryOptions): ResultAsync<UserBorrowItem[], UnexpectedError>;
|
|
941
1017
|
type UserSummaryQueryOptions = Prettify<CurrencyQueryOptions & TimeWindowQueryOptions>;
|
|
942
1018
|
/**
|
|
943
1019
|
* Fetches a user's summary across all positions.
|
|
@@ -1029,5 +1105,22 @@ declare function userBalances(client: AaveClient, request: UserBalancesRequest,
|
|
|
1029
1105
|
* @returns The user summary history items.
|
|
1030
1106
|
*/
|
|
1031
1107
|
declare function userSummaryHistory(client: AaveClient, request: UserSummaryHistoryRequest, options?: Required<CurrencyQueryOptions>): ResultAsync<UserSummaryHistoryItem[], UnexpectedError>;
|
|
1108
|
+
/**
|
|
1109
|
+
* Fetches the risk premium breakdown for a user position or spoke.
|
|
1110
|
+
*
|
|
1111
|
+
* ```ts
|
|
1112
|
+
* const result = await userRiskPremiumBreakdown(client, {
|
|
1113
|
+
* query: {
|
|
1114
|
+
* userPositionId: userPositionId('SGVsbG8h'),
|
|
1115
|
+
* },
|
|
1116
|
+
* user: evmAddress('0x742d35cc…'),
|
|
1117
|
+
* });
|
|
1118
|
+
* ```
|
|
1119
|
+
*
|
|
1120
|
+
* @param client - Aave client.
|
|
1121
|
+
* @param request - The user risk premium breakdown request parameters.
|
|
1122
|
+
* @returns Array of risk premium breakdown items.
|
|
1123
|
+
*/
|
|
1124
|
+
declare function userRiskPremiumBreakdown(client: AaveClient, request: UserRiskPremiumBreakdownRequest): ResultAsync<UserRiskPremiumBreakdownItem[], UnexpectedError>;
|
|
1032
1125
|
|
|
1033
|
-
export { type SwapOutcome, type UserPositionQueryOptions, type UserSummaryQueryOptions, activities, asset, assetBorrowHistory, assetPriceHistory, assetSupplyHistory, borrow, borrowApyHistory, cancelSwap, chain, chains, exchangeRate, hasProcessedKnownTransaction, hub, hubAssets, hubs, liquidatePosition, permitTypedData,
|
|
1126
|
+
export { type SwapOutcome, type UserPositionQueryOptions, type UserSummaryQueryOptions, activities, asset, assetBorrowHistory, assetPriceHistory, assetSupplyHistory, borrow, borrowApyHistory, borrowSwapQuote, cancelSwap, chain, chains, exchangeRate, hasProcessedKnownTransaction, hub, hubAssets, hubSummaryHistory, hubs, liquidatePosition, permitTypedData, preparePositionSwap, prepareSwapCancel, prepareTokenSwap, preview, protocolHistory, renounceSpokeUserPositionManager, repay, repayWithSupplyQuote, reserve, reserves, setSpokeUserPositionManager, setUserSuppliesAsCollateral, spoke, spokePositionManagers, spokeUserPositionManagers, spokes, supply, supplyApyHistory, supplySwapQuote, swap, swapStatus, swappableTokens, tokenSwapQuote, updateUserPositionConditions, userBalances, userBorrows, userPosition, userPositions, userRiskPremiumBreakdown, userSummary, userSummaryHistory, userSupplies, userSwaps, waitForSwapOutcome, withdraw, withdrawSwapQuote };
|