-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add readme and init base sepolia deployment
- Loading branch information
Showing
11 changed files
with
1,606 additions
and
194 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,66 +1,76 @@ | ||
## Foundry | ||
# 🐾 Snacks Protocol 🍪 | ||
|
||
**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.** | ||
Welcome to **Snacks**, the cutest and most delightful way to make Ethereum more decentralized while having fun! 🎉 | ||
|
||
Foundry consists of: | ||
--- | ||
|
||
- **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools). | ||
- **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data. | ||
- **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network. | ||
- **Chisel**: Fast, utilitarian, and verbose solidity REPL. | ||
## 🍬 What is Snacks? | ||
Snacks is a **gamified Tamagotchi-inspired protocol** that lets you: | ||
- Save **32 ETH** for deploying an Ethereum validator. 🚀 | ||
- Help decentralize the Ethereum network while enjoying an adorable journey with your virtual pets! 🐕🐾 | ||
|
||
## Documentation | ||
Think of Snacks as a **savings game**, where you and your fellow snackers work together to achieve the goal of launching a validator—all while nurturing and playing with your pets in a fun, interactive way. | ||
|
||
https://book.getfoundry.sh/ | ||
--- | ||
|
||
## Usage | ||
## 🛠 How It Works | ||
|
||
### Build | ||
1. **Create Your Pet** 🐾 | ||
Adopt a virtual pet who loves snacks as much as you do! Your pet grows healthier and happier as you deposit ETH into your savings. 🪙❤️ | ||
|
||
```shell | ||
$ forge build | ||
``` | ||
2. **Deposit ETH** 🐾 | ||
Feed your pet by depositing ETH into the **Snacks Savings Pool**. Every deposit takes us closer to our goal of 32 ETH. | ||
|
||
### Test | ||
3. **Play and Care** 🍖💞 | ||
- **Feed Snacks**: Provide your pet with snacks (ETH deposits). | ||
- **Check Health**: Track your pet's happiness and growth as our pool grows! | ||
|
||
```shell | ||
$ forge test | ||
``` | ||
4. **Launch Validator** 🎉 | ||
When we reach the magical goal of **32 ETH**, Snacks deploys an Ethereum validator! Validators help decentralize the Ethereum network, making it stronger and healthier. | ||
|
||
### Format | ||
--- | ||
|
||
```shell | ||
$ forge fmt | ||
``` | ||
## 🍩 Key Features | ||
|
||
### Gas Snapshots | ||
- **🐶 Virtual Pets**: Adopt a pet who grows with your savings journey. | ||
- **🍪 Snacks Savings Pool**: Every ETH deposit counts toward launching a validator. | ||
- **🔒 Decentralization**: Help Ethereum by making the network more robust and distributed. | ||
|
||
```shell | ||
$ forge snapshot | ||
``` | ||
--- | ||
|
||
### Anvil | ||
## 🐕 Why Snacks? | ||
Because saving ETH should be **fun**, **cute**, and **meaningful**! Snacks combines: | ||
- **Financial empowerment**: Saving together as a community. | ||
- **Network impact**: Supporting Ethereum’s decentralization. | ||
- **Heartwarming fun**: Who doesn’t love snacks and pets? | ||
|
||
```shell | ||
$ anvil | ||
``` | ||
--- | ||
|
||
### Deploy | ||
## 🍡 How to Get Started | ||
|
||
```shell | ||
$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key> | ||
``` | ||
1. **Adopt Your Pet**: | ||
Visit the Snacks app and adopt your adorable companion. Choose wisely—each pet has a unique personality! | ||
|
||
### Cast | ||
2. **Start Saving**: | ||
Deposit ETH into the Snacks Savings Pool. Every wei matters! | ||
|
||
```shell | ||
$ cast <subcommand> | ||
``` | ||
3. **Interact and Play**: | ||
Keep your pet happy by feeding it snacks and playing with it. | ||
|
||
### Help | ||
4. **Watch the Validator Launch**: | ||
Celebrate as we hit 32 ETH and Snacks deploys a validator to the Ethereum network. | ||
|
||
```shell | ||
$ forge --help | ||
$ anvil --help | ||
$ cast --help | ||
``` | ||
5. **Earn Rewards**: | ||
Get tokens and other fun rewards as a thank-you for your contributions. | ||
|
||
--- | ||
|
||
## 🌟 Our Goal | ||
Launch validators while creating a **fun, safe, and inclusive space** for everyone to participate in Ethereum's journey. Snacks is where financial technology meets adorable gamification—because saving ETH doesn't have to be boring! | ||
|
||
--- | ||
|
||
## 🐾 Come Snack With Us! 🍪 | ||
Start your journey with Snacks today and help make Ethereum better, one snack at a time. Together, we’ll launch a validator, decentralize the network, and have tons of fun doing it. | ||
|
||
✨ **Snacks Protocol—saving Ethereum, one snack at a time.** ✨ |
459 changes: 459 additions & 0 deletions
459
broadcast/DeployDiamond.s.sol/84532/run-1731743929.json
Large diffs are not rendered by default.
Oops, something went wrong.
459 changes: 459 additions & 0 deletions
459
broadcast/DeployDiamond.s.sol/84532/run-1731745562.json
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
{ | ||
"Diamond": "0x374Bdd64bBD4De29e48c7C78C3Ed974d88fcFeDF", | ||
"AdminControlFacet": "0x4Ec6F8AdD7d619eB14e35E07d59172c32e8f6303", | ||
"DiamondCutFacet": "0x86c121eb1b57858Bc63033E0722b5296A68524A5", | ||
"DiamondLoupeFacet": "0x37A9099d2bDF7c06DD1B6aBE639056aF49F5408d", | ||
"LiquityStakingFacet": "0x6e14812B88A54B35cB3A1FE4389F0F9DbA05cC25", | ||
"PetFacet": "0xeb9C37C2C8f9222D1B12953a872a5282Db7Af4df", | ||
"SavingsFacet": "0xBea41163B73a6C7f52bF0ffD2d170d2b9cE84209", | ||
"SavingsLiquityConnector": "0x6E2e45693486f7067bA933CAd9a319Da0dAB87e6", | ||
"DiamondInit": "0x0BD2F838EA6d1D774a5756704De947fb281331B7" | ||
} | ||
|
Oops, something went wrong.