@solana-mobile/wallet-adapter-mobile

This is a plugin for use with @solana/wallet-adapter. It enables apps to use a native wallet app on a mobile device to sign messages and transactions, and to send transactions if the wallet offers support for sending transactions.

Usage

Create an instance of the mobile wallet adapter like this.

1new SolanaMobileWalletAdapter({
2    addressSelector: createDefaultAddressSelector(),
3    appIdentity: {
4        name: 'My app',
5        uri: 'https://myapp.io',
6        icon: 'relative/path/to/icon.png',
7    },
8    authorizationResultCache: createDefaultAuthorizationResultCache(),
9});

Use that adapter instance alongside the other adapters used by your app.

1const wallets = useMemo(() => [
2    new SolanaMobileWalletAdapter({
3        addressSelector: createDefaultAddressSelector(),
4        appIdentity: {
5            name: 'My app',
6            uri: 'https://myapp.io',
7            icon: 'relative/path/to/icon.png',
8       },
9        authorizationResultCache: createDefaultAuthorizationResultCache(),
10    });
11    new PhantomWalletAdapter(),
12    /* ... other wallets ... */
13]);
14
15return (
16    <ConnectionProvider endpoint={clusterApiUrl(WalletAdapterNetwork.Devnet)}>
17        <WalletProvider wallets={wallets}>
18            <MyApp />
19        </WalletProvider>
20    </ConnectionProvider>
21)

For more information about how to use wallet adapter plugins, visit https://github.com/solana-labs/wallet-adapter

Configuration

App identity

The AppIdentity config identifies your app to a native mobile wallet. When someone connects to a wallet for the first time, the wallet may present this information in the on-screen prompt where the ask if the visitor would like to authorize your app for use with their account.

• name – The plain-language name of your application.
• uri – The uri of your application. This uri may be required to participate in dApp identity verification as part of the mobile wallet adapter protocol specification.
• icon – An icon file path, relative to the uri.

Authorization result cache

The first time that someone authorizes a native wallet app for use with your application, you should cache that authorization for future use. You can supply your own implementation that conforms to the AuthorizationResultCache interface.

1export interface AuthorizationResultCache {
2    clear(): Promise<void>;
3    get(): Promise<AuthorizationResult | undefined>;
4    set(authorizationResult: AuthorizationResult): Promise<void>;
5}

Alternatively, you can use the included createDefaultAuthorizationResultCache() method to create a cache that reads and writes the adapter's last-obtained AuthorizationResult to your browser's local storage, if available.