@kittycorn-labs/universal-router-sdk 1.4.42 → 2.0.0

package/dist/{entities → cjs/src/entities}/Command.d.ts

@@ -1,12 +1,12 @@
-import { RoutePlanner } from '../utils/routerCommands';
-export declare type TradeConfig = {
-    allowRevert: boolean;
-};
-export declare enum RouterActionType {
-    UniswapTrade = "UniswapTrade",
-    UnwrapWETH = "UnwrapWETH"
-}
-export interface Command {
-    tradeType: RouterActionType;
-    encode(planner: RoutePlanner, config: TradeConfig): void;
-}
+import { RoutePlanner } from '../utils/routerCommands';
+export type TradeConfig = {
+    allowRevert: boolean;
+};
+export declare enum RouterActionType {
+    UniswapTrade = "UniswapTrade",
+    UnwrapWETH = "UnwrapWETH"
+}
+export interface Command {
+    tradeType: RouterActionType;
+    encode(planner: RoutePlanner, config: TradeConfig): void;
+}

package/dist/cjs/src/entities/Command.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RouterActionType = void 0;
+var RouterActionType;
+(function (RouterActionType) {
+    RouterActionType["UniswapTrade"] = "UniswapTrade";
+    RouterActionType["UnwrapWETH"] = "UnwrapWETH";
+})(RouterActionType = exports.RouterActionType || (exports.RouterActionType = {}));
+//# sourceMappingURL=Command.js.map

package/dist/cjs/src/entities/Command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Command.js","sourceRoot":"","sources":["../../../../src/entities/Command.ts"],"names":[],"mappings":";;;AAMA,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,iDAA6B,CAAA;IAC7B,6CAAyB,CAAA;AAC3B,CAAC,EAHW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAG3B"}

package/dist/cjs/src/entities/actions/across.d.ts

@@ -0,0 +1,21 @@
+import { BigNumberish } from '@ethersproject/bignumber';
+/**
+ * Parameters for Across V4 Deposit V3 command
+ * Used for cross-chain bridging via Across Protocol V3 SpokePool
+ */
+export type AcrossV4DepositV3Params = {
+    depositor: string;
+    recipient: string;
+    inputToken: string;
+    outputToken: string;
+    inputAmount: BigNumberish;
+    outputAmount: BigNumberish;
+    destinationChainId: number;
+    exclusiveRelayer: string;
+    quoteTimestamp: number;
+    fillDeadline: number;
+    exclusivityDeadline: number;
+    message: string;
+    useNative: boolean;
+};
+export { CONTRACT_BALANCE } from '../../utils/constants';

package/dist/cjs/src/entities/actions/across.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CONTRACT_BALANCE = void 0;
+// Export CONTRACT_BALANCE constant for convenience
+var constants_1 = require("../../utils/constants");
+Object.defineProperty(exports, "CONTRACT_BALANCE", { enumerable: true, get: function () { return constants_1.CONTRACT_BALANCE; } });
+//# sourceMappingURL=across.js.map

package/dist/cjs/src/entities/actions/across.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"across.js","sourceRoot":"","sources":["../../../../../src/entities/actions/across.ts"],"names":[],"mappings":";;;AAsBA,mDAAmD;AACnD,mDAAwD;AAA/C,6GAAA,gBAAgB,OAAA"}

package/dist/{entities → cjs/src/entities}/actions/index.d.ts

@@ -1,2 +1,3 @@
-export * from './uniswap';
-export * from './unwrapWETH';
+export * from './uniswap';
+export * from './unwrapWETH';
+export * from './across';

package/dist/cjs/src/entities/actions/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./uniswap"), exports);
+tslib_1.__exportStar(require("./unwrapWETH"), exports);
+tslib_1.__exportStar(require("./across"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/src/entities/actions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/entities/actions/index.ts"],"names":[],"mappings":";;;AAAA,oDAAyB;AACzB,uDAA4B;AAC5B,mDAAwB"}

package/dist/cjs/src/entities/actions/uniswap.d.ts

@@ -0,0 +1,94 @@
+import { RoutePlanner } from '../../utils/routerCommands';
+import { FeeOptions } from '@kittycorn-labs/v3-sdk';
+import { Trade as RouterTrade, SwapOptions as RouterSwapOptions } from '@kittycorn-labs/router-sdk';
+import { Permit2Permit } from '../../utils/inputTokens';
+import { Currency, TradeType } from '@kittycorn-labs/sdk-core';
+import { Command, RouterActionType, TradeConfig } from '../Command';
+import { UniversalRouterVersion } from '../../utils/constants';
+import { BigNumberish } from '@ethersproject/bignumber';
+export type FlatFeeOptions = {
+    amount: BigNumberish;
+    recipient: string;
+};
+export declare const MAX_FEE_RECIPIENTS = 4;
+export declare enum TokenTransferMode {
+    Permit2 = "Permit2",
+    ApproveProxy = "ApproveProxy"
+}
+export type RouterBalanceInput = {
+    /**
+     * Optional floor on the router's input-token balance, enforced by a `BALANCE_CHECK_ERC20`
+     * command before any swap runs, so an under-funded router reverts up front rather than
+     * swapping a short amount. Use when the funding amount is guaranteed by the caller.
+     *
+     * This is a distinct guarantee from `slippageTolerance`: the trade-level minimum output
+     * only catches a shortfall large enough to breach it, so a wide tolerance can let an
+     * under-delivery through. This bounds the input side directly.
+     */
+    minimumAmount?: BigNumberish;
+};
+export type SwapOptions = Omit<RouterSwapOptions, 'inputTokenPermit' | 'fee'> & {
+    /** Each entry's fee is a fraction of the GROSS output (the SDK rescales later entries); >1 entry needs urVersion >= V2_1_1, and flatFee is mutually exclusive. */
+    fee?: FeeOptions | FeeOptions[];
+    useRouterBalance?: boolean;
+    /**
+     * The input Token is the chain's native gas token exposed via an ERC20 predeploy whose balance
+     * mirrors the native balance (e.g. USDC on Arc). The swap is funded by attaching
+     * msg.value = maximumAmountIn * 10^(18 - token.decimals) instead of pulling via Permit2:
+     * the router self-funds (payerIsUser = false) and unused input is swept back to the recipient
+     * on exact-output / partial-fill-risk trades. No ERC20 approval or permit is ever needed.
+     * Incompatible with native input, inputTokenPermit, and TokenTransferMode.ApproveProxy.
+     */
+    nativeErc20Input?: boolean;
+    /**
+     * Fund the swap from the Universal Router's own balance of the input token, spending
+     * whatever it holds at execution time rather than pulling a fixed amount from a payer
+     * (`payerIsUser = false`, first hop encoded as `CONTRACT_BALANCE`).
+     *
+     * This is for flows where the router is funded by a third party in the same transaction
+     * and the delivered amount is not known when the calldata is built, e.g. a bridge filler
+     * that deposits into the router and swaps atomically. Distinct from `useRouterBalance`,
+     * which keeps the fixed quoted `amountIn`.
+     *
+     * Requires an explicit `recipient` (the caller of `execute()` is not the beneficiary)
+     * and `TradeType.EXACT_INPUT` on a single (non-split) route. Supported for v2, v3, v4
+     * and mixed routes. A native input is funded by attaching msg.value to `execute()`
+     * (raw transfers to the router revert) and is wrapped in full via
+     * `WRAP_ETH(CONTRACT_BALANCE)`, with a trailing ETH dust sweep to the recipient; it
+     * requires a route that wraps, so pure-native v4 routes are unsupported.
+     * Incompatible with `inputTokenPermit`, `nativeErc20Input`, and
+     * `TokenTransferMode.ApproveProxy`.
+     */
+    routerBalanceInput?: RouterBalanceInput;
+    /**
+     * Hook addresses whose pools need the swap input already in the PoolManager when the
+     * hook runs, e.g. ERC-4626 wrapper hooks that `take` the input inside `beforeSwap` to
+     * deposit it into a vault. A v4 route through any of these hooks is encoded as
+     * `SETTLE(amountIn)` then a swap on the open delta, the order mixed-route v4 sections
+     * already use, instead of settling after the swap. The swap spends what actually arrived,
+     * so an input token whose transfers round down cannot leave an unsettled delta.
+     * Exact-input only: an exact-output route through one of these hooks is refused.
+     * Matching is case-insensitive.
+     */
+    settleBeforeSwapHooks?: string[];
+    inputTokenPermit?: Permit2Permit;
+    flatFee?: FlatFeeOptions;
+    safeMode?: boolean;
+    urVersion?: UniversalRouterVersion;
+    tokenTransferMode?: TokenTransferMode;
+    chainId?: number;
+};
+export declare class UniswapTrade implements Command {
+    trade: RouterTrade<Currency, Currency, TradeType>;
+    options: SwapOptions;
+    readonly tradeType: RouterActionType;
+    readonly payerIsUser: boolean;
+    constructor(trade: RouterTrade<Currency, Currency, TradeType>, options: SwapOptions);
+    get isAllV4(): boolean;
+    get inputRequiresWrap(): boolean;
+    get inputRequiresUnwrap(): boolean;
+    get outputRequiresWrap(): boolean;
+    get outputRequiresUnwrap(): boolean;
+    get outputRequiresTransition(): boolean;
+    encode(planner: RoutePlanner, _config: TradeConfig): void;
+}