A collection of React hooks and components for interacting with the Sui blockchain and wallets.
npm install @mysten/dapp-kitThe Sui dApp Kit is a set of React components, hooks, and utilities that make it easy to build a
dApp for the Sui ecosystem. It provides hooks and components for querying data from the Sui
blockchain, and connecting to Sui wallets.
See https://sdk.mystenlabs.com/sui for full documentation
- Query Hooks: dApp Kit provides a set of hooks for making rpc calls to the Sui blockchain,
making it easy to load any information needed for your dApp.
- Automatic Wallet State Management: dApp Kit removes the complexity of state management related
to wallet connections. You can focus on building your dApp.
- Supports all Sui wallets: No need to manually define wallets you support. All Sui wallets are
automatically supported.
- Easy to integrate: dApp Kit provides pre-built React Components that you can drop right into
your dApp, for easier integration
- Flexible: dApp Kit ships both fully functional React Component, and lower level hooks that you
can use to build your own custom components.
To use the Sui dApp Kit in your project, run the following command in your project root:
``sh npm2yarn`
npm i --save @mysten/dapp-kit @mysten/sui @tanstack/react-query
To be able to use the hooks and components in the dApp Kit, you need to wrap your app with a couple
providers. The props available on the providers are covered in more detail in their respective docs
pages.
`tsx
import { createNetworkConfig, SuiClientProvider, WalletProvider } from '@mysten/dapp-kit';
import { getJsonRpcFullnodeUrl, type SuiClientOptions } from '@mysten/sui/jsonRpc';
import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
// Config options for the networks you want to connect to
const { networkConfig } = createNetworkConfig({
localnet: { url: getJsonRpcFullnodeUrl('localnet') },
mainnet: { url: getJsonRpcFullnodeUrl('mainnet') },
});
const queryClient = new QueryClient();
function App() {
return (
);
}
`
The dApp Kit provides a set of flexible UI components that can be used to connect and manage wallet
accounts from your dApp. The components are built on top of
Radix UI and are customizable so you can quickly get your
dApp up and running.
To use our provided UI components, you will need to import the dApp Kit's CSS stylesheet into your
dApp as shown below. For more information regarding customization options, check out the respective
documentation pages for the components and themes.
`tsx`
import '@mysten/dapp-kit/dist/index.css';
The dApp Kit provides a set of hooks for making RPC calls to the Sui blockchain. The hooks are thin
wrappers around useQuery from @tanstack/react-query. For more comprehensive documentation on how
these query hooks can be used, check out the
react-query docs.
`tsx
import { useSuiClientQuery } from '@mysten/dapp-kit';
function MyComponent() {
const { data, isPending, error, refetch } = useSuiClientQuery('getOwnedObjects', {
owner: '0x123',
});
if (isPending) {
return
return
{JSON.stringify(data, null, 2)};