refactor!: use `maybeGetSemaphoreSnarkArtifacts` from `@zk-kit/utils - Githubissues

semaphore-protocol / semaphore

A zero-knowledge protocol for anonymous interactions.

https://semaphore.pse.dev

MIT License

883 stars 193 forks source link

refactor!: use `maybeGetSemaphoreSnarkArtifacts` from `@zk-kit/utils #747

Closed sripwoud closed 4 months ago

sripwoud commented 4 months ago

Description

This PRs uses the maybeGetSemaphoreSnarkArtifacts function added in https://github.com/privacy-scaling-explorations/zk-kit/pull/240.
It deletes code that becomes unnecessary in @semaphore-protocol/proof.

Notes about docs:

v4: I haven't found any reference to artifacts in the docs, so no changes to do
v3: there is a reference to a download-snark-artifacts.ts script file, didn't do any changes there either as this PR impacts v4 only

Breaking change

Change	Before	After
`SnarkArtifacts` keys (optional param of `generateProof`)	`{ wasmFilePath, zkeyFilePath }`	`{ wasm, zkey }`

Related Issue(s)

Closes #746

Checklist

[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my code
[ ] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[x] I have run yarn prettier and yarn lint without getting any errors
[ ] I have added tests that prove my fix is effective or that my feature works
[x] New and existing unit tests pass locally with my changes
[x] Any dependent changes have been merged and published in downstream modules

sripwoud commented 4 months ago

@sripwoud this PR introduces a breaking change (the SnarkArtifacts type has different property names). Worth mentioning it.

Done. Update PR title and description