coinbase-sdk 0.0.1 → 0.0.3

data/lib/coinbase/client/models/wallet_list.rb

@@ -0,0 +1,275 @@
+=begin
+#Coinbase Platform API
+
+#This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.
+
+The version of the OpenAPI document: 0.0.1-alpha
+Contact: yuga.cohler@coinbase.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.5.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Coinbase::Client
+  # Paginated list of wallets
+  class WalletList
+    attr_accessor :data
+
+    # True if this list has another page of items after this one that can be fetched.
+    attr_accessor :has_more
+
+    # The page token to be used to fetch the next page.
+    attr_accessor :next_page
+
+    # The total number of wallets
+    attr_accessor :total_count
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data',
+        :'has_more' => :'has_more',
+        :'next_page' => :'next_page',
+        :'total_count' => :'total_count'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'data' => :'Array<Wallet>',
+        :'has_more' => :'Boolean',
+        :'next_page' => :'String',
+        :'total_count' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Coinbase::Client::WalletList` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Coinbase::Client::WalletList`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      else
+        self.data = nil
+      end
+
+      if attributes.key?(:'has_more')
+        self.has_more = attributes[:'has_more']
+      else
+        self.has_more = nil
+      end
+
+      if attributes.key?(:'next_page')
+        self.next_page = attributes[:'next_page']
+      else
+        self.next_page = nil
+      end
+
+      if attributes.key?(:'total_count')
+        self.total_count = attributes[:'total_count']
+      else
+        self.total_count = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @data.nil?
+        invalid_properties.push('invalid value for "data", data cannot be nil.')
+      end
+
+      if @has_more.nil?
+        invalid_properties.push('invalid value for "has_more", has_more cannot be nil.')
+      end
+
+      if @next_page.nil?
+        invalid_properties.push('invalid value for "next_page", next_page cannot be nil.')
+      end
+
+      if @total_count.nil?
+        invalid_properties.push('invalid value for "total_count", total_count cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @data.nil?
+      return false if @has_more.nil?
+      return false if @next_page.nil?
+      return false if @total_count.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          data == o.data &&
+          has_more == o.has_more &&
+          next_page == o.next_page &&
+          total_count == o.total_count
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [data, has_more, next_page, total_count].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Coinbase::Client.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/coinbase/client/version.rb

@@ -0,0 +1,15 @@
+=begin
+#Coinbase Platform API
+
+#This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.
+
+The version of the OpenAPI document: 0.0.1-alpha
+Contact: yuga.cohler@coinbase.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.5.0
+
+=end
+
+module Coinbase::Client
+  VERSION = '0.0.1-alpha'
+end

data/lib/coinbase/client.rb

@@ -0,0 +1,59 @@
+=begin
+#Coinbase Platform API
+
+#This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.
+
+The version of the OpenAPI document: 0.0.1-alpha
+Contact: yuga.cohler@coinbase.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.5.0
+
+=end
+
+# Common files
+require 'coinbase/client/api_client'
+require 'coinbase/client/api_error'
+require 'coinbase/client/version'
+require 'coinbase/client/configuration'
+
+# Models
+Coinbase::Client.autoload :Address, 'coinbase/client/models/address'
+Coinbase::Client.autoload :AddressBalanceList, 'coinbase/client/models/address_balance_list'
+Coinbase::Client.autoload :AddressList, 'coinbase/client/models/address_list'
+Coinbase::Client.autoload :Asset, 'coinbase/client/models/asset'
+Coinbase::Client.autoload :Balance, 'coinbase/client/models/balance'
+Coinbase::Client.autoload :BroadcastTransferRequest, 'coinbase/client/models/broadcast_transfer_request'
+Coinbase::Client.autoload :CreateAddressRequest, 'coinbase/client/models/create_address_request'
+Coinbase::Client.autoload :CreateTransferRequest, 'coinbase/client/models/create_transfer_request'
+Coinbase::Client.autoload :CreateWalletRequest, 'coinbase/client/models/create_wallet_request'
+Coinbase::Client.autoload :Error, 'coinbase/client/models/error'
+Coinbase::Client.autoload :FaucetTransaction, 'coinbase/client/models/faucet_transaction'
+Coinbase::Client.autoload :Transfer, 'coinbase/client/models/transfer'
+Coinbase::Client.autoload :TransferList, 'coinbase/client/models/transfer_list'
+Coinbase::Client.autoload :User, 'coinbase/client/models/user'
+Coinbase::Client.autoload :Wallet, 'coinbase/client/models/wallet'
+Coinbase::Client.autoload :WalletList, 'coinbase/client/models/wallet_list'
+
+# APIs
+Coinbase::Client.autoload :AddressesApi, 'coinbase/client/api/addresses_api'
+Coinbase::Client.autoload :TransfersApi, 'coinbase/client/api/transfers_api'
+Coinbase::Client.autoload :UsersApi, 'coinbase/client/api/users_api'
+Coinbase::Client.autoload :WalletsApi, 'coinbase/client/api/wallets_api'
+
+module Coinbase::Client
+  class << self
+    # Customize default settings for the SDK using block.
+    #   Coinbase::Client.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/coinbase/constants.rb

@@ -8,7 +8,8 @@ module Coinbase
   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,
@@ -29,10 +30,15 @@ module Coinbase
   # 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.
+    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
 end

data/lib/coinbase/errors.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require_relative 'client/api_error'
+require 'json'
+
+module Coinbase
+  # A wrapper for API errors to provide more context.
+  class APIError < StandardError
+    attr_reader :http_code, :api_code, :api_message
+
+    # Initializes a new APIError object.
+    # @param err [Coinbase::Client::APIError] The underlying error object.
+    def initialize(err)
+      super
+      @http_code = err.code
+
+      return unless err.response_body
+
+      body = JSON.parse(err.response_body)
+      @api_code = body['code']
+      @api_message = body['message']
+    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)
+
+      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)
+      else
+        APIError.new(err)
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    # Returns a String representation of the APIError.
+    # @return [String] a String representation of the APIError
+    def to_s
+      "APIError{http_code: #{@http_code}, api_code: #{@api_code}, api_message: #{@api_message}}"
+    end
+
+    # Same as to_s.
+    # @return [String] a String representation of the APIError
+    def inspect
+      to_s
+    end
+  end
+
+  class UnimplementedError < APIError; end
+  class UnauthorizedError < APIError; end
+  class InternalError < APIError; end
+  class NotFoundError < APIError; end
+  class InvalidWalletIDError < APIError; end
+  class InvalidAddressIDError < APIError; end
+  class InvalidWalletError < APIError; end
+  class InvalidAddressError < APIError; end
+  class InvalidAmountError < APIError; end
+  class InvalidTransferIDError < APIError; end
+  class InvalidPageError < APIError; end
+  class InvalidLimitError < APIError; end
+  class AlreadyExistsError < APIError; end
+  class MalformedRequestError < APIError; end
+  class UnsupportedAssetError < APIError; end
+  class InvalidAssetIDError < APIError; end
+  class InvalidDestinationError < APIError; end
+  class InvalidNetworkIDError < APIError; end
+  class ResourceExhaustedError < APIError; end
+  class FaucetLimitReachedError < APIError; end
+  class InvalidSignedPayloadError < APIError; end
+  class InvalidTransferStatusError < APIError; end
+end

data/lib/coinbase/faucet_transaction.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Coinbase
+  # A representation of a transaction from a faucet.
+  # a user-controlled Wallet to another address. The fee is assumed to be paid
+  # in the native Asset of the Network. Transfers should be created through Wallet#transfer or
+  # Address#transfer.
+  class FaucetTransaction
+    # Returns a new FaucetTransaction object. Do not use this method directly - instead, use Address#faucet.
+    # @param model [Coinbase::Client::FaucetTransaction] The underlying FaucetTransaction object
+    def initialize(model)
+      @model = model
+    end
+
+    attr_reader :model
+
+    # Returns the transaction hash.
+    # @return [String] The onchain transaction hash
+    def transaction_hash
+      model.transaction_hash
+    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
+      # TODO: Parameterize this by Network.
+      "https://sepolia.basescan.org/tx/#{transaction_hash}"
+    end
+
+    # Returns a String representation of the FaucetTransaction.
+    # @return [String] a String representation of the FaucetTransaction
+    def to_s
+      "Coinbase::FaucetTransaction{transaction_hash: '#{transaction_hash}', transaction_link: '#{transaction_link}'}"
+    end
+
+    # Same as to_s.
+    # @return [String] a String representation of the FaucetTransaction
+    def inspect
+      to_s
+    end
+  end
+end

data/lib/coinbase/middleware.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'authenticator'
+require_relative 'client/configuration'
+require 'faraday'
+
+module Coinbase
+  # A module for middleware that can be used with Faraday.
+  module Middleware
+    Faraday::Request.register_middleware authenticator: -> { Coinbase::Authenticator }
+
+    # Returns the default middleware configuration for the Coinbase SDK.
+    def self.config
+      Coinbase::Client::Configuration.default.tap do |config|
+        config.debugging = Coinbase.configuration.debug_api
+        config.host = Coinbase.configuration.api_url
+        config.request(:authenticator)
+      end
+    end
+  end
+end

data/lib/coinbase/network.rb

@@ -5,8 +5,8 @@ module Coinbase
   class Network
     attr_reader :chain_id
 
-    # Returns a new Network object.
-    #
+    # Returns a new Network object. Do not use this method directly. Instead, use the Network constants defined in
+    # the Coinbase module.
     # @param network_id [Symbol] The Network ID
     # @param display_name [String] The Network's display name
     # @param protocol_family [String] The protocol family to which the Network belongs