peatio-bitgo-jruby 2.5.1

data/configs/wallets.yml

@@ -0,0 +1,54 @@
+
+- name:             Ethereum Deposit Wallet
+  blockchain_key:   eth-rinkeby
+  currency_id:      eth
+  # Address where deposits will be collected to.
+  address:          '0x2b9fBC10EbAeEc28a8Fc10069C0BC29E45eBEB9C'  # IMPORTANT: Always wrap this value in quotes!
+  kind:             deposit  # Wallet kind (deposit, hot, warm, cold or fee).
+  max_balance:      0.0
+  status:           active
+  gateway:          geth     # Gateway client name.
+  settings:
+    #
+    # Geth gateway client settings.
+    uri:          http://127.0.0.1:8545
+    secret:       'changeme'
+    testnet: true
+    access_token: 'v2x659261647b540ee3acda5c50ae4e878we323474eea5cbff9b9615139629'
+    wallet_id: '5e5388ad80334347ceb3540c741d'
+
+- name:             Ethereum Hot Wallet
+  blockchain_key:   eth-rinkeby
+  currency_id:      eth
+  # Address where deposits will be collected to.
+  address:          '0x270704935783087a01c7a28d8f2d8f01670c8050'  # IMPORTANT: Always wrap this value in quotes!
+  kind:             hot     # Wallet kind (deposit, hot, warm, cold or fee).
+  max_balance:      100.0
+  status:           active
+  gateway:          geth    # Gateway client name.
+  settings:
+    #
+    # Geth gateway client settings.
+    uri:          http://127.0.0.1:8545
+    secret:       'test'
+    testnet: true
+    access_token: 'v2x659261647b540ee3acda5c50ae4e878we323474eea5cbff9b9615139629'
+    wallet_id: '5e5388ad80334347ceb3540c741d'
+
+- name:             Ethereum Warm Wallet
+  blockchain_key:   eth-rinkeby
+  currency_id:      eth
+  # Address where deposits will be collected to.
+  address:          '0x2b9fBC10EbAeEc28a8Fc10069C0BC29E45eBEB9C'  # IMPORTANT: Always wrap this value in quotes!
+  kind:             warm    # Wallet kind (deposit, hot, warm, cold or fee).
+  max_balance:      1000.0
+  status:           active
+  gateway:          geth    # Gateway client name.
+  settings:
+    #
+    # Geth gateway client settings.
+    uri:          http://127.0.0.1:8545
+    secret:       'test'
+    testnet: true
+    access_token: 'v2x659261647b540ee3acda5c50ae4e878we323474eea5cbff9b9615139629'
+    wallet_id: '5e5388ad80334347ceb3540c741d'

data/docs/configuration.md

@@ -0,0 +1,36 @@
+## Bitgo wallet configuration
+
+1. Login to your bitgo account
+2. Click in create wallet button
+![scheme](images/create_wallet.png)
+3. Choose wallet for appropriate currency
+![scheme](images/choose_wallet.png)
+4. Setup your wallet
+![scheme](images/setup_wallet.png)
+5. Put name of your wallet
+![scheme](images/wallet_name.png)
+6. Put password of your wallet
+![scheme](images/wallet_secret.png)
+P.S. You should save this password for future wallet configuration
+
+## Peatio BITGO wallet configuration
+
+1. Go to tower admin panel Settings -> Wallets -> Add wallet
+* Uri == Bitgo service URI
+* Secret == Wallet password
+* Bitgo Wallet Id
+![scheme](images/wallet_id.png)
+* Bitgo Access Token
+![scheme](images/wallet_access_token.png)
+![scheme](images/create_wallet_access_token.png)
+![scheme](images/access_token.png)
+
+## Webhook configuration
+
+![scheme](images/webhook.png)
+![scheme](images/webhook_creating.png)
+
+Where url should be "https://{host_url}/api/v2/peatio/public/webhooks/{event}"
+
+* For deposit wallets event should be 'deposit'
+* For hot wallets event should be 'withdraw'

data/docs/integration.md

@@ -0,0 +1,29 @@
+# Integration.
+
+For Peatio bitgo plugin integration you need to do the following steps:
+
+## Image Build.
+
+1. Add peatio-bitgo gem into your Gemfile.plugin
+```ruby
+gem 'peatio-bitgo', '~> 0.1.0'
+```
+
+2. Run `bundle install` for updating Gemfile.lock
+
+3. Build custom Peatio [docker image with bitgo plugin](https://github.com/rubykube/peatio/blob/master/docs/plugins.md#build)
+
+4. Push your image using `docker push`
+
+5. Update your deployment to use image with peatio-bitgo gem
+
+## Peatio Configuration.
+
+1. Create bitgo Blockchain [config example](../config/blockchains.yml).
+    * No additional steps are needed
+
+2. Create bitgo Currency [config example](../config/currencies.yml).
+    * No additional steps are needed
+
+3. Create bitgo Wallets [config example](../config/wallets.yml)(deposit and hot wallets are required).
+    * No additional steps are needed

data/lib/peatio/bitgo.rb

@@ -0,0 +1,16 @@
+require "peatio"
+
+module Peatio
+  module Bitgo
+    require "bigdecimal"
+    require "bigdecimal/util"
+
+    require "peatio/bitgo/blockchain"
+    require "peatio/bitgo/client"
+    require "peatio/bitgo/wallet"
+
+    require "peatio/bitgo/hooks"
+
+    require "peatio/bitgo/version"
+  end
+end

data/lib/peatio/bitgo/blockchain.rb

@@ -0,0 +1,21 @@
+
+module Peatio
+  module Bitgo
+    # TODO: Processing of unconfirmed transactions from mempool isn't supported now.
+    class Blockchain < Peatio::Blockchain::Abstract
+
+      DEFAULT_FEATURES = {case_sensitive: true, cash_addr_format: false}.freeze
+
+      def initialize(custom_features = {})
+        @features = DEFAULT_FEATURES.merge(custom_features).slice(*SUPPORTED_FEATURES)
+        @settings = {}
+      end
+
+      def configure(settings = {})
+        # Clean client state during configure.
+        @client = nil
+        @settings.merge!(settings.slice(*SUPPORTED_SETTINGS))
+      end
+    end
+  end
+end

data/lib/peatio/bitgo/client.rb

@@ -0,0 +1,56 @@
+require 'faraday'
+require 'better-faraday'
+
+module Peatio
+  module Bitgo
+    class Client
+      Error = Class.new(StandardError)
+      class ConnectionError < Error; end
+
+      class ResponseError < Error
+        def initialize(msg)
+          super "#{msg}"
+        end
+      end
+
+      def initialize(endpoint, access_token)
+        @endpoint = URI.parse(endpoint)
+        @access_token = access_token
+      end
+
+      def rest_api(verb, path, data = nil)
+        args = [@endpoint.to_s + path]
+
+        if data
+          if %i[ post put patch ].include?(verb)
+            args << data.compact.to_json
+            args << { 'Content-Type' => 'application/json' }
+          else
+            args << data.compact
+            args << {}
+          end
+        else
+          args << nil
+          args << {}
+        end
+
+        args.last['Accept']        = 'application/json'
+        args.last['Authorization'] = 'Bearer ' + @access_token
+
+        response = Faraday.send(verb, *args)
+        response.assert_success!
+        response = JSON.parse(response.body)
+        response['error'].tap { |error| raise ResponseError.new(error) if error }
+        response
+      rescue Faraday::Error => e
+        if e.is_a?(Faraday::ConnectionFailed) || e.is_a?(Faraday::TimeoutError)
+          raise ConnectionError, e
+        else
+          raise ConnectionError, JSON.parse(e.response.body)['message']
+        end
+      rescue StandardError => e
+        raise Error, e
+      end
+    end
+  end
+end

data/lib/peatio/bitgo/hooks.rb

@@ -0,0 +1,42 @@
+module Peatio
+  module Bitgo
+    module Hooks
+      BLOCKCHAIN_VERSION_REQUIREMENT = "~> 1.0.0"
+      WALLET_VERSION_REQUIREMENT = "~> 1.0.0"
+
+      class << self
+        def check_compatibility
+          unless Gem::Requirement.new(BLOCKCHAIN_VERSION_REQUIREMENT)
+                                 .satisfied_by?(Gem::Version.new(Peatio::Blockchain::VERSION))
+            [
+              "Bitgo blockchain version requiremnt was not suttisfied by Peatio::Blockchain.",
+              "Bitgo blockchain requires #{BLOCKCHAIN_VERSION_REQUIREMENT}.",
+              "Peatio::Blockchain version is #{Peatio::Blockchain::VERSION}"
+            ].join('\n').tap { |s| Kernel.abort s }
+          end
+
+          unless Gem::Requirement.new(WALLET_VERSION_REQUIREMENT)
+                                 .satisfied_by?(Gem::Version.new(Peatio::Wallet::VERSION))
+            [
+              "Bitgo wallet version requiremnt was not suttisfied by Peatio::Wallet.",
+              "Bitgo wallet requires #{WALLET_VERSION_REQUIREMENT}.",
+              "Peatio::Wallet version is #{Peatio::Wallet::VERSION}"
+            ].join('\n').tap { |s| Kernel.abort s }
+          end
+        end
+
+        def register
+          Peatio::Blockchain.registry[:bitgo] = Bitgo::Blockchain
+          Peatio::Wallet.registry[:bitgo] = Bitgo::Wallet
+        end
+      end
+
+      if defined?(Rails::Railtie)
+        require "peatio/bitgo/railtie"
+      else
+        check_compatibility
+        register
+      end
+    end
+  end
+end

data/lib/peatio/bitgo/railtie.rb

@@ -0,0 +1,13 @@
+module Peatio
+  module Bitgo
+    class Railtie < Rails::Railtie
+      config.before_initialize do
+        Hooks.check_compatibility
+      end
+
+      config.after_initialize do
+        Hooks.register
+      end
+    end
+  end
+end

data/lib/peatio/bitgo/version.rb

@@ -0,0 +1,5 @@
+module Peatio
+  module Bitgo
+    VERSION = "2.5.1"
+  end
+end

data/lib/peatio/bitgo/wallet.rb

@@ -0,0 +1,300 @@
+module Peatio
+  module Bitgo
+    class Wallet < Peatio::Wallet::Abstract
+      TIME_DIFFERENCE_IN_MINUTES = 10
+      XLM_MEMO_TYPES = { 'memoId': 'id', 'memoText': 'text', 'memoHash': 'hash', 'memoReturn': 'return' }
+
+      def initialize(settings = {})
+        @settings = settings
+      end
+
+      def configure(settings = {})
+        # Clean client state during configure.
+        @client = nil
+
+        @settings.merge!(settings.slice(*SUPPORTED_SETTINGS))
+
+        @wallet = @settings.fetch(:wallet) do
+          raise Peatio::Wallet::MissingSettingError, :wallet
+        end.slice(:uri, :address, :secret, :access_token, :wallet_id, :testnet)
+
+         @currency = @settings.fetch(:currency) do
+          raise Peatio::Wallet::MissingSettingError, :currency
+         end.slice(:id, :base_factor, :code, :options)
+      end
+
+      def create_address!(options = {})
+        currency = erc20_currency_id
+        options.deep_symbolize_keys!
+
+        if options.dig(:pa_details, :address_id).present? &&
+           options.dig(:pa_details, :updated_at).present? &&
+           time_difference_in_minutes(options.dig(:pa_details, :updated_at)) >= TIME_DIFFERENCE_IN_MINUTES
+
+          response = client.rest_api(:get, "#{currency}/wallet/#{wallet_id}/address/#{options.dig(:pa_details, :address_id)}")
+          { address: response['address'], secret: bitgo_wallet_passphrase }
+        elsif options.dig(:pa_details, :address_id).blank?
+          response = client.rest_api(:post, "#{currency}/wallet/#{wallet_id}/address")
+          { address: response['address'], secret: bitgo_wallet_passphrase, details: { address_id: response['id'] }}
+        end
+      rescue Bitgo::Client::Error => e
+        raise Peatio::Wallet::ClientError, e
+      end
+
+      def create_transaction!(transaction, options = {})
+        currency_options = @currency.fetch(:options).slice(:gas_limit, :gas_price, :erc20_contract_address)
+
+        if currency_options[:gas_limit].present? && currency_options[:gas_price].present?
+          options.merge!(currency_options)
+          create_eth_transaction(transaction, options)
+        else
+          amount = convert_to_base_unit(transaction.amount)
+
+          if options[:subtract_fee].to_s == 'true'
+            fee = build_raw_transaction(transaction)
+            baseFeeInfo = fee.dig('feeInfo','fee')
+            fee = baseFeeInfo.present? ? baseFeeInfo : fee.dig('txInfo','Fee')
+            amount -= fee.to_i
+          end
+
+          txid = client.rest_api(:post, "#{currency_id}/wallet/#{wallet_id}/sendcoins", {
+                                 address: normalize_address(transaction.to_address.to_s),
+                                 amount: amount.to_s,
+                                 walletPassphrase: bitgo_wallet_passphrase,
+                                 memo: xlm_memo(transaction.to_address.to_s)
+          }.compact).fetch('txid')
+
+          transaction.hash = normalize_txid(txid)
+          transaction
+        end
+      rescue Bitgo::Client::Error => e
+        raise Peatio::Wallet::ClientError, e
+      end
+
+
+      def build_raw_transaction(transaction)
+        client.rest_api(:post, "#{currency_id}/wallet/#{wallet_id}/tx/build", {
+          recipients: [{
+            address: transaction.to_address,
+            amount: convert_to_base_unit(transaction.amount).to_s
+          }]
+        }.compact)
+      end
+
+      def create_eth_transaction(transaction, options = {})
+        amount = convert_to_base_unit(transaction.amount)
+        hop = true unless options.slice(:erc20_contract_address).present?
+
+        txid = client.rest_api(:post, "#{currency_id}/wallet/#{wallet_id}/sendcoins", {
+          address: transaction.to_address.to_s,
+          amount: amount.to_s,
+          walletPassphrase: bitgo_wallet_passphrase,
+          gas: options.fetch(:gas_limit).to_i,
+          gasPrice: options.fetch(:gas_price).to_i,
+          hop: hop
+        }.compact).fetch('txid')
+
+        transaction.hash = normalize_txid(txid)
+        transaction
+      end
+
+      def load_balance!
+        if @currency.fetch(:options).slice(:erc20_contract_address).present?
+          load_erc20_balance!
+        else
+          response = client.rest_api(:get, "#{currency_id}/wallet/#{wallet_id}")
+          convert_from_base_unit(response.fetch('balanceString'))
+        end
+      rescue Bitgo::Client::Error => e
+        raise Peatio::Wallet::ClientError, e
+      end
+
+      def load_erc20_balance!
+        response = client.rest_api(:get, "#{erc20_currency_id}/wallet/#{wallet_id}?allTokens=true")
+        convert_from_base_unit(response.dig('tokens', currency_id, 'balanceString'))
+      rescue Bitgo::Client::Error => e
+        raise Peatio::Wallet::ClientError, e
+      end
+
+      def trigger_webhook_event(event)
+        currency = @wallet.fetch(:testnet).present? ? 't' + @currency.fetch(:id) : @currency.fetch(:id)
+        return unless currency == event['coin'] && @wallet.fetch(:wallet_id) == event['wallet']
+
+        if event['type'] == 'transfer'
+          transactions = fetch_transfer!(event['transfer'])
+          return { transfers: transactions }
+        elsif event['type'] == 'address_confirmation'
+          address_id = fetch_address_id(event['address'])
+          return { address_id: address_id, currency_id: currency_id }
+        end
+      end
+
+      def register_webhooks!(url)
+        transfer_webhook(url)
+        address_confirmation_webhook(url)
+      end
+
+      def fetch_address_id(address)
+        currency = erc20_currency_id
+        client.rest_api(:get, "#{currency}/wallet/#{wallet_id}/address/#{address}")
+              .fetch('id')
+      rescue Bitgo::Client::Error => e
+        raise Peatio::Wallet::ClientError, e
+      end
+
+      def fetch_transfer!(id)
+        # TODO: Add Rspecs for this one
+        response = client.rest_api(:get, "#{currency_id}/wallet/#{wallet_id}/transfer/#{id}")
+        parse_entries(response['entries']).map do |entry|
+          to_address =  if response.dig('coinSpecific', 'memo').present?
+                          memo = response.dig('coinSpecific', 'memo')
+                          memo_type = memo.kind_of?(Array) ? memo.first  : memo
+                          build_address(entry['address'], memo_type)
+                        else
+                          entry['address']
+                        end
+          state = define_transaction_state(response['state'])
+
+          transaction = Peatio::Transaction.new(
+            currency_id: @currency.fetch(:id),
+            amount: convert_from_base_unit(entry['valueString']),
+            hash: normalize_txid(response['txid']),
+            to_address: to_address,
+            block_number: response['height'],
+            # TODO: Add sendmany support
+            txout: 0,
+            status: state
+          )
+
+          transaction if transaction.valid?
+        end.compact
+      rescue Bitgo::Client::Error => e
+        raise Peatio::Wallet::ClientError, e
+      end
+
+      def transfer_webhook(url)
+        client.rest_api(:post, "#{currency_id}/wallet/#{wallet_id}/webhooks", {
+          type: 'transfer',
+          allToken: true,
+          url: url,
+          label: "webhook for #{url}",
+          listenToFailureStates: false
+        })
+      end
+
+      def address_confirmation_webhook(url)
+        client.rest_api(:post, "#{currency_id}/wallet/#{wallet_id}/webhooks", {
+          type: 'address_confirmation',
+          allToken: true,
+          url: url,
+          label: "webhook for #{url}",
+          listenToFailureStates: false
+        })
+      end
+
+      def parse_entries(entries)
+        entries.map do |e|
+          e if e["valueString"].to_i.positive?
+        end.compact
+      end
+
+      private
+
+      def client
+        uri = @wallet.fetch(:uri) { raise Peatio::Wallet::MissingSettingError, :uri }
+        access_token = @wallet.fetch(:access_token) { raise Peatio::Wallet::MissingSettingError, :access_token }
+
+        currency_code_prefix = @wallet.fetch(:testnet) ? 't' : ''
+        uri = uri.gsub(/\/+\z/, '') + '/' + currency_code_prefix
+        @client ||= Client.new(uri, access_token)
+      end
+
+      def build_address(address, memo)
+        "#{address}?memoId=#{memo['value']}"
+      end
+
+      # All these functions will have to be done with the coin set to eth or teth
+      # since that is the actual coin type being used.
+      def erc20_currency_id
+        return 'eth' if @currency.fetch(:options).slice(:erc20_contract_address).present?
+
+        currency_id
+      end
+
+      def xlm_memo(address)
+        build_xlm_memo(address) if @currency.fetch(:id) == 'xlm'
+      end
+
+      def build_xlm_memo(address)
+        case address.split('?').last.split('=').first
+        when 'memoId'
+          memo_value_from(address, 'memoId')
+        when 'memoText'
+          memo_value_from(address, 'memoText')
+        when 'memoHash'
+          memo_value_from(address, 'memoHash')
+        when 'memoReturn'
+          memo_value_from(address, 'memoReturn')
+        end
+      end
+
+      def memo_value_from(address, type)
+        memo_value = address.partition(type + '=').last
+        return { type: XLM_MEMO_TYPES[type.to_sym], value: memo_value } if memo_value.present?
+      end
+
+      def currency_id
+        @currency.fetch(:id) { raise Peatio::Wallet::MissingSettingError, :id }
+      end
+
+      def bitgo_wallet_passphrase
+        @wallet.fetch(:secret)
+      end
+
+      def wallet_id
+        @wallet.fetch(:wallet_id)
+      end
+
+      def normalize_address(address)
+        if @currency.fetch(:id) == 'xlm'
+          address.split('?').first
+        else
+          address
+        end
+      end
+
+      def normalize_txid(txid)
+        txid.downcase
+      end
+
+      def convert_from_base_unit(value)
+        value.to_d / @currency.fetch(:base_factor)
+      end
+
+      def convert_to_base_unit(value)
+        x = value.to_d * @currency.fetch(:base_factor)
+        unless (x % 1).zero?
+          raise Peatio::WalletClient::Error,
+                "Failed to convert value to base (smallest) unit because it exceeds the maximum precision: " \
+                "#{value.to_d} - #{x.to_d} must be equal to zero."
+        end
+        x.to_i
+      end
+
+      def time_difference_in_minutes(updated_at)
+        (Time.now - updated_at)/60
+      end
+
+      def define_transaction_state(state)
+        case state
+        when 'unconfirmed'
+          'pending'
+        when 'confirmed'
+          'success'
+        when 'failed','rejected'
+          'failed'
+        end
+      end
+    end
+  end
+end