coinbase-sdk 0.0.1 → 0.0.2

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,57 @@
+=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 :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 :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

@@ -29,10 +29,14 @@ 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.
   }.freeze
 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 = true
+        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

data/lib/coinbase/transfer.rb

@@ -3,15 +3,14 @@
 require_relative 'constants'
 require 'bigdecimal'
 require 'eth'
+require 'json'
 
 module Coinbase
   # A representation of a Transfer, which moves an amount of an Asset from
   # a user-controlled Wallet to another address. The fee is assumed to be paid
-  # in the native Asset of the Network. Currently only ETH transfers are supported. Transfers
-  # should be created through {link:Wallet#transfer} or {link:Address#transfer}.
+  # in the native Asset of the Network. Transfers should be created through Wallet#transfer or
+  # Address#transfer.
   class Transfer
-    attr_reader :network_id, :wallet_id, :from_address_id, :amount, :asset_id, :to_address_id
-
     # A representation of a Transfer status.
     module Status
       # The Transfer is awaiting being broadcast to the Network. At this point, transaction
@@ -29,28 +28,59 @@ module Coinbase
       FAILED = :failed
     end
 
-    # Returns a new Transfer object.
-    # @param network_id [Symbol] The ID of the Network on which the Transfer originated
-    # @param wallet_id [String] The ID of the Wallet from which the Transfer originated
-    # @param from_address_id [String] The ID of the address from which the Transfer originated
-    # @param amount [Integer, Float, BigDecimal] The amount of the Asset to send. Integers are interpreted as
-    #  the smallest denomination of the Asset (e.g. Wei for Ether). Floats and BigDecimals are interpreted as the Asset
-    #  itself (e.g. Ether).
-    # @param asset_id [Symbol] The ID of the Asset being transferred. Currently only ETH is supported.
-    # @param to_address_id [String] The address to which the Transfer is being sent
-    # @param client [Jimson::Client] (Optional) The JSON RPC client to use for interacting with the Network
-    def initialize(network_id, wallet_id, from_address_id, amount, asset_id, to_address_id,
-                   client: Jimson::Client.new(Coinbase.base_sepolia_rpc_url))
-
-      raise ArgumentError, "Unsupported asset: #{asset_id}" if asset_id != :eth
-
-      @network_id = network_id
-      @wallet_id = wallet_id
-      @from_address_id = from_address_id
-      @amount = normalize_eth_amount(amount)
-      @asset_id = asset_id
-      @to_address_id = to_address_id
-      @client = client
+    # Returns a new Transfer object. Do not use this method directly. Instead, use Wallet#transfer or
+    # Address#transfer.
+    # @param model [Coinbase::Client::Transfer] The underlying Transfer object
+    def initialize(model)
+      @model = model
+    end
+
+    # Returns the Transfer ID.
+    # @return [String] The Transfer ID
+    def transfer_id
+      @model.transfer_id
+    end
+
+    # Returns the Network ID of the Transfer.
+    # @return [Symbol] The Network ID
+    def network_id
+      Coinbase.to_sym(@model.network_id)
+    end
+
+    # Returns the Wallet ID of the Transfer.
+    # @return [String] The Wallet ID
+    def wallet_id
+      @model.wallet_id
+    end
+
+    # Returns the From Address ID of the Transfer.
+    # @return [String] The From Address ID
+    def from_address_id
+      @model.address_id
+    end
+
+    # Returns the Destination Address ID of the Transfer.
+    # @return [String] The Destination Address ID
+    def destination_address_id
+      @model.destination
+    end
+
+    # Returns the Asset ID of the Transfer.
+    # @return [Symbol] The Asset ID
+    def asset_id
+      @model.asset_id.to_sym
+    end
+
+    # Returns the amount of the asset for the Transfer.
+    # @return [BigDecimal] The amount in units of ETH
+    def amount
+      BigDecimal(@model.amount) / BigDecimal(Coinbase::WEI_PER_ETHER.to_s)
+    end
+
+    # Returns the Unsigned Payload of the Transfer.
+    # @return [String] The Unsigned Payload
+    def unsigned_payload
+      @model.unsigned_payload
     end
 
     # Returns the underlying Transfer transaction, creating it if it has not been yet.
@@ -58,18 +88,19 @@ module Coinbase
     def transaction
       return @transaction unless @transaction.nil?
 
-      nonce = @client.eth_getTransactionCount(@from_address_id.to_s, 'latest').to_i(16)
-      gas_price = @client.eth_gasPrice.to_i(16)
+      raw_payload = [unsigned_payload].pack('H*')
+      parsed_payload = JSON.parse(raw_payload)
 
       params = {
-        chain_id: BASE_SEPOLIA.chain_id, # TODO: Don't hardcode Base Sepolia.
-        nonce: nonce,
-        priority_fee: gas_price, # TODO: Optimize this.
-        max_gas_fee: gas_price,
-        gas_limit: 21_000, # TODO: Handle multiple currencies.
-        from: Eth::Address.new(@from_address_id),
-        to: Eth::Address.new(@to_address_id),
-        value: (@amount * Coinbase::WEI_PER_ETHER).to_i
+        chain_id: parsed_payload['chainId'].to_i(16),
+        nonce: parsed_payload['nonce'].to_i(16),
+        priority_fee: parsed_payload['maxPriorityFeePerGas'].to_i(16),
+        max_gas_fee: parsed_payload['maxFeePerGas'].to_i(16),
+        gas_limit: parsed_payload['gas'].to_i(16), # TODO: Handle multiple currencies.
+        from: Eth::Address.new(from_address_id),
+        to: Eth::Address.new(parsed_payload['to']),
+        value: parsed_payload['value'].to_i(16),
+        data: parsed_payload['input'] || ''
       }
 
       @transaction = Eth::Tx::Eip1559.new(Eth::Tx.validate_eip1559_params(params))
@@ -87,7 +118,7 @@ module Coinbase
         return Status::PENDING
       end
 
-      onchain_transaction = @client.eth_getTransactionByHash(transaction_hash)
+      onchain_transaction = Coinbase.configuration.base_sepolia_client.eth_getTransactionByHash(transaction_hash)
 
       if onchain_transaction.nil?
         # If the transaction has not been broadcast, it is still pending.
@@ -97,7 +128,7 @@ module Coinbase
         # broadcast.
         Status::BROADCAST
       else
-        transaction_receipt = @client.eth_getTransactionReceipt(transaction_hash)
+        transaction_receipt = Coinbase.configuration.base_sepolia_client.eth_getTransactionReceipt(transaction_hash)
 
         if transaction_receipt['status'].to_i(16) == 1
           Status::COMPLETE
@@ -133,21 +164,5 @@ module Coinbase
     rescue Eth::Signature::SignatureError
       nil
     end
-
-    private
-
-    # Normalizes the given Ether amount into a BigDecimal.
-    # @param amount [Integer, Float, BigDecimal] The amount to normalize
-    # @return [BigDecimal] The normalized amount
-    def normalize_eth_amount(amount)
-      case amount
-      when BigDecimal
-        amount
-      when Integer, Float
-        BigDecimal(amount.to_s)
-      else
-        raise ArgumentError, "Invalid amount: #{amount}"
-      end
-    end
   end
 end

data/lib/coinbase/user.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative 'client'
+require_relative 'wallet'
+
+module Coinbase
+  # A representation of a User. Users have Wallets, which can hold balances of Assets. Access the default User through
+  # Coinbase#default_user.
+  class User
+    # Returns a new User object. Do not use this method directly. Instead, use Coinbase#default_user.
+    # @param model [Coinbase::Client::User] the underlying User object
+    def initialize(model)
+      @model = model
+    end
+
+    # Returns the User ID.
+    # @return [String] the User ID
+    def user_id
+      @model.id
+    end
+
+    # Creates a new Wallet belonging to the User.
+    # @return [Coinbase::Wallet] the new Wallet
+    def create_wallet
+      create_wallet_request = {
+        wallet: {
+          # TODO: Don't hardcode this.
+          network_id: 'base-sepolia'
+        }
+      }
+      opts = { create_wallet_request: create_wallet_request }
+
+      model = wallets_api.create_wallet(opts)
+
+      Wallet.new(model)
+    end
+
+    # Imports a Wallet belonging to the User.
+    # @param data [Coinbase::Wallet::Data] the Wallet data to import
+    # @return [Coinbase::Wallet] the imported Wallet
+    def import_wallet(data)
+      model = wallets_api.get_wallet(data.wallet_id)
+      address_count = addresses_api.list_addresses(model.id).total_count
+      Wallet.new(model, seed: data.seed, address_count: address_count)
+    end
+
+    # Lists the IDs of the Wallets belonging to the User.
+    # @return [Array<String>] the IDs of the Wallets belonging to the User
+    def list_wallet_ids
+      wallets = wallets_api.list_wallets
+      wallets.data.map(&:id)
+    end
+
+    private
+
+    def addresses_api
+      @addresses_api ||= Coinbase::Client::AddressesApi.new(Coinbase.configuration.api_client)
+    end
+
+    def wallets_api
+      @wallets_api ||= Coinbase::Client::WalletsApi.new(Coinbase.configuration.api_client)
+    end
+  end
+end