feat(indy-vdr): register revocation registry definitions and status list #1693

berendsliedrecht · 2024-01-08T16:56:39Z

Adds support for the IndyVdrAnonCredsRegistry to register:
- Revocation Registry Definition
- Revocation Status List
Implementation is mostly copied from the registerCredentialDefinition as there is a 90% overlap.

TimoGlastra

Nice :)

TimoGlastra · 2024-01-09T01:59:04Z

packages/indy-vdr/src/anoncreds/IndyVdrAnonCredsRegistry.ts

+        writeRequest = new CustomRequest({ customRequest: endorsedTransaction })
+        const operation = JSON.parse(endorsedTransaction)?.operation
+        // extract the seqNo from the endorsed transaction, which is contained in the ref field of the operation
+        seqNo = Number(operation?.ref)


How can we use the seqNo from a transaction that has not been published to the ledger yet? That's not possible right?

It seems that this should be the seqNo of the schema. As I've been looking at the structure of the id and it's as follows:

We should probably rename seqNo in the method to schemaSeqNo.

I think ref is used in the cred def transaction to reference the schema

I think this is not fixed yet (not sure if you were still looking at it)

TimoGlastra · 2024-01-09T02:09:16Z

packages/indy-vdr/src/anoncreds/IndyVdrAnonCredsRegistry.ts

+        const revocationRegistryDefinitionRequest = new RevocationRegistryEntryRequest({
+          submitterDid: namespaceIdentifier,
+          revocationRegistryEntry: {
+            ver: '1.0',
+            value: {
+              accum: revocationStatusList.currentAccumulator,
+            },
+          },
+          revocationRegistryDefinitionType: 'CL_ACCUM',
+          revocationRegistryDefinitionId: revocationStatusList.revRegDefId,
+        })


We also need to pass the issued/revoked indices here. These are missing in the JS wrapper: hyperledger/indy-vdr#165

Not sure if you can pass them with a ts-ignore for now and they will be passed on automatically to indy-vdr native lib or whether actual changes need to be published for this transaction can work: hyperledger/indy-vdr#165

It seems to be passing the entry value as a whole to indy-vdr, so I think it should just work by passing the values: https://github.com/hyperledger/indy-vdr/blob/main/wrappers/javascript/indy-vdr-nodejs/src/NodeJSIndyVdr.ts#L405

See: https://github.com/hyperledger/indy-node/blob/main/design/anoncreds.md#revoc_reg_entry-txn

It is still a bit confusing, but the public API now also accepts the issued/revoked arrays as I assumed that that was the point. The changes between indy-sdk, indy-vdr, non-indy ledgers and anoncreds objects vs indy objects is causing quite some confusion ;).

Signed-off-by: Berend Sliedrecht <sliedrecht@berend.io>

TimoGlastra · 2024-01-12T04:05:02Z

packages/anoncreds/src/models/registry.ts

+  issued?: Array<number>
+  revoked?: Array<number>


Suggested change

issued?: Array<number>

revoked?: Array<number>

These should not be added here. The revocation status list is the model as used by AnonCreds now, and defined in the AnonCreds specification. Indy uses deltas and in those deltas are issued and revoked keys.

So we need to do the following:

Whenever we want to issue/revoke we create or update a status list, then in the indy anoncreds registry implementation we take the current status list and compare it to the new status list. Based on that we can get the issued/revoked indices

Whenever we want to get a status list (this is already implemented before your PR) we get the detlas, and based on all deltas we construct the revocation list.

So it's important to know: Indy ALWAYS uses detlas on ledger, but everywhere else we use revocation status list as much as possible. So the indy way of doing things should only be used in the Indy anonCreds registry and be transformed to the anoncreds public models (which is revocation status list)

How do we construct a status list from the deltas? Is that something that indy-vdr provides?

There's an util for that in AFJ : https://github.com/openwallet-foundation/agent-framework-javascript/blob/1d333770dcc9e261446b43b5f4cd5626fa7ac4a7/packages/indy-vdr/src/anoncreds/utils/transform.ts#L3C7-L3C7

TimoGlastra · 2024-01-12T04:06:39Z

packages/anoncreds/src/utils/indyIdentifiers.ts

+export function getUnqualifiedRevocationRegistryEntryId(
  unqualifiedDid: string,
-  seqNo: string | number,
+  schemaSeqNo: string | number,
  credentialDefinitionTag: string,
  revocationRegistryTag: string
 ) {
-  return `${unqualifiedDid}:4:${unqualifiedDid}:3:CL:${seqNo}:${credentialDefinitionTag}:CL_ACCUM:${revocationRegistryTag}`
+  return `${unqualifiedDid}:5:${unqualifiedDid}:3:CL:${schemaSeqNo}:${credentialDefinitionTag}:CL_ACCUM:${revocationRegistryTag}`
 }


When do we need to retrieve revocation registry entries? We only need to get the deltas right?

TimoGlastra · 2024-01-12T04:07:18Z

packages/indy-sdk/src/anoncreds/utils/transform.ts

+    revoked: delta.value.revoked,
+    issued: delta.value.issued,


We should use the deltas only to create the status list

Suggested change

revoked: delta.value.revoked,

issued: delta.value.issued,

TimoGlastra · 2024-01-12T04:08:37Z

packages/indy-vdr/src/anoncreds/utils/transform.ts

+    revoked: delta.revoked,
+    issued: delta.issued,


Suggested change

revoked: delta.revoked,

issued: delta.issued,

TimoGlastra · 2024-01-12T04:10:48Z

packages/indy-vdr/src/anoncreds/IndyVdrAnonCredsRegistry.ts

+        writeRequest = new CustomRequest({ customRequest: endorsedTransaction })
+        const operation = JSON.parse(endorsedTransaction)?.operation
+        // extract the seqNo from the endorsed transaction, which is contained in the ref field of the operation
+        seqNo = Number(operation?.ref)


I think this is not fixed yet (not sure if you were still looking at it)

TimoGlastra · 2024-01-12T04:16:53Z

packages/indy-vdr/src/anoncreds/IndyVdrAnonCredsRegistry.ts

+      const schemaSeqNo = Number(schemaMetadata.indyLegderSeqNo)
+      const didIndyRevocationRegistryEntryId = getDidIndyRevocationRegistryEntryId(
+        namespace,
+        namespaceIdentifier,
+        schemaSeqNo,
+        credentialDefinition.tag,
+        revocationRegistryDefinition.tag
+      )
+


The revocation registry definition id is already passed as part of the input to this method, so I don't think it's needed to fetch the schema + cred def + revoc reg to construct the id.

Rather we can take it from revocationStatusList .revRegDefId

TimoGlastra · 2024-01-12T04:18:31Z

packages/indy-vdr/src/anoncreds/IndyVdrAnonCredsRegistry.ts

+              accum: revocationStatusList.currentAccumulator,
+              // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+              // @ts-expect-error
+              issued: revocationStatusList.issued ?? [],
+              revoked: revocationStatusList.revoked ?? [],


So here we need to get the current state, and based on the current statusList and the new statusList we need to calculate the issued and revoked indices.

TimoGlastra · 2024-01-12T04:19:15Z

packages/indy-vdr/tests/indy-vdr-anoncreds-registry.e2e.test.ts

-      agent.context,
-      legacyRevocationRegistryId,
-      entryResponse.result.txnMetadata.txnTime
+    console.log(JSON.stringify(revRegDefResp))


Suggested change

console.log(JSON.stringify(revRegDefResp))

berendsliedrecht · 2024-01-15T15:47:54Z

@TimoGlastra I am getting very close, but somehow it can't fetch the delta when I try to make the request (logs here https://github.com/openwallet-foundation/agent-framework-javascript/actions/runs/7531063980/job/20498795265?pr=1693#step:10:93)

Do you have any idea? Registration seems to respond with all the correct data.

TimoGlastra · 2024-01-15T16:39:29Z

Did you add a sleep? Indy takes a while to process a write. I'll take a good look at it tomorrow

berendsliedrecht · 2024-01-15T18:16:56Z

Did you add a sleep? Indy takes a while to process a write. I'll take a good look at it tomorrow

Yes! But it is just a second, so maybe increasing it will help

Signed-off-by: Berend Sliedrecht <sliedrecht@berend.io>

Signed-off-by: Timo Glastra <timo@animo.id>

Signed-off-by: Berend Sliedrecht <sliedrecht@berend.io>

TimoGlastra

Sorry a few more comments. But rest looks good!!

TimoGlastra · 2024-01-18T03:16:20Z

packages/indy-vdr/tests/indy-vdr-anoncreds-registry.e2e.test.ts

@@ -90,7 +90,7 @@ describe('IndyVdrAnonCredsRegistry', () => {
    await agent.wallet.delete()
  })

-  test('register and resolve a schema and credential definition (internal, issuerDid != endorserDid)', async () => {
+  xtest('register and resolve a schema and credential definition (internal, issuerDid != endorserDid)', async () => {


These are disabled and also are not updated with the new register methods.

TimoGlastra · 2024-01-18T03:18:32Z

packages/indy-vdr/src/anoncreds/IndyVdrAnonCredsRegistry.ts

+        }
+      }
+
+      const schemaSeqNo = schemaMetadata.indyLedgerSeqNo


We can extract the schema seqNo from the cred def id

So we don't have to fetch the schema

TimoGlastra · 2024-01-18T03:19:52Z

packages/indy-vdr/src/anoncreds/IndyVdrAnonCredsRegistry.ts

-      agentContext.config.logger.trace(
-        `Submitting get revocation registry delta request for revocation registry '${revocationRegistryId}' to ledger`
+      // TODO: this will bypass caching if done on a higher level.
+      const { credentialDefinition, resolutionMetadata } = await this.getCredentialDefinition(


Why do we need to fetch the cred def? We can extract all needed parts from the cred def id. And indy will reject if something is wrong

TimoGlastra · 2024-01-18T03:21:48Z

packages/indy-vdr/src/anoncreds/IndyVdrAnonCredsRegistry.ts

+      )
+
+      if (revocationRegistryNamespace && revocationRegistryNamespace !== namespace) {
+        // throw error


These are still todo. If we do it in separate pr we should remove it for now

Signed-off-by: Berend Sliedrecht <sliedrecht@berend.io>

…ist (openwallet-foundation#1693) Signed-off-by: Ariel Gentile <gentilester@gmail.com>

Signed-off-by: Ariel Gentile <gentilester@gmail.com> feat: deliver messages individually, not fetching from the queue every time Signed-off-by: Ariel Gentile <gentilester@gmail.com> chore: revert to free runners (openwallet-foundation#1662) Signed-off-by: Ry Jones <ry@linux.com> Signed-off-by: Ariel Gentile <gentilester@gmail.com> chore: create settings.yml (openwallet-foundation#1663) Signed-off-by: Ry Jones <ry@linux.com> Signed-off-by: Ariel Gentile <gentilester@gmail.com> chore: fix ci and add note to readme (openwallet-foundation#1669) Signed-off-by: Timo Glastra <timo@animo.id> Signed-off-by: Ariel Gentile <gentilester@gmail.com> docs: update active maintainers (openwallet-foundation#1664) Signed-off-by: Karim Stekelenburg <karim@animo.id> Signed-off-by: Ariel Gentile <gentilester@gmail.com> feat: did:peer:2 and did:peer:4 support in DID Exchange (openwallet-foundation#1550) Signed-off-by: Ariel Gentile <gentilester@gmail.com> feat(presentation-exchange): added PresentationExchangeService (openwallet-foundation#1672) Signed-off-by: Berend Sliedrecht <sliedrecht@berend.io> Signed-off-by: Ariel Gentile <gentilester@gmail.com> chore: removed jan as maintainer (openwallet-foundation#1678) Signed-off-by: Timo Glastra <timo@animo.id> Signed-off-by: Ariel Gentile <gentilester@gmail.com> ci: change secret (openwallet-foundation#1679) Signed-off-by: Timo Glastra <timo@animo.id> Signed-off-by: Ariel Gentile <gentilester@gmail.com> chore: add meta to rxjs timeout errors (openwallet-foundation#1683) Signed-off-by: Timo Glastra <timo@animo.id> Signed-off-by: Ariel Gentile <gentilester@gmail.com> build(deps): bump ws and @types/ws (openwallet-foundation#1686) Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: Ariel Gentile <gentilester@gmail.com> build(deps): bump follow-redirects from 1.15.2 to 1.15.4 (openwallet-foundation#1694) Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: Ariel Gentile <gentilester@gmail.com> chore: update shared components libraries (openwallet-foundation#1691) Signed-off-by: Timo Glastra <timo@animo.id> Signed-off-by: Ariel Gentile <gentilester@gmail.com> fix: properly print key class (openwallet-foundation#1684) Signed-off-by: Timo Glastra <timo@animo.id> Signed-off-by: Ariel Gentile <gentilester@gmail.com> feat(present-proof): add support for aries RFC 510 (openwallet-foundation#1676) Signed-off-by: Berend Sliedrecht <sliedrecht@berend.io> Signed-off-by: Ariel Gentile <gentilester@gmail.com> fix(present-proof): isolated tests (openwallet-foundation#1696) Signed-off-by: Ariel Gentile <gentilester@gmail.com> feat(indy-vdr): register revocation registry definitions and status list (openwallet-foundation#1693) Signed-off-by: Ariel Gentile <gentilester@gmail.com> chore: rename to credo-ts (openwallet-foundation#1703) Signed-off-by: Ry Jones <ry@linux.com> Signed-off-by: Ariel Gentile <gentilester@gmail.com> ci: fix git checkout path and update setup-node (openwallet-foundation#1709) Signed-off-by: Ariel Gentile <gentilester@gmail.com> fix: remove check for DifPresentationExchangeService dependency (openwallet-foundation#1702) Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com> Signed-off-by: Ariel Gentile <gentilester@gmail.com> docs: update zoom meeting link (openwallet-foundation#1706) Signed-off-by: Timo Glastra <timo@animo.id> Signed-off-by: Ariel Gentile <gentilester@gmail.com> refactor(oob)!: make label optional (openwallet-foundation#1680) Signed-off-by: Timo Glastra <timo@animo.id> Co-authored-by: Ariel Gentile <gentilester@gmail.com> Signed-off-by: Ariel Gentile <gentilester@gmail.com> feat: support short legacy connectionless invitations (openwallet-foundation#1705) Signed-off-by: Timo Glastra <timo@animo.id> Signed-off-by: Ariel Gentile <gentilester@gmail.com> feat(dids)!: did caching (openwallet-foundation#1710) feat: did caching Signed-off-by: Timo Glastra <timo@animo.id> Signed-off-by: Ariel Gentile <gentilester@gmail.com> fix: jsonld document loader node 18 (openwallet-foundation#1454) Signed-off-by: Timo Glastra <timo@animo.id> Signed-off-by: Ariel Gentile <gentilester@gmail.com> build(deps): bump amannn/action-semantic-pull-request from 5.3.0 to 5.4.0 (openwallet-foundation#1656) build(deps): bump amannn/action-semantic-pull-request Bumps [amannn/action-semantic-pull-request](https://github.com/amannn/action-semantic-pull-request) from 5.3.0 to 5.4.0. - [Release notes](https://github.com/amannn/action-semantic-pull-request/releases) - [Changelog](https://github.com/amannn/action-semantic-pull-request/blob/main/CHANGELOG.md) - [Commits](amannn/action-semantic-pull-request@v5.3.0...v5.4.0) --- updated-dependencies: - dependency-name: amannn/action-semantic-pull-request dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Timo Glastra <timo@animo.id> Signed-off-by: Ariel Gentile <gentilester@gmail.com> feat: did rotate (openwallet-foundation#1699) Signed-off-by: Ariel Gentile <gentilester@gmail.com> refactor: pickup protocol method names Signed-off-by: Ariel Gentile <gentilester@gmail.com>

TimoGlastra reviewed Jan 9, 2024

View reviewed changes

berendsliedrecht force-pushed the indy-vdr-register-revocation-objects branch 2 times, most recently from e4a9a1c to 2d46f52 Compare January 10, 2024 11:29

feat(indy-vdr): register revocation registry definitions and status list

419443b

Signed-off-by: Berend Sliedrecht <sliedrecht@berend.io>

berendsliedrecht force-pushed the indy-vdr-register-revocation-objects branch 13 times, most recently from 3ad9693 to bac520e Compare January 11, 2024 20:09

TimoGlastra reviewed Jan 12, 2024

View reviewed changes

berendsliedrecht force-pushed the indy-vdr-register-revocation-objects branch 11 times, most recently from c039c16 to d308681 Compare January 15, 2024 12:10

berendsliedrecht force-pushed the indy-vdr-register-revocation-objects branch 10 times, most recently from 6c811a2 to 93b7f2f Compare January 15, 2024 15:35

berendsliedrecht force-pushed the indy-vdr-register-revocation-objects branch from 93b7f2f to 5e8667d Compare January 15, 2024 16:06

test: register revocation registry definition and status list

5c6e03c

Signed-off-by: Berend Sliedrecht <sliedrecht@berend.io>

berendsliedrecht force-pushed the indy-vdr-register-revocation-objects branch from 5e8667d to 5c6e03c Compare January 16, 2024 10:32

TimoGlastra and others added 2 commits January 17, 2024 16:31

fix the test

6f011ad

Signed-off-by: Timo Glastra <timo@animo.id>

fix: removed timestamp from the in memory revocation status list

becd233

Signed-off-by: Berend Sliedrecht <sliedrecht@berend.io>

berendsliedrecht marked this pull request as ready for review January 17, 2024 10:46

berendsliedrecht requested a review from a team as a code owner January 17, 2024 10:46

berendsliedrecht force-pushed the indy-vdr-register-revocation-objects branch from 0a5421f to d3d2993 Compare January 17, 2024 11:27

fix: added additional check for status list transformation

f0969be

Signed-off-by: Berend Sliedrecht <sliedrecht@berend.io>

berendsliedrecht force-pushed the indy-vdr-register-revocation-objects branch from d3d2993 to f0969be Compare January 17, 2024 12:29

TimoGlastra approved these changes Jan 18, 2024

View reviewed changes

berendsliedrecht added 2 commits January 18, 2024 12:10

fix: resolved feedback

6454a2d

Signed-off-by: Berend Sliedrecht <sliedrecht@berend.io>

test: added revocation registry definition and status list

3702324

Signed-off-by: Berend Sliedrecht <sliedrecht@berend.io>

berendsliedrecht force-pushed the indy-vdr-register-revocation-objects branch from 2bb1ea1 to 3702324 Compare January 18, 2024 11:38

berendsliedrecht merged commit ee34fe7 into openwallet-foundation:main Jan 18, 2024
7 checks passed

genaris pushed a commit to genaris/credo-ts that referenced this pull request Jan 29, 2024

feat(indy-vdr): register revocation registry definitions and status l…

9b10d60

…ist (openwallet-foundation#1693) Signed-off-by: Ariel Gentile <gentilester@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(indy-vdr): register revocation registry definitions and status list #1693

feat(indy-vdr): register revocation registry definitions and status list #1693

berendsliedrecht commented Jan 8, 2024 •

edited

Loading

TimoGlastra left a comment

TimoGlastra Jan 9, 2024

TimoGlastra Jan 9, 2024

TimoGlastra Jan 12, 2024

TimoGlastra Jan 9, 2024

TimoGlastra Jan 9, 2024

berendsliedrecht Jan 10, 2024

TimoGlastra Jan 12, 2024

berendsliedrecht Jan 12, 2024

TimoGlastra Jan 13, 2024

TimoGlastra Jan 12, 2024

TimoGlastra Jan 12, 2024

TimoGlastra Jan 12, 2024

TimoGlastra Jan 12, 2024

TimoGlastra Jan 12, 2024

TimoGlastra Jan 12, 2024

TimoGlastra Jan 12, 2024

berendsliedrecht commented Jan 15, 2024

TimoGlastra commented Jan 15, 2024

berendsliedrecht commented Jan 15, 2024

TimoGlastra left a comment

TimoGlastra Jan 18, 2024

TimoGlastra Jan 18, 2024

TimoGlastra Jan 18, 2024

TimoGlastra Jan 18, 2024

TimoGlastra Jan 18, 2024

feat(indy-vdr): register revocation registry definitions and status list #1693

feat(indy-vdr): register revocation registry definitions and status list #1693

Conversation

berendsliedrecht commented Jan 8, 2024 • edited Loading

TimoGlastra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

berendsliedrecht commented Jan 15, 2024

TimoGlastra commented Jan 15, 2024

berendsliedrecht commented Jan 15, 2024

TimoGlastra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

berendsliedrecht commented Jan 8, 2024 •

edited

Loading