API reference
Overview
Every public export, organised by package. Signatures verified against each package entry point.
This reference lists every public export, per package. It's hand-written and
mirrors each package's src/index.ts; nothing here is generated or
speculative.
| Package | Reference |
|---|---|
@usebutr/core | The wallet manager, types, chain registries, persistence, sources |
@usebutr/react | Provider and every hook |
@usebutr/evm | EIP-6963 and injected discovery, the adapter builder, EIP-1193 types |
@usebutr/svm | Wallet Standard discovery, the adapter builder, Solana feature types |
@usebutr/sui | Wallet Standard discovery, the adapter builder, Sui feature types |
@usebutr/bitcoin | Wallet Standard and injected discovery, the adapter builder, feature types |
@usebutr/polkadot | injectedWeb3 and Wallet Standard discovery, adapter builders |
@usebutr/wallets | autoDiscovery() and composed discovery |
@usebutr/walletconnect | createWalletConnectAdapters and namespace builders |
@usebutr/ledger | createLedgerAdapter and the per-platform factories |
@usebutr/wallet-standard-shared | Discovery, the shared adapter core and getFeature, for adapter authors |
@usebutr/testing | Fake adapters, wallets, and persistence |
Signer kinds
getSigner() resolves a WalletSigner, a union tagged by kind. Each
transport package registers its own variant, so a kind is part of the union
once its package is part of your program. @usebutr/wallets loads every
platform package, so an app that imports only it can narrow every browser
wallet's kind; WalletConnect and Ledger kinds come with their packages.
kind | Fields | Registered by |
|---|---|---|
eip1193 | provider: Eip1193Provider | @usebutr/evm |
wallet-standard | wallet: WalletStandardWallet | @usebutr/wallet-standard-shared |
unisat, sats-connect | provider | @usebutr/bitcoin |
polkadot-injected | extension, extensionName: string | @usebutr/polkadot |
walletconnect | chainId: string, provider: UniversalProviderLike | @usebutr/walletconnect |
ledger-evm, ledger-svm, ledger-sui, ledger-bitcoin | app: the device app | @usebutr/ledger |
Which connector yields which kind is on each connector page.