Skip to content

Commit 56ad3a8

Browse files
committed
Update readme
1 parent eca071a commit 56ad3a8

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Because of great complexity of the contract and need for fine-tuned upgradabilit
8888

8989
## Deployment
9090

91-
1. Create `.env` file using `.env.example` template. You will need `PRIVATE_KEY` of EVM deployment account and `ALCHEMY_API_KEY` which you can get from [TODO link](). Make sure that you enabled chains you need. Additionally, you will need API key for block explorers of chains you want to deploy to (`*CHAIN_NAME*_ETHERSCAN_API_KEY`).
91+
1. Create `.env` file using `.env.example` template. You will need `PRIVATE_KEY` of EVM deployment account and `ALCHEMY_API_KEY` which you can get from [Alchemy dashboard](https://dashboard.alchemy.com). Make sure that you enabled chains you need. Additionally, you will need API key for block explorers of chains you want to deploy to (`*CHAIN_NAME*_ETHERSCAN_API_KEY`).
9292

9393
2. Compile your contract with
9494

@@ -108,6 +108,12 @@ bun satellite:deploy CHAIN_ID
108108
> bun detach_satellites
109109
> ```
110110
111+
To connect two satellites that support messaging, run
112+
113+
```
114+
bun connection:register SENDER_CHAIN_ID RECEIVER_CHAIN_ID
115+
```
116+
111117
### Upgrades
112118
113119
To upgrade existing satellite, run steps 1 and 2 from section above and then run
@@ -116,6 +122,20 @@ To upgrade existing satellite, run steps 1 and 2 from section above and then run
116122
bun satellite:upgrade CHAIN_ID
117123
```
118124
125+
### Removing satellites and connections
126+
127+
To remove connection between two satellites, run
128+
129+
```
130+
bun connection:remove SENDER_CHAIN_ID RECEIVER_CHAIN_ID
131+
```
132+
133+
When all connections to/from satellite are removed, you can remove satellite with
134+
135+
```
136+
bun satellite:remove CHAIN_ID
137+
```
138+
119139
## Documentation
120140
121141
Here are some useful links for further reading:

0 commit comments

Comments
 (0)