@kubun/store-p2p 0.17.0 → 0.18.1

package/lib/owner-classification.d.ts

@@ -0,0 +1,14 @@
+import type { StoreProvider } from '@kubun/db';
+export type DocumentOwnerClass = 'own' | 'foreign' | 'unresolved';
+export type ClassifyDocumentOwnerParams = {
+    ownerDID: string;
+    /** The controller DID whose documents this device keeps in custody. Not checked here. */
+    custodyOwner: string;
+    stores: StoreProvider;
+};
+/**
+ * Historical, not current eligibility: a revoked or departed device still owns
+ * what it wrote. `foreign` needs positive evidence; a missing binding is not
+ * evidence, so anything unattributed is `unresolved` and must be kept.
+ */
+export declare function classifyDocumentOwner(params: ClassifyDocumentOwnerParams): Promise<DocumentOwnerClass>;

package/lib/owner-classification.js

@@ -0,0 +1,18 @@
+import { DID_PREFIX } from '@kokuin/controller';
+import { normalizeDID } from '@kokuin/token';
+/**
+ * Historical, not current eligibility: a revoked or departed device still owns
+ * what it wrote. `foreign` needs positive evidence; a missing binding is not
+ * evidence, so anything unattributed is `unresolved` and must be kept.
+ */ export async function classifyDocumentOwner(params) {
+    const owner = normalizeDID(params.ownerDID);
+    const custody = normalizeDID(params.custodyOwner);
+    if (owner === custody) return 'own';
+    const store = await params.stores.getStore('p2p');
+    const controllers = await store.listBindingControllers(owner);
+    // A DID also bound to another controller stays own: a receipt costs less than a lost document.
+    if (controllers.includes(custody)) return 'own';
+    // `did:kokuin:` is self-certifying: kumiai accepts a leaf binding only to a log folding to it.
+    if (owner.startsWith(DID_PREFIX)) return 'foreign';
+    return controllers.length > 0 ? 'foreign' : 'unresolved';
+}

package/lib/tables.d.ts

@@ -1,24 +1,28 @@
 import type { CreatedAtColumn, UpdatedAtColumn } from '@kubun/db-adapter';
+import type { AnchorSlot, AppOutboxEntry, CommitCursor } from '@kumiai/rpc';
 import type { ColumnType, Insertable, Selectable, Updateable } from 'kysely';
 type DefaultedStringColumn = ColumnType<string, string | undefined, string>;
 type DefaultedNumberColumn = ColumnType<number, number | undefined, number>;
 type NullableStringColumn = ColumnType<string | null, string | null | undefined, string | null>;
+type NullableNumberColumn = ColumnType<number | null, number | null | undefined, number | null>;
 type JSONArrayColumn<T> = ColumnType<Array<T>, Array<T> | undefined, Array<T>>;
 type JSONValueColumn<T> = ColumnType<T, T, T>;
 /**
  * Whether this device belongs to the group right now.
  *
- * Only the two states that have a writer. An `invited` state would have none:
+ * An `invited` state would have no writer:
  * a group row is written when a join COMPLETES, so there is no moment at which
  * a row exists and the device has merely been asked.
  */
-export type GroupStatus = 'joined' | 'left';
+export type GroupStatus = 'joined' | 'leaving' | 'left';
+export type GroupKind = 'standard' | 'ownAgents';
 export type GroupTable = {
     id: string;
     name: string;
     description: DefaultedStringColumn;
     created_by: string;
     hlc: string;
+    kind: ColumnType<GroupKind, GroupKind | undefined, GroupKind>;
     /**
      * Leaving keeps the row: its circles, circle members, peer announcements and
      * hub bindings hang off it, and a device invited back would otherwise have to
@@ -28,11 +32,22 @@ export type GroupTable = {
      * row for it.
      */
     status: DefaultedStringColumn;
+    /**
+     * Set in the same transaction as every handle advance, to a token naming that
+     * advance; cleared only by a projection reconcile that started from the same
+     * token. NULL means the control projections match the current handle.
+     */
+    projections_dirty: NullableStringColumn;
+    /**
+     * The handle epoch the last successful reconcile caught the projections up
+     * to. NULL until a reconcile completes.
+     */
+    projections_epoch: NullableNumberColumn;
     created_at: CreatedAtColumn;
     updated_at: UpdatedAtColumn;
 };
 export type Group = Selectable<GroupTable>;
-export type InsertGroup = Insertable<GroupTable>;
+export type InsertGroup = Omit<Insertable<GroupTable>, 'kind'>;
 export type GroupMemberTable = {
     group_id: string;
     member_did: string;
@@ -44,12 +59,71 @@ export type GroupMemberTable = {
 };
 export type GroupMember = Selectable<GroupMemberTable>;
 export type InsertGroupMember = Insertable<GroupMemberTable>;
+export type CatalogOfferTable = {
+    owner: string;
+    exposure_id: string;
+    catalog_id: string;
+    group_id: string;
+    circle_id: string;
+};
+export type CatalogOfferRow = Selectable<CatalogOfferTable>;
+export type CatalogRouteTable = {
+    owner: string;
+    catalog_id: string;
+    group_id: string;
+    pull: number;
+    push: number;
+};
+/** A group this device has stopped serving document data for; absence means served. */
+export type UnservedGroupTable = {
+    group_id: string;
+};
+export type CatalogCursorTable = {
+    peer_did: string;
+    group_id: string;
+    rules_hash: string;
+    last_key: NullableStringColumn;
+    last_token: NullableStringColumn;
+    cycle_clear: DefaultedNumberColumn;
+    /** JSON object: bound-free rule key to its absolute `{ from, to }`. */
+    bounds: string;
+};
+export type DocumentRepairTable = {
+    group_id: string;
+    document_id: string;
+    listed_by: NullableStringColumn;
+    holdings_digest: string;
+    created_at: number;
+    attempted_at: number;
+};
+export type DocumentRepairAnswerTable = {
+    group_id: string;
+    document_id: string;
+    peer_did: string;
+    answer: string;
+};
+export type ObservationRepairScheduleTable = {
+    document_id: string;
+    fetch_hlc: string;
+    attempts: number;
+    next_attempt_at: number;
+    tried_count: number;
+};
+export type ObservationRepairPeerTable = {
+    document_id: string;
+    peer_did: string;
+};
+export type GroupLeaveRequestTable = {
+    group_id: string;
+    member_did: string;
+    hlc: string;
+};
+export type GroupLeaveRequest = Selectable<GroupLeaveRequestTable>;
 export type CircleTable = {
     id: string;
     group_id: string;
     name: string;
     description: DefaultedStringColumn;
-    catalog_ids: JSONArrayColumn<string>;
     hlc: string;
     removed_at_hlc: NullableStringColumn;
     open: DefaultedNumberColumn;
@@ -72,6 +146,10 @@ export type InsertCircleMember = Insertable<CircleMemberTable>;
 export type GroupDelegationTable = {
     group_id: string;
     jti: string;
+    pending_grant_hlc: NullableStringColumn;
+    pending_grant_digest: NullableStringColumn;
+    pending_revocation_hlc: NullableStringColumn;
+    pending_revocation_digest: NullableStringColumn;
 };
 export type GroupDelegation = Selectable<GroupDelegationTable>;
 export type InsertGroupDelegation = Insertable<GroupDelegationTable>;
@@ -81,6 +159,12 @@ export type GroupMLSStateTable = {
     mls_state: Uint8Array;
     credential: string;
     epoch: number;
+    /** Orders secret-tree mutations within one MLS epoch. */
+    state_version: DefaultedNumberColumn;
+    /** Retained absence marker; preserves the row version across leave and rejoin. */
+    is_deleted: DefaultedNumberColumn;
+    /** Exclusive upper bound of sender generations reserved durably for this epoch. */
+    sender_generation_hwm: DefaultedNumberColumn;
     /**
      * The handle's signed control-ledger tokens, JSON-encoded in enactment order.
      * Replayed into `restoreGroup` so a restored handle folds the same roster it
@@ -120,6 +204,14 @@ export type BroadcastLogTable = {
 };
 export type BroadcastLogEntry = Selectable<BroadcastLogTable>;
 export type InsertBroadcastLogEntry = Insertable<BroadcastLogTable>;
+export type LogHandlerCompletionTable = {
+    group_id: string;
+    procedure: string;
+    entity: string;
+    hlc: string;
+    notify: DefaultedNumberColumn;
+    completed: DefaultedNumberColumn;
+};
 export type ControlRequestTable = {
     id: string;
     group_id: string;
@@ -129,6 +221,7 @@ export type ControlRequestTable = {
     result: NullableStringColumn;
     enqueued_at: string;
     settled_at: NullableStringColumn;
+    settled_epoch: NullableNumberColumn;
 };
 export type ControlRequest = Selectable<ControlRequestTable>;
 export type InsertControlRequest = Insertable<ControlRequestTable>;
@@ -142,16 +235,34 @@ export type CommitJournalEntryTable = {
     bodies: JSONArrayColumn<string>;
     kind: string;
     journal: Uint8Array;
+    holds_log_sends: DefaultedNumberColumn;
+};
+export type CommitJournalEntry = Omit<Selectable<CommitJournalEntryTable>, 'holds_log_sends'> & {
+    holds_log_sends: boolean;
 };
-export type CommitJournalEntry = Selectable<CommitJournalEntryTable>;
 export type InsertCommitJournalEntry = Insertable<CommitJournalEntryTable>;
 export type GroupAnchorTable = {
     group_id: string;
     secret: Uint8Array;
     epoch: number;
+    pending: ColumnType<AnchorSlot['pending'] | null, AnchorSlot['pending'] | null, AnchorSlot['pending'] | null>;
 };
 export type GroupAnchor = Selectable<GroupAnchorTable>;
 export type InsertGroupAnchor = Insertable<GroupAnchorTable>;
+export type AppOutboxTable = {
+    group_id: string;
+    seq: number;
+    protocol: string;
+    prc: string;
+    data: Uint8Array;
+    iv: Uint8Array;
+    last_attempt: JSONValueColumn<AppOutboxEntry['lastAttempt']>;
+};
+export type AppOutboxStateTable = {
+    group_id: string;
+    key: ColumnType<Uint8Array | null, Uint8Array | null | undefined, Uint8Array | null>;
+    commit_cursor: ColumnType<CommitCursor | null, CommitCursor | null | undefined, CommitCursor | null>;
+};
 export type AppCursorTable = {
     group_id: string;
     topic_id: string;
@@ -159,6 +270,19 @@ export type AppCursorTable = {
 };
 export type AppCursor = Selectable<AppCursorTable>;
 export type InsertAppCursor = Insertable<AppCursorTable>;
+export type PendingAppFrameTable = {
+    group_id: string;
+    device_id: string;
+    frame_id: string;
+    topic_id: string;
+    protocol: string;
+    segment: number;
+    position: string;
+    payload: Uint8Array;
+    sender_did: string;
+    created_at: CreatedAtColumn;
+};
+export type PendingAppFrameRow = Selectable<PendingAppFrameTable>;
 export type HubTable = {
     id: string;
     label: string | null;
@@ -222,9 +346,69 @@ export type PaginatedResult<T> = {
     entries: Array<T>;
     hasMore: boolean;
 };
+export type OwnAgentsRecordTable = {
+    type: string;
+    owner: string;
+    id: string;
+    hlc: string;
+    op_jwt: string;
+    op_hash: string;
+    payload: Uint8Array | null;
+    payload_digest: string | null;
+    deleted: number;
+    meta: JSONValueColumn<Record<string, unknown>>;
+    created_at: CreatedAtColumn;
+};
+export type OwnAgentsGrantKind = 'trustedGrant' | 'leaf' | 'leafDirect';
+export type OwnAgentsGrantTable = {
+    controller_did: string;
+    kind: OwnAgentsGrantKind;
+    token: string;
+    issued_at: number;
+    expires_at: number;
+};
+export type OwnAgentsJoinCapabilityTable = {
+    group_id: string;
+    recipient_did: string;
+    capability_id: string;
+    token: string;
+    expires_at: number;
+    signer_did: NullableStringColumn;
+    signer_leaf_key: ColumnType<Uint8Array | null, Uint8Array | null | undefined, Uint8Array | null>;
+    signer_capability: NullableStringColumn;
+    signer_prefix: ColumnType<{
+        events: Array<unknown>;
+    } | null, {
+        events: Array<unknown>;
+    } | null | undefined, {
+        events: Array<unknown>;
+    } | null>;
+};
+export type BindingEvidenceTable = {
+    controller_did: string;
+    device_did: string;
+    first_seen_at: CreatedAtColumn;
+};
 export type P2PStoreTables = {
+    kubun_p2p_access_default_revocations: {
+        controller_did: string;
+        device_did: string;
+    };
+    kubun_p2p_binding_evidence: BindingEvidenceTable;
+    kubun_p2p_own_agents_records: OwnAgentsRecordTable;
+    kubun_p2p_own_agents_grants: OwnAgentsGrantTable;
+    kubun_p2p_own_agents_join_capabilities: OwnAgentsJoinCapabilityTable;
     kubun_p2p_groups: GroupTable;
     kubun_p2p_group_members: GroupMemberTable;
+    kubun_p2p_catalog_offers: CatalogOfferTable;
+    kubun_p2p_catalog_routes: CatalogRouteTable;
+    kubun_p2p_unserved_groups: UnservedGroupTable;
+    kubun_p2p_catalog_cursors: CatalogCursorTable;
+    kubun_p2p_document_repairs: DocumentRepairTable;
+    kubun_p2p_document_repair_answers: DocumentRepairAnswerTable;
+    kubun_p2p_observation_repairs: ObservationRepairScheduleTable;
+    kubun_p2p_observation_repair_peers: ObservationRepairPeerTable;
+    kubun_p2p_group_leave_requests: GroupLeaveRequestTable;
     kubun_p2p_circles: CircleTable;
     kubun_p2p_circle_members: CircleMemberTable;
     kubun_p2p_group_delegation: GroupDelegationTable;
@@ -232,10 +416,14 @@ export type P2PStoreTables = {
     kubun_p2p_sync_peers: SyncPeerTable;
     kubun_p2p_sync_checkpoints: SyncCheckpointTable;
     kubun_p2p_broadcast_log: BroadcastLogTable;
+    kubun_p2p_log_handler_completion: LogHandlerCompletionTable;
     kubun_p2p_control_requests: ControlRequestTable;
     kubun_p2p_commit_journal: CommitJournalEntryTable;
     kubun_p2p_group_anchor: GroupAnchorTable;
+    kubun_p2p_app_outbox: AppOutboxTable;
+    kubun_p2p_app_outbox_state: AppOutboxStateTable;
     kubun_p2p_app_cursor: AppCursorTable;
+    kubun_p2p_app_pending: PendingAppFrameTable;
     kubun_p2p_hubs: HubTable;
     kubun_p2p_group_hubs: GroupHubTable;
     kubun_p2p_peer_announcements: PeerAnnouncementTable;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubun/store-p2p",
-  "version": "0.17.0",
+  "version": "0.18.1",
   "keywords": [],
   "license": "see LICENSE.md",
   "sideEffects": false,
@@ -15,18 +15,23 @@
     "LICENSE.md"
   ],
   "dependencies": {
-    "@kokuin/capability": "^0.3.0",
-    "@kokuin/token": "^0.5.0",
-    "@kubun/db": "^0.17.0",
-    "@kubun/db-adapter": "^0.17.0",
-    "@kubun/logger": "^0.17.0",
-    "kysely": "^0.29.5"
+    "@kokuin/capability": "^0.4.2",
+    "@kokuin/controller": "^0.1.0",
+    "@kokuin/token": "^0.5.1",
+    "@kubun/db": "^0.18.0",
+    "@kubun/db-adapter": "^0.18.0",
+    "@kubun/logger": "^0.18.0",
+    "@kubun/records": "^0.18.0",
+    "@kumiai/rpc": "^0.10.9",
+    "@noble/ciphers": "^2.4.0",
+    "@sozai/runtime": "^0.1.0",
+    "kysely": "^0.29.7"
   },
   "devDependencies": {
-    "@kubun/db-better-sqlite": "^0.17.0",
-    "@kubun/db-postgres": "^0.17.0",
-    "@kubun/hlc": "^0.17.0",
-    "@testcontainers/postgresql": "^12.1.0"
+    "@kubun/db-better-sqlite": "^0.18.0",
+    "@kubun/db-postgres": "^0.18.0",
+    "@kubun/hlc": "^0.18.0",
+    "@testcontainers/postgresql": "^12.2.1"
   },
   "publishConfig": {
     "access": "public"