@juiceswapxyz/router-sdk 0.0.1-beta.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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2021 Uniswap Labs
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,10 @@
1
+ # Alpha software
2
+
3
+ The latest version of the SDK is used in production in the Uniswap Interface,
4
+ but it is considered Alpha software and may contain bugs or change significantly between patch versions.
5
+ If you have questions about how to use the SDK, please reach out in the `#dev-chat` channel of the Discord.
6
+ Pull requests welcome!
7
+
8
+ # Uniswap Swap Router SDK
9
+
10
+ This SDK is meant to facilitate interactions with the contracts in [swap-router-contracts](https://github.com/Uniswap/swap-router-contracts).
@@ -0,0 +1,33 @@
1
+ import { Interface } from '@ethersproject/abi';
2
+ import { Currency, Percent, Token } from '@juiceswapxyz/sdk-core';
3
+ import { MintSpecificOptions, IncreaseSpecificOptions, Position } from '@juiceswapxyz/v3-sdk';
4
+ export declare type CondensedAddLiquidityOptions = Omit<MintSpecificOptions, 'createPool'> | IncreaseSpecificOptions;
5
+ export declare enum ApprovalTypes {
6
+ NOT_REQUIRED = 0,
7
+ MAX = 1,
8
+ MAX_MINUS_ONE = 2,
9
+ ZERO_THEN_MAX = 3,
10
+ ZERO_THEN_MAX_MINUS_ONE = 4
11
+ }
12
+ export declare function isMint(options: CondensedAddLiquidityOptions): options is Omit<MintSpecificOptions, 'createPool'>;
13
+ export declare abstract class ApproveAndCall {
14
+ static INTERFACE: Interface;
15
+ /**
16
+ * Cannot be constructed.
17
+ */
18
+ private constructor();
19
+ static encodeApproveMax(token: Token): string;
20
+ static encodeApproveMaxMinusOne(token: Token): string;
21
+ static encodeApproveZeroThenMax(token: Token): string;
22
+ static encodeApproveZeroThenMaxMinusOne(token: Token): string;
23
+ static encodeCallPositionManager(calldatas: string[]): string;
24
+ /**
25
+ * Encode adding liquidity to a position in the nft manager contract
26
+ * @param position Forcasted position with expected amount out from swap
27
+ * @param minimalPosition Forcasted position with custom minimal token amounts
28
+ * @param addLiquidityOptions Options for adding liquidity
29
+ * @param slippageTolerance Defines maximum slippage
30
+ */
31
+ static encodeAddLiquidity(position: Position, minimalPosition: Position, addLiquidityOptions: CondensedAddLiquidityOptions, slippageTolerance: Percent): string;
32
+ static encodeApprove(token: Currency, approvalType: ApprovalTypes): string;
33
+ }
@@ -0,0 +1,13 @@
1
+ import { Percent } from '@juiceswapxyz/sdk-core';
2
+ import JSBI from 'jsbi';
3
+ export declare const ADDRESS_ZERO = "0x0000000000000000000000000000000000000000";
4
+ export declare const MSG_SENDER = "0x0000000000000000000000000000000000000001";
5
+ export declare const ADDRESS_THIS = "0x0000000000000000000000000000000000000002";
6
+ export declare const ZERO: JSBI;
7
+ export declare const ONE: JSBI;
8
+ export declare const MIXED_QUOTER_V1_V2_FEE_PATH_PLACEHOLDER: number;
9
+ export declare const MIXED_QUOTER_V2_V2_FEE_PATH_PLACEHOLDER: number;
10
+ export declare const MIXED_QUOTER_V2_V3_FEE_PATH_PLACEHOLDER: number;
11
+ export declare const MIXED_QUOTER_V2_V4_FEE_PATH_PLACEHOLDER: number;
12
+ export declare const ZERO_PERCENT: Percent;
13
+ export declare const ONE_HUNDRED_PERCENT: Percent;
@@ -0,0 +1,29 @@
1
+ import { Currency, Price } from '@juiceswapxyz/sdk-core';
2
+ import { TPool } from '../../utils/TPool';
3
+ /**
4
+ * Represents a list of pools or pairs through which a swap can occur
5
+ * @template TInput The input token
6
+ * @template TOutput The output token
7
+ */
8
+ export declare class MixedRouteSDK<TInput extends Currency, TOutput extends Currency> {
9
+ readonly pools: TPool[];
10
+ readonly path: Currency[];
11
+ readonly input: TInput;
12
+ readonly output: TOutput;
13
+ readonly pathInput: Currency;
14
+ readonly pathOutput: Currency;
15
+ private _midPrice;
16
+ /**
17
+ * Creates an instance of route.
18
+ * @param pools An array of `TPool` objects (pools or pairs), ordered by the route the swap will take
19
+ * @param input The input token
20
+ * @param output The output token
21
+ * @param retainsFakePool Set to true to filter out a pool that has a fake eth-weth pool
22
+ */
23
+ constructor(pools: TPool[], input: TInput, output: TOutput, retainFakePools?: boolean);
24
+ get chainId(): number;
25
+ /**
26
+ * Returns the mid price of the route
27
+ */
28
+ get midPrice(): Price<TInput, TOutput>;
29
+ }
@@ -0,0 +1,183 @@
1
+ import { Currency, Percent, Price, CurrencyAmount, TradeType } from '@juiceswapxyz/sdk-core';
2
+ import { BestTradeOptions } from '@juiceswapxyz/v3-sdk';
3
+ import { MixedRouteSDK } from './route';
4
+ import { TPool } from '../../utils/TPool';
5
+ /**
6
+ * Trades comparator, an extension of the input output comparator that also considers other dimensions of the trade in ranking them
7
+ * @template TInput The input token, either Ether or an ERC-20
8
+ * @template TOutput The output token, either Ether or an ERC-20
9
+ * @template TTradeType The trade type, either exact input or exact output
10
+ * @param a The first trade to compare
11
+ * @param b The second trade to compare
12
+ * @returns A sorted ordering for two neighboring elements in a trade array
13
+ */
14
+ export declare function tradeComparator<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType>(a: MixedRouteTrade<TInput, TOutput, TTradeType>, b: MixedRouteTrade<TInput, TOutput, TTradeType>): number;
15
+ /**
16
+ * Represents a trade executed against a set of routes where some percentage of the input is
17
+ * split across each route.
18
+ *
19
+ * Each route has its own set of pools. Pools can not be re-used across routes.
20
+ *
21
+ * Does not account for slippage, i.e., changes in price environment that can occur between
22
+ * the time the trade is submitted and when it is executed.
23
+ * @notice This class is functionally the same as the `Trade` class in the `@juiceswapxyz/v3-sdk` package, aside from typing and some input validation.
24
+ * @template TInput The input token, either Ether or an ERC-20
25
+ * @template TOutput The output token, either Ether or an ERC-20
26
+ * @template TTradeType The trade type, either exact input or exact output
27
+ */
28
+ export declare class MixedRouteTrade<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType> {
29
+ /**
30
+ * @deprecated Deprecated in favor of 'swaps' property. If the trade consists of multiple routes
31
+ * this will return an error.
32
+ *
33
+ * When the trade consists of just a single route, this returns the route of the trade,
34
+ * i.e. which pools the trade goes through.
35
+ */
36
+ get route(): MixedRouteSDK<TInput, TOutput>;
37
+ /**
38
+ * The swaps of the trade, i.e. which routes and how much is swapped in each that
39
+ * make up the trade.
40
+ */
41
+ readonly swaps: {
42
+ route: MixedRouteSDK<TInput, TOutput>;
43
+ inputAmount: CurrencyAmount<TInput>;
44
+ outputAmount: CurrencyAmount<TOutput>;
45
+ }[];
46
+ /**
47
+ * The type of the trade, either exact in or exact out.
48
+ */
49
+ readonly tradeType: TTradeType;
50
+ /**
51
+ * The cached result of the input amount computation
52
+ * @private
53
+ */
54
+ private _inputAmount;
55
+ /**
56
+ * The input amount for the trade assuming no slippage.
57
+ */
58
+ get inputAmount(): CurrencyAmount<TInput>;
59
+ /**
60
+ * The cached result of the output amount computation
61
+ * @private
62
+ */
63
+ private _outputAmount;
64
+ /**
65
+ * The output amount for the trade assuming no slippage.
66
+ */
67
+ get outputAmount(): CurrencyAmount<TOutput>;
68
+ /**
69
+ * The cached result of the computed execution price
70
+ * @private
71
+ */
72
+ private _executionPrice;
73
+ /**
74
+ * The price expressed in terms of output amount/input amount.
75
+ */
76
+ get executionPrice(): Price<TInput, TOutput>;
77
+ /**
78
+ * The cached result of the price impact computation
79
+ * @private
80
+ */
81
+ private _priceImpact;
82
+ /**
83
+ * Returns the percent difference between the route's mid price and the price impact
84
+ */
85
+ get priceImpact(): Percent;
86
+ /**
87
+ * Constructs a trade by simulating swaps through the given route
88
+ * @template TInput The input token, either Ether or an ERC-20.
89
+ * @template TOutput The output token, either Ether or an ERC-20.
90
+ * @template TTradeType The type of the trade, either exact in or exact out.
91
+ * @param route route to swap through
92
+ * @param amount the amount specified, either input or output, depending on tradeType
93
+ * @param tradeType whether the trade is an exact input or exact output swap
94
+ * @returns The route
95
+ */
96
+ static fromRoute<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType>(route: MixedRouteSDK<TInput, TOutput>, amount: TTradeType extends TradeType.EXACT_INPUT ? CurrencyAmount<TInput> : CurrencyAmount<TOutput>, tradeType: TTradeType): Promise<MixedRouteTrade<TInput, TOutput, TTradeType>>;
97
+ /**
98
+ * Constructs a trade from routes by simulating swaps
99
+ *
100
+ * @template TInput The input token, either Ether or an ERC-20.
101
+ * @template TOutput The output token, either Ether or an ERC-20.
102
+ * @template TTradeType The type of the trade, either exact in or exact out.
103
+ * @param routes the routes to swap through and how much of the amount should be routed through each
104
+ * @param tradeType whether the trade is an exact input or exact output swap
105
+ * @returns The trade
106
+ */
107
+ static fromRoutes<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType>(routes: {
108
+ amount: TTradeType extends TradeType.EXACT_INPUT ? CurrencyAmount<TInput> : CurrencyAmount<TOutput>;
109
+ route: MixedRouteSDK<TInput, TOutput>;
110
+ }[], tradeType: TTradeType): Promise<MixedRouteTrade<TInput, TOutput, TTradeType>>;
111
+ /**
112
+ * Creates a trade without computing the result of swapping through the route. Useful when you have simulated the trade
113
+ * elsewhere and do not have any tick data
114
+ * @template TInput The input token, either Ether or an ERC-20
115
+ * @template TOutput The output token, either Ether or an ERC-20
116
+ * @template TTradeType The type of the trade, either exact in or exact out
117
+ * @param constructorArguments The arguments passed to the trade constructor
118
+ * @returns The unchecked trade
119
+ */
120
+ static createUncheckedTrade<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType>(constructorArguments: {
121
+ route: MixedRouteSDK<TInput, TOutput>;
122
+ inputAmount: CurrencyAmount<TInput>;
123
+ outputAmount: CurrencyAmount<TOutput>;
124
+ tradeType: TTradeType;
125
+ }): MixedRouteTrade<TInput, TOutput, TTradeType>;
126
+ /**
127
+ * Creates a trade without computing the result of swapping through the routes. Useful when you have simulated the trade
128
+ * elsewhere and do not have any tick data
129
+ * @template TInput The input token, either Ether or an ERC-20
130
+ * @template TOutput The output token, either Ether or an ERC-20
131
+ * @template TTradeType The type of the trade, either exact in or exact out
132
+ * @param constructorArguments The arguments passed to the trade constructor
133
+ * @returns The unchecked trade
134
+ */
135
+ static createUncheckedTradeWithMultipleRoutes<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType>(constructorArguments: {
136
+ routes: {
137
+ route: MixedRouteSDK<TInput, TOutput>;
138
+ inputAmount: CurrencyAmount<TInput>;
139
+ outputAmount: CurrencyAmount<TOutput>;
140
+ }[];
141
+ tradeType: TTradeType;
142
+ }): MixedRouteTrade<TInput, TOutput, TTradeType>;
143
+ /**
144
+ * Construct a trade by passing in the pre-computed property values
145
+ * @param routes The routes through which the trade occurs
146
+ * @param tradeType The type of trade, exact input or exact output
147
+ */
148
+ private constructor();
149
+ /**
150
+ * Get the minimum amount that must be received from this trade for the given slippage tolerance
151
+ * @param slippageTolerance The tolerance of unfavorable slippage from the execution price of this trade
152
+ * @returns The amount out
153
+ */
154
+ minimumAmountOut(slippageTolerance: Percent, amountOut?: CurrencyAmount<TOutput>): CurrencyAmount<TOutput>;
155
+ /**
156
+ * Get the maximum amount in that can be spent via this trade for the given slippage tolerance
157
+ * @param slippageTolerance The tolerance of unfavorable slippage from the execution price of this trade
158
+ * @returns The amount in
159
+ */
160
+ maximumAmountIn(slippageTolerance: Percent, amountIn?: CurrencyAmount<TInput>): CurrencyAmount<TInput>;
161
+ /**
162
+ * Return the execution price after accounting for slippage tolerance
163
+ * @param slippageTolerance the allowed tolerated slippage
164
+ * @returns The execution price
165
+ */
166
+ worstExecutionPrice(slippageTolerance: Percent): Price<TInput, TOutput>;
167
+ /**
168
+ * Given a list of pools, and a fixed amount in, returns the top `maxNumResults` trades that go from an input token
169
+ * amount to an output token, making at most `maxHops` hops.
170
+ * Note this does not consider aggregation, as routes are linear. It's possible a better route exists by splitting
171
+ * the amount in among multiple routes.
172
+ * @param pools the pools to consider in finding the best trade
173
+ * @param nextAmountIn exact amount of input currency to spend
174
+ * @param currencyOut the desired currency out
175
+ * @param maxNumResults maximum number of results to return
176
+ * @param maxHops maximum number of hops a returned trade can make, e.g. 1 hop goes through a single pool
177
+ * @param currentPools used in recursion; the current list of pools
178
+ * @param currencyAmountIn used in recursion; the original value of the currencyAmountIn parameter
179
+ * @param bestTrades used in recursion; the current list of best trades
180
+ * @returns The exact in trade
181
+ */
182
+ static bestTradeExactIn<TInput extends Currency, TOutput extends Currency>(pools: TPool[], currencyAmountIn: CurrencyAmount<TInput>, currencyOut: TOutput, { maxNumResults, maxHops }?: BestTradeOptions, currentPools?: TPool[], nextAmountIn?: CurrencyAmount<Currency>, bestTrades?: MixedRouteTrade<TInput, TOutput, TradeType.EXACT_INPUT>[]): Promise<MixedRouteTrade<TInput, TOutput, TradeType.EXACT_INPUT>[]>;
183
+ }
@@ -0,0 +1,6 @@
1
+ export declare enum Protocol {
2
+ V2 = "V2",
3
+ V3 = "V3",
4
+ V4 = "V4",
5
+ MIXED = "MIXED"
6
+ }
@@ -0,0 +1,40 @@
1
+ import { Route as V2RouteSDK, Pair } from '@juiceswapxyz/v2-sdk';
2
+ import { Route as V3RouteSDK, Pool as V3Pool } from '@juiceswapxyz/v3-sdk';
3
+ import { Route as V4RouteSDK, Pool as V4Pool } from '@juiceswapxyz/v4-sdk';
4
+ import { Protocol } from './protocol';
5
+ import { Currency, Price, Token } from '@juiceswapxyz/sdk-core';
6
+ import { MixedRouteSDK } from './mixedRoute/route';
7
+ export declare function getPathToken(currency: Currency, pool: Pair | V3Pool): Token;
8
+ export interface IRoute<TInput extends Currency, TOutput extends Currency, TPool extends Pair | V3Pool | V4Pool> {
9
+ protocol: Protocol;
10
+ pools: TPool[];
11
+ path: Currency[];
12
+ midPrice: Price<TInput, TOutput>;
13
+ input: TInput;
14
+ output: TOutput;
15
+ pathInput: Currency;
16
+ pathOutput: Currency;
17
+ }
18
+ export declare class RouteV2<TInput extends Currency, TOutput extends Currency> extends V2RouteSDK<TInput, TOutput> implements IRoute<TInput, TOutput, Pair> {
19
+ readonly protocol: Protocol;
20
+ readonly pools: Pair[];
21
+ pathInput: Currency;
22
+ pathOutput: Currency;
23
+ constructor(v2Route: V2RouteSDK<TInput, TOutput>);
24
+ }
25
+ export declare class RouteV3<TInput extends Currency, TOutput extends Currency> extends V3RouteSDK<TInput, TOutput> implements IRoute<TInput, TOutput, V3Pool> {
26
+ readonly protocol: Protocol;
27
+ readonly path: Token[];
28
+ pathInput: Currency;
29
+ pathOutput: Currency;
30
+ constructor(v3Route: V3RouteSDK<TInput, TOutput>);
31
+ }
32
+ export declare class RouteV4<TInput extends Currency, TOutput extends Currency> extends V4RouteSDK<TInput, TOutput> implements IRoute<TInput, TOutput, V4Pool> {
33
+ readonly protocol: Protocol;
34
+ readonly path: Currency[];
35
+ constructor(v4Route: V4RouteSDK<TInput, TOutput>);
36
+ }
37
+ export declare class MixedRoute<TInput extends Currency, TOutput extends Currency> extends MixedRouteSDK<TInput, TOutput> implements IRoute<TInput, TOutput, Pair | V3Pool | V4Pool> {
38
+ readonly protocol: Protocol;
39
+ constructor(mixedRoute: MixedRouteSDK<TInput, TOutput>);
40
+ }
@@ -0,0 +1,127 @@
1
+ import { Currency, CurrencyAmount, Percent, Price, TradeType } from '@juiceswapxyz/sdk-core';
2
+ import { Pair, Route as V2RouteSDK } from '@juiceswapxyz/v2-sdk';
3
+ import { Pool as V3Pool, Route as V3RouteSDK } from '@juiceswapxyz/v3-sdk';
4
+ import { Pool as V4Pool, Route as V4RouteSDK } from '@juiceswapxyz/v4-sdk';
5
+ import { MixedRouteSDK } from './mixedRoute/route';
6
+ import { IRoute } from './route';
7
+ export declare class Trade<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType> {
8
+ readonly routes: IRoute<TInput, TOutput, Pair | V3Pool | V4Pool>[];
9
+ readonly tradeType: TTradeType;
10
+ private _outputAmount;
11
+ private _inputAmount;
12
+ private _nativeInputRoutes;
13
+ private _wethInputRoutes;
14
+ /**
15
+ * The swaps of the trade, i.e. which routes and how much is swapped in each that
16
+ * make up the trade. May consist of swaps in v2 or v3.
17
+ */
18
+ readonly swaps: {
19
+ route: IRoute<TInput, TOutput, Pair | V3Pool | V4Pool>;
20
+ inputAmount: CurrencyAmount<TInput>;
21
+ outputAmount: CurrencyAmount<TOutput>;
22
+ }[];
23
+ constructor({ v2Routes, v3Routes, v4Routes, mixedRoutes, tradeType, }: {
24
+ v2Routes?: {
25
+ routev2: V2RouteSDK<TInput, TOutput>;
26
+ inputAmount: CurrencyAmount<TInput>;
27
+ outputAmount: CurrencyAmount<TOutput>;
28
+ }[];
29
+ v3Routes?: {
30
+ routev3: V3RouteSDK<TInput, TOutput>;
31
+ inputAmount: CurrencyAmount<TInput>;
32
+ outputAmount: CurrencyAmount<TOutput>;
33
+ }[];
34
+ v4Routes?: {
35
+ routev4: V4RouteSDK<TInput, TOutput>;
36
+ inputAmount: CurrencyAmount<TInput>;
37
+ outputAmount: CurrencyAmount<TOutput>;
38
+ }[];
39
+ mixedRoutes?: {
40
+ mixedRoute: MixedRouteSDK<TInput, TOutput>;
41
+ inputAmount: CurrencyAmount<TInput>;
42
+ outputAmount: CurrencyAmount<TOutput>;
43
+ }[];
44
+ tradeType: TTradeType;
45
+ });
46
+ get inputAmount(): CurrencyAmount<TInput>;
47
+ get outputAmount(): CurrencyAmount<TOutput>;
48
+ /**
49
+ * Returns the sum of all swaps within the trade
50
+ * @returns
51
+ * inputAmount: total input amount
52
+ * inputAmountNative: total amount of native currency required for ETH input paths
53
+ * - 0 if inputAmount is native but no native input paths
54
+ * - undefined if inputAmount is not native
55
+ * outputAmount: total output amount
56
+ * outputAmountNative: total amount of native currency returned from ETH output paths
57
+ * - 0 if outputAmount is native but no native output paths
58
+ * - undefined if outputAmount is not native
59
+ */
60
+ get amounts(): {
61
+ inputAmount: CurrencyAmount<TInput>;
62
+ inputAmountNative: CurrencyAmount<TInput> | undefined;
63
+ outputAmount: CurrencyAmount<TOutput>;
64
+ outputAmountNative: CurrencyAmount<TOutput> | undefined;
65
+ };
66
+ get numberOfInputWraps(): number;
67
+ get numberOfInputUnwraps(): number;
68
+ get nativeInputRoutes(): IRoute<TInput, TOutput, Pair | V3Pool | V4Pool>[];
69
+ get wethInputRoutes(): IRoute<TInput, TOutput, Pair | V3Pool | V4Pool>[];
70
+ private _executionPrice;
71
+ /**
72
+ * The price expressed in terms of output amount/input amount.
73
+ */
74
+ get executionPrice(): Price<TInput, TOutput>;
75
+ /**
76
+ * Returns the sell tax of the input token
77
+ */
78
+ get inputTax(): Percent;
79
+ /**
80
+ * Returns the buy tax of the output token
81
+ */
82
+ get outputTax(): Percent;
83
+ private isWrappedNative;
84
+ /**
85
+ * The cached result of the price impact computation
86
+ * @private
87
+ */
88
+ private _priceImpact;
89
+ /**
90
+ * Returns the percent difference between the route's mid price and the expected execution price
91
+ * In order to exclude token taxes from the price impact calculation, the spot price is calculated
92
+ * using a ratio of values that go into the pools, which are the post-tax input amount and pre-tax output amount.
93
+ */
94
+ get priceImpact(): Percent;
95
+ /**
96
+ * Get the minimum amount that must be received from this trade for the given slippage tolerance
97
+ * @param slippageTolerance The tolerance of unfavorable slippage from the execution price of this trade
98
+ * @returns The amount out
99
+ */
100
+ minimumAmountOut(slippageTolerance: Percent, amountOut?: CurrencyAmount<TOutput>): CurrencyAmount<TOutput>;
101
+ /**
102
+ * Get the maximum amount in that can be spent via this trade for the given slippage tolerance
103
+ * @param slippageTolerance The tolerance of unfavorable slippage from the execution price of this trade
104
+ * @returns The amount in
105
+ */
106
+ maximumAmountIn(slippageTolerance: Percent, amountIn?: CurrencyAmount<TInput>): CurrencyAmount<TInput>;
107
+ /**
108
+ * Return the execution price after accounting for slippage tolerance
109
+ * @param slippageTolerance the allowed tolerated slippage
110
+ * @returns The execution price
111
+ */
112
+ worstExecutionPrice(slippageTolerance: Percent): Price<TInput, TOutput>;
113
+ static fromRoutes<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType>(v2Routes: {
114
+ routev2: V2RouteSDK<TInput, TOutput>;
115
+ amount: TTradeType extends TradeType.EXACT_INPUT ? CurrencyAmount<TInput> : CurrencyAmount<TOutput>;
116
+ }[], v3Routes: {
117
+ routev3: V3RouteSDK<TInput, TOutput>;
118
+ amount: TTradeType extends TradeType.EXACT_INPUT ? CurrencyAmount<TInput> : CurrencyAmount<TOutput>;
119
+ }[], tradeType: TTradeType, mixedRoutes?: {
120
+ mixedRoute: MixedRouteSDK<TInput, TOutput>;
121
+ amount: TTradeType extends TradeType.EXACT_INPUT ? CurrencyAmount<TInput> : CurrencyAmount<TOutput>;
122
+ }[], v4Routes?: {
123
+ routev4: V4RouteSDK<TInput, TOutput>;
124
+ amount: TTradeType extends TradeType.EXACT_INPUT ? CurrencyAmount<TInput> : CurrencyAmount<TOutput>;
125
+ }[]): Promise<Trade<TInput, TOutput, TTradeType>>;
126
+ static fromRoute<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType>(route: V2RouteSDK<TInput, TOutput> | V3RouteSDK<TInput, TOutput> | V4RouteSDK<TInput, TOutput> | MixedRouteSDK<TInput, TOutput>, amount: TTradeType extends TradeType.EXACT_INPUT ? CurrencyAmount<TInput> : CurrencyAmount<TOutput>, tradeType: TTradeType): Promise<Trade<TInput, TOutput, TTradeType>>;
127
+ }
@@ -0,0 +1,14 @@
1
+ export * from './constants';
2
+ export * from './approveAndCall';
3
+ export * from './multicallExtended';
4
+ export * from './paymentsExtended';
5
+ export * from './swapRouter';
6
+ export * from './entities/trade';
7
+ export * from './entities/protocol';
8
+ export * from './entities/route';
9
+ export * from './entities/mixedRoute/route';
10
+ export * from './entities/mixedRoute/trade';
11
+ export * from './utils/encodeMixedRouteToPath';
12
+ export * from './utils/TPool';
13
+ export * from './utils/pathCurrency';
14
+ export * from './utils';
package/dist/index.js ADDED
@@ -0,0 +1,8 @@
1
+
2
+ 'use strict'
3
+
4
+ if (process.env.NODE_ENV === 'production') {
5
+ module.exports = require('./router-sdk.cjs.production.min.js')
6
+ } else {
7
+ module.exports = require('./router-sdk.cjs.development.js')
8
+ }
@@ -0,0 +1,11 @@
1
+ import { Interface } from '@ethersproject/abi';
2
+ import { BigintIsh } from '@juiceswapxyz/sdk-core';
3
+ export declare type Validation = BigintIsh | string;
4
+ export declare abstract class MulticallExtended {
5
+ static INTERFACE: Interface;
6
+ /**
7
+ * Cannot be constructed.
8
+ */
9
+ private constructor();
10
+ static encodeMulticall(calldatas: string | string[], validation?: Validation): string;
11
+ }
@@ -0,0 +1,15 @@
1
+ import { Interface } from '@ethersproject/abi';
2
+ import { Token } from '@juiceswapxyz/sdk-core';
3
+ import { FeeOptions } from '@juiceswapxyz/v3-sdk';
4
+ import JSBI from 'jsbi';
5
+ export declare abstract class PaymentsExtended {
6
+ static INTERFACE: Interface;
7
+ /**
8
+ * Cannot be constructed.
9
+ */
10
+ private constructor();
11
+ static encodeUnwrapWETH9(amountMinimum: JSBI, recipient?: string, feeOptions?: FeeOptions): string;
12
+ static encodeSweepToken(token: Token, amountMinimum: JSBI, recipient?: string, feeOptions?: FeeOptions): string;
13
+ static encodePull(token: Token, amount: JSBI): string;
14
+ static encodeWrapETH(amount: JSBI): string;
15
+ }