coinbase-sdk 0.0.13 → 0.0.16

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

@@ -0,0 +1,244 @@
+=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.6.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Coinbase::Client
+  # 
+  class WebhookList
+    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
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data',
+        :'has_more' => :'has_more',
+        :'next_page' => :'next_page'
+      }
+    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<Webhook>',
+        :'has_more' => :'Boolean',
+        :'next_page' => :'String'
+      }
+    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::WebhookList` 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::WebhookList`. 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']
+      end
+
+      if attributes.key?(:'next_page')
+        self.next_page = attributes[:'next_page']
+      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
+
+      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?
+      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
+    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].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.rb

@@ -19,27 +19,35 @@ 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 :AddressHistoricalBalanceList, 'coinbase/client/models/address_historical_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 :BroadcastStakingOperationRequest, 'coinbase/client/models/broadcast_staking_operation_request'
 Coinbase::Client.autoload :BroadcastTradeRequest, 'coinbase/client/models/broadcast_trade_request'
 Coinbase::Client.autoload :BroadcastTransferRequest, 'coinbase/client/models/broadcast_transfer_request'
 Coinbase::Client.autoload :BuildStakingOperationRequest, 'coinbase/client/models/build_staking_operation_request'
+Coinbase::Client.autoload :ContractEvent, 'coinbase/client/models/contract_event'
+Coinbase::Client.autoload :ContractEventList, 'coinbase/client/models/contract_event_list'
 Coinbase::Client.autoload :CreateAddressRequest, 'coinbase/client/models/create_address_request'
 Coinbase::Client.autoload :CreateServerSignerRequest, 'coinbase/client/models/create_server_signer_request'
+Coinbase::Client.autoload :CreateStakingOperationRequest, 'coinbase/client/models/create_staking_operation_request'
 Coinbase::Client.autoload :CreateTradeRequest, 'coinbase/client/models/create_trade_request'
 Coinbase::Client.autoload :CreateTransferRequest, 'coinbase/client/models/create_transfer_request'
 Coinbase::Client.autoload :CreateWalletRequest, 'coinbase/client/models/create_wallet_request'
 Coinbase::Client.autoload :CreateWalletRequestWallet, 'coinbase/client/models/create_wallet_request_wallet'
+Coinbase::Client.autoload :CreateWebhookRequest, 'coinbase/client/models/create_webhook_request'
 Coinbase::Client.autoload :Error, 'coinbase/client/models/error'
 Coinbase::Client.autoload :EthereumValidatorMetadata, 'coinbase/client/models/ethereum_validator_metadata'
 Coinbase::Client.autoload :FaucetTransaction, 'coinbase/client/models/faucet_transaction'
-Coinbase::Client.autoload :Feature, 'coinbase/client/models/feature'
+Coinbase::Client.autoload :FeatureSet, 'coinbase/client/models/feature_set'
+Coinbase::Client.autoload :FetchHistoricalStakingBalances200Response, 'coinbase/client/models/fetch_historical_staking_balances200_response'
 Coinbase::Client.autoload :FetchStakingRewards200Response, 'coinbase/client/models/fetch_staking_rewards200_response'
 Coinbase::Client.autoload :FetchStakingRewardsRequest, 'coinbase/client/models/fetch_staking_rewards_request'
 Coinbase::Client.autoload :GetStakingContextRequest, 'coinbase/client/models/get_staking_context_request'
-Coinbase::Client.autoload :NativeEthStakingContext, 'coinbase/client/models/native_eth_staking_context'
-Coinbase::Client.autoload :PartialEthStakingContext, 'coinbase/client/models/partial_eth_staking_context'
+Coinbase::Client.autoload :HistoricalBalance, 'coinbase/client/models/historical_balance'
+Coinbase::Client.autoload :Network, 'coinbase/client/models/network'
+Coinbase::Client.autoload :NetworkIdentifier, 'coinbase/client/models/network_identifier'
 Coinbase::Client.autoload :SeedCreationEvent, 'coinbase/client/models/seed_creation_event'
 Coinbase::Client.autoload :SeedCreationEventResult, 'coinbase/client/models/seed_creation_event_result'
 Coinbase::Client.autoload :ServerSigner, 'coinbase/client/models/server_signer'
@@ -50,29 +58,39 @@ Coinbase::Client.autoload :ServerSignerList, 'coinbase/client/models/server_sign
 Coinbase::Client.autoload :SignatureCreationEvent, 'coinbase/client/models/signature_creation_event'
 Coinbase::Client.autoload :SignatureCreationEventResult, 'coinbase/client/models/signature_creation_event_result'
 Coinbase::Client.autoload :SignedVoluntaryExitMessageMetadata, 'coinbase/client/models/signed_voluntary_exit_message_metadata'
+Coinbase::Client.autoload :SponsoredSend, 'coinbase/client/models/sponsored_send'
+Coinbase::Client.autoload :StakingBalance, 'coinbase/client/models/staking_balance'
 Coinbase::Client.autoload :StakingContext, 'coinbase/client/models/staking_context'
 Coinbase::Client.autoload :StakingContextContext, 'coinbase/client/models/staking_context_context'
 Coinbase::Client.autoload :StakingOperation, 'coinbase/client/models/staking_operation'
 Coinbase::Client.autoload :StakingOperationMetadata, 'coinbase/client/models/staking_operation_metadata'
 Coinbase::Client.autoload :StakingReward, 'coinbase/client/models/staking_reward'
 Coinbase::Client.autoload :StakingRewardFormat, 'coinbase/client/models/staking_reward_format'
+Coinbase::Client.autoload :StakingRewardUSDValue, 'coinbase/client/models/staking_reward_usd_value'
 Coinbase::Client.autoload :Trade, 'coinbase/client/models/trade'
 Coinbase::Client.autoload :TradeList, 'coinbase/client/models/trade_list'
 Coinbase::Client.autoload :Transaction, 'coinbase/client/models/transaction'
 Coinbase::Client.autoload :TransactionType, 'coinbase/client/models/transaction_type'
 Coinbase::Client.autoload :Transfer, 'coinbase/client/models/transfer'
 Coinbase::Client.autoload :TransferList, 'coinbase/client/models/transfer_list'
+Coinbase::Client.autoload :UpdateWebhookRequest, 'coinbase/client/models/update_webhook_request'
 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 :Wallet, 'coinbase/client/models/wallet'
 Coinbase::Client.autoload :WalletList, 'coinbase/client/models/wallet_list'
+Coinbase::Client.autoload :Webhook, 'coinbase/client/models/webhook'
+Coinbase::Client.autoload :WebhookEventFilter, 'coinbase/client/models/webhook_event_filter'
+Coinbase::Client.autoload :WebhookEventType, 'coinbase/client/models/webhook_event_type'
+Coinbase::Client.autoload :WebhookList, 'coinbase/client/models/webhook_list'
 
 # APIs
 Coinbase::Client.autoload :AddressesApi, 'coinbase/client/api/addresses_api'
 Coinbase::Client.autoload :AssetsApi, 'coinbase/client/api/assets_api'
+Coinbase::Client.autoload :ContractEventsApi, 'coinbase/client/api/contract_events_api'
 Coinbase::Client.autoload :ExternalAddressesApi, 'coinbase/client/api/external_addresses_api'
+Coinbase::Client.autoload :NetworksApi, 'coinbase/client/api/networks_api'
 Coinbase::Client.autoload :ServerSignersApi, 'coinbase/client/api/server_signers_api'
 Coinbase::Client.autoload :StakeApi, 'coinbase/client/api/stake_api'
 Coinbase::Client.autoload :TradesApi, 'coinbase/client/api/trades_api'
@@ -80,6 +98,7 @@ 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 :WalletsApi, 'coinbase/client/api/wallets_api'
+Coinbase::Client.autoload :WebhooksApi, 'coinbase/client/api/webhooks_api'
 
 module Coinbase::Client
   class << self

data/lib/coinbase/errors.rb

@@ -63,6 +63,13 @@ module Coinbase
     end
   end
 
+  # An error raised when a resource is already signed.
+  class AlreadySignedError < StandardError
+    def initialize(msg = 'Resource already signed')
+      super(msg)
+    end
+  end
+
   # An error raised when a transaction is not signed.
   class TransactionNotSignedError < StandardError
     def initialize(msg = 'Transaction must be signed')

data/lib/coinbase/historical_balance.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Coinbase
+  # A representation of an HistoricalBalance.
+  class HistoricalBalance
+    # Converts a Coinbase::Client::HistoricalBalance model to a Coinbase::HistoricalBalance
+    # @param historical_balance_model [Coinbase::Client::HistoricalBalance] The historical balance fetched from the API.
+    # @return [HistoricalBalance] The converted HistoricalBalance object.
+    def self.from_model(historical_balance_model)
+      asset = Coinbase::Asset.from_model(historical_balance_model.asset)
+
+      new(
+        amount: asset.from_atomic_amount(historical_balance_model.amount),
+        block_height: BigDecimal(historical_balance_model.block_height),
+        block_hash: historical_balance_model.block_hash,
+        asset: asset
+      )
+    end
+
+    # Returns a new HistoricalBalance object. Do not use this method. Instead, use Balance.from_model or
+    # Balance.from_model_and_asset_id.
+    # @param amount [BigDecimal] The amount of the Asset
+    # @param block_height [BigDecimal] The block height at which the balance was recorded
+    # @param block_hash [String] The block hash at which the balance was recorded
+    # @param asset [Asset] The asset we want to fetch
+    def initialize(amount:, block_height:, block_hash:, asset:)
+      @amount = amount
+      @block_height = block_height
+      @block_hash = block_hash
+      @asset = asset
+    end
+
+    attr_reader :amount, :block_height, :block_hash, :asset
+
+    # Returns a string representation of the HistoricalBalance.
+    # @return [String] a string representation of the HistoricalBalance
+    def to_s
+      Coinbase.pretty_print_object(
+        self.class,
+        amount: amount.to_i,
+        block_height: block_height.to_i,
+        block_hash: block_hash,
+        asset: asset
+      )
+    end
+
+    # Same as to_s.
+    # @return [String] a string representation of the HistoricalBalance
+    def inspect
+      to_s
+    end
+  end
+end

data/lib/coinbase/middleware.rb

@@ -3,6 +3,7 @@
 require_relative 'authenticator'
 require_relative 'client/configuration'
 require 'faraday'
+require 'faraday/retry'
 
 module Coinbase
   # A module for middleware that can be used with Faraday.
@@ -18,6 +19,17 @@ module Coinbase
         config.host = uri.host + (uri.port ? ":#{uri.port}" : '')
         config.scheme = uri.scheme if uri.scheme
         config.request(:authenticator)
+        retry_options = {
+          max: Coinbase.configuration.max_network_tries,
+          interval: 0.05,
+          interval_randomness: 0.5,
+          backoff_factor: 2,
+          methods: %i[get],
+          retry_statuses: [500, 502, 503, 504]
+        }
+        config.configure_faraday_connection do |conn|
+          conn.request :retry, retry_options
+        end
       end
     end
   end

data/lib/coinbase/server_signer.rb

@@ -5,9 +5,15 @@ require_relative 'client'
 module Coinbase
   # A representation of a Server-Signer. Server-Signers are assigned to sign transactions for a Wallet.
   class ServerSigner
-    # Returns a new Server-Signer object. Do not use this method directly. Instead, use ServerSigner.default.
-    def initialize(model)
-      @model = model
+    # A representation of ServerSigner status in a Wallet.
+    module Status
+      # The Wallet is awaiting seed creation by the ServerSigner. At this point,
+      # the Wallet cannot create addresses or sign transactions.
+      PENDING = 'pending_seed_creation'
+
+      # The Wallet has an associated seed created by the ServerSigner. It is ready
+      # to create addresses and sign transactions.
+      ACTIVE = 'active_seed'
     end
 
     class << self
@@ -30,6 +36,11 @@ module Coinbase
       end
     end
 
+    # Returns a new Server-Signer object. Do not use this method directly. Instead, use ServerSigner.default.
+    def initialize(model)
+      @model = model
+    end
+
     # Returns the Server-Signer ID.
     # @return [String] the Server-Signer ID
     def id

data/lib/coinbase/sponsored_send.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require 'eth'
+
+module Coinbase
+  # A representation of an onchain Sponsored Send.
+  # Sponsored Sends should be constructed via higher level abstractions like Transfer.
+  class SponsoredSend
+    # A representation of a Transaction status.
+    module Status
+      # The SponsoredSend is awaiting being signed.
+      PENDING = 'pending'
+
+      # The Sponsored Send has been signed, but has not been submitted to be
+      # built into a transaction yet.
+      SIGNED = 'signed'
+
+      # The Sponsored Send has been submitted to be built into a transaction,
+      # that the sponsor will sign and submit to the network.
+      # At this point, transaction hashes may not yet be assigned.
+      SUBMITTED = 'submitted'
+
+      # The Sponsored Send's corresponding transaction is complete and has
+      # confirmed on the Network.
+      COMPLETE = 'complete'
+
+      # The Sponsored Send has failed for some reason.
+      FAILED = 'failed'
+
+      # The states that are considered terminal on-chain.
+      TERMINAL_STATES = [COMPLETE, FAILED].freeze
+    end
+
+    # Returns a new SponsoredSend object. Do not use this method directly.
+    # @param model [Coinbase::Client::SponsoredSend] The underlying SponsoredSend object
+    def initialize(model)
+      raise unless model.is_a?(Coinbase::Client::SponsoredSend)
+
+      @model = model
+    end
+
+    # Returns the Keccak256 hash of the typed data. This payload must be signed
+    # by the sender to be used as an approval in the EIP-3009 transaction.
+    # @return [String] The Keccak256 hash of the typed data
+    def typed_data_hash
+      @model.typed_data_hash
+    end
+
+    # Returns the signature of the typed data.
+    def signature
+      @signature ||= @model.signature
+    end
+
+    # Signs the Transaction with the provided key and returns the hex signing payload.
+    # @return [String] The hex-encoded signed payload
+    def sign(key)
+      raise unless key.is_a?(Eth::Key)
+      raise Coinbase::AlreadySignedError if signed?
+
+      @signature = Eth::Util.prefix_hex(key.sign(Eth::Util.hex_to_bin(typed_data_hash)))
+    end
+
+    # Returns whether the Transaction has been signed.
+    # @return [Boolean] Whether the Transaction has been signed
+    def signed?
+      !signature.nil?
+    end
+
+    # Returns the status of the Transaction.
+    # @return [Symbol] The status
+    def status
+      @model.status
+    end
+
+    # Returns whether the Sponsored Send is in a terminal state.
+    # @return [Boolean] Whether the Transaction is in a terminal state
+    def terminal_state?
+      Status::TERMINAL_STATES.include?(status)
+    end
+
+    # Returns the Transaction Hash of the Transaction.
+    # @return [String] The 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
+      @model.transaction_link
+    end
+
+    # Returns a String representation of the SponsoredSend.
+    # @return [String] a String representation of the SponsoredSend
+    def to_s
+      Coinbase.pretty_print_object(
+        self.class,
+        status: status,
+        transaction_hash: transaction_hash,
+        transaction_link: transaction_link
+      )
+    end
+
+    # Same as to_s.
+    # @return [String] a String representation of the SponsoredSend
+    def inspect
+      to_s
+    end
+  end
+end

data/lib/coinbase/staking_balance.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'date'
+
+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 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)
+      Coinbase::Pagination.enumerate(
+        ->(page) { list_page(network_id, asset_id, address_id, start_time, end_time, page) }
+      ) do |staking_balance|
+        new(staking_balance)
+      end
+    end
+
+    # Returns a new StakingBalance object.
+    # @param model [Coinbase::Client::StakingBalance] The underlying StakingBalance object
+    def initialize(model)
+      @model = model
+    end
+
+    # Returns the date of the StakingBalance.
+    # @return [Time] The date
+    def date
+      @model.date
+    end
+
+    # Returns the onchain address of the StakingBalance.
+    # @return [Time] The onchain address
+    def address
+      @model.address
+    end
+
+    # Returns the bonded stake as a Balance
+    # @return [Balance] The bonded stake
+    def bonded_stake
+      @bonded_stake ||= Balance.from_model(@model.bonded_stake)
+    end
+
+    # Returns the unbonded balance as a Balance
+    # @return [Balance] The unbonded balance
+    def unbonded_balance
+      @unbonded_balance ||= Balance.from_model(@model.unbonded_balance)
+    end
+
+    # Returns the participant type of the StakingBalance.
+    # @return [String] The participant type
+    def participant_type
+      @model.participant_type
+    end
+
+    # Returns a string representation of the StakingBalance.
+    # @return [String] a string representation of the StakingBalance
+    def to_s
+      "Coinbase::StakingBalance{date: '#{date}' address: '#{address}'}"
+    end
+
+    # Same as to_s.
+    # @return [String] a string representation of the StakingBalance
+    def inspect
+      to_s
+    end
+
+    def self.stake_api
+      Coinbase::Client::StakeApi.new(Coinbase.configuration.api_client)
+    end
+
+    def self.list_page(network_id, asset_id, address_id, start_time, end_time, page)
+      stake_api.fetch_historical_staking_balances(
+        Coinbase.normalize_network(network_id),
+        asset_id,
+        address_id,
+        start_time.iso8601,
+        end_time.iso8601,
+        { next_page: page }
+      )
+    end
+  end
+end