feat(PSDK-782): allow users to send sponsored transactions immediately

coinbase · Jan 14, 2025 · d9dc139 · d9dc139
1 parent 530e444
commit d9dc139
Show file tree

Hide file tree

Showing 148 changed files with 467 additions and 168 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Added
+- Add `skip_batching` option to `Wallet.transfer` to allow for lower latency gasless transfers.
+
 ### Breaking
 - Removed support for EOL Ruby v2.7
 
@@ -221,4 +224,4 @@ Initial release of the Coinbase Ruby SDK. Purely client-side implementation.
 - Wallet creation and export
 - Address creation
 - Send and receive ETH
-- Supported networks: Base Sepolia
+- Supported networks: Base Sepolia
diff --git a/README.md b/README.md
@@ -218,6 +218,12 @@ puts "Wallet successfully created: #{wallet3}"
 transfer = wallet1.transfer(0.00001, :usdc, wallet3, gasless: true).wait!
 ```
 
+By default, gasless transfers are batched with other transfers, and might take longer to submit. If you want to opt out of batching, you can set the `skip_batching` option to `True`, which will submit the transaction immediately.
+
+```ruby
+transfer = wallet1.transfer(0.00001, "usdc", wallet3, gasless: true, skip_batching: true).wait!
+```
+
 ## Listing Transfers
 
 ```

diff --git a/lib/coinbase/address/wallet_address.rb b/lib/coinbase/address/wallet_address.rb
@@ -41,9 +41,11 @@ def key=(key)
     #  default address. If a String, interprets it as the address ID.
     # @param gasless [Boolean] Whether gas fee for the transfer should be covered by Coinbase.
     #   Defaults to false. Check the API documentation for network and asset support.
-    # Whether the transfer should be gasless. Defaults to false.
+    # @param skip_batching [Boolean] When true, the Transfer will be submitted immediately.
+    #   Otherwise, the Transfer will be batched.
+    #   Defaults to false. Note: requires gasless option to be set to true.
     # @return [Coinbase::Transfer] The Transfer object.
-    def transfer(amount, asset_id, destination, gasless: false)
+    def transfer(amount, asset_id, destination, gasless: false, skip_batching: false)
       ensure_can_sign!
       ensure_sufficient_balance!(amount, asset_id)
 
@@ -54,7 +56,8 @@ def transfer(amount, asset_id, destination, gasless: false)
         destination: destination,
         network: network,
         wallet_id: wallet_id,
-        gasless: gasless
+        gasless: gasless,
+        skip_batching: skip_batching
       )
 
       # If a server signer is managing keys, it will sign and broadcast the underlying transfer transaction out of band.

diff --git a/lib/coinbase/client.rb b/lib/coinbase/client.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 
@@ -30,6 +30,7 @@
 Coinbase::Client.autoload :BroadcastExternalTransferRequest, 'coinbase/client/models/broadcast_external_transfer_request'
 Coinbase::Client.autoload :BroadcastStakingOperationRequest, 'coinbase/client/models/broadcast_staking_operation_request'
 Coinbase::Client.autoload :BroadcastTradeRequest, 'coinbase/client/models/broadcast_trade_request'
+Coinbase::Client.autoload :BroadcastTransferRequest, 'coinbase/client/models/broadcast_transfer_request'
 Coinbase::Client.autoload :BuildStakingOperationRequest, 'coinbase/client/models/build_staking_operation_request'
 Coinbase::Client.autoload :ContractEvent, 'coinbase/client/models/contract_event'
 Coinbase::Client.autoload :ContractEventList, 'coinbase/client/models/contract_event_list'

diff --git a/lib/coinbase/client/api/addresses_api.rb b/lib/coinbase/client/api/addresses_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/api/assets_api.rb b/lib/coinbase/client/api/assets_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/api/balance_history_api.rb b/lib/coinbase/client/api/balance_history_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/api/contract_events_api.rb b/lib/coinbase/client/api/contract_events_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/api/contract_invocations_api.rb b/lib/coinbase/client/api/contract_invocations_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/api/external_addresses_api.rb b/lib/coinbase/client/api/external_addresses_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/api/fund_api.rb b/lib/coinbase/client/api/fund_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/api/mpc_wallet_stake_api.rb b/lib/coinbase/client/api/mpc_wallet_stake_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/api/networks_api.rb b/lib/coinbase/client/api/networks_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/api/onchain_identity_api.rb b/lib/coinbase/client/api/onchain_identity_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/api/reputation_api.rb b/lib/coinbase/client/api/reputation_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/api/server_signers_api.rb b/lib/coinbase/client/api/server_signers_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/api/smart_contracts_api.rb b/lib/coinbase/client/api/smart_contracts_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/api/stake_api.rb b/lib/coinbase/client/api/stake_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/api/trades_api.rb b/lib/coinbase/client/api/trades_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/api/transaction_history_api.rb b/lib/coinbase/client/api/transaction_history_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/api/transfers_api.rb b/lib/coinbase/client/api/transfers_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 
@@ -24,11 +24,11 @@ def initialize(api_client = ApiClient.default)
     # @param wallet_id [String] The ID of the wallet the address belongs to
     # @param address_id [String] The ID of the address the transfer belongs to
     # @param transfer_id [String] The ID of the transfer to broadcast
-    # @param broadcast_external_transfer_request [BroadcastExternalTransferRequest] 
+    # @param broadcast_transfer_request [BroadcastTransferRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Transfer]
-    def broadcast_transfer(wallet_id, address_id, transfer_id, broadcast_external_transfer_request, opts = {})
-      data, _status_code, _headers = broadcast_transfer_with_http_info(wallet_id, address_id, transfer_id, broadcast_external_transfer_request, opts)
+    def broadcast_transfer(wallet_id, address_id, transfer_id, broadcast_transfer_request, opts = {})
+      data, _status_code, _headers = broadcast_transfer_with_http_info(wallet_id, address_id, transfer_id, broadcast_transfer_request, opts)
       data
     end
 
@@ -37,10 +37,10 @@ def broadcast_transfer(wallet_id, address_id, transfer_id, broadcast_external_tr
     # @param wallet_id [String] The ID of the wallet the address belongs to
     # @param address_id [String] The ID of the address the transfer belongs to
     # @param transfer_id [String] The ID of the transfer to broadcast
-    # @param broadcast_external_transfer_request [BroadcastExternalTransferRequest] 
+    # @param broadcast_transfer_request [BroadcastTransferRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Transfer, Integer, Hash)>] Transfer data, response status code and response headers
-    def broadcast_transfer_with_http_info(wallet_id, address_id, transfer_id, broadcast_external_transfer_request, opts = {})
+    def broadcast_transfer_with_http_info(wallet_id, address_id, transfer_id, broadcast_transfer_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: TransfersApi.broadcast_transfer ...'
       end
@@ -56,9 +56,9 @@ def broadcast_transfer_with_http_info(wallet_id, address_id, transfer_id, broadc
       if @api_client.config.client_side_validation && transfer_id.nil?
         fail ArgumentError, "Missing the required parameter 'transfer_id' when calling TransfersApi.broadcast_transfer"
       end
-      # verify the required parameter 'broadcast_external_transfer_request' is set
-      if @api_client.config.client_side_validation && broadcast_external_transfer_request.nil?
-        fail ArgumentError, "Missing the required parameter 'broadcast_external_transfer_request' when calling TransfersApi.broadcast_transfer"
+      # verify the required parameter 'broadcast_transfer_request' is set
+      if @api_client.config.client_side_validation && broadcast_transfer_request.nil?
+        fail ArgumentError, "Missing the required parameter 'broadcast_transfer_request' when calling TransfersApi.broadcast_transfer"
       end
       # resource path
       local_var_path = '/v1/wallets/{wallet_id}/addresses/{address_id}/transfers/{transfer_id}/broadcast'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_id.to_s)).sub('{' + 'transfer_id' + '}', CGI.escape(transfer_id.to_s))
@@ -80,7 +80,7 @@ def broadcast_transfer_with_http_info(wallet_id, address_id, transfer_id, broadc
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(broadcast_external_transfer_request)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(broadcast_transfer_request)
 
       # return_type
       return_type = opts[:debug_return_type] || 'Transfer'

diff --git a/lib/coinbase/client/api/users_api.rb b/lib/coinbase/client/api/users_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/api/wallets_api.rb b/lib/coinbase/client/api/wallets_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/api/webhooks_api.rb b/lib/coinbase/client/api/webhooks_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/api_client.rb b/lib/coinbase/client/api_client.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/api_error.rb b/lib/coinbase/client/api_error.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/configuration.rb b/lib/coinbase/client/configuration.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/models/address.rb b/lib/coinbase/client/models/address.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/models/address_balance_list.rb b/lib/coinbase/client/models/address_balance_list.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/models/address_historical_balance_list.rb b/lib/coinbase/client/models/address_historical_balance_list.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/models/address_list.rb b/lib/coinbase/client/models/address_list.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/models/address_reputation.rb b/lib/coinbase/client/models/address_reputation.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/models/address_reputation_metadata.rb b/lib/coinbase/client/models/address_reputation_metadata.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/models/address_transaction_list.rb b/lib/coinbase/client/models/address_transaction_list.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/coinbase/client/models/asset.rb b/lib/coinbase/client/models/asset.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.0.1-alpha
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
+Generator version: 7.9.0
 
 =end