A set of CLIs for creating Multi-Party Computation (MPC) web projects with ease.
MPC-CLI provides a set of interactive command-line tools that simplifies the development of multi-party computation (MPC) web applications with modern web development frameworks (e.g. Next.js, Vite). MPC-CLI is powered by mpc-framework and summon-ts. |
|---|
A streamlined tool for creating Multi-Party Computation (MPC) projects with ease.
npm create @mpc-cli
cd <your-app>
npm install
npm run devThe following templates are currently supported:
- MPC Hello with Vite (client-client)
- MPC Hello with Vite (client-server)
- MPC Hello with Vite (server-server)
- MPC Hello with NextJS (client-client)
- Rock Paper Shissors Lizard Spock (client-client)
- 2PC is for lovers (client-client)
A streamlined CLI to compile Summon circuits.
npx @mpc-cli/summon main.tsOr:
npm i -g @mpc-cli/summon && summonc main.tsClone this repository:
git clone https://github.com/cedoor/mpc-cli.gitAnd install the dependencies:
cd mpc-cli && yarnRun ESLint to analyze the code and catch bugs:
yarn lintRun Prettier to check formatting rules:
yarn formatOr to automatically format the code:
yarn format:writeMPC-CLI uses conventional commits. A command line utility to commit using the correct syntax can be used by running:
git commitIt will also automatically check that the modified files comply with ESLint and Prettier rules.
Run Rollup to build all the packages:
yarn buildBump a new version with:
yarn version:bump <version>
# e.g. yarn version:bump 2.0.0It will create a commit and a git tag that will need to be pushed on the main branch. A workflow will be triggered and will publish the MPC-CLI packages on npm and release a new version on Github with its changelogs automatically.