Merge pull request #131 from nation3/130-get-blocks-with-multicall

⏲️ perf: get blocks with multicall

Author: aahna-ashina

.github/workflows/generate-datasets-weekly.yml

@@ -42,7 +42,7 @@ jobs:
         # 2. Generate Citizen Data JSON 🧮
       - run: npm run generate-2-json
 
-        # 3. Generate Historical Citizen Data CSVs 🧮
+        # 3. Generate Historical Citizen Voting Escrow Data CSVs 🧮
       - run: npm run generate-3-voting-escrow
 
         # 4. Generate Citizen Count CSV 🧮

data-sources/citizens/README.md

@@ -49,7 +49,7 @@ npm run generate-1-csv
 npm run generate-2-json
 ```
 
-### 3. Generate Historical Citizen Data CSVs
+### 3. Generate Historical Citizen Voting Escrow Data CSVs
 
 ```
 npm run generate-3-voting-escrow

data-sources/citizens/generate-3-voting-escrow-datasets.ts

@@ -3,11 +3,12 @@ const createObjectCsvWriter = require('csv-writer').createObjectCsvWriter
 
 const VotingEscrow = require('../abis/VotingEscrow.json')
 import { ethers } from 'ethers'
+import { MulticallWrapper } from 'ethers-multicall-provider'
 const EthDater = require('ethereum-block-by-date')
 
-const ethersProvider = new ethers.JsonRpcProvider(
+const ethersProvider = MulticallWrapper.wrap(new ethers.JsonRpcProvider(
   'https://ethereum.publicnode.com'
-)
+))
 console.info('ethersProvider:', ethersProvider)
 
 const dater = new EthDater(ethersProvider)
@@ -24,6 +25,10 @@ loadVotingEscrowData()
 async function loadVotingEscrowData() {
   console.info('loadVotingEscrowData')
 
+  const blockPerWeekArray = await getBlockPerWeekArray()
+  console.info('blockPerWeekArray.length:', blockPerWeekArray.length)
+  console.debug('blockPerWeekArray:', blockPerWeekArray)
+
   const citizensJson = require('../output/citizens.json')
   for (const passportId in citizensJson) {
     console.info('passportId:', passportId)
@@ -47,14 +52,16 @@ async function loadVotingEscrowData() {
     // Iterate every week from the week of [Sun May-29-2022 → Sun Jun-05-2022] until now
     const weekEndDate: Date = new Date('2022-06-05T00:00:00Z')
     console.info('weekEndDate:', weekEndDate)
+    let weekNumber: number = 1
     const nowDate: Date = new Date()
     console.info('nowDate:', nowDate)
     while (nowDate.getTime() > weekEndDate.getTime()) {
       const weekBeginDate: Date = new Date(weekEndDate.getTime() - 7*24*60*60*1000)
       console.info('week:', `[${weekBeginDate.toISOString()} → ${weekEndDate.toISOString()}]`)
 
       // Get Ethereum block by date
-      const blockByDate = await dater.getDate(weekEndDate)
+      console.info('weekNumber:', weekNumber)
+      const blockByDate = blockPerWeekArray[weekNumber - 1]
       // console.debug('blockByDate:', blockByDate)
 
       // Get Citizen's voting escrow at the current block
@@ -75,12 +82,32 @@ async function loadVotingEscrowData() {
 
       // Increase week end date by 7 days
       weekEndDate.setDate(weekEndDate.getDate() + 7)
+      weekNumber++
     }
 
     writer.writeRecords(csvRows)
   }
 }
 
+/**
+ * Multicall for getting the Ethereum block for all the weeks.
+ */
+async function getBlockPerWeekArray() {
+  console.info('getBlockPerWeekArray')
+
+  // Populate an Array with one call per week
+  const calls = []
+  const weekEndDate: Date = new Date('2022-06-05T00:00:00Z')
+  const nowDate: Date = new Date()
+  while (nowDate.getTime() > weekEndDate.getTime()) {
+    calls.push(dater.getDate(weekEndDate))
+    weekEndDate.setDate(weekEndDate.getDate() + 7)
+  }
+  console.info('calls.length:', calls.length)
+
+  return Promise.all(calls)
+}
+
 async function getVotingEscrowAtBlock(ethAddress: string, blockNumber: number): Promise<number> {
   console.info('getVotingEscrowAtBlock')
   return await votingEscrowContract.balanceOfAt(ethAddress, blockNumber)

data-sources/citizens/package-lock.json

@@ -27,6 +27,7 @@
     "csv-writer": "^1.6.0",
     "ethereum-block-by-date": "^1.4.9",
     "ethers": "^6.9.1",
+    "ethers-multicall-provider": "^6.4.0",
     "jsonfile": "^6.1.0",
     "papaparse": "^5.4.1",
     "typescript": "^4.8.4"