@circle-fin/app-kit 1.16.0 → 1.17.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 +38 -0
- package/borrow.cjs +148 -30
- package/borrow.d.cts +35 -6
- package/borrow.d.mts +35 -6
- package/borrow.d.ts +35 -6
- package/borrow.mjs +148 -30
- package/bridge.cjs +187 -40
- package/bridge.d.cts +35 -6
- package/bridge.d.mts +35 -6
- package/bridge.d.ts +35 -6
- package/bridge.mjs +187 -40
- package/chains.cjs +8 -4
- package/chains.mjs +8 -4
- package/context.d.cts +35 -6
- package/context.d.mts +35 -6
- package/context.d.ts +35 -6
- package/earn.cjs +470 -34
- package/earn.d.cts +35 -6
- package/earn.d.mts +35 -6
- package/earn.d.ts +35 -6
- package/earn.mjs +470 -34
- package/estimateBridge.cjs +187 -40
- package/estimateBridge.d.cts +35 -6
- package/estimateBridge.d.mts +35 -6
- package/estimateBridge.d.ts +35 -6
- package/estimateBridge.mjs +187 -40
- package/estimateSwap.cjs +263 -43
- package/estimateSwap.d.cts +83 -6
- package/estimateSwap.d.mts +83 -6
- package/estimateSwap.d.ts +83 -6
- package/estimateSwap.mjs +263 -43
- package/index.cjs +468 -53
- package/index.d.cts +331 -202
- package/index.d.mts +331 -202
- package/index.d.ts +331 -202
- package/index.mjs +468 -53
- package/package.json +8 -8
- package/server.cjs +33 -7
- package/server.d.cts +29 -10
- package/server.d.mts +29 -10
- package/server.d.ts +29 -10
- package/server.mjs +33 -7
- package/swap.cjs +263 -43
- package/swap.d.cts +83 -6
- package/swap.d.mts +83 -6
- package/swap.d.ts +83 -6
- package/swap.mjs +263 -43
- package/unifiedBalance.cjs +73 -12
- package/unifiedBalance.mjs +73 -12
package/index.d.cts
CHANGED
|
@@ -899,10 +899,10 @@ declare enum Blockchain {
|
|
|
899
899
|
*
|
|
900
900
|
* Unlike the full {@link Blockchain} enum, SwapChain includes mainnet
|
|
901
901
|
* networks and explicitly whitelisted testnets (e.g., {@link Arc_Testnet})
|
|
902
|
-
* where
|
|
902
|
+
* where Adapter contracts are deployed.
|
|
903
903
|
*
|
|
904
904
|
* Dynamic validation via {@link isSwapSupportedChain} ensures chains
|
|
905
|
-
* automatically work when
|
|
905
|
+
* automatically work when Adapter contracts and supported tokens are deployed.
|
|
906
906
|
*
|
|
907
907
|
* @example
|
|
908
908
|
* ```typescript
|
|
@@ -942,20 +942,22 @@ declare enum SwapChain {
|
|
|
942
942
|
HyperEVM = "HyperEVM",
|
|
943
943
|
Monad = "Monad",
|
|
944
944
|
Arc = "Arc",
|
|
945
|
+
Cronos = "Cronos",
|
|
946
|
+
Morph = "Morph",
|
|
945
947
|
Arc_Testnet = "Arc_Testnet"
|
|
946
948
|
}
|
|
947
949
|
/**
|
|
948
950
|
* Chain definition that supports swap operations.
|
|
949
951
|
*
|
|
950
952
|
* @remarks
|
|
951
|
-
* Expanded from 4 to
|
|
952
|
-
* -
|
|
953
|
+
* Expanded from 4 to supported mainnets and whitelisted testnets based on:
|
|
954
|
+
* - A deployed Adapter contract, configured directly or through CCTP v2
|
|
953
955
|
* - Mainnet chains plus whitelisted testnets (e.g., Arc Testnet)
|
|
954
956
|
*
|
|
955
957
|
* Use `isSwapSupportedChain()` for runtime validation.
|
|
956
958
|
*/
|
|
957
959
|
type SwapChainDefinition = ChainDefinition & {
|
|
958
|
-
chain: Blockchain.Ethereum | Blockchain.Base | Blockchain.Polygon | Blockchain.Solana | Blockchain.Arbitrum | Blockchain.Optimism | Blockchain.Avalanche | Blockchain.Linea | Blockchain.Ink | Blockchain.World_Chain | Blockchain.Unichain | Blockchain.Plume | Blockchain.Sei | Blockchain.Sonic | Blockchain.XDC | Blockchain.HyperEVM | Blockchain.Monad | Blockchain.Arc | Blockchain.Arc_Testnet;
|
|
960
|
+
chain: Blockchain.Ethereum | Blockchain.Base | Blockchain.Polygon | Blockchain.Solana | Blockchain.Arbitrum | Blockchain.Optimism | Blockchain.Avalanche | Blockchain.Linea | Blockchain.Ink | Blockchain.World_Chain | Blockchain.Unichain | Blockchain.Plume | Blockchain.Sei | Blockchain.Sonic | Blockchain.XDC | Blockchain.HyperEVM | Blockchain.Monad | Blockchain.Arc | Blockchain.Cronos | Blockchain.Morph | Blockchain.Arc_Testnet;
|
|
959
961
|
};
|
|
960
962
|
/**
|
|
961
963
|
* Chain identifier accepted by swap operations.
|
|
@@ -2195,6 +2197,7 @@ declare const Cronos: {
|
|
|
2195
2197
|
};
|
|
2196
2198
|
readonly kitContracts: {
|
|
2197
2199
|
readonly bridge: "0xB3FA262d0fB521cc93bE83d87b322b8A23DAf3F0";
|
|
2200
|
+
readonly adapter: "0x7FB8c7260b63934d8da38aF902f87ae6e284a845";
|
|
2198
2201
|
};
|
|
2199
2202
|
};
|
|
2200
2203
|
|
|
@@ -3043,6 +3046,7 @@ declare const Morph: {
|
|
|
3043
3046
|
};
|
|
3044
3047
|
readonly kitContracts: {
|
|
3045
3048
|
readonly bridge: "0xB3FA262d0fB521cc93bE83d87b322b8A23DAf3F0";
|
|
3049
|
+
readonly adapter: "0x7FB8c7260b63934d8da38aF902f87ae6e284a845";
|
|
3046
3050
|
};
|
|
3047
3051
|
};
|
|
3048
3052
|
|
|
@@ -8834,7 +8838,7 @@ declare const ServiceError: {
|
|
|
8834
8838
|
* between input errors (fix your request) and service errors (retry later).
|
|
8835
8839
|
*
|
|
8836
8840
|
* Error code ranges:
|
|
8837
|
-
* - 1100-
|
|
8841
|
+
* - 1100-1107: INPUT errors — invalid, unsupported, or stale request state
|
|
8838
8842
|
* - 8100-8105: SERVICE errors — retryable backend/provider failures
|
|
8839
8843
|
*
|
|
8840
8844
|
* @example
|
|
@@ -8903,6 +8907,16 @@ declare const EarnError: {
|
|
|
8903
8907
|
readonly name: "EARN_BRIDGE_QUOTE_EXPIRED";
|
|
8904
8908
|
readonly type: ErrorType;
|
|
8905
8909
|
};
|
|
8910
|
+
/**
|
|
8911
|
+
* The wallet's vault shares are inside the vault's share lock period, which
|
|
8912
|
+
* starts at deposit. Surfaced as FATAL rather than RETRYABLE because the
|
|
8913
|
+
* lock can last hours, so an immediate retry fails the same way.
|
|
8914
|
+
*/
|
|
8915
|
+
readonly SHARES_LOCKED: {
|
|
8916
|
+
readonly code: 1107;
|
|
8917
|
+
readonly name: "EARN_SHARES_LOCKED";
|
|
8918
|
+
readonly type: ErrorType;
|
|
8919
|
+
};
|
|
8906
8920
|
/** The proxy signing call failed — retryable. */
|
|
8907
8921
|
readonly SIGNING_FAILED: {
|
|
8908
8922
|
readonly code: 8100;
|
|
@@ -13226,6 +13240,25 @@ interface CCTPXTokenDeployment {
|
|
|
13226
13240
|
* the same reason as {@link CCTPXTokenDeployment.tokenAddress}.
|
|
13227
13241
|
*/
|
|
13228
13242
|
tokenManagerAddress: string;
|
|
13243
|
+
/**
|
|
13244
|
+
* Operator-controlled per-chain kill switch, surfaced by IRIS as of CCTPE-3979.
|
|
13245
|
+
*
|
|
13246
|
+
* - `true` or absent → the deployment is routable (back-compat with older IRIS
|
|
13247
|
+
* versions that do not return the field).
|
|
13248
|
+
* - `false` → an operator has disabled this `(tokenId, domainId)` for CCTPx
|
|
13249
|
+
* transfer quotes. {@link findCCTPXDeployment} skips the row, so bridging
|
|
13250
|
+
* providers treat the chain as un-deployed for route-selection purposes.
|
|
13251
|
+
*
|
|
13252
|
+
* This field is purely informational for SDK consumers — route gating is
|
|
13253
|
+
* applied internally. Expect it to flip without warning in response to
|
|
13254
|
+
* incidents or operator policy; cache it with the same lifetime as the
|
|
13255
|
+
* registry response, not longer.
|
|
13256
|
+
*
|
|
13257
|
+
* The `| undefined` in the type is required by `exactOptionalPropertyTypes`
|
|
13258
|
+
* so Zod's `z.boolean().optional()` inferred shape assigns through this
|
|
13259
|
+
* interface without a cast.
|
|
13260
|
+
*/
|
|
13261
|
+
enabled?: boolean | undefined;
|
|
13229
13262
|
}
|
|
13230
13263
|
/** One CCTPx token from the IRIS registry, including all its per-chain deployments. */
|
|
13231
13264
|
interface CCTPXToken {
|
|
@@ -17249,6 +17282,229 @@ declare class BridgeKit<TExtraProviders extends FlexibleBridgingProvider[] = []>
|
|
|
17249
17282
|
removeCustomFeePolicy(): void;
|
|
17250
17283
|
}
|
|
17251
17284
|
|
|
17285
|
+
/** Token metadata for one side of a swap route step. */
|
|
17286
|
+
interface SwapRouteToken {
|
|
17287
|
+
readonly symbol: string;
|
|
17288
|
+
readonly address: string;
|
|
17289
|
+
readonly decimals: number;
|
|
17290
|
+
}
|
|
17291
|
+
/** Amount estimates for a swap route step, expressed in base units. */
|
|
17292
|
+
interface SwapRouteStepEstimate {
|
|
17293
|
+
readonly fromAmount: string;
|
|
17294
|
+
readonly toAmount: string;
|
|
17295
|
+
readonly gasCostUSD?: string;
|
|
17296
|
+
}
|
|
17297
|
+
/** A single swap or bridge hop selected by the route provider. */
|
|
17298
|
+
interface SwapRouteStep {
|
|
17299
|
+
/** Hop kind, for example `swap` or `bridge`. */
|
|
17300
|
+
readonly type: string;
|
|
17301
|
+
/** Protocol identifier, for example `cctp-v2`. */
|
|
17302
|
+
readonly tool: string;
|
|
17303
|
+
/** Display name for {@link SwapRouteStep.tool}. */
|
|
17304
|
+
readonly toolName: string;
|
|
17305
|
+
readonly fromToken: SwapRouteToken;
|
|
17306
|
+
readonly toToken: SwapRouteToken;
|
|
17307
|
+
readonly estimate: SwapRouteStepEstimate;
|
|
17308
|
+
/** Provider-specific details that are not part of the stable step shape. */
|
|
17309
|
+
readonly metadata?: Readonly<Record<string, unknown>>;
|
|
17310
|
+
}
|
|
17311
|
+
/** Provider and executable hops selected for a swap. */
|
|
17312
|
+
interface SwapRoute {
|
|
17313
|
+
/**
|
|
17314
|
+
* Provider that routed the swap, for example `lifi` or `circle`. Treat as
|
|
17315
|
+
* an opaque identifier; new providers can appear without an SDK release.
|
|
17316
|
+
*/
|
|
17317
|
+
readonly provider: string;
|
|
17318
|
+
readonly steps: readonly SwapRouteStep[];
|
|
17319
|
+
/** Provider-specific details that are not part of the stable route shape. */
|
|
17320
|
+
readonly metadata?: Readonly<Record<string, unknown>>;
|
|
17321
|
+
}
|
|
17322
|
+
/**
|
|
17323
|
+
* Latest cached USD rate for a single (chain, token) pair, as written by the
|
|
17324
|
+
* Stablecoin Service's `token-rate-update` cron.
|
|
17325
|
+
*
|
|
17326
|
+
* @remarks
|
|
17327
|
+
* The cron refreshes entries once per minute and they expire after 15 minutes
|
|
17328
|
+
* of staleness. Inspect {@link TokenRate.fetchedAt} when freshness matters —
|
|
17329
|
+
* a value older than a few minutes likely means the upstream provider was
|
|
17330
|
+
* unreachable on the most recent run.
|
|
17331
|
+
*
|
|
17332
|
+
* @example
|
|
17333
|
+
* ```typescript
|
|
17334
|
+
* const rate: TokenRate = { priceUSD: '1.0001', fetchedAt: 1716240000000 }
|
|
17335
|
+
* const ageMs = Date.now() - rate.fetchedAt
|
|
17336
|
+
* ```
|
|
17337
|
+
*/
|
|
17338
|
+
interface TokenRate {
|
|
17339
|
+
/**
|
|
17340
|
+
* USD price as reported by the upstream provider.
|
|
17341
|
+
*
|
|
17342
|
+
* Returned as a string to preserve precision — parse with `Number` or a
|
|
17343
|
+
* decimal library depending on how much precision callers need.
|
|
17344
|
+
*/
|
|
17345
|
+
readonly priceUSD: string;
|
|
17346
|
+
/**
|
|
17347
|
+
* Unix timestamp in milliseconds at which the price was fetched from the
|
|
17348
|
+
* upstream provider.
|
|
17349
|
+
*/
|
|
17350
|
+
readonly fetchedAt: number;
|
|
17351
|
+
/**
|
|
17352
|
+
* On-chain decimal precision of the token, when the upstream provider
|
|
17353
|
+
* reports it. Absent for tokens the provider has not catalogued.
|
|
17354
|
+
*
|
|
17355
|
+
* Use it to convert a raw base-unit balance into a human amount before
|
|
17356
|
+
* multiplying by `priceUSD`: `balance / 10 ** decimals * Number(priceUSD)`.
|
|
17357
|
+
*/
|
|
17358
|
+
readonly decimals?: number;
|
|
17359
|
+
}
|
|
17360
|
+
/**
|
|
17361
|
+
* Response payload from `GET /v1/stablecoinKits/rates`.
|
|
17362
|
+
*
|
|
17363
|
+
* Nested map keyed first by chain name (matching the `Blockchain` enum), then
|
|
17364
|
+
* by token address. Address keys preserve the service's canonical casing:
|
|
17365
|
+
* EVM hex addresses are lowercased, Solana base58 mints are case-preserved.
|
|
17366
|
+
*
|
|
17367
|
+
* @remarks
|
|
17368
|
+
* - A successful call always returns a `rates` object, but it may be empty
|
|
17369
|
+
* when no cached entries are found.
|
|
17370
|
+
* - When `addresses` was supplied, missing addresses are simply absent —
|
|
17371
|
+
* there is no 404 for partial lookups.
|
|
17372
|
+
*
|
|
17373
|
+
* @example
|
|
17374
|
+
* ```typescript
|
|
17375
|
+
* const response: GetTokenRatesResponse = {
|
|
17376
|
+
* rates: {
|
|
17377
|
+
* Ethereum: {
|
|
17378
|
+
* '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48': {
|
|
17379
|
+
* priceUSD: '1.0001',
|
|
17380
|
+
* fetchedAt: 1716240000000,
|
|
17381
|
+
* },
|
|
17382
|
+
* },
|
|
17383
|
+
* },
|
|
17384
|
+
* }
|
|
17385
|
+
* ```
|
|
17386
|
+
*/
|
|
17387
|
+
interface GetTokenRatesResponse {
|
|
17388
|
+
/**
|
|
17389
|
+
* Nested map of token rates keyed by `[chain][address]`.
|
|
17390
|
+
*
|
|
17391
|
+
* Always present; may be an empty object when no rates are found.
|
|
17392
|
+
*/
|
|
17393
|
+
readonly rates: Readonly<Record<string, Readonly<Record<string, TokenRate>>>>;
|
|
17394
|
+
}
|
|
17395
|
+
|
|
17396
|
+
/**
|
|
17397
|
+
* MOVED, not new. Lifted from providers/earn-service/src/validations/, where the
|
|
17398
|
+
* same mapper existed; borrow-service uses it instead of adding a second copy.
|
|
17399
|
+
*/
|
|
17400
|
+
|
|
17401
|
+
/**
|
|
17402
|
+
* A single claimed (or claimable) reward token amount.
|
|
17403
|
+
*
|
|
17404
|
+
* @example
|
|
17405
|
+
* ```typescript
|
|
17406
|
+
* import type { ClaimedAmount } from '@core/service-client'
|
|
17407
|
+
*
|
|
17408
|
+
* const reward: ClaimedAmount = {
|
|
17409
|
+
* address: '0x9994E35Db50125E0DF82e4c2dde62496CE330999',
|
|
17410
|
+
* symbol: 'MORPHO',
|
|
17411
|
+
* amount: Amount.fromJSON({ raw: '12500000000000000000', decimals: 18 }),
|
|
17412
|
+
* }
|
|
17413
|
+
* ```
|
|
17414
|
+
*/
|
|
17415
|
+
interface ClaimedAmount$1 {
|
|
17416
|
+
/** Reward token contract address. */
|
|
17417
|
+
readonly address: string;
|
|
17418
|
+
/** Reward token symbol. */
|
|
17419
|
+
readonly symbol: string;
|
|
17420
|
+
/** Claimed (or claimable) amount. */
|
|
17421
|
+
readonly amount: Amount;
|
|
17422
|
+
}
|
|
17423
|
+
|
|
17424
|
+
/**
|
|
17425
|
+
* MOVED, not new. The claim-rewards result types previously declared
|
|
17426
|
+
* identically in providers/earn-service/src/types.ts and
|
|
17427
|
+
* providers/borrow-service/src/types.ts. Both now re-export from here.
|
|
17428
|
+
*/
|
|
17429
|
+
/**
|
|
17430
|
+
* Provider-level result types for the claim-rewards contract.
|
|
17431
|
+
*
|
|
17432
|
+
* The claim-rewards contract returns the same shapes to every kit that
|
|
17433
|
+
* consumes it, so these are declared once here rather than per service.
|
|
17434
|
+
*
|
|
17435
|
+
* @packageDocumentation
|
|
17436
|
+
*/
|
|
17437
|
+
|
|
17438
|
+
/**
|
|
17439
|
+
* Result returned when no rewards were claimable.
|
|
17440
|
+
*
|
|
17441
|
+
* No transaction is submitted in this case, so there is no hash to report.
|
|
17442
|
+
*/
|
|
17443
|
+
interface NoClaimableRewardsResult {
|
|
17444
|
+
/** Discriminant: nothing was claimable. */
|
|
17445
|
+
readonly status: 'no_rewards';
|
|
17446
|
+
/** Always empty. */
|
|
17447
|
+
readonly rewards: readonly [];
|
|
17448
|
+
}
|
|
17449
|
+
/**
|
|
17450
|
+
* Result returned after claimable rewards were submitted on-chain.
|
|
17451
|
+
*
|
|
17452
|
+
* The reward element type is parameterized so a service whose own claimed
|
|
17453
|
+
* amount carries more than the contract-defined fields (e.g.
|
|
17454
|
+
* `@circle-fin/provider-earn-service`, whose `ClaimedAmount` also has
|
|
17455
|
+
* `type`/`status`) can reuse this shape without narrowing `rewards`.
|
|
17456
|
+
*
|
|
17457
|
+
* @typeParam TClaimedAmount - Element type of `rewards`. Defaults to the
|
|
17458
|
+
* contract-defined {@link ClaimedAmount}.
|
|
17459
|
+
*
|
|
17460
|
+
* @example
|
|
17461
|
+
* ```typescript
|
|
17462
|
+
* // Contract-defined rewards.
|
|
17463
|
+
* const claimed: ClaimedRewardsResult = {
|
|
17464
|
+
* status: 'claimed',
|
|
17465
|
+
* rewards: [],
|
|
17466
|
+
* txHash: '0xabc',
|
|
17467
|
+
* explorerUrl: 'https://example.com/tx/0xabc',
|
|
17468
|
+
* }
|
|
17469
|
+
* ```
|
|
17470
|
+
*/
|
|
17471
|
+
interface ClaimedRewardsResult$1<TClaimedAmount = ClaimedAmount$1> {
|
|
17472
|
+
/** Discriminant: rewards were claimed. */
|
|
17473
|
+
readonly status: 'claimed';
|
|
17474
|
+
/** Reward token amounts that were claimed. */
|
|
17475
|
+
readonly rewards: readonly TClaimedAmount[];
|
|
17476
|
+
/** Hash of the confirmed claim transaction. */
|
|
17477
|
+
readonly txHash: string;
|
|
17478
|
+
/** Block-explorer URL for {@link ClaimedRewardsResult.txHash}. */
|
|
17479
|
+
readonly explorerUrl: string;
|
|
17480
|
+
}
|
|
17481
|
+
/**
|
|
17482
|
+
* Result of a claim-rewards operation, discriminated on `status`.
|
|
17483
|
+
*
|
|
17484
|
+
* @typeParam TClaimedAmount - Element type of the claimed `rewards`. Defaults
|
|
17485
|
+
* to the contract-defined {@link ClaimedAmount}.
|
|
17486
|
+
*
|
|
17487
|
+
* @example
|
|
17488
|
+
* ```typescript
|
|
17489
|
+
* declare const result: ClaimRewardsResult
|
|
17490
|
+
* if (result.status === 'claimed') {
|
|
17491
|
+
* console.log(result.txHash)
|
|
17492
|
+
* }
|
|
17493
|
+
* ```
|
|
17494
|
+
*/
|
|
17495
|
+
type ClaimRewardsResult$1<TClaimedAmount = ClaimedAmount$1> = NoClaimableRewardsResult | ClaimedRewardsResult$1<TClaimedAmount>;
|
|
17496
|
+
/**
|
|
17497
|
+
* Read-only claimable-rewards quote.
|
|
17498
|
+
*
|
|
17499
|
+
* Services may extend this with their own optional fields (e.g. EarnKit
|
|
17500
|
+
* carries an always-empty `gasFees` for symmetry with its other quotes); the
|
|
17501
|
+
* `rewards` list itself is contract-defined and identical everywhere.
|
|
17502
|
+
*/
|
|
17503
|
+
interface ClaimRewardsQuoteInfo$1 {
|
|
17504
|
+
/** Reward tokens currently available for claiming. */
|
|
17505
|
+
readonly rewards: readonly ClaimedAmount$1[];
|
|
17506
|
+
}
|
|
17507
|
+
|
|
17252
17508
|
/**
|
|
17253
17509
|
* Represents a token amount with its symbol and value.
|
|
17254
17510
|
*
|
|
@@ -17447,7 +17703,7 @@ interface ServiceSwapConfig {
|
|
|
17447
17703
|
*
|
|
17448
17704
|
* @defaultValue true
|
|
17449
17705
|
*/
|
|
17450
|
-
batchTransactions?: boolean;
|
|
17706
|
+
batchTransactions?: boolean | undefined;
|
|
17451
17707
|
}
|
|
17452
17708
|
/**
|
|
17453
17709
|
* Parameters for initiating a swap operation through the Stablecoin Service.
|
|
@@ -17600,6 +17856,14 @@ interface ServiceSwapFee {
|
|
|
17600
17856
|
* addresses are not available from the proxy response.
|
|
17601
17857
|
*/
|
|
17602
17858
|
readonly recipientAddress?: string;
|
|
17859
|
+
/** Provider-defined fee component (for example `FORWARD`). */
|
|
17860
|
+
readonly component?: string;
|
|
17861
|
+
/**
|
|
17862
|
+
* Chain on which the fee is charged, as reported by the service
|
|
17863
|
+
* (a `Blockchain` value such as `'Ethereum'`). Not validated
|
|
17864
|
+
* against the `Blockchain` enum.
|
|
17865
|
+
*/
|
|
17866
|
+
readonly chain?: string;
|
|
17603
17867
|
}
|
|
17604
17868
|
/**
|
|
17605
17869
|
* Result from estimating a swap operation through the Stablecoin Service.
|
|
@@ -17662,6 +17926,8 @@ interface EstimateResult {
|
|
|
17662
17926
|
* and kit fees (if configured). Amounts are in decimal format for display.
|
|
17663
17927
|
*/
|
|
17664
17928
|
readonly fees?: readonly ServiceSwapFee[];
|
|
17929
|
+
/** Provider and executable hops selected for the swap. */
|
|
17930
|
+
readonly route?: SwapRoute;
|
|
17665
17931
|
}
|
|
17666
17932
|
/**
|
|
17667
17933
|
* Individual executed transaction in a swap operation.
|
|
@@ -17799,6 +18065,8 @@ interface SwapResult$1 {
|
|
|
17799
18065
|
* fees (charged by the DEX aggregator/protocol) and kit fees.
|
|
17800
18066
|
*/
|
|
17801
18067
|
readonly fees?: readonly ServiceSwapFee[];
|
|
18068
|
+
/** Provider and executable hops selected for the swap. */
|
|
18069
|
+
readonly route?: SwapRoute;
|
|
17802
18070
|
/**
|
|
17803
18071
|
* Lifecycle snapshot: `status`, `substatus`, and `substatusMessage`.
|
|
17804
18072
|
*
|
|
@@ -17985,192 +18253,6 @@ interface SwappingProvider {
|
|
|
17985
18253
|
swap<TFromAdapterCapabilities extends AdapterCapabilities>(params: ServiceSwapParams<TFromAdapterCapabilities>): Promise<SwapResult$1>;
|
|
17986
18254
|
}
|
|
17987
18255
|
|
|
17988
|
-
/**
|
|
17989
|
-
* Latest cached USD rate for a single (chain, token) pair, as written by the
|
|
17990
|
-
* Stablecoin Service's `token-rate-update` cron.
|
|
17991
|
-
*
|
|
17992
|
-
* @remarks
|
|
17993
|
-
* The cron refreshes entries once per minute and they expire after 15 minutes
|
|
17994
|
-
* of staleness. Inspect {@link TokenRate.fetchedAt} when freshness matters —
|
|
17995
|
-
* a value older than a few minutes likely means the upstream provider was
|
|
17996
|
-
* unreachable on the most recent run.
|
|
17997
|
-
*
|
|
17998
|
-
* @example
|
|
17999
|
-
* ```typescript
|
|
18000
|
-
* const rate: TokenRate = { priceUSD: '1.0001', fetchedAt: 1716240000000 }
|
|
18001
|
-
* const ageMs = Date.now() - rate.fetchedAt
|
|
18002
|
-
* ```
|
|
18003
|
-
*/
|
|
18004
|
-
interface TokenRate {
|
|
18005
|
-
/**
|
|
18006
|
-
* USD price as reported by the upstream provider.
|
|
18007
|
-
*
|
|
18008
|
-
* Returned as a string to preserve precision — parse with `Number` or a
|
|
18009
|
-
* decimal library depending on how much precision callers need.
|
|
18010
|
-
*/
|
|
18011
|
-
readonly priceUSD: string;
|
|
18012
|
-
/**
|
|
18013
|
-
* Unix timestamp in milliseconds at which the price was fetched from the
|
|
18014
|
-
* upstream provider.
|
|
18015
|
-
*/
|
|
18016
|
-
readonly fetchedAt: number;
|
|
18017
|
-
/**
|
|
18018
|
-
* On-chain decimal precision of the token, when the upstream provider
|
|
18019
|
-
* reports it. Absent for tokens the provider has not catalogued.
|
|
18020
|
-
*
|
|
18021
|
-
* Use it to convert a raw base-unit balance into a human amount before
|
|
18022
|
-
* multiplying by `priceUSD`: `balance / 10 ** decimals * Number(priceUSD)`.
|
|
18023
|
-
*/
|
|
18024
|
-
readonly decimals?: number;
|
|
18025
|
-
}
|
|
18026
|
-
/**
|
|
18027
|
-
* Response payload from `GET /v1/stablecoinKits/rates`.
|
|
18028
|
-
*
|
|
18029
|
-
* Nested map keyed first by chain name (matching the `Blockchain` enum), then
|
|
18030
|
-
* by token address. Address keys preserve the service's canonical casing:
|
|
18031
|
-
* EVM hex addresses are lowercased, Solana base58 mints are case-preserved.
|
|
18032
|
-
*
|
|
18033
|
-
* @remarks
|
|
18034
|
-
* - A successful call always returns a `rates` object, but it may be empty
|
|
18035
|
-
* when no cached entries are found.
|
|
18036
|
-
* - When `addresses` was supplied, missing addresses are simply absent —
|
|
18037
|
-
* there is no 404 for partial lookups.
|
|
18038
|
-
*
|
|
18039
|
-
* @example
|
|
18040
|
-
* ```typescript
|
|
18041
|
-
* const response: GetTokenRatesResponse = {
|
|
18042
|
-
* rates: {
|
|
18043
|
-
* Ethereum: {
|
|
18044
|
-
* '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48': {
|
|
18045
|
-
* priceUSD: '1.0001',
|
|
18046
|
-
* fetchedAt: 1716240000000,
|
|
18047
|
-
* },
|
|
18048
|
-
* },
|
|
18049
|
-
* },
|
|
18050
|
-
* }
|
|
18051
|
-
* ```
|
|
18052
|
-
*/
|
|
18053
|
-
interface GetTokenRatesResponse {
|
|
18054
|
-
/**
|
|
18055
|
-
* Nested map of token rates keyed by `[chain][address]`.
|
|
18056
|
-
*
|
|
18057
|
-
* Always present; may be an empty object when no rates are found.
|
|
18058
|
-
*/
|
|
18059
|
-
readonly rates: Readonly<Record<string, Readonly<Record<string, TokenRate>>>>;
|
|
18060
|
-
}
|
|
18061
|
-
|
|
18062
|
-
/**
|
|
18063
|
-
* MOVED, not new. Lifted from providers/earn-service/src/validations/, where the
|
|
18064
|
-
* same mapper existed; borrow-service uses it instead of adding a second copy.
|
|
18065
|
-
*/
|
|
18066
|
-
|
|
18067
|
-
/**
|
|
18068
|
-
* A single claimed (or claimable) reward token amount.
|
|
18069
|
-
*
|
|
18070
|
-
* @example
|
|
18071
|
-
* ```typescript
|
|
18072
|
-
* import type { ClaimedAmount } from '@core/service-client'
|
|
18073
|
-
*
|
|
18074
|
-
* const reward: ClaimedAmount = {
|
|
18075
|
-
* address: '0x9994E35Db50125E0DF82e4c2dde62496CE330999',
|
|
18076
|
-
* symbol: 'MORPHO',
|
|
18077
|
-
* amount: Amount.fromJSON({ raw: '12500000000000000000', decimals: 18 }),
|
|
18078
|
-
* }
|
|
18079
|
-
* ```
|
|
18080
|
-
*/
|
|
18081
|
-
interface ClaimedAmount$1 {
|
|
18082
|
-
/** Reward token contract address. */
|
|
18083
|
-
readonly address: string;
|
|
18084
|
-
/** Reward token symbol. */
|
|
18085
|
-
readonly symbol: string;
|
|
18086
|
-
/** Claimed (or claimable) amount. */
|
|
18087
|
-
readonly amount: Amount;
|
|
18088
|
-
}
|
|
18089
|
-
|
|
18090
|
-
/**
|
|
18091
|
-
* MOVED, not new. The claim-rewards result types previously declared
|
|
18092
|
-
* identically in providers/earn-service/src/types.ts and
|
|
18093
|
-
* providers/borrow-service/src/types.ts. Both now re-export from here.
|
|
18094
|
-
*/
|
|
18095
|
-
/**
|
|
18096
|
-
* Provider-level result types for the claim-rewards contract.
|
|
18097
|
-
*
|
|
18098
|
-
* The claim-rewards contract returns the same shapes to every kit that
|
|
18099
|
-
* consumes it, so these are declared once here rather than per service.
|
|
18100
|
-
*
|
|
18101
|
-
* @packageDocumentation
|
|
18102
|
-
*/
|
|
18103
|
-
|
|
18104
|
-
/**
|
|
18105
|
-
* Result returned when no rewards were claimable.
|
|
18106
|
-
*
|
|
18107
|
-
* No transaction is submitted in this case, so there is no hash to report.
|
|
18108
|
-
*/
|
|
18109
|
-
interface NoClaimableRewardsResult {
|
|
18110
|
-
/** Discriminant: nothing was claimable. */
|
|
18111
|
-
readonly status: 'no_rewards';
|
|
18112
|
-
/** Always empty. */
|
|
18113
|
-
readonly rewards: readonly [];
|
|
18114
|
-
}
|
|
18115
|
-
/**
|
|
18116
|
-
* Result returned after claimable rewards were submitted on-chain.
|
|
18117
|
-
*
|
|
18118
|
-
* The reward element type is parameterized so a service whose own claimed
|
|
18119
|
-
* amount carries more than the contract-defined fields (e.g.
|
|
18120
|
-
* `@circle-fin/provider-earn-service`, whose `ClaimedAmount` also has
|
|
18121
|
-
* `type`/`status`) can reuse this shape without narrowing `rewards`.
|
|
18122
|
-
*
|
|
18123
|
-
* @typeParam TClaimedAmount - Element type of `rewards`. Defaults to the
|
|
18124
|
-
* contract-defined {@link ClaimedAmount}.
|
|
18125
|
-
*
|
|
18126
|
-
* @example
|
|
18127
|
-
* ```typescript
|
|
18128
|
-
* // Contract-defined rewards.
|
|
18129
|
-
* const claimed: ClaimedRewardsResult = {
|
|
18130
|
-
* status: 'claimed',
|
|
18131
|
-
* rewards: [],
|
|
18132
|
-
* txHash: '0xabc',
|
|
18133
|
-
* explorerUrl: 'https://example.com/tx/0xabc',
|
|
18134
|
-
* }
|
|
18135
|
-
* ```
|
|
18136
|
-
*/
|
|
18137
|
-
interface ClaimedRewardsResult$1<TClaimedAmount = ClaimedAmount$1> {
|
|
18138
|
-
/** Discriminant: rewards were claimed. */
|
|
18139
|
-
readonly status: 'claimed';
|
|
18140
|
-
/** Reward token amounts that were claimed. */
|
|
18141
|
-
readonly rewards: readonly TClaimedAmount[];
|
|
18142
|
-
/** Hash of the confirmed claim transaction. */
|
|
18143
|
-
readonly txHash: string;
|
|
18144
|
-
/** Block-explorer URL for {@link ClaimedRewardsResult.txHash}. */
|
|
18145
|
-
readonly explorerUrl: string;
|
|
18146
|
-
}
|
|
18147
|
-
/**
|
|
18148
|
-
* Result of a claim-rewards operation, discriminated on `status`.
|
|
18149
|
-
*
|
|
18150
|
-
* @typeParam TClaimedAmount - Element type of the claimed `rewards`. Defaults
|
|
18151
|
-
* to the contract-defined {@link ClaimedAmount}.
|
|
18152
|
-
*
|
|
18153
|
-
* @example
|
|
18154
|
-
* ```typescript
|
|
18155
|
-
* declare const result: ClaimRewardsResult
|
|
18156
|
-
* if (result.status === 'claimed') {
|
|
18157
|
-
* console.log(result.txHash)
|
|
18158
|
-
* }
|
|
18159
|
-
* ```
|
|
18160
|
-
*/
|
|
18161
|
-
type ClaimRewardsResult$1<TClaimedAmount = ClaimedAmount$1> = NoClaimableRewardsResult | ClaimedRewardsResult$1<TClaimedAmount>;
|
|
18162
|
-
/**
|
|
18163
|
-
* Read-only claimable-rewards quote.
|
|
18164
|
-
*
|
|
18165
|
-
* Services may extend this with their own optional fields (e.g. EarnKit
|
|
18166
|
-
* carries an always-empty `gasFees` for symmetry with its other quotes); the
|
|
18167
|
-
* `rewards` list itself is contract-defined and identical everywhere.
|
|
18168
|
-
*/
|
|
18169
|
-
interface ClaimRewardsQuoteInfo$1 {
|
|
18170
|
-
/** Reward tokens currently available for claiming. */
|
|
18171
|
-
readonly rewards: readonly ClaimedAmount$1[];
|
|
18172
|
-
}
|
|
18173
|
-
|
|
18174
18256
|
/**
|
|
18175
18257
|
* A type alias that enables flexible provider type handling.
|
|
18176
18258
|
*
|
|
@@ -18543,6 +18625,33 @@ interface SwapConfig {
|
|
|
18543
18625
|
* `apiKey` is omitted, and `apiKey` takes precedence when both are set.
|
|
18544
18626
|
*/
|
|
18545
18627
|
kitKey?: string;
|
|
18628
|
+
/**
|
|
18629
|
+
* Enable or disable atomic batched execution of the approval and swap.
|
|
18630
|
+
*
|
|
18631
|
+
* When `true` (or omitted), an EVM swap that needs an on-chain ERC-20
|
|
18632
|
+
* approval submits the approval and the swap as one atomic batch if the
|
|
18633
|
+
* connected wallet supports it (EIP-5792, or a signing strategy that
|
|
18634
|
+
* declares atomic batching). Set to `false` to force the sequential
|
|
18635
|
+
* approve-then-swap flow.
|
|
18636
|
+
*
|
|
18637
|
+
* @remarks
|
|
18638
|
+
* Has no effect on the gasless permit path, native-token swaps, or Solana,
|
|
18639
|
+
* which already execute as a single transaction. USDT input always uses the
|
|
18640
|
+
* sequential path because its allowance must be reset to zero first. The
|
|
18641
|
+
* batched path relies on the wallet's own gas estimation for the swap call;
|
|
18642
|
+
* set `false` if your wallet under-estimates gas for complex routes or
|
|
18643
|
+
* rejects batched calls.
|
|
18644
|
+
*
|
|
18645
|
+
* @defaultValue `undefined` (batching attempted when the wallet supports it)
|
|
18646
|
+
*
|
|
18647
|
+
* @example
|
|
18648
|
+
* ```typescript
|
|
18649
|
+
* const config: SwapConfig = {
|
|
18650
|
+
* batchTransactions: false, // force sequential approve → swap
|
|
18651
|
+
* }
|
|
18652
|
+
* ```
|
|
18653
|
+
*/
|
|
18654
|
+
batchTransactions?: boolean | undefined;
|
|
18546
18655
|
}
|
|
18547
18656
|
/**
|
|
18548
18657
|
* Estimation result for a swap operation.
|
|
@@ -18655,6 +18764,8 @@ interface SwapEstimate {
|
|
|
18655
18764
|
* and kit fees (if configured). Amounts are in decimal format for display.
|
|
18656
18765
|
*/
|
|
18657
18766
|
readonly fees?: readonly ServiceSwapFee[];
|
|
18767
|
+
/** Provider and executable hops selected for the swap. */
|
|
18768
|
+
readonly route?: SwapRoute;
|
|
18658
18769
|
}
|
|
18659
18770
|
/**
|
|
18660
18771
|
* Configuration for swap results.
|
|
@@ -18795,6 +18906,8 @@ interface SwapResult {
|
|
|
18795
18906
|
* fees (charged by the DEX aggregator/protocol) and kit fees.
|
|
18796
18907
|
*/
|
|
18797
18908
|
fees?: readonly ServiceSwapFee[];
|
|
18909
|
+
/** Provider and executable hops selected for the swap. */
|
|
18910
|
+
readonly route?: SwapRoute;
|
|
18798
18911
|
/**
|
|
18799
18912
|
* Lifecycle snapshot: `status`, `substatus`, and `substatusMessage`.
|
|
18800
18913
|
*
|
|
@@ -47287,6 +47400,8 @@ type OnrampEventEnvelope = OnrampInitializationErrorEnvelope | OnrampInitializat
|
|
|
47287
47400
|
* re-mint.
|
|
47288
47401
|
* - `traceId` — the trace id the server stamped when minting. Echoed
|
|
47289
47402
|
* back so the client can tag widget events with the same id.
|
|
47403
|
+
* - `metadata`: string map echoed on the create response, when the API
|
|
47404
|
+
* sends one. Forwarded to the browser with the rest of the session.
|
|
47290
47405
|
*/
|
|
47291
47406
|
interface OnrampSession {
|
|
47292
47407
|
/**
|
|
@@ -47340,6 +47455,18 @@ interface OnrampSession {
|
|
|
47340
47455
|
* id.
|
|
47341
47456
|
*/
|
|
47342
47457
|
readonly traceId?: string;
|
|
47458
|
+
/**
|
|
47459
|
+
* Request `metadata` as the Onramp API echoed it on the create response.
|
|
47460
|
+
*
|
|
47461
|
+
* @remarks
|
|
47462
|
+
* Present only for a well-formed echo, never copied from the request
|
|
47463
|
+
* params, so absence means the API did not echo it. Returned once: not
|
|
47464
|
+
* sealed into the session token or delivered on later events. A host
|
|
47465
|
+
* that forwards the session to the browser (including via
|
|
47466
|
+
* `createSessionRouteHandler`) also forwards this field, so do not put
|
|
47467
|
+
* server-only values in it.
|
|
47468
|
+
*/
|
|
47469
|
+
readonly metadata?: Readonly<Record<string, string>>;
|
|
47343
47470
|
/**
|
|
47344
47471
|
* Index signature keeping the type tolerant of additive fields.
|
|
47345
47472
|
*
|
|
@@ -47712,9 +47839,8 @@ type OnrampWindowResult = {
|
|
|
47712
47839
|
* contract.
|
|
47713
47840
|
*
|
|
47714
47841
|
* Validation is intentionally conservative: only the fields the kit
|
|
47715
|
-
* actually consumes (or rejects on shape grounds) are checked.
|
|
47716
|
-
*
|
|
47717
|
-
* its own validation on top without the SDK lagging behind.
|
|
47842
|
+
* actually consumes (or rejects on shape grounds) are checked.
|
|
47843
|
+
* `metadata` is a string map. The Onramp API owns its limits.
|
|
47718
47844
|
*
|
|
47719
47845
|
* @packageDocumentation
|
|
47720
47846
|
*/
|
|
@@ -47806,7 +47932,7 @@ declare const onrampSessionRequestSchema: z.ZodObject<{
|
|
|
47806
47932
|
chain: string;
|
|
47807
47933
|
}[] | undefined;
|
|
47808
47934
|
}>>;
|
|
47809
|
-
metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.
|
|
47935
|
+
metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
47810
47936
|
}, "strip", z.ZodTypeAny, {
|
|
47811
47937
|
appUserId: string;
|
|
47812
47938
|
destinationAddress: string;
|
|
@@ -47822,7 +47948,7 @@ declare const onrampSessionRequestSchema: z.ZodObject<{
|
|
|
47822
47948
|
chain: string;
|
|
47823
47949
|
}[] | undefined;
|
|
47824
47950
|
} | undefined;
|
|
47825
|
-
metadata?: Record<string,
|
|
47951
|
+
metadata?: Record<string, string> | undefined;
|
|
47826
47952
|
}, {
|
|
47827
47953
|
appUserId: string;
|
|
47828
47954
|
destinationAddress: string;
|
|
@@ -47838,7 +47964,7 @@ declare const onrampSessionRequestSchema: z.ZodObject<{
|
|
|
47838
47964
|
chain: string;
|
|
47839
47965
|
}[] | undefined;
|
|
47840
47966
|
} | undefined;
|
|
47841
|
-
metadata?: Record<string,
|
|
47967
|
+
metadata?: Record<string, string> | undefined;
|
|
47842
47968
|
}>;
|
|
47843
47969
|
/**
|
|
47844
47970
|
* A single token↔chain pair a host app wants to offer.
|
|
@@ -47893,8 +48019,11 @@ type OnrampAssetSelection = z.infer<typeof onrampAssetSelectionSchema>;
|
|
|
47893
48019
|
* - `assets`: optional host-app scoping for the asset selector (which
|
|
47894
48020
|
* token/chain pairs the widget offers). See {@link OnrampAssetSelection}.
|
|
47895
48021
|
* Baked into the launch URL at mint time; never forwarded to wallets-api.
|
|
47896
|
-
* - `metadata`:
|
|
47897
|
-
*
|
|
48022
|
+
* - `metadata`: optional string map. The Onramp API rejects more than 20
|
|
48023
|
+
* keys, keys over 64 characters, values over 1024 characters, and
|
|
48024
|
+
* control characters. It is echoed once on the create response (see
|
|
48025
|
+
* {@link OnrampSession.metadata}) and is not delivered on later widget
|
|
48026
|
+
* events, so use `appUserId` to correlate the user.
|
|
47898
48027
|
*
|
|
47899
48028
|
* Note: the embedding-domain allowlist entry (`referrerDomain`) is **not**
|
|
47900
48029
|
* part of this request. It is a server-only concern configured on
|
|
@@ -53737,4 +53866,4 @@ declare function isTokenAddress(token: string, chain: ChainDefinition): token is
|
|
|
53737
53866
|
declare function validateToken(token: string, chain: ChainDefinition): TokenValidationResult;
|
|
53738
53867
|
|
|
53739
53868
|
export { AppKit, AppKitUnifiedBalance, BalanceError, Blockchain, BorrowChain, BorrowError, BorrowKit, BorrowServiceProvider, BridgeChain, EARN_EXECUTE_REVIEW_KIND, EarnChain, EarnError, EarnKit, InputError, KitError, NetworkError, OnchainError, QUOTE_NOT_REUSED_WARNING_CODE, RateLimitError, RpcError, SPEED_DOWNGRADED_WARNING_CODE, ServiceError, SwapChain, TOKEN_ALIASES, TransferSpeed, UnifiedBalanceChain, anyDepositParamsSchema, assertBorrowParams, addCollateral as borrowAddCollateral, addCollateralParamsSchema as borrowAddCollateralParamsSchema, addCollateralQuoteParamsSchema as borrowAddCollateralQuoteParamsSchema, borrow as borrowBorrow, claimRewards as borrowClaimRewards, claimRewardsParamsSchema as borrowClaimRewardsParamsSchema, closeLoan as borrowCloseLoan, closeLoanParamsSchema as borrowCloseLoanParamsSchema, closeLoanQuoteParamsSchema as borrowCloseLoanQuoteParamsSchema, exploreMarkets as borrowExploreMarkets, exploreMarketsIterator as borrowExploreMarketsIterator, exploreMarketsIteratorParamsSchema as borrowExploreMarketsIteratorParamsSchema, exploreMarketsParamsSchema as borrowExploreMarketsParamsSchema, getAddCollateralQuote as borrowGetAddCollateralQuote, getBorrowQuote as borrowGetBorrowQuote, getClaimRewardsQuote as borrowGetClaimRewardsQuote, getClaimRewardsQuoteParamsSchema as borrowGetClaimRewardsQuoteParamsSchema, getCloseLoanQuote as borrowGetCloseLoanQuote, getIntegratorConfig as borrowGetIntegratorConfig, getIntegratorConfigParamsSchema as borrowGetIntegratorConfigParamsSchema, getLoans as borrowGetLoans, getLoansParamsSchema as borrowGetLoansParamsSchema, getMarket as borrowGetMarket, getMarketParamsSchema as borrowGetMarketParamsSchema, getMaxBorrow as borrowGetMaxBorrow, getPosition as borrowGetPosition, getPositionParamsSchema as borrowGetPositionParamsSchema, getRepayQuote as borrowGetRepayQuote, getRequiredCollateral as borrowGetRequiredCollateral, getSupportedChains as borrowGetSupportedChains, getWithdrawCollateralRepayIfNeededQuote as borrowGetWithdrawCollateralRepayIfNeededQuote, borrowParamsSchema, borrowQuoteParamsSchema, registerWebhook as borrowRegisterWebhook, registerWebhookParamsSchema as borrowRegisterWebhookParamsSchema, repay as borrowRepay, repayParamsSchema as borrowRepayParamsSchema, repayQuoteParamsSchema as borrowRepayQuoteParamsSchema, requiredCollateralParamsSchema as borrowRequiredCollateralParamsSchema, setIntegratorConfig as borrowSetIntegratorConfig, setIntegratorConfigParamsSchema as borrowSetIntegratorConfigParamsSchema, withdrawCollateralParamsSchema as borrowWithdrawCollateralParamsSchema, withdrawCollateralQuoteParamsSchema as borrowWithdrawCollateralQuoteParamsSchema, withdrawCollateralRepayIfNeeded as borrowWithdrawCollateralRepayIfNeeded, claimRewardsParamsSchema$1 as claimRewardsParamsSchema, createBorrowKitContext, createEarnKitContext, depositParamsSchema, claimRewards$1 as earnClaimRewards, deposit as earnDeposit, exploreVaults as earnExploreVaults, exploreVaultsIterator as earnExploreVaultsIterator, getClaimRewardsQuote$1 as earnGetClaimRewardsQuote, getCrossChainDepositStatus as earnGetCrossChainDepositStatus, getCrossChainDepositStatusOutcome as earnGetCrossChainDepositStatusOutcome, getDepositQuote as earnGetDepositQuote, getPosition$1 as earnGetPosition, getSupportedChains$1 as earnGetSupportedChains, getVaults as earnGetVaults, getWithdrawalQuote as earnGetWithdrawalQuote, waitForCrossChainDeposit as earnWaitForCrossChainDeposit, withdraw as earnWithdraw, exploreVaultsIteratorParamsSchema, exploreVaultsParamsSchema, getClaimRewardsQuoteParamsSchema$1 as getClaimRewardsQuoteParamsSchema, getCrossChainDepositStatusParamsSchema, getDepositQuoteParamsSchema, getErrorCode, getErrorMessage, getPositionParamsSchema$1 as getPositionParamsSchema, getTokenDecimals, getVaultsParamsSchema, getWithdrawalQuoteParamsSchema, isBalanceError, isBorrowErrorTrace, isEarnExecuteReview, isFatalError, isInputError, isKitError, isNetworkError, isOnchainError, isRateLimitError, isResumableError, isRetryableError, isRpcError, isServiceError, isTerminalCrossChainDepositStatus as isTerminalEarnCrossChainDepositStatus, isTokenAddress, isTokenAlias, isUserCancellationError, maxBorrowParamsSchema, retryBorrow, setExternalPrefix, validateToken, waitForCrossChainDepositParamsSchema, withdrawParamsSchema };
|
|
53740
|
-
export type { ActionHandler, AdapterContext, AllowanceStrategy$2 as AllowanceStrategy, AppKitActionName, AppKitActions, AppKitBorrowActions, AppKitBorrowOperations, AppKitBridgeActions, AppKitConfig, AppKitContext, AppKitCustomFeePolicy, AppKitCustomFeePolicyScope, AppKitEarnActions, AppKitEarnOperations, AppKitOnrampClientConfig, AppKitOnrampOperations, AppKitUnifiedBalanceActions, BaseChainDefinition, BorrowActionBase, BorrowActions, BorrowAdapterContext, AddCollateralParams as BorrowAddCollateralParams, AddCollateralQuote as BorrowAddCollateralQuote, AddCollateralQuoteParams as BorrowAddCollateralQuoteParams, AddCollateralResult as BorrowAddCollateralResult, BorrowAssetAmount, BorrowChainDefinition, BorrowChainIdentifier, ClaimRewardsParams as BorrowClaimRewardsParams, BorrowClaimRewardsQuoteInfo, BorrowClaimRewardsResult, BorrowClaimedAmount, BorrowClaimedRewardsResult, CloseLoanParams as BorrowCloseLoanParams, CloseLoanQuote as BorrowCloseLoanQuote, CloseLoanQuoteParams as BorrowCloseLoanQuoteParams, CloseLoanResult as BorrowCloseLoanResult, ConfirmedAddCollateralDetailsUnavailableResult as BorrowConfirmedAddCollateralDetailsUnavailableResult, ConfirmedAddCollateralResult as BorrowConfirmedAddCollateralResult, ConfirmedCloseLoanDetailsUnavailableResult as BorrowConfirmedCloseLoanDetailsUnavailableResult, ConfirmedCloseLoanResult as BorrowConfirmedCloseLoanResult, ConfirmedRepayDetailsUnavailableResult as BorrowConfirmedRepayDetailsUnavailableResult, ConfirmedRepayResult as BorrowConfirmedRepayResult, ConfirmedWithdrawCollateralDetailsUnavailableResult as BorrowConfirmedWithdrawCollateralDetailsUnavailableResult, ConfirmedWithdrawCollateralResult as BorrowConfirmedWithdrawCollateralResult, BorrowErrorTrace, BorrowExecutionParams, ExploreMarketsIteratorParams as BorrowExploreMarketsIteratorParams, ExploreMarketsParams as BorrowExploreMarketsParams, ExploreMarketsResult as BorrowExploreMarketsResult, BorrowFee, GetClaimRewardsQuoteParams as BorrowGetClaimRewardsQuoteParams, GetIntegratorConfigParams as BorrowGetIntegratorConfigParams, GetLoansParams as BorrowGetLoansParams, GetMarketParams as BorrowGetMarketParams, GetPositionParams as BorrowGetPositionParams, HealthFactorBand as BorrowHealthFactorBand, BorrowInstruction, IntegratorConfig as BorrowIntegratorConfig, BorrowKitConfig, BorrowKitContext, ListLoansResult as BorrowListLoansResult, Loan as BorrowLoan, LoanDataStatus as BorrowLoanDataStatus, LoanExecution as BorrowLoanExecution, BorrowLoanInfo, LoanStatus as BorrowLoanStatus, BorrowMarketAsset, MarketInfo as BorrowMarketInfo, MarketSortBy as BorrowMarketSortBy, BorrowMoreParams, BorrowMoreQuoteParams, NoClaimableRewardsResult as BorrowNoClaimableRewardsResult, OpenLoanParams as BorrowOpenLoanParams, OpenLoanQuoteParams as BorrowOpenLoanQuoteParams, BorrowOperationName, BorrowOperationResultBase, BorrowPagination, BorrowParams, BorrowPosition, BorrowProtocol, BorrowingProvider as BorrowProvider, BorrowQuote, BorrowQuoteGas, BorrowQuoteGasFee, BorrowQuoteParams, RegisterWebhookParams as BorrowRegisterWebhookParams, RegisterWebhookResult as BorrowRegisterWebhookResult, RepayParams as BorrowRepayParams, RepayQuote as BorrowRepayQuote, RepayQuoteParams as BorrowRepayQuoteParams, RepayResult as BorrowRepayResult, RequiredCollateralParams as BorrowRequiredCollateralParams, RequiredCollateralQuote as BorrowRequiredCollateralQuote, BorrowResult, BorrowRetryResult, BorrowServiceConfig, SetIntegratorConfigParams as BorrowSetIntegratorConfigParams, BorrowStep, BorrowStepBase, BorrowStepName, SubmittedAddCollateralResult as BorrowSubmittedAddCollateralResult, SubmittedCloseLoanResult as BorrowSubmittedCloseLoanResult, SubmittedRepayResult as BorrowSubmittedRepayResult, SubmittedWithdrawCollateralResult as BorrowSubmittedWithdrawCollateralResult, BorrowTokenRecipient, WithdrawCollateralExecution as BorrowWithdrawCollateralExecution, WithdrawCollateralParams as BorrowWithdrawCollateralParams, WithdrawCollateralQuote as BorrowWithdrawCollateralQuote, WithdrawCollateralQuoteParams as BorrowWithdrawCollateralQuoteParams, WithdrawCollateralResult as BorrowWithdrawCollateralResult, BridgeConfig, CustomFeePolicy$2 as BridgeCustomFeePolicy, BridgeEstimateResult, BridgeExecutionConfig, BridgeParams, BridgeResult, BridgeStep, BridgeSupportedChainsOptions, BridgeWarning, CCTPConfig, CCTPMergedConfig, CCTPSplitConfig, ChainDefinition, ConfirmedBorrowDetailsUnavailableResult, ConfirmedBorrowOperationResultBase, ConfirmedBorrowResult, ConfirmedDetailsUnavailableBorrowOperationResultBase, Currency, DecodedEarnTx, DelegateStatus, DepositForParams, DepositParams, DepositResult, DeveloperFeeHooks, EVMChainDefinition, EarnAccruedRewardInfo, EarnAdapterContext, AnyDepositParams as EarnAnyDepositParams, EarnAssetAmount, EarnBridgeCctpStatus, EarnBridgeHopStatus, EarnBridgeQuoteExpiry, ClaimRewardsParams$1 as EarnClaimRewardsParams, EarnClaimRewardsQuoteInfo, EarnClaimRewardsResult, EarnClaimedAmount, EarnClaimedRewardsResult, EarnConfig, EarnCrossChainDepositDestination, CrossChainDepositParams as EarnCrossChainDepositParams, EarnCrossChainDepositResult, EarnCrossChainDepositStatus, EarnCrossChainDepositWaitOutcome, EarnCrossChainDepositWaitResult, CrossChainGetDepositQuoteParams as EarnCrossChainGetDepositQuoteParams, EarnDepositOutcome, DepositParams$2 as EarnDepositParams, EarnDepositQuoteInfo, EarnDepositResult, EarnEncodedTransaction, EarnExecuteAuthorizationReview, EarnExecuteReview, ExploreVaultsIteratorParams as EarnExploreVaultsIteratorParams, ExploreVaultsPagination as EarnExploreVaultsPagination, ExploreVaultsParams as EarnExploreVaultsParams, EarnExploreVaultsResult, ExploreVaultsSortBy as EarnExploreVaultsSortBy, EarnGasFeeEstimate, EarnGasFeeEstimateBase, GetClaimRewardsQuoteParams$1 as EarnGetClaimRewardsQuoteParams, GetCrossChainDepositStatusParams as EarnGetCrossChainDepositStatusParams, GetDepositQuoteParams as EarnGetDepositQuoteParams, GetPositionParams$1 as EarnGetPositionParams, GetVaultsParams as EarnGetVaultsParams, EarnGetVaultsResult, GetWithdrawalQuoteParams as EarnGetWithdrawalQuoteParams, EarnKitConfig, EarnKitContext, EarnOperationParams, EarnPositionInfo, EarnPositionPnLInfo, EarningProvider as EarnProvider, SameChainDepositParams as EarnSameChainDepositParams, EarnSameChainDepositResult, SameChainGetDepositQuoteParams as EarnSameChainGetDepositQuoteParams, EarnServiceConfig, EarnVaultInfo, VaultQuery as EarnVaultQuery, WaitForCrossChainDepositParams as EarnWaitForCrossChainDepositParams, WithdrawParams as EarnWithdrawParams, EarnWithdrawResult, EarnWithdrawalQuoteInfo, ErrorDetails, EstimateResult$1 as EstimateResult, EstimateSpendResult, EstimatedGas, FeeOperationType, FetchOnrampSessionOptions, GetBalancesParams, GetBalancesResult, GetDelegateStatusParams, GetSupportedChainsOptions, GetSwapStatusParams, GetTokenRatesParams, GetTokenRatesResult, InitiateRemoveFundParams, InitiateRemoveFundResult, KitContractType, MaxBorrowParams, MaxBorrowQuote, MintedOnrampSession, NonEVMChainDefinition, OnrampAssetSelection, OnrampDepositInfo, OnrampDepositNotCompletedCode, OnrampDepositNotCompletedEnvelope, OnrampDepositSettledEnvelope, OnrampDepositSubmittedEnvelope, OnrampEventCode, OnrampEventEnvelope, OnrampEventType, OnrampIframeOptions, OnrampInitializationErrorCode, OnrampInitializationErrorEnvelope, OnrampInitializationSuccessEnvelope, OnrampLifecycleOptions, OnrampPaymentMethod, OnrampSession, OnrampSessionRequest, OnrampWidget, OnrampWidgetAnyHandler, OnrampWidgetEventHandler, OnrampWidgetLifecycle, OnrampWindowBlockedReason, OnrampWindowOptions, OnrampWindowResult, OperationParamsMap, OperationType, ReceiveExactEstimateResult, ReceiveExactFeeItem, Recoverability, RemoveFundParams, RemoveFundResult, RetryContext, SendParams, SpendDestination, SpendParams, SpendResult, SubmittedBorrowOperationResultBase, SubmittedBorrowResult, SwapConfig, CustomFeePolicy$1 as SwapCustomFeePolicy, SwapDestinationLeg, SwapEstimate, SwapFeeContext, SwapKitConfig, SwapKitContext, SwapParams, SwapProgress, SwapResult, SwapSourceLeg, SwapStatus, SwapStatusResult, SwapTerminalStatus, TokenChainPair, TokenInfo, TokenRate, UnifiedBalanceChainIdentifier, CustomFeePolicy as UnifiedBalanceCustomFeePolicy, FeeRecipientsConfig as UnifiedBalanceFeeRecipientsConfig, UnifiedBalanceKitConfig, SupportedToken as UnifiedBalanceSupportedToken, UpdateDelegateParams, UpdateDelegateResult, VersionConfig, WaitForSwapDiscreteParams, WaitForSwapParams, WaitForSwapResultParams };
|
|
53869
|
+
export type { ActionHandler, AdapterContext, AllowanceStrategy$2 as AllowanceStrategy, AppKitActionName, AppKitActions, AppKitBorrowActions, AppKitBorrowOperations, AppKitBridgeActions, AppKitConfig, AppKitContext, AppKitCustomFeePolicy, AppKitCustomFeePolicyScope, AppKitEarnActions, AppKitEarnOperations, AppKitOnrampClientConfig, AppKitOnrampOperations, AppKitUnifiedBalanceActions, BaseChainDefinition, BorrowActionBase, BorrowActions, BorrowAdapterContext, AddCollateralParams as BorrowAddCollateralParams, AddCollateralQuote as BorrowAddCollateralQuote, AddCollateralQuoteParams as BorrowAddCollateralQuoteParams, AddCollateralResult as BorrowAddCollateralResult, BorrowAssetAmount, BorrowChainDefinition, BorrowChainIdentifier, ClaimRewardsParams as BorrowClaimRewardsParams, BorrowClaimRewardsQuoteInfo, BorrowClaimRewardsResult, BorrowClaimedAmount, BorrowClaimedRewardsResult, CloseLoanParams as BorrowCloseLoanParams, CloseLoanQuote as BorrowCloseLoanQuote, CloseLoanQuoteParams as BorrowCloseLoanQuoteParams, CloseLoanResult as BorrowCloseLoanResult, ConfirmedAddCollateralDetailsUnavailableResult as BorrowConfirmedAddCollateralDetailsUnavailableResult, ConfirmedAddCollateralResult as BorrowConfirmedAddCollateralResult, ConfirmedCloseLoanDetailsUnavailableResult as BorrowConfirmedCloseLoanDetailsUnavailableResult, ConfirmedCloseLoanResult as BorrowConfirmedCloseLoanResult, ConfirmedRepayDetailsUnavailableResult as BorrowConfirmedRepayDetailsUnavailableResult, ConfirmedRepayResult as BorrowConfirmedRepayResult, ConfirmedWithdrawCollateralDetailsUnavailableResult as BorrowConfirmedWithdrawCollateralDetailsUnavailableResult, ConfirmedWithdrawCollateralResult as BorrowConfirmedWithdrawCollateralResult, BorrowErrorTrace, BorrowExecutionParams, ExploreMarketsIteratorParams as BorrowExploreMarketsIteratorParams, ExploreMarketsParams as BorrowExploreMarketsParams, ExploreMarketsResult as BorrowExploreMarketsResult, BorrowFee, GetClaimRewardsQuoteParams as BorrowGetClaimRewardsQuoteParams, GetIntegratorConfigParams as BorrowGetIntegratorConfigParams, GetLoansParams as BorrowGetLoansParams, GetMarketParams as BorrowGetMarketParams, GetPositionParams as BorrowGetPositionParams, HealthFactorBand as BorrowHealthFactorBand, BorrowInstruction, IntegratorConfig as BorrowIntegratorConfig, BorrowKitConfig, BorrowKitContext, ListLoansResult as BorrowListLoansResult, Loan as BorrowLoan, LoanDataStatus as BorrowLoanDataStatus, LoanExecution as BorrowLoanExecution, BorrowLoanInfo, LoanStatus as BorrowLoanStatus, BorrowMarketAsset, MarketInfo as BorrowMarketInfo, MarketSortBy as BorrowMarketSortBy, BorrowMoreParams, BorrowMoreQuoteParams, NoClaimableRewardsResult as BorrowNoClaimableRewardsResult, OpenLoanParams as BorrowOpenLoanParams, OpenLoanQuoteParams as BorrowOpenLoanQuoteParams, BorrowOperationName, BorrowOperationResultBase, BorrowPagination, BorrowParams, BorrowPosition, BorrowProtocol, BorrowingProvider as BorrowProvider, BorrowQuote, BorrowQuoteGas, BorrowQuoteGasFee, BorrowQuoteParams, RegisterWebhookParams as BorrowRegisterWebhookParams, RegisterWebhookResult as BorrowRegisterWebhookResult, RepayParams as BorrowRepayParams, RepayQuote as BorrowRepayQuote, RepayQuoteParams as BorrowRepayQuoteParams, RepayResult as BorrowRepayResult, RequiredCollateralParams as BorrowRequiredCollateralParams, RequiredCollateralQuote as BorrowRequiredCollateralQuote, BorrowResult, BorrowRetryResult, BorrowServiceConfig, SetIntegratorConfigParams as BorrowSetIntegratorConfigParams, BorrowStep, BorrowStepBase, BorrowStepName, SubmittedAddCollateralResult as BorrowSubmittedAddCollateralResult, SubmittedCloseLoanResult as BorrowSubmittedCloseLoanResult, SubmittedRepayResult as BorrowSubmittedRepayResult, SubmittedWithdrawCollateralResult as BorrowSubmittedWithdrawCollateralResult, BorrowTokenRecipient, WithdrawCollateralExecution as BorrowWithdrawCollateralExecution, WithdrawCollateralParams as BorrowWithdrawCollateralParams, WithdrawCollateralQuote as BorrowWithdrawCollateralQuote, WithdrawCollateralQuoteParams as BorrowWithdrawCollateralQuoteParams, WithdrawCollateralResult as BorrowWithdrawCollateralResult, BridgeConfig, CustomFeePolicy$2 as BridgeCustomFeePolicy, BridgeEstimateResult, BridgeExecutionConfig, BridgeParams, BridgeResult, BridgeStep, BridgeSupportedChainsOptions, BridgeWarning, CCTPConfig, CCTPMergedConfig, CCTPSplitConfig, ChainDefinition, ConfirmedBorrowDetailsUnavailableResult, ConfirmedBorrowOperationResultBase, ConfirmedBorrowResult, ConfirmedDetailsUnavailableBorrowOperationResultBase, Currency, DecodedEarnTx, DelegateStatus, DepositForParams, DepositParams, DepositResult, DeveloperFeeHooks, EVMChainDefinition, EarnAccruedRewardInfo, EarnAdapterContext, AnyDepositParams as EarnAnyDepositParams, EarnAssetAmount, EarnBridgeCctpStatus, EarnBridgeHopStatus, EarnBridgeQuoteExpiry, ClaimRewardsParams$1 as EarnClaimRewardsParams, EarnClaimRewardsQuoteInfo, EarnClaimRewardsResult, EarnClaimedAmount, EarnClaimedRewardsResult, EarnConfig, EarnCrossChainDepositDestination, CrossChainDepositParams as EarnCrossChainDepositParams, EarnCrossChainDepositResult, EarnCrossChainDepositStatus, EarnCrossChainDepositWaitOutcome, EarnCrossChainDepositWaitResult, CrossChainGetDepositQuoteParams as EarnCrossChainGetDepositQuoteParams, EarnDepositOutcome, DepositParams$2 as EarnDepositParams, EarnDepositQuoteInfo, EarnDepositResult, EarnEncodedTransaction, EarnExecuteAuthorizationReview, EarnExecuteReview, ExploreVaultsIteratorParams as EarnExploreVaultsIteratorParams, ExploreVaultsPagination as EarnExploreVaultsPagination, ExploreVaultsParams as EarnExploreVaultsParams, EarnExploreVaultsResult, ExploreVaultsSortBy as EarnExploreVaultsSortBy, EarnGasFeeEstimate, EarnGasFeeEstimateBase, GetClaimRewardsQuoteParams$1 as EarnGetClaimRewardsQuoteParams, GetCrossChainDepositStatusParams as EarnGetCrossChainDepositStatusParams, GetDepositQuoteParams as EarnGetDepositQuoteParams, GetPositionParams$1 as EarnGetPositionParams, GetVaultsParams as EarnGetVaultsParams, EarnGetVaultsResult, GetWithdrawalQuoteParams as EarnGetWithdrawalQuoteParams, EarnKitConfig, EarnKitContext, EarnOperationParams, EarnPositionInfo, EarnPositionPnLInfo, EarningProvider as EarnProvider, SameChainDepositParams as EarnSameChainDepositParams, EarnSameChainDepositResult, SameChainGetDepositQuoteParams as EarnSameChainGetDepositQuoteParams, EarnServiceConfig, EarnVaultInfo, VaultQuery as EarnVaultQuery, WaitForCrossChainDepositParams as EarnWaitForCrossChainDepositParams, WithdrawParams as EarnWithdrawParams, EarnWithdrawResult, EarnWithdrawalQuoteInfo, ErrorDetails, EstimateResult$1 as EstimateResult, EstimateSpendResult, EstimatedGas, FeeOperationType, FetchOnrampSessionOptions, GetBalancesParams, GetBalancesResult, GetDelegateStatusParams, GetSupportedChainsOptions, GetSwapStatusParams, GetTokenRatesParams, GetTokenRatesResult, InitiateRemoveFundParams, InitiateRemoveFundResult, KitContractType, MaxBorrowParams, MaxBorrowQuote, MintedOnrampSession, NonEVMChainDefinition, OnrampAssetSelection, OnrampDepositInfo, OnrampDepositNotCompletedCode, OnrampDepositNotCompletedEnvelope, OnrampDepositSettledEnvelope, OnrampDepositSubmittedEnvelope, OnrampEventCode, OnrampEventEnvelope, OnrampEventType, OnrampIframeOptions, OnrampInitializationErrorCode, OnrampInitializationErrorEnvelope, OnrampInitializationSuccessEnvelope, OnrampLifecycleOptions, OnrampPaymentMethod, OnrampSession, OnrampSessionRequest, OnrampWidget, OnrampWidgetAnyHandler, OnrampWidgetEventHandler, OnrampWidgetLifecycle, OnrampWindowBlockedReason, OnrampWindowOptions, OnrampWindowResult, OperationParamsMap, OperationType, ReceiveExactEstimateResult, ReceiveExactFeeItem, Recoverability, RemoveFundParams, RemoveFundResult, RetryContext, SendParams, SpendDestination, SpendParams, SpendResult, SubmittedBorrowOperationResultBase, SubmittedBorrowResult, SwapConfig, CustomFeePolicy$1 as SwapCustomFeePolicy, SwapDestinationLeg, SwapEstimate, SwapFeeContext, SwapKitConfig, SwapKitContext, SwapParams, SwapProgress, SwapResult, SwapRoute, SwapRouteStep, SwapRouteStepEstimate, SwapRouteToken, SwapSourceLeg, SwapStatus, SwapStatusResult, SwapTerminalStatus, TokenChainPair, TokenInfo, TokenRate, UnifiedBalanceChainIdentifier, CustomFeePolicy as UnifiedBalanceCustomFeePolicy, FeeRecipientsConfig as UnifiedBalanceFeeRecipientsConfig, UnifiedBalanceKitConfig, SupportedToken as UnifiedBalanceSupportedToken, UpdateDelegateParams, UpdateDelegateResult, VersionConfig, WaitForSwapDiscreteParams, WaitForSwapParams, WaitForSwapResultParams };
|