feat(swap-pathfinding): get all paths between tokens (#822)

* feat(swap-pathfinding): add all-paths and best-path endpoint

* fix(swap-pathfinding): fix test failing due to generated token IDs having greater-than-expected offset

* chore(swap-pathfinding): change graph synchronisation polling interval to 120s given infrequency of poolpair updates

* fix(swap-pathfinding): dont recompute fromToken and toToken

* chore(swap-pathfinding): rebase onto main

* chore(swap-pathfinding): update package-lock.json

package.json

@@ -51,6 +51,8 @@
     "class-transformer": "^0.5.1",
     "class-validator": "^0.13.2",
     "defichain": "^2.29.0",
+    "graphology": "^0.24.1",
+    "graphology-simple-path": "^0.1.2",
     "level": "7.0.0",
     "level-js": "6.0.0",
     "level-packager": "6.0.0",

packages/whale-api-client/src/api/poolpairs.ts

@@ -180,3 +180,45 @@ export enum PoolSwapAggregatedInterval {
   ONE_HOUR = 60 * 60,
   ONE_DAY = ONE_HOUR * 24
 }
+
+export interface BestSwapPathResult {
+  fromToken: {
+    id: string
+    symbol: string
+  }
+  toToken: {
+    id: string
+    symbol: string
+  }
+  bestPath: SwapPathPoolPair[]
+  estimatedReturn: string
+}
+
+export interface SwapPathsResult {
+  fromToken: {
+    id: string
+    symbol: string
+  }
+  toToken: {
+    id: string
+    symbol: string
+  }
+  paths: SwapPathPoolPair[][]
+}
+
+export interface SwapPathPoolPair {
+  poolPairId: string
+  symbol: string
+  tokenA: {
+    id: string
+    symbol: string
+  }
+  tokenB: {
+    id: string
+    symbol: string
+  }
+  priceRatio: {
+    ab: string
+    ba: string
+  }
+}

src/module.api/_module.ts

@@ -6,7 +6,7 @@ import { TransactionController } from '@src/module.api/transaction.controller'
 import { ApiValidationPipe } from '@src/module.api/pipes/api.validation.pipe'
 import { AddressController } from '@src/module.api/address.controller'
 import { PoolPairController } from '@src/module.api/poolpair.controller'
-import { PoolPairService } from '@src/module.api/poolpair.service'
+import { PoolPairService, PoolSwapPathFindingService } from '@src/module.api/poolpair.service'
 import { MasternodeService } from '@src/module.api/masternode.service'
 import { DeFiDCache } from '@src/module.api/cache/defid.cache'
 import { SemaphoreCache } from '@src/module.api/cache/semaphore.cache'
@@ -66,6 +66,7 @@ import { LoanVaultService } from '@src/module.api/loan.vault.service'
     DeFiDCache,
     SemaphoreCache,
     PoolPairService,
+    PoolSwapPathFindingService,
     MasternodeService,
     LoanVaultService,
     {