Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/solidstate-network/abdk-math-extensions
🧮 SolidState extensions for the ABDK Solidity libraries
https://github.com/solidstate-network/abdk-math-extensions
64x64 abdk erc20 eth ether ethereum fixed-point math solidity token wow
Last synced: 22 days ago
JSON representation
🧮 SolidState extensions for the ABDK Solidity libraries
- Host: GitHub
- URL: https://github.com/solidstate-network/abdk-math-extensions
- Owner: solidstate-network
- License: mit
- Created: 2022-05-05T01:05:22.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-06-19T10:52:51.000Z (over 2 years ago)
- Last Synced: 2024-11-20T09:59:11.615Z (about 1 month ago)
- Topics: 64x64, abdk, erc20, eth, ether, ethereum, fixed-point, math, solidity, token, wow
- Language: TypeScript
- Homepage:
- Size: 219 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# SolidState Extensions for ABDK Libraries
SolidState extensions for the `abdk-libraries-solidity` [package](https://www.npmjs.com/package/abdk-libraries-solidity). Developed as a part of the [Premia Finance smart contracts](https://github.com/Premian-Labs/premia-contracts).
> **Note**: SolidState, Premia, and this package are not affiliated with ABDK.
## Installation
Install the package as well as the required ABDK package as development dependencies:
```bash
yarn add --dev @solidstate/abdk-math-extensions abdk-libraries-solidity
```
## 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
```
The Hardhat environment relies on the following environment variables. The `dotenv` package will attempt to read them from the `.env` file, if it is present.
| Key | Description |
| ------------ | ------------------------------------------------------------- |
| `REPORT_GAS` | if `true`, a gas report will be generated after running tests |
### Networks
By default, Hardhat uses the Hardhat Network in-process. Two additional networks, `mainnet` and `testnet` are available, and their behavior is determined by the configuration of environment variables.
### Testing
Test contracts via Hardhat:
```bash
yarn run hardhat test
```
Activate gas usage reporting by setting the `REPORT_GAS` environment variable to `"true"`:
```bash
REPORT_GAS=true yarn run hardhat test
```
Generate a code coverage report using `solidity-coverage`:
```bash
yarn run hardhat coverage
```