Skip to content

Commit 328a4f8

Browse files
committed
Fix lints
1 parent 001c325 commit 328a4f8

File tree

2 files changed

+30
-34
lines changed

2 files changed

+30
-34
lines changed

docs/0_internal/2_deploy_contracts.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,13 @@ Also, you will be able to deploy the Batcher Payment Service contract.
99
- You need to have installed `git` and `make`.
1010

1111
- Clone the repository
12-
```
12+
13+
```sh
1314
git clone https://github.com/yetanotherco/aligned_layer.git
1415
```
1516

1617
- Install foundry
18+
1719
```shell
1820
make install_foundry
1921
foundryup -v nightly-a428ba6ad8856611339a6319290aade3347d25d9
@@ -65,7 +67,6 @@ Also, you will be able to deploy the Batcher Payment Service contract.
6567
- Holesky: `contracts/script/output/holesky/alignedlayer_deployment_output.json`
6668
- Sepolia: `contracts/script/output/sepolia/alignedlayer_deployment_output.json`
6769

68-
6970
## BatcherPaymentsService Contracts
7071

7172
1. You should have a keystore for the Batcher, with the Seedphrase saved on paper.
@@ -78,7 +79,7 @@ Also, you will be able to deploy the Batcher Payment Service contract.
7879

7980
5. Set the ```PRIVATE_KEY``` and ```ETHERSCAN_API_KEY```on the ```.env``` used to deploy. ```contracts/scripts/.env.mainnet``` or ```contracts/scripts/.env.holesky``` or ```contracts/scripts/.env.sepolia```
8081

81-
6. Set `owner` value of `contracts/script/deploy/config/mainnet/batcher-payment-service.mainnet.config.json` or `contracts/script/deploy/config/holesky/batcher-payment-service.holesky.config.json` or `contracts/script/deploy/config/sepolia/batcher-payment-service.sepolia.config.json` to the multisig controlling this contract, or the owner of the deploying address, depending on what you want.
82+
6. Set `owner` value of `contracts/script/deploy/config/mainnet/batcher-payment-service.mainnet.config.json` or `contracts/script/deploy/config/holesky/batcher-payment-service.holesky.config.json` or `contracts/script/deploy/config/sepolia/batcher-payment-service.sepolia.config.json` to the multisig controlling this contract, or the owner of the deploying address, depending on what you want.
8283

8384
7. Set `batcherWallet` value of `contracts/script/deploy/config/mainnet/batcher-payment-service.mainnet.config.json` or `contracts/script/deploy/config/holesky/batcher-payment-service.holesky.config.json` or `contracts/script/deploy/config/sepolia/batcher-payment-service.sepolia.config.json` to the address from step 1.
8485

docs/0_internal/3_b_1_deploy_new_impl.md

Lines changed: 26 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ To deploy a new implementation, you can follow the steps below.
77
1. Make sure you have set variables as specified in the [Deploy Contracts Guide](./2_deploy_contracts.md).
88

99
2. Add the following variables to the `.env` file:
10-
10+
1111
```makefile
1212
MULTISIG=true
1313
```
14-
15-
## Deploy New Implementation
14+
15+
## What contracts can be upgraded?
1616

1717
You can deploy the new implementation of the following contracts:
1818

@@ -23,58 +23,55 @@ You can deploy the new implementation of the following contracts:
2323
### Deploy New Implementation for AlignedLayerServiceManager
2424

2525
1. Deploy the new implementation by running:
26-
27-
```shell
26+
27+
```sh
2828
make upgrade_aligned_contracts
2929
```
30-
30+
3131
If the new implementation is correctly deployed, the script will show the following message:
32-
33-
```
32+
33+
```sh
3434
The new aligned layer service manager implementation is <new_aligned_layer_service_manager_implementation>
3535

3636
You can propose the upgrade transaction with the multisig using this calldata
3737
<calldata>
3838
```
39-
39+
4040
You should save this `calldata` for later use.
41-
41+
4242
2. Get the `upgrade` function signature:
4343

44-
```
44+
```sh
4545
cast sig "upgrade(address, address)"
4646
```
4747

4848
This will show the `upgrade` signature hash: `0x99a88ec4`.
4949

5050
3. Validate the `calldata` by running:
51-
52-
```
51+
52+
```sh
5353
cast calldata-decode "upgrade(address, address)" <calldata>
5454
```
5555

5656
This will show two addresses. The first one is the `alignedLayerServiceManager` address, and the second one is the new implementation address of `alignedServiceManagerImplementation`.
5757

5858
> [!NOTE]
5959
> Make sure the `alignedLayerServiceManager` address is the same as the one you deployed in the [Deploy Contracts Guide](./2_deploy_contracts.md).
60-
>
61-
> Make sure the `alignedServiceManagerImplementation` address is the same as the one you deployed in this guide.
62-
60+
>
61+
> Make sure the `alignedServiceManagerImplementation` address is the same as the one you deployed in this guide.
6362

6463
### Deploy New Implementation for BatcherPaymentService
6564

6665
1. Deploy the new implementation by running:
67-
66+
6867
```shell
6968
make upgrade_batcher_payment_service
7069
```
7170

7271
If the new implementation is correctly deployed, the script will show the following message:
73-
74-
```
75-
You can propose the upgrade transaction with the multisig using this calldata
76-
<calldata>
77-
```
72+
73+
`You can propose the upgrade transaction with the multisig using this calldata
74+
<calldata>`
7875

7976
You should save this `calldata` for later use.
8077

@@ -88,7 +85,7 @@ You can deploy the new implementation of the following contracts:
8885

8986
3. Validate the `calldata` by running:
9087

91-
```
88+
```shell
9289
cast calldata-decode "upgradeTo(address)" <calldata>
9390
```
9491

@@ -97,21 +94,20 @@ You can deploy the new implementation of the following contracts:
9794
> [!NOTE]
9895
> Make sure the `batcherPaymentServiceImplementation` address is the same as the one you deployed in this guide.
9996

100-
10197
### Deploy New Implementation for RegistryCoordinator
10298

10399
1. Deploy the new implementation by running:
104-
105-
```shell
100+
101+
```sh
106102
make upgrade_registry_coordinator
107103
```
108104

109105
If the new implementation is correctly deployed, the script will show the following message:
110-
111-
```
106+
107+
`
112108
You can propose the upgrade transaction with the multisig using this calldata
113109
<calldata>
114-
```
110+
`
115111

116112
You should save this `calldata` for later use.
117113

@@ -125,7 +121,7 @@ You can deploy the new implementation of the following contracts:
125121

126122
3. Validate the `calldata` by running:
127123

128-
```
124+
```sh
129125
cast calldata-decode "upgrade(address, address)" <calldata>
130126
```
131127

@@ -136,7 +132,6 @@ You can deploy the new implementation of the following contracts:
136132
>
137133
> Make sure the `registryCoordinatorImplementation` address is the same as the one you deployed in this guide.
138134

139-
140135
## Next Steps
141136

142137
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).

0 commit comments

Comments
 (0)