@campnetwork/origin 1.3.0-alpha.9 → 1.3.1

package/README.md

@@ -328,7 +328,7 @@ import { ethers } from "ethers";
 
 // Setup ethers provider and signer
 const provider = new ethers.JsonRpcProvider(
-  process.env.RPC_URL || campMainnet.rpcUrls.default.http[0]
+  process.env.RPC_URL || campMainnet.rpcUrls.default.http[0],
 );
 const signer = new ethers.Wallet(process.env.PRIVATE_KEY, provider);
 
@@ -367,7 +367,7 @@ const account = privateKeyToAccount(process.env.PRIVATE_KEY);
 const client = createNodeWalletClient(
   account,
   campMainnet,
-  process.env.RPC_URL || campMainnet.rpcUrls.default.http[0]
+  process.env.RPC_URL || campMainnet.rpcUrls.default.http[0],
 );
 
 // Create Auth instance
@@ -529,7 +529,7 @@ createRoot(document.getElementById("root")).render(
         <App />
       </CampProvider>
     </QueryClientProvider>
-  </StrictMode>
+  </StrictMode>,
 );
 ```
 
@@ -1053,14 +1053,30 @@ interface TokenInfo {
 }
 ```
 
+#### `BulkMintFileEntry`
+
+An entry for the `bulkMintFile` method:
+
+```typescript
+interface BulkMintFileEntry {
+  file: File; // The file to mint as an IpNFT
+  metadata: Record<string, unknown>; // Metadata (name, description, etc.)
+  license: LicenseTerms; // License terms for this entry
+  parents?: bigint[]; // Optional parent token IDs for derivatives
+  previewImage?: File | null; // Optional preview image
+  useAssetAsPreview?: boolean; // Use the asset itself as preview (images only)
+}
+```
+
 ### Minting Constraints
 
 When minting or updating an IpNFT, the following constraints apply to the `LicenseTerms`:
 
 - The price must be at least `1000000000000000` wei (0.001 $CAMP).
 - The royaltyBps must be between `1` and `10000` (0.01% to 100%).
+- The paymentToken must be either `address(0)` (native currency) or the wCAMP token address.
 - For `DURATION_BASED` licenses, the duration must be between `86400` seconds and `2628000` seconds (1 day to 30 days).
-- For `SINGLE_PAYMENT` and `X402` licenses, duration must be `0`.
+- For `SINGLE_PAYMENT` and `X402` licenses, duration **must** be `0`. Setting a non-zero duration will cause the transaction to revert.
 
 ### `createLicenseTerms(price, duration, royaltyBps, paymentToken, licenseType?)`
 
@@ -1085,7 +1101,7 @@ const subscriptionLicense = createLicenseTerms(
   BigInt("1000000000000000"), // 0.001 CAMP in wei
   86400, // 1 day in seconds
   1000, // 10% royalty (1000 basis points)
-  zeroAddress // Native currency (CAMP)
+  zeroAddress, // Native currency (CAMP)
 );
 
 // Create single payment license (perpetual access)
@@ -1094,7 +1110,7 @@ const perpetualLicense = createLicenseTerms(
   0, // Duration must be 0 for single payment
   500, // 5% royalty
   zeroAddress,
-  LicenseType.SINGLE_PAYMENT
+  LicenseType.SINGLE_PAYMENT,
 );
 
 // Use with minting functions
@@ -1130,14 +1146,59 @@ Mints an IpNFT for a connected social account.
 - `license`: LicenseTerms object
 - **Returns:** Minted token ID as a string, or throws on failure
 
+#### `bulkMintFile(entries, options?)`
+
+Mints multiple file-based IpNFTs in a single transaction using the BatchOperations contract. Each file is uploaded and registered individually, then all mints are batched into one on-chain call.
+
+- `entries`: Array of `BulkMintFileEntry` objects
+- `options.tolerant`: When `true`, individual mints can fail without reverting the entire transaction (default: `false`)
+- `options.progressCallback`: Optional callback for tracking progress
+  - `fileIndex`: Current file index (0-based)
+  - `fileCount`: Total number of files
+  - `stage`: `"uploading"` or `"registering"`
+  - `percent`: Progress percentage (0-100)
+- **Returns:** `{ tokenIds: string[], result: any }` — array of minted token IDs and the transaction result
+
+**Example:**
+
+```typescript
+import { createLicenseTerms, LicenseType } from "@campnetwork/origin";
+import { zeroAddress } from "viem";
+
+const license = createLicenseTerms(
+  BigInt("2000000000000000"), // 0.002 CAMP
+  0, // duration must be 0 for SINGLE_PAYMENT
+  10, // 0.1% royalty
+  zeroAddress,
+  LicenseType.SINGLE_PAYMENT,
+);
+
+const result = await auth.origin.bulkMintFile(
+  [
+    { file: file1, metadata: { name: "Asset 1" }, license },
+    { file: file2, metadata: { name: "Asset 2" }, license },
+  ],
+  {
+    tolerant: false,
+    progressCallback: ({ fileIndex, fileCount, stage, percent }) => {
+      console.log(`[${fileIndex + 1}/${fileCount}] ${stage}: ${percent}%`);
+    },
+  },
+);
+
+console.log("Minted token IDs:", result.tokenIds);
+```
+
 ### IpNFT & Marketplace Methods
 
 Most methods mirror smart contract functions and require appropriate permissions.
 
 #### Core IpNFT Methods
 
-- `mintWithSignature(to, tokenId, parents, isIp, hash, uri, license, deadline, signature, appId?)` — Mint with a backend signature.
+- `mintWithSignature(to, tokenId, parents, isIp, hash, uri, license, deadline, signature, appId?)` — Mint with a backend signature
 - `registerIpNFT(source, deadline, license, metadata, fileKey?, parents?)` — Register IP with backend
+- `bulkMint(mints)` — Low-level atomic bulk mint via BatchOperations (all succeed or all fail)
+- `bulkMintTolerant(mints)` — Low-level tolerant bulk mint (partial success allowed, returns success/failure counts)
 - `updateTerms(tokenId, license)` — Update license terms
 - `finalizeDelete(tokenId)` — Finalize deletion of an IP NFT
 - `getOrCreateRoyaltyVault(tokenId)` — Get or create Token Bound Account for royalties
@@ -1276,7 +1337,7 @@ const disputeTag = keccak256(toBytes("copyright_infringement"));
 const result = await auth.origin.raiseDispute(
   1n, // Token ID to dispute
   evidenceHash,
-  disputeTag
+  disputeTag,
 );
 
 // Check if you can vote before voting
@@ -1299,13 +1360,17 @@ if (eligibility.canVote) {
 // Get detailed dispute progress
 const progress = await auth.origin.getDisputeProgress(disputeId);
 console.log(`Yes: ${progress.yesPercentage}% | No: ${progress.noPercentage}%`);
-console.log(`Quorum: ${progress.quorumPercentage}% (${progress.quorumMet ? "met" : "not met"})`);
+console.log(
+  `Quorum: ${progress.quorumPercentage}% (${progress.quorumMet ? "met" : "not met"})`,
+);
 console.log(`Projected outcome: ${progress.projectedOutcome}`);
 
 if (progress.timeline.canResolveNow) {
   await auth.origin.resolveDispute(disputeId);
 } else {
-  console.log(`Can resolve in ${progress.timeline.timeUntilResolution} seconds`);
+  console.log(
+    `Can resolve in ${progress.timeline.timeUntilResolution} seconds`,
+  );
 }
 ```