diff --git a/content/defender/index.mdx b/content/defender/index.mdx index db9ba551..2078733c 100644 --- a/content/defender/index.mdx +++ b/content/defender/index.mdx @@ -11,6 +11,15 @@ New sign-ups were disabled on June 30, 2025. Until the final shutdown on July 1, + + +- **[Migrate from Defender Monitor to OpenZeppelin Monitor](/defender/migration#monitor-migration)** - Export configurations, set up infrastructure, and test your monitors +- **[Migrate from Defender Relayer to OpenZeppelin Relayer](/defender/migration#relayer-migration)** - Transfer relayers, update SDK integration, and migrate transaction handling + +View the complete [Migration Guide](/defender/migration) for detailed instructions. + + + OpenZeppelin Defender is a mission-critical developer security platform to **code**, **audit**, **deploy**, **monitor**, and **operate** blockchain applications with confidence. 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. diff --git a/content/defender/migration.mdx b/content/defender/migration.mdx new file mode 100644 index 00000000..2d25871f --- /dev/null +++ b/content/defender/migration.mdx @@ -0,0 +1,336 @@ +--- +title: Migrating from Defender to Open Source +--- + +## Overview + +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. + +This guide covers: +- Migrating from **Defender Monitor** to [OpenZeppelin Monitor](/monitor) +- Migrating from **Defender Relayer** to [OpenZeppelin Relayer](/relayer) + +Both tools are designed to be self-hosted, giving you full control over your infrastructure while maintaining the functionality you rely on. + +## Migration Strategy + +### Planning Your Migration + +1. **Review your current usage**: Identify which Defender modules you're actively using +2. **Export configurations**: Use Defender UI to export Monitors and Relayers configuration +3. **Set up infrastructure**: Configure the open source tools on your own infrastructure +4. **Test thoroughly**: Run both systems in parallel during the transition period +5. **Migrate traffic gradually**: Switch over when you're confident everything works correctly + +### Timeline Considerations + +- Plan for adequate testing time before fully switching over +- Consider running both systems in parallel during migration +- Schedule migration during low-traffic periods if possible + +--- + +## Monitor Migration + +### From Defender Monitor to OpenZeppelin Monitor + +OpenZeppelin Monitor offers similar functionality to Defender Monitor: + +- **Event and function monitoring**: Monitor smart contract events and function calls +- **Custom filtering**: Write custom JavaScript, Python or Bash filters to match specific conditions +- **Multiple notification channels**: Integrate with Slack, Telegram, Discord, webhooks and emails + +### Getting Started + +To begin your Monitor migration: + +1. **Review your existing monitors**: Export your Defender Monitor configurations using the "Download OpenZeppelin Monitor Configurations" button +2. **Import your configurations**: Use the exported configurations to recreate your monitors in OpenZeppelin Monitor +3. **Set up OpenZeppelin Monitor**: Follow the [installation guide](/monitor) to set up the Monitor. + +![Defender Monitor Migration Button](/defender/monitor-migration-information.png) + +The "OpenZeppelin Monitor Configurations" button will download a .zip file containing configuration files for every monitor in your Defender account (If for any reason you don't want a specific monitor to be migrated, we recommend you delete the monitor before clicking on the OpenZeppelin Monitor Configurations button ). 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: + +- API keys and secrets +- RPC URLs and endpoint addresses +- Webhook URLs for notifications +- Service integration credentials (Slack, Telegram, Discord, etc.) + + +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. + + +Alternatively, if you don't want to download all the monitors 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. + +![Download Individual Monitor Config](/defender/monitor-migration-button.png) + +Here's a video with the process step by step: https://www.loom.com/share/6de3d269f92c4df6abe951af69c64feb + +4. **Test your monitors**: Verify that alerts trigger correctly before decommissioning Defender monitors + +For detailed migration instructions and support, visit the [OpenZeppelin Monitor documentation](/monitor). + +--- + +## Relayer Migration + +### From Defender Relayer to OpenZeppelin Relayer + +OpenZeppelin Relayer offers similar functionality to Defender Relayer: + +- **Transaction relaying**: Submit transactions to supported blockchain networks efficiently +- **Transaction signing**: Securely sign transactions using configurable key management +- **Nonce management**: Handle nonce management to ensure transaction order +- **Gas pricing**: Automatic gas price estimation and configuration +- **Multi-chain support**: Interact with EVM, Solana, and Stellar networks +- **SDK integration**: Easily interact with the relayer through a companion JavaScript/TypeScript SDK +- **Configurable policies**: Define and enforce network-specific policies for transaction processing + +### Getting Started + +To begin your Relayer migration: + +1. **Review your existing relayers**: Export your Defender Relayer configurations using the "OpenZeppelin Relayer Configurations" button + +![Defender Relayer Migration Button](/defender/relayer-migration-button.png) + +The "OpenZeppelin Relayer Configurations" button will download a .zip file containing configuration files for every relayer in your Defender account (If for any reason you don't want a specific relayer to be migrated, we recommend you delete the relayer before clicking on the OpenZeppelin Relayer Configurations button ). 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: + +- RPC URLs and endpoint addresses +- Signer configurations and private keys +- Network-specific policies +- Webhook URLs for notifications + +### Configuration File Structure + +After downloading your relayer configurations, you'll need to organize them in your OpenZeppelin Relayer project: + +- **`config.json`**: Place this file in the `config/` directory +- **Network files**: Place these files in the `config/networks/` directory + +This structure ensures OpenZeppelin Relayer can properly locate and load your relayer configurations. + +2. **Set up OpenZeppelin Relayer**: Follow the [installation guide](/relayer) to deploy the Relayer on your infrastructure +3. **Import your configurations**: Use the exported configurations to recreate your relayers in OpenZeppelin Relayer + +4. **Test your relayers**: Verify that transactions are processed correctly before decommissioning Defender relayers +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 +6. **Gradually move volume**: Shift traffic from Defender relayer to OpenZeppelin Relayer incrementally + +Here's a video with the process step by step: https://www.loom.com/share/cb5e0f5d8c064a71abc8c18fac273cf0 + +### Understanding Signer Migration + + +**Relayer recreation is required due to AWS KMS security constraints** + +Defender Relayers use AWS Key Management Service (AWS KMS) to secure private keys. Due to AWS KMS's security model, **private keys cannot be exported** outside AWS. This means: + +- You cannot export existing Defender Relayer private keys +- You cannot import Defender Relayer keys into OpenZeppelin Relayer +- You **must create new relayers with new addresses** when migrating to OpenZeppelin Relayer + +This is a fundamental security feature of AWS KMS that protects your keys from unauthorized access. + + +### Choosing a Signer Type + +OpenZeppelin Relayer supports multiple signer types to accommodate different security requirements and infrastructure setups. Each relayer must be configured with a signer that manages the private key for transaction signing. + +#### Available Signer Options + +| Signer Type | Description | +|------------|-------------| +| **Local** | Encrypted keystore file stored on the filesystem | +| **AWS KMS** | Amazon Web Services Key Management Service | +| **Google Cloud KMS** | Google Cloud Key Management Service | +| **HashiCorp Vault** | Vault secret engine for private key storage | +| **HashiCorp Vault Transit** | Vault Transit encryption engine | +| **Turnkey** | Third-party key management service | +| **Coinbase Developer Platform (CDP)** | Coinbase's managed key solution | + +#### Migration Steps for Signers + +1. **Select a signer type** that matches your security and infrastructure requirements +2. **Generate new keys** using your chosen signer service (refer to the [Signer Configuration documentation](/relayer/configuration/signers) for detailed setup instructions) +3. **Configure your relayers** to use the new signers in your OpenZeppelin Relayer configuration +4. **Update smart contract permissions**: Since you'll have new addresses, update any: + - Access control lists + - Whitelist entries + - Role assignments + - Trusted forwarder configurations +5. **Transfer funds** from old Defender Relayer addresses to new OpenZeppelin Relayer addresses +6. **Test thoroughly** before switching production traffic + + +For detailed configuration instructions for each signer type, see the [OpenZeppelin Relayer Signer Configuration documentation](/relayer/configuration/signers). + + +### SDK Migration + +If you are using the [Defender SDK](https://github.com/OpenZeppelin/defender-sdk) (`@openzeppelin/defender-sdk`) to interact with Defender Relayers programmatically, you will need to migrate to the [OpenZeppelin Relayer SDK](https://github.com/OpenZeppelin/openzeppelin-relayer-sdk) (`@openzeppelin/relayer-sdk`). + +#### Installation + +Replace the Defender SDK with the OpenZeppelin Relayer SDK: + +```bash +# Remove Defender SDK +npm uninstall @openzeppelin/defender-sdk @openzeppelin/defender-sdk-relay-client @openzeppelin/defender-sdk-relay-signer-client + +# Install OpenZeppelin Relayer SDK +npm install @openzeppelin/relayer-sdk +``` + +#### Code Migration Examples + +**Sending a Transaction** + +Before (Defender SDK): + +```jsx +const { Defender } = require('@openzeppelin/defender-sdk'); +const client = new Defender({ + relayerApiKey: 'YOUR_API_KEY', + relayerApiSecret: 'YOUR_API_SECRET' +}); + +const tx = await client.relaySigner.sendTransaction({ + to: '0x...', + value: '1000000000000000000', + data: '0x', + gasLimit: 21000, + speed: 'fast' +}); +``` + +After (OpenZeppelin Relayer SDK): + +```typescript +import { RelayerApi, Configuration } from '@openzeppelin/relayer-sdk'; + +const config = new Configuration({ + basePath: 'http://localhost:8080/api/v1', + accessToken: 'YOUR_API_KEY' +}); + +const relayerApi = new RelayerApi(config); + +const tx = await relayerApi.sendTransaction('your-relayer-id', { + to: '0x...', + value: '1000000000000000000', + data: '0x', + gas_limit: 21000, + speed: 'fast' +}); +``` + +**Getting Transaction Status** + +Before (Defender SDK): + +```jsx +import { Relayer } from '@openzeppelin/defender-sdk-relay-signer-client'; +const relayer = new Relayer({ apiKey: API_KEY, apiSecret: API_SECRET }); +const tx = await relayer.getTransaction(transactionId); +``` + +After (OpenZeppelin Relayer SDK): + +```typescript +import { RelayerApi, Configuration } from '@openzeppelin/relayer-sdk'; + +const config = new Configuration({ + basePath: 'http://localhost:8080/api/v1', + accessToken: 'YOUR_API_KEY' +}); + +const relayerApi = new RelayerApi(config); +const tx = await relayerApi.getTransactionById('your-relayer-id', transactionId); +``` + +**Listing Relayers** + +Before (Defender SDK): + +```jsx +const { Defender } = require('@openzeppelin/defender-sdk'); +const client = new Defender({ + apiKey: 'YOUR_API_KEY', + apiSecret: 'YOUR_API_SECRET' +}); + +const relayers = await client.relay.list(); +``` + +After (OpenZeppelin Relayer SDK): + +```typescript +import { RelayerApi, Configuration } from '@openzeppelin/relayer-sdk'; + +const config = new Configuration({ + basePath: 'http://localhost:8080/api/v1', + accessToken: 'YOUR_API_KEY' +}); + +const relayerApi = new RelayerApi(config); +const relayers = await relayerApi.listRelayers(); +``` + +#### API Method Mapping + +| Defender SDK Method | OpenZeppelin Relayer SDK Method | +|--------------------|--------------------------------| +| `client.relaySigner.sendTransaction()` | `relayerApi.sendTransaction()` | +| `relayer.getTransaction()` | `relayerApi.getTransactionById()` | +| `relayer.list()` | `relayerApi.listTransactions()` | +| `relayer.replaceTransactionById()` | `relayerApi.replaceTransaction()` | +| `relayer.cancelTransactionById()` | `relayerApi.cancelTransaction()` | +| `relayer.sign()` | `relayerApi.sign()` | +| `relayer.signTypedData()` | `relayerApi.signTypedData()` | +| `relayer.getRelayer()` | `relayerApi.getRelayer()` | +| `relayer.getRelayerStatus()` | `relayerApi.getRelayerStatus()` | + +For detailed migration instructions and support, visit the [OpenZeppelin Relayer documentation](/relayer). + +--- + +## Support and Resources + +### Documentation +- [OpenZeppelin Monitor Documentation](/monitor) +- [OpenZeppelin Relayer Documentation](/relayer) + +### Getting Help +If you encounter issues during migration or have questions: +- Review the respective documentation for each tool +- Check GitHub repositories for issues and discussions +- Reach out to the OpenZeppelin community + +### Migration Checklist + +Use this checklist to track your migration progress: + +#### Monitor Migration +- [ ] Export Monitor configurations from Defender +- [ ] Review and update placeholder values (API keys, RPC URLs, etc.) +- [ ] Set up OpenZeppelin Monitor infrastructure +- [ ] Import and configure monitors +- [ ] Recreate custom action logic +- [ ] Test alert triggers +- [ ] Run in parallel with Defender Monitor +- [ ] Switch over and decommission Defender monitors + +#### Relayer Migration +- [ ] Export Relayer configurations from Defender +- [ ] Review and update placeholder values (signers, RPC URLs, policies) +- [ ] Set up OpenZeppelin Relayer infrastructure +- [ ] Import and configure relayers +- [ ] Update SDK integration code (if applicable) +- [ ] Test transaction processing +- [ ] Run in parallel with Defender Relayers +- [ ] Transfer funds from Defender Relayers +- [ ] Gradually move traffic to OpenZeppelin Relayers +- [ ] Decommission Defender Relayers + diff --git a/content/defender/module/monitor.mdx b/content/defender/module/monitor.mdx index c714ab72..b1eba1b0 100644 --- a/content/defender/module/monitor.mdx +++ b/content/defender/module/monitor.mdx @@ -2,6 +2,14 @@ title: Monitor --- + + +Defender is now in maintenance mode. To continue monitoring your smart contracts/any other on-chain events with the latest features and updates, we recommend migrating to [OpenZeppelin Monitor](/monitor). + +See the complete [Migration Guide](/defender/migration#monitor-migration) for detailed instructions on exporting your configurations. + + + 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. ## Use cases @@ -442,3 +450,4 @@ Saving a monitor as a template stores its configuration and parameters, which ca We provide a quickstart tutorial to monitor a smart contract using Defender. Check it out [here](/defender/tutorial/monitor)! + diff --git a/content/defender/module/relayers.mdx b/content/defender/module/relayers.mdx index 6e0af163..6f12d83e 100644 --- a/content/defender/module/relayers.mdx +++ b/content/defender/module/relayers.mdx @@ -2,7 +2,15 @@ title: Relayers --- -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. + + +Defender is now in maintenance mode. To continue relaying transactions with the latest features and updates, we recommend migrating to [OpenZeppelin Relayer](/relayer). + +See the complete [Migration Guide](/defender/migration#relayer-migration) for detailed instructions on exporting your configurations. + + + +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. ## Use cases diff --git a/public/defender/monitor-migration-button.png b/public/defender/monitor-migration-button.png new file mode 100644 index 00000000..d627fd70 Binary files /dev/null and b/public/defender/monitor-migration-button.png differ diff --git a/public/defender/monitor-migration-information.png b/public/defender/monitor-migration-information.png new file mode 100644 index 00000000..764f4ebd Binary files /dev/null and b/public/defender/monitor-migration-information.png differ diff --git a/public/defender/relayer-migration-button.png b/public/defender/relayer-migration-button.png new file mode 100644 index 00000000..14181659 Binary files /dev/null and b/public/defender/relayer-migration-button.png differ diff --git a/src/components/page-actions.tsx b/src/components/page-actions.tsx index d19beaaf..cf9e5e0a 100644 --- a/src/components/page-actions.tsx +++ b/src/components/page-actions.tsx @@ -13,7 +13,7 @@ import { ExternalLinkIcon, FileText, } from "lucide-react"; -import { useMemo, useState } from "react"; +import { useEffect, useMemo, useState } from "react"; import { cn } from "../lib/cn"; import { buttonVariants } from "./ui/button"; @@ -81,19 +81,22 @@ export function ViewOptions({ */ markdownUrl: string; }) { + const [origin, setOrigin] = useState(null); + + useEffect(() => { + setOrigin(window.location.origin); + }, []); + const items = useMemo(() => { - const fullMarkdownUrl = - typeof window !== "undefined" - ? new URL(markdownUrl, window.location.origin) - : "loading"; + const fullMarkdownUrl = origin + ? new URL(markdownUrl, origin).toString() + : markdownUrl; const q = `Read ${fullMarkdownUrl}, I want to ask questions about it.`; return [ { title: "Open in Claude", - href: `https://claude.ai/new?${new URLSearchParams({ - q, - })}`, + href: `https://claude.ai/new?${new URLSearchParams({ q })}`, icon: ( , }, ]; - }, [markdownUrl]); + }, [markdownUrl, origin]); - const claudeUrl = `https://claude.ai/new?${new URLSearchParams({ - q: `Read ${typeof window !== "undefined" ? new URL(markdownUrl, window.location.origin) : "loading"}, I want to ask questions about it.`, - })}`; + const claudeUrl = useMemo(() => { + const fullMarkdownUrl = origin + ? new URL(markdownUrl, origin).toString() + : markdownUrl; + return `https://claude.ai/new?${new URLSearchParams({ + q: `Read ${fullMarkdownUrl}, I want to ask questions about it.`, + })}`; + }, [markdownUrl, origin]); return (
diff --git a/src/navigation/ethereum-evm.json b/src/navigation/ethereum-evm.json index aa010f15..23738190 100644 --- a/src/navigation/ethereum-evm.json +++ b/src/navigation/ethereum-evm.json @@ -1383,6 +1383,11 @@ "name": "SDK and API", "url": "/defender/sdk" }, + { + "type": "page", + "name": "Migration to Open Source", + "url": "/defender/migration" + }, { "type": "page", "name": "Integrations",