wrappedsdk

TypeScript SDK for the Stacks Wrapped on-chain registry.

Installation

npm install wrappedsdk
# or
pnpm add wrappedsdk

Quick Start

import { WrappedClient } from 'wrappedsdk';

const client = new WrappedClient({
  contractAddress: 'SP2...',
  contractName: 'wrapped-registry',
  network: 'mainnet',
});

// Fetch enriched live metrics for any address
const state = await client.getLiveState('SP1ABCDEF...');
console.log(state.totalTransactions);     // 342
console.log(state.elapsedSinceFirst);     // "2y 3m"
console.log(state.successRate);           // 97.08

// Claim a wrapped card (requires private key)
const txId = await client.submitAction('claim-wrapped-card', process.env.PRIVATE_KEY!);
console.log('Transaction ID:', txId);

API

new WrappedClient(config)

| Option | Type | Description | |---|---|---| | contractAddress | string | Stacks contract deployer address | | contractName | string | Contract name | | network | 'mainnet' \| 'testnet' | Network target | | hiroApiBase | string? | Override the default Hiro API base URL |

client.getLiveState(address)

Returns a LiveMetrics object with full parsed stats plus computed elapsedSinceFirst and blockEstimate.

client.getUserStats(address)

Returns raw WrappedUserStats without live computations.

client.submitAction(functionName, privateKey)

Builds, signs, and broadcasts a no-arg contract call. Returns the transaction ID.

License

MIT