refactor!: VCs and proper DID documents as basic identity modules in SDK #807

rflechtner · 2023-10-31T16:34:58Z

fixes KILTProtocol/ticket#2156

This PR is the combined result of refactoring efforts over the last couple of months, making the following improvements:

The default representation of Kilt Credentials has been transitioned to one conforming to the VC Data Model 1.0.
- Functions to support and interact with the previous representation is now available from the new package @kiltprotocol/legacy-credentials.
- The new functions are available from the new package @kiltprotocol/credentials.
The Did resolver is now fully specification-conformant, implementing resolve, resolveRepresentation, and dereference as defined in https://www.w3.org/TR/did-core/#resolution.
Implements Verifiable Presentations and VC Data Integrity 1.0 for presentation signing
- We implemented 3 cryptosuites for this purpose, compatible with Digital Bazaar’s implementation
Provides high-level implementations of common use cases, e.g.:
- Resolving a DID
- Issuing a VC
- Creating a Presentation from VCs
- Verifying a VC or a VP, checking the revocation status of a VC
Removal of low-level functions from sdk-js.
- These are still available to be imported directly from the packages in which they are defined.

Checklist:

I have verified that the code works
I have verified that the code is easy to understand
- If not, I have left a well-balanced amount of inline comments
I have left the code in a better state
I have documented the changes (where applicable)
- Either PR or Ticket to update the Docs
- Link the PR/Ticket here

REVERT BEFORE MERGE!

* Add base types for the compliant DIDs * Add base types for the compliant DID resolution * Add dereferencing * Refactor of Did.utils and Did.chain * Work on DID.signature * Bit more mess here and there * yarn check working fine * did.resolve implemented * DID resolver ok * AccountLinks2.chain.ts * Add resolveRepresentation to resolver * Better DID resolver * Resolver improvements * Improve API surface to keep the same abstraction level * First DID integration test passing! * More DID integration tests uncommented * More DID integration tests passing * More DID integration tests * All DID integration tests passing * Refactoring * Add utility function to add a verification method * Minor refactoring * Revert unwanted change * Remove addKeypairAsVerificationMethod function * Light DID unit tests passing * Unit tests for light and full DID passing * Minor changes to signing interfaces * DIDSignature unit tests passing * Halfway through the refactoring * Better error messages * Fix imports * Refactoring * First refactor * Fix DID dereferencing and signature resolution * Compiling! * Compiling after applying stash * Fix TestUtils * verificationRelationship -> verificationRelationships * Prepare ground for proper DID dereferencing * Add support for query params in DID URLs * Compiling again * WIP dereferencing in tests * Credential.spec.ts for legacy credential almost passing * Did.signature.spec.ts working again * Return minimal DID document when DID is deactivated or migrated * Add test for legacy signature support * Sr25519Signature2020.spec.ts test failing * Key -> verification method renaming * Key/service ID to URL * More constants * Fix yarn check * Fix JSDocs * Update tests * Minor refinements * Minor fixes * Apply suggestion * Push different yarn.lock * Fix type import * Fix integration test * Fix integration test pt.2 * Update unit tests for DidResolver.spec.ts * Half-way through new DidResolver unit tests * Unit tests for DidResolver complete * Replace buffer * Apply suggestion * Apply w3n suggestion * export type * Replace Buffer with Uint8Array * Add multikey context * Fix unit tests for linked signature suites * Legacy support for document loader * Make getStoreTxFromDidDocument only used in tests * Use Object.fromEntries * Refactor exportQueryParamsFromUri * Use resolve instead of dereference * Fixes * Revert DidSignature renaming * Rename URI to DID and keep DID URL

Add unit test for failed cases

* chore: upgrade typedoc and fix links (amend me!) * docs: update contribution guide * feat: updaing to new link syntax in asset creds and utils and vc export * feat: updating types links * feat: updating the links in did * feat: updating the links in core * feat: catching missed links * feat: checking whitespaces * style: running through the yarn build docs and catching problems * fix: updating linting * Update packages/types/src/CryptoCallbacks.ts Co-authored-by: Raphael Flechtner <[email protected]> --------- Co-authored-by: Raphael Flechtner <[email protected]> Co-authored-by: Raphael Flechtner <[email protected]>

* refactor!: move credential related functionality in one folder * feat: allow signing of transactions with SignerInterface * refactor!: use Date for timestamp * refactor!: update issue submission options * refactor!: separate presentation creation and signing * feat: credential issuance interfaces * feat: holder credential functions * feat: verifier interfaces

* refactor!: move balance utils to chain-helpers * refactor!: move connect/disconnect to chain-helpers * refactor!: rename core to credentials

* chore: export sr25519Signer * chore: uppercase Issuer, Holder, Verifier * refactor: make signer selection synchronous * fix: missed a few mentions of the old core package * chore: remove unnecessary use of balance utils in bundle tests * chore: do not use encryption when extracting the pk from KeyringPairs

* refactor!: remove all exports but the basics * test: fix tests & bundle tests * feat: export signerFromKeypair * test: interim reduction of coverage goals

Dudleyneedham

LGTM otherwise. There are consistencies to importing and declaring. You use Did for the type some places and KiltDid in others. Let us stick with DID and declare where we use them.

.github/workflows/tests.yml

Dudleyneedham · 2023-12-14T13:05:29Z

package.json

@@ -8,13 +8,13 @@
  "license": "BSD-4-Clause",
  "scripts": {
    "check": "tsc -p tsconfig.json --noEmit",
-    "build": "yarn workspaces foreach -p -t --exclude '{root-workspace}' run build",
+    "build": "yarn workspaces foreach -ptAv --exclude '{root-workspace}' run build",


What is this doing?

p: parallel
t: topological
A: all packages
v: verbose (more info)

Dudleyneedham · 2023-12-14T13:06:20Z

packages/asset-credentials/src/credentials/PublicCredential.spec.ts

-  AssetDidUri,
-  DidUri,
+  AssetDid,
+  Did as KiltDid,


Can you Declare this where it is used?

all these imports are internal... I don't think this is super relevant?

Dudleyneedham · 2023-12-14T13:06:34Z

packages/asset-credentials/src/credentials/PublicCredential.ts

@@ -9,7 +9,7 @@ import type { AccountId } from '@polkadot/types/interfaces'
 import type { PublicCredentialsCredentialsCredential } from '@kiltprotocol/augment-api'
 import type {
  HexString,
-  DidUri,
+  Did as KiltDid,


Same as above.

Dudleyneedham · 2023-12-14T13:08:08Z

packages/credentials/src/V1/KiltAttestationProofV1.spec.ts


 import {
  attestation,
  blockHash,
-  credential,
+  credential as VC,


Please can we do this where we are using it?

Dudleyneedham · 2023-12-14T13:09:35Z

packages/credentials/src/V1/KiltCredentialV1.spec.ts

 import {
-  attestation,
-  credential,
+  credential as VC,


Dudleyneedham · 2023-12-14T13:11:05Z

packages/credentials/src/attestation/Attestation.ts


 /**
- * An [[Attestation]] certifies a [[Claim]], sent by a claimer in the form of a [[Credential]]. [[Attestation]]s are **written on the blockchain** and are **revocable**.
+ * An {@link IAttestation | Attestation} certifies a {@link IClaim | Claim}, sent by a claimer in the form of a {@link ICredential | Credential}. Attestations are **written on the blockchain** and are **revocable**.


Suggested change

* An {@link IAttestation | Attestation} certifies a {@link IClaim | Claim}, sent by a claimer in the form of a {@link ICredential | Credential}. Attestations are **written on the blockchain** and are **revocable**.

* An {@link IAttestation | Attestation} certifies a {@link IClaim | Claim}, sent by a claimer in the form of a {@link ICredential | Credential}.

Attestations are **written on the blockchain** and are **revocable**.

packages/did/src/Did.signature.ts

Dudleyneedham · 2023-12-14T13:35:45Z

packages/utils/src/Signers.ts

+  createSigner as es256kSigner,
+  cryptosuite as es256kSuite,
+} from '@kiltprotocol/es256k-jcs-2023'
+import {
+  createSigner as ed25519Signer,
+  cryptosuite as ed25519Suite,
+} from '@kiltprotocol/eddsa-jcs-2022'
+import {
+  cryptosuite as sr25519Suite,
+  createSigner as sr25519Signer,


Can we declare this where we use it

I wanted to make these available, but obviously they need to be identifiable by the algorithm they use. What are you suggesting?

I suggest if you have a better idea (like exporting both under cryptosuite and createSigner on an object, e.g., ed25519Suite) we make a ticket and implement it on a feature branch forked from develop

rflechtner and others added 30 commits August 23, 2023 15:07

feat: legacy credentials support package

bf5fbed

refactor!: move VC transform to legacy-credentials package

50670b1

refactor!: remove unwanted functions from public api

87ace40

fix: build

0a3fbf0

refactor: review suggestions

7cb6735

chore: enable tests for this branch

600cc31

REVERT BEFORE MERGE!

test: fix testData setup

d20aa8c

Merge branch 'vc-refactor' into rf-legacy-credentials-package

589b4df

chore: update coverage paths

e65ba43

refactor!: move verifyAgainstCredential to legacy

031ed3a

refactor!: move CAIP stuff to utils

661723d

refactor!: remove credential & claim from core

5334c29

refactor!: move VCs to core

12cb807

feat: add basic presentation support to core

d48f393

refactor!: cleanup vc-export

b40b619

refactor: move constants around

d9af4c2

fix: tests & linting

246a3df

test: presentation creation in bundle test

5442d41

feat: legacy credentials package (#786)

af692dc

Merge branch 'vc-refactor' into rf-vcs-in-core-2

9fb423b

refactor!: VCs in core (#798)

1cf468f

feat: SignerInterface type signers

b148622

refactor!: signer interface POC

605cec8

feat: check for sign capability in byDid

3b4c75e

chore: improve error reporting

9230dc5

chore: linting

90222b7

chore: remove all uses of SignCallback

efdb535

refactor!: replace GetStoreTxSignCallback with signer interface

74de98d

test: fix bundle tests

672e251

refactor!: cryptosuite-style signers (#801)

88fb8c0

rflechtner self-assigned this Oct 31, 2023

rflechtner and others added 14 commits October 31, 2023 17:41

chore: don't check presentation proofs if errors are already present

38a3806

fix: bundle test

12eb274

refactor: function signature of verifyProof

65faf6b

docs: docstrings

d5e8878

docs: add TODOs

47e92db

feat: add proof/credential to results

8d6b44c

refactor: only support individual proofs

1d1d00d

chore: remove proof set features

713a8bf

chore: set domain to verifier

8b2b8b8

feat: timestamp verification

86e93b4

chore: review suggestions

24c1174

chore: bubble up did resolution errors

4d72447

docs: link to digitalbazaar typedefs instead of copying them

a6e919f

feat!: new presentations (#808)

5a32443

weichweich mentioned this pull request Nov 15, 2023

refactor!: VC Update KILTprotocol/spec-ext-credential-api#57

Merged

5 tasks

ntn-x2 and others added 7 commits November 22, 2023 10:34

fix: include encoded details in DID validation logic (#810)

e3835fa

Add unit test for failed cases

refactor!: credentials package (#814)

699e79f

* refactor!: move balance utils to chain-helpers * refactor!: move connect/disconnect to chain-helpers * refactor!: rename core to credentials

refactor!: package surfaces (#813)

b4e1e9d

* refactor!: remove all exports but the basics * test: fix tests & bundle tests * feat: export signerFromKeypair * test: interim reduction of coverage goals

Merge branch 'develop' into vc-refactor

3e1b927

rflechtner marked this pull request as ready for review December 14, 2023 13:36

Dudleyneedham approved these changes Dec 14, 2023

View reviewed changes

rflechtner added 2 commits December 14, 2023 14:51

chore: remove vc-refactor from tested branches

5614b63

chore: rename OldDidSignatureV1 to LegacyDidSignature

0342293

rflechtner merged commit 7de0d75 into develop Dec 14, 2023
13 checks passed

rflechtner deleted the vc-refactor branch December 14, 2023 16:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor!: VCs and proper DID documents as basic identity modules in SDK #807

refactor!: VCs and proper DID documents as basic identity modules in SDK #807

rflechtner commented Oct 31, 2023 •

edited

Loading

Dudleyneedham left a comment

Dudleyneedham Dec 14, 2023

rflechtner Dec 14, 2023

Dudleyneedham Dec 14, 2023

rflechtner Dec 14, 2023

Dudleyneedham Dec 14, 2023

Dudleyneedham Dec 14, 2023

Dudleyneedham Dec 14, 2023

Dudleyneedham Dec 14, 2023

Dudleyneedham Dec 14, 2023

rflechtner Dec 14, 2023

rflechtner Dec 14, 2023

	* An {@link IAttestation \| Attestation} certifies a {@link IClaim \| Claim}, sent by a claimer in the form of a {@link ICredential \| Credential}. Attestations are written on the blockchain and are revocable.
	* An {@link IAttestation \| Attestation} certifies a {@link IClaim \| Claim}, sent by a claimer in the form of a {@link ICredential \| Credential}.
	Attestations are written on the blockchain and are revocable.

refactor!: VCs and proper DID documents as basic identity modules in SDK #807

refactor!: VCs and proper DID documents as basic identity modules in SDK #807

Conversation

rflechtner commented Oct 31, 2023 • edited Loading

fixes KILTProtocol/ticket#2156

Checklist:

Dudleyneedham 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

rflechtner commented Oct 31, 2023 •

edited

Loading