coinbase-sdk 0.0.7 → 0.0.8

data/lib/coinbase/constants.rb

@@ -4,41 +4,16 @@ require_relative 'asset'
 require_relative 'network'
 
 module Coinbase
-  # The Assets supported on Base Sepolia by the Coinbase SDK.
-  ETH = Asset.new(network_id: :base_sepolia, asset_id: :eth, display_name: 'Ether')
-  USDC = Asset.new(network_id: :base_sepolia, asset_id: :usdc, display_name: 'USD Coin',
-                   address_id: '0x036CbD53842c5426634e7929541eC2318f3dCF7e')
-  WETH = Asset.new(network_id: :base_sepolia, asset_id: :weth, display_name: 'Wrapped Ether',
-                   address_id: '0x4200000000000000000000000000000000000006')
   # The Base Sepolia Network.
   BASE_SEPOLIA = Network.new(
     network_id: :base_sepolia,
     display_name: 'Base Sepolia',
     protocol_family: :evm,
     is_testnet: true,
-    assets: [ETH, USDC],
     native_asset_id: :eth,
     chain_id: 84_532
   )
 
-  # The amount of Wei per Ether.
-  WEI_PER_ETHER = 1_000_000_000_000_000_000
-
-  # The amount of Wei per Gwei.
-  WEI_PER_GWEI = 1_000_000_000
-
-  # The amount of Gwei per Ether.
-  GWEI_PER_ETHER = 1_000_000_000
-
-  # The amount of atomic units of USDC per USDC.
-  ATOMIC_UNITS_PER_USDC = 1_000_000
-
-  # A map of supported Asset IDs.
-  SUPPORTED_ASSET_IDS = {
-    eth: true, # Ether, the native asset of most EVM networks.
-    gwei: true, # A medium denomination of Ether, typically used in gas prices.
-    wei: true, # The smallest denomination of Ether.
-    usdc: true, # USD Coin, a stablecoin pegged to the US Dollar.
-    weth: true # Wrapped Ether, the ERC-20 compatible version of Ether.
-  }.freeze
+  # The number of decimal places in Gwei.
+  GWEI_DECIMALS = 9
 end

data/lib/coinbase/errors.rb

@@ -6,92 +6,51 @@ require 'json'
 module Coinbase
   # A wrapper for API errors to provide more context.
   class APIError < StandardError
-    attr_reader :http_code, :api_code, :api_message
+    attr_reader :http_code, :api_code, :api_message, :handled
 
     # Initializes a new APIError object.
     # @param err [Coinbase::Client::APIError] The underlying error object.
-    def initialize(err)
-      super
+    def initialize(err, code: nil, message: nil, unhandled: false)
       @http_code = err.code
+      @api_code = code
+      @api_message = message
+      @handled = code && message && !unhandled
 
-      return unless err.response_body
-
-      body = JSON.parse(err.response_body)
-      @api_code = body['code']
-      @api_message = body['message']
+      super(err)
     end
 
     # Creates a specific APIError based on the API error code.
     # @param err [Coinbase::Client::APIError] The underlying error object.
     # @return [APIError] The specific APIError object.
-    # rubocop:disable Metrics/MethodLength
     def self.from_error(err)
       raise ArgumentError, 'Argument must be a Coinbase::Client::APIError' unless err.is_a? Coinbase::Client::ApiError
       return APIError.new(err) unless err.response_body
 
-      body = JSON.parse(err.response_body)
+      begin
+        body = JSON.parse(err.response_body)
+      rescue JSON::ParserError
+        return APIError.new(err)
+      end
+
+      message = body['message']
+      code = body['code']
 
-      case body['code']
-      when 'unimplemented'
-        UnimplementedError.new(err)
-      when 'unauthorized'
-        UnauthorizedError.new(err)
-      when 'internal'
-        InternalError.new(err)
-      when 'not_found'
-        NotFoundError.new(err)
-      when 'invalid_wallet_id'
-        InvalidWalletIDError.new(err)
-      when 'invalid_address_id'
-        InvalidAddressIDError.new(err)
-      when 'invalid_wallet'
-        InvalidWalletError.new(err)
-      when 'invalid_address'
-        InvalidAddressError.new(err)
-      when 'invalid_amount'
-        InvalidAmountError.new(err)
-      when 'invalid_transfer_id'
-        InvalidTransferIDError.new(err)
-      when 'invalid_page_token'
-        InvalidPageError.new(err)
-      when 'invalid_page_limit'
-        InvalidLimitError.new(err)
-      when 'already_exists'
-        AlreadyExistsError.new(err)
-      when 'malformed_request'
-        MalformedRequestError.new(err)
-      when 'unsupported_asset'
-        UnsupportedAssetError.new(err)
-      when 'invalid_asset_id'
-        InvalidAssetIDError.new(err)
-      when 'invalid_destination'
-        InvalidDestinationError.new(err)
-      when 'invalid_network_id'
-        InvalidNetworkIDError.new(err)
-      when 'resource_exhausted'
-        ResourceExhaustedError.new(err)
-      when 'faucet_limit_reached'
-        FaucetLimitReachedError.new(err)
-      when 'invalid_signed_payload'
-        InvalidSignedPayloadError.new(err)
-      when 'invalid_transfer_status'
-        InvalidTransferStatusError.new(err)
-      when 'network_feature_unsupported'
-        NetworkFeatureUnsupportedError.new(err)
+      if ERROR_CODE_TO_ERROR_CLASS.key?(code)
+        ERROR_CODE_TO_ERROR_CLASS[code].new(err, code: code, message: message)
       else
-        APIError.new(err)
+        APIError.new(err, code: code, message: message, unhandled: true)
       end
     end
-    # rubocop:enable Metrics/MethodLength
 
-    # Returns a String representation of the APIError.
-    # @return [String] a String representation of the APIError
+    # Override to_s to display a friendly error message
     def to_s
-      "APIError{http_code: #{@http_code}, api_code: #{@api_code}, api_message: #{@api_message}}"
+      # For handled errors, display just the API message as that provides sufficient context.
+      return api_message if handled
+
+      # For unhandled errors, display the full error message
+      super
     end
 
-    # Same as to_s.
-    # @return [String] a String representation of the APIError
     def inspect
       to_s
     end
@@ -120,4 +79,30 @@ module Coinbase
   class InvalidSignedPayloadError < APIError; end
   class InvalidTransferStatusError < APIError; end
   class NetworkFeatureUnsupportedError < APIError; end
+
+  ERROR_CODE_TO_ERROR_CLASS = {
+    'unimplemented' => UnimplementedError,
+    'unauthorized' => UnauthorizedError,
+    'internal' => InternalError,
+    'not_found' => NotFoundError,
+    'invalid_wallet_id' => InvalidWalletIDError,
+    'invalid_address_id' => InvalidAddressIDError,
+    'invalid_wallet' => InvalidWalletError,
+    'invalid_address' => InvalidAddressError,
+    'invalid_amount' => InvalidAmountError,
+    'invalid_transfer_id' => InvalidTransferIDError,
+    'invalid_page_token' => InvalidPageError,
+    'invalid_page_limit' => InvalidLimitError,
+    'already_exists' => AlreadyExistsError,
+    'malformed_request' => MalformedRequestError,
+    'unsupported_asset' => UnsupportedAssetError,
+    'invalid_asset_id' => InvalidAssetIDError,
+    'invalid_destination' => InvalidDestinationError,
+    'invalid_network_id' => InvalidNetworkIDError,
+    'resource_exhausted' => ResourceExhaustedError,
+    'faucet_limit_reached' => FaucetLimitReachedError,
+    'invalid_signed_payload' => InvalidSignedPayloadError,
+    'invalid_transfer_status' => InvalidTransferStatusError,
+    'network_feature_unsupported' => NetworkFeatureUnsupportedError
+  }.freeze
 end

data/lib/coinbase/network.rb

@@ -12,31 +12,15 @@ module Coinbase
     # @param protocol_family [String] The protocol family to which the Network belongs
     #   (e.g., "evm")
     # @param is_testnet [Boolean] Whether the Network is a testnet
-    # @param assets [Array<Asset>] The Assets supported by the Network
     # @param native_asset_id [String] The ID of the Network's native Asset
     # @param chain_id [Integer] The Chain ID of the Network
-    def initialize(network_id:, display_name:, protocol_family:, is_testnet:, assets:, native_asset_id:, chain_id:)
+    def initialize(network_id:, display_name:, protocol_family:, is_testnet:, native_asset_id:, chain_id:)
       @network_id = network_id
       @display_name = display_name
       @protocol_family = protocol_family
       @is_testnet = is_testnet
+      @native_asset_id = native_asset_id
       @chain_id = chain_id
-
-      @asset_map = {}
-      assets.each do |asset|
-        @asset_map[asset.asset_id] = asset
-      end
-
-      raise ArgumentError, 'Native Asset not found' unless @asset_map.key?(native_asset_id)
-
-      @native_asset = @asset_map[native_asset_id]
-    end
-
-    # Lists the Assets supported by the Network.
-    #
-    # @return [Array<Asset>] The Assets supported by the Network
-    def list_assets
-      @asset_map.values
     end
 
     # Gets the Asset with the given ID.
@@ -44,12 +28,14 @@ module Coinbase
     # @param asset_id [Symbol] The ID of the Asset
     # @return [Asset] The Asset with the given ID
     def get_asset(asset_id)
-      @asset_map[asset_id]
+      Asset.fetch(@network_id, asset_id)
     end
 
     # Gets the native Asset of the Network.
     #
     # @return [Asset] The native Asset of the Network
-    attr_reader :native_asset
+    def native_asset
+      @native_asset ||= get_asset(@native_asset_id)
+    end
   end
 end

data/lib/coinbase/wallet.rb

@@ -421,9 +421,9 @@ module Coinbase
     end
 
     def address_path_prefix
-      # TODO: Add support for other networks.
+      # TODO: Push this logic to the backend.
       @address_path_prefix ||= case network_id.to_s.split('_').first
-                               when 'base'
+                               when 'base', 'ethereum'
                                  "m/44'/60'/0'/0"
                                else
                                  raise ArgumentError, "Unsupported network ID: #{network_id}"

data/lib/coinbase.rb

@@ -55,13 +55,10 @@ module Coinbase
 
   # Configuration object for the Coinbase SDK.
   class Configuration
-    attr_reader :base_sepolia_rpc_url, :base_sepolia_client
     attr_accessor :api_url, :api_key_name, :api_key_private_key, :debug_api, :use_server_signer
 
     # Initializes the configuration object.
     def initialize
-      @base_sepolia_rpc_url = 'https://sepolia.base.org'
-      @base_sepolia_client = Jimson::Client.new(@base_sepolia_rpc_url)
       @api_url = 'https://api.cdp.coinbase.com'
       @debug_api = false
       @use_server_signer = false
@@ -82,13 +79,6 @@ module Coinbase
       @api_key_private_key = data['privateKey']
     end
 
-    # Sets the Base Sepolia RPC URL.
-    # @param new_base_sepolia_rpc_url [String] the new Base Sepolia RPC URL
-    def base_sepolia_rpc_url=(new_base_sepolia_rpc_url)
-      @base_sepolia_rpc_url = new_base_sepolia_rpc_url
-      @base_sepolia_client = Jimson::Client.new(@base_sepolia_rpc_url)
-    end
-
     # Returns the API client.
     # @return [Coinbase::Client::ApiClient] the API client
     def api_client
@@ -109,6 +99,13 @@ module Coinbase
     value.to_s.gsub('-', '_').to_sym
   end
 
+  # Converts a network symbol to a string, replacing underscores with hyphens.
+  # @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(/_/, '-')
+  end
+
   # Loads the default user.
   # @return [Coinbase::User] the default user
   def self.load_default_user
@@ -122,7 +119,7 @@ module Coinbase
   def self.call_api
     yield
   rescue Coinbase::Client::ApiError => e
-    raise Coinbase::APIError.from_error(e)
+    raise Coinbase::APIError.from_error(e), cause: nil
   rescue StandardError => e
     raise e
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coinbase-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Yuga Cohler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-11 00:00:00.000000000 Z
+date: 2024-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -248,9 +248,13 @@ files:
 - lib/coinbase/balance_map.rb
 - lib/coinbase/client.rb
 - lib/coinbase/client/api/addresses_api.rb
+- lib/coinbase/client/api/assets_api.rb
+- lib/coinbase/client/api/balances_api.rb
+- lib/coinbase/client/api/external_addresses_api.rb
 - lib/coinbase/client/api/server_signers_api.rb
 - lib/coinbase/client/api/stake_api.rb
 - lib/coinbase/client/api/trades_api.rb
+- lib/coinbase/client/api/transfer_api.rb
 - lib/coinbase/client/api/transfers_api.rb
 - lib/coinbase/client/api/users_api.rb
 - lib/coinbase/client/api/wallets_api.rb
@@ -274,6 +278,10 @@ files:
 - lib/coinbase/client/models/error.rb
 - lib/coinbase/client/models/faucet_transaction.rb
 - lib/coinbase/client/models/feature.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/partial_eth_staking_context.rb
 - lib/coinbase/client/models/request_faucet_funds200_response.rb
 - lib/coinbase/client/models/seed_creation_event.rb
 - lib/coinbase/client/models/seed_creation_event_result.rb
@@ -284,7 +292,10 @@ files:
 - lib/coinbase/client/models/server_signer_list.rb
 - lib/coinbase/client/models/signature_creation_event.rb
 - lib/coinbase/client/models/signature_creation_event_result.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_reward.rb
 - lib/coinbase/client/models/trade.rb
 - lib/coinbase/client/models/trade_list.rb
 - lib/coinbase/client/models/transaction.rb