@oxy.so/core 7.24.0 → 7.26.0

package/dist/types/crypto/organizationKeys.d.ts

@@ -0,0 +1,90 @@
+/**
+ * Organization keys on the device (ADR 0061 D6).
+ *
+ * An organization's identity key is created in Commons by one of its owners or
+ * admins, from a fresh 24-word phrase (`seed[0:32]`, the personal-root
+ * derivation), and is published as the organization's DID `#key-1`. Commons
+ * holds it beside the person's own root, under the organization's account id;
+ * other Oxy apps reach it the way they reach the personal identity, by
+ * derivation and never by the key:
+ *
+ * - iOS: the keychain access group `group.so.oxy.shared`, like the personal
+ *   shared slot. Only Commons writes it.
+ * - Android: Commons' own expo-secure-store slot, mirrored into the identity
+ *   signer store (`./identitySigner`) that Commons' identity host answers
+ *   `accountId` requests from. Every other app asks Commons over IPC
+ *   (`loadCommonsIdentityBridge`), and never gets the key.
+ *
+ * The phrase is kept only in Commons, on the device that created or imported
+ * it, so an owner can show it to another owner (ADR 0061 D5); it never reaches
+ * the keychain group, an IPC answer or a log.
+ *
+ * This module imports nothing from `./keyManager` (which imports it): the
+ * signer store comes from `./identitySigner`'s registry.
+ */
+/** A secp256k1 pair: private key 64 hex, public key lowercase uncompressed (`04…`, 130 hex). */
+export interface OrganizationKeyPair {
+    privateKey: string;
+    publicKey: string;
+}
+/** A new organization key and the 24-word phrase it derives from. */
+export interface GeneratedOrganizationKey extends OrganizationKeyPair {
+    mnemonic: string;
+}
+/** What {@link storeOrganizationKey} keeps: the pair, and the phrase when the device has it. */
+export interface StoredOrganizationKey extends OrganizationKeyPair {
+    mnemonic?: string;
+}
+/** Whether `value` is an account id an organization key can be stored under. */
+export declare function isOrganizationAccountId(value: string): boolean;
+/** True only when both halves are well-formed AND the public key derives from the private one. */
+export declare function isHealthyOrganizationKeyPair(privateKey: string | null | undefined, publicKey: string | null | undefined): boolean;
+/**
+ * A fresh organization key: a 24-word phrase and the pair derived from it
+ * exactly as a personal root is (`seed[0:32]`). Stores NOTHING: the caller shows
+ * the phrase, links the key (`oxy.accounts.identityKey`), and only then calls
+ * {@link storeOrganizationKey}.
+ */
+export declare function generateOrganizationKey(): Promise<GeneratedOrganizationKey>;
+/**
+ * The pair a 24-word organization phrase derives. Stores nothing; the caller
+ * checks the public key against the organization's DID `#key-1` before keeping
+ * it (ADR 0061 D5).
+ */
+export declare function organizationKeyFromPhrase(phrase: string): Promise<OrganizationKeyPair>;
+/**
+ * Keep an organization key on this device. Commons only: on Android it needs
+ * the identity signer store Commons registers, so the identity host can serve
+ * it; on iOS only Commons calls it (the keychain group is shared).
+ *
+ * Refuses a pair whose public key does not derive from its private key, and a
+ * phrase that does not derive the pair. Overwrites whatever this device held for
+ * the organization (a replaced key is the caller's decision, ADR 0061 D7).
+ */
+export declare function storeOrganizationKey(accountId: string, key: StoredOrganizationKey): Promise<void>;
+/**
+ * The organization's public key as THIS device can reach it, or `null`.
+ * iOS: the keychain group. Android: Commons' own slot inside Commons, and
+ * Commons' identity host (`describe` with `accountId`) everywhere else. Compare
+ * it with the organization's DID `#key-1` before receiving (Peable ADR 0002).
+ */
+export declare function getOrganizationPublicKey(accountId: string): Promise<string | null>;
+/**
+ * The organization's private key, where this app may hold it: Commons (both
+ * platforms) and, on iOS, the keychain group. `null` on Android outside
+ * Commons. Use it to sign within the app only; never transmit it.
+ */
+export declare function getOrganizationPrivateKey(accountId: string): Promise<string | null>;
+/** The organization's phrase, if this device created or imported it with one. Commons only. */
+export declare function getOrganizationRecoveryPhrase(accountId: string): Promise<string | null>;
+/** The organizations this device keeps a key for (Commons' own index). */
+export declare function listOrganizationKeys(): Promise<string[]>;
+/** Forget an organization key on this device: its pair, its phrase, its signer copy and its index entry. */
+export declare function deleteOrganizationKey(accountId: string): Promise<void>;
+/**
+ * Commons on Android: copy every held organization key into the identity
+ * signer store again, so the identity host answers for it after that file was
+ * rebuilt (its self-heal leaves it empty). Call on every boot, beside
+ * `KeyManager.syncSharedIdentity`. Resolves how many it mirrored. Elsewhere 0.
+ */
+export declare function syncOrganizationKeys(): Promise<number>;

package/dist/types/index.d.ts

@@ -70,8 +70,8 @@ export type { CommonsDeliveryFacts, CommonsDeliveryPlatform, CommonsDeliveryRout
 export { getNormalizedUserId, normalizeUserIdentity, normalizeUserIdentityOrNull, } from './utils/userIdentity';
 export { getCanonicalUserHandle, getNormalizedUserHandle, } from './utils/userHandle';
 export type { CanonicalUserHandleInput, UserHandleInput } from './utils/userHandle';
-export { normalizeProfileLinks } from './utils/profileLinks';
-export type { ProfileLink, ProfileLinkMetadata } from './utils/profileLinks';
+export { normalizeProfileLinks, supportProviderOf } from './utils/profileLinks';
+export type { ProfileLink, ProfileLinkMetadata, SupportProvider } from './utils/profileLinks';
 export { SessionSyncRequiredError, AuthenticationFailedError, ensureValidToken, isAuthenticationError, withAuthErrorHandling, authenticatedApiCall, } from './utils/authHelpers';
 export type { HandleApiErrorOptions } from './utils/authHelpers';
 export { mergeSessions, normalizeAndSortSessions, sessionsArraysEqual, } from './utils/sessionUtils';

package/dist/types/utils/profileLinks.d.ts

@@ -13,6 +13,8 @@ export interface ProfileLink {
     url: string;
     description?: string;
     image?: string;
+    /** Clarity's favicon for the link's host, when Clarity has one. */
+    faviconUrl?: string;
 }
 /** Source shape of a single `User.linksMetadata` entry. */
 export interface ProfileLinkMetadata {
@@ -21,6 +23,7 @@ export interface ProfileLinkMetadata {
     description?: string;
     image?: string;
     id?: string;
+    faviconUrl?: string;
 }
 /**
  * Normalizes a user's profile links into a clean display shape.
@@ -42,3 +45,13 @@ export interface ProfileLinkMetadata {
  * as `https://`; prefixing is a display concern left to the caller.
  */
 export declare function normalizeProfileLinks(linksMetadata?: ProfileLinkMetadata[], links?: string[]): ProfileLink[];
+/** A platform a profile can point supporters to, recognised by the link's host. */
+export interface SupportProvider {
+    id: 'patreon' | 'kofi' | 'buymeacoffee' | 'github-sponsors' | 'liberapay';
+    name: string;
+}
+/**
+ * The support platform a link points at, or `null`. GitHub Sponsors is the one
+ * host shared with ordinary GitHub pages, so only its `/sponsors/` path counts.
+ */
+export declare function supportProviderOf(url: string): SupportProvider | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oxy.so/core",
-  "version": "7.24.0",
+  "version": "7.26.0",
   "description": "OxyHQ SDK Foundation — API client, authentication, cryptographic identity, and shared utilities",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -182,7 +182,7 @@
     "@noble/ciphers": "^2.4.0",
     "@noble/hashes": "^2.4.0",
     "@oxy.so/contracts": "^6.11.0",
-    "@oxy.so/protocol": "^1.6.1",
+    "@oxy.so/protocol": "^1.7.0",
     "@oxy.so/telemetry": "^2.1.0",
     "@scure/bip39": "^2.4.0",
     "buffer": "^6.0.3",

package/src/crypto/identitySigner.ts

@@ -23,4 +23,32 @@ export interface IdentitySignerStore {
   write(privateKey: string, publicKey: string): Promise<boolean>;
   /** Drop the stored key pair. */
   clear(): Promise<void>;
+  /**
+   * An ORGANIZATION key Commons holds (ADR 0061 D6), by the organization's
+   * account id: the copy the identity host answers `accountId` requests from.
+   * Optional so a store built before organization keys still type-checks; a
+   * store without them cannot hold an organization key.
+   */
+  readOrganization?(accountId: string): Promise<{ privateKey: string; publicKey: string } | null>;
+  /** Replace that organization's pair. Resolves whether a read-back confirmed it. */
+  writeOrganization?(accountId: string, privateKey: string, publicKey: string): Promise<boolean>;
+  /** Drop that organization's pair. */
+  clearOrganization?(accountId: string): Promise<void>;
+}
+
+/**
+ * The store Commons registered, readable by modules that `KeyManager` itself
+ * imports (`./organizationKeys`), which therefore cannot import `KeyManager`.
+ * Written only by `KeyManager.setIdentitySignerStore`. @internal
+ */
+let registeredSignerStore: IdentitySignerStore | null = null;
+
+/** @internal */
+export function registerIdentitySignerStore(store: IdentitySignerStore | null): void {
+  registeredSignerStore = store;
+}
+
+/** @internal */
+export function registeredIdentitySignerStore(): IdentitySignerStore | null {
+  return registeredSignerStore;
 }

package/src/crypto/index.ts

@@ -26,6 +26,25 @@ export { readIdentityMarker, updateIdentityMarker } from './identityMarker';
 export type { IdentityMarker } from './identityMarker';
 export type { IdentityDeviceBackupStore } from './deviceBackup';
 export type { IdentitySignerStore } from './identitySigner';
+// Organization keys on the device (docs/adr/0061-organization-identity-key.md D6)
+export {
+  generateOrganizationKey,
+  organizationKeyFromPhrase,
+  storeOrganizationKey,
+  getOrganizationPublicKey,
+  getOrganizationPrivateKey,
+  getOrganizationRecoveryPhrase,
+  listOrganizationKeys,
+  deleteOrganizationKey,
+  syncOrganizationKeys,
+  isOrganizationAccountId,
+  isHealthyOrganizationKeyPair,
+} from './organizationKeys';
+export type {
+  OrganizationKeyPair,
+  GeneratedOrganizationKey,
+  StoredOrganizationKey,
+} from './organizationKeys';
 export { SignatureService } from './signatureService';
 export type { SignedMessage, AuthChallenge } from './signatureService';
 export { RecoveryPhraseService, BACKUP_KDF_ENCRYPTION_INFO } from './recoveryPhrase';

package/src/crypto/keyManager.ts

@@ -30,7 +30,8 @@ import {
 } from '@oxy.so/protocol/secp256k1';
 import { isDev, logger } from '../logger';
 import { deriveScopedSeedFromKey, signSocialReceiveDigest } from './identityDerivations';
-import type { IdentitySignerStore } from './identitySigner';
+import { type IdentitySignerStore, registerIdentitySignerStore } from './identitySigner';
+import { getOrganizationPrivateKey, isOrganizationAccountId } from './organizationKeys';
 import {
   type IdentityMarker,
   clearIdentityMarker,
@@ -457,6 +458,7 @@ export class KeyManager {
    */
   static setIdentitySignerStore(store: IdentitySignerStore | null): void {
     KeyManager.identitySignerStore = store;
+    registerIdentitySignerStore(store);
     KeyManager.invalidateSharedCache();
   }
 
@@ -3237,14 +3239,26 @@ export class KeyManager {
    * Both reproduce from the user's Oxy recovery phrase, so the seed is
    * recoverable, and the IPC answer is byte-identical to the local one.
    *
+   * With `opts.accountId` the seed is derived from that ORGANIZATION's key
+   * instead (ADR 0061 D6), from the same places: Commons' own copy, the iOS
+   * keychain group, or Commons' identity host. It never falls back to the
+   * personal key.
+   *
    * @param info Context/domain-binding label (distinct labels → independent seeds).
+   * @param opts.accountId An organization's account id, for its key.
    * @returns 32 bytes of derived keying material, or `null` on web / when no
    *          identity key is available to this app.
    */
-  static async deriveScopedSeed(info: string): Promise<Uint8Array | null> {
+  static async deriveScopedSeed(
+    info: string,
+    opts?: { accountId?: string },
+  ): Promise<Uint8Array | null> {
     if (isWebPlatform()) {
       return null;
     }
+    if (opts?.accountId !== undefined) {
+      return KeyManager._deriveOrganizationScopedSeed(info, opts.accountId);
+    }
     if (isAndroid()) {
       if (KeyManager.identitySignerStore) {
         // Commons: its own key.
@@ -3263,6 +3277,28 @@ export class KeyManager {
     return deriveScopedSeedFromKey(privateKey, info);
   }
 
+  /**
+   * {@link deriveScopedSeed} over an ORGANIZATION key (ADR 0061 D6): Commons'
+   * own copy inside Commons and on iOS the keychain group, everywhere else on
+   * Android Commons' identity host. Never falls back to the personal key: an
+   * organization this device cannot reach is `null`.
+   */
+  private static async _deriveOrganizationScopedSeed(
+    info: string,
+    accountId: string,
+  ): Promise<Uint8Array | null> {
+    if (!isOrganizationAccountId(accountId)) {
+      return null;
+    }
+    if (isAndroid() && !KeyManager.identitySignerStore) {
+      const bridge = await loadCommonsIdentityBridge();
+      const seed = (await bridge?.deriveScopedSeed(info, accountId)) ?? null;
+      return seed ? hexToBytes(seed) : null;
+    }
+    const privateKey = await getOrganizationPrivateKey(accountId);
+    return privateKey ? deriveScopedSeedFromKey(privateKey, info) : null;
+  }
+
   /**
    * Sign a 32-byte digest (a transaction sighash, lowercase hex) with the
    * identity's social-receive child key `index`: the non-hardened BIP32 child
@@ -3270,8 +3306,9 @@ export class KeyManager {
    * signature is RFC 6979, low-S, DER hex; `publicKey` is the child's
    * compressed public key for the scriptSig.
    *
-   * Key source: as {@link deriveScopedSeed}. On Android outside Commons the
-   * signature comes from Commons, which allows it for the wallet app only.
+   * Key source: as {@link deriveScopedSeed}, including `opts.accountId` for an
+   * organization's key (ADR 0061 D6). On Android outside Commons the signature
+   * comes from Commons, which allows it for the wallet app only.
    *
    * @returns the signature, or `null` on web / when no identity key is
    *          available to this app.
@@ -3279,10 +3316,24 @@ export class KeyManager {
   static async signSocialReceive(
     index: number,
     digest: string,
+    opts?: { accountId?: string },
   ): Promise<CommonsSocialReceiveSignature | null> {
     if (isWebPlatform()) {
       return null;
     }
+    const accountId = opts?.accountId;
+    if (accountId !== undefined) {
+      // An organization key (ADR 0061 D6); never the personal one in its place.
+      if (!isOrganizationAccountId(accountId)) {
+        return null;
+      }
+      if (isAndroid() && !KeyManager.identitySignerStore) {
+        const bridge = await loadCommonsIdentityBridge();
+        return (await bridge?.signSocialReceive(index, digest, accountId)) ?? null;
+      }
+      const organizationKey = await getOrganizationPrivateKey(accountId);
+      return organizationKey ? signSocialReceiveDigest(organizationKey, index, digest) : null;
+    }
     if (isAndroid() && !KeyManager.identitySignerStore) {
       // Every app but Commons: Commons signs.
       const bridge = await loadCommonsIdentityBridge();