@shdwdrive/sdk NPM

shdwDrive SDK

A TypeScript SDK for interacting with ShdwDrive, providing simple and efficient methods for file operations on the decentralized storage platform.

Installation

# Install from npm
npm install @shdwdrive/sdk

# Or install from repository
git clone https://github.com/GenesysGo/shdwdrive-v2-sdk.git
cd shdwdrive-v2-sdk
npm install
npm run build

Features

📤 File uploads (supports both small and large files)
📥 File deletion
📋 File listing
📊 Bucket usage statistics
🗂️ Folder creation and management
🔐 Secure message signing
⚡ Progress tracking for uploads
🔄 Multipart upload support for large files

Quick Start

import { ShdwDriveSDK } from '@shdwdrive/sdk';

// Initialize with wallet
const drive = new ShdwDriveSDK({ endpoint: 'https://v2.shdwdrive.com' }, { wallet: yourWalletAdapter });
// Or initialize with keypair
const drive = new ShdwDriveSDK({ endpoint: 'https://v2.shdwdrive.com' }, { keypair: yourKeypair });

Usage Examples

Upload a File

const file = new File(['Hello World'], 'hello.txt', { type: 'text/plain' });
const uploadResponse = await drive.uploadFile('your-bucket', file, {
  onProgress: (progress) => {
    console.log(`Upload progress: ${progress.progress}%`);
  }
});
console.log('File uploaded:', uploadResponse.finalized_location);

Create a Folder

const folderResponse = await drive.createFolder('your-bucket', 'folder-name');
console.log('Folder created:', folderResponse.folder_location);

Delete a Folder

const deleteFolderResponse = await drive.deleteFolder('your-bucket', 'folder-url');
console.log('Folder deleted:', deleteFolderResponse.success);

List Files

const files = await drive.listFiles('your-bucket');
console.log('Files in bucket:', files);

Delete a File

const deleteResponse = await drive.deleteFile('your-bucket', 'file-url');
console.log('Delete status:', deleteResponse.success);

Get Bucket Usage

const usage = await drive.getBucketUsage('your-bucket');
console.log('Storage used:', usage.storage_used);

API Reference

`ShdwDriveSDK`

Constructor Options

interface ShdwDriveConfig {
  endpoint?: string; // Optional custom endpoint (defaults to https://v2.shdwdrive.com)
}

// Initialize with either wallet or keypair
new ShdwDriveSDK(config, { wallet: WalletAdapter });
new ShdwDriveSDK(config, { keypair: Keypair });