stellar_spectrum 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82171102575548c02b4566a049a7959544daea5bb1e4509df7a5ce1e78dd1a2e
-  data.tar.gz: 88a64d56566dacc96206c78be2fb0f4aa37ba36a0565009c9db048f55feaa3f8
+  metadata.gz: b1f612b68e42b96844627bd1b79a6bd3fc6af1cae0c58d61a6f71390b6514886
+  data.tar.gz: 9aa9ae6bbf9dc14a972b0eb544d3e335689ad932afbf9ffa9d9b9e7c32d02eae
 SHA512:
-  metadata.gz: 548ca98342523d4b589461d1a8f5ea210778a0d97acc6e0844b83c38d9ca36c9d250ef04e73b9dd5fa906ee063f5f103ac409f4f7dbfaeb1fa496e4e80260e38
-  data.tar.gz: 398063e01bf565768e527af8eba2dce1dae26d0c5f914363a76de8a7a3bde7398d1581315e032647ea33f991610cbee71892ffe3104d3e261776b26fed4ced46
+  metadata.gz: baf26711abdfea3e88212dbd5255fa8b50ae12f0c57081f9b3438306f50c3ae11ecb2a9375a3cb1114c66504574897e3f8689add2cfdacab8679c25a243d8b79
+  data.tar.gz: 47bbc538c0706fe459060bbb5c22ed5d002443ac56e471777a9209af5d1c77d9226602429bd2362a16708117b2f95e5eb693c011ffaae3c456792bb571201bce

data/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.1] - 2018-12-13
+### Fixed
+- [Make unlocking strategy safer](https://github.com/bloom-solutions/stellar_spectrum-ruby/pull/9)
+
 ## [1.1.0] - 2018-12-12
 ### Added
 - Retry when timeout is encountered [#6](https://github.com/bloom-solutions/stellar_spectrum-ruby/pull/6)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stellar_spectrum (1.1.0)
+    stellar_spectrum (1.1.1)
       activesupport
       gem_config
       light-service

data/lib/stellar_spectrum.rb

@@ -7,7 +7,6 @@ require "redis"
 require "active_support/core_ext/hash/except"
 require "active_support/core_ext/object/blank"
 require 'active_support/core_ext/integer/inflections'
-require "stellar_spectrum/services/get_channel_account_info"
 require "stellar_spectrum/services/get_available_channels"
 require "stellar_spectrum/services/get_channel_accounts"
 require "stellar_spectrum/services/get_key_for_address"
@@ -19,13 +18,9 @@ require "stellar_spectrum/services/init_stellar_client"
 require "stellar_spectrum/services/lock_channel"
 require "stellar_spectrum/services/pick_channel"
 require "stellar_spectrum/services/send_payment"
-require "stellar_spectrum/services/sending_payment/attempt_release_lock"
 require "stellar_spectrum/services/sending_payment/retry"
 require "stellar_spectrum/services/sending_payment/send_asset"
-require "stellar_spectrum/services/unlocking/attempt_release"
-require "stellar_spectrum/services/unlocking/check_sequence_number"
-require "stellar_spectrum/services/unlocking/get_account_to_unlock"
-require "stellar_spectrum/services/unlocking/unlock"
+require "stellar_spectrum/services/unlock"
 
 module StellarSpectrum
 

data/lib/stellar_spectrum/client.rb

@@ -7,7 +7,7 @@ module StellarSpectrum
     attr_accessor :logger
 
     LOG_TAG = "[StellarSpectrum]"
-    MAX_LOCK_TIME_IN_SECONDS = 30
+    MAX_LOCK_TIME_IN_SECONDS = 120
 
     def initialize(
       redis_url: StellarSpectrum.configuration.redis_url,
@@ -26,7 +26,6 @@ module StellarSpectrum
       to:,
       amount:,
       memo: nil,
-      tries: 0,
       transaction_source: nil,
       sequence: nil
     )

data/lib/stellar_spectrum/services/send_payment.rb

@@ -40,7 +40,7 @@ module StellarSpectrum
         reduce_if(->(c) {c[:force_transaction_source].nil?}, [
           GetLockedAccounts,
           GetAvailableChannels,
-          reduce_if(->(c) { c.available_channels.empty? }, retry_actions),
+          reduce_if(->(c) {c.available_channels.empty?}, SendingPayment::Retry),
           PickChannel,
         ]),
         reduce_if(->(c) {c[:force_transaction_source].present?}, [
@@ -48,15 +48,9 @@ module StellarSpectrum
         ]),
         GetSequenceNumber,
         LockChannel,
-        reduce_if(->(c) {!c.successfully_locked}, retry_actions),
+        reduce_if(->(c) {!c.successfully_locked}, SendingPayment::Retry),
         SendingPayment::SendAsset,
-      ]
-    end
-
-    def self.retry_actions
-      [
-        SendingPayment::AttemptReleaseLock,
-        SendingPayment::Retry,
+        Unlock,
       ]
     end
 

data/lib/stellar_spectrum/services/unlock.rb

@@ -0,0 +1,14 @@
+module StellarSpectrum
+  class Unlock
+
+    extend LightService::Action
+    expects :redis, :channel_account
+    promises :unlock_response
+
+    executed do |c|
+      address_key = GetKeyForAddress.execute(c.channel_account.address)
+      c.unlock_response = c.redis.del(address_key)
+    end
+
+  end
+end

data/lib/stellar_spectrum/version.rb

@@ -1,3 +1,3 @@
 module StellarSpectrum
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stellar_spectrum
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Ramon Tayag
@@ -176,7 +176,6 @@ files:
 - lib/stellar_spectrum.rb
 - lib/stellar_spectrum/client.rb
 - lib/stellar_spectrum/services/get_available_channels.rb
-- lib/stellar_spectrum/services/get_channel_account_info.rb
 - lib/stellar_spectrum/services/get_channel_accounts.rb
 - lib/stellar_spectrum/services/get_key_for_address.rb
 - lib/stellar_spectrum/services/get_locked_accounts.rb
@@ -187,13 +186,9 @@ files:
 - lib/stellar_spectrum/services/lock_channel.rb
 - lib/stellar_spectrum/services/pick_channel.rb
 - lib/stellar_spectrum/services/send_payment.rb
-- lib/stellar_spectrum/services/sending_payment/attempt_release_lock.rb
 - lib/stellar_spectrum/services/sending_payment/retry.rb
 - lib/stellar_spectrum/services/sending_payment/send_asset.rb
-- lib/stellar_spectrum/services/unlocking/attempt_release.rb
-- lib/stellar_spectrum/services/unlocking/check_sequence_number.rb
-- lib/stellar_spectrum/services/unlocking/get_account_to_unlock.rb
-- lib/stellar_spectrum/services/unlocking/unlock.rb
+- lib/stellar_spectrum/services/unlock.rb
 - lib/stellar_spectrum/version.rb
 - stellar_spectrum.gemspec
 homepage: https://github.com/bloom-solutions/stellar_spectrum-ruby

data/lib/stellar_spectrum/services/get_channel_account_info.rb

@@ -1,23 +0,0 @@
-module StellarSpectrum
-  class GetChannelAccountInfo
-
-    extend LightService::Action
-    expects :locked_accounts, :channel_account
-    promises :channel_account_info, :unlock_response
-
-    executed do |c|
-      c.channel_account_info = c.locked_accounts[c.channel_account.address]
-
-      c.unlock_response = nil
-      next c if c.channel_account_info.present?
-
-      c.unlock_response = true
-
-      message = "#{c.channel_account.address} has been unlocked by some " \
-        "other mechanism like ttl expiration or by something else, " \
-        "so this is a success"
-      c.skip_remaining!(message)
-    end
-
-  end
-end

data/lib/stellar_spectrum/services/sending_payment/attempt_release_lock.rb

@@ -1,18 +0,0 @@
-module StellarSpectrum
-  module SendingPayment
-    class AttemptReleaseLock
-
-      extend LightService::Action
-      expects :stellar_client, :redis, :channel_accounts
-
-      executed do |c|
-        Unlocking::AttemptRelease.(
-          stellar_client: c.stellar_client,
-          redis: c.redis,
-          channel_accounts: c.channel_accounts,
-        )
-      end
-
-    end
-  end
-end

data/lib/stellar_spectrum/services/unlocking/attempt_release.rb

@@ -1,37 +0,0 @@
-module StellarSpectrum
-  module Unlocking
-    class AttemptRelease
-
-      extend LightService::Organizer
-      def self.call(redis:, channel_accounts:, stellar_client:)
-        result = with(
-          stellar_client: stellar_client,
-          redis: redis,
-          channel_accounts: channel_accounts,
-        ).reduce(actions)
-
-        if result.failure?
-          result[:unlock_response] = false
-        end
-
-        result
-      end
-
-      def self.actions
-        [
-          GetLockedAccounts,
-          GetAccountToUnlock,
-          GetSequenceNumber,
-          # Someone else may have unlocked it while we were taking
-          # our sweet time fetching the sequence number, so fetch
-          # the locked accounts again:
-          GetLockedAccounts,
-          GetChannelAccountInfo,
-          CheckSequenceNumber,
-          Unlock,
-        ]
-      end
-
-    end
-  end
-end

data/lib/stellar_spectrum/services/unlocking/check_sequence_number.rb

@@ -1,25 +0,0 @@
-module StellarSpectrum
-  module Unlocking
-    class CheckSequenceNumber
-
-      extend LightService::Action
-      expects :current_sequence_number, :channel_account, :channel_account_info
-
-      executed do |c|
-        address_sequence_number = c.channel_account_info[:sequence_number].to_i
-        current_sequence_number = c.current_sequence_number
-
-        next c if current_sequence_number >= address_sequence_number
-
-        address = c.channel_account.address
-
-        message = "Not releasing #{address}: sequence number locked at " \
-          "#{address_sequence_number} is > current sequence number " \
-          "#{current_sequence_number}"
-
-        c.fail_and_return! message
-      end
-
-    end
-  end
-end

data/lib/stellar_spectrum/services/unlocking/get_account_to_unlock.rb

@@ -1,23 +0,0 @@
-module StellarSpectrum
-  module Unlocking
-    class GetAccountToUnlock
-
-      extend LightService::Action
-      expects :locked_accounts
-      promises :channel_account
-
-      executed do |c|
-        address, info = c.locked_accounts.except(c[:except_address])
-          .sort_by {|address, info| info[:pttl]}.last
-
-        if address.present?
-          c.channel_account = Stellar::Account.from_address(address)
-        else
-          c.channel_account = nil
-          c.fail_and_return! "No addresses to unlock"
-        end
-      end
-
-    end
-  end
-end

data/lib/stellar_spectrum/services/unlocking/unlock.rb

@@ -1,16 +0,0 @@
-module StellarSpectrum
-  module Unlocking
-    class Unlock
-
-      extend LightService::Action
-      expects :redis, :channel_account
-      promises :unlock_response
-
-      executed do |c|
-        address_key = GetKeyForAddress.execute(c.channel_account.address)
-        c.unlock_response = c.redis.del(address_key)
-      end
-
-    end
-  end
-end