From 09c1df3e58388854e3ec9db7b2f0490ae7e17050 Mon Sep 17 00:00:00 2001 From: klaidliadon <5322228+klaidliadon@users.noreply.github.com> Date: Fri, 17 Oct 2025 10:38:52 +0000 Subject: [PATCH] [AUTOMATED] Update: proto/docs/relayer.gen.yaml --- docs/pages/api/relayer/rpc.gen.yaml | 423 +++++++++++++++++++++++++++- 1 file changed, 415 insertions(+), 8 deletions(-) diff --git a/docs/pages/api/relayer/rpc.gen.yaml b/docs/pages/api/relayer/rpc.gen.yaml index 4f162d10..c3307673 100644 --- a/docs/pages/api/relayer/rpc.gen.yaml +++ b/docs/pages/api/relayer/rpc.gen.yaml @@ -1,6 +1,6 @@ -# sequence-relayer v0.4.1 dd964f0ae46688b8eb7e149a0057ec512d602778 +# sequence-relayer v0.4.1 e3e258b78200357173ed6f66be8ed022a3658c71 # -- -# Code generated by webrpc-gen@v0.28.1 with openapi generator; DO NOT EDIT +# Code generated by webrpc-gen@v0.26.0 with openapi generator; DO NOT EDIT # # webrpc-gen -service=Relayer -match=@public -schema=proto/relayer.ridl -target=openapi -title=Relayer Api -servers=https://amoy-relayer.sequence.app;Amoy Relayer,https://apechain-relayer.sequence.app;Apechain Relayer,https://apechain-testnet-relayer.sequence.app;Apechain-Testnet Relayer,https://arbitrum-relayer.sequence.app;Arbitrum Relayer,https://arbitrum-nova-relayer.sequence.app;Arbitrum-Nova Relayer,https://arbitrum-sepolia-relayer.sequence.app;Arbitrum-Sepolia Relayer,https://avalanche-relayer.sequence.app;Avalanche Relayer,https://avalanche-testnet-relayer.sequence.app;Avalanche-Testnet Relayer,https://b3-relayer.sequence.app;B3 Relayer,https://b3-sepolia-relayer.sequence.app;B3-Sepolia Relayer,https://base-relayer.sequence.app;Base Relayer,https://base-sepolia-relayer.sequence.app;Base-Sepolia Relayer,https://blast-relayer.sequence.app;Blast Relayer,https://blast-sepolia-relayer.sequence.app;Blast-Sepolia Relayer,https://bsc-relayer.sequence.app;Bsc Relayer,https://bsc-testnet-relayer.sequence.app;Bsc-Testnet Relayer,https://etherlink-relayer.sequence.app;Etherlink Relayer,https://etherlink-testnet-relayer.sequence.app;Etherlink-Testnet Relayer,https://gnosis-relayer.sequence.app;Gnosis Relayer,https://homeverse-relayer.sequence.app;Homeverse Relayer,https://homeverse-testnet-relayer.sequence.app;Homeverse-Testnet Relayer,https://immutable-zkevm-relayer.sequence.app;Immutable-Zkevm Relayer,https://immutable-zkevm-testnet-relayer.sequence.app;Immutable-Zkevm-Testnet Relayer,https://incentiv-testnet-v2-relayer.sequence.app;Incentiv-Testnet-V2 Relayer,https://katana-relayer.sequence.app;Katana Relayer,https://laos-relayer.sequence.app;Laos Relayer,https://laos-sigma-testnet-relayer.sequence.app;Laos-Sigma-Testnet Relayer,https://mainnet-relayer.sequence.app;Mainnet Relayer,https://monad-relayer.sequence.app;Monad Relayer,https://monad-testnet-relayer.sequence.app;Monad-Testnet Relayer,https://moonbase-alpha-relayer.sequence.app;Moonbase-Alpha Relayer,https://moonbeam-relayer.sequence.app;Moonbeam Relayer,https://optimism-relayer.sequence.app;Optimism Relayer,https://optimism-sepolia-relayer.sequence.app;Optimism-Sepolia Relayer,https://polygon-relayer.sequence.app;Polygon Relayer,https://polygon-zkevm-relayer.sequence.app;Polygon-Zkevm Relayer,https://rootnet-relayer.sequence.app;Rootnet Relayer,https://rootnet-porcini-relayer.sequence.app;Rootnet-Porcini Relayer,https://sandbox-testnet-relayer.sequence.app;Sandbox-Testnet Relayer,https://sei-relayer.sequence.app;Sei Relayer,https://sei-testnet-relayer.sequence.app;Sei-Testnet Relayer,https://sepolia-relayer.sequence.app;Sepolia Relayer,https://skale-nebula-relayer.sequence.app;Skale-Nebula Relayer,https://skale-nebula-testnet-relayer.sequence.app;Skale-Nebula-Testnet Relayer,https://somnia-relayer.sequence.app;Somnia Relayer,https://somnia-testnet-relayer.sequence.app;Somnia-Testnet Relayer,https://soneium-relayer.sequence.app;Soneium Relayer,https://soneium-minato-relayer.sequence.app;Soneium-Minato Relayer,https://telos-relayer.sequence.app;Telos Relayer,https://telos-testnet-relayer.sequence.app;Telos-Testnet Relayer,https://toy-testnet-relayer.sequence.app;Toy-Testnet Relayer,https://xai-relayer.sequence.app;Xai Relayer,https://xai-sepolia-relayer.sequence.app;Xai-Sepolia Relayer -securityAnnotation=@auth -securitySchemes={ 'ApiKeyAuth': { 'type': 'apiKey', 'in': 'header', 'description': 'Project access key for authenticating requests, get an access key at https://sequence.build', 'name': 'X-Access-Key' }, } -out=proto/docs/relayer.gen.yaml openapi: 3.0.0 @@ -293,7 +293,7 @@ components: status: type: number example: 500 - ErrorWebrpcClientAborted: + ErrorWebrpcClientDisconnected: type: object required: - error @@ -303,13 +303,13 @@ components: properties: error: type: string - example: "WebrpcClientAborted" + example: "WebrpcClientDisconnected" code: type: number example: -8 msg: type: string - example: "request aborted by client" + example: "client disconnected" cause: type: string status: @@ -1596,6 +1596,49 @@ components: type: string simulate: type: boolean + Relayer_ListGasSponsors_Request: + type: object + properties: + projectId: + type: number + page: + $ref: '#/components/schemas/Page' + Relayer_GetGasSponsor_Request: + type: object + properties: + projectId: + type: number + id: + type: number + Relayer_AddGasSponsor_Request: + type: object + properties: + projectId: + type: number + address: + type: string + name: + type: string + active: + type: boolean + Relayer_UpdateGasSponsor_Request: + type: object + properties: + projectId: + type: number + id: + type: number + name: + type: string + active: + type: boolean + Relayer_RemoveGasSponsor_Request: + type: object + properties: + projectId: + type: number + id: + type: number Relayer_GetChainID_Response: type: object properties: @@ -1625,6 +1668,40 @@ components: type: boolean quote: type: string + Relayer_ListGasSponsors_Response: + type: object + properties: + page: + $ref: '#/components/schemas/Page' + gasSponsors: + type: array + description: '[]GasSponsor' + items: + $ref: '#/components/schemas/GasSponsor' + Relayer_GetGasSponsor_Response: + type: object + properties: + gasSponsor: + $ref: '#/components/schemas/GasSponsor' + Relayer_AddGasSponsor_Response: + type: object + properties: + status: + type: boolean + gasSponsor: + $ref: '#/components/schemas/GasSponsor' + Relayer_UpdateGasSponsor_Response: + type: object + properties: + status: + type: boolean + gasSponsor: + $ref: '#/components/schemas/GasSponsor' + Relayer_RemoveGasSponsor_Response: + type: object + properties: + status: + type: boolean paths: /rpc/Relayer/GetChainID: post: @@ -1654,7 +1731,7 @@ paths: - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientAborted' + - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - $ref: '#/components/schemas/ErrorUnauthorized' - $ref: '#/components/schemas/ErrorPermissionDenied' @@ -1720,7 +1797,7 @@ paths: - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientAborted' + - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - $ref: '#/components/schemas/ErrorUnauthorized' - $ref: '#/components/schemas/ErrorPermissionDenied' @@ -1786,7 +1863,337 @@ paths: - $ref: '#/components/schemas/ErrorWebrpcBadRoute' - $ref: '#/components/schemas/ErrorWebrpcBadMethod' - $ref: '#/components/schemas/ErrorWebrpcBadRequest' - - $ref: '#/components/schemas/ErrorWebrpcClientAborted' + - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' + - $ref: '#/components/schemas/ErrorWebrpcStreamLost' + - $ref: '#/components/schemas/ErrorUnauthorized' + - $ref: '#/components/schemas/ErrorPermissionDenied' + - $ref: '#/components/schemas/ErrorSessionExpired' + - $ref: '#/components/schemas/ErrorMethodNotFound' + - $ref: '#/components/schemas/ErrorRequestConflict' + - $ref: '#/components/schemas/ErrorAborted' + - $ref: '#/components/schemas/ErrorGeoblocked' + - $ref: '#/components/schemas/ErrorRateLimited' + - $ref: '#/components/schemas/ErrorProjectNotFound' + - $ref: '#/components/schemas/ErrorAccessKeyNotFound' + - $ref: '#/components/schemas/ErrorAccessKeyMismatch' + - $ref: '#/components/schemas/ErrorInvalidOrigin' + - $ref: '#/components/schemas/ErrorInvalidService' + - $ref: '#/components/schemas/ErrorUnauthorizedUser' + - $ref: '#/components/schemas/ErrorQuotaExceeded' + - $ref: '#/components/schemas/ErrorQuotaRateLimit' + - $ref: '#/components/schemas/ErrorNoDefaultKey' + - $ref: '#/components/schemas/ErrorMaxAccessKeys' + - $ref: '#/components/schemas/ErrorAtLeastOneKey' + - $ref: '#/components/schemas/ErrorTimeout' + - $ref: '#/components/schemas/ErrorInvalidArgument' + - $ref: '#/components/schemas/ErrorUnavailable' + - $ref: '#/components/schemas/ErrorQueryFailed' + - $ref: '#/components/schemas/ErrorNotFound' + - $ref: '#/components/schemas/ErrorInsufficientFee' + - $ref: '#/components/schemas/ErrorNotEnoughBalance' + - $ref: '#/components/schemas/ErrorSimulationFailed' + '5XX': + description: Server error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcBadResponse' + - $ref: '#/components/schemas/ErrorWebrpcServerPanic' + - $ref: '#/components/schemas/ErrorWebrpcInternalError' + /rpc/Relayer/ListGasSponsors: + post: + operationId: Relayer-ListGasSponsors + tags: ["Relayer"] + summary: "Gas Sponsorship" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Relayer_ListGasSponsors_Request' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Relayer_ListGasSponsors_Response' + '4XX': + description: Client error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcEndpoint' + - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' + - $ref: '#/components/schemas/ErrorWebrpcBadRoute' + - $ref: '#/components/schemas/ErrorWebrpcBadMethod' + - $ref: '#/components/schemas/ErrorWebrpcBadRequest' + - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' + - $ref: '#/components/schemas/ErrorWebrpcStreamLost' + - $ref: '#/components/schemas/ErrorUnauthorized' + - $ref: '#/components/schemas/ErrorPermissionDenied' + - $ref: '#/components/schemas/ErrorSessionExpired' + - $ref: '#/components/schemas/ErrorMethodNotFound' + - $ref: '#/components/schemas/ErrorRequestConflict' + - $ref: '#/components/schemas/ErrorAborted' + - $ref: '#/components/schemas/ErrorGeoblocked' + - $ref: '#/components/schemas/ErrorRateLimited' + - $ref: '#/components/schemas/ErrorProjectNotFound' + - $ref: '#/components/schemas/ErrorAccessKeyNotFound' + - $ref: '#/components/schemas/ErrorAccessKeyMismatch' + - $ref: '#/components/schemas/ErrorInvalidOrigin' + - $ref: '#/components/schemas/ErrorInvalidService' + - $ref: '#/components/schemas/ErrorUnauthorizedUser' + - $ref: '#/components/schemas/ErrorQuotaExceeded' + - $ref: '#/components/schemas/ErrorQuotaRateLimit' + - $ref: '#/components/schemas/ErrorNoDefaultKey' + - $ref: '#/components/schemas/ErrorMaxAccessKeys' + - $ref: '#/components/schemas/ErrorAtLeastOneKey' + - $ref: '#/components/schemas/ErrorTimeout' + - $ref: '#/components/schemas/ErrorInvalidArgument' + - $ref: '#/components/schemas/ErrorUnavailable' + - $ref: '#/components/schemas/ErrorQueryFailed' + - $ref: '#/components/schemas/ErrorNotFound' + - $ref: '#/components/schemas/ErrorInsufficientFee' + - $ref: '#/components/schemas/ErrorNotEnoughBalance' + - $ref: '#/components/schemas/ErrorSimulationFailed' + '5XX': + description: Server error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcBadResponse' + - $ref: '#/components/schemas/ErrorWebrpcServerPanic' + - $ref: '#/components/schemas/ErrorWebrpcInternalError' + /rpc/Relayer/GetGasSponsor: + post: + operationId: Relayer-GetGasSponsor + tags: ["Relayer"] + summary: "" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Relayer_GetGasSponsor_Request' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Relayer_GetGasSponsor_Response' + '4XX': + description: Client error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcEndpoint' + - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' + - $ref: '#/components/schemas/ErrorWebrpcBadRoute' + - $ref: '#/components/schemas/ErrorWebrpcBadMethod' + - $ref: '#/components/schemas/ErrorWebrpcBadRequest' + - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' + - $ref: '#/components/schemas/ErrorWebrpcStreamLost' + - $ref: '#/components/schemas/ErrorUnauthorized' + - $ref: '#/components/schemas/ErrorPermissionDenied' + - $ref: '#/components/schemas/ErrorSessionExpired' + - $ref: '#/components/schemas/ErrorMethodNotFound' + - $ref: '#/components/schemas/ErrorRequestConflict' + - $ref: '#/components/schemas/ErrorAborted' + - $ref: '#/components/schemas/ErrorGeoblocked' + - $ref: '#/components/schemas/ErrorRateLimited' + - $ref: '#/components/schemas/ErrorProjectNotFound' + - $ref: '#/components/schemas/ErrorAccessKeyNotFound' + - $ref: '#/components/schemas/ErrorAccessKeyMismatch' + - $ref: '#/components/schemas/ErrorInvalidOrigin' + - $ref: '#/components/schemas/ErrorInvalidService' + - $ref: '#/components/schemas/ErrorUnauthorizedUser' + - $ref: '#/components/schemas/ErrorQuotaExceeded' + - $ref: '#/components/schemas/ErrorQuotaRateLimit' + - $ref: '#/components/schemas/ErrorNoDefaultKey' + - $ref: '#/components/schemas/ErrorMaxAccessKeys' + - $ref: '#/components/schemas/ErrorAtLeastOneKey' + - $ref: '#/components/schemas/ErrorTimeout' + - $ref: '#/components/schemas/ErrorInvalidArgument' + - $ref: '#/components/schemas/ErrorUnavailable' + - $ref: '#/components/schemas/ErrorQueryFailed' + - $ref: '#/components/schemas/ErrorNotFound' + - $ref: '#/components/schemas/ErrorInsufficientFee' + - $ref: '#/components/schemas/ErrorNotEnoughBalance' + - $ref: '#/components/schemas/ErrorSimulationFailed' + '5XX': + description: Server error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcBadResponse' + - $ref: '#/components/schemas/ErrorWebrpcServerPanic' + - $ref: '#/components/schemas/ErrorWebrpcInternalError' + /rpc/Relayer/AddGasSponsor: + post: + operationId: Relayer-AddGasSponsor + tags: ["Relayer"] + summary: "" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Relayer_AddGasSponsor_Request' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Relayer_AddGasSponsor_Response' + '4XX': + description: Client error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcEndpoint' + - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' + - $ref: '#/components/schemas/ErrorWebrpcBadRoute' + - $ref: '#/components/schemas/ErrorWebrpcBadMethod' + - $ref: '#/components/schemas/ErrorWebrpcBadRequest' + - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' + - $ref: '#/components/schemas/ErrorWebrpcStreamLost' + - $ref: '#/components/schemas/ErrorUnauthorized' + - $ref: '#/components/schemas/ErrorPermissionDenied' + - $ref: '#/components/schemas/ErrorSessionExpired' + - $ref: '#/components/schemas/ErrorMethodNotFound' + - $ref: '#/components/schemas/ErrorRequestConflict' + - $ref: '#/components/schemas/ErrorAborted' + - $ref: '#/components/schemas/ErrorGeoblocked' + - $ref: '#/components/schemas/ErrorRateLimited' + - $ref: '#/components/schemas/ErrorProjectNotFound' + - $ref: '#/components/schemas/ErrorAccessKeyNotFound' + - $ref: '#/components/schemas/ErrorAccessKeyMismatch' + - $ref: '#/components/schemas/ErrorInvalidOrigin' + - $ref: '#/components/schemas/ErrorInvalidService' + - $ref: '#/components/schemas/ErrorUnauthorizedUser' + - $ref: '#/components/schemas/ErrorQuotaExceeded' + - $ref: '#/components/schemas/ErrorQuotaRateLimit' + - $ref: '#/components/schemas/ErrorNoDefaultKey' + - $ref: '#/components/schemas/ErrorMaxAccessKeys' + - $ref: '#/components/schemas/ErrorAtLeastOneKey' + - $ref: '#/components/schemas/ErrorTimeout' + - $ref: '#/components/schemas/ErrorInvalidArgument' + - $ref: '#/components/schemas/ErrorUnavailable' + - $ref: '#/components/schemas/ErrorQueryFailed' + - $ref: '#/components/schemas/ErrorNotFound' + - $ref: '#/components/schemas/ErrorInsufficientFee' + - $ref: '#/components/schemas/ErrorNotEnoughBalance' + - $ref: '#/components/schemas/ErrorSimulationFailed' + '5XX': + description: Server error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcBadResponse' + - $ref: '#/components/schemas/ErrorWebrpcServerPanic' + - $ref: '#/components/schemas/ErrorWebrpcInternalError' + /rpc/Relayer/UpdateGasSponsor: + post: + operationId: Relayer-UpdateGasSponsor + tags: ["Relayer"] + summary: "" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Relayer_UpdateGasSponsor_Request' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Relayer_UpdateGasSponsor_Response' + '4XX': + description: Client error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcEndpoint' + - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' + - $ref: '#/components/schemas/ErrorWebrpcBadRoute' + - $ref: '#/components/schemas/ErrorWebrpcBadMethod' + - $ref: '#/components/schemas/ErrorWebrpcBadRequest' + - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' + - $ref: '#/components/schemas/ErrorWebrpcStreamLost' + - $ref: '#/components/schemas/ErrorUnauthorized' + - $ref: '#/components/schemas/ErrorPermissionDenied' + - $ref: '#/components/schemas/ErrorSessionExpired' + - $ref: '#/components/schemas/ErrorMethodNotFound' + - $ref: '#/components/schemas/ErrorRequestConflict' + - $ref: '#/components/schemas/ErrorAborted' + - $ref: '#/components/schemas/ErrorGeoblocked' + - $ref: '#/components/schemas/ErrorRateLimited' + - $ref: '#/components/schemas/ErrorProjectNotFound' + - $ref: '#/components/schemas/ErrorAccessKeyNotFound' + - $ref: '#/components/schemas/ErrorAccessKeyMismatch' + - $ref: '#/components/schemas/ErrorInvalidOrigin' + - $ref: '#/components/schemas/ErrorInvalidService' + - $ref: '#/components/schemas/ErrorUnauthorizedUser' + - $ref: '#/components/schemas/ErrorQuotaExceeded' + - $ref: '#/components/schemas/ErrorQuotaRateLimit' + - $ref: '#/components/schemas/ErrorNoDefaultKey' + - $ref: '#/components/schemas/ErrorMaxAccessKeys' + - $ref: '#/components/schemas/ErrorAtLeastOneKey' + - $ref: '#/components/schemas/ErrorTimeout' + - $ref: '#/components/schemas/ErrorInvalidArgument' + - $ref: '#/components/schemas/ErrorUnavailable' + - $ref: '#/components/schemas/ErrorQueryFailed' + - $ref: '#/components/schemas/ErrorNotFound' + - $ref: '#/components/schemas/ErrorInsufficientFee' + - $ref: '#/components/schemas/ErrorNotEnoughBalance' + - $ref: '#/components/schemas/ErrorSimulationFailed' + '5XX': + description: Server error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcBadResponse' + - $ref: '#/components/schemas/ErrorWebrpcServerPanic' + - $ref: '#/components/schemas/ErrorWebrpcInternalError' + /rpc/Relayer/RemoveGasSponsor: + post: + operationId: Relayer-RemoveGasSponsor + tags: ["Relayer"] + summary: "" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Relayer_RemoveGasSponsor_Request' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Relayer_RemoveGasSponsor_Response' + '4XX': + description: Client error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcEndpoint' + - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' + - $ref: '#/components/schemas/ErrorWebrpcBadRoute' + - $ref: '#/components/schemas/ErrorWebrpcBadMethod' + - $ref: '#/components/schemas/ErrorWebrpcBadRequest' + - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' - $ref: '#/components/schemas/ErrorWebrpcStreamLost' - $ref: '#/components/schemas/ErrorUnauthorized' - $ref: '#/components/schemas/ErrorPermissionDenied'