https://github.com/solidstate-network/solidstate-solidity
💠Upgradeable-first Solidity smart contract development library ðŸ’
https://github.com/solidstate-network/solidstate-solidity
buidler crypto cryptocurrency eth ether ethereum hardhat library smart-contracts solidity wow
Last synced: 12 days ago
JSON representation
💠Upgradeable-first Solidity smart contract development library ðŸ’
- Host: GitHub
- URL: https://github.com/solidstate-network/solidstate-solidity
- Owner: solidstate-network
- License: mit
- Created: 2020-10-08T03:01:01.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-12-02T20:00:52.000Z (5 months ago)
- Last Synced: 2024-12-16T20:34:50.805Z (4 months ago)
- Topics: buidler, crypto, cryptocurrency, eth, ether, ethereum, hardhat, library, smart-contracts, solidity, wow
- Language: TypeScript
- Homepage: https://discord.gg/BnvwfM6bRe
- Size: 4.44 MB
- Stars: 441
- Watchers: 12
- Forks: 89
- Open Issues: 48
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-solidity - solidstate-network/solidstate-solidity - Upgradeable-first smart contract development library. (Libraries)
- awesome-solidity - solidstate-network/solidstate-solidity - Upgradeable-first smart contract development library. (Libraries)
- awesome-solidity - solidstate-network/solidstate-solidity - Upgradeable-first smart contract development library. (Libraries)
- awesome-solidity - solidstate-network/solidstate-solidity - Upgradeable-first smart contract development library. (Libraries)
- awesome-solidity - solidstate-network/solidstate-solidity - Upgradeable-first smart contract development library. (Libraries)
README
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 | [📖](./abi/README.md) |
| `@solidstate/contracts` | core contracts | [📖](./contracts/README.md) |
| `@solidstate/library` | functions for interacting with and validating contracts | [📖](./lib/README.md) |
| `@solidstate/spec` | portable tests which may be run against third-party implementations of core contracts | [📖](./spec/README.md) |
## Development
Install dependencies via Yarn:
```bash
yarn install
```
Setup Husky to format code on commit:
```bash
yarn prepare
```
Compile contracts via Hardhat:
```bash
yarn run hardhat compile
```
Automatically upgrade dependencies with yarn-up:
```bash
yarn upgrade-dependencies
```
### Testing
Test contracts with Hardhat and generate gas report using `hardhat-gas-reporter`:
```bash
yarn run hardhat test
```
Generate a code coverage report using `solidity-coverage`:
```bash
yarn run hardhat coverage
```
### Publication
Publish packages via Lerna:
```bash
yarn lerna-publish
```