Skip to main content

Installation

npm​

npm install shadowfeed-agent

yarn​

yarn add shadowfeed-agent

pnpm​

pnpm add shadowfeed-agent

Requirements​

  • Node.js 18 or later
  • TypeScript 5.0+ (optional but recommended)

Dependencies​

The SDK automatically installs these dependencies:

PackagePurpose
axiosHTTP client for API requests
x402-stacksx402 payment protocol for Stacks blockchain

Verify Installation​

import { ShadowFeed } from 'shadowfeed-agent';

const sf = new ShadowFeed({
  privateKey: 'your-private-key-hex',
  network: 'mainnet',
});

// Should log your SP... address
console.log(sf.address);

TypeScript Support​

The SDK ships with full TypeScript declarations. All types are exported:

import type {
  ShadowFeedConfig,
  FeedId,
  FeedInfo,
  PurchaseResult,
  ChainResult,
  DiscoverOptions,
} from 'shadowfeed-agent';