@owlmeans/did 0.1.0

package/build/wallet.js

@@ -0,0 +1,151 @@
+import { DIDInitializationError, DIDKeyError, DIDWalletError } from './errors.js';
+import { generateMnemonic, toEntropy, toMnemonic, toSeed } from './utils/mnemonic.js';
+import { KEY_OWL, MASTER } from './consts.js';
+import { plugins } from './plugins/index.js';
+import { ed25519owlPluginBuilder } from './plugins/ed25519owl.js';
+import { produceKey } from './utils/key.js';
+import { makeDidKeyModel } from './model.js';
+import { mataToPath, matchMeta } from './utils.js';
+export const makeWallet = async (store, opts) => {
+    if (await store.master.load(MASTER) == null) {
+        if (!opts?.force && !opts?.allowEmpty) {
+            throw new DIDInitializationError('master');
+        }
+    }
+    const type = opts?.type ?? KEY_OWL;
+    if (plugins[type] == null) {
+        if (opts?.allowCustomType) {
+            plugins[type] = ed25519owlPluginBuilder(type);
+        }
+    }
+    const wallet = {
+        store,
+        generate: async (opts) => {
+            const mnemonic = generateMnemonic(opts);
+            const seed = {
+                entropy: toEntropy(mnemonic),
+                seed: toSeed(mnemonic)
+            };
+            const master = produceKey(seed.seed, type);
+            await store.master.save({ id: MASTER, ...master, ...seed });
+        },
+        mnemonic: async (crash) => {
+            const master = await store.master.get(MASTER);
+            if (master.seed == null) {
+                if (crash) {
+                    throw new DIDWalletError('mnemonic');
+                }
+                return false;
+            }
+            return toMnemonic(master.seed);
+        },
+        master: async () => makeDidKeyModel(await store.master.get(MASTER)),
+        add: async (key, meta) => {
+            if (key.keyPair == null || key.keyPair.privateKey == null) {
+                throw new DIDWalletError('key:non-managable');
+            }
+            const stored = await store.keys.load(key.exportAddress());
+            if (stored != null) {
+                throw new DIDWalletError('key:exists');
+            }
+            await store.keys.create({ id: key.exportAddress(), ...key.keyPair });
+            await store.meta.create({ ...meta, id: key.exportAddress() });
+        },
+        meta: async (key) => {
+            if (typeof key === 'string') {
+                if (null == await store.keys.load(key)) {
+                    throw new DIDWalletError('no:key');
+                }
+                return store.meta.get(key);
+            }
+            return wallet.meta(key.exportAddress());
+        },
+        update: async (key, meta) => {
+            if (key.keyPair == null) {
+                throw new DIDWalletError('key:non-managable');
+            }
+            const did = key.exportAddress();
+            const returnKey = await store.keys.save({ id: did, ...key.keyPair });
+            const returnMeta = await store.meta.save({ ...meta, id: did });
+            return [makeDidKeyModel(returnKey), returnMeta];
+        },
+        get: async (did) => {
+            if (await store.keys.load(did) == null) {
+                throw new DIDWalletError('no:key');
+            }
+            return makeDidKeyModel(await store.keys.get(did));
+        },
+        find: async (meta) => {
+            const result = await store.meta.list(Object.fromEntries(Object.entries(meta).filter(([_, v]) => typeof v !== 'boolean')));
+            const keys = await Promise.all(result.items.filter(item => matchMeta(item, meta))
+                .map(async (meta) => store.keys.get(meta.id)));
+            return keys.map(key => makeDidKeyModel(key));
+        },
+        provide: async (meta) => {
+            const found = await wallet.find(meta);
+            if (found.length === 0) {
+                const path = mataToPath(meta);
+                const master = await wallet.master();
+                const key = master.derive(path);
+                if (meta.name == null) {
+                    throw new DIDKeyError('no:name');
+                }
+                const metaToSave = {
+                    ...meta, id: meta.id ?? key.exportAddress(), name: meta.name
+                };
+                await wallet.add(key, metaToSave);
+                return [key];
+            }
+            return found;
+        },
+        remove: async (did) => {
+            if (typeof did === 'object') {
+                if ("keyPair" in did) {
+                    return wallet.remove(did.exportAddress());
+                }
+                const keys = await wallet.find(did);
+                const key = await keys.reduce(async (_, key) => {
+                    return wallet.remove(key);
+                }, Promise.resolve(null));
+                if (key == null) {
+                    throw new DIDWalletError('no:key');
+                }
+                return key;
+            }
+            const key = await store.keys.load(did);
+            if (key == null) {
+                throw new DIDWalletError('no:key');
+            }
+            await store.keys.delete(key);
+            const model = makeDidKeyModel(key);
+            await store.meta.delete(model.exportAddress());
+            return model;
+        },
+        all: async () => {
+            const result = [];
+            let more = false;
+            do {
+                const found = await store.keys.list({ pager: { page: Math.floor(result.length / 100), size: 100 } });
+                result.push(...found.items);
+                more = found.pager?.total != null && found.pager.total > result.length;
+            } while (more);
+            return result.map(key => makeDidKeyModel(key));
+        },
+        allMeta: async () => {
+            const result = [];
+            let more = false;
+            do {
+                // const found = await store.keys.list({ pager: { page: Math.floor(result.length / 100), size: 100 } })
+                const found = await store.meta.list({ pager: { page: Math.floor(result.length / 100), size: 100 } });
+                result.push(...found.items);
+                more = found.pager?.total != null && found.pager.total > result.length;
+            } while (more);
+            return result;
+        }
+    };
+    if (opts?.force) {
+        await wallet.generate(opts.mnemonic);
+    }
+    return wallet;
+};
+//# sourceMappingURL=wallet.js.map

package/build/wallet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wallet.js","sourceRoot":"","sources":["../src/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAEjF,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AACrF,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAC5C,OAAO,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAA;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAC5C,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAElD,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAAE,KAAe,EAAE,IAA2B,EAAE,EAAE;IAC/E,IAAI,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;QAC5C,IAAI,CAAC,IAAI,EAAE,KAAK,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,CAAC;YACtC,MAAM,IAAI,sBAAsB,CAAC,QAAQ,CAAC,CAAA;QAC5C,CAAC;IACH,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,EAAE,IAAI,IAAI,OAAO,CAAA;IAClC,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;QAC1B,IAAI,IAAI,EAAE,eAAe,EAAE,CAAC;YAC1B,OAAO,CAAC,IAAI,CAAC,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAA;QAC/C,CAAC;IACH,CAAC;IAED,MAAM,MAAM,GAAc;QACxB,KAAK;QAEL,QAAQ,EAAE,KAAK,EAAC,IAAI,EAAC,EAAE;YACrB,MAAM,QAAQ,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAA;YAEvC,MAAM,IAAI,GAAG;gBACX,OAAO,EAAE,SAAS,CAAC,QAAQ,CAAC;gBAC5B,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC;aACvB,CAAA;YAED,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;YAC1C,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAA;QAC7D,CAAC;QAED,QAAQ,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YACtB,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;YAC7C,IAAI,MAAM,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,KAAK,EAAE,CAAC;oBACV,MAAM,IAAI,cAAc,CAAC,UAAU,CAAC,CAAA;gBACtC,CAAC;gBACD,OAAO,KAAK,CAAA;YACd,CAAC;YAED,OAAO,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QAChC,CAAC;QAED,MAAM,EAAE,KAAK,IAAI,EAAE,CAAC,eAAe,CAAC,MAAM,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAEnE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;YACvB,IAAI,GAAG,CAAC,OAAO,IAAI,IAAI,IAAI,GAAG,CAAC,OAAO,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;gBAC1D,MAAM,IAAI,cAAc,CAAC,mBAAmB,CAAC,CAAA;YAC/C,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC,CAAA;YACzD,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;gBACnB,MAAM,IAAI,cAAc,CAAC,YAAY,CAAC,CAAA;YACxC,CAAC;YACD,MAAM,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,aAAa,EAAE,EAAE,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC,CAAA;YACpE,MAAM,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,GAAG,CAAC,aAAa,EAAE,EAAE,CAAC,CAAA;QAC/D,CAAC;QAED,IAAI,EAAE,KAAK,EAAC,GAAG,EAAC,EAAE;YAChB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC5B,IAAI,IAAI,IAAI,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;oBACvC,MAAM,IAAI,cAAc,CAAC,QAAQ,CAAC,CAAA;gBACpC,CAAC;gBAED,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YAC5B,CAAC;YAED,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC,CAAA;QACzC,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;YAC1B,IAAI,GAAG,CAAC,OAAO,IAAI,IAAI,EAAE,CAAC;gBACxB,MAAM,IAAI,cAAc,CAAC,mBAAmB,CAAC,CAAA;YAC/C,CAAC;YACD,MAAM,GAAG,GAAG,GAAG,CAAC,aAAa,EAAE,CAAA;YAC/B,MAAM,SAAS,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC,CAAA;YACpE,MAAM,UAAU,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAA;YAE9D,OAAO,CAAC,eAAe,CAAC,SAAS,CAAC,EAAE,UAAU,CAAC,CAAA;QACjD,CAAC;QAED,GAAG,EAAE,KAAK,EAAC,GAAG,EAAC,EAAE;YACf,IAAI,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;gBACvC,MAAM,IAAI,cAAc,CAAC,QAAQ,CAAC,CAAA;YACpC,CAAC;YACD,OAAO,eAAe,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAA;QACnD,CAAC;QAED,IAAI,EAAE,KAAK,EAAC,IAAI,EAAC,EAAE;YACjB,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAClC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,SAAS,CAAC,CAAC,CACpF,CAAA;YAED,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;iBAC9E,GAAG,CAAC,KAAK,EAAC,IAAI,EAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;YAE9C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAA;QAC9C,CAAC;QAED,OAAO,EAAE,KAAK,EAAC,IAAI,EAAC,EAAE;YACpB,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YACrC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACvB,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,CAAA;gBAC7B,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,EAAE,CAAA;gBACpC,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;gBAC/B,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;oBACtB,MAAM,IAAI,WAAW,CAAC,SAAS,CAAC,CAAA;gBAClC,CAAC;gBACD,MAAM,UAAU,GAAY;oBAC1B,GAAG,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI;iBAC7D,CAAA;gBACD,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,CAAA;gBAEjC,OAAO,CAAC,GAAG,CAAC,CAAA;YACd,CAAC;YAED,OAAO,KAAK,CAAA;QACd,CAAC;QAED,MAAM,EAAE,KAAK,EAAC,GAAG,EAAC,EAAE;YAClB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC5B,IAAI,SAAS,IAAI,GAAG,EAAE,CAAC;oBACrB,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC,CAAA;gBAC3C,CAAC;gBACD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,GAAc,CAAC,CAAA;gBAC9C,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAA8B,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE;oBAC1E,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;gBAC3B,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;gBACzB,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;oBAChB,MAAM,IAAI,cAAc,CAAC,QAAQ,CAAC,CAAA;gBACpC,CAAC;gBACD,OAAO,GAAG,CAAA;YACZ,CAAC;YACD,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YACtC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;gBAChB,MAAM,IAAI,cAAc,CAAC,QAAQ,CAAC,CAAA;YACpC,CAAC;YACD,MAAM,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YAC5B,MAAM,KAAK,GAAG,eAAe,CAAC,GAAG,CAAC,CAAA;YAClC,MAAM,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC,CAAA;YAE9C,OAAO,KAAK,CAAA;QACd,CAAC;QAED,GAAG,EAAE,KAAK,IAAI,EAAE;YACd,MAAM,MAAM,GAAoB,EAAE,CAAA;YAClC,IAAI,IAAI,GAAG,KAAK,CAAA;YAChB,GAAG,CAAC;gBACF,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,CAAA;gBACpG,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAA;gBAC3B,IAAI,GAAG,KAAK,CAAC,KAAK,EAAE,KAAK,IAAI,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,MAAM,CAAA;YACxE,CAAC,QAAQ,IAAI,EAAC;YAEd,OAAO,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAA;QAChD,CAAC;QAED,OAAO,EAAE,KAAK,IAAI,EAAE;YAClB,MAAM,MAAM,GAAc,EAAE,CAAA;YAC5B,IAAI,IAAI,GAAG,KAAK,CAAA;YAChB,GAAG,CAAC;gBACF,uGAAuG;gBACvG,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,CAAA;gBACpG,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAA;gBAC3B,IAAI,GAAG,KAAK,CAAC,KAAK,EAAE,KAAK,IAAI,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,MAAM,CAAA;YACxE,CAAC,QAAQ,IAAI,EAAC;YAEd,OAAO,MAAM,CAAA;QACf,CAAC;KACF,CAAA;IAED,IAAI,IAAI,EAAE,KAAK,EAAE,CAAC;QAChB,MAAM,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IACtC,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC,CAAA"}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@owlmeans/did",
+  "version": "0.1.0",
+  "type": "module",
+  "scripts": {
+    "build": "tsc -b",
+    "dev": "sleep 153 && nodemon -e ts,tsx,json --watch src --exec \"tsc -p ./tsconfig.json\"",
+    "watch": "tsc -b -w --preserveWatchOutput --pretty"
+  },
+  "main": "build/index.js",
+  "module": "build/index.js",
+  "types": "build/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./build/index.js",
+      "require": "./build/index.js",
+      "default": "./build/index.js",
+      "module": "./build/index.js",
+      "types": "./build/index.d.ts"
+    }
+  },
+  "dependencies": {
+    "@noble/curves": "^1.6.0",
+    "@noble/hashes": "^1.5.0",
+    "@owlmeans/auth": "^0.1.0",
+    "@owlmeans/basic-keys": "^0.1.0",
+    "@owlmeans/error": "^0.1.0",
+    "@owlmeans/i18n": "^0.1.0",
+    "@owlmeans/resource": "^0.1.0",
+    "@scure/base": "^1.1.9",
+    "@scure/bip39": "^1.4.0"
+  },
+  "devDependencies": {
+    "nodemon": "^3.1.7",
+    "npm-check": "^6.0.1",
+    "typescript": "^5.6.3"
+  },
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/consts.ts

@@ -0,0 +1,16 @@
+
+export const KEY_OWL = 'owlmk'
+
+export const KP_SEP = '/'
+
+export const MAX_DEPTH = 6
+
+export const PROFILE_PREFIX = 'profile'
+
+export const ENTITY_PREFIX = 'entity'
+
+export const SERVICE_PREFIX = 'service'
+
+export const PREFIX_SEP = '.'
+
+export const MASTER = '_master_key'

package/src/errors.ts

@@ -0,0 +1,51 @@
+import { ResilientError } from '@owlmeans/error'
+
+export class DIDError extends ResilientError {
+  public static override typeName = 'DIDError'
+
+  constructor(message: string = 'error') {
+    super(DIDError.typeName, `did:${message}`)
+  }
+}
+
+export class DIDKeyError extends DIDError {
+  public static override typeName = `${DIDError.typeName}:Key`
+
+  constructor(message: string = 'error') {
+    super(`wallet:${message}`)
+    this.type = DIDKeyError.typeName
+  }
+}
+
+export class DIDWalletError extends DIDError {
+  public static override typeName = `${DIDError.typeName}:Wallet`
+
+  constructor(message: string = 'error') {
+    super(`wallet:${message}`)
+    this.type = DIDWalletError.typeName
+  }
+}
+
+export class DIDWalletPermissionError extends DIDWalletError {
+  public static override typeName = `${DIDWalletError.typeName}:Permission`
+
+  constructor(message: string = 'error') {
+    super(`permission:${message}`)
+    this.type = DIDWalletPermissionError.typeName
+  }
+}
+
+export class DIDInitializationError extends DIDWalletError {
+  public static override typeName = `${DIDWalletError.typeName}:Initialization`
+
+  constructor(message: string = 'error') {
+    super(`init:${message}`)
+    this.type = DIDInitializationError.typeName
+  }
+}
+
+ResilientError.registerErrorClass(DIDError)
+ResilientError.registerErrorClass(DIDKeyError)
+ResilientError.registerErrorClass(DIDWalletError)
+ResilientError.registerErrorClass(DIDWalletPermissionError)
+ResilientError.registerErrorClass(DIDInitializationError)

package/src/i18n/en.json

@@ -0,0 +1,8 @@
+{
+  "address": {
+    "hint": "DID address"
+  },
+  "master": {
+    "title": "Master key"
+  }
+}

package/src/i18n/wallet-en.json

@@ -0,0 +1,99 @@
+{
+  "createKey": {
+    "title": "Create new key",
+    "description": "Some orgnanization or service asks you to create a new crypto key",
+    "unknown-reason": "Be cautious! We do not know why you are asked to create a new key.",
+    "proceed": {
+      "label": "Confirm"
+    },
+    "cancel": {
+      "label": "Cancel"
+    }
+  },
+  "getEntityKey": {
+    "title": "Get public key for an ortnaization",
+    "description": "Some service asks you to provide a public key and related data for an orgnanization profile",
+    "unknown-reason": "Be cautious! We do not know why you are asked to provide this key.",
+    "proceed": {
+      "label": "Confirm"
+    },
+    "cancel": {
+      "label": "Cancel"
+    }
+  },
+  "sign": {
+    "title": "Sign with the key",
+    "description": "Some service asks you to sign a document with your key",
+    "unknown-reason": "Be cautious! We do not know why you are asked to make this signature.",
+    "proceed": {
+      "label": "Confirm"
+    },
+    "cancel": {
+      "label": "Cancel"
+    }
+  },
+  "masterSign": {
+    "title": "Sign with the primary key",
+    "description": "Some service asks you to sign a document with your primary key, that most likely should be used only with OwlMeans services",
+    "unknown-reason": "Be cautious! We do not know why you are asked to make this signature.",
+    "proceed": {
+      "label": "Confirm"
+    },
+    "cancel": {
+      "label": "Cancel"
+    }
+  },
+  "getMasterDid": {
+    "title": "Get your primary DID",
+    "description": "Some service asks for your primary decentralized address, that most likely should be shared only with OwlMeans services",
+    "unknown-reason": "Be cautious! We do not know why you are asked to share your primary DID.",
+    "proceed": {
+      "label": "Confirm"
+    },
+    "cancel": {
+      "label": "Cancel"
+    }
+  },
+  "selectKey": {
+    "title": "Choose a key",
+    "description": "Some service asks you to choose a key to get its public detials",
+    "unknown-reason": "Be cautious! We do not know why you are asked to provide public info of one of your keys.",
+    "proceed": {
+      "label": "Confirm"
+    },
+    "cancel": {
+      "label": "Cancel"
+    }
+  },
+  "getPublicDetails": {
+    "title": "Get public key",
+    "description": "Some service asks for a public key linked to your organization profile",
+    "unknown-reason": "Be cautious! We do not know why you are asked to share your public key.",
+    "proceed": {
+      "label": "Confirm"
+    },
+    "cancel": {
+      "label": "Cancel"
+    }
+  },
+  "requestPermissions": {
+    "title": "Requested permissions",
+    "description": "Some service asks to perform an action sequence with your wallet",
+    "unknown-reason": "Be cautious! We do not know why you are asked to perform these actions.",
+    "proceed": {
+      "label": "Confirm"
+    },
+    "cancel": {
+      "label": "Cancel"
+    },
+    "method": {
+      "createKey": "Create new crypto key",
+      "getEntityKey": "Get an organization public key",
+      "sign": "Sign some data with your key",
+      "masterSign": "Sign data with your primary key",
+      "getMasterDid": "Get your primary ID",
+      "selectKey": "Get one of your public keys",
+      "getPublicDetails": "Get your public key"
+    }
+  }
+}

package/src/i18n.ts

@@ -0,0 +1,7 @@
+import { addI18nLib } from '@owlmeans/i18n'
+
+import en from './i18n/en.json' with { type: 'json' }
+import walletEn from './i18n/wallet-en.json' with { type: 'json' }
+
+addI18nLib('en', 'keys', en, { ns: 'did' })
+addI18nLib('en', 'wallet', walletEn, { ns: 'did' })

package/src/index.ts

@@ -0,0 +1,9 @@
+
+export type * from './types.js'
+export * from './i18n.js'
+export * from './consts.js'
+export * from './wallet.js'
+export * from './model.js'
+export * from './errors.js'
+export * from './plugins/index.js'
+export * from './wallet/index.js'

package/src/model.ts

@@ -0,0 +1,52 @@
+import { makeKeyPairModel, plugins, type KeyPair } from '@owlmeans/basic-keys'
+import type { DIDKeyModel } from './types.js'
+import { DIDKeyError } from './errors.js'
+import { assertType, prepareKey } from '@owlmeans/basic-keys/utils'
+import { base64 } from '@scure/base'
+import { KP_SEP, MAX_DEPTH } from './consts.js'
+
+export const makeDidKeyModel: (input?: KeyPair | string) => DIDKeyModel = input => {
+  if (typeof input == 'string') {
+    const plugin = plugins[input]
+    if (plugin != null && (plugin.fromSeed == null || plugin.derive == null)) {
+      throw new DIDKeyError(`non-derivable:${input}`)
+    }
+  }
+  const model: DIDKeyModel = makeKeyPairModel(input) as DIDKeyModel
+
+  model.derive = path => {
+    if (model.keyPair == null) {
+      throw new DIDKeyError('no:keypair')
+    }
+    assertType(model.keyPair?.type)
+    if (model.keyPair.privateKey == null) {
+      throw new DIDKeyError('no:pk')
+    }
+
+    const items = path.split(KP_SEP).filter(item => item != null && item !== '')
+
+    if (items.length > MAX_DEPTH) {
+      throw new DIDKeyError('too:deep')
+    }
+    
+    const item = items.shift()
+    if (item == null) {
+      throw new DIDKeyError('no:path')
+    }
+
+    const newKey = [model.keyPair.type, base64.encode(
+      plugins[model.keyPair.type].derive!(prepareKey(model.keyPair.privateKey), item)
+    )].join(':')
+    
+    const derived = makeDidKeyModel(newKey)
+    if (derived.keyPair == null) {
+      throw new DIDKeyError('derived:missgenerated')
+    }
+    derived.keyPair.path = path
+    derived.keyPair.parent = model.exportAddress()
+
+    return items.length > 0 ? derived.derive(items.join(KP_SEP)) : derived
+  }
+
+  return model
+}

package/src/plugins/ed25519owl.ts

@@ -0,0 +1,35 @@
+import { ed25519 } from '@noble/curves/ed25519'
+import type { KeyPlugin } from '@owlmeans/basic-keys/plugins'
+import { KEY_OWL } from '../consts.js'
+import { base58, utf8 } from '@scure/base'
+import { concatBytes, randomBytes } from '@noble/hashes/utils'
+import { hmac } from '@noble/hashes/hmac'
+import { sha512 } from '@noble/hashes/sha512'
+import { keccak_256 } from '@noble/hashes/sha3'
+
+export const ed25519owlPluginBuilder = (type: string = KEY_OWL): KeyPlugin => {
+  const key: KeyPlugin = {
+    type: type,
+
+    random: () => key.fromSeed!(randomBytes(32)),
+
+    derive: (pk, path) =>
+      hmac(sha512, pk.slice(32), concatBytes(pk.slice(0, 32), utf8.decode(path))),
+
+    fromSeed: (seed: Uint8Array) => hmac(sha512, utf8.decode(type), seed),
+
+    sign: (data, pk) => ed25519.sign(data, pk.slice(0, 32)),
+
+    verify: (data, signature, pub) => ed25519.verify(signature, data, pub),
+
+    toPublic: pk => ed25519.getPublicKey(pk.slice(0, 32)),
+
+    toAdress: pub => base58.encode(keccak_256(pub.slice(4)).slice(-20)),
+
+    encrypt: () => { throw new Error(`${key.type}:encryption-support`) },
+
+    decrypt: () => { throw new Error(`${key.type}:encryption-support`) }
+  }
+
+  return key
+}

package/src/plugins/exports.ts

@@ -0,0 +1,3 @@
+
+export * from './index.js'
+export * from './ed25519owl.js'

package/src/plugins/index.ts

@@ -0,0 +1,9 @@
+
+import { plugins as basicPlugins } from '@owlmeans/basic-keys'
+import { ed25519owlPluginBuilder } from './ed25519owl.js'
+
+const owlPluginInstance = ed25519owlPluginBuilder()
+
+basicPlugins[owlPluginInstance.type] = owlPluginInstance
+
+export const plugins = basicPlugins

package/src/types.ts

@@ -0,0 +1,89 @@
+import type { Profile } from '@owlmeans/auth'
+import type { KeyPair, KeyPairModel } from '@owlmeans/basic-keys'
+import type { Resource, ResourceRecord } from '@owlmeans/resource'
+
+export interface DIDWallet {
+  store: DIDStore
+  
+  generate: (opts?: MnemonicOptions) => Promise<void>
+  
+  mnemonic: (crash?: boolean) => Promise<string | false>
+
+  master: () => Promise<DIDKeyModel>
+
+  add: (key: DIDKeyModel, meta: KeyMeta) => Promise<void>
+
+  meta: (key: string | DIDKeyModel) => Promise<KeyMeta>
+
+  update: (key: DIDKeyModel, meta: KeyMeta) => Promise<[DIDKeyModel, KeyMeta]>
+
+  get: (did: string) => Promise<DIDKeyModel | null>
+
+  find: (meta: Partial<KeyMeta>) => Promise<DIDKeyModel[]>
+
+  provide: (mate: Partial<KeyMeta>) => Promise<DIDKeyModel[]>
+
+  remove: (did: string | KeyMeta | DIDKeyModel) => Promise<DIDKeyModel>
+
+  all: () => Promise<DIDKeyModel[]>
+  
+  allMeta: () => Promise<KeyMeta[]>
+}
+
+export interface MakeDIDWalletOptions {
+  force?: boolean
+  allowEmpty?: boolean
+  mnemonic?: MnemonicOptions
+  type?: string
+  allowCustomType?: boolean
+}
+
+export interface DIDStore {
+  master: MasterResource
+  keys: KeyPairResource
+  meta: KeyMetaResource
+}
+
+export interface MasterResource extends Resource<KeySeedRecord> {
+}
+
+export interface KeyPairResource extends Resource<KeyPairRecord> {
+}
+
+export interface KeyMetaResource extends Resource<KeyMetaRecord> {
+}
+
+export interface KeyPairRecord extends ResourceRecord, DIDKeyPair {
+}
+
+export interface KeySeedRecord extends ResourceRecord, KeySeed {
+}
+
+export interface KeyMetaRecord extends ResourceRecord, KeyMeta {
+  id: string
+}
+
+export interface KeySeed extends DIDKeyPair {
+  entropy?: string
+  seed?: string
+}
+
+export interface KeyMeta extends Partial<Profile> {
+  id: string
+  name: string
+  entityId?: string
+}
+
+export interface MnemonicOptions {
+  size?: number
+}
+
+export interface DIDKeyPair extends KeyPair {
+  path?: string
+  parent?: string 
+}
+
+export interface DIDKeyModel extends KeyPairModel  {
+  keyPair?: DIDKeyPair
+  derive: (path: string) => DIDKeyModel
+}

package/src/utils/index.ts

@@ -0,0 +1,4 @@
+
+export * from './mnemonic.js'
+export * from './key.js'
+export * from '../utils.js'

package/src/utils/key.ts

@@ -0,0 +1,29 @@
+
+import { assertType } from '@owlmeans/basic-keys/utils'
+import { KEY_OWL } from '../consts.js'
+import { base64 } from '@scure/base'
+import { plugins } from '../plugins/index.js'
+import { DIDKeyError } from '../errors.js'
+import type { DIDKeyPair } from '../types.js'
+
+export const produceKey = (seed: string | Uint8Array, type: string = KEY_OWL) => {
+  if (typeof seed === 'string') {
+    seed = base64.decode(seed)
+  }
+  assertType(type)
+
+  if (plugins[type].fromSeed == null) {
+    throw new DIDKeyError(`non-derivable:${type}`)
+  }
+
+  const privateKey = plugins[type].fromSeed(seed)
+  const publicKey = plugins[type].toPublic(privateKey)
+  const keyPair: DIDKeyPair = {
+    privateKey: base64.encode(privateKey),
+    publicKey: base64.encode(publicKey),
+    address: plugins[type].toAdress(publicKey),
+    type,
+  }
+
+  return keyPair
+}

package/src/utils/mnemonic.ts

@@ -0,0 +1,24 @@
+import type { MnemonicOptions } from '../types.js'
+import { generateMnemonic as generate, mnemonicToSeedSync, entropyToMnemonic } from '@scure/bip39'
+import { hex, base64 } from '@scure/base'
+import { wordlist } from '@scure/bip39/wordlists/english'
+
+export const generateMnemonic = (opts?: MnemonicOptions): string => {
+  const size = opts?.size ?? 18
+
+  if (size < 12 || size > 24) {
+    throw new SyntaxError('Mnemonic size should be between 12 and 24')
+  }
+
+  const strength = Math.round(256 * size / 24)
+  return generate(wordlist as any, strength + (32 - strength % 32))
+}
+
+export const toSeed = (mnemonic: string): string =>
+  base64.encode(mnemonicToSeedSync(mnemonic))
+
+export const toEntropy = (mnemonic: string): string =>
+  hex.encode(mnemonicToSeedSync(mnemonic))
+
+export const toMnemonic = (seed: string): string =>
+  entropyToMnemonic(hex.decode(seed), wordlist as any)