sync gateway / staging -> master for Hummingbot gateway version 1.27.0

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hummingbot-gateway",
-  "version": "1.26.0",
+  "version": "1.27.0",
   "description": "Middleware that helps Hummingbot clients access standardized DEX API endpoints on different blockchain networks",
   "main": "index.js",
   "license": "Apache-2.0",

src/amm/amm.requests.ts

@@ -15,6 +15,7 @@ export interface PriceRequest extends NetworkSelectionRequest {
   amount: string;
   side: Side;
   allowedSlippage?: string;
+  poolId?: string;
 }
 
 export interface PriceResponse {
@@ -41,6 +42,7 @@ export interface PoolPriceRequest extends NetworkSelectionRequest {
   fee?: string;
   period?: number;
   interval?: number;
+  poolId?: string;
 }
 
 export interface PoolPriceResponse {
@@ -67,6 +69,7 @@ export interface TradeRequest extends NetworkSelectionRequest {
   maxFeePerGas?: string;
   maxPriorityFeePerGas?: string;
   allowedSlippage?: string;
+  poolId?: string;
 }
 
 export interface TradeResponse {
@@ -106,6 +109,7 @@ export interface AddLiquidityRequest extends NetworkSelectionRequest { // now al
   maxFeePerGas?: string;
   maxPriorityFeePerGas?: string;
   allowedSlippage?: string; // COSMOS: used to calc TokenMinAmount
+  poolId?: string;
 }
 
 export interface AddLiquidityResponse {

src/amm/amm.validators.ts

@@ -62,6 +62,9 @@ export const invalidDecreasePercentError: string =
 export const invalidAllowedSlippageError: string =
   'The allowedSlippage param may be null or a string of a fraction.';
 
+export const invalidPoolIdError: string =
+  'PoolId(if supplied) must be a string.';
+
 export const validateConnector: Validator = mkValidator(
   'connector',
   invalidConnectorError,
@@ -194,6 +197,13 @@ export const validateAllowedSlippage: Validator = mkValidator(
   true
 );
 
+export const validatePoolId: Validator = mkValidator(
+  'poolId',
+  invalidPoolIdError,
+  (val) => typeof val === 'string' && val.length !== 0,
+  true
+);
+
 export const validatePriceRequest: RequestValidator = mkRequestValidator([
   validateConnector,
   validateChain,
@@ -203,6 +213,7 @@ export const validatePriceRequest: RequestValidator = mkRequestValidator([
   validateAmount,
   validateSide,
   validateAllowedSlippage,
+  validatePoolId,
 ]);
 
 export const validateTradeRequest: RequestValidator = mkRequestValidator([
@@ -218,6 +229,7 @@ export const validateTradeRequest: RequestValidator = mkRequestValidator([
   validateMaxFeePerGas,
   validateMaxPriorityFeePerGas,
   validateAllowedSlippage,
+  validatePoolId,
 ]);
 
 export const validatePerpPositionRequest: RequestValidator = mkRequestValidator(
@@ -302,6 +314,7 @@ export const validateAddLiquidityRequest: RequestValidator = mkRequestValidator(
     validateNonce,
     validateMaxFeePerGas,
     validateMaxPriorityFeePerGas,
+    validatePoolId,
   ]
 );
 
@@ -345,4 +358,5 @@ export const validatePoolPriceRequest: RequestValidator = mkRequestValidator([
   validateFee,
   validateInterval,
   validatePeriod,
+  validatePoolId,
 ]);

src/app.ts

@@ -112,7 +112,7 @@ export const startSwagger = async () => {
 
 export const startGateway = async () => {
   const port = ConfigManagerV2.getInstance().get('server.port');
-  const gateway_version="1.26.0"; // gateway version
+  const gateway_version="1.27.0"
   if (!ConfigManagerV2.getInstance().get('server.id')) {
     ConfigManagerV2.getInstance().set(
       'server.id',

src/chains/ethereum/ethereum.ts

@@ -3,6 +3,7 @@ import { logger } from '../../services/logger';
 import { BigNumber, Contract, Transaction, Wallet } from 'ethers';
 import { EthereumBase } from './ethereum-base';
 import { getEthereumConfig } from './ethereum.config';
+import { PancakeSwapConfig } from '../../connectors/pancakeswap/pancakeswap.config';
 import { Provider } from '@ethersproject/abstract-provider';
 import { ConfigManagerV2 } from '../../services/config-manager-v2';
 // import { throttleRetryWrapper } from '../../services/retry';
@@ -48,7 +49,7 @@ export class Ethereum extends EthereumBase implements Ethereumish {
       config.manualGasPrice,
       config.gasLimitTransaction,
       ConfigManagerV2.getInstance().get('server.nonceDbPath'),
-      ConfigManagerV2.getInstance().get('server.transactionDbPath')
+      ConfigManagerV2.getInstance().get('server.transactionDbPath'),
     );
     this._chain = network;
     this._nativeTokenSymbol = config.nativeCurrencySymbol;
@@ -66,7 +67,7 @@ export class Ethereum extends EthereumBase implements Ethereumish {
     this.onDebugMessage(this.requestCounter.bind(this));
     this._metricTimer = setInterval(
       this.metricLogger.bind(this),
-      this.metricsLogInterval
+      this.metricsLogInterval,
     );
     this.controller = EVMController;
   }
@@ -95,7 +96,7 @@ export class Ethereum extends EthereumBase implements Ethereumish {
       this.requestCount +
         ' request(s) sent in last ' +
         this.metricsLogInterval / 1000 +
-        ' seconds.'
+        ' seconds.',
     );
     this._requestCount = 0; // reset
   }
@@ -146,7 +147,7 @@ export class Ethereum extends EthereumBase implements Ethereumish {
 
     setTimeout(
       this.updateGasPrice.bind(this),
-      this._gasPriceRefreshInterval * 1000
+      this._gasPriceRefreshInterval * 1000,
     );
   }
 
@@ -159,15 +160,15 @@ export class Ethereum extends EthereumBase implements Ethereumish {
     let priorityFee: BigNumber = BigNumber.from('0');
     if (this._chain === 'mainnet') {
       priorityFee = BigNumber.from(
-        await this.provider.send('eth_maxPriorityFeePerGas', [])
+        await this.provider.send('eth_maxPriorityFeePerGas', []),
       );
     }
     return baseFee.add(priorityFee).toNumber() * 1e-9;
   }
 
   getContract(
     tokenAddress: string,
-    signerOrProvider?: Wallet | Provider
+    signerOrProvider?: Wallet | Provider,
   ): Contract {
     return tokenAddress === MKR_ADDRESS
       ? new Contract(tokenAddress, abi.MKRAbi, signerOrProvider)
@@ -180,19 +181,25 @@ export class Ethereum extends EthereumBase implements Ethereumish {
     let spender: string;
     if (reqSpender === 'uniswap') {
       spender = UniswapConfig.config.uniswapV3SmartOrderRouterAddress(
-        this._chain
+        this._chain,
+      );
+    } else if (reqSpender === 'pancakeswap') {
+      spender = PancakeSwapConfig.config.routerAddress(this._chain);
+    } else if (reqSpender === 'pancakeswapLP') {
+      spender = PancakeSwapConfig.config.pancakeswapV3NftManagerAddress(
+        this._chain,
       );
     } else if (reqSpender === 'sushiswap') {
       spender = SushiswapConfig.config.sushiswapRouterAddress(
         this.chainName,
-        this._chain
+        this._chain,
       );
     } else if (reqSpender === 'uniswapLP') {
       spender = UniswapConfig.config.uniswapV3NftManagerAddress(this._chain);
     } else if (reqSpender === 'carbonamm') {
       spender = CarbonConfig.config.carbonContractsConfig(
         'ethereum',
-        this._chain
+        this._chain,
       ).carbonControllerAddress;
     } else if (reqSpender === 'perp') {
       const perp = Perp.getInstance(this._chain, 'optimism');
@@ -219,7 +226,7 @@ export class Ethereum extends EthereumBase implements Ethereumish {
   // cancel transaction
   async cancelTx(wallet: Wallet, nonce: number): Promise<Transaction> {
     logger.info(
-      'Canceling any existing transaction(s) with nonce number ' + nonce + '.'
+      'Canceling any existing transaction(s) with nonce number ' + nonce + '.',
     );
     return this.cancelTxWithGasPrice(wallet, nonce, this._gasPrice * 2);
   }

src/connectors/pancakeswap/pancakeswap.config.ts

@@ -17,8 +17,11 @@ export namespace PancakeSwapConfig {
   export const v2Config: V2NetworkConfig = buildConfig(
     'pancakeswap',
     ['AMM'],
-    [{ chain: 'binance-smart-chain', networks: ['mainnet', 'testnet'] }],
-    'EVM'
+    [
+      { chain: 'binance-smart-chain', networks: ['mainnet', 'testnet'] },
+      { chain: 'ethereum', networks: ['mainnet', 'arbitrum', 'zksync'] },
+    ],
+    'EVM',
   );
 
   export const config: NetworkConfig = {
@@ -27,11 +30,11 @@ export namespace PancakeSwapConfig {
       maximumHops: ConfigManagerV2.getInstance().get(`pancakeswap.maximumHops`),
       pancakeswapV3SmartOrderRouterAddress: (network: string) =>
         ConfigManagerV2.getInstance().get(
-          `pancakeswap.contractAddresses.${network}.pancakeswapV3SmartOrderRouterAddress`
+          `pancakeswap.contractAddresses.${network}.pancakeswapV3SmartOrderRouterAddress`,
         ),
       pancakeswapV3NftManagerAddress: (network: string) =>
         ConfigManagerV2.getInstance().get(
-          `pancakeswap.contractAddresses.${network}.pancakeswapV3NftManagerAddress`
+          `pancakeswap.contractAddresses.${network}.pancakeswapV3NftManagerAddress`,
         ),
       tradingTypes: (type: string) => {
         return type === 'swap' ? ['AMM'] : ['AMM_LP'];