Skip to content

Commit 6eec9a1

Browse files
authored
Fixed wrong code blocks (#94)
1 parent 1e6c9da commit 6eec9a1

File tree

4 files changed

+56
-56
lines changed

4 files changed

+56
-56
lines changed

docs/unifi-avs/unifi-avs-getting-started.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,43 +22,43 @@ Before you begin, ensure you have the following:
2222

2323
1. Install Foundry (if not already installed):
2424

25-
```text
25+
```
2626
curl -L https://foundry.paradigm.xyz | bash
2727
foundryup
28-
```text
28+
```
2929
2. Clone the UniFi repository:
3030

31-
```text
31+
```
3232
git clone https://github.com/PufferFinance/UniFi.git
33-
```text
33+
```
3434
3. Navigate to the cloned directory:
3535

36-
```text
36+
```
3737
cd UniFi
38-
```text
38+
```
3939
4. Install dependencies:
4040

41-
```text
41+
```
4242
yarn install
43-
```text
43+
```
4444
5. Navigate to the l1-contracts directory:
4545

46-
```text
46+
```
4747
cd l1-contracts
48-
```text
48+
```
4949
6. Install Foundry dependencies:
50-
```text
50+
```
5151
forge build
52-
```text
52+
```
5353
## Phase 1 - Register to UniFi AVS
5454

5555
During phase 1 of UniFi AVS mainnet, Operators can register as follows.
5656

5757
1. **Register as an Operator**
5858
Run the following Solidity script:
59-
```text
59+
```
6060
forge script script/UniFiAVSScripts.sol:UniFiAVSScripts --sig "registerOperatorToUniFiAVS(uint256 signerPk)" 'YOUR_OPERATOR_PRIVATE_KEY' --private-key 'YOUR_OPERATOR_PRIVATE_KEY' --rpc-url 'YOUR_MAINNET_RPC_URL' --broadcast
61-
```text
61+
```
6262
Replace `YOUR_OPERATOR_PRIVATE_KEY` and `YOUR_MAINNET_RPC_URL` with your actual values.
6363

6464
:::tip

docs/yield/registration.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -38,18 +38,18 @@ Run the command where you [installed the Coral-CLI](/yield/setup#setup-coral-cli
3838

3939
The following **example** command will create a local validator keystore file in the `./etc/keys/bls_keys` directory. The keystore is encrypted using the password contained in `password.txt`. The command will create a registration payload called `registration.json`.
4040

41-
```text
41+
```
4242
cargo run --bin coral-cli validator keygen --guardian-threshold 1 --module-name 0x5055464645525f4d4f44554c455f300000000000000000000000000000000000 --withdrawal-credentials 0x0100000000000000000000005ee9246f01e95c08ee767029c1d18765bb1779d0 --guardian-pubkeys 0x049cc1fbaa3cffd3e4c1f935c47720d013938ccb822a9cbd20c5f09ab65ae8300e7986b6ce75e916d3b59599ece72134adf2972d06a76a8ba5f3747d356117c342 --fork-version 0x01017000 --password-file password.txt --output-file registration.json
43-
```text
43+
```
4444
---
4545

4646
#### Fetching the registration payload
4747

4848
If you ran the Coral-CLI on a remote server you can fetch the registration payload by substituting your information in the following command:
4949

50-
```text
50+
```
5151
scp [email protected]:/path/to/coral/registration.json ~/my/local/computer/registration.json
52-
```text
52+
```
5353
### Step 3: Mint pufETH or VTs
5454

5555
![alt text](/img/mint-pufeth-vt.png)
@@ -102,43 +102,43 @@ For operators interested in running many Puffer validators a convenience script
102102

103103
1. Clone the PufferPool repo:
104104

105-
> ```text
105+
> ```
106106
> git clone https://github.com/PufferFinance/PufferPool.git
107107
> cd PufferPool
108-
> ```text
108+
> ```
109109
2. Install [Foundry](https://book.getfoundry.sh/getting-started/installation)
110110
111-
> ```text
111+
> ```
112112
> curl -L https://foundry.paradigm.xyz | bash
113-
> ```text
113+
> ```
114114
3. Install Coral-CLI
115115
116-
> ```text
116+
> ```
117117
> cargo install -f --git https://github.com/PufferFinance/coral.git
118-
> ```text
118+
> ```
119119
4. The batch registration script requires a local Eth keystore file to run. You can create a keystore file by importing an existing private key as follows:
120-
> ```text
120+
> ```
121121
> cast wallet import -i puffer-test
122122
> Enter private key:
123123
> Enter password:
124124
> `puffer-test` keystore was saved successfully. Address: 0x4D42ABfB6D4bEDaf64dF8BE054676149BDfa224d
125-
> ```text
125+
> ```
126126
This command created a keystore file named `puffer-test` in the `ls ~/.foundry/keystores` directory. More instructions on working with Foundry keystores can be found [in their docs](https://book.getfoundry.sh/reference/cast/cast-wallet-import#directory-options).
127127
128128
5. Fund the wallet with sufficient VTs, pufETH, and ETH to cover gas. These can be purchased as [described above](./registration.md#step-3-mint-pufeth-or-vts).
129129
130130
6. Inside the PufferPool repo, install the batch registration script dependencies:
131131
132-
> ```text
132+
> ```
133133
> forge install
134-
> ```text
134+
> ```
135135
7. Edit the `validator-keystore-password.txt` file. This will be the password used to encrypt your validator BLS keystore files.
136136
137137
8. Create the `registration-data` directory for your output registration JSONs
138138
139-
> ```text
139+
> ```
140140
> mkdir -p registration-data
141-
> ```text
141+
> ```
142142
9. Simulate the batch registration script:
143143
> - Replace with your RPC URL (either for mainnet or holesky)
144144
> - Set the keystore `--account` to the name of your keystore located in `~/.foundry/keystores` (from step 4)
@@ -147,24 +147,24 @@ This command created a keystore file named `puffer-test` in the `ls ~/.foundry/k
147147
148148
- Example Holesky command:
149149
150-
> ```text
150+
> ```
151151
> forge script script/GenerateBLSKeysAndRegisterValidators.s.sol:GenerateBLSKeysAndRegisterValidators --rpc-url=https://ethereum-holesky.publicnode.com --account puffer-test -vvv --sender=0x4D42ABfB6D4bEDaf64dF8BE054676149BDfa224d --ffi
152-
> ```text
152+
> ```
153153
- Example Mainnet command:
154-
> ```text
154+
> ```
155155
> forge script script/GenerateBLSKeysAndRegisterValidators.s.sol:GenerateBLSKeysAndRegisterValidators --rpc-url=https://eth.llamarpc.com --account puffer-test -vvv --sender=0x4D42ABfB6D4bEDaf64dF8BE054676149BDfa224d --ffi
156-
> ```text
156+
> ```
157157
10. Rerun the command with the `--slow` and `--broadcast` flags to send the transaction on chain. Note that the command may take several minutes to run.
158158
159159
- Example Holesky command:
160160
161-
> ```text
161+
> ```
162162
> forge script script/GenerateBLSKeysAndRegisterValidators.s.sol:GenerateBLSKeysAndRegisterValidators --rpc-url=https://ethereum-holesky.publicnode.com --account puffer-test -vvv --sender=0x4D42ABfB6D4bEDaf64dF8BE054676149BDfa224d --ffi --slow --broadcast
163-
> ```text
163+
> ```
164164
- Example Mainnet command:
165-
> ```text
165+
> ```
166166
> forge script script/GenerateBLSKeysAndRegisterValidators.s.sol:GenerateBLSKeysAndRegisterValidators --rpc-url=https://eth.llamarpc.com --account puffer-test -vvv --sender=0x4D42ABfB6D4bEDaf64dF8BE054676149BDfa224d --ffi --slow --broadcast
167-
> ```text
167+
> ```
168168
11. Your validator keys will be generated locally in the folder: `PufferPool/etc/keys/bls_keys/` and can be added to your validator client as described [here](./registration#step-6-prepare-your-validator).
169169
170170
## Batch Registering Validators Using Gnosis SAFE
@@ -175,37 +175,37 @@ A similar flow exists for operators that use [SAFE](https://app.safe.global). Th
175175
176176
1. Clone the puffer-contracts repo:
177177
178-
> ```text
178+
> ```
179179
> git clone https://github.com/PufferFinance/puffer-contracts.git
180180
> cd puffer-contracts
181-
> ```text
181+
> ```
182182
2. Install Contract Dependencies
183183
184-
> ```text
184+
> ```
185185
> yarn install
186-
> ```text
186+
> ```
187187
3. Install [Foundry](https://book.getfoundry.sh/getting-started/installation)
188188
189-
> ```text
189+
> ```
190190
> curl -L https://foundry.paradigm.xyz | bash
191-
> ```text
191+
> ```
192192
4. Install Coral-CLI
193193
194-
> ```text
194+
> ```
195195
> cargo install -f --git https://github.com/PufferFinance/coral.git
196-
> ```text
196+
> ```
197197
5. Enter the utility-scripts directory
198198
199-
> ```text
199+
> ```
200200
> cd utility-scripts
201-
> ```text
201+
> ```
202202
6. Edit the `validator-keystore-password.txt` file. This will be the password used to encrypt your validator BLS keystore files.
203203
204204
7. Run the script:
205205
206-
> ```text
206+
> ```
207207
> forge script script/GenerateBLSKeysAndRegisterValidatorsCalldata.s.sol:GenerateBLSKeysAndRegisterValidatorsCalldata --rpc-url=$RPC_URL -vvv --ffi
208-
> ```text
208+
> ```
209209
>
210210
> ![alt text](/img/batch_registration_output.png)
211211
> Two things will happen:

docs/yield/setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ The Coral-CLI is used to generate validator keys, prepare registration payloads,
5858

5959
- Dependencies: [Rust](https://www.rust-lang.org/learn/get-started)
6060

61-
```text
61+
```
6262
git clone https://github.com/PufferFinance/coral
6363
cd coral
6464
cargo build --release
65-
```text
65+
```

docs/yield/validator-tickets-calculation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ To check your VT consumption and validator status, you can use the Puffer API. H
6868

6969
#### Endpoint
7070

71-
```text
71+
```
7272
GET https://api.puffer.fi/puffer-withdrawal-service/api/v1/noop/consumption/calculate/{node_address}
73-
```text
73+
```
7474
Replace `{node_address}` with your node operator's Ethereum address.
7575

7676
#### Request
@@ -79,7 +79,7 @@ Replace `{node_address}` with your node operator's Ethereum address.
7979
curl -X 'GET' \
8080
'https://api.puffer.fi/puffer-withdrawal-service/api/v1/noop/consumption/calculate/{node_address}' \
8181
-H 'accept: application/json'
82-
```text
82+
```
8383
#### Response
8484

8585
```json
@@ -91,7 +91,7 @@ curl -X 'GET' \
9191
"ticketsConsumed": "string", // Total VTs consumed
9292
"showWarning": true // Whether low VT balance warning should be shown
9393
}
94-
```text
94+
```
9595
This API provides real-time information about your VT status and validator health. Since the VT consumption is calculated per epoch the response is updated every epoch.
9696

9797
:::warning Important Notice for Node Operators

0 commit comments

Comments
 (0)