Feature/qv milestone 3 (#2204)

Co-authored-by: Christiano <[email protected]>
Co-authored-by: dawggydawg <[email protected]>
Co-authored-by: Noah Drabinsky <[email protected]>
Co-authored-by: mitchcivic <[email protected]>

Author: 4 people

.github/workflows/ci-main-tests.yml

@@ -71,7 +71,7 @@ jobs:
         - name: Setup Node
           uses: actions/setup-node@v4
           with:
-            node-version: 18
+            node-version: 20
             cache: yarn
 
         - name: Cache dependencies

.nvmrc

@@ -1 +1 @@
-18.19.0
+lts/iron

@types/types.ts

@@ -4,3 +4,5 @@ export interface EndpointInfo {
   name: EndpointTypes
   url: string
 }
+
+export type GovernanceRole = 'council' | 'community';

GatewayPlugin/config.ts

@@ -1,23 +1,48 @@
 // A list of "passes" offered by Civic to verify or gate access to a DAO.
-export const availablePasses = [
-    {
-        name: 'Uniqueness',
-        value: 'uniqobk8oGh4XBLMqM68K8M2zNu3CdYX7q5go7whQiv',
-        description: 'A biometric proof of personhood, preventing Sybil attacks while retaining privacy'
-    },
-    {
-        name: 'ID Verification',
-        value: 'bni1ewus6aMxTxBi5SAfzEmmXLf8KcVFRmTfproJuKw',
-        description: 'A KYC process for your DAO, allowing users to prove their identity by presenting a government-issued ID'
-    },
-    {
-        name: 'Bot Resistance',
-        value: 'ignREusXmGrscGNUesoU9mxfds9AiYTezUKex2PsZV6',
-        description: 'A simple CAPTCHA to prevent bots from spamming your DAO'
-    },
-    {
-        name: 'Other',
-        value: '',
-        description: 'Set up your own custom verification (contact Civic.com for options)'
-    },
-] as const;
+export const availablePasses: {
+  name: string
+  value: string
+  description: string
+  isSybilResistance: boolean
+}[] = [
+  // Default
+  {
+    name: 'Uniqueness',
+    value: 'uniqobk8oGh4XBLMqM68K8M2zNu3CdYX7q5go7whQiv',
+    description:
+      'A biometric proof of personhood, preventing Sybil attacks while retaining privacy',
+    isSybilResistance: true,
+  },
+  {
+    name: 'ID Verification',
+    value: 'bni1ewus6aMxTxBi5SAfzEmmXLf8KcVFRmTfproJuKw',
+    description:
+      'A KYC process for your DAO, allowing users to prove their identity by presenting a government-issued ID',
+    isSybilResistance: false,
+  },
+  {
+    name: 'Bot Resistance',
+    value: 'ignREusXmGrscGNUesoU9mxfds9AiYTezUKex2PsZV6',
+    description: 'A simple CAPTCHA to prevent bots from spamming your DAO',
+    isSybilResistance: false,
+  },
+  {
+    name: 'Other',
+    value: '',
+    description:
+      'Set up your own custom verification (contact Civic.com for options)',
+    isSybilResistance: false,
+  },
+]
+
+// Infer the types from the available passes, giving type safety on the `other` and `default` pass types
+type ArrayElement<
+  ArrayType extends readonly unknown[]
+> = ArrayType extends readonly (infer ElementType)[] ? ElementType : never
+export type CivicPass = ArrayElement<typeof availablePasses>
+
+// Use this when populating a dropdown
+export const defaultPass: CivicPass = availablePasses[0]
+// Use this in cases where you are implicitly adding sybil resistance to a DAO (e.g. QV DAO creation), rather than
+// offering a choice - this allows defaultPass to be something *other than* sybil resistance without breaking things.
+export const defaultSybilResistancePass = availablePasses[0]

GatewayPlugin/sdk/accounts.tsx

@@ -1,16 +1,65 @@
-import { PublicKey } from '@solana/web3.js'
-import { GatewayClient } from '@solana/governance-program-library'
+import {PublicKey} from '@solana/web3.js'
+import {GatewayClient} from '@solana/governance-program-library'
+import {ProgramAccount, Realm, SYSTEM_PROGRAM_ID} from "@solana/spl-governance";
+import {getRegistrarPDA} from "@utils/plugin/accounts";
 
-export const tryGetGatewayRegistrar = async (
-  registrarPk: PublicKey,
-  client: GatewayClient
+
+// Create an instruction to create a registrar account for a given realm
+export const createCivicRegistrarIx = async (
+    realm: ProgramAccount<Realm>,
+    payer: PublicKey,
+    gatewayClient: GatewayClient,
+    gatekeeperNetwork: PublicKey,
+    predecessor?: PublicKey
 ) => {
-  try {
-    const existingRegistrar = await client.program.account.registrar.fetch(
-      registrarPk
-    )
-    return existingRegistrar
-  } catch (e) {
-    return null
-  }
+  const {registrar} = getRegistrarPDA(
+      realm.pubkey,
+      realm.account.communityMint,
+      gatewayClient.program.programId
+  )
+
+  const remainingAccounts = predecessor
+      ? [{pubkey: predecessor, isSigner: false, isWritable: false}]
+      : []
+
+  return gatewayClient!.program.methods
+      .createRegistrar(!!predecessor)
+      .accounts({
+        registrar,
+        realm: realm.pubkey,
+        governanceProgramId: realm.owner,
+        realmAuthority: realm.account.authority!,
+        governingTokenMint: realm.account.communityMint!,
+        gatekeeperNetwork,
+        payer,
+        systemProgram: SYSTEM_PROGRAM_ID,
+      })
+      .remainingAccounts(remainingAccounts)
+      .instruction()
 }
+// Create an instruction to configure a registrar account for a given realm
+export const configureCivicRegistrarIx = async (
+    realm: ProgramAccount<Realm>,
+    gatewayClient: GatewayClient,
+    gatekeeperNetwork: PublicKey,
+    predecessor?: PublicKey
+) => {
+  const {registrar} = getRegistrarPDA(
+      realm.pubkey,
+      realm.account.communityMint,
+      gatewayClient.program.programId
+  )
+  const remainingAccounts = predecessor
+      ? [{pubkey: predecessor, isSigner: false, isWritable: false}]
+      : []
+  return gatewayClient.program.methods
+      .configureRegistrar(false)
+      .accounts({
+        registrar,
+        realm: realm.pubkey,
+        realmAuthority: realm.account.authority!,
+        gatekeeperNetwork: gatekeeperNetwork,
+      })
+      .remainingAccounts(remainingAccounts)
+      .instruction()
+}