Connect SDK

Appearance

@swapped/connect-sdk / react / UseWalletResult

Type Alias: UseWalletResult ​

UseWalletResult = object

Defined in: src/react/wallets/hooks/useWallet.ts:19

Properties ​

cancelPairing ​

cancelPairing: () => Promise<boolean>

Defined in: src/react/wallets/hooks/useWallet.ts:39

Returns ​

Promise<boolean>

connect ​

connect: (request?) => Promise<WalletConnection | null>

Defined in: src/react/wallets/hooks/useWallet.ts:29

Parameters ​

request? ​

UseWalletConnectRequest

Returns ​

Promise<WalletConnection | null>

connections ​

connections: WalletConnection[]

Defined in: src/react/wallets/hooks/useWallet.ts:24

Connected instances of this provider.

disconnect ​

disconnect: (walletId?) => Promise<void>

Defined in: src/react/wallets/hooks/useWallet.ts:34

Disconnect this provider. Pass walletId to drop one instance; omit it to disconnect every instance.

Parameters ​

walletId? ​

WalletId

Returns ​

Promise<void>

error ​

error: string | null

Defined in: src/react/wallets/hooks/useWallet.ts:28

Last error for this provider, or null.

getDeepLinkUrl ​

getDeepLinkUrl: () => string | null

Defined in: src/react/wallets/hooks/useWallet.ts:37

Returns ​

string | null

isConnected ​

isConnected: boolean

Defined in: src/react/wallets/hooks/useWallet.ts:25

isConnecting ​

isConnecting: boolean

Defined in: src/react/wallets/hooks/useWallet.ts:26

openDeepLink: () => string | null

Defined in: src/react/wallets/hooks/useWallet.ts:38

Returns ​

string | null

pairingDeeplinkUrl ​

pairingDeeplinkUrl: string | null

Defined in: src/react/wallets/hooks/useWallet.ts:43

Current WalletConnect mobile deep link while this provider is pairing, or null.

pairingUri ​

pairingUri: string | null

Defined in: src/react/wallets/hooks/useWallet.ts:41

Current WalletConnect URI while this provider is pairing, or null.

provider ​

provider: IntegrationProvider

Defined in: src/react/wallets/hooks/useWallet.ts:20

requiresDeepLink: boolean

Defined in: src/react/wallets/hooks/useWallet.ts:35

supportsWalletConnect ​

supportsWalletConnect: boolean

Defined in: src/react/wallets/hooks/useWallet.ts:36

wallet ​

wallet: AvailableWallet | null

Defined in: src/react/wallets/hooks/useWallet.ts:22

Availability for this provider, or null if it is not in the wallet list.