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

chore: Add release notes + update upa version #90

Merged
merged 1 commit into from
Nov 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions upa/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,33 @@ See [DEVELOPMENT.md].

## Release notes

### V2.0.x
UPA `V2` supports submission of Groth16 proofs to an off-chain submission
endpoint, allowing users to save the gas cost of submitting on-chain. The
`upa` tool has been updated to support this new feature.

The `upa off-chain` subcommand has been added to the `upa` tool.
This subcommand allows users to perform various actions related to
submitting Groth16 proofs off-chain. The `upa off-chain` subcommand
supports the following subcommands:

- submit - Submit a set of proofs to an off-chain aggregator
- deposit - Deposit ETH into an aggregator's deposits contract
- init-withdrawal - Initiate a withdrawal
- withdraw - Withdraw deposit. Must `init-withdrawal` before notice period
- balance - View the balance of an address
- withdraw-at-block - View the block at which an address can withdraw
- refund-fee - Refund a submission not aggregated within agreed expiry time
- get-state - Get the submitter state held by an off-chain aggregator
- get-parameters - Get the current parameters for an off-chain aggregator

Note depositing into the aggregator's deposits contract is required before
submitting proofs off-chain. This is because protocol fees can no longer be collected at submission time.
Deposits can be withdrawn but there is a notice period before withdrawal is allowed, to prevent any attacks.
In UPA's off-chain protocol, aggregator's agree to a block number by which the submission will
be aggregated. If the submission is not aggregated by this block number, the
submitter can get a fee refund.

### V1.2.x

The `Proof` and `VerifyingKey` objects, representing Groth16 proofs and keys
Expand Down
2 changes: 1 addition & 1 deletion upa/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@nebrazkp/upa",
"license": "MIT",
"version": "2.0.1",
"version": "2.0.2",
"description": "UPA contracts, client SDK and tools",
"repository": "https://github.com/nebrazkp/upa",
"exports": {
Expand Down
Loading