Skip to content

Update docs for relayed transactions #1081

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 18, 2025
Merged

Update docs for relayed transactions #1081

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions docs/developers/relayed-transactions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ Once all applications will completely transition to relayed v3 model, v1 and v2

## Relayed transactions version 1

:::note
Legacy version. Please use [version 3](#relayed-transactions-version-3), instead.
:::

A relayed transaction version 1 relies on having the inner transaction JSON serialized and given as an argument to the `relayedTx` protocol function.

It would look like:
Expand Down Expand Up @@ -165,6 +169,10 @@ gasLimit = 61040000 // just like the gas limit set in the relayed transaction

## Relayed transactions version 2

:::note
Legacy version. Please use [version 3](#relayed-transactions-version-3), instead.
:::

In contrast with version 1, relayed transactions version 2 have only certain fields of the inner transaction included
in the data field, making the payload smaller, therefore the tx fee smaller. It also eliminates the need of calculating
the matching gas limit values between the relayed and inner transactions.
Expand Down Expand Up @@ -249,10 +257,6 @@ Decoding the arguments ([useful resources here](/developers/sc-calls-format/)) w

## Relayed transactions version 3

:::note
This feature is not yet available on **Mainnet**. See [Spica Protocol Upgrade](https://governance.multiversx.com/proposal/erd1qqqqqqqqqqqqqpgq4qvrwlr2e6ld50f3qfc94am38p8298kthg4s3f0vfn/1).
:::

Relayed transactions v3 feature comes with a change on the entire transaction structure, adding two new optional fields:
- `relayer`, which is the relayer address that will pay the fees.
- `relayerSignature`, the signature of the relayer that proves the agreement of the relayer.
Expand Down Expand Up @@ -316,3 +320,11 @@ Here's an example of a relayed v3 transaction. Its intent is to call the `add` m
"relayerSignature": "..."
}
```

### Preparing relayed transactions using the SDKs

The SDKs have built-in support for relayed transactions. Please follow:
- [mxpy support](/sdk-and-tools/sdk-py/mxpy-cli/#relayed-transactions-v3)
- [sdk-py support](/sdk-and-tools/sdk-py/sdk-py-cookbook/#relayed-transactions)
- [sdk-js v14 support](/sdk-and-tools/sdk-js/sdk-js-cookbook-v14#relayed-transactions)
- [sdk-js v13 support (legacy)](/sdk-and-tools/sdk-js/sdk-js-cookbook-v13#preparing-a-relayed-transaction)
Loading