- ❤️🩹 Allow Starknet dApps and wallets to seamlessly connect
- 🪶 Lightweight and easy to use
- 🏎 Fast integration, building and testing
- ⚙️ Customizable and extensible
- 🌍 Open source and controlled by the community
# using npm
npm install @starknet-io/get-starknet starknet@next
# using yarn
yarn add @starknet-io/get-starknet starknet@next
# using pnpm
pnpm add @starknet-io/get-starknet starknet@next
Read more about the new Starkent Dapp<>Wallet API in the post
You can use the built-in UI to connect to any Starknet wallet as fast as possible like this:
import { connect, disconnect } from "get-starknet"
return <button onClick={() => connect()}>Connect wallet</button>
You can also choose to customize the UI by overwriting the CSS classes, or by
implementing your very own UI. This is possible due to a split into a core
and
ui
package. As a library author or dapp developer who wants to implement a
custom UI, you can use the core
package.
import {
disconnect,
enable,
getAvailableWallets,
getDiscoveryWallets,
getLastConnectedWallet,
getPreAuthorizedWallets,
} from "get-starknet-core"
interface GetStarknetResult {
// Returns all wallets available in the window object
getAvailableWallets: (
options?: GetWalletOptions,
) => Promise<StarknetWindowObject[]>
// Returns only preauthorized wallets available in the window object
getPreAuthorizedWallets: (
options?: GetWalletOptions,
) => Promise<StarknetWindowObject[]>
// Returns all wallets in existence (from discovery file)
getDiscoveryWallets: (options?: GetWalletOptions) => Promise<WalletProvider[]>
// Returns the last wallet connected when it's still connected
getLastConnectedWallet: () => Promise<StarknetWindowObject | null>
// Connects to a wallet
enable: (
wallet: StarknetWindowObject,
options?: {
starknetVersion?: "v4" | "v5"
},
) => Promise<ConnectedStarknetWindowObject>
// Disconnects from a wallet
disconnect: (options?: { clearLastWallet?: boolean }) => Promise<void>
}
You need Node and pnpm installed. Make sure to clone this repo and run:
pnpm install
pnpm build
To start watching for changes, run:
pnpm dev
and open http://localhost:5173/
For running tests:
pnpm test