utreexo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2db0a1b0bb2ecdc1be9477aee62cce16fc9ea24f1febd7c877f819a986ce6250
+  data.tar.gz: c35c3beafff28204c419f650236856b53e89a87e56270886976742718f399fd3
+SHA512:
+  metadata.gz: 183873eaba066f361498edd47c1e94edc9d6d3bc891babb1443775dc45de345759c20de657e22eea7d2fcab1554228462675bc7cc58ab5939006c805772a1db0
+  data.tar.gz: 885eeb50daefb5b4cea34fc8463c17bed69e51577e92b2eaec2b24111ed3cf51cbc6606ef763d7e501b3a92455b0b2c00ec82bcc6eded81663116211837cf091

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+utreexorb

data/.ruby-version

@@ -0,0 +1 @@
+2.6.2

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.4.5
+  - 2.5.5
+  - 2.6.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at azuchi@chaintope.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in utreexo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 azuchi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# Utreexorb [![Build Status](https://travis-ci.org/chaintope/utreexorb.svg?branch=master)](https://travis-ci.org/chaintope/utreexorb) [![Gem Version](https://badge.fury.io/rb/utreexorb.svg)](https://badge.fury.io/rb/utreexorb) [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)
+
+This library is a Ruby implementation of [Utreexo](https://github.com/mit-dci/utreexo/blob/master/utreexo.pdf).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'utreexo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install utreexo
+
+## Usage
+
+### Add element to forest.
+
+```ruby
+require 'utreexo'
+
+# initialize forest.
+ 
+f = Utreexo::Forest.new
+
+# add element to forest.
+f.add('a00000aa00000000000000000000000000000000000000000000000000000000')
+f.add('a00100aa00000000000000000000000000000000000000000000000000000000')
+f.add('a00200aa00000000000000000000000000000000000000000000000000000000')
+f.add('a00300aa00000000000000000000000000000000000000000000000000000000')
+f.add('a00400aa00000000000000000000000000000000000000000000000000000000')
+
+# 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'
+```
+
+### Verify element.
+
+```ruby
+# proof for 3rd element
+proof = Utreexo::Proof.new(2, 'a00200aa00000000000000000000000000000000000000000000000000000000',
+                                   ['a00300aa00000000000000000000000000000000000000000000000000000000', '736b3e12120637186a0a8eef8ce45ed69b39119182cc749b793f05de3996f464'])
+
+f.include?(proof)
+=> true
+```
+
+### Remove element from forest.
+
+```ruby
+proof = Utreexo::Proof.new(2, 'a00200aa00000000000000000000000000000000000000000000000000000000',
+                          ['a00300aa00000000000000000000000000000000000000000000000000000000', '736b3e12120637186a0a8eef8ce45ed69b39119182cc749b793f05de3996f464'])
+f.remove(proof)
+
+# If delete 3rd element, last item move to 3rd element position, and root hash changed.
+f.acc[2]
+=> '5fd725b67d4651a8d5153bfea9242322f2d96f152ba3cf9cbce2a7ba694ca0e6' 
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "utreexo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/utreexo/forest.rb

@@ -0,0 +1,86 @@
+module Utreexo
+
+  class Forest
+
+    # number of leaves in the forest (bottom row)
+    attr_accessor :num_leaves
+
+    # accumulator
+    attr_accessor :acc
+
+    def initialize
+      @height = 0
+      @num_leaves = 0
+      @forest = []
+      @acc = []
+    end
+
+    # Add element to forest.
+    # @param [String] leaf an element hash to be added with hex format.
+    def add(leaf)
+      n = leaf
+      h = 0
+      r = acc[h]
+      until r.nil? do
+        n = parent(r, n)
+        acc[h] = nil
+        h += 1
+        r = acc[h]
+      end
+      acc[h] = n
+      @num_leaves += 1
+    end
+
+    # Delete element from forest.
+    # @param [Utreexo::Proof] proof the proof of element to be removed.
+    def remove(proof)
+      raise Utreexo::Error, 'The target element does not exist in the forest.' unless include?(proof)
+      n = nil
+      h = 0
+      while h < proof.siblings.length do
+        p = proof.siblings[h]
+        if !n.nil?
+          n = parent(p, n)
+        elsif acc[h].nil?
+          acc[h] = p
+        else
+          n = proof.right? ? parent(p, acc[h]) : parent(acc[h], p)
+          acc[h] = nil
+        end
+        h += 1
+      end
+      acc[h] = n
+    end
+
+    # Whether the element exists in the forest
+    # @param [Utreexo::Proof] proof the proof of element
+    # @return [Boolean]
+    def include?(proof)
+      root = acc[proof.siblings.length]
+      n = proof.payload
+      proof.siblings.each_with_index do |sibling, height|
+        if ((1<<height) & proof.position) == 0
+          n = parent(n, sibling)
+        else
+          n = parent(sibling, n)
+        end
+      end
+      n == root
+    end
+
+    # get current height of the highest tree
+    # @return [Integer] current height of the highest tree
+    def height
+      i = acc.reverse.find_index{|i|!i.nil?}
+      i ||= 0
+      acc.length - i
+    end
+
+    private
+
+    def parent(left, right)
+      Blake2b.hex([left + right].pack('H*'))
+    end
+
+  end
+end

data/lib/utreexo/proof.rb

@@ -0,0 +1,31 @@
+module Utreexo
+  class Proof
+
+    attr_reader :position # where at the bottom of the tree it sits
+    attr_reader :payload  # hash of the thing itself (what's getting proved)
+    attr_reader :siblings # hash of siblings up to a root
+
+    # initialize
+    # @param [Integer] position Where at the bottom of the tree it sits
+    # @param [String] payload Target element
+    # @param [Array[String]] siblings proofs
+    def initialize(position, payload, siblings = [])
+      @position = position
+      @payload = payload
+      @siblings = siblings
+    end
+
+    # Whether the element is a node on the right
+    # @return [Boolean]
+    def right?
+      position.odd?
+    end
+
+    # Whether the element is a node on the left
+    # @return [Boolean]
+    def left?
+      position.even?
+    end
+
+  end
+end

data/lib/utreexo/version.rb

@@ -0,0 +1,3 @@
+module Utreexo
+  VERSION = "0.1.0"
+end

data/lib/utreexo.rb

@@ -0,0 +1,11 @@
+require "utreexo/version"
+require 'digest/sha2'
+require 'blake2b'
+
+module Utreexo
+  class Error < StandardError; end
+
+  autoload :Forest, 'utreexo/forest'
+  autoload :Proof, 'utreexo/proof'
+
+end

data/utreexorb.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "utreexo/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "utreexo"
+  spec.version       = Utreexo::VERSION
+  spec.authors       = ["azuchi"]
+  spec.email         = ["azuchi@chaintope.com"]
+
+  spec.summary       = %q{The ruby implementation for Utreexo.}
+  spec.description   = %q{The ruby implementation for Utreexo.}
+  spec.homepage      = "https://github.com/chaintope/utreexorb"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'blake2b'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: utreexo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- azuchi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: blake2b
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: The ruby implementation for Utreexo.
+email:
+- azuchi@chaintope.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/utreexo.rb
+- lib/utreexo/forest.rb
+- lib/utreexo/proof.rb
+- lib/utreexo/version.rb
+- utreexorb.gemspec
+homepage: https://github.com/chaintope/utreexorb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: The ruby implementation for Utreexo.
+test_files: []