coinbase-sdk 0.0.16 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: addb2d81db155719e42cf1c4057498fc8094fcf436e3a67276870b3ff77a2d69
-  data.tar.gz: 6e1a0078557be2d0fe83979c66ec9415e77edbef0b6f72ef510d69aaf7580041
+  metadata.gz: 1c8786bfb21ed8e6e8533244582389e90f94a7b5587b4995666ad5e02424fb30
+  data.tar.gz: cb4dca1f054511410761372ced09d65491ee38e21b1d9ad8b2fb90ce08e80869
 SHA512:
-  metadata.gz: 22648511bb07f598908f4b81fc87a8d06279e122b809d21a294e38b48cd54c65490a7c5009ebf6e013baffd8de7fba174017dbe6f75777e489646d9b735c885a
-  data.tar.gz: 623ecc923feb473a6a491ae07a536216ac5bf7f5648bf6e9eab8eca956ce88232973d98a376c67a61f71fade05587ba6e07300f7766d7ba3436397fce55ea994
+  metadata.gz: 2226115a66b26e4bd42429506b91ce04617440e4ce79744eddea43881d53b6814341e110fb4adf0e6967ef7e2ee57b5f13aacb44d074bb170564808bc86ec216
+  data.tar.gz: 7ee730264721461357d56f0ad7e0630036ca85d28ab120101c6813e64fca9427d919fc1a35d8c49ffc39cf1eb9a8ca34fa492211c4c86397afd88a82f685f0c8

data/lib/coinbase/address/wallet_address.rb

@@ -52,7 +52,7 @@ module Coinbase
         amount: amount,
         asset_id: asset_id,
         destination: destination,
-        network_id: network_id,
+        network: network,
         wallet_id: wallet_id,
         gasless: gasless
       )
@@ -80,7 +80,7 @@ module Coinbase
         amount: amount,
         from_asset_id: from_asset_id,
         to_asset_id: to_asset_id,
-        network_id: network_id,
+        network: network,
         wallet_id: wallet_id
       )
 
@@ -100,11 +100,16 @@ module Coinbase
     # @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
+    # @param interval_seconds [Integer] The number of seconds to wait between polling for updates. Defaults to 5.
+    # @param timeout_seconds [Integer] The number of seconds to wait before timing out. Defaults to 600.
     # @return [Coinbase::StakingOperation] The staking operation
-    def stake(amount, asset_id, mode: :default, options: {})
+    # @raise [Timeout::Error] if the Staking Operation takes longer than the given timeout.
+    def stake(amount, asset_id, mode: :default, options: {}, interval_seconds: 5, timeout_seconds: 600)
       validate_can_perform_staking_action!(amount, asset_id, 'stakeable_balance', mode, options)
 
-      complete_staking_operation(amount, asset_id, 'stake', mode: mode, options: options)
+      op = StakingOperation.create(amount, network, asset_id, id, wallet_id, 'stake', mode, options)
+
+      op.complete(@key, interval_seconds: interval_seconds, timeout_seconds: timeout_seconds)
     end
 
     # Unstakes the given amount of the given Asset
@@ -112,11 +117,16 @@ module Coinbase
     # @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
+    # @param interval_seconds [Integer] The number of seconds to wait between polling for updates. Defaults to 5.
+    # @param timeout_seconds [Integer] The number of seconds to wait before timing out. Defaults to 600.
     # @return [Coinbase::StakingOperation] The staking operation
-    def unstake(amount, asset_id, mode: :default, options: {})
+    # @raise [Timeout::Error] if the Staking Operation takes longer than the given timeout.
+    def unstake(amount, asset_id, mode: :default, options: {}, interval_seconds: 5, timeout_seconds: 600)
       validate_can_perform_staking_action!(amount, asset_id, 'unstakeable_balance', mode, options)
 
-      complete_staking_operation(amount, asset_id, 'unstake', mode: mode, options: options)
+      op = StakingOperation.create(amount, network, asset_id, id, wallet_id, 'unstake', mode, options)
+
+      op.complete(@key, interval_seconds: interval_seconds, timeout_seconds: timeout_seconds)
     end
 
     # Claims the given amount of the given Asset
@@ -124,11 +134,16 @@ module Coinbase
     # @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
+    # @param interval_seconds [Integer] The number of seconds to wait between polling for updates. Defaults to 5.
+    # @param timeout_seconds [Integer] The number of seconds to wait before timing out. Defaults to 600.
     # @return [Coinbase::StakingOperation] The staking operation
-    def claim_stake(amount, asset_id, mode: :default, options: {})
+    # @raise [Timeout::Error] if the Staking Operation takes longer than the given timeout.
+    def claim_stake(amount, asset_id, mode: :default, options: {}, interval_seconds: 5, timeout_seconds: 600)
       validate_can_perform_staking_action!(amount, asset_id, 'claimable_balance', mode, options)
 
-      complete_staking_operation(amount, asset_id, 'claim_stake', mode: mode, options: options)
+      op = StakingOperation.create(amount, network, asset_id, id, wallet_id, 'claim_stake', mode, options)
+
+      op.complete(@key, interval_seconds: interval_seconds, timeout_seconds: timeout_seconds)
     end
 
     # Returns whether the Address has a private key backing it to sign transactions.
@@ -164,7 +179,7 @@ module Coinbase
     # Returns a String representation of the WalletAddress.
     # @return [String] a String representation of the WalletAddress
     def to_s
-      "Coinbase::Address{id: '#{id}', network_id: '#{network_id}', wallet_id: '#{wallet_id}'}"
+      "Coinbase::Address{id: '#{id}', network_id: '#{network.id}', wallet_id: '#{wallet_id}'}"
     end
 
     private
@@ -183,13 +198,5 @@ 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

@@ -1,25 +1,23 @@
 # frozen_string_literal: true
 
 module Coinbase
-  # A representation of a blockchain Address, which is a user-controlled account on a Network. Addresses are used to
-  # send and receive Assets.
-  # @attr_reader [Symbol] network_id The Network ID
-  # @attr_reader [String] id The onchain Address ID
+  # A representation of a blockchain Address, which is a user-controlled account on a Network.
+  # Addresses are used to send and receive Assets.
   class Address
-    attr_reader :network_id, :id
+    attr_reader :network, :id
 
     # Returns a new Address object.
-    # @param network_id [Symbol] The Network ID
+    # @param network [Coinbase::Network, Symbol] The Network or Network ID
     # @param id [String] The onchain Address ID
-    def initialize(network_id, id)
-      @network_id = Coinbase.to_sym(network_id)
+    def initialize(network, id)
+      @network = Coinbase::Network.from_id(network)
       @id = id
     end
 
     # Returns a String representation of the Address.
     # @return [String] a String representation of the Address
     def to_s
-      "Coinbase::Address{id: '#{id}', network_id: '#{network_id}'}"
+      Coinbase.pretty_print_object(self.class, id: id, network_id: network.id)
     end
 
     # Same as to_s.
@@ -39,7 +37,7 @@ module Coinbase
     #  in ETH.
     def balances
       response = Coinbase.call_api do
-        addresses_api.list_external_address_balances(Coinbase.normalize_network(network_id), id)
+        addresses_api.list_external_address_balances(network.normalized_id, id)
       end
 
       Coinbase::BalanceMap.from_balances(response.data)
@@ -51,7 +49,7 @@ module Coinbase
     def balance(asset_id)
       response = Coinbase.call_api do
         addresses_api.get_external_address_balance(
-          Coinbase.normalize_network(network_id),
+          network.normalized_id,
           id,
           Coinbase::Asset.primary_denomination(asset_id).to_s
         )
@@ -82,7 +80,7 @@ module Coinbase
     def faucet
       Coinbase.call_api do
         Coinbase::FaucetTransaction.new(
-          addresses_api.request_external_faucet_funds(Coinbase.normalize_network(network_id), id)
+          addresses_api.request_external_faucet_funds(network.normalized_id, id)
         )
       end
     end
@@ -97,7 +95,7 @@ module Coinbase
     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)
+      StakingOperation.build(amount, network, asset_id, id, 'stake', mode, options)
     end
 
     # Builds an unstake operation for the supplied asset.
@@ -109,7 +107,7 @@ module Coinbase
     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)
+      StakingOperation.build(amount, network, asset_id, id, 'unstake', mode, options)
     end
 
     # Builds a claim_stake operation for the supplied asset.
@@ -121,7 +119,7 @@ module Coinbase
     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)
+      StakingOperation.build(amount, network, asset_id, id, 'claim_stake', mode, options)
     end
 
     # Retrieves the balances used for staking for the supplied asset.
@@ -137,7 +135,7 @@ module Coinbase
         stake_api.get_staking_context(
           {
             asset_id: asset_id,
-            network_id: Coinbase.normalize_network(network_id),
+            network_id: network.normalized_id,
             address_id: id,
             options: {
               mode: mode
@@ -197,7 +195,7 @@ module Coinbase
     # @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,
+        network,
         asset_id,
         [id],
         start_time: start_time,
@@ -213,7 +211,7 @@ module Coinbase
     # @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,
+        network,
         asset_id,
         id,
         start_time: start_time,
@@ -238,7 +236,7 @@ module Coinbase
 
     def list_page(asset_id, page)
       addresses_api.list_address_historical_balance(
-        Coinbase.normalize_network(network_id),
+        network.normalized_id,
         id,
         Coinbase::Asset.primary_denomination(asset_id).to_s,
         { limit: DEFAULT_PAGE_LIMIT, page: page }

data/lib/coinbase/asset.rb

@@ -35,7 +35,7 @@ module Coinbase
         end
 
         new(
-          network_id: Coinbase.to_sym(asset_model.network_id),
+          network: Coinbase.to_sym(asset_model.network_id),
           asset_id: asset_id || Coinbase.to_sym(asset_model.asset_id),
           address_id: asset_model.contract_address,
           decimals: decimals
@@ -43,12 +43,15 @@ module Coinbase
       end
 
       # Fetches the Asset with the provided Asset ID.
+      # @param network [Coinbase::Network, Symbol] The Network or Network ID
       # @param asset_id [Symbol] The Asset ID
       # @return [Coinbase::Asset] The Asset
-      def fetch(network_id, asset_id)
+      def fetch(network, asset_id)
+        network = Coinbase::Network.from_id(network)
+
         asset_model = Coinbase.call_api do
           assets_api.get_asset(
-            Coinbase.normalize_network(network_id),
+            network.normalized_id,
             primary_denomination(asset_id).to_s
           )
         end
@@ -65,18 +68,18 @@ module Coinbase
 
     # Returns a new Asset object. Do not use this method. Instead, use the Asset constants defined in
     # the Coinbase module.
-    # @param network_id [Symbol] The ID of the Network to which the Asset belongs
+    # @param network [Symbol] The Network or Network ID to which the Asset belongs
     # @param asset_id [Symbol] The Asset ID
     # @param address_id [String] (Optional) The Asset's address ID, if one exists
     # @param decimals [Integer] (Optional) The number of decimal places the Asset uses
-    def initialize(network_id:, asset_id:, decimals:, address_id: nil)
-      @network_id = network_id
+    def initialize(network:, asset_id:, decimals:, address_id: nil)
+      @network = Coinbase::Network.from_id(network)
       @asset_id = asset_id
       @address_id = address_id
       @decimals = decimals
     end
 
-    attr_reader :network_id, :asset_id, :address_id, :decimals
+    attr_reader :network, :asset_id, :address_id, :decimals
 
     # Converts the amount of the Asset from atomic to whole units.
     # @param atomic_amount [Integer, Float, BigDecimal] The atomic amount to convert to whole units.
@@ -103,7 +106,7 @@ module Coinbase
     # Returns a string representation of the Asset.
     # @return [String] a string representation of the Asset
     def to_s
-      "Coinbase::Asset{network_id: '#{network_id}', asset_id: '#{asset_id}', decimals: '#{decimals}'" \
+      "Coinbase::Asset{network_id: '#{network.id}', asset_id: '#{asset_id}', decimals: '#{decimals}'" \
         "#{address_id.nil? ? '' : ", address_id: '#{address_id}'"}}"
     end
 

data/lib/coinbase/client/api/addresses_api.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/api/assets_api.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/api/contract_events_api.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
 
@@ -24,15 +24,15 @@ module Coinbase::Client
     # @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 contract_name [String] Case-sensitive name of the specific contract within the project
+    # @param event_name [String] Case-sensitive name of the event to filter for in the contract's logs
     # @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)
+    def list_contract_events(network_id, protocol_name, contract_address, contract_name, event_name, from_block_height, to_block_height, opts = {})
+      data, _status_code, _headers = list_contract_events_with_http_info(network_id, protocol_name, contract_address, contract_name, event_name, from_block_height, to_block_height, opts)
       data
     end
 
@@ -41,14 +41,14 @@ module Coinbase::Client
     # @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 contract_name [String] Case-sensitive name of the specific contract within the project
+    # @param event_name [String] Case-sensitive name of the event to filter for in the contract's logs
     # @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 = {})
+    def list_contract_events_with_http_info(network_id, protocol_name, contract_address, contract_name, event_name, from_block_height, to_block_height, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ContractEventsApi.list_contract_events ...'
       end
@@ -64,6 +64,14 @@ module Coinbase::Client
       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 'contract_name' is set
+      if @api_client.config.client_side_validation && contract_name.nil?
+        fail ArgumentError, "Missing the required parameter 'contract_name' when calling ContractEventsApi.list_contract_events"
+      end
+      # verify the required parameter 'event_name' is set
+      if @api_client.config.client_side_validation && event_name.nil?
+        fail ArgumentError, "Missing the required parameter 'event_name' 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"
@@ -78,10 +86,10 @@ module Coinbase::Client
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'protocol_name'] = protocol_name
+      query_params[:'contract_name'] = contract_name
+      query_params[:'event_name'] = event_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

data/lib/coinbase/client/api/external_addresses_api.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/api/networks_api.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/api/server_signers_api.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