feat: refactor refinance data types (#250)

sdk/order-planner-service/tests/service/OrderPlannerService.spec.ts

@@ -92,7 +92,7 @@ describe('Order Planner Service', () => {
 
     const refinanceSimulation: ISimulation<SimulationType.Refinance> = getRefinanceSimulation({
       sourcePosition,
-      targetPosition,
+      targetPool: targetPosition,
     })
 
     const order = await orderPlannerService.buildOrder({

sdk/order-planner-service/tests/utils/RefinanceSimulation/RefinanceSimulation.ts

@@ -10,9 +10,9 @@ import { Position } from '@summerfi/sdk-common/common'
 
 export function getRefinanceSimulation(params: {
   sourcePosition: Position
-  targetPosition: Position
+  targetPool: Position
 }): ISimulation<SimulationType.Refinance> {
-  const { sourcePosition, targetPosition } = params
+  const { sourcePosition, targetPool: targetPosition } = params
 
   return {
     simulationType: SimulationType.Refinance,

sdk/protocol-manager-common/src/interfaces/IProtocolManager.ts

@@ -1,4 +1,4 @@
-import { Maybe } from '@summerfi/sdk-common'
+import { ILendingPoolId, IPositionId, Maybe } from '@summerfi/sdk-common'
 import { IPosition } from '@summerfi/sdk-common/common'
 import { IExternalPosition, IPositionsManager, TransactionInfo } from '@summerfi/sdk-common/orders'
 import { ILendingPool, ILendingPoolInfo } from '@summerfi/sdk-common/protocols'
@@ -17,15 +17,15 @@ export interface IProtocolManager {
    * @param poolId The pool ID
    * @returns The lending pool for the specific protocol
    */
-  getLendingPool(poolId: unknown): Promise<ILendingPool>
+  getLendingPool(poolId: ILendingPoolId): Promise<ILendingPool>
 
   /**
    * @name getLendingPoolInfo
    * @description Gets the extended lending pool information for the given pool ID
    * @param poolId The pool ID
    * @returns The extended lending pool information for the specific protocol
    */
-  getLendingPoolInfo(poolId: unknown): Promise<ILendingPoolInfo>
+  getLendingPoolInfo(poolId: ILendingPoolId): Promise<ILendingPoolInfo>
 
   /** POSITIONS */
 
@@ -35,7 +35,7 @@ export interface IProtocolManager {
    * @param positionId The position ID for the specific protocol
    * @returns The position for the specific protocol
    */
-  getPosition(positionId: unknown): Promise<IPosition>
+  getPosition(positionId: IPositionId): Promise<IPosition>
 
   /** IMPORT POSITION */
 

sdk/protocol-manager-service/src/implementation/ProtocolManager.ts

@@ -38,7 +38,7 @@ export class ProtocolManager implements IProtocolManager {
   }
 
   /** @see IProtocolManager.getLendingPool */
-  async getLendingPool(poolId: unknown): Promise<ILendingPool> {
+  async getLendingPool(poolId: ILendingPoolId): Promise<ILendingPool> {
     this._validateLendingPoolId(poolId)
 
     const plugin = this._pluginsRegistry.getPlugin({ protocolName: poolId.protocol.name })
@@ -49,7 +49,7 @@ export class ProtocolManager implements IProtocolManager {
   }
 
   /** @see IProtocolManager.getLendingPoolInfo */
-  async getLendingPoolInfo(poolId: unknown): Promise<ILendingPoolInfo> {
+  async getLendingPoolInfo(poolId: ILendingPoolId): Promise<ILendingPoolInfo> {
     this._validateLendingPoolId(poolId)
 
     const plugin = this._pluginsRegistry.getPlugin({ protocolName: poolId.protocol.name })
@@ -60,7 +60,7 @@ export class ProtocolManager implements IProtocolManager {
   }
 
   /** @see IProtocolManager.getPosition */
-  async getPosition(positionId: unknown): Promise<IPosition> {
+  async getPosition(positionId: IPositionId): Promise<IPosition> {
     this._validatePositionId(positionId)
 
     throw new Error('Not implemented')

sdk/sdk-client/src/implementation/ProtocolClient.ts

@@ -19,15 +19,11 @@ export class ProtocolClient extends Protocol implements IProtocolClient {
   }
 
   getLendingPool(params: { poolId: ILendingPoolIdData }): Promise<Maybe<ILendingPool>> {
-    return this._rpcClient.protocols.getLendingPool.query({
-      poolId: params.poolId,
-    })
+    return this._rpcClient.protocols.getLendingPool.query(params.poolId)
   }
 
   getLendingPoolInfo(params: { poolId: ILendingPoolIdData }): Promise<Maybe<ILendingPoolInfo>> {
-    return this._rpcClient.protocols.getLendingPoolInfo.query({
-      poolId: params.poolId,
-    })
+    return this._rpcClient.protocols.getLendingPoolInfo.query(params.poolId)
   }
 
   /**

sdk/sdk-client/src/implementation/simulations/RefinanceSimulationManager.ts

@@ -9,8 +9,8 @@ export class RefinanceSimulationManager extends IRPCClient {
   }
 
   public async simulateRefinancePosition(
-    params: IRefinanceParameters,
+    refinanceParameters: IRefinanceParameters,
   ): Promise<ISimulation<RefinanceSimulationTypes>> {
-    return this.rpcClient.simulation.refinance.query(params)
+    return this.rpcClient.simulation.refinance.query(refinanceParameters)
   }
 }

sdk/sdk-client/tests/queries/getLendingPool.subtest.ts

@@ -11,21 +11,20 @@ import { AddressType } from '@summerfi/sdk-common'
 export default async function getLendingPoolTest() {
   type GetLendingPoolType = RPCClientType['protocols']['getLendingPool']['query']
 
-  const getLendingPoolQuery: GetLendingPoolType = jest.fn(async (params) => {
-    expect(params).toBeDefined()
-    expect(params.poolId).toBeDefined()
+  const getLendingPoolQuery: GetLendingPoolType = jest.fn(async (poolId) => {
+    expect(poolId).toBeDefined()
 
-    if (!isMakerLendingPoolId(params.poolId)) {
+    if (!isMakerLendingPoolId(poolId)) {
       fail('PoolId is not MakerPoolId')
     }
 
-    expect(params.poolId.protocol).toBeDefined()
-    expect(params.poolId.protocol.name).toBe(ProtocolName.Maker)
-    expect(params.poolId.ilkType).toBe(ILKType.ETH_A)
+    expect(poolId.protocol).toBeDefined()
+    expect(poolId.protocol.name).toBe(ProtocolName.Maker)
+    expect(poolId.ilkType).toBe(ILKType.ETH_A)
 
     return {
       type: PoolType.Lending,
-      id: params.poolId,
+      id: poolId,
     } as unknown as MakerLendingPool
   })
 

sdk/sdk-client/tests/queries/getLendingPoolInfo.subtest.ts

@@ -11,21 +11,20 @@ import { AddressType } from '@summerfi/sdk-common'
 export default async function getLendingPoolInfoTest() {
   type GetLendingPoolInfoType = RPCClientType['protocols']['getLendingPoolInfo']['query']
 
-  const getLendingPoolInfoQuery: GetLendingPoolInfoType = jest.fn(async (params) => {
-    expect(params).toBeDefined()
-    expect(params.poolId).toBeDefined()
+  const getLendingPoolInfoQuery: GetLendingPoolInfoType = jest.fn(async (poolId) => {
+    expect(poolId).toBeDefined()
 
-    if (!isMakerLendingPoolId(params.poolId)) {
+    if (!isMakerLendingPoolId(poolId)) {
       fail('PoolId is not MakerPoolId')
     }
 
-    expect(params.poolId.protocol).toBeDefined()
-    expect(params.poolId.protocol.name).toBe(ProtocolName.Maker)
-    expect(params.poolId.ilkType).toBe(ILKType.ETH_A)
+    expect(poolId.protocol).toBeDefined()
+    expect(poolId.protocol.name).toBe(ProtocolName.Maker)
+    expect(poolId.ilkType).toBe(ILKType.ETH_A)
 
     return {
       type: PoolType.Lending,
-      id: params.poolId,
+      id: poolId,
     } as unknown as MakerLendingPoolInfo
   })
 

sdk/sdk-client/tests/queries/simulateRefinance.subtest.ts

@@ -3,25 +3,23 @@ import { SDKManager } from '../../src/implementation/SDKManager'
 import { RPCClientType, SparkPositionId } from '../../src/rpc/SDKClient'
 import {
   ILKType,
-  IMakerLendingPoolData,
+  MakerLendingPool,
+  MakerLendingPoolId,
+  MakerPosition,
   MakerPositionId,
+  MakerProtocol,
 } from '@summerfi/protocol-plugins/plugins/maker'
 import { ISimulation, SimulationType } from '@summerfi/sdk-common/simulation'
 import {
   Address,
-  AddressType,
   ChainFamilyMap,
   ChainInfo,
   Percentage,
-  Position,
   PositionType,
   Token,
   TokenAmount,
 } from '@summerfi/sdk-common/common'
-import { IRefinanceParameters } from '@summerfi/sdk-common/orders'
-import { IMakerProtocolData } from '@summerfi/protocol-plugins/plugins/maker/interfaces/IMakerProtocol'
-import { IMakerLendingPoolIdData } from '@summerfi/protocol-plugins/plugins/maker/interfaces/IMakerLendingPoolId'
-import { IPositionData } from '@summerfi/sdk-common'
+import { RefinanceParameters } from '@summerfi/sdk-common'
 
 export default async function simulateRefinanceTest() {
   type SimulateRefinanceType = RPCClientType['simulation']['refinance']['query']
@@ -32,9 +30,15 @@ export default async function simulateRefinanceTest() {
       targetPosition: {
         type: params.sourcePosition.type,
         id: SparkPositionId.createFrom({ id: '0987654321' }),
-        debtAmount: params.targetPosition.debtAmount,
-        collateralAmount: params.targetPosition.collateralAmount,
-        pool: params.targetPosition.pool,
+        debtAmount: TokenAmount.createFrom({
+          amount: params.sourcePosition.debtAmount.amount,
+          token: params.targetPool.debtToken,
+        }),
+        collateralAmount: TokenAmount.createFrom({
+          amount: params.sourcePosition.collateralAmount.amount,
+          token: params.targetPool.collateralToken,
+        }),
+        pool: params.targetPool,
       },
       swaps: [],
       steps: [],
@@ -72,72 +76,53 @@ export default async function simulateRefinanceTest() {
     decimals: 18,
   })
 
-  const protocol: IMakerProtocolData = {
+  const USDC = Token.createFrom({
+    chainInfo,
+    address: Address.createFromEthereum({ value: '0x6b175474e89094c44da98b954eedeac495271d0f' }),
+    symbol: 'USDC',
+    name: 'USD Coin',
+    decimals: 6,
+  })
+
+  const protocol = MakerProtocol.createFrom({
     name: ProtocolName.Maker,
     chainInfo: chainInfo,
-  }
+  })
 
-  const poolId: IMakerLendingPoolIdData = {
+  const poolId = MakerLendingPoolId.createFrom({
     protocol: protocol,
     ilkType: ILKType.ETH_A,
-    collateralToken: {
-      address: {
-        type: AddressType.Ethereum,
-        value: '0x6b175474e89094c44da98b954eedeac495271d0f',
-      },
-      chainInfo: { chainId: 1, name: 'Ethereum' },
-      name: 'USD Coin',
-      symbol: 'USDC',
-      decimals: 6,
-    },
-    debtToken: {
-      address: {
-        type: AddressType.Ethereum,
-        value: '0x6b175474e89094c44da98b954eedeac495271d0f',
-      },
-      chainInfo: { chainId: 1, name: 'Ethereum' },
-      name: 'USD Coin',
-      symbol: 'USDC',
-      decimals: 6,
-    },
-  }
+    collateralToken: USDC,
+    debtToken: USDC,
+  })
 
-  const pool: IMakerLendingPoolData = {
+  const pool = MakerLendingPool.createFrom({
     type: PoolType.Lending,
     id: poolId,
     collateralToken: poolId.collateralToken,
     debtToken: poolId.debtToken,
-  }
+  })
 
-  const prevPosition: IPositionData = {
+  const prevPosition = MakerPosition.createFrom({
     type: PositionType.Multiply,
     pool: pool,
     debtAmount: TokenAmount.createFrom({ token: DAI, amount: '56.78' }),
     collateralAmount: TokenAmount.createFrom({ token: WETH, amount: '105.98' }),
     id: MakerPositionId.createFrom({ id: '1234567890', vaultId: '34' }),
-  }
+  })
 
-  const targetPool: IMakerLendingPoolData = {
+  const targetPool = MakerLendingPool.createFrom({
     type: PoolType.Lending as const,
     id: poolId,
     collateralToken: poolId.collateralToken,
     debtToken: poolId.debtToken,
-  }
+  })
 
-  const targetPosition = {
-    type: PositionType.Multiply,
-    id: {
-      id: 'newEmptyPositionFromPool',
-    },
-    debtAmount: prevPosition.debtAmount,
-    collateralAmount: prevPosition.collateralAmount,
-    pool: targetPool,
-  } as unknown as Position
-  const refinanceParameters: IRefinanceParameters = {
+  const refinanceParameters = RefinanceParameters.createFrom({
     sourcePosition: prevPosition,
-    targetPosition: targetPosition,
+    targetPool: targetPool,
     slippage: Percentage.createFrom({ value: 0.5 }),
-  }
+  })
 
   const simulation =
     await sdkManager.simulator.refinance.simulateRefinancePosition(refinanceParameters)
@@ -148,6 +133,6 @@ export default async function simulateRefinanceTest() {
   expect(simulation.sourcePosition?.id).toBe(prevPosition.id)
   expect(simulation.targetPosition).toBeDefined()
   expect(simulation.targetPosition.id).toBeDefined()
-  expect(simulation.targetPosition.pool.id).toBe(targetPool.id)
+  expect(simulation.targetPosition.pool.id).toEqual(targetPool.id)
   expect(simulation.steps).toBeDefined()
 }

sdk/sdk-common/src/common/implementation/ChainInfo.ts

@@ -4,7 +4,7 @@ import { ChainId } from '../aliases/ChainId'
 
 /**
  * @name ChainInfo
- * @see IChainInfoData
+ * @see IChainInfo
  */
 export class ChainInfo implements IChainInfo {
   readonly chainId: ChainId

sdk/sdk-common/src/orders/implementation/RefinanceParameters.ts

@@ -0,0 +1,33 @@
+import { SerializationService } from '../../services/SerializationService'
+import { IRefinanceParameters } from '../interfaces'
+import { IPosition } from '../../common/interfaces/IPosition'
+import { IPercentage } from '../../common/interfaces/IPercentage'
+import { ILendingPool } from '../../protocols'
+
+/**
+ * @name RefinanceParameters
+ * @see IRefinanceParameters
+ */
+export class RefinanceParameters implements IRefinanceParameters {
+  readonly sourcePosition: IPosition
+  readonly targetPool: ILendingPool
+  readonly slippage: IPercentage
+
+  /** Factory method */
+  static createFrom(params: IRefinanceParameters): RefinanceParameters {
+    return new RefinanceParameters(params)
+  }
+
+  /** Sealed constructor */
+  private constructor(params: IRefinanceParameters) {
+    this.sourcePosition = params.sourcePosition
+    this.targetPool = params.targetPool
+    this.slippage = params.slippage
+  }
+
+  toString(): string {
+    return `Refinance Parameters (source: ${this.sourcePosition}, target: ${this.targetPool}, slippage: ${this.slippage})`
+  }
+}
+
+SerializationService.registerClass(RefinanceParameters)

sdk/sdk-common/src/orders/implementation/index.ts

@@ -1 +1,2 @@
 export * from './PositionsManager'
+export * from './RefinanceParameters'