Skip to content

Commit 7159e06

Browse files
committed
update readme to state the initial idea
1 parent 09fa5aa commit 7159e06

File tree

1 file changed

+7
-64
lines changed

1 file changed

+7
-64
lines changed

README.md

Lines changed: 7 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,9 @@
1-
## Foundry
1+
What this project does:
22

3-
**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.**
3+
1. Users use their account address and select the supported ways to make payments and the supported chains to make payments.
4+
2. Our contract will monitor the user's account after some time and check if the user has enough balance to make the payment.
5+
3. If the user has enough balance, the contract will take some amount of the user's balance and send it to the recipient's address.
6+
4. If the user does not have enough balance, the contract will rather check the second chain where user has enough balance and send the payment from that chain.
7+
5. If the user does not have enough balance in any of the chains, the contract will then notify the user about the insufficient balance.
48

5-
Foundry consists of:
6-
7-
- **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools).
8-
- **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data.
9-
- **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
10-
- **Chisel**: Fast, utilitarian, and verbose solidity REPL.
11-
12-
## Documentation
13-
14-
https://book.getfoundry.sh/
15-
16-
## Usage
17-
18-
### Build
19-
20-
```shell
21-
$ forge build
22-
```
23-
24-
### Test
25-
26-
```shell
27-
$ forge test
28-
```
29-
30-
### Format
31-
32-
```shell
33-
$ forge fmt
34-
```
35-
36-
### Gas Snapshots
37-
38-
```shell
39-
$ forge snapshot
40-
```
41-
42-
### Anvil
43-
44-
```shell
45-
$ anvil
46-
```
47-
48-
### Deploy
49-
50-
```shell
51-
$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key>
52-
```
53-
54-
### Cast
55-
56-
```shell
57-
$ cast <subcommand>
58-
```
59-
60-
### Help
61-
62-
```shell
63-
$ forge --help
64-
$ anvil --help
65-
$ cast --help
66-
```
9+
This is like a subscription service where the user can select the supported chains and supported ways to make payments and the contract will automatically make the payment from the user's account to the recipient's account.

0 commit comments

Comments
 (0)