Skip to content

Commit 5297a67

Browse files
committed
chore: update ci and readme
1 parent c7f4036 commit 5297a67

2 files changed

Lines changed: 41 additions & 99 deletions

File tree

.github/workflows/test.yml

Lines changed: 38 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,45 @@
11
name: CI
22

33
on:
4-
push:
5-
pull_request:
6-
workflow_dispatch:
4+
push:
5+
pull_request:
6+
workflow_dispatch:
77

88
env:
9-
FOUNDRY_PROFILE: ci
9+
FOUNDRY_PROFILE: ci
1010

1111
jobs:
12-
check:
13-
strategy:
14-
fail-fast: true
15-
16-
name: Foundry project
17-
runs-on: ubuntu-latest
18-
steps:
19-
- uses: actions/checkout@v4
20-
with:
21-
submodules: recursive
22-
23-
- name: Install Foundry
24-
uses: foundry-rs/foundry-toolchain@v1
25-
26-
- name: Show Forge version
27-
run: |
28-
forge --version
29-
30-
- name: Run Forge fmt
31-
run: |
32-
forge fmt --check
33-
id: fmt
34-
35-
- name: Run Forge build
36-
run: |
37-
forge build --sizes
38-
id: build
39-
40-
- name: Run Forge tests
41-
run: |
42-
forge test -vvv
43-
id: test
12+
check:
13+
strategy:
14+
fail-fast: true
15+
16+
name: Foundry project
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@v4
20+
with:
21+
submodules: recursive
22+
23+
- name: Install Foundry
24+
uses: foundry-rs/foundry-toolchain@v1
25+
with:
26+
version: '1.3.0'
27+
28+
- name: Show Forge version
29+
run: |
30+
forge --version
31+
32+
- name: Run Forge fmt
33+
run: |
34+
forge fmt --check
35+
id: fmt
36+
37+
- name: Run Forge build
38+
run: |
39+
forge build --sizes
40+
id: build
41+
42+
- name: Run Forge tests
43+
run: |
44+
forge test -vvv
45+
id: test

README.md

Lines changed: 3 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -2,69 +2,9 @@
22

33
A modular contract account designed for delegation by EOAs and compatible with EntryPoint v0.8.
44

5-
## Foundry
5+
## Development
66

7-
**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.**
8-
9-
Foundry consists of:
10-
11-
- **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools).
12-
- **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data.
13-
- **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
14-
- **Chisel**: Fast, utilitarian, and verbose solidity REPL.
15-
16-
## Documentation
17-
18-
https://book.getfoundry.sh/
19-
20-
## Usage
21-
22-
### Build
23-
24-
```shell
25-
$ forge build
267
```
27-
28-
### Test
29-
30-
```shell
31-
$ forge test
32-
```
33-
34-
### Format
35-
36-
```shell
37-
$ forge fmt
38-
```
39-
40-
### Gas Snapshots
41-
42-
```shell
43-
$ forge snapshot
44-
```
45-
46-
### Anvil
47-
48-
```shell
49-
$ anvil
50-
```
51-
52-
### Deploy
53-
54-
```shell
55-
$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key>
56-
```
57-
58-
### Cast
59-
60-
```shell
61-
$ cast <subcommand>
62-
```
63-
64-
### Help
65-
66-
```shell
67-
$ forge --help
68-
$ anvil --help
69-
$ cast --help
8+
forge soldeer install
9+
forge test
7010
```

0 commit comments

Comments
 (0)