https://github.com/yi-sun/zk-attestor

https://github.com/yi-sun/zk-attestor

Last synced: 27 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/yi-sun/zk-attestor
• Owner: yi-sun
• Created: 2022-01-08T08:24:49.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-04-23T06:51:58.000Z (over 2 years ago)
• Last Synced: 2024-08-03T08:02:35.475Z (4 months ago)
• Language: Python
• Size: 14.5 MB
• Stars: 130
• Watchers: 9
• Forks: 12
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-circom - zk-attestor - Scalable on-chain trustless attestations to data from any past Ethereum block or state (ethereum storage proofs) (Cryptographic primitives / Cryptographic primitives in Circom)

README

        
# zkAttestor

Scalable on-chain trustless attestations to data from any past Ethereum block or state.

## Project overview

This repository provides implementations of account, storage, and transaction proofs for

Ethereum.  Together, these enable a user to generate validity proofs for data from any

current or past Ethereum block or state using a trusted block hash alone.

**These implementations are for demonstration purposes only**.  These circuits are not

audited, and this is not intended to be used as a library for production-grade applications.

## Install dependencies

* Run `yarn` at the top level to install npm dependencies (`snarkjs` and `circomlib`).

* You'll also need `circom` version >= 2.0.2 on your system. Installation instructions [here](https://docs.circom.io/getting-started/installation).

* To work with large circuits, follow the setup instructions at [Best Practices for Large Circuits](https://hackmd.io/V-7Aal05Tiy-ozmzTGBYPA).

* Install Python libraries: [eth-mpt](https://pypi.org/project/eth-mpt), [pysha3](https://pypi.org/project/pysha3),

[rlp](https://pypi.org/project/rlp)

* Building these circuits requires a Powers of Tau file with `2^24` constraints in the `circuits` subdirectory with the name `pot24_final.ptau`. One such file can be downloaded from the Hermez trusted setup [here](https://github.com/iden3/snarkjs#7-prepare-phase-2).

## Building proving keys and witness generation files

We provide three circuits, which enable attestations to all current or

historical Ethereum data available from an archive node with the exception of receipts,

which are WIP:

* `eth_block_hash`: Prove state, transaction, and receipt roots corresponding to a block hash.

* `eth_addr_storage`: Prove the contents of a storage slot for an account from a block hash.

* `eth_tx_proof`: Prove the contents of a transaction from a block hash.

Run `yarn build:eth_block_hash`, `yarn build:eth_addr_storage`, `yarn build:eth_tx_proof` at the

top level to compile proving keys and witness generators for each file.

These circuits are fairly large and require special hardware and setup to run: see

[Best Practices for Large Circuits](https://hackmd.io/V-7Aal05Tiy-ozmzTGBYPA).

## Benchmarks

All benchmarks were run on a 32-core 3.1GHz, 256G RAM machine with 400G swap.

||EthBlockHash|EthAddressStorageProof|EthTransactionProof (< 7.5 kB)|

|---|---|---|---|

|Constraints                          |860K| 13M|16.5M|

|Proving key size                     |418M   |6.4G|7.8G|

|Witness generation                   |1s   |14s    |6s |

|Proving time                         |3s    |25s     |12s|

|Proof verification time              |1s    |1s    |1s |

## Testing

Run `yarn test` at the top level to run tests. Tests are minimal at present and only test

correctness of witness generation.

## Acknowledgements

We use a [circom implementation of keccak](https://github.com/vocdoni/keccak256-circom) from Vocdoni

as well as the [eth-mpt Python library](https://pypi.org/project/eth-mpt) by [popzxc](https://github.com/popzxc)

and the [Ethereum pyrlp](https://github.com/ethereum/pyrlp) library.