Skip to main content

Documentation Index

Fetch the complete documentation index at: https://companyname-a7d5b98e-feature-fumodocs.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

walletsRequiredFeatures limits the wallet picker to wallets that advertise the capabilities your dApp depends on. The SDK compares each wallet’s advertised features against the option and removes any wallet that does not match. For the protocol-level feature catalogue, see Feature specification.

​
With TonConnectUI

import { TonConnectUI } from '@tonconnect/ui';

const tonConnectUi = new TonConnectUI({
    manifestUrl: 'https://example.com/tonconnect-manifest.json',
    walletsRequiredFeatures: {
        sendTransaction: {
            minMessages: 1,
            itemTypes: ['ton', 'jetton']
        },
        signData: {
            types: ['text', 'binary', 'cell']
        },
        signMessage: {
            minMessages: 1
        },
        embeddedRequest: {}
    }
});

​
With TonConnectUIProvider (React)

import { TonConnectUIProvider } from '@tonconnect/ui-react';

function App() {
    return (
        <TonConnectUIProvider
            manifestUrl="https://example.com/tonconnect-manifest.json"
            walletsRequiredFeatures={{
                sendTransaction: {
                    minMessages: 1,
                    itemTypes: ['ton', 'jetton']
                },
                signData: {
                    types: ['text', 'binary', 'cell']
                },
                signMessage: {
                    minMessages: 1
                },
                embeddedRequest: {}
            }}
        >
            {/* your app */}
        </TonConnectUIProvider>
    );
}

​
How matching works

A wallet matches when it advertises every requirement listed. Top-level keys combine as a logical AND — declaring sendTransaction and signMessage requires both. For each filter the SDK compares your declaration to the wallet’s Feature entry:
  • minMessages — the wallet’s maxMessages must be greater than or equal to this value.
  • extraCurrencyRequired: true — matches only wallets whose feature has extraCurrencySupported: true.
  • itemTypes — every requested type must appear in the wallet’s itemTypes.
  • signData.types — every requested type must appear in the wallet’s types.
  • embeddedRequest — matches any wallet that exposes the EmbeddedRequest feature; the entry takes no parameters.

​
How filtered wallets appear in the modal

The main connect screen shows only matching wallets. The full “Wallets” list places matching wallets first and unsupported wallets below a separator. With walletsRequiredFeatures set, unsupported entries appear greyed out. Clicking one shows a brief error notification rather than starting the connection. If a wallet’s advertised features turn out to be insufficient at connect time, the SDK throws WalletMissingRequiredFeaturesError and the modal switches to an unsupported-wallet view. The “View all wallets” screen with no filter, with walletsRequiredFeatures and with walletsPreferredFeatures:

​
Available filters

type RequiredFeatures = {
    sendTransaction?: {
        minMessages?: number;             // wallet's maxMessages must be ≥ this
        extraCurrencyRequired?: boolean;  // wallet must set extraCurrencySupported
        itemTypes?: ('ton' | 'jetton' | 'nft')[];
    };
    signData?: {
        types: ('text' | 'binary' | 'cell')[]; // every requested type must be supported
    };
    signMessage?: {
        minMessages?: number;
        extraCurrencyRequired?: boolean;
        itemTypes?: ('ton' | 'jetton' | 'nft')[];
    };
    embeddedRequest?: {};                 // wallet must expose EmbeddedRequest
};
signData.types is required when signData is present; the other sub-fields are optional. The type is exported as RequiredFeatures from @tonconnect/sdk and re-exported by @tonconnect/ui and @tonconnect/ui-react.
Note. A sibling option walletsPreferredFeatures accepts the same shape and applies a softer policy. The main connect screen still hides unsupported wallets, but in the full “Wallets” list they appear without the disabled style — clicking one attempts a normal connection. Unlike walletsRequiredFeatures, the SDK does not enforce the match at connect time, so the dApp is responsible for handling missing features itself.

​
See also