Fix lints

MauroToscano · MauroToscano · commit 4884ce794d75 · 2024-11-26T11:25:24.000-03:00
diff --git a/docs/0_internal/3_a_upgrade_contracts.md b/docs/0_internal/3_a_upgrade_contracts.md
@@ -11,17 +11,19 @@ If you deployed the contract using a Multisig wallet, you can follow the [Upgrad
 - You need to have installed git and make.
 
 - Clone the repository
-   ```
+
+   ```sh
    git clone https://github.com/yetanotherco/aligned_layer.git
    ```
 
 - Install foundry
-    ```shell
+
+    ```sh
     make install_foundry
     foundryup -v nightly-a428ba6ad8856611339a6319290aade3347d25d9
     ```
 
--  Add the following variables to the `.env` file:
+- Add the following variables to the `.env` file:
 
     ```makefile
     MULTISIG=false
@@ -50,4 +52,3 @@ To upgrade the Batcher Payment Service, run:
 ```bash
 make upgrade_batcher_payment_service
 ```
-
diff --git a/docs/0_internal/3_b_1_deploy_new_impl.md b/docs/0_internal/3_b_1_deploy_new_impl.md
@@ -2,41 +2,39 @@
 
 To deploy a new implementation, you can follow the steps below.
 
-
 ## Prerequisites
 
 1. Make sure you have set variables as specified in the [Deploy Contracts Guide](./2_deploy_contracts.md).
 
 2. Set ```MULTISIG=true``` on the ```.env``` used to deploy. ```contracts/scripts/.env.mainnet``` or ```contracts/scripts/.env.holesky``` or ```contracts/scripts/.env.sepolia```
 
-
 ## Deploy New Implementation for AlignedLayerServiceManager
 
 1. Deploy the new implementation by running:
 
    For **Mainnet** deployment:
-   
+
    ```bash
     make upgrade_aligned_contracts NETWORK=mainnet
    ```
 
     For **Holesky** deployment:
-    
+
     ```bash
      make upgrade_aligned_contracts NETWORK=holesky
     ```
-   
+
     For **Sepolia** deployment:
-    
+
     ```bash
      make upgrade_aligned_contracts NETWORK=sepolia
     ```
 
    If the new implementation is correctly deployed, the terminal will show the following message:
 
-   ```
+   ```html
    The new aligned layer service manager implementation is <new_aligned_layer_service_manager_implementation>
-   
+
    You can propose the upgrade transaction with the multisig using this calldata
    <calldata>
    ```
@@ -45,43 +43,41 @@ To deploy a new implementation, you can follow the steps below.
 
 2. Create a PR with the new address for the AlignedLayerServiceManagerImplementation.
 
-
 ## Deploy New Implementation for BatcherPaymentService
 
 1. Deploy the new implementation by running:
 
     For **Mainnet** deployment:
-    
+
     ```bash
     make upgrade_batcher_payment_service NETWORK=mainnet
     ```
-   
+
     For **Holesky** deployment:
-     
+
      ```bash
      make upgrade_batcher_payment_service NETWORK=holesky
      ```
-   
+
     For **Sepolia** deployment:
-        
+
      ```bash  
      make upgrade_batcher_payment_service NETWORK=sepolia
      ```
 
    If the new implementation is correctly deployed, the script will show the following message:
 
-   ```
+   ```html
    The new Batcher Payment Service Implementation is <new_batcher_payment_service_implementation>
-   
-   You can propose the upgrade transaction with the multisig using this calldata 
+
+   You can propose the upgrade transaction with the multisig using this calldata
    <calldata>
    ```
-   
+
    Also, the ```contracts/script/output/mainnet/alignedlayer_deployment_output.json``` or ```contracts/script/output/holesky/alignedlayer_deployment_output.json``` or ```contracts/script/output/sepolia/alignedlayer_deployment_output.json``` file will be updated with the new implementation address depending on the network you are deploying.
 
 2. Create a PR with the new address for the BatcherPaymentServiceImplementation.
 
-
 ## Next Steps
 
 Once you have deployed the new implementation of the contract you want to upgrade, you need to propose the upgrade transaction to the mulstisig, following this [guide](./3_b_2_propose_upgrade.md).
diff --git a/docs/0_internal/3_b_2_propose_upgrade.md b/docs/0_internal/3_b_2_propose_upgrade.md
@@ -9,50 +9,49 @@ To propose the upgrade transaction you can follow the steps below:
 1. Go to [Safe](https://app.safe.global/home)
 
 2. Click on `New transaction` -> `Transaction Builder`
-   
+
    ![New transaction](./images/3_b_2_multisig_1.png)
 
    ![Transaction Builder](./images/3_b_2_multisig_2.png)
 
-4. Get the `alignedLayerProxyAdmin` address from ```contracts/script/output/mainnet/alignedlayer_deployment_output.json``` or ```contracts/script/output/holesky/alignedlayer_deployment_output.json``` or ```contracts/script/output/sepolia/alignedlayer_deployment_output.json```, and paste it on `Enter Address or ENS Name`
+3. Get the `alignedLayerProxyAdmin` address from ```contracts/script/output/mainnet/alignedlayer_deployment_output.json``` or ```contracts/script/output/holesky/alignedlayer_deployment_output.json``` or ```contracts/script/output/sepolia/alignedlayer_deployment_output.json```, and paste it on `Enter Address or ENS Name`
 
-5. Once you paste the address, the ABI should be automatically filled.
+4. Once you paste the address, the ABI should be automatically filled.
 
-6. Choose the method ```upgrade``` in ```Contract method selector```.
+5. Choose the method ```upgrade``` in ```Contract method selector```.
 
-7. Get the ```alignedLayerServiceManager``` and ```alignedServiceManagerImplementation``` address from ```contracts/script/output/mainnet/alignedlayer_deployment_output.json``` or ```contracts/script/output/holesky/alignedlayer_deployment_output.json``` or ```contracts/script/output/sepolia/alignedlayer_deployment_output.json```.
+6. Get the ```alignedLayerServiceManager``` and ```alignedServiceManagerImplementation``` address from ```contracts/script/output/mainnet/alignedlayer_deployment_output.json``` or ```contracts/script/output/holesky/alignedlayer_deployment_output.json``` or ```contracts/script/output/sepolia/alignedlayer_deployment_output.json```.
 
-8. Paste ```alignedLayerServiceManager``` address in ```proxy (address)```
+7. Paste ```alignedLayerServiceManager``` address in ```proxy (address)```
 
-9. Paste ```alignedServiceManagerImplementation``` address in ```implementation (address)```
+8. Paste ```alignedServiceManagerImplementation``` address in ```implementation (address)```
 
-10. Click on `Create batch` to create the transaction.
+9. Click on `Create batch` to create the transaction.
 
       ![Create batch](./images/3_b_2_multisig_7.png)
 
-11. Review and confirm the transaction.
-   
+10. Review and confirm the transaction.
+
       To make sure everything is fine, simulate the transaction by clicking on `Simulate batch`
-   
+
       Once the simulation is successful, click on `Send Batch` to send the transaction.
 
       ![Simulate batch](./images/3_b_2_multisig_8.png)
 
-12. Confirm the transaction checking the function being called is correct and the contract address is the one you deployed.
+11. Confirm the transaction checking the function being called is correct and the contract address is the one you deployed.
 
       If everything is correct, click on `Sign` to send the transaction.
 
       ![Confirm transaction](./images/3_b_2_multisig_9.png)
 
-13. Now in your transactions, you should be able to see the newly created transaction.
+12. Now in your transactions, you should be able to see the newly created transaction.
 
       ![New transaction](./images/3_b_2_multisig_10.png)
 
-14. If the transaction is correctly created, you have to wait until the required Multisig member signs the transaction to send it.
+13. If the transaction is correctly created, you have to wait until the required Multisig member signs the transaction to send it.
 
 A guide on how to sign the transaction can be found [here](./3_b_3_approve_upgrade.md)
 
-
 ## Propose transaction for BatcherPaymentService
 
 1. Go to [Safe](https://app.safe.global/home)
@@ -98,4 +97,3 @@ A guide on how to sign the transaction can be found [here](./3_b_3_approve_upgra
 12. If the transaction is correctly created, you have to wait until the required Multisig member signs the transaction to send it.
 
 A guide on how to sign the transaction can be found [here](./3_b_3_approve_upgrade.md)
-
diff --git a/docs/1_introduction/2_example_quiz_app.md b/docs/1_introduction/2_example_quiz_app.md
@@ -0,0 +1,59 @@
+# ZK Quiz
+
+## Introduction
+
+This program leverages Aligned's ZK verification infrastructure to run a small quiz. The proof allows any party to check that the quiz was answered right or wrong. If answered correctly, the user receives an NFT.
+
+The process is as follows:
+
+1. The user runs ZKQuiz and answers the questions.
+2. ZKQuiz generates a ZK Proof of correct answers.
+3. The proof is posted on Aligned.
+4. Upon verification, ZKQuiz mints an NFT via a Smart Contract.
+
+The NFT is only granted if the user's answers correctly. 
+Incorrect answers or tampering with the ZKQuiz code will result in proof generation failure or mismatched checksums, 
+preventing NFT minting.
+
+Next, we will see how to execute ZKQuiz to get your own ZKQuiz NFT!
+
+## Requirements
+
+1. [Rust](https://www.rust-lang.org/tools/install)
+2. [Foundry](https://getfoundry.sh)
+
+## Usage
+
+### 1 - Create Keystore
+
+You can use cast to create a local keystore.
+If you already have one, you can skip this step.
+
+```bash
+cast wallet new-mnemonic
+```
+
+Then you can import your created keystore using:
+
+```bash
+cast wallet import --interactive <path_to_keystore.json>
+```
+
+Then you need to get some funds to pay for gas and proof verification.
+You can do this by using this [faucet](https://cloud.google.com/application/web3/faucet/ethereum/holesky)
+
+### 2 - Answer Quiz
+
+To answer quiz questions run:
+
+```bash
+make answer_quiz KEYSTORE_PATH=<path_to_keystore.json>
+```
+
+This will:
+
+1. Ask quiz questions
+2. Generate ZK proof
+3. Pay & submit proof to aligned for verification
+4. Wait for proof to be verified in aligned
+5. Claim NFT if proof is verified
