Relayer information

Address, batching settings, token requirement, issuer and OHTTP gateway key.

GET /v1/info

Relayer information

cURL

curl --request GET \
  --url https://relay-1.example.com/v1/info

200

{
  "address": "0x1111111111111111111111111111111111111111",
  "version": "arkognito-relayer/1",
  "chainId": 7738577,
  "minBatch": 5,
  "maxWaitMs": 60000,
  "minIntervalBlocks": 5,
  "tokensRequired": true,
  "maxMinAnonymity": 50,
  "maxHoldMs": 1800000,
  "issuer": "0x1111111111111111111111111111111111111111",
  "issuerUrl": "<string>",
  "ohttpKey": "<string>"
}

Response

200 - application/json

Relayer information

address · string · required

Pattern: ^0x[0-9a-fA-F]{40}$

Example:

"0x1111111111111111111111111111111111111111"

version · string · required

Allowed value: "arkognito-relayer/1"

chainId · integer · required

Example:

7738577

minBatch · integer · required

Example:

5

maxWaitMs · integer · required

Example:

60000

minIntervalBlocks · integer · required

Example:

5

tokensRequired · boolean · required

maxMinAnonymity · integer · required

Example:

50

maxHoldMs · integer · required

Example:

1800000

issuer · string

Issuer whose arkognito.issuerKey entities this relayer accepts, when tokens are required.

Pattern: ^0x[0-9a-fA-F]{40}$

Example:

"0x1111111111111111111111111111111111111111"

issuerUrl · string<uri>

Issuer base URL, when tokens are required.

ohttpKey · string

OHTTP gateway key (X25519). Also published in the relayer's heartbeat.

Pattern: ^0x[0-9a-fA-F]*$