@mysten/dapp-kit 0.0.0-experimental-20230928204256

package/src/hooks/wallet/useSignAndExecuteTransactionBlock.ts

@@ -0,0 +1,82 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import type {
+	SuiSignAndExecuteTransactionBlockInput,
+	SuiSignAndExecuteTransactionBlockOutput,
+} from '@mysten/wallet-standard';
+import type { UseMutationOptions } from '@tanstack/react-query';
+import { useMutation } from '@tanstack/react-query';
+
+import { walletMutationKeys } from '../../constants/walletMutationKeys.js';
+import {
+	WalletFeatureNotSupportedError,
+	WalletNoAccountSelectedError,
+	WalletNotConnectedError,
+} from '../../errors/walletErrors.js';
+import type { PartialBy } from '../../types/utilityTypes.js';
+import { useCurrentAccount } from './useCurrentAccount.js';
+import { useCurrentWallet } from './useCurrentWallet.js';
+
+type UseSignAndExecuteTransactionBlockArgs = PartialBy<
+	SuiSignAndExecuteTransactionBlockInput,
+	'account'
+>;
+
+type UseSignAndExecuteTransactionBlockResult = SuiSignAndExecuteTransactionBlockOutput;
+
+type UseSignAndExecuteTransactionBlockError =
+	| WalletFeatureNotSupportedError
+	| WalletNoAccountSelectedError
+	| WalletNotConnectedError
+	| Error;
+
+type UseSignAndExecuteTransactionBlockMutationOptions = Omit<
+	UseMutationOptions<
+		UseSignAndExecuteTransactionBlockResult,
+		UseSignAndExecuteTransactionBlockError,
+		UseSignAndExecuteTransactionBlockArgs,
+		unknown
+	>,
+	'mutationFn'
+>;
+
+/**
+ * Mutation hook for prompting the user to sign and execute a transaction block.
+ */
+export function useSignAndExecuteTransactionBlock({
+	mutationKey,
+	...mutationOptions
+}: UseSignAndExecuteTransactionBlockMutationOptions = {}) {
+	const currentWallet = useCurrentWallet();
+	const currentAccount = useCurrentAccount();
+
+	return useMutation({
+		mutationKey: walletMutationKeys.signAndExecuteTransactionBlock(mutationKey),
+		mutationFn: async (signAndExecuteTransactionBlockArgs) => {
+			if (!currentWallet) {
+				throw new WalletNotConnectedError('No wallet is connected.');
+			}
+
+			const signerAccount = signAndExecuteTransactionBlockArgs.account ?? currentAccount;
+			if (!signerAccount) {
+				throw new WalletNoAccountSelectedError(
+					'No wallet account is selected to sign the personal message with.',
+				);
+			}
+
+			const walletFeature = currentWallet.features['sui:signAndExecuteTransactionBlock'];
+			if (!walletFeature) {
+				throw new WalletFeatureNotSupportedError(
+					"This wallet doesn't support the `signAndExecuteTransactionBlock` feature.",
+				);
+			}
+
+			return await walletFeature.signAndExecuteTransactionBlock({
+				...signAndExecuteTransactionBlockArgs,
+				account: signerAccount,
+			});
+		},
+		...mutationOptions,
+	});
+}

package/src/hooks/wallet/useSignPersonalMessage.ts

@@ -0,0 +1,79 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import type {
+	SuiSignPersonalMessageInput,
+	SuiSignPersonalMessageOutput,
+} from '@mysten/wallet-standard';
+import type { UseMutationOptions } from '@tanstack/react-query';
+import { useMutation } from '@tanstack/react-query';
+
+import {
+	WalletFeatureNotSupportedError,
+	WalletNoAccountSelectedError,
+	WalletNotConnectedError,
+} from '../..//errors/walletErrors.js';
+import { walletMutationKeys } from '../../constants/walletMutationKeys.js';
+import type { PartialBy } from '../../types/utilityTypes.js';
+import { useCurrentAccount } from './useCurrentAccount.js';
+import { useCurrentWallet } from './useCurrentWallet.js';
+
+type UseSignPersonalMessageArgs = PartialBy<SuiSignPersonalMessageInput, 'account'>;
+
+type UseSignPersonalMessageResult = SuiSignPersonalMessageOutput;
+
+type UseSignPersonalMessageError =
+	| WalletFeatureNotSupportedError
+	| WalletNoAccountSelectedError
+	| WalletNotConnectedError
+	| Error;
+
+type UseSignPersonalMessageMutationOptions = Omit<
+	UseMutationOptions<
+		UseSignPersonalMessageResult,
+		UseSignPersonalMessageError,
+		UseSignPersonalMessageArgs,
+		unknown
+	>,
+	'mutationFn'
+>;
+
+/**
+ * Mutation hook for prompting the user to sign a message.
+ */
+export function useSignPersonalMessage({
+	mutationKey,
+	...mutationOptions
+}: UseSignPersonalMessageMutationOptions = {}) {
+	const currentWallet = useCurrentWallet();
+	const currentAccount = useCurrentAccount();
+
+	return useMutation({
+		mutationKey: walletMutationKeys.signPersonalMessage(mutationKey),
+		mutationFn: async (signPersonalMessageArgs) => {
+			if (!currentWallet) {
+				throw new WalletNotConnectedError('No wallet is connected.');
+			}
+
+			const signerAccount = signPersonalMessageArgs.account ?? currentAccount;
+			if (!signerAccount) {
+				throw new WalletNoAccountSelectedError(
+					'No wallet account is selected to sign the personal message with.',
+				);
+			}
+
+			const walletFeature = currentWallet.features['sui:signPersonalMessage'];
+			if (!walletFeature) {
+				throw new WalletFeatureNotSupportedError(
+					"This wallet doesn't support the `signPersonalMessage` feature.",
+				);
+			}
+
+			return await walletFeature.signPersonalMessage({
+				...signPersonalMessageArgs,
+				account: signerAccount,
+			});
+		},
+		...mutationOptions,
+	});
+}

package/src/hooks/wallet/useSignTransactionBlock.ts

@@ -0,0 +1,79 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import type {
+	SuiSignTransactionBlockInput,
+	SuiSignTransactionBlockOutput,
+} from '@mysten/wallet-standard';
+import type { UseMutationOptions } from '@tanstack/react-query';
+import { useMutation } from '@tanstack/react-query';
+
+import {
+	WalletFeatureNotSupportedError,
+	WalletNoAccountSelectedError,
+	WalletNotConnectedError,
+} from '../..//errors/walletErrors.js';
+import { walletMutationKeys } from '../../constants/walletMutationKeys.js';
+import type { PartialBy } from '../../types/utilityTypes.js';
+import { useCurrentAccount } from './useCurrentAccount.js';
+import { useCurrentWallet } from './useCurrentWallet.js';
+
+type UseSignTransactionBlockArgs = PartialBy<SuiSignTransactionBlockInput, 'account'>;
+
+type UseSignTransactionBlockResult = SuiSignTransactionBlockOutput;
+
+type UseSignTransactionBlockError =
+	| WalletFeatureNotSupportedError
+	| WalletNoAccountSelectedError
+	| WalletNotConnectedError
+	| Error;
+
+type UseSignTransactionBlockMutationOptions = Omit<
+	UseMutationOptions<
+		UseSignTransactionBlockResult,
+		UseSignTransactionBlockError,
+		UseSignTransactionBlockArgs,
+		unknown
+	>,
+	'mutationFn'
+>;
+
+/**
+ * Mutation hook for prompting the user to sign a transaction block.
+ */
+export function useSignTransactionBlock({
+	mutationKey,
+	...mutationOptions
+}: UseSignTransactionBlockMutationOptions = {}) {
+	const currentWallet = useCurrentWallet();
+	const currentAccount = useCurrentAccount();
+
+	return useMutation({
+		mutationKey: walletMutationKeys.signTransactionBlock(mutationKey),
+		mutationFn: async (signTransactionBlockArgs) => {
+			if (!currentWallet) {
+				throw new WalletNotConnectedError('No wallet is connected.');
+			}
+
+			const signerAccount = signTransactionBlockArgs.account ?? currentAccount;
+			if (!signerAccount) {
+				throw new WalletNoAccountSelectedError(
+					'No wallet account is selected to sign the personal message with.',
+				);
+			}
+
+			const walletFeature = currentWallet.features['sui:signTransactionBlock'];
+			if (!walletFeature) {
+				throw new WalletFeatureNotSupportedError(
+					"This wallet doesn't support the `SignTransactionBlock` feature.",
+				);
+			}
+
+			return await walletFeature.signTransactionBlock({
+				...signTransactionBlockArgs,
+				account: signerAccount,
+			});
+		},
+		...mutationOptions,
+	});
+}

package/src/hooks/wallet/useSwitchAccount.ts

@@ -0,0 +1,59 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import type { WalletAccount } from '@mysten/wallet-standard';
+import type { UseMutationOptions } from '@tanstack/react-query';
+import { useMutation } from '@tanstack/react-query';
+
+import { walletMutationKeys } from '../../constants/walletMutationKeys.js';
+import { WalletAccountNotFoundError, WalletNotConnectedError } from '../../errors/walletErrors.js';
+import { useCurrentWallet } from './useCurrentWallet.js';
+import { useWalletStore } from './useWalletStore.js';
+
+type SwitchAccountArgs = {
+	account: WalletAccount;
+};
+
+type SwitchAccountResult = void;
+
+type UseSwitchAccountMutationOptions = Omit<
+	UseMutationOptions<
+		SwitchAccountResult,
+		WalletNotConnectedError | WalletAccountNotFoundError | Error,
+		SwitchAccountArgs,
+		unknown
+	>,
+	'mutationFn'
+>;
+
+/**
+ * Mutation hook for switching to a specific wallet account.
+ */
+export function useSwitchAccount({
+	mutationKey,
+	...mutationOptions
+}: UseSwitchAccountMutationOptions = {}) {
+	const currentWallet = useCurrentWallet();
+	const setAccountSwitched = useWalletStore((state) => state.setAccountSwitched);
+
+	return useMutation({
+		mutationKey: walletMutationKeys.switchAccount(mutationKey),
+		mutationFn: async ({ account }) => {
+			if (!currentWallet) {
+				throw new WalletNotConnectedError('No wallet is connected.');
+			}
+
+			const accountToSelect = currentWallet.accounts.find(
+				(walletAccount) => walletAccount.address === account.address,
+			);
+			if (!accountToSelect) {
+				throw new WalletAccountNotFoundError(
+					`No account with address ${account.address} is connected to ${currentWallet.name}.`,
+				);
+			}
+
+			setAccountSwitched(accountToSelect);
+		},
+		...mutationOptions,
+	});
+}

package/src/hooks/wallet/useUnsafeBurnerWallet.ts

@@ -0,0 +1,144 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import type { SuiClient } from '@mysten/sui.js/client';
+import { Ed25519Keypair } from '@mysten/sui.js/keypairs/ed25519';
+import type {
+	StandardConnectFeature,
+	StandardConnectMethod,
+	StandardEventsFeature,
+	StandardEventsOnMethod,
+	SuiFeatures,
+	SuiSignAndExecuteTransactionBlockMethod,
+	SuiSignPersonalMessageMethod,
+	SuiSignTransactionBlockMethod,
+	Wallet,
+} from '@mysten/wallet-standard';
+import { getWallets, ReadonlyWalletAccount, SUI_CHAINS } from '@mysten/wallet-standard';
+import { useEffect } from 'react';
+
+import { useSuiClient } from '../useSuiClient.js';
+
+const WALLET_NAME = 'Unsafe Burner Wallet';
+
+export function useUnsafeBurnerWallet(enabled: boolean) {
+	const suiClient = useSuiClient();
+
+	useEffect(() => {
+		if (!enabled) {
+			return;
+		}
+		const unregister = registerUnsafeBurnerWallet(suiClient);
+		return unregister;
+	}, [enabled, suiClient]);
+}
+
+function registerUnsafeBurnerWallet(suiClient: SuiClient) {
+	const walletsApi = getWallets();
+	const registeredWallets = walletsApi.get();
+
+	if (registeredWallets.find((wallet) => wallet.name === WALLET_NAME)) {
+		console.warn(
+			'registerUnsafeBurnerWallet: Unsafe Burner Wallet already registered, skipping duplicate registration.',
+		);
+		return;
+	}
+
+	console.warn(
+		'Your application is currently using the unsafe burner wallet. Make sure that this wallet is disabled in production.',
+	);
+
+	const keypair = new Ed25519Keypair();
+	const account = new ReadonlyWalletAccount({
+		address: keypair.getPublicKey().toSuiAddress(),
+		publicKey: keypair.getPublicKey().toSuiBytes(),
+		chains: ['sui:unknown'],
+		features: ['sui:signAndExecuteTransactionBlock', 'sui:signTransactionBlock'],
+	});
+
+	class UnsafeBurnerWallet implements Wallet {
+		get version() {
+			return '1.0.0' as const;
+		}
+
+		get name() {
+			return WALLET_NAME;
+		}
+
+		get icon() {
+			return 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADwAAAA8CAYAAAA6/NlyAAAJrElEQVR42tWbe2xT1x3H7UxAyD3XrdrSbGXlUbKWsq5rWdVuVOMRSEqSOmnVRZMmJqZNYv1nf3R/jWmVmVrtRRM/YwPd1nVTNcrE3pQCoikrIRAC4VVNY0hlD9ZOo1uCfe3ra9979v0dcy3s5Pper76Oh/STE+495/4+5/c85zqe2f7HAx5vKsS+monJj/CdHi/f4/HWW4f6AwdblmXjTM0NyS+movKtw9v+j6C5gKhyTMTTpA2x15Qwy+Pz75motOGdgKep8WF5ATgVZIt5NeO2wMqD0hfVGNPh3oYaYflsjG0l63PeyLCDnqbsLpZIhaRNFI+Ox+Le5KB0RybK8gDmJOkI07U4i/FhT1NDQl8Me5rUIfaDfELOJ0NsFa/SJQHm1WLsHcDqRWiy9BCL8s0N5t6UWWFVvxplejYm60hC91cNjPtzCTZsAptCVoeLP8PDDQJNCSodap6H+LtE8ZcdkvVkkD38vwDn4/Jvy4EhBhZSvRaUHiTXn31gJJxkUPoClBKKFizM+inhVA2cYIdM4HJouPvoe9s9H+KzDhyGK6KkmIqitBhww2C11rjQL2L4kgUwFxk8yPyzauUA3Pk/353XnA6zKbKCaQ2UlMvJF6W5uF5F8yHfZWZpC9HRmBziaEpm1bpY9XvhxuWJRldC7Mt03WlZwpjnkZUNa2DMG2EaPj9MGd2l2mofd0hQ7ZSopsXckHxVCUp32fXGdD0ZktrgFUmMqwhcWFjp87RArsD+9bn585IRaSHAKgBL3SZwOTRc8BKg7yYoskp5OJDiiPmF2Sj7ox0siYJ7lJA04EqvzZ9B1xSVt6PlW0IxZgUMJdZYAJuWngLQt9IRuZXmoTEkmci8ZtTXTViUKyasA9FRun5d8z6bfw0gYWm9mmCXxZatQgxfC7I2NVpRYQOxKWppLs4mcgn5NcibgL1K40xYp8CYY5TXEpjcb3LAJ0OZyyg3+2nySm6fjEtzkEz+7VBx3RTb+60z9dma7pkvwO2QQL5HzTtAdpKF7euw/HuzfrosBHy+ZsBimzbQshjWTVMDgez53B5MbjcGbr1ZjdUJOM5O0SLXzJ2R+uOA1dMAVoLsm5zb73JSId8t8Aa1LsAJdoTCrCaw6e3NC2DdFMUXWRg173mysJNOSUNskUJ1cOlXa2LhcbgmSszXYSn9hl3KSxTDjrZ2cbbfbWDyumsh9m3e7zCG7a3ETt+gtI7fx6lEOanZKDVvuA2cjYmt5xNOd2Louz3IQ12UZ2Zo3lkb9cDlvSs6m4Vk5Yqlabs0B97wT7PUuCXQz0Bnt9QxMPTW4iwBtmUlY8hFsHJPlzcQ1xuG75CVK1kXofCUGnU9fg1aVD7kfE9MoabtYkcAvIUYS2op3Hc3TTrDQzIAeojugTVLFolWDR6wFPtY0R66n6HltwjCIawnE2ymresk9NtN+pfUUi0mX6RJLfrh9zMRaRPOqubSA8W2MNzC0mHpK7j2ruuw5mYkxl5+2+HGQeg4yNYg7vNg+xMxFsuRMuiTsRJZG3cysAl4D9n4aC4un8L9qUyVvbCyYwFXX1nGUxFf1cCiEQqy75O+TpMwYKNKSPQUqhLyyWLsRbESLctx0YnixgfphRWA8pOPc+N4F9d+eV9V4OlCX/As5w5g+wtGhJGukp5go2R3D7EW9rSDcnGL56YgJHj+8GcFND/Vy41jj/H0jxc6HU/AA2QlR01UlH3D7CmITQnJq4lVWBi1yl8XYEh278c5H++F+Iui7r7bYR8tH/gbqoJN7fVODUhLYVVxzmYCEyOxFg7RUVa0egCHZZ55eRHnp/tKgMna6s/bbMdTxZgMzl9CCcmq7k690OzDfaeSN4QcsREjsQpgXHwyWyfg9K5WE7hc6JqTWjyihObfygOFOkv6i5K5TZx8LsL1sVS4NL8ItiB7sgAcEKcWHfUCVhK3kUVnBNbfXIs4l5xAv5sJs234eTUy93L0Au2otQOw5ORMyfQ6WwexFupVSHowG6uThXfebmlhWojMS3fazmMeGxEI6S2SUti6RAo2vKohVuH3qUG5FWm/PjH8kzutgSH5g58xrVwzIbZkxHf7OFjFC+wrMDXcpOqOKX/g01U/XPvVJyxdWsiJblqYmnZoWbDxAcR56X5WPuh4ewcL5PY9JBRUYjc7fzjG6Uc3mHBWbg23X1BLaFHOSnrw4bWiNAXSEWcWRntIignXTP/oDsfKZX66mMbZAPfhviU1AyYmJLYAMZa/QXjUSeIiixpj3UUFtd884KytjN7EjdGNNMbWwtlf3FvbQ4OQtIoYSzbxqVDLXMTxP8jnnbiyKcaJLvueGLD6kXW2sKZov1tpn7hwXf3ZUvq0K2FXOM7Op/Xgb6PhxsWIErYGVuK3WGXWkkwMMZVCVl5kWtax5A6usgemvnx4DelUcYcFC0eIbcbXKzggeyBjeXIhkftaKknJKLtnuSg7KmKQsrH+1nqbmLWY6w/tBGy/8xrruR5SM99LLIjfT/4ZbNZnQEPssIVb21rKTGRIPDagNoLdFMKgcuLc/TF6Bulk6c7ovg4TU+XvS6FNw1tDfVqH9MOPmBDui0hcK6wz744FlDjNe0m3aVldJYagtI6YbF+3ZGPsQHlN1vbeh8lJofqJ+uo9Zi4wXZxKFiXKGxbHT7pNq71oNg4Qi6MviE0FpRVqjGXILYoJ4tCjdYU1rWeMdPLc/ochj3B9pGNGL4NupGPRlUl35KMVxFLNO6ZnxYlBsUPqoMkbUqAb6VhMVKQ7MVT1dYdrL8hzEAcjpmvjHKphgaFb0ZVJZw7dwVD9q5fkgPTRbBxnzmGfgRLQsMCkG+moQdcp6GzzZsL2MGyllvBNGWM9RqMCk26kI7aBK526csVShZTfzid6FEzeiNAGP92jpCPQEbrW7EW5MbZxAz/fN9lg0IbQaaxrQ83/VoKPb/HqJx67Hw+43CDQBPsX0gm6ufXNvH4vP9rZapzx7+Nn+oxZAjfo2caZ3n350c5W6FSEdQ86sNarj3c/jRV+H42AXsdGRBfPPIlnb/mUtxzWXfALn/PmRze2Gud6E/xsXwYtnlsWN8Tc5/oyxjn/jvyJrlY82xLUfWuPr/TqxzuXQZkIP9M7CXiyuP4B4WmsTnNhzinjrD+WO9bRhmdZWLXe4EKRtV5tpN3Hx3s2G+d79/MJf4qff0LnE72kfFEs4ITQvWLMab8C131dP9n9Je1Yx000Nz2jAf+UJwCBchc3NvGR1Qx71XXY2Ww1Jvx7YalzAPkX9rp5E5Z+pv+ja8bE43uN491b9dHO9Xx4lUxziLn21Nai/wXWM6t9vkvtrwAAAABJRU5ErkJggg==' as const;
+		}
+
+		// Return the Sui chains that your wallet supports.
+		get chains() {
+			return SUI_CHAINS;
+		}
+
+		get accounts() {
+			return [account];
+		}
+
+		get features(): StandardConnectFeature & StandardEventsFeature & SuiFeatures {
+			return {
+				'standard:connect': {
+					version: '1.0.0',
+					connect: this.#connect,
+				},
+				'standard:events': {
+					version: '1.0.0',
+					on: this.#on,
+				},
+				'sui:signPersonalMessage': {
+					version: '1.0.0',
+					signPersonalMessage: this.#signPersonalMessage,
+				},
+				'sui:signTransactionBlock': {
+					version: '1.0.0',
+					signTransactionBlock: this.#signTransactionBlock,
+				},
+				'sui:signAndExecuteTransactionBlock': {
+					version: '1.0.0',
+					signAndExecuteTransactionBlock: this.#signAndExecuteTransactionBlock,
+				},
+			};
+		}
+
+		#on: StandardEventsOnMethod = () => {
+			return () => {};
+		};
+
+		#connect: StandardConnectMethod = async () => {
+			return { accounts: this.accounts };
+		};
+
+		#signPersonalMessage: SuiSignPersonalMessageMethod = async (messageInput) => {
+			const { bytes, signature } = await keypair.signPersonalMessage(messageInput.message);
+			return { bytes, signature };
+		};
+
+		#signTransactionBlock: SuiSignTransactionBlockMethod = async (transactionInput) => {
+			const { bytes, signature } = await transactionInput.transactionBlock.sign({
+				client: suiClient,
+				signer: keypair,
+			});
+
+			return {
+				transactionBlockBytes: bytes,
+				signature: signature,
+			};
+		};
+
+		#signAndExecuteTransactionBlock: SuiSignAndExecuteTransactionBlockMethod = async (
+			transactionInput,
+		) => {
+			return await suiClient.signAndExecuteTransactionBlock({
+				signer: keypair,
+				transactionBlock: transactionInput.transactionBlock,
+				options: transactionInput.options,
+				requestType: transactionInput.requestType,
+			});
+		};
+	}
+
+	return walletsApi.register(new UnsafeBurnerWallet());
+}

package/src/hooks/wallet/useWalletPropertiesChanged.ts

@@ -0,0 +1,29 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import { useEffect } from 'react';
+
+import { useCurrentWallet } from './useCurrentWallet.js';
+import { useWalletStore } from './useWalletStore.js';
+
+/**
+ * Internal hook for easily handling various changes in properties for a wallet.
+ */
+export function useWalletPropertiesChanged() {
+	const currentWallet = useCurrentWallet();
+	const updateWalletAccounts = useWalletStore((state) => state.updateWalletAccounts);
+
+	useEffect(() => {
+		const unsubscribeFromEvents = currentWallet?.features['standard:events'].on(
+			'change',
+			({ accounts }) => {
+				// TODO: We should handle features changing that might make the list of wallets
+				// or even the current wallet incompatible with the dApp.
+				if (accounts) {
+					updateWalletAccounts(accounts);
+				}
+			},
+		);
+		return unsubscribeFromEvents;
+	}, [currentWallet?.features, updateWalletAccounts]);
+}

package/src/hooks/wallet/useWalletStore.ts

@@ -0,0 +1,18 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import { useContext } from 'react';
+import { useStore } from 'zustand';
+
+import { WalletContext } from '../../contexts/walletContext.js';
+import type { StoreState } from '../../walletStore.js';
+
+export function useWalletStore<T>(selector: (state: StoreState) => T): T {
+	const store = useContext(WalletContext);
+	if (!store) {
+		throw new Error(
+			'Could not find WalletContext. Ensure that you have set up the WalletProvider.',
+		);
+	}
+	return useStore(store, selector);
+}

package/src/hooks/wallet/useWallets.ts

@@ -0,0 +1,11 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import { useWalletStore } from './useWalletStore.js';
+
+/**
+ * Retrieves a list of registered wallets available to the dApp sorted by preference.
+ */
+export function useWallets() {
+	return useWalletStore((state) => state.wallets);
+}

package/src/hooks/wallet/useWalletsChanged.ts

@@ -0,0 +1,40 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import type { WalletWithRequiredFeatures } from '@mysten/wallet-standard';
+import { getWallets } from '@mysten/wallet-standard';
+import { useEffect } from 'react';
+
+import { getRegisteredWallets } from '../../utils/walletUtils.js';
+import { useWalletStore } from './useWalletStore.js';
+
+/**
+ * Internal hook for easily handling the addition and removal of new wallets.
+ */
+export function useWalletsChanged(
+	preferredWallets: string[],
+	requiredFeatures: (keyof WalletWithRequiredFeatures['features'])[],
+) {
+	const setWalletRegistered = useWalletStore((state) => state.setWalletRegistered);
+	const setWalletUnregistered = useWalletStore((state) => state.setWalletUnregistered);
+
+	useEffect(() => {
+		const walletsApi = getWallets();
+
+		const unsubscribeFromRegister = walletsApi.on('register', () => {
+			setWalletRegistered(getRegisteredWallets(preferredWallets, requiredFeatures));
+		});
+
+		const unsubscribeFromUnregister = walletsApi.on('unregister', (unregisteredWallet) => {
+			setWalletUnregistered(
+				getRegisteredWallets(preferredWallets, requiredFeatures),
+				unregisteredWallet,
+			);
+		});
+
+		return () => {
+			unsubscribeFromRegister();
+			unsubscribeFromUnregister();
+		};
+	}, [preferredWallets, requiredFeatures, setWalletRegistered, setWalletUnregistered]);
+}

package/src/index.ts

@@ -0,0 +1,21 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+export * from './hooks/useSuiClient.js';
+export * from './components/ConnectButton.js';
+export * from './components/SuiClientProvider.js';
+export * from './components/WalletProvider.js';
+export * from './hooks/wallet/useCurrentAccount.js';
+export * from './hooks/wallet/useCurrentWallet.js';
+export * from './hooks/wallet/useWallets.js';
+export * from './hooks/wallet/useAccounts.js';
+export * from './hooks/wallet/useSwitchAccount.js';
+export * from './hooks/wallet/useConnectWallet.js';
+export * from './hooks/wallet/useDisconnectWallet.js';
+export * from './hooks/wallet/useSignPersonalMessage.js';
+export * from './hooks/wallet/useSignTransactionBlock.js';
+export * from './hooks/wallet/useSignAndExecuteTransactionBlock.js';
+export * from './hooks/useSuiClientMutation.js';
+export * from './hooks/useSuiClientQuery.js';
+export * from './hooks/useSuiClientInfiniteQuery.js';
+export * from './types.js';

package/src/types/utilityTypes.ts

@@ -0,0 +1,4 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<T>;

package/src/types.ts

@@ -0,0 +1,4 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+export type { SignedPersonalMessage, SignedTransactionBlock } from '@mysten/wallet-standard';

package/src/utils/assertUnreachable.ts

@@ -0,0 +1,9 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * Utility for compile-time exhaustiveness checking.
+ */
+export function assertUnreachable(value: never): never {
+	throw new Error(`ERROR! Encountered an unexpected value: ${value}`);
+}

package/src/utils/walletUtils.ts

@@ -0,0 +1,32 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import type {
+	MinimallyRequiredFeatures,
+	Wallet,
+	WalletWithFeatures,
+} from '@mysten/wallet-standard';
+import { getWallets, isWalletWithRequiredFeatureSet } from '@mysten/wallet-standard';
+
+export function getRegisteredWallets<AdditionalFeatures extends Wallet['features']>(
+	preferredWallets: string[],
+	requiredFeatures?: (keyof AdditionalFeatures)[],
+) {
+	const walletsApi = getWallets();
+	const wallets = walletsApi.get();
+
+	const suiWallets = wallets.filter(
+		(wallet): wallet is WalletWithFeatures<MinimallyRequiredFeatures & AdditionalFeatures> =>
+			isWalletWithRequiredFeatureSet(wallet, requiredFeatures),
+	);
+
+	return [
+		// Preferred wallets, in order:
+		...(preferredWallets
+			.map((name) => suiWallets.find((wallet) => wallet.name === name))
+			.filter(Boolean) as WalletWithFeatures<MinimallyRequiredFeatures & AdditionalFeatures>[]),
+
+		// Wallets in default order:
+		...suiWallets.filter((wallet) => !preferredWallets.includes(wallet.name)),
+	];
+}