stellar-base 0.26.0 → 0.27.0

data/generated/stellar/set_trust_line_flags_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 SetTrustLineFlagsResultCode
+#   {
+#       // codes considered as "success" for the operation
+#       SET_TRUST_LINE_FLAGS_SUCCESS = 0,
+#   
+#       // codes considered as "failure" for the operation
+#       SET_TRUST_LINE_FLAGS_MALFORMED = -1,
+#       SET_TRUST_LINE_FLAGS_NO_TRUST_LINE = -2,
+#       SET_TRUST_LINE_FLAGS_CANT_REVOKE = -3,
+#       SET_TRUST_LINE_FLAGS_INVALID_STATE = -4
+#   };
+#
+# ===========================================================================
+module Stellar
+  class SetTrustLineFlagsResultCode < XDR::Enum
+    member :set_trust_line_flags_success,       0
+    member :set_trust_line_flags_malformed,     -1
+    member :set_trust_line_flags_no_trust_line, -2
+    member :set_trust_line_flags_cant_revoke,   -3
+    member :set_trust_line_flags_invalid_state, -4
+
+    seal
+  end
+end

data/generated/stellar/transaction_result_code.rb

@@ -22,7 +22,7 @@ require 'xdr'
 #       txNO_ACCOUNT = -8,           // source account not found
 #       txINSUFFICIENT_FEE = -9,     // fee is too small
 #       txBAD_AUTH_EXTRA = -10,      // unused signatures attached to transaction
-#       txINTERNAL_ERROR = -11,      // an unknown error occured
+#       txINTERNAL_ERROR = -11,      // an unknown error occurred
 #   
 #       txNOT_SUPPORTED = -12,         // transaction type not supported
 #       txFEE_BUMP_INNER_FAILED = -13, // fee bump inner transaction failed

data/generated/stellar/trust_line_flags.rb

@@ -11,7 +11,10 @@ require 'xdr'
 #       AUTHORIZED_FLAG = 1,
 #       // issuer has authorized account to maintain and reduce liabilities for its
 #       // credit
-#       AUTHORIZED_TO_MAINTAIN_LIABILITIES_FLAG = 2
+#       AUTHORIZED_TO_MAINTAIN_LIABILITIES_FLAG = 2,
+#       // issuer has specified that it may clawback its credit, and that claimable
+#       // balances created with its credit may also be clawed back
+#       TRUSTLINE_CLAWBACK_ENABLED_FLAG = 4
 #   };
 #
 # ===========================================================================
@@ -19,6 +22,7 @@ module Stellar
   class TrustLineFlags < XDR::Enum
     member :authorized_flag,                         1
     member :authorized_to_maintain_liabilities_flag, 2
+    member :trustline_clawback_enabled_flag,         4
 
     seal
   end

data/lib/stellar-base.rb

@@ -16,8 +16,7 @@ silence_warnings do
 end
 Stellar.load_all!
 
-require_relative "stellar/base/version"
-Stellar::VERSION = Stellar::Base::VERSION
+require_relative "stellar/version"
 
 Stellar::ONE = 1_0000000
 Stellar::Deprecation = ActiveSupport::Deprecation.new("next release", "stellar-base")
@@ -35,6 +34,7 @@ require_relative "./stellar/path_payment_strict_receive_result"
 require_relative "./stellar/price"
 require_relative "./stellar/signer_key"
 require_relative "./stellar/thresholds"
+require_relative "./stellar/trust_line_flags"
 
 require_relative "./stellar/concerns/transaction"
 require_relative "./stellar/fee_bump_transaction"

data/lib/stellar/compat.rb

@@ -4,5 +4,6 @@ class << Stellar::Operation
 
   deprecate deprecator: Stellar::Deprecation,
             manage_offer: :manage_sell_offer,
-            create_passive_offer: :create_passive_sell_offer
+            create_passive_offer: :create_passive_sell_offer,
+            allow_trust: :set_trust_line_flags
 end

data/lib/stellar/concerns/transaction.rb

@@ -19,7 +19,7 @@ module Stellar::Concerns
     end
 
     def merge(other)
-      cloned = Marshal.load Marshal.dump(self)
+      cloned = from_xdr(to_xdr)
       cloned.operations += other.to_operations
       cloned
     end
@@ -32,7 +32,9 @@ module Stellar::Concerns
     #
     # @return [Array<Operation>] the operations
     def to_operations
-      cloned = Marshal.load Marshal.dump(operations)
+      codec = XDR::VarArray[Stellar::Operation]
+      ops = respond_to?(:operations) ? operations : inner_tx.value.tx.operations
+      cloned = codec.from_xdr(codec.to_xdr(ops))
       cloned.each do |op|
         op.source_account ||= source_account
       end

data/lib/stellar/dsl.rb

@@ -27,6 +27,9 @@ module Stellar
       )
     end
 
+    # @param [Asset, String, nil] subject
+    # @return [Stellar::Asset] instance of the Stellar::Asset
+    # @raise [TypeError] if subject cannot be converted to Stellar::Asset
     def Asset(subject = nil)
       case subject
       when Asset
@@ -45,6 +48,7 @@ module Stellar
     # 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.
+    # @raise [TypeError] if subject cannot be converted to Stellar::KeyPair
     def KeyPair(subject = nil)
       case subject
       when ->(subj) { subj.respond_to?(:to_keypair) }

data/lib/stellar/operation.rb

@@ -3,6 +3,11 @@ require "bigdecimal"
 module Stellar
   class Operation
     MAX_INT64 = 2**63 - 1
+    TRUST_LINE_FLAGS_MAPPING = {
+      full: Stellar::TrustLineFlags.authorized_flag,
+      maintain_liabilities: Stellar::TrustLineFlags.authorized_to_maintain_liabilities_flag,
+      clawback_enabled: Stellar::TrustLineFlags.trustline_clawback_enabled_flag
+    }.freeze
 
     class << self
       include Stellar::DSL
@@ -17,16 +22,17 @@ module Stellar
       # @return [Stellar::Operation] the built operation
       def make(attributes = {})
         source_account = attributes[:source_account]
-        body = Stellar::Operation::Body.new(*attributes[:body])
-
-        op = Stellar::Operation.new(body: body)
 
-        if source_account
-          raise ArgumentError, "Bad :source_account" unless source_account.is_a?(Stellar::KeyPair)
-          op.source_account = source_account.muxed_account
+        if source_account && !source_account.is_a?(Stellar::KeyPair)
+          raise ArgumentError, "Bad :source_account"
         end
 
-        op
+        body = Stellar::Operation::Body.new(*attributes[:body])
+
+        Stellar::Operation.new(
+          body: body,
+          source_account: source_account&.muxed_account
+        )
       end
 
       #
@@ -300,7 +306,7 @@ module Stellar
         op = ManageBuyOfferOp.new({
           buying: buying,
           selling: selling,
-          amount: amount,
+          buy_amount: amount,
           price: price,
           offer_id: offer_id
         })
@@ -371,11 +377,31 @@ module Stellar
         }))
       end
 
+      # @param asset [Stellar::Asset]
+      # @param trustor [Stellar::KeyPair]
+      # @param flags [{String, Symbol, Stellar::TrustLineFlags => true, false}] flags to to set or clear
+      # @param source_account [Stellar::KeyPair]  source account (default is `nil`, which will use the source account of transaction)
+      def set_trust_line_flags(asset:, trustor:, flags: {}, source_account: nil)
+        op = Stellar::SetTrustLineFlagsOp.new
+        op.trustor = KeyPair(trustor).account_id
+        op.asset = Asset(asset)
+        op.attributes = Stellar::TrustLineFlags.set_clear_masks(flags)
+
+        make(
+          source_account: source_account,
+          body: [:set_trust_line_flags, op]
+        )
+      end
+
+      # DEPRECATED in favor of `set_trustline_flags`
       #
       # Helper method to create a valid AllowTrustOp, wrapped
       # in the necessary XDR structs to be included within a
       # transactions `operations` array.
       #
+      # @deprecated Use `set_trustline_flags` operation
+      #   See {https://github.com/stellar/stellar-protocol/blob/master/core/cap-0035.md#allow-trust-operation-1 CAP-35 description}
+      #   for more details
       # @param [Hash] attributes the attributes to create the operation with
       # @option attributes [Stellar::KeyPair] :trustor
       # @option attributes [Stellar::Asset] :asset
@@ -387,7 +413,8 @@ module Stellar
         op = AllowTrustOp.new
 
         trustor = attributes[:trustor]
-        authorize = attributes[:authorize]
+        # we handle booleans here for the backward compatibility
+        authorize = attributes[:authorize].yield_self { |value| value == true ? :full : value }
         asset = attributes[:asset]
         if asset.is_a?(Array)
           asset = Asset.send(*asset)
@@ -395,20 +422,21 @@ module Stellar
 
         raise ArgumentError, "Bad :trustor" unless trustor.is_a?(Stellar::KeyPair)
 
-        op.authorize = case authorize
-        when :none, false then 0 # we handle booleans here for the backward compatibility
-        when :full, true then TrustLineFlags.authorized_flag.value
-        when :maintain_liabilities then TrustLineFlags.authorized_to_maintain_liabilities_flag.value
+        allowed_flags = TRUST_LINE_FLAGS_MAPPING.slice(:full, :maintain_liabilities)
+
+        # we handle booleans here for the backward compatibility
+        op.authorize = if allowed_flags.key?(authorize)
+          allowed_flags[authorize].value
+        elsif [:none, false].include?(authorize)
+          0
         else
           raise ArgumentError, "Bad :authorize, supported values: :full, :maintain_liabilities, :none"
         end
 
         raise ArgumentError, "Bad :asset" unless asset.type == Stellar::AssetType.asset_type_credit_alphanum4
 
-        atc = AllowTrustOp::Asset.new(:asset_type_credit_alphanum4, asset.code)
-
         op.trustor = trustor.account_id
-        op.asset = atc
+        op.asset = AssetCode.new(:asset_type_credit_alphanum4, asset.code)
 
         make(attributes.merge({
           body: [:allow_trust, op]
@@ -493,6 +521,47 @@ module Stellar
         }))
       end
 
+      def clawback(source_account:, from:, amount:)
+        asset, amount = get_asset_amount(amount)
+
+        if amount == 0
+          raise ArgumentError, "Amount can not be zero"
+        end
+
+        if amount < 0
+          raise ArgumentError, "Negative amount is not allowed"
+        end
+
+        op = ClawbackOp.new(
+          amount: amount,
+          from: from.muxed_account,
+          asset: asset
+        )
+
+        make({
+          source_account: source_account,
+          body: [:clawback, op]
+        })
+      end
+
+      # Helper method to create clawback claimable balance operation
+      #
+      # @param [Stellar::KeyPair] source_account the attributes to create the operation with
+      # @param [String] balance_id `ClaimableBalanceID`, serialized in hex
+      #
+      # @return [Stellar::Operation] the built operation
+      def clawback_claimable_balance(source_account:, balance_id:)
+        balance_id = Stellar::ClaimableBalanceID.from_xdr(balance_id, :hex)
+        op = ClawbackClaimableBalanceOp.new(balance_id: balance_id)
+
+        make(
+          source_account: source_account,
+          body: [:clawback_claimable_balance, op]
+        )
+      rescue XDR::ReadError
+        raise ArgumentError, "Claimable balance id '#{balance_id}' is invalid"
+      end
+
       private
 
       def get_asset_amount(values)

data/lib/stellar/trust_line_flags.rb

@@ -0,0 +1,53 @@
+module Stellar
+  class TrustLineFlags
+    # Converts an array of Stellar::TrustLineFlags members into
+    # an integers suitable for use in in a SetTrustLineFlagsOp.
+    #
+    # @param flags [Array<Stellar::TrustLineFlags>] the flags to combine
+    #
+    # @return [Fixnum] the combined result
+    def self.make_mask(flags)
+      normalize(flags).map(&:value).inject(&:|) || 0
+    end
+
+    # Converts an integer used in SetTrustLineFlagsOp on the set/clear flag options
+    # into an array of Stellar::TrustLineFlags members
+    #
+    #  @param combined [Fixnum]
+    #  @return [Array<Stellar::AccountFlags>]
+    def self.parse_mask(combined)
+      members.values.select { |m| (m.value & combined) != 0 }
+    end
+
+    # Converts each element of the input array to Stellar::TrustLineFlags instance.
+    #
+    # @param [Array<Stellar::TrustLineFlags,Symbol,#to_s>] input
+    # @return [Array<Stellar::TrustLineFlags>]
+    # @raise [TypeError] if any element of the input cannot be converted
+    def self.normalize(input)
+      input.map do |val|
+        case val
+        when Stellar::TrustLineFlags
+          val
+        when ->(_) { members.key?(val.to_s) }
+          from_name(val.to_s)
+        when ->(_) { members.key?("#{val}_flag") }
+          from_name("#{val}_flag")
+        else
+          raise TypeError, "unknown trustline flag: #{val}"
+        end
+      end
+    end
+
+    def self.set_clear_masks(flags)
+      set_flags = []
+      clear_flags = []
+
+      Hash(flags).each do |flag, value|
+        value.present? ? set_flags.push(flag) : clear_flags.push(flag)
+      end
+
+      {set_flags: make_mask(set_flags), clear_flags: make_mask(clear_flags)}
+    end
+  end
+end

data/lib/stellar/version.rb

@@ -0,0 +1,3 @@
+module Stellar
+  VERSION = "0.27.0"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stellar-base
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.27.0
 platform: ruby
 authors:
 - Scott Fleckenstein
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2021-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -168,9 +168,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-description: "The stellar-base library is the lowest-level stellar helper library.
-  It consists of classes to read, write, \nhash, and sign the xdr structures that
-  are used in stellar-core.\n"
+description: |
+  The stellar-base library is the lowest-level stellar helper library. It consists of classes to read, write,
+  hash, and sign the xdr structures that are used in stellar-core.
 email:
 executables: []
 extensions: []
@@ -193,12 +193,12 @@ files:
 - generated/stellar/account_merge_result.rb
 - generated/stellar/account_merge_result_code.rb
 - generated/stellar/allow_trust_op.rb
-- generated/stellar/allow_trust_op/asset.rb
 - generated/stellar/allow_trust_result.rb
 - generated/stellar/allow_trust_result_code.rb
 - generated/stellar/asset.rb
 - generated/stellar/asset/alpha_num12.rb
 - generated/stellar/asset/alpha_num4.rb
+- generated/stellar/asset_code.rb
 - generated/stellar/asset_type.rb
 - generated/stellar/auth.rb
 - generated/stellar/auth_cert.rb
@@ -225,11 +225,20 @@ files:
 - generated/stellar/claim_predicate_type.rb
 - generated/stellar/claimable_balance_entry.rb
 - generated/stellar/claimable_balance_entry/ext.rb
+- generated/stellar/claimable_balance_entry_extension_v1.rb
+- generated/stellar/claimable_balance_entry_extension_v1/ext.rb
+- generated/stellar/claimable_balance_flags.rb
 - generated/stellar/claimable_balance_id.rb
 - generated/stellar/claimable_balance_id_type.rb
 - generated/stellar/claimant.rb
 - generated/stellar/claimant/v0.rb
 - generated/stellar/claimant_type.rb
+- generated/stellar/clawback_claimable_balance_op.rb
+- generated/stellar/clawback_claimable_balance_result.rb
+- generated/stellar/clawback_claimable_balance_result_code.rb
+- generated/stellar/clawback_op.rb
+- generated/stellar/clawback_result.rb
+- generated/stellar/clawback_result_code.rb
 - generated/stellar/create_account_op.rb
 - generated/stellar/create_account_result.rb
 - generated/stellar/create_account_result_code.rb
@@ -355,6 +364,9 @@ files:
 - generated/stellar/set_options_op.rb
 - generated/stellar/set_options_result.rb
 - generated/stellar/set_options_result_code.rb
+- generated/stellar/set_trust_line_flags_op.rb
+- generated/stellar/set_trust_line_flags_result.rb
+- generated/stellar/set_trust_line_flags_result_code.rb
 - generated/stellar/signed_survey_request_message.rb
 - generated/stellar/signed_survey_response_message.rb
 - generated/stellar/signer.rb
@@ -406,7 +418,6 @@ files:
 - lib/stellar/account_flags.rb
 - lib/stellar/asset.rb
 - lib/stellar/base.rb
-- lib/stellar/base/version.rb
 - lib/stellar/claim_predicate.rb
 - lib/stellar/compat.rb
 - lib/stellar/concerns/transaction.rb
@@ -428,15 +439,19 @@ files:
 - lib/stellar/transaction_builder.rb
 - lib/stellar/transaction_envelope.rb
 - lib/stellar/transaction_v0.rb
+- lib/stellar/trust_line_flags.rb
 - lib/stellar/util/strkey.rb
-homepage: https://github.com/astroband/ruby-stellar-sdk/tree/master/base
+- lib/stellar/version.rb
+homepage: https://github.com/astroband/ruby-stellar-sdk
 licenses:
 - Apache-2.0
 metadata:
+  bug_tracker_uri: https://github.com/astroband/ruby-stellar-sdk/issues
+  changelog_uri: https://github.com/astroband/ruby-stellar-sdk/blob/v0.27.0/base/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/stellar-base/0.27.0/
   github_repo: ssh://github.com/astroband/ruby-stellar-sdk
-  documentation_uri: https://rubydoc.info/gems/stellar-base/0.26.0/
-  changelog_uri: https://github.com/astroband/ruby-stellar-sdk/blob/v0.26.0/base/CHANGELOG.md
-  source_code_uri: https://github.com/astroband/ruby-stellar-sdk/tree/v0.26.0/base
+  homepage_uri: https://github.com/astroband/ruby-stellar-sdk/tree/main/base
+  source_code_uri: https://github.com/astroband/ruby-stellar-sdk/tree/v0.27.0/base
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -453,7 +468,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.rc.2
+rubygems_version: 3.2.16
 signing_key:
 specification_version: 4
 summary: 'Stellar client library: XDR'