@dodoex/widgets 3.2.0-beta.7 → 3.2.0-beta.8
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 +674 -674
- package/README.md +69 -69
- package/dist/{8de9a184d4ef0a11.svg → 219f8611c6c9e6e2.svg} +6 -6
- package/dist/{28442382d977858a.svg → 34acf2e58b457195.svg} +9 -9
- package/dist/{b3f16b2626f03378.svg → 44df077bd19df476.svg} +10 -10
- package/dist/{ed726d76d93d4899.svg → 5c5d298f247819e1.svg} +10 -10
- package/dist/7feb1ff0e03a571d.svg +9 -0
- package/dist/cjs/locales/en-US.js +1 -1
- package/dist/cjs/locales/zh-CN.js +1 -1
- package/dist/{helper-BSboISTh.js → helper-Bwk-pafn.js} +1 -1
- package/dist/{helper-4kKoo0DZ.cjs → helper-BxZqNcaq.cjs} +1 -1
- package/dist/index-B4_cnc94.cjs +67 -0
- package/dist/{index-B9hWL0vR.cjs → index-BDehUNkw.cjs} +1 -1
- package/dist/{index-1OL6zzm0.js → index-Bk4cKKCz.js} +1 -1
- package/dist/index-DQp2ouTr.js +67 -0
- package/dist/{index-DqkmWYa2.js → index-DRV1A2No.js} +1 -1
- package/dist/{index-C0zK7JGQ.cjs → index-cEhELacT.cjs} +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.js +1 -1
- package/dist/locales/en-US.js +1 -1
- package/dist/locales/zh-CN.js +1 -1
- package/dist/types/components/Message/index.d.ts +1 -2
- package/dist/types/components/SelectChain.d.ts +1 -2
- package/dist/types/components/Swap/components/ConnectWallet/index.d.ts +2 -1
- package/dist/types/components/Swap/components/ReviewDialog.d.ts +2 -1
- package/dist/types/components/Swap/components/SwapSettingsDialog/SlippageSetting.d.ts +1 -2
- package/dist/types/components/Swap/components/SwapSettingsDialog/SlippageWarning.d.ts +1 -3
- package/dist/types/components/Swap/components/SwapSettingsDialog/index.d.ts +1 -2
- package/dist/types/components/Swap/components/SwitchBox.d.ts +2 -1
- package/dist/types/components/Swap/components/TokenCard/NumberInput.d.ts +1 -0
- package/dist/types/components/Swap/components/TokenCard/index.d.ts +5 -2
- package/dist/types/components/Swap/index.d.ts +5 -3
- package/dist/types/components/TokenSelect.d.ts +2 -1
- package/dist/types/components/Widget/index.d.ts +3 -3
- package/dist/types/components/WithExecutionDialog/index.d.ts +1 -2
- package/dist/types/constants/address.d.ts +1 -0
- package/dist/types/hooks/ConnectWallet/useSwitchChain.d.ts +0 -3
- package/dist/types/hooks/Submission/types.d.ts +4 -0
- package/dist/types/hooks/Swap/useSlippageLimit.d.ts +2 -2
- package/dist/types/hooks/contract/wallet.d.ts +2 -2
- package/dist/types/hooks/usePoolTokenSort.d.ts +24 -0
- package/dist/types/index.d.ts +3 -1
- package/dist/types/providers/useInitContractRequest.d.ts +2 -1
- package/dist/types/router/types.d.ts +2 -1
- package/dist/types/utils/address.d.ts +35 -0
- package/dist/types/utils/fractions/fraction.d.ts +24 -0
- package/dist/types/utils/fractions/index.d.ts +3 -0
- package/dist/types/utils/fractions/percent.d.ts +14 -0
- package/dist/types/utils/fractions/price.d.ts +29 -0
- package/dist/types/utils/fractions/types.d.ts +7 -0
- package/dist/types/widgets/PoolWidget/AMMV2Create/Ratio.d.ts +1 -4
- package/dist/types/widgets/PoolWidget/AMMV2Create/Setting.d.ts +16 -0
- package/dist/types/widgets/PoolWidget/Algebra/AddLiquidity.d.ts +14 -0
- package/dist/types/widgets/PoolWidget/Algebra/AlgebraPositionManage.d.ts +11 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/Badge/RangeBadge.d.ts +4 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/ClaimButton.d.ts +9 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/InRangeDot.d.ts +4 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/InputStepCounter.d.ts +17 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/LiquidityChartRangeInput/Area.d.ts +10 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/LiquidityChartRangeInput/AxisBottom.d.ts +6 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/LiquidityChartRangeInput/Brush.d.ts +13 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/LiquidityChartRangeInput/Chart.d.ts +2 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/LiquidityChartRangeInput/Line.d.ts +6 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/LiquidityChartRangeInput/Zoom.d.ts +12 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/LiquidityChartRangeInput/index.d.ts +19 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/LiquidityChartRangeInput/svg.d.ts +22 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/LiquidityChartRangeInput/types.d.ts +50 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/LiquidityChartRangeInput/usePrevious.d.ts +1 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/LiquidityChartRangeInput/utils.d.ts +14 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/MyLiquidity.d.ts +10 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/PositionPreview.d.ts +14 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/PositionSelectedRangePreview.d.ts +11 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/RangeSelector.d.ts +21 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/RateToggle.d.ts +9 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/RemoveButton.d.ts +11 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/ReviewModal.d.ts +18 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/TokenAndEtherscan.d.ts +4 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/TokenPairSelect.d.ts +7 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/shared.d.ts +4 -0
- package/dist/types/widgets/PoolWidget/Algebra/components/widgets.d.ts +56 -0
- package/dist/types/widgets/PoolWidget/Algebra/constants/misc.d.ts +17 -0
- package/dist/types/widgets/PoolWidget/Algebra/hooks/useAddAlgebraLiquidity.d.ts +15 -0
- package/dist/types/widgets/PoolWidget/Algebra/hooks/useAlgebraAmounts.d.ts +19 -0
- package/dist/types/widgets/PoolWidget/Algebra/hooks/useAlgebraPair.d.ts +59 -0
- package/dist/types/widgets/PoolWidget/Algebra/hooks/useAlgebraPositionFees.d.ts +13 -0
- package/dist/types/widgets/PoolWidget/Algebra/hooks/useClaimAlgebraFees.d.ts +12 -0
- package/dist/types/widgets/PoolWidget/Algebra/hooks/useContract.d.ts +2 -0
- package/dist/types/widgets/PoolWidget/Algebra/hooks/useFetchPositionFromTokenId.d.ts +295 -0
- package/dist/types/widgets/PoolWidget/Algebra/hooks/useFetchPositions.d.ts +23 -0
- package/dist/types/widgets/PoolWidget/Algebra/hooks/usePoolActiveLiquidityChartData.d.ts +37 -0
- package/dist/types/widgets/PoolWidget/Algebra/hooks/usePools.d.ts +22 -0
- package/dist/types/widgets/PoolWidget/Algebra/hooks/useRemoveAlgebraLiquidity.d.ts +14 -0
- package/dist/types/widgets/PoolWidget/Algebra/hooks/useSetRange.d.ts +32 -0
- package/dist/types/widgets/PoolWidget/Algebra/hooks/useSwapTaxes.d.ts +5 -0
- package/dist/types/widgets/PoolWidget/Algebra/hooks/useV3MintActionHandlers.d.ts +11 -0
- package/dist/types/widgets/PoolWidget/Algebra/hooks/useV3PositionFees.d.ts +8 -0
- package/dist/types/widgets/PoolWidget/Algebra/hooks/useV3Positions.d.ts +13 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/sdk-core/addresses.d.ts +12 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/sdk-core/chains.d.ts +4 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/sdk-core/constants.d.ts +12 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/sdk-core/entities/baseCurrency.d.ts +49 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/sdk-core/entities/currency.d.ts +3 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/sdk-core/entities/fractions/currencyAmount.d.ts +32 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/sdk-core/entities/fractions/fraction.d.ts +24 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/sdk-core/entities/fractions/index.d.ts +4 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/sdk-core/entities/fractions/percent.d.ts +14 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/sdk-core/entities/fractions/price.d.ts +38 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/sdk-core/entities/index.d.ts +4 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/sdk-core/entities/nativeCurrency.d.ts +16 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/sdk-core/entities/nativeCurrencyClass.d.ts +8 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/sdk-core/entities/token.d.ts +48 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/sdk-core/index.d.ts +5 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/sdk-core/utils/computePriceImpact.d.ts +8 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/sdk-core/utils/index.d.ts +4 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/sdk-core/utils/sortedInsert.d.ts +1 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/sdk-core/utils/sqrt.d.ts +7 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/sdk-core/utils/validateAndParseAddress.d.ts +10 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/constants.d.ts +23 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/entities/index.d.ts +7 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/entities/pool.d.ts +81 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/entities/position.d.ts +131 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/entities/route.d.ts +26 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/entities/tick.d.ts +13 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/entities/tickDataProvider.d.ts +31 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/entities/tickListDataProvider.d.ts +15 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/entities/trade.d.ts +220 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/index.d.ts +10 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/internalConstants.d.ts +6 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/multicall.d.ts +10 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/nonfungiblePositionManager.d.ts +159 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/payments.d.ts +24 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/quoter.d.ts +37 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/selfPermit.d.ts +25 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/staker.d.ts +101 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/swapRouter.d.ts +51 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/utils/calldata.d.ts +20 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/utils/computePoolAddress.d.ts +21 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/utils/encodeRouteToPath.d.ts +8 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/utils/encodeSqrtRatioX96.d.ts +9 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/utils/fullMath.d.ts +8 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/utils/index.d.ts +18 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/utils/isSorted.d.ts +7 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/utils/liquidityMath.d.ts +8 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/utils/maxLiquidityForAmounts.d.ts +14 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/utils/mostSignificantBit.d.ts +2 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/utils/nearestUsableTick.d.ts +6 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/utils/position.d.ts +8 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/utils/priceTickConversions.d.ts +15 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/utils/sqrtPriceMath.d.ts +13 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/utils/swapMath.d.ts +9 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/utils/tickLibrary.d.ts +14 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/utils/tickList.d.ts +23 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/utils/tickMath.d.ts +34 -0
- package/dist/types/widgets/PoolWidget/Algebra/sdks/v3-sdk/utils/v3swap.d.ts +8 -0
- package/dist/types/widgets/PoolWidget/Algebra/types/position.d.ts +18 -0
- package/dist/types/widgets/PoolWidget/Algebra/types.d.ts +10 -0
- package/dist/types/widgets/PoolWidget/Algebra/utils/calldata.d.ts +7 -0
- package/dist/types/widgets/PoolWidget/Algebra/utils/computeSurroundingTicks.d.ts +4 -0
- package/dist/types/widgets/PoolWidget/Algebra/utils/constants.d.ts +7 -0
- package/dist/types/widgets/PoolWidget/Algebra/utils/encodeSqrtRatioX96.d.ts +9 -0
- package/dist/types/widgets/PoolWidget/Algebra/utils/formatTickPrice.d.ts +1 -0
- package/dist/types/widgets/PoolWidget/Algebra/utils/fullMath.d.ts +8 -0
- package/dist/types/widgets/PoolWidget/Algebra/utils/getPositionAmount.d.ts +37 -0
- package/dist/types/widgets/PoolWidget/Algebra/utils/getPositionAmountWithSlippage.d.ts +23 -0
- package/dist/types/widgets/PoolWidget/Algebra/utils/getTickToPrice.d.ts +10 -0
- package/dist/types/widgets/PoolWidget/Algebra/utils/maxLiquidityForAmounts.d.ts +22 -0
- package/dist/types/widgets/PoolWidget/Algebra/utils/mostSignificantBit.d.ts +2 -0
- package/dist/types/widgets/PoolWidget/Algebra/utils/nearestUsableTick.d.ts +6 -0
- package/dist/types/widgets/PoolWidget/Algebra/utils/slippage.d.ts +3 -0
- package/dist/types/widgets/PoolWidget/Algebra/utils/sqrt.d.ts +7 -0
- package/dist/types/widgets/PoolWidget/Algebra/utils/sqrtPriceMath.d.ts +13 -0
- package/dist/types/widgets/PoolWidget/Algebra/utils/tickMath.d.ts +34 -0
- package/dist/types/widgets/PoolWidget/Algebra/utils/tryParseTick.d.ts +4 -0
- package/dist/types/widgets/PoolWidget/Algebra/utils.d.ts +9 -0
- package/dist/types/widgets/PoolWidget/PoolCreate/components/BaseInfoCardList.d.ts +1 -3
- package/dist/types/widgets/PoolWidget/PoolCreate/components/FeeRateCard.d.ts +1 -2
- package/dist/types/widgets/PoolWidget/PoolCreate/components/LqRatioSet.d.ts +1 -2
- package/dist/types/widgets/PoolWidget/PoolCreate/components/LqSettingsShow.d.ts +1 -3
- package/dist/types/widgets/PoolWidget/PoolCreate/components/PriceModeCard.d.ts +1 -3
- package/dist/types/widgets/PoolWidget/PoolCreate/components/VersionChartExample.d.ts +1 -2
- package/dist/types/widgets/PoolWidget/PoolCreate/components/widgets.d.ts +1 -2
- package/dist/types/widgets/PoolWidget/PoolCreate/hooks/usePriceInit.d.ts +1 -2
- package/dist/types/widgets/PoolWidget/PoolCreate/hooks/useVersionList.d.ts +3 -3
- package/dist/types/widgets/PoolWidget/PoolCreate/index.d.ts +1 -3
- package/dist/types/widgets/PoolWidget/PoolCreate/operate-widgets/InitPriceSetting.d.ts +1 -2
- package/dist/types/widgets/PoolWidget/PoolCreate/operate-widgets/PriceModeSetting.d.ts +1 -2
- package/dist/types/widgets/PoolWidget/PoolCreate/operate-widgets/VersionSelect.d.ts +1 -2
- package/dist/types/widgets/PoolWidget/PoolDetail/components/MoreDetail/index.d.ts +1 -2
- package/dist/types/widgets/PoolWidget/PoolDetail/components/Overview.d.ts +1 -2
- package/dist/types/widgets/PoolWidget/PoolDetail/components/TotalLiquidity.d.ts +1 -2
- package/dist/types/widgets/PoolWidget/PoolDetail/index.d.ts +1 -2
- package/dist/types/widgets/PoolWidget/PoolList/AddLiquidity.d.ts +5 -4
- package/dist/types/widgets/PoolWidget/PoolList/MyCreated.d.ts +1 -2
- package/dist/types/widgets/PoolWidget/PoolList/MyLiquidity.d.ts +5 -4
- package/dist/types/widgets/PoolWidget/PoolList/index.d.ts +9 -5
- package/dist/types/widgets/PoolWidget/PoolModify/index.d.ts +1 -2
- package/dist/types/widgets/PoolWidget/PoolOperate/PoolOperateInner.d.ts +2 -4
- package/dist/types/widgets/PoolWidget/PoolOperate/RemovePoolOperate.d.ts +2 -4
- package/dist/types/widgets/PoolWidget/PoolOperate/components/Ratio.d.ts +1 -5
- package/dist/types/widgets/PoolWidget/PoolOperate/components/SlippageSetting.d.ts +1 -1
- package/dist/types/widgets/PoolWidget/PoolOperate/index.d.ts +1 -4
- package/dist/types/widgets/PoolWidget/PoolOperate/types.d.ts +0 -12
- package/dist/types/widgets/PoolWidget/hooks/contract/useModifyDppPool.d.ts +1 -1
- package/dist/types/widgets/PoolWidget/hooks/useAMMV2AddLiquidity.d.ts +1 -1
- package/dist/types/widgets/PoolWidget/hooks/useAMMV2RemoveLiquidity.d.ts +1 -1
- package/package.json +156 -156
- package/dist/index-Bk1bh5Nd.cjs +0 -31
- package/dist/index-Ckt2Q3gy.js +0 -31
- package/dist/types/components/SubmittedDialog.d.ts +0 -5
- package/dist/types/components/Swap/components/SwapPreviewInfoCard.d.ts +0 -7
- package/dist/types/widgets/PoolWidget/hooks/usePoolListMyLiquidity.d.ts +0 -15
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { BigintIsh } from '../../sdk-core';
|
|
2
|
+
import { Tick, TickConstructorArgs } from './tick';
|
|
3
|
+
import { TickDataProvider } from './tickDataProvider';
|
|
4
|
+
/**
|
|
5
|
+
* A data provider for ticks that is backed by an in-memory array of ticks.
|
|
6
|
+
*/
|
|
7
|
+
export declare class TickListDataProvider implements TickDataProvider {
|
|
8
|
+
private ticks;
|
|
9
|
+
constructor(ticks: (Tick | TickConstructorArgs)[], tickSpacing: number);
|
|
10
|
+
getTick(tick: number): Promise<{
|
|
11
|
+
liquidityNet: BigintIsh;
|
|
12
|
+
liquidityGross: BigintIsh;
|
|
13
|
+
}>;
|
|
14
|
+
nextInitializedTickWithinOneWord(tick: number, lte: boolean, tickSpacing: number): Promise<[number, boolean]>;
|
|
15
|
+
}
|
|
@@ -0,0 +1,220 @@
|
|
|
1
|
+
import { Currency, CurrencyAmount, Percent, Price, TradeType } from '../../sdk-core';
|
|
2
|
+
import { Pool } from './pool';
|
|
3
|
+
import { Route } from './route';
|
|
4
|
+
/**
|
|
5
|
+
* Trades comparator, an extension of the input output comparator that also considers other dimensions of the trade in ranking them
|
|
6
|
+
* @template TInput The input token, either Ether or an ERC-20
|
|
7
|
+
* @template TOutput The output token, either Ether or an ERC-20
|
|
8
|
+
* @template TTradeType The trade type, either exact input or exact output
|
|
9
|
+
* @param a The first trade to compare
|
|
10
|
+
* @param b The second trade to compare
|
|
11
|
+
* @returns A sorted ordering for two neighboring elements in a trade array
|
|
12
|
+
*/
|
|
13
|
+
export declare function tradeComparator<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType>(a: Trade<TInput, TOutput, TTradeType>, b: Trade<TInput, TOutput, TTradeType>): number;
|
|
14
|
+
export interface BestTradeOptions {
|
|
15
|
+
maxNumResults?: number;
|
|
16
|
+
maxHops?: number;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Represents a trade executed against a set of routes where some percentage of the input is
|
|
20
|
+
* split across each route.
|
|
21
|
+
*
|
|
22
|
+
* Each route has its own set of pools. Pools can not be re-used across routes.
|
|
23
|
+
*
|
|
24
|
+
* Does not account for slippage, i.e., changes in price environment that can occur between
|
|
25
|
+
* the time the trade is submitted and when it is executed.
|
|
26
|
+
* @template TInput The input token, either Ether or an ERC-20
|
|
27
|
+
* @template TOutput The output token, either Ether or an ERC-20
|
|
28
|
+
* @template TTradeType The trade type, either exact input or exact output
|
|
29
|
+
*/
|
|
30
|
+
export declare class Trade<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType> {
|
|
31
|
+
/**
|
|
32
|
+
* @deprecated Deprecated in favor of 'swaps' property. If the trade consists of multiple routes
|
|
33
|
+
* this will return an error.
|
|
34
|
+
*
|
|
35
|
+
* When the trade consists of just a single route, this returns the route of the trade,
|
|
36
|
+
* i.e. which pools the trade goes through.
|
|
37
|
+
*/
|
|
38
|
+
get route(): Route<TInput, TOutput>;
|
|
39
|
+
/**
|
|
40
|
+
* The swaps of the trade, i.e. which routes and how much is swapped in each that
|
|
41
|
+
* make up the trade.
|
|
42
|
+
*/
|
|
43
|
+
readonly swaps: {
|
|
44
|
+
route: Route<TInput, TOutput>;
|
|
45
|
+
inputAmount: CurrencyAmount<TInput>;
|
|
46
|
+
outputAmount: CurrencyAmount<TOutput>;
|
|
47
|
+
}[];
|
|
48
|
+
/**
|
|
49
|
+
* The type of the trade, either exact in or exact out.
|
|
50
|
+
*/
|
|
51
|
+
readonly tradeType: TTradeType;
|
|
52
|
+
/**
|
|
53
|
+
* The cached result of the input amount computation
|
|
54
|
+
* @private
|
|
55
|
+
*/
|
|
56
|
+
private _inputAmount;
|
|
57
|
+
/**
|
|
58
|
+
* The input amount for the trade assuming no slippage.
|
|
59
|
+
*/
|
|
60
|
+
get inputAmount(): CurrencyAmount<TInput>;
|
|
61
|
+
/**
|
|
62
|
+
* The cached result of the output amount computation
|
|
63
|
+
* @private
|
|
64
|
+
*/
|
|
65
|
+
private _outputAmount;
|
|
66
|
+
/**
|
|
67
|
+
* The output amount for the trade assuming no slippage.
|
|
68
|
+
*/
|
|
69
|
+
get outputAmount(): CurrencyAmount<TOutput>;
|
|
70
|
+
/**
|
|
71
|
+
* The cached result of the computed execution price
|
|
72
|
+
* @private
|
|
73
|
+
*/
|
|
74
|
+
private _executionPrice;
|
|
75
|
+
/**
|
|
76
|
+
* The price expressed in terms of output amount/input amount.
|
|
77
|
+
*/
|
|
78
|
+
get executionPrice(): Price<TInput, TOutput>;
|
|
79
|
+
/**
|
|
80
|
+
* The cached result of the price impact computation
|
|
81
|
+
* @private
|
|
82
|
+
*/
|
|
83
|
+
private _priceImpact;
|
|
84
|
+
/**
|
|
85
|
+
* Returns the percent difference between the route's mid price and the price impact
|
|
86
|
+
*/
|
|
87
|
+
get priceImpact(): Percent;
|
|
88
|
+
/**
|
|
89
|
+
* Constructs an exact in trade with the given amount in and route
|
|
90
|
+
* @template TInput The input token, either Ether or an ERC-20
|
|
91
|
+
* @template TOutput The output token, either Ether or an ERC-20
|
|
92
|
+
* @param route The route of the exact in trade
|
|
93
|
+
* @param amountIn The amount being passed in
|
|
94
|
+
* @returns The exact in trade
|
|
95
|
+
*/
|
|
96
|
+
static exactIn<TInput extends Currency, TOutput extends Currency>(route: Route<TInput, TOutput>, amountIn: CurrencyAmount<TInput>): Promise<Trade<TInput, TOutput, TradeType.EXACT_INPUT>>;
|
|
97
|
+
/**
|
|
98
|
+
* Constructs an exact out trade with the given amount out and route
|
|
99
|
+
* @template TInput The input token, either Ether or an ERC-20
|
|
100
|
+
* @template TOutput The output token, either Ether or an ERC-20
|
|
101
|
+
* @param route The route of the exact out trade
|
|
102
|
+
* @param amountOut The amount returned by the trade
|
|
103
|
+
* @returns The exact out trade
|
|
104
|
+
*/
|
|
105
|
+
static exactOut<TInput extends Currency, TOutput extends Currency>(route: Route<TInput, TOutput>, amountOut: CurrencyAmount<TOutput>): Promise<Trade<TInput, TOutput, TradeType.EXACT_OUTPUT>>;
|
|
106
|
+
/**
|
|
107
|
+
* Constructs a trade by simulating swaps through the given route
|
|
108
|
+
* @template TInput The input token, either Ether or an ERC-20.
|
|
109
|
+
* @template TOutput The output token, either Ether or an ERC-20.
|
|
110
|
+
* @template TTradeType The type of the trade, either exact in or exact out.
|
|
111
|
+
* @param route route to swap through
|
|
112
|
+
* @param amount the amount specified, either input or output, depending on tradeType
|
|
113
|
+
* @param tradeType whether the trade is an exact input or exact output swap
|
|
114
|
+
* @returns The route
|
|
115
|
+
*/
|
|
116
|
+
static fromRoute<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType>(route: Route<TInput, TOutput>, amount: TTradeType extends TradeType.EXACT_INPUT ? CurrencyAmount<TInput> : CurrencyAmount<TOutput>, tradeType: TTradeType): Promise<Trade<TInput, TOutput, TTradeType>>;
|
|
117
|
+
/**
|
|
118
|
+
* Constructs a trade from routes by simulating swaps
|
|
119
|
+
*
|
|
120
|
+
* @template TInput The input token, either Ether or an ERC-20.
|
|
121
|
+
* @template TOutput The output token, either Ether or an ERC-20.
|
|
122
|
+
* @template TTradeType The type of the trade, either exact in or exact out.
|
|
123
|
+
* @param routes the routes to swap through and how much of the amount should be routed through each
|
|
124
|
+
* @param tradeType whether the trade is an exact input or exact output swap
|
|
125
|
+
* @returns The trade
|
|
126
|
+
*/
|
|
127
|
+
static fromRoutes<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType>(routes: {
|
|
128
|
+
amount: TTradeType extends TradeType.EXACT_INPUT ? CurrencyAmount<TInput> : CurrencyAmount<TOutput>;
|
|
129
|
+
route: Route<TInput, TOutput>;
|
|
130
|
+
}[], tradeType: TTradeType): Promise<Trade<TInput, TOutput, TTradeType>>;
|
|
131
|
+
/**
|
|
132
|
+
* Creates a trade without computing the result of swapping through the route. Useful when you have simulated the trade
|
|
133
|
+
* elsewhere and do not have any tick data
|
|
134
|
+
* @template TInput The input token, either Ether or an ERC-20
|
|
135
|
+
* @template TOutput The output token, either Ether or an ERC-20
|
|
136
|
+
* @template TTradeType The type of the trade, either exact in or exact out
|
|
137
|
+
* @param constructorArguments The arguments passed to the trade constructor
|
|
138
|
+
* @returns The unchecked trade
|
|
139
|
+
*/
|
|
140
|
+
static createUncheckedTrade<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType>(constructorArguments: {
|
|
141
|
+
route: Route<TInput, TOutput>;
|
|
142
|
+
inputAmount: CurrencyAmount<TInput>;
|
|
143
|
+
outputAmount: CurrencyAmount<TOutput>;
|
|
144
|
+
tradeType: TTradeType;
|
|
145
|
+
}): Trade<TInput, TOutput, TTradeType>;
|
|
146
|
+
/**
|
|
147
|
+
* Creates a trade without computing the result of swapping through the routes. Useful when you have simulated the trade
|
|
148
|
+
* elsewhere and do not have any tick data
|
|
149
|
+
* @template TInput The input token, either Ether or an ERC-20
|
|
150
|
+
* @template TOutput The output token, either Ether or an ERC-20
|
|
151
|
+
* @template TTradeType The type of the trade, either exact in or exact out
|
|
152
|
+
* @param constructorArguments The arguments passed to the trade constructor
|
|
153
|
+
* @returns The unchecked trade
|
|
154
|
+
*/
|
|
155
|
+
static createUncheckedTradeWithMultipleRoutes<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType>(constructorArguments: {
|
|
156
|
+
routes: {
|
|
157
|
+
route: Route<TInput, TOutput>;
|
|
158
|
+
inputAmount: CurrencyAmount<TInput>;
|
|
159
|
+
outputAmount: CurrencyAmount<TOutput>;
|
|
160
|
+
}[];
|
|
161
|
+
tradeType: TTradeType;
|
|
162
|
+
}): Trade<TInput, TOutput, TTradeType>;
|
|
163
|
+
/**
|
|
164
|
+
* Construct a trade by passing in the pre-computed property values
|
|
165
|
+
* @param routes The routes through which the trade occurs
|
|
166
|
+
* @param tradeType The type of trade, exact input or exact output
|
|
167
|
+
*/
|
|
168
|
+
private constructor();
|
|
169
|
+
/**
|
|
170
|
+
* Get the minimum amount that must be received from this trade for the given slippage tolerance
|
|
171
|
+
* @param slippageTolerance The tolerance of unfavorable slippage from the execution price of this trade
|
|
172
|
+
* @returns The amount out
|
|
173
|
+
*/
|
|
174
|
+
minimumAmountOut(slippageTolerance: Percent, amountOut?: CurrencyAmount<TOutput>): CurrencyAmount<TOutput>;
|
|
175
|
+
/**
|
|
176
|
+
* Get the maximum amount in that can be spent via this trade for the given slippage tolerance
|
|
177
|
+
* @param slippageTolerance The tolerance of unfavorable slippage from the execution price of this trade
|
|
178
|
+
* @returns The amount in
|
|
179
|
+
*/
|
|
180
|
+
maximumAmountIn(slippageTolerance: Percent, amountIn?: CurrencyAmount<TInput>): CurrencyAmount<TInput>;
|
|
181
|
+
/**
|
|
182
|
+
* Return the execution price after accounting for slippage tolerance
|
|
183
|
+
* @param slippageTolerance the allowed tolerated slippage
|
|
184
|
+
* @returns The execution price
|
|
185
|
+
*/
|
|
186
|
+
worstExecutionPrice(slippageTolerance: Percent): Price<TInput, TOutput>;
|
|
187
|
+
/**
|
|
188
|
+
* Given a list of pools, and a fixed amount in, returns the top `maxNumResults` trades that go from an input token
|
|
189
|
+
* amount to an output token, making at most `maxHops` hops.
|
|
190
|
+
* Note this does not consider aggregation, as routes are linear. It's possible a better route exists by splitting
|
|
191
|
+
* the amount in among multiple routes.
|
|
192
|
+
* @param pools the pools to consider in finding the best trade
|
|
193
|
+
* @param nextAmountIn exact amount of input currency to spend
|
|
194
|
+
* @param currencyOut the desired currency out
|
|
195
|
+
* @param maxNumResults maximum number of results to return
|
|
196
|
+
* @param maxHops maximum number of hops a returned trade can make, e.g. 1 hop goes through a single pool
|
|
197
|
+
* @param currentPools used in recursion; the current list of pools
|
|
198
|
+
* @param currencyAmountIn used in recursion; the original value of the currencyAmountIn parameter
|
|
199
|
+
* @param bestTrades used in recursion; the current list of best trades
|
|
200
|
+
* @returns The exact in trade
|
|
201
|
+
*/
|
|
202
|
+
static bestTradeExactIn<TInput extends Currency, TOutput extends Currency>(pools: Pool[], currencyAmountIn: CurrencyAmount<TInput>, currencyOut: TOutput, { maxNumResults, maxHops }?: BestTradeOptions, currentPools?: Pool[], nextAmountIn?: CurrencyAmount<Currency>, bestTrades?: Trade<TInput, TOutput, TradeType.EXACT_INPUT>[]): Promise<Trade<TInput, TOutput, TradeType.EXACT_INPUT>[]>;
|
|
203
|
+
/**
|
|
204
|
+
* similar to the above method but instead targets a fixed output amount
|
|
205
|
+
* given a list of pools, and a fixed amount out, returns the top `maxNumResults` trades that go from an input token
|
|
206
|
+
* to an output token amount, making at most `maxHops` hops
|
|
207
|
+
* note this does not consider aggregation, as routes are linear. it's possible a better route exists by splitting
|
|
208
|
+
* the amount in among multiple routes.
|
|
209
|
+
* @param pools the pools to consider in finding the best trade
|
|
210
|
+
* @param currencyIn the currency to spend
|
|
211
|
+
* @param currencyAmountOut the desired currency amount out
|
|
212
|
+
* @param nextAmountOut the exact amount of currency out
|
|
213
|
+
* @param maxNumResults maximum number of results to return
|
|
214
|
+
* @param maxHops maximum number of hops a returned trade can make, e.g. 1 hop goes through a single pool
|
|
215
|
+
* @param currentPools used in recursion; the current list of pools
|
|
216
|
+
* @param bestTrades used in recursion; the current list of best trades
|
|
217
|
+
* @returns The exact out trade
|
|
218
|
+
*/
|
|
219
|
+
static bestTradeExactOut<TInput extends Currency, TOutput extends Currency>(pools: Pool[], currencyIn: TInput, currencyAmountOut: CurrencyAmount<TOutput>, { maxNumResults, maxHops }?: BestTradeOptions, currentPools?: Pool[], nextAmountOut?: CurrencyAmount<Currency>, bestTrades?: Trade<TInput, TOutput, TradeType.EXACT_OUTPUT>[]): Promise<Trade<TInput, TOutput, TradeType.EXACT_OUTPUT>[]>;
|
|
220
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export * from './entities';
|
|
2
|
+
export * from './utils';
|
|
3
|
+
export * from './constants';
|
|
4
|
+
export * from './multicall';
|
|
5
|
+
export * from './nonfungiblePositionManager';
|
|
6
|
+
export * from './payments';
|
|
7
|
+
export * from './quoter';
|
|
8
|
+
export * from './selfPermit';
|
|
9
|
+
export * from './staker';
|
|
10
|
+
export * from './swapRouter';
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { Interface } from '@ethersproject/abi';
|
|
2
|
+
export declare abstract class Multicall {
|
|
3
|
+
static INTERFACE: Interface;
|
|
4
|
+
/**
|
|
5
|
+
* Cannot be constructed.
|
|
6
|
+
*/
|
|
7
|
+
private constructor();
|
|
8
|
+
static encodeMulticall(calldatas: string | string[]): string;
|
|
9
|
+
static decodeMulticall(multicall: string): string[];
|
|
10
|
+
}
|
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
import { Interface } from '@ethersproject/abi';
|
|
2
|
+
import { TypedDataDomain, TypedDataField } from '@ethersproject/abstract-signer';
|
|
3
|
+
import { BigintIsh, Currency, CurrencyAmount, NativeCurrencyClass as NativeCurrency, Percent } from '../sdk-core';
|
|
4
|
+
import { Pool } from './entities';
|
|
5
|
+
import { Position } from './entities/position';
|
|
6
|
+
import { PermitOptions } from './selfPermit';
|
|
7
|
+
import { MethodParameters } from './utils/calldata';
|
|
8
|
+
export interface MintSpecificOptions {
|
|
9
|
+
/**
|
|
10
|
+
* The account that should receive the minted NFT.
|
|
11
|
+
*/
|
|
12
|
+
recipient: string;
|
|
13
|
+
/**
|
|
14
|
+
* Creates pool if not initialized before mint.
|
|
15
|
+
*/
|
|
16
|
+
createPool?: boolean;
|
|
17
|
+
}
|
|
18
|
+
export interface IncreaseSpecificOptions {
|
|
19
|
+
/**
|
|
20
|
+
* Indicates the ID of the position to increase liquidity for.
|
|
21
|
+
*/
|
|
22
|
+
tokenId: BigintIsh;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Options for producing the calldata to add liquidity.
|
|
26
|
+
*/
|
|
27
|
+
export interface CommonAddLiquidityOptions {
|
|
28
|
+
/**
|
|
29
|
+
* How much the pool price is allowed to move.
|
|
30
|
+
*/
|
|
31
|
+
slippageTolerance: Percent;
|
|
32
|
+
/**
|
|
33
|
+
* When the transaction expires, in epoch seconds.
|
|
34
|
+
*/
|
|
35
|
+
deadline: BigintIsh;
|
|
36
|
+
/**
|
|
37
|
+
* Whether to spend ether. If true, one of the pool tokens must be WETH, by default false
|
|
38
|
+
*/
|
|
39
|
+
useNative?: NativeCurrency;
|
|
40
|
+
/**
|
|
41
|
+
* The optional permit parameters for spending token0
|
|
42
|
+
*/
|
|
43
|
+
token0Permit?: PermitOptions;
|
|
44
|
+
/**
|
|
45
|
+
* The optional permit parameters for spending token1
|
|
46
|
+
*/
|
|
47
|
+
token1Permit?: PermitOptions;
|
|
48
|
+
}
|
|
49
|
+
export type MintOptions = CommonAddLiquidityOptions & MintSpecificOptions;
|
|
50
|
+
export type IncreaseOptions = CommonAddLiquidityOptions & IncreaseSpecificOptions;
|
|
51
|
+
export type AddLiquidityOptions = MintOptions | IncreaseOptions;
|
|
52
|
+
export interface SafeTransferOptions {
|
|
53
|
+
/**
|
|
54
|
+
* The account sending the NFT.
|
|
55
|
+
*/
|
|
56
|
+
sender: string;
|
|
57
|
+
/**
|
|
58
|
+
* The account that should receive the NFT.
|
|
59
|
+
*/
|
|
60
|
+
recipient: string;
|
|
61
|
+
/**
|
|
62
|
+
* The id of the token being sent.
|
|
63
|
+
*/
|
|
64
|
+
tokenId: BigintIsh;
|
|
65
|
+
/**
|
|
66
|
+
* The optional parameter that passes data to the `onERC721Received` call for the staker
|
|
67
|
+
*/
|
|
68
|
+
data?: string;
|
|
69
|
+
}
|
|
70
|
+
export interface CollectOptions {
|
|
71
|
+
/**
|
|
72
|
+
* Indicates the ID of the position to collect for.
|
|
73
|
+
*/
|
|
74
|
+
tokenId: BigintIsh;
|
|
75
|
+
/**
|
|
76
|
+
* Expected value of tokensOwed0, including as-of-yet-unaccounted-for fees/liquidity value to be burned
|
|
77
|
+
*/
|
|
78
|
+
expectedCurrencyOwed0: CurrencyAmount<Currency>;
|
|
79
|
+
/**
|
|
80
|
+
* Expected value of tokensOwed1, including as-of-yet-unaccounted-for fees/liquidity value to be burned
|
|
81
|
+
*/
|
|
82
|
+
expectedCurrencyOwed1: CurrencyAmount<Currency>;
|
|
83
|
+
/**
|
|
84
|
+
* The account that should receive the tokens.
|
|
85
|
+
*/
|
|
86
|
+
recipient: string;
|
|
87
|
+
}
|
|
88
|
+
export interface NFTPermitValues {
|
|
89
|
+
spender: string;
|
|
90
|
+
tokenId: BigintIsh;
|
|
91
|
+
deadline: BigintIsh;
|
|
92
|
+
nonce: BigintIsh;
|
|
93
|
+
}
|
|
94
|
+
export interface NFTPermitData {
|
|
95
|
+
domain: TypedDataDomain;
|
|
96
|
+
types: Record<string, TypedDataField[]>;
|
|
97
|
+
values: NFTPermitValues;
|
|
98
|
+
}
|
|
99
|
+
export interface NFTPermitOptions {
|
|
100
|
+
v: 0 | 1 | 27 | 28;
|
|
101
|
+
r: string;
|
|
102
|
+
s: string;
|
|
103
|
+
deadline: BigintIsh;
|
|
104
|
+
spender: string;
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* Options for producing the calldata to exit a position.
|
|
108
|
+
*/
|
|
109
|
+
export interface RemoveLiquidityOptions {
|
|
110
|
+
/**
|
|
111
|
+
* The ID of the token to exit
|
|
112
|
+
*/
|
|
113
|
+
tokenId: BigintIsh;
|
|
114
|
+
/**
|
|
115
|
+
* The percentage of position liquidity to exit.
|
|
116
|
+
*/
|
|
117
|
+
liquidityPercentage: Percent;
|
|
118
|
+
/**
|
|
119
|
+
* How much the pool price is allowed to move.
|
|
120
|
+
*/
|
|
121
|
+
slippageTolerance: Percent;
|
|
122
|
+
/**
|
|
123
|
+
* When the transaction expires, in epoch seconds.
|
|
124
|
+
*/
|
|
125
|
+
deadline: BigintIsh;
|
|
126
|
+
/**
|
|
127
|
+
* Whether the NFT should be burned if the entire position is being exited, by default false.
|
|
128
|
+
*/
|
|
129
|
+
burnToken?: boolean;
|
|
130
|
+
/**
|
|
131
|
+
* The optional permit of the token ID being exited, in case the exit transaction is being sent by an account that does not own the NFT
|
|
132
|
+
*/
|
|
133
|
+
permit?: NFTPermitOptions;
|
|
134
|
+
/**
|
|
135
|
+
* Parameters to be passed on to collect
|
|
136
|
+
*/
|
|
137
|
+
collectOptions: Omit<CollectOptions, 'tokenId'>;
|
|
138
|
+
}
|
|
139
|
+
export declare abstract class NonfungiblePositionManager {
|
|
140
|
+
static INTERFACE: Interface;
|
|
141
|
+
/**
|
|
142
|
+
* Cannot be constructed.
|
|
143
|
+
*/
|
|
144
|
+
private constructor();
|
|
145
|
+
private static encodeCreate;
|
|
146
|
+
static createCallParameters(pool: Pool): MethodParameters;
|
|
147
|
+
static addCallParameters(position: Position, options: AddLiquidityOptions): MethodParameters;
|
|
148
|
+
private static encodeCollect;
|
|
149
|
+
static collectCallParameters(options: CollectOptions): MethodParameters;
|
|
150
|
+
/**
|
|
151
|
+
* Produces the calldata for completely or partially exiting a position
|
|
152
|
+
* @param position The position to exit
|
|
153
|
+
* @param options Additional information necessary for generating the calldata
|
|
154
|
+
* @returns The call parameters
|
|
155
|
+
*/
|
|
156
|
+
static removeCallParameters(position: Position, options: RemoveLiquidityOptions): MethodParameters;
|
|
157
|
+
static safeTransferFromParameters(options: SafeTransferOptions): MethodParameters;
|
|
158
|
+
static getPermitData(permit: NFTPermitValues, positionManagerAddress: string, chainId: number): NFTPermitData;
|
|
159
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import JSBI from 'jsbi';
|
|
2
|
+
import { Interface } from '@ethersproject/abi';
|
|
3
|
+
import { Percent, Token } from '../sdk-core';
|
|
4
|
+
export interface FeeOptions {
|
|
5
|
+
/**
|
|
6
|
+
* The percent of the output that will be taken as a fee.
|
|
7
|
+
*/
|
|
8
|
+
fee: Percent;
|
|
9
|
+
/**
|
|
10
|
+
* The recipient of the fee.
|
|
11
|
+
*/
|
|
12
|
+
recipient: string;
|
|
13
|
+
}
|
|
14
|
+
export declare abstract class Payments {
|
|
15
|
+
static INTERFACE: Interface;
|
|
16
|
+
/**
|
|
17
|
+
* Cannot be constructed.
|
|
18
|
+
*/
|
|
19
|
+
private constructor();
|
|
20
|
+
private static encodeFeeBips;
|
|
21
|
+
static encodeUnwrapWETH9(amountMinimum: JSBI, recipient: string, feeOptions?: FeeOptions): string;
|
|
22
|
+
static encodeSweepToken(token: Token, amountMinimum: JSBI, recipient: string, feeOptions?: FeeOptions): string;
|
|
23
|
+
static encodeRefundETH(): string;
|
|
24
|
+
}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { Interface } from '@ethersproject/abi';
|
|
2
|
+
import { BigintIsh, Currency, CurrencyAmount, TradeType } from '../sdk-core';
|
|
3
|
+
import { Route } from './entities';
|
|
4
|
+
import { MethodParameters } from './utils';
|
|
5
|
+
/**
|
|
6
|
+
* Optional arguments to send to the quoter.
|
|
7
|
+
*/
|
|
8
|
+
export interface QuoteOptions {
|
|
9
|
+
/**
|
|
10
|
+
* The optional price limit for the trade.
|
|
11
|
+
*/
|
|
12
|
+
sqrtPriceLimitX96?: BigintIsh;
|
|
13
|
+
/**
|
|
14
|
+
* The optional quoter interface to use
|
|
15
|
+
*/
|
|
16
|
+
useQuoterV2?: boolean;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Represents the Uniswap V3 QuoterV1 contract with a method for returning the formatted
|
|
20
|
+
* calldata needed to call the quoter contract.
|
|
21
|
+
*/
|
|
22
|
+
export declare abstract class SwapQuoter {
|
|
23
|
+
static V1INTERFACE: Interface;
|
|
24
|
+
static V2INTERFACE: Interface;
|
|
25
|
+
/**
|
|
26
|
+
* Produces the on-chain method name of the appropriate function within QuoterV2,
|
|
27
|
+
* and the relevant hex encoded parameters.
|
|
28
|
+
* @template TInput The input token, either Ether or an ERC-20
|
|
29
|
+
* @template TOutput The output token, either Ether or an ERC-20
|
|
30
|
+
* @param route The swap route, a list of pools through which a swap can occur
|
|
31
|
+
* @param amount The amount of the quote, either an amount in, or an amount out
|
|
32
|
+
* @param tradeType The trade type, either exact input or exact output
|
|
33
|
+
* @param options The optional params including price limit and Quoter contract switch
|
|
34
|
+
* @returns The formatted calldata
|
|
35
|
+
*/
|
|
36
|
+
static quoteCallParameters<TInput extends Currency, TOutput extends Currency>(route: Route<TInput, TOutput>, amount: CurrencyAmount<TInput | TOutput>, tradeType: TradeType, options?: QuoteOptions): MethodParameters;
|
|
37
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { Interface } from '@ethersproject/abi';
|
|
2
|
+
import { BigintIsh, Token } from '../sdk-core';
|
|
3
|
+
export interface StandardPermitArguments {
|
|
4
|
+
v: 0 | 1 | 27 | 28;
|
|
5
|
+
r: string;
|
|
6
|
+
s: string;
|
|
7
|
+
amount: BigintIsh;
|
|
8
|
+
deadline: BigintIsh;
|
|
9
|
+
}
|
|
10
|
+
export interface AllowedPermitArguments {
|
|
11
|
+
v: 0 | 1 | 27 | 28;
|
|
12
|
+
r: string;
|
|
13
|
+
s: string;
|
|
14
|
+
nonce: BigintIsh;
|
|
15
|
+
expiry: BigintIsh;
|
|
16
|
+
}
|
|
17
|
+
export type PermitOptions = StandardPermitArguments | AllowedPermitArguments;
|
|
18
|
+
export declare abstract class SelfPermit {
|
|
19
|
+
static INTERFACE: Interface;
|
|
20
|
+
/**
|
|
21
|
+
* Cannot be constructed.
|
|
22
|
+
*/
|
|
23
|
+
private constructor();
|
|
24
|
+
static encodePermit(token: Token, options: PermitOptions): string;
|
|
25
|
+
}
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
import { Interface } from '@ethersproject/abi';
|
|
2
|
+
import { BigintIsh, Token } from '../sdk-core';
|
|
3
|
+
import { Pool } from './entities';
|
|
4
|
+
import { MethodParameters } from './utils/calldata';
|
|
5
|
+
export type FullWithdrawOptions = ClaimOptions & WithdrawOptions;
|
|
6
|
+
/**
|
|
7
|
+
* Represents a unique staking program.
|
|
8
|
+
*/
|
|
9
|
+
export interface IncentiveKey {
|
|
10
|
+
/**
|
|
11
|
+
* The token rewarded for participating in the staking program.
|
|
12
|
+
*/
|
|
13
|
+
rewardToken: Token;
|
|
14
|
+
/**
|
|
15
|
+
* The pool that the staked positions must provide in.
|
|
16
|
+
*/
|
|
17
|
+
pool: Pool;
|
|
18
|
+
/**
|
|
19
|
+
* The time when the incentive program begins.
|
|
20
|
+
*/
|
|
21
|
+
startTime: BigintIsh;
|
|
22
|
+
/**
|
|
23
|
+
* The time that the incentive program ends.
|
|
24
|
+
*/
|
|
25
|
+
endTime: BigintIsh;
|
|
26
|
+
/**
|
|
27
|
+
* The address which receives any remaining reward tokens at `endTime`.
|
|
28
|
+
*/
|
|
29
|
+
refundee: string;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Options to specify when claiming rewards.
|
|
33
|
+
*/
|
|
34
|
+
export interface ClaimOptions {
|
|
35
|
+
/**
|
|
36
|
+
* The id of the NFT
|
|
37
|
+
*/
|
|
38
|
+
tokenId: BigintIsh;
|
|
39
|
+
/**
|
|
40
|
+
* Address to send rewards to.
|
|
41
|
+
*/
|
|
42
|
+
recipient: string;
|
|
43
|
+
/**
|
|
44
|
+
* The amount of `rewardToken` to claim. 0 claims all.
|
|
45
|
+
*/
|
|
46
|
+
amount?: BigintIsh;
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Options to specify when withdrawing a position.
|
|
50
|
+
*/
|
|
51
|
+
export interface WithdrawOptions {
|
|
52
|
+
/**
|
|
53
|
+
* Set when withdrawing. The position will be sent to `owner` on withdraw.
|
|
54
|
+
*/
|
|
55
|
+
owner: string;
|
|
56
|
+
/**
|
|
57
|
+
* Set when withdrawing. `data` is passed to `safeTransferFrom` when transferring the position from contract back to owner.
|
|
58
|
+
*/
|
|
59
|
+
data?: string;
|
|
60
|
+
}
|
|
61
|
+
export declare abstract class Staker {
|
|
62
|
+
static INTERFACE: Interface;
|
|
63
|
+
protected constructor();
|
|
64
|
+
private static INCENTIVE_KEY_ABI;
|
|
65
|
+
/**
|
|
66
|
+
* To claim rewards, must unstake and then claim.
|
|
67
|
+
* @param incentiveKey The unique identifier of a staking program.
|
|
68
|
+
* @param options Options for producing the calldata to claim. Can't claim unless you unstake.
|
|
69
|
+
* @returns The calldatas for 'unstakeToken' and 'claimReward'.
|
|
70
|
+
*/
|
|
71
|
+
private static encodeClaim;
|
|
72
|
+
/**
|
|
73
|
+
*
|
|
74
|
+
* Note: A `tokenId` can be staked in many programs but to claim rewards and continue the program you must unstake, claim, and then restake.
|
|
75
|
+
* @param incentiveKeys An IncentiveKey or array of IncentiveKeys that `tokenId` is staked in.
|
|
76
|
+
* Input an array of IncentiveKeys to claim rewards for each program.
|
|
77
|
+
* @param options ClaimOptions to specify tokenId, recipient, and amount wanting to collect.
|
|
78
|
+
* Note that you can only specify one amount and one recipient across the various programs if you are collecting from multiple programs at once.
|
|
79
|
+
* @returns
|
|
80
|
+
*/
|
|
81
|
+
static collectRewards(incentiveKeys: IncentiveKey | IncentiveKey[], options: ClaimOptions): MethodParameters;
|
|
82
|
+
/**
|
|
83
|
+
*
|
|
84
|
+
* @param incentiveKeys A list of incentiveKeys to unstake from. Should include all incentiveKeys (unique staking programs) that `options.tokenId` is staked in.
|
|
85
|
+
* @param withdrawOptions Options for producing claim calldata and withdraw calldata. Can't withdraw without unstaking all programs for `tokenId`.
|
|
86
|
+
* @returns Calldata for unstaking, claiming, and withdrawing.
|
|
87
|
+
*/
|
|
88
|
+
static withdrawToken(incentiveKeys: IncentiveKey | IncentiveKey[], withdrawOptions: FullWithdrawOptions): MethodParameters;
|
|
89
|
+
/**
|
|
90
|
+
*
|
|
91
|
+
* @param incentiveKeys A single IncentiveKey or array of IncentiveKeys to be encoded and used in the data parameter in `safeTransferFrom`
|
|
92
|
+
* @returns An IncentiveKey as a string
|
|
93
|
+
*/
|
|
94
|
+
static encodeDeposit(incentiveKeys: IncentiveKey | IncentiveKey[]): string;
|
|
95
|
+
/**
|
|
96
|
+
*
|
|
97
|
+
* @param incentiveKey An `IncentiveKey` which represents a unique staking program.
|
|
98
|
+
* @returns An encoded IncentiveKey to be read by ethers
|
|
99
|
+
*/
|
|
100
|
+
private static _encodeIncentiveKey;
|
|
101
|
+
}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import { Interface } from '@ethersproject/abi';
|
|
2
|
+
import { BigintIsh, Currency, Percent, TradeType } from '../sdk-core';
|
|
3
|
+
import { Trade } from './entities/trade';
|
|
4
|
+
import { FeeOptions } from './payments';
|
|
5
|
+
import { PermitOptions } from './selfPermit';
|
|
6
|
+
import { MethodParameters } from './utils/calldata';
|
|
7
|
+
/**
|
|
8
|
+
* Options for producing the arguments to send calls to the router.
|
|
9
|
+
*/
|
|
10
|
+
export interface SwapOptions {
|
|
11
|
+
/**
|
|
12
|
+
* How much the execution price is allowed to move unfavorably from the trade execution price.
|
|
13
|
+
*/
|
|
14
|
+
slippageTolerance: Percent;
|
|
15
|
+
/**
|
|
16
|
+
* The account that should receive the output.
|
|
17
|
+
*/
|
|
18
|
+
recipient: string;
|
|
19
|
+
/**
|
|
20
|
+
* When the transaction expires, in epoch seconds.
|
|
21
|
+
*/
|
|
22
|
+
deadline: BigintIsh;
|
|
23
|
+
/**
|
|
24
|
+
* The optional permit parameters for spending the input.
|
|
25
|
+
*/
|
|
26
|
+
inputTokenPermit?: PermitOptions;
|
|
27
|
+
/**
|
|
28
|
+
* The optional price limit for the trade.
|
|
29
|
+
*/
|
|
30
|
+
sqrtPriceLimitX96?: BigintIsh;
|
|
31
|
+
/**
|
|
32
|
+
* Optional information for taking a fee on output.
|
|
33
|
+
*/
|
|
34
|
+
fee?: FeeOptions;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Represents the Uniswap V3 SwapRouter, and has static methods for helping execute trades.
|
|
38
|
+
*/
|
|
39
|
+
export declare abstract class SwapRouter {
|
|
40
|
+
static INTERFACE: Interface;
|
|
41
|
+
/**
|
|
42
|
+
* Cannot be constructed.
|
|
43
|
+
*/
|
|
44
|
+
private constructor();
|
|
45
|
+
/**
|
|
46
|
+
* Produces the on-chain method name to call and the hex encoded parameters to pass as arguments for a given trade.
|
|
47
|
+
* @param trade to produce call parameters for
|
|
48
|
+
* @param options options for the call parameters
|
|
49
|
+
*/
|
|
50
|
+
static swapCallParameters(trades: Trade<Currency, Currency, TradeType> | Trade<Currency, Currency, TradeType>[], options: SwapOptions): MethodParameters;
|
|
51
|
+
}
|