get-starknet

Goals

• ❤️‍🩹 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

Installation

# using npm
npm install get-starknet starknet@next

# using yarn
yarn add get-starknet starknet@next

# using pnpm
pnpm add get-starknet starknet@next

Usage for dApp developers

You can use the built-in UI to connect to any Starknet wallet as fast as possible like this:

1import { connect, disconnect } from "get-starknet"
2
3return <button onClick={() => connect()}>Connect wallet</button>

Advanced usage

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.

1import {
2  disconnect,
3  enable,
4  getAvailableWallets,
5  getDiscoveryWallets,
6  getLastConnectedWallet,
7  getPreAuthorizedWallets,
8} from "get-starknet-core"
9
10interface GetStarknetResult {
11  // Returns all wallets available in the window object
12  getAvailableWallets: (
13    options?: GetWalletOptions,
14  ) => Promise<StarknetWindowObject[]>
15  // Returns only preauthorized wallets available in the window object
16  getPreAuthorizedWallets: (
17    options?: GetWalletOptions,
18  ) => Promise<StarknetWindowObject[]>
19  // Returns all wallets in existence (from discovery file)
20  getDiscoveryWallets: (options?: GetWalletOptions) => Promise<WalletProvider[]>
21  // Returns the last wallet connected when it's still connected
22  getLastConnectedWallet: () => Promise<StarknetWindowObject | null>
23  // Connects to a wallet
24  enable: (
25    wallet: StarknetWindowObject,
26    options?: {
27      starknetVersion?: "v4" | "v5"
28    },
29  ) => Promise<ConnectedStarknetWindowObject>
30  // Disconnects from a wallet
31  disconnect: (options?: { clearLastWallet?: boolean }) => Promise<void>
32}

Development

You need Node and pnpm installed. Make sure to clone this repo and run:

1pnpm install
2pnpm build

To start watching for changes, run:

1pnpm dev

and open http://localhost:5173/

Running tests

For running tests:

1pnpm test