@vocdoni/davinci-sdk 0.0.3 → 0.0.5

package/dist/index.umd.js

@@ -88,12 +88,12 @@
       super(baseURL);
     }
     /**
-     * Constructs the URI for accessing a census by its root
-     * @param censusRoot - The census root (hex-prefixed)
+     * Constructs the URI for accessing a census
+     * @param relativePath - The relative path
      * @returns The constructed URI for the census
      */
-    getCensusUri(censusRoot) {
-      return `${this.axios.defaults.baseURL}/censuses/${censusRoot}`;
+    getCensusUri(relativePath) {
+      return `${this.axios.defaults.baseURL}${relativePath}`;
     }
     createCensus() {
       return this.request({
@@ -162,10 +162,13 @@
       return this.request({
         method: "POST",
         url: `/censuses/${censusId}/publish`
-      }).then((response) => ({
-        ...response,
-        uri: this.getCensusUri(response.root)
-      }));
+      }).then((apiResponse) => {
+        const { censusUri, ...responseWithoutCensusUri } = apiResponse;
+        return {
+          ...responseWithoutCensusUri,
+          uri: this.getCensusUri(censusUri)
+        };
+      });
     }
     // BigQuery endpoints
     getSnapshots(params) {
@@ -195,13 +198,13 @@
     return CensusOrigin2;
   })(CensusOrigin || {});
   function isBaseCensusProof(proof) {
-    return !!proof && typeof proof.root === "string" && typeof proof.address === "string" && typeof proof.weight === "string" && typeof proof.censusOrigin === "number" && Object.values(CensusOrigin).includes(proof.censusOrigin);
+    return !!proof && typeof proof.root === "string" && typeof proof.address === "string" && typeof proof.censusOrigin === "number" && Object.values(CensusOrigin).includes(proof.censusOrigin);
   }
   function isMerkleCensusProof(proof) {
-    return isBaseCensusProof(proof) && proof.censusOrigin === 1 /* CensusOriginMerkleTree */ && typeof proof.value === "string" && typeof proof.siblings === "string";
+    return isBaseCensusProof(proof) && proof.censusOrigin === 1 /* CensusOriginMerkleTree */ && typeof proof.weight === "string" && typeof proof.value === "string" && typeof proof.siblings === "string";
   }
   function isCSPCensusProof(proof) {
-    return isBaseCensusProof(proof) && proof.censusOrigin === 2 /* CensusOriginCSP */ && typeof proof.processId === "string" && typeof proof.publicKey === "string" && typeof proof.signature === "string";
+    return isBaseCensusProof(proof) && proof.censusOrigin === 2 /* CensusOriginCSP */ && typeof proof.weight === "string" && typeof proof.processId === "string" && typeof proof.publicKey === "string" && typeof proof.signature === "string";
   }
   function assertMerkleCensusProof(proof) {
     if (!isMerkleCensusProof(proof)) {
@@ -561,6 +564,27 @@
         throw error;
       }
     }
+    async getAddressWeight(processId, address) {
+      const participant = await this.request({
+        method: "GET",
+        url: `/processes/${processId}/participants/${address}`
+      });
+      return participant.weight;
+    }
+    async isAddressAbleToVote(processId, address) {
+      try {
+        await this.request({
+          method: "GET",
+          url: `/processes/${processId}/participants/${address}`
+        });
+        return true;
+      } catch (error) {
+        if (error?.code === 40001) {
+          return false;
+        }
+        throw error;
+      }
+    }
     getInfo() {
       return this.request({
         method: "GET",
@@ -984,7 +1008,6 @@
     newProcess(status, startTime, duration, ballotMode, census, metadata, encryptionKey, initStateRoot) {
       const contractCensus = {
         censusOrigin: BigInt(census.censusOrigin),
-        maxVotes: BigInt(census.maxVotes),
         censusRoot: census.censusRoot,
         censusURI: census.censusURI
       };
@@ -1015,7 +1038,6 @@
     setProcessCensus(processID, census) {
       const contractCensus = {
         censusOrigin: BigInt(census.censusOrigin),
-        maxVotes: BigInt(census.maxVotes),
         censusRoot: census.censusRoot,
         censusURI: census.censusURI
       };
@@ -1184,7 +1206,6 @@
       const census = {
         type: Number(rawProcess.census.censusOrigin),
         root: rawProcess.census.censusRoot,
-        size: Number(rawProcess.census.maxVotes),
         uri: rawProcess.census.censusURI || ""
       };
       const ballot = {
@@ -1199,11 +1220,11 @@
       };
       return {
         processId,
-        title,
+        title: title || "",
         description,
         census,
         ballot,
-        questions,
+        questions: questions || [],
         status: Number(rawProcess.status),
         creator: rawProcess.organizationId,
         startDate: new Date(startTime * 1e3),
@@ -1211,8 +1232,8 @@
         duration,
         timeRemaining,
         result: rawProcess.result,
-        voteCount: Number(rawProcess.voteCount),
-        voteOverwriteCount: Number(rawProcess.voteOverwriteCount),
+        votersCount: Number(rawProcess.votersCount),
+        overwrittenVotesCount: Number(rawProcess.overwrittenVotesCount),
         metadataURI: rawProcess.metadataURI,
         raw: rawProcess
       };
@@ -1332,20 +1353,27 @@
       const censusConfig = await this.handleCensus(config.census);
       const censusRoot = censusConfig.root;
       const ballotMode = config.ballot;
-      const metadata = this.createMetadata(config);
-      const metadataHash = await this.apiService.sequencer.pushMetadata(metadata);
-      const metadataUri = this.apiService.sequencer.getMetadataUrl(metadataHash);
+      let metadataUri;
+      if ("metadataUri" in config) {
+        metadataUri = config.metadataUri;
+      } else {
+        const metadata = this.createMetadata(config);
+        const metadataHash = await this.apiService.sequencer.pushMetadata(metadata);
+        metadataUri = this.apiService.sequencer.getMetadataUrl(metadataHash);
+      }
       const signature = await signProcessCreation(processId, this.signer);
       const sequencerResult = await this.apiService.sequencer.createProcess({
         processId,
-        censusRoot,
+        census: {
+          censusOrigin: censusConfig.type,
+          censusRoot,
+          censusURI: censusConfig.uri
+        },
         ballotMode,
-        signature,
-        censusOrigin: censusConfig.type
+        signature
       });
       const census = {
         censusOrigin: censusConfig.type,
-        maxVotes: censusConfig.size.toString(),
         censusRoot,
         censusURI: censusConfig.uri
       };
@@ -1414,15 +1442,13 @@
       throw new Error("Invalid date format. Use Date object, ISO string, or Unix timestamp.");
     }
     /**
-     * Creates metadata from the simplified configuration
+     * Creates metadata from the configuration with metadata fields
+     * This method should only be called with ProcessConfigWithMetadata
      */
     createMetadata(config) {
       const metadata = getElectionMetadataTemplate();
       metadata.title.default = config.title;
       metadata.description.default = config.description || "";
-      if (!config.questions || config.questions.length === 0) {
-        throw new Error("Questions are required. Please provide at least one question with choices.");
-      }
       metadata.questions = config.questions.map((q) => ({
         title: { default: q.title },
         description: { default: q.description || "" },
@@ -1887,16 +1913,19 @@
       );
       const { proof } = await this.generateZkProof(circomInputs);
       const signature = await this.signVote(voteId);
-      await this.submitVoteRequest({
+      const voteRequest = {
         processId: config.processId,
-        censusProof,
         ballot: cryptoOutput.ballot,
         ballotProof: proof,
         ballotInputsHash: cryptoOutput.ballotInputsHash,
         address: voterAddress,
         signature,
         voteId
-      });
+      };
+      if (process.census.censusOrigin === CensusOrigin.CensusOriginCSP) {
+        voteRequest.censusProof = censusProof;
+      }
+      await this.submitVoteRequest(voteRequest);
       const status = await this.apiService.sequencer.getVoteStatus(config.processId, voteId);
       return {
         voteId,
@@ -2018,9 +2047,15 @@
           assertMerkleCensusProof(proof);
           return proof;
         } else {
-          const proof = await this.apiService.census.getCensusProof(censusRoot, voterAddress);
-          assertMerkleCensusProof(proof);
-          return proof;
+          const weight = await this.apiService.sequencer.getAddressWeight(processId, voterAddress);
+          return {
+            root: censusRoot,
+            address: voterAddress,
+            weight,
+            censusOrigin: CensusOrigin.CensusOriginMerkleTree,
+            value: "",
+            siblings: ""
+          };
         }
       }
       if (censusOrigin === CensusOrigin.CensusOriginCSP) {
@@ -2340,14 +2375,15 @@
      * @param privKey - The private key in hex format
      * @param processId - The process ID in hex format
      * @param address - The address in hex format
+     * @param weight - The vote weight as a decimal string
      * @returns The CSP proof as a parsed JSON object
      * @throws if called before `await init()`, or if Go returns an error
      */
-    async cspSign(censusOrigin, privKey, processId, address) {
+    async cspSign(censusOrigin, privKey, processId, address, weight) {
       if (!this.initialized) {
         throw new Error("DavinciCrypto not initialized \u2014 call `await init()` first");
       }
-      const raw = globalThis.DavinciCrypto.cspSign(censusOrigin, privKey, processId, address);
+      const raw = globalThis.DavinciCrypto.cspSign(censusOrigin, privKey, processId, address, weight);
       if (raw.error) {
         throw new Error(`Go/WASM cspSign error: ${raw.error}`);
       }
@@ -2361,13 +2397,14 @@
      * @param censusOrigin - The census origin type (e.g., CensusOrigin.CensusOriginCSP)
      * @param root - The census root
      * @param address - The address
+     * @param weight - The vote weight as a decimal string
      * @param processId - The process ID
      * @param publicKey - The public key
      * @param signature - The signature
      * @returns The verification result
      * @throws if called before `await init()`, or if Go returns an error
      */
-    async cspVerify(censusOrigin, root, address, processId, publicKey, signature) {
+    async cspVerify(censusOrigin, root, address, weight, processId, publicKey, signature) {
       if (!this.initialized) {
         throw new Error("DavinciCrypto not initialized \u2014 call `await init()` first");
       }
@@ -2375,6 +2412,7 @@
         censusOrigin,
         root,
         address,
+        weight,
         processId,
         publicKey,
         signature
@@ -2826,6 +2864,56 @@
       }
       return this.voteOrchestrator.hasAddressVoted(processId, address);
     }
+    /**
+     * Check if an address is able to vote in a process (i.e., is in the census).
+     *
+     * Does NOT require a provider - uses API calls only.
+     *
+     * @param processId - The process ID
+     * @param address - The voter's address
+     * @returns Promise resolving to boolean indicating if the address can vote
+     *
+     * @example
+     * ```typescript
+     * const canVote = await sdk.isAddressAbleToVote(processId, "0x1234567890abcdef...");
+     * if (canVote) {
+     *   console.log("This address can vote");
+     * } else {
+     *   console.log("This address is not in the census");
+     * }
+     * ```
+     */
+    async isAddressAbleToVote(processId, address) {
+      if (!this.initialized) {
+        throw new Error(
+          "SDK must be initialized before checking if address can vote. Call sdk.init() first."
+        );
+      }
+      return this.apiService.sequencer.isAddressAbleToVote(processId, address);
+    }
+    /**
+     * Get the voting weight for an address in a process.
+     *
+     * Does NOT require a provider - uses API calls only.
+     *
+     * @param processId - The process ID
+     * @param address - The voter's address
+     * @returns Promise resolving to the address weight as a string
+     *
+     * @example
+     * ```typescript
+     * const weight = await sdk.getAddressWeight(processId, "0x1234567890abcdef...");
+     * console.log("Address weight:", weight);
+     * ```
+     */
+    async getAddressWeight(processId, address) {
+      if (!this.initialized) {
+        throw new Error(
+          "SDK must be initialized before getting address weight. Call sdk.init() first."
+        );
+      }
+      return this.apiService.sequencer.getAddressWeight(processId, address);
+    }
     /**
      * Watch vote status changes in real-time using an async generator.
      * This method yields each status change as it happens, perfect for showing

package/dist/sequencer.d.ts

@@ -144,7 +144,6 @@ interface BallotMode {
 }
 interface CensusData {
     censusOrigin: CensusOrigin;
-    maxVotes: string;
     censusRoot: string;
     censusURI: string;
 }
@@ -155,14 +154,13 @@ interface EncryptionKey {
 
 interface CreateProcessRequest {
     processId: string;
-    censusRoot: string;
+    census: {
+        censusOrigin: CensusOrigin;
+        censusRoot: string;
+        censusURI: string;
+    };
     ballotMode: BallotMode;
     signature: string;
-    /**
-     * The censusOrigin specifies the origin type of the census used in the request.
-     * This attribute allows the API to determine how the census data should be processed or verified.
-     */
-    censusOrigin: CensusOrigin;
 }
 interface CreateProcessResponse {
     processId: string;
@@ -176,36 +174,14 @@ interface GetProcessResponse {
     organizationId: string;
     encryptionKey: EncryptionKey;
     stateRoot: string;
-    result: string[];
-    startTime: number;
+    result: string[] | null;
+    startTime: string;
     duration: number;
     metadataURI: string;
     ballotMode: BallotMode;
     census: CensusData;
-    metadata: {
-        title: Record<string, string>;
-        description: Record<string, string>;
-        media: {
-            header: string;
-            logo: string;
-        };
-        questions: {
-            title: Record<string, string>;
-            description: Record<string, string>;
-            choices: {
-                title: Record<string, string>;
-                value: number;
-                meta: Record<string, string>;
-            }[];
-            meta: Record<string, string>;
-        }[];
-        processType: {
-            name: string;
-            properties: Record<string, string>;
-        };
-    };
-    voteCount: string;
-    voteOverwrittenCount: string;
+    votersCount: string;
+    overwrittenVotesCount: string;
     isAcceptingVotes: boolean;
     sequencerStats: {
         stateTransitionCount: number;
@@ -235,8 +211,8 @@ interface VoteProof {
 interface VoteRequest {
     /** The `processId` you obtained when creating the process. */
     processId: string;
-    /** Your Merkle‐proof that you're in the census. */
-    censusProof: CensusProof;
+    /** Your census proof (only required for CSP, not for MerkleTree). */
+    censusProof?: CensusProof;
     /** Your encrypted ballot. */
     ballot: VoteBallot;
     /** The zkSNARK proof that the ballot is well‐formed. */
@@ -302,6 +278,10 @@ interface WorkerStats {
 interface WorkersResponse {
     workers: WorkerStats[];
 }
+interface ParticipantInfoResponse {
+    key: string;
+    weight: string;
+}
 
 /**
  * Creates the signature message for process creation.
@@ -421,6 +401,7 @@ interface CSPSignOutput {
     censusOrigin: CensusOrigin;
     root: string;
     address: string;
+    weight: string;
     processId: string;
     publicKey: string;
     signature: string;
@@ -431,7 +412,7 @@ interface RawResult<T = any> {
 }
 interface GoDavinciCryptoWasm {
     proofInputs(inputJson: string): RawResult<DavinciCryptoOutput>;
-    cspSign(censusOrigin: number, privKey: string, processId: string, address: string): RawResult<CSPSignOutput>;
+    cspSign(censusOrigin: number, privKey: string, processId: string, address: string, weight: string): RawResult<CSPSignOutput>;
     cspVerify(cspProof: string): RawResult<boolean>;
     cspCensusRoot(censusOrigin: number, privKey: string): RawResult<{
         root: string;
@@ -491,22 +472,24 @@ declare class DavinciCrypto {
      * @param privKey - The private key in hex format
      * @param processId - The process ID in hex format
      * @param address - The address in hex format
+     * @param weight - The vote weight as a decimal string
      * @returns The CSP proof as a parsed JSON object
      * @throws if called before `await init()`, or if Go returns an error
      */
-    cspSign(censusOrigin: CensusOrigin, privKey: string, processId: string, address: string): Promise<CSPSignOutput>;
+    cspSign(censusOrigin: CensusOrigin, privKey: string, processId: string, address: string, weight: string): Promise<CSPSignOutput>;
     /**
      * Verify a CSP (Credential Service Provider) proof.
      * @param censusOrigin - The census origin type (e.g., CensusOrigin.CensusOriginCSP)
      * @param root - The census root
      * @param address - The address
+     * @param weight - The vote weight as a decimal string
      * @param processId - The process ID
      * @param publicKey - The public key
      * @param signature - The signature
      * @returns The verification result
      * @throws if called before `await init()`, or if Go returns an error
      */
-    cspVerify(censusOrigin: CensusOrigin, root: string, address: string, processId: string, publicKey: string, signature: string): Promise<boolean>;
+    cspVerify(censusOrigin: CensusOrigin, root: string, address: string, weight: string, processId: string, publicKey: string, signature: string): Promise<boolean>;
     /**
      * Generate a CSP (Credential Service Provider) census root.
      * @param censusOrigin - The census origin type (e.g., CensusOrigin.CensusOriginCSP)
@@ -526,6 +509,8 @@ declare class VocdoniSequencerService extends BaseService {
     submitVote(vote: VoteRequest): Promise<void>;
     getVoteStatus(processId: string, voteId: string): Promise<VoteStatusResponse>;
     hasAddressVoted(processId: string, address: string): Promise<boolean>;
+    getAddressWeight(processId: string, address: string): Promise<string>;
+    isAddressAbleToVote(processId: string, address: string): Promise<boolean>;
     getInfo(): Promise<InfoResponse>;
     pushMetadata(metadata: ElectionMetadata): Promise<string>;
     getMetadata(hashOrUrl: string): Promise<ElectionMetadata>;
@@ -535,4 +520,4 @@ declare class VocdoniSequencerService extends BaseService {
 }
 
 export { CircomProof, DavinciCrypto, VocdoniSequencerService, VoteStatus, createProcessSignatureMessage, signProcessCreation, validateProcessId };
-export type { CSPSignOutput, CircomProofOptions, CreateProcessRequest, CreateProcessResponse, DavinciCryptoCiphertext, DavinciCryptoInputs, DavinciCryptoOptions, DavinciCryptoOutput, GetProcessResponse, Groth16Proof, InfoResponse, ListProcessesResponse, ProofInputs, SequencerStats, VoteBallot, VoteCiphertext, VoteProof, VoteRequest, VoteStatusResponse, WorkerStats, WorkersResponse };
+export type { CSPSignOutput, CircomProofOptions, CreateProcessRequest, CreateProcessResponse, DavinciCryptoCiphertext, DavinciCryptoInputs, DavinciCryptoOptions, DavinciCryptoOutput, GetProcessResponse, Groth16Proof, InfoResponse, ListProcessesResponse, ParticipantInfoResponse, ProofInputs, SequencerStats, VoteBallot, VoteCiphertext, VoteProof, VoteRequest, VoteStatusResponse, WorkerStats, WorkersResponse };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vocdoni/davinci-sdk",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -72,7 +72,7 @@
   },
   "dependencies": {
     "@ethereumjs/common": "^4.4.0",
-    "@vocdoni/davinci-contracts": "0.0.21",
+    "@vocdoni/davinci-contracts": "0.0.28",
     "axios": "^1.8.4",
     "ethers": "^6.7.1",
     "snarkjs": "^0.7.5"