Skip to main content

CoRelayer documentation

Cooperative Relayer Infrastructure for Autonomous Transactions.

CoRelayer pays the MultiversX network fee for your transaction. You keep your keys, you sign your transaction exactly once, and you never have to hold EGLD to move a token, call a contract or let a program act on your behalf. You pay for the service in USDC, monthly, at a price you can read off the chain before you buy.

On devnet only

CoRelayer runs on devnet only; nothing is deployed on mainnet yet.

Every page here describes what is built and tested — the contract, the API document, the SDK, the two web front ends and these docs. Where a thing is not running, the page says so instead of describing it as if it were. Nothing on this site reports a measured latency, an uptime figure or a transaction count before there is something to measure.

Four ways in​

For people​

You have a wallet with USDC in it and no EGLD. Start at What CoRelayer does, then follow the quickstart to buy a plan and send your first relayed transaction from a key your own program holds. Buying works from any MultiversX wallet. Sending from xPortal, the Web Wallet or a Ledger on other apps isn't supported yet: CoRelayer can't relay for you yet. (FAQ)

For agents​

You are a program. Read the agents page — it is written for you, in one screen, with every discovery URL. Or take the whole site as text: /llms.txt and /llms-full.txt, or append .md to any page URL on this site.

For apps: pay for your users​

Your app pays the network fee, so your users never need EGLD. One sponsor key pays for every user your server signs for: Pay for your users. For wallets you name on chain, such as your bots or your treasury, see Sign and relay.

For integrators​

Start with the SDKs, in TypeScript, Go, Rust and Python. The HTTP surface underneath is documented in the API reference, generated from the same OpenAPI document as the SDK types: /openapi.yaml · /openapi.json.

What it actually does, in five lines​

  1. You ask CoRelayer which relayer serves your address. You get one address and a short-lived lease. (Assignment)
  2. You build your transaction with that relayer in it and sign it once. (One signature)
  3. CoRelayer checks the transaction, co-signs it as the relayer, and broadcasts it. (Relayed v3)
  4. The relayer's EGLD pays the fee. Your account nonce moves; your balances do not, beyond what your own transaction does. (What we can and cannot do)
  5. The cost is counted in Relay Units against the plan you bought with USDC.

The parts of this documentation​

SectionWhat is in it
GuidesThe product explained for a reader: what gasless means, what you buy, what a Relay Unit is, how the price is set.
AgentsThe same product for a machine: discovery files, auth, purchase, relay, error handling.
APIEvery route, generated from the OpenAPI document, plus the conventions that apply to all of them.
ContractThe on-chain half: what it stores, what it can be asked to do, who may ask. Generated from the contract's own build output.
ErrorsOne page per error code, at exactly the URL the API puts in the type member of its problem documents.
ChangelogDated entries, with RSS, Atom and JSON feeds.

Where the numbers on this site come from​

Every figure on these pages is either generated from a source in this repository or labelled with its date and its source:

  • prices and tiers come from the same snapshot module the pricing page renders, and every page that shows them names the live endpoint (GET /v1/pricing) and the date the snapshot was taken;
  • request and response shapes come from /openapi.yaml;
  • contract endpoints, views, events and types come from /abi/corelayer.abi.json, which is the contract's own build artefact;
  • error codes come from the ErrorCode enum of the API document, and the build fails if a code exists without a page.

Nothing here is a projection, a benchmark or a marketing number.

On this page