Waldrop SDK · Getting Started

Install

Add the SDK and its peer dependencies to your project. Skip the SEAL install if you only need plaintext uploads and reads.

Required packages

npm install @waldrop/sdk @mysten/sui

@mysten/sui is a peer dependency — declared explicitly so you control which version your app uses (the SDK is tested against ^2.16).

Optional — SEAL encryption

Skip this unless you'll call client.crypto.encrypt or .decrypt.

npm install @mysten/seal

The SDK lazy-imports @mysten/seal on first use. If you don't install it, plaintext flows work fine; calling crypto methods throws SealNotInstalledError.

Package manager equivalents

# pnpm
pnpm add @waldrop/sdk @mysten/sui
pnpm add @mysten/seal           # optional

# yarn
yarn add @waldrop/sdk @mysten/sui
yarn add @mysten/seal           # optional

# bun
bun add @waldrop/sdk @mysten/sui
bun add @mysten/seal            # optional

TypeScript

The SDK ships its own .d.ts types — no separate @types/waldrop-sdk needed. Minimum required compiler settings:

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "ESNext",
    "moduleResolution": "Bundler",
    "strict": true
  }
}

Sanity check

Drop this into a fresh index.ts and run it. Zero config, no wallet required:

import { WaldropClient } from "@waldrop/sdk";

const client = new WaldropClient({ network: "testnet" });
const pricing = await client.cost.getPricing();

console.log("Walrus epoch:", pricing.currentEpoch);
console.log("Storage:", pricing.storagePricePerUnitFrost, "FROST/unit/epoch");
console.log("Write:  ", pricing.writePricePerUnitFrost, "FROST/unit");

bun index.ts
# → Walrus epoch: 396
# → Storage: 1184 FROST/unit/epoch
# → Write:   2368 FROST/unit

If those numbers show up, the SDK is talking to testnet correctly. Next, build your first real upload.

Testnet vs mainnet

Currently the SDK is testnet-only — the Waldrop contract package isn't deployed to mainnet yet. The network option accepts "testnet" for now; mainnet shipping later in 2026.

Edit this page on GitHub ↗

Waldrop · 2026cryptokarigar