stellar-base 0.23.1 → 0.24.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee7c9178d44b90ea76adef982ec44927775101498a500fa0a00c7ec628bbffa9
-  data.tar.gz: 8135ebe14a37dcb84ae903bd428b038037f1a9feb35460265fac86f3f6c489a4
+  metadata.gz: d13d4f0b46be5ae03ec00a019abebd5846c312d6074beab1656d097fabda353c
+  data.tar.gz: 179c7b90ffd0823967006bf92593f6b34418cd6bfb2f2b9e71456e96ef4d4360
 SHA512:
-  metadata.gz: 4c4b5b21650d187486994c7e22db39b1a7812897e2872492b7955b77843783087adfc7440b18cbc58f00e1c569075a05f6fa8c2a1801789a240b6ef71f011819
-  data.tar.gz: 69a634ed5af1faaa4b81ed9bc07da4977618435f8f1ec4c42e39d039ab12362dd76f27bd00eaf1cdf5bda66d2fdabf172b81cba423e554bddea94d8eeb1bc2a7
+  metadata.gz: 63a0222c5014c166c3f7b0ce1054783a7cd5132dccbed308763a76c6eadb1165c96dbbb4be2d33d0b75a4edf8f5bda42d73cdee642901bcb1604d2a8cb5a45f1
+  data.tar.gz: ad4c8661b62f3f43efcb51d554876f6a6e2b28429b5d1845d8603dbdd3e5ff56f27ee488cc28d59f5482028d70dbfbc15c9f2211875f763718c9c848777eb7b6

data/CHANGELOG.md

@@ -6,6 +6,94 @@ file.  This project adheres to [Semantic Versioning](http://semver.org/).
 As this project is pre 1.0, breaking changes may happen for minor version
 bumps.  A breaking change will get clearly notified in this log.
 
+## [Unreleased]
+### Added
+- Add conversion methods for KeyPair and Asset
+- Stellar Protocol 14 support
+  - Regenerate XDR wrappers from definitions in stellar-core 14.1.1
+  - Add [CAP-23 Two-Part Payments](https://github.com/stellar/stellar-protocol/blob/master/core/cap-0023.md) support
+      - Add ClaimPredicate DSL methods which help with creation of claim predicates.
+        ```
+        # use class-level helpers to create simple predicates    
+        unconditional   = Stellar::ClaimPredicate.unconditional
+        before_rel_time = Stellar::ClaimPredicate.before_relative_time(1.hour)
+        before_abs_time = Stellar::ClaimPredicate.before_absolute_time(Date.tomorrow.beginning_of_day)
+    
+        # negate predicates using `~` unary operator
+        ~predicate # same as predicate.not
+            
+        # build complex predicates using `&` and `|` infix operators
+        predicate & other_predicate # same as `predicate.and(other_predicate)`
+        predicate | other_predicate # same as `predicate.or(other_predicate)`
+        
+        # quickly define complex predicates using `.compose` class method with the block 
+        unconditional = Stellar::ClaimPredicate.compose { }
+        complex = Stellar::ClaimPredicate.compose do 
+          before_relative_time(1.week) & ~before_relative_time(10.seconds) | 
+        end
+    
+        # here's what building this predicate would look like without DSL 
+        complex = Stellar::ClaimPredicate.new(
+            Stellar::ClaimPredicateType::AND, 
+            Stellar::ClaimPredicate.new(
+                Stellar::ClaimPredicateType::BEFORE_RELATIVE_TIME, 7 * 24 * 60 * 60
+            ), 
+            Stellar::ClaimPredicate.new(
+                Stellar::ClaimPredicateType::NOT, Stellar::ClaimPredicate.new(
+                    Stellar::ClaimPredicateType::BEFORE_RELATIVE_TIME, 10
+                )
+            )
+        )
+        
+        ```
+      - Extend Operation with `create_claimable_balance` and `claim_claimable_balance` helpers
+      - Add Claimant and ClaimPredicate DSL methods to reduce the noise.
+        ```
+        include Stellar::DSL
+        
+        sender = KeyPair('S....')
+        recipient = 'G....'
+        
+        op = Operation.create_claimable_balance(
+            asset: Stellar::Asset.native,
+            amount: 100,
+            claimants: [
+              Claimant(recipient) { after(10.seconds) & before(1.week) },
+              Claimant(sender), # allow unconditional claim-back 
+            ]
+          )
+        ])
+        ```
+      - Add simple predicate evaluation feature so that developers can sanity-check their predicates
+        ```
+        include Stellar::DSL
+        
+        predicate = ClaimPredicate { before_relative_time(1.week) & ~before_relative_time(10.seconds) }
+        
+        # predicate.evaluate(balance_creation_time, claim_evaluation_time)
+        predicate.evaluate("2020-10-20 09:00:00", "2020-10-20 09:00:05") # => false
+        predicate.evaluate("2020-10-20 09:00:00", "2020-10-20 09:01:00") # => true
+        predicate.evaluate("2020-10-20 09:00:00", "2020-10-27 08:50:00") # => true
+        
+        # you can also pass an instance of ActiveSupport::Duration as a second parameter, in this case
+        # it works as a relative offset from `balance_creation_time` 
+        predicate.evaluate("2020-10-20 09:00:00", 1.week + 1.second) # => false
+        
+        # it is effectively the same as
+        predicate.evaluate("2020-10-20 09:00:00", "2020-10-27 09:00:01") # => false                 
+        ``` 
+  - Add [CAP-33 Sponsored Reserves](https://github.com/stellar/stellar-protocol/blob/master/core/cap-0033.md) support
+    - Extend the operation class with helpers that allow sponsoring reserves and also revoke sponsorships.
+      - `Operation.begin_sponsoring_future_reserves`
+      - `Operation.end_sponsoring_future_reserves`
+      - `Operation.revoke_sponsorship(account_id:)`
+      - `Operation.revoke_sponsorship(account_id:, asset:)`
+      - `Operation.revoke_sponsorship(account_id:, offer_id:)`
+      - `Operation.revoke_sponsorship(account_id:, data_name:)`
+      - `Operation.revoke_sponsorship(account_id:, balance_id:)`
+      - `Operation.revoke_sponsorship(account_id:, signer:)`
+        
+
 ## [0.23.1](https://github.com/stellar/ruby-stellar-sdk/compare/v0.23.1...v0.23.0) - 2020-06-18
 ### Added
 - Transaction builder now builds V1 transactions

data/generated/stellar-base-generated.rb

@@ -46,6 +46,10 @@ module Stellar
   autoload :Signer
   autoload :AccountFlags
   MASK_ACCOUNT_FLAGS = 0x7
+  MAX_SIGNERS = 20
+  SponsorshipDescriptor = XDR::Option[AccountID]
+  autoload :AccountEntryExtensionV2
+  autoload :AccountEntryExtensionV1
   autoload :AccountEntry
   autoload :TrustLineFlags
   MASK_TRUSTLINE_FLAGS = 1
@@ -55,7 +59,16 @@ module Stellar
   MASK_OFFERENTRY_FLAGS = 1
   autoload :OfferEntry
   autoload :DataEntry
+  autoload :ClaimPredicateType
+  autoload :ClaimPredicate
+  autoload :ClaimantType
+  autoload :Claimant
+  autoload :ClaimableBalanceIDType
+  autoload :ClaimableBalanceID
+  autoload :ClaimableBalanceEntry
+  autoload :LedgerEntryExtensionV1
   autoload :LedgerEntry
+  autoload :LedgerKey
   autoload :EnvelopeType
 end
 module Stellar
@@ -76,7 +89,13 @@ module Stellar
   autoload :AllowTrustOp
   autoload :ManageDataOp
   autoload :BumpSequenceOp
+  autoload :CreateClaimableBalanceOp
+  autoload :ClaimClaimableBalanceOp
+  autoload :BeginSponsoringFutureReservesOp
+  autoload :RevokeSponsorshipType
+  autoload :RevokeSponsorshipOp
   autoload :Operation
+  autoload :OperationID
   autoload :MemoType
   autoload :Memo
   autoload :TimeBounds
@@ -120,6 +139,16 @@ module Stellar
   autoload :ManageDataResult
   autoload :BumpSequenceResultCode
   autoload :BumpSequenceResult
+  autoload :CreateClaimableBalanceResultCode
+  autoload :CreateClaimableBalanceResult
+  autoload :ClaimClaimableBalanceResultCode
+  autoload :ClaimClaimableBalanceResult
+  autoload :BeginSponsoringFutureReservesResultCode
+  autoload :BeginSponsoringFutureReservesResult
+  autoload :EndSponsoringFutureReservesResultCode
+  autoload :EndSponsoringFutureReservesResult
+  autoload :RevokeSponsorshipResultCode
+  autoload :RevokeSponsorshipResult
   autoload :OperationResultCode
   autoload :OperationResult
   autoload :TransactionResultCode
@@ -137,7 +166,6 @@ module Stellar
   autoload :LedgerHeader
   autoload :LedgerUpgradeType
   autoload :LedgerUpgrade
-  autoload :LedgerKey
   autoload :BucketEntryType
   autoload :BucketMetadata
   autoload :BucketEntry

data/generated/stellar/account_entry.rb

@@ -21,7 +21,7 @@ require 'xdr'
 #       // thresholds stores unsigned bytes: [weight of master|low|medium|high]
 #       Thresholds thresholds;
 #   
-#       Signer signers<20>; // possible signers for this account
+#       Signer signers<MAX_SIGNERS>; // possible signers for this account
 #   
 #       // reserved for future use
 #       union switch (int v)
@@ -29,17 +29,7 @@ require 'xdr'
 #       case 0:
 #           void;
 #       case 1:
-#           struct
-#           {
-#               Liabilities liabilities;
-#   
-#               union switch (int v)
-#               {
-#               case 0:
-#                   void;
-#               }
-#               ext;
-#           } v1;
+#           AccountEntryExtensionV1 v1;
 #       }
 #       ext;
 #   };
@@ -59,7 +49,7 @@ module Stellar
     attribute :flags,           Uint32
     attribute :home_domain,     String32
     attribute :thresholds,      Thresholds
-    attribute :signers,         XDR::VarArray[Signer, 20]
+    attribute :signers,         XDR::VarArray[Signer, MAX_SIGNERS]
     attribute :ext,             Ext
   end
 end

data/generated/stellar/account_entry/ext.rb

@@ -10,33 +10,19 @@ require 'xdr'
 #       case 0:
 #           void;
 #       case 1:
-#           struct
-#           {
-#               Liabilities liabilities;
-#   
-#               union switch (int v)
-#               {
-#               case 0:
-#                   void;
-#               }
-#               ext;
-#           } v1;
+#           AccountEntryExtensionV1 v1;
 #       }
 #
 # ===========================================================================
 module Stellar
   class AccountEntry
     class Ext < XDR::Union
-      include XDR::Namespace
-
-      autoload :V1
-
       switch_on XDR::Int, :v
 
       switch 0
       switch 1, :v1
 
-      attribute :v1, V1
+      attribute :v1, AccountEntryExtensionV1
     end
   end
 end

data/generated/stellar/account_entry_extension_v1.rb

@@ -0,0 +1,32 @@
+# This code was automatically generated using xdrgen
+# DO NOT EDIT or your changes may be overwritten
+
+require 'xdr'
+
+# === xdr source ============================================================
+#
+#   struct AccountEntryExtensionV1
+#   {
+#       Liabilities liabilities;
+#   
+#       union switch (int v)
+#       {
+#       case 0:
+#           void;
+#       case 2:
+#           AccountEntryExtensionV2 v2;
+#       }
+#       ext;
+#   };
+#
+# ===========================================================================
+module Stellar
+  class AccountEntryExtensionV1 < XDR::Struct
+    include XDR::Namespace
+
+    autoload :Ext
+
+    attribute :liabilities, Liabilities
+    attribute :ext,         Ext
+  end
+end

data/generated/stellar/account_entry_extension_v1/ext.rb

@@ -0,0 +1,28 @@
+# This code was automatically generated using xdrgen
+# DO NOT EDIT or your changes may be overwritten
+
+require 'xdr'
+
+# === xdr source ============================================================
+#
+#   union switch (int v)
+#       {
+#       case 0:
+#           void;
+#       case 2:
+#           AccountEntryExtensionV2 v2;
+#       }
+#
+# ===========================================================================
+module Stellar
+  class AccountEntryExtensionV1
+    class Ext < XDR::Union
+      switch_on XDR::Int, :v
+
+      switch 0
+      switch 2, :v2
+
+      attribute :v2, AccountEntryExtensionV2
+    end
+  end
+end

data/generated/stellar/account_entry_extension_v2.rb

@@ -0,0 +1,34 @@
+# This code was automatically generated using xdrgen
+# DO NOT EDIT or your changes may be overwritten
+
+require 'xdr'
+
+# === xdr source ============================================================
+#
+#   struct AccountEntryExtensionV2
+#   {
+#       uint32 numSponsored;
+#       uint32 numSponsoring;
+#       SponsorshipDescriptor signerSponsoringIDs<MAX_SIGNERS>;
+#   
+#       union switch (int v)
+#       {
+#       case 0:
+#           void;
+#       }
+#       ext;
+#   };
+#
+# ===========================================================================
+module Stellar
+  class AccountEntryExtensionV2 < XDR::Struct
+    include XDR::Namespace
+
+    autoload :Ext
+
+    attribute :num_sponsored,          Uint32
+    attribute :num_sponsoring,         Uint32
+    attribute :signer_sponsoring_i_ds, XDR::VarArray[SponsorshipDescriptor, MAX_SIGNERS]
+    attribute :ext,                    Ext
+  end
+end

data/generated/stellar/{account_entry/ext/v1 → account_entry_extension_v2}/ext.rb

@@ -6,23 +6,19 @@ require 'xdr'
 # === xdr source ============================================================
 #
 #   union switch (int v)
-#               {
-#               case 0:
-#                   void;
-#               }
+#       {
+#       case 0:
+#           void;
+#       }
 #
 # ===========================================================================
 module Stellar
-  class AccountEntry
-    class Ext
-      class V1
-        class Ext < XDR::Union
-          switch_on XDR::Int, :v
+  class AccountEntryExtensionV2
+    class Ext < XDR::Union
+      switch_on XDR::Int, :v
 
-          switch 0
+      switch 0
 
-        end
-      end
     end
   end
 end

data/generated/stellar/account_merge_result_code.rb

@@ -15,8 +15,9 @@ require 'xdr'
 #       ACCOUNT_MERGE_IMMUTABLE_SET = -3,   // source account has AUTH_IMMUTABLE set
 #       ACCOUNT_MERGE_HAS_SUB_ENTRIES = -4, // account has trust lines/offers
 #       ACCOUNT_MERGE_SEQNUM_TOO_FAR = -5,  // sequence number is over max allowed
-#       ACCOUNT_MERGE_DEST_FULL = -6        // can't add source balance to
+#       ACCOUNT_MERGE_DEST_FULL = -6,       // can't add source balance to
 #                                           // destination balance
+#       ACCOUNT_MERGE_IS_SPONSOR = -7       // can't merge account that is a sponsor
 #   };
 #
 # ===========================================================================
@@ -29,6 +30,7 @@ module Stellar
     member :account_merge_has_sub_entries, -4
     member :account_merge_seqnum_too_far,  -5
     member :account_merge_dest_full,       -6
+    member :account_merge_is_sponsor,      -7
 
     seal
   end

data/generated/stellar/begin_sponsoring_future_reserves_op.rb

@@ -0,0 +1,18 @@
+# This code was automatically generated using xdrgen
+# DO NOT EDIT or your changes may be overwritten
+
+require 'xdr'
+
+# === xdr source ============================================================
+#
+#   struct BeginSponsoringFutureReservesOp
+#   {
+#       AccountID sponsoredID;
+#   };
+#
+# ===========================================================================
+module Stellar
+  class BeginSponsoringFutureReservesOp < XDR::Struct
+    attribute :sponsored_id, AccountID
+  end
+end

data/generated/stellar/begin_sponsoring_future_reserves_result.rb

@@ -0,0 +1,25 @@
+# This code was automatically generated using xdrgen
+# DO NOT EDIT or your changes may be overwritten
+
+require 'xdr'
+
+# === xdr source ============================================================
+#
+#   union BeginSponsoringFutureReservesResult switch (BeginSponsoringFutureReservesResultCode code)
+#   {
+#   case BEGIN_SPONSORING_FUTURE_RESERVES_SUCCESS:
+#       void;
+#   default:
+#       void;
+#   };
+#
+# ===========================================================================
+module Stellar
+  class BeginSponsoringFutureReservesResult < XDR::Union
+    switch_on BeginSponsoringFutureReservesResultCode, :code
+
+    switch :begin_sponsoring_future_reserves_success
+    switch :default
+
+  end
+end

data/generated/stellar/begin_sponsoring_future_reserves_result_code.rb

@@ -0,0 +1,29 @@
+# This code was automatically generated using xdrgen
+# DO NOT EDIT or your changes may be overwritten
+
+require 'xdr'
+
+# === xdr source ============================================================
+#
+#   enum BeginSponsoringFutureReservesResultCode
+#   {
+#       // codes considered as "success" for the operation
+#       BEGIN_SPONSORING_FUTURE_RESERVES_SUCCESS = 0,
+#   
+#       // codes considered as "failure" for the operation
+#       BEGIN_SPONSORING_FUTURE_RESERVES_MALFORMED = -1,
+#       BEGIN_SPONSORING_FUTURE_RESERVES_ALREADY_SPONSORED = -2,
+#       BEGIN_SPONSORING_FUTURE_RESERVES_RECURSIVE = -3
+#   };
+#
+# ===========================================================================
+module Stellar
+  class BeginSponsoringFutureReservesResultCode < XDR::Enum
+    member :begin_sponsoring_future_reserves_success,           0
+    member :begin_sponsoring_future_reserves_malformed,         -1
+    member :begin_sponsoring_future_reserves_already_sponsored, -2
+    member :begin_sponsoring_future_reserves_recursive,         -3
+
+    seal
+  end
+end