Installation - Sinker

Requirements

Node.js 18 or later
The Sinker Rust sidecar running on localhost:7777 (see the repo README)
An API key for your chosen model provider (OPENAI_API_KEY, ANTHROPIC_API_KEY, GROQ_API_KEY, or XAI_API_KEY)

Install

npm
pnpm
yarn

npm install sinker-sdk

pnpm add sinker-sdk

yarn add sinker-sdk

ESM

The SDK is published as native ESM ("type": "module"). If you’re using CommonJS, import it with a dynamic import():

// ESM (recommended)
import { Sinker } from 'sinker-sdk';

// CommonJS
const { Sinker } = await import('sinker-sdk');

TypeScript

Full .d.ts declarations are included. No @types/ package needed. Requires "moduleResolution": "NodeNext" (or "Bundler") in your tsconfig.json:

{
  "compilerOptions": {
    "module": "NodeNext",
    "moduleResolution": "NodeNext"
  }
}

Verify the connection

import { Sinker } from 'sinker-sdk';

const sinker = new Sinker({
  model: {
    provider: 'anthropic',
    apiKey: process.env.ANTHROPIC_API_KEY!,
  },
});

const tip = await sinker.getTip();
console.log('p50 tip:', tip.p50_lamports, 'lamports');

const state = await sinker.getSlot();
console.log('current slot:', state.slot, 'leader:', state.leader);

sinker.destroy();

If the sidecar isn’t running you’ll get a SinkerError: Request failed: fetch failed — start the sidecar first with sinker start from the sinker/ directory.