@oxy.so/protocol 1.8.0 → 1.9.0

package/dist/cjs/platform/crypto.native.js

@@ -134,6 +134,8 @@ async function loadAsyncStorage() {
 var random_native_2 = require("./random.native");
 Object.defineProperty(exports, "getRandomBytesRN", { enumerable: true, get: function () { return random_native_2.getRandomBytesRN; } });
 const LOWER_HEX = /^[0-9a-f]+$/;
+/** A lowercase uncompressed SEC1 public key, as Commons names every key it holds. */
+const PUBLIC_KEY = /^04[0-9a-f]{128}$/;
 function record(value) {
     return typeof value === 'object' && value !== null ? value : null;
 }
@@ -166,6 +168,39 @@ function narrowOrganizationDescription(value, accountId) {
     const description = narrowDescription(echoes(value, accountId));
     return description ? { ...description, accountId } : null;
 }
+/**
+ * A retired-key answer must name the key asked for, and the scope asked for:
+ * the organization's `accountId`, or none for the person. A Commons before
+ * protocol 4 ignores `keyPublicKey` and answers with the CURRENT key, without
+ * the echo; that answer is refused here.
+ */
+function echoesRetired(value, publicKey, accountId) {
+    const r = record(value);
+    if (!r || r.keyPublicKey !== publicKey)
+        return null;
+    return (r.accountId ?? undefined) === accountId ? r : null;
+}
+/**
+ * The list must be every entry a well-formed public key: one malformed entry
+ * means an answer this side does not understand, and the whole answer is
+ * `null` rather than a list missing a key the wallet would then never sweep.
+ */
+function narrowRetiredKeys(value, accountId) {
+    const r = record(value);
+    if (!r || (r.accountId ?? undefined) !== accountId)
+        return null;
+    const keys = r.publicKeys;
+    if (!Array.isArray(keys))
+        return null;
+    const out = [];
+    for (const key of keys) {
+        if (typeof key !== 'string' || !PUBLIC_KEY.test(key))
+            return null;
+        if (!out.includes(key))
+            out.push(key);
+    }
+    return out;
+}
 function narrowProof(value) {
     const r = record(value);
     const publicKey = hexField(r?.publicKey, 130);
@@ -233,6 +268,26 @@ function loadCommonsIdentityBridge() {
                         return Promise.resolve(null);
                     return ask(() => sign.call(m, index, digest, accountId), (v) => narrowSocialReceive(echoes(v, accountId)));
                 },
+                listRetiredKeys: (accountId) => {
+                    const list = m.listRetiredKeys;
+                    if (typeof list !== 'function')
+                        return Promise.resolve(null);
+                    return ask(() => list.call(m, accountId ?? null), (v) => narrowRetiredKeys(v, accountId));
+                },
+                deriveRetiredScopedSeed: (info, publicKey, accountId) => {
+                    const derive = m.deriveRetiredScopedSeed;
+                    if (typeof derive !== 'function' || !PUBLIC_KEY.test(publicKey)) {
+                        return Promise.resolve(null);
+                    }
+                    return ask(() => derive.call(m, info, publicKey, accountId ?? null), (v) => hexField(echoesRetired(v, publicKey, accountId)?.seed, 64));
+                },
+                signRetiredSocialReceive: (index, digest, publicKey, accountId) => {
+                    const sign = m.signRetiredSocialReceive;
+                    if (typeof sign !== 'function' || !PUBLIC_KEY.test(publicKey)) {
+                        return Promise.resolve(null);
+                    }
+                    return ask(() => sign.call(m, index, digest, publicKey, accountId ?? null), (v) => narrowSocialReceive(echoesRetired(v, publicKey, accountId)));
+                },
             };
         });
     }

package/dist/esm/platform/crypto.native.js

@@ -124,6 +124,8 @@ export async function loadAsyncStorage() {
 // Metro pointed at the same file.
 export { getRandomBytesRN } from './random.native.js';
 const LOWER_HEX = /^[0-9a-f]+$/;
+/** A lowercase uncompressed SEC1 public key, as Commons names every key it holds. */
+const PUBLIC_KEY = /^04[0-9a-f]{128}$/;
 function record(value) {
     return typeof value === 'object' && value !== null ? value : null;
 }
@@ -156,6 +158,39 @@ function narrowOrganizationDescription(value, accountId) {
     const description = narrowDescription(echoes(value, accountId));
     return description ? { ...description, accountId } : null;
 }
+/**
+ * A retired-key answer must name the key asked for, and the scope asked for:
+ * the organization's `accountId`, or none for the person. A Commons before
+ * protocol 4 ignores `keyPublicKey` and answers with the CURRENT key, without
+ * the echo; that answer is refused here.
+ */
+function echoesRetired(value, publicKey, accountId) {
+    const r = record(value);
+    if (!r || r.keyPublicKey !== publicKey)
+        return null;
+    return (r.accountId ?? undefined) === accountId ? r : null;
+}
+/**
+ * The list must be every entry a well-formed public key: one malformed entry
+ * means an answer this side does not understand, and the whole answer is
+ * `null` rather than a list missing a key the wallet would then never sweep.
+ */
+function narrowRetiredKeys(value, accountId) {
+    const r = record(value);
+    if (!r || (r.accountId ?? undefined) !== accountId)
+        return null;
+    const keys = r.publicKeys;
+    if (!Array.isArray(keys))
+        return null;
+    const out = [];
+    for (const key of keys) {
+        if (typeof key !== 'string' || !PUBLIC_KEY.test(key))
+            return null;
+        if (!out.includes(key))
+            out.push(key);
+    }
+    return out;
+}
 function narrowProof(value) {
     const r = record(value);
     const publicKey = hexField(r?.publicKey, 130);
@@ -223,6 +258,26 @@ export function loadCommonsIdentityBridge() {
                         return Promise.resolve(null);
                     return ask(() => sign.call(m, index, digest, accountId), (v) => narrowSocialReceive(echoes(v, accountId)));
                 },
+                listRetiredKeys: (accountId) => {
+                    const list = m.listRetiredKeys;
+                    if (typeof list !== 'function')
+                        return Promise.resolve(null);
+                    return ask(() => list.call(m, accountId ?? null), (v) => narrowRetiredKeys(v, accountId));
+                },
+                deriveRetiredScopedSeed: (info, publicKey, accountId) => {
+                    const derive = m.deriveRetiredScopedSeed;
+                    if (typeof derive !== 'function' || !PUBLIC_KEY.test(publicKey)) {
+                        return Promise.resolve(null);
+                    }
+                    return ask(() => derive.call(m, info, publicKey, accountId ?? null), (v) => hexField(echoesRetired(v, publicKey, accountId)?.seed, 64));
+                },
+                signRetiredSocialReceive: (index, digest, publicKey, accountId) => {
+                    const sign = m.signRetiredSocialReceive;
+                    if (typeof sign !== 'function' || !PUBLIC_KEY.test(publicKey)) {
+                        return Promise.resolve(null);
+                    }
+                    return ask(() => sign.call(m, index, digest, publicKey, accountId ?? null), (v) => narrowSocialReceive(echoesRetired(v, publicKey, accountId)));
+                },
             };
         });
     }

package/dist/types/platform/expoTypes.d.ts

@@ -117,6 +117,14 @@ export interface CommonsSocialReceiveSignature {
  *
  * On iOS these methods resolve `null`: the keychain access groups in
  * `@oxy.so/core`'s `KeyManager` own iOS sharing (docs/identity/ios-keychain-access-groups.md).
+ *
+ * The three `*Retired*` methods (Commons protocol 4) reach a key the person,
+ * or the organization with `accountId`, rotated away from, by its public key,
+ * for SPENDING the coins still at its addresses: never for signing in. They are
+ * always present on the bridge and resolve `null` on a native module or a
+ * Commons that predates them; an answer that does not echo the key (and the
+ * account) asked for is refused, because the current key taken for a retired
+ * one is a payment signed by the wrong key.
  */
 export interface CommonsIdentityBridge {
     /**
@@ -139,6 +147,26 @@ export interface CommonsIdentityBridge {
      * for the wallet app only.
      */
     signSocialReceive(index: number, digest: string, accountId?: string): Promise<CommonsSocialReceiveSignature | null>;
+    /**
+     * The public keys (lowercase uncompressed SEC1 hex, de-duplicated) of the
+     * retired keys Commons holds for the person, or with `accountId` for that
+     * organization, minus the current one. `[]` when it holds none; `null` when
+     * Commons cannot say (absent, refused, or older than retired keys). Allowed
+     * for the wallet app only.
+     */
+    listRetiredKeys(accountId?: string): Promise<string[] | null>;
+    /**
+     * {@link deriveScopedSeed} over the key of that scope whose public key is
+     * `publicKey` (current or retired), never another key: `null` when Commons
+     * does not hold it.
+     */
+    deriveRetiredScopedSeed(info: string, publicKey: string, accountId?: string): Promise<string | null>;
+    /**
+     * {@link signSocialReceive} with the social-receive child `index` of the key
+     * of that scope whose public key is `publicKey` (current or retired), never
+     * another key. Allowed for the wallet app only.
+     */
+    signRetiredSocialReceive(index: number, digest: string, publicKey: string, accountId?: string): Promise<CommonsSocialReceiveSignature | null>;
 }
 /**
  * What the iOS keychain says about this app's DEFAULT access group: the first

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oxy.so/protocol",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "Oxy Protocol — the app-agnostic base substrate: signed-record envelope, canonical JSON, signature/verification, and platform crypto. Reused by any Oxy app to decentralize its own content.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -133,7 +133,7 @@
   },
   "dependencies": {
     "@noble/curves": "^2.4.0",
-    "@oxy.so/contracts": "^6.11.0"
+    "@oxy.so/contracts": "^6.12.0"
   },
   "peerDependencies": {
     "@react-native-async-storage/async-storage": "<4.0.0",

package/src/__tests__/commonsIdentityBridge.test.ts

@@ -166,6 +166,175 @@ describe('loadCommonsIdentityBridge (native)', () => {
     ).resolves.toBeNull();
   });
 
+  describe('retired keys', () => {
+    const ORG = '0123456789abcdef01234567';
+    const RETIRED = `04${'cd'.repeat(64)}`;
+    const OTHER = `04${'ef'.repeat(64)}`;
+    const base = {
+      describe: async () => ({ v: 4, publicKey: PUBLIC_KEY }),
+      proveIdentity: async () => null,
+      deriveScopedSeed: async () => 'cd'.repeat(32),
+      signSocialReceive: async () => ({ signature: '3045bb', publicKey: `02${'ef'.repeat(32)}` }),
+    };
+
+    test('requests carry the key and the scope, and well-formed echoed answers pass', async () => {
+      const calls: unknown[][] = [];
+      mockNative({
+        ...base,
+        listRetiredKeys: async (accountId: string | null) => {
+          calls.push(['listRetiredKeys', accountId]);
+          return accountId === null
+            ? { publicKeys: [RETIRED, OTHER, RETIRED] }
+            : { publicKeys: [OTHER], accountId };
+        },
+        deriveRetiredScopedSeed: async (
+          info: string,
+          publicKey: string,
+          accountId: string | null,
+        ) => {
+          calls.push(['deriveRetiredScopedSeed', info, publicKey, accountId]);
+          return accountId === null
+            ? { seed: 'aa'.repeat(32), keyPublicKey: publicKey }
+            : { seed: 'bb'.repeat(32), keyPublicKey: publicKey, accountId };
+        },
+        signRetiredSocialReceive: async (
+          index: number,
+          digest: string,
+          publicKey: string,
+          accountId: string | null,
+        ) => {
+          calls.push(['signRetiredSocialReceive', index, digest, publicKey, accountId]);
+          return {
+            signature: '3046cc',
+            publicKey: `03${'aa'.repeat(32)}`,
+            keyPublicKey: publicKey,
+          };
+        },
+      });
+      const bridge = await loadBridge();
+      // De-duplicated, in Commons' order.
+      await expect(bridge?.listRetiredKeys()).resolves.toEqual([RETIRED, OTHER]);
+      await expect(bridge?.listRetiredKeys(ORG)).resolves.toEqual([OTHER]);
+      await expect(bridge?.deriveRetiredScopedSeed('peable/faircoin/v1', RETIRED)).resolves.toBe(
+        'aa'.repeat(32),
+      );
+      await expect(bridge?.deriveRetiredScopedSeed('peable/faircoin/v1', OTHER, ORG)).resolves.toBe(
+        'bb'.repeat(32),
+      );
+      await expect(bridge?.signRetiredSocialReceive(7, '11'.repeat(32), RETIRED)).resolves.toEqual({
+        signature: '3046cc',
+        publicKey: `03${'aa'.repeat(32)}`,
+      });
+      expect(calls).toEqual([
+        ['listRetiredKeys', null],
+        ['listRetiredKeys', ORG],
+        ['deriveRetiredScopedSeed', 'peable/faircoin/v1', RETIRED, null],
+        ['deriveRetiredScopedSeed', 'peable/faircoin/v1', OTHER, ORG],
+        ['signRetiredSocialReceive', 7, '11'.repeat(32), RETIRED, null],
+      ]);
+    });
+
+    test('an answer without the key echo, or for another key or scope, is null', async () => {
+      mockNative({
+        ...base,
+        // An older Commons ignored keyPublicKey and answered with the CURRENT key.
+        deriveRetiredScopedSeed: async (
+          _info: string,
+          publicKey: string,
+          accountId: string | null,
+        ) =>
+          accountId === null
+            ? { seed: 'aa'.repeat(32) }
+            : { seed: 'bb'.repeat(32), keyPublicKey: publicKey },
+        signRetiredSocialReceive: async (
+          _index: number,
+          _digest: string,
+          _publicKey: string,
+          accountId: string | null,
+        ) =>
+          accountId === null
+            ? { signature: '3046cc', publicKey: `03${'aa'.repeat(32)}`, keyPublicKey: OTHER }
+            : {
+                signature: '3046cc',
+                publicKey: `03${'aa'.repeat(32)}`,
+                keyPublicKey: RETIRED,
+                accountId: 'fedcba9876543210fedcba98',
+              },
+        // A personal answer for an organization request, and vice versa.
+        listRetiredKeys: async (accountId: string | null) =>
+          accountId === null
+            ? { publicKeys: [RETIRED], accountId: ORG }
+            : { publicKeys: [RETIRED] },
+      });
+      const bridge = await loadBridge();
+      await expect(
+        bridge?.deriveRetiredScopedSeed('peable/faircoin/v1', RETIRED),
+      ).resolves.toBeNull();
+      // The key echo is there but the account echo is missing.
+      await expect(
+        bridge?.deriveRetiredScopedSeed('peable/faircoin/v1', RETIRED, ORG),
+      ).resolves.toBeNull();
+      await expect(
+        bridge?.signRetiredSocialReceive(0, '11'.repeat(32), RETIRED),
+      ).resolves.toBeNull();
+      await expect(
+        bridge?.signRetiredSocialReceive(0, '11'.repeat(32), RETIRED, ORG),
+      ).resolves.toBeNull();
+      await expect(bridge?.listRetiredKeys()).resolves.toBeNull();
+      await expect(bridge?.listRetiredKeys(ORG)).resolves.toBeNull();
+    });
+
+    test('a list with a malformed entry is refused whole; an empty list is an answer', async () => {
+      const answers: unknown[] = [
+        { publicKeys: [RETIRED, `04${'CD'.repeat(64)}`] },
+        { publicKeys: [RETIRED, `02${'aa'.repeat(32)}`] },
+        { publicKeys: [RETIRED, 7] },
+        { publicKeys: RETIRED },
+        { publicKeys: [] },
+      ];
+      mockNative({ ...base, listRetiredKeys: async () => answers.shift() });
+      const bridge = await loadBridge();
+      await expect(bridge?.listRetiredKeys()).resolves.toBeNull();
+      await expect(bridge?.listRetiredKeys()).resolves.toBeNull();
+      await expect(bridge?.listRetiredKeys()).resolves.toBeNull();
+      await expect(bridge?.listRetiredKeys()).resolves.toBeNull();
+      await expect(bridge?.listRetiredKeys()).resolves.toEqual([]);
+    });
+
+    test('a malformed public key is never sent to Commons', async () => {
+      const derive = jest.fn(async () => ({ seed: 'aa'.repeat(32), keyPublicKey: 'x' }));
+      const sign = jest.fn(async () => null);
+      mockNative({ ...base, deriveRetiredScopedSeed: derive, signRetiredSocialReceive: sign });
+      const bridge = await loadBridge();
+      await expect(bridge?.deriveRetiredScopedSeed('peable/faircoin/v1', 'x')).resolves.toBeNull();
+      await expect(
+        bridge?.deriveRetiredScopedSeed('peable/faircoin/v1', RETIRED.toUpperCase()),
+      ).resolves.toBeNull();
+      await expect(
+        bridge?.signRetiredSocialReceive(0, '11'.repeat(32), `02${'aa'.repeat(32)}`),
+      ).resolves.toBeNull();
+      expect(derive).not.toHaveBeenCalled();
+      expect(sign).not.toHaveBeenCalled();
+    });
+
+    test('a native module without the retired functions answers null, never the current key', async () => {
+      const derive = jest.fn(base.deriveScopedSeed);
+      const sign = jest.fn(base.signSocialReceive);
+      mockNative({ ...base, deriveScopedSeed: derive, signSocialReceive: sign });
+      const bridge = await loadBridge();
+      expect(bridge).not.toBeNull();
+      await expect(bridge?.listRetiredKeys()).resolves.toBeNull();
+      await expect(
+        bridge?.deriveRetiredScopedSeed('peable/faircoin/v1', RETIRED),
+      ).resolves.toBeNull();
+      await expect(
+        bridge?.signRetiredSocialReceive(0, '11'.repeat(32), RETIRED, ORG),
+      ).resolves.toBeNull();
+      expect(derive).not.toHaveBeenCalled();
+      expect(sign).not.toHaveBeenCalled();
+    });
+  });
+
   test('the web / Node variant never has a bridge', async () => {
     const mod = await import('../platform/crypto');
     await expect(mod.loadCommonsIdentityBridge()).resolves.toBeNull();

package/src/platform/crypto.native.ts

@@ -225,9 +225,29 @@ interface OxyIdentityNativeModule {
    * Older native modules and Android lack it.
    */
   keychainDefaultAccessGroup?(): Promise<unknown>;
+  /**
+   * Retired keys (Commons protocol 4), added after the organization methods and
+   * just as absent on an older native module. `accountId` is `null` for the
+   * person. Each answer echoes the `keyPublicKey` (and the `accountId`) Commons
+   * answered for.
+   */
+  listRetiredKeys?(accountId: string | null): Promise<unknown>;
+  deriveRetiredScopedSeed?(
+    info: string,
+    publicKey: string,
+    accountId: string | null,
+  ): Promise<unknown>;
+  signRetiredSocialReceive?(
+    index: number,
+    digest: string,
+    publicKey: string,
+    accountId: string | null,
+  ): Promise<unknown>;
 }
 
 const LOWER_HEX = /^[0-9a-f]+$/;
+/** A lowercase uncompressed SEC1 public key, as Commons names every key it holds. */
+const PUBLIC_KEY = /^04[0-9a-f]{128}$/;
 
 function record(value: unknown): Record<string, unknown> | null {
   return typeof value === 'object' && value !== null ? (value as Record<string, unknown>) : null;
@@ -266,6 +286,40 @@ function narrowOrganizationDescription(
   return description ? { ...description, accountId } : null;
 }
 
+/**
+ * A retired-key answer must name the key asked for, and the scope asked for:
+ * the organization's `accountId`, or none for the person. A Commons before
+ * protocol 4 ignores `keyPublicKey` and answers with the CURRENT key, without
+ * the echo; that answer is refused here.
+ */
+function echoesRetired(
+  value: unknown,
+  publicKey: string,
+  accountId: string | undefined,
+): Record<string, unknown> | null {
+  const r = record(value);
+  if (!r || r.keyPublicKey !== publicKey) return null;
+  return (r.accountId ?? undefined) === accountId ? r : null;
+}
+
+/**
+ * The list must be every entry a well-formed public key: one malformed entry
+ * means an answer this side does not understand, and the whole answer is
+ * `null` rather than a list missing a key the wallet would then never sweep.
+ */
+function narrowRetiredKeys(value: unknown, accountId: string | undefined): string[] | null {
+  const r = record(value);
+  if (!r || (r.accountId ?? undefined) !== accountId) return null;
+  const keys = r.publicKeys;
+  if (!Array.isArray(keys)) return null;
+  const out: string[] = [];
+  for (const key of keys) {
+    if (typeof key !== 'string' || !PUBLIC_KEY.test(key)) return null;
+    if (!out.includes(key)) out.push(key);
+  }
+  return out;
+}
+
 function narrowProof(value: unknown): CommonsIdentityProof | null {
   const r = record(value);
   const publicKey = hexField(r?.publicKey, 130);
@@ -347,6 +401,39 @@ export function loadCommonsIdentityBridge(): Promise<CommonsIdentityBridge | nul
             (v) => narrowSocialReceive(echoes(v, accountId)),
           );
         },
+        listRetiredKeys: (accountId?: string) => {
+          const list = m.listRetiredKeys;
+          if (typeof list !== 'function') return Promise.resolve(null);
+          return ask(
+            () => list.call(m, accountId ?? null),
+            (v) => narrowRetiredKeys(v, accountId),
+          );
+        },
+        deriveRetiredScopedSeed: (info: string, publicKey: string, accountId?: string) => {
+          const derive = m.deriveRetiredScopedSeed;
+          if (typeof derive !== 'function' || !PUBLIC_KEY.test(publicKey)) {
+            return Promise.resolve(null);
+          }
+          return ask(
+            () => derive.call(m, info, publicKey, accountId ?? null),
+            (v) => hexField(echoesRetired(v, publicKey, accountId)?.seed, 64),
+          );
+        },
+        signRetiredSocialReceive: (
+          index: number,
+          digest: string,
+          publicKey: string,
+          accountId?: string,
+        ) => {
+          const sign = m.signRetiredSocialReceive;
+          if (typeof sign !== 'function' || !PUBLIC_KEY.test(publicKey)) {
+            return Promise.resolve(null);
+          }
+          return ask(
+            () => sign.call(m, index, digest, publicKey, accountId ?? null),
+            (v) => narrowSocialReceive(echoesRetired(v, publicKey, accountId)),
+          );
+        },
       } satisfies CommonsIdentityBridge;
     });
   }

package/src/platform/expoTypes.ts

@@ -123,6 +123,14 @@ export interface CommonsSocialReceiveSignature {
  *
  * On iOS these methods resolve `null`: the keychain access groups in
  * `@oxy.so/core`'s `KeyManager` own iOS sharing (docs/identity/ios-keychain-access-groups.md).
+ *
+ * The three `*Retired*` methods (Commons protocol 4) reach a key the person,
+ * or the organization with `accountId`, rotated away from, by its public key,
+ * for SPENDING the coins still at its addresses: never for signing in. They are
+ * always present on the bridge and resolve `null` on a native module or a
+ * Commons that predates them; an answer that does not echo the key (and the
+ * account) asked for is refused, because the current key taken for a retired
+ * one is a payment signed by the wrong key.
  */
 export interface CommonsIdentityBridge {
   /**
@@ -149,6 +157,35 @@ export interface CommonsIdentityBridge {
     digest: string,
     accountId?: string,
   ): Promise<CommonsSocialReceiveSignature | null>;
+  /**
+   * The public keys (lowercase uncompressed SEC1 hex, de-duplicated) of the
+   * retired keys Commons holds for the person, or with `accountId` for that
+   * organization, minus the current one. `[]` when it holds none; `null` when
+   * Commons cannot say (absent, refused, or older than retired keys). Allowed
+   * for the wallet app only.
+   */
+  listRetiredKeys(accountId?: string): Promise<string[] | null>;
+  /**
+   * {@link deriveScopedSeed} over the key of that scope whose public key is
+   * `publicKey` (current or retired), never another key: `null` when Commons
+   * does not hold it.
+   */
+  deriveRetiredScopedSeed(
+    info: string,
+    publicKey: string,
+    accountId?: string,
+  ): Promise<string | null>;
+  /**
+   * {@link signSocialReceive} with the social-receive child `index` of the key
+   * of that scope whose public key is `publicKey` (current or retired), never
+   * another key. Allowed for the wallet app only.
+   */
+  signRetiredSocialReceive(
+    index: number,
+    digest: string,
+    publicKey: string,
+    accountId?: string,
+  ): Promise<CommonsSocialReceiveSignature | null>;
 }
 
 /**