improve ux of constructing ticks

0xalbert · Apr 9, 2021 · fc97d1d · fc97d1d
1 parent 514a639
commit fc97d1d
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 15 deletions.
diff --git a/src/entities/pool.test.ts b/src/entities/pool.test.ts
@@ -3,7 +3,6 @@ import { FeeAmount, TICK_SPACINGS } from '../constants'
 import { nearestUsableTick } from '../utils/nearestUsableTick'
 import { TickMath } from '../utils/tickMath'
 import { Pool } from './pool'
-import { Tick } from './tick'
 import { encodeSqrtRatioX96 } from '../utils/encodeSqrtRatioX96'
 import JSBI from 'jsbi'
 import { NEGATIVE_ONE } from '../internalConstants'
@@ -180,16 +179,16 @@ describe('Pool', () => {
 
     beforeEach(() => {
       pool = new Pool(USDC, DAI, FeeAmount.LOW, encodeSqrtRatioX96(1, 1), ONE_ETHER, 0, [
-        new Tick({
+        {
           index: nearestUsableTick(TickMath.MIN_TICK, TICK_SPACINGS[FeeAmount.LOW]),
           liquidityNet: ONE_ETHER,
           liquidityGross: ONE_ETHER
-        }),
-        new Tick({
+        },
+        {
           index: nearestUsableTick(TickMath.MAX_TICK, TICK_SPACINGS[FeeAmount.LOW]),
           liquidityNet: JSBI.multiply(ONE_ETHER, NEGATIVE_ONE),
           liquidityGross: ONE_ETHER
-        })
+        }
       ])
     })
 

diff --git a/src/entities/pool.ts b/src/entities/pool.ts
@@ -7,7 +7,7 @@ import { computePoolAddress } from '../utils/computePoolAddress'
 import { LiquidityMath } from '../utils/liquidityMath'
 import { SwapMath } from '../utils/swapMath'
 import { TickMath } from '../utils/tickMath'
-import { Tick } from './tick'
+import { Tick, TickConstructorArgs } from './tick'
 import { TickList } from '../utils/tickList'
 
 interface StepComputations {
@@ -53,7 +53,7 @@ export class Pool {
     sqrtRatioX96: BigintIsh,
     liquidity: BigintIsh,
     tickCurrent: number,
-    ticks: Tick[]
+    ticks: (Tick | TickConstructorArgs)[]
   ) {
     invariant(Number.isInteger(fee) && fee < 1_000_000, 'FEE')
 
@@ -64,13 +64,15 @@ export class Pool {
         JSBI.lessThanOrEqual(JSBI.BigInt(sqrtRatioX96), nextTickSqrtRatioX96),
       'PRICE_BOUNDS'
     )
-    TickList.validate(ticks, TICK_SPACINGS[fee])
+    // always create a copy of the list since we want the pool's tick list to be immutable
+    const ticksMapped: Tick[] = ticks.map(t => (t instanceof Tick ? t : new Tick(t)))
+    TickList.validate(ticksMapped, TICK_SPACINGS[fee])
     ;[this.token0, this.token1] = tokenA.sortsBefore(tokenB) ? [tokenA, tokenB] : [tokenB, tokenA]
     this.fee = fee
     this.sqrtRatioX96 = JSBI.BigInt(sqrtRatioX96)
     this.liquidity = JSBI.BigInt(liquidity)
     this.tickCurrent = tickCurrent
-    this.ticks = ticks.slice() // create a copy since we want the pool's list to be immutable
+    this.ticks = ticksMapped
   }
 
   /**

diff --git a/src/entities/tick.ts b/src/entities/tick.ts
@@ -3,7 +3,7 @@ import invariant from 'tiny-invariant'
 import { BigintIsh } from '@uniswap/sdk-core'
 import { TickMath } from '../utils'
 
-interface TickConstructorArgs {
+export interface TickConstructorArgs {
   index: number
   liquidityGross: BigintIsh
   liquidityNet: BigintIsh

diff --git a/src/entities/trade.test.ts b/src/entities/trade.test.ts
@@ -6,7 +6,6 @@ import { nearestUsableTick } from '../utils/nearestUsableTick'
 import { TickMath } from '../utils/tickMath'
 import { Pool } from './pool'
 import { Route } from './route'
-import { Tick } from './tick'
 import { Trade } from './trade'
 
 describe('Trade', () => {
@@ -26,16 +25,16 @@ describe('Trade', () => {
       liquidity,
       TickMath.getTickAtSqrtRatio(sqrtRatioX96),
       [
-        new Tick({
+        {
           index: nearestUsableTick(TickMath.MIN_TICK, TICK_SPACINGS[feeAmount]),
           liquidityNet: liquidity,
           liquidityGross: liquidity
-        }),
-        new Tick({
+        },
+        {
           index: nearestUsableTick(TickMath.MAX_TICK, TICK_SPACINGS[feeAmount]),
           liquidityNet: JSBI.multiply(liquidity, JSBI.BigInt(-1)),
           liquidityGross: liquidity
-        })
+        }
       ]
     )
   }