Skip to content

Commit 0bdc780

Browse files
cliraaentropidelic
andauthored
docs(guides): fix typos on operator, sdk & submitting proofs (#618)
Co-authored-by: Mariano A. Nicolini <mariano.nicolini.91@gmail.com>
1 parent 72363db commit 0bdc780

3 files changed

Lines changed: 13 additions & 11 deletions

File tree

docs/guides/0_submitting_proofs.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ The following proof systems are going to be added soon:
2121

2222
## 1. Import/Create Keystore file
2323

24-
If you already have a keystore file, you can ignore this section and start sending proofs. We give two examples of how to generate one. The first one using Foundry, and the second one using EigenLayerCLI
24+
If you already have a keystore file, you can ignore this section and start sending proofs. We give two examples of how to generate one. The first one using Foundry, and the second one using EigenLayer CLI
2525

2626
### Alternative 1: With foundry
2727

2828
You need to have installed [Foundry](https://book.getfoundry.sh/getting-started/installation).
2929

30-
- If you are creating a new account. Create a private key with:
30+
- If you are creating a new account, create a private key with:
3131

3232
```bash
3333
cast wallet new-mnemonic --words 12
@@ -56,7 +56,7 @@ You need to have installed [Foundry](https://book.getfoundry.sh/getting-started/
5656

5757
This will create the ECDSA keystore file in `~/.aligned_keystore/keystore0`
5858

59-
### Alternative 2: With EigenlayerCLI
59+
### Alternative 2: With EigenLayer CLI
6060

6161
- If you have the EigenLayer CLI installed, the keystore can be generated following [this](https://docs.eigenlayer.xyz/eigenlayer/operator-guides/operator-installation#import-keys) instructions. The key will be stored into `~/.eigenlayer/operator_keys`.
6262

@@ -75,15 +75,16 @@ aligned deposit-to-batcher \
7575
--amount 0.1ether
7676
```
7777

78-
This commands allows the usage of the following flags:
78+
These commands allows the usage of the following flags:
79+
7980
- `--batcher_addr` to specify the address of the Batcher Payment Service smart contract.
8081
- `--rpc` to specify the rpc url to be used.
8182
- `--chain` to specify the chain id to be used. Could be holesky or devnet.
8283
- `--keystore_path` the path to the keystore.
8384
- `--amount` the amount of ethers to transfer to the Batcher.
8485
- Note: `--amount` flag parameter must be with the shown format. The amount followed by the `ether` keyword to specify how many ethers you wish to deposit to the Batcher.
8586

86-
After depositing funds, you can verify the Service has correctly received them, executing the following command:
87+
After depositing funds, you can verify the Service has correctly received them by executing the following command:
8788

8889
```bash
8990
aligned get-user-balance \
@@ -92,7 +93,8 @@ aligned get-user-balance \
9293
--user_addr <user_addr>
9394
```
9495

95-
This commands allows the usage of the following flags:
96+
These commands allows the usage of the following flags:
97+
9698
- `--batcher_addr` to specify the address of the Batcher Payment Service smart contract.
9799
- `--rpc` to specify the rpc url to be used.
98100
- `--user_addr` the address of the user that funded the Batcher.

docs/guides/1_SDK.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Aligned SDK
22

33
The Aligned SDK aims to help developers interact with Aligned in a simple way.
4-
Some of its functionalities include submitting and verify proofs through the Aligned batcher, as well as checks the inclusion of the verified proofs on-chain. This guide provides an overview of the SDK, its installation, usage, and API details.
4+
Some of its functionalities include submitting and verifying proofs through the Aligned Batcher, as well as checking the inclusion of the verified proofs on-chain. This guide provides an overview of the SDK, its installation, usage, and API details.
55

66
You can check the list of supported verifiers [here](../architecture/0_supported_verifiers.md).
77

@@ -46,7 +46,7 @@ pub async fn submit(
4646

4747
### submit_multiple
4848

49-
Submits mulitple proofs to the batcher to be verified and returns an aligned verification data array.
49+
Submits multiple proofs to the batcher to be verified and returns an aligned verification data array.
5050

5151
```rust
5252
pub async fn submit_multiple(

docs/operator_guides/0_running_an_operator.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ EigenLayer's guide can be found [here](https://docs.eigenlayer.xyz/eigenlayer/re
115115

116116
### Option 2
117117

118-
If you have ETH and need to convert it to WETH you can use the following command, that will convert 1 Eth to WETH.
118+
If you have ETH and need to convert it to WETH you can use the following command, that will convert 1 ETH to WETH.
119119
Make sure to have [foundry](https://book.getfoundry.sh/getting-started/installation) installed.
120120
Change the parameter in ```---value``` if you want to wrap a different amount:
121121

@@ -126,7 +126,7 @@ cast send 0x94373a4919B3240D86eA41593D5eBa789FEF3848 --rpc-url https://ethereum-
126126
Here `<private_key>` is the placeholder for the ECDSA key specified in the output when generating your keys with the EigenLayer CLI.
127127

128128
Finally, to end the staking process, you need to deposit into the WETH strategy,
129-
as shown in the Eigen guide.
129+
as shown in the EigenLayer guide.
130130

131131
<details>
132132
<summary>An alternative using the CLI (only when running without docker)</summary>
@@ -139,7 +139,7 @@ as shown in the Eigen guide.
139139
</summary>
140140
</details>
141141

142-
If you don't have Holesky Eth, these are some useful faucets:
142+
If you don't have Holesky ETH, these are some useful faucets:
143143

144144
- [Google Cloud for Web3 Holesky Faucet](https://cloud.google.com/application/web3/faucet/ethereum/holesky)
145145
- [Holesky PoW Faucet](https://holesky-faucet.pk910.de/)

0 commit comments

Comments
 (0)