chore: use ethers for ethereum-storage

package.json

@@ -49,5 +49,8 @@
     "prettier": "2.2.1",
     "remap-istanbul": "0.13.0",
     "typescript": "4.4.4"
+  },
+  "resolutions": {
+    "**/ws": "<=7.4.6"
   }
 }

packages/advanced-logic/src/extensions/payment-network/any-to-erc20-proxy.ts

@@ -41,7 +41,8 @@ export default class AnyToErc20ProxyPaymentNetwork extends Erc20FeeProxyPaymentN
     if (!currenciesWithConversionOracles[network]) {
       throw Error(`network ${network} not supported`);
     }
-    const supportedErc20: string[] = currenciesWithConversionOracles[network][RequestLogicTypes.CURRENCY.ERC20];
+    const supportedErc20: string[] =
+      currenciesWithConversionOracles[network][RequestLogicTypes.CURRENCY.ERC20];
 
     for (const address of creationParameters.acceptedTokens) {
       if (!supportedErc20.includes(address.toLowerCase())) {

packages/docs/package.json

@@ -32,10 +32,10 @@
     "gen:code2md": "aurelius 'docs/**/*'"
   },
   "dependencies": {
-    "@docusaurus/core": "2.0.0-alpha.72",
-    "@docusaurus/preset-classic": "2.0.0-alpha.72",
-    "@docusaurus/theme-live-codeblock": "2.0.0-alpha.72",
-    "@docusaurus/utils": "2.0.0-alpha.72",
+    "@docusaurus/core": "2.0.0-beta.3",
+    "@docusaurus/preset-classic": "2.0.0-beta.3",
+    "@docusaurus/theme-live-codeblock": "2.0.0-beta.3",
+    "@docusaurus/utils": "2.0.0-beta.3",
     "@metamask/contract-metadata": "1.25.0",
     "@requestnetwork/payment-processor": "0.37.0",
     "@requestnetwork/request-client.js": "0.39.0",

packages/ethereum-storage/package.json

@@ -50,13 +50,9 @@
     "keyv": "4.0.3",
     "shelljs": "0.8.4",
     "tslib": "2.3.1",
-    "web3-eth": "1.3.6",
-    "web3-utils": "1.3.6",
     "yargs": "16.2.0"
   },
   "devDependencies": {
-    "@openzeppelin/test-helpers": "0.5.6",
-    "@truffle/hdwallet-provider": "1.2.3",
     "@types/bluebird": "3.5.33",
     "@types/jest": "26.0.13",
     "@types/keyv": "3.1.1",
@@ -69,8 +65,7 @@
     "source-map-support": "0.5.19",
     "ts-jest": "26.3.0",
     "ts-node": "9.0.0",
-    "typescript": "4.4.4",
-    "web3-providers-http": "1.3.6"
+    "typescript": "4.4.4"
   },
   "gitHead": "6155223cfce769e48ccae480c510b35b4f54b4d0"
 }

packages/ethereum-storage/src/config.ts

@@ -3,9 +3,15 @@ import { BigNumber } from 'ethers';
 
 // This contains default values used to use Ethereum Network and IPFS
 // if information are not provided by the user
-const config: any = {
+const defaultNode: StorageTypes.IIpfsGatewayConnection = {
+  host: 'localhost',
+  port: 5001,
+  protocol: StorageTypes.IpfsGatewayProtocol.HTTP,
+  timeout: 30000,
+};
+const config = {
   ethereum: {
-    default: 'private',
+    default: 'private' as const,
     gasPriceDefault: '100000000000',
     maxRetries: 5,
     nodeUrlDefault: {
@@ -16,26 +22,17 @@ const config: any = {
     },
     retryDelay: 0,
     safeGasPriceLimit: '500000000000',
-    transactionPollingTimeout: 300,
   },
   ipfs: {
-    defaultNode: {
-      host: 'localhost',
-      port: 5001,
-      protocol: 'http',
-      timeout: 30000,
-    },
+    defaultNode,
     errorHandling: {
       delayBetweenRetries: 500,
       maxRetries: 3,
     },
     expectedBootstrapNodes: [
       '/dns4/ipfs-bootstrap.request.network/tcp/4001/ipfs/QmaSrBXFBaupfeGMTuigswtKtsthbVaSonurjTV967Fdxx',
-
       '/dns4/ipfs-bootstrap-2.request.network/tcp/4001/ipfs/QmYdcSoVNU1axgSnkRAyHtwsKiSvFHXeVvRonGCAV9LVEj',
-
       '/dns4/ipfs-2.request.network/tcp/4001/ipfs/QmPBPgTDVjveRu6KjGVMYixkCSgGtVyV8aUe6wGQeLZFVd',
-
       '/dns4/ipfs-survival.request.network/tcp/4001/ipfs/Qmb6a5DH45k8JwLdLVZUhRhv1rnANpsbXjtsH41esGhNCh',
     ],
     maxIpfsReadRetry: 1,
@@ -69,7 +66,7 @@ export function getDefaultEthereumProvider(): string {
  * @returns the url to connect to the network
  */
 export function getDefaultEthereumProviderTimeout(): number {
-  return config.ethereum.nodeUrlDefault[config.ethereum.default].timeout;
+  return config.ethereum.nodeUrlDefault.private.timeout;
 }
 
 /**
@@ -160,10 +157,3 @@ export function getIpfsExpectedBootstrapNodes(): string[] {
 export function getMaxIpfsReadRetry(): number {
   return config.ipfs.maxIpfsReadRetry;
 }
-
-/**
- * Retrieve from config the amount of time to wait before a transaction is considered failed
- */
-export function getTransactionPollingTimeout(): number {
-  return config.ethereum.transactionPollingTimeout;
-}

packages/ethereum-storage/src/ethereum-blocks.ts

@@ -1,12 +1,12 @@
 import { LogTypes, StorageTypes } from '@requestnetwork/types';
 import Utils from '@requestnetwork/utils';
+import { providers } from 'ethers';
 
 /**
  * Manages every info linked to the ethereum blocks (blockNumber, blockTimestamp, confirmations ... )
  */
 export default class EthereumBlocks {
-  // 'web3-eth' object
-  public eth: any;
+  public provider: providers.Provider;
 
   /**
    * Gets last block number
@@ -43,26 +43,22 @@ export default class EthereumBlocks {
 
   /**
    * Constructor
-   * @param eth eth object from web3
+   * @param provider eth object from web3
    * @param firstSignificantBlockNumber all the block before this one will be ignored
    * @param getLastBlockNumberMinDelay the minimum delay to wait between fetches of lastBlockNumber
    */
   public constructor(
-    eth: any,
+    provider: providers.Provider,
     firstSignificantBlockNumber: number,
     retryDelay: number,
     maxRetries: number,
     getLastBlockNumberMinDelay = 0,
     logger?: LogTypes.ILogger,
   ) {
-    this.eth = eth;
-
+    this.provider = provider;
     this.firstSignificantBlockNumber = firstSignificantBlockNumber;
-
     this.getLastBlockNumberMinDelay = getLastBlockNumberMinDelay;
-
     this.logger = logger || new Utils.SimpleLogger();
-
     // Get retry parameter values from config
     this.retryDelay = retryDelay;
     this.maxRetries = maxRetries;
@@ -73,7 +69,7 @@ export default class EthereumBlocks {
         Utils.retry(
           () => {
             this.logger.debug(`Getting last block number`, ['ethereum', 'ethereum-blocks']);
-            return this.eth.getBlockNumber();
+            return this.provider.getBlockNumber();
           },
           {
             maxRetries: this.maxRetries,
@@ -97,7 +93,7 @@ export default class EthereumBlocks {
 
     // if we don't know the information, let's get it
     // Use Utils.retry to rerun if getBlock fails
-    const block = await Utils.retry((bn: number) => this.eth.getBlock(bn), {
+    const block = await Utils.retry((bn: number) => this.provider.getBlock(bn), {
       maxRetries: this.maxRetries,
       retryDelay: this.retryDelay,
     })(blockNumber);
@@ -193,9 +189,9 @@ export default class EthereumBlocks {
    * @param blockNumber The block number
    * @returns An Ethereum block
    */
-  public async getBlock(blockNumber: number | string): Promise<any> {
-    return Utils.retry(this.eth.getBlock, {
-      context: this.eth,
+  public async getBlock(blockNumber: number | string): Promise<providers.Block> {
+    return Utils.retry(this.provider.getBlock, {
+      context: this.provider,
       maxRetries: this.maxRetries,
       retryDelay: this.retryDelay,
     })(blockNumber);

packages/ethereum-storage/src/ethereum-entries-to-ipfs-content.ts

@@ -209,7 +209,11 @@ async function getIpfsContent(
 
   // Check if the declared size is higher or equal to the size of the actual file
   // If the declared size is higher, it's not considered as a problem since it means the hash submitter has paid a bigger fee than he had to
-  if (!ipfsObject || ipfsObject.ipfsSize > contentSizeDeclared) {
+  if (
+    !ipfsObject ||
+    Number.isNaN(contentSizeDeclared) ||
+    ipfsObject.ipfsSize > contentSizeDeclared
+  ) {
     logger.info(`Incorrect declared size for hash: ${ethereumEntry.hash}`, ['ipfs']);
 
     // No need to retry to find this hash

packages/ethereum-storage/src/ethereum-storage.ts

@@ -71,8 +71,8 @@ export default class EthereumStorage implements StorageTypes.IStorage {
    */
   public constructor(
     externalBufferUrl: string,
-    ipfsGatewayConnection?: StorageTypes.IIpfsGatewayConnection,
-    web3Connection?: StorageTypes.IWeb3Connection,
+    ipfsGatewayConnection: StorageTypes.IIpfsGatewayConnection,
+    web3Connection: StorageTypes.IWeb3Connection,
     {
       getLastBlockNumberDelay,
       logger,
@@ -120,7 +120,7 @@ export default class EthereumStorage implements StorageTypes.IStorage {
     try {
       await this.smartContractManager.checkWeb3ProviderConnection(WEB3_PROVIDER_TIMEOUT);
     } catch (error) {
-      throw Error(`Ethereum node is not accessible: ${error}`);
+      throw new Error(`Ethereum node is not accessible: ${error}`);
     }
 
     // check if contracts are deployed on ethereum
@@ -380,9 +380,7 @@ export default class EthereumStorage implements StorageTypes.IStorage {
   public async getData(
     options?: StorageTypes.ITimestampBoundaries,
   ): Promise<StorageTypes.IEntriesWithLastTimestamp> {
-    const contentDataIdAndMeta = await this.getContentAndDataId(options);
-
-    return contentDataIdAndMeta;
+    return this.getContentAndDataId(options);
   }
 
   /**