Project

utreexo

0.0
No commit activity in last 3 years
No release in over 3 years
utreexochaintope/utreexorbHomepageDocumentationSource CodeBug TrackerWiki
The ruby implementation for Utreexo.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
4,406
Stars
3
Forks
0
Watchers
2
 Releases
Current version
0.2.0
Total releases
2
First release
2019-06-16
Latest release
2019-07-02
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2019-07-12
Reverse Dependencies
0

 Dependencies

Development

bundler
>= 0
rake
~> 10.0
rspec
~> 3.0

Runtime

blake2b
>= 0
 Project Readme

Utreexorb Build Status Gem Version MIT License

This library is a Ruby implementation of Utreexo.

Installation

Add this line to your application's Gemfile:

gem 'utreexo'

And then execute:

$ bundle

Or install it yourself as:

$ gem install utreexo

Usage

Add element to forest.

require 'utreexo'

# initialize forest.
f = Utreexo::Forest.new

# add element to forest.
f.add('a00000aa00000000000000000000000000000000000000000000000000000000')
f.add('a00100aa00000000000000000000000000000000000000000000000000000000')
# if you want to tracking proof, set tracking flag to true.
f.add('a00200aa00000000000000000000000000000000000000000000000000000000', true)
f.add('a00300aa00000000000000000000000000000000000000000000000000000000', true)
f.add('a00400aa00000000000000000000000000000000000000000000000000000000', true)

# forest has 2 tree, height 2, height 0
# accumulator root for height 2 tree
f.acc[2]
=> '2d043522d1fc5adfa966a889492acc8b4f924869e18192ad6f4bcb30db6d56c0'
# accumulator root for height 0 tree
f.acc[0]
=> 'a00400aa00000000000000000000000000000000000000000000000000000000'

# show forest.
puts f
07:2d04                         
|---------------\               |---------------\               
05:736b         06:1a8e         
|-------\       |-------\       |-------\       |-------\       
00:???? 01:???? 02:a002 03:a003 04:a004

Get proof

If leaf tracking enabled, you can get its proof. If you add or remove element to the forest, the position and inclusion proof of the leaf being tracked are updated.

proof = f.proof('a00200aa00000000000000000000000000000000000000000000000000000000')
=> [2] leaf = a00200aa00000000000000000000000000000000000000000000000000000000, siblings = ["a00300aa00000000000000000000000000000000000000000000000000000000", "736b3e12120637186a0a8eef8ce45ed69b39119182cc749b793f05de3996f464"]

# get all tracking proofs
proofs = f.proofs

Verify element.

# proof for 3rd element
proof = f.proof('a00200aa00000000000000000000000000000000000000000000000000000000')

f.include?(proof)
=> true

Remove element from forest.

f.remove(proof)

# If delete 3rd element, last item move to 3rd element position, and root hash changed.
f.acc[2]
=> '5fd725b67d4651a8d5153bfea9242322f2d96f152ba3cf9cbce2a7ba694ca0e6'