@uniswap/sdk-core 7.6.0 → 7.7.0

package/dist/types/src/chains.d.ts

@@ -0,0 +1,44 @@
+export declare enum ChainId {
+    MAINNET = 1,
+    GOERLI = 5,
+    SEPOLIA = 11155111,
+    OPTIMISM = 10,
+    OPTIMISM_GOERLI = 420,
+    OPTIMISM_SEPOLIA = 11155420,
+    ARBITRUM_ONE = 42161,
+    ARBITRUM_GOERLI = 421613,
+    ARBITRUM_SEPOLIA = 421614,
+    POLYGON = 137,
+    POLYGON_MUMBAI = 80001,
+    CELO = 42220,
+    CELO_ALFAJORES = 44787,
+    GNOSIS = 100,
+    MOONBEAM = 1284,
+    BNB = 56,
+    AVALANCHE = 43114,
+    BASE_GOERLI = 84531,
+    BASE_SEPOLIA = 84532,
+    BASE = 8453,
+    ZORA = 7777777,
+    ZORA_SEPOLIA = 999999999,
+    ROOTSTOCK = 30,
+    BLAST = 81457,
+    ZKSYNC = 324,
+    WORLDCHAIN = 480,
+    UNICHAIN_SEPOLIA = 1301,
+    UNICHAIN = 130,
+    MONAD_TESTNET = 10143,
+    SONEIUM = 1868
+}
+export declare const SUPPORTED_CHAINS: readonly [ChainId.MAINNET, ChainId.OPTIMISM, ChainId.OPTIMISM_GOERLI, ChainId.OPTIMISM_SEPOLIA, ChainId.ARBITRUM_ONE, ChainId.ARBITRUM_GOERLI, ChainId.ARBITRUM_SEPOLIA, ChainId.POLYGON, ChainId.POLYGON_MUMBAI, ChainId.GOERLI, ChainId.SEPOLIA, ChainId.CELO_ALFAJORES, ChainId.CELO, ChainId.BNB, ChainId.AVALANCHE, ChainId.BASE, ChainId.BASE_GOERLI, ChainId.BASE_SEPOLIA, ChainId.ZORA, ChainId.ZORA_SEPOLIA, ChainId.ROOTSTOCK, ChainId.BLAST, ChainId.ZKSYNC, ChainId.WORLDCHAIN, ChainId.UNICHAIN_SEPOLIA, ChainId.UNICHAIN, ChainId.MONAD_TESTNET, ChainId.SONEIUM];
+export type SupportedChainsType = (typeof SUPPORTED_CHAINS)[number];
+export declare enum NativeCurrencyName {
+    ETHER = "ETH",
+    MATIC = "MATIC",
+    CELO = "CELO",
+    GNOSIS = "XDAI",
+    MOONBEAM = "GLMR",
+    BNB = "BNB",
+    AVAX = "AVAX",
+    ROOTSTOCK = "RBTC"
+}

package/dist/types/src/constants.d.ts

@@ -0,0 +1,12 @@
+import JSBI from 'jsbi';
+export type BigintIsh = JSBI | string | number;
+export declare enum TradeType {
+    EXACT_INPUT = 0,
+    EXACT_OUTPUT = 1
+}
+export declare enum Rounding {
+    ROUND_DOWN = 0,
+    ROUND_HALF_UP = 1,
+    ROUND_UP = 2
+}
+export declare const MaxUint256: JSBI;

package/dist/types/src/entities/baseCurrency.d.ts

@@ -0,0 +1,49 @@
+import { Currency } from './currency';
+import { Token } from './token';
+/**
+ * A currency is any fungible financial instrument, including Ether, all ERC20 tokens, and other chain-native currencies
+ */
+export declare abstract class BaseCurrency {
+    /**
+     * Returns whether the currency is native to the chain and must be wrapped (e.g. Ether)
+     */
+    abstract readonly isNative: boolean;
+    /**
+     * Returns whether the currency is a token that is usable in Uniswap without wrapping
+     */
+    abstract readonly isToken: boolean;
+    /**
+     * The chain ID on which this currency resides
+     */
+    readonly chainId: number;
+    /**
+     * The decimals used in representing currency amounts
+     */
+    readonly decimals: number;
+    /**
+     * The symbol of the currency, i.e. a short textual non-unique identifier
+     */
+    readonly symbol?: string;
+    /**
+     * The name of the currency, i.e. a descriptive textual non-unique identifier
+     */
+    readonly name?: string;
+    /**
+     * Constructs an instance of the base class `BaseCurrency`.
+     * @param chainId the chain ID on which this currency resides
+     * @param decimals decimals of the currency
+     * @param symbol symbol of the currency
+     * @param name of the currency
+     */
+    protected constructor(chainId: number, decimals: number, symbol?: string, name?: string);
+    /**
+     * Returns whether this currency is functionally equivalent to the other currency
+     * @param other the other currency
+     */
+    abstract equals(other: Currency): boolean;
+    /**
+     * Return the wrapped version of this currency that can be used with the Uniswap contracts. Currencies must
+     * implement this to be used in Uniswap
+     */
+    abstract get wrapped(): Token;
+}

package/dist/types/src/entities/currency.d.ts

@@ -0,0 +1,3 @@
+import { NativeCurrency } from './nativeCurrency';
+import { Token } from './token';
+export type Currency = NativeCurrency | Token;

package/dist/types/src/entities/currency.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/entities/ether.d.ts

@@ -0,0 +1,13 @@
+import { Currency } from './currency';
+import { NativeCurrency } from './nativeCurrency';
+import { Token } from './token';
+/**
+ * Ether is the main usage of a 'native' currency, i.e. for Ethereum mainnet and all testnets
+ */
+export declare class Ether extends NativeCurrency {
+    protected constructor(chainId: number);
+    get wrapped(): Token;
+    private static _etherCache;
+    static onChain(chainId: number): Ether;
+    equals(other: Currency): boolean;
+}

package/dist/types/src/entities/ether.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/entities/fractions/currencyAmount.d.ts

@@ -0,0 +1,31 @@
+import JSBI from 'jsbi';
+import { Currency } from '../currency';
+import { Token } from '../token';
+import { Fraction } from './fraction';
+import { BigintIsh, Rounding } from '../../constants';
+export declare class CurrencyAmount<T extends Currency> extends Fraction {
+    readonly currency: T;
+    readonly decimalScale: JSBI;
+    /**
+     * Returns a new currency amount instance from the unitless amount of token, i.e. the raw amount
+     * @param currency the currency in the amount
+     * @param rawAmount the raw token or ether amount
+     */
+    static fromRawAmount<T extends Currency>(currency: T, rawAmount: BigintIsh): CurrencyAmount<T>;
+    /**
+     * Construct a currency amount with a denominator that is not equal to 1
+     * @param currency the currency
+     * @param numerator the numerator of the fractional token amount
+     * @param denominator the denominator of the fractional token amount
+     */
+    static fromFractionalAmount<T extends Currency>(currency: T, numerator: BigintIsh, denominator: BigintIsh): CurrencyAmount<T>;
+    protected constructor(currency: T, numerator: BigintIsh, denominator?: BigintIsh);
+    add(other: CurrencyAmount<T>): CurrencyAmount<T>;
+    subtract(other: CurrencyAmount<T>): CurrencyAmount<T>;
+    multiply(other: Fraction | BigintIsh): CurrencyAmount<T>;
+    divide(other: Fraction | BigintIsh): CurrencyAmount<T>;
+    toSignificant(significantDigits?: number, format?: object, rounding?: Rounding): string;
+    toFixed(decimalPlaces?: number, format?: object, rounding?: Rounding): string;
+    toExact(format?: object): string;
+    get wrapped(): CurrencyAmount<Token>;
+}

package/dist/types/src/entities/fractions/currencyAmount.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/entities/fractions/fraction.d.ts

@@ -0,0 +1,24 @@
+import JSBI from 'jsbi';
+import { BigintIsh, Rounding } from '../../constants';
+export declare class Fraction {
+    readonly numerator: JSBI;
+    readonly denominator: JSBI;
+    constructor(numerator: BigintIsh, denominator?: BigintIsh);
+    private static tryParseFraction;
+    get quotient(): JSBI;
+    get remainder(): Fraction;
+    invert(): Fraction;
+    add(other: Fraction | BigintIsh): Fraction;
+    subtract(other: Fraction | BigintIsh): Fraction;
+    lessThan(other: Fraction | BigintIsh): boolean;
+    equalTo(other: Fraction | BigintIsh): boolean;
+    greaterThan(other: Fraction | BigintIsh): boolean;
+    multiply(other: Fraction | BigintIsh): Fraction;
+    divide(other: Fraction | BigintIsh): Fraction;
+    toSignificant(significantDigits: number, format?: object, rounding?: Rounding): string;
+    toFixed(decimalPlaces: number, format?: object, rounding?: Rounding): string;
+    /**
+     * Helper method for converting any super class back to a fraction
+     */
+    get asFraction(): Fraction;
+}

package/dist/types/src/entities/fractions/fraction.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/entities/fractions/index.d.ts

@@ -0,0 +1,4 @@
+export { CurrencyAmount } from './currencyAmount';
+export { Fraction } from './fraction';
+export { Percent } from './percent';
+export { Price } from './price';

package/dist/types/src/entities/fractions/percent.d.ts

@@ -0,0 +1,14 @@
+import { BigintIsh, Rounding } from '../../constants';
+import { Fraction } from './fraction';
+export declare class Percent extends Fraction {
+    /**
+     * This boolean prevents a fraction from being interpreted as a Percent
+     */
+    readonly isPercent: true;
+    add(other: Fraction | BigintIsh): Percent;
+    subtract(other: Fraction | BigintIsh): Percent;
+    multiply(other: Fraction | BigintIsh): Percent;
+    divide(other: Fraction | BigintIsh): Percent;
+    toSignificant(significantDigits?: number, format?: object, rounding?: Rounding): string;
+    toFixed(decimalPlaces?: number, format?: object, rounding?: Rounding): string;
+}

package/dist/types/src/entities/fractions/percent.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/entities/fractions/price.d.ts

@@ -0,0 +1,38 @@
+import { BigintIsh, Rounding } from '../../constants';
+import { Currency } from '../currency';
+import { Fraction } from './fraction';
+import { CurrencyAmount } from './currencyAmount';
+export declare class Price<TBase extends Currency, TQuote extends Currency> extends Fraction {
+    readonly baseCurrency: TBase;
+    readonly quoteCurrency: TQuote;
+    readonly scalar: Fraction;
+    /**
+     * Construct a price, either with the base and quote currency amount, or the
+     * @param args
+     */
+    constructor(...args: [TBase, TQuote, BigintIsh, BigintIsh] | [{
+        baseAmount: CurrencyAmount<TBase>;
+        quoteAmount: CurrencyAmount<TQuote>;
+    }]);
+    /**
+     * Flip the price, switching the base and quote currency
+     */
+    invert(): Price<TQuote, TBase>;
+    /**
+     * Multiply the price by another price, returning a new price. The other price must have the same base currency as this price's quote currency
+     * @param other the other price
+     */
+    multiply<TOtherQuote extends Currency>(other: Price<TQuote, TOtherQuote>): Price<TBase, TOtherQuote>;
+    /**
+     * Return the amount of quote currency corresponding to a given amount of the base currency
+     * @param currencyAmount the amount of base currency to quote against the price
+     */
+    quote(currencyAmount: CurrencyAmount<TBase>): CurrencyAmount<TQuote>;
+    /**
+     * Get the value scaled by decimals for formatting
+     * @private
+     */
+    private get adjustedForDecimals();
+    toSignificant(significantDigits?: number, format?: object, rounding?: Rounding): string;
+    toFixed(decimalPlaces?: number, format?: object, rounding?: Rounding): string;
+}

package/dist/types/src/entities/fractions/price.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/entities/index.d.ts

@@ -0,0 +1,6 @@
+export * from './fractions';
+export * from './currency';
+export * from './ether';
+export * from './nativeCurrency';
+export * from './token';
+export * from './weth9';

package/dist/types/src/entities/nativeCurrency.d.ts

@@ -0,0 +1,8 @@
+import { BaseCurrency } from './baseCurrency';
+/**
+ * Represents the native currency of the chain on which it resides, e.g.
+ */
+export declare abstract class NativeCurrency extends BaseCurrency {
+    readonly isNative: true;
+    readonly isToken: false;
+}

package/dist/types/src/entities/token.d.ts

@@ -0,0 +1,48 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { BaseCurrency } from './baseCurrency';
+import { Currency } from './currency';
+/**
+ * Represents an ERC20 token with a unique address and some metadata.
+ */
+export declare class Token extends BaseCurrency {
+    readonly isNative: false;
+    readonly isToken: true;
+    /**
+     * The contract address on the chain on which this token lives
+     */
+    readonly address: string;
+    /**
+     * Relevant for fee-on-transfer (FOT) token taxes,
+     * Not every ERC20 token is FOT token, so this field is optional
+     */
+    readonly buyFeeBps?: BigNumber;
+    readonly sellFeeBps?: BigNumber;
+    /**
+     *
+     * @param chainId {@link BaseCurrency#chainId}
+     * @param address The contract address on the chain on which this token lives
+     * @param decimals {@link BaseCurrency#decimals}
+     * @param symbol {@link BaseCurrency#symbol}
+     * @param name {@link BaseCurrency#name}
+     * @param bypassChecksum If true it only checks for length === 42, startsWith 0x and contains only hex characters
+     * @param buyFeeBps Buy fee tax for FOT tokens, in basis points
+     * @param sellFeeBps Sell fee tax for FOT tokens, in basis points
+     */
+    constructor(chainId: number, address: string, decimals: number, symbol?: string, name?: string, bypassChecksum?: boolean, buyFeeBps?: BigNumber, sellFeeBps?: BigNumber);
+    /**
+     * Returns true if the two tokens are equivalent, i.e. have the same chainId and address.
+     * @param other other token to compare
+     */
+    equals(other: Currency): boolean;
+    /**
+     * Returns true if the address of this token sorts before the address of the other token
+     * @param other other token to compare
+     * @throws if the tokens have the same address
+     * @throws if the tokens are on different chains
+     */
+    sortsBefore(other: Token): boolean;
+    /**
+     * Return this token, which does not need to be wrapped
+     */
+    get wrapped(): Token;
+}

package/dist/types/src/entities/token.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/entities/weth9.d.ts

@@ -0,0 +1,7 @@
+import { Token } from './token';
+/**
+ * Known WETH9 implementation addresses, used in our implementation of Ether#wrapped
+ */
+export declare const WETH9: {
+    [chainId: number]: Token;
+};

package/dist/types/src/index.d.ts

@@ -0,0 +1,5 @@
+export * from './addresses';
+export * from './chains';
+export * from './constants';
+export * from './entities';
+export * from './utils';

package/dist/types/src/utils/computePriceImpact.d.ts

@@ -0,0 +1,8 @@
+import { Currency, CurrencyAmount, Percent, Price } from '../entities';
+/**
+ * Returns the percent difference between the mid price and the execution price, i.e. price impact.
+ * @param midPrice mid price before the trade
+ * @param inputAmount the input amount of the trade
+ * @param outputAmount the output amount of the trade
+ */
+export declare function computePriceImpact<TBase extends Currency, TQuote extends Currency>(midPrice: Price<TBase, TQuote>, inputAmount: CurrencyAmount<TBase>, outputAmount: CurrencyAmount<TQuote>): Percent;

package/dist/types/src/utils/computePriceImpact.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/utils/computeZksyncCreate2Address.d.ts

@@ -0,0 +1,2 @@
+import { BytesLike } from '@ethersproject/bytes';
+export declare function computeZksyncCreate2Address(sender: string, bytecodeHash: BytesLike, salt: BytesLike, input?: BytesLike): string;

package/dist/types/src/utils/index.d.ts

@@ -0,0 +1,5 @@
+export { computePriceImpact } from './computePriceImpact';
+export { computeZksyncCreate2Address } from './computeZksyncCreate2Address';
+export { sortedInsert } from './sortedInsert';
+export { sqrt } from './sqrt';
+export { validateAndParseAddress } from './validateAndParseAddress';

package/dist/types/src/utils/sortedInsert.d.ts

@@ -0,0 +1 @@
+export declare function sortedInsert<T>(items: T[], add: T, maxSize: number, comparator: (a: T, b: T) => number): T | null;

package/dist/types/src/utils/sortedInsert.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/utils/sqrt.d.ts

@@ -0,0 +1,7 @@
+import JSBI from 'jsbi';
+export declare const MAX_SAFE_INTEGER: JSBI;
+/**
+ * Computes floor(sqrt(value))
+ * @param value the value for which to compute the square root, rounded down
+ */
+export declare function sqrt(value: JSBI): JSBI;

package/dist/types/src/utils/sqrt.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/utils/validateAndParseAddress.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Validates an address and returns the parsed (checksummed) version of that address
+ * @param address the unchecksummed hex address
+ */
+export declare function validateAndParseAddress(address: string): string;
+/**
+ * Checks if an address is valid by checking 0x prefix, length === 42 and hex encoding.
+ * @param address the unchecksummed hex address
+ */
+export declare function checkValidAddress(address: string): string;

package/dist/types/src/utils/validateAndParseAddress.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -7,9 +7,9 @@
     "ethereum"
   ],
   "license": "MIT",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
-  "module": "dist/sdk-core.esm.js",
+  "main": "./dist/cjs/src/index.js",
+  "module": "./dist/esm/src/index.js",
+  "types": "./dist/types/src/index.d.ts",
   "files": [
     "dist"
   ],
@@ -17,11 +17,15 @@
     "node": ">=10"
   },
   "scripts": {
-    "build": "tsdx build",
-    "lint": "tsdx lint src",
-    "release": "semantic-release",
-    "start": "tsdx watch",
-    "test": "tsdx test"
+    "clean": "rm -rf dist",
+    "build": "yarn clean && yarn build:cjs && yarn build:esm && yarn build:types",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:types": "tsc -p tsconfig.types.json",
+    "lint": "eslint src --ext .ts",
+    "lint:fix": "eslint src --ext .ts --fix",
+    "test": "jest",
+    "release": "semantic-release"
   },
   "dependencies": {
     "@ethersproject/address": "^5.0.2",
@@ -37,7 +41,21 @@
   "devDependencies": {
     "@types/big.js": "^4.0.5",
     "@types/jest": "^24.0.25",
-    "tsdx": "^0.14.1"
+    "eslint": "^7.8.0",
+    "eslint-config-prettier": "^6.11.0",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-functional": "^3.0.2",
+    "eslint-plugin-import": "^2.22.0",
+    "jest": "25.5.0",
+    "prettier": "^2.4.1",
+    "typescript": "^4.3.3"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/types/src/index.d.ts",
+      "import": "./dist/esm/src/index.js",
+      "require": "./dist/cjs/src/index.js"
+    }
   },
   "prettier": {
     "printWidth": 120,
@@ -77,5 +95,5 @@
       ]
     ]
   },
-  "version": "7.6.0"
+  "version": "7.7.0"
 }

package/dist/index.js

@@ -1,8 +0,0 @@
-
-'use strict'
-
-if (process.env.NODE_ENV === 'production') {
-  module.exports = require('./sdk-core.cjs.production.min.js')
-} else {
-  module.exports = require('./sdk-core.cjs.development.js')
-}