You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Apis/RelayersApi.md
+58Lines changed: 58 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,7 @@ All URIs are relative to *http://localhost*
4
4
5
5
| Method | HTTP request | Description |
6
6
|------------- | ------------- | -------------|
7
+
|[**buildSponsoredTransaction**](RelayersApi.md#buildSponsoredTransaction)|**POST** /api/v1/relayers/{relayer_id}/transactions/sponsored/build | Prepares a sponsored (gasless) transaction with fee payments. |
7
8
|[**cancelTransaction**](RelayersApi.md#cancelTransaction)|**DELETE** /api/v1/relayers/{relayer_id}/transactions/{transaction_id} | Cancels a specific transaction by its ID. |
8
9
|[**createRelayer**](RelayersApi.md#createRelayer)|**POST** /api/v1/relayers | Creates a new relayer. |
9
10
|[**deletePendingTransactions**](RelayersApi.md#deletePendingTransactions)|**DELETE** /api/v1/relayers/{relayer_id}/transactions/pending | Deletes all pending transactions for a specific relayer. |
@@ -15,6 +16,7 @@ All URIs are relative to *http://localhost*
15
16
|[**getTransactionByNonce**](RelayersApi.md#getTransactionByNonce)|**GET** /api/v1/relayers/{relayer_id}/transactions/by-nonce/{nonce} | Retrieves a transaction by its nonce value. |
|[**listTransactions**](RelayersApi.md#listTransactions)|**GET** /api/v1/relayers/{relayer_id}/transactions/ | Lists all transactions for a specific relayer with pagination. |
19
+
|[**quoteSponsoredTransaction**](RelayersApi.md#quoteSponsoredTransaction)|**POST** /api/v1/relayers/{relayer_id}/transactions/sponsored/quote | Estimates fees for a sponsored (gasless) transaction. |
18
20
|[**replaceTransaction**](RelayersApi.md#replaceTransaction)|**PUT** /api/v1/relayers/{relayer_id}/transactions/{transaction_id} | Replaces a specific transaction with a new one. |
19
21
|[**rpc**](RelayersApi.md#rpc)|**POST** /api/v1/relayers/{relayer_id}/rpc | Performs a JSON-RPC call using the specified relayer. |
20
22
|[**sendTransaction**](RelayersApi.md#sendTransaction)|**POST** /api/v1/relayers/{relayer_id}/transactions | Sends a transaction through the specified relayer. |
@@ -24,6 +26,34 @@ All URIs are relative to *http://localhost*
24
26
|[**updateRelayer**](RelayersApi.md#updateRelayer)|**PATCH** /api/v1/relayers/{relayer_id} | Updates a relayer's information based on the provided update request. |
Prepares a sponsored (gasless) transaction with fee payments.
34
+
35
+
This endpoint builds a transaction where the relayer will pay the network fees on behalf of the user. The user pays fees in a token of their choice (e.g., USDC) instead of the native network currency. The endpoint accepts either a pre-built transaction XDR or a set of operations to build a transaction from. It returns a prepared transaction that includes: - The transaction XDR (base64 encoded) ready for signing - The fee amount in both the fee token and native currency (stroops for Stellar) - The fee token identifier - The transaction validity timestamp After receiving the prepared transaction, the user must sign it and submit it through the standard transaction submission endpoint. For Stellar, the transaction will be wrapped in a fee-bump transaction where the relayer pays the network fees.
Estimates fees for a sponsored (gasless) transaction.
345
+
346
+
This endpoint provides fee estimation for transactions where the relayer will pay the network fees on behalf of the user. The user pays fees in a token of their choice (e.g., USDC) instead of the native network currency (e.g., XLM for Stellar). The endpoint accepts either a pre-built transaction XDR or a set of operations to build a transaction from. It returns the estimated fee amount in the specified fee token and the conversion rate from the native currency.
|**data**|[**ApiResponse_SponsoredTransactionBuildResponse_data**](ApiResponse_SponsoredTransactionBuildResponse_data.md)||[optional][default to null]|
7
+
|**error**|**String**||[optional][default to null]|
8
+
|**metadata**|[**PluginMetadata**](PluginMetadata.md)||[optional][default to null]|
9
+
|**pagination**|[**PaginationMeta**](PaginationMeta.md)||[optional][default to null]|
10
+
|**success**|**Boolean**||[default to null]|
11
+
12
+
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
|**fee\_in\_lamports**|**String**||[default to null]|
7
+
|**fee\_in\_spl**|**String**||[default to null]|
8
+
|**fee\_token**|**String**| Asset identifier for fee token |[default to null]|
9
+
|**transaction**|**String**| Extended transaction XDR (base64 encoded) |[default to null]|
10
+
|**valid\_until\_blockheight**|**Long**||[default to null]|
11
+
|**fee\_in\_stroops**|**String**| Fee amount in stroops (as string) |[default to null]|
12
+
|**fee\_in\_token**|**String**| Fee amount in token (raw units as string) |[default to null]|
13
+
|**fee\_in\_token\_ui**|**String**| Fee amount in token (decimal UI representation as string) |[default to null]|
14
+
|**valid\_until**|**String**| Transaction validity timestamp (ISO 8601 format) |[default to null]|
15
+
16
+
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
|**data**|[**ApiResponse_SponsoredTransactionQuoteResponse_data**](ApiResponse_SponsoredTransactionQuoteResponse_data.md)||[optional][default to null]|
7
+
|**error**|**String**||[optional][default to null]|
8
+
|**metadata**|[**PluginMetadata**](PluginMetadata.md)||[optional][default to null]|
9
+
|**pagination**|[**PaginationMeta**](PaginationMeta.md)||[optional][default to null]|
10
+
|**success**|**Boolean**||[default to null]|
11
+
12
+
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
|**conversion\_rate**|**String**| Conversion rate from XLM to token (as string) |[default to null]|
7
+
|**estimated\_fee**|**String**||[default to null]|
8
+
|**fee\_in\_token**|**String**| Estimated fee in token amount (raw units as string) |[default to null]|
9
+
|**fee\_in\_token\_ui**|**String**| Estimated fee in token amount (decimal UI representation as string) |[default to null]|
10
+
11
+
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
|**Evm**|[**RelayerEvmPolicy**](RelayerEvmPolicy.md)||[default to null]|
7
-
|**Solana**|[**RelayerSolanaPolicy**](RelayerSolanaPolicy.md)||[default to null]|
8
-
|**Stellar**|[**RelayerStellarPolicy**](RelayerStellarPolicy.md)||[default to null]|
6
+
|**eip1559\_pricing**|**Boolean**||[optional][default to null]|
7
+
|**gas\_limit\_estimation**|**Boolean**||[optional][default to null]|
8
+
|**gas\_price\_cap**|**Integer**||[optional][default to null]|
9
+
|**min\_balance**|**Long**||[optional][default to null]|
10
+
|**private\_transactions**|**Boolean**||[optional][default to null]|
11
+
|**whitelist\_receivers**|**List**||[optional][default to null]|
12
+
|**allowed\_accounts**|**List**||[optional][default to null]|
13
+
|**allowed\_programs**|**List**||[optional][default to null]|
14
+
|**allowed\_tokens**|[**List**](StellarAllowedTokensPolicy.md)||[optional][default to null]|
15
+
|**disallowed\_accounts**|**List**||[optional][default to null]|
16
+
|**fee\_margin\_percentage**|**Float**||[optional][default to null]|
17
+
|**fee\_payment\_strategy**|[**StellarFeePaymentStrategy**](StellarFeePaymentStrategy.md)| Fee payment strategy - determines who pays transaction fees (optional) |[optional][default to null]|
18
+
|**max\_allowed\_fee\_lamports**|**Long**||[optional][default to null]|
19
+
|**max\_signatures**|**Integer**||[optional][default to null]|
20
+
|**max\_tx\_data\_size**|**Integer**||[optional][default to null]|
21
+
|**swap\_config**|[**RelayerStellarSwapConfig**](RelayerStellarSwapConfig.md)||[optional][default to null]|
22
+
|**concurrent\_transactions**|**Boolean**||[optional][default to null]|
23
+
|**max\_fee**|**Integer**||[optional][default to null]|
24
+
|**slippage\_percentage**|**Float**||[optional][default to null]|
25
+
|**timeout\_seconds**|**Long**||[optional][default to null]|
9
26
10
27
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
|**fee\_token**|**String**| Asset identifier for fee token (e.g., \"native\" or \"USDC:GA5Z...\") |[default to null]|
7
+
|**operations**|[**List**](OperationSpec.md)| Operations array to build transaction from Mutually exclusive with transaction_xdr field |[optional][default to null]|
8
+
|**source\_account**|**String**| Source account address (required when operations are provided) For sponsored transactions, this should be the user's account address |[optional][default to null]|
9
+
|**transaction\_xdr**|**String**| Pre-built transaction XDR (base64 encoded, signed or unsigned) Mutually exclusive with operations field |[optional][default to null]|
8
10
9
11
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
0 commit comments