Merge pull request #1214 from oceanprotocol/feature/own-gas-contract-…

…options Allow users/market to set own gas contract options & configurable web3 contract params
oceanprotocol · Jan 20, 2022 · 5621b43 · 5621b43
2 parents 7c6ce63 + ed2fe3a
commit 5621b43
Show file tree

Hide file tree

Showing 13 changed files with 793 additions and 290 deletions.
diff --git a/src/factories/NFTFactory.ts b/src/factories/NFTFactory.ts
@@ -9,14 +9,17 @@ import {
   generateDtName,
   getFreCreationParams,
   getErcCreationParams,
-  getPoolCreationParams
+  getPoolCreationParams,
+  configHelperNetworks,
+  setContractDefaults
 } from '../utils'
 import {
   FreCreationParams,
   Erc20CreateParams,
   PoolCreationParams,
   DispenserCreationParams
 } from '../interfaces'
+import { Config } from '../models/index.js'
 import { ProviderFees } from '../@types/index.js'
 
 interface Template {
@@ -47,7 +50,7 @@ export class NftFactory {
   public factory721Address: string
   public factory721Abi: AbiItem | AbiItem[]
   public web3: Web3
-  public startBlock: number
+  public config: Config
   public factory721: Contract
 
   /**
@@ -60,15 +63,15 @@ export class NftFactory {
     factory721Address: string,
     web3: Web3,
     factory721Abi?: AbiItem | AbiItem[],
-    startBlock?: number
+    config?: Config
   ) {
     this.factory721Address = factory721Address
     this.factory721Abi = factory721Abi || (defaultFactory721Abi.abi as AbiItem[])
     this.web3 = web3
-    this.startBlock = startBlock || 0
-    this.factory721 = new this.web3.eth.Contract(
-      this.factory721Abi,
-      this.factory721Address
+    this.config = config || configHelperNetworks[0]
+    this.factory721 = setContractDefaults(
+      new this.web3.eth.Contract(this.factory721Abi, this.factory721Address),
+      this.config
     )
   }
 
@@ -135,7 +138,7 @@ export class NftFactory {
       .send({
         from: address,
         gas: estGas + 1,
-        gasPrice: await getFairGasPrice(this.web3)
+        gasPrice: await getFairGasPrice(this.web3, this.config)
       })
 
     let tokenAddress = null
@@ -277,7 +280,7 @@ export class NftFactory {
       .send({
         from: address,
         gas: estGas + 1,
-        gasPrice: await getFairGasPrice(this.web3)
+        gasPrice: await getFairGasPrice(this.web3, this.config)
       })
 
     return trxReceipt
@@ -333,7 +336,7 @@ export class NftFactory {
       .send({
         from: address,
         gas: estGas + 1,
-        gasPrice: await getFairGasPrice(this.web3)
+        gasPrice: await getFairGasPrice(this.web3, this.config)
       })
 
     return trxReceipt
@@ -390,7 +393,7 @@ export class NftFactory {
       .send({
         from: address,
         gas: estGas + 1,
-        gasPrice: await getFairGasPrice(this.web3)
+        gasPrice: await getFairGasPrice(this.web3, this.config)
       })
 
     return trxReceipt
@@ -444,7 +447,7 @@ export class NftFactory {
       .send({
         from: address,
         gas: estGas + 1,
-        gasPrice: await getFairGasPrice(this.web3)
+        gasPrice: await getFairGasPrice(this.web3, this.config)
       })
 
     return trxReceipt
@@ -503,7 +506,7 @@ export class NftFactory {
       .send({
         from: address,
         gas: estGas + 1,
-        gasPrice: await getFairGasPrice(this.web3)
+        gasPrice: await getFairGasPrice(this.web3, this.config)
       })
 
     return trxReceipt
@@ -563,7 +566,7 @@ export class NftFactory {
       .send({
         from: address,
         gas: estGas + 1,
-        gasPrice: await getFairGasPrice(this.web3)
+        gasPrice: await getFairGasPrice(this.web3, this.config)
       })
 
     return trxReceipt
@@ -618,7 +621,7 @@ export class NftFactory {
       .send({
         from: address,
         gas: estGas + 1,
-        gasPrice: await getFairGasPrice(this.web3)
+        gasPrice: await getFairGasPrice(this.web3, this.config)
       })
 
     return trxReceipt
@@ -674,7 +677,7 @@ export class NftFactory {
       .send({
         from: address,
         gas: estGas + 1,
-        gasPrice: await getFairGasPrice(this.web3)
+        gasPrice: await getFairGasPrice(this.web3, this.config)
       })
 
     return trxReceipt
@@ -739,7 +742,7 @@ export class NftFactory {
       .send({
         from: address,
         gas: estGas + 1,
-        gasPrice: await getFairGasPrice(this.web3)
+        gasPrice: await getFairGasPrice(this.web3, this.config)
       })
 
     return trxReceipt
@@ -807,7 +810,7 @@ export class NftFactory {
       .send({
         from: address,
         gas: estGas + 1,
-        gasPrice: await getFairGasPrice(this.web3)
+        gasPrice: await getFairGasPrice(this.web3, this.config)
       })
 
     return trxReceipt
@@ -873,7 +876,7 @@ export class NftFactory {
       .send({
         from: address,
         gas: estGas + 1,
-        gasPrice: await getFairGasPrice(this.web3)
+        gasPrice: await getFairGasPrice(this.web3, this.config)
       })
 
     return trxReceipt

diff --git a/src/models/Config.ts b/src/models/Config.ts
@@ -170,6 +170,30 @@ export class Config {
    * @type {string}
    */
   oceanTokenSymbol: string
+
+  /**
+   * Specify the transaction Block Timeout
+   * @type {number}
+   */
+  transactionBlockTimeout: number
+
+  /**
+   * Specify the transaction Confirmation Blocks
+   * @type {number}
+   */
+  transactionConfirmationBlocks: number
+
+  /**
+   * Specify the transaction Polling Blocks Timeout
+   * @type {number}
+   */
+  transactionPollingTimeout: number
+
+  /**
+   * Specify the multiplier for the gas fee
+   * @type {number}
+   */
+  gasFeeMultiplier: number
 }
 
 export default Config
diff --git a/src/pools/Router.ts b/src/pools/Router.ts
@@ -3,8 +3,9 @@ import Web3 from 'web3'
 import { TransactionReceipt } from 'web3-core'
 import { AbiItem } from 'web3-utils'
 import defaultRouter from '../artifacts/pools/FactoryRouter.sol/FactoryRouter.json'
-import { getFairGasPrice } from '../utils'
+import { getFairGasPrice, setContractDefaults, configHelperNetworks } from '../utils'
 import { Operation } from '../interfaces/RouterInterface'
+import { Config } from '../models/index.js'
 
 /**
  * Provides an interface for FactoryRouter contract
@@ -14,7 +15,7 @@ export class Router {
   public routerAddress: string
   public RouterAbi: AbiItem | AbiItem[]
   public web3: Web3
-  public startBlock: number
+  public config: Config
   public router: Contract
 
   /**
@@ -27,13 +28,16 @@ export class Router {
     routerAddress: string,
     web3: Web3,
     RouterAbi?: AbiItem | AbiItem[],
-    startBlock?: number
+    config?: Config
   ) {
     this.routerAddress = routerAddress
     this.RouterAbi = RouterAbi || (defaultRouter.abi as AbiItem[])
     this.web3 = web3
-    this.startBlock = startBlock || 0
-    this.router = new this.web3.eth.Contract(this.RouterAbi, this.routerAddress)
+    this.config = config || configHelperNetworks[0]
+    this.router = setContractDefaults(
+      new this.web3.eth.Contract(this.RouterAbi, this.routerAddress),
+      this.config
+    )
   }
 
   /**
@@ -71,7 +75,7 @@ export class Router {
     const trxReceipt = await this.router.methods.buyDTBatch(operations).send({
       from: address,
       gas: estGas + 1,
-      gasPrice: await getFairGasPrice(this.web3)
+      gasPrice: await getFairGasPrice(this.web3, this.config)
     })
 
     return trxReceipt
@@ -165,7 +169,7 @@ export class Router {
     const trxReceipt = await this.router.methods.addOceanToken(tokenAddress).send({
       from: address,
       gas: estGas + 1,
-      gasPrice: await getFairGasPrice(this.web3)
+      gasPrice: await getFairGasPrice(this.web3, this.config)
     })
 
     return trxReceipt
@@ -217,7 +221,7 @@ export class Router {
     const trxReceipt = await this.router.methods.removeOceanToken(tokenAddress).send({
       from: address,
       gas: estGas + 1,
-      gasPrice: await getFairGasPrice(this.web3)
+      gasPrice: await getFairGasPrice(this.web3, this.config)
     })
 
     return trxReceipt
@@ -262,7 +266,7 @@ export class Router {
     const trxReceipt = await this.router.methods.addSSContract(tokenAddress).send({
       from: address,
       gas: estGas + 1,
-      gasPrice: await getFairGasPrice(this.web3)
+      gasPrice: await getFairGasPrice(this.web3, this.config)
     })
 
     return trxReceipt
@@ -310,7 +314,7 @@ export class Router {
     const trxReceipt = await this.router.methods.removeSSContract(tokenAddress).send({
       from: address,
       gas: estGas + 1,
-      gasPrice: await getFairGasPrice(this.web3)
+      gasPrice: await getFairGasPrice(this.web3, this.config)
     })
 
     return trxReceipt
@@ -359,7 +363,7 @@ export class Router {
     const trxReceipt = await this.router.methods.addFixedRateContract(tokenAddress).send({
       from: address,
       gas: estGas + 1,
-      gasPrice: await getFairGasPrice(this.web3)
+      gasPrice: await getFairGasPrice(this.web3, this.config)
     })
 
     return trxReceipt
@@ -410,7 +414,7 @@ export class Router {
       .send({
         from: address,
         gas: estGas + 1,
-        gasPrice: await getFairGasPrice(this.web3)
+        gasPrice: await getFairGasPrice(this.web3, this.config)
       })
 
     return trxReceipt
@@ -459,7 +463,7 @@ export class Router {
     const trxReceipt = await this.router.methods.addDispenserContract(tokenAddress).send({
       from: address,
       gas: estGas + 1,
-      gasPrice: await getFairGasPrice(this.web3)
+      gasPrice: await getFairGasPrice(this.web3, this.config)
     })
 
     return trxReceipt
@@ -510,7 +514,7 @@ export class Router {
       .send({
         from: address,
         gas: estGas + 1,
-        gasPrice: await getFairGasPrice(this.web3)
+        gasPrice: await getFairGasPrice(this.web3, this.config)
       })
 
     return trxReceipt
@@ -571,7 +575,7 @@ export class Router {
     const trxReceipt = await this.router.methods.updateOPFFee(newFee, newFee).send({
       from: address,
       gas: estGas + 1,
-      gasPrice: await getFairGasPrice(this.web3)
+      gasPrice: await getFairGasPrice(this.web3, this.config)
     })
 
     return trxReceipt
@@ -620,7 +624,7 @@ export class Router {
     const trxReceipt = await this.router.methods.addPoolTemplate(templateAddress).send({
       from: address,
       gas: estGas + 1,
-      gasPrice: await getFairGasPrice(this.web3)
+      gasPrice: await getFairGasPrice(this.web3, this.config)
     })
 
     return trxReceipt
@@ -670,7 +674,7 @@ export class Router {
       .send({
         from: address,
         gas: estGas + 1,
-        gasPrice: await getFairGasPrice(this.web3)
+        gasPrice: await getFairGasPrice(this.web3, this.config)
       })
 
     return trxReceipt