Merkle Proof Verification

.gitattributes

@@ -0,0 +1,2 @@
+# Syntax highlighting of sway files as rust
+*.sw linguist-language=Rust

README.md

@@ -31,12 +31,19 @@ These libraries contain helper functions, generalized standards, and other tools
 
 ### Libraries
 
-
+- [Binary Merkle Proof](./sway_libs/src/merkle_proof/) is used to verify Binary Merkle Trees computed off-chain.
 
 ## Using a library
 
-If you wish to use any of the libraries then clone this repository and go through the general [installation](https://fuellabs.github.io/sway/latest/introduction/installation.html) steps required to use our tools, and import the library into your contract.
+To import the Merkle Proof library the following should be added to the project's `Forc.toml` file under `[dependencies]`:
+
+<!-- TODO: This should not point to the master branch but instead to a release -->
+`sway_libs = { git = "https://github.com/FuelLabs/sway-libs", branch = "master" }`
+
+You may then import your dersired library in your Sway Smart Contract as so:
+
+`use sway_libs::binary_merkle_proof::verify_proof;`
 
 ## Contributing
 
-Check [CONTRIBUTING.md](./CONTRIBUTING.md) for more info!
+Check [CONTRIBUTING.md](./CONTRIBUTING.md) for more info!

sway_libs/.gitignore

@@ -0,0 +1,2 @@
+out
+target

sway_libs/src/lib.sw

@@ -1 +1,3 @@
 library sway_libs;
+
+dep merkle_proof/binary_merkle_proof;

sway_libs/src/merkle_proof/README.md

@@ -0,0 +1,92 @@
+# Overview
+
+Merkle trees allow for on-chain verification of off-chain data. With the merkle root posted on-chain, the generation of proofs off-chain can provide verifibly true data. 
+
+More information can be found in the [specification](./SPECIFICATION.md).
+
+## Known Issues
+
+Due to the Fuel VM padding of copy types smaller than one word, the current hashing of the leaf and node values do not match RFC-6962. The present implementation is the equavalent of hashing a `u64` as opposed to the standard `u8`. As a result, hashing of smaller sized copy types may result in unexpected behavior. For example, the `sha-256(0u8)` will result in the same hash as `sha-256(0u64)`. This will cause an incompatability with the [Fuel-Merkle](https://github.com/FuelLabs/fuel-merkle) repository. The issue regarding this can be tracked [here](https://github.com/FuelLabs/sway/issues/2594).
+
+# Using the Library
+
+## Using the Merkle Proof Library In Sway
+
+### Importing Into Your Project
+
+To import the Merkle Proof library the following should be added to the project's `Forc.toml` file under `[dependencies]`:
+
+<!-- TODO: This should not point to the master branch but instead to a release -->
+```
+sway_libs = { git = "https://github.com/FuelLabs/sway-libs", branch = "master" }
+```
+
+### Importing Into Your Contract
+
+The following can be added to your Sway Contract's imports to include the Merkle Proof library:
+
+```
+use sway_libs::binary_merkle_proof::verify_proof;
+```
+
+### Using the Merkle Proof Library In Sway
+
+Once imported, using the Merkle Proof library is as simple as calling the desired function. Here is a list of function definitions that you may use:
+
+- `leaf_digest(data: b256) -> b256`
+- `node_digest(left: b256, right: b256) -> b256`
+- `process_proof(key: u64, merkle_leaf: b256, num_leaves: u64, proof: [b256; 2]) -> b256`
+- `verify_proof(key: u64, merkle_leaf: b256, merkle_root: b256, num_leaves: u64, proof: [b256; 2]) -> bool`
+
+> **Note** Fuels-rs does not currently does not support the Sway standard library's `vec` as a function argument. As a result, the current implementation uses an array. 
+
+## Using the Merkle Proof Library in Fuels-rs
+
+To generate a Merkle Tree and corresponding proof for your Sway Smart Contract to use can be done with the [Fuel-Merkle](https://github.com/FuelLabs/fuel-merkle) crate. 
+
+### Importing Into Your Project
+
+The import the Fuel-Merkle crate, the following should be added to the project's `Cargo.toml` file under `[dependencies]`:
+
+```
+fuel-merkle = { version = "0.3" }
+```
+
+### Importing Into Your Rust File
+
+The following should be added to your Rust file to use the Fuel-Merkle crate.
+
+```
+use fuel_merkle::binary::in_memory::MerkleTree;
+```
+
+### Using Fuel-Merkle
+
+#### Generating A Tree
+
+To create a merkle tree using Fuel-Merkle is as simple as pushing your leaves in increasing order. 
+
+```
+let mut tree = MerkleTree::new();
+let leaves = ["A".as_bytes(), "B".as_bytes(), "C".as_bytes()].to_vec();
+for datum in leaves.iter() {
+    tree.push(datum);
+}
+```
+
+#### Generating And Verifying A Proof
+
+To generate a proof for a specific leaf, you must have the index or key of the leaf. Simply call the prove function:
+
+```
+let mut proof = tree.prove(key).unwrap();
+```
+
+Once the proof has been generated, you may call the Sway Smart Contract's `verify_proof` function:
+
+```
+let merkle_root = proof.0;
+let merkle_leaf = proof.1[0];
+proof.1.remove(0);
+contract_instance.verify_proof(key, merkle_leaf, merkle_root, num_leaves, proof.1).call().await;
+```

sway_libs/src/merkle_proof/SPECIFICATION.md

@@ -0,0 +1,29 @@
+# Overview
+
+This document provides an overview of the Merkle Proof library.
+
+It outlines the use cases, i.e. specification, and describes how to implement the library.
+
+# Use Cases
+
+A common use case for Merkle Tree verification is airdrops. An airdrop is a method of distribution a set amount of tokens to a specified number of users. These often include a list of addresses and amounts. By posting the root hash, users can provide a proof and claim their airdrop.
+
+# Specification
+
+All cryptographic primitives follow the [Fuel Specs](https://github.com/FuelLabs/fuel-specs/blob/master/specs/protocol/cryptographic_primitives.md).
+
+## Hashing 
+
+All hashing is done with SHA-2-256 (also known as SHA-256), defined in [FIPS 180-4](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf).
+
+## Merkle Trees
+
+Currently only one tree structure is support, the Binary Merkle Tree. Implementation for a Binary Merkle Sum Tree and Sparse Merkle Tree found in the [fuel-merkle](https://github.com/FuelLabs/fuel-merkle) repository will be added soon. 
+
+A Sparse Merkle Tree proof can be tracked [here](https://github.com/FuelLabs/sway-libs/issues/18) and Sum Merkle Tree proof can be tracked [here](https://github.com/FuelLabs/sway-libs/issues/17);
+
+### Binary Merkle Tree
+
+Binary Merkle trees are constructed in the same fashion as described in [Certificate Transparency (RFC-6962)](https://tools.ietf.org/html/rfc6962). Leaves are hashed once to get leaf node values and internal node values are the hash of the concatenation of their children (either leaf nodes or other internal nodes).
+
+For more information please check out the offical [Fuel Specs](https://github.com/FuelLabs/fuel-specs/blob/master/specs/protocol/cryptographic_primitives.md#binary-merkle-tree).

sway_libs/src/merkle_proof/binary_merkle_proof.sw

@@ -0,0 +1,175 @@
+// TODO: Function definitions that use arrays should be updated to Vecs once
+// https://github.com/FuelLabs/fuels-rs/issues/353 is resolved
+
+library binary_merkle_proof;
+
+use std::{hash::sha256, revert::require};
+
+pub enum ProofError {
+    InvalidKey: (),
+    InvalidProofLength: (),
+}
+
+pub const LEAF = 0u8;
+pub const NODE = 1u8;
+
+/// Returns the computed leaf hash of "MTH({d(0)}) = SHA-256(0x00 || d(0))".
+///
+/// # Arguments
+///
+/// * 'data' - The hash of the leaf data.
+pub fn leaf_digest(data: b256) -> b256 {
+    sha256((LEAF, data))
+}
+
+/// Returns the computed node hash of "MTH(D[n]) = SHA-256(0x01 || MTH(D[0:k]) || MTH(D[k:n]))".
+///
+/// # Arguments
+///
+/// * 'left' - The hash of the left node.
+/// * 'right' - The hash of the right node.
+pub fn node_digest(left: b256, right: b256) -> b256 {
+    sha256((NODE, left, right))
+}
+
+/// Calculates the length of the path to a leaf
+///
+/// # Arguments
+///
+/// * `key` - The key or index of the leaf.
+/// * `num_leaves` - The total number of leaves in the Merkle Tree.
+fn path_length_from_key(key: u64, num_leaves: u64) -> u64 {
+    let mut total_length = 0;
+    let mut num_leaves = num_leaves;
+    let mut key = key;
+
+    while true {
+        // The height of the left subtree is equal to the offset of the starting bit of the path
+        let path_length = starting_bit(num_leaves);
+        // Determine the number of leaves in the left subtree
+        let num_leaves_left_sub_tree = (1 <<(path_length - 1));
+
+        if key <= (num_leaves_left_sub_tree - 1) {
+            // If the leaf is in the left subtreee, path length is full height of the left subtree
+            total_length = total_length + path_length;
+            break;
+        } else if num_leaves_left_sub_tree == 1 {
+            // If the left sub tree has only one leaf, path has one additional step
+            total_length = total_length + 1;
+            break;
+        } else if (num_leaves - num_leaves_left_sub_tree) <= 1 {
+            // If the right sub tree only has one leaf, path has one additonal step
+            total_length = total_length + 1;
+            break;
+        } else {
+            // Otherwise add 1 to height and loop
+            total_length = total_length + 1;
+            key = key - num_leaves_left_sub_tree;
+            num_leaves = num_leaves - num_leaves_left_sub_tree;
+        }
+    }
+
+    total_length
+}
+
+/// This function will compute and return a Merkle root given a leaf and corresponding proof.
+///
+/// # Arguments
+///
+/// * 'key' - The key or index of the leaf to prove.
+/// * `merkle_leaf` - The hash of a leaf on the Merkle Tree.
+/// * 'num_leaves' - The number of leaves in the Merkle Tree.
+/// * `proof` - The Merkle proof that will be used to traverse the Merkle Tree and compute a root.
+///
+/// # Reverts
+///
+/// * When an incorrect proof length is provided.
+/// * When there is one or no leaves and a proof is provided.
+/// * When the key is greater than or equal to the number of leaves.
+/// * When the computed height gets larger than the proof.
+pub fn process_proof(key: u64, merkle_leaf: b256, num_leaves: u64, proof: [b256;
+2]) -> b256 {
+    // let proof_length = proof.len();
+    let proof_length = 2;
+    require((num_leaves > 1 && proof_length == path_length_from_key(key, num_leaves)) || (num_leaves <= 1 && proof_length == 0), ProofError::InvalidProofLength);
+    require(key < num_leaves, ProofError::InvalidKey);
+
+    let mut digest = merkle_leaf;
+    // If proof length is zero then the leaf is the root
+    if proof_length == 0 {
+        return digest
+    }
+
+    let mut height = 1;
+    let mut stable_end = key;
+
+    // While the current subtree is complete, determine the position of the next
+    // sibling using the complete subtree algorithm.
+    while true {
+        // Determine if the subtree is complete.
+        let sub_tree_start_index = (key / (1 << height)) * (1 << height);
+        let sub_tree_end_index = sub_tree_start_index + (1 << height) - 1;
+
+        // If the Merkle Tree does not have a leaf at the `sub_tree_end_index`, we deem that the
+        // subtree is not complete.
+        if sub_tree_end_index >= num_leaves {
+            break;
+        }
+        stable_end = sub_tree_end_index;
+        require(proof_length > height - 1, ProofError::InvalidProofLength);
+
+        // Determine if the key is in the first or the second half of the subtree.
+        if (key - sub_tree_start_index) <(1 <<(height - 1)) {
+            digest = node_digest(digest, proof[height - 1]);
+        } else {
+            digest = node_digest(proof[height - 1], digest);
+        }
+
+        height = height + 1;
+    }
+
+    // Determine if the next hash belongs to an orphan that was elevated.
+    if stable_end != (num_leaves - 1) {
+        require(proof_length > height - 1, ProofError::InvalidProofLength);
+        digest = node_digest(digest, proof[height - 1]);
+        height = height + 1;
+    }
+
+    // All remaining elements in the proof set will belong to the left sibling.
+    while(height - 1) < proof_length {
+        digest = node_digest(proof[height - 1], digest);
+        height = height + 1;
+    }
+
+    digest
+}
+
+/// Calculates the starting bit of the path to a leaf
+///
+/// # Arguments
+///
+/// * `num_leaves` - The number of leaves in the Merkle Tree.
+fn starting_bit(num_leaves: u64) -> u64 {
+    let mut starting_bit = 0;
+
+    while(1 << starting_bit) < num_leaves {
+        starting_bit = starting_bit + 1;
+    }
+
+    starting_bit
+}
+
+/// This function will take a Merkle leaf and proof and return whether the corresponding root
+/// matches the root given.
+///
+/// # Arguments
+///
+/// * 'key' - The key or index of the leaf to verify.
+/// * `merkle_leaf` - The hash of a leaf on the Merkle Tree.
+/// * `merkle_root` - The pre-computed Merkle root that will be used to verify the leaf and proof.
+/// * 'num_leaves' - The number of leaves in the Merkle Tree.
+/// * `proof` - The Merkle proof that will be used to traverse the Merkle Tree and compute a root.
+pub fn verify_proof(key: u64, merkle_leaf: b256, merkle_root: b256, num_leaves: u64, proof: [b256;
+2]) -> bool {
+    process_proof(key, merkle_leaf, num_leaves, proof) == merkle_root
+}

tests/src/Cargo.toml

@@ -6,8 +6,11 @@ edition = "2021"
 license = "Apache-2.0"
 
 [dependencies]
-forc = { version = "0.19" }
-fuels = { version = "0.20" }
+forc = { version = "0.19.1" }
+fuel-core = { version = "0.9.6 "}
+fuel-merkle = { version = "0.3" }
+fuels = { version = "0.19" }
+sha2 = { version = "0.10" }
 tokio = { version = "1.12", features = ["rt", "macros"] }
 
 [[test]]

tests/src/test_projects/harness.rs

@@ -1 +1,3 @@
-// Add test modules here:
+// Add test modules here:
+
+mod merkle_proof;

tests/src/test_projects/merkle_proof/.gitignore

@@ -0,0 +1,2 @@
+out
+target

tests/src/test_projects/merkle_proof/Forc.toml

@@ -0,0 +1,8 @@
+[project]
+authors = ["Fuel Labs <contact@fuel.sh>"]
+entry = "main.sw"
+license = "Apache-2.0"
+name = "merkle_proof"
+
+[dependencies]
+sway_libs = { path = "../../../../sway_libs" }

tests/src/test_projects/merkle_proof/mod.rs

@@ -0,0 +1 @@
+mod tests;