@blu1606/create-walrus-app 1.0.0 → 2.1.0

package/{templates/base/src/adapters/storage.ts → presets/react-mysten-simple-upload/src/lib/walrus/types.ts}

@@ -1,58 +1,83 @@
-/**
- * Universal storage adapter interface for Walrus
- *
- * This interface abstracts SDK-specific implementations,
- * allowing use case layers to work with any Walrus SDK.
- */
-
-export interface BlobMetadata {
-  blobId: string;
-  size: number;
-  contentType?: string;
-  createdAt: number;
-  expiresAt?: number;
-}
-
-export interface UploadOptions {
-  /** Number of epochs to store (Walrus-specific) */
-  epochs?: number;
-  /** MIME type of the content */
-  contentType?: string;
-}
-
-export interface DownloadOptions {
-  /** Byte range (for large files) */
-  range?: { start: number; end: number };
-}
-
-export interface StorageAdapter {
-  /**
-   * Upload data to Walrus storage
-   * @param data - File or raw bytes to upload
-   * @param options - Upload configuration
-   * @returns Blob ID (permanent reference)
-   */
-  upload(data: File | Uint8Array, options?: UploadOptions): Promise<string>;
-
-  /**
-   * Download blob data by ID
-   * @param blobId - Unique blob identifier
-   * @param options - Download configuration
-   * @returns Raw blob data
-   */
-  download(blobId: string, options?: DownloadOptions): Promise<Uint8Array>;
-
-  /**
-   * Get blob metadata without downloading content
-   * @param blobId - Unique blob identifier
-   * @returns Metadata object
-   */
-  getMetadata(blobId: string): Promise<BlobMetadata>;
-
-  /**
-   * Check if blob exists
-   * @param blobId - Unique blob identifier
-   * @returns True if blob is accessible
-   */
-  exists(blobId: string): Promise<boolean>;
-}
+/**
+ * Universal storage adapter interface for Walrus
+ *
+ * This interface abstracts SDK-specific implementations,
+ * allowing use case layers to work with any Walrus SDK.
+ */
+
+import type { SuiClient } from '@mysten/sui/client';
+import type { Transaction } from '@mysten/sui/transactions';
+
+export interface BlobMetadata {
+  blobId: string;
+  size: number;
+  contentType?: string;
+  createdAt: number;
+  expiresAt?: number;
+  /** Original filename with extension */
+  fileName?: string;
+  /** All tags from WalrusFile */
+  tags?: Record<string, string>;
+}
+
+export interface SignAndExecuteTransactionArgs {
+  transaction: Transaction;
+}
+
+export interface SignAndExecuteTransactionResult {
+  digest: string;
+  effects?: unknown;
+}
+
+export interface UploadOptions {
+  /** Number of epochs to store (Walrus-specific) */
+  epochs?: number;
+  /** MIME type of the content */
+  contentType?: string;
+  /** Sui client with Walrus extension (from useSuiClient hook) */
+  client?: SuiClient;
+  /** Wallet signer for authenticated uploads with address and transaction signing */
+  signer?: {
+    address: string;
+    signAndExecuteTransaction: (args: SignAndExecuteTransactionArgs) => Promise<SignAndExecuteTransactionResult>;
+  };
+}
+
+export interface DownloadOptions {
+  /** Byte range (for large files) */
+  range?: { start: number; end: number };
+  /** Output format - auto-detects if not specified */
+  format?: 'bytes' | 'text' | 'json';
+}
+
+export interface StorageAdapter {
+  /**
+   * Upload data to Walrus storage
+   * @param data - File or raw bytes to upload
+   * @param options - Upload configuration
+   * @returns Blob ID (permanent reference)
+   */
+  upload(data: File | Uint8Array, options?: UploadOptions): Promise<string>;
+
+  /**
+   * Download blob data by ID
+   * @param blobId - Unique blob identifier
+   * @param options - Download configuration
+   * @returns Blob data in requested format (Uint8Array, string, or JSON)
+   */
+  download(blobId: string, options?: DownloadOptions): Promise<Uint8Array | string | unknown>;
+
+  /**
+   * Get blob metadata without downloading content
+   * @param blobId - Unique blob identifier
+   * @returns Metadata object
+   */
+  getMetadata(blobId: string): Promise<BlobMetadata>;
+
+  /**
+   * Check if blob exists
+   * @param blobId - Unique blob identifier
+   * @returns True if blob is accessible
+   */
+  exists(blobId: string): Promise<boolean>;
+}

package/presets/react-mysten-simple-upload/src/main.tsx

@@ -0,0 +1,16 @@
+import React from 'react';
+import ReactDOM from 'react-dom/client';
+import { QueryProvider } from './providers/QueryProvider.js';
+import { WalletProvider } from './providers/WalletProvider.js';
+import App from './App.js';
+import './index.css';
+
+ReactDOM.createRoot(document.getElementById('root')!).render(
+  <React.StrictMode>
+    <QueryProvider>
+      <WalletProvider>
+        <App />
+      </WalletProvider>
+    </QueryProvider>
+  </React.StrictMode>
+);

package/presets/react-mysten-simple-upload/src/providers/QueryProvider.tsx

@@ -0,0 +1,18 @@
+import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
+import { ReactNode } from 'react';
+
+const queryClient = new QueryClient({
+  defaultOptions: {
+    queries: {
+      refetchOnWindowFocus: false,
+      retry: 1,
+      staleTime: 5 * 60 * 1000,
+    },
+  },
+});
+
+export function QueryProvider({ children }: { children: ReactNode }) {
+  return (
+    <QueryClientProvider client={queryClient}>{children}</QueryClientProvider>
+  );
+}

package/presets/react-mysten-simple-upload/src/providers/WalletProvider.tsx

@@ -0,0 +1,52 @@
+import {
+  createNetworkConfig,
+  SuiClientProvider,
+  WalletProvider as SuiWalletProvider,
+} from '@mysten/dapp-kit';
+import { getFullnodeUrl, SuiClient } from '@mysten/sui/client';
+import { walrus } from '@mysten/walrus';
+import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
+import { ReactNode } from 'react';
+import { loadEnv } from '../utils/env.js';
+
+const env = loadEnv();
+
+const validatedNetwork =
+  env.suiNetwork === 'mainnet' || env.suiNetwork === 'testnet'
+    ? env.suiNetwork
+    : 'testnet';
+
+const { networkConfig } = createNetworkConfig({
+  [validatedNetwork]: {
+    url: env.suiRpc || getFullnodeUrl(validatedNetwork),
+  },
+});
+
+const walletQueryClient = new QueryClient();
+
+export function WalletProvider({ children }: { children: ReactNode }) {
+  return (
+    <QueryClientProvider client={walletQueryClient}>
+      <SuiClientProvider
+        networks={networkConfig}
+        defaultNetwork={validatedNetwork}
+        createClient={(network: string | number, config: { readonly url: string }) => {
+          // Create SuiClient with Walrus extension
+          const client = new SuiClient({
+            url: config.url,
+          }).$extend(
+            walrus({
+              network: network as 'testnet' | 'mainnet',
+              wasmUrl: 'https://unpkg.com/@mysten/walrus-wasm@latest/web/walrus_wasm_bg.wasm',
+              // No uploadRelay - upload directly to storage nodes
+              // This avoids tip payment requirements but uses ~2200 requests
+            })
+          );
+          return client;
+        }}
+      >
+        <SuiWalletProvider>{children}</SuiWalletProvider>
+      </SuiClientProvider>
+    </QueryClientProvider>
+  );
+}

package/presets/react-mysten-simple-upload/src/utils/env.ts

@@ -0,0 +1,41 @@
+export interface EnvConfig {
+  walrusNetwork: string;
+  walrusAggregator: string;
+  walrusPublisher: string;
+  suiNetwork: string;
+  suiRpc: string;
+  blockberryKey?: string;
+}
+
+export function loadEnv(): EnvConfig {
+  const getEnv = (key: string, required = true): string => {
+    const value = import.meta.env[key];
+    if (required && !value) {
+      throw new Error(`Missing required environment variable: ${key}`);
+    }
+    return value || '';
+  };
+
+  return {
+    walrusNetwork: getEnv('VITE_WALRUS_NETWORK'),
+    walrusAggregator: getEnv('VITE_WALRUS_AGGREGATOR'),
+    walrusPublisher: getEnv('VITE_WALRUS_PUBLISHER'),
+    suiNetwork: getEnv('VITE_SUI_NETWORK'),
+    suiRpc: getEnv('VITE_SUI_RPC'),
+    blockberryKey: getEnv('VITE_BLOCKBERRY_KEY', false),
+  };
+}
+
+export function validateEnv(config: EnvConfig): void {
+  if (!['testnet', 'mainnet', 'devnet'].includes(config.walrusNetwork)) {
+    throw new Error(`Invalid WALRUS_NETWORK: ${config.walrusNetwork}`);
+  }
+
+  if (!config.walrusAggregator.startsWith('http')) {
+    throw new Error('WALRUS_AGGREGATOR must be a valid HTTP URL');
+  }
+
+  if (!config.walrusPublisher.startsWith('http')) {
+    throw new Error('WALRUS_PUBLISHER must be a valid HTTP URL');
+  }
+}

package/presets/react-mysten-simple-upload/src/utils/mime-type.ts

@@ -0,0 +1,97 @@
+/**
+ * MIME type detection from file extensions
+ * Handles common file types that browsers may not auto-detect
+ */
+
+const MIME_TYPES: Record<string, string> = {
+  // Text formats
+  '.txt': 'text/plain',
+  '.md': 'text/markdown',
+  '.markdown': 'text/markdown',
+  '.csv': 'text/csv',
+  '.html': 'text/html',
+  '.css': 'text/css',
+  '.js': 'text/javascript',
+  '.ts': 'text/typescript',
+  '.json': 'application/json',
+  '.xml': 'application/xml',
+
+  // Images
+  '.jpg': 'image/jpeg',
+  '.jpeg': 'image/jpeg',
+  '.png': 'image/png',
+  '.gif': 'image/gif',
+  '.svg': 'image/svg+xml',
+  '.webp': 'image/webp',
+  '.ico': 'image/x-icon',
+
+  // Documents
+  '.pdf': 'application/pdf',
+  '.doc': 'application/msword',
+  '.docx': 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+  '.xls': 'application/vnd.ms-excel',
+  '.xlsx': 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+  '.ppt': 'application/vnd.ms-powerpoint',
+  '.pptx': 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
+
+  // Archives
+  '.zip': 'application/zip',
+  '.rar': 'application/x-rar-compressed',
+  '.tar': 'application/x-tar',
+  '.gz': 'application/gzip',
+  '.7z': 'application/x-7z-compressed',
+
+  // Audio
+  '.mp3': 'audio/mpeg',
+  '.wav': 'audio/wav',
+  '.ogg': 'audio/ogg',
+  '.m4a': 'audio/mp4',
+
+  // Video
+  '.mp4': 'video/mp4',
+  '.webm': 'video/webm',
+  '.avi': 'video/x-msvideo',
+  '.mov': 'video/quicktime',
+};
+
+/**
+ * Detect MIME type from filename
+ * @param fileName - File name with extension
+ * @returns MIME type or null if not found
+ */
+export function getMimeTypeFromFileName(fileName: string): string | null {
+  const extension = fileName.toLowerCase().match(/\.[^.]+$/)?.[0];
+  if (!extension) return null;
+
+  return MIME_TYPES[extension] || null;
+}
+
+/**
+ * Get content type with fallback logic
+ * Priority: explicit contentType > File.type > extension detection > fallback
+ * @param file - File object, Uint8Array, or filename
+ * @param explicitType - Explicitly provided content type
+ * @returns Best-match content type
+ */
+export function getContentType(
+  file: File | Uint8Array | string,
+  explicitType?: string
+): string {
+  // Priority 1: Explicit content type
+  if (explicitType) return explicitType;
+
+  // Priority 2: File.type (if not empty and not generic)
+  if (file instanceof File && file.type && file.type !== 'application/octet-stream') {
+    return file.type;
+  }
+
+  // Priority 3: Detect from filename extension
+  const fileName = typeof file === 'string' ? file : file instanceof File ? file.name : '';
+  if (fileName) {
+    const detectedType = getMimeTypeFromFileName(fileName);
+    if (detectedType) return detectedType;
+  }
+
+  // Fallback: Generic binary
+  return 'application/octet-stream';
+}

package/presets/react-mysten-simple-upload/tsconfig.json

@@ -0,0 +1,39 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "useDefineForClassFields": true,
+    "lib": [
+      "ES2020",
+      "DOM",
+      "DOM.Iterable"
+    ],
+    "module": "ESNext",
+    "skipLibCheck": true,
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "jsx": "react-jsx",
+    "types": [
+      "vite/client"
+    ],
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+    "paths": {
+      "@/*": [
+        "./src/*"
+      ]
+    }
+  },
+  "include": [
+    "src"
+  ],
+  "references": [
+    {
+      "path": "./tsconfig.node.json"
+    }
+  ]
+}

package/presets/react-mysten-simple-upload/tsconfig.node.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "composite": true,
+    "skipLibCheck": true,
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "allowSyntheticDefaultImports": true
+  },
+  "include": ["vite.config.ts"]
+}

package/presets/react-mysten-simple-upload/vite.config.ts

@@ -0,0 +1,19 @@
+import { defineConfig } from 'vite';
+import react from '@vitejs/plugin-react';
+
+export default defineConfig({
+  plugins: [react()],
+  server: {
+    port: 3000,
+    open: true,
+  },
+  build: {
+    target: 'esnext',
+    outDir: 'dist',
+  },
+  resolve: {
+    alias: {
+      '@': '/src',
+    },
+  },
+});

package/templates/base/README.md

@@ -1,54 +0,0 @@
-# {{projectName}}
-
-This is a Walrus application generated by `create-walrus-app`.
-
-## What's Included
-
-### Adapter Interface
-
-- `src/adapters/storage.ts` - Universal SDK-agnostic interface
-- Allows use case code to work with any Walrus SDK
-
-### Type Definitions
-
-- `src/types/walrus.ts` - Walrus-specific types
-- `src/types/index.ts` - Common utility types
-
-### Utilities
-
-- `src/utils/env.ts` - Environment validation
-- `src/utils/format.ts` - Formatting helpers
-
-### Configuration
-
-- `.env.example` - Environment template
-- `tsconfig.json` - TypeScript strict mode config
-- `package.json` - Base dependencies
-
-## Layer Composition
-
-This base layer is **always included** and combined with:
-
-1. **SDK Layer** (e.g., `sdk-mysten/`) - Implements `StorageAdapter`
-2. **Framework Layer** (e.g., `react/`) - UI framework setup
-3. **Use Case Layer** (e.g., `simple-upload/`) - Application logic
-
-```
-Base + SDK + Framework + UseCase = Your App
-```
-
-## Environment Setup
-
-1. Copy `.env.example` to `.env`
-2. Fill in required values:
-   - Walrus network URLs
-   - Sui RPC endpoint
-3. Optional: Add Blockberry API key
-
-## Next Steps
-
-This base layer is completed by:
-
-- **Phase 4**: SDK implementation
-- **Phase 5**: Framework setup
-- **Phase 6**: Use case logic

package/templates/base/package.json

@@ -1,19 +0,0 @@
-{
-  "name": "{{projectName}}",
-  "version": "0.1.0",
-  "private": true,
-  "type": "module",
-  "scripts": {
-    "dev": "echo 'Override by framework layer'",
-    "build": "echo 'Override by framework layer'",
-    "preview": "echo 'Override by framework layer'",
-    "lint": "eslint . --ext .ts,.tsx",
-    "type-check": "tsc --noEmit"
-  },
-  "devDependencies": {
-    "typescript": "^5.3.3",
-    "eslint": "^8.56.0",
-    "@typescript-eslint/parser": "^6.19.1",
-    "@typescript-eslint/eslint-plugin": "^6.19.1"
-  }
-}

package/templates/base/src/types/index.ts

@@ -1,9 +0,0 @@
-export * from './walrus.js';
-
-export interface Result<T, E = Error> {
-  success: boolean;
-  data?: T;
-  error?: E;
-}
-
-export type AsyncResult<T, E = Error> = Promise<Result<T, E>>;

package/templates/base/src/types/walrus.ts

@@ -1,22 +0,0 @@
-export type WalrusNetwork = 'testnet' | 'mainnet' | 'devnet';
-
-export interface WalrusConfig {
-  network: WalrusNetwork;
-  publisherUrl: string;
-  aggregatorUrl: string;
-  suiRpcUrl: string;
-}
-
-export interface BlobInfo {
-  blobId: string;
-  name?: string;
-  size: number;
-  contentType?: string;
-  uploadedAt: number;
-}
-
-export interface StorageStats {
-  totalBlobs: number;
-  totalSize: number;
-  usedEpochs: number;
-}

package/templates/base/src/utils/format.ts

@@ -1,29 +0,0 @@
-/**
- * Format bytes to human-readable size
- */
-export function formatBytes(bytes: number): string {
-  if (bytes === 0) return '0 Bytes';
-
-  const k = 1024;
-  const sizes = ['Bytes', 'KB', 'MB', 'GB'];
-  const i = Math.floor(Math.log(bytes) / Math.log(k));
-
-  return `${parseFloat((bytes / Math.pow(k, i)).toFixed(2))} ${sizes[i]}`;
-}
-
-/**
- * Format blob ID for display (truncate middle)
- */
-export function formatBlobId(blobId: string, length = 12): string {
-  if (blobId.length <= length) return blobId;
-
-  const part = Math.floor((length - 3) / 2);
-  return `${blobId.slice(0, part)}...${blobId.slice(-part)}`;
-}
-
-/**
- * Format timestamp to locale string
- */
-export function formatDate(timestamp: number): string {
-  return new Date(timestamp).toLocaleString();
-}

package/templates/base/tsconfig.json

@@ -1,19 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "lib": ["ES2020", "DOM", "DOM.Iterable"],
-    "module": "ESNext",
-    "moduleResolution": "bundler",
-    "resolveJsonModule": true,
-    "allowImportingTsExtensions": true,
-    "strict": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noFallthroughCasesInSwitch": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "types": ["vite/client"]
-  },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist"]
-}

package/templates/gallery/README.md

@@ -1,44 +0,0 @@
-# File Gallery Use Case
-
-Manage multiple files with a persistent index.
-
-## Features
-
-- Upload multiple files
-- Grid view of all files
-- Local index (localStorage)
-- Delete files from gallery
-- File metadata display
-
-## Index Format
-
-```json
-{
-  "version": "1.0",
-  "items": [
-    {
-      "blobId": "abc123...",
-      "name": "photo.jpg",
-      "size": 102400,
-      "contentType": "image/jpeg",
-      "uploadedAt": 1705449600000
-    }
-  ],
-  "lastModified": 1705449600000
-}
-```
-
-## Usage
-
-1. Click "Choose File" to select a file
-2. Click "Add to Gallery" to upload
-3. Files appear in the grid below
-4. Click "Delete" to remove files from gallery
-
-## Code Structure
-
-- `GalleryGrid.tsx` - Grid layout for files
-- `FileCard.tsx` - Individual file display
-- `UploadModal.tsx` - Upload UI
-- `index-manager.ts` - localStorage persistence
-- `gallery.ts` - Type definitions

package/templates/gallery/package.json

@@ -1,6 +0,0 @@
-{
-  "name": "{{projectName}}",
-  "version": "0.1.0",
-  "private": true,
-  "dependencies": {}
-}

package/templates/gallery/src/App.tsx

@@ -1,21 +0,0 @@
-import { useState } from 'react';
-import { Layout } from './components/Layout.js';
-import { GalleryGrid } from './components/GalleryGrid.js';
-import { UploadModal } from './components/UploadModal.js';
-import './styles.css';
-
-function App() {
-  const [refreshKey, setRefreshKey] = useState(0);
-
-  return (
-    <Layout>
-      <div className="gallery-app">
-        <h2>🖼️ File Gallery</h2>
-        <UploadModal onSuccess={() => setRefreshKey((k) => k + 1)} />
-        <GalleryGrid key={refreshKey} />
-      </div>
-    </Layout>
-  );
-}
-
-export default App;