coinbase-sdk 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb99df68459ac0ded3425479c79a09a0eb0aba9a9eb213939254b049e582f6d3
-  data.tar.gz: c4bb9230a726749208267afae1ce4af39c198e619273c4c38c44fa08f3729e60
+  metadata.gz: d296ec1c6b60e1074b171eb5d32135a3942be0266348e42e101290b283039b9d
+  data.tar.gz: 1d0115be59726c67bb29e0b6415e1e20c211a82a2d8330490c56e8e0255e3f74
 SHA512:
-  metadata.gz: 41190c14711f7f1ce56ce668b60fc0e0319a9d1aa0b382f46242db330961a3bfda950ab4e619eb9202595ce172111da8eb3bcd4cb133ac030ca0bf2e4d7d6247
-  data.tar.gz: a471b10bff8d80dda05183b855967907357c5f84feabc0ee40ed37b6ca081d4c6bb75d72e91a6edc8ca67fadcc3d30437db67ee16c557b89c22291f02bab01e0
+  metadata.gz: 53d7ed283905e7336527d319b1a5ec025a912fc6f90beadd4de75aefaf8774d93d17a4767e40b04a4a45b306c99d11ec3f08cb64c1a78d503dd2a2b8fc1e1e1d
+  data.tar.gz: 46ae9c2699993a68c51cb5a1941733810429372c5cb41e08ccb1e4f0628f3366b8862604235d376970120057252a35ea77c9ef64ad9581b7925ead4bc5d8d979

data/lib/coinbase/address/wallet_address.rb

@@ -95,6 +95,51 @@ module Coinbase
       trade
     end
 
+    # Invokes a contract method on the specified contract address, with the given ABI and arguments.
+    # @param contract_address [String] The address of the contract to invoke.
+    # @param abi [Array<Hash>] The ABI of the contract to invoke.
+    # @param method [String] The method to invoke on the contract.
+    # @param args [Hash] The arguments to pass to the contract method.
+    #   The keys should be the argument names, and the values should be the argument values.
+    # @return [Coinbase::ContractInvocation] The contract invocation object.
+    def invoke_contract(contract_address:, abi:, method:, args:)
+      ensure_can_sign!
+
+      invocation = ContractInvocation.create(
+        address_id: id,
+        wallet_id: wallet_id,
+        contract_address: contract_address,
+        abi: abi,
+        method: method,
+        args: args
+      )
+
+      # If a server signer is managing keys, it will sign and broadcast the underlying transaction out of band.
+      return invocation if Coinbase.use_server_signer?
+
+      invocation.sign(@key)
+      invocation.broadcast!
+      invocation
+    end
+
+    # Signs the given unsigned payload.
+    # @param unsigned_payload [String] The hex-encoded hashed unsigned payload for the Address to sign.
+    # @return [Coinbase::PayloadSignature] The payload signature
+    def sign_payload(unsigned_payload:)
+      ensure_can_sign!
+
+      unless Coinbase.use_server_signer?
+        signature = Eth::Util.prefix_hex(@key.sign(Eth::Util.hex_to_bin(unsigned_payload)))
+      end
+
+      PayloadSignature.create(
+        wallet_id: wallet_id,
+        address_id: id,
+        unsigned_payload: unsigned_payload,
+        signature: signature
+      )
+    end
+
     # 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.
@@ -179,6 +224,14 @@ module Coinbase
       Trade.list(wallet_id: wallet_id, address_id: id)
     end
 
+    # Enumerates the payload signatures associated with the address.
+    # The result is an enumerator that lazily fetches from the server, and can be iterated over,
+    # converted to an array, etc...
+    # @return [Enumerable<Coinbase::PayloadSignature>] Enumerator that returns the address's payload signatures
+    def payload_signatures
+      PayloadSignature.list(wallet_id: wallet_id, address_id: id)
+    end
+
     # Returns a String representation of the WalletAddress.
     # @return [String] a String representation of the WalletAddress
     def to_s

data/lib/coinbase/address.rb

@@ -72,6 +72,18 @@ module Coinbase
       end
     end
 
+    # Enumerates the transactions of address.
+    # The result is an enumerator that lazily fetches from the server, and can be iterated over,
+    # converted to an array, etc...
+    # @return [Enumerable<Coinbase::HistoricalBalance>] Enumerator that returns historical_balance
+    def transactions
+      Coinbase::Pagination.enumerate(
+        ->(page) { list_transaction_page(page) }
+      ) do |transaction|
+        Coinbase::Transaction.new(transaction)
+      end
+    end
+
     # 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.
@@ -248,5 +260,13 @@ module Coinbase
         { limit: DEFAULT_PAGE_LIMIT, page: page }
       )
     end
+
+    def list_transaction_page(page)
+      addresses_api.list_address_transactions(
+        network.normalized_id,
+        id,
+        { limit: DEFAULT_TRANSACTION_PAGE_LIMIT, page: page }
+      )
+    end
   end
 end

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

@@ -4,7 +4,7 @@
 #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.7.0
 
@@ -89,6 +89,82 @@ module Coinbase::Client
       return data, status_code, headers
     end
 
+    # Create a new payload signature.
+    # Create a new payload signature with an address.
+    # @param wallet_id [String] The ID of the wallet the address belongs to.
+    # @param address_id [String] The onchain address of the address to sign the payload with.
+    # @param [Hash] opts the optional parameters
+    # @option opts [CreatePayloadSignatureRequest] :create_payload_signature_request 
+    # @return [PayloadSignature]
+    def create_payload_signature(wallet_id, address_id, opts = {})
+      data, _status_code, _headers = create_payload_signature_with_http_info(wallet_id, address_id, opts)
+      data
+    end
+
+    # Create a new payload signature.
+    # Create a new payload signature with an address.
+    # @param wallet_id [String] The ID of the wallet the address belongs to.
+    # @param address_id [String] The onchain address of the address to sign the payload with.
+    # @param [Hash] opts the optional parameters
+    # @option opts [CreatePayloadSignatureRequest] :create_payload_signature_request 
+    # @return [Array<(PayloadSignature, Integer, Hash)>] PayloadSignature data, response status code and response headers
+    def create_payload_signature_with_http_info(wallet_id, address_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AddressesApi.create_payload_signature ...'
+      end
+      # verify the required parameter 'wallet_id' is set
+      if @api_client.config.client_side_validation && wallet_id.nil?
+        fail ArgumentError, "Missing the required parameter 'wallet_id' when calling AddressesApi.create_payload_signature"
+      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 AddressesApi.create_payload_signature"
+      end
+      # resource path
+      local_var_path = '/v1/wallets/{wallet_id}/addresses/{address_id}/payload_signatures'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_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[:'create_payload_signature_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PayloadSignature'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"AddressesApi.create_payload_signature",
+        :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: AddressesApi#create_payload_signature\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get address by onchain address
     # Get address
     # @param wallet_id [String] The ID of the wallet the address belongs to.
@@ -233,6 +309,81 @@ module Coinbase::Client
       return data, status_code, headers
     end
 
+    # Get payload signature.
+    # Get payload signature.
+    # @param wallet_id [String] The ID of the wallet the address belongs to.
+    # @param address_id [String] The onchain address of the address that signed the payload.
+    # @param payload_signature_id [String] The ID of the payload signature to fetch.
+    # @param [Hash] opts the optional parameters
+    # @return [PayloadSignature]
+    def get_payload_signature(wallet_id, address_id, payload_signature_id, opts = {})
+      data, _status_code, _headers = get_payload_signature_with_http_info(wallet_id, address_id, payload_signature_id, opts)
+      data
+    end
+
+    # Get payload signature.
+    # Get payload signature.
+    # @param wallet_id [String] The ID of the wallet the address belongs to.
+    # @param address_id [String] The onchain address of the address that signed the payload.
+    # @param payload_signature_id [String] The ID of the payload signature to fetch.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PayloadSignature, Integer, Hash)>] PayloadSignature data, response status code and response headers
+    def get_payload_signature_with_http_info(wallet_id, address_id, payload_signature_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AddressesApi.get_payload_signature ...'
+      end
+      # verify the required parameter 'wallet_id' is set
+      if @api_client.config.client_side_validation && wallet_id.nil?
+        fail ArgumentError, "Missing the required parameter 'wallet_id' when calling AddressesApi.get_payload_signature"
+      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 AddressesApi.get_payload_signature"
+      end
+      # verify the required parameter 'payload_signature_id' is set
+      if @api_client.config.client_side_validation && payload_signature_id.nil?
+        fail ArgumentError, "Missing the required parameter 'payload_signature_id' when calling AddressesApi.get_payload_signature"
+      end
+      # resource path
+      local_var_path = '/v1/wallets/{wallet_id}/addresses/{address_id}/payload_signatures/{payload_signature_id}'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_id.to_s)).sub('{' + 'payload_signature_id' + '}', CGI.escape(payload_signature_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] || 'PayloadSignature'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"AddressesApi.get_payload_signature",
+        :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: AddressesApi#get_payload_signature\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get all balances for address
     # Get address balances
     # @param wallet_id [String] The ID of the wallet to fetch the balances for
@@ -382,6 +533,85 @@ module Coinbase::Client
       return data, status_code, headers
     end
 
+    # List payload signatures for an address.
+    # List payload signatures for an address.
+    # @param wallet_id [String] The ID of the wallet the address belongs to.
+    # @param address_id [String] The onchain address of the address whose payload signatures to fetch.
+    # @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 [PayloadSignatureList]
+    def list_payload_signatures(wallet_id, address_id, opts = {})
+      data, _status_code, _headers = list_payload_signatures_with_http_info(wallet_id, address_id, opts)
+      data
+    end
+
+    # List payload signatures for an address.
+    # List payload signatures for an address.
+    # @param wallet_id [String] The ID of the wallet the address belongs to.
+    # @param address_id [String] The onchain address of the address whose payload signatures to fetch.
+    # @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<(PayloadSignatureList, Integer, Hash)>] PayloadSignatureList data, response status code and response headers
+    def list_payload_signatures_with_http_info(wallet_id, address_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AddressesApi.list_payload_signatures ...'
+      end
+      # verify the required parameter 'wallet_id' is set
+      if @api_client.config.client_side_validation && wallet_id.nil?
+        fail ArgumentError, "Missing the required parameter 'wallet_id' when calling AddressesApi.list_payload_signatures"
+      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 AddressesApi.list_payload_signatures"
+      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 AddressesApi.list_payload_signatures, the character length must be smaller than or equal to 5000.'
+      end
+
+      # resource path
+      local_var_path = '/v1/wallets/{wallet_id}/addresses/{address_id}/payload_signatures'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_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] || 'PayloadSignatureList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"AddressesApi.list_payload_signatures",
+        :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: AddressesApi#list_payload_signatures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Request faucet funds for onchain address.
     # Request faucet funds to be sent to onchain address.
     # @param wallet_id [String] The ID of the wallet the address belongs to.

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

@@ -4,7 +4,7 @@
 #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.7.0
 

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

@@ -4,7 +4,7 @@
 #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.7.0