stellar-base 0.23.0.rc1 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0374689ad0aea387b1a9364e4a4008767fee2e654434d7ed83034c183e77015
-  data.tar.gz: 46642a42072f2f7ad5e2ce5e8ccb9e4cff2d8991173adc1d7627b2bfa8660e5e
+  metadata.gz: f32d18dcada46e11a1836cdeda94d852d89ac6de0c89472ef794d748e38bcc68
+  data.tar.gz: d15156a33fc3b64ef70e78d83892ab70ec3e076611667572c3bda07aa4aaf2f6
 SHA512:
-  metadata.gz: b928d1453197e01d277f26cefec2176dd54ec7cce1d558fd4c8b828021ddec9daf2be6dc597a9836a14c6b8f88381798632894c64b098324a1b168d8650ab53e
-  data.tar.gz: 8fc5fdb48d02bb67e18123038a592e321fe24689ed4fb44c7913b0fb8357fc6e1b675d6e3fb96acecc1a7de512ce0cf947aaddd95ffebdd3d62a07cd0ff587f8
+  metadata.gz: b2ad9163443ed4391d9004f41b07ba61e59378c8d01505210f7a62dff8239a748e0bc137a07e7f37d80991f8fb580246377a30c7d2189fbd044c05d586ab48a7
+  data.tar.gz: 9395e4eb5c837643a2046d681892c9bfc4ea5a43c3a4612729f61a63c3c4c962d1fbea598fef754c980a90d282a8d31a7435658c8e4053dad612b2a2efa37c5e

data/CHANGELOG.md

@@ -0,0 +1,249 @@
+# Changelog
+
+All notable changes to this project will be documented in this
+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
+- FeeBumpTransaction can wrap V0 transaction
+  
+## [0.23.0](https://github.com/stellar/ruby-stellar-sdk/compare/v0.23.0...v0.22.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))
+
+### Changed
+- Regenerate XDR files ([#57](https://github.com/stellar/ruby-stellar-base/issues/57))
+- Allow asset objects to be passed instead of list of parameters ([#59](https://github.com/stellar/ruby-stellar-base/issues/59))
+
+## [0.21.0](https://github.com/bloom-solutions/ruby-stellar-base/compare/v0.20.0...v0.21.0) - 2019-10-04
+### Changed
+- [Stellar Protocol 12 compatibility](https://github.com/bloom-solutions/ruby-stellar-base/pull/51).
+  - XDR changes for path payment
+  - constant renames, which may cause breaking changes if referred to directly
+
+## [0.20.0](https://github.com/bloom-solutions/ruby-stellar-base/compare/v0.19.0...v0.20.0) - 2019-05-22
+### Added
+- Stellar Protocol 11 compatibility (#48)
+  - XDR changes for [CAP-0006 Buy Offers](https://github.com/stellar/stellar-protocol/blob/master/core/cap-0006.md)
+  - XDR changes for [CAP-0020 Bucket Initial Entries](https://github.com/stellar/stellar-protocol/blob/master/core/cap-0020.md)
+  - Add `manage_buy_offer`, `manage_sell_offer` and `create_passive_sell_offer` factory methods to `Stellar::Transaction` and `Stellar::Operation`
+
+### Changed
+- Deprecate `manage_offer` and `create_passive_offer` factory methods in `Stellar::Transaction` and `Stellar::Operation`
+- Add an option to pass the exact stellar-core revision into `xdr:update` Rake task
+
+## [0.19.0](https://github.com/bloom-solutions/ruby-stellar-base/compare/v0.18.0...v0.19.0)
+### Changed
+- Loosen ActiveSupport to >= 5.0.0
+
+## [0.18.0](https://github.com/bloom-solutions/ruby-stellar-base/compare/v0.17.0...v0.18.0)
+### Added
+- Update XDR definitions for stellar-core v10.0.0 (introduces Liabilities and other changes to support asset-backed offers as per [CAP-0003 Specification](https://github.com/stellar/stellar-protocol/blob/master/core/cap-0003.md#specification))
+- Add factories for ledger, transaction, operation.
+
+### Changed
+- Use rbnacl instead of rbnacl-libsodium (the latter has been [deprecated](https://github.com/crypto-rb/rbnacl-libsodium/issues/29))
+
+## [0.17.0](https://github.com/bloom-solutions/ruby-stellar-base/compare/v0.16.0...v0.17.0)
+### Fixed
+- Rename `Stellar::SignerKey#onetime_signer` helper to `Stellar::SignerKey#hash_x`, add preimage validations
+
+## [0.16.0](https://github.com/bloom-solutions/ruby-stellar-base/compare/v0.15.0...v0.16.0)
+### Added
+- Create co-signers conveniently using helpers `ed25519(keypair)`, `preauthorized_transaction(tx)` and `onetime_signer(preimage)` from `Stellar::SignerKey` module
+- Merge two transactions with `Stellar::TransactionEnvelope#merge`
+
+### Fixed
+- Source account overriding in Stellar::Transaction#to_operations
+
+## [0.15.0](https://github.com/bloom-solutions/ruby-stellar-base/compare/v0.14.0...v0.15.0)
+### Added
+- `Stellar::Operation.change_trust` can accept `Stellar::Asset` instance for `line`
+
+### Fixed
+- Protect `Stellar::Operation.change_trust` against malicious arguments, in the event that developers pass this argument directly from user input
+
+## [0.14.0](https://github.com/bloom-solutions/ruby-stellar-base/compare/v0.13.0...v0.14.0)
+
+### Added
+- We now support the bump sequence operation with `Operation.bump_sequence`.
+
+### Changed
+- Update XDR definitions for stellar-core 0.10.0 support
+- `Operation.change_trust` learned how to use a default for the `:limit` parameter
+- `StrKey` learned about new version bytes `pre_auth_tx` and `hash_x`
+
+## [0.13.0](https://github.com/bloom-solutions/ruby-stellar-base/compare/v0.12.0...v0.13.0)
+
+### Changed
+- Update XDR definitions for stellar-core 0.9.1 support
+
+### Added
+- Added `#signer_key` helper to `KeyPair`
+
+## [0.12.0](https://github.com/bloom-solutions/ruby-stellar-base/compare/v0.11.0...v0.12.0)
+
+### Changed
+- Avoid modifying $LOAD_PATH to fix load order issues
+- Update XDR definitions for stellar-core 0.6 support
+
+### Removed
+
+- BREAKING CHANGE: Removed support for JRuby.
+
+## [0.11.0](https://github.com/bloom-solutions/ruby-stellar-base/compare/v0.10.0...v0.11.0)
+
+### Added
+- Added support for `manage_data` operations
+
+### Changed
+- `Stellar::Transaction#to_envelope` can now be used without arguments, returning a `Stellar::TransactionEnvelope` with zero signatures.
+
+## [0.10.0](https://github.com/bloom-solutions/ruby-stellar-base/compare/v0.9.0...v0.10.0)
+
+- Added memo helpers to `Stellar::Transaction.for_account`, allowing any operation builder (such as `Stellar::Transaction.payment) to provide a custom memo using the `:memo` attribute.
+
+## [0.9.0](https://github.com/bloom-solutions/ruby-stellar-base/compare/v0.8.0...v0.9.0)
+
+### Changed
+- XDR Definitions have been updated to stellar-core commit eed89649c2060b8e9dacffe2cec4e8b258b32416
+
+## [0.8.0](https://github.com/bloom-solutions/ruby-stellar-base/compare/v0.7.0...v0.8.0)
+
+### Changed
+- BREAKING CHANGE:  The default network for this library is now the stellar test network.
+  To enable this library for the production network use `Stellar.default_network = Stellar::Networks::PUBLIC`
+  at the head of your script or in your configuration function.
+
+## [0.7.0](https://github.com/bloom-solutions/ruby-stellar-base/compare/v0.6.1...v0.7.0)
+
+### Changed
+
+- Bump xdr dependency to 1.0.0
+
+## [0.6.1](https://github.com/bloom-solutions/ruby-stellar-base/compare/v0.6.0...v0.6.1)
+
+### Changed
+
+- Update default fee for transactions to new minimum of 100 stroops
+
+
+## [0.6.0](https://github.com/bloom-solutions/ruby-stellar-base/compare/v0.5.0...v0.6.0)
+
+### Changed
+
+- Update to latest xdr (stellar-core commit ad22bccafbbc14a358f05a989f7b95714dc9d4c6)
+
+## [0.5.0](https://github.com/bloom-solutions/ruby-stellar-base/compare/v0.4.0...v0.5.0)
+
+### Changed
+
+- Update to latest xdr
+
+## [0.4.0](https://github.com/bloom-solutions/ruby-stellar-base/compare/v0.3.0...v0.4.0)
+
+### Changed
+- BREAKING CHANGE: "Amounts", that is, input parameters that represent a
+  certain amount of a given asset, such as the `:starting_balance` option for
+  `Operation.create_account` are now interpreted using the convention of 7
+  fixed-decimal places.  For example, specifying a payment where the amount is
+  `50` will result in a transaction with an amount set to `500000000`.

data/README.md

@@ -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