Add cluster API

.changeset/yellow-sloths-juggle.md

@@ -0,0 +1,6 @@
+---
+'@solana/wallet-standard-chains': minor
+'@solana/wallet-standard-features': minor
+---
+
+Add `getCluster` and `setCluster` features

packages/core/chains/src/index.ts

@@ -1,31 +1,2 @@
-import type { IdentifierString } from '@wallet-standard/base';
-
-/** Solana Mainnet (beta) cluster, e.g. https://api.mainnet-beta.solana.com */
-export const SOLANA_MAINNET_CHAIN = 'solana:mainnet';
-
-/** Solana Devnet cluster, e.g. https://api.devnet.solana.com */
-export const SOLANA_DEVNET_CHAIN = 'solana:devnet';
-
-/** Solana Testnet cluster, e.g. https://api.testnet.solana.com */
-export const SOLANA_TESTNET_CHAIN = 'solana:testnet';
-
-/** Solana Localnet cluster, e.g. http://localhost:8899 */
-export const SOLANA_LOCALNET_CHAIN = 'solana:localnet';
-
-/** Array of all Solana clusters */
-export const SOLANA_CHAINS = [
-    SOLANA_MAINNET_CHAIN,
-    SOLANA_DEVNET_CHAIN,
-    SOLANA_TESTNET_CHAIN,
-    SOLANA_LOCALNET_CHAIN,
-] as const;
-
-/** Type of all Solana clusters */
-export type SolanaChain = (typeof SOLANA_CHAINS)[number];
-
-/**
- * Check if a chain corresponds with one of the Solana clusters.
- */
-export function isSolanaChain(chain: IdentifierString): chain is SolanaChain {
-    return SOLANA_CHAINS.includes(chain as SolanaChain);
-}
+export * from './solana.js';
+export * from './sonic.js';

packages/core/chains/src/solana.ts

@@ -0,0 +1,31 @@
+import type { IdentifierString } from '@wallet-standard/base';
+
+/** Solana Mainnet (beta) cluster, e.g. https://api.mainnet-beta.solana.com */
+export const SOLANA_MAINNET_CHAIN = 'solana:mainnet';
+
+/** Solana Devnet cluster, e.g. https://api.devnet.solana.com */
+export const SOLANA_DEVNET_CHAIN = 'solana:devnet';
+
+/** Solana Testnet cluster, e.g. https://api.testnet.solana.com */
+export const SOLANA_TESTNET_CHAIN = 'solana:testnet';
+
+/** Solana Localnet cluster, e.g. http://localhost:8899 */
+export const SOLANA_LOCALNET_CHAIN = 'solana:localnet';
+
+/** Array of all Solana clusters */
+export const SOLANA_CHAINS = [
+    SOLANA_MAINNET_CHAIN,
+    SOLANA_DEVNET_CHAIN,
+    SOLANA_TESTNET_CHAIN,
+    SOLANA_LOCALNET_CHAIN,
+] as const;
+
+/** Type of all Solana clusters */
+export type SolanaChain = (typeof SOLANA_CHAINS)[number];
+
+/**
+ * Check if a chain corresponds with one of the Solana clusters.
+ */
+export function isSolanaChain(chain: IdentifierString): chain is SolanaChain {
+    return SOLANA_CHAINS.includes(chain as SolanaChain);
+}

packages/core/chains/src/sonic.ts

@@ -0,0 +1,31 @@
+import type { IdentifierString } from '@wallet-standard/base';
+
+/** Sonic Mainnet (beta) cluster, e.g. https://api.mainnet-beta.sonic.com */
+export const SONIC_MAINNET_CHAIN = 'sonic:mainnet';
+
+/** Sonic Devnet cluster, e.g. https://api.devnet.sonic.com */
+export const SONIC_DEVNET_CHAIN = 'sonic:devnet';
+
+/** Sonic Testnet cluster, e.g. https://api.testnet.sonic.com */
+export const SONIC_TESTNET_CHAIN = 'sonic:testnet';
+
+/** Sonic Localnet cluster, e.g. http://localhost:8899 */
+export const SONIC_LOCALNET_CHAIN = 'sonic:localnet';
+
+/** Array of all Sonic clusters */
+export const SONIC_CHAINS = [
+    SONIC_MAINNET_CHAIN,
+    SONIC_DEVNET_CHAIN,
+    SONIC_TESTNET_CHAIN,
+    SONIC_LOCALNET_CHAIN,
+] as const;
+
+/** Type of all Sonic clusters */
+export type SonicChain = (typeof SONIC_CHAINS)[number];
+
+/**
+ * Check if a chain corresponds with one of the Sonic clusters.
+ */
+export function isSonicChain(chain: IdentifierString): chain is SonicChain {
+    return SONIC_CHAINS.includes(chain as SonicChain);
+}

packages/core/features/src/getCluster.ts

@@ -0,0 +1,35 @@
+import type { IdentifierString } from '@wallet-standard/base';
+
+/** Name of the feature. */
+export const SolanaGetCluster = 'solana:getCluster';
+
+/** Represents the feature for getting the current Solana cluster name. */
+export type SolanaGetClusterFeature = {
+    /** Name of the feature. */
+    readonly [SolanaGetCluster]: {
+        /** Version of the feature API. */
+        readonly version: SolanaGetClusterVersion;
+
+        /**
+         * Method to get the current Solana cluster name.
+         * This method interacts with wallet to get currently enabled Solana cluster.
+         *
+         * @returns {Promise<readonly SolanaGetClusterOutput>} A promise that resolves to Solana cluster name.
+         */
+        readonly getCluster: SolanaGetClusterMethod;
+    };
+};
+
+/** Version of the feature API. */
+export type SolanaGetClusterVersion = '1.0.0';
+
+/**
+ * Method to get the current Solana cluster name.
+ * This method returns a promise that resolves to Solana cluster name.
+ *
+ * @returns {Promise<readonly SolanaGetClusterOutput>} A promise that resolves to Solana cluster name.
+ */
+export type SolanaGetClusterMethod = () => Promise<SolanaGetClusterOutput>;
+
+/** Output type representing the Solana cluster information. */
+export type SolanaGetClusterOutput = IdentifierString;

packages/core/features/src/index.ts

@@ -3,13 +3,17 @@ import type { SolanaSignAndSendTransactionFeature } from './signAndSendTransacti
 import type { SolanaSignInFeature } from './signIn.js';
 import type { SolanaSignMessageFeature } from './signMessage.js';
 import type { SolanaSignTransactionFeature } from './signTransaction.js';
+import type { SolanaGetClusterFeature } from './getCluster.js';
+import type { SolanaSetClusterFeature } from './setCluster.js';
 
 /** TODO: docs */
 export type SolanaFeatures =
     | SolanaSignAndSendTransactionFeature
     | SolanaSignInFeature
     | SolanaSignMessageFeature
-    | SolanaSignTransactionFeature;
+    | SolanaSignTransactionFeature
+    | SolanaGetClusterFeature
+    | SolanaSetClusterFeature;
 
 /** TODO: docs */
 export type WalletWithSolanaFeatures = WalletWithFeatures<SolanaFeatures>;
@@ -18,3 +22,5 @@ export * from './signAndSendTransaction.js';
 export * from './signIn.js';
 export * from './signMessage.js';
 export * from './signTransaction.js';
+export * from './getCluster.js';
+export * from './setCluster.js';

packages/core/features/src/setCluster.ts

@@ -0,0 +1,37 @@
+import type { IdentifierString } from '@wallet-standard/base';
+
+/** Name of the setCluster feature. */
+export const SolanaSetCluster = 'solana:setCluster';
+
+/** Represents the feature for setting the current Solana cluster. */
+export type SolanaSetClusterFeature = {
+    /** Name of the setCluster feature. */
+    readonly [SolanaSetCluster]: {
+        /** Version of the setCluster feature API. */
+        readonly version: SolanaSetClusterVersion;
+
+        /**
+         * Method to set the current Solana cluster.
+         * This method interacts with the wallet to set the currently enabled Solana cluster.
+         *
+         * @param clusterName - The name of the Solana cluster to set.
+         * @returns {Promise<void>} A promise that resolves when the cluster has been set.
+         */
+        readonly setCluster: SolanaSetClusterMethod;
+    };
+};
+
+/** Version of the setCluster feature API. */
+export type SolanaSetClusterVersion = '1.0.0';
+
+/**
+ * Method to set the current Solana cluster.
+ * This method returns a promise that resolves when the cluster has been set.
+ *
+ * @param clusterName - The name of the Solana cluster to set.
+ * @returns {Promise<void>} A promise that resolves when the cluster has been set.
+ */
+export type SolanaSetClusterMethod = (clusterName: SolanaClusterInput) => Promise<void>;
+
+/** Input type representing the Solana cluster to be set. */
+export type SolanaClusterInput = IdentifierString;