https://github.com/0xmichalis/storage-layout-action
WIP: Github action to check for storage layout conflicts in upgradeable Solidity contracts
https://github.com/0xmichalis/storage-layout-action
Last synced: about 2 months ago
JSON representation
WIP: Github action to check for storage layout conflicts in upgradeable Solidity contracts
- Host: GitHub
- URL: https://github.com/0xmichalis/storage-layout-action
- Owner: 0xmichalis
- Created: 2023-01-21T17:19:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-14T14:09:32.000Z (over 1 year ago)
- Last Synced: 2025-03-25T03:51:51.714Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 29.5 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Solidity storage layout action
This action checks for storage layout conflicts in upgradeable Solidity contracts.
## Inputs
### `buildArtifactsPath`
**Required** Path to the directory where the Solidity compiler outputs built contracts. Defaults to `artifacts`.
### `storageLayoutPath`
**Required** Path to the directory where contract storage layout is cached. Defaults to `.openzeppelin`.
### `fullyQualifiedContractNames`
**Required** Comma-separated list of fully qualified contract names to inspect their storage layout for conflicts. Must match with `proxyOrBeaconAddresses`.
### `proxyOrBeaconAddresses`
**Required** Comma-separated list of proxy or beacon addresses to inspect for conflicts. Must match with `fullyQualifiedContractNames`.
### `nodeRpcUrl`
**Required** RPC URL to a blockchain node.
## Example usage
```yaml
uses: 0xmichalis/storage-layout-action@main
with:
fullyQualifiedContractNames: RetirementCertificates,ToucanCarbonOffsets
proxyOrBeaconAddresses: 0x5e377f16E4ec6001652befD737341a28889Af002,0xD46eE8815F141749834AF0Df21E744459eFEc75F
nodeRpcUrl: https://matic-mainnet.chainstacklabs.com
```