feat: legacy credentials package (#786)

jest.config.js

@@ -37,9 +37,9 @@ const common = {
     'index.ts',
     'types.ts',
     '.chain.ts',
+    'DelegationDecoder.ts',
     'SDKErrors.ts',
     'Did.rpc.ts',
-    'packages/utils/src/Chain.ts',
     // third party code copied to this repo
     'packages/utils/src/json-schema/',
     'jsonabc.ts',

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",
     "build:docs": "typedoc --theme default --out docs/api --tsconfig tsconfig.docs.json && touch docs/.nojekyll",
     "bundle": "yarn workspace @kiltprotocol/sdk-js run bundle",
     "clean": "rimraf tests/bundle/dist && rimraf tests/integration/dist && yarn workspaces foreach -p --exclude '{root-workspace}' run clean",
     "clean:docs": "rimraf docs/api",
-    "prepublish": "yarn workspaces foreach -p --no-private exec cp -f ../../LICENSE .",
-    "publish": "yarn workspaces foreach -pt --no-private npm publish",
+    "prepublish": "yarn workspaces foreach -pA --no-private exec cp -f ../../LICENSE .",
+    "publish": "yarn workspaces foreach -ptAv --no-private npm publish",
     "lint": "eslint packages tests --format=codeframe",
     "lint:fix": "yarn lint --fix",
     "set:version": "npm version --no-git-tag-version --no-workspaces-update --workspaces --include-workspace-root",

packages/legacy-credentials/README.md

@@ -0,0 +1,5 @@
+[![](https://user-images.githubusercontent.com/39338561/122415864-8d6a7c00-cf88-11eb-846f-a98a936f88da.png)](https://kilt.io)
+
+![Lint and Test](https://github.com/KILTprotocol/sdk-js/workflows/Lint%20and%20Test/badge.svg)
+
+# KILT Legacy Credentials Support

packages/legacy-credentials/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@kiltprotocol/legacy-credentials",
+  "version": "0.33.2-6",
+  "description": "",
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "types": "./lib/cjs/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./lib/esm/index.js",
+      "require": "./lib/cjs/index.js"
+    }
+  },
+  "files": [
+    "lib/**/*"
+  ],
+  "scripts": {
+    "clean": "rimraf ./lib",
+    "build": "yarn clean && yarn build:ts",
+    "build:ts": "yarn build:cjs && yarn build:esm",
+    "build:cjs": "tsc --declaration -p tsconfig.build.json && echo '{\"type\":\"commonjs\"}' > ./lib/cjs/package.json",
+    "build:esm": "tsc --declaration -p tsconfig.esm.json && echo '{\"type\":\"module\"}' > ./lib/esm/package.json"
+  },
+  "repository": "github:kiltprotocol/sdk-js",
+  "engines": {
+    "node": ">=16.0"
+  },
+  "author": "",
+  "license": "BSD-4-Clause",
+  "bugs": "https://github.com/KILTprotocol/sdk-js/issues",
+  "homepage": "https://github.com/KILTprotocol/sdk-js#readme",
+  "devDependencies": {
+    "rimraf": "^3.0.2",
+    "typescript": "^4.8.3"
+  },
+  "dependencies": {
+    "@kiltprotocol/config": "workspace:*",
+    "@kiltprotocol/core": "workspace:*",
+    "@kiltprotocol/did": "workspace:*",
+    "@kiltprotocol/types": "workspace:*",
+    "@kiltprotocol/utils": "workspace:*",
+    "@kiltprotocol/vc-export": "workspace:*",
+    "@polkadot/util": "^12.0.0",
+    "@polkadot/util-crypto": "^12.0.0"
+  }
+}

packages/legacy-credentials/src/Claim.spec.ts

@@ -0,0 +1,184 @@
+/**
+ * Copyright (c) 2018-2023, BOTLabs GmbH.
+ *
+ * This source code is licensed under the BSD 4-Clause "Original" license
+ * found in the LICENSE file in the root directory of this source tree.
+ */
+
+import { CType } from '@kiltprotocol/core'
+import type { DidUri, ICType, IClaim } from '@kiltprotocol/types'
+import { SDKErrors } from '@kiltprotocol/utils'
+
+import * as Claim from './Claim'
+
+describe('jsonld', () => {
+  const claim: IClaim = {
+    cTypeHash:
+      '0x90364302f3b6ccfa50f3d384ec0ab6369711e13298ba4a5316d7e2addd5647b2',
+    contents: {
+      name: 'John',
+      address: 'homestreet, home',
+      number: 26,
+      optIn: true,
+    },
+    owner: 'did:kilt:4r1WkS3t8rbCb11H8t3tJvGVCynwDXSUBiuGB6sLRHzCLCjs',
+  }
+
+  it('validates hashes from snapshot', () => {
+    // given some nonces...
+    const nonces = [
+      '276b53b6-37db-4179-822e-ed2337a5b889',
+      'a63ff753-2622-4312-b612-571495c1bc9d',
+      'd5ceaebd-1e0e-432a-a501-58baa2f66e59',
+      '8db12d9e-26c0-49c0-bf91-818d6cc6116a',
+      '81687a00-f759-4fee-a68c-d9085f9d32f5',
+    ]
+    const digests = Object.keys(Claim.hashClaimContents(claim).nonceMap)
+    const nonceMap = digests
+      .sort()
+      .reduce(
+        (previous, current, i) => ({ ...previous, [current]: nonces[i] }),
+        {}
+      )
+    // we expect the resulting hashes to be the same every time
+    const hashed = Claim.hashClaimContents(claim, {
+      nonces: nonceMap,
+    })
+    expect(hashed.nonceMap).toEqual(nonceMap)
+    expect(hashed.hashes).toMatchInlineSnapshot(`
+      [
+        "0x3c2ae125a0baf4ed64a30b7ad012810b4622628a2eb5ad32e769e6a1d356d58d",
+        "0x69aae66efd954c3712e91dd2761dab08ea941e6516e7cf6ddf6e3b90ddc5bdf3",
+        "0x8d5736197583931c4e4d3dce0503596760f7a13e8187cc440b7de1edd4370d6a",
+        "0xad82658110207f8e65e1c2ae196ec7952aacda0aa9f19c83ce18b60612fe909a",
+        "0xf5db5c377a5e85ba94a457d5be8b8ec05419c3e0a666147d6ed86b45089374bd",
+      ]
+    `)
+  })
+})
+
+describe('compute hashes & validate by reproducing them', () => {
+  const claim: IClaim = {
+    cTypeHash:
+      '0x90364302f3b6ccfa50f3d384ec0ab6369711e13298ba4a5316d7e2addd5647b2',
+    contents: {
+      name: 'John',
+      address: 'homestreet, home',
+      number: 26,
+      optIn: true,
+    },
+    owner: 'did:kilt:4r1WkS3t8rbCb11H8t3tJvGVCynwDXSUBiuGB6sLRHzCLCjs',
+  }
+
+  // hash claim contents with randomly generated nonces
+  const hashed = Claim.hashClaimContents(claim)
+  const { hashes, nonceMap: nonces } = hashed
+
+  it('reproduces hashes of full claim', () => {
+    // when rehashing with the same nonces, the result must be identical
+    const rehashed = Claim.hashClaimContents(claim, { nonces })
+    expect(hashes).toEqual(rehashed.hashes)
+  })
+
+  it('reproduces hashes of partial claims', () => {
+    // when rehashing a partial claim (some properties removed) while using the original nonces,
+    // the resulting hashes must be among those computed in the original hashing
+    Object.keys(claim.contents).forEach((property) => {
+      // deep copy, then delete only a single property
+      const partialClaim = JSON.parse(JSON.stringify(claim))
+      delete partialClaim.contents[property]
+      Claim.hashClaimContents(partialClaim, { nonces }).hashes.forEach(
+        (hash) => {
+          expect(hashes).toContain(hash)
+        }
+      )
+      // remove all but one single property
+      partialClaim.contents = { [property]: claim.contents[property] }
+      Claim.hashClaimContents(partialClaim, { nonces }).hashes.forEach(
+        (hash) => {
+          expect(hashes).toContain(hash)
+        }
+      )
+    })
+  })
+})
+
+describe('Claim', () => {
+  let did: DidUri
+  let claimContents: any
+  let testCType: ICType
+  let claim: IClaim
+
+  beforeAll(async () => {
+    did = 'did:kilt:4r1WkS3t8rbCb11H8t3tJvGVCynwDXSUBiuGB6sLRHzCLCjs'
+
+    claimContents = {
+      name: 'Bob',
+    }
+
+    testCType = CType.fromProperties('ClaimCtype', {
+      name: { type: 'string' },
+    })
+
+    claim = Claim.fromCTypeAndClaimContents(testCType, claimContents, did)
+  })
+
+  it('can be made from object', () => {
+    const claimObj = JSON.parse(JSON.stringify(claim))
+    expect(() => Claim.verify(claimObj, testCType)).not.toThrow()
+  })
+
+  it('allows falsy claim values', () => {
+    const claimWithFalsy: IClaim = {
+      ...claim,
+      contents: {
+        name: '',
+      },
+    }
+    expect(() => Claim.verifyDataStructure(claimWithFalsy)).not.toThrow()
+  })
+
+  it('should throw an error on faulty constructor input', () => {
+    const cTypeHash = CType.idToHash(testCType.$id)
+    const ownerAddress = did
+
+    const everything = {
+      cTypeHash,
+      contents: claimContents,
+      owner: ownerAddress,
+    } as IClaim
+
+    // @ts-ignore
+    const noCTypeHash = {
+      cTypeHash: '',
+      contents: claimContents,
+      owner: ownerAddress,
+    } as IClaim
+
+    const malformedCTypeHash = {
+      cTypeHash: cTypeHash.slice(0, 20) + cTypeHash.slice(21),
+      contents: claimContents,
+      owner: ownerAddress,
+    } as IClaim
+
+    const malformedAddress = {
+      cTypeHash,
+      contents: claimContents,
+      owner: ownerAddress.replace('8', 'D'),
+    } as IClaim
+
+    expect(() => Claim.verifyDataStructure(everything)).not.toThrow()
+
+    expect(() => Claim.verifyDataStructure(noCTypeHash)).toThrowError(
+      SDKErrors.CTypeHashMissingError
+    )
+
+    expect(() => Claim.verifyDataStructure(malformedCTypeHash)).toThrowError(
+      SDKErrors.HashMalformedError
+    )
+
+    expect(() => Claim.verifyDataStructure(malformedAddress)).toThrowError(
+      SDKErrors.AddressInvalidError
+    )
+  })
+})