diff --git a/components/RemovedContentCallout/index.tsx b/components/RemovedContentCallout/index.tsx index d0fbfd95..ad26ee9c 100644 --- a/components/RemovedContentCallout/index.tsx +++ b/components/RemovedContentCallout/index.tsx @@ -2,8 +2,8 @@ import { Callout } from 'nextra/components' import { useEffect, useState } from 'react' const RemovedContentCallout: React.FC<{ - description: string -}> = ({ description }) => { + children: React.ReactNode +}> = ({ children }) => { const [isContentRemoved, setIsContentRemoved] = useState(false) useEffect(() => { @@ -14,7 +14,7 @@ const RemovedContentCallout: React.FC<{ if (!isContentRemoved) return - return {description} + return {children} } export default RemovedContentCallout diff --git a/pages/reference-sdk-protocol-kit/overview.md b/pages/reference-sdk-protocol-kit/overview.md deleted file mode 100644 index 7d9626cb..00000000 --- a/pages/reference-sdk-protocol-kit/overview.md +++ /dev/null @@ -1,11 +0,0 @@ -# Protocol Kit Reference - -The [Protocol Kit](https://github.com/safe-global/safe-core-sdk/tree/main/packages/protocol-kit) facilitates the interaction with the Safe smart account contracts. - -## Install dependencies - -To add the Protocol Kit to your project, run: - -```bash -yarn add @safe-global/protocol-kit -``` diff --git a/pages/reference-sdk-protocol-kit/overview.mdx b/pages/reference-sdk-protocol-kit/overview.mdx new file mode 100644 index 00000000..0d3529cb --- /dev/null +++ b/pages/reference-sdk-protocol-kit/overview.mdx @@ -0,0 +1,17 @@ +import RemovedContentCallout from '../../components/RemovedContentCallout' + +# Protocol Kit Reference + + + The `SafeFactory` class has been removed from the Protocol Kit and its functionality has been moved to the `Safe` class. Check the [Protocol Kit v5 migration guide](http://localhost:3000/sdk/protocol-kit/guides/migrate-to-v5) to get more details. + + +The [Protocol Kit](https://github.com/safe-global/safe-core-sdk/tree/main/packages/protocol-kit) facilitates the interaction with the Safe smart account contracts. + +## Install dependencies + +To add the Protocol Kit to your project, run: + +```bash +yarn add @safe-global/protocol-kit +``` diff --git a/pages/sdk/onramp.mdx b/pages/sdk/onramp.mdx index 340321bf..56704435 100644 --- a/pages/sdk/onramp.mdx +++ b/pages/sdk/onramp.mdx @@ -1,6 +1,8 @@ import RemovedContentCallout from '../../components/RemovedContentCallout' - + + The Onramp Kit in the Safe\{Core\} SDK is no longer supported. We recommend integrating onramp providers directly into your application by following these guides. + # Onramp guides diff --git a/pages/sdk/onramp/monerium.mdx b/pages/sdk/onramp/monerium.mdx index b1d5dfd1..10eefef4 100644 --- a/pages/sdk/onramp/monerium.mdx +++ b/pages/sdk/onramp/monerium.mdx @@ -3,7 +3,9 @@ import Image from 'next/image' import MoneriumAddMoney from '../../../assets/monerium-sandbox-add-money.png' import RemovedContentCallout from '../../../components/RemovedContentCallout' - + + The Onramp Kit in the Safe\{Core\} SDK is no longer supported; with that, neither is the `MoneriumPack`. We recommend integrating Monerium directly into your application by following this guide. + # Onramp with Monerium diff --git a/pages/sdk/onramp/stripe.mdx b/pages/sdk/onramp/stripe.mdx index 63043c29..9723ed42 100644 --- a/pages/sdk/onramp/stripe.mdx +++ b/pages/sdk/onramp/stripe.mdx @@ -5,7 +5,9 @@ import KycAddress from '../../../assets/stripe-kyc-address.png' import PaymentMethod from '../../../assets/stripe-kyc-payment-method.png' import RemovedContentCallout from '../../../components/RemovedContentCallout' - + + The Onramp Kit in the Safe\{Core\} SDK is no longer supported; with that, neither is the `StripePack`. We recommend integrating Stripe directly into your application by following this guide. + # Onramp with Stripe diff --git a/pages/sdk/protocol-kit/guides/execute-transactions.mdx b/pages/sdk/protocol-kit/guides/execute-transactions.mdx index e797af95..d118cb43 100644 --- a/pages/sdk/protocol-kit/guides/execute-transactions.mdx +++ b/pages/sdk/protocol-kit/guides/execute-transactions.mdx @@ -2,7 +2,7 @@ In this quickstart guide, you will create a 2 of 3 multi-sig Safe and propose and execute a transaction to send some ETH out of this Safe. -To find more details and configuration options for available methods, see the [Protocol Kit reference](../../../reference-sdk-protocol-kit/overview.md). +To find more details and configuration options for available methods, see the [Protocol Kit reference](../../../reference-sdk-protocol-kit/overview.mdx). ### Prerequisites diff --git a/pages/sdk/protocol-kit/guides/multichain-safe-deployment.mdx b/pages/sdk/protocol-kit/guides/multichain-safe-deployment.mdx index 04c564b2..364fbba2 100644 --- a/pages/sdk/protocol-kit/guides/multichain-safe-deployment.mdx +++ b/pages/sdk/protocol-kit/guides/multichain-safe-deployment.mdx @@ -4,6 +4,8 @@ import { Steps } from 'nextra/components' This guide will teach you how to replicate a Safe address across different chains using the Protocol Kit. This process includes initializing the Protocol Kit, configuring the Safes to deploy, predicting its address on different chains, and executing the deployment transactions. +For more detailed information, see the [Protocol Kit Reference](../../../reference-sdk-protocol-kit/overview.mdx). + ## Prerequisites - [Node.js and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) @@ -44,7 +46,7 @@ pnpm add @safe-global/protocol-kit viem ### Create a signer - You need a signer to instantiate the Protocol Kit. This example uses a private key to obtain a signer, but other [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) compatible signers are also supported. For detailed information about signers, please refer to the [Protocol Kit reference](../../../reference-sdk-protocol-kit/overview.md). + You need a signer to instantiate the Protocol Kit. This example uses a private key to obtain a signer, but other [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) compatible signers are also supported. For detailed information about signers, please refer to the [Protocol Kit reference](../../../reference-sdk-protocol-kit/overview.mdx). {/* */} diff --git a/pages/sdk/protocol-kit/guides/safe-deployment.mdx b/pages/sdk/protocol-kit/guides/safe-deployment.mdx index f8c226b3..a771dc51 100644 --- a/pages/sdk/protocol-kit/guides/safe-deployment.mdx +++ b/pages/sdk/protocol-kit/guides/safe-deployment.mdx @@ -45,7 +45,7 @@ pnpm add @safe-global/protocol-kit viem ### Create a signer - You need a signer to instantiate the Protocol Kit. This example uses a private key to obtain a signer, but [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) compatible signers are also supported. For detailed information about signers, please refer to the [Protocol Kit reference](../../../reference-sdk-protocol-kit/overview.md). + You need a signer to instantiate the Protocol Kit. This example uses a private key to obtain a signer, but [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) compatible signers are also supported. For detailed information about signers, please refer to the [Protocol Kit reference](../../../reference-sdk-protocol-kit/overview.mdx). {/* */} diff --git a/pages/sdk/signers.mdx b/pages/sdk/signers.mdx index 4a73a0d5..c99db382 100644 --- a/pages/sdk/signers.mdx +++ b/pages/sdk/signers.mdx @@ -1,6 +1,8 @@ import RemovedContentCallout from '../../components/RemovedContentCallout' - + + The Auth Kit in the Safe\{Core\} SDK is no longer supported. We recommend integrating Web3 authentication providers directly into your application by following these guides. + # Signers diff --git a/redirects.json b/redirects.json index 05348848..e10500a2 100644 --- a/redirects.json +++ b/redirects.json @@ -321,21 +321,21 @@ }, { "source": "/sdk-protocol-kit/reference", - "destination": "/sdk/protocol-kit/reference", + "destination": "/reference-sdk-protocol-kit/overview", "permanent": true }, { - "source": "/safe-core-aa-sdk/protocol-kit/reference/v1", - "destination": "/sdk/protocol-kit/guides/migrate-to-v1", + "source": "/sdk-protocol-kit/reference/safe", + "destination": "/reference-sdk-protocol-kit/overview", "permanent": true }, { - "source": "/sdk/protocol-kit/reference/migrate-to-v1", - "destination": "/sdk/protocol-kit/guides/migrate-to-v1", + "source": "/sdk-protocol-kit/reference/safe-factory", + "destination": "/reference-sdk-protocol-kit?removed=true", "permanent": true }, { - "source": "/sdk-protocol-kit/reference/migrating-to-v1", + "source": "/safe-core-aa-sdk/protocol-kit/reference/v1", "destination": "/sdk/protocol-kit/guides/migrate-to-v1", "permanent": true }, @@ -345,12 +345,12 @@ "permanent": true }, { - "source": "/sdk/protocol-kit/reference/migrating-to-v1", + "source": "/sdk-protocol-kit/reference/migrating-to-v1", "destination": "/sdk/protocol-kit/guides/migrate-to-v1", "permanent": true }, { - "source": "/sdk/protocol-kit/reference/migrate-to-v1", + "source": "/sdk/protocol-kit/reference/migrating-to-v1", "destination": "/sdk/protocol-kit/guides/migrate-to-v1", "permanent": true }, @@ -369,21 +369,11 @@ "destination": "/sdk/protocol-kit/guides/migrate-to-v2", "permanent": true }, - { - "source": "/sdk/protocol-kit/reference/migrate-to-v2", - "destination": "/sdk/protocol-kit/guides/migrate-to-v2", - "permanent": true - }, { "source": "/sdk/protocol-kit/reference/migrating-to-v2", "destination": "/sdk/protocol-kit/guides/migrate-to-v2", "permanent": true }, - { - "source": "/sdk/protocol-kit/reference/migrate-to-v2", - "destination": "/sdk/protocol-kit/guides/migrate-to-v2", - "permanent": true - }, { "source": "/safe-core-aa-sdk/onramp-kit", "destination": "/sdk/onramp?removed=true",