TypeScript SDK¶

The @spilt/sdk package provides a TypeScript client for interacting with BPE smart contracts.

Installation¶

npm install @spilt/sdk

Features¶

Contract ABIs - Pre-compiled ABIs for all BPE contracts
Type-safe interactions - Full TypeScript types via viem
Helper functions - Common operations like capacity signal computation and stream management
Address registry - Deployed contract addresses for supported networks

Usage¶

import { addresses, contracts } from '@spilt/sdk'

// Get contract addresses for Base Sepolia
const { capacityRegistry, backpressurePool, stakeManager } = addresses.baseSepolia

// Use with viem
import { createPublicClient, http } from 'viem'
import { baseSepolia } from 'viem/chains'

const client = createPublicClient({
  chain: baseSepolia,
  transport: http(),
})

// Read smoothed capacity for a sink
const capacity = await client.readContract({
  ...contracts.capacityRegistry,
  functionName: 'getSmoothedCapacity',
  args: [taskTypeId, sinkAddress],
})

Source¶

SDK source code is in sdk/src/.