README.md
July 5, 2025 ยท View on GitHub
Solidstate Solidity
The Solidstate smart contract development library.
Packages
Solidstate is an upgradeable-first Solidity smart contract development library.
It consists of the following packages:
| package | description | ๐ |
|---|---|---|
@solidstate/abi | contract ABIs | ๐ |
@solidstate/contracts | core contracts | ๐ |
@solidstate/library | functions for interacting with and validating contracts | ๐ |
@solidstate/spec | portable tests which may be run against third-party implementations of core contracts | ๐ |
Development
Install dependencies:
pnpm install
Setup Husky to format code on commit:
pnpm prepare
Compile contracts via Hardhat:
pnpm hardhat compile
Testing
Test contracts with Hardhat and generate gas report using hardhat-gas-reporter:
pnpm hardhat test
Generate a code coverage report using solidity-coverage:
pnpm hardhat coverage
Publication
Publish packages via Lerna:
pnpm lerna-publish