Skip to content

Commit

Permalink
docs: add doc entries for new maci version (currently being developed)
Browse files Browse the repository at this point in the history
add docs for maci v1.3-alpha, which will include changes to the protocol and thus allow to keep the
docs for version up to 1.2 untouched and available for users who want a stable MACI version.
  • Loading branch information
ctrlc03 committed Apr 5, 2024
1 parent 849b49f commit e236bcd
Show file tree
Hide file tree
Showing 116 changed files with 10,567 additions and 16 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ solc
cli/tally.json
**/test_tally.json
**/tally.json
**/subsidy.json
integrationTests/test_tally.json
integrationTests/artifacts/**
deployedAddresses.json
Expand Down
1 change: 0 additions & 1 deletion circuits/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ The main circuits are:

- `processMessages.circom`
- `tallyVotes.circom`
- (optional) `subsidy.circom`

The rest of the circuits are utilities templates that are required for the main circuits to work correctly. These include utilities such as float math, conversion of private keys, and Poseidon hashing/encryption.

Expand Down
1 change: 0 additions & 1 deletion cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
"test:ceremony": "ts-mocha --exit tests/ceremony-params/ceremonyParams.test.ts",
"test:e2e": "ts-mocha --exit tests/e2e/e2e.test.ts",
"test:e2e-non-qv": "ts-mocha --exit tests/e2e/e2e.nonQv.test.ts",
"test:e2e-subsidy": "ts-mocha --exit tests/e2e/e2e.subsidy.test.ts",
"test:keyChange": "ts-mocha --exit tests/e2e/keyChange.test.ts",
"test:unit": "nyc ts-mocha --exit tests/unit/*.test.ts",
"test:airdrop": "nyc ts-mocha --exit tests/unit/airdrop.test.ts",
Expand Down
1 change: 0 additions & 1 deletion contracts/deploy-config-example.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
"Poll": {
"pollDuration": 30,
"coordinatorPubkey": "macipk.9a59264310d95cfd8eb7083aebeba221b5c26e77427f12b7c0f50bc1cc35e621",
"subsidyEnabled": false,
"useQuadraticVoting": true
}
}
Expand Down
7 changes: 5 additions & 2 deletions website/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ npm-debug.log*
yarn-debug.log*
yarn-error.log*

versioned_docs/version-v1.x/solidity-docs
versioned_docs/version-v1.x/typedoc
versioned_docs/version-v1.2/solidity-docs
versioned_docs/version-v1.2/typedoc
versioned_docs/version-v1.3_alpha/typedoc/
versioned_docs/version-v1.3_alpha/solidity-docs/

typedoc
2 changes: 1 addition & 1 deletion website/src/scripts/setupSolidityDocs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import path from "path";
import { copyDirectory, insertIndexPage } from "./utils";

// where to move the solidity doc files over
const solidityDocDir = path.resolve(__dirname, "../../versioned_docs/version-v1.x/solidity-docs");
const solidityDocDir = path.resolve(__dirname, "../../versioned_docs/version-v1.3_alpha/solidity-docs");
// the origin folder (from the contracts package)
const sourceDir = path.resolve(__dirname, "../../../contracts/docs");

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Public key: macipk.946c756cb8588f7169d37e23a98b92051359d64321cf7372a75757b5e9d55
Private key: macisk.08a06aef74c7f6a6f73704e30677418731bc738500f4e6c63dbfe41af8d6719c
```

### Generate MACI keys
### Generate MACI keys

You can generate MACI keys using the following cli utility.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,12 +113,6 @@ Edit `circuits/circom/circuits` to include the circuits you would like to compil
"template": "TallyVotesNonQv",
"params": [10, 1, 2],
"pubs": ["inputHash"]
},
"SubsidyPerBatch_10-1-2_test": {
"file": "subsidy",
"template": "SubsidyPerBatch",
"params": [10, 1, 2],
"pubs": ["inputHash"]
}
}
```
Expand Down
Loading

0 comments on commit e236bcd

Please sign in to comment.