https://github.com/scroll-tech/zktrie-ng

https://github.com/scroll-tech/zktrie-ng

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/scroll-tech/zktrie-ng
• Owner: scroll-tech
• Created: 2024-09-12T07:08:07.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-11-20T05:38:23.000Z (about 1 year ago)
• Last Synced: 2025-09-17T22:49:37.639Z (4 months ago)
• Language: Rust
• Size: 243 KB
• Stars: 7
• Watchers: 2
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# zkTrie-ng

[![book](https://img.shields.io/badge/book-latest-blue)](https://scroll-tech.github.io/zktrie-ng/index.html)

[![docs](https://img.shields.io/badge/docs-latest-blue)](https://scroll-tech.github.io/zktrie-ng/docs/zktrie_ng/index.html)

![CI Status](https://img.shields.io/github/actions/workflow/status/scroll-tech/zktrie-ng/CI)

Full-featured zkTrie implementation in Rust.

## Example

```rust

use zktrie_ng::{

    trie,

    hash::{

        key_hasher::NoCacheHasher,

        poseidon::Poseidon,

    },

    db::{HashMapDb, SledDb},

};

// A ZkTrie using Poseidon hash scheme,

// HashMap as backend kv database and NoCacheHasher as key hasher.

type ZkTrie = trie::ZkTrie;

// Or you can store the zkTrie data in a sled database.

// type ZkTrie = trie::ZkTrie;

fn main() {

    let mut trie = ZkTrie::new(HashMapDb::new(), NoCacheHasher);

    // or this is default mode

    // let mut trie = ZkTrie::default();

    trie.raw_update(&[1u8; 32], vec![[1u8; 32]], 1).unwrap();

    let values: [[u8; 32]; 1] = trie.get(&[1u8; 32]).unwrap();

    assert_eq!(values[0], [1u8; 32]);

    // zkTrie is lazy, won't update the backend database until `commit` is called.

    assert!(trie.is_dirty());

    trie.commit().unwrap();let mut trie = ZkTrie::new(HashMapDb::new(), NoCacheHasher);

    // or this is default mode

    // let mut trie = ZkTrie::default();

    trie.raw_update(&[1u8; 32], vec![[1u8; 32]], 1).unwrap();

    let values: [[u8; 32]; 1] = trie.get(&[1u8; 32]).unwrap();

    assert_eq!(values[0], [1u8; 32]);

    // zkTrie is lazy, won't update the backend database until `commit` is called.

    assert!(trie.is_dirty());

    trie.commit().unwrap();

}

```

Check the [documentation](https://scroll-tech.github.io/zktrie-ng/zktrie_ng/index.html) for more details.