@glazeen/chain-sdk
v0.0.3
Published
TypeScript SDK for Glazeen CHAIN API
Readme
Glazeen CHAIN SDK
Official TypeScript SDK for [Glazeen CHAIN]
Installation
npm install @glazeen/chain-sdkQuick Start
import { ChainClient } from "@glazeen/chain-sdk";
// Optional: Define your metadata schema for full type safety
interface MyMetrics {
tokens: number;
model: string;
}
const chain = new ChainClient<MyMetrics>({
apiKey: "sk_live_...",
projectId: "proj_abc123"
});
// Detract credits with type-safe metadata
await chain.wallets.detract("user_key_1", 10, {
tokens: 1500,
model: "claude-3-opus"
});API Reference
ChainClient<TMetadata>
The main entry point for the SDK.
Constructor
new ChainClient(config: ChainConfig)Config Options:
apiKey: Your project API secret.projectId: Your project ID.baseUrl: (Optional) Custom API endpoint. Defaults tohttps://chain.glazeen.ai/api/v1.
wallets
getBalance(userKey: string)
Returns the current balance for a specific user.
Returns: Promise<{ balance_gc: string }>
detract(userKey: string, amount: number, metadata?: TMetadata)
Deducts credits from a user's wallet.
Returns: Promise<TransactionResult>
refill(userKey: string, amount: number, metadata?: TMetadata)
Adds credits to a user's wallet.
Returns: Promise<TransactionResult>
Types
TransactionResult
interface TransactionResult {
status: "completed" | "pending" | "failed";
transaction_id: string;
amount_gc: string;
remaining_balance_gc: string;
}Metadata
type Metadata = Record<string, unknown>;License
MIT © Glazeen
