You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-2Lines changed: 22 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -88,7 +88,7 @@ Because of great complexity of the contract and need for fine-tuned upgradabilit
88
88
89
89
## Deployment
90
90
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`).
92
92
93
93
2. Compile your contract with
94
94
@@ -105,9 +105,15 @@ bun satellite:deploy CHAIN_ID
105
105
> Note: Addresses of deployed contracts are saved to `deployed_satellites.json`. If contract for chain id, which you want to deploy, already exists in the config, it will fail. If you want to erase data about deployed contracts run
106
106
>
107
107
> ```
108
-
> bun erase_deployed_satellites
108
+
> bun detach_satellites
109
109
> ```
110
110
111
+
To connect two satellites that support messaging, run
112
+
113
+
```
114
+
bun connection:register SENDER_CHAIN_ID RECEIVER_CHAIN_ID
115
+
```
116
+
111
117
### Upgrades
112
118
113
119
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
116
122
bun satellite:upgrade CHAIN_ID
117
123
```
118
124
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
0 commit comments