shdwDrive SDK

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

Installation

``bash

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

`typescript
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

$3


`typescript
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);
`

$3

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

$3

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

$3

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

$3

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

$3

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

API Reference

$3

#### Constructor Options
`typescript
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 });
`

#### Methods

- uploadFile(bucket: string, file: File, options?: FileUploadOptions)
- deleteFile(bucket: string, fileUrl: string)
- listFiles(bucket: string)
- getBucketUsage(bucket: string)
- createFolder(bucket: string, folderName: string)
- deleteFolder(bucket: string, folderUrl: string)`

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

See the LICENSE file for details.