@dorafactory/maci-sdk 0.0.4 → 0.0.5

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

@@ -3708,12 +3708,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 +3849,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 +3892,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 +3976,9 @@ var MaciClient2 = class {
     maciCodeId,
     oracleCodeId,
     customFetch,
-    defaultOptions
+    defaultOptions,
+    feegrantOperator,
+    whitelistBackendPubkey
   }) {
     const defaultParams = getDefaultParams(network);
     this.rpcEndpoint = rpcEndpoint || defaultParams.rpcEndpoint;
@@ -3983,6 +3987,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 +4005,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({