Skip to content

Commit eadd8ae

Browse files
PatStilesJuArceklaus993MarcosNicolauuri-99
authored
Feat(docs): add docs for unpause process with multisig (#1497)
Co-authored-by: JuArce <[email protected]> Co-authored-by: Klaus @ LambdaClass <[email protected]> Co-authored-by: Marcos Nicolau <[email protected]> Co-authored-by: Urix <[email protected]>
1 parent 990ec1d commit eadd8ae

18 files changed

+156
-1
lines changed

docs/0_internal/4_b_1_propose_pause.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To propose the pause transaction you can follow the steps below:
1818

1919
![Transaction Builder](./images/4_b_1_pause_2.png)
2020

21-
3. . Get the `AlignedLayerServiceManager` 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```
21+
3. Get the `AlignedLayerServiceManager` 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```
2222

2323
4. Paste the `AlignedLayerServiceManager` address on `Enter Address or ENS Name`
2424

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# Propose the Transaction for UnPause using Multisig
2+
3+
If you want to unpause the contracts, you can propose the unpause transaction using the multisig wallet.
4+
5+
## Prerequisites
6+
7+
- You need to have deployed the contracts following the [Deploy Contracts Guide](./2_deploy_contracts.md).
8+
9+
## Propose transaction for UnPause AlignedLayerServiceManager
10+
11+
To propose the unpause transaction you can follow the steps below:
12+
13+
1. Go to [Safe](https://app.safe.global/home)
14+
15+
2. Click on `New transaction` -> `Transaction Builder`
16+
17+
![New transaction](./images/4_b_1_unpause_1.png)
18+
19+
![Transaction Builder](./images/4_b_1_unpause_2.png)
20+
21+
3. Get the `AlignedLayerServiceManager` 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```
22+
23+
4. Paste the `AlignedLayerServiceManager` address on `Enter Address or ENS Name`
24+
25+
![Enter Address](./images/4_b_1_unpause_3.png)
26+
27+
5. As this is a Proxy contract, choose `Use Implementation ABI`
28+
29+
![Use Implementation ABI](./images/4_b_1_unpause_4.png)
30+
31+
6. In `contract method selector` choose `unpause()` and within `newPausedStatus(uint256)` enter the desired pause status as described in [pausable.md](./pausable.md). Use pause status `0` for pausable contracts.
32+
33+
![Choose pause](./images/4_b_1_unpause_5.png)
34+
35+
7. Click on `+ Add new transaction`
36+
37+
You should see the new transaction to be executed
38+
39+
8. Click on `Create batch` to create the transaction.
40+
41+
![Choose pause](./images/4_b_1_unpause_6.png)
42+
43+
9. Simulate the transaction by clicking on `Simulate`
44+
45+
10. If everything is correct, click on `Send batch` to send the transaction.
46+
47+
11. Simulate the transaction, and if everything is correct, click on `Sign`.
48+
49+
![Send batch](./images/4_b_1_unpause_7.png)
50+
51+
> [!NOTE]
52+
> In the `call` field, you will see `fallback`.
53+
#### 12. Wait for the transaction to be executed. You can check the transaction status on the `Transactions` tab.
54+
55+
56+
## Propose transaction for UnPause BatcherPaymentService
57+
58+
To propose the unpause transaction you can follow the steps below:
59+
60+
1. Create the unpause transaction on [Safe](https://app.safe.global/home)
61+
62+
2. Click on `New transaction` -> `Transaction Builder`
63+
64+
![New transaction](./images/4_b_1_unpause_1.png)
65+
66+
![Transaction Builder](./images/4_b_1_unpause_2.png)
67+
68+
3. Get the `BatcherPaymentService` 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```
69+
70+
4. Paste the `BatcherPaymentService` address on `Enter Address or ENS Name`
71+
72+
![Enter Address](./images/4_b_1_unpause_3.png)
73+
74+
5. As this is a Proxy contract, choose `Use Implementation ABI`
75+
76+
![Use Implementation ABI](./images/4_b_1_unpause_4.png)
77+
78+
6. In `contract method selector` choose `unpause()`
79+
80+
![Choose pause](./images/4_b_1_unpause_8.png)
81+
82+
7. Then click on `+ Add new transaction`
83+
84+
You should see the new transaction to be executed. Then click on `Create batch` to create the transaction.
85+
86+
![Add new transaction](./images/4_b_1_unpause_9.png)
87+
88+
8. Review and confirm you are interacting with the correct `BatcherPaymentService` contract and you are calling the `unpause` function.
89+
90+
![Review transaction](./images/4_b_1_unpause_10.png)
91+
92+
9. Simulate the transaction by clicking on `Simulate`
93+
94+
10. If everything is correct, click on `Send batch` to send the transaction.
95+
96+
11. Review the transaction and click on `Sign` to sign the transaction.
97+
98+
![Send batch](./images/4_b_1_unpause_11.png)
99+
100+
12. If the transaction is correctly created, you have to wait until the required Multisig member signs the transaction to send it. For this, you can follow [the following guide](./4_b_4_approve_unpause.md)
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Approve the UnPause Transaction
2+
3+
Once the transaction is proposed, the multisig owners must approve the transaction.
4+
5+
## Approve the UnPause for AlignedLayerServiceManager
6+
7+
1. Go to [Safe](https://app.safe.global/home) and connect your wallet.
8+
9+
2. Go to the `Transactions` tab and find the transaction that was proposed.
10+
11+
3. Get the ```unpause(uint256)``` signature by running:
12+
13+
```bash
14+
cast calldata "unpause(uint256)" <PAUSE_STATE>
15+
```
16+
17+
for ```PAUSE_STATE=3```
18+
19+
It must show you ```0xfabc1cbc0000000000000000000000000000000000000000000000000000000000000003```, with ```0xfabc1cbc``` being the function identifier.
20+
21+
4. Click on the transaction, and then click on ```Advanced Details```.
22+
23+
![Check details](images/4_b_2_approve_unpause_1.png)
24+
25+
5. Copy the ```Raw Data```, paste it in a text editor and verify it is the same value as the one you got in step 3.
26+
27+
6. If the data is correct, click on the `Confirm` button.
28+
29+
7. Simulate the transaction. If everything is correct, click on the `Sign` button.
30+
31+
![Sign transaction](images/4_b_2_approve_unpause_2.png)
32+
33+
8. Once the transaction is executed, the unpause will be effective.
34+
35+
## Approve the UnPause for BatcherPaymentService
36+
37+
1. Go to [Safe](https://app.safe.global/home) and connect your wallet.
38+
39+
2. Go to the `Transactions` tab and find the transaction that was proposed.
40+
41+
3. Click on the transaction and validate the data is correct.
42+
43+
The called function must be `unpause()` and the contract address must be the `BatcherPaymentService` address.
44+
45+
![Check details](images/4_b_2_approve_unpause_3.png)
46+
47+
Get the `BatcherPaymentService` 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```
48+
49+
4. If the data is correct, click on the `Confirm` button.
50+
51+
5. Simulate the transaction. If everything is correct, click on the `Sign` button.
52+
53+
![Sign transaction](images/4_b_2_approve_unpause_4.png)
54+
55+
6. Once the transaction is executed, the unpause will be effective.
545 KB
Loading
280 KB
Loading
235 KB
Loading
315 KB
Loading
415 KB
Loading
65 KB
Loading
216 KB
Loading

0 commit comments

Comments
 (0)