CHANGELOG.md

Change Log

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

1.2.0 (2024-02-23)

Features

• add interfaces and factory contracts with Natspec (579a53f)
• cli: add get poll cli command (e6e2dd3)
• cli: improve cli integration ux (7727ab1)
• contracts: made nextPollId public to support third-party apps more easily (c5c6bdb)
• contracts: return contract addresses when deploying the poll contract (e94998c)
• eas-gatekeeper: implement an eas gatekeeper for MACI (8b25d94)
• optimize deployment and tally event (185b407)
• poll: add message batch submission (005258b)
• tally: remove ballotsTallied event and add view function (32f840e)

Bug Fixes

• address messageprocessor issues: address and fixed PR reviews on MessageProcessor.sol (6505fb2)
• address pr reviews: address PR reviews issues for Tally.sol (10f2c7f)
• cli: add auto mining option for hardhat (e5ad345)
• constraint updatesbcommitment: add onlyOwner modifier to updateSbCommitment (5b8ee10)
• contract unit test: fixed unit test suites error caused by contracts refactor (0dca2c0)
• contracts: enforce msgType = 1 for vote messages at the contract level (c547e9c)
• contracts: fix wrong tally processing check (a90bcf8), closes #1137
• contracts: prevent user DoS the stateAq tree merging (d07d3bf)
• contracts: save numSignups after merging maciStateAq inside the Poll contract (4985b2d), closes #1091
• crypto: get rid of potential prototype polution (9b8a97c)
• fetch: fix bugs related to logs fetching (7c7874e), closes #1043 #1044
• fix subsidy.sol issues: address PR on Subsidy.sol (bb68116)
• message-batch-index: remove redundant check (98c00a6)
• publish: ensure we publish the correct files (bc42724)
• return new poll addres (acb38ba)
• signups: ensure we account for the blank state leaf (b1c8c97), closes #947

Code Refactoring

• contracts: add audit auggestions (415c3da)
• contracts: add natspec across contracts and cleanup (a6ad25e)
• contracts: add public to Tally.isTallied (0d28b7a)
• contracts: add virtual to functions which could be overridden (aefe48a)
• contracts: cleanup unused scripts and organize ts code (458bc6b)
• contracts: optimize code by using immutable variables are removing redundant code (d39d384)
• contracts: optimize publishMessage by using calldata and removing arg change (6f64471)
• contracts: optimize utilities.padAndHashMessage (0cc29ca)
• contracts: refactor contracts code by removing dead code, and various optimizations (7cbe5bd)
• contracts: refactoring deployment scripts (eba33cf), closes #555
• contracts: remove maxValues and batchSizes from Maci.deployPoll() and instead calculate (5393868), closes #1066
• contracts: revisit functions visibility and inheritance (f729336)
• contracts: smart contracts optimizations (b10ff70)
• core: refactor the core package subsidy and tally functions (0af7dd2)
• core: refactor the process message functions and general cleanup (823cacd)
• core: remove unnecessary messageAq from Poll (d3930f7)
• core: remove unnecessary stateAq from MaciState (22a4f28)
• fix ESLint issues (6c0ed97)
• maci-core: refactor directory structure for quick core component access (3aeba77)
• nonqv: optimize tally votes non qv circuit and contracts (ea632a9)
• remove messageaqfactory: remove messageAqFactory; remove redundant pollFactory dependency (dcd1c67)
• zk-kit-poseidon: remove old circomlib dependencies in crypto (0340f79)

Miscellaneous

• add a badges to README.md (888524b)
• add types check (69f038f)
• apply prettier (8b905c0)
• bundle size optimizations (18da49c)
• changelog: add CHANGELOG of v1.1.1 (f0c315a)
• circuits: refactor and add tests for the circom circuits (4d6419b)
• cli: integrate linter (49571a1)
• cli: optimize bundle size (39268b2)
• cli: reorganize e2e tests and add more tests for cli commands (6000227)
• cli: support install for web apps (3166cdd)
• contract: add contract verification task (ab4718f)
• contract: add deploy script for eas gatekeeper (65d883c)
• contract: add deploy tasks for maci (8b58688)
• contract: apply linter for deploy scripts and contracts (9af9c04)
• contract: disable empty code blocks warnings (f30bda2)
• contracts: add documentation for deployment workflow (243690e)
• contracts: add gas reporter to hardhat config (fd00eb5)
• contracts: add merge signups and messages task (5ee0237)
• contracts: add proof generation for task coordinator (c145883)
• contracts: clarify EASGatekeeper description (301a42b)
• contracts: deploy poll (f3ae8f8)
• contracts: enable linter (5c92154)
• contracts: re-organize smart contract tests in separate files (c7ee31e)
• contracts: refactor and add unit tests to the current suite (32c3485)
• 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 @types/snarkjs from 0.7.7 to 0.7.8 (0d98828)
• deps-dev: bump lerna from 6.6.2 to 8.0.2 (4b150ad)
• deps-dev: bump typescript from 5.2.2 to 5.3.3 (4ec399d)
• 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)
• linter (42ea4f0)
• linter unification (61a8bcd)
• maci: added audit report and amended Contract's README (0c6d28b)
• maci: added README for the circuit package and fixed typo in contract's README (4d0f74b)
• maci: updated docs after review (fd0da34), closes #531 #556
• poll: unify pollId type (21d01ef)
• publish: fix publishing scripts to publish contracts with ceremony params (f27af1c), closes #973
• 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 docs (d33e7e6)

1.1.2 (2023-01-19)

Features

• contracts: made nextPollId public to support third-party apps more easily (c5c6bdb)

Code Refactoring

• contracts: refactoring deployment scripts (eba33cf), closes #555
• 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)
• maci: added audit report and amended Contract's README (0c6d28b)
• maci: added README for the circuit package and fixed typo in contract's README (4d0f74b)
• maci: updated docs after review (fd0da34), closes #531 #556

1.1.1 (2022-12-03)

Bug Fixes

• fix insert placeholder leaf bug: fix issue related to first msg leaf (b4b9da1)
• maci.sol: fix "inconsistent restriction on voice credit upper bound" (7a8c5c1)
• maci: amended the signUp function to reflect the checks-effects-interaction pattern (d62c7c7), closes #503
• maci: final fix to the tests (51e84f8)
• maci: implemented fixes for several audit issues (6f1fa85), closes #503 #504 #505 #508 #510
• maci: removed unneded max fee calculation (14ee2a5)
• maci: reverted a fix and fixed test suits (8300cc5)
• maci: upgraded minor version and fixed bug in testnet deployment (5ef5ed8), closes #551 #552
• maci: upgraded snarkjs and other dependencies (0ce643a)
• poll.sol,maci.sol: protect messageAq by nothing up my sleeve hash (04f21b3)
• poll: amended mergeMaciStateAq to directly store the new root to state (76c991a)
• topupcredit.sol: add onlyOnwer modifier (ee0c8a6)

Reverts

• pollyprocessandtallyer: revert changes (382e435)