Skip to content

Commit 7b35184

Browse files
maximopalopoliMarcosNicolauJuArceMauroToscano
authored
docs: improve docs folder (#1988)
Co-authored-by: Marcos Nicolau <[email protected]> Co-authored-by: Julian Arce <[email protected]> Co-authored-by: Mauro Toscano <[email protected]>
1 parent 37e8e60 commit 7b35184

File tree

4 files changed

+12
-4
lines changed

4 files changed

+12
-4
lines changed

docs/1_introduction/1_try_aligned.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ We will download a previously generated SP1 proof, send it to Aligned for verifi
1414
1. Download and install Aligned to send proofs in the testnet:
1515

1616
```bash
17-
curl -L https://raw.githubusercontent.com/yetanotherco/aligned_layer/main/crates/cli/install_aligned.sh | bash
17+
curl -L https://raw.githubusercontent.com/yetanotherco/aligned_layer/testnet/crates/cli/install_aligned.sh | bash
1818
```
1919

2020
2. Run the `source` command that should appear in the shell
2121

2222
3. Download the example SP1 proof file together with the ELF file of the proved program using:
2323

2424
```bash
25-
curl -L https://raw.githubusercontent.com/yetanotherco/aligned_layer/main/crates/cli/get_proof_test_files.sh | bash
25+
curl -L https://raw.githubusercontent.com/yetanotherco/aligned_layer/testnet/crates/cli/get_proof_test_files.sh | bash
2626
```
2727

2828
4. Send the proof to be verified in Aligned with

docs/1_introduction/3_faq.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,16 @@ The batcher cannot transfer user's funds to other accounts, only spend them to c
2525

2626
### How do I send proofs without a batcher?
2727

28+
You can see the steps to do it in [this guide](../3_guides/8_submitting_batch_without_batcher.md).
29+
2830
### How do I run my own batcher?
2931

3032
### Why build Aligned on top of Ethereum?
3133

3234
Ethereum is the most decentralized and most significant source of liquidity in the crypto ecosystem. We believe it is the most ambitious and long-term project on the internet. Aligned is being built to help Ethereum achieve its highest potential, and we believe this is only possible through validity/zero-knowledge proofs.
3335

36+
For further reading on this subject, you can refer to [this aligned blog article](https://blog.alignedlayer.com/why-ethereum/), which explains why we chose Ethereum.
37+
3438
### What is Aligned's throughput?
3539

3640
Aligned runs the verifier’s code natively. Verification time depends on the proof system, program run, and public input. Generally, most verifiers can be run on the order of milliseconds on consumer-grade hardware. We can optimize the code for speed and leverage parallelization by running it natively. Our current testnet can verify more than 4000 proofs per second.

docs/2_architecture/components/3_service_manager_contract.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,23 @@ Besides the base [EigenLayer middleware contracts](https://github.com/Layr-Labs/
1919
```solidity
2020
function createNewTask(
2121
bytes32 batchMerkleRoot,
22-
string calldata batchDataPointer
22+
string calldata batchDataPointer,
23+
uint256 respondToTaskFeeLimit
2324
) external payable
2425
```
2526

2627
This method is called to create a new batch verification task that will broadcast an event to all operators, signaling that there are new proofs awaiting verification.
2728

2829
* `batchMerkleRoot` is a 256 bit hash corresponding to the Merkle Root of the proofs batch to be verified by operators.
2930
* `batchDataPointer` is a string representing a link to some specific data storage location. This is used by operators to download the entire batch of proofs.
31+
* `respondToTaskFeeLimit` are the funds required for the operator to respond to the task
3032

3133
#### Respond to task
3234

3335
```solidity
3436
function respondToTask(
3537
bytes32 batchMerkleRoot,
38+
address senderAddress,
3639
NonSignerStakesAndSignature memory nonSignerStakesAndSignature
3740
) external
3841
```
@@ -41,6 +44,7 @@ This method is used by the Aggregator once the quorum for a particular task has
4144

4245
* `batchMerkleRoot` is a 256 bit hash representing the Merkle Root of the batch that has been verified and signed by operators.
4346
* `nonSignerStakesAndSignature` is a struct provided by EigenLayer middleware with information about operators' signatures, stakes and quorum for the given task.
47+
* `senderAddress` is the address of the batcher that created the task being responded to.
4448

4549
### Verify batch inclusion
4650

docs/3_guides/6_setup_aligned.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Different configs for operators can be found in `config-files/config-operator`.
101101
If you wish to only register an operator you can run:
102102

103103
```bash
104-
make operator_full_registration CONFIG_FILE<path_to_config_file>
104+
make operator_full_registration CONFIG_FILE=<path_to_config_file>
105105
```
106106

107107
and to start it once it has been registered:

0 commit comments

Comments
 (0)