Skip to content

Commit 20cf1e3

Browse files
committed
neat readme
1 parent d04177f commit 20cf1e3

File tree

1 file changed

+11
-37
lines changed

1 file changed

+11
-37
lines changed

README.md

Lines changed: 11 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
> While this upgradeable token smart contract is built using [audited OZ libraries](https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable/tree/v5.2.0/audits),
44
> **this particular implementation has not yet underwent any security audits. Use at your own risk.**
55
6-
# $WANLOG ERC20 Token
6+
# `$WANLOG` ERC20 Token
77

88
## Initial Requirements
99

@@ -57,15 +57,15 @@ forge fmt && forge clean && forge tests
5757

5858
### Locally to Anvil
5959

60+
<details>
61+
<summary>Expand me</summary>
62+
6063
Load environment variables:
6164

6265
``` sh
6366
source .env.anvil
6467
```
6568

66-
<details>
67-
<summary>Expand me</summary>
68-
6969
Spin out an [Anvil](https://book.getfoundry.sh/anvil/) fork of Sepolia:
7070

7171
``` sh
@@ -82,41 +82,15 @@ It will ask you to enter the private key. As we're using Anvil's default `accoun
8282

8383
</details>
8484

85-
### To Sepolia testnet
86-
87-
> [!IMPORTANT]
88-
> You need to setup environment first, see [`.env.sepolia.example`](./.env.sepolia.example)
85+
### To Sepolia
8986

9087
Load environment variables:
9188

9289
``` sh
9390
source .env.sepolia
9491
```
9592

96-
#### Dry-run on Fork
97-
98-
<details>
99-
<summary>Expand me</summary>
100-
101-
Spin out an Anvil fork of Sepolia network:
102-
103-
``` sh
104-
anvil -f $SEPOLIA_RPC_URL -p $ANVIL_PORT
105-
```
106-
107-
Deploy:
108-
109-
``` sh
110-
forge script script/00_Deploy.V1.s.sol --rpc-url $ANVIL_RPC_URL --broadcast -i 1
111-
```
112-
113-
Make sure to provide the private key of the `DEPLOYER` account upon script's interactive prompt.
114-
</details>
115-
116-
117-
#### Real run on Sepolia
118-
119-
##### Deploy
93+
#### Deploy
12094

12195
Once steps described above taken and succeed, deploy to Sepolia with:
12296

@@ -130,7 +104,7 @@ forge script script/00_Deploy.V1.s.sol --rpc-url $SEPOLIA_RPC_URL --broadcast -i
130104
> forge script script/00_Deploy.V1.s.sol --rpc-url $ANVIL_RPC_URL --broadcast -l
131105
> ```
132106
133-
##### Verify
107+
#### Verify
134108
135109
Figure out `solc` version used to compile the contracts:
136110
@@ -164,15 +138,15 @@ src/AnlogTokenV1.sol:AnlogTokenV1
164138

165139
### Locally to Anvil
166140

141+
<details>
142+
<summary>Expand me</summary>
143+
167144
Load environment variables:
168145

169146
``` sh
170147
source .env.anvil
171148
```
172149

173-
<details>
174-
<summary>Expand me</summary>
175-
176150
First spin out a local anvil and deploy `V1` to it by following instructions above.
177151

178152
Then set `PROXY` environment variable to the address of the deployed proxy.
@@ -188,7 +162,7 @@ It will ask you to enter the private key. As we're using Anvil's default `accoun
188162
</details>
189163

190164

191-
### Sepolia
165+
### To Sepolia
192166

193167
In a live network, most probably a multisig is used for the `UPGRADER` account. Thus for doing an upgrade,
194168

0 commit comments

Comments
 (0)