stellar-base 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a47723e2d9150d6aea05202da7fb79397f38b41
-  data.tar.gz: 6fe5b0dda6af9aac8f9932115f6a955cfa4cef9e
+  metadata.gz: bf4158b0f95f7338c96416a0398e13dbf91ae047
+  data.tar.gz: 6df5ab1153e3b0ed2f23d30c061d5065bccc2663
 SHA512:
-  metadata.gz: fac3fc2d37981496c6988302c736ae5c2860b47bbed7dac258a3bdeef3f8d9d2bd4dedc6ba5d41db0526cb12cd98fc6429b55cbc1aac5a74df633459d4820a42
-  data.tar.gz: 49dcadf00e391dc2ed30182a17f7c53fb619710debef5631d3e11876e6c291aba0b820b95db26037168d7661f2dc75f2608471a6a266b911acf0ece590bda8e5
+  metadata.gz: be53f549d08cba214888be4658913ec604881a3bc7ebe5afbe154ef060797389b31385f5ad37c796e2ee92c9e6215ee9aa7d14878f35af7e51cc443ec6cc681e
+  data.tar.gz: dd3d97061fc6ade77de67c6a47af1c9d7f23e81b45575fc3dafa473f6aab05bba0a326969488219aabeada7f5e326f927889c7c78afbd69ca06c7de4e770fba2

data/examples/create_account.rb

@@ -16,13 +16,11 @@ destination = Stellar::KeyPair.random
 tx = Stellar::Transaction.create_account({
   account:     master,
   destination: destination,
-  sequence:    1,
-  starting_balance:  50_0000000
+  sequence:    2,
+  starting_balance:  50 * Stellar::ONE
 })
 
 hex    = tx.to_envelope(master).to_xdr(:hex)
 
 result = $server.get('tx', blob: hex)
 p result.body
-raw    = [result.body["result"]].pack("H*")
-p Stellar::TransactionResult.from_xdr(raw)

data/examples/low_level_transaction_post.rb

@@ -2,7 +2,7 @@
 
 # This is an example of using the raw xdr objects to post a transaction
 # notice that we must manually hash/sign the structures and we must manually
-# fill out all the fields. 
+# fill out all the fields.
 #
 # Look at mid_level_transaction_post.rb to see a friendlier form
 
@@ -22,7 +22,7 @@ tx.seq_num    = 1
 payment = Stellar::PaymentOp.new
 payment.destination = destination.verify_key.to_bytes
 payment.currency = Stellar::Currency.new(:native)
-payment.amount = 200_000000
+payment.amount = 200 * Stellar::ONE
 
 op = Stellar::Operation.new
 op.body = Stellar::Operation::Body.new(:payment, payment)
@@ -36,7 +36,7 @@ signature = master.sign(tx_hash)
 env = Stellar::TransactionEnvelope.new
 env.tx = tx
 env.signatures = [Stellar::DecoratedSignature.new({
-  hint:master.verify_key.to_bytes[0...4], 
+  hint:master.verify_key.to_bytes[0...4],
   signature:signature
 })]
 
@@ -44,4 +44,3 @@ env_hex = env.to_xdr.unpack("H*").first
 
 result = Faraday.get('http://localhost:39132/tx', blob: env_hex)
 puts result.body
-

data/examples/mid_level_transaction_post.rb

@@ -24,11 +24,10 @@ tx = Stellar::Transaction.payment({
   account:     master,
   destination: destination,
   sequence:    1,
-  amount:      [:native, 20_000000]
+  amount:      [:native, 20 * Stellar::ONE]
 })
 
 hex    = tx.to_envelope(master).to_xdr(:hex)
 
 result = $server.get('tx', blob: hex)
-raw    = [result.body["result"]].pack("H*")
-p Stellar::TransactionResult.from_xdr(raw)
+p result.body

data/examples/non_native_payment.rb

@@ -7,7 +7,7 @@
 # You can see where these helpers are defined in the files underneath /lib,
 # which is where we extend the xdrgen generated source files with our higher
 # level api.
-# 
+#
 # NOTE: due to the way that sequence number for a new account are set, this
 # example is pretty cumbersome to run.  It is only used for illustrative purposes
 # of the flow
@@ -25,7 +25,7 @@ def submit(key, tx)
   hex      = tx.to_envelope(key).to_xdr(:hex)
   response = $server.get('tx', blob: hex)
   raw = [response.body["result"]].pack("H*")
-  p Stellar::TransactionResult.from_xdr(raw)
+  p response.body
 end
 
 master      = Stellar::KeyPair.from_raw_seed("allmylifemyhearthasbeensearching")
@@ -35,20 +35,20 @@ submit master, Stellar::Transaction.payment({
   account:     master,
   destination: destination,
   sequence:    1,
-  amount:      [:native, 2000_000000]
+  amount:      [:native, 2000 * Stellar::ONE]
 })
 
 # NOTE: after this step, you need to get the sequence number for destination
 # Which is based off of the ledger sequence number it was funded in.
 gets # pause to get the account's sequence from the hayashi db
 
-destination_sequence = FILL_ME_IN 
+destination_sequence = FILL_ME_IN
 # destination_sequence = 17179869185
 
 submit destination, Stellar::Transaction.change_trust({
   account:    destination,
   sequence:   destination_sequence,
-  line:       [:iso4217, "USD\x00", master],
+  line:       [:alphanum, "USD\x00", master],
   limit:      1000
 })
 
@@ -56,5 +56,5 @@ submit master, Stellar::Transaction.payment({
   account:     master,
   destination: destination,
   sequence:    3,
-  amount:      [:iso4217, "USD\x00", master, 100]
+  amount:      [:alphanum, "USD\x00", master, 100]
 })

data/examples/offer.rb

@@ -7,7 +7,7 @@
 # You can see where these helpers are defined in the files underneath /lib,
 # which is where we extend the xdrgen generated source files with our higher
 # level api.
-# 
+#
 # NOTE: due to the way that sequence number for a new account are set, this
 # example is pretty cumbersome to run.  It is only used for illustrative purposes
 # of the flow
@@ -24,8 +24,7 @@ end
 def submit(key, tx)
   hex      = tx.to_envelope(key).to_xdr(:hex)
   response = $server.get('tx', blob: hex)
-  raw = [response.body["result"]].pack("H*")
-  p Stellar::TransactionResult.from_xdr(raw)
+  p response.body
 end
 
 master      = Stellar::KeyPair.from_raw_seed("allmylifemyhearthasbeensearching")
@@ -35,27 +34,27 @@ submit master, Stellar::Transaction.payment({
   account:     master,
   destination: destination,
   sequence:    1,
-  amount:      [:native, 2000_000000]
+  amount:      [:native, 2000 * Stellar::ONE]
 })
 
 # NOTE: after this step, you need to get the sequence number for destination
 # Which is based off of the ledger sequence number it was funded in.
 gets # pause to get the account's sequence from the hayashi db
 
-destination_sequence = FILL_ME_IN 
+destination_sequence = FILL_ME_IN
 # destination_sequence = 17179869185
 
 submit destination, Stellar::Transaction.change_trust({
   account:    destination,
   sequence:   destination_sequence,
-  line:       [:iso4217, "USD\x00", master],
+  line:       [:alphanum, "USD\x00", master],
   limit:      1000
 })
 
 submit destination, Stellar::Transaction.change_trust({
   account:    destination,
   sequence:   destination_sequence + 1,
-  line:       [:iso4217, "EUR\x00", master],
+  line:       [:alphanum, "EUR\x00", master],
   limit:      1000
 })
 
@@ -63,14 +62,14 @@ submit master, Stellar::Transaction.payment({
   account:     master,
   destination: destination,
   sequence:    destination_sequence + 2,
-  amount:      [:iso4217, "USD\x00", master, 1000]
+  amount:      [:alphanum, "USD\x00", master, 1000]
 })
 
 submit master, Stellar::Transaction.create_offer({
   account:    destination,
   sequence:   destination_sequence + 3
-  taker_gets: [:iso4217, "USD\x00", usd_gateway],
-  taker_pays: [:iso4217, "EUR\x00", eur_gateway],
+  taker_gets: [:alphanum, "USD\x00", usd_gateway],
+  taker_pays: [:alphanum, "EUR\x00", eur_gateway],
   amount:     100,
   price:      2.0,
 })

data/examples/transaction_merge.rb

@@ -9,14 +9,14 @@ tx1 = Stellar::Transaction.payment({
   account:     master,
   destination: destination,
   sequence:    1,
-  amount:      [:native, 20_000000]
+  amount:      [:native, 20 * Stellar::ONE]
 })
 
 tx2 = Stellar::Transaction.payment({
   account:     master,
   destination: destination,
   sequence:    2,
-  amount:      [:native, 20_000000]
+  amount:      [:native, 20 * Stellar::ONE]
 })
 
 hex = tx1.merge(tx2).to_envelope(master).to_xdr(:hex)

data/lib/stellar-base.rb

@@ -12,15 +12,17 @@ silence_warnings do
 end
 Stellar.load_all!
 
+Stellar::ONE = 1_0000000
+
+
 # extensions onto the generated files must be loaded manually, below
 
 require_relative './stellar/account_flags'
 require_relative './stellar/currency'
 require_relative './stellar/key_pair'
 require_relative './stellar/operation'
-require_relative './stellar/payment_op'
 require_relative './stellar/price'
 require_relative './stellar/transaction'
 require_relative './stellar/transaction_envelope'
 require_relative './stellar/util/base58'
-require_relative './stellar/util/continued_fraction'
+require_relative './stellar/util/continued_fraction'

data/lib/stellar/base/version.rb

@@ -1,5 +1,5 @@
 module Stellar
   module Base
-    VERSION = "0.0.9"
+    VERSION = "0.0.10"
   end
 end

data/lib/stellar/currency.rb

@@ -4,8 +4,9 @@ module Stellar
       new(:currency_type_native)
     end
 
-    def self.iso4217(code, issuer)
+    def self.alphanum(code, issuer)
       raise ArgumentError, "Bad :issuer" unless issuer.is_a?(KeyPair)
+      code = normalize_code(code)
       an = AlphaNum.new({currency_code:code, issuer:issuer.public_key})
       new(:currency_type_alphanum, an)
     end
@@ -28,5 +29,11 @@ module Stellar
     def code
       self.alpha_num!.currency_code
     end
+
+    def self.normalize_code(code)
+      raise ArgumentError, "Invalid currency code: #{code}, must be <= 4 bytes" if code.length > 4
+
+      code.ljust(4, "\x00")
+    end
   end
-end
+end

data/lib/stellar/operation.rb

@@ -2,14 +2,14 @@ module Stellar
   class Operation
 
 
-    # 
+    #
     # Construct a new Stellar::Operation from the provided
     # source account and body
-    # 
+    #
     # @param [Hash] attributes the attributes to create the operation with
     # @option attributes [Stellar::KeyPair] :source_account
     # @option attributes [Stellar::Operation::Body] :body
-    # 
+    #
     # @return [Stellar::Operation] the built operation
     def self.make(attributes={})
       source_account = attributes[:source_account]
@@ -26,37 +26,70 @@ module Stellar
     end
 
 
-    # 
+    #
     # Helper method to create a valid PaymentOp, wrapped
-    # in the necessary XDR structs to be included within a 
+    # in the necessary XDR structs to be included within a
     # transactions `operations` array.
-    # 
+    #
     # @see Stellar::Currency
-    # 
+    #
     # @param [Hash] attributes the attributes to create the operation with
     # @option attributes [Stellar::KeyPair] :destination the receiver of the payment
     # @option attributes [Array] :amount the amount to pay
-    # @option attributes [Array<Stellar::Currency>] :path the payment path to use
-    # 
-    # @return [Stellar::Operation] the built operation, containing a 
+    # @return [Stellar::Operation] the built operation, containing a
     #                              Stellar::PaymentOp body
     def self.payment(attributes={})
       destination = attributes[:destination]
-      amount      = attributes[:amount]
-      # path        = attributes[:path] || []
-      # path        = path.map{|p| Stellar::Currency.send(*p)}
+      currency, amount = extract_amount(attributes[:amount])
 
       raise ArgumentError unless destination.is_a?(KeyPair)
 
-      op = PaymentOp.send(*amount)
+
+      op             = PaymentOp.new
+      op.currency    = currency
+      op.amount      = amount
       op.destination = destination.public_key
-      op.apply_defaults
 
       return make(attributes.merge({
         body:[:payment, op]
       }))
     end
 
+    #
+    # Helper method to create a valid PathPaymentOp, wrapped
+    # in the necessary XDR structs to be included within a
+    # transactions `operations` array.
+    #
+    # @see Stellar::Currency
+    #
+    # @param [Hash] attributes the attributes to create the operation with
+    # @option attributes [Stellar::KeyPair] :destination the receiver of the payment
+    # @option attributes [Array] :amount the amount to pay
+    # @option attributes [Array] :with the source currency and maximum allowed source amount to pay with
+    # @option attributes [Array<Stellar::Currency>] :path the payment path to use
+    #
+    # @return [Stellar::Operation] the built operation, containing a
+    #                              Stellar::PaymentOp body
+    def self.path_payment(attributes={})
+      destination             = attributes[:destination]
+      currency, amount        = extract_amount(attributes[:amount])
+      send_currency, send_max = extract_amount(attributes[:with])
+      path                    = (attributes[:path] || []).map{|p| Stellar::Currency.send(*p)}
+
+      raise ArgumentError unless destination.is_a?(KeyPair)
+
+      op               = PathPaymentOp.new
+      op.send_currency = send_currency
+      op.send_max      = send_max
+      op.destination   = destination.public_key
+      op.dest_currency = currency
+      op.dest_amount   = amount
+      op.path          = path
+
+      return make(attributes.merge({
+        body:[:path_payment, op]
+      }))
+    end
 
     def self.create_account(attributes={})
       destination      = attributes[:destination]
@@ -73,16 +106,16 @@ module Stellar
       }))
     end
 
-    # 
+    #
     # Helper method to create a valid ChangeTrustOp, wrapped
-    # in the necessary XDR structs to be included within a 
+    # in the necessary XDR structs to be included within a
     # transactions `operations` array.
-    # 
+    #
     # @param [Hash] attributes the attributes to create the operation with
     # @option attributes [Stellar::Currrency] :line the currency to trust
     # @option attributes [Fixnum] :limit the maximum amount to trust
-    # 
-    # @return [Stellar::Operation] the built operation, containing a 
+    #
+    # @return [Stellar::Operation] the built operation, containing a
     #                              Stellar::ChangeTrustOp body
     def self.change_trust(attributes={})
       line  = Currency.send(*attributes[:line])
@@ -105,31 +138,31 @@ module Stellar
       price      = Price.from_f(attributes[:price])
 
       op = CreateOfferOp.new({
-        taker_pays: taker_pays, 
+        taker_pays: taker_pays,
         taker_gets: taker_gets,
         amount:     amount,
         price:      price,
         offer_id:   offer_id
       })
-      
+
       return make(attributes.merge({
         body:[:create_offer, op]
       }))
     end
 
-    # 
+    #
     # Helper method to create a valid SetOptionsOp, wrapped
-    # in the necessary XDR structs to be included within a 
+    # in the necessary XDR structs to be included within a
     # transactions `operations` array.
-    # 
+    #
     # @param [Hash] attributes the attributes to create the operation with
     # @option attributes [Stellar::KeyPair] :inflation_dest
     # @option attributes [Array<Stellar::AccountFlags>] :set flags to set
     # @option attributes [Array<Stellar::AccountFlags>] :clear flags to clear
     # @option attributes [String] :thresholds
     # @option attributes [Stellar::Signer] :signer
-    # 
-    # @return [Stellar::Operation] the built operation, containing a 
+    #
+    # @return [Stellar::Operation] the built operation, containing a
     #                              Stellar::SetOptionsOp body
     def self.set_options(attributes={})
       op             = SetOptionsOp.new()
@@ -145,35 +178,35 @@ module Stellar
         op.inflation_dest = inflation_dest.public_key
       end
 
-            
+
       return make(attributes.merge({
         body:[:set_options, op]
       }))
     end
 
-    # 
+    #
     # Helper method to create a valid AllowTrustOp, wrapped
-    # in the necessary XDR structs to be included within a 
+    # in the necessary XDR structs to be included within a
     # transactions `operations` array.
-    # 
+    #
     # @param [Hash] attributes the attributes to create the operation with
     # @option attributes [Stellar::KeyPair]  :trustor
     # @option attributes [Stellar::Currency] :currency
-    # 
-    # @return [Stellar::Operation] the built operation, containing a 
+    #
+    # @return [Stellar::Operation] the built operation, containing a
     #                              Stellar::AllowTrustOp body
     def self.allow_trust(attributes={})
       op = AllowTrustOp.new()
-      
+
       trustor   = attributes[:trustor]
       authorize = attributes[:authorize]
       currency  = Currency.send(*attributes[:currency])
 
       raise ArgumentError, "Bad :trustor" unless trustor.is_a?(Stellar::KeyPair)
       raise ArgumentError, "Bad :authorize" unless authorize == !!authorize # check boolean
-      raise ArgumentError, "Bad :currency" unless currency.type == Stellar::CurrencyType.iso4217
+      raise ArgumentError, "Bad :currency" unless currency.type == Stellar::CurrencyType.alphanum
 
-      atc = AllowTrustOp::Currency.new(:iso4217, currency.code)
+      atc = AllowTrustOp::Currency.new(:alphanum, currency.code)
 
       op.trustor   = trustor.public_key
       op.authorize = authorize
@@ -184,12 +217,12 @@ module Stellar
       }))
     end
 
-    # 
+    #
     # Helper method to create an account merge operation
-    # 
+    #
     # @param [Hash] attributes the attributes to create the operation with
     # @option attributes [Stellar::KeyPair]  :destination
-    # 
+    #
     # @return [Stellar::Operation] the built operation
     def self.account_merge(attributes={})
       destination = attributes[:destination]
@@ -202,12 +235,12 @@ module Stellar
       }))
     end
 
-    # 
+    #
     # Helper method to create an inflation operation
-    # 
+    #
     # @param [Hash] attributes the attributes to create the operation with
     # @option attributes [Integer]  :sequence
-    # 
+    #
     # @return [Stellar::Operation] the built operation
     def self.inflation(attributes={})
       sequence = attributes[:sequence]
@@ -219,5 +252,13 @@ module Stellar
         body:[:inflation, sequence]
       }))
     end
+
+    private
+    def self.extract_amount(a)
+      amount   = a.last
+      currency = Stellar::Currency.send(*a[0...-1])
+
+      return currency, amount
+    end
   end
-end
+end

data/lib/stellar/transaction.rb

@@ -1,65 +1,71 @@
 module Stellar
   class Transaction
 
-    # 
+    #
     # @see  Stellar::Operation.payment
     def self.payment(attributes={})
       make :payment, attributes
     end
 
-    # 
+    #
+    # @see  Stellar::Operation.path_payment
+    def self.path_payment(attributes={})
+      make :path_payment, attributes
+    end
+
+    #
     # @see  Stellar::Operation.create_account
     def self.create_account(attributes={})
       make :create_account, attributes
     end
 
-    # 
+    #
     # @see  Stellar::Operation.change_trust
     def self.change_trust(attributes={})
       make :change_trust, attributes
     end
 
-    # 
+    #
     # @see  Stellar::Operation.create_offer
     def self.create_offer(attributes={})
       make :create_offer, attributes
     end
 
-    # 
+    #
     # @see  Stellar::Operation.set_options
     def self.set_options(attributes={})
       make :set_options, attributes
     end
 
-    # 
+    #
     # @see  Stellar::Operation.allow_trust
     def self.allow_trust(attributes={})
       make :allow_trust, attributes
     end
-    
-    # 
+
+    #
     # @see  Stellar::Operation.account_merge
     def self.account_merge(attributes={})
       make :account_merge, attributes
     end
-     
-    # 
+
+    #
     # @see  Stellar::Operation.inflation
     def self.inflation(attributes={})
       make :inflation, attributes
     end
 
-    # 
+    #
     # Helper method to create a transaction with a single
     # operation of the provided type.  See class methods
-    # on Stellar::Operation for available values for 
+    # 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 self.make(operation_type, attributes={})
       for_account(attributes).tap do |result|
@@ -68,20 +74,20 @@ module Stellar
     end
 
 
-    # 
-    # Helper method to create the skeleton of a transaction.  
+    #
+    # 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.  
-    # 
-    # 
+    # sequence, fee, min ledger and max ledger set.
+    #
+    #
     # @param attributes={} [type] [description]
-    # 
+    #
     # @return [Stellar::Transaction] the resulting skeleton
     def self.for_account(attributes={})
       account  = attributes[:account]
       sequence = attributes[:sequence]
       fee      = attributes[:fee]
-      
+
       raise ArgumentError, "Bad :account" unless account.is_a?(KeyPair) && account.sign?
       raise ArgumentError, "Bad :sequence #{sequence}" unless sequence.is_a?(Integer)
       raise ArgumentError, "Bad :fee #{sequence}" if fee.present? && !fee.is_a?(Integer)
@@ -108,7 +114,7 @@ module Stellar
 
     def to_envelope(*key_pairs)
       signatures = key_pairs.map(&method(:sign_decorated))
-      
+
       TransactionEnvelope.new({
         :signatures => signatures,
         :tx => self
@@ -122,12 +128,12 @@ module Stellar
     end
 
 
-    # 
+    #
     # Extracts the operations from this single transaction,
     # setting the source account on the extracted operations.
-    # 
+    #
     # Useful for merging transactions.
-    # 
+    #
     # @return [Array<Operation>] the operations
     def to_operations
       cloned = Marshal.load Marshal.dump(operations)
@@ -142,4 +148,4 @@ module Stellar
       self.memo       ||= Memo.new(:memo_none)
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stellar-base
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Scott Fleckenstein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-14 00:00:00.000000000 Z
+date: 2015-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xdr
@@ -299,7 +299,6 @@ files:
 - lib/stellar/currency.rb
 - lib/stellar/key_pair.rb
 - lib/stellar/operation.rb
-- lib/stellar/payment_op.rb
 - lib/stellar/price.rb
 - lib/stellar/transaction.rb
 - lib/stellar/transaction_envelope.rb

data/lib/stellar/payment_op.rb

@@ -1,28 +0,0 @@
-module Stellar
-  class PaymentOp
-
-    def self.native(amount)
-      currency = Stellar::Currency.native
-      with_currency(currency).tap do |result|
-        result.amount   = amount
-      end
-    end
-
-    def self.iso4217(code, issuer, amount)
-      currency = Stellar::Currency.iso4217(code, issuer)
-      with_currency(currency).tap do |result|
-        result.amount   = amount
-      end
-    end
-
-    def self.with_currency(currency)
-      new.tap do |result|
-        result.currency = currency
-      end
-    end
-
-    def apply_defaults
-    end
-
-  end
-end