Vana SDK

Build user-owned data applications with gasless permissions, encrypted data management, and privacy-preserving infrastructure.

The SDK is production-ready. APIs may evolve in minor versions as we incorporate feedback and expand functionality.

Get Started

1. Install

npm install @opendatalabs/vana-sdk viem
Copy

2. Set up your client

Choose the build for your environment:

Browser:

import { Vana, mokshaTestnet } from "@opendatalabs/vana-sdk/browser";
import { createWalletClient, custom } from "viem";

const walletClient = createWalletClient({
  chain: mokshaTestnet,
  transport: custom(window.ethereum),
});

const vana = Vana({ walletClient });
Copy

Node.js:

import { Vana, mokshaTestnet } from "@opendatalabs/vana-sdk/node";
import { createWalletClient, http } from "viem";
import { privateKeyToAccount } from "viem/accounts";

const account = privateKeyToAccount("0x...");
const vana = Vana({
  walletClient: createWalletClient({
    account,
    chain: mokshaTestnet,
    transport: http("https://rpc.moksha.vana.org"),
  }),
  relayerUrl: "https://relayer.moksha.vana.org",
});
Copy

3. Use the SDK

// Grant gasless data access permission
await vana.permissions.grant({
  grantee: "0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36",
  operation: "llm_inference",
  parameters: {
    prompt: "Analyze my data for insights",
    maxTokens: 1000,
  },
  expiresAt: Math.floor(Date.now() / 1000) + 86400,
});

// Upload encrypted file with decryption permissions
await vana.data.upload({
  content: "Sensitive user data",
  filename: "data.json",
  schemaId: 123,
  permissions: [
    {
      account: "0xServerAddress...",
      publicKey: "0x04ServerKey...",
    },
  ],
});

// Query user files
const files = await vana.data.getUserFiles({
  owner: "0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36",
});
Copy

Features

The SDK provides six main controllers:

Configuration

Configure storage, relay, and subgraph services:

import { StorageManager, PinataStorage } from "@opendatalabs/vana-sdk/node";

const vana = Vana({
  walletClient,
  relayerUrl: "https://relayer.moksha.vana.org",
  storageManager: new StorageManager().register(
    "ipfs",
    new PinataStorage({
      apiKey: process.env.PINATA_API_KEY,
      secretKey: process.env.PINATA_SECRET_KEY,
    })
  ),
  subgraphUrl: "https://api.thegraph.com/subgraphs/name/vana/moksha",
});
Copy

Networks

Learn More

• Documentation - Comprehensive guides and tutorials
• API Reference - Complete TypeScript documentation
• Examples - Full demo applications
• Discord - Community support

Support

Report issues on GitHub Issues.

License

ISC