peatio 0.4.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cc7f7dae49e5e34e71138ae6f7c5097516309d421fe9a048d3fffc5aa4c4081
-  data.tar.gz: 209f063cd346d27742b57a12a991904cd7c9c320154aab9fb7d50eb9ce45d736
+  metadata.gz: 25f7358d1288e7c007202f1035d577a9dcd33b61b7f23bddf6d5b8c057bb5607
+  data.tar.gz: 24fab553870452be347d1fe1fc1067556e485a5856767e4306e5548758135b24
 SHA512:
-  metadata.gz: 9b85df8a9f919dadc29dfaff264555cfecefd1b5477e0161ccf517f1370c1a7a4e6f7b663cdc7b8982b70f937c85bf522f94b887ce30d5ec86710385814f2f37
-  data.tar.gz: 0b2081360b0f23ca898dbef3e0a0d3327f9355ff0e2e5de3c45fb45d30ff0da7fc30d6d2885abbe74210cf87b619578b0dccc1606c4f218bad772882df9cd197
+  metadata.gz: ff767337bec9e7b6dfb2993bbe94535138502f9faf761ac70b2e7b30d26bb76df89130aa7cffb1ebab342bad51c512b79034d4f72f42b40a92f7e18240d3eb11
+  data.tar.gz: 4b3602e261f5d09480d2c72e6db5c45617bbf257ebbbf7f3637dd20bb39497569f45f0d189868f437e88c2e0c8bdf6cf44408386714f82d3dacde060cb4a6d5a

data/Gemfile.lock

@@ -2,6 +2,7 @@ PATH
   remote: .
   specs:
     peatio (0.4.5)
+      activemodel (~> 5.2.3)
       amqp
       bunny
       clamp
@@ -13,6 +14,13 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
     amq-protocol (2.3.0)
     amqp (1.8.0)
       amq-protocol (>= 2.2.0)
@@ -24,6 +32,7 @@ GEM
     bunny-mock (1.7.0)
       bunny (>= 1.7)
     clamp (1.3.0)
+    concurrent-ruby (1.1.5)
     diff-lcs (1.3)
     docile (1.3.1)
     em-spec (0.2.7)
@@ -36,9 +45,12 @@ GEM
       websocket
     eventmachine (1.2.7)
     http_parser.rb (0.6.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1)
     json (2.1.0)
     jwt (2.1.0)
+    minitest (5.11.3)
     mysql2 (0.5.2)
     parallel (1.12.1)
     parser (2.5.1.2)
@@ -80,6 +92,9 @@ GEM
     simplecov-json (0.2)
       json
       simplecov
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
     unicode-display_width (1.4.0)
     websocket (1.2.8)
 

data/lib/peatio.rb

@@ -17,4 +17,15 @@ module Peatio
   require_relative "peatio/injectors/peatio_events"
   require_relative "peatio/security/key_generator"
   require_relative "peatio/auth/jwt_authenticator"
+
+  require_relative "peatio/blockchain/abstract"
+  require_relative "peatio/blockchain/error"
+  require_relative "peatio/blockchain/registry"
+
+  require_relative "peatio/wallet/abstract"
+  require_relative "peatio/wallet/error"
+  require_relative "peatio/wallet/registry"
+
+  require_relative "peatio/transaction"
+  require_relative "peatio/block"
 end

data/lib/peatio/adapter_registry.rb

@@ -0,0 +1,25 @@
+module Peatio
+  class AdapterRegistry
+    Error = Class.new(StandardError)
+    DuplicatedAdapterError = Class.new(Error)
+    NotRegisteredAdapterError = Class.new(Error)
+
+    def []=(name, instance)
+      name = name.to_sym
+      raise DuplicatedAdapterError, name if adapters.key?(name)
+      adapters[name] = instance
+    end
+
+    def [](name)
+      adapters.fetch(name.to_sym) { raise NotRegisteredAdapterError, name }
+    end
+
+    def adapters
+      @adapters ||= {}
+    end
+
+    def adapters=(h)
+      @adapters = h
+    end
+  end
+end

data/lib/peatio/block.rb

@@ -0,0 +1,14 @@
+module Peatio
+  class Block
+    include Enumerable
+
+    delegate :each, to: :@transactions
+
+    attr_reader :number, :transactions
+
+    def initialize(number, transactions)
+      @number = number
+      @transactions = transactions
+    end
+  end
+end

data/lib/peatio/blockchain/abstract.rb

@@ -0,0 +1,157 @@
+module Peatio #:nodoc:
+  module Blockchain #:nodoc:
+
+    # @abstract Represents basic blockchain interface.
+    #
+    # Subclass and override abstract methods to implement
+    # a peatio plugable blockchain.
+    # Than you need to register your blockchain implementation.
+    #
+    # @see Bitcoin::Blockchain Bitcoin as example of Abstract imlementation
+    #     (inside peatio source https://github.com/rubykube/peatio).
+    #
+    # @example
+    #
+    #   class MyBlockchain < Peatio::Abstract::Blockchain
+    #     def fetch_block(block_number)
+    #       # do something
+    #     end
+    #     ...
+    #   end
+    #
+    #   # Register MyBlockchain as peatio plugable blockchain.
+    #   Peatio::Blockchain.registry[:my_blockchain] = MyBlockchain.new
+    #
+    # @author
+    #   Yaroslav Savchuk <savchukyarpolk@gmail.com> (https://github.com/ysv)
+    class Abstract
+
+      # Hash of features supported by blockchain.
+      #
+      # @abstract
+      #
+      # @see Abstract::SUPPORTED_FEATURES for list of features supported by peatio.
+      #
+      # @!attribute [r] features
+      # @return [Hash] list of features supported by blockchain.
+      attr_reader :features
+
+      # List of features supported by peatio.
+      #
+      # @note Features list:
+      #
+      #   case_sensitive - defines if transactions and addresses of current
+      #   blockchain are case_sensitive.
+      #
+      #   cash_addr_format - defines if blockchain supports Cash Address format
+      #   for more info see (https://support.exodus.io/article/664-bitcoin-cash-address-format)
+      SUPPORTED_FEATURES = %i[case_sensitive cash_addr_format].freeze
+
+
+      # Current blockchain settings for performing API calls and building blocks.
+      #
+      # @abstract
+      #
+      # @see Abstract::SUPPORTED_SETTINGS for list of settings required by blockchain.
+      #
+      # @!attribute [r] settings
+      # @return [Hash] current blockchain settings.
+      attr_reader :settings
+
+      # List of configurable settings.
+      #
+      # @see #configure
+      SUPPORTED_SETTINGS = %i[server currencies].freeze
+
+
+      # Abstract constructor.
+      #
+      # @abstract
+      #
+      # @example
+      #   class MyBlockchain < Peatio::Abstract::Blockchain
+      #
+      #     DEFAULT_FEATURES = {case_sensitive: true, cash_addr_format: false}.freeze
+      #
+      #     # You could override default features by passing them to initializer.
+      #     def initialize(my_custom_features = {})
+      #       @features = DEFAULT_FEATURES.merge(my_custom_features)
+      #     end
+      #     ...
+      #   end
+      #
+      #   # Register MyBlockchain as peatio plugable blockchain.
+      #   custom_features = {cash_addr_format: true}
+      #   Peatio::Blockchain.registry[:my_blockchain] = MyBlockchain.new(custom_features)
+      def initialize(*)
+        abstract_method
+      end
+
+      # Merges given configuration parameters with defined during initialization
+      # and returns the result.
+      #
+      # @abstract
+      #
+      # @param [Hash] settings parameters to use.
+      #
+      # @option settings [String] :server Public blockchain API endpoint.
+      # @option settings [Array<Hash>] :currencies List of currency hashes
+      #   with :id,:base_factor,:options(deprecated) keys.
+      #   Custom keys could be added by defining them in Currency #options.
+      #
+      # @return [Hash] merged settings.
+      def configure(settings = {})
+        abstract_method
+      end
+
+      # Fetches blockchain block by calling API and builds block object
+      # from response payload.
+      #
+      # @abstract
+      #
+      # @param block_number [Integer] the block number.
+      # @return [Peatio::Block] the block object.
+      # @raise [Peatio::Blockchain::ClientError] if error was raised
+      #   on blockchain API call.
+      def fetch_block!(block_number)
+        abstract_method
+      end
+
+      # Fetches current blockchain height by calling API and returns it as number.
+      #
+      # @abstract
+      #
+      # @return [Integer] the current blockchain height.
+      # @raise [Peatio::Blockchain::ClientError] if error was raised
+      #   on blockchain API call.
+      def latest_block_number
+        abstract_method
+      end
+
+      # Fetches address balance of specific currency.
+      #
+      # @note Optional. Don't override this method if your blockchain
+      # doesn't provide functionality to get balance by address.
+      #
+      # @param address [String] the address for requesting balance.
+      # @param currency_id [String] which currency balance we need to request.
+      # @return [BigDecimal] the current address balance.
+      # @raise [Peatio::Blockchain::ClientError,Peatio::Blockchain::UnavailableAddressBalanceError]
+      # if error was raised on blockchain API call ClientError is raised.
+      # if blockchain API call was successful but we can't detect balance
+      # for address Error is raised.
+      def load_balance_of_address!(address, currency_id)
+        raise Peatio::Blockchain::UnavailableAddressBalanceError
+      end
+
+      private
+
+      # Method for defining other methods as abstract.
+      #
+      # @raise [MethodNotImplemented]
+      def abstract_method
+        method_not_implemented
+      end
+    end
+  end
+end

data/lib/peatio/blockchain/error.rb

@@ -0,0 +1,37 @@
+module Peatio
+  module Blockchain
+    Error = Class.new(StandardError)
+
+    class ClientError < Error
+
+      attr_reader :wrapped_ex
+
+      def initialize(ex_or_string)
+        @wrapped_ex = nil
+
+        if ex_or_string.respond_to?(:backtrace)
+          super(ex_or_string.message)
+          @wrapped_exception = ex_or_string
+        else
+          super(ex_or_string.to_s)
+        end
+      end
+    end
+
+    class MissingSettingError < Error
+      def initialize(key)
+        super "#{key.capitalize} setting is missing"
+      end
+    end
+
+    class UnavailableAddressBalanceError < Error
+      def initialize(address)
+        @address = address
+      end
+
+      def message
+        "Unable to load #{@address} balance"
+      end
+    end
+  end
+end

data/lib/peatio/blockchain/registry.rb

@@ -0,0 +1,16 @@
+require "peatio/adapter_registry"
+
+module Peatio
+  module Blockchain
+
+    VERSION = "1.0".freeze
+
+    class << self
+      def registry
+        @registry ||= Registry.new
+      end
+    end
+    class Registry < Peatio::AdapterRegistry
+    end
+  end
+end

data/lib/peatio/transaction.rb

@@ -0,0 +1,39 @@
+require 'active_support/concern'
+require 'active_model'
+
+module Peatio
+  class Transaction
+    include ActiveModel::Model
+
+    STATUSES = %i[success pending fail].freeze
+
+    attr_accessor :hash, :txout,
+                  :to_address,
+                  :amount,
+                  :block_number,
+                  :currency_id
+
+    attr_writer :status
+
+    validates :hash, :txout,
+              :to_address,
+              :amount,
+              :block_number,
+              :currency_id,
+              :status,
+              presence: true
+
+    validates :block_number,
+              numericality: { greater_than_or_equal_to: 0, only_integer: true }
+
+    validates :amount,
+              numericality: { greater_than_or_equal_to: 0 }
+
+    validates :status, inclusion: { in: STATUSES }
+
+    # TODO: rewrite this method
+    def status
+      @status.to_sym
+    end
+  end
+end

data/lib/peatio/version.rb

@@ -1,3 +1,3 @@
 module Peatio
-  VERSION = "0.4.5"
+  VERSION = "0.5.0"
 end

data/lib/peatio/wallet/abstract.rb

@@ -0,0 +1,168 @@
+module Peatio
+  module Wallet
+    # @abstract Represents basic wallet interface.
+    #
+    # Subclass and override abstract methods to implement
+    # a peatio plugable wallet.
+    # Than you need to register your wallet implementation.
+    #
+    # @see Bitcoin::Wallet Bitcoin as example of Abstract imlementation.
+    #
+    # @example
+    #
+    #   class MyWallet < Peatio::Abstract::Wallet
+    #     def create_address(options = {})
+    #       # do something
+    #     end
+    #     ...
+    #   end
+    #
+    #   # Register MyWallet as peatio plugable wallet.
+    #   Peatio::Wallet.registry[:my_wallet] = MyWallet.new
+    #
+    # @author
+    #   Yaroslav Savchuk <savchukyarpolk@gmail.com> (https://github.com/ysv)
+    class Abstract
+      # Current wallet settings for performing API calls.
+      #
+      # @abstract
+      #
+      # @!attribute [r] settings
+      # @return [Hash] current wallet settings.
+      attr_reader :settings
+
+      # List of configurable settings.
+      #
+      # @see #configure
+      SUPPORTED_SETTINGS = %i[wallet currency].freeze
+
+
+      # Abstract constructor.
+      #
+      # @abstract
+      #
+      # @example
+      #   class MyWallet< Peatio::Abstract::Wallet
+      #
+      #     # You could customize your wallet by passing features.
+      #     def initialize(my_custom_features = {})
+      #       @features = my_custom_features
+      #     end
+      #     ...
+      #   end
+      #
+      #   # Register MyWallet as peatio plugable wallet.
+      #   custom_features = {cash_addr_format: true}
+      #   Peatio::Wallet.registry[:my_wallet] = MyWallet.new(custom_features)
+      def initialize(*)
+        abstract_method
+      end
+
+      # Merges given configuration parameters with defined during initialization
+      # and returns the result.
+      #
+      # @abstract
+      #
+      # @param [Hash] settings configurations to use.
+      # @option settings [Hash] :wallet Wallet settings for performing API calls.
+      # With :address required key other settings could be customized
+      # using Wallet#settings.
+      # @option settings [Array<Hash>] :currencies List of currency hashes
+      #   with :id,:base_factor,:options(deprecated) keys.
+      #   Custom keys could be added by defining them in Currency #options.
+      #
+      # @return [Hash] merged settings.
+      def configure(settings = {})
+        abstract_method
+      end
+
+      # Performs API call for address creation and returns it.
+      #
+      # @abstract
+      #
+      # @param [Hash] options
+      # @options options [String] :uid User UID which requested address creation.
+      #
+      # @return [Hash] newly created blockchain address.
+      #
+      # @raise [Peatio::Blockchain::ClientError] if error was raised
+      #   on wallet API call.
+      #
+      # @example
+      #   { address: :fake_address,
+      #     secret:  :changeme,
+      #     details: { uid: account.member.uid } }
+      def create_address!(options = {})
+        abstract_method
+      end
+
+      # Performs API call for creating transaction and returns updated transaction.
+      #
+      # @abstract
+      #
+      # @param [Peatio::Transaction] transaction transaction with defined
+      # to_address, amount & currency_id.
+      #
+      # @param [Hash] options
+      # @options options [String] :subtract_fee Defines if you need to subtract
+      #   fee from amount defined in transaction.
+      #   It means that you need to deduct fee from amount declared in
+      #   transaction and send only remaining amount.
+      #   If transaction amount is 1.0 and estimated fee
+      #   for sending transaction is 0.01 you need to send 0.09
+      #   so 1.0 (0.9 + 0.1) will be subtracted from wallet balance
+      #
+      # @options options [String] custon options for wallet client.
+      #
+      # @return [Peatio::Transaction] transaction with updated hash.
+      #
+      # @raise [Peatio::Blockchain::ClientError] if error was raised
+      #   on wallet API call.
+      def create_transaction!(transaction, options = {})
+        abstract_method
+      end
+
+      # Fetches address balance of specific currency.
+      #
+      # @note Optional. Don't override this method if your blockchain
+      # doesn't provide functionality to get balance by address.
+      #
+      # @return [BigDecimal] the current address balance.
+      #
+      # @raise [Peatio::Blockchain::ClientError,Peatio::Blockchain::UnavailableAddressBalanceError]
+      # if error was raised on wallet API call ClientError is raised.
+      # if wallet API call was successful but we can't detect balance
+      # for address Error is raised.
+      def load_balance!
+        raise Peatio::Wallet::UnavailableAddressBalanceError
+      end
+
+      # Performs API call(s) for preparing for deposit collection.
+      # E.g deposits ETH for collecting ERC20 tokens in case of Ethereum blockchain.
+      #
+      # @note Optional. Override this method only if you need additional step
+      # before deposit collection.
+      #
+      # @param [Peatio::Transaction] deposit_transaction transaction which
+      # describes received deposit.
+      #
+      # @param [Array<Peatio::Transaction>] spread_transactions result of deposit
+      # spread between wallets.
+      #
+      # @return [Array<Peatio::Transaction>] transaction created for
+      # deposit collection preparing.
+      # By default return empty [Array]
+      def prepare_deposit_collection!(deposit_transaction, spread_transactions, deposit_currency)
+        # This method is mostly used for coins which needs additional fees
+        # to be deposited before deposit collection.
+        []
+      end
+
+      private
+
+      def abstract_method
+        method_not_implemented
+      end
+    end
+  end
+end

data/lib/peatio/wallet/error.rb

@@ -0,0 +1,37 @@
+module Peatio
+  module Wallet
+    Error = Class.new(StandardError)
+
+    class ClientError < Error
+
+      attr_reader :wrapped_ex
+
+      def initialize(ex_or_string)
+        @wrapped_ex = nil
+
+        if ex_or_string.respond_to?(:backtrace)
+          super(ex_or_string.message)
+          @wrapped_exception = ex_or_string
+        else
+          super(ex_or_string.to_s)
+        end
+      end
+    end
+
+    class MissingSettingError < Error
+      def initialize(key)
+        super "#{key.capitalize} setting is missing"
+      end
+    end
+
+    class UnavailableAddressBalanceError < Error
+      def initialize(address)
+        @address = address
+      end
+
+      def message
+        "Unable to load #{@address} balance"
+      end
+    end
+  end
+end

data/lib/peatio/wallet/registry.rb

@@ -0,0 +1,16 @@
+require "peatio/adapter_registry"
+
+module Peatio
+  module Wallet
+
+    VERSION = "1.0".freeze
+
+    class << self
+      def registry
+        @registry ||= Registry.new
+      end
+    end
+    class Registry < Peatio::AdapterRegistry
+    end
+  end
+end

data/peatio.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "activemodel", "~> 5.2.3"
   spec.add_dependency "clamp"
   spec.add_dependency "amqp"
   spec.add_dependency "eventmachine"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: peatio
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.0
 platform: ruby
 authors:
 - Louis B.
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-25 00:00:00.000000000 Z
+date: 2019-05-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
 - !ruby/object:Gem::Dependency
   name: clamp
   requirement: !ruby/object:Gem::Requirement
@@ -286,8 +300,13 @@ files:
 - bin/peatio
 - bin/setup
 - lib/peatio.rb
+- lib/peatio/adapter_registry.rb
 - lib/peatio/auth/error.rb
 - lib/peatio/auth/jwt_authenticator.rb
+- lib/peatio/block.rb
+- lib/peatio/blockchain/abstract.rb
+- lib/peatio/blockchain/error.rb
+- lib/peatio/blockchain/registry.rb
 - lib/peatio/command/amqp.rb
 - lib/peatio/command/base.rb
 - lib/peatio/command/db.rb
@@ -305,7 +324,11 @@ files:
 - lib/peatio/security/key_generator.rb
 - lib/peatio/sql/client.rb
 - lib/peatio/sql/schema.rb
+- lib/peatio/transaction.rb
 - lib/peatio/version.rb
+- lib/peatio/wallet/abstract.rb
+- lib/peatio/wallet/error.rb
+- lib/peatio/wallet/registry.rb
 - peatio.gemspec
 homepage: https://www.peatio.tech
 licenses: []
@@ -325,8 +348,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Peatio is a gem for running critical core services