stellar-base 0.23.1 → 0.24.0.pre.1

data/lib/stellar/compat.rb

@@ -3,17 +3,8 @@ require "active_support/deprecation"
 Stellar::Deprecation ||= ActiveSupport::Deprecation.new("next release", "stellar-base")
 
 class << Stellar::Operation
-  alias manage_offer manage_sell_offer
-  alias create_passive_offer create_passive_sell_offer
-
-  deprecate deprecator: Stellar::Deprecation,
-            manage_offer: :manage_sell_offer,
-            create_passive_offer: :create_passive_sell_offer
-end
-
-class << Stellar::Transaction
-  alias manage_offer manage_sell_offer
-  alias create_passive_offer create_passive_sell_offer
+  alias_method :manage_offer, :manage_sell_offer
+  alias_method :create_passive_offer, :create_passive_sell_offer
 
   deprecate deprecator: Stellar::Deprecation,
             manage_offer: :manage_sell_offer,

data/lib/stellar/dsl.rb

@@ -0,0 +1,85 @@
+module Stellar
+  module DSL
+    # Constructs a new ClaimPredicate using DSL
+    #
+    # @example fulfilled during [T+5min, T+60min] period, where T refers to claimable balance entry creation time
+    #   Stellar::ClaimPredicate { before_relative_time(1.hour) & ~before_relative_time(5.minutes) }
+    #
+    # @example not fulfilled starting from today midnight until tomorrow midnight,
+    #   Stellar::ClaimPredicate { before_absolute_time(Date.today.end_of_day) | ~before_absolute_time(Date.tomorrow.end_of_day) }
+    #
+    # @example always fulfilled
+    #   Stellar::ClaimPredicate { }
+    def ClaimPredicate(&block)
+      return ClaimPredicate.unconditional unless block
+      ClaimPredicate.compose(&block)
+    end
+
+    def Claimant(destination, &block)
+      Claimant.new(
+        ClaimantType.claimant_type_v0,
+        Claimant::V0.new(
+          destination: KeyPair(destination).account_id,
+          predicate: ClaimPredicate(&block)
+        )
+      )
+    end
+
+    def Asset(subject = nil)
+      case subject
+      when Asset
+        subject
+      when nil, /^(XLM[-:])?native$/
+        Asset.native
+      when /^([0-9A-Z]{1,4})[-:](G[A-Z0-9]{55})$/
+        Asset.alphanum4($1, KeyPair($2))
+      when /^([0-9A-Z]{5,12})[-:](G[A-Z0-9]{55})$/
+        Asset.alphanum12($1, KeyPair($2))
+      else
+        raise TypeError, "Cannot convert #{subject.inspect} to Stellar::Asset"
+      end
+    end
+
+    # Generates Stellar::Keypair from subject, use Stellar::Client.to_keypair as shortcut.
+    # @param subject [String|Stellar::Account|Stellar::PublicKey|Stellar::SignerKey|Stellar::Keypair] subject.
+    # @return [Stellar::Keypair] Stellar::Keypair instance.
+    def KeyPair(subject = nil)
+      case subject
+      when ->(subj) { subj.respond_to?(:to_keypair) }
+        subject.to_keypair
+      when /G[A-Z0-9]{55}/
+        KeyPair.from_address(subject)
+      when /S[A-Z0-9]{55}/
+        KeyPair.from_seed(subject)
+      when PublicKey
+        KeyPair.from_public_key(subject.value)
+      when SignerKey
+        KeyPair.from_raw_seed(subject.value)
+      when nil
+        KeyPair.random
+      else
+        raise TypeError, "cannot convert #{subject.inspect} to Stellar::KeyPair"
+      end
+    end
+
+    # Provides conversion from different input types into the SignerKey to use in ManageData operation.
+    # @param input [String|zStellar::Account|Stellar::PublicKey|Stellar::SignerKey|Stellar::Keypair] subject.
+    # @return [Stellar::SignerKey] Stellar::Keypair instance.
+    def SignerKey(input = nil)
+      case input
+      when Transaction
+        SignerKey.pre_auth_tx(input.hash)
+      when /^[0-9A-Za-z+\/=]{44}$/
+        SignerKey.hash_x(Stellar::Convert.from_base64(input))
+      when /^[0-9a-f]{64}$/
+        SignerKey.hash_x(Stellar::Convert.from_hex(input))
+      when /^.{32}$/
+        SignerKey.hash_x(input)
+      else
+        SignerKey.ed25519(KeyPair(input))
+      end
+    end
+  end
+
+  extend DSL
+end

data/lib/stellar/ext/xdr.rb

@@ -0,0 +1,49 @@
+require "active_support/core_ext/string/inflections"
+require "xdr"
+
+# For every member of XDR::Enum define constant on the corresponding enum type class.
+# Constant name is a member name stripped of the common prefix with enum type name.
+XDR::DSL::Enum.redefine_method(:seal) do
+  names = [members.keys.first, name.demodulize.underscore + "_"].join(" ")
+  common_prefix = /\A(.*_).* \1.*\Z/.match(names)&.values_at(1)&.first
+  members.each do |name, value|
+    unless common_prefix.nil?
+      full_name, name = [name, name.delete_prefix(common_prefix)]
+      singleton_class.alias_method(name, full_name)
+    end
+    const_set(name.upcase, value)
+  end
+  self.sealed = true
+end
+
+XDR::DSL::Union.redefine_method(:switch) do |switch, arm = nil|
+  raise ArgumentError, "`switch_on` not defined yet" if switch_type.nil?
+
+  switch = normalize_switch_declaration(switch)
+  self.switches = switches.merge(switch => arm)
+
+  unless arm.nil?
+    define_singleton_method(arm) do |*args, **kwargs|
+      value_type = arms[arm]
+      value = if value_type.valid?(args.first)
+        args.first
+      elsif value_type.ancestors.include?(XDR::Struct)
+        value_type.new(kwargs)
+      elsif value_type.ancestors.include?(XDR::Union)
+        value_type.new(*args[0..1])
+      else
+        args.first
+      end
+      new(switch, value)
+    end
+  end
+end
+
+# XDR::Union generates an attribute method for each `arm`, but lacks the
+# actual `attribute(attr)` method those generated methods delegate to.
+# We follow the semantics of the bang variant `XDR::Union#attribute!` method,
+# except that calls to `raise` are replaced with early returns of nil.
+XDR::Union.define_method(:attribute) do |attr|
+  return unless @arm.to_s == attr
+  get
+end

data/lib/stellar/key_pair.rb

@@ -1,40 +1,44 @@
 module Stellar
   class KeyPair
-    def self.from_seed(seed)
-      seed_bytes = Util::StrKey.check_decode(:seed, seed)
-      from_raw_seed seed_bytes
-    end
-
-    def self.from_raw_seed(seed_bytes)
-      secret_key = RbNaCl::SigningKey.new(seed_bytes)
-      public_key = secret_key.verify_key
-      new(public_key, secret_key)
-    end
-
-    def self.from_public_key(pk_bytes)
-      public_key = RbNaCl::VerifyKey.new(pk_bytes)
-      new(public_key)
-    end
-
-    def self.from_address(address)
-      pk_bytes = Util::StrKey.check_decode(:account_id, address)
-      from_public_key(pk_bytes)
-    end
-
-    def self.random
-      secret_key = RbNaCl::SigningKey.generate
-      public_key = secret_key.verify_key
-      new(public_key, secret_key)
-    end
-
-    def self.from_network_passphrase(passphrase)
-      network_id = Digest::SHA256.digest(passphrase)
-      from_raw_seed network_id
-    end
-
-    def self.master
-      from_raw_seed(Stellar.current_network_id)
-    end
+    module FactoryMethods
+      def from_seed(seed)
+        seed_bytes = Util::StrKey.check_decode(:seed, seed)
+        from_raw_seed seed_bytes
+      end
+
+      def from_raw_seed(seed_bytes)
+        secret_key = RbNaCl::SigningKey.new(seed_bytes)
+        public_key = secret_key.verify_key
+        new(public_key, secret_key)
+      end
+
+      def from_public_key(pk_bytes)
+        public_key = RbNaCl::VerifyKey.new(pk_bytes)
+        new(public_key)
+      end
+
+      def from_address(address)
+        pk_bytes = Util::StrKey.check_decode(:account_id, address)
+        from_public_key(pk_bytes)
+      end
+
+      def random
+        secret_key = RbNaCl::SigningKey.generate
+        public_key = secret_key.verify_key
+        new(public_key, secret_key)
+      end
+
+      def from_network_passphrase(passphrase)
+        network_id = Digest::SHA256.digest(passphrase)
+        from_raw_seed network_id
+      end
+
+      def master
+        from_raw_seed(Stellar.current_network_id)
+      end
+    end
+
+    extend FactoryMethods
 
     def initialize(public_key, secret_key = nil)
       @public_key = public_key
@@ -115,5 +119,9 @@ module Stellar
     rescue RbNaCl::BadSignatureError
       false
     end
+
+    def to_keypair
+      self
+    end
   end
 end

data/lib/stellar/ledger_key.rb

@@ -0,0 +1,30 @@
+require "stellar/convert"
+require "stellar/dsl"
+
+module Stellar
+  class LedgerKey
+    class << self
+      def switch_for_arm(name)
+        (@switch_by_arm ||= switches.invert).fetch(name)
+      end
+
+      def from(account_id:, **options)
+        field, value = options.first
+        case field
+        when nil
+          account(account_id: Stellar.KeyPair(account_id).account_id)
+        when :balance_id
+          claimable_balance(balance_id: ClaimableBalanceID.v0(Stellar::Convert.from_hex(value.to_s)))
+        when :offer_id
+          offer(seller_id: account_id, offer_id: Integer(value))
+        when :data_name
+          data(account_id: account_id, data_name: value.to_s)
+        when :asset
+          trust_line(account_id: account_id, asset: Stellar.Asset(value))
+        else
+          raise ArgumentError, "unknown option #{field} (not in :asset, :offer_id, :data_name, :balance_id)"
+        end
+      end
+    end
+  end
+end

data/lib/stellar/networks.rb

@@ -12,18 +12,18 @@ module Stellar
   #        methods of specifying a network if you need two threads in the same process to communicate with
   #        different networks
   #
-  # @see Stellar.default_network
   # @see Stellar.on_network
-  def self.default_network=(passphrase)
-    @default_network = passphrase
-  end
+  mattr_accessor :default_network, default: Networks::TESTNET
+
+  # Stellar network passphrase selected for current thread
+  #
+  # @see Stellar.current_network
+  # @see Stellar.on_network
+  thread_mattr_accessor :network
 
-  # Returns the passphrase for the currently-configured network, as set by Stellar.default_network
-  # or Stellar.on_network
+  # Returns the passphrase for the network currently active per-thread with a fallback to `Stellar.default_network`
   def self.current_network
-    Thread.current["stellar_network_passphrase"] ||
-      @default_network ||
-      Stellar::Networks::TESTNET
+    network.presence || default_network
   end
 
   # Returns the id for the currently configured network, suitable for use in generating
@@ -34,10 +34,10 @@ module Stellar
 
   # Executes the provided block in the context of the provided network.
   def self.on_network(passphrase, &block)
-    old = Thread.current["stellar_network_passphrase"]
-    Thread.current["stellar_network_passphrase"] = passphrase
+    old = network
+    self.network = passphrase
     block.call
   ensure
-    Thread.current["stellar_network_passphrase"] = old
+    self.network = old
   end
 end

data/lib/stellar/operation.rb

@@ -168,7 +168,6 @@ module Stellar
         }))
       end
 
-      #
       # Helper method to create a valid ChangeTrustOp, wrapped
       # in the necessary XDR structs to be included within a
       # transactions `operations` array.
@@ -200,6 +199,64 @@ module Stellar
         }))
       end
 
+      # Helper method to create a valid CreateClaimableBalanceOp, ready to be used
+      # within a transactions `operations` array.
+      #
+      # @see Stellar::DSL::Claimant
+      # @see https://github.com/astroband/ruby-stellar-sdk/tree/master/base/examples/claimable_balances.rb
+      #
+      # @param asset [Asset] the asset to transfer to a claimable balance
+      # @param amount [Fixnum] the amount of `asset` to put into a claimable balance
+      # @param claimants [Array<Claimant>] accounts authorized to claim the balance in the future
+      #
+      # @return [Operation] the built operation
+      def create_claimable_balance(asset:, amount:, claimants:, **attributes)
+        op = CreateClaimableBalanceOp.new(asset: asset, amount: amount, claimants: claimants)
+
+        make(attributes.merge(body: [:create_claimable_balance, op]))
+      end
+
+      # Helper method to create a valid CreateClaimableBalanceOp, ready to be used
+      # within a transactions `operations` array.
+      #
+      # @see Stellar::DSL::Claimant
+      # @see https://github.com/astroband/ruby-stellar-sdk/tree/master/base/examples/claimable_balances.rb
+      #
+      # @param balance_id [ClaimableBalanceID] unique ID of claimable balance
+      #
+      # @return [Operation] the built operation, containing a Stellar::ChangeTrustOp body
+      def claim_claimable_balance(balance_id:, **attributes)
+        op = ClaimClaimableBalanceOp.new(balance_id: balance_id)
+
+        make(attributes.merge(body: [:claim_claimable_balance, op]))
+      end
+
+      def begin_sponsoring_future_reserves(sponsored:, **attributes)
+        op = BeginSponsoringFutureReservesOp.new(
+          sponsored_id: Stellar.KeyPair(sponsored).account_id
+        )
+
+        make(attributes.merge(body: [:begin_sponsoring_future_reserves, op]))
+      end
+
+      def end_sponsoring_future_reserves(**attributes)
+        make(attributes.merge(body: [:end_sponsoring_future_reserves]))
+      end
+
+      # @param sponsored [#to_keypair] owner of sponsored entry
+      def revoke_sponsorship(sponsored:, **attributes)
+        key_fields = attributes.slice(:offer_id, :data_name, :balance_id, :asset, :signer)
+        raise ArgumentError, "conflicting attributes: #{key_fields.keys.join(", ")}" if key_fields.size > 1
+        account_id = Stellar.KeyPair(sponsored).account_id
+        key, value = key_fields.first
+        op = if key == :signer
+          RevokeSponsorshipOp.signer(account_id: account_id, signer_key: Stellar.SignerKey(value))
+        else
+          RevokeSponsorshipOp.ledger_key(LedgerKey.from(account_id: account_id, **key_fields))
+        end
+        make(attributes.merge(body: [:revoke_sponsorship, op]))
+      end
+
       def manage_sell_offer(attributes = {})
         buying = attributes[:buying]
         if buying.is_a?(Array)

data/lib/stellar/price.rb

@@ -4,7 +4,12 @@ module Stellar
     MAX_PRECISION = (2**31) - 1
 
     def self.from_f(number)
-      best_r = Util::ContinuedFraction.best_r(number, MAX_PRECISION)
+      best_r = number.to_r.rationalize(1.0e-7)
+
+      if best_r.numerator > MAX_PRECISION || best_r.denominator > MAX_PRECISION
+        raise ArgumentError("Couldn't find price approximation")
+      end
+
       new({
         n: best_r.numerator,
         d: best_r.denominator
@@ -15,8 +20,12 @@ module Stellar
       self.class.new(n: d, d: n)
     end
 
+    def to_d
+      n.to_d / d
+    end
+
     def to_f
-      n / d.to_f
+      n.to_f / d
     end
 
     def to_s

data/lib/stellar/transaction.rb

@@ -2,174 +2,6 @@ module Stellar
   class Transaction
     include Stellar::Concerns::Transaction
 
-    class << self
-      #
-      # @see  Stellar::Operation.payment
-      def payment(attributes = {})
-        make :payment, attributes
-      end
-
-      #
-      # @see  Stellar::Operation.path_payment
-      def path_payment(attributes = {})
-        make :path_payment, attributes
-      end
-
-      #
-      # @see  Stellar::Operation.path_payment_strict_receive
-      def path_payment_strict_receive(attributes = {})
-        make :path_payment_strict_receive, attributes
-      end
-
-      #
-      # @see  Stellar::Operation.path_payment_strict_send
-      def path_payment_strict_send(attributes = {})
-        make :path_payment_strict_send, attributes
-      end
-
-      #
-      # @see  Stellar::Operation.create_account
-      def create_account(attributes = {})
-        make :create_account, attributes
-      end
-
-      #
-      # @see  Stellar::Operation.change_trust
-      def change_trust(attributes = {})
-        make :change_trust, attributes
-      end
-
-      #
-      # @see  Stellar::Operation.manage_sell_offer
-      def manage_sell_offer(attributes = {})
-        make :manage_sell_offer, attributes
-      end
-
-      #
-      # @see  Stellar::Operation.manage_buy_offer
-      def manage_buy_offer(attributes = {})
-        make :manage_buy_offer, attributes
-      end
-
-      #
-      # @see  Stellar::Operation.create_passive_sell_offer
-      def create_passive_sell_offer(attributes = {})
-        make :create_passive_sell_offer, attributes
-      end
-
-      #
-      # @see  Stellar::Operation.set_options
-      def set_options(attributes = {})
-        make :set_options, attributes
-      end
-
-      #
-      # @see  Stellar::Operation.allow_trust
-      def allow_trust(attributes = {})
-        make :allow_trust, attributes
-      end
-
-      #
-      # @see  Stellar::Operation.account_merge
-      def account_merge(attributes = {})
-        make :account_merge, attributes
-      end
-
-      #
-      # @see  Stellar::Operation.inflation
-      def inflation(attributes = {})
-        make :inflation, attributes
-      end
-
-      #
-      # @see  Stellar::Operation.manage_data
-      def manage_data(attributes = {})
-        make :manage_data, attributes
-      end
-
-      #
-      # @see  Stellar::Operation.manage_data
-      def bump_sequence(attributes = {})
-        make :bump_sequence, attributes
-      end
-
-      #
-      # DEPRECATED
-      #
-      # All methods calling make() have been deprecated in favor of Stellar::TransactionBuilder.
-      # These functions only create single-operation transactions and essentially duplicate the
-      # methods provided by Stellar::Operation. Stellar::TransactionBuilder enables the construction
-      # of multi-operation transactions and mirrors the functionality provided by the Python and
-      # JavaScript SDKs.
-      #
-      # Helper method to create a transaction with a single
-      # operation of the provided type.  See class methods
-      # on Stellar::Operation for available values for
-      # operation_type.
-      #
-      # @see  Stellar::Operation
-      #
-      # @param operation_type [Symbol] the operation to use
-      # @param attributes={} [Hash] attributes to use for both the transaction and the operation
-      #
-      # @return [Stellar::Transaction] the resulting transaction
-      def make(operation_type, attributes = {})
-        Stellar::Deprecation.warn(
-          "Transaction.#{operation_type} is deprecated. Use Stellar::TransactionBuilder instead."
-        )
-        for_account(attributes).tap do |result|
-          result.operations << Operation.send(operation_type, attributes)
-        end
-      end
-
-      #
-      # Helper method to create the skeleton of a transaction.
-      # The resulting transaction will have its source account,
-      # sequence, fee, min ledger and max ledger set.
-      #
-      #
-      # @param attributes={} [type] [description]
-      #
-      # @return [Stellar::Transaction] the resulting skeleton
-      def for_account(attributes = {})
-        account = attributes[:account]
-        sequence = attributes[:sequence]
-        fee = attributes[:fee]
-
-        raise ArgumentError, "Bad :account" unless account.is_a?(KeyPair)
-        raise ArgumentError, "Bad :sequence #{sequence}" unless sequence.is_a?(Integer)
-        raise ArgumentError, "Bad :fee #{sequence}" if fee.present? && !fee.is_a?(Integer)
-
-        new.tap do |result|
-          result.seq_num = sequence
-          result.fee = fee
-          result.memo = make_memo(attributes[:memo])
-          result.source_account = account.muxed_account
-          result.apply_defaults
-        end
-      end
-
-      private
-
-      def make_memo(memo)
-        case memo
-        when Stellar::Memo
-          memo
-        when nil
-          nil
-        when Integer
-          Memo.new(:memo_id, memo)
-        when String
-          Memo.new(:memo_text, memo)
-        when Array
-          t, val = *memo
-          Memo.new(:"memo_#{t}", val)
-        else
-          raise ArgumentError, "Bad :memo"
-        end
-      end
-    end
-
     def to_v0
       ed25519 = if source_account.switch == Stellar::CryptoKeyType.key_type_ed25519
         source_account.ed25519!