Skip to content

Commit

Permalink
fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
erhant committed Sep 9, 2024
1 parent d6746a8 commit b655f7c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 23 deletions.
25 changes: 3 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,30 +241,11 @@ You can compute the witness via the `calculateWitness(input)` function. To test
> });
> ```
#### Using C Tester
#### Using C Tester (Work in Progress ⌛)
You can make use of C-based tester as well. There is a prerequisite:
You can make use of the C-tester as well, which performs much better for larger circuits than the WASM alternative.
- Install `nlohmann-json` header that is included within the C code:
- Install `nasm`
- Install `gmp` (GNU Multi-precision Arithmetic Library)
> [!TIP]
>
> If you are using Mac you can do these with brew:
>
> ```sh
>
> # install required stuff
> brew install nlohmann-json
> brew install nasm
> brew install gmp
>
> # add brew to path if required, path may differ M2 / M1
> export CPLUS_INCLUDE_PATH="$CPLUS_INCLUDE_PATH:/opt/homebrew/include/"
> export LIBRARY_PATH="$LIBRARY_PATH:/opt/homebrew/lib"
> export INCLUDE_PATH="$INCLUDE_PATH:/opt/homebrew/include"
> ```
There may be some prerequisites to compile, and we have an [issue on this](https://github.com/erhant/circomkit/issues/88) right now until we can have a complete setup guide.
### Proof Tester
Expand Down
4 changes: 3 additions & 1 deletion tests/witnessTester.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import {Circomkit, WitnessTester} from '../src';
import {prepareMultiplier} from './common';

// TODO: add C tester

describe('witness tester', () => {
let circuit: WitnessTester<['in'], ['out']>;
const {
Expand All @@ -18,7 +20,7 @@ describe('witness tester', () => {
dirInputs: './tests/inputs',
dirBuild: './tests/build',
});
circuit = await circomkit.WitnessTester(name, {...config, recompile: true}, 'c');
circuit = await circomkit.WitnessTester(name, {...config, recompile: true});
});

it('should have correct number of constraints', async () => {
Expand Down

0 comments on commit b655f7c

Please sign in to comment.