Skip to content

Update Explorer terminology to WalletGuide across documentation #451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions advanced/api/notify/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -199,17 +199,17 @@ await notifyClient.unregister({
#### Creating a new subscription

<Note>
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

</Note>

```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,
Expand Down Expand Up @@ -952,17 +952,17 @@ await notifyClient.register({
#### Creating a new subscription

<Note>
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

</Note>

```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,
Expand Down
18 changes: 9 additions & 9 deletions advanced/walletconnectmodal/options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand All @@ -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'
Expand All @@ -188,9 +188,9 @@ accentColor = "#9090FF";

<Tab title="Android">

#### 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<String>(
Expand All @@ -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<String>(
Expand Down Expand Up @@ -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<String> recommendedWalletIds = {
Expand Down Expand Up @@ -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[]
Expand All @@ -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[]
Expand Down
8 changes: 4 additions & 4 deletions appkit/android/core/options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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<String>(
Expand All @@ -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<String>(
Expand Down
10 changes: 5 additions & 5 deletions appkit/ios/core/options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand All @@ -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(
Expand All @@ -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(
Expand Down
2 changes: 1 addition & 1 deletion appkit/javascript/notifications/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion appkit/next/notifications/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion appkit/react-native/core/options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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({
Expand Down
2 changes: 1 addition & 1 deletion appkit/react-native/notifications/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion appkit/react/notifications/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 4 additions & 4 deletions appkit/unity/core/options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion appkit/vue/notifications/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
10 changes: 5 additions & 5 deletions cloud/chains/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

<Note>
**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.**
</Note>

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.
Expand All @@ -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

Expand Down
Loading