Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PraneshASP/huff-math
This repo contains smart contract to perform basic arithmetic operations implemented using Huff
https://github.com/PraneshASP/huff-math
evm huff solidity
Last synced: about 2 months ago
JSON representation
This repo contains smart contract to perform basic arithmetic operations implemented using Huff
- Host: GitHub
- URL: https://github.com/PraneshASP/huff-math
- Owner: PraneshASP
- License: unlicense
- Created: 2022-06-19T08:03:07.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-26T16:17:06.000Z (8 months ago)
- Last Synced: 2024-08-03T16:09:23.933Z (5 months ago)
- Topics: evm, huff, solidity
- Language: Solidity
- Homepage:
- Size: 74.2 KB
- Stars: 24
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-huff - huff-math
README
# Huffmath • [](https://github.com/PraneshASP/huff-math/actions/workflows/tests.yaml)[](https://opensource.org/licenses/unlicense) 
A math library implementation using [**Huff**](https://docs.huff.sh).
## What?
This repo contains smart contracts for simple math operations implemented using Huff. Though there are testcases implemened the contracts are not audited. Use at your own risk.
### Requirements
The following will need to be installed in order to use this repo. Please follow the links and instructions.
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- You'll know you've done it right if you can run `git --version`
- [Foundry / Foundryup](https://github.com/gakonst/foundry)
- This will install `forge`, `cast`, and `anvil`
- You can test you've installed them right by running `forge --version` and get an output like: `forge 0.2.0 (f016135 2022-07-04T00:15:02.930499Z)`
- To get the latest of each, just run `foundryup`
- [Huff Compiler](https://docs.huff.sh/get-started/installing/)
- You'll know you've done it right if you can run `huffc --version` and get an output like: `huffc 0.2.0`
### Quickstart
1. Clone this repo:
```
git clone https://github.com/PraneshASP/huff-math
cd huff-math
```
2. Install dependencies
Once you've cloned and entered into your repository, you need to install the necessary dependencies. In order to do so, simply run:
```shell
forge install
```
3. Build & Test
To build and test your contracts, you can run:
```shell
forge build
forge test
```
For more information on how to use Foundry, check out the [Foundry Github Repository](https://github.com/foundry-rs/foundry/tree/master/forge) and the [foundry-huff library repository](https://github.com/huff-language/foundry-huff).
## Blueprint
```ml
lib
├─ forge-std — https://github.com/foundry-rs/forge-std
├─ foundry-huff — https://github.com/huff-language/foundry-huff
src
├─ Math.huff — Huff library for simple math operations (experimental)
├─ WadRayMath.huff - Optimized Huff library for high presicion math (upto 27 digit decimals)
test
├─ Math.t.huff
└─ WadRayMath.t.huff
```
## License
[The Unlicense](https://github.com/PraneshASP/huff-math/blob/master/LICENSE)
## Acknowledgements
- [foundry-huff-template](https://github.com/huff-language/huff-project-template)
- [Huffmate](https://github.com/pentagonxyz/huffmate)
- [Aave](https://github.com/aave)
## TODO
- [x] Add support for `ln()` and `exp()`
- [ ] Add fuzz tests
- [ ] Handle reverts with reason string??
## Disclaimer
_These smart contracts are being provided as is. No guarantee, representation or warranty is being made, express or implied, as to the safety or correctness of the user interface or the smart contracts. They have not been audited and as such there can be no assurance they will work as intended, and users may experience delays, failures, errors, omissions, loss of transmitted information or loss of funds. The creators are not liable for any of the foregoing. Users should proceed with caution and use at their own risk._