Voting connector: Support vote statuses

packages/connect-voting/src/__test__/votes.test.ts

@@ -87,6 +87,18 @@ describe('when connecting to a voting app', () => {
  expect(vote.startDate).toEqual('1599675534')
  })
 
+ test('should have a valid endDate', () => {
+ expect(vote.endDate).toEqual('1600280334')
+ })
+
+ test('should have not be accepted', () => {
+ expect(vote.isAccepted).toBe(false)
+ })
+
+ test('should have a valid status', () => {
+ expect(vote.status).toEqual('Rejected')
+ })
+
  describe('when querying for the casts of a vote', () => {
  let casts: Cast[]
 

packages/connect-voting/src/helpers/index.ts

@@ -0,0 +1,2 @@
+export * from './numbers'
+export * from './time'

packages/connect-voting/src/helpers/numbers.ts

@@ -0,0 +1,3 @@
+import { BigNumber } from 'ethers'
+
+export const bn = (x: string | number): BigNumber => BigNumber.from(x.toString())

packages/connect-voting/src/helpers/time.ts

@@ -0,0 +1,4 @@
+import { BigNumber } from 'ethers'
+import { bn } from './numbers'
+
+export const currentTimestampEvm = (): BigNumber => bn(Math.floor(Date.now() / 1000))

packages/connect-voting/src/models/Vote.ts

@@ -2,6 +2,7 @@ import { SubscriptionCallback, SubscriptionResult } from '@aragon/connect-types'
 import { subscription } from '@aragon/connect-core'
 import { IVotingConnector, VoteData } from '../types'
 import Cast from './Cast'
+import { bn, currentTimestampEvm } from '../helpers'
 
 export default class Vote {
  #connector: IVotingConnector
@@ -13,13 +14,15 @@ export default class Vote {
  readonly executed: boolean
  readonly executedAt: string
  readonly startDate: string
+ readonly endDate: string
  readonly snapshotBlock: string
  readonly supportRequiredPct: string
  readonly minAcceptQuorum: string
  readonly yea: string
  readonly nay: string
  readonly votingPower: string
  readonly script: string
+ readonly isAccepted: boolean
 
  constructor(data: VoteData, connector: IVotingConnector) {
  this.#connector = connector
@@ -31,13 +34,29 @@ export default class Vote {
  this.executed = data.executed
  this.executedAt = data.executedAt
  this.startDate = data.startDate
+ this.endDate = data.endDate
  this.snapshotBlock = data.snapshotBlock
  this.supportRequiredPct = data.supportRequiredPct
  this.minAcceptQuorum = data.minAcceptQuorum
  this.yea = data.yea
  this.nay = data.nay
  this.votingPower = data.votingPower
  this.script = data.script
+ this.isAccepted = data.isAccepted
+ }
+
+ get status(): string {
+ const currentTimestamp = currentTimestampEvm()
+
+ if (!this.executed) {
+ if (currentTimestamp.gte(bn(this.endDate))) {
+ return this.isAccepted ? "Accepted" : "Rejected"
+ }
+
+ return "Ongoing"
+ }
+
+ return "Executed"
  }
 
  async casts({ first = 1000, skip = 0 } = {}): Promise<Cast[]> {

packages/connect-voting/src/thegraph/queries/index.ts

@@ -14,12 +14,14 @@ export const ALL_VOTES = (type: string) => gql`
  executed
  executedAt
  startDate
+ endDate
  snapshotBlock
  supportRequiredPct
  minAcceptQuorum
  yea
  nay
  votingPower
+ isAccepted
  script
  }
  }
@@ -39,12 +41,14 @@ export const CASTS_FOR_VOTE = (type: string) => gql`
  executed
  executedAt
  startDate
+ endDate
  snapshotBlock
  supportRequiredPct
  minAcceptQuorum
  yea
  nay
  votingPower
+ isAccepted
  script
  }
  voter {

packages/connect-voting/src/types.ts

@@ -13,13 +13,15 @@ export interface VoteData {
  executed: boolean
  executedAt: string
  startDate: string
+ endDate: string
  snapshotBlock: string
  supportRequiredPct: string
  minAcceptQuorum: string
  yea: string
  nay: string
  votingPower: string
  script: string
+ isAccepted: boolean
 }
 
 export interface CastData {

packages/connect-voting/subgraph/schema.graphql

@@ -8,6 +8,7 @@ type Vote @entity {
  executed: Boolean!
  executedAt: BigInt!
  startDate: BigInt!
+ endDate: BigInt!
  snapshotBlock: BigInt!
  supportRequiredPct: BigInt!
  minAcceptQuorum: BigInt!
@@ -16,6 +17,7 @@ type Vote @entity {
  votingPower: BigInt!
  script: String!
  voteNum: BigInt!
+ isAccepted: Boolean!
  castVotes: [Cast!] @derivedFrom(field: "vote")
 }
 

packages/connect-voting/subgraph/src/Voting.ts

@@ -25,6 +25,7 @@ export function handleStartVote(event: StartVoteEvent): void {
  vote.metadata = event.params.metadata
  vote.voteNum = event.params.voteId
  vote.startDate = voteData.value2
+ vote.endDate = vote.startDate.plus(voting.voteTime())
  vote.snapshotBlock = voteData.value3
  vote.supportRequiredPct = voteData.value4
  vote.minAcceptQuorum = voteData.value5
@@ -35,7 +36,7 @@ export function handleStartVote(event: StartVoteEvent): void {
  vote.orgAddress = voting.kernel()
  vote.executedAt = BigInt.fromI32(0)
  vote.executed = false
-
+ vote.isAccepted = isAccepted(vote.yea, vote.nay, vote.votingPower, vote.supportRequiredPct, vote.minAcceptQuorum, voting.PCT_BASE())
  vote.save()
 }
 
@@ -118,6 +119,16 @@ export function updateVoteState(votingAddress: Address, voteId: BigInt): void {
  const vote = VoteEntity.load(buildVoteEntityId(votingAddress, voteId))!
  vote.yea = voteData.value6
  vote.nay = voteData.value7
+ vote.isAccepted = isAccepted(vote.yea, vote.nay, vote.votingPower, vote.supportRequiredPct, vote.minAcceptQuorum, votingApp.PCT_BASE())
 
  vote.save()
 }
+
+function isAccepted(yeas: BigInt, nays: BigInt, votingPower: BigInt, supportRequiredPct: BigInt, minimumAcceptanceQuorumPct: BigInt, pctBase: BigInt): boolean {
+ return hasReachedValuePct(yeas, yeas.plus(nays), supportRequiredPct, pctBase) &&
+ hasReachedValuePct(yeas, votingPower, minimumAcceptanceQuorumPct, pctBase)
+}
+
+function hasReachedValuePct(value: BigInt, total: BigInt, pct: BigInt, pctBase: BigInt): boolean {
+ return total.notEqual(BigInt.fromI32(0)) && (value.times(pctBase).div(total)).gt(pct)
+}