docs: improve deploy_new_impl and propose_upgrade

JuArce · JuArce · commit 22230bd2ba1f · 2024-11-25T14:48:14.000-03:00
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,18 +2,13 @@
 
 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```
 
-## What contracts can be upgraded?
-
-You can deploy the new implementation of the following contracts:
-
-- AlignedLayerServiceManager
-- BatcherPaymentService
 
 ## Deploy New Implementation for AlignedLayerServiceManager
 
@@ -39,36 +34,16 @@ You can deploy the new implementation of the following contracts:
 
    If the new implementation is correctly deployed, the terminal will show the following message:
 
-   ```sh
+   ```
    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>
-    ```
-
-   You should save this `calldata` for later use.
-
-2. Get the `upgrade` function signature:
-
-   ```sh
-   cast sig "upgrade(address, address)"
+   <calldata>
    ```
 
-   This will show the `upgrade` signature hash: `0x99a88ec4`.
-
-   Verify the first 8 digits of the `calldata` are the same as the signature hash obtained in this step. 
-
-3. Validate the contracts addresses of the `calldata` by running:
-
-   ```sh
-   cast calldata-decode "upgrade(address, address)" <calldata>
-   ```
-
-   This will show two addresses. The first one is the `alignedLayerServiceManager` address, and the second one is the new implementation address of `alignedServiceManagerImplementation`.
-
-   Make sure the `alignedLayerServiceManager` address is the same as the one you deployed in the [Deploy Contracts Guide](./2_deploy_contracts.md).
+   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.
 
-   Make sure the `alignedServiceManagerImplementation` address is the same as the one you deployed in this guide.
+2. Create a PR with the new address for the AlignedLayerServiceManagerImplementation.
 
 
 ## Deploy New Implementation for BatcherPaymentService
@@ -95,33 +70,18 @@ You can deploy the new implementation of the following contracts:
 
    If the new implementation is correctly deployed, the script will show the following message:
 
-   `You can propose the upgrade transaction with the multisig using this calldata <calldata>`
-
-   You should save this `calldata` for later use.
-
-2. Get the `upgradeTo` function signature:
-
-   ```bash
-    cast sig "upgradeTo(address)"
-    ```
-
-   This will show the `upgradeTo` signature hash: `0x3659cfe6`.
-
-   Verify the first 8 digits of the `calldata` are the same as the signature hash obtained in this step.
-
-3. Validate the `calldata` by running:
-
-   ```shell
-   cast calldata-decode "upgradeTo(address)" <calldata>
    ```
-
-   This will show the `batcherPaymentServiceImplementation` address.
+   The new Batcher Payment Service Implementation is <new_batcher_payment_service_implementation>
    
-   Make sure the `batcherPaymentServiceImplementation` address is the same as the one you deployed in this guide.
+   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).
-
-You must also send the contracts addresses and `calldata` you gathered from this guide, to all the multisig participants.
diff --git a/docs/0_internal/3_b_2_propose_upgrade.md b/docs/0_internal/3_b_2_propose_upgrade.md
@@ -2,75 +2,33 @@
 
 After deploying a new implementation candidate for the upgrade, you need to propose the upgrade transaction using the multisig wallet.
 
-## Prerequisites
-
-- You need to have deployed the new implementation following the [Deploy New Implementation Guide](./3_b_1_deploy_new_impl.md).
-
-- Upgrade `calldata` obtained from the deployment of the new implementation.
-
 ## Propose transaction
 
 To propose the upgrade transaction you can follow the steps below:
 
-1. Get the function signature
-
-    If you are upgrading the AlignedLayerServiceManager or the RegistryCoordinator, you can get the function signature by running:
-
-    ```bash
-    cast sig "upgrade(address, address)"
-    ```
-
-   This will show the `upgrade` signature hash: `0x99a88ec4`.
+1. If you want to upgrade the ```alignedLayerServiceManager``` 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```.
+    
+    If you want to upgrade the ```batcherPaymentService``` get the ```batcherPaymentServiceImplementation``` 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```.
 
-    Else, if you are upgrading the BatcherPaymentService, you can get the function signature by running:
+2. If you want to upgrade the ```alignedLayerServiceManager``` generate the `calldata` for the upgrade transaction by running:
 
     ```bash
-    cast sig "upgradeTo(address)"
+    cast calldata "upgrade(address, address)" <alignedLayerServiceManager> <alignedLayerServiceManagerImplementation>
     ```
    
-    This will show the `upgradeTo` signature hash: `0x3659cfe6`.
-    
-2. Validate the calldata
-
-    If you are upgrading the AlignedLayerServiceManager or the RegistryCoordinator, you can validate the calldata by running:
+    If you want to upgrade the ```batcherPaymentService``` generate the `calldata` for the upgrade transaction by running:
 
     ```bash
-    cast calldata-decode "upgrade(address, address)" <calldata>
-    ```
-
-    This will show two addresses. 
-    
-    If you are upgrading the AlignmentLayerServiceManager, the first one is the `alignedLayerServiceManager` address, and the second one is the new implementation address of `alignedServiceManagerImplementation`.
-
-    If you are upgrading the RegistryCoordinator, the first one is the `registryCoordinator` address, and the second one is the new implementation address of `registryCoordinatorImplementation`.
-
-> [!NOTE]
-> The first 10 characters must be the same the signature hash obtained in the previous step.
-> 
-> Make sure the `alignedLayerServiceManager` address is the same as the one you deployed in the [Deploy Contracts Guide](./2_deploy_contracts.md).
-> 
-> Make sure the `alignedServiceManagerImplementation` address is the same as the one you deployed in this guide.
-
-   Else, if you are upgrading the BatcherPaymentService, you can validate the calldata by running:
-   
-   ```bash
-   cast calldata-decode "upgradeTo(address)" <calldata>
+   cast calldata "upgradeTo(address)" <batcherPaymentServiceImplementation>
    ```
 
-   This will show the `batcherPaymentServiceImplementation` address.
-
-> [!NOTE] 
-> The first 10 characters must be the same the signature hash obtained in the previous step.
-> 
-> Make sure the `batcherPaymentServiceImplementation` address is the same as the one you deployed in this guide. 
-
 3. Verify the contract bytecode running the following command:
 
    ```
    TODO
    ```
    
-4. Once the calldata and the proposed upgrade are validated, you can create the upgrade transaction on [Safe](https://app.safe.global/home)
+4. Once the proposed upgrade is validated, you can create the upgrade transaction on [Safe](https://app.safe.global/home)
 
 5. Click on `New transaction` -> `Transaction Builder`
    
@@ -80,27 +38,7 @@ To propose the upgrade transaction you can follow the steps below:
 
 6. Enable `Custom data`
 
-7. Get the `ProxyAdmin` address, and paste it on `Enter Address or ENS Name`
-
-   To get the `ProxyAdmin` address the following command will copy the address to the clipboard:
-
-    ```bash
-    # SEPOLIA
-    jq -r ".addresses.alignedLayerProxyAdmin" contracts/script/output/sepolia/alignedlayer_deployment_output.json | pbcopy
-    ```
-
-    ```bash
-   # HOLESKY
-   jq -r ".addresses.alignedLayerProxyAdmin" contracts/script/output/holesky/alignedlayer_deployment_output.json | pbcopy
-    ```
-   
-    ```bash
-    # MAINNET
-    jq -r ".addresses.alignedLayerProxyAdmin" contracts/script/output/mainnet/alignedlayer_deployment_output.json | pbcopy
-    ```
-   
->    [!NOTE]
->    Make sure to set the path to the correct deployment output file.
+7. Get the `ProxyAdmin` 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`
 
 8. Once you paste the `ProxyAdmin` address, the ABI should be automatically filled.
 
