f48431ac5c
* placeholder docs * adding more documentation * documentation work in progress * add main linking or index documents * add a link images * add messaging flows * linking operator documentation and folder cleanup * use correct pathing on tokenbridge.md * link workflow documents * add function signatures * remove welcome to * cross reference blob submission and finalization * remove confusing text * use better definition of shnarf * fix broken link * add charter, diagram and address book * docs(LSC): Rename security-council-charter-v1.3.md to security-council-charter.md Signed-off-by: Julien Marchand <julien-marchand@users.noreply.github.com> * Update contracts/docs/mainnet-address-book.csv Co-authored-by: Julien Marchand <julien-marchand@users.noreply.github.com> Signed-off-by: The Dark Jester <thedarkjester@users.noreply.github.com> --------- Signed-off-by: Julien Marchand <julien-marchand@users.noreply.github.com> Signed-off-by: The Dark Jester <thedarkjester@users.noreply.github.com> Co-authored-by: Julien Marchand <julien-marchand@users.noreply.github.com>
2.0 KiB
📘 Canonical Token Bridge Core Admin Workflows
This collection of guides outlines key privileged workflows that govern the operation and upgrade lifecycle of the Canonical Token Bridge smart contract. These workflows are designed to be executed via multisig-controlled safes, with strong verification and simulation practices to ensure safety and auditability.
Each section below links to a dedicated Markdown document detailing that category of administrative action.
📑 Workflows
1. 🔐 Role Management
Granting or revoking operational roles on core contracts like LineaRollup, L2MessageService, and TokenBridge.
2. ⏸️ Pausing Features
How to pause contract functionality using well-defined pause types.
3. ▶️ Unpausing Features
How to resume paused features using the same set of pause types.
4. 🧮 Rate Limiting
How to configure or reset message throughput limits.
5. ♻️ Upgrading Without Reinitialization
Securely upgrade the Canonical Token Bridge or related contracts without calling reinitialization logic.
6. 🔁 Upgrading With Reinitialization
Same upgrade flow but includes immediate initialization logic for the new implementation.
7. 🧾 Other Token Bridge Specific Admin Functions
How to execute setCustomContract,removeReserved, setMessageService and setReserved
8. 🧾 L1 to L2 Token Bridging
View the L1 to L2 Token Bridging flow.
9. 🧾 L2 to L1 Token Bridging
View the L2 to L1 Token Bridging flow.
✅ Notes
- All workflows require transaction simulation and parameter verification.
- Some admin operations are governed by time-locked multisigs.
- Contract addresses and roles are listed inline in each document.