@vocdoni/davinci-sdk 0.0.3 → 0.0.5

package/README.md

@@ -549,6 +549,27 @@ if (hasVoted) {
 }
 ```
 
+#### Checking if Address is Able to Vote
+
+Get participant information including voting weight for an address:
+
+```typescript
+const participantInfo = await sdk.isAddressAbleToVote(processId, voterAddress);
+
+console.log('Address:', participantInfo.key);
+console.log('Voting weight:', participantInfo.weight);
+
+// Use this to verify voter eligibility before submitting a vote
+if (participantInfo) {
+  console.log(`Address ${participantInfo.key} is eligible with weight ${participantInfo.weight}`);
+}
+```
+
+This method is useful for:
+- Verifying voter eligibility before vote submission
+- Displaying voting power/weight to users
+- Building voter dashboards and analytics
+
 ## 💡 Examples
 
 ### Complete Voting Flow

package/dist/contracts.d.ts

@@ -293,9 +293,8 @@ type ProcessStatusChangedCallback = EntityCallback<[string, bigint, bigint]>;
  * @param processID - The process ID
  * @param root - The new census root
  * @param uri - The new census URI
- * @param maxVotes - The maximum number of votes
  */
-type ProcessCensusUpdatedCallback = EntityCallback<[string, string, string, bigint]>;
+type ProcessCensusUpdatedCallback = EntityCallback<[string, string, string]>;
 /**
  * Callback for when a process duration changes.
  * @param processID - The process ID
@@ -372,7 +371,6 @@ interface BallotMode {
 }
 interface CensusData {
     censusOrigin: CensusOrigin;
-    maxVotes: string;
     censusRoot: string;
     censusURI: string;
 }
@@ -420,6 +418,7 @@ interface CSPSignOutput {
     censusOrigin: CensusOrigin;
     root: string;
     address: string;
+    weight: string;
     processId: string;
     publicKey: string;
     signature: string;
@@ -430,7 +429,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;
@@ -471,8 +470,8 @@ declare class ProcessRegistryService extends SmartContractService {
         latestStateRoot: bigint;
         startTime: bigint;
         duration: bigint;
-        voteCount: bigint;
-        voteOverwriteCount: bigint;
+        votersCount: bigint;
+        overwrittenVotesCount: bigint;
         creationBlock: bigint;
         batchNumber: bigint;
         metadataURI: string;

package/dist/index.d.ts

@@ -194,6 +194,8 @@ interface PublishCensusResponse {
     publishedAt: string;
     /** The constructed URI for accessing the census */
     uri: string;
+    /** The size of the census. */
+    size: number;
 }
 interface Snapshot {
     /** ISO timestamp of the snapshot date. */
@@ -263,11 +265,11 @@ interface HealthResponse {
 declare class VocdoniCensusService extends BaseService {
     constructor(baseURL: string);
     /**
-     * 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: string): string;
+    getCensusUri(relativePath: string): string;
     createCensus(): Promise<string>;
     addParticipants(censusId: string, participants: CensusParticipant$1[]): Promise<void>;
     getParticipants(censusId: string): Promise<CensusParticipant$1[]>;
@@ -457,7 +459,6 @@ interface BallotMode {
 }
 interface CensusData {
     censusOrigin: CensusOrigin;
-    maxVotes: string;
     censusRoot: string;
     censusURI: string;
 }
@@ -468,14 +469,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;
@@ -489,36 +489,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;
@@ -548,8 +526,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. */
@@ -615,6 +593,10 @@ interface WorkerStats {
 interface WorkersResponse {
     workers: WorkerStats[];
 }
+interface ParticipantInfoResponse {
+    key: string;
+    weight: string;
+}
 
 declare class VocdoniSequencerService extends BaseService {
     constructor(baseURL: string);
@@ -625,6 +607,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>;
@@ -864,9 +848,8 @@ type ProcessStatusChangedCallback = EntityCallback<[string, bigint, bigint]>;
  * @param processID - The process ID
  * @param root - The new census root
  * @param uri - The new census URI
- * @param maxVotes - The maximum number of votes
  */
-type ProcessCensusUpdatedCallback = EntityCallback<[string, string, string, bigint]>;
+type ProcessCensusUpdatedCallback = EntityCallback<[string, string, string]>;
 /**
  * Callback for when a process duration changes.
  * @param processID - The process ID
@@ -915,8 +898,8 @@ declare class ProcessRegistryService extends SmartContractService {
         latestStateRoot: bigint;
         startTime: bigint;
         duration: bigint;
-        voteCount: bigint;
-        voteOverwriteCount: bigint;
+        votersCount: bigint;
+        overwrittenVotesCount: bigint;
         creationBlock: bigint;
         batchNumber: bigint;
         metadataURI: string;
@@ -1094,6 +1077,7 @@ interface CSPSignOutput {
     censusOrigin: CensusOrigin;
     root: string;
     address: string;
+    weight: string;
     processId: string;
     publicKey: string;
     signature: string;
@@ -1104,7 +1088,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;
@@ -1164,22 +1148,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)
@@ -1204,27 +1190,29 @@ interface BaseProcess {
         type: CensusOrigin;
         /** Census root */
         root: string;
-        /** Census size */
-        size: number;
         /** Census URI */
         uri: string;
     };
     /** Ballot configuration */
     ballot: BallotMode;
     /** Election questions and choices (required) */
-    questions: Array<{
+    questions: Array<ProcessQuestion>;
+}
+/**
+ * Question structure used in process configuration and metadata
+ */
+type ProcessQuestion = {
+    title: string;
+    description?: string;
+    choices: Array<{
         title: string;
-        description?: string;
-        choices: Array<{
-            title: string;
-            value: number;
-        }>;
+        value: number;
     }>;
-}
+};
 /**
- * Configuration for creating a process
+ * Base configuration shared by both process creation variants
  */
-interface ProcessConfig extends Omit<BaseProcess, 'census'> {
+interface BaseProcessConfig {
     /**
      * Census - either a Census object (PlainCensus, WeightedCensus, CspCensus, PublishedCensus)
      * or manual configuration. If a Census object is provided and not published, it will be
@@ -1240,6 +1228,8 @@ interface ProcessConfig extends Omit<BaseProcess, 'census'> {
         /** Census URI */
         uri: string;
     };
+    /** Ballot configuration */
+    ballot: BallotMode;
     /** Process timing - use either duration-based or date-based configuration */
     timing: {
         /** Start date/time (Date object, ISO string, or Unix timestamp, default: now + 60 seconds) */
@@ -1250,6 +1240,31 @@ interface ProcessConfig extends Omit<BaseProcess, 'census'> {
         endDate?: Date | string | number;
     };
 }
+/**
+ * Process configuration with metadata fields (title, description, questions)
+ * The metadata will be created and uploaded automatically
+ */
+interface ProcessConfigWithMetadata extends BaseProcessConfig {
+    /** Process title */
+    title: string;
+    /** Process description (optional) */
+    description?: string;
+    /** Election questions and choices (at least one required) */
+    questions: [ProcessQuestion, ...ProcessQuestion[]];
+}
+/**
+ * Process configuration with a pre-existing metadata URI
+ * No metadata upload will occur - the provided URI will be used directly
+ */
+interface ProcessConfigWithMetadataUri extends BaseProcessConfig {
+    /** Pre-existing metadata URI to use instead of uploading new metadata */
+    metadataUri: string;
+}
+/**
+ * Configuration for creating a process
+ * Use either metadata fields (title, questions) or a pre-existing metadataUri
+ */
+type ProcessConfig = ProcessConfigWithMetadata | ProcessConfigWithMetadataUri;
 /**
  * Result of process creation
  */
@@ -1280,9 +1295,9 @@ interface ProcessInfo extends BaseProcess {
     /** Process results (array of BigInt values) */
     result: bigint[];
     /** Number of votes cast */
-    voteCount: number;
+    votersCount: number;
     /** Number of vote overwrites */
-    voteOverwriteCount: number;
+    overwrittenVotesCount: number;
     /** Metadata URI */
     metadataURI: string;
     /** Raw contract data (for advanced users) */
@@ -1379,7 +1394,8 @@ declare class ProcessOrchestrationService {
      */
     private dateToUnixTimestamp;
     /**
-     * Creates metadata from the simplified configuration
+     * Creates metadata from the configuration with metadata fields
+     * This method should only be called with ProcessConfigWithMetadata
      */
     private createMetadata;
     /**
@@ -2178,6 +2194,42 @@ declare class DavinciSDK {
      * ```
      */
     hasAddressVoted(processId: string, address: string): Promise<boolean>;
+    /**
+     * 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");
+     * }
+     * ```
+     */
+    isAddressAbleToVote(processId: string, address: string): Promise<boolean>;
+    /**
+     * 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);
+     * ```
+     */
+    getAddressWeight(processId: string, address: string): Promise<string>;
     /**
      * Watch vote status changes in real-time using an async generator.
      * This method yields each status change as it happens, perfect for showing
@@ -2507,4 +2559,4 @@ declare class DavinciSDK {
 }
 
 export { BaseService, Census, CensusOrchestrator, CensusOrigin, CensusType, CircomProof, ContractServiceError, CspCensus, DavinciCrypto, DavinciSDK, ElectionMetadataTemplate, ElectionResultsTypeNames, OrganizationAdministratorError, OrganizationCreateError, OrganizationDeleteError, OrganizationRegistryService, OrganizationUpdateError, PlainCensus, ProcessCensusError, ProcessCreateError, ProcessDurationError, ProcessOrchestrationService, ProcessRegistryService, ProcessResultError, ProcessStateTransitionError, ProcessStatus, ProcessStatusError, PublishedCensus, SmartContractService, TxStatus, VocdoniApiService, VocdoniCensusService, VocdoniSequencerService, VoteOrchestrationService, VoteStatus, WeightedCensus, assertCSPCensusProof, assertMerkleCensusProof, createProcessSignatureMessage, getElectionMetadataTemplate, isCSPCensusProof, isMerkleCensusProof, signProcessCreation, validateProcessId };
-export type { AbstainProperties, AnyJson, ApiError, ApprovalProperties, BallotMode, BaseCensusProof, BaseProcess, BudgetProperties, CSPCensusProof, CSPCensusProofProvider, CSPSignOutput, CensusData, CensusParticipant$1 as CensusParticipant, CensusProof, CensusProviders, CensusSizeResponse, Choice, ChoiceProperties, CircomProofOptions, CreateProcessRequest, CreateProcessResponse, CustomMeta, DavinciCryptoCiphertext, DavinciCryptoInputs, DavinciCryptoOptions, DavinciCryptoOutput, DavinciSDKConfig, ElectionMetadata, ElectionResultsType, EncryptionKey, EntityCallback, GetProcessResponse, Groth16Proof, HealthResponse, IChoice, IQuestion, InfoResponse, JsonArray, JsonMap, ListProcessesResponse, MerkleCensusProof, MerkleCensusProofProvider, MultiLanguage, OrganizationAdministratorAddedCallback, OrganizationAdministratorRemovedCallback, OrganizationCreatedCallback, OrganizationInfo, OrganizationUpdatedCallback, ProcessCensusUpdatedCallback, ProcessConfig, ProcessCreatedCallback, ProcessCreationResult, ProcessDurationChangedCallback, ProcessInfo, ProcessResultsSetCallback, ProcessStateRootUpdatedCallback, ProcessStatusChangedCallback, ProofInputs, ProtocolVersion, PublishCensusResponse, QuadraticProperties, Question, SequencerStats, Snapshot, SnapshotsQueryParams, SnapshotsResponse, TxStatusEvent, VocdoniApiServiceConfig, VoteBallot, VoteCiphertext, VoteConfig, VoteOrchestrationConfig, VoteProof, VoteRequest, VoteResult, VoteStatusInfo, VoteStatusResponse, WeightedParticipant, WorkerStats, WorkersResponse };
+export type { AbstainProperties, AnyJson, ApiError, ApprovalProperties, BallotMode, BaseCensusProof, BaseProcess, BudgetProperties, CSPCensusProof, CSPCensusProofProvider, CSPSignOutput, CensusData, CensusParticipant$1 as CensusParticipant, CensusProof, CensusProviders, CensusSizeResponse, Choice, ChoiceProperties, CircomProofOptions, CreateProcessRequest, CreateProcessResponse, CustomMeta, DavinciCryptoCiphertext, DavinciCryptoInputs, DavinciCryptoOptions, DavinciCryptoOutput, DavinciSDKConfig, ElectionMetadata, ElectionResultsType, EncryptionKey, EntityCallback, GetProcessResponse, Groth16Proof, HealthResponse, IChoice, IQuestion, InfoResponse, JsonArray, JsonMap, ListProcessesResponse, MerkleCensusProof, MerkleCensusProofProvider, MultiLanguage, OrganizationAdministratorAddedCallback, OrganizationAdministratorRemovedCallback, OrganizationCreatedCallback, OrganizationInfo, OrganizationUpdatedCallback, ParticipantInfoResponse, ProcessCensusUpdatedCallback, ProcessConfig, ProcessConfigWithMetadata, ProcessConfigWithMetadataUri, ProcessCreatedCallback, ProcessCreationResult, ProcessDurationChangedCallback, ProcessInfo, ProcessQuestion, ProcessResultsSetCallback, ProcessStateRootUpdatedCallback, ProcessStatusChangedCallback, ProofInputs, ProtocolVersion, PublishCensusResponse, QuadraticProperties, Question, SequencerStats, Snapshot, SnapshotsQueryParams, SnapshotsResponse, TxStatusEvent, VocdoniApiServiceConfig, VoteBallot, VoteCiphertext, VoteConfig, VoteOrchestrationConfig, VoteProof, VoteRequest, VoteResult, VoteStatusInfo, VoteStatusResponse, WeightedParticipant, WorkerStats, WorkersResponse };