@maci-protocol/domainobjs 0.0.0-ci.185b643

package/CHANGELOG.md

@@ -0,0 +1,183 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [3.0.0](https://github.com/privacy-scaling-explorations/maci/compare/v2.5.0...v3.0.0) (2025-03-28)
+
+
+### Features
+
+* voice credits per poll ([#1967](https://github.com/privacy-scaling-explorations/maci/issues/1967)) ([f59e9c3](https://github.com/privacy-scaling-explorations/maci/commit/f59e9c350133efb2fbbc37e5139addf5e34c55e6))
+
+
+### Miscellaneous
+
+* **deps-dev:** bump @types/mocha from 10.0.8 to 10.0.10 ([a8b029a](https://github.com/privacy-scaling-explorations/maci/commit/a8b029a140b3bc81c639c26e049a766ce67b8886))
+* **deps-dev:** bump @types/node from 20.17.19 to 22.13.9 ([aa7c356](https://github.com/privacy-scaling-explorations/maci/commit/aa7c356469592547f3d60c05077268267d7ea186))
+* **deps-dev:** bump @types/node from 22.10.7 to 22.12.0 ([#2073](https://github.com/privacy-scaling-explorations/maci/issues/2073)) ([1dcb28e](https://github.com/privacy-scaling-explorations/maci/commit/1dcb28e33699ee91f9691c1073d4da0293e406c0))
+* **deps-dev:** bump @types/node from 22.12.0 to 22.13.1 ([5f06af0](https://github.com/privacy-scaling-explorations/maci/commit/5f06af0180f522f552519529c07d2bb660fdd586))
+* **deps-dev:** bump @types/node from 22.13.1 to 22.13.4 ([dba94f4](https://github.com/privacy-scaling-explorations/maci/commit/dba94f4fe6d405eaca655dfdc8ca01d57664b99b))
+* **deps-dev:** bump @types/node from 22.13.9 to 22.13.10 ([#2241](https://github.com/privacy-scaling-explorations/maci/issues/2241)) ([3f50bb6](https://github.com/privacy-scaling-explorations/maci/commit/3f50bb65db4cd83b5ebe9d4fb1b7a6d650bb1c51))
+* **deps-dev:** bump @types/node from 22.9.0 to 22.10.7 ([3e4a5ae](https://github.com/privacy-scaling-explorations/maci/commit/3e4a5ae43cc57d6ebaedeb5ce95ca6dd1c968ffe))
+* **deps-dev:** bump mocha from 10.7.3 to 11.0.1 ([457a504](https://github.com/privacy-scaling-explorations/maci/commit/457a5048580a5460ad012b10486a65df0dacae0e))
+* **deps-dev:** bump mocha from 10.8.2 to 11.1.0 ([f524a07](https://github.com/privacy-scaling-explorations/maci/commit/f524a07f5a3b1e94eaf6f230ecf16476f4c6810d))
+* **deps-dev:** bump ts-mocha from 10.0.0 to 11.1.0 ([df84193](https://github.com/privacy-scaling-explorations/maci/commit/df84193a1ad0980523aba66f5b43b5a6cdd74307))
+
+
+
+## [2.5.0](https://github.com/privacy-scaling-explorations/maci/compare/v2.4.0...v2.5.0) (2024-11-20)
+
+
+### Miscellaneous
+
+* **deps-dev:** bump @types/node from 22.4.1 to 22.8.1 ([#1873](https://github.com/privacy-scaling-explorations/maci/issues/1873)) ([c1b9c0e](https://github.com/privacy-scaling-explorations/maci/commit/c1b9c0ed18eb3fae5e189dff952a8ab9dfb2f9b1))
+* **deps-dev:** bump @types/node from 22.8.1 to 22.9.0 ([0e11e5d](https://github.com/privacy-scaling-explorations/maci/commit/0e11e5d668fed2e2168de56e87981b0edcca8cd9))
+* **deps-dev:** bump nyc from 17.0.0 to 17.1.0 ([3dce47c](https://github.com/privacy-scaling-explorations/maci/commit/3dce47c8c2a016765ae68b48ebd38b36226b9709))
+
+
+
+## [2.4.0](https://github.com/privacy-scaling-explorations/maci/compare/v2.3.0...v2.4.0) (2024-09-30)
+
+
+### Miscellaneous
+
+* **deps-dev:** bump @types/mocha from 10.0.7 to 10.0.8 ([#1827](https://github.com/privacy-scaling-explorations/maci/issues/1827)) ([4deae8b](https://github.com/privacy-scaling-explorations/maci/commit/4deae8bb3a4ea5cf1b4ad16018186a593142adb8))
+
+
+
+## [2.2.0](https://github.com/privacy-scaling-explorations/maci/compare/v2.1.0...v2.2.0) (2024-08-19)
+
+
+### Miscellaneous
+
+* **deps-dev:** bump @types/node from 22.1.0 to 22.2.0 ([ac18985](https://github.com/privacy-scaling-explorations/maci/commit/ac189852bf6abb787736c474ad87927afaa5163c))
+* **deps-dev:** bump @types/node from 22.2.0 to 22.4.1 ([#1779](https://github.com/privacy-scaling-explorations/maci/issues/1779)) ([4a929e0](https://github.com/privacy-scaling-explorations/maci/commit/4a929e0b9a5c4de5ac0345e742668a3400798867))
+* **deps-dev:** bump mocha from 10.7.0 to 10.7.3 ([6ba908f](https://github.com/privacy-scaling-explorations/maci/commit/6ba908f5f78628aa6afe973b3d71ae54ff08c735))
+
+
+
+## [2.0.0](https://github.com/privacy-scaling-explorations/maci/compare/v1.2.0...v2.0.0) (2024-08-06)
+
+
+### ⚠ BREAKING CHANGES
+
+* **topup:** No more topups
+
+### Features
+
+* export merge function and modify package version ([#1584](https://github.com/privacy-scaling-explorations/maci/issues/1584)) ([f6ae34a](https://github.com/privacy-scaling-explorations/maci/commit/f6ae34a3f9ea375cd5dac8f0ce8618e33509f8ad))
+
+
+### Bug Fixes
+
+* do not accept invalid maci keys ([9f9e858](https://github.com/privacy-scaling-explorations/maci/commit/9f9e858755a3e064f854675a678ef2fb18041fab))
+* minor type issue for @zk-kit/eddsa-poseidon ([ee81309](https://github.com/privacy-scaling-explorations/maci/commit/ee8130924433a040a2d53b00b654f611b3b3e9c4))
+* publish proof onchain ([e813174](https://github.com/privacy-scaling-explorations/maci/commit/e8131741b3fb5059572822c04cb61b1cbae9599d))
+
+
+### Code Refactoring
+
+* **topup:** remove the topup feature ([67711d4](https://github.com/privacy-scaling-explorations/maci/commit/67711d44058831302d4556f12d1972ffacede653))
+
+
+### Miscellaneous
+
+* bump to 1.2.2 ([e63278f](https://github.com/privacy-scaling-explorations/maci/commit/e63278f71937a1fa908ec8f4be2d43114701c134))
+* **contracts:** add typedoc script for contracts package ([43459a0](https://github.com/privacy-scaling-explorations/maci/commit/43459a02301f102e80a709a0a722dd591e8e00ef))
+* **deps-dev:** bump @types/mocha from 10.0.6 to 10.0.7 ([07c3480](https://github.com/privacy-scaling-explorations/maci/commit/07c3480efc40ad1d3f651b78cd7c3aaeee8d7f8a))
+* **deps-dev:** bump @types/node from 20.11.20 to 20.11.24 ([c575eca](https://github.com/privacy-scaling-explorations/maci/commit/c575eca7c54c262764ce794a919f3b1d58d7d8e7))
+* **deps-dev:** bump @types/node from 20.11.24 to 20.11.25 ([5eb49f9](https://github.com/privacy-scaling-explorations/maci/commit/5eb49f9090fc6db3a80ad2d63548d93430ff7645))
+* **deps-dev:** bump @types/node from 20.11.25 to 20.11.28 ([81bebaa](https://github.com/privacy-scaling-explorations/maci/commit/81bebaa880cbc15b8c8445d412b9fc9d89580e67))
+* **deps-dev:** bump @types/node from 20.11.28 to 20.11.30 ([5ef4420](https://github.com/privacy-scaling-explorations/maci/commit/5ef44209d16cd441067fb67201daa61cf968382d))
+* **deps-dev:** bump @types/node from 20.11.30 to 20.12.2 ([e7c32d0](https://github.com/privacy-scaling-explorations/maci/commit/e7c32d0ddd506727f229d950239a116961bbe1a0))
+* **deps-dev:** bump @types/node from 20.12.10 to 20.12.11 ([3019c66](https://github.com/privacy-scaling-explorations/maci/commit/3019c66eb70e54b376e9464417e073bd98d96b6a))
+* **deps-dev:** bump @types/node from 20.12.11 to 20.12.12 ([bd0a0a5](https://github.com/privacy-scaling-explorations/maci/commit/bd0a0a5a1ec685542c2af4f6962186176d5453ba))
+* **deps-dev:** bump @types/node from 20.12.2 to 20.12.5 ([588392f](https://github.com/privacy-scaling-explorations/maci/commit/588392f2f773addce0204f236fc26981ead1f7bb))
+* **deps-dev:** bump @types/node from 20.12.5 to 20.12.7 ([f1b00de](https://github.com/privacy-scaling-explorations/maci/commit/f1b00deb29788e390dcecd5b1741339f96f06f73))
+* **deps-dev:** bump @types/node from 20.12.7 to 20.12.10 ([cf5026a](https://github.com/privacy-scaling-explorations/maci/commit/cf5026a42a41c0078467fb477fdd51a2afb31e1f))
+* **deps-dev:** bump @types/node from 20.14.10 to 20.14.11 ([01564c0](https://github.com/privacy-scaling-explorations/maci/commit/01564c0503379ca65ce90ea77fdc5ebcd9ae81c5))
+* **deps-dev:** bump @types/node from 20.14.11 to 22.1.0 ([#1732](https://github.com/privacy-scaling-explorations/maci/issues/1732)) ([3c4b9d9](https://github.com/privacy-scaling-explorations/maci/commit/3c4b9d9c9eb7439c4ea9791e4388ff586530be50))
+* **deps-dev:** bump @types/node from 20.14.2 to 20.14.8 ([636ac22](https://github.com/privacy-scaling-explorations/maci/commit/636ac22bd29d12e5af7f69c7dd639d0223595992))
+* **deps-dev:** bump @types/node from 20.14.8 to 20.14.10 ([add0ce4](https://github.com/privacy-scaling-explorations/maci/commit/add0ce4e406fea4bfe2b839facc6a0a33b3fe3bf))
+* **deps-dev:** bump mocha from 10.3.0 to 10.4.0 ([7bf5afe](https://github.com/privacy-scaling-explorations/maci/commit/7bf5afe954bcb6b34dbe7f109c9c7e8d5396f1b2))
+* **deps-dev:** bump mocha from 10.4.0 to 10.5.0 ([e5c14cf](https://github.com/privacy-scaling-explorations/maci/commit/e5c14cf01e9b5beb6232e80345121dbb47190fd0))
+* **deps-dev:** bump mocha from 10.5.0 to 10.6.0 ([6847bb3](https://github.com/privacy-scaling-explorations/maci/commit/6847bb374893672bf7e809fc80d124e2d874b784))
+* **deps-dev:** bump mocha from 10.6.0 to 10.7.0 ([#1687](https://github.com/privacy-scaling-explorations/maci/issues/1687)) ([2cad35b](https://github.com/privacy-scaling-explorations/maci/commit/2cad35bab133af79f77ea9c19098d3561ba06f69))
+* **deps-dev:** bump nyc from 15.1.0 to 17.0.0 ([c7f4414](https://github.com/privacy-scaling-explorations/maci/commit/c7f441417d7c7ec8019867801b77e7b5c07c2307))
+* **dev-deps:** bump docusaurus packages to 3.4.0 ([b2c5568](https://github.com/privacy-scaling-explorations/maci/commit/b2c5568ea21d494075bc2bd8908820583e73a07f))
+* **release:** publish 1.2.1 ([93564f8](https://github.com/privacy-scaling-explorations/maci/commit/93564f8a98baa0fee65db16e2e40209d9ac1b3ae))
+* **release:** publish 2.0.0 ([04e647d](https://github.com/privacy-scaling-explorations/maci/commit/04e647d231df34952569ad6ff802e0b2333eb658))
+
+
+
+## [1.2.0](https://github.com/privacy-scaling-explorations/maci/compare/v1.1.1...v1.2.0) (2024-02-23)
+
+
+### Features
+
+* update sidebar ([6206a1b](https://github.com/privacy-scaling-explorations/maci/commit/6206a1b8849108d78997e00b01c6e7f11efce124))
+
+
+### Bug Fixes
+
+* **circuits:** enforce use of stateIndex from message ([510e6ee](https://github.com/privacy-scaling-explorations/maci/commit/510e6ee365958e8c7f72cfca6cea75d15a89d28b))
+* **publish:** ensure we publish the correct files ([bc42724](https://github.com/privacy-scaling-explorations/maci/commit/bc42724b34cf0c047c5692fbf477ed013a102aee))
+
+
+### Code Refactoring
+
+* **circuits:** fix ts types, improve docs ([a849486](https://github.com/privacy-scaling-explorations/maci/commit/a84948685d2e4be426cef50c5c608c107b5142b1))
+* **crypto:** modify genPrivKey to generate a random seed vs a babyjubjub compatible value ([0f1e9ba](https://github.com/privacy-scaling-explorations/maci/commit/0f1e9bad81a872e67a09e6912beb48784cc19a4b))
+* **crypto:** remove ffjavascript and implement utils functions locally ([0b2986f](https://github.com/privacy-scaling-explorations/maci/commit/0b2986fcaadbfce37ff9fc0007ddeae97573924e)), closes [#458](https://github.com/privacy-scaling-explorations/maci/issues/458)
+* fix ESLint issues ([6c0ed97](https://github.com/privacy-scaling-explorations/maci/commit/6c0ed97c0976a81b5e5506699d550ec93a553cb8))
+* **zk-kit-poseidon:** remove old circomlib dependencies in crypto ([0340f79](https://github.com/privacy-scaling-explorations/maci/commit/0340f7960a2214410d8885541ac542419a980a34))
+
+
+### Miscellaneous
+
+* add a badges to README.md ([888524b](https://github.com/privacy-scaling-explorations/maci/commit/888524baae82d56edbf0c794e587de174906c34c))
+* add types check ([69f038f](https://github.com/privacy-scaling-explorations/maci/commit/69f038f55e6c740d43b8b5376db999bcf92de845))
+* apply prettier ([8b905c0](https://github.com/privacy-scaling-explorations/maci/commit/8b905c0948d4a1f950653c6812067ec98ebfcbc8))
+* bundle size optimizations ([18da49c](https://github.com/privacy-scaling-explorations/maci/commit/18da49c791e53350158659df8248d48af8e80f6d))
+* **changelog:** add CHANGELOG of v1.1.1 ([f0c315a](https://github.com/privacy-scaling-explorations/maci/commit/f0c315a4c1b86f88839f2dbe4c4b9f59193f7be4))
+* **circuits:** refactor and add tests for the circom circuits ([4d6419b](https://github.com/privacy-scaling-explorations/maci/commit/4d6419b4962af6e94929721a3008406b6bc29c1e))
+* **cli:** optimize bundle size ([39268b2](https://github.com/privacy-scaling-explorations/maci/commit/39268b2ff8e0d27d062c6d3bc52a63ce8038ec5e))
+* **cli:** reorganize e2e tests and add more tests for cli commands ([6000227](https://github.com/privacy-scaling-explorations/maci/commit/6000227231bee3917686b64685c14ca329fcf38b))
+* **contract:** apply linter for deploy scripts and contracts ([9af9c04](https://github.com/privacy-scaling-explorations/maci/commit/9af9c0497a2491eaf89fbff475cf0f60bc04f59c))
+* **coverage:** setup coverage for TS packages ([f4e6964](https://github.com/privacy-scaling-explorations/maci/commit/f4e6964b3e268e4d3f2819b85e6abf3e34bcb10e))
+* **dependencies:** update project dependencies and remove redundant ones ([4c5ac27](https://github.com/privacy-scaling-explorations/maci/commit/4c5ac27767492c9867a6e2ab2acd6b10fe132847))
+* **deps-dev:** bump @types/node from 18.19.6 to 20.10.8 ([6645120](https://github.com/privacy-scaling-explorations/maci/commit/664512038212d36d40799e8c4787847735bd7d82))
+* **deps-dev:** bump @types/node from 20.10.8 to 20.11.0 ([805d253](https://github.com/privacy-scaling-explorations/maci/commit/805d2536a54478c51403362419ecad0b6ab736a7))
+* **deps-dev:** bump @types/node from 20.11.0 to 20.11.2 ([45839e8](https://github.com/privacy-scaling-explorations/maci/commit/45839e8c2668ec56ea06221758605f88029ea8a1))
+* **deps-dev:** bump @types/node from 20.11.10 to 20.11.16 ([8144919](https://github.com/privacy-scaling-explorations/maci/commit/8144919939f7d9a841eb6fce7182628cedbf8746))
+* **deps-dev:** bump @types/node from 20.11.16 to 20.11.17 ([44de5db](https://github.com/privacy-scaling-explorations/maci/commit/44de5db0c25a5fdfd5c13c397f49edb7185bf1f5))
+* **deps-dev:** bump @types/node from 20.11.17 to 20.11.19 ([8d86b32](https://github.com/privacy-scaling-explorations/maci/commit/8d86b32ef70b89f4239aad3903fd36937cf6a90f))
+* **deps-dev:** bump @types/node from 20.11.2 to 20.11.5 ([7698ede](https://github.com/privacy-scaling-explorations/maci/commit/7698edef2b95bc017e54c1fc0d796ccc9da3de85))
+* **deps-dev:** bump @types/node from 20.11.5 to 20.11.10 ([a2c445a](https://github.com/privacy-scaling-explorations/maci/commit/a2c445a295e792e421f6c1537b2b21f8a7648683))
+* **deps-dev:** bump lerna from 6.6.2 to 8.0.2 ([4b150ad](https://github.com/privacy-scaling-explorations/maci/commit/4b150ade7c4fbaf88eb0e1f629cec6749377706d))
+* **deps-dev:** bump mocha from 10.2.0 to 10.3.0 ([2b76e04](https://github.com/privacy-scaling-explorations/maci/commit/2b76e0445f5da5864a335352f66eac33c070ab29))
+* **domainobjs:** apply linter rules and fixes ([6649ca6](https://github.com/privacy-scaling-explorations/maci/commit/6649ca6d2afc83cfec60008fa6314add1cd837cd))
+* **domainobjs:** implement unit tests for the domainobjs package ([c19d1d3](https://github.com/privacy-scaling-explorations/maci/commit/c19d1d3b6652d306e5ae7f4083eb20c4832c1233))
+* linter ([42ea4f0](https://github.com/privacy-scaling-explorations/maci/commit/42ea4f0ae8b342f6bd5ca5ac86f1bdd143978324))
+* linter unification ([61a8bcd](https://github.com/privacy-scaling-explorations/maci/commit/61a8bcd915fd3e4b4da3c00d40704d892c02f51b))
+* **publishing:** remove bash script for empty ballot roots contract ([025287c](https://github.com/privacy-scaling-explorations/maci/commit/025287c778547e0acb1582532f3412e022cca6fa))
+* **release:** publish 1.1.2 ([10b3a85](https://github.com/privacy-scaling-explorations/maci/commit/10b3a85cc9b53c0fc1ccdf54221a48ec8d6efe0d))
+* remove `gitHead` field from package.json ([d38ba71](https://github.com/privacy-scaling-explorations/maci/commit/d38ba71301469f350b3d80eab5bf94e779dda9cc))
+* run prettier ([d09cd0e](https://github.com/privacy-scaling-explorations/maci/commit/d09cd0e01ac747245307ceec5343d9ed30d7a6f0))
+* run prettier fix after bumping version ([e1f85a5](https://github.com/privacy-scaling-explorations/maci/commit/e1f85a53bbb72696b6998af5406748fd18df4701))
+
+
+
+## [1.1.2](https://github.com/gurrpi/maci/compare/v1.1.1...v1.1.2) (2023-01-19)
+
+### Miscellaneous
+
+- add a badges to README.md ([888524b](https://github.com/gurrpi/maci/commit/888524baae82d56edbf0c794e587de174906c34c))
+- **changelog:** add CHANGELOG of v1.1.1 ([ea1f0ca](https://github.com/gurrpi/maci/commit/ea1f0ca93f1618df0ba046f1f01b2abad57e0ee1))
+
+## [1.1.1](https://github.com/gurrpi/maci/compare/v1.1.0...v1.1.1) (2022-12-03)
+
+### Bug Fixes
+
+- **maci:** upgraded minor version and fixed bug in testnet deployment ([5ef5ed8](https://github.com/gurrpi/maci/commit/5ef5ed842360277ac823c6919e171d0c51ff5702)), closes [#551](https://github.com/gurrpi/maci/issues/551) [#552](https://github.com/gurrpi/maci/issues/552)

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2020 Barry WhiteHat, Kendrick Tan, Kobi Gurkan, Kirill Goncharov
+Cory Dickson, Han Jian, Chih-Cheng Liang, and Koh Wei Jie
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,78 @@
+# maci-domainobjs
+
+[![NPM Package][domainobjs-npm-badge]][domainobjs-npm-link]
+[![Actions Status][domainobjs-actions-badge]][domainobjs-actions-link]
+
+This module implements domain objects. A domain object is:
+
+> a logical container of purely domain information, usually representing a
+> logical entity in the problem domain space
+
+https://wiki.c2.com/?DomainObject
+
+In effect, domain objects are representations of objects shared between other
+modules in this codebase. They also encapsulate helper functions which make it
+easy to use them with said modules.
+
+## `PrivKey`
+
+A private key. Provides helper functions to do with passing it into a circuit
+in the right format, serialisation and deserialisation, and deep copying.
+
+This is a MACI private key, which is not to be confused with an Ethereum private key.
+A serialized MACI private key is prefixed by 'macisk.'
+A raw MACI private key can be thought as a point on the baby jubjub curve.
+
+## `PubKey`
+
+A public key. Provides helper functions to do with passing it into a contract
+function or circuit in the right format, hashing, serialisation and
+deserialisation, and deep copying.
+
+This is a MACI public key, which is not to be confused with an Ethereum public key. A serialized MACI public key is prefixed by 'macipk.' A raw MACI public key can be thought as a pair of BigIntegers (x, y) representing a point on the baby jubjub curve.
+
+## `Keypair`
+
+Encapsulates a `PrivKey` and `PubKey`. Also provides `genEcdhSharedKey` which
+generates an ECDH shared key from a public key and a private key.
+
+This is a MACI keypair, which is not to be confused with an Ethereum keypair.
+A MACI keypair is comprised of a MACI public key and a MACI private key
+
+## `Command`
+
+The `Command` domain object represents a request by a user to cast a vote
+and/or change one's public key.
+
+## `Message`
+
+The `Message` domain object is an encrypted `Command` and signature. That is, a
+`Message` is a `Ciphertext` (defined in `maci-crypto`)
+which is the encrypted `Command` and its `Signature` (also defined in
+`maci-crypto`). In other terms:
+
+```
+Message = Encrypt([Command, Signature], Key)
+```
+
+## `Ballot`
+
+Represents a User's votes in a Poll, as well as their next valid nonce.
+
+## `StateLeaf`
+
+Represents a leaf in the state tree, which maps public keys to voice credit
+balances, as well as the timestamp at which it was inserted.
+
+## `VerifyingKey`
+
+Encapsulates a Groth16 zk-SNARK verifying key.
+
+## `Proof`
+
+Encapsulates a Groth16 zk-SNARK proof.
+
+[domainobjs-npm-badge]: https://img.shields.io/npm/v/maci-domainobjs.svg
+[domainobjs-npm-link]: https://www.npmjs.com/package/maci-domainobjs
+[domainobjs-actions-badge]: https://github.com/privacy-scaling-explorations/maci/actions/workflows/domainobjs-build.yml/badge.svg
+[domainobjs-actions-link]: https://github.com/privacy-scaling-explorations/maci/actions?query=workflow%3Adomainobjs

package/build/ts/ballot.d.ts

@@ -0,0 +1,68 @@
+import type { IJsonBallot } from "./types";
+/**
+ * A Ballot represents a User's votes in a Poll, as well as their next valid
+ * nonce.
+ */
+export declare class Ballot {
+    votes: bigint[];
+    nonce: bigint;
+    voteOptionTreeDepth: number;
+    /**
+     * Create a new Ballot instance
+     * @param _numVoteOptions How many vote options are available in the poll
+     * @param _voteOptionTreeDepth The depth of the merkle tree holding the vote options
+     */
+    constructor(_numVoteOptions: number, _voteOptionTreeDepth: number);
+    /**
+     * Generate an hash of this ballot
+     * @returns The hash of the ballot
+     */
+    hash: () => bigint;
+    /**
+     * Convert in a format suitable for the circuit
+     * @returns the ballot as a BigInt array
+     */
+    asCircuitInputs: () => bigint[];
+    /**
+     * Convert in a an array of bigints
+     * @notice this is the nonce and the root of the vote option tree
+     * @returns the ballot as a bigint array
+     */
+    asArray: () => bigint[];
+    /**
+     * Create a deep clone of this Ballot
+     * @returns a copy of the ballot
+     */
+    copy: () => Ballot;
+    /**
+     * Check if two ballots are equal (same votes and same nonce)
+     * @param b - The ballot to compare with
+     * @returns whether the two ballots are equal
+     */
+    equals(b: Ballot): boolean;
+    /**
+     * Generate a random ballot
+     * @param numVoteOptions How many vote options are available
+     * @param voteOptionTreeDepth How deep is the merkle tree holding the vote options
+     * @returns a random Ballot
+     */
+    static genRandomBallot(numVoteOptions: number, voteOptionTreeDepth: number): Ballot;
+    /**
+     * Generate a blank ballot
+     * @param numVoteOptions How many vote options are available
+     * @param voteOptionTreeDepth How deep is the merkle tree holding the vote options
+     * @returns a Blank Ballot object
+     */
+    static genBlankBallot(numVoteOptions: number, voteOptionTreeDepth: number): Ballot;
+    /**
+     * Serialize to a JSON object
+     */
+    toJSON(): IJsonBallot;
+    /**
+     * Deserialize into a Ballot instance
+     * @param json - the json representation
+     * @returns the deserialized object as a Ballot instance
+     */
+    static fromJSON(json: IJsonBallot): Ballot;
+}
+//# sourceMappingURL=ballot.d.ts.map

package/build/ts/ballot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ballot.d.ts","sourceRoot":"","sources":["../../ts/ballot.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE3C;;;GAGG;AACH,qBAAa,MAAM;IACjB,KAAK,EAAE,MAAM,EAAE,CAAM;IAErB,KAAK,SAAa;IAElB,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;;OAIG;gBACS,eAAe,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM;IASjE;;;OAGG;IACH,IAAI,QAAO,MAAM,CAGf;IAEF;;;OAGG;IACH,eAAe,QAAO,MAAM,EAAE,CAAmB;IAEjD;;;;OAIG;IACH,OAAO,QAAO,MAAM,EAAE,CAUpB;IAEF;;;OAGG;IACH,IAAI,QAAO,MAAM,CAMf;IAEF;;;;OAIG;IACH,MAAM,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO;IAK1B;;;;;OAKG;IACH,MAAM,CAAC,eAAe,CAAC,cAAc,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,GAAG,MAAM;IAMnF;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CAAC,cAAc,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,GAAG,MAAM;IAKlF;;OAEG;IACH,MAAM,IAAI,WAAW;IAQrB;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,MAAM;CAM3C"}

package/build/ts/ballot.js

@@ -0,0 +1,120 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Ballot = void 0;
+const crypto_1 = require("@maci-protocol/crypto");
+const assert_1 = __importDefault(require("assert"));
+/**
+ * A Ballot represents a User's votes in a Poll, as well as their next valid
+ * nonce.
+ */
+class Ballot {
+    /**
+     * Create a new Ballot instance
+     * @param _numVoteOptions How many vote options are available in the poll
+     * @param _voteOptionTreeDepth The depth of the merkle tree holding the vote options
+     */
+    constructor(_numVoteOptions, _voteOptionTreeDepth) {
+        this.votes = [];
+        this.nonce = BigInt(0);
+        /**
+         * Generate an hash of this ballot
+         * @returns The hash of the ballot
+         */
+        this.hash = () => {
+            const vals = this.asArray();
+            return (0, crypto_1.hashLeftRight)(vals[0], vals[1]);
+        };
+        /**
+         * Convert in a format suitable for the circuit
+         * @returns the ballot as a BigInt array
+         */
+        this.asCircuitInputs = () => this.asArray();
+        /**
+         * Convert in a an array of bigints
+         * @notice this is the nonce and the root of the vote option tree
+         * @returns the ballot as a bigint array
+         */
+        this.asArray = () => {
+            const lastIndex = this.votes.length - 1;
+            const foundIndex = this.votes.findIndex((_, index) => this.votes[lastIndex - index] !== BigInt(0));
+            const lastIndexToInsert = foundIndex < 0 ? -1 : lastIndex - foundIndex;
+            const voTree = new crypto_1.IncrementalQuinTree(this.voteOptionTreeDepth, BigInt(0), 5, crypto_1.hash5);
+            for (let i = 0; i <= lastIndexToInsert; i += 1) {
+                voTree.insert(this.votes[i]);
+            }
+            return [this.nonce, voTree.root];
+        };
+        /**
+         * Create a deep clone of this Ballot
+         * @returns a copy of the ballot
+         */
+        this.copy = () => {
+            const b = new Ballot(this.votes.length, this.voteOptionTreeDepth);
+            b.votes = this.votes.map((x) => BigInt(x.toString()));
+            b.nonce = BigInt(this.nonce.toString());
+            return b;
+        };
+        this.voteOptionTreeDepth = _voteOptionTreeDepth;
+        (0, assert_1.default)(5 ** _voteOptionTreeDepth >= _numVoteOptions);
+        (0, assert_1.default)(_numVoteOptions >= 0);
+        for (let i = 0; i < _numVoteOptions; i += 1) {
+            this.votes.push(BigInt(0));
+        }
+    }
+    /**
+     * Check if two ballots are equal (same votes and same nonce)
+     * @param b - The ballot to compare with
+     * @returns whether the two ballots are equal
+     */
+    equals(b) {
+        const isEqualVotes = this.votes.every((vote, index) => vote === b.votes[index]);
+        return isEqualVotes ? b.nonce === this.nonce && this.votes.length === b.votes.length : false;
+    }
+    /**
+     * Generate a random ballot
+     * @param numVoteOptions How many vote options are available
+     * @param voteOptionTreeDepth How deep is the merkle tree holding the vote options
+     * @returns a random Ballot
+     */
+    static genRandomBallot(numVoteOptions, voteOptionTreeDepth) {
+        const ballot = new Ballot(numVoteOptions, voteOptionTreeDepth);
+        ballot.nonce = (0, crypto_1.genRandomSalt)();
+        return ballot;
+    }
+    /**
+     * Generate a blank ballot
+     * @param numVoteOptions How many vote options are available
+     * @param voteOptionTreeDepth How deep is the merkle tree holding the vote options
+     * @returns a Blank Ballot object
+     */
+    static genBlankBallot(numVoteOptions, voteOptionTreeDepth) {
+        const ballot = new Ballot(numVoteOptions, voteOptionTreeDepth);
+        return ballot;
+    }
+    /**
+     * Serialize to a JSON object
+     */
+    toJSON() {
+        return {
+            votes: this.votes.map((x) => x.toString()),
+            nonce: this.nonce.toString(),
+            voteOptionTreeDepth: this.voteOptionTreeDepth.toString(),
+        };
+    }
+    /**
+     * Deserialize into a Ballot instance
+     * @param json - the json representation
+     * @returns the deserialized object as a Ballot instance
+     */
+    static fromJSON(json) {
+        const ballot = new Ballot(json.votes.length, Number.parseInt(json.voteOptionTreeDepth.toString(), 10));
+        ballot.votes = json.votes.map((x) => BigInt(x));
+        ballot.nonce = BigInt(json.nonce);
+        return ballot;
+    }
+}
+exports.Ballot = Ballot;
+//# sourceMappingURL=ballot.js.map

package/build/ts/ballot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ballot.js","sourceRoot":"","sources":["../../ts/ballot.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAiG;AAEjG,oDAA4B;AAI5B;;;GAGG;AACH,MAAa,MAAM;IAOjB;;;;OAIG;IACH,YAAY,eAAuB,EAAE,oBAA4B;QAXjE,UAAK,GAAa,EAAE,CAAC;QAErB,UAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QAkBlB;;;WAGG;QACH,SAAI,GAAG,GAAW,EAAE;YAClB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;YAC5B,OAAO,IAAA,sBAAa,EAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACzC,CAAC,CAAC;QAEF;;;WAGG;QACH,oBAAe,GAAG,GAAa,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QAEjD;;;;WAIG;QACH,YAAO,GAAG,GAAa,EAAE;YACvB,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;YACxC,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YACnG,MAAM,iBAAiB,GAAG,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,UAAU,CAAC;YACvE,MAAM,MAAM,GAAG,IAAI,4BAAmB,CAAC,IAAI,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,cAAK,CAAC,CAAC;YACtF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,iBAAiB,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC/C,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC/B,CAAC;YAED,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QACnC,CAAC,CAAC;QAEF;;;WAGG;QACH,SAAI,GAAG,GAAW,EAAE;YAClB,MAAM,CAAC,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;YAElE,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YACtD,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;YACxC,OAAO,CAAC,CAAC;QACX,CAAC,CAAC;QAlDA,IAAI,CAAC,mBAAmB,GAAG,oBAAoB,CAAC;QAChD,IAAA,gBAAM,EAAC,CAAC,IAAI,oBAAoB,IAAI,eAAe,CAAC,CAAC;QACrD,IAAA,gBAAM,EAAC,eAAe,IAAI,CAAC,CAAC,CAAC;QAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,eAAe,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5C,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IA8CD;;;;OAIG;IACH,MAAM,CAAC,CAAS;QACd,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;QAChF,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;IAC/F,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,eAAe,CAAC,cAAsB,EAAE,mBAA2B;QACxE,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,cAAc,EAAE,mBAAmB,CAAC,CAAC;QAC/D,MAAM,CAAC,KAAK,GAAG,IAAA,sBAAa,GAAE,CAAC;QAC/B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CAAC,cAAsB,EAAE,mBAA2B;QACvE,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,cAAc,EAAE,mBAAmB,CAAC,CAAC;QAC/D,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,OAAO;YACL,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC1C,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;YAC5B,mBAAmB,EAAE,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE;SACzD,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAiB;QAC/B,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;QACvG,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAChD,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAClC,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAxHD,wBAwHC"}

package/build/ts/commands/PCommand.d.ts

@@ -0,0 +1,89 @@
+import { type Signature, type EcdhSharedKey } from "@maci-protocol/crypto";
+import type { IJsonPCommand } from "./types";
+import type { PrivKey } from "../privateKey";
+import { Message } from "../message";
+import { PubKey } from "../publicKey";
+export interface IDecryptMessage {
+    command: PCommand;
+    signature: Signature;
+}
+/**
+ * @notice Unencrypted data whose fields include the user's public key, vote etc.
+ * This represents a Vote command.
+ */
+export declare class PCommand {
+    stateIndex: bigint;
+    newPubKey: PubKey;
+    voteOptionIndex: bigint;
+    newVoteWeight: bigint;
+    nonce: bigint;
+    pollId: bigint;
+    salt: bigint;
+    /**
+     * Create a new PCommand
+     * @param stateIndex the state index of the user
+     * @param newPubKey the new public key of the user
+     * @param voteOptionIndex the index of the vote option
+     * @param newVoteWeight the new vote weight of the user
+     * @param nonce the nonce of the message
+     * @param pollId the poll ID
+     * @param salt the salt of the message
+     */
+    constructor(stateIndex: bigint, newPubKey: PubKey, voteOptionIndex: bigint, newVoteWeight: bigint, nonce: bigint, pollId: bigint, salt?: bigint);
+    /**
+     * Create a deep clone of this PCommand
+     * @returns a copy of the PCommand
+     */
+    copy: <T extends PCommand>() => T;
+    /**
+     * @notice Returns this Command as an array. Note that 5 of the Command's fields
+     * are packed into a single 250-bit value. This allows Messages to be
+     * smaller and thereby save gas when the user publishes a message.
+     * @returns bigint[] - the command as an array
+     */
+    asArray: () => bigint[];
+    asCircuitInputs: () => bigint[];
+    equals: (command: PCommand) => boolean;
+    hash: () => bigint;
+    /**
+     * @notice Signs this command and returns a Signature.
+     */
+    sign: (privKey: PrivKey) => Signature;
+    /**
+     * @notice Returns true if the given signature is a correct signature of this
+     * command and signed by the private key associated with the given public
+     * key.
+     */
+    verifySignature: (signature: Signature, pubKey: PubKey) => boolean;
+    /**
+     * @notice Encrypts this command along with a signature to produce a Message.
+     * To save gas, we can constrain the following values to 50 bits and pack
+     * them into a 250-bit value:
+     * 0. state index
+     * 3. vote option index
+     * 4. new vote weight
+     * 5. nonce
+     * 6. poll ID
+     */
+    encrypt: (signature: Signature, sharedKey: EcdhSharedKey) => Message;
+    /**
+     * Decrypts a Message to produce a Command.
+     * @dev You can force decrypt the message by setting `force` to true.
+     * This is useful in case you don't want an invalid message to throw an error.
+     * @param message - the message to decrypt
+     * @param sharedKey - the shared key to use for decryption
+     * @param force - whether to force decryption or not
+     */
+    static decrypt: (message: Message, sharedKey: EcdhSharedKey, force?: boolean) => IDecryptMessage;
+    /**
+     * Serialize into a JSON object
+     */
+    toJSON(): IJsonPCommand;
+    /**
+     * Deserialize into a PCommand instance
+     * @param json
+     * @returns a PCommand instance
+     */
+    static fromJSON(json: IJsonPCommand): PCommand;
+}
+//# sourceMappingURL=PCommand.d.ts.map

package/build/ts/commands/PCommand.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PCommand.d.ts","sourceRoot":"","sources":["../../../ts/commands/PCommand.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,KAAK,SAAS,EAEd,KAAK,aAAa,EAGnB,MAAM,uBAAuB,CAAC;AAI/B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAE7C,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,QAAQ,CAAC;IAClB,SAAS,EAAE,SAAS,CAAC;CACtB;AAED;;;GAGG;AACH,qBAAa,QAAQ;IACnB,UAAU,EAAE,MAAM,CAAC;IAEnB,SAAS,EAAE,MAAM,CAAC;IAElB,eAAe,EAAE,MAAM,CAAC;IAExB,aAAa,EAAE,MAAM,CAAC;IAEtB,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;;OASG;gBAED,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,eAAe,EAAE,MAAM,EACvB,aAAa,EAAE,MAAM,EACrB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,IAAI,GAAE,MAAwB;IAkBhC;;;OAGG;IACH,IAAI,GAAI,CAAC,SAAS,QAAQ,OAAK,CAAC,CASZ;IAEpB;;;;;OAKG;IACH,OAAO,QAAO,MAAM,EAAE,CAcpB;IAEF,eAAe,QAAO,MAAM,EAAE,CAAmB;IAKjD,MAAM,GAAI,SAAS,QAAQ,KAAG,OAAO,CAOR;IAE7B,IAAI,QAAO,MAAM,CAA0B;IAE3C;;OAEG;IACH,IAAI,GAAI,SAAS,OAAO,KAAG,SAAS,CAAqD;IAEzF;;;;OAIG;IACH,eAAe,GAAI,WAAW,SAAS,EAAE,QAAQ,MAAM,KAAG,OAAO,CACL;IAE5D;;;;;;;;;OASG;IACH,OAAO,GAAI,WAAW,SAAS,EAAE,WAAW,aAAa,KAAG,OAAO,CAUjE;IAEF;;;;;;;OAOG;IACH,MAAM,CAAC,OAAO,GAAI,SAAS,OAAO,EAAE,WAAW,aAAa,EAAE,eAAa,KAAG,eAAe,CAyC3F;IAEF;;OAEG;IACH,MAAM,IAAI,aAAa;IAYvB;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,aAAa,GAAG,QAAQ;CAa/C"}