Skip to content
Open
78 changes: 57 additions & 21 deletions docs/pages/api/relayer/rpc.gen.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# sequence-relayer v0.4.1 fbfff38a4ab40460ad18af7b7c60bb67e3b35ea5
# sequence-relayer v0.4.1 79bc8587bcdd2a699a446797e518730be33110a2
# --
# Code generated by webrpc-gen@v0.31.2 with openapi@v0.16.4 generator; DO NOT EDIT
#
# webrpc-gen -service=Relayer -match=@public -schema=proto/relayer.ridl -target=openapi@v0.16.4 -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://arc-testnet-relayer.sequence.app;Arc-Testnet 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-shadownet-testnet-relayer.sequence.app;Etherlink-Shadownet-Testnet 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-relayer.sequence.app;Incentiv Relayer,https://incentiv-testnet-v2-relayer.sequence.app;Incentiv-Testnet-V2 Relayer,https://katana-relayer.sequence.app;Katana 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://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
# webrpc-gen -service=Relayer -match=@public -schema=proto/relayer.ridl -target=openapi@v0.16.4 -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://arc-testnet-relayer.sequence.app;Arc-Testnet 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://berachain-relayer.sequence.app;Berachain 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-shadownet-testnet-relayer.sequence.app;Etherlink-Shadownet-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://hyperevm-relayer.sequence.app;Hyperevm Relayer,https://immutable-zkevm-relayer.sequence.app;Immutable-Zkevm Relayer,https://immutable-zkevm-testnet-relayer.sequence.app;Immutable-Zkevm-Testnet Relayer,https://incentiv-relayer.sequence.app;Incentiv Relayer,https://incentiv-testnet-v2-relayer.sequence.app;Incentiv-Testnet-V2 Relayer,https://katana-relayer.sequence.app;Katana 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://sandbox-testnet-relayer.sequence.app;Sandbox-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://sonic-relayer.sequence.app;Sonic 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
info:
title: 'Relayer Api'
Expand Down Expand Up @@ -34,6 +34,8 @@ servers:
description: 'Base Relayer'
- url: 'https://base-sepolia-relayer.sequence.app'
description: 'Base-Sepolia Relayer'
- url: 'https://berachain-relayer.sequence.app'
description: 'Berachain Relayer'
- url: 'https://blast-relayer.sequence.app'
description: 'Blast Relayer'
- url: 'https://blast-sepolia-relayer.sequence.app'
Expand All @@ -46,14 +48,14 @@ servers:
description: 'Etherlink Relayer'
- url: 'https://etherlink-shadownet-testnet-relayer.sequence.app'
description: 'Etherlink-Shadownet-Testnet 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'
description: 'Homeverse Relayer'
- url: 'https://homeverse-testnet-relayer.sequence.app'
description: 'Homeverse-Testnet Relayer'
- url: 'https://hyperevm-relayer.sequence.app'
description: 'Hyperevm Relayer'
- url: 'https://immutable-zkevm-relayer.sequence.app'
description: 'Immutable-Zkevm Relayer'
- url: 'https://immutable-zkevm-testnet-relayer.sequence.app'
Expand Down Expand Up @@ -84,10 +86,6 @@ servers:
description: 'Polygon-Zkevm Relayer'
- url: 'https://sandbox-testnet-relayer.sequence.app'
description: 'Sandbox-Testnet Relayer'
- url: 'https://sei-relayer.sequence.app'
description: 'Sei Relayer'
- url: 'https://sei-testnet-relayer.sequence.app'
description: 'Sei-Testnet Relayer'
- url: 'https://sepolia-relayer.sequence.app'
description: 'Sepolia Relayer'
- url: 'https://skale-nebula-relayer.sequence.app'
Expand All @@ -102,6 +100,8 @@ servers:
description: 'Soneium Relayer'
- url: 'https://soneium-minato-relayer.sequence.app'
description: 'Soneium-Minato Relayer'
- url: 'https://sonic-relayer.sequence.app'
description: 'Sonic Relayer'
- url: 'https://telos-relayer.sequence.app'
description: 'Telos Relayer'
- url: 'https://telos-testnet-relayer.sequence.app'
Expand Down Expand Up @@ -598,7 +598,7 @@ components:
type: string
status:
type: number
example: 409
example: 403
ErrorInvalidOrigin:
type: object
required:
Expand Down Expand Up @@ -665,6 +665,28 @@ components:
status:
type: number
example: 403
ErrorInvalidChain:
type: object
required:
- error
- code
- msg
- status
properties:
error:
type: string
example: "InvalidChain"
code:
type: number
example: 1106
msg:
type: string
example: "Network not enabled for Access key"
cause:
type: string
status:
type: number
example: 403
ErrorQuotaExceeded:
type: object
required:
Expand Down Expand Up @@ -963,6 +985,7 @@ components:
- PARTIALLY_FAILED
- FAILED
- PENDING_PRECONDITION
- MINED
TransferType:
type: string
description: Represented as uint32 on the server side
Expand Down Expand Up @@ -990,9 +1013,9 @@ components:
- UNKNOWN
- ERC20_TOKEN
- ERC1155_TOKEN
SortOrder:
Order:
type: string
description: Represented as uint32 on the server side
description: Represented as string on the server side
enum:
- DESC
- ASC
Expand Down Expand Up @@ -1055,6 +1078,7 @@ components:
- index
- address
- etherBalance
- enabled
- active
properties:
index:
Expand All @@ -1063,6 +1087,8 @@ components:
type: string
etherBalance:
type: number
enabled:
type: boolean
active:
type: boolean
RuntimeChecks:
Expand Down Expand Up @@ -1272,6 +1298,8 @@ components:
type: string
input:
type: string
bridgeGas:
type: string
txnArgs:
type: object
description: 'map<string,any>'
Expand Down Expand Up @@ -1545,27 +1573,27 @@ components:
type: string
Page:
type: object
required:
- pageSize
- page
- more
- column
- sort
properties:
pageSize:
type: number
page:
type: number
more:
type: boolean
totalRecords:
type: number
column:
type: string
before:
type: object
after:
type: object
sort:
type: array
description: '[]SortBy'
description: '[]Sort'
items:
$ref: '#/components/schemas/SortBy'
SortBy:
$ref: '#/components/schemas/Sort'
Sort:
type: object
required:
- column
Expand All @@ -1574,7 +1602,7 @@ components:
column:
type: string
order:
$ref: '#/components/schemas/SortOrder'
$ref: '#/components/schemas/Order'
Relayer_GetChainID_Request:
type: object
Relayer_FeeTokens_Request:
Expand Down Expand Up @@ -1741,6 +1769,7 @@ paths:
- $ref: '#/components/schemas/ErrorInvalidOrigin'
- $ref: '#/components/schemas/ErrorInvalidService'
- $ref: '#/components/schemas/ErrorUnauthorizedUser'
- $ref: '#/components/schemas/ErrorInvalidChain'
- $ref: '#/components/schemas/ErrorQuotaExceeded'
- $ref: '#/components/schemas/ErrorQuotaRateLimit'
- $ref: '#/components/schemas/ErrorNoDefaultKey'
Expand Down Expand Up @@ -1807,6 +1836,7 @@ paths:
- $ref: '#/components/schemas/ErrorInvalidOrigin'
- $ref: '#/components/schemas/ErrorInvalidService'
- $ref: '#/components/schemas/ErrorUnauthorizedUser'
- $ref: '#/components/schemas/ErrorInvalidChain'
- $ref: '#/components/schemas/ErrorQuotaExceeded'
- $ref: '#/components/schemas/ErrorQuotaRateLimit'
- $ref: '#/components/schemas/ErrorNoDefaultKey'
Expand Down Expand Up @@ -1873,6 +1903,7 @@ paths:
- $ref: '#/components/schemas/ErrorInvalidOrigin'
- $ref: '#/components/schemas/ErrorInvalidService'
- $ref: '#/components/schemas/ErrorUnauthorizedUser'
- $ref: '#/components/schemas/ErrorInvalidChain'
- $ref: '#/components/schemas/ErrorQuotaExceeded'
- $ref: '#/components/schemas/ErrorQuotaRateLimit'
- $ref: '#/components/schemas/ErrorNoDefaultKey'
Expand Down Expand Up @@ -1939,6 +1970,7 @@ paths:
- $ref: '#/components/schemas/ErrorInvalidOrigin'
- $ref: '#/components/schemas/ErrorInvalidService'
- $ref: '#/components/schemas/ErrorUnauthorizedUser'
- $ref: '#/components/schemas/ErrorInvalidChain'
- $ref: '#/components/schemas/ErrorQuotaExceeded'
- $ref: '#/components/schemas/ErrorQuotaRateLimit'
- $ref: '#/components/schemas/ErrorNoDefaultKey'
Expand Down Expand Up @@ -2005,6 +2037,7 @@ paths:
- $ref: '#/components/schemas/ErrorInvalidOrigin'
- $ref: '#/components/schemas/ErrorInvalidService'
- $ref: '#/components/schemas/ErrorUnauthorizedUser'
- $ref: '#/components/schemas/ErrorInvalidChain'
- $ref: '#/components/schemas/ErrorQuotaExceeded'
- $ref: '#/components/schemas/ErrorQuotaRateLimit'
- $ref: '#/components/schemas/ErrorNoDefaultKey'
Expand Down Expand Up @@ -2071,6 +2104,7 @@ paths:
- $ref: '#/components/schemas/ErrorInvalidOrigin'
- $ref: '#/components/schemas/ErrorInvalidService'
- $ref: '#/components/schemas/ErrorUnauthorizedUser'
- $ref: '#/components/schemas/ErrorInvalidChain'
- $ref: '#/components/schemas/ErrorQuotaExceeded'
- $ref: '#/components/schemas/ErrorQuotaRateLimit'
- $ref: '#/components/schemas/ErrorNoDefaultKey'
Expand Down Expand Up @@ -2137,6 +2171,7 @@ paths:
- $ref: '#/components/schemas/ErrorInvalidOrigin'
- $ref: '#/components/schemas/ErrorInvalidService'
- $ref: '#/components/schemas/ErrorUnauthorizedUser'
- $ref: '#/components/schemas/ErrorInvalidChain'
- $ref: '#/components/schemas/ErrorQuotaExceeded'
- $ref: '#/components/schemas/ErrorQuotaRateLimit'
- $ref: '#/components/schemas/ErrorNoDefaultKey'
Expand Down Expand Up @@ -2203,6 +2238,7 @@ paths:
- $ref: '#/components/schemas/ErrorInvalidOrigin'
- $ref: '#/components/schemas/ErrorInvalidService'
- $ref: '#/components/schemas/ErrorUnauthorizedUser'
- $ref: '#/components/schemas/ErrorInvalidChain'
- $ref: '#/components/schemas/ErrorQuotaExceeded'
- $ref: '#/components/schemas/ErrorQuotaRateLimit'
- $ref: '#/components/schemas/ErrorNoDefaultKey'
Expand Down