Skip to content

Commit ff1e53e

Browse files
committed
commetns
Signed-off-by: bennett <bennett@umaproject.org>
1 parent 909e208 commit ff1e53e

File tree

3 files changed

+9
-0
lines changed

3 files changed

+9
-0
lines changed

script/universal/DeploySP1Helios.s.sol

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ import { SP1MockVerifier } from "@sp1-contracts/src/SP1MockVerifier.sol";
1010
/// @notice Deploy script for the SP1Helios contract.
1111
/// @dev This script downloads the genesis binary from the SP1Helios GitHub releases,
1212
/// runs it to generate the genesis.json, then deploys the SP1Helios contract.
13+
/// @dev Be familiar with the README in this directory before deploying, as there are time
14+
/// considerations and follow-up transactions to execute after deployments.
1315
///
1416
/// How to run:
1517
/// 1. Set environment variables in .env:

script/universal/DeployUniversalSpokePool.s.sol

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ import { ITokenMessenger } from "../../contracts/external/interfaces/CCTPInterfa
1111
/// @title DeployUniversalSpokePool
1212
/// @notice Deploy script for the Universal_SpokePool contract.
1313
/// @dev See script/universal/README.md for detailed usage instructions.
14+
/// @dev Be familiar with the README in this directory before deploying, as there are time
15+
/// considerations and follow-up transactions to execute after deployments.
1416
///
1517
/// Example:
1618
/// forge script script/universal/DeployUniversalSpokePool.s.sol:DeployUniversalSpokePool \

script/universal/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ This guide covers deploying the **Universal SpokePool** infrastructure to a new
1010
- A funded deployer wallet (via mnemonic)
1111
- `generated/constants.json` with chain configuration (run `yarn generate-constants` if missing)
1212

13+
## A Note to Deployers
14+
15+
When you deploy a new Universal Spoke pool to be used by Across, there is a time limit you must follow from Sp1Helios deployment to config store activation.
16+
The SP1Helios contract has a constant `MAX_SLOT_AGE = 7 days`, which is the upper-bound on how long updates may be spaced apart from each other. If the `stateUpdater` is not actively updating helios within seven days of deployment, the Sp1Helios contract will revert to a state where no further updates can be made, and by extension the Universal spoke will become inert and must be upgraded by the `owner` (where the upgrade implementation candidate has a fresh Sp1Helios contract set in its constructor).
17+
1318
## Environment Variables
1419

1520
Create a `.env` file with the following variables:

0 commit comments

Comments
 (0)