stellar-sdk 0.29.0 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3829133758963683cfff3f2132c55d8bf53540bd731d9cb2e619d2ae36012112
-  data.tar.gz: d2ec22a621018102dc93c9cb6e89dbaa5029ef29ec4d1b85f5b6cf6a8b1a8ccb
+  metadata.gz: 5dc8d8d67076947afebdb2065fa08387d878e4250b5604ddfb4eb32b7056507a
+  data.tar.gz: 71b168f5ce4f97e76839d712eec86241a6839b0f93d7cd45544692703b28af22
 SHA512:
-  metadata.gz: 53958e7a613b1a8cfa6b7a36a505c3820337b5a696bc16bfe7b7d3da9060fee01b0dd1afd61f4c48cb2eeee8c6a9b8b3b71d75b39afc1681b985a2a266af6231
-  data.tar.gz: b235706bc0f6d4b92298a43dae775d9b7210028c1306171ffd65212478addc929f760e0f6421e795c77d2e58570e6aa81d7665f5d93005695e1c4271e6e074f2
+  metadata.gz: cf1ebdc0471f3884cfe207bcfc2f1131b6efbb9e35b7b4cce75044fea3b0c2245f7219af4b04bc868b79396d01303209fdc8ce041102b124ab92e64cb30e2dcc
+  data.tar.gz: 773d3492c23d37de50cafff1c6847aa0041136d235013e5d3526b44dc7a5e81ba18a77698eebcff3bb31f040bd958d903a803e2b9033205607cc47776c44e004

data/CHANGELOG.md

@@ -5,6 +5,16 @@ 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/).
 
+## [0.30.0](https://www.github.com/astroband/ruby-stellar-sdk/compare/v0.29.0...v0.30.0) (2021-10-14)
+
+### Added
+* `stellar-sdk` now depends on `stellar-horizon`
+### Changed
+* `Stellar::Amount` class moved to `stellar-base` gem
+* `Stellar::Horizon::Problem` class moved to `stellar-horizon` gem
+* `Stellar::TransactionPage` is now `Stellar::Horizon::TransactionPage` in `stellar-horizon` gem
+* `toml-rb` gem is replaced with `tomlrb` gem to work around [segfaults in Ruby 3.0](https://github.com/mjackson/citrus/issues/60)
+
 ## [0.29.0](https://www.github.com/astroband/ruby-stellar-sdk/compare/v0.28.0...v0.29.0) (2021-09-07)
 
 ### Added

data/lib/stellar/federation.rb

@@ -1,4 +1,4 @@
-require "toml-rb"
+require "tomlrb"
 require "uri"
 require "faraday"
 require "json"
@@ -17,7 +17,7 @@ module Stellar
         raise InvalidStellarDomain, "Domain does not contain stellar.toml file"
       end
 
-      fed_server_url = TomlRB.parse(domain_req.body)["FEDERATION_SERVER"]
+      fed_server_url = Tomlrb.parse(domain_req.body)["FEDERATION_SERVER"]
       if fed_server_url.nil?
         raise InvalidStellarTOML, "Invalid Stellar TOML file"
       end

data/lib/stellar-sdk.rb

@@ -1,23 +1,13 @@
 require "stellar-base"
+require "stellar-horizon"
 
 module Stellar
   module SDK
     VERSION = ::Stellar::VERSION
   end
+  Client = Horizon::Client
 
   autoload :Amount
-  autoload :Client
   autoload :Federation
   autoload :SEP10
-
-  module Horizon
-    extend ActiveSupport::Autoload
-
-    autoload :Problem
-    autoload :Result
-  end
-
-  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.29.0
+  version: 0.30.0
 platform: ruby
 authors:
 - Scott Fleckenstein
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-07 00:00:00.000000000 Z
+date: 2021-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stellar-base
@@ -18,61 +18,55 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.29.0
+        version: 0.30.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.29.0
+        version: 0.30.0
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: stellar-horizon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0
-    - - "<"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: 0.30.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0
-    - - "<"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: 0.30.0
 - !ruby/object:Gem::Dependency
-  name: excon
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.71.0
+        version: 5.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.71.0
+        version: 5.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: hyperclient
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 1.6.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -82,17 +76,17 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 1.6.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: toml-rb
+  name: tomlrb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 2.0.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
@@ -102,7 +96,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 2.0.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
@@ -161,23 +155,18 @@ files:
 - LICENSE
 - README.md
 - lib/stellar-sdk.rb
-- lib/stellar/amount.rb
-- lib/stellar/client.rb
-- lib/stellar/compat.rb
 - lib/stellar/federation.rb
-- lib/stellar/horizon/problem.rb
 - lib/stellar/sep10.rb
-- lib/stellar/transaction_page.rb
 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/
+  changelog_uri: https://github.com/astroband/ruby-stellar-sdk/blob/v0.30.0/sdk/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/stellar-sdk/0.30.0/
   github_repo: ssh://github.com/astroband/ruby-stellar-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
+  source_code_uri: https://github.com/astroband/ruby-stellar-sdk/tree/v0.30.0/sdk
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -193,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Stellar client library

data/lib/stellar/amount.rb

@@ -1,36 +0,0 @@
-module Stellar
-  class Amount
-    attr_reader :amount
-    attr_reader :asset
-
-    # @param [Fixnum] amount
-    # @param [Stellar::Asset] asset
-    def initialize(amount, asset = Stellar::Asset.native)
-      # TODO: how are we going to handle decimal considerations?
-
-      @amount = amount
-      @asset = asset
-    end
-
-    # @return [Array(Symbol, Fixnum)] in case of a native asset
-    # @return [Array(Symbol, String, Stellar::KeyPair, Fixnum)] in case of alphanum asset
-    def to_payment
-      case asset.type
-      when AssetType.asset_type_native
-        [:native, amount]
-      when AssetType.asset_type_credit_alphanum4
-        keypair = KeyPair.from_public_key(asset.issuer.value)
-        [:alphanum4, asset.code, keypair, amount]
-      when AssetType.asset_type_credit_alphanum12
-        keypair = KeyPair.from_public_key(asset.issuer.value)
-        [:alphanum12, asset.code, keypair, amount]
-      else
-        raise "Unknown asset type: #{asset.type}"
-      end
-    end
-
-    def inspect
-      "#<Stellar::Amount #{asset}(#{amount})>"
-    end
-  end
-end

data/lib/stellar/client.rb

@@ -1,300 +0,0 @@
-require "hyperclient"
-require "active_support/core_ext/object/blank"
-require "securerandom"
-
-module Stellar
-  class AccountRequiresMemoError < StandardError
-    attr_reader :account_id, :operation_index
-
-    def initialize(message, account_id, operation_index)
-      super(message)
-      @account_id = account_id
-      @operation_index = operation_index
-    end
-  end
-
-  class Client
-    DEFAULT_FEE = 100
-
-    HORIZON_LOCALHOST_URL = "http://127.0.0.1:8000"
-    HORIZON_MAINNET_URL = "https://horizon.stellar.org"
-    HORIZON_TESTNET_URL = "https://horizon-testnet.stellar.org"
-    FRIENDBOT_URL = "https://friendbot.stellar.org".freeze
-
-    def self.default(options = {})
-      new options.merge(
-        horizon: HORIZON_MAINNET_URL
-      )
-    end
-
-    def self.default_testnet(options = {})
-      new options.merge(
-        horizon: HORIZON_TESTNET_URL,
-        friendbot: HORIZON_TESTNET_URL
-      )
-    end
-
-    def self.localhost(options = {})
-      new options.merge(
-        horizon: HORIZON_LOCALHOST_URL
-      )
-    end
-
-    attr_reader :horizon
-
-    # @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|
-          conn.use Faraday::Response::RaiseError
-          conn.use FaradayMiddleware::FollowRedirects
-          conn.request :url_encoded
-          conn.response :hal_json, content_type: /\bjson$/
-          conn.adapter :excon
-        end
-        client.headers = {
-          "Accept" => "application/hal+json,application/problem+json,application/json",
-          "X-Client-Name" => "ruby-stellar-sdk",
-          "X-Client-Version" => VERSION
-        }
-      }
-    end
-
-    # @param [Stellar::Account|String] account_or_address
-    def account_info(account_or_address)
-      account_id = if account_or_address.is_a?(Stellar::Account)
-        account_or_address.address
-      else
-        account_or_address
-      end
-      @horizon.account(account_id: account_id)._get
-    end
-
-    # @option options [Stellar::Account] :account
-    # @option options [Stellar::Account] :destination
-    def account_merge(options = {})
-      account = options[:account]
-      destination = options[:destination]
-      sequence = options[:sequence] || (account_info(account).sequence.to_i + 1)
-
-      transaction = Stellar::TransactionBuilder.account_merge(
-        source_account: destination.keypair,
-        sequence_number: sequence,
-        destination: destination.keypair
-      )
-
-      envelope = transaction.to_envelope(account.keypair)
-      submit_transaction(tx_envelope: envelope)
-    end
-
-    def friendbot(account)
-      uri = URI.parse(FRIENDBOT_URL)
-      uri.query = "addr=#{account.address}"
-      Faraday.post(uri.to_s)
-    end
-
-    # @option options [Stellar::Account] :account
-    # @option options [Stellar::Account] :funder
-    # @option options [Integer] :starting_balance
-    def create_account(options = {})
-      funder = options[:funder]
-      sequence = options[:sequence] || (account_info(funder).sequence.to_i + 1)
-      # In the future, the fee should be grabbed from the network's last transactions,
-      # instead of using a hard-coded default value.
-      fee = options[:fee] || DEFAULT_FEE
-
-      payment = Stellar::TransactionBuilder.create_account(
-        source_account: funder.keypair,
-        sequence_number: sequence,
-        base_fee: fee,
-        destination: options[:account].keypair,
-        starting_balance: options[:starting_balance]
-      )
-      envelope = payment.to_envelope(funder.keypair)
-      submit_transaction(tx_envelope: envelope)
-    end
-
-    # @option options [Stellar::Account] :from The source account
-    # @option options [Stellar::Account] :to The destination account
-    # @option options [Stellar::Amount] :amount The amount to send
-    def send_payment(options = {})
-      from_account = options[:from]
-      tx_source_account = options[:transaction_source] || from_account
-      op_source_account = from_account if tx_source_account.present?
-
-      sequence = options[:sequence] ||
-        (account_info(tx_source_account).sequence.to_i + 1)
-
-      payment = Stellar::TransactionBuilder.new(
-        source_account: tx_source_account.keypair,
-        sequence_number: sequence
-      ).add_operation(
-        Stellar::Operation.payment(
-          source_account: op_source_account.keypair,
-          destination: options[:to].keypair,
-          amount: options[:amount].to_payment
-        )
-      ).set_memo(options[:memo]).set_timeout(0).build
-
-      signers = [tx_source_account, op_source_account].uniq(&:address)
-      to_envelope_args = signers.map(&:keypair)
-
-      envelope = payment.to_envelope(*to_envelope_args)
-      submit_transaction(tx_envelope: envelope)
-    end
-
-    # @option options [Stellar::Account] :account
-    # @option options [Integer] :limit
-    # @option options [Integer] :cursor
-    # @return [Stellar::TransactionPage]
-    def transactions(options = {})
-      args = options.slice(:limit, :cursor)
-
-      resource = if options[:account]
-        args = args.merge(account_id: options[:account].address)
-        @horizon.account_transactions(args)
-      else
-        @horizon.transactions(args)
-      end
-
-      TransactionPage.new(resource)
-    end
-
-    # @param [Array(Symbol,String,Stellar::KeyPair|Stellar::Account)] asset
-    # @param [Stellar::Account] source
-    # @param [Integer] sequence
-    # @param [Integer] fee
-    # @param [Integer] limit
-    def change_trust(
-      asset:,
-      source:,
-      sequence: nil,
-      fee: DEFAULT_FEE,
-      limit: nil
-    )
-      sequence ||= (account_info(source).sequence.to_i + 1)
-
-      op_args = {
-        account: source.keypair,
-        sequence: sequence,
-        line: asset
-      }
-      op_args[:limit] = limit unless limit.nil?
-
-      tx = Stellar::TransactionBuilder.change_trust(
-        source_account: source.keypair,
-        sequence_number: sequence,
-        **op_args
-      )
-
-      envelope = tx.to_envelope(source.keypair)
-      submit_transaction(tx_envelope: envelope)
-    end
-
-    # @param [Stellar::TransactionEnvelope] tx_envelope
-    # @option options [Boolean] :skip_memo_required_check (false)
-    def submit_transaction(tx_envelope:, options: {skip_memo_required_check: false})
-      unless options[:skip_memo_required_check]
-        check_memo_required(tx_envelope)
-      end
-      @horizon.transactions._post(tx: tx_envelope.to_xdr(:base64))
-    end
-
-    # Required by SEP-0029
-    # @param [Stellar::TransactionEnvelope] tx_envelope
-    def check_memo_required(tx_envelope)
-      tx = tx_envelope.tx
-
-      if tx.is_a?(Stellar::FeeBumpTransaction)
-        tx = tx.inner_tx.v1!.tx
-      end
-
-      # Check transactions where the .memo field is nil or of type MemoType.memo_none
-      if !tx.memo.nil? && tx.memo.type != Stellar::MemoType.memo_none
-        return
-      end
-
-      destinations = Set.new
-      ot = Stellar::OperationType
-
-      tx.operations.each_with_index do |op, idx|
-        destination = case op.body.type
-        when ot.payment, ot.path_payment_strict_receive, ot.path_payment_strict_send
-          op.body.value.destination
-        when ot.account_merge
-          # There is no AccountMergeOp, op.body is an Operation object
-          # and op.body.value is a PublicKey (or AccountID) object.
-          op.body.value
-        else
-          next
-        end
-
-        if destinations.include?(destination) || destination.switch == Stellar::CryptoKeyType.key_type_muxed_ed25519
-          next
-        end
-
-        destinations.add(destination)
-        kp = Stellar::KeyPair.from_public_key(destination.value)
-
-        begin
-          info = account_info(kp.address)
-        rescue Faraday::ResourceNotFound
-          # Don't raise an error if its a 404, but throw one otherwise
-          next
-        end
-        if info.data["config.memo_required"] == "MQ=="
-          # MQ== is the base64 encoded string for the string "1"
-          raise AccountRequiresMemoError.new("account requires memo", destination, idx)
-        end
-      end
-    end
-
-    # DEPRECATED: this function has been moved Stellar::SEP10.build_challenge_tx and
-    # will be removed in the next major version release.
-    #
-    # A wrapper function for Stellar::SEP10::build_challenge_tx.
-    #
-    # @param server [Stellar::KeyPair] Keypair for server's signing account.
-    # @param client [Stellar::KeyPair] Keypair for the account whishing to authenticate with the server.
-    # @param anchor_name [String] Anchor's name to be used in the manage_data key.
-    # @param timeout [Integer] Challenge duration (default to 5 minutes).
-    #
-    # @return [String] A base64 encoded string of the raw TransactionEnvelope xdr struct for the transaction.
-    def build_challenge_tx(server:, client:, anchor_name:, timeout: 300)
-      Stellar::SEP10.build_challenge_tx(
-        server: server, client: client, anchor_name: anchor_name, timeout: timeout
-      )
-    end
-
-    # DEPRECATED: this function has been moved to Stellar::SEP10::read_challenge_tx and
-    # will be removed in the next major version release.
-    #
-    # A wrapper function for Stellar::SEP10.verify_challenge_transaction
-    #
-    # @param challenge [String] SEP0010 transaction challenge in base64.
-    # @param server [Stellar::KeyPair] Stellar::KeyPair for server where the challenge was generated.
-    #
-    # @return [Boolean]
-    def verify_challenge_tx(challenge:, server:)
-      Stellar::SEP10.verify_challenge_tx(challenge_xdr: challenge, server: server)
-      true
-    end
-
-    # DEPRECATED: this function has been moved to Stellar::SEP10::verify_tx_signed_by and
-    # will be removed in the next major version release.
-    #
-    # @param transaction_envelope [Stellar::TransactionEnvelope]
-    # @param keypair [Stellar::KeyPair]
-    #
-    # @return [Boolean]
-    #
-    def verify_tx_signed_by(transaction_envelope:, keypair:)
-      Stellar::SEP10.verify_tx_signed_by(
-        tx_envelope: transaction_envelope, keypair: keypair
-      )
-    end
-  end
-end

data/lib/stellar/compat.rb

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

data/lib/stellar/horizon/problem.rb

@@ -1,45 +0,0 @@
-module Stellar
-  module Horizon
-    class Problem
-      def initialize(attributes)
-        @attributes = attributes.reverse_merge({
-          type: "about:blank",
-          title: "Unknown Error",
-          status: 500
-        })
-
-        @meta = @attributes.except!(:type, :title, :status, :detail, :instance)
-      end
-
-      # @return [String]
-      def type
-        @attributes[:type]
-      end
-
-      # @return [String]
-      def title
-        @attributes[:title]
-      end
-
-      # @return [Integer]
-      def status
-        @attributes[:status]
-      end
-
-      # @return [String]
-      def detail
-        @attributes[:detail]
-      end
-
-      # @return [String]
-      def instance
-        @attributes[:instance]
-      end
-
-      # @return [{String => Object}]
-      def meta
-        @attributes[:instance]
-      end
-    end
-  end
-end

data/lib/stellar/transaction_page.rb

@@ -1,25 +0,0 @@
-module Stellar
-  class TransactionPage
-    include Enumerable
-
-    # @param [Hyperclient::Link] resource
-    def initialize(resource)
-      @resource = resource
-    end
-
-    def each
-      @resource.records.each do |tx|
-        yield tx if block_given?
-      end
-    end
-
-    # @return [Stellar::TransactionPage]
-    def next_page
-      self.class.new(@resource.next)
-    end
-
-    def next_page!
-      @resource = @resource.next
-    end
-  end
-end