diff --git a/advanced/api/notify/usage.mdx b/advanced/api/notify/usage.mdx index 7f8b0c6af..e0f5772f1 100644 --- a/advanced/api/notify/usage.mdx +++ b/advanced/api/notify/usage.mdx @@ -199,17 +199,17 @@ await notifyClient.unregister({ #### Creating a new subscription -To identify dapps that can be subscribed to via Notify, we can query the following Explorer API endpoint: +To identify dapps that can be subscribed to via Notify, we can query the following WalletGuide API endpoint: https://explorer-api.walletconnect.com/v3/dapps?projectId=YOUR_PROJECT_ID&is_notify_enabled=true ```javascript -// Get the domain of the target dapp from the Explorer API response +// Get the domain of the target dapp from the WalletGuide API response const appDomain = new URL(fetchedExplorerDapp.platform_browser).hostname; -// Subscribe to `fetchedExplorerDapp` by passing the account to be subscribed and the domain of the target dapp. +// Subscribe to `fetchedWalletGuideDapp` by passing the account to be subscribed and the domain of the target dapp. await notifyClient.subscribe({ account, appDomain, @@ -952,17 +952,17 @@ await notifyClient.register({ #### Creating a new subscription -To identify dapps that can be subscribed to via Notify, we can query the following Explorer API endpoint: +To identify dapps that can be subscribed to via Notify, we can query the following WalletGuide API endpoint: https://explorer-api.walletconnect.com/v3/dapps?projectId=YOUR_PROJECT_ID&is_notify_enabled=true ```javascript -// Get the domain of the target dapp from the Explorer API response +// Get the domain of the target dapp from the WalletGuide API response const appDomain = new URL(fetchedExplorerDapp.platform_browser).hostname; -// Subscribe to `fetchedExplorerDapp` by passing the account to be subscribed and the domain of the target dapp. +// Subscribe to `fetchedWalletGuideDapp` by passing the account to be subscribed and the domain of the target dapp. await notifyClient.subscribe({ account, appDomain, diff --git a/advanced/walletconnectmodal/options.mdx b/advanced/walletconnectmodal/options.mdx index 4ab9ed018..c07cc1c11 100644 --- a/advanced/walletconnectmodal/options.mdx +++ b/advanced/walletconnectmodal/options.mdx @@ -147,7 +147,7 @@ const onCopyClipboard = (value: string) => { #### explorerRecommendedWalletIds (optional) -Allows to override default recommended wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define an array of wallet ids you'd like to prioritize (order is respected). You can get these ids from the explorer link mentioned before by clicking on a copy icon of desired wallet card. If you want to completely disable recommended wallets, you can set this option to `NONE`. Defaults to `undefined`. +Allows to override default recommended wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define an array of wallet ids you'd like to prioritize (order is respected). You can get these ids from the WalletGuide link mentioned before by clicking on a copy icon of desired wallet card. If you want to completely disable recommended wallets, you can set this option to `NONE`. Defaults to `undefined`. ```ts explorerRecommendedWalletIds: string[] | 'NONE' @@ -161,7 +161,7 @@ explorerRecommendedWalletIds={[ #### explorerExcludedWalletIds (optional) -Allows to exclude wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define an array of wallet ids you'd like to exclude. You can get these ids from the explorer link mentioned before by clicking on a copy icon of desired wallet card. If you want to exclude all wallets, you can set this option to `ALL`, however if `explorerRecommendedWalletIds` were defined, they will still be fetched. Defaults to `undefined`. +Allows to exclude wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define an array of wallet ids you'd like to exclude. You can get these ids from the WalletGuide link mentioned before by clicking on a copy icon of desired wallet card. If you want to exclude all wallets, you can set this option to `ALL`, however if `explorerRecommendedWalletIds` were defined, they will still be fetched. Defaults to `undefined`. ```ts explorerExcludedWalletIds: string[] | 'ALL' @@ -188,9 +188,9 @@ accentColor = "#9090FF"; -#### Explorer recommended wallets +#### WalletGuide recommended wallets -Allows to set default recommended wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define a list of wallets ids you'd like to prioritise (order is respected). You can get these ids from the explorer link mentioned before by clicking on a copy icon of your desired wallet card. +Allows to set default recommended wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define a list of wallets ids you'd like to prioritise (order is respected). You can get these ids from the WalletGuide link mentioned before by clicking on a copy icon of your desired wallet card. ```kotlin val recommendedWalletsIds = listOf( @@ -211,9 +211,9 @@ WalletConnectModal.initialize( ) ``` -#### Explorer excluded wallets +#### WalletGuide excluded wallets -Allows to exclude wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define an array of wallet ids you'd like to exclude. You can get these ids from the explorer link mentioned before by clicking on a copy icon of your desired wallet card. +Allows to exclude wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define an array of wallet ids you'd like to exclude. You can get these ids from the WalletGuide link mentioned before by clicking on a copy icon of your desired wallet card. ```kotlin val excludedWalletIds = listOf( @@ -320,7 +320,7 @@ You can change it at any time with the `setOptionalNamespaces` method. #### recommendedWalletIds (optional) -Allows to override default recommended wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define an array of wallet ids you'd like to prioritize (order is respected). You can get these ids from the explorer link mentioned before by clicking on a copy icon of desired wallet card. Defaults to `null`. +Allows to override default recommended wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define an array of wallet ids you'd like to prioritize (order is respected). You can get these ids from the WalletGuide link mentioned before by clicking on a copy icon of desired wallet card. Defaults to `null`. ```javascript final Set recommendedWalletIds = { @@ -374,7 +374,7 @@ ConnectOptions = new ConnectOptions #### IncludedWalletIds -Allows to override default recommended wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define an array of wallet ids you'd like to prioritize (order is respected). You can get these ids from the explorer link mentioned before by clicking on a copy icon of desired wallet card. Defaults to `null`. +Allows to override default recommended wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define an array of wallet ids you'd like to prioritize (order is respected). You can get these ids from the WalletGuide link mentioned before by clicking on a copy icon of desired wallet card. Defaults to `null`. ```csharp IncludedWalletIds = new[] @@ -386,7 +386,7 @@ IncludedWalletIds = new[] #### ExcludedWalletIds -Allows to exclude wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define an array of wallet ids you'd like to exclude. You can get these ids from the explorer link mentioned before by clicking on a copy icon of desired wallet card. Defaults to `null`. +Allows to exclude wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define an array of wallet ids you'd like to exclude. You can get these ids from the WalletGuide link mentioned before by clicking on a copy icon of desired wallet card. Defaults to `null`. ```csharp ExcludedWalletIds = new[] diff --git a/appkit/android/core/options.mdx b/appkit/android/core/options.mdx index 5bbc0ac6a..62e3071c2 100644 --- a/appkit/android/core/options.mdx +++ b/appkit/android/core/options.mdx @@ -2,9 +2,9 @@ title: Options --- -### Explorer recommended wallets +### WalletGuide recommended wallets -Allows to set default recommended wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define a list of wallets ids you'd like to prioritize (order is respected). You can get these ids from the explorer link mentioned before by clicking on a copy icon of your desired wallet card. +Allows to set default recommended wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define a list of wallets ids you'd like to prioritize (order is respected). You can get these ids from the WalletGuide link mentioned before by clicking on a copy icon of your desired wallet card. ```kotlin val recommendedWalletsIds = listOf( @@ -25,9 +25,9 @@ AppKit.initialize( ) ``` -### Explorer excluded wallets +### WalletGuide excluded wallets -Allows to exclude wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define an array of wallet ids you'd like to exclude. You can get these ids from the explorer link mentioned before by clicking on a copy icon of your desired wallet card. +Allows to exclude wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define an array of wallet ids you'd like to exclude. You can get these ids from the WalletGuide link mentioned before by clicking on a copy icon of your desired wallet card. ```kotlin val excludedWalletIds = listOf( diff --git a/appkit/ios/core/options.mdx b/appkit/ios/core/options.mdx index d2a403a38..938769f73 100644 --- a/appkit/ios/core/options.mdx +++ b/appkit/ios/core/options.mdx @@ -2,9 +2,9 @@ title: Options --- -### Explorer recommended wallets +### WalletGuide recommended wallets -Allows to set default recommended wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define a list of wallets ids you'd like to prioritize (order is respected). You can get these ids from the explorer link mentioned before by clicking on a copy icon of your desired wallet card. +Allows to set default recommended wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define a list of wallets ids you'd like to prioritize (order is respected). You can get these ids from the WalletGuide link mentioned before by clicking on a copy icon of your desired wallet card. ```swift AppKit.configure( @@ -14,9 +14,9 @@ AppKit.configure( ) ``` -### Explorer excluded wallets +### WalletGuide excluded wallets -Allows to exclude wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define an array of wallet ids you'd like to exclude. You can get these ids from the explorer link mentioned before by clicking on a copy icon of your desired wallet card. +Allows to exclude wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define an array of wallet ids you'd like to exclude. You can get these ids from the WalletGuide link mentioned before by clicking on a copy icon of your desired wallet card. ```swift AppKit.configure( @@ -28,7 +28,7 @@ AppKit.configure( ### Add custom wallets -If you want to list wallet that is not included in the explorer, you can configure the client as follows: +If you want to list wallet that is not included in the WalletGuide, you can configure the client as follows: ```swift AppKit.configure( diff --git a/appkit/javascript/notifications/overview.mdx b/appkit/javascript/notifications/overview.mdx index 499a1fbb4..c52670892 100644 --- a/appkit/javascript/notifications/overview.mdx +++ b/appkit/javascript/notifications/overview.mdx @@ -40,7 +40,7 @@ Users can receive notifications in several places: - [iOS sample wallet](https://testflight.apple.com/join/09bTAryp) - [Android sample wallet](https://appdistribution.firebase.dev/i/d2c86e879abd5a86) -Users can also subscribe to notifications in all of the above locations too. To be discoverable in the Web3Inbox.com app or in wallets, apps must submit an explorer listing. +Users can also subscribe to notifications in all of the above locations too. To be discoverable in the Web3Inbox.com app or in wallets, apps must submit a WalletGuide listing. ## Try it out diff --git a/appkit/next/notifications/overview.mdx b/appkit/next/notifications/overview.mdx index 2b09af33d..349555e52 100644 --- a/appkit/next/notifications/overview.mdx +++ b/appkit/next/notifications/overview.mdx @@ -40,7 +40,7 @@ Users can receive notifications in several places: - [iOS sample wallet](https://testflight.apple.com/join/09bTAryp) - [Android sample wallet](https://appdistribution.firebase.dev/i/d2c86e879abd5a86) -Users can also subscribe to notifications in all of the above locations too. To be discoverable in the Web3Inbox.com app or in wallets, apps must submit an explorer listing. +Users can also subscribe to notifications in all of the above locations too. To be discoverable in the Web3Inbox.com app or in wallets, apps must submit a WalletGuide listing. ## Try it out diff --git a/appkit/react-native/core/options.mdx b/appkit/react-native/core/options.mdx index 392d117de..9215a6e39 100644 --- a/appkit/react-native/core/options.mdx +++ b/appkit/react-native/core/options.mdx @@ -125,7 +125,7 @@ createAppKit({ Override default recommended wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). Array of wallet ids defined will be shown (order is respected). Unlike `featuredWalletIds`, these wallets will be the **only** ones shown in `All Wallets` view and as recommended wallets. -You can get these ids from the explorer link mentioned before by clicking on a copy icon of desired wallet card. +You can get these ids from the WalletGuide link mentioned before by clicking on a copy icon of desired wallet card. ```ts createAppKit({ diff --git a/appkit/react-native/notifications/overview.mdx b/appkit/react-native/notifications/overview.mdx index cc4b3249d..fb7daa8d5 100644 --- a/appkit/react-native/notifications/overview.mdx +++ b/appkit/react-native/notifications/overview.mdx @@ -40,7 +40,7 @@ Users can receive notifications in several places: - [iOS sample wallet](https://testflight.apple.com/join/09bTAryp) - [Android sample wallet](https://appdistribution.firebase.dev/i/d2c86e879abd5a86) -Users can also subscribe to notifications in all of the above locations too. To be discoverable in the Web3Inbox.com app or in wallets, apps must submit an explorer listing. +Users can also subscribe to notifications in all of the above locations too. To be discoverable in the Web3Inbox.com app or in wallets, apps must submit a WalletGuide listing. ## Try it out diff --git a/appkit/react/notifications/overview.mdx b/appkit/react/notifications/overview.mdx index 2b09af33d..349555e52 100644 --- a/appkit/react/notifications/overview.mdx +++ b/appkit/react/notifications/overview.mdx @@ -40,7 +40,7 @@ Users can receive notifications in several places: - [iOS sample wallet](https://testflight.apple.com/join/09bTAryp) - [Android sample wallet](https://appdistribution.firebase.dev/i/d2c86e879abd5a86) -Users can also subscribe to notifications in all of the above locations too. To be discoverable in the Web3Inbox.com app or in wallets, apps must submit an explorer listing. +Users can also subscribe to notifications in all of the above locations too. To be discoverable in the Web3Inbox.com app or in wallets, apps must submit a WalletGuide listing. ## Try it out diff --git a/appkit/unity/core/options.mdx b/appkit/unity/core/options.mdx index e67203f9d..aa7a3388f 100644 --- a/appkit/unity/core/options.mdx +++ b/appkit/unity/core/options.mdx @@ -2,9 +2,9 @@ title: Options --- -### Explorer included wallets +### WalletGuide included wallets -Allows to set included wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define a list of wallets ids you'd like to prioritize (order is respected). You can get these ids from the explorer link mentioned before by clicking on a copy icon of your desired wallet card. +Allows to set included wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define a list of wallets ids you'd like to prioritize (order is respected). You can get these ids from the WalletGuide link mentioned before by clicking on a copy icon of your desired wallet card. ```csharp await AppKit.InitializeAsync(new AppKitConfig @@ -16,9 +16,9 @@ await AppKit.InitializeAsync(new AppKitConfig }); ``` -### Explorer excluded wallets +### WalletGuide excluded wallets -Allows to set excluded wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can get these ids from the explorer link mentioned before by clicking on a copy icon of your desired wallet card. +Allows to set excluded wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can get these ids from the WalletGuide link mentioned before by clicking on a copy icon of your desired wallet card. ```csharp await AppKit.InitializeAsync(new AppKitConfig diff --git a/appkit/vue/notifications/overview.mdx b/appkit/vue/notifications/overview.mdx index cc4b3249d..fb7daa8d5 100644 --- a/appkit/vue/notifications/overview.mdx +++ b/appkit/vue/notifications/overview.mdx @@ -40,7 +40,7 @@ Users can receive notifications in several places: - [iOS sample wallet](https://testflight.apple.com/join/09bTAryp) - [Android sample wallet](https://appdistribution.firebase.dev/i/d2c86e879abd5a86) -Users can also subscribe to notifications in all of the above locations too. To be discoverable in the Web3Inbox.com app or in wallets, apps must submit an explorer listing. +Users can also subscribe to notifications in all of the above locations too. To be discoverable in the Web3Inbox.com app or in wallets, apps must submit a WalletGuide listing. ## Try it out diff --git a/cloud/chains/overview.mdx b/cloud/chains/overview.mdx index 47116434a..86f80c49d 100644 --- a/cloud/chains/overview.mdx +++ b/cloud/chains/overview.mdx @@ -4,15 +4,15 @@ title: "Chain Onboarding" The WalletConnect protocol is multi-chain by design. By using the [CAIP-25 standard](https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-25.md), WalletConnect aims to provide a standardized process for onboarding new chains into our ecosystem. To get started, follow the following steps. -## Register Chain with the Explorer +## Register Chain with the WalletGuide -**Registering a chain with the Explorer does not impact or improve the ability for wallets and dapps to support your chain.** It is simply a way for users to discover wallets and dapps that support your chain by: +**Registering a chain with the WalletGuide does not impact or improve the ability for wallets and dapps to support your chain.** It is simply a way for users to discover wallets and dapps that support your chain by: - Browsing the [Chains List](./chain-list) -- Filtering results programmatically via the [Explorer API](../../cloud/explorer.md) +- Filtering results programmatically via the [WalletGuide API](../../cloud/explorer.md) -**It is still up to wallets and dapps to provide concrete support for your chain once it is listed as part of the Explorer.** +**It is still up to wallets and dapps to provide concrete support for your chain once it is listed as part of the WalletGuide.** If you don't see your chain listed in this [list](./chain-list), then you will need to create an issue in GitHub to to get the process started. @@ -38,7 +38,7 @@ Integrate RPC method support into the example wallets and dapp. ## Promote -For a chain to benefit users, its prominent wallets and dApps must be registered in the Explorer. Encourage them to join the API, allowing users to view the wallets as options when connecting to a dApp. +For a chain to benefit users, its prominent wallets and dApps must be registered in the WalletGuide. Encourage them to join the API, allowing users to view the wallets as options when connecting to a dApp. ## Wagmi & Viem diff --git a/cloud/explorer-submission.mdx b/cloud/explorer-submission.mdx index 239deb481..51e84f89c 100644 --- a/cloud/explorer-submission.mdx +++ b/cloud/explorer-submission.mdx @@ -1,11 +1,11 @@ --- -title: Explorer Submission +title: WalletGuide Submission --- -Submitting a project to the Reown Cloud Explorer is recommended but optional. You can still use Reown services without submitting your project. -However, doing so ensures that your project is listed under [WalletGuide](https://walletguide.walletconnect.network/?utm_source=walletconnect-docs&utm_medium=cloud&utm_campaign=github) and [Cloud Explorer API](./explorer.md). +Submitting a project to the Reown Cloud WalletGuide is recommended but optional. You can still use Reown services without submitting your project. +However, doing so ensures that your project is listed under [WalletGuide](https://walletguide.walletconnect.network/?utm_source=walletconnect-docs&utm_medium=cloud&utm_campaign=github) and [Cloud WalletGuide API](./explorer.md). @@ -20,7 +20,7 @@ However, doing so ensures that your project is listed under [WalletGuide](https: ## Project Details -- Go to the "WalletGuide" tab and fill in the details of your wallet. +- Go to the "WalletGuide" tab and fill in the details of your project. @@ -28,14 +28,14 @@ However, doing so ensures that your project is listed under [WalletGuide](https: | Field | Description | Required | |------------------------------|-----------------------------------------------------------------------------|----------| -| Name | The name to display in the explorer | yes | +| Name | The name to display in the WalletGuide | yes | | Description | A short description explaining your project (dapp/wallet) | yes | | Type | Whether your project is a dapp or a wallet | yes | | Category | Appropriate category for your project. This field is dependent on the type of your project | yes | | Homepage | The URL of your project | yes | | Web App | The URL of your web app. This field is only applicable for dapps | yes | | Chains | Chains supported by your project | yes | -| Logo | The logo of your project. Further requirements are provided in the explorer submission form | yes | +| Logo | The logo of your project. Further requirements are provided in the WalletGuide submission form | yes | | Testing Instructions | Instructions on how to test your Reown Integration | yes | | Download Links | Links to download your project (if applicable) | no | | Mobile Linking | Required for mobile wallets targeting AppKit. Deep Link is recommended over Universal Link | no | @@ -100,7 +100,7 @@ The following test cases only apply for wallets supporting a particular set of c ## What's Next? -Now depending on whether or not your submission met all parameters, you will receive an email from the Reown team with the status of your submission. This change will also be reflected with more directions in the "Explorer" tab of your project. -If your submission was not accepted, you can make the necessary changes and resubmit your project for review. The reason for rejection will be mentioned in the email and in the "Explorer" tab of your project. +Now depending on whether or not your submission met all parameters, you will receive an email from the Reown team with the status of your submission. This change will also be reflected with more directions in the "WalletGuide" tab of your project. +If your submission was not accepted, you can make the necessary changes and resubmit your project for review. The reason for rejection will be mentioned in the email and in the "WalletGuide" tab of your project. In case of any questions, feel free to ask on [Github Discussions](https://github.com/orgs/WalletConnect/discussions/categories/explorer-support) diff --git a/cloud/explorer.mdx b/cloud/explorer.mdx index 336b17cca..ce123ca9f 100644 --- a/cloud/explorer.mdx +++ b/cloud/explorer.mdx @@ -1,11 +1,11 @@ --- -title: Explorer API +title: WalletGuide API --- -The Cloud Explorer API currently offers the following functionality: +The Cloud WalletGuide API currently offers the following functionality: - [Listings](#listings) - Allows for fetching of wallets and dApps listed in the [WalletGuide](https://walletguide.walletconnect.network/). -- [Logos](#logos) - Provides logo assets in different sizes for a given Cloud explorer entry. +- [Logos](#logos) - Provides logo assets in different sizes for a given Cloud WalletGuide entry. ### Listings @@ -26,7 +26,7 @@ By default listings endpoints return all data for provided type. You can use fol #### `GET /v3/wallets` -Returns a JSON object containing all wallets listed in the cloud explorer. +Returns a JSON object containing all wallets listed in the cloud WalletGuide. Examples: @@ -35,7 +35,7 @@ Examples: #### `GET /v3/dapps` -Returns a JSON object containing all dApps listed in the public cloud explorer. +Returns a JSON object containing all dApps listed in the public cloud WalletGuide. Examples: @@ -43,7 +43,7 @@ Examples: #### `GET /v3/hybrid` -Returns a JSON object containing all hybrids listed in the public cloud explorer. +Returns a JSON object containing all hybrids listed in the public cloud WalletGuide. Examples: @@ -51,7 +51,7 @@ Examples: #### `GET /v3/all` -Returns a JSON object containing all entries listed in the public cloud explorer. +Returns a JSON object containing all entries listed in the public cloud WalletGuide. Examples: @@ -96,7 +96,7 @@ Examples: | Param | Description | | ----- | ---------------------------------------------------------------------------------------- | | size | Determines resolution of returned image can be one of: `sm`, `md` or `lg` | -| id | Corresponds to a Cloud Explorer entry's `image_id` field as returned by the Listings API | +| id | Corresponds to a Cloud WalletGuide entry's `image_id` field as returned by the Listings API | #### Query Parameters diff --git a/cloud/relay.mdx b/cloud/relay.mdx index 2402c960b..1594dfe85 100644 --- a/cloud/relay.mdx +++ b/cloud/relay.mdx @@ -63,7 +63,7 @@ Example of possible origins in the allowlist: ## Best Practices -- Create a new `projectId` for each project. This allows for more granular control, dedicated explorer listings, and project metrics. +- Create a new `projectId` for each project. This allows for more granular control, dedicated WalletGuide listings, and project metrics. - Don't reuse a `projectId`. - Use the AllowList to limit unauthorized usage. - Avoid committing projects keys to the repo. Use env variables instead. diff --git a/docs.json b/docs.json index 3f7b137ed..3076a015d 100644 --- a/docs.json +++ b/docs.json @@ -88,16 +88,16 @@ "group": "Cloud", "pages": [ { - "group": "Explorer", + "group": "WalletGuide", "pages": [ "cloud/explorer", "cloud/explorer-submission", { - "group": "Explorer Chains", + "group": "WalletGuide Chains", "pages": ["cloud/chains/overview", "cloud/chains/chain-list"] }, { - "group": "Explorer Wallets", + "group": "WalletGuide Wallets", "pages": ["cloud/wallets/wallet-list"] } ] diff --git a/snippets/cloud/explorer-submission.mdx b/snippets/cloud/explorer-submission.mdx index 29fff458d..60721dd6c 100644 --- a/snippets/cloud/explorer-submission.mdx +++ b/snippets/cloud/explorer-submission.mdx @@ -1,12 +1,12 @@ --- -title: Explorer Submission +title: WalletGuide Submission --- **Note** -Submitting a project to the Reown Cloud Explorer is recommended but optional. You can still use Reown services without submitting your project. -However, doing so ensures that your project is listed under [WalletGuide](https://walletguide.walletconnect.network/?utm_source=walletconnect-docs&utm_medium=cloud&utm_campaign=explorer-submission) and [Cloud Explorer API](./explorer.md). +Submitting a project to the Reown Cloud WalletGuide is recommended but optional. You can still use Reown services without submitting your project. +However, doing so ensures that your project is listed under [WalletGuide](https://walletguide.walletconnect.network/?utm_source=walletconnect-docs&utm_medium=cloud&utm_campaign=explorer-submission) and [Cloud WalletGuide API](./explorer.md). ## Creating a New Project @@ -20,7 +20,7 @@ However, doing so ensures that your project is listed under [WalletGuide](https: ## Project Details -- Go to the "Explorer" tab and fill in the details of your project. +- Go to the "WalletGuide" tab and fill in the details of your project. @@ -28,14 +28,14 @@ However, doing so ensures that your project is listed under [WalletGuide](https: | Field | Description | Required | |------------------------------|-------------------------------------------------------------------------------------------------------------------------|----------| -| **Name** | The name to display in the explorer | Yes | +| **Name** | The name to display in the WalletGuide | Yes | | **Description** | A short description explaining your project (dapp/wallet) | Yes | | **Type** | Whether your project is a dapp or a wallet | Yes | | **Category** | Appropriate category for your project. This field is dependent on the type of your project | Yes | | **Homepage** | The URL of your project | Yes | | **Web App** | The URL of your web app. This field is only applicable for dapps | Yes | | **Chains** | Chains supported by your project | Yes | -| **Logo** | The logo of your project. Further requirements are provided in the explorer submission form | Yes | +| **Logo** | The logo of your project. Further requirements are provided in the WalletGuide submission form | Yes | | **Testing Instructions** | Instructions on how to test your Reown Integration | Yes | | **Download Links** | Links to download your project (if applicable) | No | | **Mobile Linking** | Required for mobile wallets targeting AppKit. Deep Link is recommended over Universal Link | No | @@ -100,7 +100,7 @@ The following test cases only apply for wallets supporting a particular set of c ## What's Next? -Now depending on whether or not your submission met all parameters, you will receive an email from the Reown team with the status of your submission. This change will also be reflected with more directions in the "Explorer" tab of your project. -If your submission was not accepted, you can make the necessary changes and resubmit your project for review. The reason for rejection will be mentioned in the email and in the "Explorer" tab of your project. +Now depending on whether or not your submission met all parameters, you will receive an email from the Reown team with the status of your submission. This change will also be reflected with more directions in the "WalletGuide" tab of your project. +If your submission was not accepted, you can make the necessary changes and resubmit your project for review. The reason for rejection will be mentioned in the email and in the "WalletGuide" tab of your project. In case of any questions, feel free to ask on [Github Discussions](https://github.com/orgs/WalletConnect/discussions/categories/explorer-support) diff --git a/snippets/cloud/relay.mdx b/snippets/cloud/relay.mdx index 2402c960b..1594dfe85 100644 --- a/snippets/cloud/relay.mdx +++ b/snippets/cloud/relay.mdx @@ -63,7 +63,7 @@ Example of possible origins in the allowlist: ## Best Practices -- Create a new `projectId` for each project. This allows for more granular control, dedicated explorer listings, and project metrics. +- Create a new `projectId` for each project. This allows for more granular control, dedicated WalletGuide listings, and project metrics. - Don't reuse a `projectId`. - Use the AllowList to limit unauthorized usage. - Avoid committing projects keys to the repo. Use env variables instead. diff --git a/snippets/walletkit/shared/mobile-linking.mdx b/snippets/walletkit/shared/mobile-linking.mdx index b24fc765d..ddcc6171b 100644 --- a/snippets/walletkit/shared/mobile-linking.mdx +++ b/snippets/walletkit/shared/mobile-linking.mdx @@ -1,6 +1,6 @@ ### How to test -Before submitting your project to the Cloud Explorer you can test mobile linking in our sample Dapp: +Before submitting your project to the Cloud WalletGuide you can test mobile linking in our sample Dapp: 1. On your mobile device, visit the appropriate link: - For EVM: https://appkit-lab.reown.com/library/wagmi/ @@ -9,4 +9,4 @@ Before submitting your project to the Cloud Explorer you can test mobile linking 2. Click the "Custom Wallet" button and fill in the form with your wallet information. The website will reload and your wallet will be stored locally. 3. Click the "Connect Wallet" button and choose your mobile wallet. It _should_ automatically open and redirect to your wallet. -Learn more about mobile linking in the [Best Practices section](../best-practices#2-mobile-linking). \ No newline at end of file +Learn more about mobile linking in the [Best Practices section](../best-practices#2-mobile-linking). diff --git a/snippets/web3modal/v2/_partials/options/enableAuthMode.mdx b/snippets/web3modal/v2/_partials/options/enableAuthMode.mdx index 2e7e84368..6fdb56ff1 100644 --- a/snippets/web3modal/v2/_partials/options/enableAuthMode.mdx +++ b/snippets/web3modal/v2/_partials/options/enableAuthMode.mdx @@ -1,4 +1,4 @@ -Option to enable auth only mode for modal, will adjust which wallets are fetched from explorer. Defaults to `false`. +Option to enable auth only mode for modal, will adjust which wallets are fetched from WalletGuide. Defaults to `false`. ```ts enableAuthMode: true diff --git a/snippets/web3modal/v2/_partials/options/explorerExcludedWalletIds.mdx b/snippets/web3modal/v2/_partials/options/explorerExcludedWalletIds.mdx index 6453fa647..ae915cfd0 100644 --- a/snippets/web3modal/v2/_partials/options/explorerExcludedWalletIds.mdx +++ b/snippets/web3modal/v2/_partials/options/explorerExcludedWalletIds.mdx @@ -1,4 +1,4 @@ -Allows to exclude wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define an array of wallet ids you'd like to exclude. You can get these ids from the explorer link mentioned before by clicking on a copy icon of desired wallet card. If you want to exclude all wallets, you can set this option to `ALL`, however if `explorerRecommendedWalletIds` were defined, they will still be fetched. Defaults to `undefined`. +Allows to exclude wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define an array of wallet ids you'd like to exclude. You can get these ids from the WalletGuide link mentioned before by clicking on a copy icon of desired wallet card. If you want to exclude all wallets, you can set this option to `ALL`, however if `explorerRecommendedWalletIds` were defined, they will still be fetched. Defaults to `undefined`. ```ts explorerExcludedWalletIds: [ diff --git a/snippets/web3modal/v2/_partials/options/explorerRecommendedWalletIds.mdx b/snippets/web3modal/v2/_partials/options/explorerRecommendedWalletIds.mdx index c85be9e33..9aaf62555 100644 --- a/snippets/web3modal/v2/_partials/options/explorerRecommendedWalletIds.mdx +++ b/snippets/web3modal/v2/_partials/options/explorerRecommendedWalletIds.mdx @@ -1,4 +1,4 @@ -Allows to override default recommended wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define an array of wallet ids you'd like to prioritise (order is respected). You can get these ids from the explorer link mentioned before by clicking on a copy icon of desired wallet card. If you want to completely disable recommended wallets, you can set this option to `NONE`. Defaults to `undefined`. +Allows to override default recommended wallets that are fetched from [WalletGuide](https://walletguide.walletconnect.network/). You can define an array of wallet ids you'd like to prioritise (order is respected). You can get these ids from the WalletGuide link mentioned before by clicking on a copy icon of desired wallet card. If you want to completely disable recommended wallets, you can set this option to `NONE`. Defaults to `undefined`. ```ts explorerRecommendedWalletIds: [ diff --git a/walletkit/android/cloud/explorer-submission.mdx b/walletkit/android/cloud/explorer-submission.mdx index cd1e47b62..9e451417c 100644 --- a/walletkit/android/cloud/explorer-submission.mdx +++ b/walletkit/android/cloud/explorer-submission.mdx @@ -1,7 +1,7 @@ --- -title: Explorer Submission +title: WalletGuide Submission --- import ExplorerSubmission from "/snippets/cloud/explorer-submission.mdx"; - \ No newline at end of file + diff --git a/walletkit/android/mobile-linking.mdx b/walletkit/android/mobile-linking.mdx index 2fd9fa146..f2a06ec11 100644 --- a/walletkit/android/mobile-linking.mdx +++ b/walletkit/android/mobile-linking.mdx @@ -76,7 +76,7 @@ When the Dapp needs the user to sign something (like a transaction), a similar p ## Platform preparations -In order for Dapps to be able to trigger your wallet for a connection or sign request using deep links you first need to add your own wallet to the Explorer by login to your [Reown Cloud](https://cloud.reown.com/sign-in) account, declare a deep link and define an [``](https://developer.android.com/training/app-links/deep-linking#adding-filters) in your wallet's Manifest.xml with the same deep link added in Explorer: +In order for Dapps to be able to trigger your wallet for a connection or sign request using deep links you first need to add your own wallet to the WalletGuide by login to your [Reown Cloud](https://cloud.reown.com/sign-in) account, declare a deep link and define an [``](https://developer.android.com/training/app-links/deep-linking#adding-filters) in your wallet's Manifest.xml with the same deep link added in WalletGuide: ```xml diff --git a/walletkit/c-sharp/cloud/explorer-submission.mdx b/walletkit/c-sharp/cloud/explorer-submission.mdx index e5f11c89c..9e451417c 100644 --- a/walletkit/c-sharp/cloud/explorer-submission.mdx +++ b/walletkit/c-sharp/cloud/explorer-submission.mdx @@ -1,5 +1,5 @@ --- -title: Explorer Submission +title: WalletGuide Submission --- import ExplorerSubmission from "/snippets/cloud/explorer-submission.mdx"; diff --git a/walletkit/flutter/cloud/explorer-submission.mdx b/walletkit/flutter/cloud/explorer-submission.mdx index e5f11c89c..9e451417c 100644 --- a/walletkit/flutter/cloud/explorer-submission.mdx +++ b/walletkit/flutter/cloud/explorer-submission.mdx @@ -1,5 +1,5 @@ --- -title: Explorer Submission +title: WalletGuide Submission --- import ExplorerSubmission from "/snippets/cloud/explorer-submission.mdx"; diff --git a/walletkit/ios/cloud/explorer-submission.mdx b/walletkit/ios/cloud/explorer-submission.mdx index e5f11c89c..9e451417c 100644 --- a/walletkit/ios/cloud/explorer-submission.mdx +++ b/walletkit/ios/cloud/explorer-submission.mdx @@ -1,5 +1,5 @@ --- -title: Explorer Submission +title: WalletGuide Submission --- import ExplorerSubmission from "/snippets/cloud/explorer-submission.mdx"; diff --git a/walletkit/ios/mobile-linking.mdx b/walletkit/ios/mobile-linking.mdx index 60417761d..e164e5a21 100644 --- a/walletkit/ios/mobile-linking.mdx +++ b/walletkit/ios/mobile-linking.mdx @@ -107,7 +107,7 @@ Dapps developers must do the same for their own custom schemes if they want the iOS has some more caveats to the integration but we ensure to make it as straightforward as possible. Since its operating system is not designed to handle multiple applications subscribing to the same deep linking schema, we've designed the AppKit to list supporting wallets on our [WalletGuide](https://walletguide.walletconnect.network/) and target specific deep links or universal links for each wallet. -To add your own wallet to the Explorer, login to your [Reown Cloud](https://cloud.reown.com/sign-in) account. +To add your own wallet to the WalletGuide, login to your [Reown Cloud](https://cloud.reown.com/sign-in) account. ```bash # For deep links diff --git a/walletkit/react-native/cloud/explorer-submission.mdx b/walletkit/react-native/cloud/explorer-submission.mdx index e5f11c89c..9e451417c 100644 --- a/walletkit/react-native/cloud/explorer-submission.mdx +++ b/walletkit/react-native/cloud/explorer-submission.mdx @@ -1,5 +1,5 @@ --- -title: Explorer Submission +title: WalletGuide Submission --- import ExplorerSubmission from "/snippets/cloud/explorer-submission.mdx"; diff --git a/walletkit/react-native/notifications/notify/usage.mdx b/walletkit/react-native/notifications/notify/usage.mdx index abb0b337b..01e127aaf 100644 --- a/walletkit/react-native/notifications/notify/usage.mdx +++ b/walletkit/react-native/notifications/notify/usage.mdx @@ -129,13 +129,13 @@ await notifyClient.register({ To begin receiving notifications from a dapp, users must opt-in by subscribing. This subscription process grants permission for the dapp to send notifications to the user. These notifications can serve a variety of purposes, such as providing updates on the user's blockchain account activities or informing them about ongoing campaigns within the dapp. Upon initial subscription, clients will be automatically enrolled to receive all types of notifications as defined by the dapp at that moment. Users have the flexibility to modify their notification settings later, allowing them to tailor the types of alerts they receive according to their preferences. -To identify dapps that can be subscribed to via Notify, we can query the following Explorer API endpoint: +To identify dapps that can be subscribed to via Notify, we can query the following WalletGuide API endpoint: https://explorer-api.walletconnect.com/v3/dapps?projectId=YOUR_PROJECT_ID&is_notify_enabled=true ```javascript -// Get the domain of the target dapp from the Explorer API response +// Get the domain of the target dapp from the WalletGuide API response const appDomain = new URL(fetchedExplorerDapp.platform_browser).hostname; // Subscribe to `fetchedExplorerDapp` by passing the account to be subscribed and the domain of the target dapp. diff --git a/walletkit/web/cloud/explorer-submission.mdx b/walletkit/web/cloud/explorer-submission.mdx index e5f11c89c..9e451417c 100644 --- a/walletkit/web/cloud/explorer-submission.mdx +++ b/walletkit/web/cloud/explorer-submission.mdx @@ -1,5 +1,5 @@ --- -title: Explorer Submission +title: WalletGuide Submission --- import ExplorerSubmission from "/snippets/cloud/explorer-submission.mdx"; diff --git a/web3modal/v2/_partials/customisation/customExplorerWallets.mdx b/web3modal/v2/_partials/customisation/customExplorerWallets.mdx index dc85d06b0..2c9ec35a3 100644 --- a/web3modal/v2/_partials/customisation/customExplorerWallets.mdx +++ b/web3modal/v2/_partials/customisation/customExplorerWallets.mdx @@ -1,5 +1,5 @@ -You can manage wallets fetched from explorer via `explorerRecommendedWalletIds` and `explorerExcludedWalletIds` options to prioritize, include or exclude them. -To fully disable explorer wallets, use `enableExplorer` options. +You can manage wallets fetched from WalletGuide via `explorerRecommendedWalletIds` and `explorerExcludedWalletIds` options to prioritize, include or exclude them. +To fully disable WalletGuide wallets, use `enableExplorer` options. You can get all wallet id's from [WalletGuide](https://walletguide.walletconnect.network/) (click copy icon on chosen wallets).