@learncard/didkey-plugin 1.1.24 → 1.1.26

package/README.md

@@ -9,25 +9,26 @@
 The LearnCard Core is a pluggable, open-source, universal digital wallet to enable any individual or organization to seamlessly **issue, earn, store, share, and spend currency and credentials** built for the future of education and work.
 
 ## Documentation
+
 All LearnCard documentation can be found at:
 https://docs.learncard.com
 
 ## Install
 
 ```bash
-pnpm i @learncard/core
+bun add @learncard/core
 ```
 
 ## Usage
 
 ### Instantiation
 
-Instantiate a wallet using `initLearnCard`. This method accepts a unique identifier string that is 
+Instantiate a wallet using `initLearnCard`. This method accepts a unique identifier string that is
 up to 64 characters long. If it is less than 64 characters, `initLearnCard` will pad the start of
 the string with 0's until it is 64 characters long.
 
 ```js
-import { initLearnCard } from "@learncard/core";
+import { initLearnCard } from '@learncard/core';
 
 const wallet = await initLearnCard({ seed: 'a'.repeat(64) });
 ```
@@ -35,6 +36,7 @@ const wallet = await initLearnCard({ seed: 'a'.repeat(64) });
 ### Issuing/Verifying Credentials and Presentations
 
 #### Issue a credential
+
 ```js
 // Grab a test VC, or create your own!
 const unsignedVc = await wallet.invoke.getTestVc();
@@ -43,6 +45,7 @@ const vc = await wallet.invoke.issueCredential(unsignedVc);
 ```
 
 #### Verify a credential
+
 ```js
 const result = await wallet.invoke.verifyCredential(vc, {}, true);
 
@@ -53,11 +56,13 @@ else console.log('This credential is valid!');
 ```
 
 #### Issue a presentation
+
 ```js
 const vp = await wallet.invoke.issuePresentation(vc);
 ```
 
 #### Verify a presentation
+
 ```js
 const result = await wallet.invoke.verifyPresentation(vp);
 
@@ -74,14 +79,14 @@ else console.log('This presentation is valid!');
 To maintain co-ownership of credentials, it is best to store credentials in a public place, and then
 store references to that public place. While this is not the only way to store credentials (and is
 also definitely not a silver bullet! E.g. credentials containing private data), it is the opinion of
-this library that it should be used by default. As a result, instantiating a wallet, will 
-automatically connect you to WeLibrary's ceramic node, and allow you to publish and retrieve 
+this library that it should be used by default. As a result, instantiating a wallet, will
+automatically connect you to WeLibrary's ceramic node, and allow you to publish and retrieve
 credentials there using IDX.
 
 #### Publish Credential
 
 After signing a VC, you may choose to publish that credential to Ceramic. Doing so will return a
-stream ID, which you may share to the recipient. That stream ID can then be used to resolve the 
+stream ID, which you may share to the recipient. That stream ID can then be used to resolve the
 issued credential. This means both the issuer and recipient may store the _stream ID_ instead of the
 credential itself.
 
@@ -126,6 +131,7 @@ const vcs = await Promise.all(uris.map(async uri => wallet.read.get(uri)));
 ```
 
 ## Contributing
+
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
 
 Please make sure to update tests as appropriate.
@@ -134,7 +140,6 @@ Please make sure to update tests as appropriate.
 
 **[Learning Economy Foundation (LEF)](https://www.learningeconomy.io)** is a 501(c)(3) non-profit organization leveraging global standards and web3 protocols to bring quality skills and equal opportunity to every human on earth, and address the persistent inequities that exist around the globe in education and employment. We help you build the future of education and work with:
 
-
 ## License
 
 MIT © [Learning Economy Foundation](https://github.com/Learning-Economy-Foundation)

package/dist/didkey-plugin.cjs.development.cjs

@@ -25,7 +25,7 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 
-// ../../../node_modules/.pnpm/hex-lite@1.5.0/node_modules/hex-lite/dist/hex-lite.mjs
+// ../../../node_modules/hex-lite/dist/hex-lite.mjs
 function toUint8Array(str) {
   var s = 0, sl = str.length, bytes = [];
   if (sl % 2) {

package/dist/didkey-plugin.cjs.development.cjs.map

@@ -1,6 +1,6 @@
 {
   "version": 3,
-  "sources": ["../src/index.ts", "../../../../node_modules/.pnpm/hex-lite@1.5.0/node_modules/hex-lite/dist/hex-lite.mjs", "../src/helpers.ts"],
+  "sources": ["../src/index.ts", "../../../../node_modules/hex-lite/dist/hex-lite.mjs", "../src/helpers.ts"],
   "sourcesContent": ["import { toUint8Array } from 'hex-lite';\nimport { isHex } from '@learncard/helpers';\nimport { JWKWithPrivateKey } from '@learncard/types';\nimport { LearnCard } from '@learncard/core';\n\nimport { getAlgorithmForDidMethod } from './helpers';\n\nimport { DidKeyPlugin, DependentMethods, Algorithm } from './types';\n\nexport * from './types';\n\nlet _shortSeedWarned = false;\n\n/**\n *\n * @group Plugins\n */\nexport const getDidKeyPlugin = async <DidMethod extends string>(\n    learnCard: LearnCard<any, any, DependentMethods<DidMethod>>,\n    key: string,\n    defaultDidMethod: DidMethod\n): Promise<DidKeyPlugin<DidMethod>> => {\n    if (key.length === 0) throw new Error(\"Please don't use an empty string for a key!\");\n    if (!isHex(key)) throw new Error('Key must be a hexadecimal string!');\n    if (key.length > 64) throw new Error('Key must be less than 64 characters');\n\n    if (key.length < 64 && !_shortSeedWarned) {\n        _shortSeedWarned = true;\n\n        console.warn(\n            'Warning: A LearnCard has been initialized with a seed that is less than 32 bytes, and will be padded with zeroes'\n        );\n        console.warn(\n            'Please instantiate LearnCards using 32 bytes that have been randomly generated in a cryptographically secure fashion!'\n        );\n        console.warn(\n            'See https://app.gitbook.com/o/6uDv1QDlxaaZC7i8EaGb/s/FXvEJ9j3Vf3FW5Nc557n/learn-card-packages/learncard-core/instantiation#key-generation for details'\n        );\n    }\n\n    const seed = key.padStart(64, '0');\n    const seedBytes = toUint8Array(seed);\n\n    const memoizedDids: Partial<Record<DidMethod, string>> = {};\n    const keyPairs: Record<Algorithm, JWKWithPrivateKey> = {\n        ed25519: learnCard.invoke.generateEd25519KeyFromBytes(seedBytes),\n        secp256k1: learnCard.invoke.generateSecp256k1KeyFromBytes(seedBytes),\n    };\n\n    const did = (method = defaultDidMethod) => {\n        if (!memoizedDids[method]) {\n            const algorithm = getAlgorithmForDidMethod(method);\n            memoizedDids[method] = learnCard.invoke.keyToDid(method, keyPairs[algorithm]);\n        }\n\n        return memoizedDids[method]!;\n    };\n\n    const keypair = (algorithm: Algorithm = 'ed25519') => {\n        if (!keyPairs[algorithm]) throw new Error('Unsupported algorithm');\n\n        return keyPairs[algorithm];\n    };\n\n    return {\n        name: 'DID Key',\n        displayName: 'DID Key',\n        description: 'Generates dids and JWKs using 32 Secure Random Bytes of Entropy',\n        id: {\n            did: (_learnCard, method) => did(method as any),\n            keypair: (_learnCard, algorithm) => keypair(algorithm as any),\n        },\n        methods: {\n            getSubjectDid: (_learnCard, method = defaultDidMethod) => did(method),\n            getSubjectKeypair: (_learnCard, algorithm = 'ed25519') => keypair(algorithm),\n            getKey: () => seed,\n        },\n    };\n};\n", "function fromUint8Array(uint8Array) {\n    return uint8Array.reduce(function (ag, v) { return ag += ('00' + v.toString(16)).slice(-2); }, '');\n}\n\nfunction toUint8Array(str) {\n    var s = 0, sl = str.length, bytes = [];\n    if (sl % 2) \n        { throw new Error('invalid hex:' + str); }\n    for (; s < sl; s += 2) {\n        bytes.push(parseInt(str.substr(s, 2), 16));\n    }\n    return new Uint8Array(bytes);\n}\n\nfunction fromBuffer(buffer) {\n    return fromUint8Array(new Uint8Array(buffer));\n}\n\nfunction toBuffer(str) {\n    return toUint8Array(str).buffer;\n}\n\nexport { fromUint8Array, toUint8Array, fromBuffer, toBuffer };\n//# sourceMappingURL=hex-lite.mjs.map\n", "import { Algorithm } from './types';\n\nexport const ED25519_METHODS = ['key', 'tz', 'pkh:tz', 'pkh:tezos', 'pkh:sol', 'pkh:solana'];\n\nexport const SECP256K1_METHODS = [\n    'key',\n    'tz',\n    'ethr',\n    'pkh:tz',\n    'pkh:tezos',\n    'pkh:eth',\n    'pkh:celo',\n    'pkh:poly',\n    'pkh:btc',\n    'pkh:doge',\n    'pkh:eip155',\n    'pkh:bip122',\n];\n\nexport const getAlgorithmForDidMethod = <DidMethod extends string>(\n    didMethod: DidMethod\n): Algorithm => {\n    if (ED25519_METHODS.includes(didMethod)) return 'ed25519';\n    if (\n        SECP256K1_METHODS.includes(didMethod) ||\n        didMethod.startsWith('pkh:eip155:') ||\n        didMethod.startsWith('pkh:bip122:')\n    ) {\n        return 'secp256k1';\n    }\n\n    throw new Error('Unspported Did Method');\n};\n"],
   "mappings": ";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACIA,SAAS,aAAa,KAAK;AACvB,MAAI,IAAI,GAAG,KAAK,IAAI,QAAQ,QAAQ,CAAC;AACrC,MAAI,KAAK,GACL;AAAE,UAAM,IAAI,MAAM,iBAAiB,GAAG;AAAA,EAAG;AAC7C,SAAO,IAAI,IAAI,KAAK,GAAG;AACnB,UAAM,KAAK,SAAS,IAAI,OAAO,GAAG,CAAC,GAAG,EAAE,CAAC;AAAA,EAC7C;AACA,SAAO,IAAI,WAAW,KAAK;AAC/B;AARS;;;ADHT,qBAAsB;;;AECf,IAAM,kBAAkB,CAAC,OAAO,MAAM,UAAU,aAAa,WAAW,YAAY;AAEpF,IAAM,oBAAoB;AAAA,EAC7B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACJ;AAEO,IAAM,2BAA2B,wBACpC,cACY;AACZ,MAAI,gBAAgB,SAAS,SAAS,EAAG,QAAO;AAChD,MACI,kBAAkB,SAAS,SAAS,KACpC,UAAU,WAAW,aAAa,KAClC,UAAU,WAAW,aAAa,GACpC;AACE,WAAO;AAAA,EACX;AAEA,QAAM,IAAI,MAAM,uBAAuB;AAC3C,GAbwC;;;AFRxC,IAAI,mBAAmB;AAMhB,IAAM,kBAAkB,8BAC3B,WACA,KACA,qBACmC;AACnC,MAAI,IAAI,WAAW,EAAG,OAAM,IAAI,MAAM,6CAA6C;AACnF,MAAI,KAAC,sBAAM,GAAG,EAAG,OAAM,IAAI,MAAM,mCAAmC;AACpE,MAAI,IAAI,SAAS,GAAI,OAAM,IAAI,MAAM,qCAAqC;AAE1E,MAAI,IAAI,SAAS,MAAM,CAAC,kBAAkB;AACtC,uBAAmB;AAEnB,YAAQ;AAAA,MACJ;AAAA,IACJ;AACA,YAAQ;AAAA,MACJ;AAAA,IACJ;AACA,YAAQ;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AAEA,QAAM,OAAO,IAAI,SAAS,IAAI,GAAG;AACjC,QAAM,YAAY,aAAa,IAAI;AAEnC,QAAM,eAAmD,CAAC;AAC1D,QAAM,WAAiD;AAAA,IACnD,SAAS,UAAU,OAAO,4BAA4B,SAAS;AAAA,IAC/D,WAAW,UAAU,OAAO,8BAA8B,SAAS;AAAA,EACvE;AAEA,QAAM,MAAM,wBAAC,SAAS,qBAAqB;AACvC,QAAI,CAAC,aAAa,MAAM,GAAG;AACvB,YAAM,YAAY,yBAAyB,MAAM;AACjD,mBAAa,MAAM,IAAI,UAAU,OAAO,SAAS,QAAQ,SAAS,SAAS,CAAC;AAAA,IAChF;AAEA,WAAO,aAAa,MAAM;AAAA,EAC9B,GAPY;AASZ,QAAM,UAAU,wBAAC,YAAuB,cAAc;AAClD,QAAI,CAAC,SAAS,SAAS,EAAG,OAAM,IAAI,MAAM,uBAAuB;AAEjE,WAAO,SAAS,SAAS;AAAA,EAC7B,GAJgB;AAMhB,SAAO;AAAA,IACH,MAAM;AAAA,IACN,aAAa;AAAA,IACb,aAAa;AAAA,IACb,IAAI;AAAA,MACA,KAAK,wBAAC,YAAY,WAAW,IAAI,MAAa,GAAzC;AAAA,MACL,SAAS,wBAAC,YAAY,cAAc,QAAQ,SAAgB,GAAnD;AAAA,IACb;AAAA,IACA,SAAS;AAAA,MACL,eAAe,wBAAC,YAAY,SAAS,qBAAqB,IAAI,MAAM,GAArD;AAAA,MACf,mBAAmB,wBAAC,YAAY,YAAY,cAAc,QAAQ,SAAS,GAAxD;AAAA,MACnB,QAAQ,6BAAM,MAAN;AAAA,IACZ;AAAA,EACJ;AACJ,GA7D+B;",
   "names": []

package/dist/didkey-plugin.cjs.production.min.cjs.map

@@ -1,6 +1,6 @@
 {
   "version": 3,
-  "sources": ["../src/index.ts", "../../../../node_modules/.pnpm/hex-lite@1.5.0/node_modules/hex-lite/dist/hex-lite.mjs", "../src/helpers.ts"],
+  "sources": ["../src/index.ts", "../../../../node_modules/hex-lite/dist/hex-lite.mjs", "../src/helpers.ts"],
   "sourcesContent": ["import { toUint8Array } from 'hex-lite';\nimport { isHex } from '@learncard/helpers';\nimport { JWKWithPrivateKey } from '@learncard/types';\nimport { LearnCard } from '@learncard/core';\n\nimport { getAlgorithmForDidMethod } from './helpers';\n\nimport { DidKeyPlugin, DependentMethods, Algorithm } from './types';\n\nexport * from './types';\n\nlet _shortSeedWarned = false;\n\n/**\n *\n * @group Plugins\n */\nexport const getDidKeyPlugin = async <DidMethod extends string>(\n    learnCard: LearnCard<any, any, DependentMethods<DidMethod>>,\n    key: string,\n    defaultDidMethod: DidMethod\n): Promise<DidKeyPlugin<DidMethod>> => {\n    if (key.length === 0) throw new Error(\"Please don't use an empty string for a key!\");\n    if (!isHex(key)) throw new Error('Key must be a hexadecimal string!');\n    if (key.length > 64) throw new Error('Key must be less than 64 characters');\n\n    if (key.length < 64 && !_shortSeedWarned) {\n        _shortSeedWarned = true;\n\n        console.warn(\n            'Warning: A LearnCard has been initialized with a seed that is less than 32 bytes, and will be padded with zeroes'\n        );\n        console.warn(\n            'Please instantiate LearnCards using 32 bytes that have been randomly generated in a cryptographically secure fashion!'\n        );\n        console.warn(\n            'See https://app.gitbook.com/o/6uDv1QDlxaaZC7i8EaGb/s/FXvEJ9j3Vf3FW5Nc557n/learn-card-packages/learncard-core/instantiation#key-generation for details'\n        );\n    }\n\n    const seed = key.padStart(64, '0');\n    const seedBytes = toUint8Array(seed);\n\n    const memoizedDids: Partial<Record<DidMethod, string>> = {};\n    const keyPairs: Record<Algorithm, JWKWithPrivateKey> = {\n        ed25519: learnCard.invoke.generateEd25519KeyFromBytes(seedBytes),\n        secp256k1: learnCard.invoke.generateSecp256k1KeyFromBytes(seedBytes),\n    };\n\n    const did = (method = defaultDidMethod) => {\n        if (!memoizedDids[method]) {\n            const algorithm = getAlgorithmForDidMethod(method);\n            memoizedDids[method] = learnCard.invoke.keyToDid(method, keyPairs[algorithm]);\n        }\n\n        return memoizedDids[method]!;\n    };\n\n    const keypair = (algorithm: Algorithm = 'ed25519') => {\n        if (!keyPairs[algorithm]) throw new Error('Unsupported algorithm');\n\n        return keyPairs[algorithm];\n    };\n\n    return {\n        name: 'DID Key',\n        displayName: 'DID Key',\n        description: 'Generates dids and JWKs using 32 Secure Random Bytes of Entropy',\n        id: {\n            did: (_learnCard, method) => did(method as any),\n            keypair: (_learnCard, algorithm) => keypair(algorithm as any),\n        },\n        methods: {\n            getSubjectDid: (_learnCard, method = defaultDidMethod) => did(method),\n            getSubjectKeypair: (_learnCard, algorithm = 'ed25519') => keypair(algorithm),\n            getKey: () => seed,\n        },\n    };\n};\n", "function fromUint8Array(uint8Array) {\n    return uint8Array.reduce(function (ag, v) { return ag += ('00' + v.toString(16)).slice(-2); }, '');\n}\n\nfunction toUint8Array(str) {\n    var s = 0, sl = str.length, bytes = [];\n    if (sl % 2) \n        { throw new Error('invalid hex:' + str); }\n    for (; s < sl; s += 2) {\n        bytes.push(parseInt(str.substr(s, 2), 16));\n    }\n    return new Uint8Array(bytes);\n}\n\nfunction fromBuffer(buffer) {\n    return fromUint8Array(new Uint8Array(buffer));\n}\n\nfunction toBuffer(str) {\n    return toUint8Array(str).buffer;\n}\n\nexport { fromUint8Array, toUint8Array, fromBuffer, toBuffer };\n//# sourceMappingURL=hex-lite.mjs.map\n", "import { Algorithm } from './types';\n\nexport const ED25519_METHODS = ['key', 'tz', 'pkh:tz', 'pkh:tezos', 'pkh:sol', 'pkh:solana'];\n\nexport const SECP256K1_METHODS = [\n    'key',\n    'tz',\n    'ethr',\n    'pkh:tz',\n    'pkh:tezos',\n    'pkh:eth',\n    'pkh:celo',\n    'pkh:poly',\n    'pkh:btc',\n    'pkh:doge',\n    'pkh:eip155',\n    'pkh:bip122',\n];\n\nexport const getAlgorithmForDidMethod = <DidMethod extends string>(\n    didMethod: DidMethod\n): Algorithm => {\n    if (ED25519_METHODS.includes(didMethod)) return 'ed25519';\n    if (\n        SECP256K1_METHODS.includes(didMethod) ||\n        didMethod.startsWith('pkh:eip155:') ||\n        didMethod.startsWith('pkh:bip122:')\n    ) {\n        return 'secp256k1';\n    }\n\n    throw new Error('Unspported Did Method');\n};\n"],
   "mappings": "4dAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,qBAAAE,IAAA,eAAAC,EAAAH,GCIA,SAASI,EAAaC,EAAK,CACvB,IAAIC,EAAI,EAAGC,EAAKF,EAAI,OAAQG,EAAQ,CAAC,EACrC,GAAID,EAAK,EACH,MAAM,IAAI,MAAM,eAAiBF,CAAG,EAC1C,KAAOC,EAAIC,EAAID,GAAK,EAChBE,EAAM,KAAK,SAASH,EAAI,OAAOC,EAAG,CAAC,EAAG,EAAE,CAAC,EAE7C,OAAO,IAAI,WAAWE,CAAK,CAC/B,CARSC,EAAAL,EAAA,gBDHT,IAAAM,EAAsB,8BECf,IAAMC,EAAkB,CAAC,MAAO,KAAM,SAAU,YAAa,UAAW,YAAY,EAE9EC,EAAoB,CAC7B,MACA,KACA,OACA,SACA,YACA,UACA,WACA,WACA,UACA,WACA,aACA,YACJ,EAEaC,EAA2BC,EACpCC,GACY,CACZ,GAAIJ,EAAgB,SAASI,CAAS,EAAG,MAAO,UAChD,GACIH,EAAkB,SAASG,CAAS,GACpCA,EAAU,WAAW,aAAa,GAClCA,EAAU,WAAW,aAAa,EAElC,MAAO,YAGX,MAAM,IAAI,MAAM,uBAAuB,CAC3C,EAbwC,4BFRxC,IAAIC,EAAmB,GAMVC,EAAkBC,EAAA,MAC3BC,EACAC,EACAC,IACmC,CACnC,GAAID,EAAI,SAAW,EAAG,MAAM,IAAI,MAAM,6CAA6C,EACnF,GAAI,IAAC,SAAMA,CAAG,EAAG,MAAM,IAAI,MAAM,mCAAmC,EACpE,GAAIA,EAAI,OAAS,GAAI,MAAM,IAAI,MAAM,qCAAqC,EAEtEA,EAAI,OAAS,IAAM,CAACJ,IACpBA,EAAmB,GAEnB,QAAQ,KACJ,kHACJ,EACA,QAAQ,KACJ,uHACJ,EACA,QAAQ,KACJ,uJACJ,GAGJ,IAAMM,EAAOF,EAAI,SAAS,GAAI,GAAG,EAC3BG,EAAYC,EAAaF,CAAI,EAE7BG,EAAmD,CAAC,EACpDC,EAAiD,CACnD,QAASP,EAAU,OAAO,4BAA4BI,CAAS,EAC/D,UAAWJ,EAAU,OAAO,8BAA8BI,CAAS,CACvE,EAEMI,EAAMT,EAAA,CAACU,EAASP,IAAqB,CACvC,GAAI,CAACI,EAAaG,CAAM,EAAG,CACvB,IAAMC,EAAYC,EAAyBF,CAAM,EACjDH,EAAaG,CAAM,EAAIT,EAAU,OAAO,SAASS,EAAQF,EAASG,CAAS,CAAC,CAChF,CAEA,OAAOJ,EAAaG,CAAM,CAC9B,EAPY,OASNG,EAAUb,EAAA,CAACW,EAAuB,YAAc,CAClD,GAAI,CAACH,EAASG,CAAS,EAAG,MAAM,IAAI,MAAM,uBAAuB,EAEjE,OAAOH,EAASG,CAAS,CAC7B,EAJgB,WAMhB,MAAO,CACH,KAAM,UACN,YAAa,UACb,YAAa,kEACb,GAAI,CACA,IAAKX,EAAA,CAACc,EAAYJ,IAAWD,EAAIC,CAAa,EAAzC,OACL,QAASV,EAAA,CAACc,EAAYH,IAAcE,EAAQF,CAAgB,EAAnD,UACb,EACA,QAAS,CACL,cAAeX,EAAA,CAACc,EAAYJ,EAASP,IAAqBM,EAAIC,CAAM,EAArD,iBACf,kBAAmBV,EAAA,CAACc,EAAYH,EAAY,YAAcE,EAAQF,CAAS,EAAxD,qBACnB,OAAQX,EAAA,IAAMI,EAAN,SACZ,CACJ,CACJ,EA7D+B",
   "names": ["index_exports", "__export", "getDidKeyPlugin", "__toCommonJS", "toUint8Array", "str", "s", "sl", "bytes", "__name", "import_helpers", "ED25519_METHODS", "SECP256K1_METHODS", "getAlgorithmForDidMethod", "__name", "didMethod", "_shortSeedWarned", "getDidKeyPlugin", "__name", "learnCard", "key", "defaultDidMethod", "seed", "seedBytes", "toUint8Array", "memoizedDids", "keyPairs", "did", "method", "algorithm", "getAlgorithmForDidMethod", "keypair", "_learnCard"]

package/dist/didkey-plugin.esm.js

@@ -1,7 +1,7 @@
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 
-// ../../../node_modules/.pnpm/hex-lite@1.5.0/node_modules/hex-lite/dist/hex-lite.mjs
+// ../../../node_modules/hex-lite/dist/hex-lite.mjs
 function toUint8Array(str) {
   var s = 0, sl = str.length, bytes = [];
   if (sl % 2) {

package/dist/didkey-plugin.esm.js.map

@@ -1,6 +1,6 @@
 {
   "version": 3,
-  "sources": ["../../../../node_modules/.pnpm/hex-lite@1.5.0/node_modules/hex-lite/dist/hex-lite.mjs", "../src/index.ts", "../src/helpers.ts"],
+  "sources": ["../../../../node_modules/hex-lite/dist/hex-lite.mjs", "../src/index.ts", "../src/helpers.ts"],
   "sourcesContent": ["function fromUint8Array(uint8Array) {\n    return uint8Array.reduce(function (ag, v) { return ag += ('00' + v.toString(16)).slice(-2); }, '');\n}\n\nfunction toUint8Array(str) {\n    var s = 0, sl = str.length, bytes = [];\n    if (sl % 2) \n        { throw new Error('invalid hex:' + str); }\n    for (; s < sl; s += 2) {\n        bytes.push(parseInt(str.substr(s, 2), 16));\n    }\n    return new Uint8Array(bytes);\n}\n\nfunction fromBuffer(buffer) {\n    return fromUint8Array(new Uint8Array(buffer));\n}\n\nfunction toBuffer(str) {\n    return toUint8Array(str).buffer;\n}\n\nexport { fromUint8Array, toUint8Array, fromBuffer, toBuffer };\n//# sourceMappingURL=hex-lite.mjs.map\n", "import { toUint8Array } from 'hex-lite';\nimport { isHex } from '@learncard/helpers';\nimport { JWKWithPrivateKey } from '@learncard/types';\nimport { LearnCard } from '@learncard/core';\n\nimport { getAlgorithmForDidMethod } from './helpers';\n\nimport { DidKeyPlugin, DependentMethods, Algorithm } from './types';\n\nexport * from './types';\n\nlet _shortSeedWarned = false;\n\n/**\n *\n * @group Plugins\n */\nexport const getDidKeyPlugin = async <DidMethod extends string>(\n    learnCard: LearnCard<any, any, DependentMethods<DidMethod>>,\n    key: string,\n    defaultDidMethod: DidMethod\n): Promise<DidKeyPlugin<DidMethod>> => {\n    if (key.length === 0) throw new Error(\"Please don't use an empty string for a key!\");\n    if (!isHex(key)) throw new Error('Key must be a hexadecimal string!');\n    if (key.length > 64) throw new Error('Key must be less than 64 characters');\n\n    if (key.length < 64 && !_shortSeedWarned) {\n        _shortSeedWarned = true;\n\n        console.warn(\n            'Warning: A LearnCard has been initialized with a seed that is less than 32 bytes, and will be padded with zeroes'\n        );\n        console.warn(\n            'Please instantiate LearnCards using 32 bytes that have been randomly generated in a cryptographically secure fashion!'\n        );\n        console.warn(\n            'See https://app.gitbook.com/o/6uDv1QDlxaaZC7i8EaGb/s/FXvEJ9j3Vf3FW5Nc557n/learn-card-packages/learncard-core/instantiation#key-generation for details'\n        );\n    }\n\n    const seed = key.padStart(64, '0');\n    const seedBytes = toUint8Array(seed);\n\n    const memoizedDids: Partial<Record<DidMethod, string>> = {};\n    const keyPairs: Record<Algorithm, JWKWithPrivateKey> = {\n        ed25519: learnCard.invoke.generateEd25519KeyFromBytes(seedBytes),\n        secp256k1: learnCard.invoke.generateSecp256k1KeyFromBytes(seedBytes),\n    };\n\n    const did = (method = defaultDidMethod) => {\n        if (!memoizedDids[method]) {\n            const algorithm = getAlgorithmForDidMethod(method);\n            memoizedDids[method] = learnCard.invoke.keyToDid(method, keyPairs[algorithm]);\n        }\n\n        return memoizedDids[method]!;\n    };\n\n    const keypair = (algorithm: Algorithm = 'ed25519') => {\n        if (!keyPairs[algorithm]) throw new Error('Unsupported algorithm');\n\n        return keyPairs[algorithm];\n    };\n\n    return {\n        name: 'DID Key',\n        displayName: 'DID Key',\n        description: 'Generates dids and JWKs using 32 Secure Random Bytes of Entropy',\n        id: {\n            did: (_learnCard, method) => did(method as any),\n            keypair: (_learnCard, algorithm) => keypair(algorithm as any),\n        },\n        methods: {\n            getSubjectDid: (_learnCard, method = defaultDidMethod) => did(method),\n            getSubjectKeypair: (_learnCard, algorithm = 'ed25519') => keypair(algorithm),\n            getKey: () => seed,\n        },\n    };\n};\n", "import { Algorithm } from './types';\n\nexport const ED25519_METHODS = ['key', 'tz', 'pkh:tz', 'pkh:tezos', 'pkh:sol', 'pkh:solana'];\n\nexport const SECP256K1_METHODS = [\n    'key',\n    'tz',\n    'ethr',\n    'pkh:tz',\n    'pkh:tezos',\n    'pkh:eth',\n    'pkh:celo',\n    'pkh:poly',\n    'pkh:btc',\n    'pkh:doge',\n    'pkh:eip155',\n    'pkh:bip122',\n];\n\nexport const getAlgorithmForDidMethod = <DidMethod extends string>(\n    didMethod: DidMethod\n): Algorithm => {\n    if (ED25519_METHODS.includes(didMethod)) return 'ed25519';\n    if (\n        SECP256K1_METHODS.includes(didMethod) ||\n        didMethod.startsWith('pkh:eip155:') ||\n        didMethod.startsWith('pkh:bip122:')\n    ) {\n        return 'secp256k1';\n    }\n\n    throw new Error('Unspported Did Method');\n};\n"],
   "mappings": ";;;;AAIA,SAAS,aAAa,KAAK;AACvB,MAAI,IAAI,GAAG,KAAK,IAAI,QAAQ,QAAQ,CAAC;AACrC,MAAI,KAAK,GACL;AAAE,UAAM,IAAI,MAAM,iBAAiB,GAAG;AAAA,EAAG;AAC7C,SAAO,IAAI,IAAI,KAAK,GAAG;AACnB,UAAM,KAAK,SAAS,IAAI,OAAO,GAAG,CAAC,GAAG,EAAE,CAAC;AAAA,EAC7C;AACA,SAAO,IAAI,WAAW,KAAK;AAC/B;AARS;;;ACHT,SAAS,aAAa;;;ACCf,IAAM,kBAAkB,CAAC,OAAO,MAAM,UAAU,aAAa,WAAW,YAAY;AAEpF,IAAM,oBAAoB;AAAA,EAC7B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACJ;AAEO,IAAM,2BAA2B,wBACpC,cACY;AACZ,MAAI,gBAAgB,SAAS,SAAS,EAAG,QAAO;AAChD,MACI,kBAAkB,SAAS,SAAS,KACpC,UAAU,WAAW,aAAa,KAClC,UAAU,WAAW,aAAa,GACpC;AACE,WAAO;AAAA,EACX;AAEA,QAAM,IAAI,MAAM,uBAAuB;AAC3C,GAbwC;;;ADRxC,IAAI,mBAAmB;AAMhB,IAAM,kBAAkB,8BAC3B,WACA,KACA,qBACmC;AACnC,MAAI,IAAI,WAAW,EAAG,OAAM,IAAI,MAAM,6CAA6C;AACnF,MAAI,CAAC,MAAM,GAAG,EAAG,OAAM,IAAI,MAAM,mCAAmC;AACpE,MAAI,IAAI,SAAS,GAAI,OAAM,IAAI,MAAM,qCAAqC;AAE1E,MAAI,IAAI,SAAS,MAAM,CAAC,kBAAkB;AACtC,uBAAmB;AAEnB,YAAQ;AAAA,MACJ;AAAA,IACJ;AACA,YAAQ;AAAA,MACJ;AAAA,IACJ;AACA,YAAQ;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AAEA,QAAM,OAAO,IAAI,SAAS,IAAI,GAAG;AACjC,QAAM,YAAY,aAAa,IAAI;AAEnC,QAAM,eAAmD,CAAC;AAC1D,QAAM,WAAiD;AAAA,IACnD,SAAS,UAAU,OAAO,4BAA4B,SAAS;AAAA,IAC/D,WAAW,UAAU,OAAO,8BAA8B,SAAS;AAAA,EACvE;AAEA,QAAM,MAAM,wBAAC,SAAS,qBAAqB;AACvC,QAAI,CAAC,aAAa,MAAM,GAAG;AACvB,YAAM,YAAY,yBAAyB,MAAM;AACjD,mBAAa,MAAM,IAAI,UAAU,OAAO,SAAS,QAAQ,SAAS,SAAS,CAAC;AAAA,IAChF;AAEA,WAAO,aAAa,MAAM;AAAA,EAC9B,GAPY;AASZ,QAAM,UAAU,wBAAC,YAAuB,cAAc;AAClD,QAAI,CAAC,SAAS,SAAS,EAAG,OAAM,IAAI,MAAM,uBAAuB;AAEjE,WAAO,SAAS,SAAS;AAAA,EAC7B,GAJgB;AAMhB,SAAO;AAAA,IACH,MAAM;AAAA,IACN,aAAa;AAAA,IACb,aAAa;AAAA,IACb,IAAI;AAAA,MACA,KAAK,wBAAC,YAAY,WAAW,IAAI,MAAa,GAAzC;AAAA,MACL,SAAS,wBAAC,YAAY,cAAc,QAAQ,SAAgB,GAAnD;AAAA,IACb;AAAA,IACA,SAAS;AAAA,MACL,eAAe,wBAAC,YAAY,SAAS,qBAAqB,IAAI,MAAM,GAArD;AAAA,MACf,mBAAmB,wBAAC,YAAY,YAAY,cAAc,QAAQ,SAAS,GAAxD;AAAA,MACnB,QAAQ,6BAAM,MAAN;AAAA,IACZ;AAAA,EACJ;AACJ,GA7D+B;",
   "names": []

package/package.json

@@ -1,58 +1,60 @@
 {
-  "name": "@learncard/didkey-plugin",
-  "version": "1.1.24",
-  "description": "",
-  "type": "module",
-  "main": "./dist/index.cjs",
-  "module": "./dist/didkey-plugin.esm.js",
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/didkey-plugin.esm.js"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
-    }
-  },
-  "files": [
-    "dist"
-  ],
-  "author": "Learning Economy Foundation (www.learningeconomy.io)",
-  "license": "MIT",
-  "homepage": "https://github.com/learningeconomy/LearnCard/tree/main/packages/plugins/didkey/README.md",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/learningeconomy/LearnCard"
-  },
-  "bugs": {
-    "url": "https://github.com/learningeconomy/LearnCard/issues"
-  },
-  "devDependencies": {
-    "@types/jest": "^29.2.2",
-    "@types/node": "^17.0.31",
-    "aqu": "0.4.3",
-    "esbuild": "^0.27.1",
-    "esbuild-jest": "^0.5.0",
-    "esbuild-plugin-copy": "^1.3.0",
-    "jest": "^29.3.0",
-    "shx": "^0.3.4",
-    "ts-jest": "^29.0.3",
-    "@learncard/types": "5.17.4"
-  },
-  "types": "./dist/index.d.ts",
-  "dependencies": {
-    "hex-lite": "^1.5.0",
-    "@learncard/core": "9.4.24",
-    "@learncard/helpers": "^1.3.6"
-  },
-  "sideEffects": false,
-  "scripts": {
-    "build": "node ./scripts/build.mjs && shx cp ./scripts/mixedEntypoint.js ./dist/index.cjs && tsc --p tsconfig.json && shx cp ./dist/index.d.ts ./dist/index.d.cts",
-    "test": "jest --passWithNoTests",
-    "test:watch": "jest --watch",
-    "test:coverage": "jest --silent --ci --coverage --coverageReporters=\"text\" --coverageReporters=\"text-summary\""
-  }
-}
+    "name": "@learncard/didkey-plugin",
+    "version": "1.1.26",
+    "description": "",
+    "type": "module",
+    "main": "./dist/index.cjs",
+    "module": "./dist/didkey-plugin.esm.js",
+    "exports": {
+        ".": {
+            "development": "./src/index.ts",
+            "import": {
+                "types": "./dist/index.d.ts",
+                "default": "./dist/didkey-plugin.esm.js"
+            },
+            "require": {
+                "types": "./dist/index.d.cts",
+                "default": "./dist/index.cjs"
+            }
+        }
+    },
+    "files": [
+        "dist",
+        "src"
+    ],
+    "scripts": {
+        "build": "node ./scripts/build.mjs && shx cp ./scripts/mixedEntypoint.js ./dist/index.cjs && tsc --p tsconfig.json && shx cp ./dist/index.d.ts ./dist/index.d.cts",
+        "test": "jest --passWithNoTests",
+        "test:watch": "jest --watch",
+        "test:coverage": "jest --silent --ci --coverage --coverageReporters=\"text\" --coverageReporters=\"text-summary\""
+    },
+    "author": "Learning Economy Foundation (www.learningeconomy.io)",
+    "license": "MIT",
+    "homepage": "https://github.com/learningeconomy/LearnCard/tree/main/packages/plugins/didkey/README.md",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/learningeconomy/LearnCard"
+    },
+    "bugs": {
+        "url": "https://github.com/learningeconomy/LearnCard/issues"
+    },
+    "devDependencies": {
+        "@learncard/types": "5.17.5",
+        "@types/jest": "^29.2.2",
+        "@types/node": "^17.0.31",
+        "aqu": "0.4.3",
+        "esbuild": "^0.27.1",
+        "esbuild-jest": "^0.5.0",
+        "esbuild-plugin-copy": "^1.3.0",
+        "jest": "^29.3.0",
+        "shx": "^0.3.4",
+        "ts-jest": "^29.0.3"
+    },
+    "types": "./dist/index.d.ts",
+    "dependencies": {
+        "@learncard/core": "9.4.26",
+        "@learncard/helpers": "^1.3.8",
+        "hex-lite": "^1.5.0"
+    },
+    "sideEffects": false
+}

package/src/global.d.ts

@@ -0,0 +1,6 @@
+declare module 'hex-lite' {
+    function toUint8Array(hex: string): Uint8Array;
+    function fromUint8Array(array: Uint8Array): string;
+    function toBuffer(hex: string): ArrayBuffer;
+    function fromBuffer(buffer: ArrayBuffer): string;
+}

package/src/helpers.ts

@@ -0,0 +1,33 @@
+import { Algorithm } from './types';
+
+export const ED25519_METHODS = ['key', 'tz', 'pkh:tz', 'pkh:tezos', 'pkh:sol', 'pkh:solana'];
+
+export const SECP256K1_METHODS = [
+    'key',
+    'tz',
+    'ethr',
+    'pkh:tz',
+    'pkh:tezos',
+    'pkh:eth',
+    'pkh:celo',
+    'pkh:poly',
+    'pkh:btc',
+    'pkh:doge',
+    'pkh:eip155',
+    'pkh:bip122',
+];
+
+export const getAlgorithmForDidMethod = <DidMethod extends string>(
+    didMethod: DidMethod
+): Algorithm => {
+    if (ED25519_METHODS.includes(didMethod)) return 'ed25519';
+    if (
+        SECP256K1_METHODS.includes(didMethod) ||
+        didMethod.startsWith('pkh:eip155:') ||
+        didMethod.startsWith('pkh:bip122:')
+    ) {
+        return 'secp256k1';
+    }
+
+    throw new Error('Unspported Did Method');
+};

package/src/index.ts

@@ -0,0 +1,79 @@
+import { toUint8Array } from 'hex-lite';
+import { isHex } from '@learncard/helpers';
+import { JWKWithPrivateKey } from '@learncard/types';
+import { LearnCard } from '@learncard/core';
+
+import { getAlgorithmForDidMethod } from './helpers';
+
+import { DidKeyPlugin, DependentMethods, Algorithm } from './types';
+
+export * from './types';
+
+let _shortSeedWarned = false;
+
+/**
+ *
+ * @group Plugins
+ */
+export const getDidKeyPlugin = async <DidMethod extends string>(
+    learnCard: LearnCard<any, any, DependentMethods<DidMethod>>,
+    key: string,
+    defaultDidMethod: DidMethod
+): Promise<DidKeyPlugin<DidMethod>> => {
+    if (key.length === 0) throw new Error("Please don't use an empty string for a key!");
+    if (!isHex(key)) throw new Error('Key must be a hexadecimal string!');
+    if (key.length > 64) throw new Error('Key must be less than 64 characters');
+
+    if (key.length < 64 && !_shortSeedWarned) {
+        _shortSeedWarned = true;
+
+        console.warn(
+            'Warning: A LearnCard has been initialized with a seed that is less than 32 bytes, and will be padded with zeroes'
+        );
+        console.warn(
+            'Please instantiate LearnCards using 32 bytes that have been randomly generated in a cryptographically secure fashion!'
+        );
+        console.warn(
+            'See https://app.gitbook.com/o/6uDv1QDlxaaZC7i8EaGb/s/FXvEJ9j3Vf3FW5Nc557n/learn-card-packages/learncard-core/instantiation#key-generation for details'
+        );
+    }
+
+    const seed = key.padStart(64, '0');
+    const seedBytes = toUint8Array(seed);
+
+    const memoizedDids: Partial<Record<DidMethod, string>> = {};
+    const keyPairs: Record<Algorithm, JWKWithPrivateKey> = {
+        ed25519: learnCard.invoke.generateEd25519KeyFromBytes(seedBytes),
+        secp256k1: learnCard.invoke.generateSecp256k1KeyFromBytes(seedBytes),
+    };
+
+    const did = (method = defaultDidMethod) => {
+        if (!memoizedDids[method]) {
+            const algorithm = getAlgorithmForDidMethod(method);
+            memoizedDids[method] = learnCard.invoke.keyToDid(method, keyPairs[algorithm]);
+        }
+
+        return memoizedDids[method]!;
+    };
+
+    const keypair = (algorithm: Algorithm = 'ed25519') => {
+        if (!keyPairs[algorithm]) throw new Error('Unsupported algorithm');
+
+        return keyPairs[algorithm];
+    };
+
+    return {
+        name: 'DID Key',
+        displayName: 'DID Key',
+        description: 'Generates dids and JWKs using 32 Secure Random Bytes of Entropy',
+        id: {
+            did: (_learnCard, method) => did(method as any),
+            keypair: (_learnCard, algorithm) => keypair(algorithm as any),
+        },
+        methods: {
+            getSubjectDid: (_learnCard, method = defaultDidMethod) => did(method),
+            getSubjectKeypair: (_learnCard, algorithm = 'ed25519') => keypair(algorithm),
+            getKey: () => seed,
+        },
+    };
+};

package/src/types.ts

@@ -0,0 +1,28 @@
+import { Plugin } from '@learncard/core';
+import { JWKWithPrivateKey } from '@learncard/types';
+
+/** @group DidKey Plugin */
+export type Algorithm = 'ed25519' | 'secp256k1';
+
+/** @group DidKey Plugin */
+export type DependentMethods<DidMethod extends string> = {
+    generateEd25519KeyFromBytes: (bytes: Uint8Array) => JWKWithPrivateKey;
+    generateSecp256k1KeyFromBytes: (bytes: Uint8Array) => JWKWithPrivateKey;
+    keyToDid: (method: DidMethod, keypair: JWKWithPrivateKey) => string;
+};
+
+/** @group DidKey Plugin */
+export type DidKeyPluginMethods<DidMethod extends string> = {
+    getSubjectDid: (method?: DidMethod) => string;
+    getSubjectKeypair: (algorithm?: Algorithm) => JWKWithPrivateKey;
+    getKey: () => string;
+};
+
+/** @group DidKey Plugin */
+export type DidKeyPlugin<DidMethod extends string = string> = Plugin<
+    'DID Key',
+    'id',
+    DidKeyPluginMethods<DidMethod>,
+    any,
+    DependentMethods<DidMethod>
+>;