Skip to content

Commit e4927a6

Browse files
committed
chore: Docs improvements
1 parent 04bf7fc commit e4927a6

File tree

7 files changed

+51
-39
lines changed

7 files changed

+51
-39
lines changed

content/defender/index.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,17 @@ New sign-ups were disabled on June 30, 2025. Until the final shutdown on July 1,
1111

1212
</Callout>
1313

14+
<Callout type='info' title='Migration Guides Available'>
15+
16+
We have comprehensive migration guides to help you transition:
17+
18+
- **[Migrate from Defender Monitor to OpenZeppelin Monitor](/defender/migration#monitor-migration)** - Export configurations, set up infrastructure, and test your monitors
19+
- **[Migrate from Defender Relayer to OpenZeppelin Relayer](/defender/migration#relayer-migration)** - Transfer relayers, update SDK integration, and migrate transaction handling
20+
21+
View the complete [Migration Guide](/defender/migration) for detailed instructions.
22+
23+
</Callout>
24+
1425
OpenZeppelin Defender is a mission-critical developer security platform to **code**, **audit**, **deploy**, **monitor**, and **operate** blockchain applications with confidence.
1526

1627
Integrating directly into the developer workflow, Defender makes it easy and fast for developers and operators to prevent and fix security issues pre and post-deployment.

content/defender/migration.mdx

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ title: Migrating from Defender to Open Source
77
Defender is now in maintenance mode. To continue using monitoring and relaying capabilities with the latest features and updates, we recommend migrating to OpenZeppelin's open source tools.
88

99
This guide covers:
10-
- Migrating from **Defender Monitor** to [OpenZeppelin Monitor](/monitor/1.1.x)
11-
- Migrating from **Defender Relayer** to [OpenZeppelin Relayer](/relayer/1.2.x)
10+
- Migrating from **Defender Monitor** to [OpenZeppelin Monitor](/monitor)
11+
- Migrating from **Defender Relayer** to [OpenZeppelin Relayer](/relayer)
1212

1313
Both tools are designed to be self-hosted, giving you full control over your infrastructure while maintaining the functionality you rely on.
1414

@@ -32,9 +32,9 @@ Both tools are designed to be self-hosted, giving you full control over your inf
3232

3333
## Monitor Migration
3434

35-
### From Defender Monitor to OpenZeppelin Open Source Monitor
35+
### From Defender Monitor to OpenZeppelin Monitor
3636

37-
The open source Monitor offers similar functionality to Defender Monitor:
37+
OpenZeppelin Monitor offers similar functionality to Defender Monitor:
3838

3939
- **Event and function monitoring**: Monitor smart contract events and function calls
4040
- **Custom filtering**: Write custom JavaScript, Python or Bash filters to match specific conditions
@@ -45,20 +45,20 @@ The open source Monitor offers similar functionality to Defender Monitor:
4545
To begin your Monitor migration:
4646

4747
1. **Review your existing monitors**: Export your Defender Monitor configurations using the "Download OpenZeppelin Monitor Configurations" button
48-
2. **Import your configurations**: Use the exported configurations to recreate your monitors in the open source version
49-
3. **Set up the open source Monitor**: Follow the [installation guide](/monitor/1.1.x) to deploy Monitor on your infrastructure
48+
2. **Import your configurations**: Use the exported configurations to recreate your monitors in OpenZeppelin Monitor
49+
3. **Set up OpenZeppelin Monitor**: Follow the [installation guide](/monitor) to set up the Monitor.
5050

5151
![Defender Monitor Migration Button](/defender/monitor-migration-information.png)
5252

53-
The "Download OpenZeppelin Monitor Configurations" button will download a .zip file containing configuration files for every active monitor in your Defender account. These configurations are ready to copy and paste directly into the open source Monitor. Before running the monitors, make sure to review and update any placeholder values in the configuration files, such as:
53+
The "OpenZeppelin Monitor Configurations" button will download a .zip file containing configuration files for every monitor in your Defender account (if you don't have to download some monitor, first delete it). These configurations are ready to copy and paste directly into OpenZeppelin Monitor. Before running the monitors, make sure to review and update any placeholder values in the configuration files, such as:
5454

5555
- API keys and secrets
5656
- RPC URLs and endpoint addresses
5757
- Webhook URLs for notifications
5858
- Service integration credentials (Slack, Telegram, Discord, etc.)
5959

6060
<Callout type='warn'>
61-
Custom Actions attached to your Defender monitors will not be automatically migrated. You will need to manually recreate any custom action logic following the [OpenZeppelin Monitor documentation](/monitor/1.1.x) for trigger handlers and custom notifications.
61+
Custom Actions attached to your Defender monitors will not be automatically migrated. You will need to manually recreate any custom action logic following the [OpenZeppelin Monitor documentation](/monitor) for trigger handlers and custom notifications.
6262
</Callout>
6363

6464
Alternatively, if you don't want to download all monitor configurations at once, you can navigate to each individual monitor and download its configuration separately. This gives you more control over which monitors to migrate and when.
@@ -69,15 +69,15 @@ Here's a video with the process step by step: https://www.loom.com/share/6de3d26
6969

7070
4. **Test your monitors**: Verify that alerts trigger correctly before decommissioning Defender monitors
7171

72-
For detailed migration instructions and support, visit the [OpenZeppelin Monitor documentation](/monitor/1.1.x).
72+
For detailed migration instructions and support, visit the [OpenZeppelin Monitor documentation](/monitor).
7373

7474
---
7575

7676
## Relayer Migration
7777

78-
### From Defender Relayer to OpenZeppelin Open Source Relayer
78+
### From Defender Relayer to OpenZeppelin Relayer
7979

80-
The open source Relayer offers similar functionality to Defender Relayer:
80+
OpenZeppelin Relayer offers similar functionality to Defender Relayer:
8181

8282
- **Transaction relaying**: Submit transactions to supported blockchain networks efficiently
8383
- **Transaction signing**: Securely sign transactions using configurable key management
@@ -91,22 +91,22 @@ The open source Relayer offers similar functionality to Defender Relayer:
9191

9292
To begin your Relayer migration:
9393

94-
1. **Review your existing relayers**: Export your Defender Relayer configurations using the "Download OpenZeppelin Relayer Configurations" button
94+
1. **Review your existing relayers**: Export your Defender Relayer configurations using the "OpenZeppelin Relayer Configurations" button
9595

96-
The "Download OpenZeppelin Relayer Configurations" button will download a .zip file containing configuration files for every active relayer in your Defender account. These configurations are ready to copy and paste directly into the open source Relayer. Before running the relayers, make sure to review and update any placeholder values in the configuration files, such as:
96+
![Defender Relayer Migration Button](/defender/relayer-migration-button.png)
9797

98-
![Defender Relayer Migration Button](/defender/defender-relayer-migration-button.png)
98+
The "Download OpenZeppelin Relayer Configurations" button will download a .zip file containing configuration files for every relayer in your Defender account (if you don't want to download some relayer, first delete it). These configurations are ready to copy and paste directly into OpenZeppelin Relayer. Before running the relayers, make sure to review and update any placeholder values in the configuration files, such as:
9999

100-
2. **Set up the open source Relayer**: Follow the [installation guide](/relayer/1.2.x) to deploy the Relayer on your infrastructure
101-
3. **Import your configurations**: Use the exported configurations to recreate your relayers in the open source version
100+
2. **Set up OpenZeppelin Relayer**: Follow the [installation guide](/relayer) to deploy the Relayer on your infrastructure
101+
3. **Import your configurations**: Use the exported configurations to recreate your relayers in OpenZeppelin Relayer
102102

103103
- RPC URLs and endpoint addresses
104104
- Signer configurations and private keys
105105
- Network-specific policies
106106
- Webhook URLs for notifications
107107

108108
4. **Test your relayers**: Verify that transactions are processed correctly before decommissioning Defender relayers
109-
5. **Transfer funds**: Once your open source relayers are fully configured and running, transfer the funds from your Defender relayers to your new open source relayer addresses using the Withdraw functionality
109+
5. **Transfer funds**: Once your OpenZeppelin Relayers are fully configured and running, transfer the funds from your Defender relayers to your new OpenZeppelin Relayer addresses using the Withdraw functionality
110110
6. **Gradually move volume**: Shift traffic from Defender relayer to OpenZeppelin Relayer incrementally
111111

112112
Here's a video with the process step by step: https://www.loom.com/share/cb5e0f5d8c064a71abc8c18fac273cf0
@@ -236,15 +236,15 @@ const relayers = await relayerApi.listRelayers();
236236
| `relayer.getRelayer()` | `relayerApi.getRelayer()` |
237237
| `relayer.getRelayerStatus()` | `relayerApi.getRelayerStatus()` |
238238

239-
For detailed migration instructions and support, visit the [OpenZeppelin Relayer documentation](/relayer/1.2.x).
239+
For detailed migration instructions and support, visit the [OpenZeppelin Relayer documentation](/relayer).
240240

241241
---
242242

243243
## Support and Resources
244244

245245
### Documentation
246-
- [OpenZeppelin Monitor Documentation](/monitor/1.1.x)
247-
- [OpenZeppelin Relayer Documentation](/relayer/1.2.x)
246+
- [OpenZeppelin Monitor Documentation](/monitor)
247+
- [OpenZeppelin Relayer Documentation](/relayer)
248248

249249
### Getting Help
250250
If you encounter issues during migration or have questions:
@@ -259,7 +259,7 @@ Use this checklist to track your migration progress:
259259
#### Monitor Migration
260260
- [ ] Export Monitor configurations from Defender
261261
- [ ] Review and update placeholder values (API keys, RPC URLs, etc.)
262-
- [ ] Set up open source Monitor infrastructure
262+
- [ ] Set up OpenZeppelin Monitor infrastructure
263263
- [ ] Import and configure monitors
264264
- [ ] Recreate custom action logic
265265
- [ ] Test alert triggers
@@ -269,12 +269,12 @@ Use this checklist to track your migration progress:
269269
#### Relayer Migration
270270
- [ ] Export Relayer configurations from Defender
271271
- [ ] Review and update placeholder values (signers, RPC URLs, policies)
272-
- [ ] Set up open source Relayer infrastructure
272+
- [ ] Set up OpenZeppelin Relayer infrastructure
273273
- [ ] Import and configure relayers
274274
- [ ] Update SDK integration code (if applicable)
275275
- [ ] Test transaction processing
276276
- [ ] Run in parallel with Defender Relayers
277277
- [ ] Transfer funds from Defender Relayers
278-
- [ ] Gradually move traffic to open source Relayers
278+
- [ ] Gradually move traffic to OpenZeppelin Relayers
279279
- [ ] Decommission Defender Relayers
280280

content/defender/module/monitor.mdx

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22
title: Monitor
33
---
44

5+
<Callout type='warn' title='Defender is in Maintenance Mode'>
6+
7+
Defender is now in maintenance mode. To continue monitoring your smart contracts with the latest features and updates, we recommend migrating to [OpenZeppelin Monitor](/monitor).
8+
9+
See the complete [Migration Guide](/defender/migration#monitor-migration) for detailed instructions on exporting your configurations.
10+
11+
</Callout>
12+
513
Monitors allow you to gain full visibility into your smart contracts' risks and behaviors. You can detect threats, get alerts on threats and anomalies, and automatically respond and resolve issues.
614

715
## Use cases
@@ -443,10 +451,3 @@ Saving a monitor as a template stores its configuration and parameters, which ca
443451
We provide a quickstart tutorial to monitor a smart contract using Defender. Check it out [here](/defender/tutorial/monitor)!
444452
</Callout>
445453

446-
## Migration to Open Source
447-
448-
<Callout type='warn'>
449-
Defender is now in maintenance mode. To continue monitoring your smart contracts with the latest features and updates, we recommend migrating to the [OpenZeppelin open source Monitor](/monitor/1.1.x).
450-
451-
See the complete [Migration Guide](/defender/migration#monitor-migration) for detailed instructions on exporting your configurations, setting up the open source Monitor, and testing your migration.
452-
</Callout>

content/defender/module/relayers.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,15 @@
22
title: Relayers
33
---
44

5-
Relayers allow you to send on-chain transactions via regular API requests or through other Defender modules, like Actions, Workflows, and Deploy. Relayers also automate the payment of gas fees and take care of private key secure storage, transaction signing, nonce management, gas pricing estimation, and resubmissions. With Relayers, you don’t have to worry about storing private keys on your back-end servers or monitoring gas prices and transactions to ensure they get confirmed.
5+
<Callout type='warn' title='Defender is in Maintenance Mode'>
6+
7+
Defender is now in maintenance mode. To continue relaying transactions with the latest features and updates, we recommend migrating to [OpenZeppelin Relayer](/relayer).
8+
9+
See the complete [Migration Guide](/defender/migration#relayer-migration) for detailed instructions on exporting your configurations.
10+
11+
</Callout>
12+
13+
Relayers allow you to send on-chain transactions via regular API requests or through other Defender modules, like Actions, Workflows, and Deploy. Relayers also automate the payment of gas fees and take care of private key secure storage, transaction signing, nonce management, gas pricing estimation, and resubmissions. With Relayers, you don't have to worry about storing private keys on your back-end servers or monitoring gas prices and transactions to ensure they get confirmed.
614

715
## Use cases
816

@@ -725,11 +733,3 @@ When sending transactions to a rollup chain, such as Arbitrum or Optimism, Relay
725733
## Inactivity
726734
727735
Testnet relayers are considered inactive if they haven’t sent any transactions in more than 60 days. When a testnet relayer is inactive, we provide a 14-day grace period to mark the relayer as active. If users don’t take any action, the relayer will be automatically deleted once the period is over.
728-
729-
## Migration to Open Source
730-
731-
<Callout type='warn'>
732-
Defender is now in maintenance mode. To continue relaying transactions with the latest features and updates, we recommend migrating to the [OpenZeppelin open source Relayer](/relayer/1.2.x).
733-
734-
See the complete [Migration Guide](/defender/migration#relayer-migration) for detailed instructions on exporting your configurations, setting up the open source Relayer, SDK migration, and testing your migration.
735-
</Callout>
-68.8 KB
Binary file not shown.
-25.1 KB
Loading
65.6 KB
Loading

0 commit comments

Comments
 (0)