@openzeppelin/relayer-sdk
Version:
OpenZeppelin Relayer SDK
709 lines (708 loc) • 36.5 kB
TypeScript
/**
* OpenZeppelin Relayer API
* OpenZeppelin Relayer API
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { ApiResponseBalanceResponse } from '../models';
import type { ApiResponseDeletePendingTransactionsResponse } from '../models';
import type { ApiResponseRelayerResponse } from '../models';
import type { ApiResponseRelayerStatus } from '../models';
import type { ApiResponseSignDataResponse } from '../models';
import type { ApiResponseSignTransactionResponse } from '../models';
import type { ApiResponseString } from '../models';
import type { ApiResponseTransactionResponse } from '../models';
import type { ApiResponseVecRelayerResponse } from '../models';
import type { ApiResponseVecTransactionResponse } from '../models';
import type { CreateRelayerRequest } from '../models';
import type { JsonRpcRequestNetworkRpcRequest } from '../models';
import type { JsonRpcResponseNetworkRpcResult } from '../models';
import type { NetworkTransactionRequest } from '../models';
import type { SignDataRequest } from '../models';
import type { SignTransactionRequest } from '../models';
import type { SignTypedDataRequest } from '../models';
import type { UpdateRelayerRequest } from '../models';
/**
* RelayersApi - axios parameter creator
* @export
*/
export declare const RelayersApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @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: string, transactionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Creates a new relayer.
* @param {CreateRelayerRequest} createRelayerRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createRelayer: (createRelayerRequest: CreateRelayerRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @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: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @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: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @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: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @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: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @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: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @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: string, transactionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @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: string, nonce: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* 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?: number, perPage?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @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: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @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: string, transactionId: string, networkTransactionRequest: NetworkTransactionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @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: string, jsonRpcRequestNetworkRpcRequest: JsonRpcRequestNetworkRpcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @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: string, networkTransactionRequest: NetworkTransactionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @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: string, signDataRequest: SignDataRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @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: string, signTransactionRequest: SignTransactionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @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: string, signTypedDataRequest: SignTypedDataRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @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: string, updateRelayerRequest: UpdateRelayerRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* RelayersApi - functional programming interface
* @export
*/
export declare const RelayersApiFp: (configuration?: Configuration) => {
/**
*
* @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: string, transactionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseTransactionResponse>>;
/**
*
* @summary Creates a new relayer.
* @param {CreateRelayerRequest} createRelayerRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createRelayer(createRelayerRequest: CreateRelayerRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseRelayerResponse>>;
/**
*
* @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: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseDeletePendingTransactionsResponse>>;
/**
*
* @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: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseString>>;
/**
*
* @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: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseRelayerResponse>>;
/**
*
* @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: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseBalanceResponse>>;
/**
*
* @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: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseRelayerStatus>>;
/**
*
* @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: string, transactionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseTransactionResponse>>;
/**
*
* @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: string, nonce: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseTransactionResponse>>;
/**
* 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?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseVecRelayerResponse>>;
/**
*
* @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: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseVecTransactionResponse>>;
/**
*
* @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: string, transactionId: string, networkTransactionRequest: NetworkTransactionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseTransactionResponse>>;
/**
*
* @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: string, jsonRpcRequestNetworkRpcRequest: JsonRpcRequestNetworkRpcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonRpcResponseNetworkRpcResult>>;
/**
*
* @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: string, networkTransactionRequest: NetworkTransactionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseTransactionResponse>>;
/**
*
* @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: string, signDataRequest: SignDataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseSignDataResponse>>;
/**
*
* @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: string, signTransactionRequest: SignTransactionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseSignTransactionResponse>>;
/**
*
* @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: string, signTypedDataRequest: SignTypedDataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseSignDataResponse>>;
/**
*
* @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: string, updateRelayerRequest: UpdateRelayerRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseRelayerResponse>>;
};
/**
* RelayersApi - factory interface
* @export
*/
export declare const RelayersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @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: string, transactionId: string, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseTransactionResponse>;
/**
*
* @summary Creates a new relayer.
* @param {CreateRelayerRequest} createRelayerRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createRelayer(createRelayerRequest: CreateRelayerRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseRelayerResponse>;
/**
*
* @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: string, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseDeletePendingTransactionsResponse>;
/**
*
* @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: string, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseString>;
/**
*
* @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: string, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseRelayerResponse>;
/**
*
* @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: string, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseBalanceResponse>;
/**
*
* @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: string, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseRelayerStatus>;
/**
*
* @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: string, transactionId: string, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseTransactionResponse>;
/**
*
* @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: string, nonce: number, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseTransactionResponse>;
/**
* 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?: number, perPage?: number, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseVecRelayerResponse>;
/**
*
* @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: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseVecTransactionResponse>;
/**
*
* @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: string, transactionId: string, networkTransactionRequest: NetworkTransactionRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseTransactionResponse>;
/**
*
* @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: string, jsonRpcRequestNetworkRpcRequest: JsonRpcRequestNetworkRpcRequest, options?: RawAxiosRequestConfig): AxiosPromise<JsonRpcResponseNetworkRpcResult>;
/**
*
* @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: string, networkTransactionRequest: NetworkTransactionRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseTransactionResponse>;
/**
*
* @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: string, signDataRequest: SignDataRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseSignDataResponse>;
/**
*
* @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: string, signTransactionRequest: SignTransactionRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseSignTransactionResponse>;
/**
*
* @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: string, signTypedDataRequest: SignTypedDataRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseSignDataResponse>;
/**
*
* @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: string, updateRelayerRequest: UpdateRelayerRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseRelayerResponse>;
};
/**
* RelayersApi - object-oriented interface
* @export
* @class RelayersApi
* @extends {BaseAPI}
*/
export declare class RelayersApi extends BaseAPI {
/**
*
* @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}
* @memberof RelayersApi
*/
cancelTransaction(relayerId: string, transactionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseTransactionResponse, any>>;
/**
*
* @summary Creates a new relayer.
* @param {CreateRelayerRequest} createRelayerRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RelayersApi
*/
createRelayer(createRelayerRequest: CreateRelayerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseRelayerResponse, any>>;
/**
*
* @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}
* @memberof RelayersApi
*/
deletePendingTransactions(relayerId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseDeletePendingTransactionsResponse, any>>;
/**
*
* @summary Deletes a relayer by ID.
* @param {string} relayerId The unique identifier of the relayer
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RelayersApi
*/
deleteRelayer(relayerId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseString, any>>;
/**
*
* @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}
* @memberof RelayersApi
*/
getRelayer(relayerId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseRelayerResponse, any>>;
/**
*
* @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}
* @memberof RelayersApi
*/
getRelayerBalance(relayerId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseBalanceResponse, any>>;
/**
*
* @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}
* @memberof RelayersApi
*/
getRelayerStatus(relayerId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseRelayerStatus, any>>;
/**
*
* @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}
* @memberof RelayersApi
*/
getTransactionById(relayerId: string, transactionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseTransactionResponse, any>>;
/**
*
* @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}
* @memberof RelayersApi
*/
getTransactionByNonce(relayerId: string, nonce: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseTransactionResponse, any>>;
/**
* 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}
* @memberof RelayersApi
*/
listRelayers(page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseVecRelayerResponse, any>>;
/**
*
* @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}
* @memberof RelayersApi
*/
listTransactions(relayerId: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseVecTransactionResponse, any>>;
/**
*
* @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}
* @memberof RelayersApi
*/
replaceTransaction(relayerId: string, transactionId: string, networkTransactionRequest: NetworkTransactionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseTransactionResponse, any>>;
/**
*
* @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}
* @memberof RelayersApi
*/
rpc(relayerId: string, jsonRpcRequestNetworkRpcRequest: JsonRpcRequestNetworkRpcRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<JsonRpcResponseNetworkRpcResult, any>>;
/**
*
* @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}
* @memberof RelayersApi
*/
sendTransaction(relayerId: string, networkTransactionRequest: NetworkTransactionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseTransactionResponse, any>>;
/**
*
* @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}
* @memberof RelayersApi
*/
sign(relayerId: string, signDataRequest: SignDataRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseSignDataResponse, any>>;
/**
*
* @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}
* @memberof RelayersApi
*/
signTransaction(relayerId: string, signTransactionRequest: SignTransactionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseSignTransactionResponse, any>>;
/**
*
* @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}
* @memberof RelayersApi
*/
signTypedData(relayerId: string, signTypedDataRequest: SignTypedDataRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseSignDataResponse, any>>;
/**
*
* @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}
* @memberof RelayersApi
*/
updateRelayer(relayerId: string, updateRelayerRequest: UpdateRelayerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseRelayerResponse, any>>;
}