coinbase-sdk 0.0.16 → 0.1.0

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 Contact: yuga.cohler@coinbase.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.7.0
 
 =end
 

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 Contact: yuga.cohler@coinbase.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.7.0
 
 =end
 

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 Contact: yuga.cohler@coinbase.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.7.0
 
 =end
 

data/lib/coinbase/client/version.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 Contact: yuga.cohler@coinbase.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.7.0
 
 =end
 

data/lib/coinbase/client.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 Contact: yuga.cohler@coinbase.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.7.0
 
 =end
 
@@ -78,6 +78,7 @@ Coinbase::Client.autoload :User, 'coinbase/client/models/user'
 Coinbase::Client.autoload :Validator, 'coinbase/client/models/validator'
 Coinbase::Client.autoload :ValidatorDetails, 'coinbase/client/models/validator_details'
 Coinbase::Client.autoload :ValidatorList, 'coinbase/client/models/validator_list'
+Coinbase::Client.autoload :ValidatorStatus, 'coinbase/client/models/validator_status'
 Coinbase::Client.autoload :Wallet, 'coinbase/client/models/wallet'
 Coinbase::Client.autoload :WalletList, 'coinbase/client/models/wallet_list'
 Coinbase::Client.autoload :Webhook, 'coinbase/client/models/webhook'
@@ -97,6 +98,7 @@ Coinbase::Client.autoload :TradesApi, 'coinbase/client/api/trades_api'
 Coinbase::Client.autoload :TransfersApi, 'coinbase/client/api/transfers_api'
 Coinbase::Client.autoload :UsersApi, 'coinbase/client/api/users_api'
 Coinbase::Client.autoload :ValidatorsApi, 'coinbase/client/api/validators_api'
+Coinbase::Client.autoload :WalletStakeApi, 'coinbase/client/api/wallet_stake_api'
 Coinbase::Client.autoload :WalletsApi, 'coinbase/client/api/wallets_api'
 Coinbase::Client.autoload :WebhooksApi, 'coinbase/client/api/webhooks_api'
 

data/lib/coinbase/constants.rb

@@ -4,16 +4,6 @@ require_relative 'asset'
 require_relative 'network'
 
 module Coinbase
-  # The Base Sepolia Network.
-  BASE_SEPOLIA = Network.new(
-    network_id: :base_sepolia,
-    display_name: 'Base Sepolia',
-    protocol_family: :evm,
-    is_testnet: true,
-    native_asset_id: :eth,
-    chain_id: 84_532
-  )
-
   # The number of decimal places in Gwei.
   GWEI_DECIMALS = 9
 

data/lib/coinbase/contract_event.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Coinbase
+  # Represents a single contract event
+  class ContractEvent
+    # Returns a new ContractEvent object.
+    # @param model [Coinbase::Client::ContractEvent] The underlying ContractEvent object
+    def initialize(model)
+      @model = model
+    end
+
+    # Returns the network ID of the ContractEvent.
+    # @return [String] The network ID
+    def network_id
+      @model.network_id
+    end
+
+    # Returns the protocol name of the ContractEvent.
+    # @return [String] The protocol name
+    def protocol_name
+      @model.protocol_name
+    end
+
+    # Returns the contract name of the ContractEvent.
+    # @return [String] The contract name
+    def contract_name
+      @model.contract_name
+    end
+
+    # Returns the event name of the ContractEvent.
+    # @return [String] The event name
+    def event_name
+      @model.event_name
+    end
+
+    # Returns the signature of the ContractEvent.
+    # @return [String] The event signature
+    def sig
+      @model.sig
+    end
+
+    # Returns the four bytes of the Keccak hash of the event signature.
+    # @return [String] The four bytes of the event signature hash
+    def four_bytes
+      @model.four_bytes
+    end
+
+    # Returns the contract address of the ContractEvent.
+    # @return [String] The contract address
+    def contract_address
+      @model.contract_address
+    end
+
+    # Returns the block time of the ContractEvent.
+    # @return [Time] The block time
+    def block_time
+      Time.parse(@model.block_time)
+    end
+
+    # Returns the block height of the ContractEvent.
+    # @return [Integer] The block height
+    def block_height
+      @model.block_height
+    end
+
+    # Returns the transaction hash of the ContractEvent.
+    # @return [String] The transaction hash
+    def tx_hash
+      @model.tx_hash
+    end
+
+    # Returns the transaction index of the ContractEvent.
+    # @return [Integer] The transaction index
+    def tx_index
+      @model.tx_index
+    end
+
+    # Returns the event index of the ContractEvent.
+    # @return [Integer] The event index
+    def event_index
+      @model.event_index
+    end
+
+    # Returns the event data of the ContractEvent.
+    # @return [String] The event data
+    def data
+      @model.data
+    end
+
+    # Returns a string representation of the ContractEvent.
+    # @return [String] a string representation of the ContractEvent
+    def to_s
+      "Coinbase::ContractEvent{network_id: '#{network_id}', protocol_name: '#{protocol_name}', " \
+        "contract_name: '#{contract_name}', event_name: '#{event_name}', contract_address: '#{contract_address}', " \
+        "block_height: #{block_height}, tx_hash: '#{tx_hash}', data: '#{data}'}"
+    end
+
+    # Same as to_s.
+    # @return [String] a string representation of the ContractEvent
+    def inspect
+      to_s
+    end
+  end
+end

data/lib/coinbase/correlation.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'securerandom'
+
+module Coinbase
+  # A middleware that injects correlation data into the request headers.
+  class Correlation < Faraday::Middleware
+    # Initializes the Correlation middleware.
+    # @param app [Faraday::Connection] The Faraday connection
+    def initialize(app)
+      super(app)
+      @app = app
+    end
+
+    # Processes the request by adding the Correlation Data to the request headers.
+    # @param env [Faraday::Env] The Faraday request environment
+    def call(env)
+      env.request_headers['Correlation-Context'] = correlation_data
+      @app.call(env)
+    end
+
+    def correlation_data
+      @correlation_data ||= {
+        sdk_version: Coinbase::VERSION,
+        sdk_language: 'ruby'
+      }.map { |key, val| "#{key}=#{CGI.escape(val)}" }.join(',')
+    end
+  end
+end

data/lib/coinbase/destination.rb

@@ -20,32 +20,34 @@ module Coinbase
     #   If the destination is a String, it uses it as the Address ID.
     # @param network_id [Symbol] The ID of the Network to which the Destination belongs
     # @return [Destination] The Destination object
-    def initialize(model, network_id: nil)
+    def initialize(model, network:)
+      network = Coinbase::Network.from_id(network)
+
       case model
       when Coinbase::Destination
-        raise ArgumentError, 'destination network must match destination' unless model.network_id == network_id
+        raise ArgumentError, 'destination network must match destination' unless model.network == network
 
         @address_id = model.address_id
-        @network_id = model.network_id
+        @network = model.network
       when Coinbase::Wallet
-        raise ArgumentError, 'destination network must match wallet' unless model.network_id == network_id
+        raise ArgumentError, 'destination network must match wallet' unless model.network == network
         raise ArgumentError, 'destination wallet must have default address' if model.default_address.nil?
 
         @address_id = model.default_address.id
-        @network_id = model.network_id
+        @network = model.network
       when Coinbase::Address
-        raise ArgumentError, 'destination network must match address' unless model.network_id == network_id
+        raise ArgumentError, 'destination network must match address' unless model.network == network
 
         @address_id = model.id
-        @network_id = model.network_id
+        @network = model.network
       when String
         @address_id = model
-        @network_id = network_id
+        @network = network
       else
         raise ArgumentError, "unsupported destination type: #{model.class}"
       end
     end
 
-    attr_reader :address_id, :network_id
+    attr_reader :address_id, :network
   end
 end

data/lib/coinbase/errors.rb

@@ -56,6 +56,13 @@ module Coinbase
     end
   end
 
+  # An error raised when an operation is attempted with insufficient funds.
+  class NetworkUnsupportedError < StandardError
+    def initialize(network_id)
+      super("Network #{network_id} is not supported")
+    end
+  end
+
   # An error raised when an operation is attempted with insufficient funds.
   class InsufficientFundsError < StandardError
     def initialize(expected, exact, msg = 'Insufficient funds')

data/lib/coinbase/middleware.rb

@@ -9,6 +9,7 @@ module Coinbase
   # A module for middleware that can be used with Faraday.
   module Middleware
     Faraday::Request.register_middleware authenticator: -> { Coinbase::Authenticator }
+    Faraday::Request.register_middleware correlation: -> { Coinbase::Correlation }
 
     # Returns the default middleware configuration for the Coinbase SDK.
     def self.config
@@ -19,6 +20,7 @@ module Coinbase
         config.host = uri.host + (uri.port ? ":#{uri.port}" : '')
         config.scheme = uri.scheme if uri.scheme
         config.request(:authenticator)
+        config.request(:correlation)
         retry_options = {
           max: Coinbase.configuration.max_network_tries,
           interval: 0.05,

data/lib/coinbase/network.rb

@@ -3,39 +3,122 @@
 module Coinbase
   # A blockchain network.
   class Network
-    attr_reader :chain_id
+    # Returns the Network object for the given ID, if supported.
+    # @param network_id [Symbol, String] The ID of the network
+    # @return [Network] The network object
+    def self.from_id(network_id)
+      return network_id if network_id.is_a?(Network)
 
-    # Returns a new Network object. Do not use this method directly. Instead, use the Network constants defined in
+      network = NETWORK_MAP.fetch(Coinbase.to_sym(network_id), nil)
+
+      return network unless network.nil?
+
+      raise NetworkUnsupportedError, network_id
+    end
+
+    # Constructs 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
-    #   (e.g., "evm")
-    # @param is_testnet [Boolean] Whether the Network is a testnet
-    # @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:, 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
+    # @param id [Symbol, String] The Network ID
+    # @return [Network] The new Network object
+    def initialize(id)
+      @id = ::Coinbase.to_sym(id)
+    end
+
+    # Returns the equality of the Network object with another Network object by ID.
+    # @param other [Coinbase::Network] The network object to compare
+    # @return [Boolean] Whether the Network objects are equal
+    def ==(other)
+      return false unless other.is_a?(Network)
+
+      id == other.id
+    end
+
+    attr_reader :id
+
+    def normalized_id
+      id.to_s.gsub('_', '-')
+    end
+
+    # The Chain ID of the Network.
+    # @return [Integer] The Chain ID of the Network
+    # @example
+    #   network.chain_id #=> 84_532
+    def chain_id
+      model.chain_id
+    end
+
+    # Whether the Network is a testnet.
+    # @return [Boolean] Whether the Network is a testnet
+    # @example
+    #   network.testnet? #=> true
+    def testnet?
+      model.is_testnet
+    end
+
+    # The display name of the Network.
+    # @return [String] The display name of the Network
+    # @example
+    #  network.display_name #=> "Base Sepolia"
+    def display_name
+      model.display_name
+    end
+
+    # The protocol family to which the Network belongs. Example: `evm`.
+    # @return [String] The protocol family to which the Network belongs.
+    # @example
+    #  network.protocol_family #=> "evm"
+    def protocol_family
+      model.protocol_family
+    end
+
+    # The address path prefix of the Network.
+    # @return [String] The address path prefix of the Network
+    # @example
+    #   network.address_path_prefix #=> "m/44'/60'/0'/0"
+    def address_path_prefix
+      model.address_path_prefix
     end
 
     # Gets the Asset with the given ID.
-    #
     # @param asset_id [Symbol] The ID of the Asset
     # @return [Asset] The Asset with the given ID
     def get_asset(asset_id)
-      Asset.fetch(@network_id, asset_id)
+      Asset.fetch(@id, asset_id)
     end
 
     # Gets the native Asset of the Network.
-    #
     # @return [Asset] The native Asset of the Network
     def native_asset
-      @native_asset ||= get_asset(@native_asset_id)
+      @native_asset ||= Coinbase::Asset.from_model(model.native_asset)
+    end
+
+    def to_s
+      details = { id: id }
+
+      # Only include optional details if the model is already fetched.
+      unless @model.nil?
+        Coinbase::Client::Network.attribute_map.each_key do |attr|
+          details[attr] = @model.send(attr)
+        end
+      end
+
+      Coinbase.pretty_print_object(self.class, **details)
+    end
+
+    def inspect
+      to_s
+    end
+
+    private
+
+    def networks_api
+      @networks_api ||= Coinbase::Client::NetworksApi.new(Coinbase.configuration.api_client)
+    end
+
+    def model
+      @model ||= Coinbase.call_api do
+        networks_api.get_network(Coinbase.normalize_network(id))
+      end
     end
   end
 end

data/lib/coinbase/smart_contract.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Coinbase
+  # A representation of a SmartContract on the blockchain.
+  class SmartContract
+    # Returns a list of ContractEvents for the provided network, contract, and event details.
+    # @param network_id [Symbol] The network ID
+    # @param protocol_name [String] The protocol name
+    # @param contract_address [String] The contract address
+    # @param contract_name [String] The contract name
+    # @param event_name [String] The event name
+    # @param from_block_height [Integer] The start block height
+    # @param to_block_height [Integer] The end block height
+    # @return [Enumerable<Coinbase::ContractEvent>] The contract events
+    def self.list_events(
+      network_id:,
+      protocol_name:,
+      contract_address:,
+      contract_name:,
+      event_name:,
+      from_block_height:,
+      to_block_height:
+    )
+      Coinbase::Pagination.enumerate(
+        lambda { |page|
+          list_events_page(network_id, protocol_name, contract_address, contract_name, event_name, from_block_height,
+                           to_block_height, page)
+        }
+      ) do |contract_event|
+        Coinbase::ContractEvent.new(contract_event)
+      end
+    end
+
+    # Returns a new SmartContract object.
+    # @param model [Coinbase::Client::SmartContract] The underlying SmartContract object
+    def initialize(model)
+      @model = model
+    end
+
+    # Returns the network ID of the SmartContract.
+    # @return [String] The network ID
+    def network_id
+      Coinbase.to_sym(@model.network_id)
+    end
+
+    # Returns the protocol name of the SmartContract.
+    # @return [String] The protocol name
+    def protocol_name
+      @model.protocol_name
+    end
+
+    # Returns the contract name of the SmartContract.
+    # @return [String] The contract name
+    def contract_name
+      @model.contract_name
+    end
+
+    # Returns the address of the SmartContract.
+    # @return [String] The contract address
+    def address
+      @model.address
+    end
+
+    # Returns a string representation of the SmartContract.
+    # @return [String] a string representation of the SmartContract
+    def to_s
+      "Coinbase::SmartContract{
+        network_id: '#{network_id}',
+        protocol_name: '#{protocol_name}',
+        contract_name: '#{contract_name}',
+        address: '#{address}'}"
+    end
+
+    # Same as to_s.
+    # @return [String] a string representation of the SmartContract
+    def inspect
+      to_s
+    end
+
+    def self.contract_events_api
+      Coinbase::Client::ContractEventsApi.new(Coinbase.configuration.api_client)
+    end
+
+    def self.list_events_page(
+      network_id,
+      protocol_name,
+      contract_address,
+      contract_name,
+      event_name,
+      from_block_height,
+      to_block_height,
+      page
+    )
+      contract_events_api.list_contract_events(
+        Coinbase.normalize_network(network_id),
+        protocol_name,
+        contract_address,
+        contract_name,
+        event_name,
+        from_block_height,
+        to_block_height,
+        { next_page: page }
+      )
+    end
+  end
+end

data/lib/coinbase/staking_balance.rb

@@ -6,15 +6,17 @@ 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 network [Coinbase::Network, Symbol] The Network or 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)
+    def self.list(network, asset_id, address_id, start_time: DateTime.now.prev_month(1), end_time: DateTime.now)
+      network = Coinbase::Network.from_id(network)
+
       Coinbase::Pagination.enumerate(
-        ->(page) { list_page(network_id, asset_id, address_id, start_time, end_time, page) }
+        ->(page) { list_page(network, asset_id, address_id, start_time, end_time, page) }
       ) do |staking_balance|
         new(staking_balance)
       end
@@ -72,9 +74,11 @@ module Coinbase
       Coinbase::Client::StakeApi.new(Coinbase.configuration.api_client)
     end
 
-    def self.list_page(network_id, asset_id, address_id, start_time, end_time, page)
+    private_class_method :stake_api
+
+    def self.list_page(network, asset_id, address_id, start_time, end_time, page)
       stake_api.fetch_historical_staking_balances(
-        Coinbase.normalize_network(network_id),
+        network.normalized_id,
         asset_id,
         address_id,
         start_time.iso8601,
@@ -82,5 +86,7 @@ module Coinbase
         { next_page: page }
       )
     end
+
+    private_class_method :list_page
   end
 end