coinbase-sdk 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c18b015a028c3b795a618318ab244f31d58861f66f67e6d76a7b70ee3b664e2f
-  data.tar.gz: c82577524824f743ac16624ffc042c2017183d366a5c849d1baa3d2028b85c96
+  metadata.gz: d4413913708fadc44dcbb49a00a72fe55382187c8084531b9cec43894e0ee9a0
+  data.tar.gz: e47f6295ce5f8bc1d8888b49ba71cdbc1558d606e708e66452f0ae6a76127249
 SHA512:
-  metadata.gz: 92efa9bc82a0d753698bae8de9e60768c696ce6ef5019cbb3eab6ae7bd25d9257f289dd95164a6440a7f25f0cd90b02a0d267b07ea1d82ebe6b0d4cb142fe82f
-  data.tar.gz: 204120f5e22ec7bfd4b87f0e09bdd8600740106d11a0e7d04264d39f650b8a1154472de209537da510cef03daeb669e6a84c5ee5f212c82d9eda66207f5f8e81
+  metadata.gz: acb6233add651f82063b7f2a73da8b7a8112687603d61fb77f3160713d813ea07447e25b5b69e83dd81c1852478c1b9999c1b207c9137ae08868db495721181b
+  data.tar.gz: 3b72b12e92386e7114e0146f257032b904a4f26a2a97369bff19c1bc722b195372c830a2bb405e1a2f2655c81608beeee8d601deab293f87c1adf5fb18ca64e9

data/lib/coinbase/address.rb

@@ -35,40 +35,32 @@ module Coinbase
 
     # Returns the Address ID.
     # @return [String] The Address ID
-    def address_id
+    def id
       @model.address_id
     end
 
     # Returns the balances of the Address.
     # @return [BalanceMap] The balances of the Address, keyed by asset ID. Ether balances are denominated
     #  in ETH.
-    def list_balances
-      response = addresses_api.list_address_balances(wallet_id, address_id)
-      Coinbase.to_balance_map(response)
+    def balances
+      response = Coinbase.call_api do
+        addresses_api.list_address_balances(wallet_id, id)
+      end
+
+      Coinbase::BalanceMap.from_balances(response.data)
     end
 
     # Returns the balance of the provided Asset.
     # @param asset_id [Symbol] The Asset to retrieve the balance for
     # @return [BigDecimal] The balance of the Asset
-    def get_balance(asset_id)
-      normalized_asset_id = normalize_asset_id(asset_id)
-
-      response = addresses_api.get_address_balance(wallet_id, address_id, normalized_asset_id.to_s)
+    def balance(asset_id)
+      response = Coinbase.call_api do
+        addresses_api.get_address_balance(wallet_id, id, Coinbase::Asset.primary_denomination(asset_id).to_s)
+      end
 
       return BigDecimal('0') if response.nil?
 
-      amount = BigDecimal(response.amount)
-
-      case asset_id
-      when :eth
-        amount / BigDecimal(Coinbase::WEI_PER_ETHER.to_s)
-      when :gwei
-        amount / BigDecimal(Coinbase::GWEI_PER_ETHER.to_s)
-      when :usdc
-        amount / BigDecimal(Coinbase::ATOMIC_UNITS_PER_USDC.to_s)
-      else
-        amount
-      end
+      Coinbase::Balance.from_model_and_asset_id(response, asset_id).amount
     end
 
     # Transfers the given amount of the given Asset to the given address. Only same-Network Transfers are supported.
@@ -78,83 +70,105 @@ module Coinbase
     #  default address. If a String, interprets it as the address ID.
     # @return [String] The hash of the Transfer transaction.
     def transfer(amount, asset_id, destination)
-      raise ArgumentError, "Unsupported asset: #{asset_id}" unless Coinbase::SUPPORTED_ASSET_IDS[asset_id]
+      raise ArgumentError, "Unsupported asset: #{asset_id}" unless Coinbase::Asset.supported?(asset_id)
 
       if destination.is_a?(Wallet)
         raise ArgumentError, 'Transfer must be on the same Network' if destination.network_id != network_id
 
-        destination = destination.default_address.address_id
+        destination = destination.default_address.id
       elsif destination.is_a?(Address)
         raise ArgumentError, 'Transfer must be on the same Network' if destination.network_id != network_id
 
-        destination = destination.address_id
+        destination = destination.id
       end
 
-      current_balance = get_balance(asset_id)
+      current_balance = balance(asset_id)
       if current_balance < amount
         raise ArgumentError, "Insufficient funds: #{amount} requested, but only #{current_balance} available"
       end
 
-      normalized_amount = normalize_asset_amount(amount, asset_id)
-
-      normalized_asset_id = normalize_asset_id(asset_id)
-
       create_transfer_request = {
-        amount: normalized_amount.to_i.to_s,
+        amount: Coinbase::Asset.to_atomic_amount(amount, asset_id).to_i.to_s,
         network_id: network_id,
-        asset_id: normalized_asset_id.to_s,
+        asset_id: Coinbase::Asset.primary_denomination(asset_id).to_s,
         destination: destination
       }
 
-      transfer_model = transfers_api.create_transfer(wallet_id, address_id, create_transfer_request)
+      transfer_model = Coinbase.call_api do
+        transfers_api.create_transfer(wallet_id, id, create_transfer_request)
+      end
 
       transfer = Coinbase::Transfer.new(transfer_model)
 
       transaction = transfer.transaction
       transaction.sign(@key)
-      Coinbase.configuration.base_sepolia_client.eth_sendRawTransaction("0x#{transaction.hex}")
 
-      transfer
+      signed_payload = transaction.hex
+
+      broadcast_transfer_request = {
+        signed_payload: signed_payload
+      }
+
+      transfer_model = Coinbase.call_api do
+        transfers_api.broadcast_transfer(wallet_id, id, transfer.id, broadcast_transfer_request)
+      end
+
+      Coinbase::Transfer.new(transfer_model)
     end
 
-    # Returns the address as a string.
-    # @return [String] The address
+    # Returns a String representation of the Address.
+    # @return [String] a String representation of the Address
     def to_s
-      address_id
+      "Coinbase::Address{id: '#{id}', network_id: '#{network_id}', wallet_id: '#{wallet_id}'}"
     end
 
-    private
+    # Same as to_s.
+    # @return [String] a String representation of the Address
+    def inspect
+      to_s
+    end
 
-    # Normalizes the amount of the Asset to send to the atomic unit.
-    # @param amount [Integer, Float, BigDecimal] The amount to normalize
-    # @param asset_id [Symbol] The ID of the Asset being transferred
-    # @return [BigDecimal] The normalized amount in atomic units
-    def normalize_asset_amount(amount, asset_id)
-      big_amount = BigDecimal(amount.to_s)
-
-      case asset_id
-      when :eth
-        big_amount * Coinbase::WEI_PER_ETHER
-      when :gwei
-        big_amount * Coinbase::WEI_PER_GWEI
-      when :usdc
-        big_amount * Coinbase::ATOMIC_UNITS_PER_USDC
-      else
-        big_amount
+    # Requests funds for the address from the faucet and returns the faucet transaction.
+    # This is only supported on testnet networks.
+    # @return [Coinbase::FaucetTransaction] The successful faucet transaction
+    # @raise [Coinbase::FaucetLimitReachedError] If the faucet limit has been reached for the address or user.
+    # @raise [Coinbase::Client::ApiError] If an unexpected error occurs while requesting faucet funds.
+    def faucet
+      Coinbase.call_api do
+        Coinbase::FaucetTransaction.new(addresses_api.request_faucet_funds(wallet_id, id))
       end
     end
 
-    # Normalizes the asset ID to use during requests.
-    # @param asset_id [Symbol] The asset ID to normalize
-    # @return [Symbol] The normalized asset ID
-    def normalize_asset_id(asset_id)
-      if %i[wei gwei].include?(asset_id)
-        :eth
-      else
-        asset_id
+    # Exports the Address's private key to a hex string.
+    # @return [String] The Address's private key as a hex String
+    def export
+      @key.private_hex
+    end
+
+    # Returns all of the transfers associated with the address.
+    # @return [Array<Coinbase::Transfer>] The transfers associated with the address
+    def transfers
+      transfers = []
+      page = nil
+
+      loop do
+        puts "fetch transfers page: #{page}"
+        response = Coinbase.call_api do
+          transfers_api.list_transfers(wallet_id, id, { limit: 100, page: page })
+        end
+
+        transfers.concat(response.data.map { |transfer| Coinbase::Transfer.new(transfer) }) if response.data
+
+        break unless response.has_more
+
+        page = response.next_page
       end
+
+      transfers
     end
 
+    private
+
     def addresses_api
       @addresses_api ||= Coinbase::Client::AddressesApi.new(Coinbase.configuration.api_client)
     end

data/lib/coinbase/asset.rb

@@ -3,7 +3,63 @@
 module Coinbase
   # A representation of an Asset.
   class Asset
-    attr_reader :network_id, :asset_id, :display_name, :address_id
+    # Retuns whether the provided asset ID is supported.
+    # @param asset_id [Symbol] The Asset ID
+    # @return [Boolean] Whether the Asset ID is supported
+    def self.supported?(asset_id)
+      !!Coinbase::SUPPORTED_ASSET_IDS[asset_id]
+    end
+
+    # Converts the amount of the Asset to the atomic units of the primary denomination of the Asset.
+    # @param amount [Integer, Float, BigDecimal] The amount to normalize
+    # @param asset_id [Symbol] The ID of the Asset being transferred
+    # @return [BigDecimal] The normalized amount in atomic units
+    def self.to_atomic_amount(amount, asset_id)
+      case asset_id
+      when :eth
+        amount * BigDecimal(Coinbase::WEI_PER_ETHER.to_s)
+      when :gwei
+        amount * BigDecimal(Coinbase::WEI_PER_GWEI.to_s)
+      when :usdc
+        amount * BigDecimal(Coinbase::ATOMIC_UNITS_PER_USDC.to_s)
+      when :weth
+        amount * BigDecimal(Coinbase::WEI_PER_ETHER)
+      else
+        amount
+      end
+    end
+
+    # Converts an amount from the atomic value of the primary denomination of the provided Asset ID
+    # to whole units of the specified asset ID.
+    # @param atomic_amount [BigDecimal] The amount in atomic units
+    # @param asset_id [Symbol] The Asset ID
+    # @return [BigDecimal] The amount in whole units of the specified asset ID
+    def self.from_atomic_amount(atomic_amount, asset_id)
+      case asset_id
+      when :eth
+        atomic_amount / BigDecimal(Coinbase::WEI_PER_ETHER.to_s)
+      when :gwei
+        atomic_amount / BigDecimal(Coinbase::WEI_PER_GWEI.to_s)
+      when :usdc
+        atomic_amount / BigDecimal(Coinbase::ATOMIC_UNITS_PER_USDC.to_s)
+      when :weth
+        atomic_amount / BigDecimal(Coinbase::WEI_PER_ETHER)
+      else
+        atomic_amount
+      end
+    end
+
+    # Returns the primary denomination for the provided Asset ID.
+    # For assets with multiple denominations, e.g. eth can also be denominated in wei and gwei,
+    # this method will return the primary denomination.
+    # e.g. eth.
+    # @param asset_id [Symbol] The Asset ID
+    # @return [Symbol] The primary denomination for the Asset ID
+    def self.primary_denomination(asset_id)
+      return :eth if %i[wei gwei].include?(asset_id)
+
+      asset_id
+    end
 
     # Returns a new Asset object. Do not use this method. Instead, use the Asset constants defined in
     # the Coinbase module.
@@ -17,5 +73,20 @@ module Coinbase
       @display_name = display_name
       @address_id = address_id
     end
+
+    attr_reader :network_id, :asset_id, :display_name, :address_id
+
+    # Returns a string representation of the Asset.
+    # @return [String] a string representation of the Asset
+    def to_s
+      "Coinbase::Asset{network_id: '#{network_id}', asset_id: '#{asset_id}', display_name: '#{display_name}'" +
+        (address_id.nil? ? '}' : ", address_id: '#{address_id}'}")
+    end
+
+    # Same as to_s.
+    # @return [String] a string representation of the Balance
+    def inspect
+      to_s
+    end
   end
 end

data/lib/coinbase/balance.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Coinbase
+  # A representation of an Balance.
+  class Balance
+    # Converts a Coinbase::Client::Balance model to a Coinbase::Balance
+    # @param balance_model [Coinbase::Client::Balance] The balance fetched from the API.
+    # @return [Balance] The converted Balance object.
+    def self.from_model(balance_model)
+      asset_id = Coinbase.to_sym(balance_model.asset.asset_id.downcase)
+
+      from_model_and_asset_id(balance_model, asset_id)
+    end
+
+    # Converts a Coinbase::Client::Balance model and asset ID to a Coinbase::Balance
+    # This can be used to specify a non-primary denomination that we want the balance
+    # to be converted to.
+    # @param balance_model [Coinbase::Client::Balance] The balance fetched from the API.
+    # @param asset_id [Symbol] The Asset ID of the denomination we want returned.
+    # @return [Balance] The converted Balance object.
+    def self.from_model_and_asset_id(balance_model, asset_id)
+      new(
+        amount: Coinbase::Asset.from_atomic_amount(BigDecimal(balance_model.amount), asset_id),
+        asset_id: asset_id
+      )
+    end
+
+    # Returns a new Asset object. Do not use this method. Instead, use the Asset constants defined in
+    # the Coinbase module.
+    # @param network_id [Symbol] The ID of the Network to which the Asset belongs
+    # @param asset_id [Symbol] The Asset ID
+    # @param display_name [String] The Asset's display name
+    # @param address_id [String] (Optional) The Asset's address ID, if one exists
+    def initialize(amount:, asset_id:)
+      @amount = amount
+      @asset_id = asset_id
+    end
+
+    attr_reader :amount, :asset_id
+
+    # Returns a string representation of the Balance.
+    # @return [String] a string representation of the Balance
+    def to_s
+      "Coinbase::Balance{amount: '#{amount.to_i}', asset_id: '#{asset_id}'}"
+    end
+
+    # Same as to_s.
+    # @return [String] a string representation of the Balance
+    def inspect
+      to_s
+    end
+  end
+end

data/lib/coinbase/balance_map.rb

@@ -5,15 +5,27 @@ require 'bigdecimal'
 module Coinbase
   # A convenience class for printing out Asset balances in a human-readable format.
   class BalanceMap < Hash
-    # Returns a new BalanceMap object.
-    # @param hash [Map<Symbol, BigDecimal>] The hash to initialize with
-    def initialize(hash = {})
-      super()
-      hash.each do |key, value|
-        self[key] = value
+    # Converts a list of Coinbase::Client::Balance models to a Coinbase::BalanceMap.
+    # @param balances [Array<Coinbase::Client::Balance>] The list of balances fetched from the API.
+    # @return [BalanceMap] The converted BalanceMap object.
+    def self.from_balances(balances)
+      BalanceMap.new.tap do |balance_map|
+        balances.each do |balance_model|
+          balance = Coinbase::Balance.from_model(balance_model)
+
+          balance_map.add(balance)
+        end
       end
     end
 
+    # Adds a balance to the map.
+    # @param balance [Coinbase::Balance] The balance to add to the map.
+    def add(balance)
+      raise ArgumentError, 'balance must be a Coinbase::Balance' unless balance.is_a?(Coinbase::Balance)
+
+      self[balance.asset_id] = balance.amount
+    end
+
     # Returns a string representation of the balance map.
     # @return [String] The string representation of the balance
     def to_s
@@ -42,7 +54,7 @@ module Coinbase
         result[asset_id] = str
       end
 
-      result
+      result.to_s
     end
   end
 end

data/lib/coinbase/client/api/addresses_api.rb

@@ -381,5 +381,74 @@ module Coinbase::Client
       end
       return data, status_code, headers
     end
+
+    # Request faucet funds for onchain address.
+    # Request faucet funds to be sent to onchain address.
+    # @param wallet_id [String] The ID of the wallet the address belongs to.
+    # @param address_id [String] The onchain address of the address that is being fetched.
+    # @param [Hash] opts the optional parameters
+    # @return [FaucetTransaction]
+    def request_faucet_funds(wallet_id, address_id, opts = {})
+      data, _status_code, _headers = request_faucet_funds_with_http_info(wallet_id, address_id, opts)
+      data
+    end
+
+    # Request faucet funds for onchain address.
+    # Request faucet funds to be sent to onchain address.
+    # @param wallet_id [String] The ID of the wallet the address belongs to.
+    # @param address_id [String] The onchain address of the address that is being fetched.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FaucetTransaction, Integer, Hash)>] FaucetTransaction data, response status code and response headers
+    def request_faucet_funds_with_http_info(wallet_id, address_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AddressesApi.request_faucet_funds ...'
+      end
+      # verify the required parameter 'wallet_id' is set
+      if @api_client.config.client_side_validation && wallet_id.nil?
+        fail ArgumentError, "Missing the required parameter 'wallet_id' when calling AddressesApi.request_faucet_funds"
+      end
+      # verify the required parameter 'address_id' is set
+      if @api_client.config.client_side_validation && address_id.nil?
+        fail ArgumentError, "Missing the required parameter 'address_id' when calling AddressesApi.request_faucet_funds"
+      end
+      # resource path
+      local_var_path = '/v1/wallets/{wallet_id}/addresses/{address_id}/faucet'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'FaucetTransaction'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"AddressesApi.request_faucet_funds",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AddressesApi#request_faucet_funds\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/coinbase/client/api/transfers_api.rb

@@ -19,6 +19,92 @@ module Coinbase::Client
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Broadcast a transfer
+    # Broadcast a transfer
+    # @param wallet_id [String] The ID of the wallet the address belongs to
+    # @param address_id [String] The ID of the address the transfer belongs to
+    # @param transfer_id [String] The ID of the transfer to broadcast
+    # @param broadcast_transfer_request [BroadcastTransferRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Transfer]
+    def broadcast_transfer(wallet_id, address_id, transfer_id, broadcast_transfer_request, opts = {})
+      data, _status_code, _headers = broadcast_transfer_with_http_info(wallet_id, address_id, transfer_id, broadcast_transfer_request, opts)
+      data
+    end
+
+    # Broadcast a transfer
+    # Broadcast a transfer
+    # @param wallet_id [String] The ID of the wallet the address belongs to
+    # @param address_id [String] The ID of the address the transfer belongs to
+    # @param transfer_id [String] The ID of the transfer to broadcast
+    # @param broadcast_transfer_request [BroadcastTransferRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Transfer, Integer, Hash)>] Transfer data, response status code and response headers
+    def broadcast_transfer_with_http_info(wallet_id, address_id, transfer_id, broadcast_transfer_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TransfersApi.broadcast_transfer ...'
+      end
+      # verify the required parameter 'wallet_id' is set
+      if @api_client.config.client_side_validation && wallet_id.nil?
+        fail ArgumentError, "Missing the required parameter 'wallet_id' when calling TransfersApi.broadcast_transfer"
+      end
+      # verify the required parameter 'address_id' is set
+      if @api_client.config.client_side_validation && address_id.nil?
+        fail ArgumentError, "Missing the required parameter 'address_id' when calling TransfersApi.broadcast_transfer"
+      end
+      # verify the required parameter 'transfer_id' is set
+      if @api_client.config.client_side_validation && transfer_id.nil?
+        fail ArgumentError, "Missing the required parameter 'transfer_id' when calling TransfersApi.broadcast_transfer"
+      end
+      # verify the required parameter 'broadcast_transfer_request' is set
+      if @api_client.config.client_side_validation && broadcast_transfer_request.nil?
+        fail ArgumentError, "Missing the required parameter 'broadcast_transfer_request' when calling TransfersApi.broadcast_transfer"
+      end
+      # resource path
+      local_var_path = '/v1/wallets/{wallet_id}/addresses/{address_id}/transfers/{transfer_id}/broadcast'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_id.to_s)).sub('{' + 'transfer_id' + '}', CGI.escape(transfer_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(broadcast_transfer_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Transfer'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"TransfersApi.broadcast_transfer",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TransfersApi#broadcast_transfer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create a new transfer for an address
     # Create a new transfer
     # @param wallet_id [String] The ID of the wallet the source address belongs to