coinbase-sdk 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df442398edde68b8c97794f9b1f0a2bfd33304f02459962fe13a437c348aba37
-  data.tar.gz: e8fcd68e07c0d0012985c5046705d53137b3f7c6f1717f0ac2546f161cfadb0a
+  metadata.gz: 20237f97b110d59cc508ab2bf8d12c50e03de8c99722caf7c8afc0b44ae14d6f
+  data.tar.gz: a94842743529bd1171179dbbe690034fcd04911fe16046c27b48b4aae2354a30
 SHA512:
-  metadata.gz: e777794208415ac5797c445db30fb7e0b6e2fe5f53c1dc22323ba2411a7648d6ee971b94e594806d9738018e41888d04c5ae036457883f51e4eaa76de7875920
-  data.tar.gz: 8b5b812b286509fa1962b1f9c5098955de0d8a19d3f233b2205c9c85c8bb1c4869566915db7ca15dd2020e713f515b80499532b87a45f1e7ba7b80419c35c3e5
+  metadata.gz: b9affa919b3835243affb7ada3935280c4249348082055e79d598ff04b3df65979401078bebadbbd3c1e0ab32499a6eb00acb82221654c2f6a7e9474653436b7
+  data.tar.gz: aa868c4e37d612a0727f05826ec2275f434f23ecccb6edffab13e553b1c1bafec1573793fe6a983c5c9572a21fdbcdae778e83de7907472109d6861c0a101a04

data/lib/coinbase/address/external_address.rb

@@ -44,7 +44,7 @@ module Coinbase
       build_staking_operation(amount, asset_id, 'claim_stake', mode: mode, options: options)
     end
 
-    # Retreives the balances used for staking for the supplied asset.
+    # 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
@@ -82,7 +82,7 @@ module Coinbase
       }
     end
 
-    # Retreives the stakeable balance for the supplied asset.
+    # 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
@@ -91,7 +91,7 @@ module Coinbase
       staking_balances(asset_id, mode: mode, options: options)[:stakeable_balance]
     end
 
-    # Retreives the unstakeable balance for the supplied asset.
+    # 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
@@ -100,7 +100,7 @@ module Coinbase
       staking_balances(asset_id, mode: mode, options: options)[:unstakeable_balance]
     end
 
-    # Retreives the claimable balance for the supplied asset.
+    # 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

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

@@ -165,6 +165,81 @@ module Coinbase::Client
       return data, status_code, headers
     end
 
+    # Get the latest state of a staking operation
+    # Get the latest state of a staking operation
+    # @param network_id [String] The ID of the blockchain network
+    # @param address_id [String] The ID of the address to fetch the staking operation for
+    # @param staking_operation_id [String] The ID of the staking operation
+    # @param [Hash] opts the optional parameters
+    # @return [StakingOperation]
+    def get_external_staking_operation(network_id, address_id, staking_operation_id, opts = {})
+      data, _status_code, _headers = get_external_staking_operation_with_http_info(network_id, address_id, staking_operation_id, opts)
+      data
+    end
+
+    # Get the latest state of a staking operation
+    # Get the latest state of a staking operation
+    # @param network_id [String] The ID of the blockchain network
+    # @param address_id [String] The ID of the address to fetch the staking operation for
+    # @param staking_operation_id [String] The ID of the staking operation
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(StakingOperation, Integer, Hash)>] StakingOperation data, response status code and response headers
+    def get_external_staking_operation_with_http_info(network_id, address_id, staking_operation_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StakeApi.get_external_staking_operation ...'
+      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 StakeApi.get_external_staking_operation"
+      end
+      # verify the required parameter 'address_id' is set
+      if @api_client.config.client_side_validation && address_id.nil?
+        fail ArgumentError, "Missing the required parameter 'address_id' when calling StakeApi.get_external_staking_operation"
+      end
+      # verify the required parameter 'staking_operation_id' is set
+      if @api_client.config.client_side_validation && staking_operation_id.nil?
+        fail ArgumentError, "Missing the required parameter 'staking_operation_id' when calling StakeApi.get_external_staking_operation"
+      end
+      # resource path
+      local_var_path = '/v1/networks/{network_id}/addresses/{address_id}/staking_operations/{staking_operation_id}'.sub('{' + 'network_id' + '}', CGI.escape(network_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_id.to_s)).sub('{' + 'staking_operation_id' + '}', CGI.escape(staking_operation_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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] || 'StakingOperation'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"StakeApi.get_external_staking_operation",
+        :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: StakeApi#get_external_staking_operation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get staking context
     # Get staking context for an address
     # @param get_staking_context_request [GetStakingContextRequest] 

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

@@ -0,0 +1,179 @@
+=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 ValidatorsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get a validator belonging to the CDP project
+    # Get a validator belonging to the user for a given network, asset and id.
+    # @param network_id [String] The ID of the blockchain network.
+    # @param asset_id [String] The symbol of the asset to get the validator for.
+    # @param validator_id [String] The unique id of the validator to fetch details for.
+    # @param [Hash] opts the optional parameters
+    # @return [Validator]
+    def get_validator(network_id, asset_id, validator_id, opts = {})
+      data, _status_code, _headers = get_validator_with_http_info(network_id, asset_id, validator_id, opts)
+      data
+    end
+
+    # Get a validator belonging to the CDP project
+    # Get a validator belonging to the user for a given network, asset and id.
+    # @param network_id [String] The ID of the blockchain network.
+    # @param asset_id [String] The symbol of the asset to get the validator for.
+    # @param validator_id [String] The unique id of the validator to fetch details for.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Validator, Integer, Hash)>] Validator data, response status code and response headers
+    def get_validator_with_http_info(network_id, asset_id, validator_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ValidatorsApi.get_validator ...'
+      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 ValidatorsApi.get_validator"
+      end
+      # verify the required parameter 'asset_id' is set
+      if @api_client.config.client_side_validation && asset_id.nil?
+        fail ArgumentError, "Missing the required parameter 'asset_id' when calling ValidatorsApi.get_validator"
+      end
+      # verify the required parameter 'validator_id' is set
+      if @api_client.config.client_side_validation && validator_id.nil?
+        fail ArgumentError, "Missing the required parameter 'validator_id' when calling ValidatorsApi.get_validator"
+      end
+      # resource path
+      local_var_path = '/v1/networks/{network_id}/assets/{asset_id}/validators/{validator_id}'.sub('{' + 'network_id' + '}', CGI.escape(network_id.to_s)).sub('{' + 'asset_id' + '}', CGI.escape(asset_id.to_s)).sub('{' + 'validator_id' + '}', CGI.escape(validator_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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] || 'Validator'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ValidatorsApi.get_validator",
+        :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: ValidatorsApi#get_validator\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List validators belonging to the CDP project
+    # List validators belonging to the user for a given network and asset.
+    # @param network_id [String] The ID of the blockchain network.
+    # @param asset_id [String] The symbol of the asset to get the validators for.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :status A filter to list validators based on a status.
+    # @option opts [Integer] :limit A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.
+    # @option opts [String] :page A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
+    # @return [ValidatorList]
+    def list_validators(network_id, asset_id, opts = {})
+      data, _status_code, _headers = list_validators_with_http_info(network_id, asset_id, opts)
+      data
+    end
+
+    # List validators belonging to the CDP project
+    # List validators belonging to the user for a given network and asset.
+    # @param network_id [String] The ID of the blockchain network.
+    # @param asset_id [String] The symbol of the asset to get the validators for.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :status A filter to list validators based on a status.
+    # @option opts [Integer] :limit A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.
+    # @option opts [String] :page A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
+    # @return [Array<(ValidatorList, Integer, Hash)>] ValidatorList data, response status code and response headers
+    def list_validators_with_http_info(network_id, asset_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ValidatorsApi.list_validators ...'
+      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 ValidatorsApi.list_validators"
+      end
+      # verify the required parameter 'asset_id' is set
+      if @api_client.config.client_side_validation && asset_id.nil?
+        fail ArgumentError, "Missing the required parameter 'asset_id' when calling ValidatorsApi.list_validators"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'].to_s.length > 5000
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ValidatorsApi.list_validators, the character length must be smaller than or equal to 5000.'
+      end
+
+      # resource path
+      local_var_path = '/v1/networks/{network_id}/assets/{asset_id}/validators'.sub('{' + 'network_id' + '}', CGI.escape(network_id.to_s)).sub('{' + 'asset_id' + '}', CGI.escape(asset_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'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] || 'ValidatorList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ValidatorsApi.list_validators",
+        :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: ValidatorsApi#list_validators\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

@@ -15,10 +15,10 @@ require 'time'
 
 module Coinbase::Client
   class CreateServerSignerRequest
-    # The ID of the server signer
+    # The ID of the server signer for the 1 of 1 server signer.
     attr_accessor :server_signer_id
 
-    # The enrollment data of the server signer. This will be the base64 encoded server-signer-id.
+    # The enrollment data of the server signer. This will be the base64 encoded server-signer-id for the 1 of 1 server signer.
     attr_accessor :enrollment_data
 
     # Whether the Server-Signer uses MPC.
@@ -70,8 +70,6 @@ module Coinbase::Client
 
       if attributes.key?(:'server_signer_id')
         self.server_signer_id = attributes[:'server_signer_id']
-      else
-        self.server_signer_id = nil
       end
 
       if attributes.key?(:'enrollment_data')
@@ -92,10 +90,6 @@ module Coinbase::Client
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @server_signer_id.nil?
-        invalid_properties.push('invalid value for "server_signer_id", server_signer_id cannot be nil.')
-      end
-
       if @enrollment_data.nil?
         invalid_properties.push('invalid value for "enrollment_data", enrollment_data cannot be nil.')
       end
@@ -111,7 +105,6 @@ module Coinbase::Client
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @server_signer_id.nil?
       return false if @enrollment_data.nil?
       return false if @is_mpc.nil?
       true