bitcoin_active_record 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d56a5588b8abf5cc2c2974d5bc237e88461fdeff
+  data.tar.gz: ec4e8fde879bf7db2ca0424858fb5c0d9e16bb04
+SHA512:
+  metadata.gz: d4aab36a9ed83ab2ead41047af48fa05b4639910ca8406d9d8f1fbff0bdf3cd7821c8c25e0baadf07a2553787864b3678dca812b451901fbae17ab2bbb289b41
+  data.tar.gz: d60538e623947ceace6463e9c92552fbf4ce762da0e3c6d94e542998668d1e059a9a16c4e223d336ded7310e7c823628424d2c940c9fa609e20fd9a2867ad3ac

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org/'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    bitcoin_active_record (0.0.1)
+      auto_strip_attributes (>= 2.0.4)
+      httparty (>= 0.13.1)
+      script_utils (= 0.0.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (4.2.1)
+      activesupport (= 4.2.1)
+      builder (~> 3.1)
+    activerecord (4.2.1)
+      activemodel (= 4.2.1)
+      activesupport (= 4.2.1)
+      arel (~> 6.0)
+    activesupport (4.2.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.0)
+    auto_strip_attributes (2.0.6)
+      activerecord (>= 3.0)
+    builder (3.2.2)
+    httparty (0.13.3)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    i18n (0.7.0)
+    json (1.8.2)
+    minitest (5.6.0)
+    multi_xml (0.5.5)
+    script_utils (0.0.3)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bitcoin_active_record!

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Lihan Li
+
+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,121 @@
+# bitcoin_active_record
+Keep records of sent and received bitcoin transactions in your database using activerecord.  
+
+## Quick start guide
+* Start bitcoin-qt or bitcoind with these options set in bitcoin.conf
+```
+server=1
+rpcuser=change_this
+rpcpassword=change_this
+txindex=1 # needed for getting transaction sender keys
+```
+* Add to gemfile, bundle install
+* Run generator
+```
+rails g bitcoin_active_record:install
+```
+* Run db:migrate
+* Create a bitcoin client
+```ruby
+client = BitcoinActiveRecord::Client.new(
+  server: {
+    url: 'http://127.0.0.1:8332',
+    username: '',
+    password: '',
+  },
+)
+```
+* Run client.create_received_payments to create records of received payments
+* Run client.pay(public_key: public_key, amount: BigDecimal.new(1), comment: 'hello') to send a payment and save a record of it in the database
+
+## Usage
+
+This gem creates 4 models:
+
+btc_address.rb
+
+column_name | type | description
+--- | --- | ---
+public_key | string | public key of a bitcoin address
+
+payment.rb
+
+column_name | type | description
+--- | --- | ---
+btc_address_id | integer | foreign key
+amount | decimal | transaction amount
+txid | string | bitcoin transaction id
+
+received_payment.rb  
+
+column_name | type | description
+--- | --- | ---
+payment_id | integer | The btc address associated with this payment id is the address of the person who sent the payment
+btc_address_id | integer | This is the address in your wallet that the payment was sent to
+
+sent_payment.rb  
+
+column_name | type | description
+--- | --- | ---
+payment_id | integer | foreign key
+
+Sent payments are only recorded if you send them using the gem's api.
+
+### BitcoinActiveRecord::Client
+
+Initialize options
+
+```ruby
+client = BitcoinActiveRecord::Client.new(
+  # required, bitcoind server credentials
+  server: {
+    url: 'http://127.0.0.1:8332',
+    username: '',
+    password: '',
+  },
+  # optional, amounts less than this will be ignored when running create_received_payments
+  minimum_amount: BigDecimal.new('0.001'),
+  # optional, the wallet account you want to look for received transactions in
+  account: :foo,
+)
+```
+
+* client.request(method, *args)
+
+Send a request to the bitcoind server.  
+
+```ruby
+client.request(:getinfo)
+client.request(:sendtoaddress, '1N2ZWQszjGDjaW5y3jAStuJQW23MbG1r4N', BigDecimal.new(1))
+```
+
+* client.get_new_address
+
+Get a new public key from the server
+
+* client.get_sender_address(txid)
+
+Get the public key of the transaction sender for a transaction with id txid
+
+* client.pay
+
+Pay someone and save a record of it as a SentPayment
+
+```ruby
+client.pay(
+  # required, public key you want to send BTC to
+  public_key: '1N2ZWQszjGDjaW5y3jAStuJQW23MbG1r4N',
+  # required, amount in BTC you want to send
+  amount: BigDecimal.new('1.23'),
+  # optional, transaction comment
+  comment: 'foo',
+) do |sent_payment|
+  # adding a block is optional
+  # modify the sent_payment record before it gets saved
+  sent_payment.custom_attribute = 'foo'
+end
+```
+
+* client.create_received_payments
+
+Create a ReceivedPayment model for every transaction from client.account that's >= client.minimum_amount. If the latest transaction is already in the database it will assume all earlier transactions have already been saved.

data/Rakefile

@@ -0,0 +1,4 @@
+task :test do
+  Dir.chdir('test')
+  system('bin/rake test')
+end

data/bitcoin_active_record.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |gem|
+  gem.name = 'bitcoin_active_record'
+  gem.version = '0.0.1'
+  gem.summary = 'bitcoin activerecord integration'
+  gem.author = 'Lihan Li'
+  gem.email = 'frankieteardrop@gmail.com'
+
+  gem.add_dependency('httparty', '>= 0.13.1')
+  gem.add_dependency('auto_strip_attributes', '>= 2.0.4')
+  gem.add_dependency('script_utils', '0.0.3')
+
+  gem.files = `git ls-files`.split("\n")
+  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths = ["lib"]
+end

data/lib/bitcoin_active_record/client.rb

@@ -0,0 +1,128 @@
+module BitcoinActiveRecord
+  class ApiError < StandardError; end
+
+  class Client
+    attr_accessor(:minimum_amount)
+    attr_accessor(:account)
+    attr_reader(:server)
+
+    def initialize(server: raise('server required'), minimum_amount: 0, account: '')
+      @server = server
+      @minimum_amount = minimum_amount
+      @account = account
+      @default_transaction_count = 25
+    end
+
+    def request(method, *args)
+      args.map! { |a| a.is_a?(BigDecimal) ? a.to_f : a }
+      raise 'payments disabled in test/development' if method.to_sym == :sendtoaddress && (Rails.env.test? || Rails.env.development?)
+
+      res = HTTParty.post(
+        @server[:url],
+        basic_auth: {
+          username: @server[:username],
+          password: @server[:password],
+        },
+        headers: {
+          'Content-Type' => 'application/json',
+        },
+        body: {
+          method: method,
+          params: args,
+          id: 'jsonrpc',
+        }.to_json,
+      )
+      raise ApiError.new(res) unless res['error'].nil?
+
+      res['result']
+    end
+
+    def get_new_address
+      raise if Rails.env.test?
+      request(:getnewaddress, @account)
+    end
+
+    def get_sender_address(txid)
+      addresses = []
+      raw_tx = request('decoderawtransaction', request('getrawtransaction', txid))
+
+      raw_tx['vin'].each do |input|
+        input_raw_tx = request('decoderawtransaction', request('getrawtransaction', input['txid']))
+        addresses << input_raw_tx['vout'][input['vout']]['scriptPubKey']['addresses'][0]
+      end
+
+      addresses[0]
+    end
+
+    def pay(public_key: raise('public key required'), amount: raise('amount required'), comment: '')
+      raise('amount cant be zero or negative') unless amount > 0
+
+      sent_payment = SentPayment.new(
+        payment: Payment.new(
+          btc_address: BtcAddress.find_or_initialize_by(public_key: public_key),
+          amount: amount,
+          txid: request(:sendtoaddress, public_key, amount, comment),
+        ),
+      )
+      yield(sent_payment) if block_given?
+
+      sent_payment.save!
+
+      sent_payment
+    end
+
+    def create_received_payments
+      page = 0
+
+      while true
+        transactions = get_received_transactions(page: page)
+        return if transactions.size == 0
+
+        transactions.each do |transaction|
+          txid = transaction['txid']
+          # already created payment for this transaction and all older ones
+          return if Payment.where(txid: txid).count > 0
+
+          amount = transaction['amount']
+          from_key = get_sender_address(txid)
+
+          received_payment = ReceivedPayment.create!(
+            payment: Payment.new(
+              # payment from this address
+              btc_address: BtcAddress.find_or_initialize_by(
+                public_key: from_key
+              ),
+              amount: amount,
+              txid: txid,
+            ),
+            # sent to this address
+            btc_address: BtcAddress.find_or_initialize_by(public_key: transaction['address']),
+          )
+
+          puts("Received payment #{amount} BTC from #{from_key}: #{received_payment.inspect}")
+        end
+
+        page += 1
+      end
+    end
+
+    private
+
+    def get_received_transactions(page: 0)
+      from = page * @default_transaction_count
+
+      request(
+        :listtransactions,
+        @account,
+        @default_transaction_count,
+        from,
+      ).each do |transaction|
+        transaction['amount'] = BigDecimal.new(transaction['amount'].to_s) if transaction['amount']
+      end.find_all do |transaction|
+        (transaction['category'] == 'receive' &&
+         transaction['confirmations'] > 0 &&
+         transaction['amount'] >= @minimum_amount)
+      end.reverse
+    end
+  end
+end

data/lib/bitcoin_active_record/models/btc_address.rb

@@ -0,0 +1,12 @@
+module BitcoinActiveRecord::Models::BtcAddress
+  extend ActiveSupport::Concern
+
+  included do
+    has_many(:payments, inverse_of: :btc_address)
+    has_many(:received_payments, inverse_of: :btc_address)
+
+    validates(:public_key, presence: true, uniqueness: { case_sensitive: true })
+
+    auto_strip_attributes(:public_key)
+  end
+end

data/lib/bitcoin_active_record/models/payment.rb

@@ -0,0 +1,18 @@
+module BitcoinActiveRecord::Models::Payment
+  extend ActiveSupport::Concern
+
+  included do
+    # sender's address for received payments
+    # payee address for sent payments
+    belongs_to(:btc_address, inverse_of: :payments)
+
+    has_one(:received_payment, inverse_of: :payment)
+    has_one(:sent_payment, inverse_of: :payment)
+
+    validates(:txid, :btc_address, :amount, presence: true)
+    validates(:amount, numericality: { greater_than_or_equal_to: 0 })
+    validates(:txid, uniqueness: true)
+
+    auto_strip_attributes(:txid)
+  end
+end

data/lib/bitcoin_active_record/models/received_payment.rb

@@ -0,0 +1,11 @@
+module BitcoinActiveRecord::Models::ReceivedPayment
+  extend ActiveSupport::Concern
+
+  included do
+    belongs_to(:payment, inverse_of: :received_payment, dependent: :destroy)
+    belongs_to(:btc_address, inverse_of: :received_payments) # payment to this address
+
+    validates(:payment, presence: true)
+    validates(:payment_id, uniqueness: true)
+  end
+end

data/lib/bitcoin_active_record/models/sent_payment.rb

@@ -0,0 +1,10 @@
+module BitcoinActiveRecord::Models::SentPayment
+  extend ActiveSupport::Concern
+
+  included do
+    belongs_to(:payment, inverse_of: :sent_payment, dependent: :destroy)
+
+    validates(:payment, presence: true)
+    validates(:payment_id, uniqueness: true)
+  end
+end

data/lib/bitcoin_active_record/models.rb

@@ -0,0 +1,9 @@
+module BitcoinActiveRecord
+  module Models
+    def bitcoin_active_record_model
+      include "BitcoinActiveRecord::Models::#{self}".constantize
+    end
+  end
+end
+
+ActiveRecord::Base.extend(BitcoinActiveRecord::Models)

data/lib/bitcoin_active_record.rb

@@ -0,0 +1,24 @@
+require 'active_support/dependencies'
+require 'active_support/concern'
+require 'httparty'
+require 'bigdecimal'
+require 'auto_strip_attributes'
+require 'bitcoin_active_record/models'
+
+module BitcoinActiveRecord
+  module_function
+
+  autoload(:Client, 'bitcoin_active_record/client')
+
+  module Models
+    lambda do
+      path_prefix = 'bitcoin_active_record/models/'
+
+      Dir["#{File.dirname(__FILE__)}/#{path_prefix}*.rb"].map do |file|
+        File.basename(file, '.rb')
+      end.each do |file_name|
+        autoload(file_name.camelize, "#{path_prefix}#{file_name}")
+      end
+    end.()
+  end
+end

data/lib/generators/bitcoin_active_record/install_generator.rb

@@ -0,0 +1,26 @@
+require 'rails/generators'
+require "rails/generators/active_record"
+require 'script_utils'
+
+module BitcoinActiveRecord
+  module Generators
+    class InstallGenerator < ActiveRecord::Generators::Base
+      # ActiveRecord::Generators::Base inherits from Rails::Generators::NamedBase which requires a NAME parameter for the
+      # new table name. Our generator always has the same model names so we just set a random name here.
+      argument(:name, type: :string, default: 'random_name')
+
+      source_root(File.expand_path("../../templates", __FILE__))
+
+      def copy_models
+        ScriptUtils.file_names(File.expand_path('../../templates/models', __FILE__)).each do |file_name|
+          copy_file("models/#{file_name}", "app/models/#{file_name}")
+        end
+      end
+
+      def create_migrations
+        filename = 'create_bitcoin_active_record_models.rb'
+        migration_template(filename, "db/migrate/#{filename}")
+      end
+    end
+  end
+end

data/lib/generators/templates/create_bitcoin_active_record_models.rb

@@ -0,0 +1,32 @@
+class CreateBitcoinActiveRecordModels < ActiveRecord::Migration
+  def change
+    create_table "payments" do |t|
+      t.integer "btc_address_id", null: false
+      t.decimal "amount",         null: false
+      t.string  "txid",           null: false
+      t.timestamps
+    end
+    add_index "payments", ["btc_address_id"]
+    add_index "payments", ["txid"], unique: true
+
+    create_table "btc_addresses" do |t|
+      t.string  "public_key", null: false
+      t.timestamps
+    end
+    add_index "btc_addresses", ["public_key"], unique: true
+
+    create_table "received_payments" do |t|
+      t.integer "payment_id", null: false
+      t.integer "btc_address_id", null: false
+      t.timestamps
+    end
+    add_index "received_payments", ["payment_id"], unique: true
+    add_index :received_payments, :btc_address_id
+
+    create_table "sent_payments" do |t|
+      t.integer "payment_id", null: false
+      t.timestamps
+    end
+    add_index "sent_payments", ["payment_id"], unique: true
+  end
+end

data/lib/generators/templates/models/btc_address.rb

@@ -0,0 +1,3 @@
+class BtcAddress < ActiveRecord::Base
+  bitcoin_active_record_model
+end

data/lib/generators/templates/models/payment.rb

@@ -0,0 +1,3 @@
+class Payment < ActiveRecord::Base
+  bitcoin_active_record_model
+end

data/lib/generators/templates/models/received_payment.rb

@@ -0,0 +1,3 @@
+class ReceivedPayment < ActiveRecord::Base
+  bitcoin_active_record_model
+end

data/lib/generators/templates/models/sent_payment.rb

@@ -0,0 +1,3 @@
+class SentPayment < ActiveRecord::Base
+  bitcoin_active_record_model
+end

data/test/.gitignore

@@ -0,0 +1,18 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp
+
+config/initializers/bitcoin_active_record.rb

data/test/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+gem 'rails', '4.2.1'
+
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+gem 'bitcoin_active_record', path: '..'
+
+gem 'pry-nav'
+gem 'pry-rails'
+
+group(:development) do
+  gem 'spring', '1.3.4'
+  gem 'spring-commands-testunit'
+end
+
+group :test do
+  gem 'mocha', '1.1.0'
+  gem 'minitest-reporters', '1.0.11'
+end