diff --git a/docs/.openapi-generator/FILES b/docs/.openapi-generator/FILES index e2ddb562..7d59bd91 100644 --- a/docs/.openapi-generator/FILES +++ b/docs/.openapi-generator/FILES @@ -1,5 +1,6 @@ Apis/HealthApi.md Apis/MetricsApi.md +Apis/NetworksApi.md Apis/NotificationsApi.md Apis/PluginsApi.md Apis/RelayersApi.md @@ -8,10 +9,16 @@ Models/ApiResponse_BalanceResponse.md Models/ApiResponse_BalanceResponse_data.md Models/ApiResponse_DeletePendingTransactionsResponse.md Models/ApiResponse_DeletePendingTransactionsResponse_data.md +Models/ApiResponse_NetworkResponse.md +Models/ApiResponse_NetworkResponse_data.md Models/ApiResponse_NotificationResponse.md Models/ApiResponse_NotificationResponse_data.md +Models/ApiResponse_PaginatedResult_PluginModel.md +Models/ApiResponse_PaginatedResult_PluginModel_data.md +Models/ApiResponse_PaginatedResult_PluginModel_data_items_inner.md Models/ApiResponse_PluginHandlerError.md Models/ApiResponse_PluginHandlerError_data.md +Models/ApiResponse_PluginModel.md Models/ApiResponse_RelayerResponse.md Models/ApiResponse_RelayerResponse_data.md Models/ApiResponse_RelayerStatus.md @@ -33,6 +40,7 @@ Models/ApiResponse_String.md Models/ApiResponse_TransactionResponse.md Models/ApiResponse_TransactionResponse_data.md Models/ApiResponse_Value.md +Models/ApiResponse_Vec_NetworkResponse.md Models/ApiResponse_Vec_NotificationResponse.md Models/ApiResponse_Vec_RelayerResponse.md Models/ApiResponse_Vec_SignerResponse.md @@ -49,6 +57,8 @@ Models/AuthSpec_oneOf_3.md Models/AwsKmsSignerRequestConfig.md Models/BalanceResponse.md Models/CdpSignerRequestConfig.md +Models/ComponentStatus.md +Models/Components.md Models/ContractSource.md Models/ContractSource_oneOf.md Models/ContractSource_oneOf_1.md @@ -85,6 +95,7 @@ Models/JupiterSwapOptions.md Models/LocalSignerRequestConfig.md Models/LogEntry.md Models/LogLevel.md +Models/MaskedRpcConfig.md Models/MemoSpec.md Models/MemoSpec_oneOf.md Models/MemoSpec_oneOf_1.md @@ -92,6 +103,7 @@ Models/MemoSpec_oneOf_2.md Models/MemoSpec_oneOf_3.md Models/MemoSpec_oneOf_4.md Models/NetworkPolicyResponse.md +Models/NetworkResponse.md Models/NetworkRpcRequest.md Models/NetworkRpcResult.md Models/NetworkTransactionRequest.md @@ -107,7 +119,13 @@ Models/OperationSpec_oneOf_3.md Models/PaginationMeta.md Models/PluginCallRequest.md Models/PluginHandlerError.md +Models/PluginHealth.md Models/PluginMetadata.md +Models/PluginModel.md +Models/PoolStatus.md +Models/QueueHealth.md +Models/ReadinessResponse.md +Models/RedisHealth.md Models/RelayerEvmPolicy.md Models/RelayerNetworkPolicy.md Models/RelayerNetworkPolicyResponse.md @@ -122,6 +140,7 @@ Models/RelayerStatus.md Models/RelayerStellarPolicy.md Models/RelayerStellarSwapConfig.md Models/RpcConfig.md +Models/RpcUrlEntry.md Models/SignAndSendTransactionRequestParams.md Models/SignAndSendTransactionResult.md Models/SignDataRequest.md @@ -206,11 +225,14 @@ Models/StellarTokenKind_oneOf_classic.md Models/StellarTokenMetadata.md Models/StellarTransactionRequest.md Models/StellarTransactionResponse.md +Models/SystemHealth.md Models/TransactionResponse.md Models/TransactionStatus.md Models/TransferTransactionRequestParams.md Models/TransferTransactionResult.md Models/TurnkeySignerRequestConfig.md +Models/UpdateNetworkRequest.md +Models/UpdatePluginRequest.md Models/UpdateRelayerRequest.md Models/VaultSignerRequestConfig.md Models/VaultTransitSignerRequestConfig.md diff --git a/docs/Apis/HealthApi.md b/docs/Apis/HealthApi.md index 4a63de93..189affb4 100644 --- a/docs/Apis/HealthApi.md +++ b/docs/Apis/HealthApi.md @@ -4,7 +4,8 @@ All URIs are relative to *http://localhost* | Method | HTTP request | Description | |------------- | ------------- | -------------| -| [**health**](HealthApi.md#health) | **GET** /v1/health | Health routes implementation | +| [**health**](HealthApi.md#health) | **GET** /api/v1/health | Health routes implementation | +| [**readiness**](HealthApi.md#readiness) | **GET** /api/v1/ready | Readiness endpoint that checks system resources, Redis, Queue, and plugins. | @@ -13,7 +14,7 @@ All URIs are relative to *http://localhost* Health routes implementation - Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file Handles the `/health` endpoint. Returns an `HttpResponse` with a status of `200 OK` and a body of `\"OK\"`. + Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file Handles the `/health` endpoint. Returns an `HttpResponse` with a status of `200 OK` and a body of `\"OK\"`. This endpoint is used for liveness probes in container orchestration platforms. ### Parameters This endpoint does not need any parameter. @@ -31,3 +32,27 @@ No authorization required - **Content-Type**: Not defined - **Accept**: text/plain + +# **readiness** +> ReadinessResponse readiness() + +Readiness endpoint that checks system resources, Redis, Queue, and plugins. + + Returns 200 OK if the service is ready to accept traffic, or 503 Service Unavailable if not. This endpoint is used for readiness probes in container orchestration platforms like AWS ECS or Kubernetes. ## Health Check Components - **System**: File descriptor usage, CLOSE_WAIT socket count - **Redis**: Primary and reader pool connectivity - **Queue**: Queue's Redis connections (separate from app's Redis) - **Plugins**: Plugin pool health, circuit breaker state, and connection metrics (if enabled) ## Status Levels - `healthy`: All components operational - `degraded`: Some components degraded but service can function (e.g., reader pool down) - `unhealthy`: Critical components failed, service unavailable ## Plugin Connection Metrics When plugins are enabled, the following connection metrics are exposed: - `shared_socket_available_slots`: Number of additional concurrent plugin executions that can start - `shared_socket_active_connections`: Current number of active plugin execution connections - `shared_socket_registered_executions`: Number of plugin executions currently registered (awaiting response) - `connection_pool_available_slots`: Available connections to the pool server - `connection_pool_active_connections`: Active connections to the pool server These metrics help diagnose connection pool exhaustion and plugin capacity issues. ## Caching Health check results are cached for 10 seconds to prevent excessive load from frequent health checks. Multiple requests within the TTL return the same cached response. + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**ReadinessResponse**](../Models/ReadinessResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + diff --git a/docs/Apis/NetworksApi.md b/docs/Apis/NetworksApi.md new file mode 100644 index 00000000..876e44df --- /dev/null +++ b/docs/Apis/NetworksApi.md @@ -0,0 +1,90 @@ +# NetworksApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getNetwork**](NetworksApi.md#getNetwork) | **GET** /api/v1/networks/{network_id} | Retrieves details of a specific network by ID. | +| [**listNetworks**](NetworksApi.md#listNetworks) | **GET** /api/v1/networks | Network routes implementation | +| [**updateNetwork**](NetworksApi.md#updateNetwork) | **PATCH** /api/v1/networks/{network_id} | Updates a network's configuration. Currently supports updating RPC URLs only. Can be extended to support other fields. | + + + +# **getNetwork** +> ApiResponse_NetworkResponse getNetwork(network\_id) + +Retrieves details of a specific network by ID. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **network\_id** | **String**| Network ID (e.g., evm:sepolia, solana:mainnet) | [default to null] | + +### Return type + +[**ApiResponse_NetworkResponse**](../Models/ApiResponse_NetworkResponse.md) + +### Authorization + +[bearer_auth](../README.md#bearer_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **listNetworks** +> ApiResponse_Vec_NetworkResponse listNetworks(page, per\_page) + +Network routes implementation + + Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file Lists all networks 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_NetworkResponse**](../Models/ApiResponse_Vec_NetworkResponse.md) + +### Authorization + +[bearer_auth](../README.md#bearer_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **updateNetwork** +> ApiResponse_NetworkResponse updateNetwork(network\_id, UpdateNetworkRequest) + +Updates a network's configuration. Currently supports updating RPC URLs only. Can be extended to support other fields. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **network\_id** | **String**| Network ID (e.g., evm:sepolia, solana:mainnet) | [default to null] | +| **UpdateNetworkRequest** | [**UpdateNetworkRequest**](../Models/UpdateNetworkRequest.md)| | | + +### Return type + +[**ApiResponse_NetworkResponse**](../Models/ApiResponse_NetworkResponse.md) + +### Authorization + +[bearer_auth](../README.md#bearer_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + diff --git a/docs/Apis/PluginsApi.md b/docs/Apis/PluginsApi.md index dfe310bc..0c36e5b3 100644 --- a/docs/Apis/PluginsApi.md +++ b/docs/Apis/PluginsApi.md @@ -4,16 +4,20 @@ All URIs are relative to *http://localhost* | Method | HTTP request | Description | |------------- | ------------- | -------------| -| [**callPlugin**](PluginsApi.md#callPlugin) | **POST** /api/v1/plugins/{plugin_id}/call | Execute a plugin and receive the sanitized result | +| [**callPlugin**](PluginsApi.md#callPlugin) | **POST** /api/v1/plugins/{plugin_id}/call | Execute a plugin with optional wildcard route routing | +| [**callPluginGet**](PluginsApi.md#callPluginGet) | **GET** /api/v1/plugins/{plugin_id}/call | Execute a plugin via GET (must be enabled per plugin) | +| [**getPlugin**](PluginsApi.md#getPlugin) | **GET** /api/v1/plugins/{plugin_id} | Get plugin by ID | +| [**listPlugins**](PluginsApi.md#listPlugins) | **GET** /api/v1/plugins | List plugins. | +| [**updatePlugin**](PluginsApi.md#updatePlugin) | **PATCH** /api/v1/plugins/{plugin_id} | Update plugin configuration | # **callPlugin** -> ApiResponse_Value callPlugin(plugin\_id, PluginCallRequest) +> ApiResponse_Value callPlugin(plugin\_id, PluginCallRequest, route) -Execute a plugin and receive the sanitized result +Execute a plugin with optional wildcard route routing - Logs and traces are only returned when the plugin is configured with `emit_logs` / `emit_traces`. Plugin-provided errors are normalized into a consistent payload (`code`, `details`) and a derived message so downstream clients receive a stable shape regardless of how the handler threw. + Logs and traces are only returned when the plugin is configured with `emit_logs` / `emit_traces`. Plugin-provided errors are normalized into a consistent payload (`code`, `details`) and a derived message so downstream clients receive a stable shape regardless of how the handler threw. The endpoint supports wildcard route routing, allowing plugins to implement custom routing logic: - `/api/v1/plugins/{plugin_id}/call` - Default endpoint (route = \"\") - `/api/v1/plugins/{plugin_id}/call?route=/verify` - Custom route via query parameter - `/api/v1/plugins/{plugin_id}/call/verify` - Custom route via URL path (route = \"/verify\") The route is passed to the plugin handler via the `context.route` field. You can specify a custom route either by appending it to the URL path or by using the `route` query parameter. ### Parameters @@ -21,6 +25,7 @@ Execute a plugin and receive the sanitized result |------------- | ------------- | ------------- | -------------| | **plugin\_id** | **String**| The unique identifier of the plugin | [default to null] | | **PluginCallRequest** | [**PluginCallRequest**](../Models/PluginCallRequest.md)| | | +| **route** | **String**| Optional route suffix for custom routing (e.g., '/verify'). Alternative to appending the route to the URL path. | [optional] [default to null] | ### Return type @@ -35,3 +40,110 @@ Execute a plugin and receive the sanitized result - **Content-Type**: application/json - **Accept**: application/json + +# **callPluginGet** +> ApiResponse_Value callPluginGet(plugin\_id, route) + +Execute a plugin via GET (must be enabled per plugin) + + This endpoint is disabled by default. To enable it for a given plugin, set `allow_get_invocation: true` in the plugin configuration. When invoked via GET: - `params` is an empty object (`{}`) - query parameters are passed to the plugin handler via `context.query` - wildcard route routing is supported the same way as POST (see `doc_call_plugin`) - Use the `route` query parameter or append the route to the URL path + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **plugin\_id** | **String**| The unique identifier of the plugin | [default to null] | +| **route** | **String**| Optional route suffix for custom routing (e.g., '/verify'). Alternative to appending the route to the URL path. | [optional] [default to null] | + +### Return type + +[**ApiResponse_Value**](../Models/ApiResponse_Value.md) + +### Authorization + +[bearer_auth](../README.md#bearer_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **getPlugin** +> ApiResponse_PluginModel getPlugin(plugin\_id) + +Get plugin by ID + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **plugin\_id** | **String**| The unique identifier of the plugin | [default to null] | + +### Return type + +[**ApiResponse_PluginModel**](../Models/ApiResponse_PluginModel.md) + +### Authorization + +[bearer_auth](../README.md#bearer_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **listPlugins** +> ApiResponse_PaginatedResult_PluginModel listPlugins(page, per\_page) + +List plugins. + +### 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_PaginatedResult_PluginModel**](../Models/ApiResponse_PaginatedResult_PluginModel.md) + +### Authorization + +[bearer_auth](../README.md#bearer_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +# **updatePlugin** +> ApiResponse_PluginModel updatePlugin(plugin\_id, UpdatePluginRequest) + +Update plugin configuration + + Updates mutable plugin fields such as timeout, emit_logs, emit_traces, raw_response, allow_get_invocation, config, and forward_logs. The plugin id and path cannot be changed after creation. All fields are optional - only the provided fields will be updated. To clear the `config` field, pass `\"config\": null`. + +### Parameters + +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **plugin\_id** | **String**| The unique identifier of the plugin | [default to null] | +| **UpdatePluginRequest** | [**UpdatePluginRequest**](../Models/UpdatePluginRequest.md)| Plugin configuration update. All fields are optional. | | + +### Return type + +[**ApiResponse_PluginModel**](../Models/ApiResponse_PluginModel.md) + +### Authorization + +[bearer_auth](../README.md#bearer_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + diff --git a/docs/Models/ApiResponse_NetworkResponse.md b/docs/Models/ApiResponse_NetworkResponse.md new file mode 100644 index 00000000..53fa962a --- /dev/null +++ b/docs/Models/ApiResponse_NetworkResponse.md @@ -0,0 +1,13 @@ +# ApiResponse_NetworkResponse +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **data** | [**ApiResponse_NetworkResponse_data**](ApiResponse_NetworkResponse_data.md) | | [optional] [default to null] | +| **error** | **String** | | [optional] [default to null] | +| **metadata** | [**PluginMetadata**](PluginMetadata.md) | | [optional] [default to null] | +| **pagination** | [**PaginationMeta**](PaginationMeta.md) | | [optional] [default to null] | +| **success** | **Boolean** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Models/ApiResponse_NetworkResponse_data.md b/docs/Models/ApiResponse_NetworkResponse_data.md new file mode 100644 index 00000000..57b05f9e --- /dev/null +++ b/docs/Models/ApiResponse_NetworkResponse_data.md @@ -0,0 +1,22 @@ +# ApiResponse_NetworkResponse_data +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **average\_blocktime\_ms** | **Long** | Estimated average time between blocks in milliseconds | [optional] [default to null] | +| **chain\_id** | **Long** | EVM-specific: Chain ID | [optional] [default to null] | +| **explorer\_urls** | **List** | List of Explorer endpoint URLs | [optional] [default to null] | +| **features** | **List** | EVM-specific: Network features (e.g., \"eip1559\") | [optional] [default to null] | +| **horizon\_url** | **String** | Stellar-specific: Horizon URL | [optional] [default to null] | +| **id** | **String** | Unique identifier composed of network_type and name, e.g., \"evm:mainnet\" | [default to null] | +| **is\_testnet** | **Boolean** | Flag indicating if the network is a testnet | [optional] [default to null] | +| **name** | **String** | Name of the network (e.g., \"mainnet\", \"sepolia\") | [default to null] | +| **network\_type** | [**RelayerNetworkType**](RelayerNetworkType.md) | Type of the network (EVM, Solana, Stellar) | [default to null] | +| **passphrase** | **String** | Stellar-specific: Network passphrase | [optional] [default to null] | +| **required\_confirmations** | **Long** | EVM-specific: Required confirmations | [optional] [default to null] | +| **rpc\_urls** | [**List**](RpcConfig.md) | List of RPC endpoint configurations | [optional] [default to null] | +| **symbol** | **String** | EVM-specific: Native token symbol | [optional] [default to null] | +| **tags** | **List** | List of arbitrary tags for categorizing or filtering networks | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Models/ApiResponse_PaginatedResult_PluginModel.md b/docs/Models/ApiResponse_PaginatedResult_PluginModel.md new file mode 100644 index 00000000..e2fb102e --- /dev/null +++ b/docs/Models/ApiResponse_PaginatedResult_PluginModel.md @@ -0,0 +1,13 @@ +# ApiResponse_PaginatedResult_PluginModel +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **data** | [**ApiResponse_PaginatedResult_PluginModel_data**](ApiResponse_PaginatedResult_PluginModel_data.md) | | [optional] [default to null] | +| **error** | **String** | | [optional] [default to null] | +| **metadata** | [**PluginMetadata**](PluginMetadata.md) | | [optional] [default to null] | +| **pagination** | [**PaginationMeta**](PaginationMeta.md) | | [optional] [default to null] | +| **success** | **Boolean** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Models/ApiResponse_PaginatedResult_PluginModel_data.md b/docs/Models/ApiResponse_PaginatedResult_PluginModel_data.md new file mode 100644 index 00000000..e012bf26 --- /dev/null +++ b/docs/Models/ApiResponse_PaginatedResult_PluginModel_data.md @@ -0,0 +1,12 @@ +# ApiResponse_PaginatedResult_PluginModel_data +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **items** | [**List**](ApiResponse_PaginatedResult_PluginModel_data_items_inner.md) | | [default to null] | +| **page** | **Integer** | | [default to null] | +| **per\_page** | **Integer** | | [default to null] | +| **total** | **Long** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Models/ApiResponse_PaginatedResult_PluginModel_data_items_inner.md b/docs/Models/ApiResponse_PaginatedResult_PluginModel_data_items_inner.md new file mode 100644 index 00000000..55266b2e --- /dev/null +++ b/docs/Models/ApiResponse_PaginatedResult_PluginModel_data_items_inner.md @@ -0,0 +1,17 @@ +# ApiResponse_PaginatedResult_PluginModel_data_items_inner +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **allow\_get\_invocation** | **Boolean** | Whether to allow GET requests to invoke plugin logic | [optional] [default to null] | +| **config** | [**Map**](AnyType.md) | User-defined configuration accessible to the plugin (must be a JSON object) | [optional] [default to null] | +| **emit\_logs** | **Boolean** | Whether to include logs in the HTTP response | [optional] [default to null] | +| **emit\_traces** | **Boolean** | Whether to include traces in the HTTP response | [optional] [default to null] | +| **forward\_logs** | **Boolean** | Whether to forward plugin logs into the relayer's tracing output | [optional] [default to null] | +| **id** | **String** | Plugin ID | [default to null] | +| **path** | **String** | Plugin path | [default to null] | +| **raw\_response** | **Boolean** | Whether to return raw plugin response without ApiResponse wrapper | [optional] [default to null] | +| **timeout** | **Long** | Plugin timeout | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Models/ApiResponse_PluginModel.md b/docs/Models/ApiResponse_PluginModel.md new file mode 100644 index 00000000..6de933e3 --- /dev/null +++ b/docs/Models/ApiResponse_PluginModel.md @@ -0,0 +1,13 @@ +# ApiResponse_PluginModel +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **data** | [**ApiResponse_PaginatedResult_PluginModel_data_items_inner**](ApiResponse_PaginatedResult_PluginModel_data_items_inner.md) | | [optional] [default to null] | +| **error** | **String** | | [optional] [default to null] | +| **metadata** | [**PluginMetadata**](PluginMetadata.md) | | [optional] [default to null] | +| **pagination** | [**PaginationMeta**](PaginationMeta.md) | | [optional] [default to null] | +| **success** | **Boolean** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Models/ApiResponse_RelayerResponse_data.md b/docs/Models/ApiResponse_RelayerResponse_data.md index 49f7222d..9d52d951 100644 --- a/docs/Models/ApiResponse_RelayerResponse_data.md +++ b/docs/Models/ApiResponse_RelayerResponse_data.md @@ -4,7 +4,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | **address** | **String** | | [optional] [default to null] | -| **custom\_rpc\_urls** | [**List**](RpcConfig.md) | | [optional] [default to null] | +| **custom\_rpc\_urls** | [**List**](MaskedRpcConfig.md) | Custom RPC URLs with sensitive path/query parameters masked for security. The domain is visible to identify providers (e.g., Alchemy, Infura) but API keys embedded in paths are hidden. | [optional] [default to null] | | **disabled\_reason** | [**DisabledReason**](DisabledReason.md) | | [optional] [default to null] | | **id** | **String** | | [default to null] | | **name** | **String** | | [default to null] | diff --git a/docs/Models/ApiResponse_SponsoredTransactionBuildResponse_data.md b/docs/Models/ApiResponse_SponsoredTransactionBuildResponse_data.md index da3004ec..8659ad2c 100644 --- a/docs/Models/ApiResponse_SponsoredTransactionBuildResponse_data.md +++ b/docs/Models/ApiResponse_SponsoredTransactionBuildResponse_data.md @@ -11,6 +11,9 @@ | **fee\_in\_stroops** | **String** | Fee amount in stroops (as string) | [default to null] | | **fee\_in\_token** | **String** | Fee amount in token (raw units as string) | [default to null] | | **fee\_in\_token\_ui** | **String** | Fee amount in token (decimal UI representation as string) | [default to null] | +| **max\_fee\_in\_token** | **String** | Maximum fee in token amount (raw units as string). Only present for Soroban gas abstraction - includes slippage buffer. | [optional] [default to null] | +| **max\_fee\_in\_token\_ui** | **String** | Maximum fee in token amount (decimal UI representation as string). Only present for Soroban gas abstraction - includes slippage buffer. | [optional] [default to null] | +| **user\_auth\_entry** | **String** | User authorization entry XDR (base64 encoded). Present for Soroban gas abstraction - user must sign this auth entry. | [optional] [default to null] | | **valid\_until** | **String** | Transaction validity timestamp (ISO 8601 format) | [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Models/ApiResponse_SponsoredTransactionQuoteResponse_data.md b/docs/Models/ApiResponse_SponsoredTransactionQuoteResponse_data.md index 52669023..7928ef6c 100644 --- a/docs/Models/ApiResponse_SponsoredTransactionQuoteResponse_data.md +++ b/docs/Models/ApiResponse_SponsoredTransactionQuoteResponse_data.md @@ -7,6 +7,8 @@ | **estimated\_fee** | **String** | | [default to null] | | **fee\_in\_token** | **String** | Estimated fee in token amount (raw units as string) | [default to null] | | **fee\_in\_token\_ui** | **String** | Estimated fee in token amount (decimal UI representation as string) | [default to null] | +| **max\_fee\_in\_token** | **String** | Maximum fee in token amount (raw units as string). Only present for Soroban gas abstraction - includes slippage buffer. | [optional] [default to null] | +| **max\_fee\_in\_token\_ui** | **String** | Maximum fee in token amount (decimal UI representation as string). Only present for Soroban gas abstraction - includes slippage buffer. | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Models/ApiResponse_TransactionResponse_data.md b/docs/Models/ApiResponse_TransactionResponse_data.md index 2c171b83..91066e37 100644 --- a/docs/Models/ApiResponse_TransactionResponse_data.md +++ b/docs/Models/ApiResponse_TransactionResponse_data.md @@ -27,6 +27,7 @@ | **fee** | **Integer** | | [default to null] | | **sequence\_number** | **Long** | | [default to null] | | **source\_account** | **String** | | [default to null] | +| **transaction\_result\_xdr** | **String** | | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Models/ApiResponse_Vec_NetworkResponse.md b/docs/Models/ApiResponse_Vec_NetworkResponse.md new file mode 100644 index 00000000..c1c803e1 --- /dev/null +++ b/docs/Models/ApiResponse_Vec_NetworkResponse.md @@ -0,0 +1,13 @@ +# ApiResponse_Vec_NetworkResponse +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **data** | [**List**](ApiResponse_NetworkResponse_data.md) | | [optional] [default to null] | +| **error** | **String** | | [optional] [default to null] | +| **metadata** | [**PluginMetadata**](PluginMetadata.md) | | [optional] [default to null] | +| **pagination** | [**PaginationMeta**](PaginationMeta.md) | | [optional] [default to null] | +| **success** | **Boolean** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Models/ComponentStatus.md b/docs/Models/ComponentStatus.md new file mode 100644 index 00000000..e1df9594 --- /dev/null +++ b/docs/Models/ComponentStatus.md @@ -0,0 +1,8 @@ +# ComponentStatus +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Models/Components.md b/docs/Models/Components.md new file mode 100644 index 00000000..82083e33 --- /dev/null +++ b/docs/Models/Components.md @@ -0,0 +1,12 @@ +# Components +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **plugins** | [**PluginHealth**](PluginHealth.md) | | [optional] [default to null] | +| **queue** | [**QueueHealth**](QueueHealth.md) | | [default to null] | +| **redis** | [**RedisHealth**](RedisHealth.md) | | [default to null] | +| **system** | [**SystemHealth**](SystemHealth.md) | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Models/MaskedRpcConfig.md b/docs/Models/MaskedRpcConfig.md new file mode 100644 index 00000000..e418e5f2 --- /dev/null +++ b/docs/Models/MaskedRpcConfig.md @@ -0,0 +1,10 @@ +# MaskedRpcConfig +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **url** | **String** | The RPC endpoint URL with path/query masked. | [default to null] | +| **weight** | **Integer** | The weight of this endpoint in the weighted round-robin selection. | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Models/NetworkResponse.md b/docs/Models/NetworkResponse.md new file mode 100644 index 00000000..8691fab0 --- /dev/null +++ b/docs/Models/NetworkResponse.md @@ -0,0 +1,22 @@ +# NetworkResponse +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **average\_blocktime\_ms** | **Long** | Estimated average time between blocks in milliseconds | [optional] [default to null] | +| **chain\_id** | **Long** | EVM-specific: Chain ID | [optional] [default to null] | +| **explorer\_urls** | **List** | List of Explorer endpoint URLs | [optional] [default to null] | +| **features** | **List** | EVM-specific: Network features (e.g., \"eip1559\") | [optional] [default to null] | +| **horizon\_url** | **String** | Stellar-specific: Horizon URL | [optional] [default to null] | +| **id** | **String** | Unique identifier composed of network_type and name, e.g., \"evm:mainnet\" | [default to null] | +| **is\_testnet** | **Boolean** | Flag indicating if the network is a testnet | [optional] [default to null] | +| **name** | **String** | Name of the network (e.g., \"mainnet\", \"sepolia\") | [default to null] | +| **network\_type** | [**RelayerNetworkType**](RelayerNetworkType.md) | Type of the network (EVM, Solana, Stellar) | [default to null] | +| **passphrase** | **String** | Stellar-specific: Network passphrase | [optional] [default to null] | +| **required\_confirmations** | **Long** | EVM-specific: Required confirmations | [optional] [default to null] | +| **rpc\_urls** | [**List**](RpcConfig.md) | List of RPC endpoint configurations | [optional] [default to null] | +| **symbol** | **String** | EVM-specific: Native token symbol | [optional] [default to null] | +| **tags** | **List** | List of arbitrary tags for categorizing or filtering networks | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Models/NetworkTransactionRequest.md b/docs/Models/NetworkTransactionRequest.md index 86898afc..dbf72a18 100644 --- a/docs/Models/NetworkTransactionRequest.md +++ b/docs/Models/NetworkTransactionRequest.md @@ -19,8 +19,9 @@ | **memo** | [**MemoSpec**](MemoSpec.md) | | [optional] [default to null] | | **network** | **String** | | [default to null] | | **operations** | [**List**](OperationSpec.md) | | [optional] [default to null] | +| **signed\_auth\_entry** | **String** | Signed Soroban authorization entry (base64 encoded SorobanAuthorizationEntry XDR) Used for Soroban gas abstraction: contains the user's signed auth entry from /build response. When provided, transaction_xdr must also be provided (the FeeForwarder transaction from /build). The relayer will inject this signed auth entry into the transaction before submitting. | [optional] [default to null] | | **source\_account** | **String** | | [optional] [default to null] | -| **transaction\_xdr** | **String** | Pre-built transaction XDR (base64 encoded, signed or unsigned) Mutually exclusive with operations field | [optional] [default to null] | +| **transaction\_xdr** | **String** | Pre-built transaction XDR (base64 encoded, signed or unsigned) Mutually exclusive with operations field. For Soroban gas abstraction: submit the transaction XDR from sponsored/build response with the user's signed auth entry updated inside. | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Models/PluginCallRequest.md b/docs/Models/PluginCallRequest.md index cf341550..847035cf 100644 --- a/docs/Models/PluginCallRequest.md +++ b/docs/Models/PluginCallRequest.md @@ -3,7 +3,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| **params** | [**oas_any_type_not_mapped**](.md) | | [default to null] | +| **params** | [**oas_any_type_not_mapped**](.md) | | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Models/PluginHealth.md b/docs/Models/PluginHealth.md new file mode 100644 index 00000000..5de8470f --- /dev/null +++ b/docs/Models/PluginHealth.md @@ -0,0 +1,25 @@ +# PluginHealth +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **avg\_response\_time\_ms** | **Integer** | Average response time in milliseconds | [optional] [default to null] | +| **circuit\_state** | **String** | | [optional] [default to null] | +| **connection\_pool\_active\_connections** | **Integer** | Connection pool active connections (for pool server connections) | [optional] [default to null] | +| **connection\_pool\_available\_slots** | **Integer** | Connection pool available slots (for pool server connections) | [optional] [default to null] | +| **enabled** | **Boolean** | | [default to null] | +| **error** | **String** | | [optional] [default to null] | +| **memory** | **Long** | Memory usage in bytes | [optional] [default to null] | +| **pool\_completed** | **Long** | Number of completed tasks in the pool | [optional] [default to null] | +| **pool\_queued** | **Long** | Number of queued tasks in the pool | [optional] [default to null] | +| **recovering** | **Boolean** | Whether recovery mode is active | [optional] [default to null] | +| **recovery\_percent** | **Integer** | Current recovery allowance percentage | [optional] [default to null] | +| **shared\_socket\_active\_connections** | **Integer** | Shared socket active connection count | [optional] [default to null] | +| **shared\_socket\_available\_slots** | **Integer** | Shared socket available connection slots | [optional] [default to null] | +| **shared\_socket\_registered\_executions** | **Integer** | Shared socket registered execution count | [optional] [default to null] | +| **status** | [**ComponentStatus**](ComponentStatus.md) | | [default to null] | +| **success\_rate** | **Double** | Success rate as a percentage (0.0-100.0) | [optional] [default to null] | +| **uptime\_ms** | **Long** | Plugin uptime in milliseconds | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Models/PluginModel.md b/docs/Models/PluginModel.md new file mode 100644 index 00000000..97e40cdd --- /dev/null +++ b/docs/Models/PluginModel.md @@ -0,0 +1,17 @@ +# PluginModel +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **allow\_get\_invocation** | **Boolean** | Whether to allow GET requests to invoke plugin logic | [optional] [default to null] | +| **config** | [**Map**](AnyType.md) | User-defined configuration accessible to the plugin (must be a JSON object) | [optional] [default to null] | +| **emit\_logs** | **Boolean** | Whether to include logs in the HTTP response | [optional] [default to null] | +| **emit\_traces** | **Boolean** | Whether to include traces in the HTTP response | [optional] [default to null] | +| **forward\_logs** | **Boolean** | Whether to forward plugin logs into the relayer's tracing output | [optional] [default to null] | +| **id** | **String** | Plugin ID | [default to null] | +| **path** | **String** | Plugin path | [default to null] | +| **raw\_response** | **Boolean** | Whether to return raw plugin response without ApiResponse wrapper | [optional] [default to null] | +| **timeout** | **Long** | Plugin timeout | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Models/PoolStatus.md b/docs/Models/PoolStatus.md new file mode 100644 index 00000000..6613017c --- /dev/null +++ b/docs/Models/PoolStatus.md @@ -0,0 +1,12 @@ +# PoolStatus +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **available** | **Integer** | Number of available connections in the pool. | [default to null] | +| **connected** | **Boolean** | Whether the pool is connected and responding to PING. | [default to null] | +| **error** | **String** | Error message if the pool is not healthy. | [optional] [default to null] | +| **max\_size** | **Integer** | Maximum configured pool size. | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Models/QueueHealth.md b/docs/Models/QueueHealth.md new file mode 100644 index 00000000..b1fe68f0 --- /dev/null +++ b/docs/Models/QueueHealth.md @@ -0,0 +1,10 @@ +# QueueHealth +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **error** | **String** | | [optional] [default to null] | +| **status** | [**ComponentStatus**](ComponentStatus.md) | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Models/ReadinessResponse.md b/docs/Models/ReadinessResponse.md new file mode 100644 index 00000000..b84be32b --- /dev/null +++ b/docs/Models/ReadinessResponse.md @@ -0,0 +1,13 @@ +# ReadinessResponse +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **components** | [**Components**](Components.md) | | [default to null] | +| **ready** | **Boolean** | | [default to null] | +| **reason** | **String** | | [optional] [default to null] | +| **status** | [**ComponentStatus**](ComponentStatus.md) | | [default to null] | +| **timestamp** | **String** | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Models/RedisHealth.md b/docs/Models/RedisHealth.md new file mode 100644 index 00000000..72ede69c --- /dev/null +++ b/docs/Models/RedisHealth.md @@ -0,0 +1,12 @@ +# RedisHealth +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **error** | **String** | | [optional] [default to null] | +| **primary\_pool** | [**PoolStatus**](PoolStatus.md) | | [default to null] | +| **reader\_pool** | [**PoolStatus**](PoolStatus.md) | | [default to null] | +| **status** | [**ComponentStatus**](ComponentStatus.md) | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Models/RelayerResponse.md b/docs/Models/RelayerResponse.md index 4ac26556..e1d2fa00 100644 --- a/docs/Models/RelayerResponse.md +++ b/docs/Models/RelayerResponse.md @@ -4,7 +4,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | **address** | **String** | | [optional] [default to null] | -| **custom\_rpc\_urls** | [**List**](RpcConfig.md) | | [optional] [default to null] | +| **custom\_rpc\_urls** | [**List**](MaskedRpcConfig.md) | Custom RPC URLs with sensitive path/query parameters masked for security. The domain is visible to identify providers (e.g., Alchemy, Infura) but API keys embedded in paths are hidden. | [optional] [default to null] | | **disabled\_reason** | [**DisabledReason**](DisabledReason.md) | | [optional] [default to null] | | **id** | **String** | | [default to null] | | **name** | **String** | | [default to null] | diff --git a/docs/Models/RpcConfig.md b/docs/Models/RpcConfig.md index 77469a60..15539968 100644 --- a/docs/Models/RpcConfig.md +++ b/docs/Models/RpcConfig.md @@ -4,7 +4,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | **url** | **String** | The RPC endpoint URL. | [default to null] | -| **weight** | **Integer** | The weight of this endpoint in the weighted round-robin selection. Defaults to DEFAULT_RPC_WEIGHT (100). Should be between 0 and 100. | [optional] [default to null] | +| **weight** | **Integer** | The weight of this endpoint in the weighted round-robin selection. Defaults to [`DEFAULT_RPC_WEIGHT`]. Should be between 0 and 100. | [default to 100] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Models/RpcUrlEntry.md b/docs/Models/RpcUrlEntry.md new file mode 100644 index 00000000..8fad22fb --- /dev/null +++ b/docs/Models/RpcUrlEntry.md @@ -0,0 +1,10 @@ +# RpcUrlEntry +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **url** | **String** | The RPC endpoint URL. | [default to null] | +| **weight** | **Integer** | The weight of this endpoint in the weighted round-robin selection. Defaults to [`DEFAULT_RPC_WEIGHT`]. Should be between 0 and 100. | [default to 100] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Models/SponsoredTransactionBuildRequest.md b/docs/Models/SponsoredTransactionBuildRequest.md index 632ff205..0ab59489 100644 --- a/docs/Models/SponsoredTransactionBuildRequest.md +++ b/docs/Models/SponsoredTransactionBuildRequest.md @@ -3,11 +3,11 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| **fee\_token** | **String** | Asset identifier for fee token | [default to null] | +| **fee\_token** | **String** | Asset identifier for fee token. For classic: \"native\" or \"USDC:GA5Z...\" format. For Soroban: contract address (C...) format. | [default to null] | | **transaction** | **String** | | [default to null] | | **operations** | [**List**](OperationSpec.md) | Operations array to build transaction from Mutually exclusive with transaction_xdr field | [optional] [default to null] | | **source\_account** | **String** | Source account address (required when operations are provided) For gasless transactions, this should be the user's account address | [optional] [default to null] | -| **transaction\_xdr** | **String** | Pre-built transaction XDR (base64 encoded, signed or unsigned) Mutually exclusive with operations field | [optional] [default to null] | +| **transaction\_xdr** | **String** | Pre-built transaction XDR (base64 encoded, signed or unsigned) Mutually exclusive with operations field. For Soroban gas abstraction: pass XDR containing InvokeHostFunction operation. | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Models/SponsoredTransactionBuildResponse.md b/docs/Models/SponsoredTransactionBuildResponse.md index 5431bc96..3d784f99 100644 --- a/docs/Models/SponsoredTransactionBuildResponse.md +++ b/docs/Models/SponsoredTransactionBuildResponse.md @@ -11,6 +11,9 @@ | **fee\_in\_stroops** | **String** | Fee amount in stroops (as string) | [default to null] | | **fee\_in\_token** | **String** | Fee amount in token (raw units as string) | [default to null] | | **fee\_in\_token\_ui** | **String** | Fee amount in token (decimal UI representation as string) | [default to null] | +| **max\_fee\_in\_token** | **String** | Maximum fee in token amount (raw units as string). Only present for Soroban gas abstraction - includes slippage buffer. | [optional] [default to null] | +| **max\_fee\_in\_token\_ui** | **String** | Maximum fee in token amount (decimal UI representation as string). Only present for Soroban gas abstraction - includes slippage buffer. | [optional] [default to null] | +| **user\_auth\_entry** | **String** | User authorization entry XDR (base64 encoded). Present for Soroban gas abstraction - user must sign this auth entry. | [optional] [default to null] | | **valid\_until** | **String** | Transaction validity timestamp (ISO 8601 format) | [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Models/SponsoredTransactionQuoteRequest.md b/docs/Models/SponsoredTransactionQuoteRequest.md index 2d56a36c..414841ff 100644 --- a/docs/Models/SponsoredTransactionQuoteRequest.md +++ b/docs/Models/SponsoredTransactionQuoteRequest.md @@ -3,11 +3,11 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| **fee\_token** | **String** | Asset identifier for fee token (e.g., \"native\" or \"USDC:GA5Z...\") | [default to null] | +| **fee\_token** | **String** | Asset identifier for fee token. For classic: \"native\" or \"USDC:GA5Z...\" format. For Soroban: contract address (C...) format. | [default to null] | | **transaction** | **String** | | [default to null] | | **operations** | [**List**](OperationSpec.md) | Operations array to build transaction from Mutually exclusive with transaction_xdr field | [optional] [default to null] | | **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] | -| **transaction\_xdr** | **String** | Pre-built transaction XDR (base64 encoded, signed or unsigned) Mutually exclusive with operations field | [optional] [default to null] | +| **transaction\_xdr** | **String** | Pre-built transaction XDR (base64 encoded, signed or unsigned) Mutually exclusive with operations field. For Soroban gas abstraction: pass XDR containing InvokeHostFunction operation. | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Models/SponsoredTransactionQuoteResponse.md b/docs/Models/SponsoredTransactionQuoteResponse.md index 0b10cc92..b33596ac 100644 --- a/docs/Models/SponsoredTransactionQuoteResponse.md +++ b/docs/Models/SponsoredTransactionQuoteResponse.md @@ -7,6 +7,8 @@ | **estimated\_fee** | **String** | | [default to null] | | **fee\_in\_token** | **String** | Estimated fee in token amount (raw units as string) | [default to null] | | **fee\_in\_token\_ui** | **String** | Estimated fee in token amount (decimal UI representation as string) | [default to null] | +| **max\_fee\_in\_token** | **String** | Maximum fee in token amount (raw units as string). Only present for Soroban gas abstraction - includes slippage buffer. | [optional] [default to null] | +| **max\_fee\_in\_token\_ui** | **String** | Maximum fee in token amount (decimal UI representation as string). Only present for Soroban gas abstraction - includes slippage buffer. | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Models/StellarFeeEstimateRequestParams.md b/docs/Models/StellarFeeEstimateRequestParams.md index 887080e0..f423e39e 100644 --- a/docs/Models/StellarFeeEstimateRequestParams.md +++ b/docs/Models/StellarFeeEstimateRequestParams.md @@ -3,10 +3,10 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| **fee\_token** | **String** | Asset identifier for fee token (e.g., \"native\" or \"USDC:GA5Z...\") | [default to null] | +| **fee\_token** | **String** | Asset identifier for fee token. For classic: \"native\" or \"USDC:GA5Z...\" format. For Soroban: contract address (C...) format. | [default to null] | | **operations** | [**List**](OperationSpec.md) | Operations array to build transaction from Mutually exclusive with transaction_xdr field | [optional] [default to null] | | **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] | -| **transaction\_xdr** | **String** | Pre-built transaction XDR (base64 encoded, signed or unsigned) Mutually exclusive with operations field | [optional] [default to null] | +| **transaction\_xdr** | **String** | Pre-built transaction XDR (base64 encoded, signed or unsigned) Mutually exclusive with operations field. For Soroban gas abstraction: pass XDR containing InvokeHostFunction operation. | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Models/StellarFeeEstimateResult.md b/docs/Models/StellarFeeEstimateResult.md index 9c4ed66a..73f1838a 100644 --- a/docs/Models/StellarFeeEstimateResult.md +++ b/docs/Models/StellarFeeEstimateResult.md @@ -6,6 +6,8 @@ | **conversion\_rate** | **String** | Conversion rate from XLM to token (as string) | [default to null] | | **fee\_in\_token** | **String** | Estimated fee in token amount (raw units as string) | [default to null] | | **fee\_in\_token\_ui** | **String** | Estimated fee in token amount (decimal UI representation as string) | [default to null] | +| **max\_fee\_in\_token** | **String** | Maximum fee in token amount (raw units as string). Only present for Soroban gas abstraction - includes slippage buffer. | [optional] [default to null] | +| **max\_fee\_in\_token\_ui** | **String** | Maximum fee in token amount (decimal UI representation as string). Only present for Soroban gas abstraction - includes slippage buffer. | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Models/StellarPrepareTransactionRequestParams.md b/docs/Models/StellarPrepareTransactionRequestParams.md index 98f925df..3c3d51d9 100644 --- a/docs/Models/StellarPrepareTransactionRequestParams.md +++ b/docs/Models/StellarPrepareTransactionRequestParams.md @@ -3,10 +3,10 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| **fee\_token** | **String** | Asset identifier for fee token | [default to null] | +| **fee\_token** | **String** | Asset identifier for fee token. For classic: \"native\" or \"USDC:GA5Z...\" format. For Soroban: contract address (C...) format. | [default to null] | | **operations** | [**List**](OperationSpec.md) | Operations array to build transaction from Mutually exclusive with transaction_xdr field | [optional] [default to null] | | **source\_account** | **String** | Source account address (required when operations are provided) For gasless transactions, this should be the user's account address | [optional] [default to null] | -| **transaction\_xdr** | **String** | Pre-built transaction XDR (base64 encoded, signed or unsigned) Mutually exclusive with operations field | [optional] [default to null] | +| **transaction\_xdr** | **String** | Pre-built transaction XDR (base64 encoded, signed or unsigned) Mutually exclusive with operations field. For Soroban gas abstraction: pass XDR containing InvokeHostFunction operation. | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Models/StellarPrepareTransactionResult.md b/docs/Models/StellarPrepareTransactionResult.md index 17959424..64128e15 100644 --- a/docs/Models/StellarPrepareTransactionResult.md +++ b/docs/Models/StellarPrepareTransactionResult.md @@ -7,7 +7,10 @@ | **fee\_in\_token** | **String** | Fee amount in token (raw units as string) | [default to null] | | **fee\_in\_token\_ui** | **String** | Fee amount in token (decimal UI representation as string) | [default to null] | | **fee\_token** | **String** | Asset identifier for fee token | [default to null] | +| **max\_fee\_in\_token** | **String** | Maximum fee in token amount (raw units as string). Only present for Soroban gas abstraction - includes slippage buffer. | [optional] [default to null] | +| **max\_fee\_in\_token\_ui** | **String** | Maximum fee in token amount (decimal UI representation as string). Only present for Soroban gas abstraction - includes slippage buffer. | [optional] [default to null] | | **transaction** | **String** | Extended transaction XDR (base64 encoded) | [default to null] | +| **user\_auth\_entry** | **String** | User authorization entry XDR (base64 encoded). Present for Soroban gas abstraction - user must sign this auth entry. | [optional] [default to null] | | **valid\_until** | **String** | Transaction validity timestamp (ISO 8601 format) | [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Models/StellarTransactionRequest.md b/docs/Models/StellarTransactionRequest.md index 7275af0d..d45cc365 100644 --- a/docs/Models/StellarTransactionRequest.md +++ b/docs/Models/StellarTransactionRequest.md @@ -8,8 +8,9 @@ | **memo** | [**MemoSpec**](MemoSpec.md) | | [optional] [default to null] | | **network** | **String** | | [default to null] | | **operations** | [**List**](OperationSpec.md) | | [optional] [default to null] | +| **signed\_auth\_entry** | **String** | Signed Soroban authorization entry (base64 encoded SorobanAuthorizationEntry XDR) Used for Soroban gas abstraction: contains the user's signed auth entry from /build response. When provided, transaction_xdr must also be provided (the FeeForwarder transaction from /build). The relayer will inject this signed auth entry into the transaction before submitting. | [optional] [default to null] | | **source\_account** | **String** | | [optional] [default to null] | -| **transaction\_xdr** | **String** | Pre-built transaction XDR (base64 encoded, signed or unsigned) Mutually exclusive with operations field | [optional] [default to null] | +| **transaction\_xdr** | **String** | Pre-built transaction XDR (base64 encoded, signed or unsigned) Mutually exclusive with operations field. For Soroban gas abstraction: submit the transaction XDR from sponsored/build response with the user's signed auth entry updated inside. | [optional] [default to null] | | **valid\_until** | **String** | | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Models/StellarTransactionResponse.md b/docs/Models/StellarTransactionResponse.md index 07c244b8..d5bae237 100644 --- a/docs/Models/StellarTransactionResponse.md +++ b/docs/Models/StellarTransactionResponse.md @@ -14,6 +14,7 @@ | **source\_account** | **String** | | [default to null] | | **status** | [**TransactionStatus**](TransactionStatus.md) | | [default to null] | | **status\_reason** | **String** | | [optional] [default to null] | +| **transaction\_result\_xdr** | **String** | | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Models/SystemHealth.md b/docs/Models/SystemHealth.md new file mode 100644 index 00000000..3385221c --- /dev/null +++ b/docs/Models/SystemHealth.md @@ -0,0 +1,14 @@ +# SystemHealth +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **close\_wait\_count** | **Integer** | | [default to null] | +| **error** | **String** | | [optional] [default to null] | +| **fd\_count** | **Integer** | | [default to null] | +| **fd\_limit** | **Integer** | | [default to null] | +| **fd\_usage\_percent** | **Integer** | | [default to null] | +| **status** | [**ComponentStatus**](ComponentStatus.md) | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Models/TransactionResponse.md b/docs/Models/TransactionResponse.md index 9088f4fd..f4f8c1ef 100644 --- a/docs/Models/TransactionResponse.md +++ b/docs/Models/TransactionResponse.md @@ -27,6 +27,7 @@ | **fee** | **Integer** | | [default to null] | | **sequence\_number** | **Long** | | [default to null] | | **source\_account** | **String** | | [default to null] | +| **transaction\_result\_xdr** | **String** | | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Models/UpdateNetworkRequest.md b/docs/Models/UpdateNetworkRequest.md new file mode 100644 index 00000000..f7680b97 --- /dev/null +++ b/docs/Models/UpdateNetworkRequest.md @@ -0,0 +1,9 @@ +# UpdateNetworkRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **rpc\_urls** | [**List**](RpcUrlEntry.md) | List of RPC endpoint configurations for connecting to the network. Supports multiple formats: - Array of strings: `[\"https://rpc.example.com\"]` (defaults to weight 100) - Array of RpcConfig objects: `[{\"url\": \"https://rpc.example.com\", \"weight\": 100}]` - Mixed array: `[\"https://rpc1.com\", {\"url\": \"https://rpc2.com\", \"weight\": 100}]` Must be non-empty and contain valid HTTP/HTTPS URLs if provided. | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Models/UpdatePluginRequest.md b/docs/Models/UpdatePluginRequest.md new file mode 100644 index 00000000..36f30325 --- /dev/null +++ b/docs/Models/UpdatePluginRequest.md @@ -0,0 +1,15 @@ +# UpdatePluginRequest +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **allow\_get\_invocation** | **Boolean** | Whether to allow GET requests to invoke plugin logic | [optional] [default to null] | +| **config** | [**Map**](AnyType.md) | User-defined configuration accessible to the plugin (must be a JSON object) Use `null` to clear the config | [optional] [default to null] | +| **emit\_logs** | **Boolean** | Whether to include logs in the HTTP response | [optional] [default to null] | +| **emit\_traces** | **Boolean** | Whether to include traces in the HTTP response | [optional] [default to null] | +| **forward\_logs** | **Boolean** | Whether to forward plugin logs into the relayer's tracing output | [optional] [default to null] | +| **raw\_response** | **Boolean** | Whether to return raw plugin response without ApiResponse wrapper | [optional] [default to null] | +| **timeout** | **Long** | Plugin timeout in seconds | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/README.md b/docs/README.md index 0bd2e778..d4b3e2cf 100644 --- a/docs/README.md +++ b/docs/README.md @@ -7,16 +7,24 @@ All URIs are relative to *http://localhost* | Class | Method | HTTP request | Description | |------------ | ------------- | ------------- | -------------| -| *HealthApi* | [**health**](Apis/HealthApi.md#health) | **GET** /v1/health | Health routes implementation | +| *HealthApi* | [**health**](Apis/HealthApi.md#health) | **GET** /api/v1/health | Health routes implementation | +*HealthApi* | [**readiness**](Apis/HealthApi.md#readiness) | **GET** /api/v1/ready | Readiness endpoint that checks system resources, Redis, Queue, and plugins. | | *MetricsApi* | [**listMetrics**](Apis/MetricsApi.md#listmetrics) | **GET** /metrics | Metrics routes implementation | *MetricsApi* | [**metricDetail**](Apis/MetricsApi.md#metricdetail) | **GET** /metrics/{metric_name} | Returns the details of a specific metric in plain text format. | *MetricsApi* | [**scrapeMetrics**](Apis/MetricsApi.md#scrapemetrics) | **GET** /debug/metrics/scrape | Triggers an update of system metrics and returns the result in plain text format. | +| *NetworksApi* | [**getNetwork**](Apis/NetworksApi.md#getnetwork) | **GET** /api/v1/networks/{network_id} | Retrieves details of a specific network by ID. | +*NetworksApi* | [**listNetworks**](Apis/NetworksApi.md#listnetworks) | **GET** /api/v1/networks | Network routes implementation | +*NetworksApi* | [**updateNetwork**](Apis/NetworksApi.md#updatenetwork) | **PATCH** /api/v1/networks/{network_id} | Updates a network's configuration. Currently supports updating RPC URLs only. Can be extended to support other fields. | | *NotificationsApi* | [**createNotification**](Apis/NotificationsApi.md#createnotification) | **POST** /api/v1/notifications | Creates a new notification. | *NotificationsApi* | [**deleteNotification**](Apis/NotificationsApi.md#deletenotification) | **DELETE** /api/v1/notifications/{notification_id} | Deletes a notification by ID. | *NotificationsApi* | [**getNotification**](Apis/NotificationsApi.md#getnotification) | **GET** /api/v1/notifications/{notification_id} | Retrieves details of a specific notification by ID. | *NotificationsApi* | [**listNotifications**](Apis/NotificationsApi.md#listnotifications) | **GET** /api/v1/notifications | Notification routes implementation | *NotificationsApi* | [**updateNotification**](Apis/NotificationsApi.md#updatenotification) | **PATCH** /api/v1/notifications/{notification_id} | Updates an existing notification. | -| *PluginsApi* | [**callPlugin**](Apis/PluginsApi.md#callplugin) | **POST** /api/v1/plugins/{plugin_id}/call | Execute a plugin and receive the sanitized result | +| *PluginsApi* | [**callPlugin**](Apis/PluginsApi.md#callplugin) | **POST** /api/v1/plugins/{plugin_id}/call | Execute a plugin with optional wildcard route routing | +*PluginsApi* | [**callPluginGet**](Apis/PluginsApi.md#callpluginget) | **GET** /api/v1/plugins/{plugin_id}/call | Execute a plugin via GET (must be enabled per plugin) | +*PluginsApi* | [**getPlugin**](Apis/PluginsApi.md#getplugin) | **GET** /api/v1/plugins/{plugin_id} | Get plugin by ID | +*PluginsApi* | [**listPlugins**](Apis/PluginsApi.md#listplugins) | **GET** /api/v1/plugins | List plugins. | +*PluginsApi* | [**updatePlugin**](Apis/PluginsApi.md#updateplugin) | **PATCH** /api/v1/plugins/{plugin_id} | Update plugin configuration | | *RelayersApi* | [**buildSponsoredTransaction**](Apis/RelayersApi.md#buildsponsoredtransaction) | **POST** /api/v1/relayers/{relayer_id}/transactions/sponsored/build | Prepares a sponsored (gasless) transaction with fee payments. | *RelayersApi* | [**cancelTransaction**](Apis/RelayersApi.md#canceltransaction) | **DELETE** /api/v1/relayers/{relayer_id}/transactions/{transaction_id} | Cancels a specific transaction by its ID. | *RelayersApi* | [**createRelayer**](Apis/RelayersApi.md#createrelayer) | **POST** /api/v1/relayers | Creates a new relayer. | @@ -51,10 +59,16 @@ All URIs are relative to *http://localhost* - [ApiResponse_BalanceResponse_data](./Models/ApiResponse_BalanceResponse_data.md) - [ApiResponse_DeletePendingTransactionsResponse](./Models/ApiResponse_DeletePendingTransactionsResponse.md) - [ApiResponse_DeletePendingTransactionsResponse_data](./Models/ApiResponse_DeletePendingTransactionsResponse_data.md) + - [ApiResponse_NetworkResponse](./Models/ApiResponse_NetworkResponse.md) + - [ApiResponse_NetworkResponse_data](./Models/ApiResponse_NetworkResponse_data.md) - [ApiResponse_NotificationResponse](./Models/ApiResponse_NotificationResponse.md) - [ApiResponse_NotificationResponse_data](./Models/ApiResponse_NotificationResponse_data.md) + - [ApiResponse_PaginatedResult_PluginModel](./Models/ApiResponse_PaginatedResult_PluginModel.md) + - [ApiResponse_PaginatedResult_PluginModel_data](./Models/ApiResponse_PaginatedResult_PluginModel_data.md) + - [ApiResponse_PaginatedResult_PluginModel_data_items_inner](./Models/ApiResponse_PaginatedResult_PluginModel_data_items_inner.md) - [ApiResponse_PluginHandlerError](./Models/ApiResponse_PluginHandlerError.md) - [ApiResponse_PluginHandlerError_data](./Models/ApiResponse_PluginHandlerError_data.md) + - [ApiResponse_PluginModel](./Models/ApiResponse_PluginModel.md) - [ApiResponse_RelayerResponse](./Models/ApiResponse_RelayerResponse.md) - [ApiResponse_RelayerResponse_data](./Models/ApiResponse_RelayerResponse_data.md) - [ApiResponse_RelayerStatus](./Models/ApiResponse_RelayerStatus.md) @@ -76,6 +90,7 @@ All URIs are relative to *http://localhost* - [ApiResponse_TransactionResponse](./Models/ApiResponse_TransactionResponse.md) - [ApiResponse_TransactionResponse_data](./Models/ApiResponse_TransactionResponse_data.md) - [ApiResponse_Value](./Models/ApiResponse_Value.md) + - [ApiResponse_Vec_NetworkResponse](./Models/ApiResponse_Vec_NetworkResponse.md) - [ApiResponse_Vec_NotificationResponse](./Models/ApiResponse_Vec_NotificationResponse.md) - [ApiResponse_Vec_RelayerResponse](./Models/ApiResponse_Vec_RelayerResponse.md) - [ApiResponse_Vec_SignerResponse](./Models/ApiResponse_Vec_SignerResponse.md) @@ -92,6 +107,8 @@ All URIs are relative to *http://localhost* - [AwsKmsSignerRequestConfig](./Models/AwsKmsSignerRequestConfig.md) - [BalanceResponse](./Models/BalanceResponse.md) - [CdpSignerRequestConfig](./Models/CdpSignerRequestConfig.md) + - [ComponentStatus](./Models/ComponentStatus.md) + - [Components](./Models/Components.md) - [ContractSource](./Models/ContractSource.md) - [ContractSource_oneOf](./Models/ContractSource_oneOf.md) - [ContractSource_oneOf_1](./Models/ContractSource_oneOf_1.md) @@ -128,6 +145,7 @@ All URIs are relative to *http://localhost* - [LocalSignerRequestConfig](./Models/LocalSignerRequestConfig.md) - [LogEntry](./Models/LogEntry.md) - [LogLevel](./Models/LogLevel.md) + - [MaskedRpcConfig](./Models/MaskedRpcConfig.md) - [MemoSpec](./Models/MemoSpec.md) - [MemoSpec_oneOf](./Models/MemoSpec_oneOf.md) - [MemoSpec_oneOf_1](./Models/MemoSpec_oneOf_1.md) @@ -135,6 +153,7 @@ All URIs are relative to *http://localhost* - [MemoSpec_oneOf_3](./Models/MemoSpec_oneOf_3.md) - [MemoSpec_oneOf_4](./Models/MemoSpec_oneOf_4.md) - [NetworkPolicyResponse](./Models/NetworkPolicyResponse.md) + - [NetworkResponse](./Models/NetworkResponse.md) - [NetworkRpcRequest](./Models/NetworkRpcRequest.md) - [NetworkRpcResult](./Models/NetworkRpcResult.md) - [NetworkTransactionRequest](./Models/NetworkTransactionRequest.md) @@ -150,7 +169,13 @@ All URIs are relative to *http://localhost* - [PaginationMeta](./Models/PaginationMeta.md) - [PluginCallRequest](./Models/PluginCallRequest.md) - [PluginHandlerError](./Models/PluginHandlerError.md) + - [PluginHealth](./Models/PluginHealth.md) - [PluginMetadata](./Models/PluginMetadata.md) + - [PluginModel](./Models/PluginModel.md) + - [PoolStatus](./Models/PoolStatus.md) + - [QueueHealth](./Models/QueueHealth.md) + - [ReadinessResponse](./Models/ReadinessResponse.md) + - [RedisHealth](./Models/RedisHealth.md) - [RelayerEvmPolicy](./Models/RelayerEvmPolicy.md) - [RelayerNetworkPolicy](./Models/RelayerNetworkPolicy.md) - [RelayerNetworkPolicyResponse](./Models/RelayerNetworkPolicyResponse.md) @@ -165,6 +190,7 @@ All URIs are relative to *http://localhost* - [RelayerStellarPolicy](./Models/RelayerStellarPolicy.md) - [RelayerStellarSwapConfig](./Models/RelayerStellarSwapConfig.md) - [RpcConfig](./Models/RpcConfig.md) + - [RpcUrlEntry](./Models/RpcUrlEntry.md) - [SignAndSendTransactionRequestParams](./Models/SignAndSendTransactionRequestParams.md) - [SignAndSendTransactionResult](./Models/SignAndSendTransactionResult.md) - [SignDataRequest](./Models/SignDataRequest.md) @@ -249,11 +275,14 @@ All URIs are relative to *http://localhost* - [StellarTokenMetadata](./Models/StellarTokenMetadata.md) - [StellarTransactionRequest](./Models/StellarTransactionRequest.md) - [StellarTransactionResponse](./Models/StellarTransactionResponse.md) + - [SystemHealth](./Models/SystemHealth.md) - [TransactionResponse](./Models/TransactionResponse.md) - [TransactionStatus](./Models/TransactionStatus.md) - [TransferTransactionRequestParams](./Models/TransferTransactionRequestParams.md) - [TransferTransactionResult](./Models/TransferTransactionResult.md) - [TurnkeySignerRequestConfig](./Models/TurnkeySignerRequestConfig.md) + - [UpdateNetworkRequest](./Models/UpdateNetworkRequest.md) + - [UpdatePluginRequest](./Models/UpdatePluginRequest.md) - [UpdateRelayerRequest](./Models/UpdateRelayerRequest.md) - [VaultSignerRequestConfig](./Models/VaultSignerRequestConfig.md) - [VaultTransitSignerRequestConfig](./Models/VaultTransitSignerRequestConfig.md) diff --git a/examples/networks/getNetworkById.ts b/examples/networks/getNetworkById.ts new file mode 100644 index 00000000..04c124c0 --- /dev/null +++ b/examples/networks/getNetworkById.ts @@ -0,0 +1,31 @@ +/** + * Get Network By Id Example + * + * This example demonstrates how to use the OpenZeppelin Relayer SDK to get a network by id. + * * + * IMPORTANT: This is provided as a demonstration only. For production use: + * - Use proper error handling and transaction confirmation checks + * - Implement appropriate security measures for API keys and tokens + * - Consider rate limiting and monitoring for production applications + * - Test thoroughly on devnet/testnet before using on mainnet + * - Use https connection for production applications + * + * Usage: + * ts-node getNetworkById.ts + */ +import { Configuration, NetworksApi } from '../../src'; + +// example dev config +const config = new Configuration({ + basePath: 'http://localhost:8080', + accessToken: '', // replace with your actual api key +}); + +const networksApi = new NetworksApi(config); + +const networkId = 'evm:sepolia'; + +networksApi + .getNetwork(networkId) + .then((networks) => console.log(JSON.stringify(networks.data, null, 2))) + .catch(console.error); diff --git a/examples/networks/listNetworks.ts b/examples/networks/listNetworks.ts new file mode 100644 index 00000000..b895f22d --- /dev/null +++ b/examples/networks/listNetworks.ts @@ -0,0 +1,29 @@ +/** + * List Networks Example + * + * This example demonstrates how to use the OpenZeppelin Relayer SDK to list networks. + * * + * IMPORTANT: This is provided as a demonstration only. For production use: + * - Use proper error handling and transaction confirmation checks + * - Implement appropriate security measures for API keys and tokens + * - Consider rate limiting and monitoring for production applications + * - Test thoroughly on devnet/testnet before using on mainnet + * - Use https connection for production applications + * + * Usage: + * ts-node listNetworks.ts + */ +import { Configuration, NetworksApi } from '../../src'; + +// example dev config +const config = new Configuration({ + basePath: 'http://localhost:8080', + accessToken: '', // replace with your actual api key +}); + +const networksApi = new NetworksApi(config); + +networksApi + .listNetworks() + .then((networks) => console.log(JSON.stringify(networks.data, null, 2))) + .catch(console.error); diff --git a/examples/networks/updateNetwork.ts b/examples/networks/updateNetwork.ts new file mode 100644 index 00000000..f0c41d60 --- /dev/null +++ b/examples/networks/updateNetwork.ts @@ -0,0 +1,38 @@ +/** + * Update Network Example + * + * This example demonstrates how to use the OpenZeppelin Relayer SDK to update a network. + * * + * IMPORTANT: This is provided as a demonstration only. For production use: + * - Use proper error handling and transaction confirmation checks + * - Implement appropriate security measures for API keys and tokens + * - Consider rate limiting and monitoring for production applications + * - Test thoroughly on devnet/testnet before using on mainnet + * - Use https connection for production applications + * + * Usage: + * ts-node updateNetwork.ts + */ +import { Configuration, NetworksApi } from '../../src'; + +// example dev config +const config = new Configuration({ + basePath: 'http://localhost:8080', + accessToken: '', // replace with your actual api key +}); + +const networksApi = new NetworksApi(config); + +const networkId = 'evm:sepolia'; + +networksApi + .updateNetwork(networkId, { + rpc_urls: [ + { + url: 'https://rpc.sepolia.org', + weight: 100, + }, + ], + }) + .then((network) => console.log(JSON.stringify(network.data, null, 2))) + .catch(console.error); diff --git a/openapi.json b/openapi.json index 8bd4d47a..8f3a034c 100644 --- a/openapi.json +++ b/openapi.json @@ -12,17 +12,50 @@ "name": "AGPL-3.0 license", "url": "https://github.com/OpenZeppelin/openzeppelin-relayer/blob/main/LICENSE" }, - "version": "1.2.0" + "version": "1.3.0" }, "paths": { - "/api/v1/notifications": { + "/api/v1/health": { "get": { "tags": [ - "Notifications" + "Health" ], - "summary": "Notification routes implementation", - "description": "Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file\n\nLists all notifications with pagination support.", - "operationId": "listNotifications", + "summary": "Health routes implementation", + "description": "Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file\n\nHandles the `/health` endpoint.\n\nReturns an `HttpResponse` with a status of `200 OK` and a body of `\"OK\"`.\nThis endpoint is used for liveness probes in container orchestration platforms.", + "operationId": "health", + "responses": { + "200": { + "description": "Service is alive", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "OK" + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "text/plain": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/v1/networks": { + "get": { + "tags": [ + "Networks" + ], + "summary": "Network routes implementation", + "description": "Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file\n\nLists all networks with pagination support.", + "operationId": "listNetworks", "parameters": [ { "name": "page", @@ -47,11 +80,11 @@ ], "responses": { "200": { - "description": "Notification list retrieved successfully", + "description": "Network list retrieved successfully", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ApiResponse_Vec_NotificationResponse" + "$ref": "#/components/schemas/ApiResponse_Vec_NetworkResponse" } } } @@ -107,36 +140,144 @@ "bearer_auth": [] } ] + } + }, + "/api/v1/networks/{network_id}": { + "get": { + "tags": [ + "Networks" + ], + "summary": "Retrieves details of a specific network by ID.", + "operationId": "getNetwork", + "parameters": [ + { + "name": "network_id", + "in": "path", + "description": "Network ID (e.g., evm:sepolia, solana:mainnet)", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Network retrieved successfully", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_NetworkResponse" + } + } + } + }, + "400": { + "description": "Bad Request - invalid network type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "message": "Bad Request", + "success": false + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "message": "Unauthorized", + "success": false + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "message": "Network with ID 'evm:sepolia' not found", + "success": false + } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "message": "Internal Server Error", + "success": false + } + } + } + } + }, + "security": [ + { + "bearer_auth": [] + } + ] }, - "post": { + "patch": { "tags": [ - "Notifications" + "Networks" + ], + "summary": "Updates a network's configuration.\nCurrently supports updating RPC URLs only. Can be extended to support other fields.", + "operationId": "updateNetwork", + "parameters": [ + { + "name": "network_id", + "in": "path", + "description": "Network ID (e.g., evm:sepolia, solana:mainnet)", + "required": true, + "schema": { + "type": "string" + } + } ], - "summary": "Creates a new notification.", - "operationId": "createNotification", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NotificationCreateRequest" + "$ref": "#/components/schemas/UpdateNetworkRequest" } } }, "required": true }, "responses": { - "201": { - "description": "Notification created successfully", + "200": { + "description": "Network updated successfully", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ApiResponse_NotificationResponse" + "$ref": "#/components/schemas/ApiResponse_NetworkResponse" } } } }, "400": { - "description": "Bad Request", + "description": "Bad Request - invalid network type or request data", "content": { "application/json": { "schema": { @@ -165,8 +306,8 @@ } } }, - "409": { - "description": "Notification with this ID already exists", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -174,7 +315,7 @@ }, "example": { "data": null, - "message": "Notification with this ID already exists", + "message": "Network with ID 'evm:sepolia' not found", "success": false } } @@ -203,18 +344,631 @@ ] } }, - "/api/v1/notifications/{notification_id}": { + "/api/v1/notifications": { + "get": { + "tags": [ + "Notifications" + ], + "summary": "Notification routes implementation", + "description": "Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file\n\nLists all notifications with pagination support.", + "operationId": "listNotifications", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "Page number for pagination (starts at 1)", + "required": false, + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "per_page", + "in": "query", + "description": "Number of items per page (default: 10)", + "required": false, + "schema": { + "type": "integer", + "minimum": 0 + } + } + ], + "responses": { + "200": { + "description": "Notification list retrieved successfully", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_Vec_NotificationResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "message": "Bad Request", + "success": false + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "message": "Unauthorized", + "success": false + } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "message": "Internal Server Error", + "success": false + } + } + } + } + }, + "security": [ + { + "bearer_auth": [] + } + ] + }, + "post": { + "tags": [ + "Notifications" + ], + "summary": "Creates a new notification.", + "operationId": "createNotification", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationCreateRequest" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Notification created successfully", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_NotificationResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "message": "Bad Request", + "success": false + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "message": "Unauthorized", + "success": false + } + } + } + }, + "409": { + "description": "Notification with this ID already exists", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "message": "Notification with this ID already exists", + "success": false + } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "message": "Internal Server Error", + "success": false + } + } + } + } + }, + "security": [ + { + "bearer_auth": [] + } + ] + } + }, + "/api/v1/notifications/{notification_id}": { + "get": { + "tags": [ + "Notifications" + ], + "summary": "Retrieves details of a specific notification by ID.", + "operationId": "getNotification", + "parameters": [ + { + "name": "notification_id", + "in": "path", + "description": "Notification ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Notification retrieved successfully", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_NotificationResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "message": "Bad Request", + "success": false + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "message": "Unauthorized", + "success": false + } + } + } + }, + "404": { + "description": "Notification not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "message": "Notification not found", + "success": false + } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "message": "Internal Server Error", + "success": false + } + } + } + } + }, + "security": [ + { + "bearer_auth": [] + } + ] + }, + "delete": { + "tags": [ + "Notifications" + ], + "summary": "Deletes a notification by ID.", + "operationId": "deleteNotification", + "parameters": [ + { + "name": "notification_id", + "in": "path", + "description": "Notification ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Notification deleted successfully", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": "Notification deleted successfully", + "message": "Notification deleted successfully", + "success": true + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "message": "Bad Request", + "success": false + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "message": "Unauthorized", + "success": false + } + } + } + }, + "404": { + "description": "Notification not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "message": "Notification not found", + "success": false + } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "message": "Internal Server Error", + "success": false + } + } + } + } + }, + "security": [ + { + "bearer_auth": [] + } + ] + }, + "patch": { + "tags": [ + "Notifications" + ], + "summary": "Updates an existing notification.", + "operationId": "updateNotification", + "parameters": [ + { + "name": "notification_id", + "in": "path", + "description": "Notification ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationUpdateRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Notification updated successfully", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_NotificationResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "message": "Bad Request", + "success": false + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "message": "Unauthorized", + "success": false + } + } + } + }, + "404": { + "description": "Notification not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "message": "Notification not found", + "success": false + } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "message": "Internal Server Error", + "success": false + } + } + } + } + }, + "security": [ + { + "bearer_auth": [] + } + ] + } + }, + "/api/v1/plugins": { + "get": { + "tags": [ + "Plugins" + ], + "summary": "List plugins.", + "operationId": "listPlugins", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "Page number for pagination (starts at 1)", + "required": false, + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "per_page", + "in": "query", + "description": "Number of items per page (default: 10)", + "required": false, + "schema": { + "type": "integer", + "minimum": 0 + } + } + ], + "responses": { + "200": { + "description": "Plugins listed successfully", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_PaginatedResult_PluginModel" + } + } + } + }, + "400": { + "description": "BadRequest", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "error": "Bad Request", + "success": false + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "error": "Unauthorized", + "success": false + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "error": "Plugin with ID plugin_id not found", + "success": false + } + } + } + }, + "429": { + "description": "Too Many Requests", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "error": "Too Many Requests", + "success": false + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "error": "Internal Server Error", + "success": false + } + } + } + } + }, + "security": [ + { + "bearer_auth": [] + } + ] + } + }, + "/api/v1/plugins/{plugin_id}": { "get": { "tags": [ - "Notifications" + "Plugins" ], - "summary": "Retrieves details of a specific notification by ID.", - "operationId": "getNotification", + "summary": "Get plugin by ID", + "operationId": "getPlugin", "parameters": [ { - "name": "notification_id", + "name": "plugin_id", "in": "path", - "description": "Notification ID", + "description": "The unique identifier of the plugin", "required": true, "schema": { "type": "string" @@ -223,17 +977,34 @@ ], "responses": { "200": { - "description": "Notification retrieved successfully", + "description": "Plugin retrieved successfully", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ApiResponse_NotificationResponse" + "$ref": "#/components/schemas/ApiResponse_PluginModel" + }, + "example": { + "data": { + "allow_get_invocation": false, + "config": { + "featureFlag": true + }, + "emit_logs": false, + "emit_traces": false, + "forward_logs": false, + "id": "my-plugin", + "path": "plugins/my-plugin.ts", + "raw_response": false, + "timeout": 30 + }, + "error": null, + "success": true } } } }, - "400": { - "description": "Bad Request", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -241,14 +1012,14 @@ }, "example": { "data": null, - "message": "Bad Request", + "error": "Unauthorized", "success": false } } } }, - "401": { - "description": "Unauthorized", + "404": { + "description": "Plugin not found", "content": { "application/json": { "schema": { @@ -256,14 +1027,14 @@ }, "example": { "data": null, - "message": "Unauthorized", + "error": "Plugin with id my-plugin not found", "success": false } } } }, - "404": { - "description": "Notification not found", + "429": { + "description": "Too Many Requests", "content": { "application/json": { "schema": { @@ -271,14 +1042,14 @@ }, "example": { "data": null, - "message": "Notification not found", + "error": "Too Many Requests", "success": false } } } }, "500": { - "description": "Internal Server Error", + "description": "Internal server error", "content": { "application/json": { "schema": { @@ -286,7 +1057,7 @@ }, "example": { "data": null, - "message": "Internal Server Error", + "error": "Internal Server Error", "success": false } } @@ -299,41 +1070,75 @@ } ] }, - "delete": { + "patch": { "tags": [ - "Notifications" + "Plugins" ], - "summary": "Deletes a notification by ID.", - "operationId": "deleteNotification", + "summary": "Update plugin configuration", + "description": "Updates mutable plugin fields such as timeout, emit_logs, emit_traces,\nraw_response, allow_get_invocation, config, and forward_logs.\nThe plugin id and path cannot be changed after creation.\n\nAll fields are optional - only the provided fields will be updated.\nTo clear the `config` field, pass `\"config\": null`.", + "operationId": "updatePlugin", "parameters": [ { - "name": "notification_id", + "name": "plugin_id", "in": "path", - "description": "Notification ID", + "description": "The unique identifier of the plugin", "required": true, "schema": { "type": "string" } } ], + "requestBody": { + "description": "Plugin configuration update. All fields are optional.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdatePluginRequest" + }, + "example": { + "config": { + "apiKey": "xyz123", + "featureFlag": true + }, + "emit_logs": true, + "forward_logs": true, + "timeout": 60 + } + } + }, + "required": true + }, "responses": { "200": { - "description": "Notification deleted successfully", + "description": "Plugin updated successfully", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ApiResponse_String" + "$ref": "#/components/schemas/ApiResponse_PluginModel" }, "example": { - "data": "Notification deleted successfully", - "message": "Notification deleted successfully", + "data": { + "allow_get_invocation": false, + "config": { + "apiKey": "xyz123", + "featureFlag": true + }, + "emit_logs": true, + "emit_traces": false, + "forward_logs": true, + "id": "my-plugin", + "path": "plugins/my-plugin.ts", + "raw_response": false, + "timeout": 60 + }, + "error": null, "success": true } } } }, "400": { - "description": "Bad Request", + "description": "Bad Request (invalid timeout or other validation error)", "content": { "application/json": { "schema": { @@ -341,7 +1146,7 @@ }, "example": { "data": null, - "message": "Bad Request", + "error": "Timeout must be greater than 0", "success": false } } @@ -356,14 +1161,14 @@ }, "example": { "data": null, - "message": "Unauthorized", + "error": "Unauthorized", "success": false } } } }, "404": { - "description": "Notification not found", + "description": "Plugin not found", "content": { "application/json": { "schema": { @@ -371,14 +1176,29 @@ }, "example": { "data": null, - "message": "Notification not found", + "error": "Plugin with id my-plugin not found", + "success": false + } + } + } + }, + "429": { + "description": "Too Many Requests", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "error": "Too Many Requests", "success": false } } } }, "500": { - "description": "Internal Server Error", + "description": "Internal server error", "content": { "application/json": { "schema": { @@ -386,7 +1206,7 @@ }, "example": { "data": null, - "message": "Internal Server Error", + "error": "Internal Server Error", "success": false } } @@ -398,47 +1218,64 @@ "bearer_auth": [] } ] - }, - "patch": { + } + }, + "/api/v1/plugins/{plugin_id}/call": { + "get": { "tags": [ - "Notifications" + "Plugins" ], - "summary": "Updates an existing notification.", - "operationId": "updateNotification", + "summary": "Execute a plugin via GET (must be enabled per plugin)", + "description": "This endpoint is disabled by default. To enable it for a given plugin, set\n`allow_get_invocation: true` in the plugin configuration.\n\nWhen invoked via GET:\n- `params` is an empty object (`{}`)\n- query parameters are passed to the plugin handler via `context.query`\n- wildcard route routing is supported the same way as POST (see `doc_call_plugin`)\n- Use the `route` query parameter or append the route to the URL path", + "operationId": "callPluginGet", "parameters": [ { - "name": "notification_id", + "name": "plugin_id", "in": "path", - "description": "Notification ID", + "description": "The unique identifier of the plugin", "required": true, "schema": { "type": "string" } + }, + { + "name": "route", + "in": "query", + "description": "Optional route suffix for custom routing (e.g., '/verify'). Alternative to appending the route to the URL path.", + "required": false, + "schema": { + "type": "string" + } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotificationUpdateRequest" + "responses": { + "200": { + "description": "Plugin call successful", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse_Value" + } } } }, - "required": true - }, - "responses": { - "200": { - "description": "Notification updated successfully", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ApiResponse_NotificationResponse" + "$ref": "#/components/schemas/ApiResponse_String" + }, + "example": { + "data": null, + "error": "Unauthorized", + "success": false } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -446,14 +1283,14 @@ }, "example": { "data": null, - "message": "Bad Request", + "error": "Plugin with ID plugin_id not found", "success": false } } } }, - "401": { - "description": "Unauthorized", + "405": { + "description": "Method Not Allowed (GET invocation disabled for this plugin)", "content": { "application/json": { "schema": { @@ -461,14 +1298,14 @@ }, "example": { "data": null, - "message": "Unauthorized", + "error": "GET requests are not enabled for this plugin. Set 'allow_get_invocation: true' in plugin configuration to enable.", "success": false } } } }, - "404": { - "description": "Notification not found", + "429": { + "description": "Too Many Requests", "content": { "application/json": { "schema": { @@ -476,14 +1313,14 @@ }, "example": { "data": null, - "message": "Notification not found", + "error": "Too Many Requests", "success": false } } } }, "500": { - "description": "Internal Server Error", + "description": "Internal server error", "content": { "application/json": { "schema": { @@ -491,7 +1328,7 @@ }, "example": { "data": null, - "message": "Internal Server Error", + "error": "Internal Server Error", "success": false } } @@ -503,15 +1340,13 @@ "bearer_auth": [] } ] - } - }, - "/api/v1/plugins/{plugin_id}/call": { + }, "post": { "tags": [ "Plugins" ], - "summary": "Execute a plugin and receive the sanitized result", - "description": "Logs and traces are only returned when the plugin is configured with `emit_logs` / `emit_traces`.\nPlugin-provided errors are normalized into a consistent payload (`code`, `details`) and a derived\nmessage so downstream clients receive a stable shape regardless of how the handler threw.", + "summary": "Execute a plugin with optional wildcard route routing", + "description": "Logs and traces are only returned when the plugin is configured with `emit_logs` / `emit_traces`.\nPlugin-provided errors are normalized into a consistent payload (`code`, `details`) and a derived\nmessage so downstream clients receive a stable shape regardless of how the handler threw.\n\nThe endpoint supports wildcard route routing, allowing plugins to implement custom routing logic:\n- `/api/v1/plugins/{plugin_id}/call` - Default endpoint (route = \"\")\n- `/api/v1/plugins/{plugin_id}/call?route=/verify` - Custom route via query parameter\n- `/api/v1/plugins/{plugin_id}/call/verify` - Custom route via URL path (route = \"/verify\")\n\nThe route is passed to the plugin handler via the `context.route` field.\nYou can specify a custom route either by appending it to the URL path or by using the `route` query parameter.", "operationId": "callPlugin", "parameters": [ { @@ -522,6 +1357,15 @@ "schema": { "type": "string" } + }, + { + "name": "route", + "in": "query", + "description": "Optional route suffix for custom routing (e.g., '/verify'). Alternative to appending the route to the URL path.", + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -661,6 +1505,139 @@ ] } }, + "/api/v1/ready": { + "get": { + "tags": [ + "Health" + ], + "summary": "Readiness endpoint that checks system resources, Redis, Queue, and plugins.", + "description": "Returns 200 OK if the service is ready to accept traffic, or 503 Service Unavailable if not.\nThis endpoint is used for readiness probes in container orchestration platforms like\nAWS ECS or Kubernetes.\n\n## Health Check Components\n\n- **System**: File descriptor usage, CLOSE_WAIT socket count\n- **Redis**: Primary and reader pool connectivity\n- **Queue**: Queue's Redis connections (separate from app's Redis)\n- **Plugins**: Plugin pool health, circuit breaker state, and connection metrics (if enabled)\n\n## Status Levels\n\n- `healthy`: All components operational\n- `degraded`: Some components degraded but service can function (e.g., reader pool down)\n- `unhealthy`: Critical components failed, service unavailable\n\n## Plugin Connection Metrics\n\nWhen plugins are enabled, the following connection metrics are exposed:\n\n- `shared_socket_available_slots`: Number of additional concurrent plugin executions that can start\n- `shared_socket_active_connections`: Current number of active plugin execution connections\n- `shared_socket_registered_executions`: Number of plugin executions currently registered (awaiting response)\n- `connection_pool_available_slots`: Available connections to the pool server\n- `connection_pool_active_connections`: Active connections to the pool server\n\nThese metrics help diagnose connection pool exhaustion and plugin capacity issues.\n\n## Caching\n\nHealth check results are cached for 10 seconds to prevent excessive load from frequent\nhealth checks. Multiple requests within the TTL return the same cached response.", + "operationId": "readiness", + "responses": { + "200": { + "description": "Service is ready (healthy or degraded)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReadinessResponse" + }, + "example": { + "components": { + "plugins": { + "avg_response_time_ms": 120, + "circuit_state": "closed", + "connection_pool_active_connections": 2, + "connection_pool_available_slots": 8, + "enabled": true, + "memory": 52428800, + "pool_completed": 1000, + "pool_queued": 2, + "recovering": false, + "shared_socket_active_connections": 2, + "shared_socket_available_slots": 48, + "shared_socket_registered_executions": 2, + "status": "healthy", + "success_rate": 99.5, + "uptime_ms": 3600000 + }, + "queue": { + "status": "healthy" + }, + "redis": { + "primary_pool": { + "available": 8, + "connected": true, + "max_size": 16 + }, + "reader_pool": { + "available": 8, + "connected": true, + "max_size": 16 + }, + "status": "healthy" + }, + "system": { + "close_wait_count": 0, + "fd_count": 42, + "fd_limit": 1024, + "fd_usage_percent": 4, + "status": "healthy" + } + }, + "ready": true, + "status": "healthy", + "timestamp": "2026-01-30T12:00:00Z" + } + } + } + }, + "503": { + "description": "Service is not ready (unhealthy)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReadinessResponse" + }, + "example": { + "components": { + "plugins": { + "avg_response_time_ms": 150, + "circuit_state": "open", + "connection_pool_active_connections": 4, + "connection_pool_available_slots": 6, + "enabled": true, + "error": "Plugin pool health check failed", + "memory": 52428800, + "pool_completed": 1000, + "pool_queued": 5, + "recovering": true, + "recovery_percent": 10, + "shared_socket_active_connections": 5, + "shared_socket_available_slots": 45, + "shared_socket_registered_executions": 5, + "status": "degraded", + "success_rate": 95.5, + "uptime_ms": 3600000 + }, + "queue": { + "error": "Queue connection: Stats check timed out", + "status": "unhealthy" + }, + "redis": { + "error": "Redis primary pool: PING timed out", + "primary_pool": { + "available": 0, + "connected": false, + "error": "PING timed out", + "max_size": 16 + }, + "reader_pool": { + "available": 0, + "connected": false, + "error": "PING timed out", + "max_size": 16 + }, + "status": "unhealthy" + }, + "system": { + "close_wait_count": 0, + "fd_count": 42, + "fd_limit": 1024, + "fd_usage_percent": 4, + "status": "healthy" + } + }, + "ready": false, + "reason": "Redis primary pool: PING timed out", + "status": "unhealthy", + "timestamp": "2026-01-30T12:00:00Z" + } + } + } + } + } + } + }, "/api/v1/relayers": { "get": { "tags": [ @@ -3630,38 +4607,6 @@ } ] } - }, - "/v1/health": { - "get": { - "tags": [ - "Health" - ], - "summary": "Health routes implementation", - "description": "Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file\nHandles the `/health` endpoint.\n\nReturns an `HttpResponse` with a status of `200 OK` and a body of `\"OK\"`.", - "operationId": "health", - "responses": { - "200": { - "description": "Service is healthy", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - } - } - }, - "500": { - "description": "Internal server error", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - } - } - } - } - } } }, "components": { @@ -3682,10 +4627,58 @@ "balance": { "type": "integer", "minimum": 0 - }, - "unit": { - "type": "string", - "example": "wei" + }, + "unit": { + "type": "string", + "example": "wei" + } + } + }, + "error": { + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/PluginMetadata" + }, + "pagination": { + "$ref": "#/components/schemas/PaginationMeta" + }, + "success": { + "type": "boolean" + } + } + }, + "ApiResponse_DeletePendingTransactionsResponse": { + "type": "object", + "required": [ + "success" + ], + "properties": { + "data": { + "type": "object", + "description": "Response for delete pending transactions operation", + "required": [ + "queued_for_cancellation_transaction_ids", + "failed_to_queue_transaction_ids", + "total_processed" + ], + "properties": { + "failed_to_queue_transaction_ids": { + "type": "array", + "items": { + "type": "string" + } + }, + "queued_for_cancellation_transaction_ids": { + "type": "array", + "items": { + "type": "string" + } + }, + "total_processed": { + "type": "integer", + "format": "int32", + "minimum": 0 } } }, @@ -3703,7 +4696,7 @@ } } }, - "ApiResponse_DeletePendingTransactionsResponse": { + "ApiResponse_NetworkResponse": { "type": "object", "required": [ "success" @@ -3711,29 +4704,86 @@ "properties": { "data": { "type": "object", - "description": "Response for delete pending transactions operation", + "description": "Network response model for API endpoints.\n\nThis flattens the internal NetworkRepoModel structure for API responses,\nmaking network-type-specific fields available at the top level.", "required": [ - "queued_for_cancellation_transaction_ids", - "failed_to_queue_transaction_ids", - "total_processed" + "id", + "name", + "network_type" ], "properties": { - "failed_to_queue_transaction_ids": { + "average_blocktime_ms": { + "type": "integer", + "format": "int64", + "description": "Estimated average time between blocks in milliseconds", + "minimum": 0 + }, + "chain_id": { + "type": "integer", + "format": "int64", + "description": "EVM-specific: Chain ID", + "minimum": 0 + }, + "explorer_urls": { "type": "array", "items": { "type": "string" - } + }, + "description": "List of Explorer endpoint URLs" }, - "queued_for_cancellation_transaction_ids": { + "features": { "type": "array", "items": { "type": "string" - } + }, + "description": "EVM-specific: Network features (e.g., \"eip1559\")" }, - "total_processed": { + "horizon_url": { + "type": "string", + "description": "Stellar-specific: Horizon URL" + }, + "id": { + "type": "string", + "description": "Unique identifier composed of network_type and name, e.g., \"evm:mainnet\"" + }, + "is_testnet": { + "type": "boolean", + "description": "Flag indicating if the network is a testnet" + }, + "name": { + "type": "string", + "description": "Name of the network (e.g., \"mainnet\", \"sepolia\")" + }, + "network_type": { + "$ref": "#/components/schemas/RelayerNetworkType", + "description": "Type of the network (EVM, Solana, Stellar)" + }, + "passphrase": { + "type": "string", + "description": "Stellar-specific: Network passphrase" + }, + "required_confirmations": { "type": "integer", - "format": "int32", + "format": "int64", + "description": "EVM-specific: Required confirmations", "minimum": 0 + }, + "rpc_urls": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RpcConfig" + }, + "description": "List of RPC endpoint configurations" + }, + "symbol": { + "type": "string", + "description": "EVM-specific: Native token symbol" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of arbitrary tags for categorizing or filtering networks" } } }, @@ -3796,6 +4846,110 @@ } } }, + "ApiResponse_PaginatedResult_PluginModel": { + "type": "object", + "required": [ + "success" + ], + "properties": { + "data": { + "type": "object", + "required": [ + "items", + "total", + "page", + "per_page" + ], + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "path", + "timeout" + ], + "properties": { + "allow_get_invocation": { + "type": "boolean", + "description": "Whether to allow GET requests to invoke plugin logic" + }, + "config": { + "type": [ + "object", + "null" + ], + "description": "User-defined configuration accessible to the plugin (must be a JSON object)", + "additionalProperties": {}, + "propertyNames": { + "type": "string" + } + }, + "emit_logs": { + "type": "boolean", + "description": "Whether to include logs in the HTTP response" + }, + "emit_traces": { + "type": "boolean", + "description": "Whether to include traces in the HTTP response" + }, + "forward_logs": { + "type": "boolean", + "description": "Whether to forward plugin logs into the relayer's tracing output" + }, + "id": { + "type": "string", + "description": "Plugin ID" + }, + "path": { + "type": "string", + "description": "Plugin path" + }, + "raw_response": { + "type": "boolean", + "description": "Whether to return raw plugin response without ApiResponse wrapper" + }, + "timeout": { + "type": "integer", + "format": "int64", + "description": "Plugin timeout", + "minimum": 0 + } + } + } + }, + "page": { + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "per_page": { + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "total": { + "type": "integer", + "format": "int64", + "minimum": 0 + } + } + }, + "error": { + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/PluginMetadata" + }, + "pagination": { + "$ref": "#/components/schemas/PaginationMeta" + }, + "success": { + "type": "boolean" + } + } + }, "ApiResponse_PluginHandlerError": { "type": "object", "required": [ @@ -3828,6 +4982,81 @@ } } }, + "ApiResponse_PluginModel": { + "type": "object", + "required": [ + "success" + ], + "properties": { + "data": { + "type": "object", + "required": [ + "id", + "path", + "timeout" + ], + "properties": { + "allow_get_invocation": { + "type": "boolean", + "description": "Whether to allow GET requests to invoke plugin logic" + }, + "config": { + "type": [ + "object", + "null" + ], + "description": "User-defined configuration accessible to the plugin (must be a JSON object)", + "additionalProperties": {}, + "propertyNames": { + "type": "string" + } + }, + "emit_logs": { + "type": "boolean", + "description": "Whether to include logs in the HTTP response" + }, + "emit_traces": { + "type": "boolean", + "description": "Whether to include traces in the HTTP response" + }, + "forward_logs": { + "type": "boolean", + "description": "Whether to forward plugin logs into the relayer's tracing output" + }, + "id": { + "type": "string", + "description": "Plugin ID" + }, + "path": { + "type": "string", + "description": "Plugin path" + }, + "raw_response": { + "type": "boolean", + "description": "Whether to return raw plugin response without ApiResponse wrapper" + }, + "timeout": { + "type": "integer", + "format": "int64", + "description": "Plugin timeout", + "minimum": 0 + } + } + }, + "error": { + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/PluginMetadata" + }, + "pagination": { + "$ref": "#/components/schemas/PaginationMeta" + }, + "success": { + "type": "boolean" + } + } + }, "ApiResponse_RelayerResponse": { "type": "object", "required": [ @@ -3852,8 +5081,9 @@ "custom_rpc_urls": { "type": "array", "items": { - "$ref": "#/components/schemas/RpcConfig" - } + "$ref": "#/components/schemas/MaskedRpcConfig" + }, + "description": "Custom RPC URLs with sensitive path/query parameters masked for security.\nThe domain is visible to identify providers (e.g., Alchemy, Infura) but\nAPI keys embedded in paths are hidden." }, "disabled_reason": { "$ref": "#/components/schemas/DisabledReason" @@ -4173,7 +5403,7 @@ }, { "$ref": "#/components/schemas/StellarPrepareTransactionResult", - "description": "Stellar-specific prepare transaction result" + "description": "Stellar-specific prepare transaction result (classic and Soroban)\nFor Soroban: includes optional user_auth_entry, expiration_ledger" } ], "description": "Network-agnostic prepare transaction response for gasless transactions.\nContains network-specific prepare transaction results." @@ -4206,7 +5436,7 @@ }, { "$ref": "#/components/schemas/StellarFeeEstimateResult", - "description": "Stellar-specific fee estimate result" + "description": "Stellar-specific fee estimate result (classic and Soroban)" } ], "description": "Network-agnostic fee estimate response for gasless transactions.\nContains network-specific fee estimate results." @@ -4265,29 +5495,137 @@ { "$ref": "#/components/schemas/StellarTransactionResponse" } - ] - }, - "error": { - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/PluginMetadata" - }, - "pagination": { - "$ref": "#/components/schemas/PaginationMeta" + ] + }, + "error": { + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/PluginMetadata" + }, + "pagination": { + "$ref": "#/components/schemas/PaginationMeta" + }, + "success": { + "type": "boolean" + } + } + }, + "ApiResponse_Value": { + "type": "object", + "required": [ + "success" + ], + "properties": { + "data": {}, + "error": { + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/PluginMetadata" + }, + "pagination": { + "$ref": "#/components/schemas/PaginationMeta" + }, + "success": { + "type": "boolean" + } + } + }, + "ApiResponse_Vec_NetworkResponse": { + "type": "object", + "required": [ + "success" + ], + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "description": "Network response model for API endpoints.\n\nThis flattens the internal NetworkRepoModel structure for API responses,\nmaking network-type-specific fields available at the top level.", + "required": [ + "id", + "name", + "network_type" + ], + "properties": { + "average_blocktime_ms": { + "type": "integer", + "format": "int64", + "description": "Estimated average time between blocks in milliseconds", + "minimum": 0 + }, + "chain_id": { + "type": "integer", + "format": "int64", + "description": "EVM-specific: Chain ID", + "minimum": 0 + }, + "explorer_urls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of Explorer endpoint URLs" + }, + "features": { + "type": "array", + "items": { + "type": "string" + }, + "description": "EVM-specific: Network features (e.g., \"eip1559\")" + }, + "horizon_url": { + "type": "string", + "description": "Stellar-specific: Horizon URL" + }, + "id": { + "type": "string", + "description": "Unique identifier composed of network_type and name, e.g., \"evm:mainnet\"" + }, + "is_testnet": { + "type": "boolean", + "description": "Flag indicating if the network is a testnet" + }, + "name": { + "type": "string", + "description": "Name of the network (e.g., \"mainnet\", \"sepolia\")" + }, + "network_type": { + "$ref": "#/components/schemas/RelayerNetworkType", + "description": "Type of the network (EVM, Solana, Stellar)" + }, + "passphrase": { + "type": "string", + "description": "Stellar-specific: Network passphrase" + }, + "required_confirmations": { + "type": "integer", + "format": "int64", + "description": "EVM-specific: Required confirmations", + "minimum": 0 + }, + "rpc_urls": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RpcConfig" + }, + "description": "List of RPC endpoint configurations" + }, + "symbol": { + "type": "string", + "description": "EVM-specific: Native token symbol" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of arbitrary tags for categorizing or filtering networks" + } + } + } }, - "success": { - "type": "boolean" - } - } - }, - "ApiResponse_Value": { - "type": "object", - "required": [ - "success" - ], - "properties": { - "data": {}, "error": { "type": "string" }, @@ -4376,8 +5714,9 @@ "custom_rpc_urls": { "type": "array", "items": { - "$ref": "#/components/schemas/RpcConfig" - } + "$ref": "#/components/schemas/MaskedRpcConfig" + }, + "description": "Custom RPC URLs with sensitive path/query parameters masked for security.\nThe domain is visible to identify providers (e.g., Alchemy, Infura) but\nAPI keys embedded in paths are hidden." }, "disabled_reason": { "$ref": "#/components/schemas/DisabledReason" @@ -4708,6 +6047,38 @@ }, "additionalProperties": false }, + "ComponentStatus": { + "type": "string", + "description": "Component health status levels.", + "enum": [ + "healthy", + "degraded", + "unhealthy" + ] + }, + "Components": { + "type": "object", + "description": "All health check components.", + "required": [ + "system", + "redis", + "queue" + ], + "properties": { + "plugins": { + "$ref": "#/components/schemas/PluginHealth" + }, + "queue": { + "$ref": "#/components/schemas/QueueHealth" + }, + "redis": { + "$ref": "#/components/schemas/RedisHealth" + }, + "system": { + "$ref": "#/components/schemas/SystemHealth" + } + } + }, "ContractSource": { "oneOf": [ { @@ -5549,6 +6920,31 @@ "result" ] }, + "MaskedRpcConfig": { + "type": "object", + "description": "RPC configuration with masked URL for API responses.\n\nThis type is used in API responses to prevent exposing sensitive API keys\nthat are often embedded in RPC endpoint URLs (e.g., Alchemy, Infura, QuickNode).\nThe URL path and query parameters are masked while keeping the host visible,\nallowing users to identify which provider is configured.", + "required": [ + "url", + "weight" + ], + "properties": { + "url": { + "type": "string", + "description": "The RPC endpoint URL with path/query masked." + }, + "weight": { + "type": "integer", + "format": "int32", + "description": "The weight of this endpoint in the weighted round-robin selection.", + "maximum": 100, + "minimum": 0 + } + }, + "example": { + "url": "https://eth-mainnet.g.alchemy.com/***", + "weight": 100 + } + }, "MemoSpec": { "oneOf": [ { @@ -5659,6 +7055,91 @@ ], "description": "Network policy response models for OpenAPI documentation" }, + "NetworkResponse": { + "type": "object", + "description": "Network response model for API endpoints.\n\nThis flattens the internal NetworkRepoModel structure for API responses,\nmaking network-type-specific fields available at the top level.", + "required": [ + "id", + "name", + "network_type" + ], + "properties": { + "average_blocktime_ms": { + "type": "integer", + "format": "int64", + "description": "Estimated average time between blocks in milliseconds", + "minimum": 0 + }, + "chain_id": { + "type": "integer", + "format": "int64", + "description": "EVM-specific: Chain ID", + "minimum": 0 + }, + "explorer_urls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of Explorer endpoint URLs" + }, + "features": { + "type": "array", + "items": { + "type": "string" + }, + "description": "EVM-specific: Network features (e.g., \"eip1559\")" + }, + "horizon_url": { + "type": "string", + "description": "Stellar-specific: Horizon URL" + }, + "id": { + "type": "string", + "description": "Unique identifier composed of network_type and name, e.g., \"evm:mainnet\"" + }, + "is_testnet": { + "type": "boolean", + "description": "Flag indicating if the network is a testnet" + }, + "name": { + "type": "string", + "description": "Name of the network (e.g., \"mainnet\", \"sepolia\")" + }, + "network_type": { + "$ref": "#/components/schemas/RelayerNetworkType", + "description": "Type of the network (EVM, Solana, Stellar)" + }, + "passphrase": { + "type": "string", + "description": "Stellar-specific: Network passphrase" + }, + "required_confirmations": { + "type": "integer", + "format": "int64", + "description": "EVM-specific: Required confirmations", + "minimum": 0 + }, + "rpc_urls": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RpcConfig" + }, + "description": "List of RPC endpoint configurations" + }, + "symbol": { + "type": "string", + "description": "EVM-specific: Native token symbol" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of arbitrary tags for categorizing or filtering networks" + } + } + }, "NetworkRpcRequest": { "oneOf": [ { @@ -5890,96 +7371,334 @@ "wasm", "type" ], - "properties": { - "auth": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/AuthSpec" - } - ] - }, - "type": { - "type": "string", - "enum": [ - "upload_wasm" - ] - }, - "wasm": { - "$ref": "#/components/schemas/WasmSource" - } + "properties": { + "auth": { + "oneOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/AuthSpec" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "upload_wasm" + ] + }, + "wasm": { + "$ref": "#/components/schemas/WasmSource" + } + } + } + ] + }, + "PaginationMeta": { + "type": "object", + "required": [ + "current_page", + "per_page", + "total_items" + ], + "properties": { + "current_page": { + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "per_page": { + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "total_items": { + "type": "integer", + "format": "int64", + "minimum": 0 + } + } + }, + "PluginCallRequest": { + "type": "object", + "properties": { + "params": { + "description": "Plugin parameters. If not provided, the entire request body will be used as params." + } + } + }, + "PluginHandlerError": { + "type": "object", + "properties": { + "code": { + "type": [ + "string", + "null" + ] + }, + "details": {} + } + }, + "PluginHealth": { + "type": "object", + "description": "Plugin health information.", + "required": [ + "status", + "enabled" + ], + "properties": { + "avg_response_time_ms": { + "type": "integer", + "format": "int32", + "description": "Average response time in milliseconds", + "minimum": 0 + }, + "circuit_state": { + "type": "string" + }, + "connection_pool_active_connections": { + "type": "integer", + "description": "Connection pool active connections (for pool server connections)", + "minimum": 0 + }, + "connection_pool_available_slots": { + "type": "integer", + "description": "Connection pool available slots (for pool server connections)", + "minimum": 0 + }, + "enabled": { + "type": "boolean" + }, + "error": { + "type": "string" + }, + "memory": { + "type": "integer", + "format": "int64", + "description": "Memory usage in bytes", + "minimum": 0 + }, + "pool_completed": { + "type": "integer", + "format": "int64", + "description": "Number of completed tasks in the pool", + "minimum": 0 + }, + "pool_queued": { + "type": "integer", + "format": "int64", + "description": "Number of queued tasks in the pool", + "minimum": 0 + }, + "recovering": { + "type": "boolean", + "description": "Whether recovery mode is active" + }, + "recovery_percent": { + "type": "integer", + "format": "int32", + "description": "Current recovery allowance percentage", + "minimum": 0 + }, + "shared_socket_active_connections": { + "type": "integer", + "description": "Shared socket active connection count", + "minimum": 0 + }, + "shared_socket_available_slots": { + "type": "integer", + "description": "Shared socket available connection slots", + "minimum": 0 + }, + "shared_socket_registered_executions": { + "type": "integer", + "description": "Shared socket registered execution count", + "minimum": 0 + }, + "status": { + "$ref": "#/components/schemas/ComponentStatus" + }, + "success_rate": { + "type": "number", + "format": "double", + "description": "Success rate as a percentage (0.0-100.0)" + }, + "uptime_ms": { + "type": "integer", + "format": "int64", + "description": "Plugin uptime in milliseconds", + "minimum": 0 + } + } + }, + "PluginMetadata": { + "type": "object", + "properties": { + "logs": { + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/components/schemas/LogEntry" } + }, + "traces": { + "type": [ + "array", + "null" + ], + "items": {} } - ] + } }, - "PaginationMeta": { + "PluginModel": { "type": "object", "required": [ - "current_page", - "per_page", - "total_items" + "id", + "path", + "timeout" ], "properties": { - "current_page": { + "allow_get_invocation": { + "type": "boolean", + "description": "Whether to allow GET requests to invoke plugin logic" + }, + "config": { + "type": [ + "object", + "null" + ], + "description": "User-defined configuration accessible to the plugin (must be a JSON object)", + "additionalProperties": {}, + "propertyNames": { + "type": "string" + } + }, + "emit_logs": { + "type": "boolean", + "description": "Whether to include logs in the HTTP response" + }, + "emit_traces": { + "type": "boolean", + "description": "Whether to include traces in the HTTP response" + }, + "forward_logs": { + "type": "boolean", + "description": "Whether to forward plugin logs into the relayer's tracing output" + }, + "id": { + "type": "string", + "description": "Plugin ID" + }, + "path": { + "type": "string", + "description": "Plugin path" + }, + "raw_response": { + "type": "boolean", + "description": "Whether to return raw plugin response without ApiResponse wrapper" + }, + "timeout": { "type": "integer", - "format": "int32", + "format": "int64", + "description": "Plugin timeout", "minimum": 0 - }, - "per_page": { + } + } + }, + "PoolStatus": { + "type": "object", + "description": "Status of an individual Redis connection pool.", + "required": [ + "connected", + "available", + "max_size" + ], + "properties": { + "available": { "type": "integer", - "format": "int32", + "description": "Number of available connections in the pool.", "minimum": 0 }, - "total_items": { + "connected": { + "type": "boolean", + "description": "Whether the pool is connected and responding to PING." + }, + "error": { + "type": "string", + "description": "Error message if the pool is not healthy." + }, + "max_size": { "type": "integer", - "format": "int64", + "description": "Maximum configured pool size.", "minimum": 0 } } }, - "PluginCallRequest": { + "QueueHealth": { "type": "object", + "description": "Queue health information.", "required": [ - "params" + "status" ], "properties": { - "params": { - "description": "Plugin parameters" + "error": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/ComponentStatus" } } }, - "PluginHandlerError": { + "ReadinessResponse": { "type": "object", + "description": "Complete readiness response.", + "required": [ + "ready", + "status", + "components", + "timestamp" + ], "properties": { - "code": { - "type": [ - "string", - "null" - ] + "components": { + "$ref": "#/components/schemas/Components" }, - "details": {} + "ready": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/ComponentStatus" + }, + "timestamp": { + "type": "string" + } } }, - "PluginMetadata": { + "RedisHealth": { "type": "object", + "description": "Redis health information.", + "required": [ + "status", + "primary_pool", + "reader_pool" + ], "properties": { - "logs": { - "type": [ - "array", - "null" - ], - "items": { - "$ref": "#/components/schemas/LogEntry" - } + "error": { + "type": "string" }, - "traces": { - "type": [ - "array", - "null" - ], - "items": {} + "primary_pool": { + "$ref": "#/components/schemas/PoolStatus" + }, + "reader_pool": { + "$ref": "#/components/schemas/PoolStatus" + }, + "status": { + "$ref": "#/components/schemas/ComponentStatus" } } }, @@ -6140,8 +7859,9 @@ "custom_rpc_urls": { "type": "array", "items": { - "$ref": "#/components/schemas/RpcConfig" - } + "$ref": "#/components/schemas/MaskedRpcConfig" + }, + "description": "Custom RPC URLs with sensitive path/query parameters masked for security.\nThe domain is visible to identify providers (e.g., Alchemy, Infura) but\nAPI keys embedded in paths are hidden." }, "disabled_reason": { "$ref": "#/components/schemas/DisabledReason" @@ -6509,9 +8229,10 @@ }, "RpcConfig": { "type": "object", - "description": "Configuration for an RPC endpoint.", + "description": "Configuration for an RPC endpoint.\n\nThis struct contains only persistent configuration (URL and weight).\nHealth metadata (failures, pause state) is managed separately via `RpcHealthStore`.", "required": [ - "url" + "url", + "weight" ], "properties": { "url": { @@ -6521,11 +8242,30 @@ "weight": { "type": "integer", "format": "int32", - "description": "The weight of this endpoint in the weighted round-robin selection.\nDefaults to DEFAULT_RPC_WEIGHT (100). Should be between 0 and 100.", + "description": "The weight of this endpoint in the weighted round-robin selection.\nDefaults to [`DEFAULT_RPC_WEIGHT`]. Should be between 0 and 100.", + "default": 100, + "maximum": 100, "minimum": 0 } + }, + "example": { + "url": "https://rpc.example.com", + "weight": 100 } }, + "RpcUrlEntry": { + "oneOf": [ + { + "type": "string", + "description": "Simple string format (e.g., \"https://rpc.example.com\")\nDefaults to weight 100." + }, + { + "$ref": "#/components/schemas/RpcConfig", + "description": "Extended object format with explicit weight" + } + ], + "description": "Schema-only type representing a flexible RPC URL entry.\nUsed for OpenAPI documentation to show that rpc_urls can accept\neither strings or RpcConfig objects.\n\nThis is NOT used for actual deserialization - the custom deserializer\nhandles the conversion. This type exists solely for schema generation." + }, "SignAndSendTransactionRequestParams": { "type": "object", "required": [ @@ -7670,10 +9410,10 @@ }, { "$ref": "#/components/schemas/StellarPrepareTransactionRequestParams", - "description": "Stellar-specific prepare transaction request parameters" + "description": "Stellar-specific prepare transaction request parameters (classic and Soroban)" } ], - "description": "Network-agnostic prepare transaction request parameters for gasless transactions.\nContains network-specific request parameters for preparing transactions with fee payments.\nThe network type is inferred from the relayer's network configuration." + "description": "Network-agnostic prepare transaction request parameters for gasless transactions.\nContains network-specific request parameters for preparing transactions with fee payments.\nThe network type is inferred from the relayer's network configuration.\n\nFor Stellar, supports both classic and Soroban gas abstraction:\n- Classic: Pass operations or transaction_xdr with classic fee token\n- Soroban: Pass transaction_xdr containing InvokeHostFunction, user_address, and contract fee token" }, "SponsoredTransactionBuildResponse": { "oneOf": [ @@ -7683,7 +9423,7 @@ }, { "$ref": "#/components/schemas/StellarPrepareTransactionResult", - "description": "Stellar-specific prepare transaction result" + "description": "Stellar-specific prepare transaction result (classic and Soroban)\nFor Soroban: includes optional user_auth_entry, expiration_ledger" } ], "description": "Network-agnostic prepare transaction response for gasless transactions.\nContains network-specific prepare transaction results." @@ -7696,10 +9436,10 @@ }, { "$ref": "#/components/schemas/StellarFeeEstimateRequestParams", - "description": "Stellar-specific fee estimate request parameters" + "description": "Stellar-specific fee estimate request parameters (classic and Soroban)" } ], - "description": "Network-agnostic fee estimate request parameters for gasless transactions.\nContains network-specific request parameters for fee estimation.\nThe network type is inferred from the relayer's network configuration." + "description": "Network-agnostic fee estimate request parameters for gasless transactions.\nContains network-specific request parameters for fee estimation.\nThe network type is inferred from the relayer's network configuration.\n\nFor Stellar, supports both classic and Soroban gas abstraction:\n- Classic: Pass operations or transaction_xdr with classic fee token (native/USDC:GA...)\n- Soroban: Pass transaction_xdr containing InvokeHostFunction, user_address, and contract fee token (C...)" }, "SponsoredTransactionQuoteResponse": { "oneOf": [ @@ -7709,7 +9449,7 @@ }, { "$ref": "#/components/schemas/StellarFeeEstimateResult", - "description": "Stellar-specific fee estimate result" + "description": "Stellar-specific fee estimate result (classic and Soroban)" } ], "description": "Network-agnostic fee estimate response for gasless transactions.\nContains network-specific fee estimate results." @@ -7776,7 +9516,7 @@ "properties": { "fee_token": { "type": "string", - "description": "Asset identifier for fee token (e.g., \"native\" or \"USDC:GA5Z...\")" + "description": "Asset identifier for fee token.\nFor classic: \"native\" or \"USDC:GA5Z...\" format.\nFor Soroban: contract address (C...) format." }, "operations": { "type": [ @@ -7800,7 +9540,7 @@ "string", "null" ], - "description": "Pre-built transaction XDR (base64 encoded, signed or unsigned)\nMutually exclusive with operations field" + "description": "Pre-built transaction XDR (base64 encoded, signed or unsigned)\nMutually exclusive with operations field.\nFor Soroban gas abstraction: pass XDR containing InvokeHostFunction operation." } }, "additionalProperties": false @@ -7824,6 +9564,20 @@ "fee_in_token_ui": { "type": "string", "description": "Estimated fee in token amount (decimal UI representation as string)" + }, + "max_fee_in_token": { + "type": [ + "string", + "null" + ], + "description": "Maximum fee in token amount (raw units as string).\nOnly present for Soroban gas abstraction - includes slippage buffer." + }, + "max_fee_in_token_ui": { + "type": [ + "string", + "null" + ], + "description": "Maximum fee in token amount (decimal UI representation as string).\nOnly present for Soroban gas abstraction - includes slippage buffer." } } }, @@ -7888,7 +9642,7 @@ "properties": { "fee_token": { "type": "string", - "description": "Asset identifier for fee token" + "description": "Asset identifier for fee token.\nFor classic: \"native\" or \"USDC:GA5Z...\" format.\nFor Soroban: contract address (C...) format." }, "operations": { "type": [ @@ -7912,7 +9666,7 @@ "string", "null" ], - "description": "Pre-built transaction XDR (base64 encoded, signed or unsigned)\nMutually exclusive with operations field" + "description": "Pre-built transaction XDR (base64 encoded, signed or unsigned)\nMutually exclusive with operations field.\nFor Soroban gas abstraction: pass XDR containing InvokeHostFunction operation." } }, "additionalProperties": false @@ -7944,10 +9698,31 @@ "type": "string", "description": "Asset identifier for fee token" }, + "max_fee_in_token": { + "type": [ + "string", + "null" + ], + "description": "Maximum fee in token amount (raw units as string).\nOnly present for Soroban gas abstraction - includes slippage buffer." + }, + "max_fee_in_token_ui": { + "type": [ + "string", + "null" + ], + "description": "Maximum fee in token amount (decimal UI representation as string).\nOnly present for Soroban gas abstraction - includes slippage buffer." + }, "transaction": { "type": "string", "description": "Extended transaction XDR (base64 encoded)" }, + "user_auth_entry": { + "type": [ + "string", + "null" + ], + "description": "User authorization entry XDR (base64 encoded).\nPresent for Soroban gas abstraction - user must sign this auth entry." + }, "valid_until": { "type": "string", "description": "Transaction validity timestamp (ISO 8601 format)" @@ -8104,6 +9879,13 @@ "$ref": "#/components/schemas/OperationSpec" } }, + "signed_auth_entry": { + "type": [ + "string", + "null" + ], + "description": "Signed Soroban authorization entry (base64 encoded SorobanAuthorizationEntry XDR)\nUsed for Soroban gas abstraction: contains the user's signed auth entry from /build response.\nWhen provided, transaction_xdr must also be provided (the FeeForwarder transaction from /build).\nThe relayer will inject this signed auth entry into the transaction before submitting." + }, "source_account": { "type": [ "string", @@ -8115,7 +9897,7 @@ "string", "null" ], - "description": "Pre-built transaction XDR (base64 encoded, signed or unsigned)\nMutually exclusive with operations field" + "description": "Pre-built transaction XDR (base64 encoded, signed or unsigned)\nMutually exclusive with operations field.\nFor Soroban gas abstraction: submit the transaction XDR from sponsored/build response\nwith the user's signed auth entry updated inside." }, "valid_until": { "type": [ @@ -8175,6 +9957,45 @@ "string", "null" ] + }, + "transaction_result_xdr": { + "type": "string" + } + } + }, + "SystemHealth": { + "type": "object", + "description": "System health information (file descriptors, sockets).", + "required": [ + "status", + "fd_count", + "fd_limit", + "fd_usage_percent", + "close_wait_count" + ], + "properties": { + "close_wait_count": { + "type": "integer", + "minimum": 0 + }, + "error": { + "type": "string" + }, + "fd_count": { + "type": "integer", + "minimum": 0 + }, + "fd_limit": { + "type": "integer", + "minimum": 0 + }, + "fd_usage_percent": { + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "status": { + "$ref": "#/components/schemas/ComponentStatus" } } }, @@ -8288,6 +10109,88 @@ }, "additionalProperties": false }, + "UpdateNetworkRequest": { + "type": "object", + "description": "Request structure for updating a network configuration.\nCurrently supports updating RPC URLs only. Can be extended to support other fields.", + "properties": { + "rpc_urls": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RpcUrlEntry" + }, + "description": "List of RPC endpoint configurations for connecting to the network.\nSupports multiple formats:\n- Array of strings: `[\"https://rpc.example.com\"]` (defaults to weight 100)\n- Array of RpcConfig objects: `[{\"url\": \"https://rpc.example.com\", \"weight\": 100}]`\n- Mixed array: `[\"https://rpc1.com\", {\"url\": \"https://rpc2.com\", \"weight\": 100}]`\n Must be non-empty and contain valid HTTP/HTTPS URLs if provided.", + "example": [ + { + "url": "https://rpc.example.com", + "weight": 100 + } + ] + } + }, + "additionalProperties": false + }, + "UpdatePluginRequest": { + "type": "object", + "description": "Request model for updating an existing plugin.\nAll fields are optional to allow partial updates.\nNote: `id` and `path` are not updateable after creation.", + "properties": { + "allow_get_invocation": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow GET requests to invoke plugin logic" + }, + "config": { + "type": [ + "object", + "null" + ], + "description": "User-defined configuration accessible to the plugin (must be a JSON object)\nUse `null` to clear the config", + "additionalProperties": {}, + "propertyNames": { + "type": "string" + } + }, + "emit_logs": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to include logs in the HTTP response" + }, + "emit_traces": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to include traces in the HTTP response" + }, + "forward_logs": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to forward plugin logs into the relayer's tracing output" + }, + "raw_response": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to return raw plugin response without ApiResponse wrapper" + }, + "timeout": { + "type": [ + "integer", + "null" + ], + "format": "int64", + "description": "Plugin timeout in seconds", + "minimum": 0 + } + }, + "additionalProperties": false + }, "UpdateRelayerRequest": { "type": "object", "properties": { @@ -8437,6 +10340,10 @@ "name": "Signers", "description": "Signers are responsible for signing the transactions related to the relayers." }, + { + "name": "Networks", + "description": "Networks represent blockchain network configurations including RPC endpoints and network-specific settings." + }, { "name": "Metrics", "description": "Metrics are responsible for showing the metrics related to the relayers." diff --git a/src/.openapi-generator/FILES b/src/.openapi-generator/FILES index 2c1e9b5f..866fe1b9 100644 --- a/src/.openapi-generator/FILES +++ b/src/.openapi-generator/FILES @@ -5,6 +5,7 @@ README.md api.ts apis/health-api.ts apis/metrics-api.ts +apis/networks-api.ts apis/notifications-api.ts apis/plugins-api.ts apis/relayers-api.ts @@ -18,10 +19,16 @@ models/api-response-balance-response-data.ts models/api-response-balance-response.ts models/api-response-delete-pending-transactions-response-data.ts models/api-response-delete-pending-transactions-response.ts +models/api-response-network-response-data.ts +models/api-response-network-response.ts models/api-response-notification-response-data.ts models/api-response-notification-response.ts +models/api-response-paginated-result-plugin-model-data-items-inner.ts +models/api-response-paginated-result-plugin-model-data.ts +models/api-response-paginated-result-plugin-model.ts models/api-response-plugin-handler-error-data.ts models/api-response-plugin-handler-error.ts +models/api-response-plugin-model.ts models/api-response-relayer-response-data.ts models/api-response-relayer-response.ts models/api-response-relayer-status-data-one-of.ts @@ -43,6 +50,7 @@ models/api-response-string.ts models/api-response-transaction-response-data.ts models/api-response-transaction-response.ts models/api-response-value.ts +models/api-response-vec-network-response.ts models/api-response-vec-notification-response.ts models/api-response-vec-relayer-response.ts models/api-response-vec-signer-response.ts @@ -59,6 +67,8 @@ models/auth-spec.ts models/aws-kms-signer-request-config.ts models/balance-response.ts models/cdp-signer-request-config.ts +models/component-status.ts +models/components.ts models/contract-source-one-of.ts models/contract-source-one-of1.ts models/contract-source.ts @@ -96,6 +106,7 @@ models/jupiter-swap-options.ts models/local-signer-request-config.ts models/log-entry.ts models/log-level.ts +models/masked-rpc-config.ts models/memo-spec-one-of.ts models/memo-spec-one-of1.ts models/memo-spec-one-of2.ts @@ -103,6 +114,7 @@ models/memo-spec-one-of3.ts models/memo-spec-one-of4.ts models/memo-spec.ts models/network-policy-response.ts +models/network-response.ts models/network-rpc-request.ts models/network-rpc-result.ts models/network-transaction-request.ts @@ -118,7 +130,13 @@ models/operation-spec.ts models/pagination-meta.ts models/plugin-call-request.ts models/plugin-handler-error.ts +models/plugin-health.ts models/plugin-metadata.ts +models/plugin-model.ts +models/pool-status.ts +models/queue-health.ts +models/readiness-response.ts +models/redis-health.ts models/relayer-evm-policy.ts models/relayer-network-policy-one-of.ts models/relayer-network-policy-one-of1.ts @@ -133,6 +151,7 @@ models/relayer-status.ts models/relayer-stellar-policy.ts models/relayer-stellar-swap-config.ts models/rpc-config.ts +models/rpc-url-entry.ts models/sign-and-send-transaction-request-params.ts models/sign-and-send-transaction-result.ts models/sign-data-request.ts @@ -217,11 +236,14 @@ models/stellar-token-kind.ts models/stellar-token-metadata.ts models/stellar-transaction-request.ts models/stellar-transaction-response.ts +models/system-health.ts models/transaction-response.ts models/transaction-status.ts models/transfer-transaction-request-params.ts models/transfer-transaction-result.ts models/turnkey-signer-request-config.ts +models/update-network-request.ts +models/update-plugin-request.ts models/update-relayer-request.ts models/vault-signer-request-config.ts models/vault-transit-signer-request-config.ts diff --git a/src/api.ts b/src/api.ts index c14f712d..67ae790e 100644 --- a/src/api.ts +++ b/src/api.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -16,6 +16,7 @@ export * from './apis/health-api'; export * from './apis/metrics-api'; +export * from './apis/networks-api'; export * from './apis/notifications-api'; export * from './apis/plugins-api'; export * from './apis/relayers-api'; diff --git a/src/apis/health-api.ts b/src/apis/health-api.ts index e6e752b9..7e0323e5 100644 --- a/src/apis/health-api.ts +++ b/src/apis/health-api.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -21,6 +21,8 @@ import globalAxios from 'axios'; import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base'; +// @ts-ignore +import type { ReadinessResponse } from '../models'; /** * HealthApi - axios parameter creator * @export @@ -28,13 +30,43 @@ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError export const HealthApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file Handles the `/health` endpoint. Returns an `HttpResponse` with a status of `200 OK` and a body of `\"OK\"`. + * Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file Handles the `/health` endpoint. Returns an `HttpResponse` with a status of `200 OK` and a body of `\"OK\"`. This endpoint is used for liveness probes in container orchestration platforms. * @summary Health routes implementation * @param {*} [options] Override http request option. * @throws {RequiredError} */ health: async (options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/v1/health`; + const localVarPath = `/api/v1/health`; + // 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 = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Returns 200 OK if the service is ready to accept traffic, or 503 Service Unavailable if not. This endpoint is used for readiness probes in container orchestration platforms like AWS ECS or Kubernetes. ## Health Check Components - **System**: File descriptor usage, CLOSE_WAIT socket count - **Redis**: Primary and reader pool connectivity - **Queue**: Queue\'s Redis connections (separate from app\'s Redis) - **Plugins**: Plugin pool health, circuit breaker state, and connection metrics (if enabled) ## Status Levels - `healthy`: All components operational - `degraded`: Some components degraded but service can function (e.g., reader pool down) - `unhealthy`: Critical components failed, service unavailable ## Plugin Connection Metrics When plugins are enabled, the following connection metrics are exposed: - `shared_socket_available_slots`: Number of additional concurrent plugin executions that can start - `shared_socket_active_connections`: Current number of active plugin execution connections - `shared_socket_registered_executions`: Number of plugin executions currently registered (awaiting response) - `connection_pool_available_slots`: Available connections to the pool server - `connection_pool_active_connections`: Active connections to the pool server These metrics help diagnose connection pool exhaustion and plugin capacity issues. ## Caching Health check results are cached for 10 seconds to prevent excessive load from frequent health checks. Multiple requests within the TTL return the same cached response. + * @summary Readiness endpoint that checks system resources, Redis, Queue, and plugins. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + readiness: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/v1/ready`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -68,7 +100,7 @@ export const HealthApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = HealthApiAxiosParamCreator(configuration) return { /** - * Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file Handles the `/health` endpoint. Returns an `HttpResponse` with a status of `200 OK` and a body of `\"OK\"`. + * Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file Handles the `/health` endpoint. Returns an `HttpResponse` with a status of `200 OK` and a body of `\"OK\"`. This endpoint is used for liveness probes in container orchestration platforms. * @summary Health routes implementation * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -79,6 +111,18 @@ export const HealthApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['HealthApi.health']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * Returns 200 OK if the service is ready to accept traffic, or 503 Service Unavailable if not. This endpoint is used for readiness probes in container orchestration platforms like AWS ECS or Kubernetes. ## Health Check Components - **System**: File descriptor usage, CLOSE_WAIT socket count - **Redis**: Primary and reader pool connectivity - **Queue**: Queue\'s Redis connections (separate from app\'s Redis) - **Plugins**: Plugin pool health, circuit breaker state, and connection metrics (if enabled) ## Status Levels - `healthy`: All components operational - `degraded`: Some components degraded but service can function (e.g., reader pool down) - `unhealthy`: Critical components failed, service unavailable ## Plugin Connection Metrics When plugins are enabled, the following connection metrics are exposed: - `shared_socket_available_slots`: Number of additional concurrent plugin executions that can start - `shared_socket_active_connections`: Current number of active plugin execution connections - `shared_socket_registered_executions`: Number of plugin executions currently registered (awaiting response) - `connection_pool_available_slots`: Available connections to the pool server - `connection_pool_active_connections`: Active connections to the pool server These metrics help diagnose connection pool exhaustion and plugin capacity issues. ## Caching Health check results are cached for 10 seconds to prevent excessive load from frequent health checks. Multiple requests within the TTL return the same cached response. + * @summary Readiness endpoint that checks system resources, Redis, Queue, and plugins. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async readiness(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.readiness(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['HealthApi.readiness']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, } }; @@ -90,7 +134,7 @@ export const HealthApiFactory = function (configuration?: Configuration, basePat const localVarFp = HealthApiFp(configuration) return { /** - * Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file Handles the `/health` endpoint. Returns an `HttpResponse` with a status of `200 OK` and a body of `\"OK\"`. + * Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file Handles the `/health` endpoint. Returns an `HttpResponse` with a status of `200 OK` and a body of `\"OK\"`. This endpoint is used for liveness probes in container orchestration platforms. * @summary Health routes implementation * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -98,6 +142,15 @@ export const HealthApiFactory = function (configuration?: Configuration, basePat health(options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.health(options).then((request) => request(axios, basePath)); }, + /** + * Returns 200 OK if the service is ready to accept traffic, or 503 Service Unavailable if not. This endpoint is used for readiness probes in container orchestration platforms like AWS ECS or Kubernetes. ## Health Check Components - **System**: File descriptor usage, CLOSE_WAIT socket count - **Redis**: Primary and reader pool connectivity - **Queue**: Queue\'s Redis connections (separate from app\'s Redis) - **Plugins**: Plugin pool health, circuit breaker state, and connection metrics (if enabled) ## Status Levels - `healthy`: All components operational - `degraded`: Some components degraded but service can function (e.g., reader pool down) - `unhealthy`: Critical components failed, service unavailable ## Plugin Connection Metrics When plugins are enabled, the following connection metrics are exposed: - `shared_socket_available_slots`: Number of additional concurrent plugin executions that can start - `shared_socket_active_connections`: Current number of active plugin execution connections - `shared_socket_registered_executions`: Number of plugin executions currently registered (awaiting response) - `connection_pool_available_slots`: Available connections to the pool server - `connection_pool_active_connections`: Active connections to the pool server These metrics help diagnose connection pool exhaustion and plugin capacity issues. ## Caching Health check results are cached for 10 seconds to prevent excessive load from frequent health checks. Multiple requests within the TTL return the same cached response. + * @summary Readiness endpoint that checks system resources, Redis, Queue, and plugins. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + readiness(options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.readiness(options).then((request) => request(axios, basePath)); + }, }; }; @@ -109,7 +162,7 @@ export const HealthApiFactory = function (configuration?: Configuration, basePat */ export class HealthApi extends BaseAPI { /** - * Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file Handles the `/health` endpoint. Returns an `HttpResponse` with a status of `200 OK` and a body of `\"OK\"`. + * Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file Handles the `/health` endpoint. Returns an `HttpResponse` with a status of `200 OK` and a body of `\"OK\"`. This endpoint is used for liveness probes in container orchestration platforms. * @summary Health routes implementation * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -118,5 +171,16 @@ export class HealthApi extends BaseAPI { public health(options?: RawAxiosRequestConfig) { return HealthApiFp(this.configuration).health(options).then((request) => request(this.axios, this.basePath)); } + + /** + * Returns 200 OK if the service is ready to accept traffic, or 503 Service Unavailable if not. This endpoint is used for readiness probes in container orchestration platforms like AWS ECS or Kubernetes. ## Health Check Components - **System**: File descriptor usage, CLOSE_WAIT socket count - **Redis**: Primary and reader pool connectivity - **Queue**: Queue\'s Redis connections (separate from app\'s Redis) - **Plugins**: Plugin pool health, circuit breaker state, and connection metrics (if enabled) ## Status Levels - `healthy`: All components operational - `degraded`: Some components degraded but service can function (e.g., reader pool down) - `unhealthy`: Critical components failed, service unavailable ## Plugin Connection Metrics When plugins are enabled, the following connection metrics are exposed: - `shared_socket_available_slots`: Number of additional concurrent plugin executions that can start - `shared_socket_active_connections`: Current number of active plugin execution connections - `shared_socket_registered_executions`: Number of plugin executions currently registered (awaiting response) - `connection_pool_available_slots`: Available connections to the pool server - `connection_pool_active_connections`: Active connections to the pool server These metrics help diagnose connection pool exhaustion and plugin capacity issues. ## Caching Health check results are cached for 10 seconds to prevent excessive load from frequent health checks. Multiple requests within the TTL return the same cached response. + * @summary Readiness endpoint that checks system resources, Redis, Queue, and plugins. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof HealthApi + */ + public readiness(options?: RawAxiosRequestConfig) { + return HealthApiFp(this.configuration).readiness(options).then((request) => request(this.axios, this.basePath)); + } } diff --git a/src/apis/metrics-api.ts b/src/apis/metrics-api.ts index 9db8dec0..89164b24 100644 --- a/src/apis/metrics-api.ts +++ b/src/apis/metrics-api.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/apis/networks-api.ts b/src/apis/networks-api.ts new file mode 100644 index 00000000..379cdd11 --- /dev/null +++ b/src/apis/networks-api.ts @@ -0,0 +1,305 @@ +/* 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. + */ + + +import type { Configuration } from '../configuration'; +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; +// Some imports not used depending on template conditions +// @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common'; +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base'; +// @ts-ignore +import type { ApiResponseNetworkResponse } from '../models'; +// @ts-ignore +import type { ApiResponseString } from '../models'; +// @ts-ignore +import type { ApiResponseVecNetworkResponse } from '../models'; +// @ts-ignore +import type { UpdateNetworkRequest } from '../models'; +/** + * NetworksApi - axios parameter creator + * @export + */ +export const NetworksApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * + * @summary Retrieves details of a specific network by ID. + * @param {string} networkId Network ID (e.g., evm:sepolia, solana:mainnet) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getNetwork: async (networkId: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'networkId' is not null or undefined + assertParamExists('getNetwork', 'networkId', networkId) + const localVarPath = `/api/v1/networks/{network_id}` + .replace(`{${"network_id"}}`, encodeURIComponent(String(networkId))); + // 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 = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication bearer_auth required + // http bearer authentication required + await setBearerAuthToObject(localVarHeaderParameter, configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...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 networks with pagination support. + * @summary Network 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} + */ + listNetworks: async (page?: number, perPage?: number, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/v1/networks`; + // 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 = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication bearer_auth required + // http bearer authentication required + await 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 = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Updates a network\'s configuration. Currently supports updating RPC URLs only. Can be extended to support other fields. + * @param {string} networkId Network ID (e.g., evm:sepolia, solana:mainnet) + * @param {UpdateNetworkRequest} updateNetworkRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateNetwork: async (networkId: string, updateNetworkRequest: UpdateNetworkRequest, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'networkId' is not null or undefined + assertParamExists('updateNetwork', 'networkId', networkId) + // verify required parameter 'updateNetworkRequest' is not null or undefined + assertParamExists('updateNetwork', 'updateNetworkRequest', updateNetworkRequest) + const localVarPath = `/api/v1/networks/{network_id}` + .replace(`{${"network_id"}}`, encodeURIComponent(String(networkId))); + // 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 = { method: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication bearer_auth required + // http bearer authentication required + await setBearerAuthToObject(localVarHeaderParameter, configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(updateNetworkRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * NetworksApi - functional programming interface + * @export + */ +export const NetworksApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = NetworksApiAxiosParamCreator(configuration) + return { + /** + * + * @summary Retrieves details of a specific network by ID. + * @param {string} networkId Network ID (e.g., evm:sepolia, solana:mainnet) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getNetwork(networkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getNetwork(networkId, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NetworksApi.getNetwork']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file Lists all networks with pagination support. + * @summary Network 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} + */ + async listNetworks(page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listNetworks(page, perPage, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NetworksApi.listNetworks']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @summary Updates a network\'s configuration. Currently supports updating RPC URLs only. Can be extended to support other fields. + * @param {string} networkId Network ID (e.g., evm:sepolia, solana:mainnet) + * @param {UpdateNetworkRequest} updateNetworkRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async updateNetwork(networkId: string, updateNetworkRequest: UpdateNetworkRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateNetwork(networkId, updateNetworkRequest, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NetworksApi.updateNetwork']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * NetworksApi - factory interface + * @export + */ +export const NetworksApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = NetworksApiFp(configuration) + return { + /** + * + * @summary Retrieves details of a specific network by ID. + * @param {string} networkId Network ID (e.g., evm:sepolia, solana:mainnet) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getNetwork(networkId: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getNetwork(networkId, options).then((request) => request(axios, basePath)); + }, + /** + * Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file Lists all networks with pagination support. + * @summary Network 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} + */ + listNetworks(page?: number, perPage?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.listNetworks(page, perPage, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Updates a network\'s configuration. Currently supports updating RPC URLs only. Can be extended to support other fields. + * @param {string} networkId Network ID (e.g., evm:sepolia, solana:mainnet) + * @param {UpdateNetworkRequest} updateNetworkRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateNetwork(networkId: string, updateNetworkRequest: UpdateNetworkRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateNetwork(networkId, updateNetworkRequest, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * NetworksApi - object-oriented interface + * @export + * @class NetworksApi + * @extends {BaseAPI} + */ +export class NetworksApi extends BaseAPI { + /** + * + * @summary Retrieves details of a specific network by ID. + * @param {string} networkId Network ID (e.g., evm:sepolia, solana:mainnet) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof NetworksApi + */ + public getNetwork(networkId: string, options?: RawAxiosRequestConfig) { + return NetworksApiFp(this.configuration).getNetwork(networkId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file Lists all networks with pagination support. + * @summary Network 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 NetworksApi + */ + public listNetworks(page?: number, perPage?: number, options?: RawAxiosRequestConfig) { + return NetworksApiFp(this.configuration).listNetworks(page, perPage, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Updates a network\'s configuration. Currently supports updating RPC URLs only. Can be extended to support other fields. + * @param {string} networkId Network ID (e.g., evm:sepolia, solana:mainnet) + * @param {UpdateNetworkRequest} updateNetworkRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof NetworksApi + */ + public updateNetwork(networkId: string, updateNetworkRequest: UpdateNetworkRequest, options?: RawAxiosRequestConfig) { + return NetworksApiFp(this.configuration).updateNetwork(networkId, updateNetworkRequest, options).then((request) => request(this.axios, this.basePath)); + } +} + diff --git a/src/apis/notifications-api.ts b/src/apis/notifications-api.ts index 791a14d6..c0830749 100644 --- a/src/apis/notifications-api.ts +++ b/src/apis/notifications-api.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/apis/plugins-api.ts b/src/apis/plugins-api.ts index f8f25e55..888f03ee 100644 --- a/src/apis/plugins-api.ts +++ b/src/apis/plugins-api.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -22,13 +22,19 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base'; // @ts-ignore +import type { ApiResponsePaginatedResultPluginModel } from '../models'; +// @ts-ignore import type { ApiResponsePluginHandlerError } from '../models'; // @ts-ignore +import type { ApiResponsePluginModel } from '../models'; +// @ts-ignore import type { ApiResponseString } from '../models'; // @ts-ignore import type { ApiResponseValue } from '../models'; // @ts-ignore import type { PluginCallRequest } from '../models'; +// @ts-ignore +import type { UpdatePluginRequest } from '../models'; /** * PluginsApi - axios parameter creator * @export @@ -36,14 +42,15 @@ import type { PluginCallRequest } from '../models'; export const PluginsApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Logs and traces are only returned when the plugin is configured with `emit_logs` / `emit_traces`. Plugin-provided errors are normalized into a consistent payload (`code`, `details`) and a derived message so downstream clients receive a stable shape regardless of how the handler threw. - * @summary Execute a plugin and receive the sanitized result + * Logs and traces are only returned when the plugin is configured with `emit_logs` / `emit_traces`. Plugin-provided errors are normalized into a consistent payload (`code`, `details`) and a derived message so downstream clients receive a stable shape regardless of how the handler threw. The endpoint supports wildcard route routing, allowing plugins to implement custom routing logic: - `/api/v1/plugins/{plugin_id}/call` - Default endpoint (route = \"\") - `/api/v1/plugins/{plugin_id}/call?route=/verify` - Custom route via query parameter - `/api/v1/plugins/{plugin_id}/call/verify` - Custom route via URL path (route = \"/verify\") The route is passed to the plugin handler via the `context.route` field. You can specify a custom route either by appending it to the URL path or by using the `route` query parameter. + * @summary Execute a plugin with optional wildcard route routing * @param {string} pluginId The unique identifier of the plugin * @param {PluginCallRequest} pluginCallRequest + * @param {string} [route] Optional route suffix for custom routing (e.g., \'/verify\'). Alternative to appending the route to the URL path. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - callPlugin: async (pluginId: string, pluginCallRequest: PluginCallRequest, options: RawAxiosRequestConfig = {}): Promise => { + callPlugin: async (pluginId: string, pluginCallRequest: PluginCallRequest, route?: string, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'pluginId' is not null or undefined assertParamExists('callPlugin', 'pluginId', pluginId) // verify required parameter 'pluginCallRequest' is not null or undefined @@ -65,6 +72,10 @@ export const PluginsApiAxiosParamCreator = function (configuration?: Configurati // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) + if (route !== undefined) { + localVarQueryParameter['route'] = route; + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -74,6 +85,175 @@ export const PluginsApiAxiosParamCreator = function (configuration?: Configurati localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; localVarRequestOptions.data = serializeDataIfNeeded(pluginCallRequest, localVarRequestOptions, configuration) + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * This endpoint is disabled by default. To enable it for a given plugin, set `allow_get_invocation: true` in the plugin configuration. When invoked via GET: - `params` is an empty object (`{}`) - query parameters are passed to the plugin handler via `context.query` - wildcard route routing is supported the same way as POST (see `doc_call_plugin`) - Use the `route` query parameter or append the route to the URL path + * @summary Execute a plugin via GET (must be enabled per plugin) + * @param {string} pluginId The unique identifier of the plugin + * @param {string} [route] Optional route suffix for custom routing (e.g., \'/verify\'). Alternative to appending the route to the URL path. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + callPluginGet: async (pluginId: string, route?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'pluginId' is not null or undefined + assertParamExists('callPluginGet', 'pluginId', pluginId) + const localVarPath = `/api/v1/plugins/{plugin_id}/call` + .replace(`{${"plugin_id"}}`, encodeURIComponent(String(pluginId))); + // 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 = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication bearer_auth required + // http bearer authentication required + await setBearerAuthToObject(localVarHeaderParameter, configuration) + + if (route !== undefined) { + localVarQueryParameter['route'] = route; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Get plugin by ID + * @param {string} pluginId The unique identifier of the plugin + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getPlugin: async (pluginId: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'pluginId' is not null or undefined + assertParamExists('getPlugin', 'pluginId', pluginId) + const localVarPath = `/api/v1/plugins/{plugin_id}` + .replace(`{${"plugin_id"}}`, encodeURIComponent(String(pluginId))); + // 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 = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication bearer_auth required + // http bearer authentication required + await setBearerAuthToObject(localVarHeaderParameter, configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary List plugins. + * @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} + */ + listPlugins: async (page?: number, perPage?: number, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/v1/plugins`; + // 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 = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication bearer_auth required + // http bearer authentication required + await 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 = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Updates mutable plugin fields such as timeout, emit_logs, emit_traces, raw_response, allow_get_invocation, config, and forward_logs. The plugin id and path cannot be changed after creation. All fields are optional - only the provided fields will be updated. To clear the `config` field, pass `\"config\": null`. + * @summary Update plugin configuration + * @param {string} pluginId The unique identifier of the plugin + * @param {UpdatePluginRequest} updatePluginRequest Plugin configuration update. All fields are optional. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updatePlugin: async (pluginId: string, updatePluginRequest: UpdatePluginRequest, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'pluginId' is not null or undefined + assertParamExists('updatePlugin', 'pluginId', pluginId) + // verify required parameter 'updatePluginRequest' is not null or undefined + assertParamExists('updatePlugin', 'updatePluginRequest', updatePluginRequest) + const localVarPath = `/api/v1/plugins/{plugin_id}` + .replace(`{${"plugin_id"}}`, encodeURIComponent(String(pluginId))); + // 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 = { method: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication bearer_auth required + // http bearer authentication required + await setBearerAuthToObject(localVarHeaderParameter, configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(updatePluginRequest, localVarRequestOptions, configuration) + return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, @@ -90,19 +270,75 @@ export const PluginsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = PluginsApiAxiosParamCreator(configuration) return { /** - * Logs and traces are only returned when the plugin is configured with `emit_logs` / `emit_traces`. Plugin-provided errors are normalized into a consistent payload (`code`, `details`) and a derived message so downstream clients receive a stable shape regardless of how the handler threw. - * @summary Execute a plugin and receive the sanitized result + * Logs and traces are only returned when the plugin is configured with `emit_logs` / `emit_traces`. Plugin-provided errors are normalized into a consistent payload (`code`, `details`) and a derived message so downstream clients receive a stable shape regardless of how the handler threw. The endpoint supports wildcard route routing, allowing plugins to implement custom routing logic: - `/api/v1/plugins/{plugin_id}/call` - Default endpoint (route = \"\") - `/api/v1/plugins/{plugin_id}/call?route=/verify` - Custom route via query parameter - `/api/v1/plugins/{plugin_id}/call/verify` - Custom route via URL path (route = \"/verify\") The route is passed to the plugin handler via the `context.route` field. You can specify a custom route either by appending it to the URL path or by using the `route` query parameter. + * @summary Execute a plugin with optional wildcard route routing * @param {string} pluginId The unique identifier of the plugin * @param {PluginCallRequest} pluginCallRequest + * @param {string} [route] Optional route suffix for custom routing (e.g., \'/verify\'). Alternative to appending the route to the URL path. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async callPlugin(pluginId: string, pluginCallRequest: PluginCallRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.callPlugin(pluginId, pluginCallRequest, options); + async callPlugin(pluginId: string, pluginCallRequest: PluginCallRequest, route?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.callPlugin(pluginId, pluginCallRequest, route, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['PluginsApi.callPlugin']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * This endpoint is disabled by default. To enable it for a given plugin, set `allow_get_invocation: true` in the plugin configuration. When invoked via GET: - `params` is an empty object (`{}`) - query parameters are passed to the plugin handler via `context.query` - wildcard route routing is supported the same way as POST (see `doc_call_plugin`) - Use the `route` query parameter or append the route to the URL path + * @summary Execute a plugin via GET (must be enabled per plugin) + * @param {string} pluginId The unique identifier of the plugin + * @param {string} [route] Optional route suffix for custom routing (e.g., \'/verify\'). Alternative to appending the route to the URL path. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async callPluginGet(pluginId: string, route?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.callPluginGet(pluginId, route, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PluginsApi.callPluginGet']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @summary Get plugin by ID + * @param {string} pluginId The unique identifier of the plugin + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getPlugin(pluginId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPlugin(pluginId, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PluginsApi.getPlugin']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @summary List plugins. + * @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} + */ + async listPlugins(page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listPlugins(page, perPage, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PluginsApi.listPlugins']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Updates mutable plugin fields such as timeout, emit_logs, emit_traces, raw_response, allow_get_invocation, config, and forward_logs. The plugin id and path cannot be changed after creation. All fields are optional - only the provided fields will be updated. To clear the `config` field, pass `\"config\": null`. + * @summary Update plugin configuration + * @param {string} pluginId The unique identifier of the plugin + * @param {UpdatePluginRequest} updatePluginRequest Plugin configuration update. All fields are optional. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async updatePlugin(pluginId: string, updatePluginRequest: UpdatePluginRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updatePlugin(pluginId, updatePluginRequest, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PluginsApi.updatePlugin']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, } }; @@ -114,15 +350,59 @@ export const PluginsApiFactory = function (configuration?: Configuration, basePa const localVarFp = PluginsApiFp(configuration) return { /** - * Logs and traces are only returned when the plugin is configured with `emit_logs` / `emit_traces`. Plugin-provided errors are normalized into a consistent payload (`code`, `details`) and a derived message so downstream clients receive a stable shape regardless of how the handler threw. - * @summary Execute a plugin and receive the sanitized result + * Logs and traces are only returned when the plugin is configured with `emit_logs` / `emit_traces`. Plugin-provided errors are normalized into a consistent payload (`code`, `details`) and a derived message so downstream clients receive a stable shape regardless of how the handler threw. The endpoint supports wildcard route routing, allowing plugins to implement custom routing logic: - `/api/v1/plugins/{plugin_id}/call` - Default endpoint (route = \"\") - `/api/v1/plugins/{plugin_id}/call?route=/verify` - Custom route via query parameter - `/api/v1/plugins/{plugin_id}/call/verify` - Custom route via URL path (route = \"/verify\") The route is passed to the plugin handler via the `context.route` field. You can specify a custom route either by appending it to the URL path or by using the `route` query parameter. + * @summary Execute a plugin with optional wildcard route routing * @param {string} pluginId The unique identifier of the plugin * @param {PluginCallRequest} pluginCallRequest + * @param {string} [route] Optional route suffix for custom routing (e.g., \'/verify\'). Alternative to appending the route to the URL path. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + callPlugin(pluginId: string, pluginCallRequest: PluginCallRequest, route?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.callPlugin(pluginId, pluginCallRequest, route, options).then((request) => request(axios, basePath)); + }, + /** + * This endpoint is disabled by default. To enable it for a given plugin, set `allow_get_invocation: true` in the plugin configuration. When invoked via GET: - `params` is an empty object (`{}`) - query parameters are passed to the plugin handler via `context.query` - wildcard route routing is supported the same way as POST (see `doc_call_plugin`) - Use the `route` query parameter or append the route to the URL path + * @summary Execute a plugin via GET (must be enabled per plugin) + * @param {string} pluginId The unique identifier of the plugin + * @param {string} [route] Optional route suffix for custom routing (e.g., \'/verify\'). Alternative to appending the route to the URL path. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + callPluginGet(pluginId: string, route?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.callPluginGet(pluginId, route, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Get plugin by ID + * @param {string} pluginId The unique identifier of the plugin * @param {*} [options] Override http request option. * @throws {RequiredError} */ - callPlugin(pluginId: string, pluginCallRequest: PluginCallRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.callPlugin(pluginId, pluginCallRequest, options).then((request) => request(axios, basePath)); + getPlugin(pluginId: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getPlugin(pluginId, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary List plugins. + * @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} + */ + listPlugins(page?: number, perPage?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.listPlugins(page, perPage, options).then((request) => request(axios, basePath)); + }, + /** + * Updates mutable plugin fields such as timeout, emit_logs, emit_traces, raw_response, allow_get_invocation, config, and forward_logs. The plugin id and path cannot be changed after creation. All fields are optional - only the provided fields will be updated. To clear the `config` field, pass `\"config\": null`. + * @summary Update plugin configuration + * @param {string} pluginId The unique identifier of the plugin + * @param {UpdatePluginRequest} updatePluginRequest Plugin configuration update. All fields are optional. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updatePlugin(pluginId: string, updatePluginRequest: UpdatePluginRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updatePlugin(pluginId, updatePluginRequest, options).then((request) => request(axios, basePath)); }, }; }; @@ -135,16 +415,68 @@ export const PluginsApiFactory = function (configuration?: Configuration, basePa */ export class PluginsApi extends BaseAPI { /** - * Logs and traces are only returned when the plugin is configured with `emit_logs` / `emit_traces`. Plugin-provided errors are normalized into a consistent payload (`code`, `details`) and a derived message so downstream clients receive a stable shape regardless of how the handler threw. - * @summary Execute a plugin and receive the sanitized result + * Logs and traces are only returned when the plugin is configured with `emit_logs` / `emit_traces`. Plugin-provided errors are normalized into a consistent payload (`code`, `details`) and a derived message so downstream clients receive a stable shape regardless of how the handler threw. The endpoint supports wildcard route routing, allowing plugins to implement custom routing logic: - `/api/v1/plugins/{plugin_id}/call` - Default endpoint (route = \"\") - `/api/v1/plugins/{plugin_id}/call?route=/verify` - Custom route via query parameter - `/api/v1/plugins/{plugin_id}/call/verify` - Custom route via URL path (route = \"/verify\") The route is passed to the plugin handler via the `context.route` field. You can specify a custom route either by appending it to the URL path or by using the `route` query parameter. + * @summary Execute a plugin with optional wildcard route routing * @param {string} pluginId The unique identifier of the plugin * @param {PluginCallRequest} pluginCallRequest + * @param {string} [route] Optional route suffix for custom routing (e.g., \'/verify\'). Alternative to appending the route to the URL path. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PluginsApi + */ + public callPlugin(pluginId: string, pluginCallRequest: PluginCallRequest, route?: string, options?: RawAxiosRequestConfig) { + return PluginsApiFp(this.configuration).callPlugin(pluginId, pluginCallRequest, route, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint is disabled by default. To enable it for a given plugin, set `allow_get_invocation: true` in the plugin configuration. When invoked via GET: - `params` is an empty object (`{}`) - query parameters are passed to the plugin handler via `context.query` - wildcard route routing is supported the same way as POST (see `doc_call_plugin`) - Use the `route` query parameter or append the route to the URL path + * @summary Execute a plugin via GET (must be enabled per plugin) + * @param {string} pluginId The unique identifier of the plugin + * @param {string} [route] Optional route suffix for custom routing (e.g., \'/verify\'). Alternative to appending the route to the URL path. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PluginsApi + */ + public callPluginGet(pluginId: string, route?: string, options?: RawAxiosRequestConfig) { + return PluginsApiFp(this.configuration).callPluginGet(pluginId, route, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Get plugin by ID + * @param {string} pluginId The unique identifier of the plugin + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PluginsApi + */ + public getPlugin(pluginId: string, options?: RawAxiosRequestConfig) { + return PluginsApiFp(this.configuration).getPlugin(pluginId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary List plugins. + * @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 PluginsApi + */ + public listPlugins(page?: number, perPage?: number, options?: RawAxiosRequestConfig) { + return PluginsApiFp(this.configuration).listPlugins(page, perPage, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Updates mutable plugin fields such as timeout, emit_logs, emit_traces, raw_response, allow_get_invocation, config, and forward_logs. The plugin id and path cannot be changed after creation. All fields are optional - only the provided fields will be updated. To clear the `config` field, pass `\"config\": null`. + * @summary Update plugin configuration + * @param {string} pluginId The unique identifier of the plugin + * @param {UpdatePluginRequest} updatePluginRequest Plugin configuration update. All fields are optional. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PluginsApi */ - public callPlugin(pluginId: string, pluginCallRequest: PluginCallRequest, options?: RawAxiosRequestConfig) { - return PluginsApiFp(this.configuration).callPlugin(pluginId, pluginCallRequest, options).then((request) => request(this.axios, this.basePath)); + public updatePlugin(pluginId: string, updatePluginRequest: UpdatePluginRequest, options?: RawAxiosRequestConfig) { + return PluginsApiFp(this.configuration).updatePlugin(pluginId, updatePluginRequest, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/apis/relayers-api.ts b/src/apis/relayers-api.ts index e2e5d0f6..176391cd 100644 --- a/src/apis/relayers-api.ts +++ b/src/apis/relayers-api.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/apis/signers-api.ts b/src/apis/signers-api.ts index 59f40663..ead208f7 100644 --- a/src/apis/signers-api.ts +++ b/src/apis/signers-api.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/base.ts b/src/base.ts index 2c06a2c7..fedf625e 100644 --- a/src/base.ts +++ b/src/base.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/common.ts b/src/common.ts index 83f53d58..1f460307 100644 --- a/src/common.ts +++ b/src/common.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/configuration.ts b/src/configuration.ts index 2a560dfc..a90f1bf3 100644 --- a/src/configuration.ts +++ b/src/configuration.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/index.ts b/src/index.ts index 92c9b600..fe939dfe 100644 --- a/src/index.ts +++ b/src/index.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-balance-response-data.ts b/src/models/api-response-balance-response-data.ts index ccb995dd..bde81dfc 100644 --- a/src/models/api-response-balance-response-data.ts +++ b/src/models/api-response-balance-response-data.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-balance-response.ts b/src/models/api-response-balance-response.ts index dfa0ae90..8101a526 100644 --- a/src/models/api-response-balance-response.ts +++ b/src/models/api-response-balance-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-delete-pending-transactions-response-data.ts b/src/models/api-response-delete-pending-transactions-response-data.ts index 024654eb..76d077ee 100644 --- a/src/models/api-response-delete-pending-transactions-response-data.ts +++ b/src/models/api-response-delete-pending-transactions-response-data.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-delete-pending-transactions-response.ts b/src/models/api-response-delete-pending-transactions-response.ts index 361b7c48..99c6874a 100644 --- a/src/models/api-response-delete-pending-transactions-response.ts +++ b/src/models/api-response-delete-pending-transactions-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-network-response-data.ts b/src/models/api-response-network-response-data.ts new file mode 100644 index 00000000..3e6096a6 --- /dev/null +++ b/src/models/api-response-network-response-data.ts @@ -0,0 +1,116 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { RelayerNetworkType } from './relayer-network-type'; +// May contain unused imports in some cases +// @ts-ignore +import type { RpcConfig } from './rpc-config'; + +/** + * Network response model for API endpoints. This flattens the internal NetworkRepoModel structure for API responses, making network-type-specific fields available at the top level. + * @export + * @interface ApiResponseNetworkResponseData + */ +export interface ApiResponseNetworkResponseData { + /** + * Estimated average time between blocks in milliseconds + * @type {number} + * @memberof ApiResponseNetworkResponseData + */ + 'average_blocktime_ms'?: number; + /** + * EVM-specific: Chain ID + * @type {number} + * @memberof ApiResponseNetworkResponseData + */ + 'chain_id'?: number; + /** + * List of Explorer endpoint URLs + * @type {Array} + * @memberof ApiResponseNetworkResponseData + */ + 'explorer_urls'?: Array; + /** + * EVM-specific: Network features (e.g., \"eip1559\") + * @type {Array} + * @memberof ApiResponseNetworkResponseData + */ + 'features'?: Array; + /** + * Stellar-specific: Horizon URL + * @type {string} + * @memberof ApiResponseNetworkResponseData + */ + 'horizon_url'?: string; + /** + * Unique identifier composed of network_type and name, e.g., \"evm:mainnet\" + * @type {string} + * @memberof ApiResponseNetworkResponseData + */ + 'id': string; + /** + * Flag indicating if the network is a testnet + * @type {boolean} + * @memberof ApiResponseNetworkResponseData + */ + 'is_testnet'?: boolean; + /** + * Name of the network (e.g., \"mainnet\", \"sepolia\") + * @type {string} + * @memberof ApiResponseNetworkResponseData + */ + 'name': string; + /** + * Type of the network (EVM, Solana, Stellar) + * @type {RelayerNetworkType} + * @memberof ApiResponseNetworkResponseData + */ + 'network_type': RelayerNetworkType; + /** + * Stellar-specific: Network passphrase + * @type {string} + * @memberof ApiResponseNetworkResponseData + */ + 'passphrase'?: string; + /** + * EVM-specific: Required confirmations + * @type {number} + * @memberof ApiResponseNetworkResponseData + */ + 'required_confirmations'?: number; + /** + * List of RPC endpoint configurations + * @type {Array} + * @memberof ApiResponseNetworkResponseData + */ + 'rpc_urls'?: Array; + /** + * EVM-specific: Native token symbol + * @type {string} + * @memberof ApiResponseNetworkResponseData + */ + 'symbol'?: string; + /** + * List of arbitrary tags for categorizing or filtering networks + * @type {Array} + * @memberof ApiResponseNetworkResponseData + */ + 'tags'?: Array; +} + + + diff --git a/src/models/api-response-network-response.ts b/src/models/api-response-network-response.ts new file mode 100644 index 00000000..7e76409c --- /dev/null +++ b/src/models/api-response-network-response.ts @@ -0,0 +1,63 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { ApiResponseNetworkResponseData } from './api-response-network-response-data'; +// May contain unused imports in some cases +// @ts-ignore +import type { PaginationMeta } from './pagination-meta'; +// May contain unused imports in some cases +// @ts-ignore +import type { PluginMetadata } from './plugin-metadata'; + +/** + * + * @export + * @interface ApiResponseNetworkResponse + */ +export interface ApiResponseNetworkResponse { + /** + * + * @type {ApiResponseNetworkResponseData} + * @memberof ApiResponseNetworkResponse + */ + 'data'?: ApiResponseNetworkResponseData; + /** + * + * @type {string} + * @memberof ApiResponseNetworkResponse + */ + 'error'?: string; + /** + * + * @type {PluginMetadata} + * @memberof ApiResponseNetworkResponse + */ + 'metadata'?: PluginMetadata; + /** + * + * @type {PaginationMeta} + * @memberof ApiResponseNetworkResponse + */ + 'pagination'?: PaginationMeta; + /** + * + * @type {boolean} + * @memberof ApiResponseNetworkResponse + */ + 'success': boolean; +} + diff --git a/src/models/api-response-notification-response-data.ts b/src/models/api-response-notification-response-data.ts index 0678bfb7..07a2b22f 100644 --- a/src/models/api-response-notification-response-data.ts +++ b/src/models/api-response-notification-response-data.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-notification-response.ts b/src/models/api-response-notification-response.ts index ffedb88b..b41b420b 100644 --- a/src/models/api-response-notification-response.ts +++ b/src/models/api-response-notification-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-paginated-result-plugin-model-data-items-inner.ts b/src/models/api-response-paginated-result-plugin-model-data-items-inner.ts new file mode 100644 index 00000000..66a436f6 --- /dev/null +++ b/src/models/api-response-paginated-result-plugin-model-data-items-inner.ts @@ -0,0 +1,78 @@ +/* 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. + */ + + + +/** + * + * @export + * @interface ApiResponsePaginatedResultPluginModelDataItemsInner + */ +export interface ApiResponsePaginatedResultPluginModelDataItemsInner { + /** + * Whether to allow GET requests to invoke plugin logic + * @type {boolean} + * @memberof ApiResponsePaginatedResultPluginModelDataItemsInner + */ + 'allow_get_invocation'?: boolean; + /** + * User-defined configuration accessible to the plugin (must be a JSON object) + * @type {{ [key: string]: any; }} + * @memberof ApiResponsePaginatedResultPluginModelDataItemsInner + */ + 'config'?: { [key: string]: any; }; + /** + * Whether to include logs in the HTTP response + * @type {boolean} + * @memberof ApiResponsePaginatedResultPluginModelDataItemsInner + */ + 'emit_logs'?: boolean; + /** + * Whether to include traces in the HTTP response + * @type {boolean} + * @memberof ApiResponsePaginatedResultPluginModelDataItemsInner + */ + 'emit_traces'?: boolean; + /** + * Whether to forward plugin logs into the relayer\'s tracing output + * @type {boolean} + * @memberof ApiResponsePaginatedResultPluginModelDataItemsInner + */ + 'forward_logs'?: boolean; + /** + * Plugin ID + * @type {string} + * @memberof ApiResponsePaginatedResultPluginModelDataItemsInner + */ + 'id': string; + /** + * Plugin path + * @type {string} + * @memberof ApiResponsePaginatedResultPluginModelDataItemsInner + */ + 'path': string; + /** + * Whether to return raw plugin response without ApiResponse wrapper + * @type {boolean} + * @memberof ApiResponsePaginatedResultPluginModelDataItemsInner + */ + 'raw_response'?: boolean; + /** + * Plugin timeout + * @type {number} + * @memberof ApiResponsePaginatedResultPluginModelDataItemsInner + */ + 'timeout': number; +} + diff --git a/src/models/api-response-paginated-result-plugin-model-data.ts b/src/models/api-response-paginated-result-plugin-model-data.ts new file mode 100644 index 00000000..5db21687 --- /dev/null +++ b/src/models/api-response-paginated-result-plugin-model-data.ts @@ -0,0 +1,51 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { ApiResponsePaginatedResultPluginModelDataItemsInner } from './api-response-paginated-result-plugin-model-data-items-inner'; + +/** + * + * @export + * @interface ApiResponsePaginatedResultPluginModelData + */ +export interface ApiResponsePaginatedResultPluginModelData { + /** + * + * @type {Array} + * @memberof ApiResponsePaginatedResultPluginModelData + */ + 'items': Array; + /** + * + * @type {number} + * @memberof ApiResponsePaginatedResultPluginModelData + */ + 'page': number; + /** + * + * @type {number} + * @memberof ApiResponsePaginatedResultPluginModelData + */ + 'per_page': number; + /** + * + * @type {number} + * @memberof ApiResponsePaginatedResultPluginModelData + */ + 'total': number; +} + diff --git a/src/models/api-response-paginated-result-plugin-model.ts b/src/models/api-response-paginated-result-plugin-model.ts new file mode 100644 index 00000000..609572f0 --- /dev/null +++ b/src/models/api-response-paginated-result-plugin-model.ts @@ -0,0 +1,63 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { ApiResponsePaginatedResultPluginModelData } from './api-response-paginated-result-plugin-model-data'; +// May contain unused imports in some cases +// @ts-ignore +import type { PaginationMeta } from './pagination-meta'; +// May contain unused imports in some cases +// @ts-ignore +import type { PluginMetadata } from './plugin-metadata'; + +/** + * + * @export + * @interface ApiResponsePaginatedResultPluginModel + */ +export interface ApiResponsePaginatedResultPluginModel { + /** + * + * @type {ApiResponsePaginatedResultPluginModelData} + * @memberof ApiResponsePaginatedResultPluginModel + */ + 'data'?: ApiResponsePaginatedResultPluginModelData; + /** + * + * @type {string} + * @memberof ApiResponsePaginatedResultPluginModel + */ + 'error'?: string; + /** + * + * @type {PluginMetadata} + * @memberof ApiResponsePaginatedResultPluginModel + */ + 'metadata'?: PluginMetadata; + /** + * + * @type {PaginationMeta} + * @memberof ApiResponsePaginatedResultPluginModel + */ + 'pagination'?: PaginationMeta; + /** + * + * @type {boolean} + * @memberof ApiResponsePaginatedResultPluginModel + */ + 'success': boolean; +} + diff --git a/src/models/api-response-plugin-handler-error-data.ts b/src/models/api-response-plugin-handler-error-data.ts index 9464a8b2..ba0d80e8 100644 --- a/src/models/api-response-plugin-handler-error-data.ts +++ b/src/models/api-response-plugin-handler-error-data.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-plugin-handler-error.ts b/src/models/api-response-plugin-handler-error.ts index c40e3602..b97c7249 100644 --- a/src/models/api-response-plugin-handler-error.ts +++ b/src/models/api-response-plugin-handler-error.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-plugin-model.ts b/src/models/api-response-plugin-model.ts new file mode 100644 index 00000000..60f7cab7 --- /dev/null +++ b/src/models/api-response-plugin-model.ts @@ -0,0 +1,63 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { ApiResponsePaginatedResultPluginModelDataItemsInner } from './api-response-paginated-result-plugin-model-data-items-inner'; +// May contain unused imports in some cases +// @ts-ignore +import type { PaginationMeta } from './pagination-meta'; +// May contain unused imports in some cases +// @ts-ignore +import type { PluginMetadata } from './plugin-metadata'; + +/** + * + * @export + * @interface ApiResponsePluginModel + */ +export interface ApiResponsePluginModel { + /** + * + * @type {ApiResponsePaginatedResultPluginModelDataItemsInner} + * @memberof ApiResponsePluginModel + */ + 'data'?: ApiResponsePaginatedResultPluginModelDataItemsInner; + /** + * + * @type {string} + * @memberof ApiResponsePluginModel + */ + 'error'?: string; + /** + * + * @type {PluginMetadata} + * @memberof ApiResponsePluginModel + */ + 'metadata'?: PluginMetadata; + /** + * + * @type {PaginationMeta} + * @memberof ApiResponsePluginModel + */ + 'pagination'?: PaginationMeta; + /** + * + * @type {boolean} + * @memberof ApiResponsePluginModel + */ + 'success': boolean; +} + diff --git a/src/models/api-response-relayer-response-data.ts b/src/models/api-response-relayer-response-data.ts index eb36a088..cadc3b77 100644 --- a/src/models/api-response-relayer-response-data.ts +++ b/src/models/api-response-relayer-response-data.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -18,13 +18,13 @@ import type { DisabledReason } from './disabled-reason'; // May contain unused imports in some cases // @ts-ignore -import type { RelayerNetworkPolicyResponse } from './relayer-network-policy-response'; +import type { MaskedRpcConfig } from './masked-rpc-config'; // May contain unused imports in some cases // @ts-ignore -import type { RelayerNetworkType } from './relayer-network-type'; +import type { RelayerNetworkPolicyResponse } from './relayer-network-policy-response'; // May contain unused imports in some cases // @ts-ignore -import type { RpcConfig } from './rpc-config'; +import type { RelayerNetworkType } from './relayer-network-type'; /** * Relayer response model for API endpoints @@ -39,11 +39,11 @@ export interface ApiResponseRelayerResponseData { */ 'address'?: string; /** - * - * @type {Array} + * Custom RPC URLs with sensitive path/query parameters masked for security. The domain is visible to identify providers (e.g., Alchemy, Infura) but API keys embedded in paths are hidden. + * @type {Array} * @memberof ApiResponseRelayerResponseData */ - 'custom_rpc_urls'?: Array; + 'custom_rpc_urls'?: Array; /** * * @type {DisabledReason} diff --git a/src/models/api-response-relayer-response.ts b/src/models/api-response-relayer-response.ts index f62c02e7..2b3f29c2 100644 --- a/src/models/api-response-relayer-response.ts +++ b/src/models/api-response-relayer-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-relayer-status-data-one-of.ts b/src/models/api-response-relayer-status-data-one-of.ts index 7af47afc..1d562423 100644 --- a/src/models/api-response-relayer-status-data-one-of.ts +++ b/src/models/api-response-relayer-status-data-one-of.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-relayer-status-data-one-of1.ts b/src/models/api-response-relayer-status-data-one-of1.ts index e1bf7ef5..f15375cc 100644 --- a/src/models/api-response-relayer-status-data-one-of1.ts +++ b/src/models/api-response-relayer-status-data-one-of1.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-relayer-status-data-one-of2.ts b/src/models/api-response-relayer-status-data-one-of2.ts index bb951e79..5799fda1 100644 --- a/src/models/api-response-relayer-status-data-one-of2.ts +++ b/src/models/api-response-relayer-status-data-one-of2.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-relayer-status-data.ts b/src/models/api-response-relayer-status-data.ts index ec007c33..13abd449 100644 --- a/src/models/api-response-relayer-status-data.ts +++ b/src/models/api-response-relayer-status-data.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-relayer-status.ts b/src/models/api-response-relayer-status.ts index f1ac0e88..96406ce7 100644 --- a/src/models/api-response-relayer-status.ts +++ b/src/models/api-response-relayer-status.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-sign-data-response-data.ts b/src/models/api-response-sign-data-response-data.ts index 8a718838..e6d6672a 100644 --- a/src/models/api-response-sign-data-response-data.ts +++ b/src/models/api-response-sign-data-response-data.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-sign-data-response.ts b/src/models/api-response-sign-data-response.ts index 17dce54c..c0dd0bfa 100644 --- a/src/models/api-response-sign-data-response.ts +++ b/src/models/api-response-sign-data-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-sign-transaction-response-data.ts b/src/models/api-response-sign-transaction-response-data.ts index b9752dd6..d983231e 100644 --- a/src/models/api-response-sign-transaction-response-data.ts +++ b/src/models/api-response-sign-transaction-response-data.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-sign-transaction-response.ts b/src/models/api-response-sign-transaction-response.ts index 7029124c..93c32e4d 100644 --- a/src/models/api-response-sign-transaction-response.ts +++ b/src/models/api-response-sign-transaction-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-signer-response-data.ts b/src/models/api-response-signer-response-data.ts index 33e78517..119264fe 100644 --- a/src/models/api-response-signer-response-data.ts +++ b/src/models/api-response-signer-response-data.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-signer-response.ts b/src/models/api-response-signer-response.ts index 9b80d224..e4e6ea4b 100644 --- a/src/models/api-response-signer-response.ts +++ b/src/models/api-response-signer-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-sponsored-transaction-build-response-data.ts b/src/models/api-response-sponsored-transaction-build-response-data.ts index bbf58aef..2ac71213 100644 --- a/src/models/api-response-sponsored-transaction-build-response-data.ts +++ b/src/models/api-response-sponsored-transaction-build-response-data.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-sponsored-transaction-build-response.ts b/src/models/api-response-sponsored-transaction-build-response.ts index 4f2836c3..701381f2 100644 --- a/src/models/api-response-sponsored-transaction-build-response.ts +++ b/src/models/api-response-sponsored-transaction-build-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-sponsored-transaction-quote-response-data.ts b/src/models/api-response-sponsored-transaction-quote-response-data.ts index d33cb103..3fa80226 100644 --- a/src/models/api-response-sponsored-transaction-quote-response-data.ts +++ b/src/models/api-response-sponsored-transaction-quote-response-data.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-sponsored-transaction-quote-response.ts b/src/models/api-response-sponsored-transaction-quote-response.ts index ccdb2241..606e85a2 100644 --- a/src/models/api-response-sponsored-transaction-quote-response.ts +++ b/src/models/api-response-sponsored-transaction-quote-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-string.ts b/src/models/api-response-string.ts index 4a2935a1..69eec5b9 100644 --- a/src/models/api-response-string.ts +++ b/src/models/api-response-string.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-transaction-response-data.ts b/src/models/api-response-transaction-response-data.ts index 3114c9b5..812f1527 100644 --- a/src/models/api-response-transaction-response-data.ts +++ b/src/models/api-response-transaction-response-data.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-transaction-response.ts b/src/models/api-response-transaction-response.ts index dd4c172f..766e30c4 100644 --- a/src/models/api-response-transaction-response.ts +++ b/src/models/api-response-transaction-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-value.ts b/src/models/api-response-value.ts index 33b22c25..576919cd 100644 --- a/src/models/api-response-value.ts +++ b/src/models/api-response-value.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-vec-network-response.ts b/src/models/api-response-vec-network-response.ts new file mode 100644 index 00000000..2d0df030 --- /dev/null +++ b/src/models/api-response-vec-network-response.ts @@ -0,0 +1,63 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { ApiResponseNetworkResponseData } from './api-response-network-response-data'; +// May contain unused imports in some cases +// @ts-ignore +import type { PaginationMeta } from './pagination-meta'; +// May contain unused imports in some cases +// @ts-ignore +import type { PluginMetadata } from './plugin-metadata'; + +/** + * + * @export + * @interface ApiResponseVecNetworkResponse + */ +export interface ApiResponseVecNetworkResponse { + /** + * + * @type {Array} + * @memberof ApiResponseVecNetworkResponse + */ + 'data'?: Array; + /** + * + * @type {string} + * @memberof ApiResponseVecNetworkResponse + */ + 'error'?: string; + /** + * + * @type {PluginMetadata} + * @memberof ApiResponseVecNetworkResponse + */ + 'metadata'?: PluginMetadata; + /** + * + * @type {PaginationMeta} + * @memberof ApiResponseVecNetworkResponse + */ + 'pagination'?: PaginationMeta; + /** + * + * @type {boolean} + * @memberof ApiResponseVecNetworkResponse + */ + 'success': boolean; +} + diff --git a/src/models/api-response-vec-notification-response.ts b/src/models/api-response-vec-notification-response.ts index 27942acd..f0584ead 100644 --- a/src/models/api-response-vec-notification-response.ts +++ b/src/models/api-response-vec-notification-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-vec-relayer-response.ts b/src/models/api-response-vec-relayer-response.ts index 099fef50..be86c5c2 100644 --- a/src/models/api-response-vec-relayer-response.ts +++ b/src/models/api-response-vec-relayer-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-vec-signer-response.ts b/src/models/api-response-vec-signer-response.ts index 50d671df..ee830b29 100644 --- a/src/models/api-response-vec-signer-response.ts +++ b/src/models/api-response-vec-signer-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/api-response-vec-transaction-response.ts b/src/models/api-response-vec-transaction-response.ts index cb0df4e7..e6ceff5b 100644 --- a/src/models/api-response-vec-transaction-response.ts +++ b/src/models/api-response-vec-transaction-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/asset-spec-one-of.ts b/src/models/asset-spec-one-of.ts index 15a7e491..214e0229 100644 --- a/src/models/asset-spec-one-of.ts +++ b/src/models/asset-spec-one-of.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/asset-spec-one-of1.ts b/src/models/asset-spec-one-of1.ts index 94e3f54b..14e64076 100644 --- a/src/models/asset-spec-one-of1.ts +++ b/src/models/asset-spec-one-of1.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/asset-spec-one-of2.ts b/src/models/asset-spec-one-of2.ts index f818ddea..235ff0f7 100644 --- a/src/models/asset-spec-one-of2.ts +++ b/src/models/asset-spec-one-of2.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/asset-spec.ts b/src/models/asset-spec.ts index eaf9c24a..ef6a7abc 100644 --- a/src/models/asset-spec.ts +++ b/src/models/asset-spec.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/auth-spec-one-of.ts b/src/models/auth-spec-one-of.ts index 6076e337..bf60ed0e 100644 --- a/src/models/auth-spec-one-of.ts +++ b/src/models/auth-spec-one-of.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/auth-spec-one-of1.ts b/src/models/auth-spec-one-of1.ts index 663e99a4..1945f3fb 100644 --- a/src/models/auth-spec-one-of1.ts +++ b/src/models/auth-spec-one-of1.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/auth-spec-one-of2.ts b/src/models/auth-spec-one-of2.ts index 9c67f7e4..215a6792 100644 --- a/src/models/auth-spec-one-of2.ts +++ b/src/models/auth-spec-one-of2.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/auth-spec-one-of3.ts b/src/models/auth-spec-one-of3.ts index 6ff46528..9b06aaaf 100644 --- a/src/models/auth-spec-one-of3.ts +++ b/src/models/auth-spec-one-of3.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/auth-spec.ts b/src/models/auth-spec.ts index bf072e1d..78ef4f53 100644 --- a/src/models/auth-spec.ts +++ b/src/models/auth-spec.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/aws-kms-signer-request-config.ts b/src/models/aws-kms-signer-request-config.ts index cfa28463..2634637d 100644 --- a/src/models/aws-kms-signer-request-config.ts +++ b/src/models/aws-kms-signer-request-config.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/balance-response.ts b/src/models/balance-response.ts index cc45d32e..7b1c96b2 100644 --- a/src/models/balance-response.ts +++ b/src/models/balance-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/cdp-signer-request-config.ts b/src/models/cdp-signer-request-config.ts index 0a646467..37b3dfd8 100644 --- a/src/models/cdp-signer-request-config.ts +++ b/src/models/cdp-signer-request-config.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/component-status.ts b/src/models/component-status.ts new file mode 100644 index 00000000..dc81dff4 --- /dev/null +++ b/src/models/component-status.ts @@ -0,0 +1,30 @@ +/* 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. + */ + + + +/** + * Component health status levels. + * @export + * @enum {string} + */ + +export enum ComponentStatus { + HEALTHY = 'healthy', + DEGRADED = 'degraded', + UNHEALTHY = 'unhealthy' +} + + + diff --git a/src/models/components.ts b/src/models/components.ts new file mode 100644 index 00000000..7ecd1726 --- /dev/null +++ b/src/models/components.ts @@ -0,0 +1,60 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { PluginHealth } from './plugin-health'; +// May contain unused imports in some cases +// @ts-ignore +import type { QueueHealth } from './queue-health'; +// May contain unused imports in some cases +// @ts-ignore +import type { RedisHealth } from './redis-health'; +// May contain unused imports in some cases +// @ts-ignore +import type { SystemHealth } from './system-health'; + +/** + * All health check components. + * @export + * @interface Components + */ +export interface Components { + /** + * + * @type {PluginHealth} + * @memberof Components + */ + 'plugins'?: PluginHealth; + /** + * + * @type {QueueHealth} + * @memberof Components + */ + 'queue': QueueHealth; + /** + * + * @type {RedisHealth} + * @memberof Components + */ + 'redis': RedisHealth; + /** + * + * @type {SystemHealth} + * @memberof Components + */ + 'system': SystemHealth; +} + diff --git a/src/models/contract-source-one-of.ts b/src/models/contract-source-one-of.ts index 4a19211a..b2c1e50e 100644 --- a/src/models/contract-source-one-of.ts +++ b/src/models/contract-source-one-of.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/contract-source-one-of1.ts b/src/models/contract-source-one-of1.ts index e6acb4b3..1ec7764e 100644 --- a/src/models/contract-source-one-of1.ts +++ b/src/models/contract-source-one-of1.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/contract-source.ts b/src/models/contract-source.ts index 49f285bb..b9ab0600 100644 --- a/src/models/contract-source.ts +++ b/src/models/contract-source.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/create-relayer-policy-request.ts b/src/models/create-relayer-policy-request.ts index b788a7e2..d76ecdaf 100644 --- a/src/models/create-relayer-policy-request.ts +++ b/src/models/create-relayer-policy-request.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/create-relayer-request.ts b/src/models/create-relayer-request.ts index 0e01a158..1d6ebe20 100644 --- a/src/models/create-relayer-request.ts +++ b/src/models/create-relayer-request.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/delete-pending-transactions-response.ts b/src/models/delete-pending-transactions-response.ts index 0614ef88..2b482175 100644 --- a/src/models/delete-pending-transactions-response.ts +++ b/src/models/delete-pending-transactions-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/disabled-reason-one-of.ts b/src/models/disabled-reason-one-of.ts index 97c8bf7e..a372a5fd 100644 --- a/src/models/disabled-reason-one-of.ts +++ b/src/models/disabled-reason-one-of.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/disabled-reason-one-of1.ts b/src/models/disabled-reason-one-of1.ts index ecace548..8c1b023b 100644 --- a/src/models/disabled-reason-one-of1.ts +++ b/src/models/disabled-reason-one-of1.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/disabled-reason-one-of2.ts b/src/models/disabled-reason-one-of2.ts index 77533ee1..45da8c3f 100644 --- a/src/models/disabled-reason-one-of2.ts +++ b/src/models/disabled-reason-one-of2.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/disabled-reason-one-of3.ts b/src/models/disabled-reason-one-of3.ts index 446748da..20cc5572 100644 --- a/src/models/disabled-reason-one-of3.ts +++ b/src/models/disabled-reason-one-of3.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/disabled-reason-one-of4.ts b/src/models/disabled-reason-one-of4.ts index c7da5b4a..1831cdf7 100644 --- a/src/models/disabled-reason-one-of4.ts +++ b/src/models/disabled-reason-one-of4.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/disabled-reason.ts b/src/models/disabled-reason.ts index 952be63e..a4ba230d 100644 --- a/src/models/disabled-reason.ts +++ b/src/models/disabled-reason.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/evm-policy-response.ts b/src/models/evm-policy-response.ts index e611fbec..2558a607 100644 --- a/src/models/evm-policy-response.ts +++ b/src/models/evm-policy-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/evm-rpc-request-one-of.ts b/src/models/evm-rpc-request-one-of.ts index 986468d2..ed203e6d 100644 --- a/src/models/evm-rpc-request-one-of.ts +++ b/src/models/evm-rpc-request-one-of.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/evm-rpc-request.ts b/src/models/evm-rpc-request.ts index eb09f069..209403a0 100644 --- a/src/models/evm-rpc-request.ts +++ b/src/models/evm-rpc-request.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/evm-rpc-result.ts b/src/models/evm-rpc-result.ts index 4e25f39c..881abba9 100644 --- a/src/models/evm-rpc-result.ts +++ b/src/models/evm-rpc-result.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/evm-transaction-data-signature.ts b/src/models/evm-transaction-data-signature.ts index a894a2ce..a1bf9a62 100644 --- a/src/models/evm-transaction-data-signature.ts +++ b/src/models/evm-transaction-data-signature.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/evm-transaction-request.ts b/src/models/evm-transaction-request.ts index 3682b640..c5618bb9 100644 --- a/src/models/evm-transaction-request.ts +++ b/src/models/evm-transaction-request.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/evm-transaction-response.ts b/src/models/evm-transaction-response.ts index 623aff78..9f9c34da 100644 --- a/src/models/evm-transaction-response.ts +++ b/src/models/evm-transaction-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/get-features-enabled-result.ts b/src/models/get-features-enabled-result.ts index a16c7757..394e7a81 100644 --- a/src/models/get-features-enabled-result.ts +++ b/src/models/get-features-enabled-result.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/get-supported-tokens-item.ts b/src/models/get-supported-tokens-item.ts index 29b28f83..3c892044 100644 --- a/src/models/get-supported-tokens-item.ts +++ b/src/models/get-supported-tokens-item.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/get-supported-tokens-result.ts b/src/models/get-supported-tokens-result.ts index afe94de1..e15d9fb5 100644 --- a/src/models/get-supported-tokens-result.ts +++ b/src/models/get-supported-tokens-result.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/google-cloud-kms-signer-key-request-config.ts b/src/models/google-cloud-kms-signer-key-request-config.ts index e2f869a5..bbf492ac 100644 --- a/src/models/google-cloud-kms-signer-key-request-config.ts +++ b/src/models/google-cloud-kms-signer-key-request-config.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/google-cloud-kms-signer-key-response-config.ts b/src/models/google-cloud-kms-signer-key-response-config.ts index 9eff35f1..86c74859 100644 --- a/src/models/google-cloud-kms-signer-key-response-config.ts +++ b/src/models/google-cloud-kms-signer-key-response-config.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/google-cloud-kms-signer-request-config.ts b/src/models/google-cloud-kms-signer-request-config.ts index 285da9a6..fdb4fc63 100644 --- a/src/models/google-cloud-kms-signer-request-config.ts +++ b/src/models/google-cloud-kms-signer-request-config.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/google-cloud-kms-signer-service-account-request-config.ts b/src/models/google-cloud-kms-signer-service-account-request-config.ts index b005d195..c6474e8a 100644 --- a/src/models/google-cloud-kms-signer-service-account-request-config.ts +++ b/src/models/google-cloud-kms-signer-service-account-request-config.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/google-cloud-kms-signer-service-account-response-config.ts b/src/models/google-cloud-kms-signer-service-account-response-config.ts index 54ba9bd3..25c207d8 100644 --- a/src/models/google-cloud-kms-signer-service-account-response-config.ts +++ b/src/models/google-cloud-kms-signer-service-account-response-config.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/index.ts b/src/models/index.ts index da438244..9b2d9952 100644 --- a/src/models/index.ts +++ b/src/models/index.ts @@ -2,10 +2,16 @@ export * from './api-response-balance-response'; export * from './api-response-balance-response-data'; export * from './api-response-delete-pending-transactions-response'; export * from './api-response-delete-pending-transactions-response-data'; +export * from './api-response-network-response'; +export * from './api-response-network-response-data'; export * from './api-response-notification-response'; export * from './api-response-notification-response-data'; +export * from './api-response-paginated-result-plugin-model'; +export * from './api-response-paginated-result-plugin-model-data'; +export * from './api-response-paginated-result-plugin-model-data-items-inner'; export * from './api-response-plugin-handler-error'; export * from './api-response-plugin-handler-error-data'; +export * from './api-response-plugin-model'; export * from './api-response-relayer-response'; export * from './api-response-relayer-response-data'; export * from './api-response-relayer-status'; @@ -27,6 +33,7 @@ export * from './api-response-string'; export * from './api-response-transaction-response'; export * from './api-response-transaction-response-data'; export * from './api-response-value'; +export * from './api-response-vec-network-response'; export * from './api-response-vec-notification-response'; export * from './api-response-vec-relayer-response'; export * from './api-response-vec-signer-response'; @@ -43,6 +50,8 @@ export * from './auth-spec-one-of3'; export * from './aws-kms-signer-request-config'; export * from './balance-response'; export * from './cdp-signer-request-config'; +export * from './component-status'; +export * from './components'; export * from './contract-source'; export * from './contract-source-one-of'; export * from './contract-source-one-of1'; @@ -79,6 +88,7 @@ export * from './jupiter-swap-options'; export * from './local-signer-request-config'; export * from './log-entry'; export * from './log-level'; +export * from './masked-rpc-config'; export * from './memo-spec'; export * from './memo-spec-one-of'; export * from './memo-spec-one-of1'; @@ -86,6 +96,7 @@ export * from './memo-spec-one-of2'; export * from './memo-spec-one-of3'; export * from './memo-spec-one-of4'; export * from './network-policy-response'; +export * from './network-response'; export * from './network-rpc-request'; export * from './network-rpc-result'; export * from './network-transaction-request'; @@ -101,7 +112,13 @@ export * from './operation-spec-one-of3'; export * from './pagination-meta'; export * from './plugin-call-request'; export * from './plugin-handler-error'; +export * from './plugin-health'; export * from './plugin-metadata'; +export * from './plugin-model'; +export * from './pool-status'; +export * from './queue-health'; +export * from './readiness-response'; +export * from './redis-health'; export * from './relayer-evm-policy'; export * from './relayer-network-policy'; export * from './relayer-network-policy-one-of'; @@ -116,6 +133,7 @@ export * from './relayer-status'; export * from './relayer-stellar-policy'; export * from './relayer-stellar-swap-config'; export * from './rpc-config'; +export * from './rpc-url-entry'; export * from './sign-and-send-transaction-request-params'; export * from './sign-and-send-transaction-result'; export * from './sign-data-request'; @@ -200,11 +218,14 @@ export * from './stellar-token-kind-one-of-classic'; export * from './stellar-token-metadata'; export * from './stellar-transaction-request'; export * from './stellar-transaction-response'; +export * from './system-health'; export * from './transaction-response'; export * from './transaction-status'; export * from './transfer-transaction-request-params'; export * from './transfer-transaction-result'; export * from './turnkey-signer-request-config'; +export * from './update-network-request'; +export * from './update-plugin-request'; export * from './update-relayer-request'; export * from './vault-signer-request-config'; export * from './vault-transit-signer-request-config'; diff --git a/src/models/json-rpc-error.ts b/src/models/json-rpc-error.ts index 5ccb94e3..8ee3e3c1 100644 --- a/src/models/json-rpc-error.ts +++ b/src/models/json-rpc-error.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/json-rpc-id.ts b/src/models/json-rpc-id.ts index b37f2afe..d85e3d37 100644 --- a/src/models/json-rpc-id.ts +++ b/src/models/json-rpc-id.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/json-rpc-request-network-rpc-request.ts b/src/models/json-rpc-request-network-rpc-request.ts index 3b5089dc..00d3d12a 100644 --- a/src/models/json-rpc-request-network-rpc-request.ts +++ b/src/models/json-rpc-request-network-rpc-request.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/json-rpc-response-network-rpc-result-result.ts b/src/models/json-rpc-response-network-rpc-result-result.ts index ab82c355..c4fd64ad 100644 --- a/src/models/json-rpc-response-network-rpc-result-result.ts +++ b/src/models/json-rpc-response-network-rpc-result-result.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/json-rpc-response-network-rpc-result.ts b/src/models/json-rpc-response-network-rpc-result.ts index 04cbb2aa..20dc2235 100644 --- a/src/models/json-rpc-response-network-rpc-result.ts +++ b/src/models/json-rpc-response-network-rpc-result.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/jupiter-swap-options.ts b/src/models/jupiter-swap-options.ts index 629035b2..3d5d40fa 100644 --- a/src/models/jupiter-swap-options.ts +++ b/src/models/jupiter-swap-options.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/local-signer-request-config.ts b/src/models/local-signer-request-config.ts index 8d06fdd2..4ed94490 100644 --- a/src/models/local-signer-request-config.ts +++ b/src/models/local-signer-request-config.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/log-entry.ts b/src/models/log-entry.ts index 0f41ceaa..dcdc584c 100644 --- a/src/models/log-entry.ts +++ b/src/models/log-entry.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/log-level.ts b/src/models/log-level.ts index 9480a2ee..e11a8a3a 100644 --- a/src/models/log-level.ts +++ b/src/models/log-level.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/masked-rpc-config.ts b/src/models/masked-rpc-config.ts new file mode 100644 index 00000000..6b6cb5cc --- /dev/null +++ b/src/models/masked-rpc-config.ts @@ -0,0 +1,36 @@ +/* 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. + */ + + + +/** + * RPC configuration with masked URL for API responses. This type is used in API responses to prevent exposing sensitive API keys that are often embedded in RPC endpoint URLs (e.g., Alchemy, Infura, QuickNode). The URL path and query parameters are masked while keeping the host visible, allowing users to identify which provider is configured. + * @export + * @interface MaskedRpcConfig + */ +export interface MaskedRpcConfig { + /** + * The RPC endpoint URL with path/query masked. + * @type {string} + * @memberof MaskedRpcConfig + */ + 'url': string; + /** + * The weight of this endpoint in the weighted round-robin selection. + * @type {number} + * @memberof MaskedRpcConfig + */ + 'weight': number; +} + diff --git a/src/models/memo-spec-one-of.ts b/src/models/memo-spec-one-of.ts index c06c67e9..a904e366 100644 --- a/src/models/memo-spec-one-of.ts +++ b/src/models/memo-spec-one-of.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/memo-spec-one-of1.ts b/src/models/memo-spec-one-of1.ts index cf974e57..73329512 100644 --- a/src/models/memo-spec-one-of1.ts +++ b/src/models/memo-spec-one-of1.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/memo-spec-one-of2.ts b/src/models/memo-spec-one-of2.ts index 119f3656..9ebefb10 100644 --- a/src/models/memo-spec-one-of2.ts +++ b/src/models/memo-spec-one-of2.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/memo-spec-one-of3.ts b/src/models/memo-spec-one-of3.ts index 236a7d57..2de5a4b8 100644 --- a/src/models/memo-spec-one-of3.ts +++ b/src/models/memo-spec-one-of3.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/memo-spec-one-of4.ts b/src/models/memo-spec-one-of4.ts index 3702c4fb..00699875 100644 --- a/src/models/memo-spec-one-of4.ts +++ b/src/models/memo-spec-one-of4.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/memo-spec.ts b/src/models/memo-spec.ts index 39944389..9e95dfb8 100644 --- a/src/models/memo-spec.ts +++ b/src/models/memo-spec.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/network-policy-response.ts b/src/models/network-policy-response.ts index cf5df2c4..5a8bcadb 100644 --- a/src/models/network-policy-response.ts +++ b/src/models/network-policy-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/network-response.ts b/src/models/network-response.ts new file mode 100644 index 00000000..3fdbf900 --- /dev/null +++ b/src/models/network-response.ts @@ -0,0 +1,116 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { RelayerNetworkType } from './relayer-network-type'; +// May contain unused imports in some cases +// @ts-ignore +import type { RpcConfig } from './rpc-config'; + +/** + * Network response model for API endpoints. This flattens the internal NetworkRepoModel structure for API responses, making network-type-specific fields available at the top level. + * @export + * @interface NetworkResponse + */ +export interface NetworkResponse { + /** + * Estimated average time between blocks in milliseconds + * @type {number} + * @memberof NetworkResponse + */ + 'average_blocktime_ms'?: number; + /** + * EVM-specific: Chain ID + * @type {number} + * @memberof NetworkResponse + */ + 'chain_id'?: number; + /** + * List of Explorer endpoint URLs + * @type {Array} + * @memberof NetworkResponse + */ + 'explorer_urls'?: Array; + /** + * EVM-specific: Network features (e.g., \"eip1559\") + * @type {Array} + * @memberof NetworkResponse + */ + 'features'?: Array; + /** + * Stellar-specific: Horizon URL + * @type {string} + * @memberof NetworkResponse + */ + 'horizon_url'?: string; + /** + * Unique identifier composed of network_type and name, e.g., \"evm:mainnet\" + * @type {string} + * @memberof NetworkResponse + */ + 'id': string; + /** + * Flag indicating if the network is a testnet + * @type {boolean} + * @memberof NetworkResponse + */ + 'is_testnet'?: boolean; + /** + * Name of the network (e.g., \"mainnet\", \"sepolia\") + * @type {string} + * @memberof NetworkResponse + */ + 'name': string; + /** + * Type of the network (EVM, Solana, Stellar) + * @type {RelayerNetworkType} + * @memberof NetworkResponse + */ + 'network_type': RelayerNetworkType; + /** + * Stellar-specific: Network passphrase + * @type {string} + * @memberof NetworkResponse + */ + 'passphrase'?: string; + /** + * EVM-specific: Required confirmations + * @type {number} + * @memberof NetworkResponse + */ + 'required_confirmations'?: number; + /** + * List of RPC endpoint configurations + * @type {Array} + * @memberof NetworkResponse + */ + 'rpc_urls'?: Array; + /** + * EVM-specific: Native token symbol + * @type {string} + * @memberof NetworkResponse + */ + 'symbol'?: string; + /** + * List of arbitrary tags for categorizing or filtering networks + * @type {Array} + * @memberof NetworkResponse + */ + 'tags'?: Array; +} + + + diff --git a/src/models/network-rpc-request.ts b/src/models/network-rpc-request.ts index 30a81d07..c87590f0 100644 --- a/src/models/network-rpc-request.ts +++ b/src/models/network-rpc-request.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/network-rpc-result.ts b/src/models/network-rpc-result.ts index 37467256..ae362cc5 100644 --- a/src/models/network-rpc-result.ts +++ b/src/models/network-rpc-result.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/network-transaction-request.ts b/src/models/network-transaction-request.ts index b9697c1d..b40b5f83 100644 --- a/src/models/network-transaction-request.ts +++ b/src/models/network-transaction-request.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/notification-create-request.ts b/src/models/notification-create-request.ts index a7a22242..50fd12df 100644 --- a/src/models/notification-create-request.ts +++ b/src/models/notification-create-request.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/notification-response.ts b/src/models/notification-response.ts index 9dc889d9..eb3c09f3 100644 --- a/src/models/notification-response.ts +++ b/src/models/notification-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/notification-type.ts b/src/models/notification-type.ts index c30e0872..1c0d1ee6 100644 --- a/src/models/notification-type.ts +++ b/src/models/notification-type.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/notification-update-request.ts b/src/models/notification-update-request.ts index 98c9b954..fc68ce2c 100644 --- a/src/models/notification-update-request.ts +++ b/src/models/notification-update-request.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/operation-spec-one-of.ts b/src/models/operation-spec-one-of.ts index 992e9ea3..7e1ffa85 100644 --- a/src/models/operation-spec-one-of.ts +++ b/src/models/operation-spec-one-of.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/operation-spec-one-of1.ts b/src/models/operation-spec-one-of1.ts index 479c61ef..2666035c 100644 --- a/src/models/operation-spec-one-of1.ts +++ b/src/models/operation-spec-one-of1.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/operation-spec-one-of2.ts b/src/models/operation-spec-one-of2.ts index 927d317f..9b2d6e38 100644 --- a/src/models/operation-spec-one-of2.ts +++ b/src/models/operation-spec-one-of2.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/operation-spec-one-of3.ts b/src/models/operation-spec-one-of3.ts index 5b703d3d..8b99d67a 100644 --- a/src/models/operation-spec-one-of3.ts +++ b/src/models/operation-spec-one-of3.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/operation-spec.ts b/src/models/operation-spec.ts index eebf628d..24974f27 100644 --- a/src/models/operation-spec.ts +++ b/src/models/operation-spec.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/pagination-meta.ts b/src/models/pagination-meta.ts index b26f8bd9..33b51f70 100644 --- a/src/models/pagination-meta.ts +++ b/src/models/pagination-meta.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/plugin-api.ts b/src/models/plugin-api.ts index a3df9723..bd3aaaf0 100644 --- a/src/models/plugin-api.ts +++ b/src/models/plugin-api.ts @@ -197,7 +197,6 @@ export interface PluginContext { api: PluginAPI; kv: PluginKVStore; headers: PluginHeaders; - // eslint-disable-next-line @typescript-eslint/no-explicit-any params: any; } diff --git a/src/models/plugin-call-request.ts b/src/models/plugin-call-request.ts index 3598086f..2b68fd23 100644 --- a/src/models/plugin-call-request.ts +++ b/src/models/plugin-call-request.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -25,6 +25,6 @@ export interface PluginCallRequest { * @type {any} * @memberof PluginCallRequest */ - 'params': any; + 'params'?: any; } diff --git a/src/models/plugin-handler-error.ts b/src/models/plugin-handler-error.ts index 32d4d2d7..fb12089a 100644 --- a/src/models/plugin-handler-error.ts +++ b/src/models/plugin-handler-error.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/plugin-health.ts b/src/models/plugin-health.ts new file mode 100644 index 00000000..2402b5aa --- /dev/null +++ b/src/models/plugin-health.ts @@ -0,0 +1,131 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { ComponentStatus } from './component-status'; + +/** + * Plugin health information. + * @export + * @interface PluginHealth + */ +export interface PluginHealth { + /** + * Average response time in milliseconds + * @type {number} + * @memberof PluginHealth + */ + 'avg_response_time_ms'?: number; + /** + * + * @type {string} + * @memberof PluginHealth + */ + 'circuit_state'?: string; + /** + * Connection pool active connections (for pool server connections) + * @type {number} + * @memberof PluginHealth + */ + 'connection_pool_active_connections'?: number; + /** + * Connection pool available slots (for pool server connections) + * @type {number} + * @memberof PluginHealth + */ + 'connection_pool_available_slots'?: number; + /** + * + * @type {boolean} + * @memberof PluginHealth + */ + 'enabled': boolean; + /** + * + * @type {string} + * @memberof PluginHealth + */ + 'error'?: string; + /** + * Memory usage in bytes + * @type {number} + * @memberof PluginHealth + */ + 'memory'?: number; + /** + * Number of completed tasks in the pool + * @type {number} + * @memberof PluginHealth + */ + 'pool_completed'?: number; + /** + * Number of queued tasks in the pool + * @type {number} + * @memberof PluginHealth + */ + 'pool_queued'?: number; + /** + * Whether recovery mode is active + * @type {boolean} + * @memberof PluginHealth + */ + 'recovering'?: boolean; + /** + * Current recovery allowance percentage + * @type {number} + * @memberof PluginHealth + */ + 'recovery_percent'?: number; + /** + * Shared socket active connection count + * @type {number} + * @memberof PluginHealth + */ + 'shared_socket_active_connections'?: number; + /** + * Shared socket available connection slots + * @type {number} + * @memberof PluginHealth + */ + 'shared_socket_available_slots'?: number; + /** + * Shared socket registered execution count + * @type {number} + * @memberof PluginHealth + */ + 'shared_socket_registered_executions'?: number; + /** + * + * @type {ComponentStatus} + * @memberof PluginHealth + */ + 'status': ComponentStatus; + /** + * Success rate as a percentage (0.0-100.0) + * @type {number} + * @memberof PluginHealth + */ + 'success_rate'?: number; + /** + * Plugin uptime in milliseconds + * @type {number} + * @memberof PluginHealth + */ + 'uptime_ms'?: number; +} + + + diff --git a/src/models/plugin-metadata.ts b/src/models/plugin-metadata.ts index 66be15cc..bdf27068 100644 --- a/src/models/plugin-metadata.ts +++ b/src/models/plugin-metadata.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/plugin-model.ts b/src/models/plugin-model.ts new file mode 100644 index 00000000..397c90af --- /dev/null +++ b/src/models/plugin-model.ts @@ -0,0 +1,78 @@ +/* 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. + */ + + + +/** + * + * @export + * @interface PluginModel + */ +export interface PluginModel { + /** + * Whether to allow GET requests to invoke plugin logic + * @type {boolean} + * @memberof PluginModel + */ + 'allow_get_invocation'?: boolean; + /** + * User-defined configuration accessible to the plugin (must be a JSON object) + * @type {{ [key: string]: any; }} + * @memberof PluginModel + */ + 'config'?: { [key: string]: any; }; + /** + * Whether to include logs in the HTTP response + * @type {boolean} + * @memberof PluginModel + */ + 'emit_logs'?: boolean; + /** + * Whether to include traces in the HTTP response + * @type {boolean} + * @memberof PluginModel + */ + 'emit_traces'?: boolean; + /** + * Whether to forward plugin logs into the relayer\'s tracing output + * @type {boolean} + * @memberof PluginModel + */ + 'forward_logs'?: boolean; + /** + * Plugin ID + * @type {string} + * @memberof PluginModel + */ + 'id': string; + /** + * Plugin path + * @type {string} + * @memberof PluginModel + */ + 'path': string; + /** + * Whether to return raw plugin response without ApiResponse wrapper + * @type {boolean} + * @memberof PluginModel + */ + 'raw_response'?: boolean; + /** + * Plugin timeout + * @type {number} + * @memberof PluginModel + */ + 'timeout': number; +} + diff --git a/src/models/pool-status.ts b/src/models/pool-status.ts new file mode 100644 index 00000000..cc2f9e28 --- /dev/null +++ b/src/models/pool-status.ts @@ -0,0 +1,48 @@ +/* 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. + */ + + + +/** + * Status of an individual Redis connection pool. + * @export + * @interface PoolStatus + */ +export interface PoolStatus { + /** + * Number of available connections in the pool. + * @type {number} + * @memberof PoolStatus + */ + 'available': number; + /** + * Whether the pool is connected and responding to PING. + * @type {boolean} + * @memberof PoolStatus + */ + 'connected': boolean; + /** + * Error message if the pool is not healthy. + * @type {string} + * @memberof PoolStatus + */ + 'error'?: string; + /** + * Maximum configured pool size. + * @type {number} + * @memberof PoolStatus + */ + 'max_size': number; +} + diff --git a/src/models/queue-health.ts b/src/models/queue-health.ts new file mode 100644 index 00000000..824ba266 --- /dev/null +++ b/src/models/queue-health.ts @@ -0,0 +1,41 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { ComponentStatus } from './component-status'; + +/** + * Queue health information. + * @export + * @interface QueueHealth + */ +export interface QueueHealth { + /** + * + * @type {string} + * @memberof QueueHealth + */ + 'error'?: string; + /** + * + * @type {ComponentStatus} + * @memberof QueueHealth + */ + 'status': ComponentStatus; +} + + + diff --git a/src/models/readiness-response.ts b/src/models/readiness-response.ts new file mode 100644 index 00000000..90b6f478 --- /dev/null +++ b/src/models/readiness-response.ts @@ -0,0 +1,62 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { ComponentStatus } from './component-status'; +// May contain unused imports in some cases +// @ts-ignore +import type { Components } from './components'; + +/** + * Complete readiness response. + * @export + * @interface ReadinessResponse + */ +export interface ReadinessResponse { + /** + * + * @type {Components} + * @memberof ReadinessResponse + */ + 'components': Components; + /** + * + * @type {boolean} + * @memberof ReadinessResponse + */ + 'ready': boolean; + /** + * + * @type {string} + * @memberof ReadinessResponse + */ + 'reason'?: string; + /** + * + * @type {ComponentStatus} + * @memberof ReadinessResponse + */ + 'status': ComponentStatus; + /** + * + * @type {string} + * @memberof ReadinessResponse + */ + 'timestamp': string; +} + + + diff --git a/src/models/redis-health.ts b/src/models/redis-health.ts new file mode 100644 index 00000000..a241b526 --- /dev/null +++ b/src/models/redis-health.ts @@ -0,0 +1,56 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { ComponentStatus } from './component-status'; +// May contain unused imports in some cases +// @ts-ignore +import type { PoolStatus } from './pool-status'; + +/** + * Redis health information. + * @export + * @interface RedisHealth + */ +export interface RedisHealth { + /** + * + * @type {string} + * @memberof RedisHealth + */ + 'error'?: string; + /** + * + * @type {PoolStatus} + * @memberof RedisHealth + */ + 'primary_pool': PoolStatus; + /** + * + * @type {PoolStatus} + * @memberof RedisHealth + */ + 'reader_pool': PoolStatus; + /** + * + * @type {ComponentStatus} + * @memberof RedisHealth + */ + 'status': ComponentStatus; +} + + + diff --git a/src/models/relayer-evm-policy.ts b/src/models/relayer-evm-policy.ts index 0dfc7d73..eb8d01d1 100644 --- a/src/models/relayer-evm-policy.ts +++ b/src/models/relayer-evm-policy.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/relayer-network-policy-one-of.ts b/src/models/relayer-network-policy-one-of.ts index d5d956f8..cdbc0e46 100644 --- a/src/models/relayer-network-policy-one-of.ts +++ b/src/models/relayer-network-policy-one-of.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/relayer-network-policy-one-of1.ts b/src/models/relayer-network-policy-one-of1.ts index d204df77..5506e15b 100644 --- a/src/models/relayer-network-policy-one-of1.ts +++ b/src/models/relayer-network-policy-one-of1.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/relayer-network-policy-one-of2.ts b/src/models/relayer-network-policy-one-of2.ts index f9db16ed..2a218bf7 100644 --- a/src/models/relayer-network-policy-one-of2.ts +++ b/src/models/relayer-network-policy-one-of2.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/relayer-network-policy-response.ts b/src/models/relayer-network-policy-response.ts index fbf78840..fd26ed01 100644 --- a/src/models/relayer-network-policy-response.ts +++ b/src/models/relayer-network-policy-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/relayer-network-policy.ts b/src/models/relayer-network-policy.ts index b41b07d3..c4bfb2ad 100644 --- a/src/models/relayer-network-policy.ts +++ b/src/models/relayer-network-policy.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/relayer-network-type.ts b/src/models/relayer-network-type.ts index 4c766b70..9d7b68e3 100644 --- a/src/models/relayer-network-type.ts +++ b/src/models/relayer-network-type.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/relayer-response.ts b/src/models/relayer-response.ts index 4e9dbc2c..145a7c9c 100644 --- a/src/models/relayer-response.ts +++ b/src/models/relayer-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -18,13 +18,13 @@ import type { DisabledReason } from './disabled-reason'; // May contain unused imports in some cases // @ts-ignore -import type { RelayerNetworkPolicyResponse } from './relayer-network-policy-response'; +import type { MaskedRpcConfig } from './masked-rpc-config'; // May contain unused imports in some cases // @ts-ignore -import type { RelayerNetworkType } from './relayer-network-type'; +import type { RelayerNetworkPolicyResponse } from './relayer-network-policy-response'; // May contain unused imports in some cases // @ts-ignore -import type { RpcConfig } from './rpc-config'; +import type { RelayerNetworkType } from './relayer-network-type'; /** * Relayer response model for API endpoints @@ -39,11 +39,11 @@ export interface RelayerResponse { */ 'address'?: string; /** - * - * @type {Array} + * Custom RPC URLs with sensitive path/query parameters masked for security. The domain is visible to identify providers (e.g., Alchemy, Infura) but API keys embedded in paths are hidden. + * @type {Array} * @memberof RelayerResponse */ - 'custom_rpc_urls'?: Array; + 'custom_rpc_urls'?: Array; /** * * @type {DisabledReason} diff --git a/src/models/relayer-solana-policy.ts b/src/models/relayer-solana-policy.ts index f69b9909..960aa352 100644 --- a/src/models/relayer-solana-policy.ts +++ b/src/models/relayer-solana-policy.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/relayer-solana-swap-config.ts b/src/models/relayer-solana-swap-config.ts index 98485d78..94730c00 100644 --- a/src/models/relayer-solana-swap-config.ts +++ b/src/models/relayer-solana-swap-config.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/relayer-status.ts b/src/models/relayer-status.ts index 2bff53cc..cfe4fd19 100644 --- a/src/models/relayer-status.ts +++ b/src/models/relayer-status.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/relayer-stellar-policy.ts b/src/models/relayer-stellar-policy.ts index a6309f59..a96c1683 100644 --- a/src/models/relayer-stellar-policy.ts +++ b/src/models/relayer-stellar-policy.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/relayer-stellar-swap-config.ts b/src/models/relayer-stellar-swap-config.ts index c081e418..382799fd 100644 --- a/src/models/relayer-stellar-swap-config.ts +++ b/src/models/relayer-stellar-swap-config.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/rpc-config.ts b/src/models/rpc-config.ts index 0f02e05e..b554af5c 100644 --- a/src/models/rpc-config.ts +++ b/src/models/rpc-config.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -15,7 +15,7 @@ /** - * Configuration for an RPC endpoint. + * Configuration for an RPC endpoint. This struct contains only persistent configuration (URL and weight). Health metadata (failures, pause state) is managed separately via `RpcHealthStore`. * @export * @interface RpcConfig */ @@ -27,10 +27,10 @@ export interface RpcConfig { */ 'url': string; /** - * The weight of this endpoint in the weighted round-robin selection. Defaults to DEFAULT_RPC_WEIGHT (100). Should be between 0 and 100. + * The weight of this endpoint in the weighted round-robin selection. Defaults to [`DEFAULT_RPC_WEIGHT`]. Should be between 0 and 100. * @type {number} * @memberof RpcConfig */ - 'weight'?: number; + 'weight': number; } diff --git a/src/models/rpc-url-entry.ts b/src/models/rpc-url-entry.ts new file mode 100644 index 00000000..26d3ec62 --- /dev/null +++ b/src/models/rpc-url-entry.ts @@ -0,0 +1,27 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { RpcConfig } from './rpc-config'; + +/** + * @type RpcUrlEntry + * Schema-only type representing a flexible RPC URL entry. Used for OpenAPI documentation to show that rpc_urls can accept either strings or RpcConfig objects. This is NOT used for actual deserialization - the custom deserializer handles the conversion. This type exists solely for schema generation. + * @export + */ +export type RpcUrlEntry = RpcConfig | string; + + diff --git a/src/models/sign-and-send-transaction-request-params.ts b/src/models/sign-and-send-transaction-request-params.ts index c6e51684..079ffdbb 100644 --- a/src/models/sign-and-send-transaction-request-params.ts +++ b/src/models/sign-and-send-transaction-request-params.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/sign-and-send-transaction-result.ts b/src/models/sign-and-send-transaction-result.ts index caf95bff..fe8f80c8 100644 --- a/src/models/sign-and-send-transaction-result.ts +++ b/src/models/sign-and-send-transaction-result.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/sign-data-request.ts b/src/models/sign-data-request.ts index c8ec6f71..9845224c 100644 --- a/src/models/sign-data-request.ts +++ b/src/models/sign-data-request.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/sign-data-response-evm.ts b/src/models/sign-data-response-evm.ts index 31eceed1..b189acd6 100644 --- a/src/models/sign-data-response-evm.ts +++ b/src/models/sign-data-response-evm.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/sign-data-response-solana.ts b/src/models/sign-data-response-solana.ts index 8aa1efab..11049bdd 100644 --- a/src/models/sign-data-response-solana.ts +++ b/src/models/sign-data-response-solana.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/sign-data-response.ts b/src/models/sign-data-response.ts index d249bd3a..ea29f066 100644 --- a/src/models/sign-data-response.ts +++ b/src/models/sign-data-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/sign-transaction-request-params.ts b/src/models/sign-transaction-request-params.ts index f00a641c..d739f892 100644 --- a/src/models/sign-transaction-request-params.ts +++ b/src/models/sign-transaction-request-params.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/sign-transaction-request-solana.ts b/src/models/sign-transaction-request-solana.ts index ff8fcc90..dd1fc0af 100644 --- a/src/models/sign-transaction-request-solana.ts +++ b/src/models/sign-transaction-request-solana.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/sign-transaction-request-stellar.ts b/src/models/sign-transaction-request-stellar.ts index 1d20bacc..db1f8e61 100644 --- a/src/models/sign-transaction-request-stellar.ts +++ b/src/models/sign-transaction-request-stellar.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/sign-transaction-request.ts b/src/models/sign-transaction-request.ts index 20b532df..236e04ea 100644 --- a/src/models/sign-transaction-request.ts +++ b/src/models/sign-transaction-request.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/sign-transaction-response-solana.ts b/src/models/sign-transaction-response-solana.ts index 9154543f..8d3d7e0c 100644 --- a/src/models/sign-transaction-response-solana.ts +++ b/src/models/sign-transaction-response-solana.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/sign-transaction-response-stellar.ts b/src/models/sign-transaction-response-stellar.ts index 5ee017cd..3b12aa43 100644 --- a/src/models/sign-transaction-response-stellar.ts +++ b/src/models/sign-transaction-response-stellar.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/sign-transaction-response.ts b/src/models/sign-transaction-response.ts index 684bbe25..869acf85 100644 --- a/src/models/sign-transaction-response.ts +++ b/src/models/sign-transaction-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/sign-transaction-result.ts b/src/models/sign-transaction-result.ts index 04cfe431..fb34ab5d 100644 --- a/src/models/sign-transaction-result.ts +++ b/src/models/sign-transaction-result.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/sign-typed-data-request.ts b/src/models/sign-typed-data-request.ts index db43967d..92766f0c 100644 --- a/src/models/sign-typed-data-request.ts +++ b/src/models/sign-typed-data-request.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/signer-config-request.ts b/src/models/signer-config-request.ts index 3cd75c4f..27fa6236 100644 --- a/src/models/signer-config-request.ts +++ b/src/models/signer-config-request.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/signer-config-response-one-of.ts b/src/models/signer-config-response-one-of.ts index 8a2c5c82..1a133a0b 100644 --- a/src/models/signer-config-response-one-of.ts +++ b/src/models/signer-config-response-one-of.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/signer-config-response-one-of1.ts b/src/models/signer-config-response-one-of1.ts index 7627e83d..e9b5c827 100644 --- a/src/models/signer-config-response-one-of1.ts +++ b/src/models/signer-config-response-one-of1.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/signer-config-response-one-of2.ts b/src/models/signer-config-response-one-of2.ts index ad8dbaf3..807c3d39 100644 --- a/src/models/signer-config-response-one-of2.ts +++ b/src/models/signer-config-response-one-of2.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/signer-config-response-one-of3.ts b/src/models/signer-config-response-one-of3.ts index 2e9778da..1765f273 100644 --- a/src/models/signer-config-response-one-of3.ts +++ b/src/models/signer-config-response-one-of3.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/signer-config-response-one-of4.ts b/src/models/signer-config-response-one-of4.ts index b021f7dd..fab917be 100644 --- a/src/models/signer-config-response-one-of4.ts +++ b/src/models/signer-config-response-one-of4.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/signer-config-response-one-of5.ts b/src/models/signer-config-response-one-of5.ts index 59d8b93e..d662ec7b 100644 --- a/src/models/signer-config-response-one-of5.ts +++ b/src/models/signer-config-response-one-of5.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/signer-config-response.ts b/src/models/signer-config-response.ts index 70a11e78..023ce7be 100644 --- a/src/models/signer-config-response.ts +++ b/src/models/signer-config-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/signer-create-request.ts b/src/models/signer-create-request.ts index 9a6be362..83c5980c 100644 --- a/src/models/signer-create-request.ts +++ b/src/models/signer-create-request.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/signer-response.ts b/src/models/signer-response.ts index 94742f07..244f9b4f 100644 --- a/src/models/signer-response.ts +++ b/src/models/signer-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/signer-type-request.ts b/src/models/signer-type-request.ts index 96349705..66e040cd 100644 --- a/src/models/signer-type-request.ts +++ b/src/models/signer-type-request.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/signer-type.ts b/src/models/signer-type.ts index c319d06a..71ae614c 100644 --- a/src/models/signer-type.ts +++ b/src/models/signer-type.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-account-meta.ts b/src/models/solana-account-meta.ts index 5c3963cb..c8de1749 100644 --- a/src/models/solana-account-meta.ts +++ b/src/models/solana-account-meta.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-allowed-tokens-policy.ts b/src/models/solana-allowed-tokens-policy.ts index 18cbcce2..525a5f6b 100644 --- a/src/models/solana-allowed-tokens-policy.ts +++ b/src/models/solana-allowed-tokens-policy.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-allowed-tokens-swap-config.ts b/src/models/solana-allowed-tokens-swap-config.ts index b5cc5e35..c4a02175 100644 --- a/src/models/solana-allowed-tokens-swap-config.ts +++ b/src/models/solana-allowed-tokens-swap-config.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-fee-estimate-request-params.ts b/src/models/solana-fee-estimate-request-params.ts index 214b393a..f8e6ebfa 100644 --- a/src/models/solana-fee-estimate-request-params.ts +++ b/src/models/solana-fee-estimate-request-params.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-fee-estimate-result.ts b/src/models/solana-fee-estimate-result.ts index b55c6e4f..c0cfab75 100644 --- a/src/models/solana-fee-estimate-result.ts +++ b/src/models/solana-fee-estimate-result.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-fee-payment-strategy.ts b/src/models/solana-fee-payment-strategy.ts index 6176b970..df150702 100644 --- a/src/models/solana-fee-payment-strategy.ts +++ b/src/models/solana-fee-payment-strategy.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-instruction-spec.ts b/src/models/solana-instruction-spec.ts index 9002b56c..486c5b2e 100644 --- a/src/models/solana-instruction-spec.ts +++ b/src/models/solana-instruction-spec.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-policy-response.ts b/src/models/solana-policy-response.ts index 8d14003c..b63cf7e6 100644 --- a/src/models/solana-policy-response.ts +++ b/src/models/solana-policy-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-prepare-transaction-request-params.ts b/src/models/solana-prepare-transaction-request-params.ts index 1d0ac307..af52b7e3 100644 --- a/src/models/solana-prepare-transaction-request-params.ts +++ b/src/models/solana-prepare-transaction-request-params.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-prepare-transaction-result.ts b/src/models/solana-prepare-transaction-result.ts index 1c79f019..53f520e2 100644 --- a/src/models/solana-prepare-transaction-result.ts +++ b/src/models/solana-prepare-transaction-result.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-rpc-request-one-of.ts b/src/models/solana-rpc-request-one-of.ts index 797d11ca..8b46bc35 100644 --- a/src/models/solana-rpc-request-one-of.ts +++ b/src/models/solana-rpc-request-one-of.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-rpc-request-one-of1.ts b/src/models/solana-rpc-request-one-of1.ts index 9bd7e8ec..53db84f0 100644 --- a/src/models/solana-rpc-request-one-of1.ts +++ b/src/models/solana-rpc-request-one-of1.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-rpc-request-one-of2.ts b/src/models/solana-rpc-request-one-of2.ts index 39989750..a87e3303 100644 --- a/src/models/solana-rpc-request-one-of2.ts +++ b/src/models/solana-rpc-request-one-of2.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-rpc-request-one-of3.ts b/src/models/solana-rpc-request-one-of3.ts index e9ffd228..24603446 100644 --- a/src/models/solana-rpc-request-one-of3.ts +++ b/src/models/solana-rpc-request-one-of3.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-rpc-request-one-of4.ts b/src/models/solana-rpc-request-one-of4.ts index 85382eef..501bdefa 100644 --- a/src/models/solana-rpc-request-one-of4.ts +++ b/src/models/solana-rpc-request-one-of4.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-rpc-request-one-of5.ts b/src/models/solana-rpc-request-one-of5.ts index b04c38bf..72967957 100644 --- a/src/models/solana-rpc-request-one-of5.ts +++ b/src/models/solana-rpc-request-one-of5.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-rpc-request-one-of6.ts b/src/models/solana-rpc-request-one-of6.ts index df6efed2..29eb9799 100644 --- a/src/models/solana-rpc-request-one-of6.ts +++ b/src/models/solana-rpc-request-one-of6.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-rpc-request-one-of7-params.ts b/src/models/solana-rpc-request-one-of7-params.ts index 2781c177..1f1c5874 100644 --- a/src/models/solana-rpc-request-one-of7-params.ts +++ b/src/models/solana-rpc-request-one-of7-params.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-rpc-request-one-of7.ts b/src/models/solana-rpc-request-one-of7.ts index 5b1d9aea..550ddd76 100644 --- a/src/models/solana-rpc-request-one-of7.ts +++ b/src/models/solana-rpc-request-one-of7.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-rpc-request.ts b/src/models/solana-rpc-request.ts index 3592f53c..23f794c6 100644 --- a/src/models/solana-rpc-request.ts +++ b/src/models/solana-rpc-request.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-rpc-result-one-of.ts b/src/models/solana-rpc-result-one-of.ts index cb0832a8..65d6aa39 100644 --- a/src/models/solana-rpc-result-one-of.ts +++ b/src/models/solana-rpc-result-one-of.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-rpc-result-one-of1.ts b/src/models/solana-rpc-result-one-of1.ts index 59500bab..f632ad7e 100644 --- a/src/models/solana-rpc-result-one-of1.ts +++ b/src/models/solana-rpc-result-one-of1.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-rpc-result-one-of2.ts b/src/models/solana-rpc-result-one-of2.ts index bd68f18f..14e2558d 100644 --- a/src/models/solana-rpc-result-one-of2.ts +++ b/src/models/solana-rpc-result-one-of2.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-rpc-result-one-of3.ts b/src/models/solana-rpc-result-one-of3.ts index 769cd222..6c585be3 100644 --- a/src/models/solana-rpc-result-one-of3.ts +++ b/src/models/solana-rpc-result-one-of3.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-rpc-result-one-of4.ts b/src/models/solana-rpc-result-one-of4.ts index 4cee74ca..d26df2d7 100644 --- a/src/models/solana-rpc-result-one-of4.ts +++ b/src/models/solana-rpc-result-one-of4.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-rpc-result-one-of5.ts b/src/models/solana-rpc-result-one-of5.ts index 784f8188..ab22c69f 100644 --- a/src/models/solana-rpc-result-one-of5.ts +++ b/src/models/solana-rpc-result-one-of5.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-rpc-result-one-of6.ts b/src/models/solana-rpc-result-one-of6.ts index e66c7e31..611fdea7 100644 --- a/src/models/solana-rpc-result-one-of6.ts +++ b/src/models/solana-rpc-result-one-of6.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-rpc-result-one-of7.ts b/src/models/solana-rpc-result-one-of7.ts index 0562c25b..54e9e798 100644 --- a/src/models/solana-rpc-result-one-of7.ts +++ b/src/models/solana-rpc-result-one-of7.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-rpc-result.ts b/src/models/solana-rpc-result.ts index deffdbe9..35a522d3 100644 --- a/src/models/solana-rpc-result.ts +++ b/src/models/solana-rpc-result.ts @@ -1,19 +1,29 @@ // This file is a workaround to generate the desired output. // Workaround for https://github.com/OpenAPITools/openapi-generator/issues/13417 -// @ts-expect-error May contain unused imports in some cases +// May contain unused imports in some cases +// @ts-ignore import type { FeeEstimateResult } from './fee-estimate-result'; -// @ts-expect-error May contain unused imports in some cases +// May contain unused imports in some cases +// @ts-ignore import type { GetFeaturesEnabledResult } from './get-features-enabled-result'; -// @ts-expect-error May contain unused imports in some cases +// May contain unused imports in some cases +// @ts-ignore +import type { GetSupportedTokensItem } from './get-supported-tokens-item'; +// May contain unused imports in some cases +// @ts-ignore import type { GetSupportedTokensResult } from './get-supported-tokens-result'; -// @ts-expect-error May contain unused imports in some cases +// May contain unused imports in some cases +// @ts-ignore import type { PrepareTransactionResult } from './prepare-transaction-result'; -// @ts-expect-error May contain unused imports in some cases +// May contain unused imports in some cases +// @ts-ignore import type { SignAndSendTransactionResult } from './sign-and-send-transaction-result'; -// @ts-expect-error May contain unused imports in some cases +// May contain unused imports in some cases +// @ts-ignore import type { SignTransactionResult } from './sign-transaction-result'; -// @ts-expect-error May contain unused imports in some cases +// May contain unused imports in some cases +// @ts-ignore import type { TransferTransactionResult } from './transfer-transaction-result'; type TransferTransactionResultWithMethod = TransferTransactionResult & { diff --git a/src/models/solana-swap-strategy.ts b/src/models/solana-swap-strategy.ts index d6997346..1f6df942 100644 --- a/src/models/solana-swap-strategy.ts +++ b/src/models/solana-swap-strategy.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-transaction-request.ts b/src/models/solana-transaction-request.ts index f2e3365f..642a00a4 100644 --- a/src/models/solana-transaction-request.ts +++ b/src/models/solana-transaction-request.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/solana-transaction-response.ts b/src/models/solana-transaction-response.ts index dfa7b66b..89a9df88 100644 --- a/src/models/solana-transaction-response.ts +++ b/src/models/solana-transaction-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/speed.ts b/src/models/speed.ts index 6a817721..4a1aadd8 100644 --- a/src/models/speed.ts +++ b/src/models/speed.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/sponsored-transaction-build-request.ts b/src/models/sponsored-transaction-build-request.ts index 6545d0a6..95aa92ea 100644 --- a/src/models/sponsored-transaction-build-request.ts +++ b/src/models/sponsored-transaction-build-request.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -25,7 +25,7 @@ import type { StellarPrepareTransactionRequestParams } from './stellar-prepare-t /** * @type SponsoredTransactionBuildRequest - * Network-agnostic prepare transaction request parameters for gasless transactions. Contains network-specific request parameters for preparing transactions with fee payments. The network type is inferred from the relayer\'s network configuration. + * Network-agnostic prepare transaction request parameters for gasless transactions. Contains network-specific request parameters for preparing transactions with fee payments. The network type is inferred from the relayer\'s network configuration. For Stellar, supports both classic and Soroban gas abstraction: - Classic: Pass operations or transaction_xdr with classic fee token - Soroban: Pass transaction_xdr containing InvokeHostFunction, user_address, and contract fee token * @export */ export type SponsoredTransactionBuildRequest = SolanaPrepareTransactionRequestParams | StellarPrepareTransactionRequestParams; diff --git a/src/models/sponsored-transaction-build-response.ts b/src/models/sponsored-transaction-build-response.ts index e13c208d..2d39f9d9 100644 --- a/src/models/sponsored-transaction-build-response.ts +++ b/src/models/sponsored-transaction-build-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/sponsored-transaction-quote-request.ts b/src/models/sponsored-transaction-quote-request.ts index 77f0b893..304f3a94 100644 --- a/src/models/sponsored-transaction-quote-request.ts +++ b/src/models/sponsored-transaction-quote-request.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -25,7 +25,7 @@ import type { StellarFeeEstimateRequestParams } from './stellar-fee-estimate-req /** * @type SponsoredTransactionQuoteRequest - * Network-agnostic fee estimate request parameters for gasless transactions. Contains network-specific request parameters for fee estimation. The network type is inferred from the relayer\'s network configuration. + * Network-agnostic fee estimate request parameters for gasless transactions. Contains network-specific request parameters for fee estimation. The network type is inferred from the relayer\'s network configuration. For Stellar, supports both classic and Soroban gas abstraction: - Classic: Pass operations or transaction_xdr with classic fee token (native/USDC:GA...) - Soroban: Pass transaction_xdr containing InvokeHostFunction, user_address, and contract fee token (C...) * @export */ export type SponsoredTransactionQuoteRequest = SolanaFeeEstimateRequestParams | StellarFeeEstimateRequestParams; diff --git a/src/models/sponsored-transaction-quote-response.ts b/src/models/sponsored-transaction-quote-response.ts index b2636e5b..0fd5667b 100644 --- a/src/models/sponsored-transaction-quote-response.ts +++ b/src/models/sponsored-transaction-quote-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/stellar-allowed-tokens-policy.ts b/src/models/stellar-allowed-tokens-policy.ts index 31bd3365..bc6215f5 100644 --- a/src/models/stellar-allowed-tokens-policy.ts +++ b/src/models/stellar-allowed-tokens-policy.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/stellar-allowed-tokens-swap-config.ts b/src/models/stellar-allowed-tokens-swap-config.ts index e1344c25..5e8e2868 100644 --- a/src/models/stellar-allowed-tokens-swap-config.ts +++ b/src/models/stellar-allowed-tokens-swap-config.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/stellar-fee-estimate-request-params.ts b/src/models/stellar-fee-estimate-request-params.ts index 6df80e02..19c73116 100644 --- a/src/models/stellar-fee-estimate-request-params.ts +++ b/src/models/stellar-fee-estimate-request-params.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -26,7 +26,7 @@ export interface StellarFeeEstimateRequestParams { [key: string]: any; /** - * Asset identifier for fee token (e.g., \"native\" or \"USDC:GA5Z...\") + * Asset identifier for fee token. For classic: \"native\" or \"USDC:GA5Z...\" format. For Soroban: contract address (C...) format. * @type {string} * @memberof StellarFeeEstimateRequestParams */ @@ -44,7 +44,7 @@ export interface StellarFeeEstimateRequestParams { */ 'source_account'?: string; /** - * Pre-built transaction XDR (base64 encoded, signed or unsigned) Mutually exclusive with operations field + * Pre-built transaction XDR (base64 encoded, signed or unsigned) Mutually exclusive with operations field. For Soroban gas abstraction: pass XDR containing InvokeHostFunction operation. * @type {string} * @memberof StellarFeeEstimateRequestParams */ diff --git a/src/models/stellar-fee-estimate-result.ts b/src/models/stellar-fee-estimate-result.ts index ef9b3244..fb5ba427 100644 --- a/src/models/stellar-fee-estimate-result.ts +++ b/src/models/stellar-fee-estimate-result.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -38,5 +38,17 @@ export interface StellarFeeEstimateResult { * @memberof StellarFeeEstimateResult */ 'fee_in_token_ui': string; + /** + * Maximum fee in token amount (raw units as string). Only present for Soroban gas abstraction - includes slippage buffer. + * @type {string} + * @memberof StellarFeeEstimateResult + */ + 'max_fee_in_token'?: string | null; + /** + * Maximum fee in token amount (decimal UI representation as string). Only present for Soroban gas abstraction - includes slippage buffer. + * @type {string} + * @memberof StellarFeeEstimateResult + */ + 'max_fee_in_token_ui'?: string | null; } diff --git a/src/models/stellar-fee-payment-strategy.ts b/src/models/stellar-fee-payment-strategy.ts index aaff3eb1..bd17d09d 100644 --- a/src/models/stellar-fee-payment-strategy.ts +++ b/src/models/stellar-fee-payment-strategy.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/stellar-policy-response.ts b/src/models/stellar-policy-response.ts index 9902914f..31f5ceff 100644 --- a/src/models/stellar-policy-response.ts +++ b/src/models/stellar-policy-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/stellar-prepare-transaction-request-params.ts b/src/models/stellar-prepare-transaction-request-params.ts index 268cecb8..530b53b7 100644 --- a/src/models/stellar-prepare-transaction-request-params.ts +++ b/src/models/stellar-prepare-transaction-request-params.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -26,7 +26,7 @@ export interface StellarPrepareTransactionRequestParams { [key: string]: any; /** - * Asset identifier for fee token + * Asset identifier for fee token. For classic: \"native\" or \"USDC:GA5Z...\" format. For Soroban: contract address (C...) format. * @type {string} * @memberof StellarPrepareTransactionRequestParams */ @@ -44,7 +44,7 @@ export interface StellarPrepareTransactionRequestParams { */ 'source_account'?: string; /** - * Pre-built transaction XDR (base64 encoded, signed or unsigned) Mutually exclusive with operations field + * Pre-built transaction XDR (base64 encoded, signed or unsigned) Mutually exclusive with operations field. For Soroban gas abstraction: pass XDR containing InvokeHostFunction operation. * @type {string} * @memberof StellarPrepareTransactionRequestParams */ diff --git a/src/models/stellar-prepare-transaction-result.ts b/src/models/stellar-prepare-transaction-result.ts index 1f790eff..17b3336d 100644 --- a/src/models/stellar-prepare-transaction-result.ts +++ b/src/models/stellar-prepare-transaction-result.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -44,12 +44,30 @@ export interface StellarPrepareTransactionResult { * @memberof StellarPrepareTransactionResult */ 'fee_token': string; + /** + * Maximum fee in token amount (raw units as string). Only present for Soroban gas abstraction - includes slippage buffer. + * @type {string} + * @memberof StellarPrepareTransactionResult + */ + 'max_fee_in_token'?: string | null; + /** + * Maximum fee in token amount (decimal UI representation as string). Only present for Soroban gas abstraction - includes slippage buffer. + * @type {string} + * @memberof StellarPrepareTransactionResult + */ + 'max_fee_in_token_ui'?: string | null; /** * Extended transaction XDR (base64 encoded) * @type {string} * @memberof StellarPrepareTransactionResult */ 'transaction': string; + /** + * User authorization entry XDR (base64 encoded). Present for Soroban gas abstraction - user must sign this auth entry. + * @type {string} + * @memberof StellarPrepareTransactionResult + */ + 'user_auth_entry'?: string | null; /** * Transaction validity timestamp (ISO 8601 format) * @type {string} diff --git a/src/models/stellar-rpc-request-one-of.ts b/src/models/stellar-rpc-request-one-of.ts index 81a8fdaa..3c2b3dd1 100644 --- a/src/models/stellar-rpc-request-one-of.ts +++ b/src/models/stellar-rpc-request-one-of.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/stellar-rpc-request.ts b/src/models/stellar-rpc-request.ts index c8e26827..7181b0bb 100644 --- a/src/models/stellar-rpc-request.ts +++ b/src/models/stellar-rpc-request.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/stellar-rpc-result.ts b/src/models/stellar-rpc-result.ts index e0a7399e..5d0e1e8c 100644 --- a/src/models/stellar-rpc-result.ts +++ b/src/models/stellar-rpc-result.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/stellar-swap-strategy.ts b/src/models/stellar-swap-strategy.ts index af66c566..fbaf4d3e 100644 --- a/src/models/stellar-swap-strategy.ts +++ b/src/models/stellar-swap-strategy.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/stellar-token-kind-one-of-classic.ts b/src/models/stellar-token-kind-one-of-classic.ts index d66f44be..e720d192 100644 --- a/src/models/stellar-token-kind-one-of-classic.ts +++ b/src/models/stellar-token-kind-one-of-classic.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/stellar-token-kind-one-of.ts b/src/models/stellar-token-kind-one-of.ts index c082b5f6..d92f5f6d 100644 --- a/src/models/stellar-token-kind-one-of.ts +++ b/src/models/stellar-token-kind-one-of.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/stellar-token-kind-one-of1-contract.ts b/src/models/stellar-token-kind-one-of1-contract.ts index 920c24bd..0dd2a758 100644 --- a/src/models/stellar-token-kind-one-of1-contract.ts +++ b/src/models/stellar-token-kind-one-of1-contract.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/stellar-token-kind-one-of1.ts b/src/models/stellar-token-kind-one-of1.ts index 775b8842..f733b069 100644 --- a/src/models/stellar-token-kind-one-of1.ts +++ b/src/models/stellar-token-kind-one-of1.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/stellar-token-kind.ts b/src/models/stellar-token-kind.ts index 8f2acbe8..97a1e22e 100644 --- a/src/models/stellar-token-kind.ts +++ b/src/models/stellar-token-kind.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/stellar-token-metadata.ts b/src/models/stellar-token-metadata.ts index 7ec717df..21155bdb 100644 --- a/src/models/stellar-token-metadata.ts +++ b/src/models/stellar-token-metadata.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/stellar-transaction-response.ts b/src/models/stellar-transaction-response.ts index 71d9bd2b..4c620ea9 100644 --- a/src/models/stellar-transaction-response.ts +++ b/src/models/stellar-transaction-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -89,6 +89,12 @@ export interface StellarTransactionResponse { * @memberof StellarTransactionResponse */ 'status_reason'?: string | null; + /** + * + * @type {string} + * @memberof StellarTransactionResponse + */ + 'transaction_result_xdr'?: string; } diff --git a/src/models/system-health.ts b/src/models/system-health.ts new file mode 100644 index 00000000..26b8a87c --- /dev/null +++ b/src/models/system-health.ts @@ -0,0 +1,65 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { ComponentStatus } from './component-status'; + +/** + * System health information (file descriptors, sockets). + * @export + * @interface SystemHealth + */ +export interface SystemHealth { + /** + * + * @type {number} + * @memberof SystemHealth + */ + 'close_wait_count': number; + /** + * + * @type {string} + * @memberof SystemHealth + */ + 'error'?: string; + /** + * + * @type {number} + * @memberof SystemHealth + */ + 'fd_count': number; + /** + * + * @type {number} + * @memberof SystemHealth + */ + 'fd_limit': number; + /** + * + * @type {number} + * @memberof SystemHealth + */ + 'fd_usage_percent': number; + /** + * + * @type {ComponentStatus} + * @memberof SystemHealth + */ + 'status': ComponentStatus; +} + + + diff --git a/src/models/transaction-response.ts b/src/models/transaction-response.ts index 1ef1a623..e34a5ceb 100644 --- a/src/models/transaction-response.ts +++ b/src/models/transaction-response.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/transaction-status.ts b/src/models/transaction-status.ts index 99e00366..e3e95c42 100644 --- a/src/models/transaction-status.ts +++ b/src/models/transaction-status.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/transfer-transaction-request-params.ts b/src/models/transfer-transaction-request-params.ts index 8e8b8dff..1b116353 100644 --- a/src/models/transfer-transaction-request-params.ts +++ b/src/models/transfer-transaction-request-params.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/transfer-transaction-result.ts b/src/models/transfer-transaction-result.ts index e42c6991..5ab787d8 100644 --- a/src/models/transfer-transaction-result.ts +++ b/src/models/transfer-transaction-result.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/turnkey-signer-request-config.ts b/src/models/turnkey-signer-request-config.ts index 9903c0c9..fefd1859 100644 --- a/src/models/turnkey-signer-request-config.ts +++ b/src/models/turnkey-signer-request-config.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/update-network-request.ts b/src/models/update-network-request.ts new file mode 100644 index 00000000..b562ffaa --- /dev/null +++ b/src/models/update-network-request.ts @@ -0,0 +1,35 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { RpcUrlEntry } from './rpc-url-entry'; + +/** + * Request structure for updating a network configuration. Currently supports updating RPC URLs only. Can be extended to support other fields. + * @export + * @interface UpdateNetworkRequest + */ +export interface UpdateNetworkRequest { + [key: string]: any; + + /** + * List of RPC endpoint configurations for connecting to the network. Supports multiple formats: - Array of strings: `[\"https://rpc.example.com\"]` (defaults to weight 100) - Array of RpcConfig objects: `[{\"url\": \"https://rpc.example.com\", \"weight\": 100}]` - Mixed array: `[\"https://rpc1.com\", {\"url\": \"https://rpc2.com\", \"weight\": 100}]` Must be non-empty and contain valid HTTP/HTTPS URLs if provided. + * @type {Array} + * @memberof UpdateNetworkRequest + */ + 'rpc_urls'?: Array; +} + diff --git a/src/models/update-plugin-request.ts b/src/models/update-plugin-request.ts new file mode 100644 index 00000000..88b95e1a --- /dev/null +++ b/src/models/update-plugin-request.ts @@ -0,0 +1,68 @@ +/* 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. + */ + + + +/** + * Request model for updating an existing plugin. All fields are optional to allow partial updates. Note: `id` and `path` are not updateable after creation. + * @export + * @interface UpdatePluginRequest + */ +export interface UpdatePluginRequest { + [key: string]: any; + + /** + * Whether to allow GET requests to invoke plugin logic + * @type {boolean} + * @memberof UpdatePluginRequest + */ + 'allow_get_invocation'?: boolean; + /** + * User-defined configuration accessible to the plugin (must be a JSON object) Use `null` to clear the config + * @type {{ [key: string]: any; }} + * @memberof UpdatePluginRequest + */ + 'config'?: { [key: string]: any; }; + /** + * Whether to include logs in the HTTP response + * @type {boolean} + * @memberof UpdatePluginRequest + */ + 'emit_logs'?: boolean; + /** + * Whether to include traces in the HTTP response + * @type {boolean} + * @memberof UpdatePluginRequest + */ + 'emit_traces'?: boolean; + /** + * Whether to forward plugin logs into the relayer\'s tracing output + * @type {boolean} + * @memberof UpdatePluginRequest + */ + 'forward_logs'?: boolean; + /** + * Whether to return raw plugin response without ApiResponse wrapper + * @type {boolean} + * @memberof UpdatePluginRequest + */ + 'raw_response'?: boolean; + /** + * Plugin timeout in seconds + * @type {number} + * @memberof UpdatePluginRequest + */ + 'timeout'?: number; +} + diff --git a/src/models/update-relayer-request.ts b/src/models/update-relayer-request.ts index 2613751e..c98e7416 100644 --- a/src/models/update-relayer-request.ts +++ b/src/models/update-relayer-request.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/vault-signer-request-config.ts b/src/models/vault-signer-request-config.ts index 75642a71..1f51e82e 100644 --- a/src/models/vault-signer-request-config.ts +++ b/src/models/vault-signer-request-config.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/vault-transit-signer-request-config.ts b/src/models/vault-transit-signer-request-config.ts index 25c86c8d..d0904bb2 100644 --- a/src/models/vault-transit-signer-request-config.ts +++ b/src/models/vault-transit-signer-request-config.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/wasm-source-one-of.ts b/src/models/wasm-source-one-of.ts index b459f3fa..0a42e457 100644 --- a/src/models/wasm-source-one-of.ts +++ b/src/models/wasm-source-one-of.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/wasm-source-one-of1.ts b/src/models/wasm-source-one-of1.ts index bd27875e..f9afa53c 100644 --- a/src/models/wasm-source-one-of1.ts +++ b/src/models/wasm-source-one-of1.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/models/wasm-source.ts b/src/models/wasm-source.ts index 3d8fe189..d36b0f8c 100644 --- a/src/models/wasm-source.ts +++ b/src/models/wasm-source.ts @@ -4,7 +4,7 @@ * OpenZeppelin Relayer API * OpenZeppelin Relayer API * - * The version of the OpenAPI document: 1.2.0 + * The version of the OpenAPI document: 1.3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).