@nebrazkp/upa v1.0.1
UPA contracts, client SDK and tools
UPA is Nebra's "Universal Proof Aggregator". This package contains the client SDK for buiding apps that leverage the UPA to reduce the cost of on-chain ZKP verification.
This package also includes the upa
tool for interacting with UPA
deployments.
Full documentation is available at docs.nebra.one.
Requirements
- node.js>=18
Installation
$ yarn add @nebrazkp/upa
Run the upa
tool
$ ./node_modules/bin/upa --help
Development
See DEVELOPMENT.md.
Release notes
v1.0.1
upa groth16-verify
tool for offline proof and input data verification- Expose
VerifyingKey
in top-level namespace - Documentation comments for more public types and functions
v1.0.0
This version of the package provides:
- A Typescript library including full support for client-side proof submission and detection of aggregation.
- Solidity contract interfaces and library for on-chain verification from application smart contracts.
- A
upa
CLI tools for performing operations on a deployed instance, as well as for setting up development environments for end-to-end application testing.
NOTE: The SDK defines types application.Proof
and application.VerifyingKey
for Groth16 verifying keys and proofs, describing the format expected for
these objects. Functions to convert from keys and proofs as output from
snarkjs
are also included. Proofs generated by other implementations
(gnark, arkworks, etc) must be converted to the application
types by the
caller (see the definitions of these types in application.d.ts
for details).
Conversion function for more Groth16 implementations will be provided in upcoming versions.