@backproto/sdk

TypeScript SDK for the Backproto protocol on Base Sepolia.

Installation

npm install @backproto/sdk

Usage

import { getAddresses } from "@backproto/sdk";
import * as sink from "@backproto/sdk/actions/sink";
import * as pool from "@backproto/sdk/actions/pool";
import * as pricing from "@backproto/sdk/actions/pricing";
import * as lightning from "@backproto/sdk/actions/lightning";
import { createPublicClient, createWalletClient, http } from "viem";
import { baseSepolia } from "viem/chains";
import { privateKeyToAccount } from "viem/accounts";

const addrs = getAddresses(84532); // Base Sepolia
const account = privateKeyToAccount("0x...");

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

// Register as a sink for a task type
await sink.registerSink(walletClient, addrs, taskTypeId, 50n);

// Read the dynamic price
const price = await pricing.getPrice(publicClient, addrs, taskTypeId, account.address);

// Get optimal Lightning route
const route = await lightning.getOptimalRoute(publicClient, addrs, 3);

Modules

Core BPE

| Module | Description | |--------|-------------| | actions/sink | Register/deregister sinks | | actions/source | Register task types, start/stop payment streams | | actions/pool | Create pools, rebalance, read member units | | actions/stake | Stake/unstake tokens, read capacity cap | | actions/buffer | Deposit to / drain from escrow buffer | | actions/pricing | Report queue load, advance pricing epoch, read prices | | actions/completion | Record completions, advance completion epoch | | actions/aggregator | Submit batched off-chain attestations | | signing | EIP-712 signing helpers for attestations and completion receipts |

Domain Extensions

| Module | Description | |--------|-------------| | actions/demurrage | Wrap/unwrap demurrage tokens, rebase, read decay | | actions/relay | Register relays, join pools, set anti-spam minimums | | actions/lightning | Register nodes, join routing pools, get optimal routes | | actions/platform | Aggregate reputation, stake discounts, route attestations |

Examples

• examples/full-flow.ts: 7-step end-to-end demo
• examples/testnet-validation.ts: multi-scenario validation with CSV output

PRIVATE_KEY=0x... npx tsx src/examples/full-flow.ts

Development

npm install
npm run build    # compile TypeScript
npm run lint     # type-check (tsc --noEmit)
npm test         # run tests (vitest)

License

MIT