pochette_toshi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f50e277f409de70f366b93f9677902028df8b17
+  data.tar.gz: 1f536b620dc7930970051e56f14b5339b22a9b64
+SHA512:
+  metadata.gz: b1b9ddb4759fa69eb26a61bde1d1c549f0b302aae9e230204bf7c99384538b3983cb417d62dd1541b8c15bea1a123629ae25d6b89a4e6cb0d83a773044c027f0
+  data.tar.gz: 92dc48c252c261316593f2536627b5434c5a2b5a809c8f0556a1fecf994d1b51637a9442506962c4a4f79582ac371989b97dcb2cb6abbe2ab52955191375e988

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pochette_toshi.gemspec
+gemspec

data/README.md

@@ -0,0 +1,48 @@
+# PochetteToshi
+
+A [Pochette](https://github.com/bitex-la/pochette) backend using Toshi.
+
+It will connect to your Toshi postgres database directly (not using Toshi's JSON RPC)
+
+For better performance it is recommended you create the following indexes in your
+database:
+
+      CREATE INDEX inputs_hsh_index on inputs (hsh);
+      CREATE INDEX inputs_is_coinbase_index on inputs (prev_out, hsh) WHERE prev_out = '0000000000000000000000000000000000000000000000000000000000000000';
+      CREATE INDEX unspent_outputs_usable_index on unspent_outputs (amount) WHERE amount > 5000;
+      CREATE INDEX transactions_hsh_height ON transactions (hsh, height);
+
+You can instatiate a Toshi backend passing your postgres connection options, they will be passed
+to the pg gem [as seen in their docs](http://deveiate.org/code/pg/PG/Connection.html#method-c-new)
+
+      >>> Pochette::Backends::Toshi.new(host: 'your-db-host', dbname: 'toshi')
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pochette_toshi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pochette_toshi
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/pochette_toshi/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pochette_toshi"
+
+# 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

data/bin/setup

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

data/lib/pochette_toshi.rb

@@ -0,0 +1,226 @@
+require "pochette_toshi/version"
+require "active_support"
+require "active_support/core_ext"
+require "pg"
+
+module Pochette
+  module Backends
+  end
+end
+
+# This class is not properly tested.
+# Be careful when changing anything, and/or make sure
+# you can run and assert your changes with a local copy of
+# a toshi testnet database.
+class Pochette::Backends::Toshi 
+  attr_accessor :connection
+
+  def initialize(options)
+    self.connection = PG.connect(options)
+  end
+  
+  def incoming_for(addresses, min_date)
+    addresses.in_groups_of(500, false).collect do |group|
+      incoming_for_helper(group, min_date)
+    end.flatten(1)
+  end
+
+  def incoming_for_helper(addresses, min_date)
+    addresses_sql = sanitize_list(addresses)
+    current_height = block_height
+    from_block = current_height - ((Time.now - min_date) / 60 / 60 * 6).ceil
+
+    query(%{
+      SELECT ale.amount, a.address, t.hsh,
+        (#{current_height + 1} - t.height) as confirmations, o.position,
+        (SELECT string_agg(a2.address,',') as sender
+         FROM address_ledger_entries ale2
+           INNER JOIN addresses a2 ON a2.id = ale2.address_id
+         WHERE ale2.transaction_id = t.id AND ale2.input_id IS NOT NULL
+        ) as senders
+      FROM address_ledger_entries ale
+        INNER JOIN addresses a ON a.id = ale.address_id AND a.address in (#{addresses_sql})
+        INNER JOIN transactions t ON t.id = ale.transaction_id AND t.pool = 1 AND t.height > #{from_block}
+        INNER JOIN outputs o ON o.id = ale.output_id AND o.branch = 0
+      UNION
+      SELECT ale.amount, a.address, t.hsh, 0 as confirmations, o.position,
+        (
+         SELECT string_agg(a2.address,',') as sender
+         FROM unconfirmed_ledger_entries ale2
+           INNER JOIN unconfirmed_addresses a2 ON a2.id = ale2.address_id
+         WHERE ale2.transaction_id = t.id AND ale2.input_id IS NOT NULL
+        ) as senders
+      FROM unconfirmed_ledger_entries ale
+        INNER JOIN unconfirmed_addresses a ON a.id = ale.address_id AND a.address in (#{addresses_sql})
+        INNER JOIN unconfirmed_transactions t ON t.id = ale.transaction_id AND t.pool = 1
+        INNER JOIN unconfirmed_outputs o ON o.id = ale.output_id 
+    }).collect{|a,addr,hsh,confs,pos,sender| [a.to_i, addr, hsh, confs.to_i, pos.to_i, sender] }
+  end
+  
+  def balances_for(addresses, confirmations)
+    addresses.in_groups_of(500, false).reduce({}) do |accum, group|
+      accum.merge!(balances_for_helper(group, confirmations))
+    end
+  end
+
+  def balances_for_helper(addresses, confirmations)
+    # Addresses have denormalized sent and received columns for all
+    # transactions. We must then calculate which portion
+    # of that is unconfirmed in order to get the 'confirmed' balances.
+    # And to get the 'unconfirmed' balances we also need to fetch
+    # ledger entries for transactions that were not added to a block yet.
+    addresses_sql = sanitize_list(addresses)
+    
+    confirmed_id_to_address = {}
+    unconfirmed_id_to_address = {}
+    result = addresses.reduce({}) do |accum, address|
+      accum[address] = [0,0,0,0,0,0]
+      accum
+    end
+
+    query(%{
+      SELECT id, address, total_received, total_sent
+      FROM addresses WHERE address in (#{addresses_sql})
+    }).each do |id, address, received, sent|
+      confirmed_id_to_address[id] = address
+      received = received.to_d / 1_0000_0000
+      sent = sent.to_d / 1_0000_0000
+      balance = received - sent
+      result[address] = [received, sent, balance, received, sent, balance]
+    end
+
+    # Now we take the previous 1 confirmation balances and substract
+    # what was below threshold to get the 'confirmed' balances.
+    query(%{
+      SELECT ale.address_id,
+        sum(CASE WHEN ale.amount > 0 THEN ale.amount ELSE 0 END) as received,
+        sum(CASE WHEN ale.amount < 0 THEN ale.amount ELSE 0 END) as sent
+      FROM address_ledger_entries ale
+        INNER JOIN addresses a ON a.id = ale.address_id AND a.address in (#{addresses_sql})
+        INNER JOIN transactions t ON t.id = ale.transaction_id AND t.pool = 1
+          AND t.height > #{block_height - confirmations + 1}
+      GROUP BY ale.address_id
+    }).each do |id, received, sent|
+      row = result[confirmed_id_to_address[id]]
+      row[0] = row[0] - (received.to_d / 1_0000_0000)
+      row[1] = row[1] - (sent.to_d.abs / 1_0000_0000)
+      row[2] = row[0] - row[1]
+    end
+
+    query(%{SELECT id, address
+      FROM unconfirmed_addresses WHERE address in (#{addresses_sql})
+    }).each do |id, address|
+      unconfirmed_id_to_address[id] = address
+    end
+    
+    # And then we also add the unconfirmed stuff to the already
+    # cached 1 confirmation balances
+    query(%{
+      SELECT ale.address_id, 
+        sum(CASE WHEN ale.amount > 0 THEN ale.amount ELSE 0 END) as received,
+        sum(CASE WHEN ale.amount < 0 THEN ale.amount ELSE 0 END) as sent
+      FROM unconfirmed_ledger_entries ale
+        INNER JOIN unconfirmed_addresses a ON a.id = ale.address_id
+          AND a.address in (#{addresses_sql})
+        INNER JOIN unconfirmed_transactions t ON t.id = ale.transaction_id AND t.pool = 1
+      GROUP BY ale.address_id
+    }).each do |id, received, sent|
+      row = result[unconfirmed_id_to_address[id]]
+      row[3] += (received.to_d / 1_0000_0000)
+      row[4] += (sent.to_d.abs / 1_0000_0000)
+      row[5] = row[3] - row[4]
+    end
+    
+    return result 
+  end
+
+  # Performs the low level queries to the toshi database
+  # and returns a JSON structure for the unspents and the transactions.
+  # THIS METHOD IS NOT TESTED IN CI!!!! DO NOT JUST REFACTOR THIS WITHOUT
+  # TESTING IT LOCALLY AGAINST THE ~20 GB TOSHI TESTNET DATABASE.
+  def list_unspent(addresses)
+    unspents = []
+    addresses.in_groups_of(500, false).collect do |group|
+      unspents += list_unspent_helper(group)
+    end
+    unspents
+  end
+
+  def list_unspent_helper(addresses)
+    addresses_sql = sanitize_list(addresses)
+    query(%{
+      SELECT a.address, o.hsh, o.position, uo.amount
+      FROM addresses a
+        INNER JOIN unspent_outputs uo ON uo.address_id = a.id AND uo.amount > 5000
+        LEFT JOIN outputs o ON o.id = uo.output_id
+      WHERE a.address in (#{addresses_sql})
+        AND NOT EXISTS (
+          SELECT i.id FROM inputs i
+          LEFT JOIN transactions t ON t.hsh = i.hsh
+          WHERE i.hsh = o.hsh AND
+          i.prev_out = '0000000000000000000000000000000000000000000000000000000000000000'
+          AND t.height > #{block_height - 100}
+        )
+    }).collect{|a,b,c,d| [a,b,c.to_i,d.to_i]}
+  end
+
+  def list_transactions(txids)
+    transactions = []
+    addresses.in_groups_of(500, false).collect do |group|
+      transactions += list_transactions_helper(group)
+    end
+    transactions
+  end
+
+  def list_transactions_helper(hashes)
+    transactions_sql = sanitize_list(hashes)
+    transactions = query(%{SELECT * FROM transactions WHERE hsh IN (#{transactions_sql})})
+    inputs = query(%{SELECT * FROM inputs WHERE hsh IN (#{transactions_sql})
+      ORDER BY position})
+    inputs_by_hsh = inputs.reduce({}) do |d, i|
+      d[i[1]] ||= []
+      d[i[1]] << i
+      d
+    end
+    outputs = query(%{SELECT * FROM outputs WHERE hsh IN (#{transactions_sql})
+      ORDER BY position})
+    outputs_by_hsh = outputs.reduce({}) do |d, o|
+      d[o[1]] ||= []
+      d[o[1]] << o
+      d
+    end
+    
+    transactions_json = transactions.collect do |_, hsh, ver, lock_time|
+      inputs_json = inputs_by_hsh[hsh].collect do |_, _, prev, index, script, seq, pos|
+        { prev_hash: prev,
+          prev_index: index.to_i,
+          sequence: [seq[2..-1]].pack('H*').unpack('V')[0],
+          script_sig: script[2..-1]
+        }
+      end
+      outputs_json = outputs_by_hsh[hsh].collect do |_, _, amount, script|
+        { amount: amount.to_i, script_pubkey: script[2..-1] }
+      end
+      { hash: hsh,
+        version: ver.to_i,
+        lock_time: lock_time.to_i,
+        inputs: inputs_json,
+        bin_outputs: outputs_json
+      }
+    end
+    transactions_json
+  end
+
+  def block_height
+    connection.exec('select max(height) from blocks where branch = 0').values[0][0].to_i
+  end
+  
+  def query(sql)
+    connection.exec(sql).values
+  end
+  
+  def sanitize_list(list)
+    list.collect{|a| "'#{a}'"}.join(',')
+  end
+end
+

data/lib/pochette_toshi/version.rb

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

data/pochette_toshi.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pochette_toshi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pochette_toshi"
+  spec.version       = PochetteToshi::VERSION
+  spec.authors       = ["Nubis"]
+  spec.email         = ["yo@nubis.im"]
+  spec.license       = "MIT"
+
+  spec.summary       = "Toshi backend for pochette"
+  spec.description   = "Toshi backend for the pochette wallet library"
+  spec.homepage      = "https://github.com/bitex-la/pochette-toshi"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "pochette", "~> 0.1"
+  spec.add_dependency "pg", "~> 0.17"
+  spec.add_dependency "activesupport", "~> 4.2"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 2"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: pochette_toshi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nubis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pochette
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Toshi backend for the pochette wallet library
+email:
+- yo@nubis.im
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pochette_toshi.rb
+- lib/pochette_toshi/version.rb
+- pochette_toshi.gemspec
+homepage: https://github.com/bitex-la/pochette-toshi
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Toshi backend for pochette
+test_files: []