https://github.com/refcell/femplate

Robust, Feature-Rich Solidity Template Repository for Foundry Projects with Scripting, Testing, and Utility Bash Scripts.
https://github.com/refcell/femplate

ethereum evm foundry rust script solidity starter template

Last synced: 2 months ago
JSON representation

Robust, Feature-Rich Solidity Template Repository for Foundry Projects with Scripting, Testing, and Utility Bash Scripts.

• Host: GitHub
• URL: https://github.com/refcell/femplate
• Owner: refcell
• License: mit
• Created: 2022-01-08T17:35:45.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-09T02:47:37.000Z (over 1 year ago)
• Last Synced: 2024-04-03T17:17:52.421Z (2 months ago)
• Topics: ethereum, evm, foundry, rust, script, solidity, starter, template
• Language: Solidity
• Homepage: https://github.com/refcell/femplate
• Size: 493 KB
• Stars: 369
• Watchers: 3
• Forks: 51
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-foundry - Femplate - Robust Template for Foundry Projects. (Tools)

README

        


# femplate • [![tests](https://github.com/refcell/femplate/actions/workflows/ci.yml/badge.svg?label=tests)](https://github.com/refcell/femplate/actions/workflows/ci.yml) ![license](https://img.shields.io/github/license/refcell/femplate?label=license) ![solidity](https://img.shields.io/badge/solidity-^0.8.17-lightgrey)

A **Clean**, **Robust** Template for Foundry Projects.

### Usage

**Building & Testing**

Build the foundry project with `forge build`. Then you can run tests with `forge test`.

**Deployment & Verification**

Inside the [`utils/`](./utils/) directory are a few preconfigured scripts that can be used to deploy and verify contracts.

Scripts take inputs from the cli, using silent mode to hide any sensitive information.

_NOTE: These scripts are required to be _executable_ meaning they must be made executable by running `chmod +x ./utils/*`._

_NOTE: these scripts will prompt you for the contract name and deployed addresses (when verifying). Also, they use the `-i` flag on `forge` to ask for your private key for deployment. This uses silent mode which keeps your private key from being printed to the console (and visible in logs)._

### I'm new, how do I get started?

We created a guide to get you started with: [GETTING_STARTED.md](./GETTING_STARTED.md).

### Blueprint

```txt

lib

├─ forge-std — https://github.com/foundry-rs/forge-std

├─ solmate — https://github.com/transmissions11/solmate

scripts

├─ Deploy.s.sol — Example Contract Deployment Script

src

├─ Greeter — Example Contract

test

└─ Greeter.t — Example Contract Tests

```

### Notable Mentions

- [femplate](https://github.com/refcell/femplate)

- [foundry](https://github.com/foundry-rs/foundry)

- [solmate](https://github.com/Rari-Capital/solmate)

- [forge-std](https://github.com/brockelmore/forge-std)

- [forge-template](https://github.com/foundry-rs/forge-template)

- [foundry-toolchain](https://github.com/foundry-rs/foundry-toolchain)

### 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._

See [LICENSE](./LICENSE) for more details.