Skip to content

Commit 3a92154

Browse files
committed
docs: upgrade docs [WIP]
1 parent 2598707 commit 3a92154

File tree

7 files changed

+106
-7
lines changed

7 files changed

+106
-7
lines changed

docs/0_internal/0_guides.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,6 @@
22

33
This guide will walk you through the deployment of the Aligned Layer contracts.
44

5-
## Prerequisites
6-
7-
- Clone the repository
8-
```
9-
git clone https://github.com/yetanotherco/aligned_layer.git
10-
```
115

126
## Setup
137

@@ -19,3 +13,6 @@ This guide will walk you through the deployment of the Aligned Layer contracts.
1913

2014
After finishing the deployment, you will have the deployed contract addresses.
2115

16+
3. Once you have deployed the Aligned contracts, you can perform upgrades on them.
17+
18+
a. If you are not using a Multisig wallet, you can follow the [Upgrade Guide](./3_a_upgrade_contracts.md).

docs/0_internal/2_deploy_contracts.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,21 @@ This guide will walk you through the deployment of the Aligned Layer contracts.
44

55
Also, you will be able to deploy the Batch Payment Service contract.
66

7+
## Prerequisites
8+
9+
- You need to have installed git and make.
10+
11+
- Clone the repository
12+
```
13+
git clone https://github.com/yetanotherco/aligned_layer.git
14+
```
15+
16+
- Install foundry
17+
```shell
18+
make install_foundry
19+
foundryup -v nightly-a428ba6ad8856611339a6319290aade3347d25d9
20+
```
21+
722
## Eigenlayer Contracts
823

924
To deploy Aligned contracts, you need previously deployed EigenLayer contracts.
@@ -175,7 +190,7 @@ For the batcher payment service, you can set the Multisig address in the `owner`
175190
176191
### Deploy the contracts
177192
178-
Once you have configured the `.env` and `DEPLOY_CONFIG_PATH` files, you can run the following command:
193+
Once you have configured the `.env` and `BATCHER_PAYMENT_SERVICE_CONFIG_PATH` files, you can run the following command:
179194
180195
```bash
181196
make deploy_batcher_payment_service
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Upgrade Contracts
2+
3+
This guide is for upgrading contracts deployed without a multisig wallet. If you deployed the contract using a Multisig wallet, you can follow the [Upgrade Contracts with Multisig](./3_b_upgrade_contracts_with_multisig.md) tutorial.
4+
5+
## Prerequisites
6+
7+
- To upgrade any of the contracts, you need to have set the `.env`, `DEPLOY_CONFIG_PATH` and `BATCHER_PAYMENT_SERVICE_CONFIG_PATH`
8+
9+
- You need to have installed git and make.
10+
11+
- Clone the repository
12+
```
13+
git clone https://github.com/yetanotherco/aligned_layer.git
14+
```
15+
16+
- Install foundry
17+
```shell
18+
make install_foundry
19+
foundryup -v nightly-a428ba6ad8856611339a6319290aade3347d25d9
20+
```
21+
22+
## Upgrade Service Manager
23+
24+
To upgrade the Service Manager Contract, run:
25+
26+
```bash
27+
make upgrade_aligned_contracts
28+
```
29+
30+
## Upgrade Registry Coordinator
31+
32+
To upgrade the Registry Coordinator, run:
33+
34+
```bash
35+
make upgrade_registry_coordinator
36+
```
37+
38+
## Upgrade Batcher Payment Service
39+
40+
To upgrade the Batcher Payment Service, run:
41+
42+
```bash
43+
make upgrade_batcher_payment_service
44+
```
45+
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Deploy New Implementation
2+
3+

docs/0_internal/3_b_2_propose_upgrade.md

Whitespace-only changes.

docs/0_internal/3_b_3_approve_upgrade.md

Whitespace-only changes.
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Upgrade Contracts using a Multisig
2+
3+
> [!WARNING]
4+
> Safe Multisig Wallet is not currently supported in Holesky Testnet.
5+
> For this reason, we deployed EigenLayer contracts in Sepolia to test the upgrade on AlignedLayer Contracts.
6+
7+
> [!NOTE]
8+
> EigenLayer Sepolia contracts information is available in `contracts/script/output/sepolia/eigenlayer_deployment_output.json`.
9+
10+
> [!NOTE]
11+
> You can find a guide on how to Deploy the contracts [here](./2_deploy_contracts.md).
12+
13+
14+
This guide is for upgrading contracts deployed using a Multisig wallet. If you deployed the contract without a Multisig wallet, you can follow the [Upgrade Contracts](./3_a_upgrade_contracts.md) tutorial.
15+
16+
In this guide we make an upgrade of Aligned Layer Service Manager contract using a multisig wallet. This is important to ensure not one party can do an upgrade, and helps ensure the team is not locked out of upgrading the network due to a loss of keys.
17+
18+
## Prerequisites
19+
20+
- To upgrade any of the contracts, you need to have set the `.env`, `DEPLOY_CONFIG_PATH` and `BATCHER_PAYMENT_SERVICE_CONFIG_PATH`
21+
22+
- You need to have installed git and make.
23+
24+
- Clone the repository
25+
```
26+
git clone https://github.com/yetanotherco/aligned_layer.git
27+
```
28+
29+
- Install foundry
30+
```shell
31+
make install_foundry
32+
foundryup -v nightly-a428ba6ad8856611339a6319290aade3347d25d9
33+
```
34+
35+
## Deploy the new implementation
36+
37+
The first step is to deploy the new implementation of the contract.
38+
39+
You need to

0 commit comments

Comments
 (0)