plotlink-ows 1.0.24 → 1.0.26

package/README.md

@@ -7,6 +7,7 @@
 <p>
   <a href="https://plotlink.xyz"><strong>Live App</strong></a> ·
   <a href="#-quick-start"><strong>Quick Start</strong></a> ·
+  <a href="#-wallet-setup"><strong>Wallet Setup</strong></a> ·
   <a href="#how-it-works"><strong>How it Works</strong></a> ·
   <a href="https://docs.openwallet.sh/"><strong>OWS Docs</strong></a>
 </p>
@@ -116,6 +117,49 @@ npx plotlink-ows status  # Show config + wallet info
 
 ---
 
+## 🔑 Wallet Setup
+
+PlotLink OWS uses an encrypted local wallet via Open Wallet Standard. No raw private keys are exposed to scripts or environment variables.
+
+### Initial Setup
+
+```bash
+npx plotlink-ows init
+```
+
+The setup wizard will:
+1. Ask you to create a passphrase (encrypts your wallet at rest)
+2. Generate a new OWS wallet in `~/.ows/`
+3. Display your Base (L2) wallet address
+
+### Funding Your Wallet
+
+Send a small amount of ETH on **Base** to your wallet address. Publishing costs less than $0.05 per story.
+
+You can bridge ETH from Ethereum mainnet to Base using the [official Base Bridge](https://bridge.base.org) or any supported bridge.
+
+### Environment Variables
+
+| Variable | Required | Description |
+|----------|----------|-------------|
+| `OWS_PASSPHRASE` | Yes | Your wallet encryption passphrase |
+| `NEXT_PUBLIC_RPC_URL` | No | Custom Base RPC URL (defaults to `https://mainnet.base.org`) |
+| `NEXT_PUBLIC_APP_URL` | No | PlotLink API URL (defaults to `https://plotlink.xyz`) |
+
+Copy `.env.example` to `.env` and fill in your values:
+
+```bash
+cp .env.example .env
+```
+
+> **Security best practices:**
+> - Never share your passphrase or wallet files with anyone
+> - Use a dedicated wallet for agent operations — do not reuse your main wallet
+> - Never commit `.env` or wallet files to version control
+> - Store backups of `~/.ows/` in a secure, offline location
+
+---
+
 ## 🏗️ Architecture
 
 ```

package/app/lib/publish.ts

@@ -142,9 +142,9 @@ async function indexWithDelayAndRetry(
  * Upload story content to IPFS via PlotLink's API (plotlink.xyz/api/upload).
  * PlotLink handles Filebase credentials server-side.
  */
-export async function uploadToIPFS(content: string, title: string, genre?: string): Promise<string> {
+export async function uploadToIPFS(content: string, title: string, genre?: string, language?: string): Promise<string> {
   const PLOTLINK_URL = process.env.NEXT_PUBLIC_APP_URL || "https://plotlink.xyz";
-  const metadata = JSON.stringify({ title, genre, content });
+  const metadata = JSON.stringify({ title, genre, language, content });
   const slug = title.toLowerCase().replace(/[^a-z0-9]+/g, "-").slice(0, 40);
   const key = `plotlink/storylines/${Date.now()}-${slug}.json`;
 
@@ -293,10 +293,16 @@ export async function publishStoryline(
   content: string,
   genre: string | undefined,
   onProgress: (progress: PublishProgress) => void,
+  language?: string,
+  isNsfw?: boolean,
 ): Promise<PublishResult> {
+  // Normalize optional fields to backwards-compatible defaults
+  const normalizedLanguage = language || "English";
+  const normalizedIsNsfw = isNsfw ?? false;
+
   // Step 1: Upload to IPFS
   onProgress({ step: "uploading", message: "Uploading story to IPFS..." });
-  const contentCid = await uploadToIPFS(content, title, genre);
+  const contentCid = await uploadToIPFS(content, title, genre, normalizedLanguage);
 
   // Step 2: Compute content hash + get creation fee
   const contentHash = keccak256(toBytes(content));
@@ -334,7 +340,7 @@ export async function publishStoryline(
   // Streams "Indexing…" progress so the user does not escalate to Retry Publish.
   const indexError = await indexWithDelayAndRetry(
     "storyline",
-    { txHash, content, genre },
+    { txHash, content, genre, language: normalizedLanguage, isNsfw: normalizedIsNsfw },
     onProgress,
     txHash,
     contentCid,
@@ -361,10 +367,13 @@ export async function publishPlot(
   content: string,
   genre: string | undefined,
   onProgress: (progress: PublishProgress) => void,
+  language?: string,
 ): Promise<PublishResult> {
+  const normalizedLanguage = language || "English";
+
   // Step 1: Upload to IPFS
   onProgress({ step: "uploading", message: "Uploading plot to IPFS..." });
-  const contentCid = await uploadToIPFS(content, title, genre);
+  const contentCid = await uploadToIPFS(content, title, genre, normalizedLanguage);
 
   // Step 2: Compute content hash
   const contentHash = keccak256(toBytes(content));
@@ -415,3 +424,74 @@ export async function publishPlot(
 
   return { txHash, contentCid, storylineId, plotIndex: confirmation.plotIndex >= 0 ? confirmation.plotIndex : undefined, gasCost: confirmation.gasCost, indexError };
 }
+
+/**
+ * Upload a cover image to PlotLink via signed API call.
+ * Uses createOwsAccount for signing (not raw owsSignMsg).
+ * Returns the IPFS CID of the uploaded image.
+ */
+export async function uploadCoverImage(
+  walletName: string,
+  walletAddress: `0x${string}`,
+  imageFile: File,
+): Promise<string> {
+  const PLOTLINK_URL = process.env.NEXT_PUBLIC_APP_URL || "https://plotlink.xyz";
+  const account = createOwsAccount(walletName, walletAddress);
+
+  const timestamp = Date.now();
+  const message = `PlotLink: Upload cover image\nTimestamp: ${timestamp}`;
+  const signature = await account.signMessage({ message });
+
+  const formData = new FormData();
+  formData.append("file", imageFile);
+  formData.append("message", message);
+  formData.append("signature", signature);
+
+  const res = await fetch(`${PLOTLINK_URL}/api/upload-cover`, {
+    method: "POST",
+    body: formData,
+  });
+
+  if (!res.ok) {
+    const err = await res.json().catch(() => ({})) as Record<string, string>;
+    throw new Error(err.error || `Cover upload failed: HTTP ${res.status}`);
+  }
+
+  const data = await res.json() as { cid: string };
+  return data.cid;
+}
+
+/**
+ * Update storyline metadata (cover, genre, language, NSFW) on PlotLink via signed API call.
+ * Uses createOwsAccount for signing (not raw owsSignMsg).
+ * Message format must match: /^PlotLink: Update storyline #(\d+)\nTimestamp: (\d+)$/
+ */
+export async function updateStoryline(
+  walletName: string,
+  walletAddress: `0x${string}`,
+  storylineId: number,
+  updates: { coverCid?: string | null; genre?: string; language?: string; isNsfw?: boolean },
+): Promise<void> {
+  const PLOTLINK_URL = process.env.NEXT_PUBLIC_APP_URL || "https://plotlink.xyz";
+  const account = createOwsAccount(walletName, walletAddress);
+
+  const timestamp = Date.now();
+  const message = `PlotLink: Update storyline #${storylineId}\nTimestamp: ${timestamp}`;
+  const signature = await account.signMessage({ message });
+
+  const res = await fetch(`${PLOTLINK_URL}/api/storyline/update`, {
+    method: "POST",
+    headers: { "Content-Type": "application/json" },
+    body: JSON.stringify({
+      storylineId,
+      signature,
+      message,
+      ...updates,
+    }),
+  });
+
+  if (!res.ok) {
+    const err = await res.json().catch(() => ({})) as Record<string, string>;
+    throw new Error(err.error || `Storyline update failed: HTTP ${res.status}`);
+  }
+}

package/app/routes/publish.ts

@@ -1,6 +1,6 @@
 import { Hono } from "hono";
 import { streamSSE } from "hono/streaming";
-import { publishStoryline, publishPlot, getEthBalance, estimatePublishCost } from "../lib/publish";
+import { publishStoryline, publishPlot, getEthBalance, estimatePublishCost, uploadCoverImage, updateStoryline } from "../lib/publish";
 import { keccak256, toBytes } from "viem";
 import { listAgentWallets, getBaseAddress } from "../../lib/ows/wallet";
 
@@ -71,6 +71,8 @@ publish.post("/file", async (c) => {
     title: string;
     content: string;
     genre?: string;
+    language?: string;
+    isNsfw?: boolean;
     storylineId?: number;
   }>();
 
@@ -118,6 +120,7 @@ publish.post("/file", async (c) => {
           async (progress) => {
             await stream.writeSSE({ data: JSON.stringify(progress) });
           },
+          body.language,
         );
       } else {
         // Create new storyline (genesis or first file)
@@ -129,6 +132,8 @@ publish.post("/file", async (c) => {
           async (progress) => {
             await stream.writeSSE({ data: JSON.stringify(progress) });
           },
+          body.language,
+          body.isNsfw,
         );
       }
 
@@ -191,4 +196,79 @@ publish.post("/retry-index", async (c) => {
   }
 });
 
+/** POST /api/publish/upload-cover — upload cover image with wallet signature */
+publish.post("/upload-cover", async (c) => {
+  try {
+    const wallets = listAgentWallets();
+    const wallet = wallets.find((w) => w.name.startsWith("plotlink-writer"));
+    if (!wallet) return c.json({ error: "No OWS wallet" }, 400);
+
+    const address = getBaseAddress(wallet);
+    if (!address) return c.json({ error: "No EVM address on wallet" }, 400);
+
+    const formData = await c.req.formData();
+    const file = formData.get("file");
+    if (!file || !(file instanceof File)) {
+      return c.json({ error: "No image file provided" }, 400);
+    }
+
+    // Validate file size (500KB max)
+    if (file.size > 500 * 1024) {
+      return c.json({ error: "Image exceeds 500KB limit" }, 400);
+    }
+
+    // Validate file type
+    if (!file.type.startsWith("image/")) {
+      return c.json({ error: "File must be an image (WebP or JPEG recommended)" }, 400);
+    }
+
+    const cid = await uploadCoverImage(wallet.name, address as `0x${string}`, file);
+    return c.json({ cid });
+  } catch (err: unknown) {
+    const message = err instanceof Error ? err.message : "Cover upload failed";
+    return c.json({ error: message }, 500);
+  }
+});
+
+/** POST /api/publish/update-storyline — update storyline metadata with wallet signature */
+publish.post("/update-storyline", async (c) => {
+  try {
+    const wallets = listAgentWallets();
+    const wallet = wallets.find((w) => w.name.startsWith("plotlink-writer"));
+    if (!wallet) return c.json({ error: "No OWS wallet" }, 400);
+
+    const address = getBaseAddress(wallet);
+    if (!address) return c.json({ error: "No EVM address on wallet" }, 400);
+
+    const body = await c.req.json<{
+      storylineId: number;
+      coverCid?: string | null;
+      genre?: string;
+      language?: string;
+      isNsfw?: boolean;
+    }>();
+
+    if (!body.storylineId) {
+      return c.json({ error: "storylineId required" }, 400);
+    }
+
+    await updateStoryline(
+      wallet.name,
+      address as `0x${string}`,
+      body.storylineId,
+      {
+        coverCid: body.coverCid,
+        genre: body.genre,
+        language: body.language,
+        isNsfw: body.isNsfw,
+      },
+    );
+
+    return c.json({ ok: true });
+  } catch (err: unknown) {
+    const message = err instanceof Error ? err.message : "Update failed";
+    return c.json({ error: message }, 500);
+  }
+});
+
 export { publish as publishRoutes };

package/app/routes/stories.ts

@@ -23,6 +23,7 @@ interface FileStatus {
   publishedAt?: string;
   gasCost?: string;
   indexError?: string;
+  authorAddress?: string;
 }
 
 interface StoryInfo {
@@ -243,6 +244,7 @@ stories.post("/:name/:file/publish-status", async (c) => {
     contentCid: string;
     gasCost?: string;
     indexError?: string;
+    authorAddress?: string;
   }>();
 
   const status = readPublishStatus(storyDir);
@@ -255,6 +257,7 @@ stories.post("/:name/:file/publish-status", async (c) => {
     plotIndex: body.plotIndex ?? existing?.plotIndex,
     contentCid: body.contentCid || existing?.contentCid,
     gasCost: body.gasCost || existing?.gasCost,
+    authorAddress: body.authorAddress || existing?.authorAddress,
     publishedAt: new Date().toISOString(),
     ...(body.indexError ? { indexError: body.indexError } : {}),
   };

package/app/web/components/Layout.tsx

@@ -174,6 +174,17 @@ export function Layout({ token, onLogout }: { token: string; onLogout: () => voi
               </ol>
             </div>
 
+            <div className="text-center">
+              <a
+                href="https://github.com/realproject7/plotlink-ows#-wallet-setup"
+                target="_blank"
+                rel="noopener noreferrer"
+                className="text-xs text-muted hover:text-accent underline transition-colors"
+              >
+                Wallet Setup Guide
+              </a>
+            </div>
+
             <WalletCard token={token} />
           </div>
         )}