Wallet Provider

💳 Connecting Wallet Provider

API

<WalletProvider> ... </WalletProvider>
PropertyTypeDescriptionDefault

children

ReactNode

The wrapped children.

undefined

For example

import { WalletProvider } from '@senhub/provider'

// Wrap a paragraph as a child.
<WalletProvider>
  <p>Hello world</p>
</WalletProvider>

Context

type Provider = {
  wallet: State
}

type State = {
  visible: boolean
  address: string
  lamports: bigint
}

Provider

PropertyTypeDescription

wallet

State

The wallet data.

State

PropertyTypeDescription

visible

boolean

Whether the wallet modal is visible.

address

string

The connecting wallet address.

lamports

bigint

The available number of lamports (1 SOL = 1,000,000,000 lamports) in the current wallet.

Hook & HOC

import { useWallet, withWallet } from '@senhub/providers'

For example

Wrap the parent by WalletProvider before accessing the context.

import { useWallet, withWallet } from '@senhub/providers'

// Within a functional component
const Component = () => {
  const {
    wallet: { address, lamports },
  } = useWallet()
}
export default Component

// Within a class component
class Component {
  render() {
    const {
      wallet: { address, lamports },
    } = this.props
  }
}
export default withWallet(Component)

Last updated