Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 10 commits into from
Apr 24, 2024

Conversation

sripwoud
Copy link
Contributor

@sripwoud sripwoud commented Apr 24, 2024

Description

This PRs uses the maybeGetSemaphoreSnarkArtifacts function added in privacy-scaling-explorations/zk-kit#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

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • 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
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@sripwoud sripwoud marked this pull request as ready for review April 24, 2024 10:39
@sripwoud sripwoud marked this pull request as draft April 24, 2024 10:44
@sripwoud sripwoud marked this pull request as ready for review April 24, 2024 10:51
@cedoor cedoor self-requested a review April 24, 2024 13:09
@sripwoud sripwoud force-pushed the refactor/snark-artifacts branch from 78a59ea to c15dc21 Compare April 24, 2024 13:15
@sripwoud sripwoud self-assigned this Apr 24, 2024
@sripwoud sripwoud added dependencies 📦 Upgrades or downgrades in dependencies refactoring ♻️ A code change that neither fixes a bug nor adds a feature labels Apr 24, 2024
Copy link
Member

@cedoor cedoor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

packages/proof/README.md Outdated Show resolved Hide resolved
packages/proof/package.json Outdated Show resolved Hide resolved
packages/proof/src/generate-proof.ts Show resolved Hide resolved
@sripwoud sripwoud changed the title refactor: use maybeGetSemaphoreSnarkArtifacts from `@zk-kit/utils refactor!: use maybeGetSemaphoreSnarkArtifacts from `@zk-kit/utils Apr 24, 2024
@sripwoud
Copy link
Contributor Author

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

Done. Update PR title and description

@sripwoud sripwoud force-pushed the refactor/snark-artifacts branch from b280189 to c15dc21 Compare April 24, 2024 14:02
@sripwoud sripwoud force-pushed the refactor/snark-artifacts branch from 79f34e2 to bcae7be Compare April 24, 2024 14:14
@sripwoud sripwoud requested a review from cedoor April 24, 2024 14:14
@cedoor cedoor merged commit cf1cffd into semaphore-protocol:main Apr 24, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies 📦 Upgrades or downgrades in dependencies refactoring ♻️ A code change that neither fixes a bug nor adds a feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use maybeGetSemaphoreSnarkArtifacts from @zk-kit/utils
2 participants