TypeScript SDK
The @kaizen-core/sdk package provides a complete TypeScript SDK for interacting with Kaizen Core.
Installation
pnpm add @kaizen-core/sdkThe SDK has viem as a peer dependency:
pnpm add viemQuick Start
import { createClient, parseUSDC, formatUSDC } from "@kaizen-core/sdk";
// Create client
const client = createClient({
rpcUrl: "http://localhost:8546",
wsUrl: "ws://localhost:8546/ws", // Optional: for real-time subscriptions
chainId: 1,
});
// Connect a signer
client.connectSigner("0x...");
// Get account info
const account = await client.getMyAccount();
console.log(`Balance: ${formatUSDC(account.balance)} USDC`);
// Send a transfer (high-level API)
const receipt = await client.transfer(
"0xRecipient...",
parseUSDC("100.00"),
{ waitForConfirmation: true }
);
console.log(`Transaction confirmed: ${receipt.hash}`);Features
| Feature | Description |
|---|---|
| Type-safe | Full TypeScript support with complete type definitions |
| EIP-712 | Secure typed data signing (Ethereum standard) |
| Borsh Serialization | Efficient binary encoding compatible with Rust |
| WebSocket | Real-time subscriptions for blocks, orders, and prices |
| Transaction Builders | Helper functions for all transaction types |
SDK Components
- Client - Main client for interacting with Kaizen
- Signer - Transaction signing with EIP-712
- Transactions - Transaction builders and helpers
- WebSocket - Real-time event subscriptions
