feat: varsig

.editorconfig

@@ -0,0 +1,14 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

packages/varsig/.gitignore

@@ -0,0 +1,4 @@
+*.log
+.DS_Store
+node_modules
+dist

packages/varsig/LICENSE-APACHE

@@ -0,0 +1,5 @@
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

packages/varsig/LICENSE-MIT

@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

packages/varsig/README.md

@@ -0,0 +1,42 @@
+# Multidid
+Multidid is a representation strategy for DIDs and DID URLs that is very compact and extensible. It allows any DID method to be represented as a string of bytes. Reference [specification](https://github.com/ChainAgnostic/multidid).
+
+This library is a multidid utility library to encode and decode multidids to their byte and string representation and convert from did strings to multidid representations. 
+
+## Installation
+
+```
+npm install --save @didtools/multidid
+```
+
+## Usage
+
+```js
+import { Multidid } from '@didtools/multidid'
+
+const didString = "did:key:z6MkiTBz1ymuepAQ4HEHYSF1H8quG5GLVVQR3djdX3mDooWp#z6MkiTBz1ymuepAQ4HEHYSF1H8quG5GLVVQR3djdX3mDooWp"
+
+// Multidid instance from did string
+const multidid = Multidid.fromString(didString)
+
+// Encode to bytes
+multidid.toBytes() 
+
+// Decode from bytes to multidid instance
+Multidid.fromBytes(bytes)
+
+// Encode as a multibase base16 string 
+const mdStr = multidid.toMultibase('base16')
+console.log(mdStr)
+//f9d1aed013b6a27bcceb6a42d62a3a8d02a6f0d73653215771de243a63ac048a18b59da29307a364d6b6954427a31796d75657041513448454859534631483871754735474c5656515233646a6458336d446f6f5770
+
+// Multidid instance from base encoded string 
+Multidid.fromMultibase(mdStr)
+
+// DID string from multidid
+multidid.toString() 
+```
+
+## License
+
+Apache-2.0 OR MIT

packages/varsig/jest.config.json

@@ -0,0 +1,22 @@
+{
+  "moduleFileExtensions": ["js", "json", "ts"],
+  "testRegex": ".(spec|test).ts$",
+  "testEnvironment": "node",
+  "extensionsToTreatAsEsm": [".ts"],
+  "globals": {
+    "ts-jest": {
+      "useESM": true
+    }
+  },
+  "moduleNameMapper": {
+    "^(\\.{1,2}/.*)\\.js$": "$1"
+  },
+  "transform": {
+    "^.+\\.(t|j)s$": [
+      "@swc/jest",
+      {
+        "root": "../.."
+      }
+    ]
+  }
+}

packages/varsig/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@didtools/varsig",
+  "version": "0.0.1",
+  "author": "3Box Labs",
+  "license": "(Apache-2.0 OR MIT)",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=14.14"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build:clean": "del dist",
+    "build:js": "swc src -d ./dist --config-file ../../.swcrc",
+    "build:types": "tsc --emitDeclarationOnly --skipLibCheck",
+    "build": "pnpm run build:clean && pnpm run build:types && pnpm run build:js",
+    "lint": "eslint src --fix",
+    "test": "node --experimental-vm-modules ../../node_modules/jest/bin/jest.js",
+    "test:ci": "pnpm run test --ci --coverage",
+    "prepare": "pnpm run build",
+    "prepublishOnly": "package-check",
+    "size": "./node_modules/.bin/size-limit",
+    "analyze": "./node_modules/.bin/size-limit --why",
+    "gen:vectors": "./node_modules/.bin/tsm ./src/__tests__/gen-vectors.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ceramicnetwork/js-did.git"
+  },
+  "keywords": [
+    "DID",
+    "identity",
+    "did-provider",
+    "self-sovereign",
+    "multiformat"
+  ],
+  "bugs": {
+    "url": "https://github.com/ceramicnetwork/js-did/issues"
+  },
+  "homepage": "https://github.com/ceramicnetwork/js-did#readme",
+  "devDependencies": {
+    "@stablelib/random": "^1.0.2",
+    "cartonne": "^3.0.1",
+    "tsm": "^2.3.0"
+  },
+  "dependencies": {
+    "@ipld/dag-json": "^10.1.5",
+    "@noble/curves": "^1.2.0",
+    "@noble/hashes": "^1.3.2",
+    "@types/node": "^20.2.3",
+    "codeco": "^1.1.0",
+    "fast-json-stable-stringify": "^2.1.0",
+    "key-did-provider-ed25519": "workspace:^",
+    "key-did-resolver": "workspace:^",
+    "klona": "^2.0.6",
+    "multiformats": "^13.0.1",
+    "uint8arrays": "^5.0.2",
+    "varintes": "^2.0.5",
+    "viem": "^1.19.5"
+  }
+}

packages/varsig/src/__tests__/canonicalization.test.ts

@@ -0,0 +1,118 @@
+import { expect, test } from '@jest/globals'
+import { BytesTape } from '../bytes-tape.js'
+import { CanonicalizationDecoder, CanonicalizationKind } from '../canonicalization.js'
+import { concat, toString } from 'uint8arrays'
+import { encode } from 'varintes/encode'
+import { HashingKind, hashingAlgoByKind } from '../hashing.js'
+import { SigningKind } from '../signing.js'
+import { fromOriginal } from '../canons/eip712.js'
+
+const TEST_DATA = {
+  types: {
+    EIP712Domain: [
+      {
+        name: 'name',
+        type: 'string',
+      },
+      {
+        name: 'version',
+        type: 'string',
+      },
+      {
+        name: 'chainId',
+        type: 'uint256',
+      },
+      {
+        name: 'verifyingContract',
+        type: 'address',
+      },
+    ],
+    Person: [
+      {
+        name: 'name',
+        type: 'string',
+      },
+      {
+        name: 'wallet',
+        type: 'address',
+      },
+    ],
+    Mail: [
+      {
+        name: 'from',
+        type: 'Person',
+      },
+      {
+        name: 'to',
+        type: 'Person',
+      },
+      {
+        name: 'contents',
+        type: 'string',
+      },
+      {
+        name: 'attachment',
+        type: 'bytes',
+      },
+    ],
+  },
+  primaryType: 'Mail',
+  domain: {
+    name: 'Ether Mail',
+    version: '1',
+    chainId: 1,
+    verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
+  },
+  message: {
+    from: {
+      name: 'Cow',
+      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
+    },
+    to: {
+      name: 'Bob',
+      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
+    },
+    contents: 'Hello, Bob!',
+    attachment: '0xababababababababababa83459873459873459873498575986734359',
+  },
+  signature:
+    '0x0c095239e4d3d2cc0b7aa28110f42abcdefe47656bbde7048244471e701331ec3f94adfe7959b0ed0efec533d511f9e1e11b3e47242d82341870dc31fbc2146d1b',
+} as const
+
+test('EIP712', () => {
+  const node = fromOriginal({
+    // @ts-ignore
+    types: TEST_DATA.types,
+    domain: TEST_DATA.domain,
+    primaryType: TEST_DATA.primaryType,
+    message: TEST_DATA.message,
+    signature: TEST_DATA.signature,
+  })
+  const tape = new BytesTape(node._sig)
+  tape.readVarint() // skip varsig sigil
+  tape.readVarint() // skip key sigil
+  tape.read(1)
+  tape.readVarint() // skip hash sigil
+  const canonicalization = CanonicalizationDecoder.read(
+    tape,
+    hashingAlgoByKind(HashingKind.KECCAK256),
+    SigningKind.SECP256K1,
+  )
+  expect(canonicalization.kind).toEqual(CanonicalizationKind.EIP712)
+  if (canonicalization.kind !== CanonicalizationKind.EIP712) throw new Error()
+  const input = toString(canonicalization(TEST_DATA.message), 'hex')
+  expect(input).toEqual('703012a88c79c0ae106c7e0bd144d39d63304df1815e6d11b19189aff3dce0c4')
+})
+
+test('EIP191', () => {
+  const bytes = concat([encode(0xe191)[0]])
+  const tape = new BytesTape(bytes)
+  const result = CanonicalizationDecoder.read(
+    tape,
+    hashingAlgoByKind(HashingKind.KECCAK256),
+    SigningKind.SECP256K1,
+  )
+  expect(result.kind).toEqual(CanonicalizationKind.EIP191)
+  const canonicalized = toString(result('Hello'), 'hex')
+  expect(canonicalized).toEqual('aa744ba2ca576ec62ca0045eca00ad3917fdf7ffa34fbbae50828a5a69c1580e')
+})

packages/varsig/src/__tests__/canons/eip712.test.ts

@@ -0,0 +1,78 @@
+import { fromOriginal, prepareCanonicalization } from '../../canons/eip712.js'
+import { BytesTape } from '../../bytes-tape.js'
+import * as uint8arrays from 'uint8arrays'
+import { HashingDecoder } from '../../hashing.js'
+import { CanonicalizationKind } from '../../canonicalization.js'
+
+const testData = {
+  types: {
+    EIP712Domain: [
+      { name: 'name', type: 'string' },
+      { name: 'version', type: 'string' },
+      { name: 'chainId', type: 'uint256' },
+      { name: 'verifyingContract', type: 'address' },
+    ],
+    Person: [
+      { name: 'name', type: 'string' },
+      { name: 'wallet', type: 'address' },
+    ],
+    Mail: [
+      { name: 'from', type: 'Person' },
+      { name: 'to', type: 'Person' },
+      { name: 'contents', type: 'string' },
+      { name: 'attachment', type: 'bytes' },
+    ],
+  },
+  primaryType: 'Mail',
+  domain: {
+    name: 'Ether Mail',
+    version: '1',
+    chainId: 1,
+    verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
+  },
+  message: {
+    from: {
+      name: 'Cow',
+      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
+    },
+    to: {
+      name: 'Bob',
+      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
+    },
+    contents: 'Hello, Bob!',
+    attachment: '0xababababababababababa83459873459873459873498575986734359',
+  },
+  signature:
+    '0x0c095239e4d3d2cc0b7aa28110f42abcdefe47656bbde7048244471e701331ec3f94adfe7959b0ed0efec533d511f9e1e11b3e47242d82341870dc31fbc2146d1b',
+} as const
+
+const expectedHash = uint8arrays.fromString(
+  '703012a88c79c0ae106c7e0bd144d39d63304df1815e6d11b19189aff3dce0c4',
+  'base16',
+)
+
+test('Encode eip712 message', () => {
+  // @ts-ignore
+  const node = fromOriginal(testData)
+
+  expect(node._sig.length).toEqual(268)
+  expect(node.attachment instanceof Uint8Array).toBeTruthy()
+})
+
+test('Canonicalize ipld eip712 object', () => {
+  // @ts-ignore
+  const node = fromOriginal(testData)
+  const tape = new BytesTape(node._sig)
+  tape.readVarint() // skip sigil
+  tape.readVarint() // skip key type
+  tape.read(1) // skip recovery bit
+  const hashing = HashingDecoder.read(tape) // read hash type
+  tape.readVarint() // skip canonicalizer codec
+  const can = prepareCanonicalization(tape, hashing, 0xe7)
+  if (can.kind !== CanonicalizationKind.EIP712) throw new Error(`Nope`)
+  expect(tape.remainder.length).toEqual(64)
+  // @ts-ignore
+  delete node._sig
+  const sigInput = can(node)
+  expect(sigInput).toEqual(expectedHash)
+})