@campnetwork/origin 1.4.0-alpha.6 → 1.4.0-alpha.8

package/README.md

@@ -1192,6 +1192,62 @@ const result = await auth.origin.bulkMintFile(
 console.log("Minted token IDs:", result.tokenIds);
 ```
 
+### IPFS Credentials for Large File Uploads
+
+Files up to **20 MB** are uploaded automatically via the SDK's built-in S3 multipart upload. Files larger than 20 MB require you to configure your own IPFS pinning service credentials. Once configured, the SDK uploads the file directly to your IPFS provider and registers the resulting CID with Origin.
+
+#### Supported Providers
+
+| Provider | Required Fields |
+| --- | --- |
+| **Pinata** | `jwt` **or** both `apiKey` and `apiSecret` |
+| **Infura** | `projectId` and `projectSecret` |
+| **web3.storage** | `token` |
+
+#### Saving Credentials
+
+```typescript
+await auth.origin.saveIpfsCredentials({
+  provider: "pinata",
+  jwt: "your-pinata-jwt",
+});
+```
+
+#### Verifying & Checking Credentials
+
+```typescript
+// Verify that saved credentials are valid
+const { valid, error } = await auth.origin.verifyIpfsCredentials();
+
+// Check if credentials have been configured
+const hasCredentials = await auth.origin.hasIpfsCredentials();
+```
+
+#### Deleting Credentials
+
+```typescript
+await auth.origin.deleteIpfsCredentials();
+```
+
+#### How It Works
+
+When `mintFile` or `bulkMintFile` is called:
+
+1. If the file is **≤ 20 MB**, it is uploaded via the built-in S3 multipart upload — no IPFS credentials needed.
+2. If the file is **> 20 MB** (or the `forceIpfs` option is set), the SDK fetches your IPFS upload config and uploads the file directly to your pinning service.
+3. If no IPFS credentials are configured for a file that exceeds 20 MB, the SDK throws an error:
+   > `File "example.mp4" exceeds 20MB limit. Please configure your IPFS pinning service in Settings to upload large files.`
+
+#### Forcing IPFS Upload
+
+You can force any file (even those under 20 MB) to be uploaded via IPFS by passing `forceIpfs: true`:
+
+```typescript
+await auth.origin.mintFile(file, metadata, license, [], {
+  forceIpfs: true,
+});
+```
+
 ### IpNFT & Marketplace Methods
 
 Most methods mirror smart contract functions and require appropriate permissions.
@@ -1227,7 +1283,6 @@ These methods handle complexity automatically and are recommended for most use c
 
 - `getTokenInfoSmart(tokenId, owner?)` — Get comprehensive token info in a single call (owner, terms, status, access info, etc.)
 - `buyAccessSmart(tokenId)` — Buys access with automatic fee fetching. Returns `null` if user already has access.
-- `settlePaymentIntent(x402Response, signer?)` — Settle an X402 payment intent response
 
 **Example:**