Skip to main content

RelayRequest

tx objectrequired

The 17 proxy fields of a MultiversX transaction. Unknown members give UNSUPPORTED_TX_FIELD.

nonceinteger<int64>required

Possible values: >= 0

valuestringrequired

Possible values: Value must match regular expression ^[0-9]+$

receiverAddressrequired

MultiversX bech32 address.

Possible values: Value must match regular expression ^erd1[02-9ac-hj-np-z]{58}$

Example: erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e
senderAddressrequired

MultiversX bech32 address.

Possible values: Value must match regular expression ^erd1[02-9ac-hj-np-z]{58}$

Example: erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e
senderUsernamestring

base64

receiverUsernamestring

base64

gasPriceinteger<int64>required

Possible values: >= 1

gasLimitinteger<int64>required

Possible values: >= 1 and <= 600000000

datastring

base64

chainIDstringrequired
versionintegerrequired

Possible values: [1, 2]

optionsinteger

Possible values: [0, 1, 2, 3]

guardianAddress

MultiversX bech32 address.

Possible values: Value must match regular expression ^erd1[02-9ac-hj-np-z]{58}$

Example: erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e
signaturestringrequired

Possible values: Value must match regular expression ^[0-9a-f]{128}$

guardianSignaturestring

Possible values: Value must match regular expression ^[0-9a-f]{128}$

relayerAddressrequired

MultiversX bech32 address.

Possible values: Value must match regular expression ^erd1[02-9ac-hj-np-z]{58}$

Example: erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e
relayerSignaturestring

Must be absent or empty (RELAYER_SIGNATURE_PRESENT).

leasestringrequired
modeRelayMode

Possible values: [normal, cancel, replace]

Default value: normal
simulateboolean

Simulate before co-signing. On by default for human tiers and the free flow; agent tiers can opt out.

accountAddress

Optional. Bill this account, provided it has authorised the sender on chain.

Possible values: Value must match regular expression ^erd1[02-9ac-hj-np-z]{58}$

Example: erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e
intentKeystring

Optional idempotency key for this user action, 16 to 128 visible ASCII characters. It is the same key as the Idempotency-Key header; if you send both, the header is used. Reusing it with different bytes or another nonce, while the first intent is not DEAD, gives 409 INTENT_ALREADY_SUBMITTED.

Possible values: >= 16 characters and <= 128 characters, Value must match regular expression ^[\x21-\x7E]+$

RelayRequest
{
  "tx": {
    "nonce": 0,
    "value": "string",
    "receiver": "erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e",
    "sender": "erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e",
    "senderUsername": "string",
    "receiverUsername": "string",
    "gasPrice": 0,
    "gasLimit": 0,
    "data": "string",
    "chainID": "string",
    "version": 1,
    "options": 0,
    "guardian": "erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e",
    "signature": "string",
    "guardianSignature": "string",
    "relayer": "erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e",
    "relayerSignature": "string"
  },
  "lease": "string",
  "mode": "normal",
  "simulate": true,
  "account": "erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e",
  "intentKey": "string"
}