Arnau Bennassar
    • Create new note
    • Create a note from template
      • Sharing URL Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Customize slides
      • Note Permission
      • Read
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Write
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Engagement control Commenting, Suggest edit, Emoji Reply
      • Invitee
      • No invitee
    • Publish Note

      Publish Note

      Everyone on the web can find and read all notes of this public team.
      Once published, notes can be searched and viewed by anyone online.
      See published notes
      Please check the box to agree to the Community Guidelines.
    • Commenting
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
      • Everyone
    • Suggest edit
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
    • Emoji Reply
    • Enable
    • Versions and GitHub Sync
    • Note settings
    • Engagement control
    • Transfer ownership
    • Delete this note
    • Save as template
    • Insert from template
    • Import from
      • Dropbox
      • Google Drive
      • Gist
      • Clipboard
    • Export to
      • Dropbox
      • Google Drive
      • Gist
    • Download
      • Markdown
      • HTML
      • Raw HTML
Menu Note settings Sharing URL Create Help
Create Create new note Create a note from template
Menu
Options
Versions and GitHub Sync Engagement control Transfer ownership Delete this note
Import from
Dropbox Google Drive Gist Clipboard
Export to
Dropbox Google Drive Gist
Download
Markdown HTML Raw HTML
Back
Sharing URL Link copied
/edit
View mode
  • Edit mode
  • View mode
  • Book mode
  • Slide mode
Edit mode View mode Book mode Slide mode
Customize slides
Note Permission
Read
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Write
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Engagement control Commenting, Suggest edit, Emoji Reply
Invitee
No invitee
Publish Note

Publish Note

Everyone on the web can find and read all notes of this public team.
Once published, notes can be searched and viewed by anyone online.
See published notes
Please check the box to agree to the Community Guidelines.
Engagement control
Commenting
Permission
Disabled Forbidden Owners Signed-in users Everyone
Enable
Permission
  • Forbidden
  • Owners
  • Signed-in users
  • Everyone
Suggest edit
Permission
Disabled Forbidden Owners Signed-in users Everyone
Enable
Permission
  • Forbidden
  • Owners
  • Signed-in users
Emoji Reply
Enable
Import from Dropbox Google Drive Gist Clipboard
   owned this note    owned this note      
Published Linked with GitHub
Subscribed
  • Any changes
    Be notified of any changes
  • Mention me
    Be notified of mention me
  • Unsubscribe
Subscribe
# Hermez 1.5 - Merkle Tree spec This document describes the Merkle Tree that will use Hermez 1.5. Basic understanding on how Merkle trees and Merkle proofs work is assumed. ## Glossary - Key: position of a leaf in the tree. - Branch: node of the tree that have children insted of data, e.g: a non-leaf node - Leaf: node of the tree that stores data ## Topology - Hexary (16 child per branch, could be 8 if deemed necessary to reduce complexity in zk circuits) - Number of levels doesn't have to be fixed, because STARK allows to compute it dynamically. Max levels is 64 due to key size. At least 32 levels (we may consider using more levels to avoid collisions. Amount of leafs = `16**levels`. 32 levels ~= 3.4e38) - Sparse ## Keys and paths A key is the index of a leaf. They've to be generated in a way that there are no collisions and are deterministic (same leaf always have the same key). Therefore a convinient way to generate keys is by hashing some content of the leaf that uniquely identifies it. Poseidon hash will be used for that purpose (could be changed). A path is a list of directions that enable navigation from root to a given leaf. Paths are derived from keys by taking the **last** `4bits * (Levels-1)`, each 4 bit group will represent a number (values 0 to 15) that indicates which is the child of the branch that follows the path to the leaf. Since poseidon hashes output 253,59 bits, and 4 bits are needed to encode each direction, the tree can have a maximum of 64 levels: `253.59bits / 4bits = Levels-1`. Keys are Finite Field Elements. Values are numbers between 0 and 2^256-1 (uint256). ## Example Given a tree with 8 levels (for example purposes, the actual implementation will have at least 32 levels), and the following key, the path will be this: Key (in Little Endian encoding): `0x21665a9251173584a82d950b0ea5f3c19297fdce2383ef325d3c01cb30191d10` Path: | | direction | used bits | | ---------- | --------- | --------- | | Root => L1 | 0x0 | 252:256 | | L1 => L2 | 0x1 | 248:252 | | L2 => L3 | 0xd | 244:248 | | L3 => L4 | 0x1 | 240:244 | | L4 => L5 | 0x9 | 236:240 | | L5 => L6 | 0x1 | 232:236 | | L6 => L7 | 0x0 | 228:232 | Graphical representation: <!-- old: ![](https://i.imgur.com/YSYaeqw.png) --> ![](https://i.imgur.com/cuN23kj.png) ## Reference implementation Jordi has done js implementation here: [hermeznetwork/zkproverjs](https://github.com/hermeznetwork/zkproverjs/blob/main/src/smt.js) ## Example of MT creation Initially we have an empty MT, that has zero value as a root hash. For the example purpose it has 5 levels and keys are 2 bytes long (4 bits * 4). ### Step 1 Adding first leaf to sparse MT: * Key: `0x4321` * Value: `0x66` Leafs: | Key (LE) | Path | Value | Real Path | Hash | | -------- | ---- | ----- | --------- | ------------------------- | | 4321 | 1234 | 66 | - | H[1,1234,66,0,0,0,0,0..0] | Merkle root hash equals to the hash of the leaf node, which is `H[1,1234,66,0,0..0]`, since there's no other leaves in the tree. `keyPrime` equals to Path. Graphical representation: ![one leaf](https://i.imgur.com/RmxHyCF.png) * *Yellow nodes need (re)calculation* ### Step 2 Adding second leaf: * Key: `0x4421` * Value: `0x77` Leafs: | Path | Value | Real Path | Hash | | ------ | -------- | --------- | -------------------- | | 1234 | 66 | 123 | H[1,4,66,0,0,0,0..0] | | 1244 | 77 | 124 | H[1,4,77,0,0,0,0..0] | Graphical representation: ![two leaves](https://i.imgur.com/KqR96E8.png) * *Yellow nodes need (re)calculation* ### Step 3 Adding third leaf: * Key: `0x6541` * Value: `0x88` Leafs: | Path | Value | Real Path | Hash | | ------ | -------- | --------- | --------------------- | | 1234 | 66 | 123 | H[1,4,66,0,0,0,0..0] | | 1244 | 77 | 124 | H[1,4,77,0,0,0,0..0] | | 1456 | 88 | 14 | H[1,56,88,0,0,0,0..0] | Graphical representation: ![three leaves](https://i.imgur.com/I69k5zZ.png) * *Yellow nodes need (re)calculation* ### Step 4 Adding fourth leaf: * Key: `0x5541` * Value: `0x99` Leafs: | Path | Value | Real Path | Hash | | ------ | -------- | --------- | --------------------- | | 1234 | 66 | 123 | H[1,4,66,0,0,0,0..0] | | 1244 | 77 | 124 | H[1,4,77,0,0,0,0..0] | | 1455 | 99 | 145 | H[1,5,99,0,0,0,0..0] | | 1456 | 88 | 145 | H[1,6,88,0,0,0,0..0] | Graphical representation: ![four leaves](https://i.imgur.com/xJlQOM1.png) * *Yellow nodes need (re)calculation* ## Nodes Hermez 1.5 has 2 categories of nodes: - Leafs: node of the tree that instead of pointing to other nodes, it holds data. There is 4 types of leafs: - Nonce: Counter of transactions made by an account - Balance: amount of Ether holded by an account - SC code: code of a smart contract - SC storage: persistent data stored by a smart contract - Branches: node of the tree that point to other nodes. Generic schema to generate node hash: `poseidon.Hash(1, keyPrime, V0, V1, V2, V3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)` where: - `keyPrime` - is a remaining part of the key, depends on a position of the Leaf in the Tree - `V0, V1, V2, V3` - parts of Value split in 64 bit chunks <table> <tr> <th colspan="4"><center>Value, 256 bits</center></th> </tr> <tr> <td>MSB</td> <td></td> <td></td> <td>LSB</td> </tr> <tr> <td>64 bits</td> <td>64 bits</td> <td>64 bits</td> <td>64 bits</td> </tr> <tr> <td>V3</td> <td>V2</td> <td>V1</td> <td>V0</td> </tr> </table> - `0 .. 0` - zero padding to get 16 inputs to poseidon hash in total, in this case 10 additional zero values ### Branch (middle node) - Value: array of 16 poseidon hashes - Key: - - Hash: `poseidon.Hash(hashChild0, hashChild1, ..., hashChild15)` ## Proofs Proofs are very similar to the implementation used in Hermez 1.0. ### Proof of leaf inclusion in Merkle Tree This type of proof is needed to prove that a key in Merkle Tree has specific value. Structure of the proof from a reference implementation: ```json { root: root, key: key, value: value, siblings: siblings, isOld0: isOld0, // true if leaf hash is 0 insKey: insKey, insValue: insValue, } ``` ### Proof of leaf update This type of proof is needed as an input for the ZKP, to prove the transiction from one state `state A` to the next one `state B`. Structure of the proof from a reference implementation: ```json { oldRoot: oldRoot, newRoot: newRoot, key: key, siblings: siblings, // array [level][keys[level]] bytes, insKey: insKey, insValue: insValue, isOld0: isOld0, // true if previous leaf hash was 0 oldValue: oldValue, newValue: value, } ``` --- # Hermez specific Leaf Types ### Balance - Value: unsigned integer of 256 bits - Key: key is generated by hashing the Ethereum address and a constant with value 0 using Poseidon: `key = poseidon.Hash(ethAddrBytes[0:8], ethAddrBytes[8:16], ethAddrBytes[16:24], 0, 0..0)` - Hash: `poseidon.Hash(1, keyPrime, balanceBytes[0:8], balanceBytes[8:16], balanceBytes[16:24], balanceBytes[24:32], 0..0)` ### Nonce - Value: unsigned integer of 256 bits - Key: key is generated by hashing the Ethereum address and a constant with value 1 using Poseidon: `key = poseidon.Hash(ethAddrBytes[0:8], ethAddrBytes[8:16], ethAddrBytes[16:24], 1, 0..0)` - Hash: `poseidon.Hash(1, keyPrime, nonceBytes[0:8], nonceBytes[8:16], nonceBytes[16:24], nonceBytes[24:32], 0..0)` ### SC Code - Value: byte array that represents the compiled code - Key: key is generated by hashing the Ethereum address and a constant with value 2 using Poseidon: `key = poseidon.Hash(ethAddrBytes[0:8], ethAddrBytes[8:16], ethAddrBytes[16:24], 2, 0..0)` - Hash: ![](https://i.imgur.com/ggTVdl6.png) - Splitting the bytecode into chunks of 15 elements (16 the first one) and hashing the 15 elements and the hash of the previous chunk - Pad 0 bytes until fulfill the poseidon inputs - `poseidon.Hash(1, keyPrime, byteCodeHash[0:8], byteCodeHash[8:16], byteCodeHash[16:24], byteCodeHash[24:32], 0..0)` - example: ``` bytecode: "0x1234" only one poseidon with 16 elements [ "123400000000000...000", (31 bytes) (element 0) "000...00000000000000 0", (31 bytes) (element 1) "000...00000000000000 0", (31 bytes) (element 2) ... "000...00000000000000 0" (31 bytes) (element 15) ] ``` ### SC storage - Value: 256 bits that will be interpreted by the SC - Key: key is generated by hashing the Ethereum address and a constant with value 3 and the position of the storage that is being accessed: `key = poseidon.Hash(ethAddrBytes[0:8], ethAddrBytes[8:16], ethAddrBytes[16:24], 3, storagePositionBytes[0:8], storagePositionBytes[8:16], storagePositionBytes[16:24], storagePositionBytes[24:32], 0..0)` - Hash: `poseidon.Hash(1, keyPrime, valueBytes[0:8], valueBytes[8:16], valueBytes[16:24], valueBytes[24:32], 0..0)` <!-- *This is not 100% confirmed yet* The node will not need to generate Merkle proofs in a conventional way, instead it will collect and provide the necessary information to generate them. This information will consist on the hashes of all the relevant leafs and branches, presented as a key-value object: ```json { "storage": { "*key": "*value" } } ``` - `*key`: hash of the tree node as described on the `Nodes` section - `*value`: value of the tree node described on the `Nodes` section ## Flow / usage Description of how is the MT going to be used ### State updates Process a batch of transactions that it's going to result in a new state (root). There is no need to calculate intermediary states, and it's safe to implement multi-insert techniques to avoid calculating the hash of some branches many times (e.g: root hash should be computed only once). ### Proof generation *This is not 100% confirmed yet* Proofs are needed as inputs for the ZKP, to prove the transiction from one state `state A` to the next one `state B`. It's not 100% clear how this proofs are going to be generated, but it's very likely to be doable using two different approaches: - Proof is generated at synchronization time: when a new "virtual" batch is being processed, already generate the proof - PROS: Faster for proof generation - CONS: Proofs could be generated way ahead of time. Could be slower for other purposes (RPC, Sequencer) - Proof is generated after batch is processed and root is updated - PROS: generate the proof at any time, aggregator access the MT in `read only` mode - CONS: Slower ### Uncommited processing Process transactions without updating the root nor generating proofs. The only goal is to know what transactions are valid if executed sequentaly starting at a given state (last block). ### RPC queries Read state at any block --- # Q&A ## MT questions This questions are meant to clarify the design of the MT, taking special care of the limitations that arise by working with ZK technology > Q: Merge `nonce` and `balance` leafs? A: ## EVM <===> MT questions This questions are meant to clarify how the integration of the MT with the PolygonSDK can be made > Q: How is the root of the storage account handled? A: --- <!-- # Interface **WIP!** Proposal of an interface that is as close as posible to PolygonSDK, but at the same time fit the requirements of the MT and the potential hacks to improve performance. ```go type State struct { // NewBlockProcessor creates a BlockProcessor starting at the state represented by root func NewBlockProcessor(root hash) BlockProcessor } type BlockProcessor interface { // Commit consolidates changes to the underlaying State, and updates the root func Commit() root // Rollback discards all the state changes done using this BlockProcessor func Rollback() func NewTxProcessor() TxProcessor } type TxProcessor interface { // Host is the interface used to interact with the EVM Host // Commit consolidates changes to the underlaying BlockProcessor func Commit() // Rollback discards all the state changes done using this TxProcessor func Rollback() } // https://github.com/0xPolygon/polygon-sdk/blob/develop/state/runtime/runtime.go#L57 type Host interface { AccountExists(addr types.Address) bool GetStorage(addr types.Address, key types.Hash) types.Hash SetStorage(addr types.Address, key types.Hash, value types.Hash, config *chain.ForksInTime) StorageStatus GetBalance(addr types.Address) *big.Int GetCodeSize(addr types.Address) int GetCodeHash(addr types.Address) types.Hash GetCode(addr types.Address) []byte Selfdestruct(addr types.Address, beneficiary types.Address) GetTxContext() TxContext GetBlockHash(number int64) types.Hash EmitLog(addr types.Address, topics []types.Hash, data []byte) Callx(*Contract, Host) *ExecutionResult Empty(addr types.Address) bool GetNonce(addr types.Address) uint64 } ``` --> <!-- Leaf Nodes Leaf = Hash([1, key', V0, V1, V2, V3, 0, ...., 0]) -->

Import from clipboard

Advanced permission required

Your current role can only read. Ask the system administrator to acquire write and comment permission.

This team is disabled

Sorry, this team is disabled. You can't edit this note.

This note is locked

Sorry, only owner can edit this note.

Reach the limit

Sorry, you've reached the max length this note can be.
Please reduce the content or divide it to more notes, thank you!

Import from Gist

Import from Snippet

or

Export to Snippet

Are you sure?

Do you really want to delete this note?
All users will lose their connection.

Create a note from template

Create a note from template

Oops...
This template is not available.
Upgrade
All
  • All
  • Team
No template found.

Create custom template

Upgrade

Delete template

Do you really want to delete this template?
Turn this template into a regular note and keep its content, versions, and comments.

This page need refresh

You have an incompatible client version.
Refresh to update.
New version available!
See releases notes here
Refresh to enjoy new features.
Your user state has changed.
Refresh to load new user state.

Sign in

Forgot password

or

By clicking below, you agree to our terms of service.

Sign in via Facebook Sign in via Twitter Sign in via GitHub Sign in via Dropbox Sign in with Wallet
Wallet ( )
Connect another wallet

New to HackMD? Sign up

Help

  • English
  • 中文
  • Français
  • Deutsch
  • 日本語
  • Español
  • Català
  • Ελληνικά
  • Português
  • italiano
  • Türkçe
  • Русский
  • Nederlands
  • hrvatski jezik
  • język polski
  • Українська
  • हिन्दी
  • svenska
  • Esperanto
  • dansk

Documents

Help & Tutorial

How to use Book mode

How to use Slide mode

API Docs

Edit in VSCode

Install browser extension

Get in Touch

Feedback

Discord

Send us email

Resources

Releases

Pricing

Blog

Policy

Terms

Privacy

Cheatsheet

Syntax Example Reference
# Header Header 基本排版
- Unordered List
  • Unordered List
1. Ordered List
  1. Ordered List
- [ ] Todo List
  • Todo List
> Blockquote
Blockquote
**Bold font** Bold font
*Italics font* Italics font
~~Strikethrough~~ Strikethrough
19^th^ 19th
H~2~O H2O
++Inserted text++ Inserted text
==Marked text== Marked text
[link text](https:// "title") Link
![image alt](https:// "title") Image
`Code` Code 在筆記中貼入程式碼
```javascript
var i = 0;
```
var i = 0;
:smile: :smile: Emoji list
{%youtube youtube_id %} Externals
$L^aT_eX$ LaTeX
:::info
This is a alert area.
:::

This is a alert area.

Versions and GitHub Sync
Upgrade to Prime Plan

  • Edit version name
  • Delete

revision author avatar     named on  

More Less

No updates to save
Compare
    Choose a version
    No search result
    Version not found
Sign in to link this note to GitHub
Learn more
This note is not linked with GitHub
 

Feedback

Submission failed, please try again

Thanks for your support.

On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

Please give us some advice and help us improve HackMD.

 

Thanks for your feedback

Remove version name

Do you want to remove this version name and description?

Transfer ownership

Transfer to
    Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

      Link with GitHub

      Please authorize HackMD on GitHub
      • Please sign in to GitHub and install the HackMD app on your GitHub repo.
      • HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.
      Learn more  Sign in to GitHub

      Push the note to GitHub Push to GitHub Pull a file from GitHub

        Authorize again
       

      Choose which file to push to

      Select repo
      Refresh Authorize more repos
      Select branch
      Select file
      Select branch
      Choose version(s) to push
      • Save a new version and push
      • Choose from existing versions
      Include title and tags
      Available push count

      Upgrade

      Pull from GitHub

       
      File from GitHub
      File from HackMD

      GitHub Link Settings

      File linked

      Linked by
      File path
      Last synced branch
      Available push count

      Upgrade

      Danger Zone

      Unlink
      You will no longer receive notification when GitHub file changes after unlink.

      Syncing

      Push failed

      Push successfully