stellar_base-rails 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f634660d3aa8e4f2c16dbde0657f5b5be1d23f881911e863350a8800f1e6b5e
-  data.tar.gz: e4d0e9d9ff41c4cdb82f195935b4423181ef3b3631f8238b96498839a1dc6f6c
+  metadata.gz: ecb3cdd428227714bb071c59f1ac3b40c85f131522f376363fc0722aa1272a71
+  data.tar.gz: 023c9c4dcf96b9a0d87a7cfb81d6059b987bc81bb5d4f3f2d82361db201db183
 SHA512:
-  metadata.gz: 8104f50041913ea06f3ff64be43d1a0b428494077239899683c4a5f662641707c85e81099b3dc2e8f2354ab1cbe857ccb4a8664ab82a0706630fc4f6908a18bd
-  data.tar.gz: 3277b1888a740c362b9789daa9c2adc3835841c360c5f2e4fb87eae8b1e8a329a8c51105f536e185b75fded1f8044559625a627201c4aeaf863c6d524400e7ac
+  metadata.gz: 9a205a0ec92f9c2b6de8bcddb9e02cff60122318039c537912844666ffdf4bd1cfe94f16343b63d2a45bf3215059d5af5daba40af2b2a72161c38e7099efe9d1
+  data.tar.gz: 4aa5d187e3f65f1a77b6a643aed6ca9b8ce76bbe04666342c2093f9fad2a7a67eebe657bfa4c28f3b5527fae5455af717e68c07565a481d2938d79fc3ec9f574

data/README.md

@@ -54,6 +54,11 @@ This is the same distribution account that is setup in bridge. Currently, it is
 - Default: https://horizon.stellar.org
 - This is where the engine will check bridge callbacks if `c.check_bridge_callbacks_authenticity` is turned on
 
+#### c.stellar_network
+- Values(s): "public" or "testnet"
+- Default: testnet
+- This tells stellar_base-rails what network it will use to send assets/lumens with. Currently used by the deposit module. If someone deposits a real asset, stellar_base sends the corresponding token to the requester.
+
 #### c.stellar_toml
 - Value(s): Hash, follow Stellar's [documentation](https://www.stellar.org/developers/guides/concepts/stellar-toml.html) for `stellar.toml`
 - Example:
@@ -83,6 +88,16 @@ And then execute:
 $ bundle
 ```
 
+If you're using `StellarBase.on_deposit_trigger` you'll need to install:
+
+```
+# Gemfile
+gem("stellar-sdk", {
+  github: "bloom-solutions/ruby-stellar-sdk",
+  branch: "payment-memo",
+})
+```
+
 ## Development
 
 ```ruby

data/app/models/stellar_base/deposit.rb

@@ -0,0 +1,7 @@
+module StellarBase
+  class Deposit < ApplicationRecord
+
+    belongs_to :deposit_request, class_name: "StellarBase::DepositRequest"
+
+  end
+end

data/app/services/stellar_base/deposit_requests/create_deposit.rb

@@ -0,0 +1,19 @@
+module StellarBase
+  module DepositRequests
+    class CreateDeposit
+
+      extend LightService::Action
+      expects :tx_id, :amount, :deposit_request
+      promises :deposit
+
+      executed do |c|
+        c.deposit = Deposit.create!(
+          tx_id: c.tx_id,
+          amount: c.amount,
+          deposit_request_id: c.deposit_request.id,
+        )
+      end
+
+    end
+  end
+end

data/app/services/stellar_base/deposit_requests/find_config.rb

@@ -0,0 +1,23 @@
+module StellarBase
+  module DepositRequests
+    class FindConfig
+
+      extend LightService::Action
+
+      expects :network
+      promises :deposit_config
+
+      executed do |c|
+        depositable_assets = StellarBase.configuration.depositable_assets
+        c.deposit_config = depositable_assets.find do |asset|
+          asset[:network] == c.network
+        end
+
+        if c.deposit_config.blank?
+          c.fail_and_return! "No depositable_asset config for #{c.network}"
+        end
+      end
+
+    end
+  end
+end

data/app/services/stellar_base/deposit_requests/find_deposit.rb

@@ -0,0 +1,21 @@
+module StellarBase
+  module DepositRequests
+    class FindDeposit
+
+      extend LightService::Action
+
+      expects :deposit_request, :tx_id
+      promises :deposit
+
+      executed do |c|
+        c.deposit = Deposit.find_by(
+          deposit_request_id: c.deposit_request.id,
+          tx_id: c.tx_id,
+        )
+
+        c.skip_remaining! if c.deposit.present?
+      end
+
+    end
+  end
+end

data/app/services/stellar_base/deposit_requests/find_deposit_request.rb

@@ -0,0 +1,27 @@
+module StellarBase
+  module DepositRequests
+    class FindDepositRequest
+
+      extend LightService::Action
+
+      expects :deposit_config, :deposit_address
+      promises :deposit_request
+
+      executed do |c|
+        deposit_address = c.deposit_address
+        asset_code = c.deposit_config[:asset_code]
+
+        c.deposit_request = DepositRequest.find_by(
+          deposit_address: deposit_address,
+          asset_code: asset_code,
+        )
+
+        if c.deposit_request.blank?
+          c.fail_and_return! "No DepositRequest found for " +
+            [asset_code, deposit_address].join(":")
+        end
+      end
+
+    end
+  end
+end

data/app/services/stellar_base/deposit_requests/init_stellar_amount.rb

@@ -0,0 +1,15 @@
+module StellarBase
+  module DepositRequests
+    class InitStellarAmount
+
+      extend LightService::Action
+      expects :stellar_asset, :amount
+      promises :stellar_amount
+
+      executed do |c|
+        c.stellar_amount = Stellar::Amount.new(c.amount, c.stellar_asset)
+      end
+
+    end
+  end
+end

data/app/services/stellar_base/deposit_requests/init_stellar_asset.rb

@@ -0,0 +1,18 @@
+module StellarBase
+  module DepositRequests
+    class InitStellarAsset
+
+      extend LightService::Action
+      expects :deposit_request, :issuer_account
+      promises :stellar_asset
+
+      executed do |c|
+        c.stellar_asset = Stellar::Asset.alphanum4(
+          c.deposit_request.asset_code,
+          c.issuer_account.keypair,
+        )
+      end
+
+    end
+  end
+end

data/app/services/stellar_base/deposit_requests/init_stellar_distribution_account.rb

@@ -0,0 +1,17 @@
+module StellarBase
+  module DepositRequests
+    class InitStellarDistributionAccount
+
+      extend LightService::Action
+      expects :deposit_config
+      promises :distribution_account
+
+      executed do |c|
+        config = c.deposit_config
+        c.distribution_account = Stellar::Account
+          .from_seed(config[:distributor_seed])
+      end
+
+    end
+  end
+end

data/app/services/stellar_base/deposit_requests/init_stellar_issuer_account.rb

@@ -0,0 +1,16 @@
+module StellarBase
+  module DepositRequests
+    class InitStellarIssuerAccount
+
+      extend LightService::Action
+      expects :deposit_config
+      promises :issuer_account
+
+      executed do |c|
+        config = c.deposit_config
+        c.issuer_account = Stellar::Account.from_address(config[:issuer])
+      end
+
+    end
+  end
+end

data/app/services/stellar_base/deposit_requests/init_stellar_recipient_account.rb

@@ -0,0 +1,16 @@
+module StellarBase
+  module DepositRequests
+    class InitStellarRecipientAccount
+
+      extend LightService::Action
+      expects :deposit_request
+      promises :recipient_account
+
+      executed do |c|
+        c.recipient_account = Stellar::Account
+          .from_address(c.deposit_request.account_id)
+      end
+
+    end
+  end
+end

data/app/services/stellar_base/deposit_requests/send_asset.rb

@@ -0,0 +1,40 @@
+module StellarBase
+  module DepositRequests
+    class SendAsset
+
+      extend LightService::Action
+      expects(
+        :deposit_request,
+        :distribution_account,
+        :issuer_account,
+        :recipient_account,
+        :stellar_amount,
+        :stellar_sdk_client,
+      )
+      promises :stellar_tx_id
+
+      executed do |c|
+        msg = [
+          "issuing account: #{c.issuer_account.address}",
+          "recipient account: #{c.recipient_account.address}",
+          "stellar amount: #{c.stellar_amount.amount}#{c.stellar_amount.asset}",
+          "distribution account: #{c.distribution_account.address}",
+          "recipient memo: #{c.deposit_request.memo}",
+        ].join("; ")
+
+        Rails.logger.info(msg)
+
+        # TODO: handle when this fails
+        response = c.stellar_sdk_client.send_payment(
+          from: c.distribution_account,
+          to: c.recipient_account,
+          amount: c.stellar_amount,
+          memo: c.deposit_request.memo,
+        )
+
+        c.stellar_tx_id = response.to_hash["hash"]
+      end
+
+    end
+  end
+end

data/app/services/stellar_base/deposit_requests/trigger.rb

@@ -0,0 +1,35 @@
+module StellarBase
+  module DepositRequests
+    class Trigger
+
+      extend LightService::Organizer
+
+      def self.call(network, deposit_address, tx_id, amount)
+        with(
+          network: network,
+          deposit_address: deposit_address,
+          tx_id: tx_id,
+          amount: amount,
+        ).reduce(actions)
+      end
+
+      def self.actions
+        [
+          FindConfig,
+          FindDepositRequest,
+          FindDeposit,
+          CreateDeposit,
+          InitStellarClient,
+          InitStellarIssuerAccount,
+          InitStellarRecipientAccount,
+          InitStellarDistributionAccount,
+          InitStellarAsset,
+          InitStellarAmount,
+          SendAsset,
+          UpdateDeposit, # save the stellar operation id on it
+        ]
+      end
+
+    end
+  end
+end

data/app/services/stellar_base/deposit_requests/update_deposit.rb

@@ -0,0 +1,14 @@
+module StellarBase
+  module DepositRequests
+    class UpdateDeposit
+
+      extend LightService::Action
+      expects :stellar_tx_id, :deposit
+
+      executed do |c|
+        c.deposit.update!(stellar_tx_id: c.stellar_tx_id)
+      end
+
+    end
+  end
+end

data/app/services/stellar_base/init_stellar_client.rb

@@ -0,0 +1,14 @@
+module StellarBase
+  class InitStellarClient
+
+    extend LightService::Action
+    promises :stellar_sdk_client
+
+    executed do |c|
+      c.stellar_sdk_client = Stellar::Client.new(
+        horizon: StellarBase.configuration.horizon_url,
+      )
+    end
+
+  end
+end

data/db/migrate/20181001070647_create_stellar_base_deposits.rb

@@ -0,0 +1,18 @@
+class CreateStellarBaseDeposits < ActiveRecord::Migration[5.2]
+
+  def change
+    create_table :stellar_base_deposits do |t|
+      t.integer :deposit_request_id, index: true
+      t.string :tx_id, index: true
+      t.decimal :amount
+      t.string :stellar_tx_id
+
+      t.timestamps
+    end
+
+    add_foreign_key(:stellar_base_deposits, :stellar_base_deposit_requests, {
+      column: :deposit_request_id,
+    })
+  end
+
+end

data/lib/stellar_base.rb

@@ -17,68 +17,87 @@ module StellarBase
   include GemConfig::Base
 
   with_configuration do
+    has :bridge_callbacks_mac_key, default: false
+    has :check_bridge_callbacks_authenticity, default: false
+    has :check_bridge_callbacks_mac_payload, default: false
+    has :distribution_account, classes: [NilClass, String]
     has :horizon_url, default: "https://horizon.stellar.org"
     has :modules, default: [:bridge_callbacks]
-
-    has :distribution_account, classes: [NilClass, String]
-
     has :on_bridge_callback
-    has :check_bridge_callbacks_authenticity, default: false
-    has :check_bridge_callbacks_mac_payload, default: false
-    has :bridge_callbacks_mac_key, default: false
-
-    has :withdrawable_assets, classes: [NilClass, Array, String, Pathname]
     has :on_withdraw
-
-    has :depositable_assets, classes: [NilClass, Array, String, Pathname]
-
+    has :stellar_network, classes: String, default: "testnet"
     has :stellar_toml, classes: Hash, default: {}
+    has :depositable_assets, classes: [NilClass, Array, String, Pathname]
+    has :withdrawable_assets, classes: [NilClass, Array, String, Pathname]
   end
 
   after_configuration_change do
-    self.convert_config_withdraw!
-    self.convert_config_deposit!
+    convert_config_withdraw!
+    convert_config_deposit!
+    set_stellar_network!
   end
 
+  def self.on_deposit_trigger(network:, deposit_address:, tx_id:, amount:)
+    result = DepositRequests::Trigger.(network, deposit_address, tx_id, amount)
+    raise StandardError, result.message if result.failure?
+    result
+  end
 
   def self.included_module?(module_name)
-    self.configuration.modules&.include?(module_name)
+    configuration.modules&.include?(module_name)
+  end
+
+  def self.set_stellar_network!
+    stellar_network = configuration.stellar_network
+
+    case stellar_network
+    when "public"
+      Stellar.default_network = Stellar::Networks::PUBLIC
+    when "testnet"
+      Stellar.default_network = Stellar::Networks::TESTNET
+    else
+      raise(
+        ArgumentError,
+        "'#{stellar_network}' not a valid stellar_network config",
+      )
+    end
   end
 
   def self.convert_config_deposit!
-    depositable_assets = self.configuration.depositable_assets
+    depositable_assets = configuration.depositable_assets
     return if depositable_assets.is_a?(Array) || depositable_assets.nil?
 
-    self.configuration.depositable_assets =
+    configuration.depositable_assets =
       convert_config!(depositable_assets)
   end
 
   def self.convert_config_withdraw!
-    withdrawable_assets = self.configuration.withdrawable_assets
+    withdrawable_assets = configuration.withdrawable_assets
     return if withdrawable_assets.is_a?(Array) || withdrawable_assets.nil?
 
-    self.configuration.withdrawable_assets =
+    configuration.withdrawable_assets =
       convert_config!(withdrawable_assets)
   end
 
-  private
-
   def self.convert_config!(asset_config)
     array_of_hashes = try_from_yaml_file_path(asset_config) ||
       try_from_json(asset_config)
 
     array_of_hashes.map(&:with_indifferent_access)
   end
+  private_class_method :convert_config!
 
   def self.try_from_json(str)
     JSON.parse(str)
   rescue JSON::ParserError
   end
+  private_class_method :try_from_json
 
   def self.try_from_yaml_file_path(str)
     YAML.load_file(str.to_s)
   rescue Errno::ENOENT
   end
+  private_class_method :try_from_yaml_file_path
 end
 
 require "stellar_base/horizon_client"

data/lib/stellar_base/factories/deposit_requests.rb

@@ -1,7 +1,8 @@
 FactoryBot.define do
-
   factory :stellar_base_deposit_request, class: "StellarBase::DepositRequest" do
     deposit_address { "dep-addr" }
+    asset_code { "BTCT" }
+    asset_type { "crypto" }
     issuer { "issuer-addr" }
     memo_type { "text" }
     memo { "ABAC" }
@@ -13,5 +14,4 @@ FactoryBot.define do
     fee_fixed { 0 }
     fee_percent { 0 }
   end
-
 end

data/lib/stellar_base/factories/deposits.rb

@@ -0,0 +1,11 @@
+FactoryBot.define do
+  factory :stellar_base_deposit, class: "StellarBase::Deposit" do
+    stellar_tx_id { "issuer-addr" }
+    deposit_request do
+      StellarBase::DepositRequest.first ||
+        association(:stellar_base_deposit_request)
+    end
+    tx_id { "dep-addr" }
+    amount { "crypto" }
+  end
+end

data/lib/stellar_base/version.rb

@@ -1,3 +1,3 @@
 module StellarBase
-  VERSION = "0.6.1".freeze
+  VERSION = "0.7.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stellar_base-rails
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Ace Subido
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-28 00:00:00.000000000 Z
+date: 2018-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: disposable
@@ -310,6 +310,7 @@ files:
 - app/mailers/stellar_base/application_mailer.rb
 - app/models/stellar_base/application_record.rb
 - app/models/stellar_base/bridge_callback.rb
+- app/models/stellar_base/deposit.rb
 - app/models/stellar_base/deposit_request.rb
 - app/models/stellar_base/stellar_toml.rb
 - app/models/stellar_base/withdrawal_request.rb
@@ -329,9 +330,22 @@ files:
 - app/services/stellar_base/bridge_callbacks/process.rb
 - app/services/stellar_base/bridge_callbacks/verify_mac_payload.rb
 - app/services/stellar_base/configured_class_runner.rb
+- app/services/stellar_base/deposit_requests/create_deposit.rb
+- app/services/stellar_base/deposit_requests/find_config.rb
+- app/services/stellar_base/deposit_requests/find_deposit.rb
+- app/services/stellar_base/deposit_requests/find_deposit_request.rb
 - app/services/stellar_base/deposit_requests/find_depositable_asset.rb
+- app/services/stellar_base/deposit_requests/init_stellar_amount.rb
+- app/services/stellar_base/deposit_requests/init_stellar_asset.rb
+- app/services/stellar_base/deposit_requests/init_stellar_distribution_account.rb
+- app/services/stellar_base/deposit_requests/init_stellar_issuer_account.rb
+- app/services/stellar_base/deposit_requests/init_stellar_recipient_account.rb
+- app/services/stellar_base/deposit_requests/send_asset.rb
+- app/services/stellar_base/deposit_requests/trigger.rb
+- app/services/stellar_base/deposit_requests/update_deposit.rb
 - app/services/stellar_base/gen_memo_for.rb
 - app/services/stellar_base/gen_random_string.rb
+- app/services/stellar_base/init_stellar_client.rb
 - app/services/stellar_base/withdrawal_requests/call_on_withdraw.rb
 - app/services/stellar_base/withdrawal_requests/determine_fee.rb
 - app/services/stellar_base/withdrawal_requests/determine_max_amount.rb
@@ -348,12 +362,14 @@ files:
 - db/migrate/20180816110314_create_stellar_base_withdrawal_requests.rb
 - db/migrate/20180816135847_unique_stellar_base_bridge_callbacks_operation_id.rb
 - db/migrate/20180925045927_create_stellar_base_deposit_requests.rb
+- db/migrate/20181001070647_create_stellar_base_deposits.rb
 - lib/stellar_base-rails.rb
 - lib/stellar_base.rb
 - lib/stellar_base/engine.rb
 - lib/stellar_base/factories.rb
 - lib/stellar_base/factories/bridge_callbacks.rb
 - lib/stellar_base/factories/deposit_requests.rb
+- lib/stellar_base/factories/deposits.rb
 - lib/stellar_base/factories/withdrawal_requests.rb
 - lib/stellar_base/horizon_client.rb
 - lib/stellar_base/rails/routes.rb