stellar-base 0.25.0 → 0.29.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/generated/stellar-base-generated.rb

@@ -38,6 +38,7 @@ module Stellar
   AssetCode4 = XDR::Opaque[4]
   AssetCode12 = XDR::Opaque[12]
   autoload :AssetType
+  autoload :AssetCode
   autoload :Asset
   autoload :Price
   autoload :Liabilities
@@ -46,6 +47,7 @@ module Stellar
   autoload :Signer
   autoload :AccountFlags
   MASK_ACCOUNT_FLAGS = 0x7
+  MASK_ACCOUNT_FLAGS_V17 = 0xF
   MAX_SIGNERS = 20
   SponsorshipDescriptor = XDR::Option[AccountID]
   autoload :AccountEntryExtensionV2
@@ -54,6 +56,7 @@ module Stellar
   autoload :TrustLineFlags
   MASK_TRUSTLINE_FLAGS = 1
   MASK_TRUSTLINE_FLAGS_V13 = 3
+  MASK_TRUSTLINE_FLAGS_V17 = 7
   autoload :TrustLineEntry
   autoload :OfferEntryFlags
   MASK_OFFERENTRY_FLAGS = 1
@@ -65,6 +68,9 @@ module Stellar
   autoload :Claimant
   autoload :ClaimableBalanceIDType
   autoload :ClaimableBalanceID
+  autoload :ClaimableBalanceFlags
+  MASK_CLAIMABLE_BALANCE_FLAGS = 0x1
+  autoload :ClaimableBalanceEntryExtensionV1
   autoload :ClaimableBalanceEntry
   autoload :LedgerEntryExtensionV1
   autoload :LedgerEntry
@@ -94,6 +100,9 @@ module Stellar
   autoload :BeginSponsoringFutureReservesOp
   autoload :RevokeSponsorshipType
   autoload :RevokeSponsorshipOp
+  autoload :ClawbackOp
+  autoload :ClawbackClaimableBalanceOp
+  autoload :SetTrustLineFlagsOp
   autoload :Operation
   autoload :OperationID
   autoload :MemoType
@@ -149,6 +158,12 @@ module Stellar
   autoload :EndSponsoringFutureReservesResult
   autoload :RevokeSponsorshipResultCode
   autoload :RevokeSponsorshipResult
+  autoload :ClawbackResultCode
+  autoload :ClawbackResult
+  autoload :ClawbackClaimableBalanceResultCode
+  autoload :ClawbackClaimableBalanceResult
+  autoload :SetTrustLineFlagsResultCode
+  autoload :SetTrustLineFlagsResult
   autoload :OperationResultCode
   autoload :OperationResult
   autoload :TransactionResultCode

data/lib/stellar/account.rb

@@ -0,0 +1,59 @@
+module Stellar
+  class Account
+    delegate :address, to: :keypair
+
+    def self.random
+      keypair = Stellar::KeyPair.random
+      new(keypair)
+    end
+
+    def self.from_seed(seed)
+      keypair = Stellar::KeyPair.from_seed(seed)
+      new(keypair)
+    end
+
+    def self.from_address(address)
+      muxed_xdr = Util::StrKey.decode_muxed_account(address)
+
+      if muxed_xdr.ed25519
+        new(KeyPair.from_public_key(muxed_xdr.ed25519))
+      else
+        muxed_xdr = muxed_xdr.med25519!
+        new(KeyPair.from_public_key(muxed_xdr.ed25519), muxed_xdr.id)
+      end
+    end
+
+    def self.master
+      keypair = Stellar::KeyPair.from_raw_seed("allmylifemyhearthasbeensearching")
+      new(keypair)
+    end
+
+    attr_reader :keypair, :id
+
+    # @param [Stellar::KeyPair] keypair
+    # @param [Integer] id
+    def initialize(keypair, id = nil)
+      @keypair = keypair
+      @id = id
+    end
+
+    def base_account
+      Stellar::MuxedAccount.ed25519(keypair.raw_public_key)
+    end
+
+    def muxed_account
+      return base_account unless id
+      Stellar::MuxedAccount.med25519(ed25519: keypair.raw_public_key, id: id)
+    end
+
+    def address(force_account_id: true)
+      return keypair.address if force_account_id
+
+      Util::StrKey.check_encode(:muxed, keypair.raw_public_key + [id].pack("Q>"))
+    end
+
+    def to_keypair
+      keypair
+    end
+  end
+end

data/lib/stellar/compat.rb

@@ -2,7 +2,10 @@ class << Stellar::Operation
   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,
-            create_passive_offer: :create_passive_sell_offer
+  deprecate(
+    deprecator: Stellar::Deprecation,
+    manage_offer: :manage_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,28 @@ module Stellar
       )
     end
 
+    def Account(subject = nil)
+      case subject
+      when Account
+        subject
+      when /^M[A-Z0-9]{68}$/
+        Account.from_address(subject.to_str)
+      when nil
+        Account.random
+      else
+        begin
+          keypair = KeyPair(subject)
+
+          Account.new(keypair)
+        rescue TypeError
+          raise TypeError, "Cannot convert #{subject.inspect} to Stellar::Account"
+        end
+      end
+    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 +67,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/transaction_builder.rb

@@ -1,5 +1,7 @@
 module Stellar
   class TransactionBuilder
+    include Stellar::DSL
+
     attr_reader :source_account, :sequence_number, :base_fee, :time_bounds, :memo, :operations
 
     class << self
@@ -29,21 +31,20 @@ module Stellar
       base_fee: 100,
       time_bounds: nil,
       memo: nil,
+      enable_muxed_accounts: false,
       **_ # ignore any additional parameters without errors
     )
-      raise ArgumentError, "Bad :source_account" unless source_account.is_a?(Stellar::KeyPair)
       raise ArgumentError, "Bad :sequence_number" unless sequence_number.is_a?(Integer) && sequence_number >= 0
       raise ArgumentError, "Bad :time_bounds" unless time_bounds.is_a?(Stellar::TimeBounds) || time_bounds.nil?
       raise ArgumentError, "Bad :base_fee" unless base_fee.is_a?(Integer) && base_fee >= 100
 
-      @source_account = source_account
+      @source_account = Account(source_account)
       @sequence_number = sequence_number
       @base_fee = base_fee
       @time_bounds = time_bounds
+      @enable_muxed_accounts = enable_muxed_accounts
 
-      if time_bounds.nil?
-        set_timeout(0)
-      end
+      set_timeout(0) if time_bounds.nil?
 
       @memo = make_memo(memo)
       @operations = []
@@ -59,7 +60,7 @@ module Stellar
       end
 
       attrs = {
-        source_account: @source_account.muxed_account,
+        source_account: source_muxed_account,
         fee: @base_fee * @operations.length,
         seq_num: @sequence_number,
         time_bounds: @time_bounds,
@@ -90,7 +91,7 @@ module Stellar
       end
 
       Stellar::FeeBumpTransaction.new(
-        fee_source: @source_account.muxed_account,
+        fee_source: source_muxed_account,
         fee: @base_fee * (inner_ops.length + 1),
         inner_tx: Stellar::FeeBumpTransaction::InnerTx.new(:envelope_type_tx, inner_txe.v1!),
         ext: Stellar::FeeBumpTransaction::Ext.new(0)
@@ -162,5 +163,17 @@ module Stellar
         raise ArgumentError, "Bad :memo"
       end
     end
+
+    def source_muxed_account
+      if with_muxed_accounts?
+        @source_account.muxed_account
+      else
+        @source_account.base_account
+      end
+    end
+
+    def with_muxed_accounts?
+      @enable_muxed_accounts
+    end
   end
 end