TeddySwap Integration

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 All notable changes to Dexter will be documented in this file.
 
+## [UNRELEASED]
+- TeddySwap integration
+
 ## [v4.2.0]
 - Fix WR price impact formula for 0 decimals
 - Rename Asset identifier function

README.md

@@ -6,6 +6,7 @@
     <img src="https://raw.githubusercontent.com/IndigoProtocol/dexter/master/src/dex/logo/muesliswap.png" width="30" />
     <img src="https://raw.githubusercontent.com/IndigoProtocol/dexter/master/src/dex/logo/wingriders.png" width="30" />
     <img src="https://raw.githubusercontent.com/IndigoProtocol/dexter/master/src/dex/logo/vyfinance.png" width="30" />
+    <img src="https://raw.githubusercontent.com/IndigoProtocol/dexter/master/src/dex/logo/teddyswap.png" width="30" />
 </div>
 
 ### What You Can Do

package.json

@@ -27,13 +27,15 @@
     "axios-retry": "^3.5.1",
     "bottleneck": "^2.19.5",
     "crypto-js": "^4.1.1",
+    "lodash": "^4.17.21",
     "lucid-cardano": "^0.8.7"
   },
   "devDependencies": {
     "@babel/core": "^7.21.4",
     "@babel/preset-env": "^7.21.4",
     "@babel/preset-typescript": "^7.21.4",
     "@types/jest": "^29.5.0",
+    "@types/lodash": "^4.14.202",
     "babel-jest": "^29.5.0",
     "jest": "^29.5.0",
     "prettier": "^2.8.8",

src/constants.ts

@@ -40,6 +40,8 @@ export enum DatumParameterKey {
      */
     PoolIdentifier = 'PoolIdentifier',
     TotalLpTokens = 'TotalLpTokens',
+    LpTokenPolicyId = 'LpTokenPolicyId',
+    LpTokenAssetName = 'LpTokenAssetName',
     LpFee = 'LpFee',
     LpFeeNumerator = 'LpFeeNumerator',
     LpFeeDenominator = 'LpFeeDenominator',
@@ -54,6 +56,8 @@ export enum DatumParameterKey {
     RootKLast = 'RootKLast',
     LastInteraction = 'LastInteraction',
     RequestScriptHash = 'RequestScriptHash',
+    StakeAdminPolicy = 'StakeAdminPolicy',
+    LqBound = 'LqBound',
 }
 
 export enum TransactionStatus {
@@ -68,4 +72,4 @@ export enum AddressType {
     Contract,
     Base,
     Enterprise,
-}
+}

src/definition-builder.ts

@@ -1,6 +1,7 @@
 import { DatumParameters, DefinitionConstr, DefinitionField } from './types';
 import { datumJsonToCbor } from 'lucid-cardano';
 import { DatumParameterKey } from './constants';
+import _ from 'lodash';
 
 export class DefinitionBuilder {
 
@@ -10,7 +11,11 @@ export class DefinitionBuilder {
      * Load a DEX definition file as a template for this builder.
      */
     public async loadDefinition(definition: DefinitionConstr): Promise<DefinitionBuilder> {
-        this._definition = structuredClone(definition);
+        this._definition = _.cloneDeepWith(definition, (value: any) => {
+            if (value instanceof Function) {
+                return value;
+            }
+        })
 
         return this;
     }
@@ -54,6 +59,10 @@ export class DefinitionBuilder {
      * Recursively set specified parameters.
      */
     private applyParameters(field: DefinitionField, mappedParameters: DatumParameters): DefinitionConstr {
+        if (field instanceof Function) {
+            return field(field, mappedParameters, false);
+        }
+
         if ('fields' in field) {
             if (typeof field.constructor === 'string') {
                 const parameterValue: any = mappedParameters[field.constructor as keyof typeof DatumParameterKey];
@@ -100,6 +109,20 @@ export class DefinitionBuilder {
      * Recursively pull parameters from datum using definition template.
      */
     private extractParameters(definedDefinition: DefinitionField, templateDefinition: DefinitionField, foundParameters: DatumParameters = {}): DatumParameters {
+        if (templateDefinition instanceof Function) {
+            templateDefinition(definedDefinition, foundParameters);
+
+            return foundParameters;
+        }
+
+        if (templateDefinition instanceof Array) {
+            templateDefinition.map((fieldParameter: DefinitionField, index: number) => {
+                return this.extractParameters(fieldParameter, templateDefinition[index], foundParameters);
+            }).forEach((parameters: DatumParameters) => {
+                foundParameters = {...foundParameters, ...parameters};
+            })
+        }
+
         if ('fields' in definedDefinition) {
             if (! ('fields' in templateDefinition)) {
                 throw new Error("Template definition does not match with 'fields'");

src/dex/api/teddyswap-api.ts

@@ -0,0 +1,61 @@
+import { BaseApi } from './base-api';
+import { Asset, Token } from '../models/asset';
+import { LiquidityPool } from '../models/liquidity-pool';
+import axios, { AxiosInstance } from 'axios';
+import { RequestConfig } from '@app/types';
+import { appendSlash, tokensMatch } from '@app/utils';
+import { TeddySwap } from '@dex/teddyswap';
+
+export class TeddyswapApi extends BaseApi {
+
+    protected readonly api: AxiosInstance;
+    protected readonly dex: TeddySwap;
+
+    constructor(dex: TeddySwap, requestConfig: RequestConfig) {
+        super();
+
+        this.dex = dex;
+        this.api = axios.create({
+            timeout: requestConfig.timeout,
+            baseURL: `${appendSlash(requestConfig.proxyUrl)}https://analytics.teddyswap.org/v1`,
+            headers: {
+                'Content-Type': 'application/json',
+            }
+        });
+    }
+
+    liquidityPools(assetA: Token, assetB?: Token): Promise<LiquidityPool[]> {
+        return this.api.get('/front/pools', ).then((response: any) => {
+            return response.data.map((poolResponse: any) => {
+                const tokenA: Token = poolResponse.lockedX.asset.currencySymbol !== ''
+                    ? new Asset(poolResponse.lockedX.asset.currencySymbol, Buffer.from(poolResponse.lockedX.asset.tokenName, 'utf8').toString('hex'))
+                    : 'lovelace';
+                const tokenB: Token = poolResponse.lockedY.asset.currencySymbol !== ''
+                    ? new Asset(poolResponse.lockedY.asset.currencySymbol, Buffer.from(poolResponse.lockedY.asset.tokenName, 'utf8').toString('hex'))
+                    : 'lovelace';
+
+                if (! tokensMatch(tokenA, assetA) || (assetB && ! tokensMatch(tokenB, assetB))) {
+                    return undefined;
+                }
+
+                let liquidityPool: LiquidityPool = new LiquidityPool(
+                    TeddySwap.identifier,
+                    tokenA,
+                    tokenB,
+                    BigInt(poolResponse.lockedX.amount),
+                    BigInt(poolResponse.lockedY.amount),
+                    '', // Not supplied
+                    this.dex.orderAddress,
+                    this.dex.orderAddress,
+                );
+
+                liquidityPool.lpToken = new Asset(poolResponse.lockedLQ.asset.currencySymbol, Buffer.from(poolResponse.lockedLQ.asset.tokenName, 'utf8').toString('hex'));
+                liquidityPool.poolFeePercent = (1 - (poolResponse.poolFeeNum / poolResponse.poolFeeDenum)) * 10;
+                liquidityPool.identifier = liquidityPool.lpToken.identifier();
+
+                return liquidityPool;
+            }).filter((pool: LiquidityPool | undefined) => pool !== undefined) as LiquidityPool[];
+        });
+    }
+
+}

src/dex/definitions/teddyswap/order.ts

@@ -0,0 +1,85 @@
+import { DatumParameterKey } from '@app/constants';
+import { DatumParameters, DefinitionField } from '@app/types';
+
+export default {
+  constructor: 0,
+  fields: [
+    {
+      constructor: 0,
+      fields: [
+        {
+          bytes: DatumParameterKey.SwapInTokenPolicyId
+        },
+        {
+          bytes: DatumParameterKey.SwapInTokenAssetName
+        }
+      ],
+    },
+    {
+      constructor: 0,
+      fields: [
+        {
+          bytes: DatumParameterKey.SwapOutTokenPolicyId
+        },
+        {
+          bytes: DatumParameterKey.SwapOutTokenAssetName
+        }
+      ],
+    },
+    {
+      constructor: 0,
+      fields: [
+        {
+          bytes: DatumParameterKey.TokenPolicyId // Pool NFT
+        },
+        {
+          bytes: DatumParameterKey.TokenAssetName
+        }
+      ],
+    },
+    {
+      int: DatumParameterKey.LpFee
+    },
+    {
+      int: DatumParameterKey.LpFeeNumerator // Execution fee numerator
+    },
+    {
+      int: DatumParameterKey.LpFeeDenominator // Execution fee denominator
+    },
+    {
+      bytes: DatumParameterKey.SenderPubKeyHash
+    },
+    (field: DefinitionField, parameters: DatumParameters, shouldExtract: boolean = true) => {
+      if (! shouldExtract) {
+        const stakeKeyHash: string = parameters[DatumParameterKey.SenderStakingKeyHash] as string ?? null;
+
+        if (! stakeKeyHash) return;
+
+        return {
+          constructor: 0,
+          fields: [
+            {
+              bytes: stakeKeyHash,
+            }
+          ],
+        };
+      }
+
+      if ('fields' in field) {
+        if (field.constructor === 1) return;
+
+        if (field.fields.length > 0 && 'bytes' in field.fields[0]) {
+          parameters[DatumParameterKey.SenderStakingKeyHash] = field.fields[0].bytes;
+        }
+      }
+
+      return;
+    },
+    {
+      int: DatumParameterKey.SwapInAmount
+    },
+    {
+      int: DatumParameterKey.MinReceive
+    }
+  ],
+}

src/dex/definitions/teddyswap/pool.ts

@@ -0,0 +1,62 @@
+import { DatumParameterKey } from '@app/constants';
+
+export default {
+  constructor: 0,
+  fields: [
+    {
+      constructor: 0,
+      fields: [
+        {
+          bytes: DatumParameterKey.TokenPolicyId // Pool NFT
+        },
+        {
+          bytes: DatumParameterKey.TokenAssetName
+        }
+      ]
+    },
+    {
+      constructor: 0,
+      fields: [
+        {
+          bytes: DatumParameterKey.PoolAssetAPolicyId
+        },
+        {
+          bytes: DatumParameterKey.PoolAssetAAssetName
+        }
+      ]
+    },
+    {
+      constructor: 0,
+      fields: [
+        {
+          bytes: DatumParameterKey.PoolAssetBPolicyId
+        },
+        {
+          bytes: DatumParameterKey.PoolAssetBAssetName
+        }
+      ]
+    },
+    {
+      constructor: 0,
+      fields: [
+        {
+          bytes: DatumParameterKey.LpTokenPolicyId
+        },
+        {
+          bytes: DatumParameterKey.LpTokenAssetName
+        }
+      ]
+    },
+    {
+      int: DatumParameterKey.LpFee
+    },
+    [
+      {
+        bytes: DatumParameterKey.StakeAdminPolicy
+      }
+    ],
+    {
+      int: DatumParameterKey.LqBound
+    }
+  ]
+}

src/dex/minswap.ts

@@ -210,6 +210,7 @@ export class Minswap extends BaseDex {
                         },
                     ],
                     datum: datumBuilder.getCbor(),
+                    isInlineDatum: false,
                     spendUtxos: spendUtxos,
                 }
             )
@@ -230,6 +231,7 @@ export class Minswap extends BaseDex {
                 address: returnAddress,
                 addressType: AddressType.Base,
                 assetBalances: relevantUtxo.assetBalances,
+                isInlineDatum: false,
                 spendUtxos: [relevantUtxo],
             }
         ];

src/dex/muesliswap.ts

@@ -202,6 +202,7 @@ export class MuesliSwap extends BaseDex {
                         },
                     ],
                     datum: datumBuilder.getCbor(),
+                    isInlineDatum: false,
                     spendUtxos: spendUtxos,
                 }
             )
@@ -222,6 +223,7 @@ export class MuesliSwap extends BaseDex {
                 address: returnAddress,
                 addressType: AddressType.Base,
                 assetBalances: relevantUtxo.assetBalances,
+                isInlineDatum: false,
                 spendUtxos: [relevantUtxo],
             }
         ];