coinbase-sdk 0.0.9 → 0.0.10

data/lib/coinbase/staking_operation.rb

@@ -4,18 +4,75 @@ module Coinbase
   # A representation of a staking operation (stake, unstake, claim rewards, etc). It
   # may have multiple steps with some being transactions to sign, and others to wait.
   # @attr_reader [Array<Coinbase::Transaction>] transactions The list of current
-  #   transactions associated with the operation
+  #   transactions associated with the operation.
+  # @attr_reader [Symbol] status The status of the operation
   class StakingOperation
     attr_reader :transactions
 
     # Returns a new StakingOperation object.
     # @param model [Coinbase::Client::StakingOperation] The underlying StakingOperation object
     def initialize(model)
-      @model = model
+      from_model(model)
+    end
 
-      @transactions = model.transactions.map do |transaction_model|
-        Transaction.new(transaction_model)
+    # Returns the Staking Operation ID.
+    # @return [String] The Staking Operation ID
+    def id
+      @model.id
+    end
+
+    # Returns the Network ID of the Staking Operation.
+    # @return [Symbol] The Network ID
+    def network_id
+      Coinbase.to_sym(@model.network_id)
+    end
+
+    # Returns the Address ID of the Staking Operation.
+    # @return [String] The Address ID
+    def address_id
+      @model.address_id
+    end
+
+    # Returns the status of the Staking Operation.
+    # @return [Symbol] The status
+    def status
+      @model.status
+    end
+
+    # Waits until the Staking Operation is completed or failed by polling its status at the given interval. Raises a
+    # Timeout::Error if the Staking Operation takes longer than the given timeout.
+    # @param interval_seconds [Integer] The interval at which to poll, in seconds
+    # @param timeout_seconds [Integer] The maximum amount of time
+    #   to wait for the StakingOperation to complete, in seconds
+    # @return [StakingOperation] The completed StakingOperation object
+    def wait!(interval_seconds = 5, timeout_seconds = 3600)
+      start_time = Time.now
+
+      loop do
+        reload
+
+        # Wait for the Staking Operation to be in a terminal state.
+        break if status == 'complete'
+
+        raise Timeout::Error, 'Staking Operation timed out' if Time.now - start_time > timeout_seconds
+
+        self.sleep interval_seconds
+      end
+
+      self
+    end
+
+    # Fetch the StakingOperation with the provided network, address and staking operation ID.
+    # @param network_id [Symbol] The Network ID
+    # @param address_id [Symbol] The Address ID
+    # @param id [String] The ID of the StakingOperation
+    # @return [Coinbase::StakingOperation] The staking operation
+    def self.fetch(network_id, address_id, id)
+      staking_operation_model = Coinbase.call_api do
+        stake_api.get_external_staking_operation(network_id, address_id, id)
       end
+
+      from_model(staking_operation_model)
     end
 
     # Signs the Open Transactions with the provided key
@@ -25,5 +82,44 @@ module Coinbase
         transaction.sign(key) unless transaction.signed?
       end
     end
+
+    # Reloads the staking_operation from the service
+    # @return [Coinbase::StakingOperation] The updated staking operation
+    def reload
+      @model = Coinbase.call_api do
+        stake_api.get_external_staking_operation(network_id, address_id, id)
+      end
+
+      from_model(@model)
+    end
+
+    # Fetches the presigned_voluntary exit messages for the staking operation
+    # @return [Array<string>] The list of presigned exit transaction messages
+    def signed_voluntary_exit_messages
+      return [] unless @model.metadata
+
+      signed_voluntary_exit_messages = []
+
+      @model.metadata.each do |metadata|
+        decoded_string = Base64.decode64(metadata.signed_voluntary_exit)
+        signed_voluntary_exit_messages.push(decoded_string)
+      end
+
+      signed_voluntary_exit_messages
+    end
+
+    private
+
+    def stake_api
+      @stake_api ||= Coinbase::Client::StakeApi.new(Coinbase.configuration.api_client)
+    end
+
+    def from_model(model)
+      @model = model
+      @status = model.status
+      @transactions = model.transactions.map do |transaction_model|
+        Transaction.new(transaction_model)
+      end
+    end
   end
 end

data/lib/coinbase/staking_reward.rb

@@ -47,10 +47,16 @@ module Coinbase
       @model.date
     end
 
+    # Returns the onchain address of the StakingReward.
+    # @return [Time] The onchain address
+    def address_id
+      @model.address_id
+    end
+
     # Returns a string representation of the StakingReward.
     # @return [String] a string representation of the StakingReward
     def to_s
-      "Coinbase::StakingReward{amount: '#{amount}'}"
+      "Coinbase::StakingReward{date: '#{date}' address_id: '#{address_id}' amount: '#{amount.to_f}'}"
     end
 
     # Same as to_s.

data/lib/coinbase/validator.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Coinbase
+  # A representation of a staking validator.
+  class Validator
+    # Returns a new Validator object.
+    # @param model [Coinbase::Client::Validator] The underlying Validator object
+    def initialize(model)
+      @model = model
+    end
+
+    # Returns a list of Validators for the provided network and asset.
+    # @param network_id [Symbol] The network ID
+    # @param asset_id [Symbol] The asset ID
+    # @param status [Symbol] The status of the validator. Defaults to nil.
+    # @return [Enumerable<Coinbase::Validator>] The validators
+    def self.list(network_id, asset_id, status: nil)
+      Coinbase::Pagination.enumerate(
+        ->(page) { list_page(network_id, asset_id, status, page) }
+      ) do |validator|
+        new(validator)
+      end
+    end
+
+    # Returns a Validator for the provided network, asset, and validator.
+    # @param network_id [Symbol] The network ID
+    # @param asset_id [Symbol] The asset ID
+    # @param validator_id [String] The validator ID
+    # @return [Coinbase::Validator] The validator
+    def self.fetch(network_id, asset_id, validator_id)
+      validator = Coinbase.call_api do
+        validators_api.get_validator(
+          network_id,
+          asset_id,
+          validator_id
+        )
+      end
+      new(validator)
+    end
+
+    # Returns the public identifiable id of the Validator.
+    # @return [String] The validator ID
+    def validator_id
+      @model.validator_id
+    end
+
+    # Returns the status of the Validator.
+    # @return [Symbol] The status
+    def status
+      @model.status
+    end
+
+    # Returns a string representation of the Validator.
+    # @return [String] a string representation of the Validator
+    def to_s
+      "Coinbase::Validator{id: '#{validator_id}' status: '#{status}'}"
+    end
+
+    # Same as to_s.
+    # @return [String] a string representation of the Validator
+    def inspect
+      to_s
+    end
+
+    def self.list_page(network_id, asset_id, status, page)
+      Coinbase.call_api do
+        validators_api.list_validators(
+          network_id,
+          asset_id,
+          {
+            status: status,
+            page: page
+          }
+        )
+      end
+    end
+
+    def self.validators_api
+      Coinbase::Client::ValidatorsApi.new(Coinbase.configuration.api_client)
+    end
+  end
+end

data/lib/coinbase.rb

@@ -22,6 +22,7 @@ require_relative 'coinbase/wallet'
 require_relative 'coinbase/server_signer'
 require_relative 'coinbase/staking_operation'
 require_relative 'coinbase/staking_reward'
+require_relative 'coinbase/validator'
 require 'json'
 
 # The Coinbase SDK.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coinbase-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Yuga Cohler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-26 00:00:00.000000000 Z
+date: 2024-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -243,6 +243,7 @@ files:
 - lib/coinbase/client/api/trades_api.rb
 - lib/coinbase/client/api/transfers_api.rb
 - lib/coinbase/client/api/users_api.rb
+- lib/coinbase/client/api/validators_api.rb
 - lib/coinbase/client/api/wallets_api.rb
 - lib/coinbase/client/api_client.rb
 - lib/coinbase/client/api_error.rb
@@ -262,11 +263,13 @@ files:
 - lib/coinbase/client/models/create_wallet_request.rb
 - lib/coinbase/client/models/create_wallet_request_wallet.rb
 - lib/coinbase/client/models/error.rb
+- lib/coinbase/client/models/ethereum_validator_metadata.rb
 - lib/coinbase/client/models/faucet_transaction.rb
 - lib/coinbase/client/models/feature.rb
 - lib/coinbase/client/models/fetch_staking_rewards200_response.rb
 - lib/coinbase/client/models/fetch_staking_rewards_request.rb
 - lib/coinbase/client/models/get_staking_context_request.rb
+- lib/coinbase/client/models/native_eth_staking_context.rb
 - lib/coinbase/client/models/partial_eth_staking_context.rb
 - lib/coinbase/client/models/seed_creation_event.rb
 - lib/coinbase/client/models/seed_creation_event_result.rb
@@ -277,9 +280,11 @@ files:
 - lib/coinbase/client/models/server_signer_list.rb
 - lib/coinbase/client/models/signature_creation_event.rb
 - lib/coinbase/client/models/signature_creation_event_result.rb
+- lib/coinbase/client/models/signed_voluntary_exit_message_metadata.rb
 - lib/coinbase/client/models/staking_context.rb
 - lib/coinbase/client/models/staking_context_context.rb
 - lib/coinbase/client/models/staking_operation.rb
+- lib/coinbase/client/models/staking_operation_metadata.rb
 - lib/coinbase/client/models/staking_reward.rb
 - lib/coinbase/client/models/staking_reward_format.rb
 - lib/coinbase/client/models/trade.rb
@@ -289,6 +294,9 @@ files:
 - lib/coinbase/client/models/transfer.rb
 - lib/coinbase/client/models/transfer_list.rb
 - lib/coinbase/client/models/user.rb
+- lib/coinbase/client/models/validator.rb
+- lib/coinbase/client/models/validator_details.rb
+- lib/coinbase/client/models/validator_list.rb
 - lib/coinbase/client/models/wallet.rb
 - lib/coinbase/client/models/wallet_list.rb
 - lib/coinbase/client/version.rb
@@ -305,6 +313,7 @@ files:
 - lib/coinbase/transaction.rb
 - lib/coinbase/transfer.rb
 - lib/coinbase/user.rb
+- lib/coinbase/validator.rb
 - lib/coinbase/wallet.rb
 homepage: https://github.com/coinbase/coinbase-sdk-ruby
 licenses: