feat: add simulated swap data to simulations (#147)

- Add Swaps to Simulation output
- Refactor `Simulation` -> `ISimulation` to align better with rest of
the SDK
- Refactor Swap related types from `swap-common` -> `sdk-common` to
remove cyclic dependencies in simulation types

Note:
- `getSpotPrices` simplified to `getSpotPrice` in
#153

TODO:
- Write tests for simulation swaps (done in
#153)
- Update refinance strategy to handle swaps (current implementation is
based on assumptions that no longer hold following
ProtocolManager/Plugins/Pool work) (done in
#153)

sdk/order-planner-common/src/implementation/OrderPlanner.ts

@@ -1,5 +1,5 @@
 import { Order, type IPositionsManager } from '@summerfi/sdk-common/orders'
-import { Simulation, SimulationType, steps } from '@summerfi/sdk-common/simulation'
+import { ISimulation, SimulationType, steps } from '@summerfi/sdk-common/simulation'
 import { Deployment } from '@summerfi/deployment-utils'
 import { Address, Maybe } from '@summerfi/sdk-common/common'
 import { HexData } from '@summerfi/sdk-common/common/aliases'
@@ -22,7 +22,7 @@ export class OrderPlanner implements IOrderPlanner {
   async buildOrder(params: {
     user: IUser
     positionsManager: IPositionsManager
-    simulation: Simulation<SimulationType>
+    simulation: ISimulation<SimulationType>
     actionBuildersMap: ActionBuildersMap
     deployment: Deployment
     swapManager: ISwapManager
@@ -75,12 +75,12 @@ export class OrderPlanner implements IOrderPlanner {
     return actionBuildersMap[step.type] as ActionBuilder<T>
   }
 
-  private _getStrategyName(simulation: Simulation<SimulationType>): string {
+  private _getStrategyName(simulation: ISimulation<SimulationType>): string {
     return `${simulation.simulationType}${simulation.sourcePosition?.pool.protocol.name}${simulation.targetPosition?.pool.protocol.name}`
   }
 
   private _generateOrder(
-    simulation: Simulation<SimulationType>,
+    simulation: ISimulation<SimulationType>,
     simulationCalls: ActionCall[],
     positionsManager: IPositionsManager,
     deployment: Deployment,

sdk/order-planner-common/src/interfaces/IOrderPlanner.ts

@@ -1,6 +1,6 @@
 import { Deployment } from '@summerfi/deployment-utils'
 import { Order, type IPositionsManager } from '@summerfi/sdk-common/orders'
-import { Simulation, SimulationType } from '@summerfi/sdk-common/simulation'
+import { ISimulation, SimulationType } from '@summerfi/sdk-common/simulation'
 import { ISwapManager } from '@summerfi/swap-common/interfaces'
 import { Maybe } from '@summerfi/sdk-common/common'
 import { IUser } from '@summerfi/sdk-common/user'
@@ -10,7 +10,7 @@ export interface IOrderPlanner {
   buildOrder<T extends SimulationType>(params: {
     user: IUser
     positionsManager: IPositionsManager
-    simulation: Simulation<T>
+    simulation: ISimulation<T>
     actionBuildersMap: ActionBuildersMap
     deployment: Deployment
     swapManager: ISwapManager

sdk/order-planner-service/src/implementation/OrderPlannerService.ts

@@ -1,6 +1,6 @@
 import { OrderPlanner } from '@summerfi/order-planner-common/implementation'
 import { Order, type IPositionsManager } from '@summerfi/sdk-common/orders'
-import { Simulation, SimulationType } from '@summerfi/sdk-common/simulation'
+import { ISimulation, SimulationType } from '@summerfi/sdk-common/simulation'
 import { IUser } from '@summerfi/sdk-common/user'
 import { ChainInfo, Maybe } from '@summerfi/sdk-common/common'
 import { DeploymentIndex } from '@summerfi/deployment-utils'
@@ -29,7 +29,7 @@ export class OrderPlannerService implements IOrderPlannerService {
   async buildOrder(params: {
     user: IUser
     positionsManager: IPositionsManager
-    simulation: Simulation<SimulationType>
+    simulation: ISimulation<SimulationType>
     swapManager: ISwapManager
     protocolsRegistry: IProtocolPluginsRegistry
   }): Promise<Maybe<Order>> {

sdk/order-planner-service/src/interfaces/IOrderPlannerService.ts

@@ -1,5 +1,5 @@
 import { Order, type IPositionsManager } from '@summerfi/sdk-common/orders'
-import { Simulation, SimulationType } from '@summerfi/sdk-common/simulation'
+import { ISimulation, SimulationType } from '@summerfi/sdk-common/simulation'
 import { IUser } from '@summerfi/sdk-common/user'
 import { Maybe } from '@summerfi/sdk-common/common'
 import { ISwapManager } from '@summerfi/swap-common/interfaces'
@@ -9,7 +9,7 @@ export interface IOrderPlannerService {
   buildOrder<T extends SimulationType>(params: {
     user: IUser
     positionsManager: IPositionsManager
-    simulation: Simulation<T>
+    simulation: ISimulation<T>
     swapManager: ISwapManager
     protocolsRegistry: IProtocolPluginsRegistry
   }): Promise<Maybe<Order>>

sdk/order-planner-service/tests/mocks/SwapManagerMock.ts

@@ -1,10 +1,11 @@
 import { Address, ChainInfo, Percentage, Token, TokenAmount } from '@summerfi/sdk-common/common'
 import { ISwapManager } from '@summerfi/swap-common/interfaces'
-import { QuoteData, SwapData } from '@summerfi/swap-common/types'
+import { QuoteData, SwapData, SpotData } from '@summerfi/sdk-common/swap'
 
 export class SwapManagerMock implements ISwapManager {
   private _swapDataReturnValue: SwapData = {} as SwapData
   private _quoteDataReturnValue: QuoteData = {} as QuoteData
+  private _spotDataReturnValue: SpotData = {} as SpotData
 
   private _lastGetSwapDataExactInputParams:
     | {
@@ -52,6 +53,10 @@ export class SwapManagerMock implements ISwapManager {
     return this._quoteDataReturnValue
   }
 
+  async getSpotPrices(params: { chainInfo: ChainInfo; tokens: Token[] }): Promise<SpotData> {
+    return this._spotDataReturnValue
+  }
+
   get swapDataReturnValue(): SwapData {
     return this._swapDataReturnValue
   }

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

@@ -1,15 +1,14 @@
-import { FlashloanProvider, Simulation, SimulationType } from '@summerfi/sdk-common/simulation'
-import { DeploymentIndex } from '@summerfi/deployment-utils'
-import { ISwapManager } from '@summerfi/swap-common/interfaces'
-import { Address, AddressValue, ChainFamilyMap, ChainInfo } from '@summerfi/sdk-common/common'
-import { IPositionsManager } from '@summerfi/sdk-common/orders'
 import {
   FlashloanAction,
-  ReturnFundsAction,
   SetApprovalAction,
+  ReturnFundsAction,
 } from '@summerfi/protocol-plugins/plugins/common'
+import { FlashloanProvider, ISimulation, SimulationType } from '@summerfi/sdk-common/simulation'
+import { DeploymentIndex } from '@summerfi/deployment-utils'
+import { ISwapManager } from '@summerfi/swap-common/interfaces'
+import { Address, AddressValue, ChainFamilyMap, ChainInfo } from '@summerfi/sdk-common/common'
 import { ProtocolName } from '@summerfi/sdk-common/protocols'
-
+import { IPositionsManager } from '@summerfi/sdk-common/orders'
 import { SetupDeployments } from '../utils/SetupDeployments'
 import { UserMock } from '../mocks/UserMock'
 import { SwapManagerMock } from '../mocks/SwapManagerMock'
@@ -25,7 +24,6 @@ import {
 import assert from 'assert'
 import { IUser } from '@summerfi/sdk-common/user'
 import {
-  IContractProvider,
   IPriceService,
   IProtocolPluginsRegistry,
   ITokenService,
@@ -90,7 +88,7 @@ describe('Order Planner Service', () => {
     const sourcePosition = getMakerPosition()
     const targetPosition = getSparkPosition()
 
-    const refinanceSimulation: Simulation<SimulationType.Refinance> = getRefinanceSimulation({
+    const refinanceSimulation: ISimulation<SimulationType.Refinance> = getRefinanceSimulation({
       sourcePosition,
       targetPosition,
     })
@@ -114,7 +112,7 @@ describe('Order Planner Service', () => {
     const sourcePosition = getMakerPosition()
     const targetPosition = getSparkPosition()
 
-    const refinanceSimulation: Simulation<SimulationType.Refinance> = getRefinanceSimulation({
+    const refinanceSimulation: ISimulation<SimulationType.Refinance> = getRefinanceSimulation({
       sourcePosition,
       targetPosition,
     })

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

@@ -1,6 +1,6 @@
 import {
   FlashloanProvider,
-  Simulation,
+  ISimulation,
   SimulationSteps,
   SimulationType,
   TokenTransferTargetType,
@@ -11,13 +11,14 @@ import { Position } from '@summerfi/sdk-common/common'
 export function getRefinanceSimulation(params: {
   sourcePosition: Position
   targetPosition: Position
-}): Simulation<SimulationType.Refinance> {
+}): ISimulation<SimulationType.Refinance> {
   const { sourcePosition, targetPosition } = params
 
   return {
     simulationType: SimulationType.Refinance,
     sourcePosition: sourcePosition,
     targetPosition: targetPosition,
+    swaps: [],
     steps: [
       {
         name: 'Flashloan',

sdk/protocol-plugins/tests/builders/SwapActionBuilder.spec.ts

@@ -3,12 +3,13 @@ import {
   AddressValue,
   ChainFamilyMap,
   ChainInfo,
+  Price,
   Percentage,
   Token,
   TokenAmount,
 } from '@summerfi/sdk-common/common'
 import { SimulationSteps, steps } from '@summerfi/sdk-common/simulation'
-import { SwapProviderType } from '@summerfi/swap-common/enums'
+import { SwapProviderType } from '@summerfi/sdk-common/swap'
 
 import { SetupBuilderReturnType, setupBuilderParams } from '../utils/SetupBuilderParams'
 import { SwapActionBuilder } from '../../src/plugins/common/builders'
@@ -58,8 +59,17 @@ describe('Swap Action Builder', () => {
       type: SimulationSteps.Swap,
       name: 'SwapStep',
       inputs: {
+        provider: SwapProviderType.OneInch,
+        routes: [],
         fromTokenAmount: fromAmount,
         toTokenAmount: toAmount,
+        prices: [
+          Price.createFrom({
+            value: '0',
+            quoteToken: fromAmount.token,
+            baseToken: toAmount.token,
+          }),
+        ],
         fee: fee,
         slippage,
       },

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

@@ -7,7 +7,7 @@ import {
   Wallet,
 } from '@summerfi/sdk-common/common'
 import { IPositionsManager, Order } from '@summerfi/sdk-common/orders'
-import { Simulation, SimulationType } from '@summerfi/sdk-common/simulation'
+import { ISimulation, SimulationType } from '@summerfi/sdk-common/simulation'
 import { IUserClient } from '../interfaces/IUserClient'
 import { IRPCClient } from '../interfaces/IRPCClient'
 import { RPCClientType } from '../rpc/SDKClient'
@@ -49,7 +49,7 @@ export class User extends IRPCClient implements IUserClient {
 
   public async newOrder(params: {
     positionsManager: IPositionsManager
-    simulation: Simulation<SimulationType>
+    simulation: ISimulation<SimulationType>
   }): Promise<Maybe<Order>> {
     return await this.rpcClient.orders.buildOrder.mutate({
       user: {

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

@@ -1,5 +1,5 @@
 import { IRefinanceParameters } from '@summerfi/sdk-common/orders'
-import { Simulation, SimulationType } from '@summerfi/sdk-common/simulation'
+import { ISimulation, SimulationType } from '@summerfi/sdk-common/simulation'
 import { RPCClientType } from '../../rpc/SDKClient'
 import { IRPCClient } from '../../interfaces/IRPCClient'
 
@@ -10,7 +10,7 @@ export class RefinanceSimulationManager extends IRPCClient {
 
   public async simulateRefinancePosition(
     params: IRefinanceParameters,
-  ): Promise<Simulation<SimulationType.Refinance>> {
+  ): Promise<ISimulation<SimulationType.Refinance>> {
     const refinanceParameters: IRefinanceParameters = {
       position: {
         positionId: params.position.positionId,

sdk/sdk-client/src/interfaces/IUserClient.ts

@@ -1,6 +1,6 @@
 import { Maybe, Position, PositionId } from '@summerfi/sdk-common/common'
 
-import { Simulation, SimulationType } from '@summerfi/sdk-common/simulation'
+import { ISimulation, SimulationType } from '@summerfi/sdk-common/simulation'
 import { IUser } from '@summerfi/sdk-common/user'
 import { Order } from '@summerfi/sdk-common/orders'
 import { IProtocol } from '@summerfi/sdk-common/protocols'
@@ -39,5 +39,5 @@ export interface IUserClient extends IUser {
    *
    * @returns The new order created for the user
    */
-  newOrder(params: { simulation: Simulation<SimulationType> }): Promise<Maybe<Order>>
+  newOrder(params: { simulation: ISimulation<SimulationType> }): Promise<Maybe<Order>>
 }

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

@@ -2,7 +2,8 @@ import { IProtocol, PoolType, ProtocolName } from '@summerfi/sdk-common/protocol
 import { SDKManager } from '../../src/implementation/SDKManager'
 import { RPCClientType } from '../../src/rpc/SDKClient'
 import { MakerLendingPool } from '@summerfi/protocol-plugins/plugins/maker'
-import { Simulation, SimulationType } from '@summerfi/sdk-common/simulation'
+import { SparkLendingPool } from '@summerfi/protocol-plugins/plugins/spark'
+import { ISimulation, SimulationType } from '@summerfi/sdk-common/simulation'
 import {
   Address,
   ChainFamilyMap,
@@ -17,7 +18,6 @@ import {
 } from '@summerfi/sdk-common/common'
 import { IPositionsManager, Order } from '@summerfi/sdk-common/orders'
 import { User } from '../../src/implementation/User'
-import { SparkLendingPool } from '@summerfi/protocol-plugins/plugins/spark'
 
 export default async function simulateNewOrder() {
   const chainInfo: ChainInfo = ChainFamilyMap.Ethereum.Mainnet
@@ -77,9 +77,10 @@ export default async function simulateNewOrder() {
     baseCurrency: DAI,
   } as SparkLendingPool
 
-  const simulation: Simulation<SimulationType.Refinance> = {
+  const simulation: ISimulation<SimulationType.Refinance> = {
     simulationType: SimulationType.Refinance,
     sourcePosition: prevPosition,
+    swaps: [],
     targetPosition: {
       positionId: PositionId.createFrom({ id: '1234567890' }),
       debtAmount: TokenAmount.createFrom({ token: DAI, amount: '56.78' }),

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

@@ -2,7 +2,8 @@ import { IProtocol, PoolType, ProtocolName } from '@summerfi/sdk-common/protocol
 import { SDKManager } from '../../src/implementation/SDKManager'
 import { RPCClientType } from '../../src/rpc/SDKClient'
 import { MakerLendingPool } from '@summerfi/protocol-plugins/plugins/maker'
-import { Simulation, SimulationType } from '@summerfi/sdk-common/simulation'
+import { SparkLendingPool } from '@summerfi/protocol-plugins/plugins/spark'
+import { ISimulation, SimulationType } from '@summerfi/sdk-common/simulation'
 import {
   Address,
   ChainFamilyMap,
@@ -15,22 +16,22 @@ import {
   TokenAmount,
 } from '@summerfi/sdk-common/common'
 import { IRefinanceParameters } from '@summerfi/sdk-common/orders'
-import { SparkLendingPool } from '@summerfi/protocol-plugins/plugins/spark'
 
 export default async function simulateRefinanceTest() {
   type SimulateRefinanceType = RPCClientType['simulation']['refinance']['query']
   const simulateRefinance: SimulateRefinanceType = jest.fn(async (params) => {
     return {
       simulationType: SimulationType.Refinance,
       sourcePosition: params.position,
+      swaps: [],
       targetPosition: {
         positionId: PositionId.createFrom({ id: '0987654321' }),
         debtAmount: params.position.debtAmount,
         collateralAmount: params.position.collateralAmount,
         pool: params.targetPool,
       },
       steps: [],
-    } as Simulation<SimulationType.Refinance>
+    } as ISimulation<SimulationType.Refinance>
   })
 
   const rpcClient = {

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

@@ -1,5 +1,6 @@
 import { IPrice } from '../interfaces/IPrice'
 import { isToken } from '../interfaces/IToken'
+import { BigNumber } from 'bignumber.js'
 import { SerializationService } from '../../services/SerializationService'
 import { CurrencySymbol } from '../enums/CurrencySymbol'
 import { Token } from './Token'
@@ -32,6 +33,10 @@ export class Price implements IPrice {
       return `${this.value} ${this.baseToken.symbol}/${this.quoteToken}`
     }
   }
+
+  public toBN(): BigNumber {
+    return new BigNumber(this.value)
+  }
 }
 
 SerializationService.registerClass(Price)

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

@@ -1,4 +1,5 @@
 import { BigNumber } from 'bignumber.js'
+import { Percentage } from './Percentage'
 import { Token } from './Token'
 import { SerializationService } from '../../services/SerializationService'
 import { ITokenAmount } from '../interfaces/ITokenAmount'
@@ -60,14 +61,28 @@ export class TokenAmount implements ITokenAmount {
     })
   }
 
-  public multiply(multiplier: string | number): TokenAmount {
+  public multiply(multiplier: Percentage | string | number): TokenAmount {
+    if (multiplier instanceof Percentage) {
+      return new TokenAmount({
+        token: this.token,
+        amount: this.amountBN.times(multiplier.value).toString(),
+      })
+    }
+
     return new TokenAmount({
       token: this.token,
       amount: this.amountBN.times(multiplier).toString(),
     })
   }
 
-  public divide(divisor: string | number): TokenAmount {
+  public divide(divisor: Percentage | string | number): TokenAmount {
+    if (divisor instanceof Percentage) {
+      return new TokenAmount({
+        token: this.token,
+        amount: this.amountBN.div(divisor.value).toString(),
+      })
+    }
+
     return new TokenAmount({ token: this.token, amount: this.amountBN.div(divisor).toString() })
   }
 
@@ -79,6 +94,10 @@ export class TokenAmount implements ITokenAmount {
     return new BigNumber(this.amount).times(this._baseUnitFactor).toFixed(0)
   }
 
+  public toBaseUnitAsBn(): BigNumber {
+    return new BigNumber(this.amount).times(this._baseUnitFactor)
+  }
+
   public toBN(): BigNumber {
     return new BigNumber(this.amount)
   }