Skip to content

Commit 47139ef

Browse files
MauroToscanocliraa
andauthored
Pull staging updates (#2061)
Co-authored-by: cliraa <[email protected]>
2 parents 0cf435a + d57521b commit 47139ef

14 files changed

+230
-15
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,6 @@ witness.wtns
3737
*.zkey
3838
circuit_cpp/
3939
circuit_js
40+
41+
# Link checker results
42+
docs/dead_links_report.txt

docs/3_guides/0_submitting_proofs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ This will create the ECDSA keystore file in `~/.aligned_keystore/keystore0`
6161

6262
### Alternative 2: With EigenLayer CLI
6363

64-
- If you have the EigenLayer CLI installed, the keystore can be generated following [these](https://docs.eigenlayer.xyz/eigenlayer/operator-guides/operator-installation#import-keys) instructions. The key will be stored into `~/.eigenlayer/operator_keys`.
64+
- If you have the EigenLayer CLI installed, the keystore can be generated following [these](https://docs.eigencloud.xyz/products/eigenlayer/operators/howto/operator-installation) instructions. The key will be stored into `~/.eigenlayer/operator_keys`.
6565

6666
## 2. Send funds to Aligned
6767

docs/3_guides/2.2_modify_zkquiz_questions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ if output
7474
## 3. Compile the Program
7575

7676
Now we need to compile the updated Program, generating the binary file that will be run by the zkVM (ELF).
77-
For this, ensure that the [SP1 Rust toolchain](https://docs.succinct.xyz/introduction.html) is installed. Run:
77+
For this, ensure that the [SP1 Rust toolchain](https://docs.succinct.xyz/docs/sp1/introduction) is installed. Run:
7878

7979
```
8080
make compile_elf

docs/3_guides/2_build_your_first_aligned_application.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ ZkQuiz has three main components:
9696
The user interacts with ZkQuiz App to solve a trivia challenge answering questions. Then, the App generates a Zk Proof with the Program generated using SP1.
9797

9898
{% hint style="info" %}
99-
The ZkQuiz Program is built using SP1 following the [quickstart guide](https://docs.succinct.xyz/getting-started/quickstart.html#project-overview). For your projects, you can user any of the [prooving systems supported by Aligned](../2_architecture/0_supported_verifiers.md).
99+
The ZkQuiz Program is built using SP1 following the [quickstart guide](https://docs.succinct.xyz/docs/sp1/getting-started/quickstart). For your projects, you can user any of the [prooving systems supported by Aligned](../2_architecture/0_supported_verifiers.md).
100100
{% endhint %}
101101

102102
Once the proof is generated, the App sends the proof to Aligned, and once it is verified, the App calls to the ZkQuiz Verifier Contract to check the proof verification and send an NFT to the user is the proof was verified in Aligned.

docs/3_guides/3_validating_public_input.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This guide demonstrates how to validate Risc0 and SP1 proofs using the Aligned S
77
In this case, the Fibonacci number to be calculated is **500** and the last two numbers of the sequence modulo 7919 are **1268** and **1926**.
88

99
## Requirements
10-
- [SP1](https://docs.succinct.xyz/getting-started/install.html)
10+
- [SP1](https://docs.succinct.xyz/docs/sp1/getting-started/install)
1111
- [Risc0](https://dev.risczero.com/api/zkvm/install)
1212
- [Foundry](https://book.getfoundry.sh/getting-started/installation)
1313

@@ -29,7 +29,7 @@ For `SP1`, the Fibonacci program is located in `examples/validating-public-input
2929

3030
> [!IMPORTANT]
3131
> To generate the proof ensure you have [docker](https://www.docker.com/get-started/) installed and the docker daemon running.
32-
> This is necessary to ensure deterministic builds of the binary we want to generate a proof of. If not used, builds may differ depending on the system you are running on. To know more about this, check [this link](https://dev.risczero.com/terminology#deterministic-builds) from RiscZero docs or [this](https://docs.succinct.xyz/writing-programs/compiling.html#advanced-build-options-1) from SP1.
32+
> This is necessary to ensure deterministic builds of the binary we want to generate a proof of. If not used, builds may differ depending on the system you are running on. To know more about this, check [this link](https://dev.risczero.com/terminology#deterministic-builds) from RiscZero docs or [this](https://docs.succinct.xyz/docs/sp1/writing-programs/compiling) from SP1.
3333
3434
To submit proofs to **Aligned** and get them verified, you first need to generate those proofs. Every proving system has its own method for generating proofs.
3535

docs/3_guides/4_generating_proofs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66

77
This guide assumes that:
88

9-
- sp1 prover installed (instructions [here](https://succinctlabs.github.io/sp1/getting-started/install.html))
9+
- sp1 prover installed (instructions [here](https://docs.succinct.xyz/docs/sp1/getting-started/install))
1010
- sp1 project to generate the proofs
11-
(instructions [here](https://succinctlabs.github.io/sp1/generating-proofs/setup.html))
11+
(instructions [here](https://docs.succinct.xyz/docs/sp1/getting-started/quickstart))
1212
- aligned installed (instructions [here](../1_introduction/1_try_aligned.md#quickstart))
1313

1414
### How to generate a proof

docs/3_guides/7_contract_addresses.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Below is the list of supported strategies available on Aligned Mainnet:
3232
| [lsETH](https://app.eigenlayer.xyz/restake/lsETH) | [0xAe60d8180437b5C34bB956822ac2710972584473](https://etherscan.io/address/0xAe60d8180437b5C34bB956822ac2710972584473) |
3333
| [mETH](https://app.eigenlayer.xyz/restake/mETH) | [0x298aFB19A105D59E74658C4C334Ff360BadE6dd2](https://etherscan.io/address/0x298aFB19A105D59E74658C4C334Ff360BadE6dd2) |
3434

35-
For additional details, refer to the [official EigenLayer documentation](https://github.com/Layr-Labs/eigenlayer-contracts/tree/mainnet?tab=readme-ov-file#strategies).
35+
For additional details, refer to the [official EigenLayer documentation](https://github.com/Layr-Labs/eigenlayer-contracts).
3636

3737

3838
## Holesky Deployments

docs/3_guides/setup_holesky.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
These contracts are not deployed by Aligned. Current EigenLayer contracts:
66

7-
- [Holesky Contracts](https://github.com/Layr-Labs/eigenlayer-contracts/blob/testnet-holesky/script/configs/holesky/Holesky_current_deployment.config.json)
8-
- [Mainnet Contracts](https://github.com/Layr-Labs/eigenlayer-contracts/blob/mainnet/script/configs/mainnet/Mainnet_current_deployment.config.json)
7+
- [Holesky Contracts](https://github.com/Layr-Labs/eigenlayer-contracts/blob/main/script/configs/holesky.json)
8+
- [Mainnet Contracts](https://github.com/Layr-Labs/eigenlayer-contracts/blob/main/script/configs/mainnet.json)
99

1010
## Aligned Contracts: Holesky/Mainnet
1111

docs/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Aligned Docs
2+
3+
To check for broken links run:
4+
5+
```python3 check_markdown_links.py```

docs/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
* [Explorer](./2_architecture/components/6_explorer.md)
2222
* [Proof Aggregation Service](2_architecture/2_aggregation_mode.md)
2323
* [Deep Dive](2_architecture/agg_mode_components/1_deep_dive.md)
24-
* [Rollup-as-a-Service Platform](3_raas_platform.md)
24+
* [Rollup-as-a-Service Platform](2_architecture/3_raas_platform.md)
2525

2626
## Guides
2727

0 commit comments

Comments
 (0)