feat: add single choice and approval voting type (#46)

* fix: show voting buttons for offchain proposals * refactor: move the network actions to actions.ts * feat: add support for basic voting for offchain proposals * fix: fix invalid import type * fix: use correct sequencer network depending on chainId * chore: add tests * Update packages/sx.js/src/clients/offchain/ethereum-sig/index.ts Co-authored-by: Wiktor Tkaczyński <wiktor.tkaczynski@gmail.com> * refactor: use same function order definition as other networks * fix: handle offchain receipt without tx_hash * fix: fix typing * fix: throw error on sequencer error response * chore: add unit test * chore: fix tests * fix: show voting form only for supported voting type * chore: remove cumbersome describe block * fix: switch to correct chain for offchain actions * fix: avoid changing type * chore: improve test * fix: revert network enforcer * fix: remove unused import * refactor: rename voteType * refactor: rename type * feat: add support for single choice voting * fix: remove redundant tooltip * feat: add support for approval voting * chore: fix tests * refactor: extract list to constant * chore: update changeset * fix: UI fix * Update .changeset/chilly-avocados-teach.md Co-authored-by: Wiktor Tkaczyński <wiktor.tkaczynski@gmail.com> * Update apps/ui/src/networks/offchain/helpers.ts Co-authored-by: Wiktor Tkaczyński <wiktor.tkaczynski@gmail.com> * fix: fix missing parenthesis * fix: fix botched merged * refactor: extract vote form into their own component * refactor: add more type to Choice * fix(ui): fix glitched focus ring * fix(ui): remove unused class * fix(ui): DRY class * fix: fix Choice type * Update packages/sx.js/src/clients/starknet/starknet-tx/index.ts Co-authored-by: Wiktor Tkaczyński <wiktor.tkaczynski@gmail.com> * refactor: rename events name * refactor: improve event naming * fix: tentative type fix --------- Co-authored-by: Wiktor Tkaczyński <wiktor.tkaczynski@gmail.com>
snapshot-labs · Feb 21, 2024 · ff6f988 · ff6f988
1 parent c76f035
commit ff6f988
Show file tree

Hide file tree

Showing 17 changed files with 210 additions and 76 deletions.
diff --git a/.changeset/chilly-avocados-teach.md b/.changeset/chilly-avocados-teach.md
@@ -0,0 +1,5 @@
+---
+"@snapshot-labs/sx": patch
+---
+
+add approval and single choice vote support to OffchainEthereumSig
diff --git a/apps/ui/src/components/ProposalVote.vue b/apps/ui/src/components/ProposalVote.vue
@@ -1,4 +1,5 @@
 <script setup lang="ts">
+import { SUPPORTED_VOTING_TYPES } from '@/helpers/constants';
 import { _t } from '@/helpers/utils';
 import { getNetwork } from '@/networks';
 import { Proposal as ProposalType } from '@/types';
@@ -21,7 +22,11 @@ const isSupported = computed(() => {
     network.helpers.isStrategySupported(strategy)
   );
 
-  return hasSupportedAuthenticator && hasSupportedStrategies && props.proposal.type === 'basic';
+  return (
+    hasSupportedAuthenticator &&
+    hasSupportedStrategies &&
+    SUPPORTED_VOTING_TYPES.includes(props.proposal.type)
+  );
 });
 </script>
 
@@ -50,5 +55,7 @@ const isSupported = computed(() => {
   <slot v-else-if="!isSupported" name="unsupported">
     Voting for this proposal is not supported
   </slot>
-  <slot v-else></slot>
+  <div v-else class="py-2">
+    <slot />
+  </div>
 </template>
diff --git a/apps/ui/src/components/ProposalVoteApproval.vue b/apps/ui/src/components/ProposalVoteApproval.vue
@@ -0,0 +1,49 @@
+<script setup lang="ts">
+import { Choice, Proposal } from '@/types';
+
+defineProps<{
+  sendingType: Choice | null;
+  proposal: Proposal;
+}>();
+
+const emit = defineEmits<{
+  (e: 'vote', value: Choice);
+}>();
+
+const selectedChoices = ref<number[]>([]);
+
+function toggleSelectedChoice(choice: number) {
+  if (selectedChoices.value.includes(choice)) {
+    selectedChoices.value = selectedChoices.value.filter(c => c !== choice);
+  } else {
+    selectedChoices.value = [...selectedChoices.value, choice];
+  }
+}
+</script>
+
+<template>
+  <div class="flex flex-col space-y-3">
+    <div class="flex flex-col space-y-2">
+      <UiButton
+        v-for="(choice, index) in proposal.choices"
+        :key="index"
+        class="!h-[48px] text-left w-full flex items-center"
+        :class="{ 'border-skin-text': selectedChoices.includes(index + 1) }"
+        @click="toggleSelectedChoice(index + 1)"
+      >
+        <div class="grow truncate">
+          {{ choice }}
+        </div>
+        <IH-check v-if="selectedChoices.includes(index + 1)" class="shrink-0" />
+      </UiButton>
+    </div>
+    <UiButton
+      primary
+      class="!h-[48px] w-full"
+      :loading="!!sendingType"
+      @click="emit('vote', selectedChoices)"
+    >
+      Vote
+    </UiButton>
+  </div>
+</template>
diff --git a/apps/ui/src/components/ProposalVoteBasic.vue b/apps/ui/src/components/ProposalVoteBasic.vue
@@ -0,0 +1,50 @@
+<script setup lang="ts">
+import { Choice } from '@/types';
+
+withDefaults(
+  defineProps<{
+    sendingType: Choice | null;
+    size: number;
+  }>(),
+  { size: 48 }
+);
+
+const emit = defineEmits<{
+  (e: 'vote', value: Choice);
+}>();
+</script>
+
+<template>
+  <div class="flex space-x-2">
+    <UiTooltip title="For">
+      <UiButton
+        class="!text-skin-success !border-skin-success !px-0"
+        :class="{ '!w-[48px] !h-[48px]': size === 48, '!w-[40px] !h-[40px]': size === 40 }"
+        :loading="sendingType === 'for'"
+        @click="emit('vote', 'for')"
+      >
+        <IH-check class="inline-block" />
+      </UiButton>
+    </UiTooltip>
+    <UiTooltip title="Against">
+      <UiButton
+        class="!text-skin-danger !border-skin-danger !px-0"
+        :class="{ '!w-[48px] !h-[48px]': size === 48, '!w-[40px] !h-[40px]': size === 40 }"
+        :loading="sendingType === 'against'"
+        @click="emit('vote', 'against')"
+      >
+        <IH-x class="inline-block" />
+      </UiButton>
+    </UiTooltip>
+    <UiTooltip title="Abstain">
+      <UiButton
+        class="!text-gray-500 !border-gray-500 !px-0"
+        :class="{ '!w-[48px] !h-[48px]': size === 48, '!w-[40px] !h-[40px]': size === 40 }"
+        :loading="sendingType === 'abstain'"
+        @click="emit('vote', 'abstain')"
+      >
+        <IH-minus-sm class="inline-block" />
+      </UiButton>
+    </UiTooltip>
+  </div>
+</template>
diff --git a/apps/ui/src/components/ProposalVoteSingleChoice.vue b/apps/ui/src/components/ProposalVoteSingleChoice.vue
@@ -0,0 +1,26 @@
+<script setup lang="ts">
+import { Choice, Proposal } from '@/types';
+
+defineProps<{
+  sendingType: Choice | null;
+  proposal: Proposal;
+}>();
+
+const emit = defineEmits<{
+  (e: 'vote', value: number);
+}>();
+</script>
+
+<template>
+  <div class="flex flex-col space-y-2">
+    <UiButton
+      v-for="(choice, index) in proposal.choices"
+      :key="index"
+      class="!h-[48px] text-left w-full truncate"
+      :loading="sendingType === index + 1"
+      @click="emit('vote', index + 1)"
+    >
+      {{ choice }}
+    </UiButton>
+  </div>
+</template>
diff --git a/apps/ui/src/components/ProposalsListItem.vue b/apps/ui/src/components/ProposalsListItem.vue
@@ -80,35 +80,12 @@ async function handleVoteClick(choice: Choice) {
             <ProposalResults v-if="proposal.type === 'basic'" :proposal="proposal" />
             <div v-else />
           </template>
-          <div class="flex space-x-2 py-2">
-            <UiTooltip title="For">
-              <UiButton
-                class="w-[40px] !text-skin-success !border-skin-success !h-[40px] !px-0"
-                :loading="sendingType === 'for'"
-                @click="handleVoteClick('for')"
-              >
-                <IH-check class="inline-block" />
-              </UiButton>
-            </UiTooltip>
-            <UiTooltip title="Against">
-              <UiButton
-                class="w-[40px] !text-skin-danger !border-skin-danger !h-[40px] !px-0"
-                :loading="sendingType === 'against'"
-                @click="handleVoteClick('against')"
-              >
-                <IH-x class="inline-block" />
-              </UiButton>
-            </UiTooltip>
-            <UiTooltip title="Abstain">
-              <UiButton
-                class="w-[40px] !text-gray-500 !border-gray-500 !h-[40px] !px-0"
-                :loading="sendingType === 'abstain'"
-                @click="handleVoteClick('abstain')"
-              >
-                <IH-minus-sm class="inline-block" />
-              </UiButton>
-            </UiTooltip>
-          </div>
+          <ProposalVoteBasic
+            v-if="proposal.type === 'basic'"
+            :sending-type="sendingType"
+            :size="40"
+            @vote="handleVoteClick"
+          />
         </ProposalVote>
       </div>
     </div>

diff --git a/apps/ui/src/helpers/constants.ts b/apps/ui/src/helpers/constants.ts
@@ -23,3 +23,4 @@ export const COINGECKO_BASE_ASSETS = {
 
 export const MAX_SYMBOL_LENGTH = 12;
 export const CHOICES = ['For', 'Against', 'Abstain'];
+export const SUPPORTED_VOTING_TYPES = ['basic', 'single-choice', 'approval'];
diff --git a/apps/ui/src/networks/offchain/actions.ts b/apps/ui/src/networks/offchain/actions.ts
@@ -39,7 +39,8 @@ export function createActions(
       const data = {
         space: proposal.space.id,
         proposal: proposal.proposal_id as string,
-        choice: getSdkChoice(choice),
+        type: proposal.type,
+        choice: getSdkChoice(proposal.type, choice),
         authenticator: '',
         strategies: [],
         metadataUri: ''

diff --git a/apps/ui/src/networks/offchain/helpers.ts b/apps/ui/src/networks/offchain/helpers.ts
@@ -1,7 +1,19 @@
 import { Choice } from '@/types';
 
-export function getSdkChoice(choice: Choice): number {
-  if (choice === 'for') return 1;
-  if (choice === 'against') return 2;
-  return 3;
+export function getSdkChoice(type: string, choice: Choice): number | number[] {
+  if (type === 'basic') {
+    if (choice === 'for') return 1;
+    if (choice === 'against') return 2;
+    return 3;
+  }
+
+  if (type === 'single-choice') {
+    return choice as number;
+  }
+
+  if (type === 'approval') {
+    return choice as number[];
+  }
+
+  throw new Error('Vote type not supported');
 }
diff --git a/apps/ui/src/types.ts b/apps/ui/src/types.ts
@@ -16,7 +16,7 @@ export type NetworkID =
   | 'matic'
   | 'arb1';
 
-export type Choice = 'for' | 'against' | 'abstain';
+export type Choice = 'for' | 'against' | 'abstain' | number | number[];
 
 export type SelectedStrategy = {
   address: string;

diff --git a/apps/ui/src/views/Proposal.vue b/apps/ui/src/views/Proposal.vue
@@ -162,35 +162,23 @@ watchEffect(() => {
 
           <h4 class="block eyebrow mb-2 mt-4 first:mt-1">Cast your vote</h4>
           <ProposalVote v-if="proposal" :proposal="proposal">
-            <div class="flex space-x-2 py-2">
-              <UiTooltip title="For">
-                <UiButton
-                  class="!text-skin-success !border-skin-success !w-[48px] !h-[48px] !px-0"
-                  :loading="sendingType === 'for'"
-                  @click="handleVoteClick('for')"
-                >
-                  <IH-check class="inline-block" />
-                </UiButton>
-              </UiTooltip>
-              <UiTooltip title="Against">
-                <UiButton
-                  class="!text-skin-danger !border-skin-danger !w-[48px] !h-[48px] !px-0"
-                  :loading="sendingType === 'against'"
-                  @click="handleVoteClick('against')"
-                >
-                  <IH-x class="inline-block" />
-                </UiButton>
-              </UiTooltip>
-              <UiTooltip title="Abstain">
-                <UiButton
-                  class="!text-gray-500 !border-gray-500 !w-[48px] !h-[48px] !px-0"
-                  :loading="sendingType === 'abstain'"
-                  @click="handleVoteClick('abstain')"
-                >
-                  <IH-minus-sm class="inline-block" />
-                </UiButton>
-              </UiTooltip>
-            </div>
+            <ProposalVoteBasic
+              v-if="proposal.type === 'basic'"
+              :sending-type="sendingType"
+              @vote="handleVoteClick"
+            />
+            <ProposalVoteSingleChoice
+              v-else-if="proposal.type === 'single-choice'"
+              :proposal="proposal"
+              :sending-type="sendingType"
+              @vote="handleVoteClick"
+            />
+            <ProposalVoteApproval
+              v-else-if="proposal.type === 'approval'"
+              :proposal="proposal"
+              :sending-type="sendingType"
+              @vote="handleVoteClick"
+            />
           </ProposalVote>
         </template>
 

diff --git a/packages/sx.js/src/clients/offchain/ethereum-sig/index.ts b/packages/sx.js/src/clients/offchain/ethereum-sig/index.ts
@@ -1,5 +1,5 @@
 import { offchainGoerli } from '../../../offchainNetworks';
-import { domain, voteTypes } from './types';
+import { domain, SingleChoiceVoteTypes, MultipleChoiceVoteTypes } from './types';
 import type { Signer, TypedDataSigner, TypedDataField } from '@ethersproject/abstract-signer';
 import type { Vote, Envelope, SignatureData, EIP712VoteMessage, EIP712Message } from '../types';
 import type { OffchainNetworkConfig } from '../../../types';
@@ -93,7 +93,12 @@ export class EthereumSig {
       metadata: ''
     };
 
-    const signatureData = await this.sign(signer, message, voteTypes);
+    let voteType = SingleChoiceVoteTypes;
+    if (data.type === 'approval') {
+      voteType = MultipleChoiceVoteTypes;
+    }
+
+    const signatureData = await this.sign(signer, message, voteType);
 
     return {
       signatureData,

diff --git a/packages/sx.js/src/clients/offchain/ethereum-sig/types.ts b/packages/sx.js/src/clients/offchain/ethereum-sig/types.ts
@@ -3,7 +3,7 @@ export const domain = {
   version: '0.1.4'
 };
 
-export const voteTypes = {
+export const SingleChoiceVoteTypes = {
   Vote: [
     { name: 'from', type: 'address' },
     { name: 'space', type: 'string' },
@@ -15,3 +15,16 @@ export const voteTypes = {
     { name: 'metadata', type: 'string' }
   ]
 };
+
+export const MultipleChoiceVoteTypes = {
+  Vote: [
+    { name: 'from', type: 'address' },
+    { name: 'space', type: 'string' },
+    { name: 'timestamp', type: 'uint64' },
+    { name: 'proposal', type: 'string' },
+    { name: 'choice', type: 'uint32[]' },
+    { name: 'reason', type: 'string' },
+    { name: 'app', type: 'string' },
+    { name: 'metadata', type: 'string' }
+  ]
+};
diff --git a/packages/sx.js/src/clients/offchain/types.ts b/packages/sx.js/src/clients/offchain/types.ts
@@ -1,10 +1,6 @@
 import type { TypedDataDomain, TypedDataField } from '@ethersproject/abstract-signer';
 
-enum Choice {
-  Against = 2,
-  For = 1,
-  Abstain = 3
-}
+type Choice = number | number[];
 
 export type SignatureData = {
   address: string;
@@ -43,4 +39,5 @@ export type Vote = {
   proposal: string;
   choice: Choice;
   metadataUri: string;
+  type: string;
 };
diff --git a/packages/sx.js/test/integration/offchain/fixtures/vote.json b/packages/sx.js/test/integration/offchain/fixtures/vote.json
@@ -4,5 +4,6 @@
   "strategies": [],
   "proposal": "0xcc47146e5e0ac781e8976405a8da4468f2a0c4cdf0c7659353d728fafe46f801",
   "choice": 1,
-  "metadataUri": ""
+  "metadataUri": "",
+  "type": "basic"
 }
diff --git a/packages/sx.js/test/unit/clients/offchain/ethereum-sig/__snapshots__/index.test.ts.snap b/packages/sx.js/test/unit/clients/offchain/ethereum-sig/__snapshots__/index.test.ts.snap
@@ -9,6 +9,7 @@ exports[`EthereumSig > should create vote envelope 1`] = `
     "proposal": "0xcc47146e5e0ac781e8976405a8da4468f2a0c4cdf0c7659353d728fafe46f801",
     "space": "wan-test.eth",
     "strategies": [],
+    "type": "basic",
   },
   "signatureData": {
     "address": "0xf1f09AdC06aAB740AA16004D62Dbd89484d3Be90",

diff --git a/packages/sx.js/test/unit/clients/offchain/ethereum-sig/index.test.ts b/packages/sx.js/test/unit/clients/offchain/ethereum-sig/index.test.ts
@@ -26,7 +26,8 @@ describe('EthereumSig', () => {
       strategies: [],
       proposal: '0xcc47146e5e0ac781e8976405a8da4468f2a0c4cdf0c7659353d728fafe46f801',
       choice: 1,
-      metadataUri: ''
+      metadataUri: '',
+      type: 'basic'
     };
 
     const envelope = await client.vote({