coinbase-sdk 0.0.14 → 0.0.16

data/lib/coinbase/staking_balance.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module Coinbase
+  # A representation of a staking balance on a network for a given asset.
+  class StakingBalance
+    # Returns a list of StakingBalance for the provided network, asset, and addresses.
+    # @param network_id [Symbol] The network ID
+    # @param asset_id [Symbol] The asset ID
+    # @param address_id [String] The address ID
+    # @param start_time [Time] The start time. Defaults to one month ago.
+    # @param end_time [Time] The end time. Defaults to the current time.
+    # @return [Enumerable<Coinbase::StakingBalance>] The staking balances
+    def self.list(network_id, asset_id, address_id, start_time: DateTime.now.prev_month(1), end_time: DateTime.now)
+      Coinbase::Pagination.enumerate(
+        ->(page) { list_page(network_id, asset_id, address_id, start_time, end_time, page) }
+      ) do |staking_balance|
+        new(staking_balance)
+      end
+    end
+
+    # Returns a new StakingBalance object.
+    # @param model [Coinbase::Client::StakingBalance] The underlying StakingBalance object
+    def initialize(model)
+      @model = model
+    end
+
+    # Returns the date of the StakingBalance.
+    # @return [Time] The date
+    def date
+      @model.date
+    end
+
+    # Returns the onchain address of the StakingBalance.
+    # @return [Time] The onchain address
+    def address
+      @model.address
+    end
+
+    # Returns the bonded stake as a Balance
+    # @return [Balance] The bonded stake
+    def bonded_stake
+      @bonded_stake ||= Balance.from_model(@model.bonded_stake)
+    end
+
+    # Returns the unbonded balance as a Balance
+    # @return [Balance] The unbonded balance
+    def unbonded_balance
+      @unbonded_balance ||= Balance.from_model(@model.unbonded_balance)
+    end
+
+    # Returns the participant type of the StakingBalance.
+    # @return [String] The participant type
+    def participant_type
+      @model.participant_type
+    end
+
+    # Returns a string representation of the StakingBalance.
+    # @return [String] a string representation of the StakingBalance
+    def to_s
+      "Coinbase::StakingBalance{date: '#{date}' address: '#{address}'}"
+    end
+
+    # Same as to_s.
+    # @return [String] a string representation of the StakingBalance
+    def inspect
+      to_s
+    end
+
+    def self.stake_api
+      Coinbase::Client::StakeApi.new(Coinbase.configuration.api_client)
+    end
+
+    def self.list_page(network_id, asset_id, address_id, start_time, end_time, page)
+      stake_api.fetch_historical_staking_balances(
+        Coinbase.normalize_network(network_id),
+        asset_id,
+        address_id,
+        start_time.iso8601,
+        end_time.iso8601,
+        { next_page: page }
+      )
+    end
+  end
+end

data/lib/coinbase/staking_reward.rb

@@ -53,6 +53,24 @@ module Coinbase
       @model.address_id
     end
 
+    # Returns the USD value of the StakingReward.
+    # @return [BigDecimal] The USD value
+    def usd_value
+      BigDecimal(@model.usd_value.amount.to_i) / BigDecimal(100)
+    end
+
+    # Returns the USD conversion price of the StakingReward.
+    # @return [BigDecimal] The USD conversion price
+    def usd_conversion_price
+      BigDecimal(@model.usd_value.conversion_price.to_i) / BigDecimal(100)
+    end
+
+    # Returns the USD conversion time of the StakingReward.
+    # @return [Time] The USD conversion time
+    def usd_conversion_time
+      @model.usd_value.conversion_time
+    end
+
     # Returns a string representation of the StakingReward.
     # @return [String] a string representation of the StakingReward
     def to_s

data/lib/coinbase/transaction.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'constants'
-require 'bigdecimal'
 require 'eth'
 require 'json'
 
@@ -113,12 +111,18 @@ module Coinbase
       @raw = Eth::Tx::Eip1559.new(Eth::Tx.validate_eip1559_params(params))
     end
 
+    # Returns the signature of the Transaction.
+    # @return [String] The hex-encode signature
+    def signature
+      raw.hex
+    end
+
     # Signs the Transaction with the provided key and returns the hex signing payload.
     # @return [String] The hex-encoded signed payload
     def sign(key)
       raw.sign(key)
 
-      raw.hex
+      signature
     end
 
     # Returns whether the Transaction has been signed.

data/lib/coinbase/transfer.rb

@@ -3,7 +3,6 @@
 require_relative 'constants'
 require 'bigdecimal'
 require 'eth'
-require 'json'
 
 module Coinbase
   # A representation of a Transfer, which moves an amount of an Asset from
@@ -25,7 +24,7 @@ module Coinbase
       # @param wallet_id [String] The Wallet ID of the sending Wallet
       # @return [Transfer] The new pending Transfer object
       # @raise [Coinbase::ApiError] If the Transfer fails
-      def create(address_id:, amount:, asset_id:, destination:, network_id:, wallet_id:)
+      def create(address_id:, amount:, asset_id:, destination:, network_id:, wallet_id:, gasless: false)
         asset = Asset.fetch(network_id, asset_id)
 
         model = Coinbase.call_api do
@@ -36,7 +35,8 @@ module Coinbase
               amount: asset.to_atomic_amount(amount).to_i.to_s,
               asset_id: asset.primary_denomination.to_s,
               destination: Coinbase::Destination.new(destination, network_id: network_id).address_id,
-              network_id: Coinbase.normalize_network(network_id)
+              network_id: Coinbase.normalize_network(network_id),
+              gasless: gasless
             }
           )
         end
@@ -122,40 +122,52 @@ module Coinbase
       BigDecimal(@model.amount) / BigDecimal(10).power(@model.asset.decimals)
     end
 
-    # Returns the link to the transaction on the blockchain explorer.
-    # @return [String] The link to the transaction on the blockchain explorer
-    def transaction_link
-      transaction.transaction_link
-    end
+    # Signs the Transfer with the given key. This is required before broadcasting the Transfer.
+    # @param key [Eth::Key] The key to sign the Transfer with
+    # @raise [RuntimeError] If the key is not an Eth::Key
+    # @return [Transfer] The Transfer object
+    def sign(key)
+      raise unless key.is_a?(Eth::Key)
 
-    # Returns the Unsigned Payload of the Transfer.
-    # @return [String] The Unsigned Payload
-    def unsigned_payload
-      transaction.unsigned_payload
-    end
+      unless sponsored_send.nil?
+        sponsored_send.sign(key)
+
+        return
+      end
 
-    # Returns the Signed Payload of the Transfer.
-    # @return [String] The Signed Payload
-    def signed_payload
-      transaction.signed_payload
+      transaction.sign(key)
+
+      self
     end
 
     # Returns the Transfer transaction.
     # @return [Coinbase::Transaction] The Transfer transaction
     def transaction
-      @transaction ||= Coinbase::Transaction.new(@model.transaction)
+      @transaction ||= @model.transaction.nil? ? nil : Coinbase::Transaction.new(@model.transaction)
     end
 
-    # Returns the Transaction Hash of the Transfer.
-    # @return [String] The Transaction Hash
-    def transaction_hash
-      transaction.transaction_hash
+    # Returns the SponsoredSend of the Transfer, if the transfer is gasless.
+    # @return [Coinbase::SponsoredSend] The SponsoredSend object
+    def sponsored_send
+      @sponsored_send ||= @model.sponsored_send.nil? ? nil : Coinbase::SponsoredSend.new(@model.sponsored_send)
     end
 
     # Returns the status of the Transfer.
     # @return [Symbol] The status
     def status
-      transaction.status
+      send_tx_delegate.status
+    end
+
+    # Returns the link to the transaction on the blockchain explorer.
+    # @return [String] The link to the transaction on the blockchain explorer
+    def transaction_link
+      send_tx_delegate.transaction_link
+    end
+
+    # Returns the Transaction Hash of the Transfer.
+    # @return [String] The Transaction Hash
+    def transaction_hash
+      send_tx_delegate.transaction_hash
     end
 
     # Broadcasts the Transfer to the Network.
@@ -163,18 +175,19 @@ module Coinbase
     # @raise [RuntimeError] If the Transfer is not signed
     # @return [Transfer] The Transfer object
     def broadcast!
-      raise TransactionNotSignedError unless transaction.signed?
+      raise TransactionNotSignedError unless send_tx_delegate.signed?
 
       @model = Coinbase.call_api do
         transfers_api.broadcast_transfer(
           wallet_id,
           from_address_id,
           id,
-          { signed_payload: transaction.raw.hex }
+          { signed_payload: send_tx_delegate.signature }
         )
       end
 
-      update_transaction(@model)
+      update_transaction(@model) unless @model.transaction.nil?
+      update_sponsored_send(@model) unless @model.sponsored_send.nil?
 
       self
     end
@@ -186,7 +199,8 @@ module Coinbase
         transfers_api.get_transfer(wallet_id, from_address_id, id)
       end
 
-      update_transaction(@model)
+      update_transaction(@model) unless @model.transaction.nil?
+      update_sponsored_send(@model) unless @model.sponsored_send.nil?
 
       self
     end
@@ -202,7 +216,7 @@ module Coinbase
       loop do
         reload
 
-        return self if transaction.terminal_state?
+        return self if terminal_state?
 
         raise Timeout::Error, 'Transfer timed out' if Time.now - start_time > timeout_seconds
 
@@ -229,6 +243,16 @@ module Coinbase
 
     private
 
+    def terminal_state?
+      send_tx_delegate.terminal_state?
+    end
+
+    def send_tx_delegate
+      return sponsored_send unless sponsored_send.nil?
+
+      transaction
+    end
+
     def transfers_api
       @transfers_api ||= Coinbase::Client::TransfersApi.new(Coinbase.configuration.api_client)
     end
@@ -236,5 +260,9 @@ module Coinbase
     def update_transaction(model)
       @transaction = Coinbase::Transaction.new(model.transaction)
     end
+
+    def update_sponsored_send(model)
+      @sponsored_send = Coinbase::SponsoredSend.new(model.sponsored_send)
+    end
   end
 end

data/lib/coinbase/wallet/data.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Coinbase
+  class Wallet
+    # The data required to recreate a Wallet.
+    class Data
+      attr_reader :wallet_id, :seed
+
+      # Returns a new Data object.
+      # @param wallet_id [String] The ID of the Wallet
+      # @param seed [String] The seed of the Wallet
+      def initialize(wallet_id:, seed:)
+        @wallet_id = wallet_id
+        @seed = seed
+      end
+
+      # Converts the Data object to a Hash.
+      # @return [Hash] The Hash representation of the Data object
+      def to_hash
+        { wallet_id: wallet_id, seed: seed }
+      end
+
+      # Creates a Data object from the given Hash.
+      # @param data [Hash] The Hash to create the Data object from
+      # @return [Data] The new Data object
+      def self.from_hash(data)
+        Data.new(wallet_id: data['wallet_id'], seed: data['seed'])
+      end
+    end
+  end
+end

data/lib/coinbase/wallet.rb

@@ -5,6 +5,8 @@ require 'json'
 require 'money-tree'
 require 'securerandom'
 
+require_relative 'wallet/data'
+
 module Coinbase
   # A representation of a Wallet. Wallets come with a single default Address, but can expand to have a set of Addresses,
   # each of which can hold a balance of one or more Assets. Wallets can create new Addresses, list their addresses,
@@ -13,17 +15,6 @@ module Coinbase
     # The maximum number of addresses in a Wallet.
     MAX_ADDRESSES = 20
 
-    # A representation of ServerSigner status in a Wallet.
-    module ServerSignerStatus
-      # The Wallet is awaiting seed creation by the ServerSigner. At this point,
-      # the Wallet cannot create addresses or sign transactions.
-      PENDING = 'pending_seed_creation'
-
-      # The Wallet has an associated seed created by the ServerSigner. It is ready
-      # to create addresses and sign transactions.
-      ACTIVE = 'active_seed'
-    end
-
     class << self
       # Imports a Wallet from previously exported wallet data.
       # @param data [Coinbase::Wallet::Data] the Wallet data to import
@@ -43,7 +34,7 @@ module Coinbase
       # converted to an array, etc...
       # @return [Enumerable<Coinbase::Wallet>] Enumerator that returns wallets
       def list
-        Coinbase::Pagination.enumerate(lambda(&method(:fetch_wallets_page))) do |wallet|
+        Coinbase::Pagination.enumerate(method(:fetch_wallets_page)) do |wallet|
           Coinbase::Wallet.new(wallet, seed: '')
         end
       end
@@ -107,7 +98,7 @@ module Coinbase
             wallets_api.get_wallet(wallet_id)
           end
 
-          return self if model.server_signer_status == ServerSignerStatus::ACTIVE
+          return self if model.server_signer_status == ServerSigner::Status::ACTIVE
 
           if Time.now - start_time > timeout_seconds
             raise Timeout::Error, 'Wallet creation timed out. Check status of your Server-Signer'
@@ -278,9 +269,15 @@ module Coinbase
     # @param asset_id [Symbol] The ID of the Asset to send
     # @param destination [Wallet | Address | String] The destination of the transfer. If a Wallet, sends to the Wallet's
     #  default address. If a String, interprets it as the address ID.
+    # @param gasless [Boolean] Whether gas fee for the transfer should be covered by Coinbase.
+    #   Defaults to false. Check the API documentation for network and asset support.
     # @return [Coinbase::Transfer] The Transfer object.
-    def transfer(amount, asset_id, destination)
-      default_address.transfer(amount, asset_id, destination)
+    def transfer(amount, asset_id, destination, options = {})
+      # For ruby 2.7 compatibility we cannot pass in keyword args when the create wallet
+      # options is empty
+      return default_address.transfer(amount, asset_id, destination) if options.empty?
+
+      default_address.transfer(amount, asset_id, destination, **options)
     end
 
     # Trades the given amount of the given Asset for another Asset.
@@ -371,7 +368,7 @@ module Coinbase
     end
 
     # Exports the Wallet's data to a Data object.
-    # @return [Data] The Wallet data
+    # @return [Coinbase::Wallet::Data] The Wallet data
     def export
       # TODO: Improve this check by relying on the backend data to decide whether a wallet is server-signer backed.
       raise 'Cannot export data for Server-Signer backed Wallet' if Coinbase.use_server_signer?
@@ -433,9 +430,7 @@ module Coinbase
         iv: iv
       }
 
-      File.open(file_path, 'w') do |file|
-        file.write(JSON.pretty_generate(existing_seeds_in_store))
-      end
+      File.write(file_path, JSON.pretty_generate(existing_seeds_in_store))
 
       "Successfully saved seed for wallet #{id} to #{file_path}."
     end
@@ -492,32 +487,6 @@ module Coinbase
       to_s
     end
 
-    # The data required to recreate a Wallet.
-    class Data
-      attr_reader :wallet_id, :seed
-
-      # Returns a new Data object.
-      # @param wallet_id [String] The ID of the Wallet
-      # @param seed [String] The seed of the Wallet
-      def initialize(wallet_id:, seed:)
-        @wallet_id = wallet_id
-        @seed = seed
-      end
-
-      # Converts the Data object to a Hash.
-      # @return [Hash] The Hash representation of the Data object
-      def to_hash
-        { wallet_id: wallet_id, seed: seed }
-      end
-
-      # Creates a Data object from the given Hash.
-      # @param data [Hash] The Hash to create the Data object from
-      # @return [Data] The new Data object
-      def self.from_hash(data)
-        Data.new(wallet_id: data['wallet_id'], seed: data['seed'])
-      end
-    end
-
     private
 
     # Reloads the Wallet with the latest data.
@@ -540,7 +509,7 @@ module Coinbase
     def address_path_prefix
       # TODO: Push this logic to the backend.
       @address_path_prefix ||= case network_id.to_s.split('_').first
-                               when 'base', 'ethereum'
+                               when 'base', 'ethereum', 'polygon'
                                  "m/44'/60'/0'/0"
                                else
                                  raise ArgumentError, "Unsupported network ID: #{network_id}"

data/lib/coinbase.rb

@@ -7,6 +7,7 @@ require_relative 'coinbase/asset'
 require_relative 'coinbase/authenticator'
 require_relative 'coinbase/balance'
 require_relative 'coinbase/balance_map'
+require_relative 'coinbase/historical_balance'
 require_relative 'coinbase/client'
 require_relative 'coinbase/constants'
 require_relative 'coinbase/destination'
@@ -21,6 +22,8 @@ require_relative 'coinbase/transaction'
 require_relative 'coinbase/user'
 require_relative 'coinbase/wallet'
 require_relative 'coinbase/server_signer'
+require_relative 'coinbase/sponsored_send'
+require_relative 'coinbase/staking_balance'
 require_relative 'coinbase/staking_operation'
 require_relative 'coinbase/staking_reward'
 require_relative 'coinbase/validator'
@@ -111,7 +114,7 @@ module Coinbase
   # @param network_sym [Symbol] the network symbol to convert
   # @return [String] the converted string
   def self.normalize_network(network_sym)
-    network_sym.to_s.gsub(/_/, '-')
+    network_sym.to_s.gsub('_', '-')
   end
 
   # Loads the default user.
@@ -128,8 +131,17 @@ module Coinbase
     yield
   rescue Coinbase::Client::ApiError => e
     raise Coinbase::APIError.from_error(e), cause: nil
-  rescue StandardError => e
-    raise e
+  end
+
+  # Returns a pretty-printed object string that contains the object's class name and
+  # the details of the object, filtering out nil values.
+  # @param klass [Class] the class of the object
+  # @param details [Hash] the details of the object
+  # @return [String] the pretty-printed object string
+  def self.pretty_print_object(klass, **details)
+    filtered_details = details.filter { |_, v| !v.nil? }.map { |k, v| "#{k}: '#{v}'" }
+
+    "#{klass}{#{filtered_details.join(', ')}}"
   end
 
   # Returns whether to use a server signer to manage private keys.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coinbase-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.16
 platform: ruby
 authors:
 - Yuga Cohler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-05 00:00:00.000000000 Z
+date: 2024-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +206,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.63.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -253,6 +281,7 @@ files:
 - lib/coinbase/client/api/assets_api.rb
 - lib/coinbase/client/api/contract_events_api.rb
 - lib/coinbase/client/api/external_addresses_api.rb
+- lib/coinbase/client/api/networks_api.rb
 - lib/coinbase/client/api/server_signers_api.rb
 - lib/coinbase/client/api/stake_api.rb
 - lib/coinbase/client/api/trades_api.rb
@@ -266,6 +295,7 @@ files:
 - lib/coinbase/client/configuration.rb
 - lib/coinbase/client/models/address.rb
 - lib/coinbase/client/models/address_balance_list.rb
+- lib/coinbase/client/models/address_historical_balance_list.rb
 - lib/coinbase/client/models/address_list.rb
 - lib/coinbase/client/models/asset.rb
 - lib/coinbase/client/models/balance.rb
@@ -284,13 +314,21 @@ files:
 - lib/coinbase/client/models/create_wallet_request_wallet.rb
 - lib/coinbase/client/models/create_webhook_request.rb
 - lib/coinbase/client/models/error.rb
+- lib/coinbase/client/models/ethereum_validator.rb
 - lib/coinbase/client/models/ethereum_validator_metadata.rb
 - lib/coinbase/client/models/faucet_transaction.rb
 - lib/coinbase/client/models/feature.rb
+- lib/coinbase/client/models/feature_set.rb
+- lib/coinbase/client/models/fetch_historical_staking_balances200_response.rb
 - lib/coinbase/client/models/fetch_staking_rewards200_response.rb
 - lib/coinbase/client/models/fetch_staking_rewards_request.rb
 - lib/coinbase/client/models/get_staking_context_request.rb
+- lib/coinbase/client/models/get_validator200_response.rb
+- lib/coinbase/client/models/get_validator200_response_validator.rb
+- lib/coinbase/client/models/historical_balance.rb
 - lib/coinbase/client/models/native_eth_staking_context.rb
+- lib/coinbase/client/models/network.rb
+- lib/coinbase/client/models/network_identifier.rb
 - lib/coinbase/client/models/partial_eth_staking_context.rb
 - lib/coinbase/client/models/seed_creation_event.rb
 - lib/coinbase/client/models/seed_creation_event_result.rb
@@ -302,12 +340,15 @@ files:
 - lib/coinbase/client/models/signature_creation_event.rb
 - lib/coinbase/client/models/signature_creation_event_result.rb
 - lib/coinbase/client/models/signed_voluntary_exit_message_metadata.rb
+- lib/coinbase/client/models/sponsored_send.rb
+- lib/coinbase/client/models/staking_balance.rb
 - lib/coinbase/client/models/staking_context.rb
 - lib/coinbase/client/models/staking_context_context.rb
 - lib/coinbase/client/models/staking_operation.rb
 - lib/coinbase/client/models/staking_operation_metadata.rb
 - lib/coinbase/client/models/staking_reward.rb
 - lib/coinbase/client/models/staking_reward_format.rb
+- lib/coinbase/client/models/staking_reward_usd_value.rb
 - lib/coinbase/client/models/trade.rb
 - lib/coinbase/client/models/trade_list.rb
 - lib/coinbase/client/models/transaction.rb
@@ -319,6 +360,7 @@ files:
 - lib/coinbase/client/models/validator.rb
 - lib/coinbase/client/models/validator_details.rb
 - lib/coinbase/client/models/validator_list.rb
+- lib/coinbase/client/models/validator_list_data.rb
 - lib/coinbase/client/models/wallet.rb
 - lib/coinbase/client/models/wallet_list.rb
 - lib/coinbase/client/models/webhook.rb
@@ -330,10 +372,13 @@ files:
 - lib/coinbase/destination.rb
 - lib/coinbase/errors.rb
 - lib/coinbase/faucet_transaction.rb
+- lib/coinbase/historical_balance.rb
 - lib/coinbase/middleware.rb
 - lib/coinbase/network.rb
 - lib/coinbase/pagination.rb
 - lib/coinbase/server_signer.rb
+- lib/coinbase/sponsored_send.rb
+- lib/coinbase/staking_balance.rb
 - lib/coinbase/staking_operation.rb
 - lib/coinbase/staking_reward.rb
 - lib/coinbase/trade.rb
@@ -342,6 +387,7 @@ files:
 - lib/coinbase/user.rb
 - lib/coinbase/validator.rb
 - lib/coinbase/wallet.rb
+- lib/coinbase/wallet/data.rb
 homepage: https://github.com/coinbase/coinbase-sdk-ruby
 licenses:
 - Apache-2.0