coinbase-sdk 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98cd32134ee8acb14c9dc018f39e7af188646b546998c4182cd50d7ae75f2816
-  data.tar.gz: df6ff19c63798ec10f054972aa75edef79fe65ae39c93cbe0941c77db251e5d6
+  metadata.gz: ee1676ef79c89fd46c217eacbffecf507bed15a7362b8550d3110df96d45cd47
+  data.tar.gz: 21627d8b1bd0aefd94f33e5638eb514d8984aea244fb353c21e6fc17e899bf8d
 SHA512:
-  metadata.gz: a209d25aa72fc185fb667a5ef7b8de617341dba449b0a02b15ad95bc0c434140932353e12258f4665b35ef60e37b5346efca76db811cc5a308cfc69b907f37b8
-  data.tar.gz: 8856f048ea3ecb664559665e2422d60b6c12d607526aea4bea75f8e8273cf0584b2206e14dcb4e99bdca3436114b03961558be36029b40614d018028f9d41183
+  metadata.gz: 8b4ea7efb7b44a82b7b508ae8145ac7df6f467c55a17b27c10fe66aed6a72a7d4408d24ff1253b9ab9cbd6eca19d46def359d094673a066eb6479656ed47d30a
+  data.tar.gz: 79557441fda3a63c564976f8568cb0ab5b724063dd793fc5ad32085e2eb533355720d1084cace42d3b7a92e3bdf3748434389c0f1f8a7989c402b7191054be2f

data/lib/coinbase/address.rb

@@ -71,59 +71,26 @@ module Coinbase
       Coinbase::Balance.from_model_and_asset_id(response, asset_id).amount
     end
 
-    # Transfers the given amount of the given Asset to the given address. Only same-Network Transfers are supported.
+    # Transfers the given amount of the given Asset to the specified address or wallet.
+    # Only same-network Transfers are supported.
     # @param amount [Integer, Float, BigDecimal] The amount of the Asset to send.
     # @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.
     # @return [String] The hash of the Transfer transaction.
     def transfer(amount, asset_id, destination)
-      raise 'Cannot transfer from address without private key loaded' if @key.nil?
+      destination_address, destination_network = destination_address_and_network(destination)
 
-      raise ArgumentError, "Unsupported asset: #{asset_id}" unless Coinbase::Asset.supported?(asset_id)
-
-      if destination.is_a?(Wallet)
-        raise ArgumentError, 'Transfer must be on the same Network' if destination.network_id != network_id
+      validate_can_transfer!(amount, asset_id, destination_network)
 
-        destination = destination.default_address.id
-      elsif destination.is_a?(Address)
-        raise ArgumentError, 'Transfer must be on the same Network' if destination.network_id != network_id
+      transfer = create_transfer(amount, asset_id, destination_address)
 
-        destination = destination.id
-      end
-
-      current_balance = balance(asset_id)
-      if current_balance < amount
-        raise ArgumentError, "Insufficient funds: #{amount} requested, but only #{current_balance} available"
-      end
-
-      create_transfer_request = {
-        amount: Coinbase::Asset.to_atomic_amount(amount, asset_id).to_i.to_s,
-        network_id: network_id,
-        asset_id: Coinbase::Asset.primary_denomination(asset_id).to_s,
-        destination: destination
-      }
-
-      transfer_model = Coinbase.call_api do
-        transfers_api.create_transfer(wallet_id, id, create_transfer_request)
-      end
+      # 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 = Coinbase::Transfer.new(transfer_model)
+      signed_payload = sign_transfer(transfer)
 
-      transaction = transfer.transaction
-      transaction.sign(@key)
-
-      signed_payload = transaction.hex
-
-      broadcast_transfer_request = {
-        signed_payload: signed_payload
-      }
-
-      transfer_model = Coinbase.call_api do
-        transfers_api.broadcast_transfer(wallet_id, id, transfer.id, broadcast_transfer_request)
-      end
-
-      Coinbase::Transfer.new(transfer_model)
+      broadcast_transfer(transfer, signed_payload)
     end
 
     # Returns whether the Address has a private key backing it to sign transactions.
@@ -170,12 +137,13 @@ module Coinbase
       page = nil
 
       loop do
-        puts "fetch transfers page: #{page}"
         response = Coinbase.call_api do
           transfers_api.list_transfers(wallet_id, id, { limit: 100, page: page })
         end
 
-        transfers.concat(response.data.map { |transfer| Coinbase::Transfer.new(transfer) }) if response.data
+        break if response.data.empty?
+
+        transfers.concat(response.data.map { |transfer| Coinbase::Transfer.new(transfer) })
 
         break unless response.has_more
 
@@ -194,5 +162,56 @@ module Coinbase
     def transfers_api
       @transfers_api ||= Coinbase::Client::TransfersApi.new(Coinbase.configuration.api_client)
     end
+
+    def destination_address_and_network(destination)
+      return [destination.default_address.id, destination.network_id] if destination.is_a?(Wallet)
+      return [destination.id, destination.network_id] if destination.is_a?(Address)
+
+      [destination, network_id]
+    end
+
+    def validate_can_transfer!(amount, asset_id, destination_network_id)
+      raise 'Cannot transfer from address without private key loaded' unless can_sign? || Coinbase.use_server_signer?
+
+      raise ArgumentError, "Unsupported asset: #{asset_id}" unless Coinbase::Asset.supported?(asset_id)
+
+      raise ArgumentError, 'Transfer must be on the same Network' unless destination_network_id == network_id
+
+      current_balance = balance(asset_id)
+
+      return unless current_balance < amount
+
+      raise ArgumentError, "Insufficient funds: #{amount} requested, but only #{current_balance} available"
+    end
+
+    def create_transfer(amount, asset_id, destination)
+      create_transfer_request = {
+        amount: Coinbase::Asset.to_atomic_amount(amount, asset_id).to_i.to_s,
+        network_id: network_id,
+        asset_id: Coinbase::Asset.primary_denomination(asset_id).to_s,
+        destination: destination
+      }
+
+      transfer_model = Coinbase.call_api do
+        transfers_api.create_transfer(wallet_id, id, create_transfer_request)
+      end
+
+      Coinbase::Transfer.new(transfer_model)
+    end
+
+    def sign_transfer(transfer)
+      transaction = transfer.transaction
+      transaction.sign(@key)
+
+      transaction.hex
+    end
+
+    def broadcast_transfer(transfer, signed_payload)
+      transfer_model = Coinbase.call_api do
+        transfers_api.broadcast_transfer(wallet_id, id, transfer.id, { signed_payload: signed_payload })
+      end
+
+      Coinbase::Transfer.new(transfer_model)
+    end
   end
 end

data/lib/coinbase/authenticator.rb

@@ -38,7 +38,7 @@ module Coinbase
 
       claims = {
         sub: Coinbase.configuration.api_key_name,
-        iss: 'coinbase-cloud',
+        iss: 'cdp',
         aud: ['cdp_service'],
         nbf: Time.now.to_i,
         exp: Time.now.to_i + 60, # Expiration time: 1 minute from now.

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

@@ -0,0 +1,419 @@
+=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.5.0
+
+=end
+
+require 'cgi'
+
+module Coinbase::Client
+  class ServerSignersApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a new Server-Signer
+    # Create a new Server-Signer
+    # @param [Hash] opts the optional parameters
+    # @option opts [CreateServerSignerRequest] :create_server_signer_request 
+    # @return [ServerSigner]
+    def create_server_signer(opts = {})
+      data, _status_code, _headers = create_server_signer_with_http_info(opts)
+      data
+    end
+
+    # Create a new Server-Signer
+    # Create a new Server-Signer
+    # @param [Hash] opts the optional parameters
+    # @option opts [CreateServerSignerRequest] :create_server_signer_request 
+    # @return [Array<(ServerSigner, Integer, Hash)>] ServerSigner data, response status code and response headers
+    def create_server_signer_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ServerSignersApi.create_server_signer ...'
+      end
+      # resource path
+      local_var_path = '/v1/server_signers'
+
+      # 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'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_server_signer_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ServerSigner'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ServerSignersApi.create_server_signer",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ServerSignersApi#create_server_signer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a server signer by ID
+    # Get a server signer by ID
+    # @param server_signer_id [String] The ID of the server signer to fetch
+    # @param [Hash] opts the optional parameters
+    # @return [ServerSigner]
+    def get_server_signer(server_signer_id, opts = {})
+      data, _status_code, _headers = get_server_signer_with_http_info(server_signer_id, opts)
+      data
+    end
+
+    # Get a server signer by ID
+    # Get a server signer by ID
+    # @param server_signer_id [String] The ID of the server signer to fetch
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ServerSigner, Integer, Hash)>] ServerSigner data, response status code and response headers
+    def get_server_signer_with_http_info(server_signer_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ServerSignersApi.get_server_signer ...'
+      end
+      # verify the required parameter 'server_signer_id' is set
+      if @api_client.config.client_side_validation && server_signer_id.nil?
+        fail ArgumentError, "Missing the required parameter 'server_signer_id' when calling ServerSignersApi.get_server_signer"
+      end
+      # resource path
+      local_var_path = '/v1/server_signers/{server_signer_id}'.sub('{' + 'server_signer_id' + '}', CGI.escape(server_signer_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] || 'ServerSigner'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ServerSignersApi.get_server_signer",
+        :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: ServerSignersApi#get_server_signer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List events for a server signer
+    # List events for a server signer
+    # @param server_signer_id [String] The ID of the server signer to fetch events for
+    # @param [Hash] opts the optional parameters
+    # @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 10.
+    # @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 [ServerSignerEventList]
+    def list_server_signer_events(server_signer_id, opts = {})
+      data, _status_code, _headers = list_server_signer_events_with_http_info(server_signer_id, opts)
+      data
+    end
+
+    # List events for a server signer
+    # List events for a server signer
+    # @param server_signer_id [String] The ID of the server signer to fetch events for
+    # @param [Hash] opts the optional parameters
+    # @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 10.
+    # @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<(ServerSignerEventList, Integer, Hash)>] ServerSignerEventList data, response status code and response headers
+    def list_server_signer_events_with_http_info(server_signer_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ServerSignersApi.list_server_signer_events ...'
+      end
+      # verify the required parameter 'server_signer_id' is set
+      if @api_client.config.client_side_validation && server_signer_id.nil?
+        fail ArgumentError, "Missing the required parameter 'server_signer_id' when calling ServerSignersApi.list_server_signer_events"
+      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 ServerSignersApi.list_server_signer_events, the character length must be smaller than or equal to 5000.'
+      end
+
+      # resource path
+      local_var_path = '/v1/server_signers/{server_signer_id}/events'.sub('{' + 'server_signer_id' + '}', CGI.escape(server_signer_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      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] || 'ServerSignerEventList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ServerSignersApi.list_server_signer_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: ServerSignersApi#list_server_signer_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List server signers for the current project
+    # List server signers for the current project
+    # @param [Hash] opts the optional parameters
+    # @return [ServerSigner]
+    def list_server_signers(opts = {})
+      data, _status_code, _headers = list_server_signers_with_http_info(opts)
+      data
+    end
+
+    # List server signers for the current project
+    # List server signers for the current project
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ServerSigner, Integer, Hash)>] ServerSigner data, response status code and response headers
+    def list_server_signers_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ServerSignersApi.list_server_signers ...'
+      end
+      # resource path
+      local_var_path = '/v1/server_signers'
+
+      # 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] || 'ServerSigner'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ServerSignersApi.list_server_signers",
+        :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: ServerSignersApi#list_server_signers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Submit the result of a server signer event
+    # Submit the result of a server signer event
+    # @param server_signer_id [String] The ID of the server signer to submit the event result for
+    # @param [Hash] opts the optional parameters
+    # @option opts [SeedCreationEventResult] :seed_creation_event_result 
+    # @return [SeedCreationEventResult]
+    def submit_server_signer_seed_event_result(server_signer_id, opts = {})
+      data, _status_code, _headers = submit_server_signer_seed_event_result_with_http_info(server_signer_id, opts)
+      data
+    end
+
+    # Submit the result of a server signer event
+    # Submit the result of a server signer event
+    # @param server_signer_id [String] The ID of the server signer to submit the event result for
+    # @param [Hash] opts the optional parameters
+    # @option opts [SeedCreationEventResult] :seed_creation_event_result 
+    # @return [Array<(SeedCreationEventResult, Integer, Hash)>] SeedCreationEventResult data, response status code and response headers
+    def submit_server_signer_seed_event_result_with_http_info(server_signer_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ServerSignersApi.submit_server_signer_seed_event_result ...'
+      end
+      # verify the required parameter 'server_signer_id' is set
+      if @api_client.config.client_side_validation && server_signer_id.nil?
+        fail ArgumentError, "Missing the required parameter 'server_signer_id' when calling ServerSignersApi.submit_server_signer_seed_event_result"
+      end
+      # resource path
+      local_var_path = '/v1/server_signers/{server_signer_id}/seed_event_result'.sub('{' + 'server_signer_id' + '}', CGI.escape(server_signer_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'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'seed_creation_event_result'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SeedCreationEventResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ServerSignersApi.submit_server_signer_seed_event_result",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ServerSignersApi#submit_server_signer_seed_event_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Submit the result of a server signer event
+    # Submit the result of a server signer event
+    # @param server_signer_id [String] The ID of the server signer to submit the event result for
+    # @param [Hash] opts the optional parameters
+    # @option opts [SignatureCreationEventResult] :signature_creation_event_result 
+    # @return [SignatureCreationEventResult]
+    def submit_server_signer_signature_event_result(server_signer_id, opts = {})
+      data, _status_code, _headers = submit_server_signer_signature_event_result_with_http_info(server_signer_id, opts)
+      data
+    end
+
+    # Submit the result of a server signer event
+    # Submit the result of a server signer event
+    # @param server_signer_id [String] The ID of the server signer to submit the event result for
+    # @param [Hash] opts the optional parameters
+    # @option opts [SignatureCreationEventResult] :signature_creation_event_result 
+    # @return [Array<(SignatureCreationEventResult, Integer, Hash)>] SignatureCreationEventResult data, response status code and response headers
+    def submit_server_signer_signature_event_result_with_http_info(server_signer_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ServerSignersApi.submit_server_signer_signature_event_result ...'
+      end
+      # verify the required parameter 'server_signer_id' is set
+      if @api_client.config.client_side_validation && server_signer_id.nil?
+        fail ArgumentError, "Missing the required parameter 'server_signer_id' when calling ServerSignersApi.submit_server_signer_signature_event_result"
+      end
+      # resource path
+      local_var_path = '/v1/server_signers/{server_signer_id}/signature_event_result'.sub('{' + 'server_signer_id' + '}', CGI.escape(server_signer_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'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'signature_creation_event_result'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SignatureCreationEventResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ServerSignersApi.submit_server_signer_signature_event_result",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ServerSignersApi#submit_server_signer_signature_event_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end