Docs/Hyperkit SDK

Hyperkit SDK

A modern React SDK for building decentralized applications with ease. Hyperkit provides high-level components and hooks for wallet connections, token swaps, bridging, staking, and more.

Activev1.0.0

What is Hyperkit SDK?

Hyperkit SDK is a comprehensive React library that simplifies building decentralized applications. It provides pre-built components, hooks, and utilities for common Web3 operations, allowing developers to focus on building features rather than low-level blockchain interactions.

Type Safe

Written entirely in TypeScript with full declaration support, providing excellent developer experience and type safety.

Key Features

Multi-Chain Support

Ready-to-use configurations for popular EVM chains

Pre-built Components

ConnectWallet, Swap, Bridge, Staking, and more

Programmatic API

Use actions API for custom implementations

Modular Styles

Tailwind-compatible CSS that can be easily customized

Quick Start

Get started with Hyperkit SDK in three simple steps:

1. Install the SDK

npm install hyperkit

2. Setup Provider

App.tsx

import { HyperkitProvider } from 'hyperkit';
import 'hyperkit/dist/hyperkit.css';

function App() {
  return (
    <HyperkitProvider>
      <YourAppContent />
    </HyperkitProvider>
  );
}

3. Use Components

Header.tsx

import { ConnectWallet } from 'hyperkit';

function Header() {
  return (
    <header>
      <ConnectWallet />
    </header>
  );
}

Available Components

ConnectWallet

Interactive button for wallet connection and account management

Swap

Token exchange interface with slippage protection

Bridge

Cross-chain bridging interface

Staking

Yield and staking management

Faucet

Testnet token distribution

Container

Layout wrapper for kit components

Next Steps

Getting Started

Install and set up Hyperkit SDK in your project

Components

Explore all available components and their props