Skip to content

feat(CHAIN-1663): add readme to script/universal dir #169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jackchuma merged 1 commit into from
Nov 21, 2025
Merged

feat(CHAIN-1663): add readme to script/universal dir #169

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions script/universal/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Universal Scripts

This directory contains a collection of utility scripts and libraries used in Base smart contract operations tasks. These utilities are designed to simplify the process of creating, simulating, signing, and executing transactions, particularly those involving Gnosis Safe multisigs.

For the actual operations tasks and usage examples, please refer to the [contract-deployments repository](https://github.com/base/contract-deployments).

## Key Files

### `MultisigScript.sol`

This is the core script for building Forge scripts that interact with Gnosis Safes. It supports:

- **Nested Multisigs**: Handles arbitrary depths of nested Safes (Safes owned by other Safes).
- **Workflows**: Provides standard functions for `sign` (generating signatures), `approve` (onchain approval for nested Safes), `simulate` (dry-run with state overrides), and `run` (execution).
- **Simulation**: Integrates with `Simulation.sol` to provide detailed simulation links and state diffs.

### `Simulation.sol`

A library for simulating multisig transactions with state overrides. It is particularly useful for:

- Generating Tenderly simulation links.
- Overriding contract storage (e.g., modifying Safe thresholds or nonces) to test execution paths that would otherwise be blocked.

### `MultisigBuilder.sol`

_Deprecated_. Use `MultisigScript.sol` instead. This was an earlier version of the multisig tooling.

### Other Utilities

- `IGnosisSafe.sol`: Interface definitions for interacting with Gnosis Safe contracts.
- `Signatures.sol`: Helper functions for handling and formatting signatures for Gnosis Safe transactions.
- `StateDiff.sol`: Utilities for capturing and reporting state changes during simulations.

## Usage

These scripts are typically imported by specific task scripts in the `contract-deployments` repository. A typical task script inherits from `MultisigScript` and implements the `_buildCalls` method to define the actions to be taken.
Loading