CHANGELOG.md

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

2.5.0 (2024-11-20)

Features

• contracts: add tally results (5d8a720)
• contracts: add total spent to tally (ac206f3)

Miscellaneous

• contracts: add struct for add tally results args (45eb28d)
• deps-dev: bump @types/node from 22.4.1 to 22.8.1 (#1873) (c1b9c0e)
• deps-dev: bump @types/node from 22.8.1 to 22.9.0 (0e11e5d)
• deps-dev: bump nyc from 17.0.0 to 17.1.0 (3dce47c)
• deps-dev: bump typescript from 5.5.4 to 5.6.3 (8058c5d)
• deps: bump ethers from 6.13.2 to 6.13.4 (b698a03)
• deps: bump hardhat from 2.22.8 to 2.22.13 (f8a139a)
• deps: bump snarkjs from 0.7.4 to 0.7.5 (5f5ffa6)

2.4.0 (2024-09-30)

Features

• scripts: added merkleproof gatekeeper to signup script and utils (#1823) (f5d7e6d)

Bug Fixes

• ensure nightly workflow use correct paths (#1814) (e0c81ac)

Miscellaneous

• deps-dev: bump @types/mocha from 10.0.7 to 10.0.8 (#1827) (4deae8b)
• deps-dev: bump @types/prompt from 1.1.8 to 1.1.9 (#1826) (52bf4b6)

2.3.0 (2024-09-05)

Miscellaneous

• ceremony: update ceremony tests to work with v2 params and keys (#1807) (6bf1ffb)
• get poll mode within sdk (#1800) (71545c1)

2.2.1 (2024-08-19)

Note: Version bump only for package maci-cli

2.2.0 (2024-08-19)

Features

• return voice credits on signup (d1b7e3d)

Miscellaneous

• deps-dev: bump @types/node from 22.1.0 to 22.2.0 (ac18985)
• deps-dev: bump @types/node from 22.2.0 to 22.4.1 (#1779) (4a929e0)
• deps-dev: bump mocha from 10.7.0 to 10.7.3 (6ba908f)
• deps: bump hardhat from 2.22.7 to 2.22.8 (#1755) (92b30af)

2.1.0 (2024-08-07)

Features

• sdk: get hats gatekeeper data (a06fa6b)

2.0.0 (2024-08-06)

⚠ BREAKING CHANGES

• topup: No more topups

Features

• add extractVkToFile function to cli command (346ebee)
• cli: add export from contracts, circuits for cli package (8f90c79)
• cli: add initial voice credits from signup event (0900e69)
• cli: add provider fallback for poll data sdk method (580b92e)
• cli: add publish batch method for cli sdk (843fe7e)
• cli: add sdk command to get eas gatekeeper data (#1701) (bd894d8)
• cli: add start block for signup event parsing (9657b6e)
• cli: return additional data from publish batch command (7271d5f)
• contracts: add new adapter for lowdb to support browser env (a3c2371)
• contracts: added message processor and tally addresses to the maci contract (#1715) (801b774)
• contracts: tally qv and non-qv optimisations (b0b7b38)
• contract: support qv and non-qv verification keys (a0cce8c)
• export extractVkToFile function (e65ca2e)
• export merge function and modify package version (#1584) (f6ae34a)
• export pubkey and update description of deployment (c782d24)
• multiple-polls: allow concurrent polls (14e89ba)
• sdk: add function to get zupass gatekeeper data (#1649) (49794ab)
• support deployment without hardhat (dab5e2b)
• use mode instead of flag for voting option (34421de)

Bug Fixes

• add coordinator public key hash public input (9766bbf)
• add uq argument in cli/index (6a0dd44)
• avoid export prompt in cli/sdk (#1591) (8479dd7)
• cli-signup: added comments (6192759)
• cli-signup: changed validation for the signup data and voice credit data (a099aff)
• cli: fix cli vkRegistry typo (499582b)
• cli: fix vk commands flags (#1587) (8ab3d7d)
• cli: generate ecdh shared key only one time (a75ccae)
• cli: genLocalState '-o' arg is a string and does not need parsing (3326d4a)
• cli: read state index from event args (7d7991b)
• do not import enum as type (#1641) (45fca46)
• export typechain instead of contract (#1590) (4e792c4)
• export value from utils/interfaces vs utils (#1642) (c0a5a52)
• isregistered: use a block range to fetch events (#1514) (2740e4c)
• nightly-ceremony: fix wrong path in zkey/dat filename (57c79be)
• nightly: checkout tag v1.2.2 on nightly-ceremony workflow (ef5cfd9)
• nightly: fix issue with artifacts not found due to wrong filename (908e377)
• poll-command: fixed poll command to support merged state root (#1477) (ee6a16e)
• publish proof onchain (e813174)
• remove se flag in testscript (c13cdec)

Code Refactoring

• contracts: do not return contract addresses on poll deploy (43d5224)
• general cleanup, variables/events/functions renaming (b5f5015)
• maci: remove subsidy feature to simplify further protocol improvements (52fc7c5)
• topup: remove the topup feature (67711d4)

Miscellaneous

• add @types/snarkjs package (57bf0ed)
• add doc entries for new maci version (currently being developed) (c72a130)
• add forking options (2f0908b)
• add function to get semaphore gatekeeper details (c877d21)
• add name to gatekeepers and add sdk function (#1639) (30984d0)
• add qv and non-qv key setup during deploy (29f9e17)
• bump to 1.2.2 (e63278f)
• ceremony: update ceremony params tests (b78830d)
• contracts: add typedoc script for contracts package (43459a0)
• deps-dev: bump @types/mocha from 10.0.6 to 10.0.7 (07c3480)
• deps-dev: bump @types/node from 20.11.20 to 20.11.24 (c575eca)
• deps-dev: bump @types/node from 20.11.24 to 20.11.25 (5eb49f9)
• deps-dev: bump @types/node from 20.11.25 to 20.11.28 (81bebaa)
• deps-dev: bump @types/node from 20.11.28 to 20.11.30 (5ef4420)
• deps-dev: bump @types/node from 20.11.30 to 20.12.2 (e7c32d0)
• deps-dev: bump @types/node from 20.12.10 to 20.12.11 (3019c66)
• deps-dev: bump @types/node from 20.12.11 to 20.12.12 (bd0a0a5)
• deps-dev: bump @types/node from 20.12.2 to 20.12.5 (588392f)
• deps-dev: bump @types/node from 20.12.5 to 20.12.7 (f1b00de)
• deps-dev: bump @types/node from 20.12.7 to 20.12.10 (cf5026a)
• deps-dev: bump @types/node from 20.14.10 to 20.14.11 (01564c0)
• deps-dev: bump @types/node from 20.14.11 to 22.1.0 (#1732) (3c4b9d9)
• deps-dev: bump @types/node from 20.14.2 to 20.14.8 (636ac22)
• deps-dev: bump @types/node from 20.14.8 to 20.14.10 (add0ce4)
• deps-dev: bump chai-as-promised from 7.1.1 to 7.1.2 (6930a1c)
• deps-dev: bump mocha from 10.3.0 to 10.4.0 (7bf5afe)
• deps-dev: bump mocha from 10.4.0 to 10.5.0 (e5c14cf)
• deps-dev: bump mocha from 10.5.0 to 10.6.0 (6847bb3)
• deps-dev: bump mocha from 10.6.0 to 10.7.0 (#1687) (2cad35b)
• deps-dev: bump nyc from 15.1.0 to 17.0.0 (c7f4414)
• deps-dev: bump typescript from 5.3.3 to 5.4.2 (591c767)
• deps-dev: bump typescript from 5.4.2 to 5.4.3 (a2f5c8a)
• deps-dev: bump typescript from 5.4.3 to 5.4.4 (5e047ea)
• deps-dev: bump typescript from 5.4.4 to 5.4.5 (ea6339d)
• deps-dev: bump typescript from 5.4.5 to 5.5.2 (e2b4d45)
• deps-dev: bump typescript from 5.5.2 to 5.5.3 (c979188)
• deps-dev: bump typescript from 5.5.3 to 5.5.4 (8ed2e2b)
• deps: bump @commander-js/extra-typings from 12.0.0 to 12.0.1 (59c205c)
• deps: bump @nomicfoundation/hardhat-toolbox from 4.0.0 to 5.0.0 (c403cb4)
• deps: bump ethers from 6.11.1 to 6.12.0 (9db5a93)
• deps: bump ethers from 6.12.0 to 6.12.1 (16b4615)
• deps: bump ethers from 6.13.0 to 6.13.1 (b32694d)
• deps: bump ethers from 6.13.1 to 6.13.2 (#1709) (c9de72e)
• deps: bump hardhat from 2.22.1 to 2.22.2 (397e50b)
• deps: bump hardhat from 2.22.3 to 2.22.4 (481a1e7)
• deps: bump hardhat from 2.22.5 to 2.22.6 (6949eee)
• deps: bump snarkjs from 0.7.3 to 0.7.4 (50642af)
• docs: fixed broken links (#1585) (4b2012e)
• fix typos (96ae030)
• genlocalstate: add start block calculation on genLocalState cli command (615dee4)
• keys: update maci keys in docs and scripts (403262f)
• optimize message processor and tally (d75b244)
• release: publish 1.2.1 (93564f8)
• release: publish 2.0.0 (04e647d)
• remove duplicate words (f138abe)
• remove max values (8f951b0)
• signup: fix flaky test (#1582) (69663ea)
• unify maci address arguments (dfc5fd2)
• update hardhat to 2.21.1 (ba6e236)
• use async fs instead of sync version (fb8317e)
• use non-zero start and end blocks for proof generation (59887e7)
• zkeys: use ts to download zkey artifacts and simplify repo (d364f24)

1.2.0 (2024-02-23)

Features

• add interfaces and factory contracts with Natspec (579a53f)
• circuits: remove circomlib fork in favour of latest and zk-kit (bf11b40), closes #772
• circuits: remove zkey-manager in favour of circomkit (d79e9c0)
• cli: accept signer as parameter to cli commands (b1802e7)
• cli: add get poll cli command (e6e2dd3)
• cli: add relevant information in tally.json to simplify verify interface (6fa9c1e)
• cli: add seed param for generate keypair command (29d7b20)
• cli: improve cli integration ux (7727ab1)
• contracts: return contract addresses when deploying the poll contract (e94998c)
• modify cli/.env.template and allow hardhat.config.ts to read env variables (a206df1)
• optimize deployment and tally event (185b407)
• proofs: make preferred witness type in circuit's genProof function (2b95044)
• qv: add optional flag to use quadratic voting or not in MACI (86ba854)
• update sidebar (6206a1b)

Bug Fixes

• add on-chain verification (6427f37)
• circuits: enforce use of stateIndex from message (510e6ee)
• cli: add a check that the subsidy verifying key was set correctly on chain (6bda14d), closes #446
• cli: add env initialization for hardhat config (5442b8a)
• cli: export genLocalState (0026669)
• cli: give priority to gatekeeper and voice credit proxy args (1597ee3)
• cli: prioritize contract addresses params (8ec36c4), closes #1039
• cli: remove files property from package.json (5c544c6)
• cli: remove hardcoded gas limit from signup and publish (1bf3a4b), closes #1086
• cli: remove redundant local check for poll address (8b19756), closes #1084
• cli: run all the tests for package (859a8cf)
• cli: signup loop length (bfecd5b)
• contracts: fix wrong tally processing check (a90bcf8), closes #1137
• contracts: save numSignups after merging maciStateAq inside the Poll contract (4985b2d), closes #1091
• fetch: fix bugs related to logs fetching (7c7874e), closes #1043 #1044
• fix integrationtests: fix integrationTests caused by refactoring (09ae37f)
• fix subsidy.sol issues: address PR on Subsidy.sol (bb68116)
• message-batch-index: remove redundant check (98c00a6)
• nightly: add back snarkjs to cli as dev dependency and fix poll duration (1e5e41d)
• publish: ensure we publish the correct files (bc42724)
• signups: ensure we account for the blank state leaf (b1c8c97), closes #947
• tests: fix ceremony params nightly workflow and convert to ts (b2b4d4a)
• undefined error reading totalSpentVoiceCredits (10e46af)

Code Refactoring

• circuits: fix ts types, improve docs (a849486)
• cli: print relevant values when comparing fails (2e26126)
• cli: use object args for cli commands (41c4333)
• contracts: cleanup unused scripts and organize ts code (458bc6b)
• contracts: refactor contracts code by removing dead code, and various optimizations (7cbe5bd)
• contracts: remove maxValues and batchSizes from Maci.deployPoll() and instead calculate (5393868), closes #1066
• core: refactor the core package subsidy and tally functions (0af7dd2)
• core: remove unnecessary messageAq from Poll (d3930f7)
• crypto: remove ffjavascript and implement utils functions locally (0b2986f), closes #458
• nonqv: optimize tally votes non qv circuit and contracts (ea632a9)
• optimisedmt: remove dependency and implement locally (c7d81e2)
• refactor verify.ts: refactor verify cli command for Tally and Subsidy contracts (dedfda6)
• remove messageaqfactory: remove messageAqFactory; remove redundant pollFactory dependency (dcd1c67)
• repo: remove redundant code from certain packages (d55497a)

Miscellaneous

• add a badges to README.md (888524b)
• add types check (69f038f)
• apply prettier (8b905c0)
• bundle size optimizations (18da49c)
• ceremony: add circuit tests with ceremony params (58611db)
• changelog: add CHANGELOG of v1.1.1 (f0c315a)
• cli: change maci-cli script run instructions (c51c34d)
• cli: clarify cli commands (3aa4f33)
• cli: integrate linter (49571a1)
• cli: optimize bundle size (39268b2)
• cli: prepare cli package for web apps (f706d9a)
• cli: reorganize e2e tests and add more tests for cli commands (6000227)
• cli: support install for web apps (3166cdd)
• cli: unify publish arg type (50635dc)
• contract: apply linter for deploy scripts and contracts (9af9c04)
• contracts: enable linter (5c92154)
• core: add CircuitInputs type (c4b72b0)
• core: add quiet flag to process messages to log errors (8793a09), closes #1135
• core: add Typedoc comments (a8521ee)
• coverage: setup coverage for TS packages (f4e6964)
• dependencies: update project dependencies and remove redundant ones (4c5ac27)
• deps-dev: bump @types/node from 18.19.6 to 20.10.8 (6645120)
• deps-dev: bump @types/node from 20.10.8 to 20.11.0 (805d253)
• deps-dev: bump @types/node from 20.11.0 to 20.11.2 (45839e8)
• deps-dev: bump @types/node from 20.11.10 to 20.11.16 (8144919)
• deps-dev: bump @types/node from 20.11.16 to 20.11.17 (44de5db)
• deps-dev: bump @types/node from 20.11.17 to 20.11.19 (8d86b32)
• deps-dev: bump @types/node from 20.11.2 to 20.11.5 (7698ede)
• deps-dev: bump @types/node from 20.11.5 to 20.11.10 (a2c445a)
• deps-dev: bump lerna from 6.6.2 to 8.0.2 (4b150ad)
• deps-dev: bump mocha from 10.2.0 to 10.3.0 (2b76e04)
• deps-dev: bump typescript from 5.2.2 to 5.3.3 (4ec399d)
• deps: bump @commander-js/extra-typings from 11.1.0 to 12.0.0 (8688daa)
• deps: bump commander from 11.1.0 to 12.0.0 (72b1a2e)
• deps: bump dotenv from 16.3.1 to 16.3.2 (845becc)
• deps: bump dotenv from 16.3.2 to 16.4.1 (2430c50)
• deps: bump dotenv from 16.4.1 to 16.4.2 (8431e74)
• deps: bump dotenv from 16.4.2 to 16.4.4 (472c616)
• deps: bump ethers from 6.10.0 to 6.11.0 (815696d)
• deps: bump ethers from 6.11.0 to 6.11.1 (a01f434)
• deps: bump ethers from 6.9.2 to 6.10.0 (dd8b4a0)
• deps: bump hardhat from 2.19.4 to 2.19.5 (40ab10d)
• deps: bump hardhat from 2.19.5 to 2.20.1 (68543a6)
• deps: bump snarkjs from 0.7.2 to 0.7.3 (cf95b6f)
• deps: remove circomlib and add big-integer (50eff2f)
• key-change: add tests and docs around key-change (ce394e2)
• linter (42ea4f0)
• linter unification (61a8bcd)
• maci-cli: check hardhat config file (3a6ac6b)
• poll: unify pollId type (21d01ef)
• publishing: remove bash script for empty ballot roots contract (025287c)
• rebased with the dev branch (8165968)
• release: publish 1.1.2 (10b3a85)
• remove gitHead field from package.json (d38ba71)
• run prettier (d09cd0e)
• run prettier fix after bumping version (e1f85a5)
• topup: implement test cases for the topup feature (7775a8b)
• update ptauFiles URLs (b11b56a)
• website: apply linter for website and remove unused packages (1a3b343)

1.1.2 (2023-01-19)

Code Refactoring

• remove messageaqfactory: remove messageAqFactory; remove redundant pollFactory dependency (dcd1c67)

Miscellaneous

• add a badges to README.md (888524b)
• changelog: add CHANGELOG of v1.1.1 (ea1f0ca)

1.1.1 (2022-12-03)

Bug Fixes

• maci: upgraded minor version and fixed bug in testnet deployment (5ef5ed8), closes #551 #552
• maci: upgraded snarkjs and other dependencies (0ce643a)