@vocdoni/data-models

@vocdoni/data-models

@vocdoni/data-models contains the data model definitions for the dvote-js library

Installation

Use npm to install @vocdoni/data-models.

npm install @vocdoni/data-models

Usage

Account Backup

import { AccountBackup } from "@vocdoni/data-models"

const wallet = Wallet.createRandom()
const originalPassphrase = Math.random().toString()
const encryptedMnemonic = AccountBackup.encryptPayload(wallet.mnemonic.phrase, originalPassphrase)

const backupBytes = AccountBackup.create({
  backupName: "Hello world",
  questionIds: [1, 2, 3],
  answers: ["Answer 1", "Answer 2", "Answer 3"],
  accountWallet: {
    encryptedMnemonic,
    authMethod: Wallet_AuthMethod.PASS,
    hdPath: wallet.mnemonic.path,
    locale: wallet.mnemonic.locale
  },
  currentPassphrase: originalPassphrase
})
const decryptedPassphrase = AccountBackup.recoverPassphrase(backupBytes, ["Answer 1", "Answer 2", "Answer 3"])

Entity Metadata

import { checkValidEntityMetadata } from "@vocdoni/data-models"

checkValidEntityMetadata({})
// throws an Error

Process Metadata

import { checkValidProcessMetadata } from "@vocdoni/data-models"

checkValidProcessMetadata({})
// throws an Error

Testing

To execute library tests just run

npm run test

Changelog

1.15.0

• Adding support for Anonymous voting, using ZK Snarks
• Census.addClaim, Census.addClaimBulk and Census.registerVoterKey now don't receive the isDigested parameter.
• generateProof now returns the siblings and the weight
• IProofArbo, IProofCA and IProofEVM now require a weight bigint
• Adding VotingApi.registerVotingKey
• Implementing Voting.packageAnonymousEnvelope
• Adding Voting.getAnonymousVoteNullifier()
• [Breaking]
  • VotingApi.getProcessId, VotingApi.packageAnonymousEnvelope, VotingApi.packageVoteContent, VotingApi.packageSignedProof and VotingApi.getSignedVoteNullifier are moved from VotingApi to the Voting namespace
• CAbundleprotobuf is now exported from @vocdoni/data-models as CAbundle