New RPC method for signing with prefixed keys (#19)

apps/client-web/CHANGELOG.md

@@ -1,5 +1,13 @@
 # client-web
 
+## 0.0.11
+
+### Patch Changes
+
+- Updated dependencies
+  - @parcnet-js/client-rpc@1.1.1
+  - @parcnet-js/client-helpers@1.0.2
+
 ## 0.0.10
 
 ### Patch Changes

apps/client-web/package.json

@@ -1,7 +1,7 @@
 {
   "name": "client-web",
   "private": true,
-  "version": "0.0.10",
+  "version": "0.0.11",
   "type": "module",
   "scripts": {
     "dev": "vite",

apps/client-web/src/App.tsx

@@ -34,7 +34,8 @@ function App() {
     if (
       state.advice &&
       state.connectionState === ConnectionState.AUTHORIZED &&
-      state.zapp
+      state.zapp &&
+      state.zappOrigin
     ) {
       state.advice.hideClient();
       state.advice.ready(
@@ -43,7 +44,8 @@ function App() {
           state.pods,
           dispatch,
           state.identity,
-          state.zapp
+          state.zapp,
+          state.zappOrigin
         )
       );
     }
@@ -53,7 +55,8 @@ function App() {
     state.pods,
     state.identity,
     dispatch,
-    state.zapp
+    state.zapp,
+    state.zappOrigin
   ]);
 
   return (

apps/client-web/src/client/client.ts

@@ -27,7 +27,8 @@ export class ParcnetClientProcessor implements ParcnetRPC {
     private readonly pods: PODCollectionManager,
     dispatch: Dispatch<ClientAction>,
     userIdentity: Identity,
-    zapp: Zapp
+    zapp: Zapp,
+    zappOrigin: string
   ) {
     this.subscriptions = new QuerySubscriptions(this.pods);
     this.subscriptions.onSubscriptionUpdated((update, serial) => {
@@ -37,7 +38,8 @@ export class ParcnetClientProcessor implements ParcnetRPC {
       this.pods,
       this.subscriptions,
       userIdentity,
-      zapp
+      zapp,
+      zappOrigin
     );
     this.identity = new ParcnetIdentityProcessor(userIdentity, zapp);
     this.gpc = new ParcnetGPCProcessor(

apps/client-web/src/client/pod.ts

@@ -16,7 +16,8 @@ export class ParcnetPODProcessor implements ParcnetPODRPC {
     private readonly pods: PODCollectionManager,
     private readonly subscriptions: QuerySubscriptions,
     private readonly identity: Identity,
-    private readonly zapp: Zapp
+    private readonly zapp: Zapp,
+    private readonly zappOrigin: string
   ) {}
 
   public async query(
@@ -94,4 +95,30 @@ export class ParcnetPODProcessor implements ParcnetPODRPC {
     );
     return podToPODData(pod);
   }
+
+  public async signPrefixed(entries: PODEntries): Promise<PODData> {
+    const permission = this.zapp.permissions.SIGN_POD;
+    if (!permission) {
+      throw new MissingPermissionError("SIGN_POD", "pod.signPrefixed");
+    }
+
+    for (const name of Object.keys(entries)) {
+      if (!name.startsWith("_UNSAFE_")) {
+        throw new Error(
+          "PODs signed with signPrefixed must have a prefix of _UNSAFE_"
+        );
+      }
+    }
+
+    entries.UNSAFE_META_ORIGIN = {
+      type: "string",
+      value: this.zappOrigin
+    };
+
+    const pod = POD.sign(
+      entries,
+      encodePrivateKey(Buffer.from(this.identity.export(), "base64"))
+    );
+    return podToPODData(pod);
+  }
 }

apps/client-web/src/pages/HostedZapp.tsx

@@ -28,19 +28,27 @@ export function HostedZapp(): ReactNode {
   }, [dispatch]);
 
   useEffect(() => {
-    if (state.advice && state.zapp) {
+    if (state.advice && state.zapp && state.zappOrigin) {
       state.advice.hideClient();
       state.advice.ready(
         new ParcnetClientProcessor(
           state.advice,
           state.pods,
           dispatch,
           state.identity,
-          state.zapp
+          state.zapp,
+          state.zappOrigin
         )
       );
     }
-  }, [state.advice, state.pods, state.identity, dispatch, state.zapp]);
+  }, [
+    state.advice,
+    state.pods,
+    state.identity,
+    dispatch,
+    state.zapp,
+    state.zappOrigin
+  ]);
 
   const modalVisible = useMemo(() => {
     return state.proofInProgress !== undefined;

examples/test-app/CHANGELOG.md

@@ -1,5 +1,14 @@
 # test-app
 
+## 1.0.13
+
+### Patch Changes
+
+- Updated dependencies
+  - @parcnet-js/app-connector@1.1.1
+  - @parcnet-js/client-rpc@1.1.1
+  - @parcnet-js/ticket-spec@1.1.1
+
 ## 1.0.12
 
 ### Patch Changes

examples/test-app/package.json

@@ -1,6 +1,6 @@
 {
   "name": "test-app",
-  "version": "1.0.12",
+  "version": "1.0.13",
   "private": true,
   "type": "module",
   "scripts": {

examples/test-app/src/apis/PODSection.tsx

@@ -22,6 +22,8 @@ export function PODSection(): ReactNode {
         <QueryPODs z={z} />
         <h2 className="text-lg font-bold mt-4">Sign POD</h2>
         <SignPOD z={z} setSignedPOD={setPOD} />
+        <h2 className="text-lg font-bold mt-4">Sign POD with Prefix</h2>
+        <SignPODWithPrefix z={z} setSignedPOD={setPOD} />
         <h2 className="text-lg font-bold mt-4">Insert POD</h2>
         <InsertPOD z={z} pod={pod} />
         <h2 className="text-lg font-bold mt-4">Delete POD</h2>
@@ -134,6 +136,7 @@ type Action =
   | {
       type: "ADD_ENTRY";
       value: PODValue;
+      prefix?: string;
     }
   | {
       type: "REMOVE_ENTRY";
@@ -150,7 +153,7 @@ const editPODReducer = function (
   switch (action.type) {
     case "ADD_ENTRY": {
       const newState = { ...state };
-      let key = "entry";
+      let key = `${action.prefix ?? ""}entry`;
       let n = 1;
       while (key in newState) {
         key = `entry${n}`;
@@ -308,6 +311,101 @@ ${Object.entries(entries)
   );
 }
 
+function SignPODWithPrefix({
+  z,
+  setSignedPOD
+}: {
+  z: ParcnetAPI;
+  setSignedPOD: Dispatch<SetStateAction<PODData | null>>;
+}): ReactNode {
+  const [creationState, setCreationState] = useState<PODCreationState>(
+    PODCreationState.None
+  );
+  const [pod, setPOD] = useState<PODData | null>(null);
+  const [entries, dispatch] = useReducer(editPODReducer, {
+    _UNSAFE_test: { type: "string", value: "Testing" }
+  } satisfies PODEntries);
+  return (
+    <div>
+      <p>
+        To sign a POD, first we have to create the entries. Note that the
+        entries must have a prefix of <code>_UNSAFE_</code>. Select the entries
+        for the POD below:
+      </p>
+      <div className="flex flex-col gap-2 mb-4">
+        {Object.entries(entries).map(([name, value], index) => (
+          <EditPODEntry
+            key={index}
+            showLabels={index === 0}
+            name={name}
+            value={value.value}
+            type={value.type}
+            dispatch={dispatch}
+          />
+        ))}
+        <Button
+          onClick={() =>
+            dispatch({
+              type: "ADD_ENTRY",
+              value: { type: "string", value: "" },
+              prefix: "_UNSAFE_"
+            })
+          }
+        >
+          Add Another Entry
+        </Button>
+      </div>
+      <p>
+        Then we can sign the POD:
+        <code className="block text-xs font-base rounded-md p-2 whitespace-pre">
+          {`const pod = await z.pod.sign({
+${Object.entries(entries)
+  .map(([key, value]) => {
+    return `  ${key}: { type: "${value.type}", value: ${
+      bigintish.includes(value.type)
+        ? `${value.value.toString()}n`
+        : `"${value.value.toString()}"`
+    } }`;
+  })
+  .join(",\n")}
+});
+
+`}
+        </code>
+      </p>
+      <TryIt
+        onClick={async () => {
+          try {
+            const pod = await z.pod.signPrefixed(entries);
+            setPOD(pod);
+            setSignedPOD(pod);
+            setCreationState(PODCreationState.Success);
+          } catch (e) {
+            console.error(e);
+            setCreationState(PODCreationState.Failure);
+          }
+        }}
+        label="Sign POD with Prefix"
+      />
+      {creationState !== PODCreationState.None && (
+        <div className="my-2">
+          {creationState === PODCreationState.Success && (
+            <div>
+              POD signed successfully! The signature is{" "}
+              <code className="block text-xs font-base rounded-md p-2 whitespace-pre">
+                {pod?.signature}
+              </code>
+            </div>
+          )}
+          {creationState === PODCreationState.Failure && (
+            <div>An error occurred while signing your POD.</div>
+          )}
+        </div>
+      )}
+    </div>
+  );
+}
+
 function EditPODEntry({
   name,
   value,

packages/app-connector/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @parcnet-js/app-connector
 
+## 1.1.1
+
+### Patch Changes
+
+- Support 'signPrefixed' for unsafely-signed PODs
+- Updated dependencies
+  - @parcnet-js/client-rpc@1.1.1
+
 ## 1.1.0
 
 ### Minor Changes

packages/app-connector/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@parcnet-js/app-connector",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "license": "GPL-3.0-or-later",
   "type": "module",
   "main": "dist/index.cjs",

packages/app-connector/src/api_wrapper.ts

@@ -116,6 +116,10 @@ export class ParcnetPODWrapper {
       this.#api.pod.sign(entries).then(resolve).catch(reject);
     });
   }
+
+  async signPrefixed(entries: PODEntries): Promise<PODData> {
+    return this.#api.pod.signPrefixed(entries);
+  }
 }
 
 /**

packages/app-connector/src/rpc_client.ts

@@ -165,6 +165,13 @@ export class ParcnetRPCConnector implements ParcnetRPC, ParcnetEvents {
           [entries],
           ParcnetRPCSchema.pod.sign
         );
+      },
+      signPrefixed: async (entries: PODEntries): Promise<PODData> => {
+        return this.#typedInvoke(
+          "pod.signPrefixed",
+          [entries],
+          ParcnetRPCSchema.pod.signPrefixed
+        );
       }
     };
     this.gpc = {

packages/client-helpers/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @parcnet-js/client-helpers
 
+## 1.0.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @parcnet-js/client-rpc@1.1.1
+
 ## 1.0.1
 
 ### Patch Changes

packages/client-helpers/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@parcnet-js/client-helpers",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "license": "GPL-3.0-or-later",
   "type": "module",
   "main": "dist/index.js",

packages/client-rpc/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @parcnet-js/client-rpc
 
+## 1.1.1
+
+### Patch Changes
+
+- Support 'signPrefixed' for unsafely-signed PODs
+
 ## 1.1.0
 
 ### Minor Changes

packages/client-rpc/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@parcnet-js/client-rpc",
   "type": "module",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "license": "GPL-3.0-or-later",
   "main": "dist/index.js",
   "module": "dist/index.js",

packages/client-rpc/src/rpc_interfaces.ts

@@ -78,6 +78,7 @@ export interface ParcnetPODRPC {
   unsubscribe: (subscriptionId: string) => Promise<void>;
   // Returns serialized POD
   sign: (entries: PODEntries) => Promise<PODData>;
+  signPrefixed: (entries: PODEntries) => Promise<PODData>;
 }
 
 export interface ParcnetRPC {