diff --git a/docs/pages/api/relayer/rpc.gen.yaml b/docs/pages/api/relayer/rpc.gen.yaml index a4a9a23abd9..1de4e803ace 100644 --- a/docs/pages/api/relayer/rpc.gen.yaml +++ b/docs/pages/api/relayer/rpc.gen.yaml @@ -1,8 +1,8 @@ -# sequence-relayer v0.4.1 aa8b359d22b858519ecd4b5a7927f1241ed4f85b +# sequence-relayer v0.4.1 1f4604a0ed2a112483a6dd07586ca96ad125de98 # -- -# Code generated by webrpc-gen@v0.20.3 with openapi generator; DO NOT EDIT +# Code generated by webrpc-gen@v0.22.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://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://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://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://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://soneium-minato-relayer.sequence.app;Soneium-Minato 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,https://xr-sepolia-relayer.sequence.app;Xr-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 +# 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://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://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://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-devnet-relayer.sequence.app;Somnia-Devnet 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,https://xr-sepolia-relayer.sequence.app;Xr-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 info: title: 'Relayer Api' @@ -40,6 +40,10 @@ servers: description: 'Bsc Relayer' - url: 'https://bsc-testnet-relayer.sequence.app' description: 'Bsc-Testnet Relayer' + - url: 'https://etherlink-relayer.sequence.app' + description: 'Etherlink Relayer' + - url: 'https://etherlink-testnet-relayer.sequence.app' + description: 'Etherlink-Testnet Relayer' - url: 'https://gnosis-relayer.sequence.app' description: 'Gnosis Relayer' - url: 'https://homeverse-relayer.sequence.app' @@ -56,6 +60,10 @@ servers: description: 'Laos-Sigma-Testnet Relayer' - url: 'https://mainnet-relayer.sequence.app' description: 'Mainnet Relayer' + - url: 'https://moonbase-alpha-relayer.sequence.app' + description: 'Moonbase-Alpha Relayer' + - url: 'https://moonbeam-relayer.sequence.app' + description: 'Moonbeam Relayer' - url: 'https://optimism-relayer.sequence.app' description: 'Optimism Relayer' - url: 'https://optimism-sepolia-relayer.sequence.app' @@ -74,8 +82,16 @@ servers: description: 'Skale-Nebula Relayer' - url: 'https://skale-nebula-testnet-relayer.sequence.app' description: 'Skale-Nebula-Testnet Relayer' + - url: 'https://somnia-devnet-relayer.sequence.app' + description: 'Somnia-Devnet Relayer' + - url: 'https://soneium-relayer.sequence.app' + description: 'Soneium Relayer' - url: 'https://soneium-minato-relayer.sequence.app' description: 'Soneium-Minato Relayer' + - url: 'https://telos-relayer.sequence.app' + description: 'Telos Relayer' + - url: 'https://telos-testnet-relayer.sequence.app' + description: 'Telos-Testnet Relayer' - url: 'https://toy-testnet-relayer.sequence.app' description: 'Toy-Testnet Relayer' - url: 'https://xai-relayer.sequence.app' @@ -373,6 +389,28 @@ components: status: type: number example: 403 + ErrorSessionExpired: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "SessionExpired" + code: + type: number + example: 1002 + msg: + type: string + example: "Session expired" + cause: + type: string + status: + type: number + example: 403 ErrorMethodNotFound: type: object required: @@ -461,6 +499,292 @@ components: status: type: number example: 451 + ErrorRateLimited: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "RateLimited" + code: + type: number + example: 1007 + msg: + type: string + example: "Rate-limited. Please slow down." + cause: + type: string + status: + type: number + example: 429 + ErrorProjectNotFound: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "ProjectNotFound" + code: + type: number + example: 1008 + msg: + type: string + example: "Project not found" + cause: + type: string + status: + type: number + example: 401 + ErrorAccessKeyNotFound: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "AccessKeyNotFound" + code: + type: number + example: 1101 + msg: + type: string + example: "Access key not found" + cause: + type: string + status: + type: number + example: 401 + ErrorAccessKeyMismatch: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "AccessKeyMismatch" + code: + type: number + example: 1102 + msg: + type: string + example: "Access key mismatch" + cause: + type: string + status: + type: number + example: 409 + ErrorInvalidOrigin: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "InvalidOrigin" + code: + type: number + example: 1103 + msg: + type: string + example: "Invalid origin for Access Key" + cause: + type: string + status: + type: number + example: 403 + ErrorInvalidService: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "InvalidService" + code: + type: number + example: 1104 + msg: + type: string + example: "Service not enabled for Access key" + cause: + type: string + status: + type: number + example: 403 + ErrorUnauthorizedUser: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "UnauthorizedUser" + code: + type: number + example: 1105 + msg: + type: string + example: "Unauthorized user" + cause: + type: string + status: + type: number + example: 403 + ErrorQuotaExceeded: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "QuotaExceeded" + code: + type: number + example: 1200 + msg: + type: string + example: "Quota request exceeded" + cause: + type: string + status: + type: number + example: 429 + ErrorQuotaRateLimit: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "QuotaRateLimit" + code: + type: number + example: 1201 + msg: + type: string + example: "Quota rate limit exceeded" + cause: + type: string + status: + type: number + example: 429 + ErrorNoDefaultKey: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "NoDefaultKey" + code: + type: number + example: 1300 + msg: + type: string + example: "No default access key found" + cause: + type: string + status: + type: number + example: 403 + ErrorMaxAccessKeys: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "MaxAccessKeys" + code: + type: number + example: 1301 + msg: + type: string + example: "Access keys limit reached" + cause: + type: string + status: + type: number + example: 403 + ErrorAtLeastOneKey: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "AtLeastOneKey" + code: + type: number + example: 1302 + msg: + type: string + example: "You need at least one Access Key" + cause: + type: string + status: + type: number + example: 403 + ErrorTimeout: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "Timeout" + code: + type: number + example: 1900 + msg: + type: string + example: "Request timed out" + cause: + type: string + status: + type: number + example: 408 ErrorInvalidArgument: type: object required: @@ -813,13 +1137,10 @@ components: MetaTxn: type: object required: - - chainId - walletAddress - contract - input properties: - chainId: - type: number walletAddress: type: string contract: @@ -851,6 +1172,7 @@ components: - gasEstimated - usdRate - creditsUsed + - cost - isWhitelisted - updatedAt - createdAt @@ -911,6 +1233,8 @@ components: type: string creditsUsed: type: number + cost: + type: string isWhitelisted: type: boolean gasSponsor: @@ -1202,10 +1526,24 @@ paths: - $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' @@ -1250,10 +1588,24 @@ paths: - $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' @@ -1298,10 +1650,24 @@ paths: - $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'