Proof-of-Commitment SDK

A lightweight TypeScript wrapper around the Proof-of-Commitment staking and governance contracts. The SDK is designed to be framework-agnostic and works with any viem PublicClient/WalletClient pair.

Installation

``bash
npm install @proof-of-commitment/sdk viem
`

Quick Start

`ts
import { createPublicClient, createWalletClient, http } from 'viem';
import { lisk } from 'viem/chains';
import { ProofOfCommitmentSDK } from '@proof-of-commitment/sdk';

const publicClient = createPublicClient({ chain: lisk, transport: http() });
const walletClient = createWalletClient({ chain: lisk, transport: http(), account });

const sdk = new ProofOfCommitmentSDK({ publicClient, walletClient });

const stats = await sdk.staking.getProtocolStats();
await sdk.staking.stake({ amount: '100', lockDays: 30 });
const proposals = await sdk.governance.listProposals();
`

Packages

- staking – approvals, staking flows, rewards, and protocol stats
- governance – proposal lifecycle helpers and voting power utilities
- analytics – opinionated aggregations (user overview + protocol overview)
- nft – helpers for NFT-backed stake data

Building Locally

`bash
cd sdk
npm install
npm run build
`

This produces ESM + CJS bundles with type declarations inside dist/`.