stellar-sdk 0.25.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14f9e7a13e44b5eb83bce5faee3918a49c03cfd9d36f00b49cdec501131702bc
-  data.tar.gz: cbf8145d6a546359ba66f74bc868cc1f5c6bf82a0e1c077d6073ef242f3989ef
+  metadata.gz: 3829133758963683cfff3f2132c55d8bf53540bd731d9cb2e619d2ae36012112
+  data.tar.gz: d2ec22a621018102dc93c9cb6e89dbaa5029ef29ec4d1b85f5b6cf6a8b1a8ccb
 SHA512:
-  metadata.gz: a1a999329ba74c3a0448c59c4d249c4fecdc1b0961dbc82ba985f8b3fb792b993825a1eabd2df8918566ac1b7f1ca847572a381d61c0194aa8f48cc50fdea6e4
-  data.tar.gz: b4c7f193cd7fef55798e4788476e30898c2b8517981ad4d05da2c9ac7a1ab4758e5287700cd017b1c62cd97e995b6f645dc15ef9cff22d0cc061aeb85375dfe7
+  metadata.gz: 53958e7a613b1a8cfa6b7a36a505c3820337b5a696bc16bfe7b7d3da9060fee01b0dd1afd61f4c48cb2eeee8c6a9b8b3b71d75b39afc1681b985a2a266af6231
+  data.tar.gz: b235706bc0f6d4b92298a43dae775d9b7210028c1306171ffd65212478addc929f760e0f6421e795c77d2e58570e6aa81d7665f5d93005695e1c4271e6e074f2

data/CHANGELOG.md

@@ -1,12 +1,35 @@
 # Change Log
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [Unreleased](https://github.com/stellar/ruby-stellar-sdk/compare/v0.25.0...master)
+## [0.29.0](https://www.github.com/astroband/ruby-stellar-sdk/compare/v0.28.0...v0.29.0) (2021-09-07)
+
+### Added
+* support for client domain in SEP-10
+### Deprecated
+* `Stellar::Client` class is marked as deprecated in favour of new `stellar-horizon` gem
+
+## [0.28.0](https://www.github.com/astroband/ruby-stellar-sdk/compare/v0.27.0...v0.28.0) (2021-07-17)
+
+### Changed
+* `Stellar::Account` class is now part of `stellar-base` gem
+* `Stellar::Account.lookup` is deprecated, use `Stellar::Federation.lookup` instead
+
+## [0.27.0](https://github.com/astroband/ruby-stellar-sdk/compare/v0.26.0...v0.27.0) (2021-05-08)
+- No changes
+
+## [0.26.0](https://github.com/astroband/ruby-stellar-sdk/compare/v0.25.0...v0.26.0) - 2021-02-05
+### Changed
+- `Stellar::SEP10` is updated to comply with SEP10 v3.0.0 and v3.1.0
+  - `read_challenge_tx`` now verifies `domain` in challenge auth operation, as per SEP10 v3.0.0
+  - it is now possible to provide `auth_domain` parameter to enforce auth server domain verification:
+    - `build_challenge_tx` will encode the extra auth domain operation into the challenge tx
+    - `read_challenge_tx` will verify that the challenge includes the correct auth domain operation
 
-## [0.25.0](https://github.com/stellar/ruby-stellar-sdk/compare/v0.24.0...0.25.0)
+## [0.25.0](https://github.com/astroband/ruby-stellar-sdk/compare/v0.24.0...v0.25.0) - 2020-10-30
 ### Changed
 - `Stellar::SEP10` is updated to comply with SEP10 v2.1.0
   - `build_challenge_tx` now accepts `domain` instead of `anchor_name`, using the
@@ -16,25 +39,25 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Removed:
 - Deprecated `Stellar::SEP10.verify_challenge_tx` method is removed
 
-## [0.24.0](https://github.com/stellar/ruby-stellar-sdk/compare/v0.23.1...v0.24.0) - 2020-10-20
+## [0.24.0](https://github.com/astroband/ruby-stellar-sdk/compare/v0.23.1...v0.24.0) - 2020-10-20
 - Protocol 14 support
 
-## [0.23.1](https://github.com/stellar/ruby-stellar-sdk/compare/v0.23.0...v0.23.1) - 2020-06-18
+## [0.23.1](https://github.com/astroband/ruby-stellar-sdk/compare/v0.23.0...v0.23.1) - 2020-06-18
 - Fix SEP10, considering muxed accounts
 
-## [0.23.0](https://github.com/stellar/ruby-stellar-sdk/compare/v0.9.0...v0.23.0)
+## [0.23.0](https://github.com/astroband/ruby-stellar-sdk/compare/v0.9.0-rc.1...v0.23.0)
 - No changes. We bumped this version to sync `stellar-sdk` and `stellar-base` versions
 
-## [0.9.0](https://github.com/stellar/ruby-stellar-sdk/compare/v0.9.0...v0.8.0)
+## [0.9.0](https://github.com/astroband/ruby-stellar-sdk/compare/v0.8.0...v0.9.0-rc.1)
 ### 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.8.0](https://github.com/stellar/ruby-stellar-sdk/compare/v0.7.0...v0.8.0)
+## [0.8.0](https://github.com/astroband/ruby-stellar-sdk/compare/v0.7.0...v0.8.0)
 ### Added
-- SEP-10 Multisig Support [#69](https://github.com/stellar/ruby-stellar-sdk/pull/69)
+- SEP-10 Multisig Support [#69](https://github.com/astroband/ruby-stellar-sdk/pull/69)
 - `X-Client-Name` and `X-Client-Version` headers
 
 ## [0.7.0] - 2019-04-26

data/README.md

@@ -39,7 +39,7 @@ client.send_payment({
 })
 ```
 
-Be sure to set the network when submitting to the public network (more information in [stellar-base](https://www.github.com/bloom-solutions/ruby-stellar-base)):
+Be sure to set the network when submitting to the public network (more information in [stellar-base](https://www.github.com/astroband/ruby-stellar-base)):
 
 ```ruby
 Stellar.default_network = Stellar::Networks::PUBLIC
@@ -57,7 +57,7 @@ Stellar.default_network = Stellar::Networks::PUBLIC
 ## Contributing
 
 1. Sign the [Contributor License Agreement](https://docs.google.com/forms/d/1g7EF6PERciwn7zfmfke5Sir2n10yddGGSXyZsq98tVY/viewform?usp=send_form)
-2. Fork it ( https://github.com/bloom-solutions/ruby-stellar-lib/fork )
+2. Fork it ( https://github.com/astroband/ruby-stellar-sdk/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/stellar/client.rb

@@ -44,6 +44,8 @@ module Stellar
 
     # @option options [String] :horizon The Horizon server URL.
     def initialize(options)
+      ActiveSupport::Deprecation.warn("`Stellar::Horizon` is deprecated and will be removed from `stellar-sdk` next relase. Use `stellar-horizon` gem for requesting Horizon API")
+
       @options = options
       @horizon = Hyperclient.new(options[:horizon]) { |client|
         client.faraday_block = lambda do |conn|

data/lib/stellar/compat.rb

@@ -0,0 +1,4 @@
+class << Stellar::Account
+  delegate :lookup, to: Stellar::Federation
+  deprecate deprecator: Stellar::Deprecation, lookup: "Use `Stellar::Federation.lookup` method"
+end

data/lib/stellar/federation.rb

@@ -0,0 +1,51 @@
+require "toml-rb"
+require "uri"
+require "faraday"
+require "json"
+
+module Stellar
+  class Federation
+    def self.lookup(federated_name)
+      _, domain = federated_name.split("*")
+      if domain.nil?
+        raise InvalidFederationAddress.new
+      end
+
+      domain_req = Faraday.new("https://#{domain}/.well-known/stellar.toml").get
+
+      unless domain_req.status == 200
+        raise InvalidStellarDomain, "Domain does not contain stellar.toml file"
+      end
+
+      fed_server_url = TomlRB.parse(domain_req.body)["FEDERATION_SERVER"]
+      if fed_server_url.nil?
+        raise InvalidStellarTOML, "Invalid Stellar TOML file"
+      end
+
+      unless fed_server_url&.match?(URI::DEFAULT_PARSER.make_regexp)
+        raise InvalidFederationURL, "Invalid Federation Server URL"
+      end
+
+      lookup_req = Faraday.new(fed_server_url).get { |req|
+        req.params[:q] = federated_name
+        req.params[:type] = "name"
+      }
+
+      unless lookup_req.status == 200
+        raise AccountNotFound, "Account not found"
+      end
+
+      JSON.parse(lookup_req.body)["account_id"]
+    end
+  end
+
+  class AccountNotFound < StandardError; end
+
+  class InvalidStellarTOML < StandardError; end
+
+  class InvalidFederationAddress < StandardError; end
+
+  class InvalidStellarDomain < StandardError; end
+
+  class InvalidFederationURL < StandardError; end
+end

data/lib/stellar/sep10.rb

@@ -30,10 +30,6 @@ module Stellar
         MSG
         domain = options[:anchor_name]
       end
-      # The value must be 64 bytes long. It contains a 48 byte
-      # cryptographic-quality random string encoded using base64 (for a total of
-      # 64 bytes after encoding).
-      value = SecureRandom.base64(48)
 
       now = Time.now.to_i
       time_bounds = Stellar::TimeBounds.new(
@@ -41,19 +37,48 @@ module Stellar
         max_time: now + timeout
       )
 
-      tx = Stellar::TransactionBuilder.new(
+      tb = Stellar::TransactionBuilder.new(
         source_account: server,
         sequence_number: 0,
         time_bounds: time_bounds
-      ).add_operation(
+      )
+
+      # The value must be 64 bytes long. It contains a 48 byte
+      # cryptographic-quality random string encoded using base64 (for a total of
+      # 64 bytes after encoding).
+      tb.add_operation(
         Stellar::Operation.manage_data(
           name: "#{domain} auth",
-          value: value,
+          value: SecureRandom.base64(48),
           source_account: client
         )
-      ).build
+      )
+
+      if options.key?(:auth_domain)
+        tb.add_operation(
+          Stellar::Operation.manage_data(
+            name: "web_auth_domain",
+            value: options[:auth_domain],
+            source_account: server
+          )
+        )
+      end
+
+      if options[:client_domain].present?
+        if options[:client_domain_account].blank?
+          raise "`client_domain_account` is required, if `client_domain` is provided"
+        end
+
+        tb.add_operation(
+          Stellar::Operation.manage_data(
+            name: "client_domain",
+            value: options[:client_domain],
+            source_account: options[:client_domain_account]
+          )
+        )
+      end
 
-      tx.to_envelope(server).to_xdr(:base64)
+      tb.build.to_envelope(server).to_xdr(:base64)
     end
 
     # Reads a SEP 10 challenge transaction and returns the decoded transaction envelope and client account ID contained within.
@@ -68,8 +93,8 @@ module Stellar
     # @example
     #   sep10 = Stellar::SEP10
     #   server = Stellar::KeyPair.random # this should be the SIGNING_KEY from your stellar.toml
-    #   challenge = sep10.build_challenge_tx(server: server, client: user, home_domain: domain, timeout: timeout)
-    #   envelope, client_address = sep10.read_challenge_tx(server: server, challenge: challenge)
+    #   challenge = sep10.build_challenge_tx(server: server, client: user, domain: domain, timeout: timeout)
+    #   envelope, client_address = sep10.read_challenge_tx(server: server, challenge_xdr: challenge)
     #
     # @param challenge_xdr [String] SEP0010 transaction challenge in base64.
     # @param server [Stellar::KeyPair] keypair for server where the challenge was generated.
@@ -94,7 +119,9 @@ module Stellar
       auth_op, *rest_ops = transaction.operations
       client_account_id = auth_op.source_account
 
-      if client_account_id.nil?
+      auth_op_body = auth_op.body.value
+
+      if client_account_id.blank?
         raise InvalidSep10ChallengeError, "The transaction's operation should contain a source account"
       end
 
@@ -102,15 +129,24 @@ module Stellar
         raise InvalidSep10ChallengeError, "The transaction's first operation should be manageData"
       end
 
-      if auth_op.body.value.data_value.unpack1("m").size != 48
+      if options.key?(:domain) && auth_op_body.data_name != "#{options[:domain]} auth"
+        raise InvalidSep10ChallengeError, "The transaction's operation data name is invalid"
+      end
+
+      if auth_op_body.data_value.unpack1("m").size != 48
         raise InvalidSep10ChallengeError, "The transaction's operation value should be a 64 bytes base64 random string"
       end
 
       rest_ops.each do |op|
-        if op.body.arm != :manage_data_op
+        body = op.body
+        op_params = body.value
+
+        if body.arm != :manage_data_op
           raise InvalidSep10ChallengeError, "The transaction has operations that are not of type 'manageData'"
-        elsif op.source_account != server.muxed_account
+        elsif op.source_account != server.muxed_account && op_params.data_name != "client_domain"
           raise InvalidSep10ChallengeError, "The transaction has operations that are unrecognized"
+        elsif op_params.data_name == "web_auth_domain" && options.key?(:auth_domain) && op_params.data_value != options[:auth_domain]
+          raise InvalidSep10ChallengeError, "The transaction has 'manageData' operation with 'web_auth_domain' key and invalid value"
         end
       end
 
@@ -121,7 +157,7 @@ module Stellar
       time_bounds = transaction.time_bounds
       now = Time.now.to_i
 
-      if time_bounds.nil? || !now.between?(time_bounds.min_time, time_bounds.max_time)
+      if time_bounds.blank? || !now.between?(time_bounds.min_time, time_bounds.max_time)
         raise InvalidSep10ChallengeError, "The transaction has expired"
       end
 
@@ -186,6 +222,9 @@ module Stellar
       client_signers = signers.select { |s| s =~ /G[A-Z0-9]{55}/ && s != server.address }.to_set
       raise InvalidSep10ChallengeError, "at least one regular signer must be provided" if client_signers.empty?
 
+      client_domain_account_address = extract_client_domain_account(te.tx)
+      client_signers.add(client_domain_account_address) if client_domain_account_address.present?
+
       # verify all signatures in one pass
       client_signers.add(server.address)
       signers_found = verify_tx_signatures(tx_envelope: te, signers: client_signers)
@@ -205,6 +244,10 @@ module Stellar
         raise InvalidSep10ChallengeError, "Transaction has unrecognized signatures."
       end
 
+      if client_domain_account_address.present? && !signers_found.include?(client_domain_account_address)
+        raise InvalidSep10ChallengeError, "Transaction not signed by client domain account."
+      end
+
       signers_found
     end
 
@@ -225,7 +268,7 @@ module Stellar
       to_keypair = Stellar::DSL.method(:KeyPair)
       keys_by_hint = signers.map(&to_keypair).index_by(&:signature_hint)
 
-      tx_envelope.signatures.each.with_object(Set.new) do |sig, result|
+      signatures.each_with_object(Set.new) do |sig, result|
         key = keys_by_hint.delete(sig.hint)
         result.add(key.address) if key&.verify(sig.signature, tx_hash)
       end
@@ -248,5 +291,16 @@ module Stellar
         keypair.verify(sig.signature, tx_hash)
       end
     end
+
+    def self.extract_client_domain_account(transaction)
+      client_domain_account_op =
+        transaction
+          .operations
+          .find { |op| op.body.value.data_name == "client_domain" }
+
+      return if client_domain_account_op.blank?
+
+      Util::StrKey.encode_muxed_account(client_domain_account_op.source_account)
+    end
   end
 end

data/lib/stellar-sdk.rb

@@ -1,10 +1,13 @@
 require "stellar-base"
-require_relative "stellar/sdk/version"
 
 module Stellar
-  autoload :Account
+  module SDK
+    VERSION = ::Stellar::VERSION
+  end
+
   autoload :Amount
   autoload :Client
+  autoload :Federation
   autoload :SEP10
 
   module Horizon
@@ -16,3 +19,5 @@ module Stellar
 
   autoload :TransactionPage
 end
+
+require_relative "stellar/compat"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stellar-sdk
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.29.0
 platform: ruby
 authors:
 - Scott Fleckenstein
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-30 00:00:00.000000000 Z
+date: 2021-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stellar-base
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.25.0
+        version: 0.29.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.25.0
+        version: 0.29.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -75,7 +75,7 @@ dependencies:
         version: 0.7.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -85,7 +85,7 @@ dependencies:
         version: 0.7.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: toml-rb
   requirement: !ruby/object:Gem::Requirement
@@ -112,14 +112,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -161,21 +161,23 @@ files:
 - LICENSE
 - README.md
 - lib/stellar-sdk.rb
-- lib/stellar/account.rb
 - lib/stellar/amount.rb
 - lib/stellar/client.rb
+- lib/stellar/compat.rb
+- lib/stellar/federation.rb
 - lib/stellar/horizon/problem.rb
-- lib/stellar/sdk/version.rb
 - lib/stellar/sep10.rb
 - lib/stellar/transaction_page.rb
-homepage: https://github.com/stellar/ruby-stellar-sdk/tree/master/sdk
+homepage: https://github.com/astroband/ruby-stellar-sdk
 licenses:
 - Apache-2.0
 metadata:
+  bug_tracker_uri: https://github.com/astroband/ruby-stellar-sdk/issues
+  changelog_uri: https://github.com/astroband/ruby-stellar-sdk/blob/v0.29.0/sdk/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/stellar-sdk/0.29.0/
   github_repo: ssh://github.com/astroband/ruby-stellar-sdk
-  documentation_uri: https://rubydoc.info/gems/stellar-sdk/0.25.0/
-  changelog_uri: https://github.com/astroband/ruby-stellar-sdk/blob/v0.25.0/sdk/CHANGELOG.md
-  source_code_uri: https://github.com/astroband/ruby-stellar-sdk/tree/v0.25.0/sdk
+  homepage_uri: https://github.com/astroband/ruby-stellar-sdk/tree/main/sdk
+  source_code_uri: https://github.com/astroband/ruby-stellar-sdk/tree/v0.29.0/sdk
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -191,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.rc.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Stellar client library

data/lib/stellar/account.rb

@@ -1,89 +0,0 @@
-require "toml-rb"
-require "uri"
-require "faraday"
-require "json"
-
-module Stellar
-  class Account
-    delegate :address, to: :keypair
-
-    def self.random
-      keypair = Stellar::KeyPair.random
-      new(keypair)
-    end
-
-    def self.from_seed(seed)
-      keypair = Stellar::KeyPair.from_seed(seed)
-      new(keypair)
-    end
-
-    def self.from_address(address)
-      keypair = Stellar::KeyPair.from_address(address)
-      new(keypair)
-    end
-
-    def self.lookup(federated_name)
-      _, domain = federated_name.split("*")
-      if domain.nil?
-        raise InvalidFederationAddress.new
-      end
-
-      domain_req = Faraday.new("https://#{domain}/.well-known/stellar.toml").get
-
-      unless domain_req.status == 200
-        raise InvalidStellarDomain.new("Domain does not contain stellar.toml file")
-      end
-
-      fed_server_url = TomlRB.parse(domain_req.body)["FEDERATION_SERVER"]
-      if fed_server_url.nil?
-        raise InvalidStellarTOML.new("Invalid Stellar TOML file")
-      end
-
-      unless fed_server_url&.match?(URI::DEFAULT_PARSER.make_regexp)
-        raise InvalidFederationURL.new("Invalid Federation Server URL")
-      end
-
-      lookup_req = Faraday.new(fed_server_url).get { |req|
-        req.params[:q] = federated_name
-        req.params[:type] = "name"
-      }
-
-      unless lookup_req.status == 200
-        raise AccountNotFound.new("Account not found")
-      end
-
-      JSON.parse(lookup_req.body)["account_id"]
-    end
-
-    def self.master
-      keypair = Stellar::KeyPair.from_raw_seed("allmylifemyhearthasbeensearching")
-      new(keypair)
-    end
-
-    attr_reader :keypair
-
-    # @param [Stellar::KeyPair] keypair
-    def initialize(keypair)
-      @keypair = keypair
-    end
-
-    def to_keypair
-      keypair
-    end
-  end
-
-  class AccountNotFound < StandardError
-  end
-
-  class InvalidStellarTOML < StandardError
-  end
-
-  class InvalidFederationAddress < StandardError
-  end
-
-  class InvalidStellarDomain < StandardError
-  end
-
-  class InvalidFederationURL < StandardError
-  end
-end

data/lib/stellar/sdk/version.rb

@@ -1,5 +0,0 @@
-module Stellar
-  module SDK
-    VERSION = "0.25.0"
-  end
-end