Merge pull request #124 from nation3/113-rename-to-voting-escrow

Rename to voting escrow (#113)

Author: aahna-ashina

.github/CODEOWNERS

@@ -1 +1 @@
-*     @nation3/developer-level-4 @nation3/developer-level-5
+*     @nation3/developer-level-4

.github/pull_request_template.md

@@ -7,7 +7,7 @@
 <!--- Please describe in detail how you tested your changes. -->
 
 - [ ] Status checks pass
-- [ ] Works on Goerli
+- [ ] Works on Sepolia
 - [ ] Works on Mainnet
 
 ## Are There Admin Tasks?

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

@@ -36,17 +36,17 @@ jobs:
       - name: Build
         run: npm run build
 
-        # Generate Citizen Data CSV 🧮
-      - run: npm run generate-csv
+        # 1. Generate Citizen Data CSV 🧮
+      - run: npm run generate-1-csv
 
-        # Generate Citizen Data JSON 🧮
-      - run: npm run generate-json
+        # 2. Generate Citizen Data JSON 🧮
+      - run: npm run generate-2-json
 
-        # Generate Historical Citizen Data CSVs 🧮
-      - run: npm run generate-power
+        # 3. Generate Historical Citizen Data CSVs 🧮
+      - run: npm run generate-3-voting-escrow
 
-        # Generate Citizen Count CSV 🧮
-      - run: npm run generate-count
+        # 4. Generate Citizen Count CSV 🧮
+      - run: npm run generate-4-count
 
       - name: Commit Changes
         run: |

data-sources/citizens/README.md

@@ -6,7 +6,7 @@ https://etherscan.io/token/0x3337dac9f251d4e403d6030e18e3cfb6a2cb1333#inventory
 
 - `citizens.csv`
 
-    - Contains the NFT Passport ID, owner/signer Ethereum address and ENS name (if any) of each Nation3 Citizen.  And the `voting_power` column is the Citizen's [`$veNATION`](https://wiki.nation3.org/token/#venation) balance.
+    - Contains the NFT Passport ID, owner/signer Ethereum address and ENS name (if any) of each Nation3 Citizen.  And the `voting_escrow` column is the Citizen's [`$veNATION`](https://wiki.nation3.org/token/#venation) balance.
 
     - The `owner_address` is the Ethereum address used for linking a Citizen to activity in Dework/GitHub/Karma/Snapshot/SourceCred.
 
@@ -16,7 +16,7 @@ https://etherscan.io/token/0x3337dac9f251d4e403d6030e18e3cfb6a2cb1333#inventory
 
 - `citizen-<passportId>.csv`
 
-    - Contains a Citizen's voting power week by week.
+    - Contains a Citizen's voting escrow week by week.
 
 - `citizen-count-peer-week.csv`
 
@@ -36,26 +36,26 @@ npm install
 npm run build
 ```
 
-### Generate Citizen Data CSV
+### 1. Generate Citizen Data CSV
 
 ```
-npm run generate-csv
+npm run generate-1-csv
 ```
 
-### Generate Citizen Data JSON
+### 2. Generate Citizen Data JSON
 
 ```
-npm run generate-json
+npm run generate-2-json
 ```
 
-### Generate Historical Citizen Data CSVs
+### 3. Generate Historical Citizen Data CSVs
 
 ```
-npm run generate-power
+npm run generate-3-voting-escrow
 ```
 
-### Generate Citizen Count CSV
+### 4. Generate Citizen Count CSV
 
 ```
-npm run generate-count
+npm run generate-4-count
 ```

data-sources/citizens/generate-citizens-csv.ts data-sources/citizens/generate-1-citizens-csv.ts

@@ -35,7 +35,7 @@ async function loadCitizenData() {
       { id: 'owner_address', title: 'owner_address' },
       { id: 'signer_address', title: 'signer_address' },
       { id: 'ens_name', title: 'ens_name' },
-      { id: 'voting_power', title: 'voting_power' },
+      { id: 'voting_escrow', title: 'voting_escrow' },
     ],
   })
   let csvRows = []
@@ -62,20 +62,20 @@ async function loadCitizenData() {
     const ensName: string | null = await getEnsName(ownerAddress)
     console.info('ensName:', ensName)
 
-    const votingPowerWei: number = await getVotingPower(ownerAddress)
-    console.info('votingPowerWei:', votingPowerWei)
-    const votingPowerEther: string = ethers.formatUnits(votingPowerWei)
-    console.info('votingPowerEther:', votingPowerEther)
-    const votingPowerRounded: string = new Number(votingPowerEther).toFixed(2)
-    console.info('votingPowerRounded:', votingPowerRounded)
+    const votingEscrowWei: number = await getVotingEscrow(ownerAddress)
+    console.info('votingEscrowWei:', votingEscrowWei)
+    const votingEscrowEther: string = ethers.formatUnits(votingEscrowWei)
+    console.info('votingEscrowEther:', votingEscrowEther)
+    const votingEscrowRounded: string = new Number(votingEscrowEther).toFixed(2)
+    console.info('votingEscrowRounded:', votingEscrowRounded)
 
     // Export to CSV
     const csvRow = {
       passport_id: passportId,
       owner_address: ownerAddress.toLowerCase(),
       signer_address: signerAddress.toLowerCase(),
       ens_name: ensName,
-      voting_power: votingPowerRounded
+      voting_escrow: votingEscrowRounded
     }
     csvRows.push(csvRow)
   }
@@ -113,8 +113,8 @@ async function getEnsName(ethAddress: string): Promise<string | null> {
   return await ethersProvider.lookupAddress(ethAddress)
 }
 
-async function getVotingPower(ethAddress: string): Promise<number> {
-  console.info('getVotingPower')
+async function getVotingEscrow(ethAddress: string): Promise<number> {
+  console.info('getVotingEscrow')
   return await votingEscrowContract.balanceOf(ethAddress)
 }
 

data-sources/citizens/generate-citizens-json.ts data-sources/citizens/generate-2-citizens-json.ts

@@ -27,15 +27,15 @@ async function convertToJSON() {
       const ownerAddress: string = row.owner_address
       const signerAddress: string = row.signer_address
       const ensName: string = row.ens_name
-      const votingPower: number = Number(row.voting_power)
+      const votingEscrow: number = Number(row.voting_escrow)
 
       if (passportID >= 0) {
         const citizenObject = {
           passportId: passportID,
           ownerAddress: ownerAddress,
           signerAddress: signerAddress,
           ensName: ensName,
-          votingPower: votingPower,
+          votingEscrow: votingEscrow,
         }
 
         citizenObjects[String(passportID)] = citizenObject

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

@@ -19,10 +19,10 @@ const votingEscrowContract = new ethers.Contract(
   ethersProvider
 )
 
-loadVotingPowerData()
+loadVotingEscrowData()
 
-async function loadVotingPowerData() {
-  console.info('loadVotingPowerData')
+async function loadVotingEscrowData() {
+  console.info('loadVotingEscrowData')
 
   const citizensJson = require('../output/citizens.json')
   for (const passportId in citizensJson) {
@@ -39,7 +39,7 @@ async function loadVotingPowerData() {
       header: [
         { id: 'week_end', title: 'week_end' },
         { id: 'block', title: 'block' },
-        { id: 'voting_power', title: 'voting_power' }
+        { id: 'voting_escrow', title: 'voting_escrow' }
       ]
     })
     const csvRows = []
@@ -57,19 +57,19 @@ async function loadVotingPowerData() {
       const blockByDate = await dater.getDate(weekEndDate)
       // console.debug('blockByDate:', blockByDate)
 
-      // Get Citizen's voting power at the current block
-      const votingPowerWei: number = await getVotingPowerAtBlock(ethAddress, blockByDate.block)
-      console.info('votingPowerWei:', votingPowerWei)
-      const votingPowerEther: string = ethers.formatUnits(votingPowerWei)
-      console.info('votingPowerEther:', votingPowerEther)
-      const votingPowerRounded: string = new Number(votingPowerEther).toFixed(2)
-      console.info('votingPowerRounded:', votingPowerRounded)
+      // Get Citizen's voting escrow at the current block
+      const votingEscrowWei: number = await getVotingEscrowAtBlock(ethAddress, blockByDate.block)
+      console.info('votingEscrowWei:', votingEscrowWei)
+      const votingEscrowEther: string = ethers.formatUnits(votingEscrowWei)
+      console.info('votingEscrowEther:', votingEscrowEther)
+      const votingEscrowRounded: string = new Number(votingEscrowEther).toFixed(2)
+      console.info('votingEscrowRounded:', votingEscrowRounded)
 
       // Export to CSV
       const csvRow = {
         week_end: weekEndDate.toISOString().substring(0, 10),
         block: blockByDate.block,
-        voting_power: votingPowerRounded
+        voting_escrow: votingEscrowRounded
       }
       csvRows.push(csvRow)
 
@@ -81,7 +81,7 @@ async function loadVotingPowerData() {
   }
 }
 
-async function getVotingPowerAtBlock(ethAddress: string, blockNumber: number): Promise<number> {
-  console.info('getVotingPowerAtBlock')
+async function getVotingEscrowAtBlock(ethAddress: string, blockNumber: number): Promise<number> {
+  console.info('getVotingEscrowAtBlock')
   return await votingEscrowContract.balanceOfAt(ethAddress, blockNumber)
 }

data-sources/citizens/generate-citizen-count-csv.ts data-sources/citizens/generate-4-citizen-count-csv.ts

@@ -101,7 +101,7 @@ function getTotalExpiredPassports(weekEndDate: Date, maxPassportID: number): num
   for (let passportID = 0; passportID < maxPassportID; passportID++) {
     console.info(`weekEndDate: ${weekEndDateString}, passportID: ${passportID}`)
 
-    // Fetch voting power data from the citizen's data CSV
+    // Fetch voting escrow data from the citizen's data CSV
     const citizenFilePath: string = `output/citizen-${passportID}.csv`
     console.info('Fetching citizen data:', citizenFilePath)
     const file: File = fs.readFileSync(citizenFilePath)
@@ -115,8 +115,8 @@ function getTotalExpiredPassports(weekEndDate: Date, maxPassportID: number): num
         // console.info('result:', result)
         result.data.forEach((row: any, i: number) => {
           if (row.week_end == weekEndDateString) {
-            console.info(`row.week_end ${row.week_end}, row.voting_power: ${row.voting_power}`)
-            if (row.voting_power < 1.5) {
+            console.info(`row.week_end ${row.week_end}, row.voting_escrow: ${row.voting_escrow}`)
+            if (row.voting_escrow < 1.5) {
               // https://etherscan.io/address/0x279c0b6bfcbba977eaf4ad1b2ffe3c208aa068ac#readContract#F9
               console.info('Passport ID expired:', passportID)
               totalExpiredPassports++

data-sources/citizens/output/citizen-0.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,0.00
 2022-06-12,14947132,0.00
 2022-06-19,14987809,0.00

data-sources/citizens/output/citizen-1.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,2.91
 2022-06-12,14947132,2.89
 2022-06-19,14987809,2.88

data-sources/citizens/output/citizen-10.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,3.38
 2022-06-12,14947132,3.37
 2022-06-19,14987809,3.35

data-sources/citizens/output/citizen-100.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,2.42
 2022-06-12,14947132,2.40
 2022-06-19,14987809,2.39

data-sources/citizens/output/citizen-101.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,2.22
 2022-06-12,14947132,2.21
 2022-06-19,14987809,2.20

data-sources/citizens/output/citizen-102.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,2.60
 2022-06-12,14947132,2.59
 2022-06-19,14987809,2.57

data-sources/citizens/output/citizen-103.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,2.03
 2022-06-12,14947132,2.02
 2022-06-19,14987809,2.01

data-sources/citizens/output/citizen-104.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,2.10
 2022-06-12,14947132,2.09
 2022-06-19,14987809,2.08

data-sources/citizens/output/citizen-105.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,2.03
 2022-06-12,14947132,2.02
 2022-06-19,14987809,2.01

data-sources/citizens/output/citizen-106.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,2.43
 2022-06-12,14947132,2.42
 2022-06-19,14987809,2.40

data-sources/citizens/output/citizen-107.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,2.42
 2022-06-12,14947132,2.40
 2022-06-19,14987809,2.39

data-sources/citizens/output/citizen-108.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,2.43
 2022-06-12,14947132,2.42
 2022-06-19,14987809,2.40

data-sources/citizens/output/citizen-109.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,2.22
 2022-06-12,14947132,2.21
 2022-06-19,14987809,2.20

data-sources/citizens/output/citizen-11.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,2.13
 2022-06-12,14947132,2.12
 2022-06-19,14987809,2.11

data-sources/citizens/output/citizen-110.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,3.98
 2022-06-12,14947132,3.96
 2022-06-19,14987809,3.94

data-sources/citizens/output/citizen-111.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,2.08
 2022-06-12,14947132,2.07
 2022-06-19,14987809,2.06

data-sources/citizens/output/citizen-112.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,0.00
 2022-06-12,14947132,0.00
 2022-06-19,14987809,0.00

data-sources/citizens/output/citizen-113.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,2.43
 2022-06-12,14947132,2.42
 2022-06-19,14987809,2.40

data-sources/citizens/output/citizen-114.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,2.19
 2022-06-12,14947132,2.18
 2022-06-19,14987809,2.17

data-sources/citizens/output/citizen-115.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,2.09
 2022-06-12,14947132,2.08
 2022-06-19,14987809,2.07

data-sources/citizens/output/citizen-116.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,2.52
 2022-06-12,14947132,2.50
 2022-06-19,14987809,2.49

data-sources/citizens/output/citizen-117.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,2.55
 2022-06-12,14947132,2.53
 2022-06-19,14987809,2.51

data-sources/citizens/output/citizen-118.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,2.04
 2022-06-12,14947132,2.03
 2022-06-19,14987809,2.02

data-sources/citizens/output/citizen-119.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,2.03
 2022-06-12,14947132,2.02
 2022-06-19,14987809,2.01

data-sources/citizens/output/citizen-12.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,2.43
 2022-06-12,14947132,2.42
 2022-06-19,14987809,2.41

data-sources/citizens/output/citizen-120.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,2.09
 2022-06-12,14947132,2.08
 2022-06-19,14987809,2.07

data-sources/citizens/output/citizen-121.csv

@@ -1,4 +1,4 @@
-week_end,block,voting_power
+week_end,block,voting_escrow
 2022-06-05,14905988,2.51
 2022-06-12,14947132,2.50
 2022-06-19,14987809,2.49