@semaphore-protocol/proof 4.0.0-beta.1 → 4.0.0-beta.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -78,7 +78,7 @@ group: _Group_,
78
78
  message: _BigNumberish_ | _Uint8Array_ | string,
79
79
  scope: _BigNumberish_ | _Uint8Array_ | string,
80
80
  merkleTreeDepth: _number_,
81
- snarkArtifacts?: _SnarkArtifacts_
81
+ snarkArtifacts?: [_SnarkArtifacts_](https://github.com/privacy-scaling-explorations/zk-kit/blob/88acdc6d8fa5f3f2a8ecd1e1a0140244b970c551/packages/utils/src/types/index.ts#L46)
82
82
  ): Promise\<_SemaphoreProof_>
83
83
 
84
84
  ```typescript
@@ -95,15 +95,17 @@ const group = new Group([identity1.commitment, identity2.commitment, identity3.c
95
95
  const message = "Hello world"
96
96
  const scope = "Semaphore"
97
97
 
98
+ // snarkArtifacts are not provided.
99
+ // So they will be automatically downloaded (see https://github.com/privacy-scaling-explorations/snark-artifacts).
98
100
  const proof1 = await generateProof(identity1, group, message, scope)
99
101
 
100
102
  // You can also specify the maximum tree depth supported by the proof.
101
103
  const proof2 = await generateProof(identity2, group, message, scope, 20)
102
104
 
103
- // You can also specify the default zkey/wasm files.
105
+ // You can also override our default zkey/wasm files.
104
106
  const proof3 = await generateProof(identity3, group, message, scope, 20, {
105
- wasmFilePath: "./semaphore.wasm",
106
- zkeyFilePath: "./semaphore.zkey"
107
+ wasm: "./semaphore.wasm",
108
+ zkey: "./semaphore.zkey"
107
109
  })
108
110
  ```
109
111