/STP

safe transfer protocol

Primary LanguageSolidityGNU Affero General Public License v3.0AGPL-3.0

Safe Transfer Protocol. Wrap and send ETH or ERC20 tokens with timelock and guardian.

Getting Started

Run: curl -L https://foundry.paradigm.xyz | bash && source ~/.bashrc && foundryup

Build the foundry project with forge build. Run tests with forge test. Measure gas with forge snapshot. Format with forge fmt.

GitHub Actions

Contracts will be tested and gas measured on every push and pull request.

You can edit the CI script in .github/workflows/ci.yml.

Blueprint

lib
├─ forge-std — https://github.com/foundry-rs/forge-std
src
├─ STP — Protocol Contract
test
└─ STP.t - Test Protocol Contract

Disclaimer

These smart contracts and testing suite are being provided as is. No guarantee, representation or warranty is being made, express or implied, as to the safety or correctness of anything provided herein or through related user interfaces. This repository and related code have not been audited and as such there can be no assurance anything 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.

License

See LICENSE for more details.