@net-protocol/storage 0.1.12 → 0.1.13

package/README.md

@@ -32,8 +32,8 @@ Net Storage supports three storage patterns for different file sizes:
 
 ### XML Storage
 
-**Best for**: Large files (> 20KB) or files containing XML references  
-**How it works**: Splits large files into 80KB pieces, stores each using ChunkedStorage (compressed and chunked into 20KB pieces), maintains references as XML metadata  
+**Best for**: Large files (> 20KB) or files containing XML references
+**How it works**: Splits large files into 80KB pieces (configurable via `chunkSize`), stores each using ChunkedStorage (compressed and chunked into 20KB pieces), maintains references as XML metadata
 **Use cases**: Videos, large images, datasets, any large file
 
 ## What can you do with this package?
@@ -133,38 +133,24 @@ function XmlComponent() {
   return <div>{data}</div>;
 }
 
-// XML storage with format options
-function XmlWithFormats() {
-  // Return as tuple format with hex output
-  const { data: tupleData } = useXmlStorage({
+// XML storage with options
+function XmlWithOptions() {
+  // With hex output (default)
+  const { data: hexData, isXml } = useXmlStorage({
     chainId: 8453,
     key: "my-xml-key",
     operatorAddress: "0x...",
-    returnFormat: "tuple", // Returns [text, data] tuple
     outputFormat: "hex", // Data is hex string (default)
     useRouter: true, // Use StorageRouter for automatic detection
   });
 
-  // Return as tuple format with string output
-  const { data: tupleStringData } = useXmlStorage({
+  // With string output
+  const { data: stringData } = useXmlStorage({
     chainId: 8453,
     key: "my-xml-key",
     operatorAddress: "0x...",
-    returnFormat: "tuple",
     outputFormat: "string", // Data is plain string
   });
-
-  // Return as object format (default)
-  const {
-    data: objectData,
-    filename,
-    isXml,
-  } = useXmlStorage({
-    chainId: 8453,
-    key: "my-xml-key",
-    operatorAddress: "0x...",
-    returnFormat: "object", // Returns { data, filename, isLoading, error, isXml }
-  });
 }
 
 // Storage from router (handles chunked storage)
@@ -228,6 +214,7 @@ import {
   fileToDataUri,
   detectFileTypeFromBase64,
   base64ToDataUri,
+  OPTIMAL_CHUNK_SIZE,
 } from "@net-protocol/storage";
 
 // Generate storage key bytes
@@ -242,8 +229,11 @@ const assembled = assembleChunks(chunks);
 // Parse XML references
 const references = parseNetReferences('<net k="hash" v="0.0.1" />');
 
-// Process data for XML storage
-const result = processDataForStorage(data, operatorAddress);
+// Process data for XML storage (default 80KB chunk size)
+const result = processDataForStorage(data, operatorAddress, storageKey);
+
+// Process with custom chunk size (40KB)
+const result2 = processDataForStorage(data, operatorAddress, storageKey, 40000);
 ```
 
 ### File Utilities
@@ -297,6 +287,11 @@ const dataUri = base64ToDataUri(base64Data);
 - `getForOperatorAndKey(params)` - Get storage by operator and key
 - `readStorageData(params)` - Read with XML resolution
 - `readChunkedStorage(params)` - Read chunked storage with decompression
+- `prepareXmlStorage(params)` - Prepare XML storage transactions (supports optional `chunkSize`)
+
+### Constants
+
+- `OPTIMAL_CHUNK_SIZE` - Default chunk size for XML storage (80000 bytes)
 
 ## Storage Types
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@net-protocol/storage",
-  "version": "0.1.12",
+  "version": "0.1.13",
   "description": "Net Storage SDK for key-value storage on the Net protocol",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -42,10 +42,10 @@
     "test:ui": "vitest --ui"
   },
   "dependencies": {
-    "@net-protocol/core": "^0.1.8",
+    "@net-protocol/core": "^0.1.9",
     "pako": "^2.1.0",
     "use-async-effect": "^2.2.7",
-    "viem": "^2.31.4"
+    "viem": "^2.45.0"
   },
   "devDependencies": {
     "@tanstack/react-query": "^5.0.0",