Docs JavaScript SDK
SDK

JavaScript SDK

Official Node.js SDK for SwiftProof. TypeScript-first with full type definitions included.

Installation

terminal
npm install swiftproof
# or
yarn add swiftproof

Initialisation

TypeScript
import { SwiftProof } from 'swiftproof';

const sp = new SwiftProof({
  apiKey: process.env.SWIFTPROOF_API_KEY,
  timeout: 10000, // ms, optional, default 30000
});

Chains

TypeScript
// Create
const chain = await sp.chains.create({ title, actors, metadata });

// Get
const chain = await sp.chains.get(chain_id);

// List
const chains = await sp.chains.list({ limit: 20, status: 'open' });

// Verify
const proof = await sp.chains.verify(chain_id);

Handoffs

TypeScript
// List handoffs for a chain
const handoffs = await sp.handoffs.list(chain_id);

// Resend a confirmation link
const result = await sp.handoffs.resend(chain_id, handoff_id);

Idempotency

TypeScript
const chain = await sp.chains.create(
  { title, actors },
  { idempotencyKey: `order-\${orderId}` }
);

Error handling

TypeScript
import { SwiftProof, SwiftProofError } from 'swiftproof';

try {
  const chain = await sp.chains.create({ title, actors });
} catch (err) {
  if (err instanceof SwiftProofError) {
    console.error(err.code);    // e.g. "rate_limited"
    console.error(err.status);  // HTTP status code
    console.error(err.message); // Human-readable message
  }
}

Requirements