Skip to content

Latest commit

 

History

History

prover

README.md

go-rapidsnark prover

A go wrapper for the RapidSNARK C++ library.

To use this module you either need to have RapidSNARK library available on your build host or have one of the supported architectures to use vendored pre-built libraries for convenience.

Dependencies

  • C/C++ compiler and standard libraries available
  • glibc version >= 2.31
  • OpenMP

On Ubuntu it would be enough to install build-essential and libomp-dev packages.

If you build your project using golang Docker container, all tools are already installed.

To run compiled project on Alpine linux you would need to install there libstdc++, gcompat and libgomp packages.

Build using pre-built vendored RapidSNARK library.

For the following architectures, pre-built vendored libraries are included:

  • MacOS x86_64
  • MacOS ARM64 Apple Silicon
  • Linux x86_64
  • Linux ARM64 v8

Performance optimization on x86_64 hardware

Rapidsnark has optimization for recent x86_64 processors that gives ~2x speed boost, but older hardware may lack support for ADX and BMI2 instruction sets used. If you have such hardware, you may want to disable assembly optimizations by specifying rapidsnark_noasm build tag. By default, optimizations are ON.

MacOS build there is no way to disable assembly optimizations with build tags. You need to build your custom library with disabled optimizations. And build the library with dynamic tag to use it instead of vendored one.

go build -tags rapidsnark_noasm
go test -tags rapidsnark_noasm

Performance optimization on arm64 hardware

We used NEON instruction set, and it is always enabled, so no build tags are needed.

Build using custom RapidSNARK library.

You need gmp and rapidsnark libraries available on build host.

Supposed all needed files are in following directories:

  • prover.h is located in ${HOME}/src/rapidsnark/src
  • librapidsnark.a is located in ${HOME}/src/rapidsnark/build_prover/src
  • libgmp.a is located in ${HOME}/src/rapidsnark/depends/gmp/package/lib
export CGO_CFLAGS="-I${HOME}/src/rapidsnark/src" 
export CGO_LDFLAGS="-L${HOME}/src/rapidsnark/build_prover/src -L${HOME}/src/rapidsnark/depends/gmp/package/lib"
go build -tags dynamic

Tag dynamic is required to exclude usage of vendored libraries.

Examples

Library usage example is available in /cmd/proof/ directory.