hyperkit
v0.1.0
Published
Multi-chain blockchain SDK with interactive CLI for EVM and Layer 1 blockchains
Maintainers
Readme
HyperKit SDK
Multi-chain blockchain SDK with interactive CLI for seamless DeFi operations across EVM and Layer 1 blockchains.
Features
- 🎯 Interactive CLI - Easy blockchain selection via terminal
- 🌉 Bridge - Cross-chain token transfers
- 💱 Swap - Decentralized token exchange
- 🔒 Staking - Stake tokens for rewards
- 💧 Faucet - Get testnet tokens
- ⚡ Multi-Chain - Support for Layer 1 (Sui, Aptos) and Layer 2 (Metis, Mantle)
Installation
npm install hyperionkitCLI Usage
Run the interactive CLI to select your blockchain:
npx hyperkit-sdkOr if installed globally:
npm install -g hyperkit-sdk
hyperkit-sdkCLI Features
The CLI provides an interactive menu to:
- Select between Layer 1 (Sui, Aptos) or Layer 2 (Metis, Mantle) blockchains
- Choose specific blockchain operations (Bridge, Swap, Staking, Faucet)
- View contract addresses and network information
Currently Active:
- ✅ Metis - Full DeFi operations support
Coming Soon:
- ⏳ Sui - Layer 1 blockchain support
- ⏳ Aptos - Layer 1 blockchain support
- ⏳ Mantle - Layer 2 blockchain support
React SDK Usage
For building DeFi applications with React:
import {
HyperkitProvider,
ConnectWallet,
Bridge,
Swap,
Staking,
Faucet,
} from "hyperionkit";
function App() {
return (
<HyperkitProvider defaultNetwork="metis-hyperion-testnet">
<ConnectWallet />
<Bridge />
<Swap />
<Staking />
<Faucet />
</HyperkitProvider>
);
}Supported Networks
Layer 2 (EVM)
Metis Hyperion Testnet
- Chain ID: 133717 (0x20A55)
- RPC: https://hyperion-testnet.metisdevops.link
- Explorer: https://hyperion-testnet-explorer.metisdevops.link
Metis Sepolia
- Chain ID: 59902 (0xE9FE)
- RPC: https://metis-sepolia-rpc.publicnode.com
Layer 1
- Sui - Coming Soon
- Aptos - Coming Soon
Contract Addresses (Metis Hyperion Testnet)
| Contract | Address |
| --------------- | -------------------------------------------- |
| Bridge | 0xfF064Fd496256e84b68dAE2509eDA84a3c235550 |
| Liquidity Pool | 0x91C39DAA7617C5188d0427Fc82e4006803772B74 |
| Staking Rewards | 0xB94d264074571A5099C458f74b526d1e4EE0314B |
| Faucet | 0xE1B8C7168B0c48157A5e4B80649C5a1b83bF4cC4 |
Token Addresses (Metis Hyperion Testnet)
| Token | Address |
| ----- | -------------------------------------------- |
| USDT | 0x9b52D326D4866055F6c23297656002992e4293FC |
| USDC | 0x31424DB0B7a929283C394b4DA412253Ab6D61682 |
| DAI | 0xdE896235F5897EC6D13Aa5b43964F9d2d34D82Fb |
| WETH | 0xc8BB7DB0a07d2146437cc20e1f3a133474546dD4 |
API Reference
Components
<HyperkitProvider>
Wraps your app and provides blockchain context.
<HyperkitProvider defaultNetwork="metis-hyperion-testnet">
{children}
</HyperkitProvider><ConnectWallet>
Wallet connection button with network switching.
<Bridge>
Cross-chain bridge interface for token transfers.
<Swap>
Token swap interface with liquidity pool integration.
<Staking>
Staking interface for earning rewards.
<Faucet>
Testnet token faucet for development.
Hooks
useWallet()
Access wallet state and functions.
const { wallet, connectWallet, disconnectWallet, switchNetwork } = useWallet();Actions
createBlockchainActions(provider, signer)
Create blockchain action instance for programmatic interactions.
import { createBlockchainActions } from "hyperionkit";
const actions = createBlockchainActions(provider, signer);
// Get token balance
const balance = await actions.getTokenBalance("USDT", userAddress);
// Swap tokens
await actions.swapTokens("USDT", "USDC", "100", expectedOut, recipient, 0.5);
// Stake tokens
await actions.stakeTokens("1000");Development
# Install dependencies
pnpm install
# Build package
pnpm build
# Run demo
pnpm demo:install
pnpm demoLicense
ISC
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
