stellar-base 0.23.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d47a957d6769b441707e5072b9de09576c87bb411787d10818e885680e59de69
-  data.tar.gz: '07820e81c7b00d7b6db48192095f5bd6ad497b3680383c85944030abaae60410'
+  metadata.gz: b29836900dbce5c01176c3b92c7c3ef365dbca086d700258e00299edf3edbd61
+  data.tar.gz: 0c17163d8d41dc0c7847ea888d5e2650b715dc43ecd552f292dc1090fce6e786
 SHA512:
-  metadata.gz: 19b5c2836eaafa4ce5b53e5c33f373bc995428111d1463ffa3571ec0e3411c1dbec6ca319ac5689c138a2dfdd01e07fa5d3cca08fff5ba7f827f3d4d1f71ca54
-  data.tar.gz: 342be2d0102eea5d6fe61e137a4609ff1e562639aa994eb908f9f025625ee4585a39a9cb09daaceba6824129cfc1812890577101cb62f1ede4c5d6da5e6c23ea
+  metadata.gz: d2470776823bd7581c6b0985756001fbfb796368aa8ecb2f6c0ead49c13b776dad0405a37b3f3f9c33c3765b84103a16cd4854a3122e1a4e9ef6712ffa1b12fe
+  data.tar.gz: 1c13e6d755225adc62c22f9e917e74ec178d85df6bfd440ab9ae65d757830c393bab00bb63fb9c8abac34af6c0044a738dea0a1acad03969dda754a627022875

data/CHANGELOG.md

@@ -1,11 +1,124 @@
 # Changelog
 
 All notable changes to this project will be documented in this
-file.  This project adheres to [Semantic Versioning](http://semver.org/).
+file. The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and 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](https://github.com/stellar/ruby-stellar-sdk/compare/v0.26.0...master)
+
+## [0.26.0](https://github.com/stellar/ruby-stellar-sdk/compare/v0.25.0...0.26.0) - 2021-02-05
+- No changes
+
+## [0.25.0](https://github.com/stellar/ruby-stellar-sdk/compare/v0.24.0...v0.25.0) - 2020-10-30
+### Added
+- `MuxedAccount` implements `#to_keypair` conversion protocol
+- `MuxedAccount` correctly responds to `#address` with strkey encoded public key
+### Fixed
+- `Transaction::V0#source_account` now properly returns `MuxedAccount` instead of raw bytes
+
+## [0.24.0](https://github.com/stellar/ruby-stellar-sdk/compare/v0.23.1...v0.24.0) - 2020-10-20
+### 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.
+        ```ruby
+        # 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.
+        ```ruby
+        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
+        ```ruby
+        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.0...v0.23.1) - 2020-06-18
+### Added
+- Transaction builder now builds V1 transactions
+- FeeBumpTransaction can wrap V0 transaction
+
+## [0.23.0](https://github.com/stellar/ruby-stellar-sdk/compare/v0.22.0...v0.23.0) - 2020-06-11
+### Added
+- Stellar Protocol 13 support
+  - Fee-Bump transactions ([CAP-0015](https://github.com/stellar/stellar-protocol/blob/master/core/cap-0015.md))
+  - Multiplexed accounts ([CAP-0027](https://github.com/stellar/stellar-protocol/blob/master/core/cap-0027.md))
+  - Fine-Grained control on trustline authorization ([CAP-0018](https://github.com/stellar/stellar-protocol/blob/master/core/cap-0018.md))
+
 ## [0.22.0](https://github.com/stellar/ruby-stellar-base/compare/v0.21.0...v0.22.0) - 2020-03-26
 ### Added
 - Add TransactionBuilder ([#54](https://github.com/stellar/ruby-stellar-base/issues/54))

data/README.md

@@ -1,7 +1,7 @@
-# Stellar::Base
-
-[![Build Status](https://travis-ci.org/stellar/ruby-stellar-base.svg)](https://travis-ci.org/stellar/ruby-stellar-base)
-[![Code Climate](https://codeclimate.com/github/stellar/ruby-stellar-base/badges/gpa.svg)](https://codeclimate.com/github/stellar/ruby-stellar-base)
+# Stellar SDK for Ruby: XDR and Low Level Abstractions
+[![stellar-base](https://badge.fury.io/rb/stellar-base.svg)](https://badge.fury.io/rb/stellar-base)
+[![Test](https://github.com/astroband/ruby-stellar-sdk/workflows/Test/badge.svg)](https://github.com/astroband/ruby-stellar-sdk/actions?query=branch%3Amaster)
+[![Maintainability](https://api.codeclimate.com/v1/badges/dadfcd9396aba493cb93/maintainability)](https://codeclimate.com/github/astroband/ruby-stellar-sdk/maintainability)
 
 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 stellard.
@@ -12,15 +12,12 @@ Add this line to your application's Gemfile:
 
 ```ruby
 gem 'stellar-base'
-gem 'xdr', git: 'https://github.com/stellar/ruby-xdr.git', tag: 'v3.0.1'
 ```
 
 And then execute:
 
     $ bundle
 
-**Note** we need to add such explicit xdr dependency, because version 3.0.1 is not on RubyGems yet. When it's published, you can remove this line
-
 Also requires libsodium. Installable via `brew install libsodium` on OS X.
 
 ## Supported Ruby Versions

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