coinbase-sdk 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7282200e25117b148ba99b4fa055c604edfdfa41b66e2632ba7107b2ae21fc7f
-  data.tar.gz: a8ea9dc85e68fc0f40397e8f00f0007a5dc6d8952b1d59e2b674b86921ae5da2
+  metadata.gz: eb99df68459ac0ded3425479c79a09a0eb0aba9a9eb213939254b049e582f6d3
+  data.tar.gz: c4bb9230a726749208267afae1ce4af39c198e619273c4c38c44fa08f3729e60
 SHA512:
-  metadata.gz: d2f7da4368fd8c033b0566e1bf0851b7c5d9fdde368995d53923cd1535113b7ae9dba55aafaf4e6ec22f4525e7ad80399fa470b77d0dd1326ca6cf71fe1d3bcf
-  data.tar.gz: 1bcfa5eb7782d6946f11c4ca60a65a05c92805ac737529b9ad4ca4136b1e0a5b1f9bceb9a4a042367fc846307510badb96f74ffe3433c210285ee93b4fdf34ff
+  metadata.gz: 41190c14711f7f1ce56ce668b60fc0e0319a9d1aa0b382f46242db330961a3bfda950ab4e619eb9202595ce172111da8eb3bcd4cb133ac030ca0bf2e4d7d6247
+  data.tar.gz: a471b10bff8d80dda05183b855967907357c5f84feabc0ee40ed37b6ca081d4c6bb75d72e91a6edc8ca67fadcc3d30437db67ee16c557b89c22291f02bab01e0

data/lib/coinbase/address/wallet_address.rb

@@ -95,11 +95,12 @@ module Coinbase
       trade
     end
 
-    # Stakes the given amount of the given Asset
+    # Stakes the given amount of the given Asset. The stake operation
+    # may take a few minutes to complete in the case when infrastructure is spun up.
     # @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
+    # @param options [Hash] (Optional) Additional options for the stake operation. ({StakingOperation#create see_more})
     # @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
@@ -116,7 +117,8 @@ module Coinbase
     # @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
+    # @param options [Hash] (Optional) Additional options for the unstake operation.
+    #   ({StakingOperation#create see_more})
     # @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
@@ -133,7 +135,8 @@ module Coinbase
     # @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
+    # @param options [Hash] (Optional) Additional options for the claim_stake operation.
+    #   ({StakingOperation#create see_more})
     # @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

data/lib/coinbase/address.rb

@@ -74,13 +74,16 @@ module Coinbase
 
     # Requests funds for the address from the faucet and returns the faucet transaction.
     # This is only supported on testnet networks.
+    # @param asset_id [Symbol] The ID of the Asset to transfer to the wallet.
     # @return [Coinbase::FaucetTransaction] The successful faucet transaction
     # @raise [Coinbase::FaucetLimitReachedError] If the faucet limit has been reached for the address or user.
     # @raise [Coinbase::Client::ApiError] If an unexpected error occurs while requesting faucet funds.
-    def faucet
+    def faucet(asset_id: nil)
+      opts = { asset_id: asset_id }.compact
+
       Coinbase.call_api do
         Coinbase::FaucetTransaction.new(
-          addresses_api.request_external_faucet_funds(network.normalized_id, id)
+          addresses_api.request_external_faucet_funds(network.normalized_id, id, opts)
         )
       end
     end
@@ -90,7 +93,7 @@ module Coinbase
     # @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
+    # @param options [Hash] (Optional) Additional options for the stake operation. ({StakingOperation#build see_more})
     # @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)
@@ -102,7 +105,7 @@ module Coinbase
     # @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
+    # @param options [Hash] (Optional) Additional options for the unstake operation. ({StakingOperation#build see_more})
     # @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)
@@ -114,7 +117,8 @@ module Coinbase
     # @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
+    # @param options [Hash] (Optional) Additional options for the claim_stake operation.
+    #   ({StakingOperation#build see_more})
     # @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)
@@ -125,7 +129,9 @@ module Coinbase
     # 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
+    # @param options [Hash] (Optional) Additional options for fetching the staking balances
+    # @option options [String] (Optional) :validator_pub_keys List of comma separated validator public keys to retrieve
+    #   staking balances for. (default: all validators) [asset_id: :eth, mode: :native]
     # @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
@@ -163,7 +169,7 @@ module Coinbase
     # 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
+    # @param options [Hash] Additional options for fetching the stakeable balance
     # @return [BigDecimal] The stakeable balance
     def stakeable_balance(asset_id, mode: :default, options: {})
       staking_balances(asset_id, mode: mode, options: options)[:stakeable_balance]
@@ -172,7 +178,7 @@ module Coinbase
     # 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
+    # @param options [Hash] Additional options for fetching the unstakeable balance
     # @return [BigDecimal] The unstakeable balance
     def unstakeable_balance(asset_id, mode: :default, options: {})
       staking_balances(asset_id, mode: mode, options: options)[:unstakeable_balance]
@@ -181,7 +187,7 @@ module Coinbase
     # 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
+    # @param options [Hash] Additional options for fetching the claimable balance
     # @return [BigDecimal] The claimable balance
     def claimable_balance(asset_id, mode: :default, options: {})
       staking_balances(asset_id, mode: mode, options: options)[:claimable_balance]

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

@@ -387,6 +387,7 @@ module Coinbase::Client
     # @param wallet_id [String] The ID of the wallet the address belongs to.
     # @param address_id [String] The onchain address of the address that is being fetched.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :asset_id The ID of the asset to transfer from the faucet.
     # @return [FaucetTransaction]
     def request_faucet_funds(wallet_id, address_id, opts = {})
       data, _status_code, _headers = request_faucet_funds_with_http_info(wallet_id, address_id, opts)
@@ -398,6 +399,7 @@ module Coinbase::Client
     # @param wallet_id [String] The ID of the wallet the address belongs to.
     # @param address_id [String] The onchain address of the address that is being fetched.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :asset_id The ID of the asset to transfer from the faucet.
     # @return [Array<(FaucetTransaction, Integer, Hash)>] FaucetTransaction data, response status code and response headers
     def request_faucet_funds_with_http_info(wallet_id, address_id, opts = {})
       if @api_client.config.debugging
@@ -416,6 +418,7 @@ module Coinbase::Client
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'asset_id'] = opts[:'asset_id'] if !opts[:'asset_id'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

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

@@ -224,7 +224,7 @@ module Coinbase::Client
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -260,6 +260,7 @@ module Coinbase::Client
     # @param network_id [String] The ID of the wallet the address belongs to.
     # @param address_id [String] The onchain address of the address that is being fetched.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :asset_id The ID of the asset to transfer from the faucet.
     # @return [FaucetTransaction]
     def request_external_faucet_funds(network_id, address_id, opts = {})
       data, _status_code, _headers = request_external_faucet_funds_with_http_info(network_id, address_id, opts)
@@ -271,6 +272,7 @@ module Coinbase::Client
     # @param network_id [String] The ID of the wallet the address belongs to.
     # @param address_id [String] The onchain address of the address that is being fetched.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :asset_id The ID of the asset to transfer from the faucet.
     # @return [Array<(FaucetTransaction, Integer, Hash)>] FaucetTransaction data, response status code and response headers
     def request_external_faucet_funds_with_http_info(network_id, address_id, opts = {})
       if @api_client.config.debugging
@@ -289,6 +291,7 @@ module Coinbase::Client
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'asset_id'] = opts[:'asset_id'] if !opts[:'asset_id'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/coinbase/staking_operation.rb

@@ -17,6 +17,19 @@ module Coinbase
     # @param action [Symbol] The action to perform
     # @param mode [Symbol] The staking mode
     # @param options [Hash] Additional options
+    # @option options [String] :integrator_contract_address The integrator contract
+    #   address. [asset_id: :eth, mode: :partial, action: all]
+    # @option options [String] :funding_address The address funding the 32 ETH
+    #   (default: :address_id) [asset_id: :eth, mode: :native, action: :stake]
+    # @option options [String] :withdrawal_address The address receiving rewards and withdrawal funds.
+    #   (default: :address_id) [asset_id: :eth, mode: :native, action: :stake]
+    # @option options [String] :fee_recipient_address The address receiving transaction fees.
+    #   (default: :address_id) [asset_id: :eth, mode: :native, action: :stake]
+    # @option options [Boolean] :immediate To leverage "Coinbase Managed Unstake".
+    #   (default: false i.e. User Managed Unstake) [asset_id: :eth, mode: :native, action: :unstake]
+    # @option options [String] :validator_pub_keys List of comma separated validator public keys to unstake.
+    #   (default: validators picked up on your behalf corresponding to the unstake amount.) [asset_id: :eth,
+    #   mode: :native, action: :unstake]
     # @return [Coinbase::StakingOperation] The staking operation
     def self.build(amount, network, asset_id, address_id, action, mode, options)
       network = Coinbase::Network.from_id(network)
@@ -49,6 +62,19 @@ module Coinbase
     # @param action [Symbol] The action to perform
     # @param mode [Symbol] The staking mode
     # @param options [Hash] Additional options
+    # @option options [String] :integrator_contract_address The integrator contract
+    #   address. [asset_id: :eth, mode: :partial, action: all]
+    # @option options [String] :funding_address The address funding the 32 ETH
+    #   (default: :address_id) [asset_id: :eth, mode: :native, action: :stake]
+    # @option options [String] :withdrawal_address The address receiving rewards and withdrawal funds.
+    #   (default: :address_id) [asset_id: :eth, mode: :native, action: :stake]
+    # @option options [String] :fee_recipient_address The address receiving transaction fees.
+    #   (default: :address_id) [asset_id: :eth, mode: :native, action: :stake]
+    # @option options [Boolean] :immediate To leverage "Coinbase Managed Unstake".
+    #   (default: false i.e. User Managed Unstake) [asset_id: :eth, mode: :native, action: :unstake]
+    # @option options [String] :validator_pub_keys List of comma separated validator public keys to unstake.
+    #   (default: validators picked up on your behalf corresponding to the unstake amount.) [asset_id: :eth,
+    #   mode: :native, action: :unstake]
     # @return [Coinbase::StakingOperation] The staking operation
     def self.create(amount, network, asset_id, address_id, wallet_id, action, mode, options)
       network = Coinbase::Network.from_id(network)

data/lib/coinbase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Coinbase
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/coinbase/wallet.rb

@@ -162,6 +162,7 @@ module Coinbase
     # @return [Coinbase::Trade] The Trade object.
 
     # @!method faucet
+    # @param asset_id [Symbol] The ID of the Asset to transfer to the wallet.
     # Requests funds from the faucet for the Wallet's default address and returns the faucet transaction.
     # This is only supported on testnet networks.
     # @return [Coinbase::FaucetTransaction] The successful faucet transaction
@@ -363,12 +364,6 @@ module Coinbase
       Data.new(wallet_id: id, seed: @master.seed_hex)
     end
 
-    def faucet
-      Coinbase.call_api do
-        Coinbase::FaucetTransaction.new(addresses_api.request_faucet_funds(id, default_address.id))
-      end
-    end
-
     # Returns whether the Wallet has a seed with which to derive keys and sign transactions.
     # @return [Boolean] Whether the Wallet has a seed with which to derive keys and sign transactions.
     def can_sign?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coinbase-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Yuga Cohler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-22 00:00:00.000000000 Z
+date: 2024-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal