Merge pull request #223 from OjusWiZard/fix/plenty

Fix/Plenty: Maintenance of Tezos and Plenty connectors

src/chains/tezos/tezos.base.ts

@@ -54,6 +54,7 @@ export class TezosBase {
 
   private tzktURL: string;
   private _tzktApiClient: TzktApiClient;
+  public ctezAdminAddress: string;
 
   constructor(network: string) {
     const config = getTezosConfig('tezos', network);
@@ -62,6 +63,7 @@ export class TezosBase {
     this.tzktURL = config.network.tzktURL;
     this.tokenListType = config.network.tokenListType;
     this.tokenListSource = config.network.tokenListSource;
+    this.ctezAdminAddress = config.network.ctezAdminAddress;
     this._provider = new TezosToolkit(this.rpcUrl);
     this._rpcClient = new RpcClient(this.rpcUrl);
     this._tzktApiClient = new TzktApiClient(this.tzktURL);
@@ -117,10 +119,10 @@ export class TezosBase {
     return this._contractMap[address];
   }
 
-  // returns the contract storage for a given address (cached for 15 seconds)
+  // returns the contract storage for a given address (cached for 12 seconds)
   async getContractStorage(address: string) {
     const timestamp = Date.now();
-    if (!this._contractStorageMap[address] || timestamp - this._contractStorageMap[address].timestamp > 15000) {
+    if (!this._contractStorageMap[address] || timestamp - this._contractStorageMap[address].timestamp > 12000) {
       const contract = await this.getContract(address);
       this._contractStorageMap[address] = {
         storage: await contract.storage(),

src/chains/tezos/tezos.config.ts

@@ -9,6 +9,7 @@ export interface NetworkConfig {
   tokenListType: TokenListType;
   tokenListSource: string;
   tzktURL: string;
+  ctezAdminAddress: string;
 }
 
 export interface Config {
@@ -41,6 +42,9 @@ export function getTezosConfig(chainName: string, networkName: string): Config {
       tzktURL: ConfigManagerV2.getInstance().get(
         chainName + '.networks.' + network + '.tzktURL'
       ),
+      ctezAdminAddress: ConfigManagerV2.getInstance().get(
+        chainName + '.networks.' + network + '.ctezAdmin'
+      )
     },
     nativeCurrencySymbol: ConfigManagerV2.getInstance().get(
       chainName + '.networks.' + network + '.nativeCurrencySymbol'

src/connectors/plenty/plenty.config.ts

@@ -8,7 +8,6 @@ export namespace PlentyConfig {
     poolsApi: (network: string) => string;
     analyticsApi: (network: string) => string;
     routerAddress: (network: string) => string;
-    ctezAdminAddress: (network: string) => string;
     tradingTypes: Array<string>;
     availableNetworks: Array<AvailableNetworks>;
     chainType: string;
@@ -33,10 +32,6 @@ export namespace PlentyConfig {
       ConfigManagerV2.getInstance().get(
         'plenty.contractAddresses.' + network + '.router'
       ),
-    ctezAdminAddress: (network: string) =>
-      ConfigManagerV2.getInstance().get(
-        'plenty.contractAddresses.' + network + '.ctezAdmin'
-      ),
     tradingTypes: ['AMM'],
     chainType: 'TEZOS',
     availableNetworks: [

src/connectors/plenty/plenty.ts

@@ -19,16 +19,14 @@ export class Plenty {
   private _tokenList: Record<string, IConfigToken> = {};
   private _pools: Record<string, IConfigPool> = {};
   private _ready: boolean = false;
-  private _skipTokens: string[] = ['SEB', 'PEPE'];
-  public ctezAdminAddress: string;
+  private _skipTokens: string[] = ['SEB', 'PEPE', 'TKEY-X'];
   public isPlenty = true;
 
   constructor(network: string) {
     const config = PlentyConfig.config;
     this._router = config.routerAddress(network);
     this._poolsApi = config.poolsApi(network);
     this._analyticsApi = config.analyticsApi(network);
-    this.ctezAdminAddress = config.ctezAdminAddress(network);
     this._gasLimitEstimate = config.gasLimitEstimate;
   }
 
@@ -50,7 +48,7 @@ export class Plenty {
    * @param address Token address
    */
   public getTokenBySymbol(symbol: string): IConfigToken {
-    return this._tokenList[symbol];
+    return this._tokenList[symbol.toLocaleUpperCase()];
   }
 
   public async init() {
@@ -63,7 +61,7 @@ export class Plenty {
         pool.token2.symbol = pool.token2.symbol.toUpperCase();
         pool.token1.pairs = pool.token1.pairs.map((pair) => pair.toUpperCase());
         pool.token2.pairs = pool.token2.pairs.map((pair) => pair.toUpperCase());
-        if (pool.token1.symbol in this._skipTokens || pool.token2.symbol in this._skipTokens)
+        if (this._skipTokens.includes(pool.token1.symbol) || this._skipTokens.includes(pool.token2.symbol))
           continue;
 
         let tokensKey = pool.token1.symbol + '-' + pool.token2.symbol;
@@ -105,10 +103,6 @@ export class Plenty {
     return await apiResponse.json();
   }
 
-  public async ctezContract(tezos: Tezosish): Promise<any> {
-    return await tezos.getContract(this.ctezAdminAddress);
-  }
-
   public get tokenList(): Record<string, IConfigToken> {
     return this._tokenList;
   }
@@ -245,7 +239,7 @@ export class Plenty {
     return {
       expectedAmount: path.tokenOutAmount,
       trade: {
-        executionPrice: path.exchangeRate,
+        executionPrice: BigNumber(1).dividedBy(path.exchangeRate),
         routeParams: path,
         amountIn: path.tokenOutAmount.multipliedBy(10 ** quoteToken.decimals),
       }

src/connectors/plenty/utils/wrappers.ts

@@ -410,7 +410,7 @@ export const loadSwapDataWrapper = async (
         (tokenIn === "XTZ" && tokenOut === "CTEZ") ||
         (tokenIn === "CTEZ" && tokenOut === "XTZ")
       ) {
-        const ctezAdmin = await tezos.getContractStorage(plenty.ctezAdminAddress);
+        const ctezAdmin = await tezos.getContractStorage(tezos.ctezAdminAddress);
         swapData = loadSwapDataTezCtez(dex, poolAnalytics, tokenIn, tokenOut);
         swapData.target = ctezAdmin.target;
       } else {

src/services/schema/plenty-schema.json

@@ -22,15 +22,11 @@
                         },
                         "router": {
                             "type": "string"
-                        },
-                        "ctezAdmin": {
-                            "type": "string"
                         }
                     },
                     "required": [
                         "poolsApi",
-                        "router",
-                        "ctezAdmin"
+                        "router"
                     ],
                     "additionalProperties": false
                 }

src/services/schema/tezos-schema.json

@@ -28,6 +28,9 @@
             },
             "tzktURL": {
               "type": "string"
+            },
+            "ctezAdmin": {
+              "type": "string"
             }
           },
           "required": [
@@ -36,7 +39,8 @@
             "nodeURL",
             "tokenListType",
             "tokenListSource",
-            "tzktURL"
+            "tzktURL",
+            "ctezAdmin"
           ],
           "additionalProperties": false
         }

src/templates/lists/tezos.mainnet.tokens.json

@@ -511,6 +511,14 @@
       "decimals": 12,
       "standard": "FA2",
       "tokenId": 0
+    },
+    {
+      "name": "Tezos Domains Governance Token",
+      "symbol": "TED",
+      "decimals": 6,
+      "standard": "FA2",
+      "address": "KT1GY5qCWwmESfTv9dgjYyTYs2T5XGDSvRp1",
+      "tokenId": 0
     }
   ]
 }

src/templates/plenty.yml

@@ -10,6 +10,5 @@ gasLimitEstimate: 15000
 contractAddresses:
   mainnet:
     poolsApi: 'https://config.mainnet.plenty.network/pools'
-    analyticsApi: 'https://api.analytics.plenty.network/analytics/pools'
+    analyticsApi: 'https://api.plenty.network/analytics/pools'
     router: 'KT1WPctQmrbGDf5Md2xmFGQGUSvQgao18vK4'
-    ctezAdmin: 'KT1GWnsoFZVHGh7roXEER3qeCcgJgrXT3de2'

src/templates/tezos.yml

@@ -5,10 +5,11 @@ networks:
   mainnet: 
     chainID: 'mainnet'
     nativeCurrencySymbol: 'XTZ'    
-    nodeURL: 'https://rpc.tzbeta.net'
+    nodeURL: 'https://mainnet.tezos.marigold.dev'
     tokenListType: 'FILE'
     tokenListSource: 'conf/lists/tezos.mainnet.tokens.json'
     tzktURL: 'https://api.tzkt.io'
+    ctezAdmin: 'KT1GWnsoFZVHGh7roXEER3qeCcgJgrXT3de2'
 
   ghostnet:
     chainID: 'ghostnet'
@@ -17,6 +18,7 @@ networks:
     tokenListType: 'FILE'
     tokenListSource: 'conf/lists/tezos.ghostnet.tokens.json'
     tzktURL: 'https://api.ghostnet.tzkt.io'
+    ctezAdmin: 'KT1CYRQciQpUnyPPEXBR6f65tnyidao76kdn'
 
 manualGasPrice: 123456 # Refer https://tezos.stackexchange.com/questions/2176/how-to-calculate-price-of-gas/2177#2177
 gasLimitTransaction: 100000

test-bronze/connectors/plenty/plenty.test.ts

@@ -62,13 +62,6 @@ describe('Plenty', () => {
     });
   });
 
-  describe('ctezContract', () => {
-    it('should return the ctez contract', async () => {
-      const contract = await plenty.ctezContract(tezos);
-      expect(contract).toBeDefined();
-    });
-  });
-
   describe('tokenList', () => {
     it('should return the token list', () => {
       const tokenList = plenty.tokenList;