peatio-electrum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1826ed8fd6cda494ca2bbc3ff4a96c3fafb9c0424abc85dbb6b917fecb0834d0
+  data.tar.gz: 249fa5f632f8e32d2d467ff1b7e4bad7090ebf1afbed06200bb0730c740d6a30
+SHA512:
+  metadata.gz: 41add4a5bc5151cf30e6babd801fc6c3351d4aaaacf0b99d84f5fd12d8f33bcc57b33e99d044b0d9dbe6bb02831a8431382b4ac1572acaee1bd5c7d17cd6a8da
+  data.tar.gz: 893cb8b69be5485048e9c0dbca02965c6fb53e5778a91e27e23f444aa5c8d10ed11ed1dd1f050875257608217ac1009195d05f74b2bc3958232e7dd4ec0690af

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in peatio-electrum.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    peatio-electrum (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.0)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    io-console (0.5.6)
+    irb (1.2.4)
+      reline (>= 0.0.1)
+    jaro_winkler (1.5.4)
+    minitest (5.14.0)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    rack (2.2.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    reline (0.1.4)
+      io-console (~> 0.5)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-github (0.15.0)
+      rubocop (<= 0.82.0)
+      rubocop-performance (~> 1.0)
+      rubocop-rails (~> 2.0)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    rubocop-rails (2.5.2)
+      activesupport
+      rack (>= 1.1)
+      rubocop (>= 0.72.0)
+    ruby-progressbar (1.10.1)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  irb
+  peatio-electrum!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop-github
+  simplecov
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,20 @@
+# Peatio Electrum Blockchain Plugin
+
+This gem is a [peatio](https://github.com/openware/peatio) plugin adding the support of Electrum blockchain.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'peatio-electrum'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install peatio-electrum
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/peatio-electrum-console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "peatio/electrum"
+
+# 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(__FILE__)

data/bin/peatio-electrum-setup

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "peatio/electrum"
+
+# 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(__FILE__)

data/lib/peatio/electrum.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Peatio
+  module Electrum
+    Error = Class.new(StandardError)
+
+    require "peatio/electrum/version"
+    require "peatio/electrum/hooks"
+    require "peatio/electrum/blockchain"
+    require "peatio/electrum/wallet"
+  end
+end
+

data/lib/peatio/electrum/blockchain.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Peatio::Electrum
+  #
+  # See the abstract class here:
+  # https://github.com/openware/peatio-core/blob/master/lib/peatio/blockchain/abstract.rb
+  #
+  class Blockchain < Peatio::Blockchain::Abstract
+    DEFAULT_FEATURES = {case_sensitive: true}.freeze
+
+    # You could override default features by passing them to initializer.
+    def initialize(custom_features = {})
+      @features = DEFAULT_FEATURES.merge(custom_features)
+    end
+
+    # Merges given configuration parameters with defined during initialization
+    # and returns the result.
+    #
+    # @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.
+    #
+    # @note Be careful with your blockchain state after configure.
+    #       Clean everything what could be related to other blockchain configuration.
+    #       E.g. client state.
+    def configure(settings = {})
+      @settings.merge!(settings.slice(*SUPPORTED_SETTINGS))
+    end
+
+    # Fetches blockchain block by calling API and builds block object
+    # from response payload.
+    #
+    # @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)
+      method_not_implemented
+    end
+
+    # Fetches current blockchain height by calling API and returns it as number.
+    #
+    # @return [Integer] the current blockchain height.
+    # @raise [Peatio::Blockchain::ClientError] if error was raised
+    #   on blockchain API call.
+    def latest_block_number
+      method_not_implemented
+    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
+  end
+end

data/lib/peatio/electrum/hooks.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Peatio::Electrum::Hooks
+  class << self
+    def check_compatibility
+      if Peatio::Blockchain::VERSION >= '2.0'
+        [
+          "Electrum plugin was designed for work with 1.x. Blockchain.",
+          "You have #{Peatio::Electrum::Blockchain::VERSION}."
+        ].join('\n').tap { |s| Kernel.abort s }
+      end
+
+      if Peatio::Wallet::VERSION >= '2.0'
+        [
+          "Electrum plugin was designed for work with 1.x. Wallet.",
+          "You have #{Peatio::Electrum::Wallet::VERSION}."
+        ].join('\n').tap { |s| Kernel.abort s }
+      end
+    end
+
+    def register
+      Peatio::Blockchain.registry[:Electrum] = Electrum::Blockchain
+      Peatio::Wallet.registry[:Electrumd] = Electrum::Wallet
+    end
+  end
+
+  if defined?(Rails::Railtie)
+    require "peatio/Electrum/railtie"
+  else
+    check_compatibility
+    register
+  end
+end

data/lib/peatio/electrum/railtie.rb

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

data/lib/peatio/electrum/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Peatio
+  module Electrum
+    VERSION = "0.1.0"
+  end
+end

data/lib/peatio/electrum/wallet.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Peatio::Electrum
+  #
+  # See the abstract class here:
+  # https://github.com/openware/peatio-core/blob/master/lib/peatio/wallet/abstract.rb
+  #
+  class Wallet < Peatio::Wallet::Abstract
+
+    def initialize(settings = {})
+      @settings = settings
+    end
+
+    # Merges given configuration parameters with defined during initialization
+    # and returns the result.
+    #
+    # @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.
+    #
+    # @note Be careful with your wallet state after configure.
+    #       Clean everything what could be related to other wallet configuration.
+    #       E.g. client state.
+    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)
+
+      @currency = @settings.fetch(:currency) do
+        raise Peatio::Wallet::MissingSettingError, :currency
+      end.slice(:id, :base_factor, :options)
+    end
+
+    # Performs API call for address creation and returns it.
+    #
+    # @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 = {})
+      method_not_implemented
+    end
+
+    # Performs API call for creating transaction and returns updated transaction.
+    #
+    # @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 = {})
+      method_not_implemented
+    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
+
+  end
+end

data/peatio-electrum.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "peatio/electrum/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "peatio-electrum"
+  spec.version       = Peatio::Electrum::VERSION
+  spec.authors       = ["Camille Meulien"]
+  spec.email         = ["cmeulien@heliostech.fr"]
+
+  spec.summary       = "Peatio Electrum Blockchain Plugin"
+  spec.description   = "Peatio Electrum Blockchain Plugin"
+  spec.homepage      = "https://www.openware.com"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/openware/peatio-contrib"
+    spec.metadata["changelog_uri"] = "https://github.com/openware/peatio-contrib/blob/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "irb"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop-github"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: peatio-electrum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Camille Meulien
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-github
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Peatio Electrum Blockchain Plugin
+email:
+- cmeulien@heliostech.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/peatio-electrum-console
+- bin/peatio-electrum-setup
+- lib/peatio/electrum.rb
+- lib/peatio/electrum/blockchain.rb
+- lib/peatio/electrum/hooks.rb
+- lib/peatio/electrum/railtie.rb
+- lib/peatio/electrum/version.rb
+- lib/peatio/electrum/wallet.rb
+- peatio-electrum.gemspec
+homepage: https://www.openware.com
+licenses: []
+metadata:
+  homepage_uri: https://www.openware.com
+  source_code_uri: https://github.com/openware/peatio-contrib
+  changelog_uri: https://github.com/openware/peatio-contrib/blob/master/CHANGELOG.md
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Peatio Electrum Blockchain Plugin
+test_files: []