@ibgib/core-gib 0.1.61 → 0.1.63

package/src/keystone/keystone-service-v1.mts

@@ -1,22 +1,30 @@
 import { extractErrorMsg, mergeMapsOrArrays_Naive } from '@ibgib/helper-gib/dist/helpers/utils-helper.mjs';
-import { getIbGibAddr } from '@ibgib/ts-gib/dist/helper.mjs';
+import { getIbGibAddr, getIbAndGib } from '@ibgib/ts-gib/dist/helper.mjs';
+import { IbGibAddr } from '@ibgib/ts-gib/dist/types.mjs';
+import { IbGib_V1 } from '@ibgib/ts-gib/dist/V1/types.mjs';
 
 import { GLOBAL_LOG_A_LOT } from '../core-constants.mjs';
 import {
     KeystoneData_V1, KeystoneIbGib_V1, KeystonePoolConfig, KeystoneClaim,
     KeystoneChallengePool, KeystoneReplenishStrategy, KeystoneRevocationInfo,
+    DelegateKeystoneStatus,
 } from './keystone-types.mjs';
 import { KeystoneStrategyFactory } from './strategy/keystone-strategy-factory.mjs';
-import { POOL_ID_REVOKE, KEYSTONE_VERB_REVOKE, KEYSTONE_VERB_MANAGE, KEYSTONE_CHECKPOINT_FREQUENCY } from './keystone-constants.mjs';
+import {
+    POOL_ID_REVOKE, KEYSTONE_VERB_REVOKE, KEYSTONE_VERB_MANAGE,
+    KEYSTONE_CHECKPOINT_FREQUENCY, POOL_ID_MANAGE, KEYSTONE_VERB_SYNC
+} from './keystone-constants.mjs';
 import {
     createKeystoneIbGibImpl, evolvePersistAndRegisterKeystone,
     generateOpaqueChallengeId, resolveTargetPool, selectChallengeIds,
     solveAndReplenish, validateKeystoneTransition,
     validateGenesisKeystone, validateKeystoneGraph
 } from './keystone-helpers.mjs';
+import { getLatestAddrs } from '../witness/space/space-helper.mjs';
 import { IbGibSpaceAny } from '../witness/space/space-base-v1.mjs';
 import { MetaspaceService } from '../witness/space/metaspace/metaspace-types.mjs';
 import { FlatIbGibGraph } from '../common/other/graph-types.mjs';
+import { getTjpAddr } from '../common/other/ibgib-helper.mjs';
 
 const logalot = GLOBAL_LOG_A_LOT;
 
@@ -110,6 +118,7 @@ export class KeystoneService_V1 {
         frameDetails,
         metaspace,
         space,
+        dataToPatch,
     }: {
         latestKeystone: KeystoneIbGib_V1;
         /**
@@ -133,6 +142,7 @@ export class KeystoneService_V1 {
         frameDetails?: any;
         metaspace: MetaspaceService;
         space: IbGibSpaceAny;
+        dataToPatch?: Partial<KeystoneData_V1>;
     }): Promise<KeystoneIbGib_V1> {
         const lc = `${this.lc}[${this.sign.name}]`;
         try {
@@ -193,6 +203,8 @@ export class KeystoneService_V1 {
                 proofs: [proof],
                 frameDetails,
                 checkpointDetails,
+                ...(prevData.delegates ? { delegates: prevData.delegates } : {}),
+                ...dataToPatch,
             };
 
             // 5. Commit (Evolve, Persist, Register)
@@ -236,6 +248,213 @@ export class KeystoneService_V1 {
         return errors;
     }
 
+    /**
+     * Registers a delegate keystone on the parent keystone by appending its information
+     * to the parent's `delegates` map. This operation is signed using the parent's `manage` pool.
+     * Validates the delegate keystone's entire graph/timeline before registering.
+     */
+    async registerDelegate({
+        parentKeystone,
+        delegateKeystone,
+        masterSecret,
+        frameDetails,
+        metaspace,
+        space,
+        allowedVerbs,
+    }: {
+        parentKeystone: KeystoneIbGib_V1;
+        delegateKeystone: KeystoneIbGib_V1;
+        masterSecret: string;
+        frameDetails?: any;
+        metaspace: MetaspaceService;
+        space: IbGibSpaceAny;
+        allowedVerbs: string[];
+    }): Promise<KeystoneIbGib_V1> {
+        const lc = `${this.lc}[${this.registerDelegate.name}]`;
+        try {
+            if (logalot) { console.log(`${lc} starting...`); }
+
+            // 1. Validate the delegate keystone's entire graph/timeline
+            const validationErrors = await validateKeystoneGraph({
+                keystoneIbGib: delegateKeystone,
+                getLatest: true,
+                invalidIfMoreRecentKeystoneFoundInSpace: false,
+                space,
+            });
+            if (validationErrors.length > 0) {
+                throw new Error(`Delegate keystone validation failed: ${validationErrors.join(', ')} (E: 88fa8ab28c9b60e68994511a5825)`);
+            }
+
+            // 2. Verify that parent contains POOL_ID_MANAGE pool configuration
+            const prevData = parentKeystone.data!;
+            const hasManagePool = prevData.challengePools.some(p => p.id === POOL_ID_MANAGE);
+            if (!hasManagePool) {
+                throw new Error(`Parent keystone does not support delegation. Manage pool is required. (E: 818fa8ab28c9b60e68994511a5825)`);
+            }
+
+            const delegateTjpAddr = getTjpAddr({ ibGib: delegateKeystone });
+            if (!delegateTjpAddr) { throw new Error(`(UNEXPECTED) delegateTjpAddr falsy? (E: d4d6e8ad03c8925d4838b9a87b8f2826)`); }
+
+            // 3. Prepare the claim
+            const claim: Partial<KeystoneClaim> = {
+                target: delegateTjpAddr,
+                verb: KEYSTONE_VERB_MANAGE,
+            };
+
+            // 4. Update the delegates map
+            const currentDelegates = prevData.delegates ? { ...prevData.delegates } : {};
+            currentDelegates[delegateTjpAddr] = {
+                delegateTjpAddr,
+                delegateAddr: getIbGibAddr({ ibGib: delegateKeystone }),
+                thisAddr: getIbGibAddr({ ibGib: parentKeystone }),
+                // allowedVerbs: allowedVerbs ?? [KEYSTONE_VERB_SYNC], // NO! We cannot default to sync just to get things to work right now
+                allowedVerbs,
+            };
+
+            // 5. Sign & evolve parent keystone using the 'manage' pool
+            const evolved = await this.sign({
+                latestKeystone: parentKeystone,
+                masterSecret,
+                claim,
+                poolId: POOL_ID_MANAGE,
+                frameDetails,
+                metaspace,
+                space,
+                dataToPatch: {
+                    delegates: currentDelegates
+                }
+            });
+
+            return evolved;
+        } catch (error) {
+            console.error(`${lc} ${extractErrorMsg(error)}`);
+            throw error;
+        } finally {
+            if (logalot) { console.log(`${lc} complete.`); }
+        }
+    }
+
+    /**
+     * Unregisters a delegate keystone from the parent keystone by removing its entry
+     * from the parent's `delegates` map. This operation is signed using the parent's `manage` pool.
+     */
+    async unregisterDelegate({
+        parentKeystone,
+        delegateTjpAddr,
+        masterSecret,
+        frameDetails,
+        metaspace,
+        space,
+    }: {
+        parentKeystone: KeystoneIbGib_V1;
+        delegateTjpAddr: IbGibAddr;
+        masterSecret: string;
+        frameDetails?: any;
+        metaspace: MetaspaceService;
+        space: IbGibSpaceAny;
+    }): Promise<KeystoneIbGib_V1> {
+        const lc = `${this.lc}[${this.unregisterDelegate.name}]`;
+        try {
+            if (logalot) { console.log(`${lc} starting...`); }
+
+            // 1. Verify that parent contains POOL_ID_MANAGE pool configuration
+            const prevData = parentKeystone.data!;
+            const hasManagePool = prevData.challengePools.some(p => p.id === POOL_ID_MANAGE);
+            if (!hasManagePool) {
+                throw new Error(`Parent keystone does not support delegation. Manage pool is required. (E: 3889f8ab28c9b60e68994511a5825)`);
+            }
+
+            // 2. Prepare the claim
+            const claim: Partial<KeystoneClaim> = {
+                target: delegateTjpAddr,
+                verb: KEYSTONE_VERB_MANAGE,
+            };
+
+            // 3. Update the delegates map
+            const currentDelegates = prevData.delegates ? { ...prevData.delegates } : {};
+            if (!currentDelegates[delegateTjpAddr]) {
+                throw new Error(`Delegate ${delegateTjpAddr} is not registered on this parent. (E: 81d9f8ab28c9b60e68994511a5825)`);
+            }
+            delete currentDelegates[delegateTjpAddr];
+
+            // 4. Sign & evolve parent keystone using the 'manage' pool
+            const evolved = await this.sign({
+                latestKeystone: parentKeystone,
+                masterSecret,
+                claim,
+                poolId: POOL_ID_MANAGE,
+                frameDetails,
+                metaspace,
+                space,
+                dataToPatch: {
+                    delegates: currentDelegates
+                }
+            });
+
+            return evolved;
+        } catch (error) {
+            console.error(`${lc} ${extractErrorMsg(error)}`);
+            throw error;
+        } finally {
+            if (logalot) { console.log(`${lc} complete.`); }
+        }
+    }
+
+    /**
+     * Gets the registration status of a delegate keystone from the parent's latest tip frame.
+     */
+    async getDelegateStatus({
+        parentTjpAddr,
+        delegateTjpAddr,
+        metaspace,
+        space,
+    }: {
+        parentTjpAddr: IbGibAddr;
+        delegateTjpAddr: IbGibAddr;
+        metaspace: MetaspaceService;
+        space: IbGibSpaceAny;
+    }): Promise<DelegateKeystoneStatus> {
+        const lc = `${this.lc}[${this.getDelegateStatus.name}]`;
+        try {
+            if (logalot) { console.log(`${lc} starting...`); }
+
+            const { ib, gib } = getIbAndGib({ ibGibAddr: parentTjpAddr });
+            const parentIbGib: IbGib_V1 = { ib, gib };
+            const resGetLatest = await getLatestAddrs({
+                ibGibs: [parentIbGib],
+                space,
+            });
+
+            if (!resGetLatest.data?.latestAddrsMap) {
+                return { registered: false };
+            }
+
+            const latestAddr = resGetLatest.data.latestAddrsMap[parentTjpAddr];
+            if (!latestAddr) {
+                return { registered: false };
+            }
+
+            const resGet = await metaspace.get({ addr: latestAddr, space });
+            const latestParent = resGet.ibGibs?.at(0) as KeystoneIbGib_V1;
+            if (!latestParent || !latestParent.data) {
+                return { registered: false };
+            }
+
+            const delegates = latestParent.data.delegates || {};
+            const delegateInfo = delegates[delegateTjpAddr];
+
+            return {
+                registered: !!delegateInfo,
+                delegateInfo,
+            };
+        } catch (error) {
+            console.error(`${lc} ${extractErrorMsg(error)}`);
+            throw error;
+        } finally {
+            if (logalot) { console.log(`${lc} complete.`); }
+        }
+    }
+
     /**
      * Validates a genesis keystone.
      *
@@ -429,6 +648,7 @@ export class KeystoneService_V1 {
                 revocationInfo,
                 frameDetails,
                 checkpointDetails,
+                ...(prevData.delegates ? { delegates: prevData.delegates } : {}),
             };
 
             // 7. Commit
@@ -555,6 +775,7 @@ export class KeystoneService_V1 {
                 challengePools: finalPools,
                 proofs: [proof], // The proof authorizes the structure change
                 checkpointDetails,
+                ...(prevData.delegates ? { delegates: prevData.delegates } : {}),
             };
 
             // 7. Commit