stellar-base 0.20.0 → 0.21.0

data/spec/lib/stellar/{path_payment_result_spec.rb → path_payment_strict_receive_result_spec.rb}

@@ -1,10 +1,10 @@
 require "spec_helper"
 
-describe Stellar::PathPaymentResult, "#send_amount" do
+describe Stellar::PathPaymentStrictReceiveResult, "#send_amount" do
 
 
   context "when the result is not successful" do
-    subject{ Stellar::PathPaymentResult.new(:path_payment_malformed) }
+    subject{ Stellar::PathPaymentStrictReceiveResult.new(:path_payment_strict_receive_malformed) }
 
     it "raises an exception if the result is not successful" do
       expect{ subject.send_amount }.to raise_error(XDR::ArmNotSetError)
@@ -13,9 +13,9 @@ describe Stellar::PathPaymentResult, "#send_amount" do
 
   context "when the result has no claimed offers" do
     let(:simple_success){ Stellar::SimplePaymentResult.new(amount: 100) }
-    let(:path_success){ Stellar::PathPaymentResult::Success.new(last: simple_success) }
+    let(:path_success){ Stellar::PathPaymentStrictReceiveResult::Success.new(last: simple_success) }
 
-    subject{ Stellar::PathPaymentResult.new(:path_payment_success, path_success) }
+    subject{ Stellar::PathPaymentStrictReceiveResult.new(:path_payment_strict_receive_success, path_success) }
 
     it "returns the amount from the 'last' component" do
       expect(subject.send_amount).to eql(100)
@@ -30,13 +30,13 @@ describe Stellar::PathPaymentResult, "#send_amount" do
     end
 
     let(:path_success) do
-      Stellar::PathPaymentResult::Success.new({
+      Stellar::PathPaymentStrictReceiveResult::Success.new({
         offers: offers,
         last:   simple_success,
       })
     end
 
-    subject{ Stellar::PathPaymentResult.new(:path_payment_success, path_success) }
+    subject{ Stellar::PathPaymentStrictReceiveResult.new(:path_payment_strict_receive_success, path_success) }
 
     it "returns the amount from the ClaimOfferAtom" do
       expect(subject.send_amount).to eql(200)
@@ -53,13 +53,13 @@ describe Stellar::PathPaymentResult, "#send_amount" do
     end
 
     let(:path_success) do
-      Stellar::PathPaymentResult::Success.new({
+      Stellar::PathPaymentStrictReceiveResult::Success.new({
         offers: offers,
         last:   simple_success,
       })
     end
 
-    subject{ Stellar::PathPaymentResult.new(:path_payment_success, path_success) }
+    subject{ Stellar::PathPaymentStrictReceiveResult.new(:path_payment_strict_receive_success, path_success) }
 
     it "returns the summed amount from the ClaimOfferAtoms" do
       expect(subject.send_amount).to eql(400)
@@ -79,13 +79,13 @@ describe Stellar::PathPaymentResult, "#send_amount" do
     end
 
     let(:path_success) do
-      Stellar::PathPaymentResult::Success.new({
+      Stellar::PathPaymentStrictReceiveResult::Success.new({
         offers: offers,
         last:   simple_success,
       })
     end
 
-    subject{ Stellar::PathPaymentResult.new(:path_payment_success, path_success) }
+    subject{ Stellar::PathPaymentStrictReceiveResult.new(:path_payment_strict_receive_success, path_success) }
 
     it "returns the summed amount from the ClaimOfferAtoms" do
       expect(subject.send_amount).to eql(400)

data/spec/lib/stellar/transaction_spec.rb

@@ -15,6 +15,38 @@ describe Stellar::Transaction do
   end
   let(:key_pair){ Stellar::KeyPair.random }
 
+  describe ".path_payment_strict_receive" do
+    it 'works' do
+      tx = Stellar::Transaction.path_payment_strict_receive({
+        account: Stellar::KeyPair.random,
+        sequence: 1,
+        fee: 100,
+        destination: Stellar::KeyPair.random,
+        with: [:alphanum4, "USD", Stellar::KeyPair.master, 10],
+        amount: [:alphanum4, "EUR", Stellar::KeyPair.master, 9.2],
+      })
+
+      expect(tx.operations.size).to eq(1)
+      expect(tx.operations.first.body.arm).to eql(:path_payment_strict_receive_op)
+    end
+  end
+
+  describe ".path_payment_strict_send" do
+    it 'works' do
+      tx = Stellar::Transaction.path_payment_strict_send({
+        account: Stellar::KeyPair.random,
+        sequence: 1,
+        fee: 100,
+        destination: Stellar::KeyPair.random,
+        with: [:alphanum4, "USD", Stellar::KeyPair.master, 10],
+        amount: [:alphanum4, "EUR", Stellar::KeyPair.master, 9.2],
+      })
+
+      expect(tx.operations.size).to eq(1)
+      expect(tx.operations.first.body.arm).to eql(:path_payment_strict_send_op)
+    end
+  end
+
   describe "#sign" do
     let(:result){ subject.sign(key_pair) }
 

data/xdr/Stellar-transaction.x

@@ -17,7 +17,7 @@ enum OperationType
 {
     CREATE_ACCOUNT = 0,
     PAYMENT = 1,
-    PATH_PAYMENT = 2,
+    PATH_PAYMENT_STRICT_RECEIVE = 2,
     MANAGE_SELL_OFFER = 3,
     CREATE_PASSIVE_SELL_OFFER = 4,
     SET_OPTIONS = 5,
@@ -27,7 +27,8 @@ enum OperationType
     INFLATION = 9,
     MANAGE_DATA = 10,
     BUMP_SEQUENCE = 11,
-    MANAGE_BUY_OFFER = 12
+    MANAGE_BUY_OFFER = 12,
+    PATH_PAYMENT_STRICT_SEND = 13
 };
 
 /* CreateAccount
@@ -59,7 +60,7 @@ struct PaymentOp
     int64 amount;          // amount they end up with
 };
 
-/* PathPayment
+/* PathPaymentStrictReceive
 
 send an amount to a destination account through a path.
 (up to sendMax, sendAsset)
@@ -68,9 +69,9 @@ send an amount to a destination account through a path.
 
 Threshold: med
 
-Result: PathPaymentResult
+Result: PathPaymentStrictReceiveResult
 */
-struct PathPaymentOp
+struct PathPaymentStrictReceiveOp
 {
     Asset sendAsset; // asset we pay with
     int64 sendMax;   // the maximum amount of sendAsset to
@@ -84,6 +85,32 @@ struct PathPaymentOp
     Asset path<5>; // additional hops it must go through to get there
 };
 
+/* PathPaymentStrictSend
+
+send an amount to a destination account through a path.
+(sendMax, sendAsset)
+(X0, Path[0]) .. (Xn, Path[n])
+(at least destAmount, destAsset)
+
+Threshold: med
+
+Result: PathPaymentStrictSendResult
+*/
+struct PathPaymentStrictSendOp
+{
+    Asset sendAsset;  // asset we pay with
+    int64 sendAmount; // amount of sendAsset to send (excluding fees)
+
+    AccountID destination; // recipient of the payment
+    Asset destAsset;       // what they end up with
+    int64 destMin;         // the minimum amount of dest asset to
+                           // be received
+                           // The operation will fail if it can't be met
+
+    Asset path<5>; // additional hops it must go through to get there
+};
+
+
 /* Creates, updates or deletes an offer
 
 Threshold: med
@@ -266,8 +293,8 @@ struct Operation
         CreateAccountOp createAccountOp;
     case PAYMENT:
         PaymentOp paymentOp;
-    case PATH_PAYMENT:
-        PathPaymentOp pathPaymentOp;
+    case PATH_PAYMENT_STRICT_RECEIVE:
+        PathPaymentStrictReceiveOp pathPaymentStrictReceiveOp;
     case MANAGE_SELL_OFFER:
         ManageSellOfferOp manageSellOfferOp;
     case CREATE_PASSIVE_SELL_OFFER:
@@ -288,6 +315,8 @@ struct Operation
         BumpSequenceOp bumpSequenceOp;
     case MANAGE_BUY_OFFER:
         ManageBuyOfferOp manageBuyOfferOp;
+    case PATH_PAYMENT_STRICT_SEND:
+        PathPaymentStrictSendOp pathPaymentStrictSendOp;
     }
     body;
 };
@@ -447,26 +476,26 @@ default:
     void;
 };
 
-/******* Payment Result ********/
+/******* PathPaymentStrictReceive Result ********/
 
-enum PathPaymentResultCode
+enum PathPaymentStrictReceiveResultCode
 {
     // codes considered as "success" for the operation
-    PATH_PAYMENT_SUCCESS = 0, // success
+    PATH_PAYMENT_STRICT_RECEIVE_SUCCESS = 0, // success
 
     // codes considered as "failure" for the operation
-    PATH_PAYMENT_MALFORMED = -1,          // bad input
-    PATH_PAYMENT_UNDERFUNDED = -2,        // not enough funds in source account
-    PATH_PAYMENT_SRC_NO_TRUST = -3,       // no trust line on source account
-    PATH_PAYMENT_SRC_NOT_AUTHORIZED = -4, // source not authorized to transfer
-    PATH_PAYMENT_NO_DESTINATION = -5,     // destination account does not exist
-    PATH_PAYMENT_NO_TRUST = -6,           // dest missing a trust line for asset
-    PATH_PAYMENT_NOT_AUTHORIZED = -7,     // dest not authorized to hold asset
-    PATH_PAYMENT_LINE_FULL = -8,          // dest would go above their limit
-    PATH_PAYMENT_NO_ISSUER = -9,          // missing issuer on one asset
-    PATH_PAYMENT_TOO_FEW_OFFERS = -10,    // not enough offers to satisfy path
-    PATH_PAYMENT_OFFER_CROSS_SELF = -11,  // would cross one of its own offers
-    PATH_PAYMENT_OVER_SENDMAX = -12       // could not satisfy sendmax
+    PATH_PAYMENT_STRICT_RECEIVE_MALFORMED = -1,          // bad input
+    PATH_PAYMENT_STRICT_RECEIVE_UNDERFUNDED = -2,        // not enough funds in source account
+    PATH_PAYMENT_STRICT_RECEIVE_SRC_NO_TRUST = -3,       // no trust line on source account
+    PATH_PAYMENT_STRICT_RECEIVE_SRC_NOT_AUTHORIZED = -4, // source not authorized to transfer
+    PATH_PAYMENT_STRICT_RECEIVE_NO_DESTINATION = -5,     // destination account does not exist
+    PATH_PAYMENT_STRICT_RECEIVE_NO_TRUST = -6,           // dest missing a trust line for asset
+    PATH_PAYMENT_STRICT_RECEIVE_NOT_AUTHORIZED = -7,     // dest not authorized to hold asset
+    PATH_PAYMENT_STRICT_RECEIVE_LINE_FULL = -8,          // dest would go above their limit
+    PATH_PAYMENT_STRICT_RECEIVE_NO_ISSUER = -9,          // missing issuer on one asset
+    PATH_PAYMENT_STRICT_RECEIVE_TOO_FEW_OFFERS = -10,    // not enough offers to satisfy path
+    PATH_PAYMENT_STRICT_RECEIVE_OFFER_CROSS_SELF = -11,  // would cross one of its own offers
+    PATH_PAYMENT_STRICT_RECEIVE_OVER_SENDMAX = -12       // could not satisfy sendmax
 };
 
 struct SimplePaymentResult
@@ -476,15 +505,51 @@ struct SimplePaymentResult
     int64 amount;
 };
 
-union PathPaymentResult switch (PathPaymentResultCode code)
+union PathPaymentStrictReceiveResult switch (PathPaymentStrictReceiveResultCode code)
+{
+case PATH_PAYMENT_STRICT_RECEIVE_SUCCESS:
+    struct
+    {
+        ClaimOfferAtom offers<>;
+        SimplePaymentResult last;
+    } success;
+case PATH_PAYMENT_STRICT_RECEIVE_NO_ISSUER:
+    Asset noIssuer; // the asset that caused the error
+default:
+    void;
+};
+
+/******* PathPaymentStrictSend Result ********/
+
+enum PathPaymentStrictSendResultCode
 {
-case PATH_PAYMENT_SUCCESS:
+    // codes considered as "success" for the operation
+    PATH_PAYMENT_STRICT_SEND_SUCCESS = 0, // success
+
+    // codes considered as "failure" for the operation
+    PATH_PAYMENT_STRICT_SEND_MALFORMED = -1,          // bad input
+    PATH_PAYMENT_STRICT_SEND_UNDERFUNDED = -2,        // not enough funds in source account
+    PATH_PAYMENT_STRICT_SEND_SRC_NO_TRUST = -3,       // no trust line on source account
+    PATH_PAYMENT_STRICT_SEND_SRC_NOT_AUTHORIZED = -4, // source not authorized to transfer
+    PATH_PAYMENT_STRICT_SEND_NO_DESTINATION = -5,     // destination account does not exist
+    PATH_PAYMENT_STRICT_SEND_NO_TRUST = -6,           // dest missing a trust line for asset
+    PATH_PAYMENT_STRICT_SEND_NOT_AUTHORIZED = -7,     // dest not authorized to hold asset
+    PATH_PAYMENT_STRICT_SEND_LINE_FULL = -8,          // dest would go above their limit
+    PATH_PAYMENT_STRICT_SEND_NO_ISSUER = -9,          // missing issuer on one asset
+    PATH_PAYMENT_STRICT_SEND_TOO_FEW_OFFERS = -10,    // not enough offers to satisfy path
+    PATH_PAYMENT_STRICT_SEND_OFFER_CROSS_SELF = -11,  // would cross one of its own offers
+    PATH_PAYMENT_STRICT_SEND_UNDER_DESTMIN = -12      // could not satisfy destMin
+};
+
+union PathPaymentStrictSendResult switch (PathPaymentStrictSendResultCode code)
+{
+case PATH_PAYMENT_STRICT_SEND_SUCCESS:
     struct
     {
         ClaimOfferAtom offers<>;
         SimplePaymentResult last;
     } success;
-case PATH_PAYMENT_NO_ISSUER:
+case PATH_PAYMENT_STRICT_SEND_NO_ISSUER:
     Asset noIssuer; // the asset that caused the error
 default:
     void;
@@ -762,8 +827,8 @@ case opINNER:
         CreateAccountResult createAccountResult;
     case PAYMENT:
         PaymentResult paymentResult;
-    case PATH_PAYMENT:
-        PathPaymentResult pathPaymentResult;
+    case PATH_PAYMENT_STRICT_RECEIVE:
+        PathPaymentStrictReceiveResult pathPaymentStrictReceiveResult;
     case MANAGE_SELL_OFFER:
         ManageSellOfferResult manageSellOfferResult;
     case CREATE_PASSIVE_SELL_OFFER:
@@ -784,6 +849,8 @@ case opINNER:
         BumpSequenceResult bumpSeqResult;
     case MANAGE_BUY_OFFER:
 	ManageBuyOfferResult manageBuyOfferResult;
+    case PATH_PAYMENT_STRICT_SEND:
+        PathPaymentStrictSendResult pathPaymentStrictSendResult;
     }
     tr;
 default:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stellar-base
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Scott Fleckenstein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-22 00:00:00.000000000 Z
+date: 2019-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xdr
@@ -327,10 +327,14 @@ files:
 - generated/stellar/operation_result/tr.rb
 - generated/stellar/operation_result_code.rb
 - generated/stellar/operation_type.rb
-- generated/stellar/path_payment_op.rb
-- generated/stellar/path_payment_result.rb
-- generated/stellar/path_payment_result/success.rb
-- generated/stellar/path_payment_result_code.rb
+- generated/stellar/path_payment_strict_receive_op.rb
+- generated/stellar/path_payment_strict_receive_result.rb
+- generated/stellar/path_payment_strict_receive_result/success.rb
+- generated/stellar/path_payment_strict_receive_result_code.rb
+- generated/stellar/path_payment_strict_send_op.rb
+- generated/stellar/path_payment_strict_send_result.rb
+- generated/stellar/path_payment_strict_send_result/success.rb
+- generated/stellar/path_payment_strict_send_result_code.rb
 - generated/stellar/payment_op.rb
 - generated/stellar/payment_result.rb
 - generated/stellar/payment_result_code.rb
@@ -398,7 +402,7 @@ files:
 - lib/stellar/key_pair.rb
 - lib/stellar/networks.rb
 - lib/stellar/operation.rb
-- lib/stellar/path_payment_result.rb
+- lib/stellar/path_payment_strict_receive_result.rb
 - lib/stellar/price.rb
 - lib/stellar/signer_key.rb
 - lib/stellar/thresholds.rb
@@ -413,7 +417,7 @@ files:
 - spec/lib/stellar/key_pair_spec.rb
 - spec/lib/stellar/networks_spec.rb
 - spec/lib/stellar/operation_spec.rb
-- spec/lib/stellar/path_payment_result_spec.rb
+- spec/lib/stellar/path_payment_strict_receive_result_spec.rb
 - spec/lib/stellar/price_spec.rb
 - spec/lib/stellar/signer_key_spec.rb
 - spec/lib/stellar/thresholds_spec.rb
@@ -454,7 +458,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.9
 signing_key: 
 specification_version: 4
 summary: 'Stellar client library: XDR'
@@ -465,7 +469,7 @@ test_files:
 - spec/lib/stellar/key_pair_spec.rb
 - spec/lib/stellar/networks_spec.rb
 - spec/lib/stellar/operation_spec.rb
-- spec/lib/stellar/path_payment_result_spec.rb
+- spec/lib/stellar/path_payment_strict_receive_result_spec.rb
 - spec/lib/stellar/price_spec.rb
 - spec/lib/stellar/signer_key_spec.rb
 - spec/lib/stellar/thresholds_spec.rb

data/generated/stellar/path_payment_result_code.rb

@@ -1,47 +0,0 @@
-# This code was automatically generated using xdrgen
-# DO NOT EDIT or your changes may be overwritten
-
-require 'xdr'
-
-# === xdr source ============================================================
-#
-#   enum PathPaymentResultCode
-#   {
-#       // codes considered as "success" for the operation
-#       PATH_PAYMENT_SUCCESS = 0, // success
-#   
-#       // codes considered as "failure" for the operation
-#       PATH_PAYMENT_MALFORMED = -1,          // bad input
-#       PATH_PAYMENT_UNDERFUNDED = -2,        // not enough funds in source account
-#       PATH_PAYMENT_SRC_NO_TRUST = -3,       // no trust line on source account
-#       PATH_PAYMENT_SRC_NOT_AUTHORIZED = -4, // source not authorized to transfer
-#       PATH_PAYMENT_NO_DESTINATION = -5,     // destination account does not exist
-#       PATH_PAYMENT_NO_TRUST = -6,           // dest missing a trust line for asset
-#       PATH_PAYMENT_NOT_AUTHORIZED = -7,     // dest not authorized to hold asset
-#       PATH_PAYMENT_LINE_FULL = -8,          // dest would go above their limit
-#       PATH_PAYMENT_NO_ISSUER = -9,          // missing issuer on one asset
-#       PATH_PAYMENT_TOO_FEW_OFFERS = -10,    // not enough offers to satisfy path
-#       PATH_PAYMENT_OFFER_CROSS_SELF = -11,  // would cross one of its own offers
-#       PATH_PAYMENT_OVER_SENDMAX = -12       // could not satisfy sendmax
-#   };
-#
-# ===========================================================================
-module Stellar
-  class PathPaymentResultCode < XDR::Enum
-    member :path_payment_success,            0
-    member :path_payment_malformed,          -1
-    member :path_payment_underfunded,        -2
-    member :path_payment_src_no_trust,       -3
-    member :path_payment_src_not_authorized, -4
-    member :path_payment_no_destination,     -5
-    member :path_payment_no_trust,           -6
-    member :path_payment_not_authorized,     -7
-    member :path_payment_line_full,          -8
-    member :path_payment_no_issuer,          -9
-    member :path_payment_too_few_offers,     -10
-    member :path_payment_offer_cross_self,   -11
-    member :path_payment_over_sendmax,       -12
-
-    seal
-  end
-end