​
Primary Types in the Routes System

This section describes the primary data structures used in the Routes system, and understanding them is critical to understanding how the Routes system works.

​
Call

A Call is a single contract call with encoded function data. It is used to execute arbitrary function calls on the destination chain and allows for value to be sent with the call.

struct Call {
    address target;
    bytes data;
    uint256 value;
}

​
TokenAmount

A TokenAmount is a pair of a token address and an amount. It is used to specify token rewards on the origin chain and the tokens required for execution of calls on the destination chain.

struct TokenAmount {
    address token;
    uint256 amount;
}

​
Route

A Route is a collection of calls and token amounts that make up a complete cross-chain intent. It is used to specify the routing and execution instructions for a cross-chain message.

  • Source and Destination are the chain IDs of the origin and destination chains, respectively.
  • The Inbox is the address of the inbox contract on the destination chain.
  • The Salt is a unique identifier provided by the intent creator, used to prevent duplicates.
  • Tokens is an array of TokenAmounts that specify the tokens required for execution of calls on the destination chain.
  • Calls is an array of Calls that specify the function calls to execute on the destination chain.
struct Route {
    bytes32 salt;
    uint256 source;
    uint256 destination;
    address inbox;
    TokenAmount[] tokens;
    Call[] calls;
}

​
Reward

A Reward is a collection of tokens and a native value that make up a reward for the solver.

  • Creator is the address of the creator of the intent.
  • Prover is the address of the prover that is responsible for validating the intent on the origin chain.
  • Deadline is the unix timestamp after which the intent can no longer be executed.
  • NativeValue is the amount of native tokens offered as reward.
  • Tokens is an array of TokenAmounts that specify the tokens offered as additional rewards.
struct Reward {
    address creator;
    address prover;
    uint256 deadline;
    uint256 nativeValue;
    TokenAmount[] tokens;
}

​
Putting it all together — an Intent

Putting it all together, an Intent is a Route and a Reward. The Route specifies the routing and execution instructions for a cross-chain message, and the Reward specifies the reward for the solver.

struct Intent {
    Route route;
    Reward reward;
}

Laying out the intent this way allows for a flexible and powerful way to specify cross-chain messages and rewards, and allows for efficient use of calldata at each step of the intent lifecycle.