-
Notifications
You must be signed in to change notification settings - Fork 911
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
A series of Solana React hooks for Wallet Standard wallets (#2772)
- Loading branch information
1 parent
4a9b544
commit 8fe4551
Showing
13 changed files
with
873 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| '@solana/react': patch | ||
| --- | ||
|
|
||
| Added a series of React hooks to which you can pass a Wallet Standard `UiWalletAccount` to extract its `signMessage`, `signTransaction`, and `signAndSendTransaction` features |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
135 changes: 135 additions & 0 deletions
135
packages/react/src/__tests__/useSignAndSendTransaction-test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| import type { Wallet, WalletAccount, WalletVersion } from '@wallet-standard/base'; | ||
| import { | ||
| WALLET_STANDARD_ERROR__FEATURES__WALLET_ACCOUNT_CHAIN_UNSUPPORTED, | ||
| WALLET_STANDARD_ERROR__FEATURES__WALLET_ACCOUNT_FEATURE_UNIMPLEMENTED, | ||
| WalletStandardError, | ||
| } from '@wallet-standard/errors'; | ||
| import type { UiWalletAccount } from '@wallet-standard/ui'; | ||
| import { | ||
| getWalletAccountForUiWalletAccount_DO_NOT_USE_OR_YOU_WILL_BE_FIRED, | ||
| getWalletForHandle_DO_NOT_USE_OR_YOU_WILL_BE_FIRED, | ||
| } from '@wallet-standard/ui-registry'; | ||
|
|
||
| import { renderHook } from '../test-renderer'; | ||
| import { useSignAndSendTransaction } from '../useSignAndSendTransaction'; | ||
|
|
||
| jest.mock('@wallet-standard/ui-registry'); | ||
|
|
||
| describe('useSignAndSendTransaction', () => { | ||
| let mockSignAndSendTransaction: jest.Mock; | ||
| let mockUiWalletAccount: { | ||
| address: 'abc'; | ||
| chains: ['solana:danknet']; | ||
| features: ['solana:signAndSendTransaction']; | ||
| publicKey: Uint8Array; | ||
| '~uiWalletHandle': UiWalletAccount['~uiWalletHandle']; | ||
| }; | ||
| let mockWalletAccount: WalletAccount; | ||
| beforeEach(() => { | ||
| mockSignAndSendTransaction = jest.fn().mockResolvedValue([{ signature: 'abc' }]); | ||
| mockUiWalletAccount = { | ||
| address: 'abc', | ||
| chains: ['solana:danknet'] as const, | ||
| features: ['solana:signAndSendTransaction'] as const, | ||
| publicKey: new Uint8Array([1, 2, 3]), | ||
| '~uiWalletHandle': null as unknown as UiWalletAccount['~uiWalletHandle'], | ||
| }; | ||
| mockWalletAccount = { | ||
| address: 'abc', | ||
| chains: ['solana:danknet'] as const, | ||
| features: ['solana:signAndSendTransaction'] as const, | ||
| publicKey: new Uint8Array([1, 2, 3]), | ||
| }; | ||
| const mockWallet: Wallet = { | ||
| accounts: [mockWalletAccount], | ||
| chains: ['solana:danknet'], | ||
| features: { | ||
| ['solana:signAndSendTransaction']: { | ||
| signAndSendTransaction: mockSignAndSendTransaction, | ||
| }, | ||
| }, | ||
| icon: 'data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEAAAAALAAAAAABAAEAAAIBAAA=', | ||
| name: 'Mock Wallet', | ||
| version: '1.0.0' as WalletVersion, | ||
| }; | ||
| jest.mocked(getWalletForHandle_DO_NOT_USE_OR_YOU_WILL_BE_FIRED).mockReturnValue(mockWallet); | ||
| jest.mocked(getWalletAccountForUiWalletAccount_DO_NOT_USE_OR_YOU_WILL_BE_FIRED).mockReturnValue( | ||
| mockWalletAccount, | ||
| ); | ||
| // Suppresses console output when an `ErrorBoundary` is hit. | ||
| // See https://stackoverflow.com/a/72632884/802047 | ||
| jest.spyOn(console, 'error').mockImplementation(); | ||
| jest.spyOn(console, 'warn').mockImplementation(); | ||
| }); | ||
| it('fatals when passed a wallet account that does not support the `solana:signAndSendTransaction` feature', () => { | ||
| const { result } = renderHook(() => | ||
| useSignAndSendTransaction({ ...mockUiWalletAccount, features: ['other:feature'] }, 'solana:danknet'), | ||
| ); | ||
| expect(result.__type).toBe('error'); | ||
| expect(result.current).toEqual( | ||
| new WalletStandardError(WALLET_STANDARD_ERROR__FEATURES__WALLET_ACCOUNT_FEATURE_UNIMPLEMENTED, { | ||
| address: 'abc', | ||
| featureName: 'solana:signAndSendTransaction', | ||
| supportedChains: ['solana:danknet'], | ||
| supportedFeatures: ['other:feature'], | ||
| }), | ||
| ); | ||
| }); | ||
| it('fatals when passed a wallet account that does not support the specified chain', () => { | ||
| const { result } = renderHook(() => | ||
| useSignAndSendTransaction( | ||
| { ...mockUiWalletAccount, chains: ['solana:basednet'] }, | ||
| // @ts-expect-error Using a non-supported chain on purpose, as part of the test. | ||
| 'solana:danknet', | ||
| ), | ||
| ); | ||
| expect(result.__type).toBe('error'); | ||
| expect(result.current).toEqual( | ||
| new WalletStandardError(WALLET_STANDARD_ERROR__FEATURES__WALLET_ACCOUNT_CHAIN_UNSUPPORTED, { | ||
| address: 'abc', | ||
| chain: 'solana:danknet', | ||
| featureName: 'solana:signAndSendTransaction', | ||
| supportedChains: ['solana:basednet'], | ||
| supportedFeatures: ['solana:signAndSendTransaction'], | ||
| }), | ||
| ); | ||
| }); | ||
| it('fatals when the wallet account lookup for the supplied React wallet account fails', () => { | ||
| jest.mocked(getWalletAccountForUiWalletAccount_DO_NOT_USE_OR_YOU_WILL_BE_FIRED).mockImplementation(() => { | ||
| throw 'o no'; | ||
| }); | ||
| const { result } = renderHook(() => useSignAndSendTransaction(mockUiWalletAccount, 'solana:danknet')); | ||
| expect(result.__type).toBe('error'); | ||
| expect(result.current).toBe('o no'); | ||
| }); | ||
| describe('the function returned', () => { | ||
| it("calls the wallet's `signAndSendTransaction` implementation", async () => { | ||
| expect.assertions(2); | ||
| const { result } = renderHook(() => useSignAndSendTransaction(mockUiWalletAccount, 'solana:danknet')); | ||
| // eslint-disable-next-line jest/no-conditional-in-test | ||
| if (result.__type === 'error' || !result.current) { | ||
| throw result.current; | ||
| } else { | ||
| const signAndSendTransaction = result.current; | ||
| signAndSendTransaction({ | ||
| options: { minContextSlot: 123n }, | ||
| transaction: new Uint8Array([1, 2, 3]), | ||
| }); | ||
| await jest.runAllTimersAsync(); | ||
| signAndSendTransaction({ | ||
| options: { minContextSlot: 123n }, | ||
| transaction: new Uint8Array([1, 2, 3]), | ||
| }); | ||
| // eslint-disable-next-line jest/no-conditional-expect | ||
| expect(mockSignAndSendTransaction).toHaveBeenCalledTimes(2); | ||
| // eslint-disable-next-line jest/no-conditional-expect | ||
| expect(mockSignAndSendTransaction).toHaveBeenCalledWith({ | ||
| account: mockWalletAccount, | ||
| chain: 'solana:danknet', | ||
| options: { minContextSlot: 123 }, | ||
| transaction: new Uint8Array([1, 2, 3]), | ||
| }); | ||
| } | ||
| }); | ||
| }); | ||
| }); |
Oops, something went wrong.