[Feature] Optigov plugin

.github/workflows/ci.yml

@@ -74,6 +74,27 @@ jobs:
           github-token: ${{ secrets.COVERALLS_NEW }}
           flag-name: ethernaut-oso
           parallel: true
+  ethernaut-optigov:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: ['20.12.0']
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm run compile --if-present
+      - run: cd packages/ethernaut-optigov && npm t
+      - name: Coveralls
+        uses: coverallsapp/github-action@v2.3.6
+        with:
+          github-token: ${{ secrets.COVERALLS_NEW }}
+          flag-name: ethernaut-optigov
+          parallel: true
   ethernaut-util:
     runs-on: ubuntu-latest
     strategy:
@@ -386,6 +407,7 @@ jobs:
       [
         ethernaut-common,
         ethernaut-oso,
+        ethernaut-optigov,
         ethernaut-util,
         ethernaut-util-ui,
         ethernaut-ui,

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ethernaut-cli-monorepo",
-  "version": "1.0.0",
+  "version": "1.1.12",
   "private": true,
   "workspaces": [
     "packages/*"

packages/ethernaut-cli/test/update.test.js

@@ -25,15 +25,13 @@ describe('update', function () {
   before('cache', async function () {
     const config = storage.readConfig()
     cachedAutoUpdate = config.general?.autoUpdate
-
     cachedPkg = fs.readFileSync('package.json', 'utf8')
   })
 
   after('restore', async function () {
     const config = storage.readConfig()
     config.general.autoUpdate = cachedAutoUpdate
     storage.saveConfig(config)
-
     fs.writeFileSync('package.json', cachedPkg, 'utf8')
   })
 
@@ -69,6 +67,7 @@ describe('update', function () {
     describe('when auto update is the current version', function () {
       before('modify', async function () {
         const pkg = JSON.parse(cachedPkg)
+        pkg.version = '0.0.0'
         const config = storage.readConfig()
         config.general.autoUpdate = pkg.version
         storage.saveConfig(config)
@@ -79,7 +78,7 @@ describe('update', function () {
       })
 
       it('displays navigation', async function () {
-        terminal.has('Pick a task or scope')
+        terminal.has('A new version of the ethernaut-cli is available')
       })
     })
 

packages/ethernaut-optigov/README.md

@@ -33,6 +33,10 @@ This plugin doesn't depend on any other plugins.
 This plugin adds the tasks listed below.
 
 - login Logs in to the Agora RetroPGF API with SIWE (Sign in with Ethereum)
+- projects Prints a list of projects registered in RetroPGF, given specified filters
+- proposals Prints a list of proposals registered in RetroPGF, given specified filters
+- delegate Prints a list of delegates on Agora, or details a specific delegate, with optional related data (votes or delegators)
+
 
 ## Environment extensions
 

packages/ethernaut-optigov/src/internal/agora/Agora.js

@@ -0,0 +1,62 @@
+const axios = require('axios')
+const EthernautCliError = require('ethernaut-common/src/error/error')
+const debug = require('ethernaut-common/src/ui/debug')
+
+const API_BASE_URL = 'https://vote.optimism.io/api/v1'
+const AGORA_API_KEY = process.env.AGORA_API_KEY
+
+class Agora {
+  constructor() {
+    this.apiKey = AGORA_API_KEY
+    this.apiBaseUrl = API_BASE_URL
+    this.bearerToken = null
+  }
+
+  // Axios instance setup
+  createAxiosInstance() {
+    const headers = {
+      Authorization: this.bearerToken
+        ? `Bearer ${this.bearerToken}`
+        : `Bearer ${this.apiKey}`,
+    }
+
+    return axios.create({
+      baseURL: this.apiBaseUrl,
+      headers,
+    })
+  }
+
+  // Handle common API errors
+  handleError(error) {
+    if (error.response) {
+      throw new EthernautCliError(
+        'ethernaut-optigov',
+        `Http status error: ${error.response.data}`,
+      )
+    } else {
+      throw new EthernautCliError(
+        'ethernaut-optigov',
+        `Http status error: ${error.message}`,
+      )
+    }
+  }
+
+  // common method for getting API spec
+  async getSpec() {
+    try {
+      const axiosInstance = this.createAxiosInstance()
+      const response = await axiosInstance.get('/spec')
+      debug.log(`Spec: ${response.data}`, 'ethernaut-optigov')
+      return response.data
+    } catch (error) {
+      this.handleError(error)
+    }
+  }
+
+  // Set the bearer token after authentication
+  setBearerToken(token) {
+    this.bearerToken = token
+  }
+}
+
+module.exports = Agora

packages/ethernaut-optigov/src/internal/agora/Auth.js

@@ -1,61 +1,38 @@
-const axios = require('axios')
 const debug = require('ethernaut-common/src/ui/debug')
-const EthernautCliError = require('ethernaut-common/src/error/error')
-const API_BASE_URL = 'https://vote.optimism.io/api/v1'
 
 class Auth {
-  constructor() {}
+  constructor(agora) {
+    this.agora = agora
+  }
 
-  // Get a nonce from the Agora API
   async getNonce() {
     try {
-      const response = await axios.get(`${API_BASE_URL}/auth/nonce`)
-
+      const axiosInstance = this.agora.createAxiosInstance()
+      const response = await axiosInstance.get('/auth/nonce')
       debug.log(`Nonce: ${response.data.nonce}`, 'ethernaut-optigov')
-      return response.data
+      return response.data.nonce
     } catch (error) {
-      throw new EthernautCliError(
-        'ethernaut-optigov',
-        `Http status error: ${error.message}`,
-      )
+      this.agora.handleError(error)
     }
   }
 
-  // Authenticate with the Agora API
   async authenticateWithAgora(message, signature, nonce) {
     try {
-      const response = await axios.post(
-        `${API_BASE_URL}/auth/verify`,
-        {
-          message,
-          signature,
-          nonce,
-        },
-        {
-          headers: {
-            'Content-Type': 'application/json',
-          },
-        },
-      )
+      const axiosInstance = this.agora.createAxiosInstance()
+      const response = await axiosInstance.post('/auth/verify', {
+        message,
+        signature,
+        nonce,
+      })
 
       debug.log('Auth Response Status:', response.status)
-      // save the Bearer token
-      this.bearerToken = response.data.access_token
+
+      // Set the Bearer token for future requests
+      this.agora.setBearerToken(response.data.access_token)
+
       return response.data.access_token
     } catch (error) {
-      if (error.response) {
-        // Server responded with a status other than 2xx
-        throw new EthernautCliError(
-          'ethernaut-optigov',
-          `Http status error: ${error.response.data}`,
-        )
-      } else {
-        // Other errors (e.g., network issue)
-        throw new EthernautCliError(
-          'ethernaut-optigov',
-          `Http status error: ${error.message}`,
-        )
-      }
+      this.agora.handleError(error)
     }
   }
 }

packages/ethernaut-optigov/src/internal/agora/Delegates.js

@@ -0,0 +1,132 @@
+const debug = require('ethernaut-common/src/ui/debug')
+
+class Delegates {
+  constructor(agora) {
+    this.agora = agora
+  }
+
+  // Get a list of delegates with pagination
+  async getDelegates({ limit = 10, offset = 0, sort } = {}) {
+    try {
+      const axiosInstance = this.agora.createAxiosInstance()
+      const response = await axiosInstance.get('/delegates', {
+        params: { limit, offset, sort },
+      })
+
+      debug.log(`Delegates: ${response.data.data}`, 'ethernaut-optigov')
+      return response.data.data.map((delegate) => ({
+        address: delegate.address,
+        votingPower: delegate.votingPower?.total,
+        twitter: delegate.statement?.payload?.twitter,
+        discord: delegate.statement?.payload?.discord,
+        delegateStatement:
+          delegate.statement?.payload?.delegateStatement?.substring(0, 100),
+      }))
+    } catch (error) {
+      this.agora.handleError(error)
+    }
+  }
+
+  // Get a specific delegate by address or ENS name
+  async getDelegateById(addressOrEnsName) {
+    try {
+      const axiosInstance = this.agora.createAxiosInstance()
+      const response = await axiosInstance.get(`/delegates/${addressOrEnsName}`)
+
+      debug.log(`Delegate: ${response.data}`, 'ethernaut-optigov')
+      const data = response.data
+      return {
+        address: data.address,
+        votingPower: {
+          advanced: data.votingPower.advanced,
+          direct: data.votingPower.direct,
+          total: data.votingPower.total,
+        },
+        votingPowerRelativeToVotableSupply:
+          data.votingPowerRelativeToVotableSupply,
+        votingPowerRelativeToQuorum: data.votingPowerRelativeToQuorum,
+        proposalsCreated: data.proposalsCreated,
+        proposalsVotedOn: data.proposalsVotedOn,
+        votedFor: data.votedFor,
+        votedAgainst: data.votedAgainst,
+        votedAbstain: data.votedAbstain,
+        votingParticipation: data.votingParticipation,
+        lastTenProps: data.lastTenProps,
+        numOfDelegators: data.numOfDelegators,
+      }
+    } catch (error) {
+      this.agora.handleError(error)
+    }
+  }
+
+  // Get a paginated list of votes for a specific delegate
+  async getDelegateVotes({
+    addressOrEnsName,
+    limit = 10,
+    offset = 0,
+    sort,
+  } = {}) {
+    try {
+      const axiosInstance = this.agora.createAxiosInstance()
+      const response = await axiosInstance.get(
+        `/delegates/${addressOrEnsName}/votes`,
+        {
+          params: { limit, offset, sort },
+        },
+      )
+
+      debug.log(
+        `Votes for Delegate ${addressOrEnsName}: ${response.data.data}`,
+        'ethernaut-optigov',
+      )
+      return response.data.data.map((vote) => ({
+        transactionHash: vote.transactionHash,
+        proposalId: vote.proposalId,
+        address: vote.address,
+        support: vote.support,
+        reason: vote.reason,
+        weight: vote.weight,
+        proposalValue: vote.proposalValue,
+        proposalTitle: vote.proposalTitle,
+        proposalType: vote.proposalType,
+        timestamp: vote.timestamp,
+      }))
+    } catch (error) {
+      this.agora.handleError(error)
+    }
+  }
+
+  // Get a paginated list of delegators for a specific delegate
+  async getDelegateDelegators({
+    addressOrEnsName,
+    limit = 10,
+    offset = 0,
+    sort,
+  } = {}) {
+    try {
+      const axiosInstance = this.agora.createAxiosInstance()
+      const response = await axiosInstance.get(
+        `/delegates/${addressOrEnsName}/delegators`,
+        {
+          params: { limit, offset, sort },
+        },
+      )
+
+      debug.log(
+        `Delegators for Delegate ${addressOrEnsName}: ${response.data.data}`,
+        'ethernaut-optigov',
+      )
+      return response.data.data.map((delegator) => ({
+        from: delegator.from,
+        allowance: delegator.allowance,
+        timestamp: delegator.timestamp,
+        type: delegator.type,
+        amount: delegator.amount,
+      }))
+    } catch (error) {
+      this.agora.handleError(error)
+    }
+  }
+}
+
+module.exports = Delegates