https://github.com/GenesysGo/shdwdrive-v2-sdk
A Typescript SDK for shdwDrive
https://github.com/GenesysGo/shdwdrive-v2-sdk
Last synced: 3 months ago
JSON representation
A Typescript SDK for shdwDrive
- Host: GitHub
- URL: https://github.com/GenesysGo/shdwdrive-v2-sdk
- Owner: GenesysGo
- License: apache-2.0
- Created: 2025-01-09T04:18:50.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-02-06T16:52:02.000Z (4 months ago)
- Last Synced: 2025-02-06T17:41:32.571Z (4 months ago)
- Language: TypeScript
- Size: 88.9 KB
- Stars: 4
- Watchers: 4
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - GenesysGo/shdwdrive-v2-sdk - A Typescript SDK for shdwDrive (TypeScript)
README
# 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
### Upload a File
```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);
```
### Create a Folder
```typescript
const folderResponse = await drive.createFolder('your-bucket', 'folder-name');
console.log('Folder created:', folderResponse.folder_location);
```
### Delete a Folder
```typescript
const deleteFolderResponse = await drive.deleteFolder('your-bucket', 'folder-url');
console.log('Folder deleted:', deleteFolderResponse.success);
```
### List Files
```typescript
const files = await drive.listFiles('your-bucket');
console.log('Files in bucket:', files);
```
### Delete a File
```typescript
const deleteResponse = await drive.deleteFile('your-bucket', 'file-url');
console.log('Delete status:', deleteResponse.success);
```
### Get Bucket Usage
```typescript
const usage = await drive.getBucketUsage('your-bucket');
console.log('Storage used:', usage.storage_used);
```
## API Reference
### `ShdwDriveSDK`
#### 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.