@openzeppelin/relayer-sdk
Version:
OpenZeppelin Relayer SDK
769 lines • 99.8 kB
JavaScript
/* tslint:disable */
/* eslint-disable */
/**
* OpenZeppelin Relayer API
* OpenZeppelin Relayer API
*
* The version of the OpenAPI document: 1.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
import globalAxios from 'axios';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setBearerAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
// @ts-ignore
import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
/**
* RelayersApi - axios parameter creator
* @export
*/
export const RelayersApiAxiosParamCreator = function (configuration) {
return {
/**
* 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.
* @summary Prepares a sponsored (gasless) transaction with fee payments.
* @param {string} relayerId The unique identifier of the relayer
* @param {SponsoredTransactionBuildRequest} sponsoredTransactionBuildRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
buildSponsoredTransaction: (relayerId_1, sponsoredTransactionBuildRequest_1, ...args_1) => __awaiter(this, [relayerId_1, sponsoredTransactionBuildRequest_1, ...args_1], void 0, function* (relayerId, sponsoredTransactionBuildRequest, options = {}) {
// verify required parameter 'relayerId' is not null or undefined
assertParamExists('buildSponsoredTransaction', 'relayerId', relayerId);
// verify required parameter 'sponsoredTransactionBuildRequest' is not null or undefined
assertParamExists('buildSponsoredTransaction', 'sponsoredTransactionBuildRequest', sponsoredTransactionBuildRequest);
const localVarPath = `/api/v1/relayers/{relayer_id}/transactions/sponsored/build`
.replace(`{${"relayer_id"}}`, encodeURIComponent(String(relayerId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication bearer_auth required
// http bearer authentication required
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = serializeDataIfNeeded(sponsoredTransactionBuildRequest, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
*
* @summary Cancels a specific transaction by its ID.
* @param {string} relayerId The unique identifier of the relayer
* @param {string} transactionId The unique identifier of the transaction
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
cancelTransaction: (relayerId_1, transactionId_1, ...args_1) => __awaiter(this, [relayerId_1, transactionId_1, ...args_1], void 0, function* (relayerId, transactionId, options = {}) {
// verify required parameter 'relayerId' is not null or undefined
assertParamExists('cancelTransaction', 'relayerId', relayerId);
// verify required parameter 'transactionId' is not null or undefined
assertParamExists('cancelTransaction', 'transactionId', transactionId);
const localVarPath = `/api/v1/relayers/{relayer_id}/transactions/{transaction_id}`
.replace(`{${"relayer_id"}}`, encodeURIComponent(String(relayerId)))
.replace(`{${"transaction_id"}}`, encodeURIComponent(String(transactionId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication bearer_auth required
// http bearer authentication required
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
*
* @summary Creates a new relayer.
* @param {CreateRelayerRequest} createRelayerRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createRelayer: (createRelayerRequest_1, ...args_1) => __awaiter(this, [createRelayerRequest_1, ...args_1], void 0, function* (createRelayerRequest, options = {}) {
// verify required parameter 'createRelayerRequest' is not null or undefined
assertParamExists('createRelayer', 'createRelayerRequest', createRelayerRequest);
const localVarPath = `/api/v1/relayers`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication bearer_auth required
// http bearer authentication required
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = serializeDataIfNeeded(createRelayerRequest, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
*
* @summary Deletes all pending transactions for a specific relayer.
* @param {string} relayerId The unique identifier of the relayer
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deletePendingTransactions: (relayerId_1, ...args_1) => __awaiter(this, [relayerId_1, ...args_1], void 0, function* (relayerId, options = {}) {
// verify required parameter 'relayerId' is not null or undefined
assertParamExists('deletePendingTransactions', 'relayerId', relayerId);
const localVarPath = `/api/v1/relayers/{relayer_id}/transactions/pending`
.replace(`{${"relayer_id"}}`, encodeURIComponent(String(relayerId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication bearer_auth required
// http bearer authentication required
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
*
* @summary Deletes a relayer by ID.
* @param {string} relayerId The unique identifier of the relayer
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteRelayer: (relayerId_1, ...args_1) => __awaiter(this, [relayerId_1, ...args_1], void 0, function* (relayerId, options = {}) {
// verify required parameter 'relayerId' is not null or undefined
assertParamExists('deleteRelayer', 'relayerId', relayerId);
const localVarPath = `/api/v1/relayers/{relayer_id}`
.replace(`{${"relayer_id"}}`, encodeURIComponent(String(relayerId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication bearer_auth required
// http bearer authentication required
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
*
* @summary Retrieves details of a specific relayer by ID.
* @param {string} relayerId The unique identifier of the relayer
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getRelayer: (relayerId_1, ...args_1) => __awaiter(this, [relayerId_1, ...args_1], void 0, function* (relayerId, options = {}) {
// verify required parameter 'relayerId' is not null or undefined
assertParamExists('getRelayer', 'relayerId', relayerId);
const localVarPath = `/api/v1/relayers/{relayer_id}`
.replace(`{${"relayer_id"}}`, encodeURIComponent(String(relayerId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication bearer_auth required
// http bearer authentication required
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
*
* @summary Retrieves the balance of a specific relayer.
* @param {string} relayerId The unique identifier of the relayer
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getRelayerBalance: (relayerId_1, ...args_1) => __awaiter(this, [relayerId_1, ...args_1], void 0, function* (relayerId, options = {}) {
// verify required parameter 'relayerId' is not null or undefined
assertParamExists('getRelayerBalance', 'relayerId', relayerId);
const localVarPath = `/api/v1/relayers/{relayer_id}/balance`
.replace(`{${"relayer_id"}}`, encodeURIComponent(String(relayerId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication bearer_auth required
// http bearer authentication required
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
*
* @summary Fetches the current status of a specific relayer.
* @param {string} relayerId The unique identifier of the relayer
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getRelayerStatus: (relayerId_1, ...args_1) => __awaiter(this, [relayerId_1, ...args_1], void 0, function* (relayerId, options = {}) {
// verify required parameter 'relayerId' is not null or undefined
assertParamExists('getRelayerStatus', 'relayerId', relayerId);
const localVarPath = `/api/v1/relayers/{relayer_id}/status`
.replace(`{${"relayer_id"}}`, encodeURIComponent(String(relayerId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication bearer_auth required
// http bearer authentication required
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
*
* @summary Retrieves a specific transaction by its ID.
* @param {string} relayerId The unique identifier of the relayer
* @param {string} transactionId The unique identifier of the transaction
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTransactionById: (relayerId_1, transactionId_1, ...args_1) => __awaiter(this, [relayerId_1, transactionId_1, ...args_1], void 0, function* (relayerId, transactionId, options = {}) {
// verify required parameter 'relayerId' is not null or undefined
assertParamExists('getTransactionById', 'relayerId', relayerId);
// verify required parameter 'transactionId' is not null or undefined
assertParamExists('getTransactionById', 'transactionId', transactionId);
const localVarPath = `/api/v1/relayers/{relayer_id}/transactions/{transaction_id}`
.replace(`{${"relayer_id"}}`, encodeURIComponent(String(relayerId)))
.replace(`{${"transaction_id"}}`, encodeURIComponent(String(transactionId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication bearer_auth required
// http bearer authentication required
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
*
* @summary Retrieves a transaction by its nonce value.
* @param {string} relayerId The unique identifier of the relayer
* @param {number} nonce The nonce of the transaction
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTransactionByNonce: (relayerId_1, nonce_1, ...args_1) => __awaiter(this, [relayerId_1, nonce_1, ...args_1], void 0, function* (relayerId, nonce, options = {}) {
// verify required parameter 'relayerId' is not null or undefined
assertParamExists('getTransactionByNonce', 'relayerId', relayerId);
// verify required parameter 'nonce' is not null or undefined
assertParamExists('getTransactionByNonce', 'nonce', nonce);
const localVarPath = `/api/v1/relayers/{relayer_id}/transactions/by-nonce/{nonce}`
.replace(`{${"relayer_id"}}`, encodeURIComponent(String(relayerId)))
.replace(`{${"nonce"}}`, encodeURIComponent(String(nonce)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication bearer_auth required
// http bearer authentication required
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file Lists all relayers with pagination support.
* @summary Relayer routes implementation
* @param {number} [page] Page number for pagination (starts at 1)
* @param {number} [perPage] Number of items per page (default: 10)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listRelayers: (page_1, perPage_1, ...args_1) => __awaiter(this, [page_1, perPage_1, ...args_1], void 0, function* (page, perPage, options = {}) {
const localVarPath = `/api/v1/relayers`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication bearer_auth required
// http bearer authentication required
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
if (page !== undefined) {
localVarQueryParameter['page'] = page;
}
if (perPage !== undefined) {
localVarQueryParameter['per_page'] = perPage;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
*
* @summary Lists all transactions for a specific relayer with pagination.
* @param {string} relayerId The unique identifier of the relayer
* @param {number} [page] Page number for pagination (starts at 1)
* @param {number} [perPage] Number of items per page (default: 10)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listTransactions: (relayerId_1, page_1, perPage_1, ...args_1) => __awaiter(this, [relayerId_1, page_1, perPage_1, ...args_1], void 0, function* (relayerId, page, perPage, options = {}) {
// verify required parameter 'relayerId' is not null or undefined
assertParamExists('listTransactions', 'relayerId', relayerId);
const localVarPath = `/api/v1/relayers/{relayer_id}/transactions/`
.replace(`{${"relayer_id"}}`, encodeURIComponent(String(relayerId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication bearer_auth required
// http bearer authentication required
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
if (page !== undefined) {
localVarQueryParameter['page'] = page;
}
if (perPage !== undefined) {
localVarQueryParameter['per_page'] = perPage;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* 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.
* @summary Estimates fees for a sponsored (gasless) transaction.
* @param {string} relayerId The unique identifier of the relayer
* @param {SponsoredTransactionQuoteRequest} sponsoredTransactionQuoteRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
quoteSponsoredTransaction: (relayerId_1, sponsoredTransactionQuoteRequest_1, ...args_1) => __awaiter(this, [relayerId_1, sponsoredTransactionQuoteRequest_1, ...args_1], void 0, function* (relayerId, sponsoredTransactionQuoteRequest, options = {}) {
// verify required parameter 'relayerId' is not null or undefined
assertParamExists('quoteSponsoredTransaction', 'relayerId', relayerId);
// verify required parameter 'sponsoredTransactionQuoteRequest' is not null or undefined
assertParamExists('quoteSponsoredTransaction', 'sponsoredTransactionQuoteRequest', sponsoredTransactionQuoteRequest);
const localVarPath = `/api/v1/relayers/{relayer_id}/transactions/sponsored/quote`
.replace(`{${"relayer_id"}}`, encodeURIComponent(String(relayerId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication bearer_auth required
// http bearer authentication required
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = serializeDataIfNeeded(sponsoredTransactionQuoteRequest, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
*
* @summary Replaces a specific transaction with a new one.
* @param {string} relayerId The unique identifier of the relayer
* @param {string} transactionId The unique identifier of the transaction
* @param {NetworkTransactionRequest} networkTransactionRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
replaceTransaction: (relayerId_1, transactionId_1, networkTransactionRequest_1, ...args_1) => __awaiter(this, [relayerId_1, transactionId_1, networkTransactionRequest_1, ...args_1], void 0, function* (relayerId, transactionId, networkTransactionRequest, options = {}) {
// verify required parameter 'relayerId' is not null or undefined
assertParamExists('replaceTransaction', 'relayerId', relayerId);
// verify required parameter 'transactionId' is not null or undefined
assertParamExists('replaceTransaction', 'transactionId', transactionId);
// verify required parameter 'networkTransactionRequest' is not null or undefined
assertParamExists('replaceTransaction', 'networkTransactionRequest', networkTransactionRequest);
const localVarPath = `/api/v1/relayers/{relayer_id}/transactions/{transaction_id}`
.replace(`{${"relayer_id"}}`, encodeURIComponent(String(relayerId)))
.replace(`{${"transaction_id"}}`, encodeURIComponent(String(transactionId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication bearer_auth required
// http bearer authentication required
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = serializeDataIfNeeded(networkTransactionRequest, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
*
* @summary Performs a JSON-RPC call using the specified relayer.
* @param {string} relayerId The unique identifier of the relayer
* @param {JsonRpcRequestNetworkRpcRequest} jsonRpcRequestNetworkRpcRequest JSON-RPC request with method and parameters
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
rpc: (relayerId_1, jsonRpcRequestNetworkRpcRequest_1, ...args_1) => __awaiter(this, [relayerId_1, jsonRpcRequestNetworkRpcRequest_1, ...args_1], void 0, function* (relayerId, jsonRpcRequestNetworkRpcRequest, options = {}) {
// verify required parameter 'relayerId' is not null or undefined
assertParamExists('rpc', 'relayerId', relayerId);
// verify required parameter 'jsonRpcRequestNetworkRpcRequest' is not null or undefined
assertParamExists('rpc', 'jsonRpcRequestNetworkRpcRequest', jsonRpcRequestNetworkRpcRequest);
const localVarPath = `/api/v1/relayers/{relayer_id}/rpc`
.replace(`{${"relayer_id"}}`, encodeURIComponent(String(relayerId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication bearer_auth required
// http bearer authentication required
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = serializeDataIfNeeded(jsonRpcRequestNetworkRpcRequest, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
*
* @summary Sends a transaction through the specified relayer.
* @param {string} relayerId The unique identifier of the relayer
* @param {NetworkTransactionRequest} networkTransactionRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
sendTransaction: (relayerId_1, networkTransactionRequest_1, ...args_1) => __awaiter(this, [relayerId_1, networkTransactionRequest_1, ...args_1], void 0, function* (relayerId, networkTransactionRequest, options = {}) {
// verify required parameter 'relayerId' is not null or undefined
assertParamExists('sendTransaction', 'relayerId', relayerId);
// verify required parameter 'networkTransactionRequest' is not null or undefined
assertParamExists('sendTransaction', 'networkTransactionRequest', networkTransactionRequest);
const localVarPath = `/api/v1/relayers/{relayer_id}/transactions`
.replace(`{${"relayer_id"}}`, encodeURIComponent(String(relayerId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication bearer_auth required
// http bearer authentication required
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = serializeDataIfNeeded(networkTransactionRequest, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
*
* @summary Signs data using the specified relayer.
* @param {string} relayerId The unique identifier of the relayer
* @param {SignDataRequest} signDataRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
sign: (relayerId_1, signDataRequest_1, ...args_1) => __awaiter(this, [relayerId_1, signDataRequest_1, ...args_1], void 0, function* (relayerId, signDataRequest, options = {}) {
// verify required parameter 'relayerId' is not null or undefined
assertParamExists('sign', 'relayerId', relayerId);
// verify required parameter 'signDataRequest' is not null or undefined
assertParamExists('sign', 'signDataRequest', signDataRequest);
const localVarPath = `/api/v1/relayers/{relayer_id}/sign`
.replace(`{${"relayer_id"}}`, encodeURIComponent(String(relayerId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication bearer_auth required
// http bearer authentication required
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = serializeDataIfNeeded(signDataRequest, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
*
* @summary Signs a transaction using the specified relayer (Stellar only).
* @param {string} relayerId The unique identifier of the relayer
* @param {SignTransactionRequest} signTransactionRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
signTransaction: (relayerId_1, signTransactionRequest_1, ...args_1) => __awaiter(this, [relayerId_1, signTransactionRequest_1, ...args_1], void 0, function* (relayerId, signTransactionRequest, options = {}) {
// verify required parameter 'relayerId' is not null or undefined
assertParamExists('signTransaction', 'relayerId', relayerId);
// verify required parameter 'signTransactionRequest' is not null or undefined
assertParamExists('signTransaction', 'signTransactionRequest', signTransactionRequest);
const localVarPath = `/api/v1/relayers/{relayer_id}/sign-transaction`
.replace(`{${"relayer_id"}}`, encodeURIComponent(String(relayerId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication bearer_auth required
// http bearer authentication required
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = serializeDataIfNeeded(signTransactionRequest, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
*
* @summary Signs typed data using the specified relayer.
* @param {string} relayerId The unique identifier of the relayer
* @param {SignTypedDataRequest} signTypedDataRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
signTypedData: (relayerId_1, signTypedDataRequest_1, ...args_1) => __awaiter(this, [relayerId_1, signTypedDataRequest_1, ...args_1], void 0, function* (relayerId, signTypedDataRequest, options = {}) {
// verify required parameter 'relayerId' is not null or undefined
assertParamExists('signTypedData', 'relayerId', relayerId);
// verify required parameter 'signTypedDataRequest' is not null or undefined
assertParamExists('signTypedData', 'signTypedDataRequest', signTypedDataRequest);
const localVarPath = `/api/v1/relayers/{relayer_id}/sign-typed-data`
.replace(`{${"relayer_id"}}`, encodeURIComponent(String(relayerId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication bearer_auth required
// http bearer authentication required
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = serializeDataIfNeeded(signTypedDataRequest, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
*
* @summary Updates a relayer\'s information based on the provided update request.
* @param {string} relayerId The unique identifier of the relayer
* @param {UpdateRelayerRequest} updateRelayerRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateRelayer: (relayerId_1, updateRelayerRequest_1, ...args_1) => __awaiter(this, [relayerId_1, updateRelayerRequest_1, ...args_1], void 0, function* (relayerId, updateRelayerRequest, options = {}) {
// verify required parameter 'relayerId' is not null or undefined
assertParamExists('updateRelayer', 'relayerId', relayerId);
// verify required parameter 'updateRelayerRequest' is not null or undefined
assertParamExists('updateRelayer', 'updateRelayerRequest', updateRelayerRequest);
const localVarPath = `/api/v1/relayers/{relayer_id}`
.replace(`{${"relayer_id"}}`, encodeURIComponent(String(relayerId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication bearer_auth required
// http bearer authentication required
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = serializeDataIfNeeded(updateRelayerRequest, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
};
};
/**
* RelayersApi - functional programming interface
* @export
*/
export const RelayersApiFp = function (configuration) {
const localVarAxiosParamCreator = RelayersApiAxiosParamCreator(configuration);
return {
/**
* 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.
* @summary Prepares a sponsored (gasless) transaction with fee payments.
* @param {string} relayerId The unique identifier of the relayer
* @param {SponsoredTransactionBuildRequest} sponsoredTransactionBuildRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
buildSponsoredTransaction(relayerId, sponsoredTransactionBuildRequest, options) {
return __awaiter(this, void 0, void 0, function* () {
var _a, _b, _c;
const localVarAxiosArgs = yield localVarAxiosParamCreator.b