Skip to content
A rails bitcoin payment processing gem
Branch: master
Clone or download
Pull request Compare This branch is 47 commits ahead, 13 commits behind Sailias:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
config
features
lib
spec/dummy
.gitignore
Gemfile
LICENSE.txt
README.md
Rakefile
bitcoin_payable.gemspec

README.md

BitcoinPayable

Support Bitcoin and Bitcoin Cash in your Ruby on Rails application!

A rails gem that enables any model to have bitcoin payments. The polymorphic table bitcoin_payments creates payments with unique addresses based on a BIP32 deterministic seed using https://github.com/wink/money-tree and uses different API to check for payments.

Payments have 5 states: pending, partial_payment, paid_in_full, confirmed, comped

No private keys needed, No bitcoind blockchain indexing on new servers, just address and payments.

Support for multiple fiat currencies: USD EUR GBP AUD BRL CAD CZK IDR ILS JPY MXN MYR NZD PLN RUB SEK SGD TRY

TODO

  • Implement Bitcoin SV
  • Find a reliable webhooks provider

Rails 5.1

Master now supports multiple Rails versions.

No longer maintained Support for Rails 5.1

Other crypto currencies

Cryptocoin Payable

Installation

Add this line to your application's Gemfile: (I might be too lazy to update RubyGems all the time)

gem 'bitcoin_payable', git: 'https://github.com/maesitos/bitcoin_payable', branch: 'master'

And then execute:

$ bundle

$ rails g bitcoin_payable:install --skip

$ bundle exec rake db:migrate

Or install it yourself as:

$ gem install bitcoin_payable

Usage

Configuration

config/initializers/bitcoin_payable.rb

BitcoinPayable.config do |config|

  config.currency = :usd    # Default currency

  # Bitcoin or Bitcoin Bitcoin Cash
  # Blockcypher and Blockchain.info still to add BCH support
  config.crypto = :btc # or :bch   

  config.node_path = "m/0/"
  config.master_public_key = "your xpub master public key here"

  config.testnet = true
  config.adapter = 'blocktrail' # Use blocktrail, blockchain_info, blockcypher or bitcoin_com

  # Confirmations (defaults to 6)
  config.confirmations = 6

  # The rate for Bitcoin you'll be using to calculate prices
  # Optional setting. Default to :daily_average
  # :last               The last market's price
  # :high               Today's highest price
  # :low                Today's highest price
  # :daily_average      The daily average price
  # :weekly_average     The weekly average price
  # :monthly_average    The monthly average price
  config.rate_calculation = :daily_average

  # Webhooks
  # Only available for blocktrail adapter
  config.allowwebhooks = true
  config.webhook_domain = "subdomain.domain.com:port"
  config.webhook_protocol = "https" # Or 'http'
end
  • In order to use the bitcoin network and issue real addresses, BitcoinPayable.config.testnet must be set to false *

    BitcoinPayable.config.testnet = false

Adapters

Blocktrail Adapter

If you use config.adapter = 'blocktrail' (The only one supporting webhooks) you'll need to set the following environment variables:

# Basic authentification for your webhooks
ENV['BITCOIN_PAYABLE_WEBHOOK_USER']= "username"
ENV['BITCOIN_PAYABLE_WEBHOOK_PASS']= "password"

# API keys provided by Blocktrail.com
ENV['BLOCKTRAIL_API_KEY']= "key"
ENV['BLOCKTRAIL_API_SECRET']= "secret"

Please bear in mind Blocktrail.com was acquired by Bitmain and the service has ben entirely moved to BTC.com.

You can obtain your API keys at https://dev.btc.com

Adapters status

Adapter Health Webhooks Coins Supported
Bitcoin.com Good No BCH
Blocktrail Dead Yes BCH and BTC
BTC.com Very Bad Deprecated BCH and BTC
Blockchyper Good Not implemented BTC
Blockchain.info Good No BTC

Node Path

The derivation path for the node that will be creating your addresses

Master Public Key

A BIP32 MPK in "Extended Key" format.

Public net starts with: xpub Testnet starts with: tpub

Adding it to your model

class Product < ActiveRecord::Base
  has_bitcoin_payments
end

Creating a payment from your application

def create_payment(amount_in_cents)
  self.bitcoin_payments.create!(reason: 'sale', price: amount_in_cents, currency: :eur)
end

If currency is not provided the default fiat currency will be used. You can create a Bitcoin payment for a new—supported—fiat currency and BitcoinPayable will automatically create obtain the exchange rate before creating the payment.

Update payments with the current price of BTC based on your currency

BitcoinPayable also supports multiple fiat currencies conversions and BTC exchange rates.

The process_prices rake task connects to api.bitcoinaverage.com to get the 24 hour weighted average of BTC for your specified currency. It then updates all payments that haven't received an update in the last 30 minutes with the new value owing in BTC. This honors the price of a payment for 30 minutes at a time.

rake bitcoin_payable:process_prices

BitcoinPayable will update the prices for all the fiat pairs.

Clean up old rates

You will be able to clean up old rates with:

rake bitcoin_payable:clean_old_rates or rake bitcoin_payable:clean_old_rates[days_old]

Processing payments

All payments are calculated against the dollar amount of the payment. So a bitcoin_payment for $49.99 will have it's value calculated in BTC. It will stay at that price for 30 minutes. When a payment is made, a transaction is created that stores the BTC in satoshis paid, and the exchange rate is was paid at. This is very valuable for accounting later. (capital gains of all payments received)

If a partial payment is made, the BTC value is recalculated for the remaining dollar amount with the latest exchange rate. This means that if someone pays 0.01 for a 0.5 payment, that 0.01 is converted into dollars at the time of processing and the remaining amount is calculated in dollars and the remaining amount in BTC is issued. (If BTC bombs, that value could be greater than 0.5 now)

This prevents people from gaming the payments by paying very little BTC in hopes the price will rise. Payments are not recalculated based on the current value of BTC, but in dollars.

To run the payment processor:

rake bitcoin_payable:process_payments

Do no run the payment processor if you have webhooks set up as new transactions will be processed automatically by the webhook.

Notify your application when a payment is made

Use the bitcoin_payment_paid method

def Product < ActiveRecord::Base
  has_bitcoin_payments

  def create_payment(amount_in_cents)
    self.bitcoin_payments.create!(reason: 'sale', price: amount_in_cents)
  end

  def bitcoin_payment_paid
    self.ship!
  end
end

Use the bitcoin_payment_status_changed method

def bitcoin_payment_status_changed(from_state, to_state)
  if to_state == "confirmed"
    self.ship!
  elsif to_state == "paid_in_full"
    self.notify_payment_received(self)
  end
end

Comp a payment

This will bypass the payment, set the state to comped and call back to your app that the payment has been processed.

@bitcoin_payment.comp

View all the transactions in the payment

bitcoin_payment = @product.bitcoin_payments.first
bitcoin_payment.transactions.each do |transaction|
  puts transaction.block_hash
  puts transaction.block_time

  puts transaction.transaction_hash

  puts transaction.estimated_value
  puts transaction.estimated_time

  puts transaction.btc_conversion
end

Contributing

  1. Fork it
  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 new Pull Request
You can’t perform that action at this time.