relayer

AddGasSponsor

SecurityApiKeyAuth

Request

Request Body schema: application/json

active	boolean
address	string
gasTankId	number
name	string
projectId	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/AddGasSponsor

Request samples

Payload
curl

application/json

{"active": true,
"address": "string",
"gasTankId": 0,
"name": "string",
"projectId": 0
}

Response samples

application/json

{"gasSponsor": {"active": true,
"address": "string",
"createdAt": "string",
"deletedAt": "string",
"gasTankId": 0,
"id": 0,
"name": "string",
"projectId": 0,
"updatedAt": "string"
},
"status": true
}

AddGasTank

SecurityApiKeyAuth

Request

Request Body schema: application/json

feeMarkupFactor	number
name	string
unlimited	boolean

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/AddGasTank

Request samples

Payload
curl

application/json

{"feeMarkupFactor": 0,
"name": "string",
"unlimited": true
}

Response samples

application/json

{"gasTank": {"createdAt": "string",
"currentBalance": 0,
"feeMarkupFactor": 0,
"id": 0,
"name": "string",
"unlimited": true,
"updatedAt": "string"
},
"status": true
}

AddressGasSponsors

SecurityApiKeyAuth

Request

Request Body schema: application/json

address	string
	object (Page)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/AddressGasSponsors

Request samples

Payload
curl

application/json

{"address": "string",
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

Response samples

application/json

{"gasSponsors": [{"active": true,
"address": "string",
"createdAt": "string",
"deletedAt": "string",
"gasTankId": 0,
"id": 0,
"name": "string",
"projectId": 0,
"updatedAt": "string"
}
],
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

AdjustGasTankBalance

SecurityApiKeyAuth

Request

Request Body schema: application/json

amount	number
id	number
nonce	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/AdjustGasTankBalance

Request samples

Payload
curl

application/json

{"amount": 0,
"id": 0,
"nonce": 0
}

Response samples

application/json

{"adjustment": {"amount": 0,
"balanceTimestamp": "string",
"createdAt": "string",
"gasTankId": 0,
"nonce": 0,
"totalBalance": 0
},
"status": true
}

FeeOptions

SecurityApiKeyAuth

Request

Request Body schema: application/json

data	string
simulate	boolean
to	string
wallet	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/FeeOptions

Request samples

Payload
curl

application/json

{"data": "string",
"simulate": true,
"to": "string",
"wallet": "string"
}

Response samples

application/json

{"options": [{"gasLimit": 0,
"to": "string",
"token": {"chainId": 0,
"contractAddress": "string",
"decimals": 0,
"logoURL": "string",
"name": "string",
"symbol": "string",
"tokenID": "string",
"type": "UNKNOWN"
},
"value": "string"
}
],
"quote": "string",
"sponsored": true
}

FeeTokens

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (Relayer_FeeTokens_Request)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/FeeTokens

Request samples

Payload
curl

application/json

{ }

Response samples

application/json

{"isFeeRequired": true,
"tokens": [{"chainId": 0,
"contractAddress": "string",
"decimals": 0,
"logoURL": "string",
"name": "string",
"symbol": "string",
"tokenID": "string",
"type": "UNKNOWN"
}
]
}

GetChainID

TODO: return a string instead

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (Relayer_GetChainID_Request)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/GetChainID

Request samples

Payload
curl

application/json

{ }

Response samples

application/json

{"chainID": 0
}

GetGasSponsor

SecurityApiKeyAuth

Request

Request Body schema: application/json

number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/GetGasSponsor

Request samples

Payload
curl

application/json

{"id": 0
}

Response samples

application/json

{"gasSponsor": {"active": true,
"address": "string",
"createdAt": "string",
"deletedAt": "string",
"gasTankId": 0,
"id": 0,
"name": "string",
"projectId": 0,
"updatedAt": "string"
}
}

GetGasTank

SecurityApiKeyAuth

Request

Request Body schema: application/json

number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/GetGasTank

Request samples

Payload
curl

application/json

{"id": 0
}

Response samples

application/json

{"gasTank": {"createdAt": "string",
"currentBalance": 0,
"feeMarkupFactor": 0,
"id": 0,
"name": "string",
"unlimited": true,
"updatedAt": "string"
}
}

GetGasTankBalanceAdjustment

SecurityApiKeyAuth

Request

Request Body schema: application/json

id	number
nonce	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/GetGasTankBalanceAdjustment

Request samples

Payload
curl

application/json

{"id": 0,
"nonce": 0
}

Response samples

application/json

{"adjustment": {"amount": 0,
"balanceTimestamp": "string",
"createdAt": "string",
"gasTankId": 0,
"nonce": 0,
"totalBalance": 0
}
}

GetMetaTransactions

SecurityApiKeyAuth

Request

Request Body schema: application/json

gasTankId	number
	object (Page)
projectId	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/GetMetaTransactions

Request samples

Payload
curl

application/json

{"gasTankId": 0,
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
},
"projectId": 0
}

Response samples

application/json

{"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
},
"transactions": [{"createdAt": "string",
"creditsUsed": 0,
"gasEstimated": 0,
"gasFeeMarkup": 0,
"gasLimit": 0,
"gasPrice": "string",
"gasSponsor": 0,
"gasTank": 0,
"gasUsed": 0,
"id": 0,
"input": "string",
"isWhitelisted": true,
"metaTxnID": "string",
"metaTxnNonce": "string",
"minedAt": "string",
"projectId": 0,
"queuedAt": "string",
"requeues": 0,
"sentAt": "string",
"target": "string",
"txnArgs": {"property1": { },
"property2": { }
},
"txnHash": "string",
"txnNonce": "string",
"txnReceipt": {"property1": { },
"property2": { }
},
"txnRevertReason": "string",
"txnStatus": "UNKNOWN",
"updatedAt": "string",
"usdRate": "string",
"walletAddress": "string"
}
]
}

GetMetaTxnNetworkFeeOptions

TODO: deprecated, to be removed by https://github.com/0xsequence/stack/pull/356 at a later date

SecurityApiKeyAuth

Request

Request Body schema: application/json

payload	string
walletConfig	object

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/GetMetaTxnNetworkFeeOptions

Request samples

Payload
curl

application/json

{"payload": "string",
"walletConfig": { }
}

Response samples

application/json

{"options": [{"gasLimit": 0,
"to": "string",
"token": {"chainId": 0,
"contractAddress": "string",
"decimals": 0,
"logoURL": "string",
"name": "string",
"symbol": "string",
"tokenID": "string",
"type": "UNKNOWN"
},
"value": "string"
}
]
}

GetMetaTxnNonce

SecurityApiKeyAuth

Request

Request Body schema: application/json

space	string
walletContractAddress	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/GetMetaTxnNonce

Request samples

Payload
curl

application/json

{"space": "string",
"walletContractAddress": "string"
}

Response samples

application/json

{"nonce": "string"
}

GetMetaTxnReceipt

TODO: one day, make GetMetaTxnReceipt respond immediately with receipt or not and add WaitTransactionReceipt method, which will block and wait, similar to how GetMetaTxnReceipt is implemented now. For backwards compat, we can leave the current GetMetaTxnReceipt how it is, an deprecate it, and introduce new, GetTransactionReceipt and WaitTransactionReceipt methods we can also accept metaTxnId and txnHash .. so can take either or.. I wonder if ERC-4337 has any convention on this?

SecurityApiKeyAuth

Request

Request Body schema: application/json

metaTxID

string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/GetMetaTxnReceipt

Request samples

Payload
curl

application/json

{"metaTxID": "string"
}

Response samples

application/json

{"receipt": {"id": "string",
"index": 0,
"logs": [{"address": "string",
"data": "string",
"topics": ["string"
]
}
],
"receipts": [{ }
],
"revertReason": "string",
"status": "string",
"txnReceipt": "string"
}
}

GetSequenceContext

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (Relayer_GetSequenceContext_Request)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/GetSequenceContext

Request samples

Payload
curl

application/json

{ }

Response samples

application/json

{"data": {"factory": "string",
"guestModule": "string",
"mainModule": "string",
"mainModuleUpgradable": "string",
"utils": "string"
}
}

ListGasSponsors

SecurityApiKeyAuth

Request

Request Body schema: application/json

gasTankId	number
	object (Page)
projectId	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/ListGasSponsors

Request samples

Payload
curl

application/json

{"gasTankId": 0,
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
},
"projectId": 0
}

Response samples

application/json

{"gasSponsors": [{"active": true,
"address": "string",
"createdAt": "string",
"deletedAt": "string",
"gasTankId": 0,
"id": 0,
"name": "string",
"projectId": 0,
"updatedAt": "string"
}
],
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

ListGasTankBalanceAdjustments

SecurityApiKeyAuth

Request

Request Body schema: application/json

id	number
	object (Page)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/ListGasTankBalanceAdjustments

Request samples

Payload
curl

application/json

{"id": 0,
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

Response samples

application/json

{"adjustments": [{"amount": 0,
"balanceTimestamp": "string",
"createdAt": "string",
"gasTankId": 0,
"nonce": 0,
"totalBalance": 0
}
],
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

NextGasTankBalanceAdjustmentNonce

SecurityApiKeyAuth

Request

Request Body schema: application/json

number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/NextGasTankBalanceAdjustmentNonce

Request samples

Payload
curl

application/json

{"id": 0
}

Response samples

application/json

{"nonce": 0
}

PendingTransactions

Pending transactions waiting to be mined for an account. This endpoint is just a sugar of SentTransactions with the filter set to pending: true.

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (Page)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/PendingTransactions

Request samples

Payload
curl

application/json

{"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

Response samples

application/json

{"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
},
"transactions": [{"blockNumber": 0,
"chainId": 0,
"metaTxnID": "string",
"timestamp": "string",
"transfers": [{"amounts": ["string"
],
"contractAddress": "string",
"from": "string",
"ids": ["string"
],
"to": "string",
"transferType": "SEND"
}
],
"txnHash": "string",
"users": {"property1": {"username": "string"
},
"property2": {"username": "string"
}
}
}
]
}

Ping

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (Relayer_Ping_Request)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/Ping

Request samples

Payload
curl

application/json

{ }

Response samples

application/json

{"status": true
}

RemoveGasSponsor

SecurityApiKeyAuth

Request

Request Body schema: application/json

number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/RemoveGasSponsor

Request samples

Payload
curl

application/json

{"id": 0
}

Response samples

application/json

{"status": true
}

ReportGasSponsorUsage

SecurityApiKeyAuth

Request

Request Body schema: application/json

endTime	string
gasTankId	number
projectId	number
startTime	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/ReportGasSponsorUsage

Request samples

Payload
curl

application/json

{"endTime": "string",
"gasTankId": 0,
"projectId": 0,
"startTime": "string"
}

Response samples

application/json

{"gasSponsorUsage": [{"avgGasPrice": 0,
"endTime": "string",
"id": 0,
"name": "string",
"startTime": "string",
"totalGasUsed": 0,
"totalTxnFees": 0,
"totalTxnFeesUsd": 0,
"totalTxns": 0
}
]
}

RuntimeStatus

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (Relayer_RuntimeStatus_Request)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/RuntimeStatus

Request samples

Payload
curl

application/json

{ }

Response samples

application/json

{"status": {"branch": "string",
"checks": { },
"commitHash": "string",
"healthOK": true,
"numTxnsRelayed": {"current": 0,
"period": 0,
"prev": 0
},
"senders": [{"active": true,
"address": "string",
"etherBalance": 0,
"index": 0
}
],
"startTime": "string",
"uptime": 0,
"useEIP1559": true,
"ver": "string"
}
}

SendMetaTxn

Transactions TODO (future): rename this to just, 'SendTransaction(txn: MetaTransaction)' or 'SendTransaction(txn: SignedTransaction)', or something.. Project ID is only used by service and admin calls. Other clients must have projectID passed via the context TODO: rename return txnHash: string to metaTxnID: string

SecurityApiKeyAuth

Request

Request Body schema: application/json

	object (MetaTxn)
projectID	number
quote	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/SendMetaTxn

Request samples

Payload
curl

application/json

{"call": {"contract": "string",
"input": "string",
"walletAddress": "string"
},
"projectID": 0,
"quote": "string"
}

Response samples

application/json

{"status": true,
"txnHash": "string"
}

SentTransactions

Sent transactions from an account. If filter is omitted then it will return all transactions.

SecurityApiKeyAuth

Request

Request Body schema: application/json

	object (SentTransactionsFilter)
	object (Page)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/SentTransactions

Request samples

Payload
curl

application/json

{"filter": {"failed": true,
"pending": true
},
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

Response samples

application/json

{"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
},
"transactions": [{"blockNumber": 0,
"chainId": 0,
"metaTxnID": "string",
"timestamp": "string",
"transfers": [{"amounts": ["string"
],
"contractAddress": "string",
"from": "string",
"ids": ["string"
],
"to": "string",
"transferType": "SEND"
}
],
"txnHash": "string",
"users": {"property1": {"username": "string"
},
"property2": {"username": "string"
}
}
}
]
}

Simulate

SecurityApiKeyAuth

Request

Request Body schema: application/json

transactions	string
wallet	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/Simulate

Request samples

Payload
curl

application/json

{"transactions": "string",
"wallet": "string"
}

Response samples

application/json

{"results": [{"executed": true,
"gasLimit": 0,
"gasUsed": 0,
"reason": "string",
"result": "string",
"succeeded": true
}
]
}

UpdateGasSponsor

SecurityApiKeyAuth

Request

Request Body schema: application/json

active	boolean
id	number
name	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/UpdateGasSponsor

Request samples

Payload
curl

application/json

{"active": true,
"id": 0,
"name": "string"
}

Response samples

application/json

{"gasSponsor": {"active": true,
"address": "string",
"createdAt": "string",
"deletedAt": "string",
"gasTankId": 0,
"id": 0,
"name": "string",
"projectId": 0,
"updatedAt": "string"
},
"status": true
}

UpdateGasTank

SecurityApiKeyAuth

Request

Request Body schema: application/json

feeMarkupFactor	number
id	number
name	string
unlimited	boolean

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/UpdateGasTank

Request samples

Payload
curl

application/json

{"feeMarkupFactor": 0,
"id": 0,
"name": "string",
"unlimited": true
}

Response samples

application/json

{"gasTank": {"createdAt": "string",
"currentBalance": 0,
"feeMarkupFactor": 0,
"id": 0,
"name": "string",
"unlimited": true,
"updatedAt": "string"
},
"status": true
}

UpdateMetaTxnGasLimits

TODO: deprecated, to be removed by https://github.com/0xsequence/stack/pull/356 at a later date

SecurityApiKeyAuth

Request

Request Body schema: application/json

payload	string
walletAddress	string
walletConfig	object

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/UpdateMetaTxnGasLimits

Request samples

Payload
curl

application/json

{"payload": "string",
"walletAddress": "string",
"walletConfig": { }
}

Response samples

application/json

{"payload": "string"
}

Version

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (Relayer_Version_Request)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Relayer/Version

Request samples

Payload
curl

application/json

{ }

Response samples

application/json

{"version": {"appVersion": "string",
"schemaHash": "string",
"schemaVersion": "string",
"webrpcVersion": "string"
}
}