stellar-base 0.23.0.rc1 → 0.24.0

data/generated/stellar/revoke_sponsorship_result_code.rb

@@ -0,0 +1,31 @@
+# This code was automatically generated using xdrgen
+# DO NOT EDIT or your changes may be overwritten
+
+require 'xdr'
+
+# === xdr source ============================================================
+#
+#   enum RevokeSponsorshipResultCode
+#   {
+#       // codes considered as "success" for the operation
+#       REVOKE_SPONSORSHIP_SUCCESS = 0,
+#   
+#       // codes considered as "failure" for the operation
+#       REVOKE_SPONSORSHIP_DOES_NOT_EXIST = -1,
+#       REVOKE_SPONSORSHIP_NOT_SPONSOR = -2,
+#       REVOKE_SPONSORSHIP_LOW_RESERVE = -3,
+#       REVOKE_SPONSORSHIP_ONLY_TRANSFERABLE = -4
+#   };
+#
+# ===========================================================================
+module Stellar
+  class RevokeSponsorshipResultCode < XDR::Enum
+    member :revoke_sponsorship_success,           0
+    member :revoke_sponsorship_does_not_exist,    -1
+    member :revoke_sponsorship_not_sponsor,       -2
+    member :revoke_sponsorship_low_reserve,       -3
+    member :revoke_sponsorship_only_transferable, -4
+
+    seal
+  end
+end

data/generated/stellar/revoke_sponsorship_type.rb

@@ -0,0 +1,22 @@
+# This code was automatically generated using xdrgen
+# DO NOT EDIT or your changes may be overwritten
+
+require 'xdr'
+
+# === xdr source ============================================================
+#
+#   enum RevokeSponsorshipType
+#   {
+#       REVOKE_SPONSORSHIP_LEDGER_ENTRY = 0,
+#       REVOKE_SPONSORSHIP_SIGNER = 1
+#   };
+#
+# ===========================================================================
+module Stellar
+  class RevokeSponsorshipType < XDR::Enum
+    member :revoke_sponsorship_ledger_entry, 0
+    member :revoke_sponsorship_signer,       1
+
+    seal
+  end
+end

data/generated/stellar/transaction_result_code.rb

@@ -24,8 +24,9 @@ require 'xdr'
 #       txBAD_AUTH_EXTRA = -10,      // unused signatures attached to transaction
 #       txINTERNAL_ERROR = -11,      // an unknown error occured
 #   
-#       txNOT_SUPPORTED = -12,        // transaction type not supported
-#       txFEE_BUMP_INNER_FAILED = -13 // fee bump inner transaction failed
+#       txNOT_SUPPORTED = -12,         // transaction type not supported
+#       txFEE_BUMP_INNER_FAILED = -13, // fee bump inner transaction failed
+#       txBAD_SPONSORSHIP = -14        // sponsorship not confirmed
 #   };
 #
 # ===========================================================================
@@ -46,6 +47,7 @@ module Stellar
     member :tx_internal_error,         -11
     member :tx_not_supported,          -12
     member :tx_fee_bump_inner_failed,  -13
+    member :tx_bad_sponsorship,        -14
 
     seal
   end

data/lib/stellar-base.rb

@@ -4,6 +4,9 @@ require "digest/sha2"
 require "active_support/core_ext/object/blank"
 require "active_support/core_ext/enumerable"
 require "active_support/core_ext/kernel/reporting"
+require "active_support/core_ext/module/attribute_accessors_per_thread"
+
+require_relative "stellar/ext/xdr"
 
 # See ../generated for code-gen'ed files
 silence_warnings do
@@ -11,28 +14,35 @@ silence_warnings do
 end
 Stellar.load_all!
 
+require_relative "stellar/base/version"
+Stellar::VERSION = Stellar::Base::VERSION
+
 Stellar::ONE = 1_0000000
 
 # extensions onto the generated files must be loaded manually, below
 
 require_relative "./stellar/account_flags"
 require_relative "./stellar/asset"
+require_relative "./stellar/claim_predicate"
 require_relative "./stellar/key_pair"
+require_relative "./stellar/ledger_key"
+require_relative "./stellar/networks"
 require_relative "./stellar/operation"
 require_relative "./stellar/path_payment_strict_receive_result"
 require_relative "./stellar/price"
 require_relative "./stellar/signer_key"
 require_relative "./stellar/thresholds"
+
 require_relative "./stellar/concerns/transaction"
-require_relative "./stellar/transaction"
-require_relative "./stellar/transaction_v0"
 require_relative "./stellar/fee_bump_transaction"
+require_relative "./stellar/transaction"
 require_relative "./stellar/transaction_builder"
 require_relative "./stellar/transaction_envelope"
+require_relative "./stellar/transaction_v0"
+
 require_relative "./stellar/util/strkey"
-require_relative "./stellar/util/continued_fraction"
 require_relative "./stellar/convert"
-require_relative "./stellar/networks"
-require_relative "./stellar/version"
+
+require_relative "./stellar/dsl"
 
 require_relative "./stellar/compat"

data/lib/stellar/account_flags.rb

@@ -4,7 +4,7 @@ module Stellar
     # Converts an array of Stellar::AccountFlags members into
     # an Integer suitable for use in a SetOptionsOp.
     #
-    # @param flags=nil [Array<Stellar::AccountFlags>] the flags to combine
+    # @param flags [Array<Stellar::AccountFlags>] the flags to combine
     #
     # @return [Fixnum] the combined result
     def self.make_mask(flags = nil)

data/lib/stellar/{version.rb → base/version.rb}

@@ -1,5 +1,5 @@
 module Stellar
   module Base
-    VERSION = "0.23.0.rc1"
+    VERSION = "0.24.0"
   end
 end

data/lib/stellar/claim_predicate.rb

@@ -0,0 +1,198 @@
+# frozen_string_literals: true
+require "active_support/core_ext/integer/time"
+require "active_support/core_ext/string/conversions"
+
+module Stellar
+  # Represents claim predicate on Stellar network.
+  #
+  # @see https://developers.stellar.org/docs/glossary/claimable-balance/
+  class ClaimPredicate
+    module FactoryMethods
+      # Constructs an `unconditional` claim predicate.
+      #
+      # This predicate will be always fulfilled.
+      #
+      # @return [ClaimPredicate] `unconditional` claim predicate
+      def unconditional
+        ClaimPredicate.new(ClaimPredicateType::UNCONDITIONAL)
+      end
+
+      # Constructs a `before_relative_time` claim predicate.
+      #
+      # This predicate will be fulfilled if the closing time of the ledger that includes
+      # the Stellar::CreateClaimableBalance operation plus this relative time delta (in seconds)
+      # is less than the current time.
+      #
+      # @param seconds [#to_int|#to_i] seconds since `closeTime` of the ledger in which
+      #                                the ClaimableBalanceEntry was created.
+      # @return [ClaimPredicate] `before_relative_time` claim predicate
+      def before_relative_time(seconds)
+        ClaimPredicate.new(ClaimPredicateType::BEFORE_RELATIVE_TIME, Integer(seconds))
+      end
+
+      # Constructs an `before_absolute_time` claim predicate.
+      #
+      # This predicate will be fulfilled if the closing time of the ledger that includes
+      # the Stellar::CreateClaimableBalance operation is less than provided timestamp.
+      #
+      # @param timestamp [#to_time|#to_int|#to_i] time value or timestamp
+      #
+      # @return [ClaimPredicate] `before_absolute_time` claim predicate.
+      def before_absolute_time(timestamp)
+        timestamp = timestamp.to_time if timestamp.respond_to?(:to_time)
+
+        ClaimPredicate.new(ClaimPredicateType::BEFORE_ABSOLUTE_TIME, Integer(timestamp))
+      end
+
+      # Constructs either relative or absolute time predicate based on the type of the input.
+      #
+      # If input is an instance of `ActiveSupport::Duration` class it will be handled as a relative time
+      # (seconds since close time of the ledger), otherwise it will be treated as an absolute time.
+      #
+      # It is intended to work with time helpers provided by ActiveSupport, like `1.day` (relative)
+      # or `2.weeks.from_now` (absolute).
+      #
+      # @example relative time
+      #   ClaimPredicate.before(2.days + 15.seconds)
+      #
+      # @example absolute time
+      #   ClaimPredicate.before(5.hours.from_now)
+      #
+      # @param time [ActiveSupport::Duration|#to_time|#to_i] duration since ledger close time or absolute time value
+      #
+      # @return [ClaimPredicate] `before_relative_time` or `before_absolute_time` claim predicate.
+      def before(time)
+        ActiveSupport::Duration === time ? before_relative_time(time.to_i) : before_absolute_time(time)
+      end
+
+      # Constructs a negated predicate from either relative or absolute time based on the type of the input.
+      #
+      # @see #before
+      # @param (see #before)
+      # @return (see #before)
+      def after(time)
+        ~before(time)
+      end
+
+      # Compose a complex predicate by calling DSL methods from the block.
+      #
+      # @example
+      #   ClaimPredicate.compose {
+      #     after(15.minutes) & before(1.day) | after(1.week.from_now) & before(1.week.from_now + 1.day)
+      #   }
+      #
+      # @yieldreturn [ClaimPredicate|nil]
+      # @return [ClaimPredicate] `not(before_relative_time)` or `not(before_absolute_time)` claim predicate.
+      def compose(&block)
+        result = instance_eval(&block)
+        result.nil? ? unconditional : result
+      end
+    end
+
+    extend FactoryMethods
+
+    # Constructs an `and` claim predicate.
+    #
+    # This predicate will be fulfilled if both `self` and `other` predicates are fulfilled.
+    #
+    # @param other [ClaimPredicate] another predicate
+    #
+    # @return [ClaimPredicate] `and` claim predicate
+    def and(other)
+      raise TypeError, "no conversion from #{other.class.name} to ClaimPredicate" unless ClaimPredicate === other
+      ClaimPredicate.new(ClaimPredicateType::AND, [self, other])
+    end
+    alias_method :&, :and
+
+    # Constructs an `or` claim predicate.
+    #
+    # This predicate will be fulfilled if either of `self` or `other` predicates is fulfilled.
+    #
+    # @param other [ClaimPredicate] another predicate.
+    #
+    # @return [ClaimPredicate] `or` claim predicate
+    def or(other)
+      raise TypeError, "no conversion from #{other.class.name} to ClaimPredicate" unless ClaimPredicate === other
+      ClaimPredicate.new(ClaimPredicateType::OR, [self, other])
+    end
+    alias_method :|, :or
+
+    # Constructs a `not` claim predicate.
+    #
+    # This predicate will be fulfilled if `self` is not fulfilled.
+    #
+    # @return [ClaimPredicate] `not` claim predicate
+    def not
+      ClaimPredicate.new(ClaimPredicateType::NOT, self)
+    end
+    alias_method :~@, :not
+
+    # Evaluates the predicate value for provided inputs.
+    #
+    # @param created_at [#to_time|#to_int] closing time of the ledger containing CreateClaimableBalance operation
+    # @param claiming_at [#to_time|#to_int|ActiveSupport::Duration] time point to evaluate predicate at, either
+    #   absolute time or duration relative to `created_at`. In reality predicate will be evaluated by stellar-core
+    #   using the closing time of a ledger containing ClaimClaimableBalance operation, in either successful
+    #   or failed state.
+    #
+    # @return [Boolean] `true` if this predicate would allow claiming the balance, `false` otherwise
+    def evaluate(created_at, claiming_at)
+      created_at = created_at.to_time if created_at.respond_to?(:to_time)
+      claiming_at = created_at + claiming_at if claiming_at.is_a?(ActiveSupport::Duration)
+      claiming_at = claiming_at.to_time if claiming_at.respond_to?(:to_time)
+
+      return false if claiming_at < created_at
+
+      case switch
+      when ClaimPredicateType::UNCONDITIONAL
+        true
+      when ClaimPredicateType::BEFORE_RELATIVE_TIME
+        Integer(claiming_at) < Integer(created_at) + value
+      when ClaimPredicateType::BEFORE_ABSOLUTE_TIME
+        Integer(claiming_at).to_i < value
+      when ClaimPredicateType::AND
+        value[0].evaluate(created_at, claiming_at) && value[1].evaluate(created_at, claiming_at)
+      when ClaimPredicateType::OR
+        value[0].evaluate(created_at, claiming_at) || value[1].evaluate(created_at, claiming_at)
+      when ClaimPredicateType::NOT
+        !value.evaluate(created_at, claiming_at)
+      else
+        raise ArgumentError, "evaluation is not implemented for #{switch.name} predicate"
+      end
+    end
+
+    def describe
+      case switch
+      when ClaimPredicateType::UNCONDITIONAL
+        "always"
+      when ClaimPredicateType::BEFORE_RELATIVE_TIME
+        dur = ActiveSupport::Duration.build(value)
+        "less than #{dur.inspect} since creation"
+      when ClaimPredicateType::BEFORE_ABSOLUTE_TIME
+        "before #{Time.at(value).to_formatted_s(:db)}"
+      when ClaimPredicateType::AND
+        value.map(&:describe).join(" and ")
+      when ClaimPredicateType::OR
+        "(" << value.map(&:describe).join(" or ") << ")"
+      when ClaimPredicateType::NOT
+        case value.switch
+        when ClaimPredicateType::UNCONDITIONAL
+          "never"
+        when ClaimPredicateType::BEFORE_RELATIVE_TIME
+          dur = ActiveSupport::Duration.build(value.value)
+          "#{dur.inspect} or more since creation"
+        when ClaimPredicateType::BEFORE_ABSOLUTE_TIME
+          "after #{Time.at(value.value).to_formatted_s(:db)}"
+        else
+          "not (#{value.describe})"
+        end
+      else
+        raise ArgumentError, "evaluation is not implemented for #{switch.name} predicate"
+      end
+    end
+
+    def inspect
+      "#<ClaimPredicate: #{describe}>"
+    end
+  end
+end

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