@blu1606/create-walrus-app 0.1.4 → 2.0.0

package/presets/react-mysten-simple-upload/src/lib/walrus/adapter.ts

@@ -0,0 +1,197 @@
+import type {
+  StorageAdapter,
+  BlobMetadata,
+  UploadOptions,
+  DownloadOptions,
+} from './types.js';
+import { getWalrusClient, resetWalrusClient } from './client.js';
+import { WalrusFile, RetryableWalrusClientError } from '@mysten/walrus';
+import { getContentType } from '../../utils/mime-type.js';
+
+export class MystenStorageAdapter implements StorageAdapter {
+  async upload(
+    data: File | Uint8Array,
+    options?: UploadOptions
+  ): Promise<string> {
+    const bytes =
+      data instanceof File ? new Uint8Array(await data.arrayBuffer()) : data;
+    const fileName = data instanceof File ? data.name : 'upload.bin';
+
+    try {
+      // Check if signer and client are provided
+      if (!options?.signer) {
+        throw new Error('Wallet signer is required for upload. Please connect your wallet.');
+      }
+      if (!options?.client) {
+        throw new Error('Sui client is required for upload.');
+      }
+
+      const client = options.client;
+
+      console.log('[Upload] Starting upload flow...');
+
+      // Detect content type with fallback logic
+      const contentType = getContentType(
+        data,
+        options?.contentType
+      );
+
+      console.log(`[Upload] Detected content-type: ${contentType} for file: ${fileName}`);
+
+      // Create upload flow with full metadata (identifier + tags)
+      const flow = client.walrus.writeFilesFlow({
+        files: [
+          WalrusFile.from({
+            contents: bytes,
+            identifier: fileName, // Original filename with extension
+            tags: {
+              'content-type': contentType,
+              'original-name': fileName,
+            },
+          }),
+        ],
+      });
+
+      // Step 1: Encode the file
+      console.log('[Upload] Step 1: Encoding file...');
+      await flow.encode();
+      console.log('[Upload] Step 1: Encode complete');
+
+      // Step 2: Register the blob on-chain (requires wallet signature)
+      console.log('[Upload] Step 2: Creating register transaction...');
+      const registerTx = flow.register({
+        epochs: options?.epochs || 1,
+        owner: options.signer.address,
+        deletable: true,
+      });
+
+      // Sign and execute the register transaction (dapp-kit will handle wrapping)
+      console.log('[Upload] Step 2: Signing register transaction...');
+      const registerResult = await options.signer.signAndExecuteTransaction({
+        transaction: registerTx,
+      });
+      console.log('[Upload] Step 2: Register complete, digest:', registerResult.digest);
+
+      // Step 3: Upload the data to storage nodes
+      console.log('[Upload] Step 3: Uploading to storage nodes...');
+      await flow.upload({ digest: registerResult.digest });
+      console.log('[Upload] Step 3: Upload complete');
+
+      // Step 4: Certify the blob (requires wallet signature)
+      console.log('[Upload] Step 4: Creating certify transaction...');
+      const certifyTx = flow.certify();
+
+      // Sign and execute the certify transaction (dapp-kit will handle wrapping)
+      console.log('[Upload] Step 4: Signing certify transaction...');
+      await options.signer.signAndExecuteTransaction({
+        transaction: certifyTx,
+      });
+      console.log('[Upload] Step 4: Certify complete');
+
+      // Step 5: Get the uploaded files
+      console.log('[Upload] Step 5: Getting file list...');
+      const files = await flow.listFiles();
+
+      if (!files || files.length === 0) {
+        throw new Error('Upload completed but no files were returned');
+      }
+
+      const blobId = files[0].blobId;
+      console.log('[Upload] Success! Blob ID:', blobId);
+      return blobId;
+    } catch (error) {
+      console.error('[Upload] Error details:', error);
+      throw new Error(
+        `Upload failed: ${error instanceof Error ? error.message : 'Unknown error'}`
+      );
+    }
+  }
+
+  async download(
+    blobId: string,
+    options?: DownloadOptions
+  ): Promise<Uint8Array | string | unknown> {
+    const client = getWalrusClient();
+
+    try {
+      // Use getFiles for better API - supports future batch downloads
+      const [file] = await client.walrus.getFiles({ ids: [blobId] });
+
+      // Handle different output formats
+      switch (options?.format) {
+        case 'text':
+          return await file.text();
+        case 'json':
+          return await file.json();
+        default:
+          return await file.bytes();
+      }
+    } catch (error) {
+      // Handle retryable errors by resetting client and retrying once
+      if (error instanceof RetryableWalrusClientError) {
+        console.warn(`[Download] Retryable error detected, resetting client and retrying...`);
+        resetWalrusClient();
+
+        try {
+          const retryClient = getWalrusClient();
+          const [file] = await retryClient.walrus.getFiles({ ids: [blobId] });
+
+          switch (options?.format) {
+            case 'text':
+              return await file.text();
+            case 'json':
+              return await file.json();
+            default:
+              return await file.bytes();
+          }
+        } catch (retryError) {
+          throw new Error(
+            `Download retry failed for blob ${blobId}: ${retryError instanceof Error ? retryError.message : 'Unknown error'}`
+          );
+        }
+      }
+
+      throw new Error(
+        `Download failed for blob ${blobId}: ${error instanceof Error ? error.message : 'Unknown error'}`
+      );
+    }
+  }
+
+  async getMetadata(blobId: string): Promise<BlobMetadata> {
+    const client = getWalrusClient();
+
+    try {
+      // Get metadata from Walrus
+      const metadata = await client.walrus.getBlobMetadata({ blobId });
+
+      // Get WalrusFile to extract identifier and tags
+      const [file] = await client.walrus.getFiles({ ids: [blobId] });
+      const identifier = await file.getIdentifier();
+      const tags = await file.getTags();
+
+      return {
+        blobId,
+        size: Number(metadata.metadata.V1.unencoded_length),
+        contentType: tags['content-type'] || 'application/octet-stream',
+        fileName: tags['original-name'] || identifier || `blob-${blobId.slice(0, 8)}`,
+        tags,
+        createdAt: (metadata as unknown as { createdAt?: number }).createdAt || Date.now(),
+      };
+    } catch (error) {
+      throw new Error(
+        `Failed to get metadata for blob ${blobId}: ${error instanceof Error ? error.message : 'Unknown error'}`
+      );
+    }
+  }
+
+  async exists(blobId: string): Promise<boolean> {
+    try {
+      await this.getMetadata(blobId);
+      return true;
+    } catch {
+      return false;
+    }
+  }
+}
+
+export const storageAdapter = new MystenStorageAdapter();

package/presets/react-mysten-simple-upload/src/lib/walrus/client.ts

@@ -0,0 +1,87 @@
+import { walrus, WalrusClient } from '@mysten/walrus';
+import { getFullnodeUrl, SuiClient } from '@mysten/sui/client';
+import { loadEnv } from '../../utils/env.js';
+
+// Types
+export type WalrusNetwork = 'testnet' | 'mainnet';
+
+export interface MystenWalrusConfig {
+  network: WalrusNetwork;
+  publisherUrl?: string;
+  aggregatorUrl?: string;
+  suiRpcUrl?: string;
+}
+
+type WalrusExtendedClient = SuiClient & { walrus: WalrusClient };
+
+// Network Configurations
+const NETWORK_CONFIGS: Record<WalrusNetwork, MystenWalrusConfig> = {
+  testnet: {
+    network: 'testnet',
+    publisherUrl: 'https://publisher.walrus-testnet.walrus.space',
+    aggregatorUrl: 'https://aggregator.walrus-testnet.walrus.space',
+    suiRpcUrl: 'https://fullnode.testnet.sui.io:443',
+  },
+  mainnet: {
+    network: 'mainnet',
+    publisherUrl: 'https://publisher.walrus.space',
+    aggregatorUrl: 'https://aggregator.walrus.space',
+    suiRpcUrl: 'https://fullnode.mainnet.sui.io:443',
+  },
+};
+
+function getNetworkConfig(network: WalrusNetwork): MystenWalrusConfig {
+  return NETWORK_CONFIGS[network];
+}
+
+// Client Management
+let walrusClient: WalrusExtendedClient | null = null;
+
+export function getWalrusClient(): WalrusExtendedClient {
+  if (walrusClient) {
+    return walrusClient;
+  }
+
+  const env = loadEnv();
+
+  // Validate network value before casting
+  const allowedNetworks: WalrusNetwork[] = ['testnet', 'mainnet'];
+  if (!allowedNetworks.includes(env.walrusNetwork as WalrusNetwork)) {
+    throw new Error(
+      `Invalid WALRUS_NETWORK: ${env.walrusNetwork}. Must be one of: ${allowedNetworks.join(', ')}`
+    );
+  }
+  const network = env.walrusNetwork as WalrusNetwork;
+  const config = getNetworkConfig(network);
+
+  // Use SuiClient (required for Walrus SDK and CoinWithBalance intent)
+  const suiClient = new SuiClient({
+    url:
+      env.suiRpc ||
+      config.suiRpcUrl ||
+      getFullnodeUrl(network === 'testnet' ? 'testnet' : 'mainnet'),
+  });
+
+  // Extend the client with Walrus capabilities and upload relay
+  walrusClient = suiClient.$extend(
+    walrus({
+      network: network, // REQUIRED: Walrus SDK needs to know which network
+      // Use CDN for WASM - more reliable than bundler resolution
+      wasmUrl: 'https://unpkg.com/@mysten/walrus-wasm@latest/web/walrus_wasm_bg.wasm',
+      uploadRelay: {
+        host:
+          env.walrusPublisher ||
+          config.publisherUrl ||
+          `https://upload-relay.${network}.walrus.space`,
+        sendTip: null, // Skip tip config fetch to avoid CORS issues in development
+      },
+      ...(env.walrusAggregator && { aggregatorUrl: env.walrusAggregator }),
+    })
+  );
+
+  return walrusClient;
+}
+
+export function resetWalrusClient(): void {
+  walrusClient = null;
+}

package/presets/react-mysten-simple-upload/src/lib/walrus/index.ts

@@ -0,0 +1,4 @@
+// Walrus library exports
+export * from './types.js';
+export * from './adapter.js';
+export * from './client.js';

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';
+}