Skip to content

RelayersApi.md

Latest commit

 

History

History
492 lines (307 loc) · 15.7 KB

RelayersApi.md

File metadata and controls

492 lines (307 loc) · 15.7 KB

RelayersApi

All URIs are relative to http://localhost

Method HTTP request Description
cancelTransaction DELETE /api/v1/relayers/{relayer_id}/transactions/{transaction_id} Cancels a specific transaction by its ID.
createRelayer POST /api/v1/relayers Creates a new relayer.
deletePendingTransactions DELETE /api/v1/relayers/{relayer_id}/transactions/pending Deletes all pending transactions for a specific relayer.
deleteRelayer DELETE /api/v1/relayers/{relayer_id} Deletes a relayer by ID.
getRelayer GET /api/v1/relayers/{relayer_id} Retrieves details of a specific relayer by ID.
getRelayerBalance GET /api/v1/relayers/{relayer_id}/balance Retrieves the balance of a specific relayer.
getRelayerStatus GET /api/v1/relayers/{relayer_id}/status Fetches the current status of a specific relayer.
getTransactionById GET /api/v1/relayers/{relayer_id}/transactions/{transaction_id} Retrieves a specific transaction by its ID.
getTransactionByNonce GET /api/v1/relayers/{relayer_id}/transactions/by-nonce/{nonce} Retrieves a transaction by its nonce value.
listRelayers GET /api/v1/relayers Relayer routes implementation
listTransactions GET /api/v1/relayers/{relayer_id}/transactions/ Lists all transactions for a specific relayer with pagination.
replaceTransaction PUT /api/v1/relayers/{relayer_id}/transactions/{transaction_id} Replaces a specific transaction with a new one.
rpc POST /api/v1/relayers/{relayer_id}/rpc Performs a JSON-RPC call using the specified relayer.
sendTransaction POST /api/v1/relayers/{relayer_id}/transactions Sends a transaction through the specified relayer.
sign POST /api/v1/relayers/{relayer_id}/sign Signs data using the specified relayer.
signTransaction POST /api/v1/relayers/{relayer_id}/sign-transaction Signs a transaction using the specified relayer (Stellar only).
signTypedData POST /api/v1/relayers/{relayer_id}/sign-typed-data Signs typed data using the specified relayer.
updateRelayer PATCH /api/v1/relayers/{relayer_id} Updates a relayer's information based on the provided update request.

cancelTransaction

ApiResponse_TransactionResponse cancelTransaction(relayer_id, transaction_id)

Cancels a specific transaction by its ID.

Parameters

Name Type Description Notes
relayer_id String The unique identifier of the relayer [default to null]
transaction_id String The unique identifier of the transaction [default to null]

Return type

ApiResponse_TransactionResponse

Authorization

bearer_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

createRelayer

ApiResponse_RelayerResponse createRelayer(CreateRelayerRequest)

Creates a new relayer.

Parameters

Name Type Description Notes
CreateRelayerRequest CreateRelayerRequest

Return type

ApiResponse_RelayerResponse

Authorization

bearer_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deletePendingTransactions

ApiResponse_DeletePendingTransactionsResponse deletePendingTransactions(relayer_id)

Deletes all pending transactions for a specific relayer.

Parameters

Name Type Description Notes
relayer_id String The unique identifier of the relayer [default to null]

Return type

ApiResponse_DeletePendingTransactionsResponse

Authorization

bearer_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

deleteRelayer

ApiResponse_String deleteRelayer(relayer_id)

Deletes a relayer by ID.

Parameters

Name Type Description Notes
relayer_id String The unique identifier of the relayer [default to null]

Return type

ApiResponse_String

Authorization

bearer_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getRelayer

ApiResponse_RelayerResponse getRelayer(relayer_id)

Retrieves details of a specific relayer by ID.

Parameters

Name Type Description Notes
relayer_id String The unique identifier of the relayer [default to null]

Return type

ApiResponse_RelayerResponse

Authorization

bearer_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getRelayerBalance

ApiResponse_BalanceResponse getRelayerBalance(relayer_id)

Retrieves the balance of a specific relayer.

Parameters

Name Type Description Notes
relayer_id String The unique identifier of the relayer [default to null]

Return type

ApiResponse_BalanceResponse

Authorization

bearer_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getRelayerStatus

ApiResponse_RelayerStatus getRelayerStatus(relayer_id)

Fetches the current status of a specific relayer.

Parameters

Name Type Description Notes
relayer_id String The unique identifier of the relayer [default to null]

Return type

ApiResponse_RelayerStatus

Authorization

bearer_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getTransactionById

ApiResponse_TransactionResponse getTransactionById(relayer_id, transaction_id)

Retrieves a specific transaction by its ID.

Parameters

Name Type Description Notes
relayer_id String The unique identifier of the relayer [default to null]
transaction_id String The unique identifier of the transaction [default to null]

Return type

ApiResponse_TransactionResponse

Authorization

bearer_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getTransactionByNonce

ApiResponse_TransactionResponse getTransactionByNonce(relayer_id, nonce)

Retrieves a transaction by its nonce value.

Parameters

Name Type Description Notes
relayer_id String The unique identifier of the relayer [default to null]
nonce Integer The nonce of the transaction [default to null]

Return type

ApiResponse_TransactionResponse

Authorization

bearer_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

listRelayers

ApiResponse_Vec_RelayerResponse listRelayers(page, per_page)

Relayer routes implementation

Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file  Lists all relayers with pagination support.

Parameters

Name Type Description Notes
page Integer Page number for pagination (starts at 1) [optional] [default to null]
per_page Integer Number of items per page (default: 10) [optional] [default to null]

Return type

ApiResponse_Vec_RelayerResponse

Authorization

bearer_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

listTransactions

ApiResponse_Vec_TransactionResponse listTransactions(relayer_id, page, per_page)

Lists all transactions for a specific relayer with pagination.

Parameters

Name Type Description Notes
relayer_id String The unique identifier of the relayer [default to null]
page Integer Page number for pagination (starts at 1) [optional] [default to null]
per_page Integer Number of items per page (default: 10) [optional] [default to null]

Return type

ApiResponse_Vec_TransactionResponse

Authorization

bearer_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

replaceTransaction

ApiResponse_TransactionResponse replaceTransaction(relayer_id, transaction_id, NetworkTransactionRequest)

Replaces a specific transaction with a new one.

Parameters

Name Type Description Notes
relayer_id String The unique identifier of the relayer [default to null]
transaction_id String The unique identifier of the transaction [default to null]
NetworkTransactionRequest NetworkTransactionRequest

Return type

ApiResponse_TransactionResponse

Authorization

bearer_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

rpc

JsonRpcResponse_NetworkRpcResult rpc(relayer_id, JsonRpcRequest_NetworkRpcRequest)

Performs a JSON-RPC call using the specified relayer.

Parameters

Name Type Description Notes
relayer_id String The unique identifier of the relayer [default to null]
JsonRpcRequest_NetworkRpcRequest JsonRpcRequest_NetworkRpcRequest JSON-RPC request with method and parameters

Return type

JsonRpcResponse_NetworkRpcResult

Authorization

bearer_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

sendTransaction

ApiResponse_TransactionResponse sendTransaction(relayer_id, NetworkTransactionRequest)

Sends a transaction through the specified relayer.

Parameters

Name Type Description Notes
relayer_id String The unique identifier of the relayer [default to null]
NetworkTransactionRequest NetworkTransactionRequest

Return type

ApiResponse_TransactionResponse

Authorization

bearer_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

sign

ApiResponse_SignDataResponse sign(relayer_id, SignDataRequest)

Signs data using the specified relayer.

Parameters

Name Type Description Notes
relayer_id String The unique identifier of the relayer [default to null]
SignDataRequest SignDataRequest

Return type

ApiResponse_SignDataResponse

Authorization

bearer_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

signTransaction

ApiResponse_SignTransactionResponse signTransaction(relayer_id, SignTransactionRequest)

Signs a transaction using the specified relayer (Stellar only).

Parameters

Name Type Description Notes
relayer_id String The unique identifier of the relayer [default to null]
SignTransactionRequest SignTransactionRequest

Return type

ApiResponse_SignTransactionResponse

Authorization

bearer_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

signTypedData

ApiResponse_SignDataResponse signTypedData(relayer_id, SignTypedDataRequest)

Signs typed data using the specified relayer.

Parameters

Name Type Description Notes
relayer_id String The unique identifier of the relayer [default to null]
SignTypedDataRequest SignTypedDataRequest

Return type

ApiResponse_SignDataResponse

Authorization

bearer_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateRelayer

ApiResponse_RelayerResponse updateRelayer(relayer_id, UpdateRelayerRequest)

Updates a relayer's information based on the provided update request.

Parameters

Name Type Description Notes
relayer_id String The unique identifier of the relayer [default to null]
UpdateRelayerRequest UpdateRelayerRequest

Return type

ApiResponse_RelayerResponse

Authorization

bearer_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json