feat: get credential registry state (tever vcstate) (WebOfTrust#282)

* feat: get credential registry state (tever vcstate)

* refactor: prettier run

* build: dev4 keria

* build: npm audit run

* test: updates for long running op saids

* test: unit tests

* test: remove log

.github/workflows/main.yml

@@ -57,7 +57,7 @@ jobs:
     strategy:
       matrix:
         os: ['ubuntu-latest']
-        keria-version: ['0.2.0-dev3']
+        keria-version: ['0.2.0-dev4']
         node-version: ['20']
     env:
       KERIA_IMAGE_TAG: ${{ matrix.keria-version }}

docker-compose.yaml

@@ -26,7 +26,7 @@ services:
             - 7723:7723
 
     keria:
-        image: ${KERIA_IMAGE:-weboftrust/keria}:${KERIA_IMAGE_TAG:-0.2.0-dev3}
+        image: ${KERIA_IMAGE:-weboftrust/keria}:${KERIA_IMAGE_TAG:-0.2.0-dev4}
         environment:
             - KERI_AGENT_CORS=1
             - KERI_URL=http://keria:3902

examples/integration-scripts/credentials.test.ts

@@ -1,5 +1,5 @@
 import { strict as assert } from 'assert';
-import { Saider, Serder, SignifyClient } from 'signify-ts';
+import { Ilks, Saider, Serder, SignifyClient } from 'signify-ts';
 import { resolveEnvironment } from './utils/resolve-env';
 import {
     assertNotifications,
@@ -248,6 +248,18 @@ test('single signature credentials', async () => {
         await waitOperation(issuerClient, op);
     });
 
+    await step(
+        'holder can get the credential status before or without holding',
+        async () => {
+            const state = await retry(async () =>
+                holderClient.credentials().state(registry.regk, qviCredentialId)
+            );
+            assert.equal(state.i, qviCredentialId);
+            assert.equal(state.ri, registry.regk);
+            assert.equal(state.et, Ilks.iss);
+        }
+    );
+
     await step('holder IPEX admit', async () => {
         const holderNotifications = await waitForNotifications(
             holderClient,

examples/integration-scripts/singlesig-drt.test.ts

@@ -55,7 +55,7 @@ describe('singlesig-drt', () => {
         kargs = {};
         result = await delegate.identifiers().rotate('delegate1', kargs);
         op = await result.op();
-        expect(op.name).toEqual(`delegation.${delegate1.prefix}`);
+        expect(op.name).toEqual(`delegation.${result.serder.ked.d}`);
 
         // delegator approves delegate
         delegate1 = await delegate.identifiers().get('delegate1');

src/keri/app/credentialing.ts

@@ -229,6 +229,26 @@ export interface IpexAdmitArgs {
     datetime?: string;
 }
 
+export type CredentialState = {
+    vn: [number, number];
+    i: string;
+    s: string;
+    d: string;
+    ri: string;
+    a: { s: number; d: string };
+    dt: string;
+    et: string;
+} & (
+    | {
+          et: 'iss' | 'rev';
+          ra: Record<string, never>;
+      }
+    | {
+          et: 'bis' | 'brv';
+          ra: { i: string; s: string; d: string };
+      }
+);
+
 /**
  * Credentials
  */
@@ -285,6 +305,20 @@ export class Credentials {
         return includeCESR ? await res.text() : await res.json();
     }
 
+    /**
+     * Get the state of a credential
+     * @async
+     * @param {string} ri - management registry identifier
+     * @param {string} said - SAID of the credential
+     * @returns {Promise<CredentialState>} A promise to the credential registry state
+     */
+    async state(ri: string, said: string): Promise<CredentialState> {
+        const path = `/registries/${ri}/${said}`;
+        const method = 'GET';
+        const res = await this.client.fetch(path, method, null);
+        return res.json();
+    }
+
     /**
      * Issue a credential
      */

src/keri/core/core.ts

@@ -32,6 +32,8 @@ export const Ilks = {
     vcp: 'vcp',
     iss: 'iss',
     rev: 'rev',
+    bis: 'bis',
+    brv: 'brv',
 };
 
 export const IcpLabels = [

test/app/credentialing.test.ts

@@ -315,6 +315,16 @@ describe('Credentialing', () => {
         );
         assert.equal(lastBody.sigs[0].substring(0, 2), 'AA');
         assert.equal(lastBody.sigs[0].length, 88);
+
+        await credentials.state(mockCredential.sad.ri, mockCredential.sad.d);
+        lastCall = fetchMock.mock.calls[fetchMock.mock.calls.length - 1]!;
+        assert.equal(
+            lastCall[0]!,
+            url +
+                '/registries/EGK216v1yguLfex4YRFnG7k1sXRjh3OKY7QqzdKsx7df/EMwcsEMUEruPXVwPCW7zmqmN8m0I3CihxolBm-RDrsJo'
+        );
+        assert.equal(lastCall[1]!.method, 'GET');
+        assert.equal(lastCall[1]!.body, null);
     });
 });