Skip to content

Latest commit

 

History

History
102 lines (59 loc) · 2.69 KB

README.md

File metadata and controls

102 lines (59 loc) · 2.69 KB
Raw

rapidsnark

This library is Swift wrapper for the Rapidsnark. It enables the generation of proofs for specified circuits within an iOS environment.

Platform Support

iOS: Compatible with any iOS device with 64 bit architecture.

Version for emulator built without assembly optimizations, resulting in slower performance.

macOS: Not supported yet.

Requirements

  • iOS 12.0+

Installation

rapidsnark is available through CocoaPods and SPM. To install it, simply add the following line to your Podfile:

pod 'rapidsnark'

or add it to your project SPM dependencies in XCode.

Usage

groth16ProveWithZKeyFilePath

Generates a proof and public signals using a .zkey file path and witness data buffer.

Reads .zkey file directly from filesystem.

import rapidsnark

let zkeyPath = "path/to/zkey"
let witness = Data(/* witness data */)
let (proof, inputs) = try groth16ProveWithZKeyFilePath(zkeyPath: zkeyPath, witness: witness)

groth16Verify

Verifies proof and public signals against verification key.

let isValid = try groth16Verify(proof: proof, inputs: publicSignals, verificationKey: verificationKey)

groth16Prove

Function that takes zkey and witness files encoded as base64.

proof and publicSignals are base64 encoded strings.

Large circuits might cause OOM. Use with caution.

import rapidsnark

// ...

let (proof, inputs) = try groth16Prove(zkey: zkeyFile, witness: witness)

groth16PublicSizeForZkeyFile

Calculates public buffer size for specified zkey.

import rapidsnark

// ...

let bufferSize = try groth16PublicSizeForZkeyFile(zkeyPath: zkeyPath)

Public buffer size

Both groth16Prove and groth16ProveWithZKeyFilePath has an optional proofBufferSize, publicBufferSize and errorBufferSize parameters. If publicBufferSize is too small it will be calculated automatically by library.

These parameters are used to set the size of the buffers used to store the proof, public signals and error.

If you have embedded circuit in the app, it is recommended to calculate the size of the public buffer once and reuse it. To calculate the size of public buffer call groth16PublicSizeForZkeyFile.

Example

To run the example project, clone the repo, and run pod install from the Example directory first. Then open the rapidsnark.xcworkspace file in XCode and run it on iOS device or simulator.

License

ios-rapidsnark is part of the iden3 project copyright 2021 0KIMS association and published with LGPL-3 license. Please check the COPYING file for more details.