@dorafactory/maci-sdk 0.0.4 → 0.0.6

package/README.md

@@ -82,7 +82,7 @@ const proof = await client.getProofByContractAddress('dora1...');
 
 ### Contract Interactions
 
-#### Create New Voting Round
+#### Create New Oracle Maci Round
 ```typescript
 const wallet = await DirectSecp256k1Wallet.fromKey(
   Buffer.from(privateKey, 'hex'),
@@ -93,14 +93,13 @@ const newRound = await client.createOracleMaciRound({
   signer: wallet,
   operatorPubkey: '0e752c...',
   startVoting: new Date(),
-  endVoting: new Date(new Date().getTime() + 1 * 60 * 1000),
-  title: 'test',
-  description: 'test',
-  link: 'test',
+  endVoting: new Date(new Date().getTime() + 10 * 60 * 1000),
+  title: 'Just for fun',
+  description: 'some description',
+  link: 'https://www.dorafactory.org',
   maxVoter: '5',
   maxOption: '5',
   circuitType: MaciCircuitType.IP1V,
-  whitelistBackendPubkey: 'AoYo...',
   whitelistEcosystem: 'cosmoshub',
   whitelistSnapshotHeight: '0',
   whitelistVotingPowerArgs: {
@@ -108,6 +107,22 @@ const newRound = await client.createOracleMaciRound({
     slope: '1000000',
     threshold: '1000000',
   },
-  feegrantOperator: 'dora1...',
 });
 ```
+
+**Note:** 
+- The `operatorPubkey` is the public key of the operator. It is the compressed public key of the operator's private key.
+- The `whitelistEcosystem` is the ecosystem of the whitelist (e.g. 'cosmoshub'). Only wallet addresses that have staked tokens in the specified ecosystem before the snapshot block height will be eligible to become voters.
+- The `whitelistSnapshotHeight` is the snapshot block height for checking voter eligibility. The minimum valid height is 23,342,001. If set to "0", the round will evaluate the voter's stake at the time of signup.
+- The `whitelistVotingPowerArgs` configures how voting power is calculated:
+  - `mode`: Can be either 'slope' or 'threshold'
+    - 'slope' mode: Calculates voice credits based on each voter's stake amount using the formula: voice credits = staked tokens / slope value
+    - 'threshold' mode: Equally assigns 1 voice credit to voters whose stake exceeds the specified threshold
+  - `slope`: The slope value for calculating voice credits in slope mode (e.g. 1000000)
+  - `threshold`: The minimum stake threshold in threshold mode (e.g. 1000000)
+
+For example, if a voter stakes 100000000 tokens and the slope value is 2500000, the voter will be assigned 40 voice credits.
+
+> The 1,000,000 reference value here is the precision of cosmoshub, which is 6 bits, and doravota, which is 18 bits, so when you want to pick doravota's staker as a whitelist and ask them to pledge 1DORA to convert 1vote, you need to set the scope to 1000000000000000000 (10**18). Note that currently only cosmoshub and doravota are supported as ecosystem options.
+> 
+> One detail, here the slope is calculated by rounding down.

package/dist/index.js

@@ -3566,7 +3566,23 @@ var CIRCUIT_INFO = {
       vote_option_tree_depth: "3"
     },
     groth16: {
-      process_vkey: {
+      process_1p1v_vkey: {
+        vk_alpha1: "2d4d9aa7e302d9df41749d5507949d05dbea33fbb16c643b22f599a2be6df2e214bedd503c37ceb061d8ec60209fe345ce89830a19230301f076caff004d1926",
+        vk_beta_2: "0967032fcbf776d1afc985f88877f182d38480a653f2decaa9794cbc3bf3060c0e187847ad4c798374d0d6732bf501847dd68bc0e071241e0213bc7fc13db7ab304cfbd1e08a704a99f5e847d93f8c3caafddec46b7a0d379da69a4d112346a71739c1b1a457a8c7313123d24d2f9192f896b7c63eea05a9d57f06547ad0cec8",
+        vk_gamma_2: "198e9393920d483a7260bfb731fb5d25f1aa493335a9e71297e485b7aef312c21800deef121f1e76426a00665e5c4479674322d4f75edadd46debd5cd992f6ed090689d0585ff075ec9e99ad690c3395bc4b313370b38ef355acdadcd122975b12c85ea5db8c6deb4aab71808dcb408fe3d1e7690c43d37b4ce6cc0166fa7daa",
+        vk_delta_2: "198e9393920d483a7260bfb731fb5d25f1aa493335a9e71297e485b7aef312c21800deef121f1e76426a00665e5c4479674322d4f75edadd46debd5cd992f6ed090689d0585ff075ec9e99ad690c3395bc4b313370b38ef355acdadcd122975b12c85ea5db8c6deb4aab71808dcb408fe3d1e7690c43d37b4ce6cc0166fa7daa",
+        vk_ic0: "1195be678487bbc8c0ae726c0985a5caf6f75e3f8327926926c4f89e498ad733043e46e10b506d194b27275f402bc3fb208a2f5be69662e7c9898d1c0ece4f04",
+        vk_ic1: "10c34362189a7ee44b1c5e57755d7e0d672dba552e614d5cd9a53081bee2333425879fa4e4a9e3fff287824cce35f94725ca0edb60a4ffcbf50becb2fd96cb0b"
+      },
+      tally_1p1v_vkey: {
+        vk_alpha1: "2d4d9aa7e302d9df41749d5507949d05dbea33fbb16c643b22f599a2be6df2e214bedd503c37ceb061d8ec60209fe345ce89830a19230301f076caff004d1926",
+        vk_beta_2: "0967032fcbf776d1afc985f88877f182d38480a653f2decaa9794cbc3bf3060c0e187847ad4c798374d0d6732bf501847dd68bc0e071241e0213bc7fc13db7ab304cfbd1e08a704a99f5e847d93f8c3caafddec46b7a0d379da69a4d112346a71739c1b1a457a8c7313123d24d2f9192f896b7c63eea05a9d57f06547ad0cec8",
+        vk_gamma_2: "198e9393920d483a7260bfb731fb5d25f1aa493335a9e71297e485b7aef312c21800deef121f1e76426a00665e5c4479674322d4f75edadd46debd5cd992f6ed090689d0585ff075ec9e99ad690c3395bc4b313370b38ef355acdadcd122975b12c85ea5db8c6deb4aab71808dcb408fe3d1e7690c43d37b4ce6cc0166fa7daa",
+        vk_delta_2: "198e9393920d483a7260bfb731fb5d25f1aa493335a9e71297e485b7aef312c21800deef121f1e76426a00665e5c4479674322d4f75edadd46debd5cd992f6ed090689d0585ff075ec9e99ad690c3395bc4b313370b38ef355acdadcd122975b12c85ea5db8c6deb4aab71808dcb408fe3d1e7690c43d37b4ce6cc0166fa7daa",
+        vk_ic0: "2ec191d51bd4ac7cd65cb3dd2decfa4e56c4f167bbc40e2c9e1ca728f9bc5b0e2ed1c82319dc554aea5ff2ca05d6f4d4d61e8f059a8c05d4b4faabae5128a437",
+        vk_ic1: "2f19db8f03b6b5896abc6989273371b14833356f45c12685e57bc292eccc53570cb629e551df179f73b9f3391946bad29739af8b808c80b0f057af45aea59849"
+      },
+      process_qv_vkey: {
         vk_alpha1: "2d4d9aa7e302d9df41749d5507949d05dbea33fbb16c643b22f599a2be6df2e214bedd503c37ceb061d8ec60209fe345ce89830a19230301f076caff004d1926",
         vk_beta_2: "0967032fcbf776d1afc985f88877f182d38480a653f2decaa9794cbc3bf3060c0e187847ad4c798374d0d6732bf501847dd68bc0e071241e0213bc7fc13db7ab304cfbd1e08a704a99f5e847d93f8c3caafddec46b7a0d379da69a4d112346a71739c1b1a457a8c7313123d24d2f9192f896b7c63eea05a9d57f06547ad0cec8",
         vk_gamma_2: "198e9393920d483a7260bfb731fb5d25f1aa493335a9e71297e485b7aef312c21800deef121f1e76426a00665e5c4479674322d4f75edadd46debd5cd992f6ed090689d0585ff075ec9e99ad690c3395bc4b313370b38ef355acdadcd122975b12c85ea5db8c6deb4aab71808dcb408fe3d1e7690c43d37b4ce6cc0166fa7daa",
@@ -3574,7 +3590,7 @@ var CIRCUIT_INFO = {
         vk_ic0: "1832600210a459fe61d971081d4baa1a1add23f87c8a8dc4042cd5cf6c6fdf8e3018489aec30d9deb26629e05965a3a7e038be58ce10c854cb7e1071f2708aad",
         vk_ic1: "0274a24117a799333754d646e35f37292e7ca9984fb8781211504b158d69d2c422aa99651ca207c77084988b16ef363664b9cf36071f7131dcc10b98ea27d7f6"
       },
-      tally_vkey: {
+      tally_qv_vkey: {
         vk_alpha1: "2d4d9aa7e302d9df41749d5507949d05dbea33fbb16c643b22f599a2be6df2e214bedd503c37ceb061d8ec60209fe345ce89830a19230301f076caff004d1926",
         vk_beta_2: "0967032fcbf776d1afc985f88877f182d38480a653f2decaa9794cbc3bf3060c0e187847ad4c798374d0d6732bf501847dd68bc0e071241e0213bc7fc13db7ab304cfbd1e08a704a99f5e847d93f8c3caafddec46b7a0d379da69a4d112346a71739c1b1a457a8c7313123d24d2f9192f896b7c63eea05a9d57f06547ad0cec8",
         vk_gamma_2: "198e9393920d483a7260bfb731fb5d25f1aa493335a9e71297e485b7aef312c21800deef121f1e76426a00665e5c4479674322d4f75edadd46debd5cd992f6ed090689d0585ff075ec9e99ad690c3395bc4b313370b38ef355acdadcd122975b12c85ea5db8c6deb4aab71808dcb408fe3d1e7690c43d37b4ce6cc0166fa7daa",
@@ -3662,8 +3678,13 @@ function getContractParams(type, circuitType, proofSystem, maxVoter, maxOption)
   } else if (Number(maxVoter) <= 1953125 && Number(maxOption) <= 125) {
     parameters = CIRCUIT_INFO["9-4-3-625"].parameter;
     if (proofSystem === "groth16" /* GROTH16 */) {
-      groth16ProcessVkey = CIRCUIT_INFO["9-4-3-625"]["groth16"].process_vkey;
-      groth16TallyVkey = CIRCUIT_INFO["9-4-3-625"]["groth16"].tally_vkey;
+      if (circuitType === "0" /* IP1V */) {
+        groth16ProcessVkey = CIRCUIT_INFO["9-4-3-625"]["groth16"].process_1p1v_vkey;
+        groth16TallyVkey = CIRCUIT_INFO["9-4-3-625"]["groth16"].tally_1p1v_vkey;
+      } else if (circuitType === "1" /* QV */) {
+        groth16ProcessVkey = CIRCUIT_INFO["9-4-3-625"]["groth16"].process_qv_vkey;
+        groth16TallyVkey = CIRCUIT_INFO["9-4-3-625"]["groth16"].tally_qv_vkey;
+      }
     } else if (proofSystem === "plonk" /* PLONK */) {
       throw new Error("PLONK is not supported for MACI-9");
     }
@@ -3708,12 +3729,16 @@ var Contract = class {
     rpcEndpoint,
     registryAddress,
     maciCodeId,
-    oracleCodeId
+    oracleCodeId,
+    feegrantOperator,
+    whitelistBackendPubkey
   }) {
     this.rpcEndpoint = rpcEndpoint;
     this.registryAddress = registryAddress;
     this.maciCodeId = maciCodeId;
     this.oracleCodeId = oracleCodeId;
+    this.feegrantOperator = feegrantOperator;
+    this.whitelistBackendPubkey = whitelistBackendPubkey;
   }
   async createAMaciRound({
     signer,
@@ -3845,11 +3870,9 @@ var Contract = class {
     maxVoter,
     maxOption,
     circuitType,
-    whitelistBackendPubkey,
     whitelistEcosystem,
     whitelistSnapshotHeight,
-    whitelistVotingPowerArgs,
-    feegrantOperator
+    whitelistVotingPowerArgs
   }) {
     const start_time = (startVoting.getTime() * 1e6).toString();
     const end_time = (endVoting.getTime() * 1e6).toString();
@@ -3890,14 +3913,14 @@ var Contract = class {
         plonk_process_vkey: plonkProcessVkey,
         plonk_tally_vkey: plonkTallyVkey,
         max_vote_options: maxOption,
-        whitelist_backend_pubkey: whitelistBackendPubkey,
+        whitelist_backend_pubkey: this.whitelistBackendPubkey,
         whitelist_ecosystem: whitelistEcosystem,
         whitelist_snapshot_height: whitelistSnapshotHeight,
         whitelist_voting_power_args: whitelistVotingPowerArgs,
         circuit_type: maciVoteType,
         certification_system: maciCertSystem,
         qtr_lib: QTR_LIB,
-        feegrant_operator: feegrantOperator
+        feegrant_operator: this.feegrantOperator
       },
       "[Oracle MACI]" + title,
       "auto"
@@ -3974,7 +3997,9 @@ var MaciClient2 = class {
     maciCodeId,
     oracleCodeId,
     customFetch,
-    defaultOptions
+    defaultOptions,
+    feegrantOperator,
+    whitelistBackendPubkey
   }) {
     const defaultParams = getDefaultParams(network);
     this.rpcEndpoint = rpcEndpoint || defaultParams.rpcEndpoint;
@@ -3983,6 +4008,8 @@ var MaciClient2 = class {
     this.registryAddress = registryAddress || defaultParams.registryAddress;
     this.maciCodeId = maciCodeId || defaultParams.maciCodeId;
     this.oracleCodeId = oracleCodeId || defaultParams.oracleCodeId;
+    this.feegrantOperator = feegrantOperator || defaultParams.oracleFeegrantOperator;
+    this.whitelistBackendPubkey = whitelistBackendPubkey || defaultParams.oracleWhitelistBackendPubkey;
     this.http = new Http(
       this.apiEndpoint,
       this.restEndpoint,
@@ -3999,7 +4026,9 @@ var MaciClient2 = class {
       rpcEndpoint: this.rpcEndpoint,
       registryAddress: this.registryAddress,
       maciCodeId: this.maciCodeId,
-      oracleCodeId: this.oracleCodeId
+      oracleCodeId: this.oracleCodeId,
+      feegrantOperator: this.feegrantOperator,
+      whitelistBackendPubkey: this.whitelistBackendPubkey
     });
   }
   async oracleMaciClient({