feat: native bigint support, modernization of sdk

.github/workflows/lint.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Set up node
         uses: actions/setup-node@v2
         with:
-          node-version: 12
+          node-version: 14
 
       - name: Install dependencies
         run: yarn install --frozen-lockfile

.github/workflows/unit-tests.yml

@@ -13,7 +13,7 @@ jobs:
     name: Unit tests
     strategy:
       matrix:
-        node: ['10.x', '12.x', '14.x']
+        node: ['14.x', '16.x', '18.x']
 
     runs-on: ubuntu-latest
 

jest.config.js

@@ -0,0 +1,25 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'jsdom',
+  transform: {
+    // transform files with ts-jest
+    '^.+\\.(js|ts)$': [
+      'ts-jest',
+      {
+        tsconfig: {
+          // allow js in typescript
+          allowJs: true,
+        },
+      },
+    ],
+  },
+  transformIgnorePatterns: [
+    // allow lit-html transformation
+    'node_modules/(?!lit-html)',
+  ],
+  // for absolute imports
+  moduleNameMapper: {
+    'src/(.*)': '<rootDir>/src/$1',
+  },
+}

package.json

@@ -13,12 +13,10 @@
     "uniswap",
     "ethereum"
   ],
-  "module": "dist/sdk-core.esm.js",
   "scripts": {
-    "build": "tsdx build",
-    "start": "tsdx watch",
-    "test": "tsdx test",
-    "prepublishOnly": "tsdx build"
+    "build": "tsc",
+    "test": "jest",
+    "prepublishOnly": "tsc"
   },
   "dependencies": {
     "@ethersproject/address": "^5.0.2",
@@ -31,10 +29,14 @@
   "devDependencies": {
     "@types/big.js": "^4.0.5",
     "@types/jest": "^24.0.25",
-    "tsdx": "^0.14.1"
+    "tslib": "^2.5.1",
+    "typescript": "^5.0.4",
+    "jest": "^29.5.0",
+    "ts-jest": "^29.1.0",
+    "jest-environment-jsdom": "^29.5.0"
   },
   "engines": {
-    "node": ">=10"
+    "node": ">=14"
   },
   "prettier": {
     "printWidth": 120,

src/entities/currency.test.ts → src/__tests__/entities/currency.test.ts

@@ -1,4 +1,4 @@
-import { Ether, Token } from './index'
+import { Ether, Token } from 'src/entities/index'
 
 describe('Currency', () => {
   const ADDRESS_ZERO = '0x0000000000000000000000000000000000000000'

src/entities/ether.test.ts → src/__tests__/entities/ether.test.ts

@@ -1,4 +1,4 @@
-import { Ether } from './ether'
+import { Ether } from 'src/entities/ether'
 
 describe('Ether', () => {
   it('static constructor uses cache', () => {

src/entities/fractions/currencyAmount.test.ts → src/__tests__/entities/fractions/currencyAmount.test.ts

@@ -1,9 +1,9 @@
 import JSBI from 'jsbi'
-import { MaxUint256 } from '../../constants'
-import { Ether } from '../ether'
-import { Token } from '../token'
-import { CurrencyAmount } from './currencyAmount'
-import { Percent } from './percent'
+import { MaxUint256 } from 'src/constants'
+import { Ether } from 'src/entities/ether'
+import { Token } from 'src/entities/token'
+import { CurrencyAmount } from 'src/entities/fractions/currencyAmount'
+import { Percent } from 'src/entities/fractions/percent'
 
 describe('CurrencyAmount', () => {
   const ADDRESS_ONE = '0x0000000000000000000000000000000000000001'

src/entities/fractions/fraction.test.ts → src/__tests__/entities/fractions/fraction.test.ts

@@ -1,5 +1,5 @@
 import JSBI from 'jsbi'
-import { Fraction } from './fraction'
+import { Fraction } from 'src/entities/fractions/fraction'
 
 describe('Fraction', () => {
   describe('#quotient', () => {

src/entities/fractions/percent.test.ts → src/__tests__/entities/fractions/percent.test.ts

@@ -1,4 +1,4 @@
-import { Percent } from './percent'
+import { Percent } from 'src/entities/fractions/percent'
 
 describe('Percent', () => {
   describe('constructor', () => {

src/entities/fractions/price.test.ts → src/__tests__/entities/fractions/price.test.ts

@@ -1,6 +1,6 @@
-import { Token } from '../token'
-import { CurrencyAmount } from './currencyAmount'
-import { Price } from './price'
+import { Token } from 'src/entities/token'
+import { CurrencyAmount } from 'src/entities/fractions/currencyAmount'
+import { Price } from 'src/entities/fractions/price'
 
 describe('Price', () => {
   const ADDRESS_ZERO = '0x0000000000000000000000000000000000000000'
@@ -20,7 +20,7 @@ describe('Price', () => {
     it('object format works', () => {
       const price = new Price({
         baseAmount: CurrencyAmount.fromRawAmount(t0, 1),
-        quoteAmount: CurrencyAmount.fromRawAmount(t1, 54321)
+        quoteAmount: CurrencyAmount.fromRawAmount(t1, 54321),
       })
       expect(price.toSignificant(5)).toEqual('54321')
       expect(price.baseCurrency.equals(t0))

src/entities/token.test.ts → src/__tests__/entities/token.test.ts

@@ -1,4 +1,4 @@
-import { Token } from './token'
+import { Token } from 'src/entities/token'
 import { BigNumber } from '@ethersproject/bignumber'
 
 describe('Token', () => {

src/utils/computePriceImpact.test.ts → src/__tests__/utils/computePriceImpact.test.ts

@@ -1,5 +1,5 @@
-import { CurrencyAmount, Ether, Percent, Price, Token } from '../entities'
-import { computePriceImpact } from './computePriceImpact'
+import { CurrencyAmount, Ether, Percent, Price, Token } from 'src/entities'
+import { computePriceImpact } from 'src/utils/computePriceImpact'
 
 describe('#computePriceImpact', () => {
   const ADDRESS_ZERO = '0x0000000000000000000000000000000000000000'

src/utils/sortedInsert.test.ts → src/__tests__/utils/sortedInsert.test.ts

@@ -1,4 +1,4 @@
-import { sortedInsert } from './sortedInsert'
+import { sortedInsert } from 'src/utils/sortedInsert'
 
 describe('#sortedInsert', () => {
   const comp = (a: number, b: number) => a - b

src/utils/sqrt.test.ts → src/__tests__/utils/sqrt.test.ts

@@ -1,6 +1,6 @@
 import JSBI from 'jsbi'
-import { MaxUint256 } from '../constants'
-import { sqrt } from './sqrt'
+import { MaxUint256 } from 'src/constants'
+import { sqrt } from 'src/utils/sqrt'
 
 describe('#sqrt', () => {
   it('correct for 0-1000', () => {

src/utils/validateAndParseAddress.test.ts → src/__tests__/utils/validateAndParseAddress.test.ts

@@ -1,4 +1,4 @@
-import { checkValidAddress, validateAndParseAddress } from './validateAndParseAddress'
+import { checkValidAddress, validateAndParseAddress } from 'src/utils/validateAndParseAddress'
 
 describe('#validateAndParseAddress', () => {
   it('returns same address if already checksummed', () => {

src/constants.ts

@@ -1,17 +1,18 @@
 import JSBI from 'jsbi'
 
 // exports for external consumption
-export type BigintIsh = JSBI | string | number
+export type BigintIsh = bigint | JSBI | string | number
 
 export enum TradeType {
   EXACT_INPUT,
-  EXACT_OUTPUT
+  EXACT_OUTPUT,
 }
 
 export enum Rounding {
   ROUND_DOWN,
   ROUND_HALF_UP,
-  ROUND_UP
+  ROUND_UP,
 }
 
 export const MaxUint256 = JSBI.BigInt('0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff')
+export const MaxUint256BigInt = BigInt('0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff')

src/entities/fractions/currencyAmount.ts

@@ -6,13 +6,16 @@ import { Fraction } from './fraction'
 import _Big from 'big.js'
 
 import toFormat from 'toformat'
-import { BigintIsh, Rounding, MaxUint256 } from '../../constants'
+import { BigintIsh, Rounding, MaxUint256BigInt } from '../../constants'
 
 const Big = toFormat(_Big)
 
 export class CurrencyAmount<T extends Currency> extends Fraction {
   public readonly currency: T
-  public readonly decimalScale: JSBI
+  public get decimalScale(): JSBI {
+    return JSBI.BigInt(this._decimalScale.toString(10))
+  }
+  public readonly _decimalScale: bigint
 
   /**
    * Returns a new currency amount instance from the unitless amount of token, i.e. the raw amount
@@ -39,39 +42,39 @@ export class CurrencyAmount<T extends Currency> extends Fraction {
 
   protected constructor(currency: T, numerator: BigintIsh, denominator?: BigintIsh) {
     super(numerator, denominator)
-    invariant(JSBI.lessThanOrEqual(this.quotient, MaxUint256), 'AMOUNT')
+    invariant(this.quotientBigInt <= MaxUint256BigInt, 'AMOUNT')
     this.currency = currency
-    this.decimalScale = JSBI.exponentiate(JSBI.BigInt(10), JSBI.BigInt(currency.decimals))
+    this._decimalScale = 10n ** BigInt(currency.decimals)
   }
 
   public add(other: CurrencyAmount<T>): CurrencyAmount<T> {
     invariant(this.currency.equals(other.currency), 'CURRENCY')
     const added = super.add(other)
-    return CurrencyAmount.fromFractionalAmount(this.currency, added.numerator, added.denominator)
+    return CurrencyAmount.fromFractionalAmount(this.currency, added._numerator, added._denominator)
   }
 
   public subtract(other: CurrencyAmount<T>): CurrencyAmount<T> {
     invariant(this.currency.equals(other.currency), 'CURRENCY')
     const subtracted = super.subtract(other)
-    return CurrencyAmount.fromFractionalAmount(this.currency, subtracted.numerator, subtracted.denominator)
+    return CurrencyAmount.fromFractionalAmount(this.currency, subtracted._numerator, subtracted._denominator)
   }
 
   public multiply(other: Fraction | BigintIsh): CurrencyAmount<T> {
     const multiplied = super.multiply(other)
-    return CurrencyAmount.fromFractionalAmount(this.currency, multiplied.numerator, multiplied.denominator)
+    return CurrencyAmount.fromFractionalAmount(this.currency, multiplied._numerator, multiplied._denominator)
   }
 
   public divide(other: Fraction | BigintIsh): CurrencyAmount<T> {
     const divided = super.divide(other)
-    return CurrencyAmount.fromFractionalAmount(this.currency, divided.numerator, divided.denominator)
+    return CurrencyAmount.fromFractionalAmount(this.currency, divided._numerator, divided._denominator)
   }
 
   public toSignificant(
     significantDigits: number = 6,
     format?: object,
     rounding: Rounding = Rounding.ROUND_DOWN
   ): string {
-    return super.divide(this.decimalScale).toSignificant(significantDigits, format, rounding)
+    return super.divide(this._decimalScale).toSignificant(significantDigits, format, rounding)
   }
 
   public toFixed(
@@ -80,16 +83,16 @@ export class CurrencyAmount<T extends Currency> extends Fraction {
     rounding: Rounding = Rounding.ROUND_DOWN
   ): string {
     invariant(decimalPlaces <= this.currency.decimals, 'DECIMALS')
-    return super.divide(this.decimalScale).toFixed(decimalPlaces, format, rounding)
+    return super.divide(this._decimalScale).toFixed(decimalPlaces, format, rounding)
   }
 
   public toExact(format: object = { groupSeparator: '' }): string {
     Big.DP = this.currency.decimals
-    return new Big(this.quotient.toString()).div(this.decimalScale.toString()).toFormat(format)
+    return new Big(this.quotientBigInt.toString()).div(this._decimalScale.toString()).toFormat(format)
   }
 
   public get wrapped(): CurrencyAmount<Token> {
     if (this.currency.isToken) return this as CurrencyAmount<Token>
-    return CurrencyAmount.fromFractionalAmount(this.currency.wrapped, this.numerator, this.denominator)
+    return CurrencyAmount.fromFractionalAmount(this.currency.wrapped, this._numerator, this._denominator)
   }
 }