Commit 9575365c authored by clabby's avatar clabby

Rebase on `develop` / Docgen

parent e8acf7d2
...@@ -116,6 +116,7 @@ contract XDM_MinGasLimits is Messenger_Initializer, InvariantTest { ...@@ -116,6 +116,7 @@ contract XDM_MinGasLimits is Messenger_Initializer, InvariantTest {
* gas limits are supplied. * gas limits are supplied.
* *
* There are two minimum gas limits here: * There are two minimum gas limits here:
*
* - The outer min gas limit is for the call from the `OptimismPortal` to the * - The outer min gas limit is for the call from the `OptimismPortal` to the
* `L1CrossDomainMessenger`, and it can be retrieved by calling the xdm's `baseGas` function * `L1CrossDomainMessenger`, and it can be retrieved by calling the xdm's `baseGas` function
* with the `message` and inner limit. * with the `message` and inner limit.
......
# `CrossDomainMessenger` Invariants
## A call to `relayMessage` should never revert if at least the proper minimum gas limits are supplied.
**Test:** [`CrossDomainMessenger.t.sol#L127`](../contracts/test/invariants/CrossDomainMessenger.t.sol#L127)
There are two minimum gas limits here:
- The outer min gas limit is for the call from the `OptimismPortal` to the `L1CrossDomainMessenger`, and it can be retrieved by calling the xdm's `baseGas` function with the `message` and inner limit.
- The inner min gas limit is for the call from the `L1CrossDomainMessenger` to the target contract.
...@@ -8,6 +8,7 @@ This directory contains documentation for all defined invariant tests within `co ...@@ -8,6 +8,7 @@ This directory contains documentation for all defined invariant tests within `co
## Table of Contents ## Table of Contents
- [AddressAliasing](./AddressAliasing.md) - [AddressAliasing](./AddressAliasing.md)
- [Burn](./Burn.md) - [Burn](./Burn.md)
- [CrossDomainMessenger](./CrossDomainMessenger.md)
- [Encoding](./Encoding.md) - [Encoding](./Encoding.md)
- [Hashing](./Hashing.md) - [Hashing](./Hashing.md)
- [L2OutputOracle](./L2OutputOracle.md) - [L2OutputOracle](./L2OutputOracle.md)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment