coinbase-sdk 0.0.13 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ea6f3f49e4b03f6131d891a1e628b9bed3a60b40b0a640358b5cc85ff4075ab
-  data.tar.gz: 92d2b00b3dac22f12173f9b6a7860889b7d9e64966e55cf7ba175a3728f43be3
+  metadata.gz: addb2d81db155719e42cf1c4057498fc8094fcf436e3a67276870b3ff77a2d69
+  data.tar.gz: 6e1a0078557be2d0fe83979c66ec9415e77edbef0b6f72ef510d69aaf7580041
 SHA512:
-  metadata.gz: c4a96ebe5f58f569419d2911aab739706d4176fb403b2283d8b44d29f36768bcf2588088f1870cbabc7a7f4941d12a9d796565e60c126014c48b318725fb8d13
-  data.tar.gz: d97661b3ab9abb774561a307bb228c1d3795077777001ca5b6657f2205cf81f8674f68ef4bb9dff4b01623cfffa5c2835e26e58d26dbbf51a8bfcd70b13edc52
+  metadata.gz: 22648511bb07f598908f4b81fc87a8d06279e122b809d21a294e38b48cd54c65490a7c5009ebf6e013baffd8de7fba174017dbe6f75777e489646d9b735c885a
+  data.tar.gz: 623ecc923feb473a6a491ae07a536216ac5bf7f5648bf6e9eab8eca956ce88232973d98a376c67a61f71fade05587ba6e07300f7766d7ba3436397fce55ea994

data/lib/coinbase/address/external_address.rb

@@ -3,171 +3,8 @@
 require 'date'
 
 module Coinbase
-  # A representation of a blockchain Address that do not belong to a Coinbase::Wallet.
-  # External addresses can be used to fetch balances, request funds from the faucet, etc...,
+  # A representation of a blockchain Address that does not belong to a Coinbase::Wallet.
+  # External addresses can be used to fetch balances, request funds from the faucet, etc.,
   # but cannot be used to sign transactions.
-  class ExternalAddress < Address
-    # Builds a stake operation for the supplied asset. The stake operation
-    # may take a few minutes to complete in the case when infrastructure is spun up.
-    # @param amount [Integer,String,BigDecimal] The amount of the asset to stake
-    # @param asset_id [Symbol] The asset to stake
-    # @param mode [Symbol] The staking mode. Defaults to :default.
-    # @param options [Hash] Additional options for the stake operation
-    # @return [Coinbase::StakingOperation] The stake operation
-    def build_stake_operation(amount, asset_id, mode: :default, options: {})
-      validate_can_stake!(amount, asset_id, mode, options)
-
-      build_staking_operation(amount, asset_id, 'stake', mode: mode, options: options)
-    end
-
-    # Builds an unstake operation for the supplied asset.
-    # @param amount [Integer,String,BigDecimal] The amount of the asset to unstake
-    # @param asset_id [Symbol] The asset to unstake
-    # @param mode [Symbol] The staking mode. Defaults to :default.
-    # @param options [Hash] Additional options for the unstake operation
-    # @return [Coinbase::StakingOperation] The unstake operation
-    def build_unstake_operation(amount, asset_id, mode: :default, options: {})
-      validate_can_unstake!(amount, asset_id, mode, options)
-
-      build_staking_operation(amount, asset_id, 'unstake', mode: mode, options: options)
-    end
-
-    # Builds an claim_stake operation for the supplied asset.
-    # @param amount [Integer,String,BigDecimal] The amount of the asset to claim
-    # @param asset_id [Symbol] The asset to claim
-    # @param mode [Symbol] The staking mode. Defaults to :default.
-    # @param options [Hash] Additional options for the claim_stake operation
-    # @return [Coinbase::StakingOperation] The claim_stake operation
-    def build_claim_stake_operation(amount, asset_id, mode: :default, options: {})
-      validate_can_claim_stake!(amount, asset_id, mode, options)
-
-      build_staking_operation(amount, asset_id, 'claim_stake', mode: mode, options: options)
-    end
-
-    # Retrieves the balances used for staking for the supplied asset.
-    # @param asset_id [Symbol] The asset to retrieve staking balances for
-    # @param mode [Symbol] The staking mode. Defaults to :default.
-    # @param options [Hash] Additional options for the staking operation
-    # @return [Hash] The staking balances
-    # @return [BigDecimal] :stakeable_balance The amount of the asset that can be staked
-    # @return [BigDecimal] :unstakeable_balance The amount of the asset that is currently staked and cannot be unstaked
-    # @return [BigDecimal] :claimable_balance The amount of the asset that can be claimed
-    def staking_balances(asset_id, mode: :default, options: {})
-      context_model = Coinbase.call_api do
-        stake_api.get_staking_context(
-          {
-            asset_id: asset_id,
-            network_id: Coinbase.normalize_network(network_id),
-            address_id: id,
-            options: {
-              mode: mode
-            }.merge(options)
-          }
-        )
-      end.context
-
-      {
-        stakeable_balance: Coinbase::Balance.from_model_and_asset_id(
-          context_model.stakeable_balance,
-          asset_id
-        ).amount,
-        unstakeable_balance: Coinbase::Balance.from_model_and_asset_id(
-          context_model.unstakeable_balance,
-          asset_id
-        ).amount,
-        claimable_balance: Coinbase::Balance.from_model_and_asset_id(
-          context_model.claimable_balance,
-          asset_id
-        ).amount
-      }
-    end
-
-    # Retrieves the stakeable balance for the supplied asset.
-    # @param asset_id [Symbol] The asset to retrieve the stakeable balance for
-    # @param mode [Symbol] The staking mode. Defaults to :default.
-    # @param options [Hash] Additional options for the staking operation
-    # @return [BigDecimal] The stakeable balance
-    def stakeable_balance(asset_id, mode: :default, options: {})
-      staking_balances(asset_id, mode: mode, options: options)[:stakeable_balance]
-    end
-
-    # Retrieves the unstakeable balance for the supplied asset.
-    # @param asset_id [Symbol] The asset to retrieve the unstakeable balance for
-    # @param mode [Symbol] The staking mode. Defaults to :default.
-    # @param options [Hash] Additional options for the staking operation
-    # @return [BigDecimal] The unstakeable balance
-    def unstakeable_balance(asset_id, mode: :default, options: {})
-      staking_balances(asset_id, mode: mode, options: options)[:unstakeable_balance]
-    end
-
-    # Retrieves the claimable balance for the supplied asset.
-    # @param asset_id [Symbol] The asset to retrieve the claimable balance for
-    # @param mode [Symbol] The staking mode. Defaults to :default.
-    # @param options [Hash] Additional options for the staking operation
-    # @return [BigDecimal] The claimable balance
-    def claimable_balance(asset_id, mode: :default, options: {})
-      staking_balances(asset_id, mode: mode, options: options)[:claimable_balance]
-    end
-
-    # Lists the staking rewards for the address.
-    # @param asset_id [Symbol] The asset to retrieve staking rewards for
-    # @param start_time [Time] The start time for the rewards. Defaults to 1 month ago.
-    # @param end_time [Time] The end time for the rewards. Defaults to the current time.
-    # @param format [Symbol] The format to return the rewards in. Defaults to :usd.
-    # @return [Enumerable<Coinbase::StakingReward>] The staking rewards
-    def staking_rewards(asset_id, start_time: DateTime.now.prev_month(1), end_time: DateTime.now, format: :usd)
-      StakingReward.list(
-        network_id,
-        asset_id,
-        [id],
-        start_time: start_time,
-        end_time: end_time,
-        format: format
-      )
-    end
-
-    private
-
-    def validate_can_stake!(amount, asset_id, mode, options)
-      stakeable_balance = stakeable_balance(asset_id, mode: mode, options: options)
-
-      raise InsufficientFundsError.new(amount, stakeable_balance) unless stakeable_balance >= amount
-    end
-
-    def validate_can_unstake!(amount, asset_id, mode, options)
-      unstakeable_balance = unstakeable_balance(asset_id, mode: mode, options: options)
-
-      raise InsufficientFundsError.new(amount, unstakeable_balance) unless unstakeable_balance >= amount
-    end
-
-    def validate_can_claim_stake!(amount, asset_id, mode, options)
-      claimable_balance = claimable_balance(asset_id, mode: mode, options: options)
-
-      raise InsufficientFundsError.new(amount, claimable_balance) unless claimable_balance >= amount
-    end
-
-    def build_staking_operation(amount, asset_id, action, mode: :default, options: {})
-      operation_model = Coinbase.call_api do
-        asset = Coinbase::Asset.fetch(network_id, asset_id)
-        stake_api.build_staking_operation(
-          {
-            asset_id: asset.primary_denomination.to_s,
-            address_id: id,
-            action: action,
-            network_id: Coinbase.normalize_network(network_id),
-            options: {
-              amount: asset.to_atomic_amount(amount).to_i.to_s,
-              mode: mode
-            }.merge(options)
-          }
-        )
-      end
-
-      StakingOperation.new(operation_model)
-    end
-
-    def stake_api
-      @stake_api ||= Coinbase::Client::StakeApi.new(Coinbase.configuration.api_client)
-    end
-  end
+  class ExternalAddress < Address; end
 end

data/lib/coinbase/address/wallet_address.rb

@@ -39,8 +39,11 @@ module Coinbase
     # @param asset_id [Symbol] The ID of the Asset to send. For Ether, :eth, :gwei, and :wei are supported.
     # @param destination [Wallet | Address | String] The destination of the transfer. If a Wallet, sends to the Wallet's
     #  default address. If a String, interprets it as the address ID.
+    # @param gasless [Boolean] Whether gas fee for the transfer should be covered by Coinbase.
+    #   Defaults to false. Check the API documentation for network and asset support.
+    # Whether the transfer should be gasless. Defaults to false.
     # @return [Coinbase::Transfer] The Transfer object.
-    def transfer(amount, asset_id, destination)
+    def transfer(amount, asset_id, destination, gasless: false)
       ensure_can_sign!
       ensure_sufficient_balance!(amount, asset_id)
 
@@ -50,14 +53,14 @@ module Coinbase
         asset_id: asset_id,
         destination: destination,
         network_id: network_id,
-        wallet_id: wallet_id
+        wallet_id: wallet_id,
+        gasless: gasless
       )
 
       # If a server signer is managing keys, it will sign and broadcast the underlying transfer transaction out of band.
       return transfer if Coinbase.use_server_signer?
 
-      transfer.transaction.sign(@key)
-
+      transfer.sign(@key)
       transfer.broadcast!
       transfer
     end
@@ -92,6 +95,42 @@ module Coinbase
       trade
     end
 
+    # Stakes the given amount of the given Asset
+    # @param amount [Integer, Float, BigDecimal] The amount of the Asset to stake.
+    # @param asset_id [Symbol] The ID of the Asset to stake. For Ether, :eth, :gwei, and :wei are supported.
+    # @param mode [Symbol] The staking mode. Defaults to :default.
+    # @param options [Hash] Additional options for the stake operation
+    # @return [Coinbase::StakingOperation] The staking operation
+    def stake(amount, asset_id, mode: :default, options: {})
+      validate_can_perform_staking_action!(amount, asset_id, 'stakeable_balance', mode, options)
+
+      complete_staking_operation(amount, asset_id, 'stake', mode: mode, options: options)
+    end
+
+    # Unstakes the given amount of the given Asset
+    # @param amount [Integer, Float, BigDecimal] The amount of the Asset to unstake.
+    # @param asset_id [Symbol] The ID of the Asset to stake. For Ether, :eth, :gwei, and :wei are supported.
+    # @param mode [Symbol] The staking mode. Defaults to :default.
+    # @param options [Hash] Additional options for the stake operation
+    # @return [Coinbase::StakingOperation] The staking operation
+    def unstake(amount, asset_id, mode: :default, options: {})
+      validate_can_perform_staking_action!(amount, asset_id, 'unstakeable_balance', mode, options)
+
+      complete_staking_operation(amount, asset_id, 'unstake', mode: mode, options: options)
+    end
+
+    # Claims the given amount of the given Asset
+    # @param amount [Integer, Float, BigDecimal] The amount of the Asset to claim.
+    # @param asset_id [Symbol] The ID of the Asset to stake. For Ether, :eth, :gwei, and :wei are supported.
+    # @param mode [Symbol] The staking mode. Defaults to :default.
+    # @param options [Hash] Additional options for the stake operation
+    # @return [Coinbase::StakingOperation] The staking operation
+    def claim_stake(amount, asset_id, mode: :default, options: {})
+      validate_can_perform_staking_action!(amount, asset_id, 'claimable_balance', mode, options)
+
+      complete_staking_operation(amount, asset_id, 'claim_stake', mode: mode, options: options)
+    end
+
     # Returns whether the Address has a private key backing it to sign transactions.
     # @return [Boolean] Whether the Address has a private key backing it to sign transactions.
     def can_sign?
@@ -144,5 +183,13 @@ module Coinbase
 
       raise InsufficientFundsError.new(amount, current_balance)
     end
+
+    def complete_staking_operation(amount, asset_id, action, mode: :default, options: {})
+      op = StakingOperation.create(amount, network_id, asset_id, id, wallet_id, action, mode, options)
+      op.transactions.each do |transaction|
+        transaction.sign(@key)
+      end
+      op.broadcast!
+    end
   end
 end

data/lib/coinbase/address.rb

@@ -62,6 +62,18 @@ module Coinbase
       Coinbase::Balance.from_model_and_asset_id(response, asset_id).amount
     end
 
+    # Enumerates the historical balances for a given asset belonging of address.
+    # The result is an enumerator that lazily fetches from the server, and can be iterated over,
+    # converted to an array, etc...
+    # @return [Enumerable<Coinbase::HistoricalBalance>] Enumerator that returns historical_balance
+    def historical_balances(asset_id)
+      Coinbase::Pagination.enumerate(
+        ->(page) { list_page(asset_id, page) }
+      ) do |historical_balance|
+        Coinbase::HistoricalBalance.from_model(historical_balance)
+      end
+    end
+
     # Requests funds for the address from the faucet and returns the faucet transaction.
     # This is only supported on testnet networks.
     # @return [Coinbase::FaucetTransaction] The successful faucet transaction
@@ -75,10 +87,162 @@ module Coinbase
       end
     end
 
+    # Builds a stake operation for the supplied asset. The stake operation
+    # may take a few minutes to complete in the case when infrastructure is spun up.
+    # @param amount [Integer,String,BigDecimal] The amount of the asset to stake
+    # @param asset_id [Symbol] The asset to stake
+    # @param mode [Symbol] The staking mode. Defaults to :default.
+    # @param options [Hash] Additional options for the stake operation
+    # @return [Coinbase::StakingOperation] The stake operation
+    def build_stake_operation(amount, asset_id, mode: :default, options: {})
+      validate_can_perform_staking_action!(amount, asset_id, 'stakeable_balance', mode, options)
+
+      StakingOperation.build(amount, network_id, asset_id, id, 'stake', mode, options)
+    end
+
+    # Builds an unstake operation for the supplied asset.
+    # @param amount [Integer,String,BigDecimal] The amount of the asset to unstake
+    # @param asset_id [Symbol] The asset to unstake
+    # @param mode [Symbol] The staking mode. Defaults to :default.
+    # @param options [Hash] Additional options for the unstake operation
+    # @return [Coinbase::StakingOperation] The unstake operation
+    def build_unstake_operation(amount, asset_id, mode: :default, options: {})
+      validate_can_perform_staking_action!(amount, asset_id, 'unstakeable_balance', mode, options)
+
+      StakingOperation.build(amount, network_id, asset_id, id, 'unstake', mode, options)
+    end
+
+    # Builds a claim_stake operation for the supplied asset.
+    # @param amount [Integer,String,BigDecimal] The amount of the asset to claim
+    # @param asset_id [Symbol] The asset to claim
+    # @param mode [Symbol] The staking mode. Defaults to :default.
+    # @param options [Hash] Additional options for the claim_stake operation
+    # @return [Coinbase::StakingOperation] The claim_stake operation
+    def build_claim_stake_operation(amount, asset_id, mode: :default, options: {})
+      validate_can_perform_staking_action!(amount, asset_id, 'claimable_balance', mode, options)
+
+      StakingOperation.build(amount, network_id, asset_id, id, 'claim_stake', mode, options)
+    end
+
+    # Retrieves the balances used for staking for the supplied asset.
+    # @param asset_id [Symbol] The asset to retrieve staking balances for
+    # @param mode [Symbol] The staking mode. Defaults to :default.
+    # @param options [Hash] Additional options for the staking operation
+    # @return [Hash] The staking balances
+    # @return [BigDecimal] :stakeable_balance The amount of the asset that can be staked
+    # @return [BigDecimal] :unstakeable_balance The amount of the asset that is currently staked and cannot be unstaked
+    # @return [BigDecimal] :claimable_balance The amount of the asset that can be claimed
+    def staking_balances(asset_id, mode: :default, options: {})
+      context_model = Coinbase.call_api do
+        stake_api.get_staking_context(
+          {
+            asset_id: asset_id,
+            network_id: Coinbase.normalize_network(network_id),
+            address_id: id,
+            options: {
+              mode: mode
+            }.merge(options)
+          }
+        )
+      end.context
+
+      {
+        stakeable_balance: Coinbase::Balance.from_model_and_asset_id(
+          context_model.stakeable_balance,
+          asset_id
+        ).amount,
+        unstakeable_balance: Coinbase::Balance.from_model_and_asset_id(
+          context_model.unstakeable_balance,
+          asset_id
+        ).amount,
+        claimable_balance: Coinbase::Balance.from_model_and_asset_id(
+          context_model.claimable_balance,
+          asset_id
+        ).amount
+      }
+    end
+
+    # Retrieves the stakeable balance for the supplied asset.
+    # @param asset_id [Symbol] The asset to retrieve the stakeable balance for
+    # @param mode [Symbol] The staking mode. Defaults to :default.
+    # @param options [Hash] Additional options for the staking operation
+    # @return [BigDecimal] The stakeable balance
+    def stakeable_balance(asset_id, mode: :default, options: {})
+      staking_balances(asset_id, mode: mode, options: options)[:stakeable_balance]
+    end
+
+    # Retrieves the unstakeable balance for the supplied asset.
+    # @param asset_id [Symbol] The asset to retrieve the unstakeable balance for
+    # @param mode [Symbol] The staking mode. Defaults to :default.
+    # @param options [Hash] Additional options for the staking operation
+    # @return [BigDecimal] The unstakeable balance
+    def unstakeable_balance(asset_id, mode: :default, options: {})
+      staking_balances(asset_id, mode: mode, options: options)[:unstakeable_balance]
+    end
+
+    # Retrieves the claimable balance for the supplied asset.
+    # @param asset_id [Symbol] The asset to retrieve the claimable balance for
+    # @param mode [Symbol] The staking mode. Defaults to :default.
+    # @param options [Hash] Additional options for the staking operation
+    # @return [BigDecimal] The claimable balance
+    def claimable_balance(asset_id, mode: :default, options: {})
+      staking_balances(asset_id, mode: mode, options: options)[:claimable_balance]
+    end
+
+    # Lists the staking rewards for the address.
+    # @param asset_id [Symbol] The asset to retrieve staking rewards for
+    # @param start_time [Time] The start time for the rewards. Defaults to 1 week ago.
+    # @param end_time [Time] The end time for the rewards. Defaults to the current time.
+    # @param format [Symbol] The format to return the rewards in. Defaults to :usd.
+    # @return [Enumerable<Coinbase::StakingReward>] The staking rewards
+    def staking_rewards(asset_id, start_time: DateTime.now.prev_week(1), end_time: DateTime.now, format: :usd)
+      StakingReward.list(
+        network_id,
+        asset_id,
+        [id],
+        start_time: start_time,
+        end_time: end_time,
+        format: format
+      )
+    end
+
+    # Fetches the historical staking balances for the address.
+    # @param asset_id [Symbol] The asset to retrieve staking rewards for
+    # @param start_time [Time] The start time for the rewards. Defaults to 1 week ago.
+    # @param end_time [Time] The end time for the rewards. Defaults to the current time.
+    # @return [Enumerable<Coinbase::StakingBalance>] The staking rewards
+    def historical_staking_balances(asset_id, start_time: DateTime.now.prev_week(1), end_time: DateTime.now)
+      StakingBalance.list(
+        network_id,
+        asset_id,
+        id,
+        start_time: start_time,
+        end_time: end_time
+      )
+    end
+
     private
 
+    def validate_can_perform_staking_action!(amount, asset_id, balance_type, mode, options)
+      current_staking_balance = staking_balances(asset_id, mode: mode, options: options)[balance_type.to_sym]
+      raise InsufficientFundsError.new(amount, current_staking_balance) unless current_staking_balance >= amount
+    end
+
     def addresses_api
       @addresses_api ||= Coinbase::Client::ExternalAddressesApi.new(Coinbase.configuration.api_client)
     end
+
+    def stake_api
+      @stake_api ||= Coinbase::Client::StakeApi.new(Coinbase.configuration.api_client)
+    end
+
+    def list_page(asset_id, page)
+      addresses_api.list_address_historical_balance(
+        Coinbase.normalize_network(network_id),
+        id,
+        Coinbase::Asset.primary_denomination(asset_id).to_s,
+        { limit: DEFAULT_PAGE_LIMIT, page: page }
+      )
+    end
   end
 end

data/lib/coinbase/client/api/assets_api.rb

@@ -22,7 +22,7 @@ module Coinbase::Client
     # Get the asset for the specified asset ID.
     # Get the asset for the specified asset ID.
     # @param network_id [String] The ID of the blockchain network
-    # @param asset_id [String] The ID of the asset to fetch
+    # @param asset_id [String] The ID of the asset to fetch. This could be a symbol or an ERC20 contract address.
     # @param [Hash] opts the optional parameters
     # @return [Asset]
     def get_asset(network_id, asset_id, opts = {})
@@ -33,7 +33,7 @@ module Coinbase::Client
     # Get the asset for the specified asset ID.
     # Get the asset for the specified asset ID.
     # @param network_id [String] The ID of the blockchain network
-    # @param asset_id [String] The ID of the asset to fetch
+    # @param asset_id [String] The ID of the asset to fetch. This could be a symbol or an ERC20 contract address.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Asset, Integer, Hash)>] Asset data, response status code and response headers
     def get_asset_with_http_info(network_id, asset_id, opts = {})

data/lib/coinbase/client/api/contract_events_api.rb

@@ -0,0 +1,121 @@
+=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 'cgi'
+
+module Coinbase::Client
+  class ContractEventsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get contract events
+    # Retrieve events for a specific contract
+    # @param network_id [String] Unique identifier for the blockchain network
+    # @param protocol_name [String] Case-sensitive name of the blockchain protocol
+    # @param contract_address [String] EVM address of the smart contract (42 characters, including '0x', in lowercase)
+    # @param from_block_height [Integer] Lower bound of the block range to query (inclusive)
+    # @param to_block_height [Integer] Upper bound of the block range to query (inclusive)
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :contract_name Case-sensitive name of the specific contract within the project
+    # @option opts [String] :event_name Case-sensitive name of the event to filter for in the contract's logs
+    # @option opts [String] :next_page Pagination token for retrieving the next set of results
+    # @return [ContractEventList]
+    def list_contract_events(network_id, protocol_name, contract_address, from_block_height, to_block_height, opts = {})
+      data, _status_code, _headers = list_contract_events_with_http_info(network_id, protocol_name, contract_address, from_block_height, to_block_height, opts)
+      data
+    end
+
+    # Get contract events
+    # Retrieve events for a specific contract
+    # @param network_id [String] Unique identifier for the blockchain network
+    # @param protocol_name [String] Case-sensitive name of the blockchain protocol
+    # @param contract_address [String] EVM address of the smart contract (42 characters, including '0x', in lowercase)
+    # @param from_block_height [Integer] Lower bound of the block range to query (inclusive)
+    # @param to_block_height [Integer] Upper bound of the block range to query (inclusive)
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :contract_name Case-sensitive name of the specific contract within the project
+    # @option opts [String] :event_name Case-sensitive name of the event to filter for in the contract's logs
+    # @option opts [String] :next_page Pagination token for retrieving the next set of results
+    # @return [Array<(ContractEventList, Integer, Hash)>] ContractEventList data, response status code and response headers
+    def list_contract_events_with_http_info(network_id, protocol_name, contract_address, from_block_height, to_block_height, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ContractEventsApi.list_contract_events ...'
+      end
+      # verify the required parameter 'network_id' is set
+      if @api_client.config.client_side_validation && network_id.nil?
+        fail ArgumentError, "Missing the required parameter 'network_id' when calling ContractEventsApi.list_contract_events"
+      end
+      # verify the required parameter 'protocol_name' is set
+      if @api_client.config.client_side_validation && protocol_name.nil?
+        fail ArgumentError, "Missing the required parameter 'protocol_name' when calling ContractEventsApi.list_contract_events"
+      end
+      # verify the required parameter 'contract_address' is set
+      if @api_client.config.client_side_validation && contract_address.nil?
+        fail ArgumentError, "Missing the required parameter 'contract_address' when calling ContractEventsApi.list_contract_events"
+      end
+      # verify the required parameter 'from_block_height' is set
+      if @api_client.config.client_side_validation && from_block_height.nil?
+        fail ArgumentError, "Missing the required parameter 'from_block_height' when calling ContractEventsApi.list_contract_events"
+      end
+      # verify the required parameter 'to_block_height' is set
+      if @api_client.config.client_side_validation && to_block_height.nil?
+        fail ArgumentError, "Missing the required parameter 'to_block_height' when calling ContractEventsApi.list_contract_events"
+      end
+      # resource path
+      local_var_path = '/v1/networks/{network_id}/smart_contracts/{contract_address}/events'.sub('{' + 'network_id' + '}', CGI.escape(network_id.to_s)).sub('{' + 'contract_address' + '}', CGI.escape(contract_address.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'protocol_name'] = protocol_name
+      query_params[:'from_block_height'] = from_block_height
+      query_params[:'to_block_height'] = to_block_height
+      query_params[:'contract_name'] = opts[:'contract_name'] if !opts[:'contract_name'].nil?
+      query_params[:'event_name'] = opts[:'event_name'] if !opts[:'event_name'].nil?
+      query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ContractEventList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ContractEventsApi.list_contract_events",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ContractEventsApi#list_contract_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end