add information to the readme

Signed-off-by: Uncle Fatso <uncle.fatso@ghostchain.io>
This commit is contained in:
Uncle Fatso 2025-07-23 22:26:52 +03:00
parent 8e2caaba0f
commit 6e6b64a61b
Signed by: f4ts0
GPG Key ID: 565F4F2860226EBB

117
README.md
View File

@ -1,6 +1,63 @@
## Foundry ## Ghost DAO protocol
**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.** [ghostDAO](https://app.dao.ghostchain.io/) is a decentralized multi-chain reserve currency protocol. ghostDAO protocol is powered by [GHOST native blockchain](https://ghostchain.io/) enabling anonymous cross-chain transactions of GHST. Each eGHST token is backed by a basket of stablecoins in the ghostDAO treasury, giving it an intrinsic value that it cannot fall below.
## Usage
You need to install [foundry](https://getfoundry.sh/) or use contracts from `/src` folder with any tool you are comfortable with.
### Clone
```shell
git clone https://git.ghostchain.io/ghostchain/ghost-dao-contracts.git
```
### Foundry preparation
```shell
git submodule init
git submodule update
forge soldeer install
```
### Build contracts
```shell
$ forge build
```
### Test contracts
```shell
$ forge test
```
### Environment
```shell
$ cp .env.template .env
# populate the .env file with specific values for environment variables
```
### Local deployment
```shell
# in first terminal
$ anvil
# in second terminal
$ ./deployer.sh --network anvil-localnet
```
### Deployer help
```shell
$ ./deployer.sh --help
```
## Technologies Used
[Foundry](https://getfoundry.sh/) is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.
Foundry consists of: Foundry consists of:
@ -8,59 +65,3 @@ Foundry consists of:
- **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data. - **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. - **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
- **Chisel**: Fast, utilitarian, and verbose solidity REPL. - **Chisel**: Fast, utilitarian, and verbose solidity REPL.
## Documentation
https://book.getfoundry.sh/
## Usage
### Build
```shell
$ forge build
```
### Test
```shell
$ forge test
```
### Format
```shell
$ forge fmt
```
### Gas Snapshots
```shell
$ forge snapshot
```
### Anvil
```shell
$ anvil
```
### Deploy
```shell
$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key>
```
### Cast
```shell
$ cast <subcommand>
```
### Help
```shell
$ forge --help
$ anvil --help
$ cast --help
```