@twin.org/node-core 0.0.3-next.4 → 0.0.3-next.40

package/dist/es/identity.js

@@ -1,182 +0,0 @@
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-import { Converter, I18n, Is, RandomHelper, StringHelper, Urn } from "@twin.org/core";
-import { Bip39 } from "@twin.org/crypto";
-import { IdentityConnectorType, WalletConnectorType } from "@twin.org/engine-types";
-import { EntityStorageConnectorFactory } from "@twin.org/entity-storage-models";
-import { IdentityConnectorFactory, IdentityResolverConnectorFactory } from "@twin.org/identity-models";
-import { VaultConnectorFactory } from "@twin.org/vault-models";
-import { WalletConnectorFactory } from "@twin.org/wallet-models";
-/**
- * Generate an identity and fund it.
- * @param engineCore The engine core for the node.
- * @param envVars The environment variables for the node.
- * @param configIdentity A identity from config to use.
- * @param configMnemonic A mnemonic from config to use.
- * @param controller The controller for the identity.
- * @param identityType The type of identity.
- * @param addWallet Whether to add a wallet for the identity.
- * @returns The identity that was generated.
- */
-export async function createIdentity(engineCore, envVars, configIdentity, configMnemonic, controller, identityType, addWallet) {
-    engineCore.logInfo(I18n.formatMessage("node.processingIdentity", { identityType }));
-    // We have a chicken and egg problem in that we can't create the identity
-    // to store the mnemonic in the vault without an identity. We use a temporary identity
-    // and then replace it with the new identity later in the process.
-    const defaultVaultConnectorType = engineCore.getRegisteredInstanceType("vaultConnector");
-    const vaultConnector = VaultConnectorFactory.get(defaultVaultConnectorType);
-    const workingIdentity = configIdentity ?? `bootstrap-temp-${Converter.bytesToHex(RandomHelper.generate(16))}`;
-    const workingController = controller ?? workingIdentity;
-    const mnemonicStored = await bootstrapMnemonic(engineCore, vaultConnector, workingIdentity, configMnemonic);
-    const addresses = addWallet ? await generateWallet(engineCore, envVars, workingIdentity) : [];
-    const finalIdentity = await generateIdentity(engineCore, envVars, workingController, workingIdentity, identityType);
-    if (mnemonicStored) {
-        engineCore.logInfo(I18n.formatMessage("node.finalMnemonic", { vaultKey: `${finalIdentity}/mnemonic` }));
-    }
-    await finaliseWallet(engineCore, envVars, finalIdentity, addresses);
-    await finaliseMnemonic(vaultConnector, workingIdentity, finalIdentity);
-    return finalIdentity;
-}
-/**
- * Generate a mnemonic for the node identity.
- * @param engineCore The engine core for the node.
- * @param vaultConnector The vault connector to use.
- * @param identity The identity of the node.
- * @param existingMnemonic An existing mnemonic to use.
- * @returns Whether the mnemonic was stored.
- */
-async function bootstrapMnemonic(engineCore, vaultConnector, identity, existingMnemonic) {
-    let mnemonic = existingMnemonic;
-    let storeMnemonic = false;
-    const mnemonicKey = `${identity}/mnemonic`;
-    try {
-        const storedMnemonic = await vaultConnector.getSecret(mnemonicKey);
-        if (Is.stringValue(storedMnemonic)) {
-            storeMnemonic = storedMnemonic !== mnemonic && !Is.empty(mnemonic);
-            mnemonic = storedMnemonic;
-        }
-        else {
-            storeMnemonic = true;
-        }
-    }
-    catch {
-        storeMnemonic = true;
-    }
-    // If there is no mnemonic then we need to generate one
-    if (Is.empty(mnemonic)) {
-        mnemonic = Bip39.randomMnemonic();
-        storeMnemonic = true;
-    }
-    // If there is no mnemonic stored in the vault then we need to store it
-    if (storeMnemonic) {
-        engineCore.logInfo(I18n.formatMessage("node.storingMnemonic"));
-        await vaultConnector.setSecret(mnemonicKey, mnemonic);
-    }
-    else {
-        engineCore.logInfo(I18n.formatMessage("node.existingMnemonic"));
-    }
-    return storeMnemonic;
-}
-/**
- * Finalise the mnemonic for the node identity.
- * @param vaultConnector The vault connector to use.
- * @param workingIdentity The identity of the node.
- * @param finalIdentity The final identity for the node.
- */
-async function finaliseMnemonic(vaultConnector, workingIdentity, finalIdentity) {
-    // Now that we have an identity we can remove the temporary one
-    // and store the mnemonic with the new identity
-    if (workingIdentity.startsWith("bootstrap-temp-") && workingIdentity !== finalIdentity) {
-        const mnemonic = await vaultConnector.getSecret(`${workingIdentity}/mnemonic`);
-        await vaultConnector.setSecret(`${finalIdentity}/mnemonic`, mnemonic);
-        await vaultConnector.removeSecret(`${workingIdentity}/mnemonic`);
-    }
-}
-/**
- * Bootstrap the identity for the node.
- * @param engineCore The engine core for the node.
- * @param envVars The environment variables for the node.
- * @param finalIdentity The identity of the node.
- * @param addresses The addresses for the wallet.
- */
-async function finaliseWallet(engineCore, envVars, finalIdentity, addresses) {
-    if (Is.arrayValue(addresses)) {
-        const defaultWalletConnectorType = engineCore.getRegisteredInstanceType("walletConnector");
-        // If we are using entity storage for wallet the identity associated with the
-        // address will be wrong, so fix it
-        if (defaultWalletConnectorType.startsWith(WalletConnectorType.EntityStorage)) {
-            const walletAddress = EntityStorageConnectorFactory.get("wallet-address");
-            const addr = await walletAddress.get(addresses[0]);
-            if (!Is.empty(addr)) {
-                addr.identity = finalIdentity;
-                await walletAddress.set(addr);
-            }
-        }
-    }
-}
-/**
- * Bootstrap the wallet for the node.
- * @param engineCore The engine core for the node.
- * @param envVars The environment variables for the node.
- * @param identity The identity to create the wallet for.
- * @returns The addresses for the wallet.
- */
-async function generateWallet(engineCore, envVars, identity) {
-    const defaultWalletConnectorType = engineCore.getRegisteredInstanceType("walletConnector");
-    const walletConnector = WalletConnectorFactory.get(defaultWalletConnectorType);
-    const addresses = await walletConnector.getAddresses(identity, 0, 0, 5);
-    const balance = await walletConnector.getBalance(identity, addresses[0]);
-    if (balance === 0n) {
-        let address0 = addresses[0];
-        if (defaultWalletConnectorType.startsWith(WalletConnectorType.Iota) &&
-            Is.stringValue(envVars.iotaExplorerEndpoint)) {
-            address0 = `${StringHelper.trimTrailingSlashes(envVars.iotaExplorerEndpoint)}/address/${address0}?network=${envVars.iotaNetwork}`;
-        }
-        engineCore.logInfo(I18n.formatMessage("node.fundingWallet", { address: address0 }));
-        // Add some funds to the wallet from the faucet
-        await walletConnector.ensureBalance(identity, addresses[0], 1000000000n);
-    }
-    else {
-        engineCore.logInfo(I18n.formatMessage("node.fundedWallet"));
-    }
-    return addresses;
-}
-/**
- * Bootstrap the identity for the node.
- * @param engineCore The engine core for the node.
- * @param envVars The environment variables for the node.
- * @param controller The controller for the identity.
- * @param identity The existing identity if there is one.
- * @param identityType The type of identity.
- * @returns The addresses for the wallet.
- */
-async function generateIdentity(engineCore, envVars, controller, identity, identityType) {
-    const defaultIdentityConnectorType = engineCore.getRegisteredInstanceType("identityConnector");
-    // Now create an identity for the node controlled by the address we just funded
-    const identityConnector = IdentityConnectorFactory.get(defaultIdentityConnectorType);
-    let identityDocument;
-    try {
-        const defaultIdentityResolverConnectorType = engineCore.getRegisteredInstanceType("identityResolverConnector");
-        const identityResolverConnector = IdentityResolverConnectorFactory.get(defaultIdentityResolverConnectorType);
-        identityDocument = await identityResolverConnector.resolveDocument(identity);
-        engineCore.logInfo(I18n.formatMessage("node.existingIdentity", { identity }));
-    }
-    catch { }
-    if (Is.empty(identityDocument)) {
-        engineCore.logInfo(I18n.formatMessage("node.generatingIdentity", { identityType }));
-        identityDocument = await identityConnector.createDocument(controller);
-        engineCore.logInfo(I18n.formatMessage("node.createdIdentity", { identity: identityDocument.id }));
-    }
-    if (defaultIdentityConnectorType.startsWith(IdentityConnectorType.Iota)) {
-        const didUrn = Urn.fromValidString(identityDocument.id);
-        const didParts = didUrn.parts();
-        const objectId = didParts[3];
-        if (Is.stringValue(envVars.iotaExplorerEndpoint)) {
-            engineCore.logInfo(I18n.formatMessage("node.identityExplorer", {
-                url: `${StringHelper.trimTrailingSlashes(envVars.iotaExplorerEndpoint)}/object/${objectId}?network=${envVars.iotaNetwork}`
-            }));
-        }
-    }
-    return identityDocument.id;
-}
-//# sourceMappingURL=identity.js.map

package/dist/es/identity.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"identity.js","sourceRoot":"","sources":["../../src/identity.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACtF,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AACpF,OAAO,EACN,6BAA6B,EAE7B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACN,wBAAwB,EACxB,gCAAgC,EAChC,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAwB,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAErF,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAGjE;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CACnC,UAAuB,EACvB,OAAkC,EAClC,cAAkC,EAClC,cAAkC,EAClC,UAA8B,EAC9B,YAA8C,EAC9C,SAAkB;IAElB,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,yBAAyB,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC;IAEpF,yEAAyE;IACzE,sFAAsF;IACtF,kEAAkE;IAClE,MAAM,yBAAyB,GAAG,UAAU,CAAC,yBAAyB,CAAC,gBAAgB,CAAC,CAAC;IACzF,MAAM,cAAc,GAAG,qBAAqB,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;IAE5E,MAAM,eAAe,GACpB,cAAc,IAAI,kBAAkB,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;IACvF,MAAM,iBAAiB,GAAG,UAAU,IAAI,eAAe,CAAC;IAExD,MAAM,cAAc,GAAG,MAAM,iBAAiB,CAC7C,UAAU,EACV,cAAc,EACd,eAAe,EACf,cAAc,CACd,CAAC;IAEF,MAAM,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC,MAAM,cAAc,CAAC,UAAU,EAAE,OAAO,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAE9F,MAAM,aAAa,GAAG,MAAM,gBAAgB,CAC3C,UAAU,EACV,OAAO,EACP,iBAAiB,EACjB,eAAe,EACf,YAAY,CACZ,CAAC;IAEF,IAAI,cAAc,EAAE,CAAC;QACpB,UAAU,CAAC,OAAO,CACjB,IAAI,CAAC,aAAa,CAAC,oBAAoB,EAAE,EAAE,QAAQ,EAAE,GAAG,aAAa,WAAW,EAAE,CAAC,CACnF,CAAC;IACH,CAAC;IAED,MAAM,cAAc,CAAC,UAAU,EAAE,OAAO,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;IAEpE,MAAM,gBAAgB,CAAC,cAAc,EAAE,eAAe,EAAE,aAAa,CAAC,CAAC;IAEvE,OAAO,aAAa,CAAC;AACtB,CAAC;AAED;;;;;;;GAOG;AACH,KAAK,UAAU,iBAAiB,CAC/B,UAAuB,EACvB,cAA+B,EAC/B,QAAgB,EAChB,gBAAyB;IAEzB,IAAI,QAAQ,GAAG,gBAAgB,CAAC;IAChC,IAAI,aAAa,GAAG,KAAK,CAAC;IAE1B,MAAM,WAAW,GAAG,GAAG,QAAQ,WAAW,CAAC;IAE3C,IAAI,CAAC;QACJ,MAAM,cAAc,GAAG,MAAM,cAAc,CAAC,SAAS,CAAS,WAAW,CAAC,CAAC;QAC3E,IAAI,EAAE,CAAC,WAAW,CAAC,cAAc,CAAC,EAAE,CAAC;YACpC,aAAa,GAAG,cAAc,KAAK,QAAQ,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACnE,QAAQ,GAAG,cAAc,CAAC;QAC3B,CAAC;aAAM,CAAC;YACP,aAAa,GAAG,IAAI,CAAC;QACtB,CAAC;IACF,CAAC;IAAC,MAAM,CAAC;QACR,aAAa,GAAG,IAAI,CAAC;IACtB,CAAC;IAED,uDAAuD;IACvD,IAAI,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxB,QAAQ,GAAG,KAAK,CAAC,cAAc,EAAE,CAAC;QAClC,aAAa,GAAG,IAAI,CAAC;IACtB,CAAC;IAED,uEAAuE;IACvE,IAAI,aAAa,EAAE,CAAC;QACnB,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC,CAAC;QAC/D,MAAM,cAAc,CAAC,SAAS,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IACvD,CAAC;SAAM,CAAC;QACP,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC,CAAC;IACjE,CAAC;IAED,OAAO,aAAa,CAAC;AACtB,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,gBAAgB,CAC9B,cAA+B,EAC/B,eAAuB,EACvB,aAAqB;IAErB,+DAA+D;IAC/D,+CAA+C;IAC/C,IAAI,eAAe,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,eAAe,KAAK,aAAa,EAAE,CAAC;QACxF,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,SAAS,CAAC,GAAG,eAAe,WAAW,CAAC,CAAC;QAC/E,MAAM,cAAc,CAAC,SAAS,CAAC,GAAG,aAAa,WAAW,EAAE,QAAQ,CAAC,CAAC;QACtE,MAAM,cAAc,CAAC,YAAY,CAAC,GAAG,eAAe,WAAW,CAAC,CAAC;IAClE,CAAC;AACF,CAAC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,cAAc,CAC5B,UAAuB,EACvB,OAAkC,EAClC,aAAqB,EACrB,SAAmB;IAEnB,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAC9B,MAAM,0BAA0B,GAAG,UAAU,CAAC,yBAAyB,CAAC,iBAAiB,CAAC,CAAC;QAE3F,6EAA6E;QAC7E,mCAAmC;QACnC,IAAI,0BAA0B,CAAC,UAAU,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE,CAAC;YAC9E,MAAM,aAAa,GAClB,6BAA6B,CAAC,GAAG,kBAEhC,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,aAAa,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;YACnD,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrB,IAAI,CAAC,QAAQ,GAAG,aAAa,CAAC;gBAC9B,MAAM,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC;QACF,CAAC;IACF,CAAC;AACF,CAAC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,cAAc,CAC5B,UAAuB,EACvB,OAAkC,EAClC,QAAgB;IAEhB,MAAM,0BAA0B,GAAG,UAAU,CAAC,yBAAyB,CAAC,iBAAiB,CAAC,CAAC;IAE3F,MAAM,eAAe,GAAG,sBAAsB,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;IAC/E,MAAM,SAAS,GAAG,MAAM,eAAe,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAExE,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IACzE,IAAI,OAAO,KAAK,EAAE,EAAE,CAAC;QACpB,IAAI,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;QAE5B,IACC,0BAA0B,CAAC,UAAU,CAAC,mBAAmB,CAAC,IAAI,CAAC;YAC/D,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAC3C,CAAC;YACF,QAAQ,GAAG,GAAG,YAAY,CAAC,mBAAmB,CAAC,OAAO,CAAC,oBAAoB,CAAC,YAAY,QAAQ,YAAY,OAAO,CAAC,WAAW,EAAE,CAAC;QACnI,CAAC;QAED,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,oBAAoB,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;QAEpF,+CAA+C;QAC/C,MAAM,eAAe,CAAC,aAAa,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;IAC1E,CAAC;SAAM,CAAC;QACP,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAC7D,CAAC;IACD,OAAO,SAAS,CAAC;AAClB,CAAC;AAED;;;;;;;;GAQG;AACH,KAAK,UAAU,gBAAgB,CAC9B,UAAuB,EACvB,OAAkC,EAClC,UAAkB,EAClB,QAAgB,EAChB,YAA8C;IAE9C,MAAM,4BAA4B,GAAG,UAAU,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,CAAC;IAE/F,+EAA+E;IAC/E,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;IAErF,IAAI,gBAAgB,CAAC;IAErB,IAAI,CAAC;QACJ,MAAM,oCAAoC,GAAG,UAAU,CAAC,yBAAyB,CAChF,2BAA2B,CAC3B,CAAC;QAEF,MAAM,yBAAyB,GAAG,gCAAgC,CAAC,GAAG,CACrE,oCAAoC,CACpC,CAAC;QACF,gBAAgB,GAAG,MAAM,yBAAyB,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QAC7E,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,uBAAuB,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;IAC/E,CAAC;IAAC,MAAM,CAAC,CAAA,CAAC;IAEV,IAAI,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,CAAC;QAChC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,yBAAyB,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC;QAEpF,gBAAgB,GAAG,MAAM,iBAAiB,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QAEtE,UAAU,CAAC,OAAO,CACjB,IAAI,CAAC,aAAa,CAAC,sBAAsB,EAAE,EAAE,QAAQ,EAAE,gBAAgB,CAAC,EAAE,EAAE,CAAC,CAC7E,CAAC;IACH,CAAC;IAED,IAAI,4BAA4B,CAAC,UAAU,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,CAAC;QACzE,MAAM,MAAM,GAAG,GAAG,CAAC,eAAe,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QACxD,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;QAE7B,IAAI,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAAE,CAAC;YAClD,UAAU,CAAC,OAAO,CACjB,IAAI,CAAC,aAAa,CAAC,uBAAuB,EAAE;gBAC3C,GAAG,EAAE,GAAG,YAAY,CAAC,mBAAmB,CAAC,OAAO,CAAC,oBAAoB,CAAC,WAAW,QAAQ,YAAY,OAAO,CAAC,WAAW,EAAE;aAC1H,CAAC,CACF,CAAC;QACH,CAAC;IACF,CAAC;IACD,OAAO,gBAAgB,CAAC,EAAE,CAAC;AAC5B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Converter, I18n, Is, RandomHelper, StringHelper, Urn } from \"@twin.org/core\";\nimport { Bip39 } from \"@twin.org/crypto\";\nimport type { IEngineCore } from \"@twin.org/engine-models\";\nimport { IdentityConnectorType, WalletConnectorType } from \"@twin.org/engine-types\";\nimport {\n\tEntityStorageConnectorFactory,\n\ttype IEntityStorageConnector\n} from \"@twin.org/entity-storage-models\";\nimport {\n\tIdentityConnectorFactory,\n\tIdentityResolverConnectorFactory\n} from \"@twin.org/identity-models\";\nimport { nameofKebabCase } from \"@twin.org/nameof\";\nimport { type IVaultConnector, VaultConnectorFactory } from \"@twin.org/vault-models\";\nimport type { WalletAddress } from \"@twin.org/wallet-connector-entity-storage\";\nimport { WalletConnectorFactory } from \"@twin.org/wallet-models\";\nimport type { INodeEnvironmentVariables } from \"./models/INodeEnvironmentVariables.js\";\n\n/**\n * Generate an identity and fund it.\n * @param engineCore The engine core for the node.\n * @param envVars The environment variables for the node.\n * @param configIdentity A identity from config to use.\n * @param configMnemonic A mnemonic from config to use.\n * @param controller The controller for the identity.\n * @param identityType The type of identity.\n * @param addWallet Whether to add a wallet for the identity.\n * @returns The identity that was generated.\n */\nexport async function createIdentity(\n\tengineCore: IEngineCore,\n\tenvVars: INodeEnvironmentVariables,\n\tconfigIdentity: string | undefined,\n\tconfigMnemonic: string | undefined,\n\tcontroller: string | undefined,\n\tidentityType: \"node\" | \"organization\" | \"user\",\n\taddWallet: boolean\n): Promise<string> {\n\tengineCore.logInfo(I18n.formatMessage(\"node.processingIdentity\", { identityType }));\n\n\t// We have a chicken and egg problem in that we can't create the identity\n\t// to store the mnemonic in the vault without an identity. We use a temporary identity\n\t// and then replace it with the new identity later in the process.\n\tconst defaultVaultConnectorType = engineCore.getRegisteredInstanceType(\"vaultConnector\");\n\tconst vaultConnector = VaultConnectorFactory.get(defaultVaultConnectorType);\n\n\tconst workingIdentity =\n\t\tconfigIdentity ?? `bootstrap-temp-${Converter.bytesToHex(RandomHelper.generate(16))}`;\n\tconst workingController = controller ?? workingIdentity;\n\n\tconst mnemonicStored = await bootstrapMnemonic(\n\t\tengineCore,\n\t\tvaultConnector,\n\t\tworkingIdentity,\n\t\tconfigMnemonic\n\t);\n\n\tconst addresses = addWallet ? await generateWallet(engineCore, envVars, workingIdentity) : [];\n\n\tconst finalIdentity = await generateIdentity(\n\t\tengineCore,\n\t\tenvVars,\n\t\tworkingController,\n\t\tworkingIdentity,\n\t\tidentityType\n\t);\n\n\tif (mnemonicStored) {\n\t\tengineCore.logInfo(\n\t\t\tI18n.formatMessage(\"node.finalMnemonic\", { vaultKey: `${finalIdentity}/mnemonic` })\n\t\t);\n\t}\n\n\tawait finaliseWallet(engineCore, envVars, finalIdentity, addresses);\n\n\tawait finaliseMnemonic(vaultConnector, workingIdentity, finalIdentity);\n\n\treturn finalIdentity;\n}\n\n/**\n * Generate a mnemonic for the node identity.\n * @param engineCore The engine core for the node.\n * @param vaultConnector The vault connector to use.\n * @param identity The identity of the node.\n * @param existingMnemonic An existing mnemonic to use.\n * @returns Whether the mnemonic was stored.\n */\nasync function bootstrapMnemonic(\n\tengineCore: IEngineCore,\n\tvaultConnector: IVaultConnector,\n\tidentity: string,\n\texistingMnemonic?: string\n): Promise<boolean> {\n\tlet mnemonic = existingMnemonic;\n\tlet storeMnemonic = false;\n\n\tconst mnemonicKey = `${identity}/mnemonic`;\n\n\ttry {\n\t\tconst storedMnemonic = await vaultConnector.getSecret<string>(mnemonicKey);\n\t\tif (Is.stringValue(storedMnemonic)) {\n\t\t\tstoreMnemonic = storedMnemonic !== mnemonic && !Is.empty(mnemonic);\n\t\t\tmnemonic = storedMnemonic;\n\t\t} else {\n\t\t\tstoreMnemonic = true;\n\t\t}\n\t} catch {\n\t\tstoreMnemonic = true;\n\t}\n\n\t// If there is no mnemonic then we need to generate one\n\tif (Is.empty(mnemonic)) {\n\t\tmnemonic = Bip39.randomMnemonic();\n\t\tstoreMnemonic = true;\n\t}\n\n\t// If there is no mnemonic stored in the vault then we need to store it\n\tif (storeMnemonic) {\n\t\tengineCore.logInfo(I18n.formatMessage(\"node.storingMnemonic\"));\n\t\tawait vaultConnector.setSecret(mnemonicKey, mnemonic);\n\t} else {\n\t\tengineCore.logInfo(I18n.formatMessage(\"node.existingMnemonic\"));\n\t}\n\n\treturn storeMnemonic;\n}\n\n/**\n * Finalise the mnemonic for the node identity.\n * @param vaultConnector The vault connector to use.\n * @param workingIdentity The identity of the node.\n * @param finalIdentity The final identity for the node.\n */\nasync function finaliseMnemonic(\n\tvaultConnector: IVaultConnector,\n\tworkingIdentity: string,\n\tfinalIdentity: string\n): Promise<void> {\n\t// Now that we have an identity we can remove the temporary one\n\t// and store the mnemonic with the new identity\n\tif (workingIdentity.startsWith(\"bootstrap-temp-\") && workingIdentity !== finalIdentity) {\n\t\tconst mnemonic = await vaultConnector.getSecret(`${workingIdentity}/mnemonic`);\n\t\tawait vaultConnector.setSecret(`${finalIdentity}/mnemonic`, mnemonic);\n\t\tawait vaultConnector.removeSecret(`${workingIdentity}/mnemonic`);\n\t}\n}\n\n/**\n * Bootstrap the identity for the node.\n * @param engineCore The engine core for the node.\n * @param envVars The environment variables for the node.\n * @param finalIdentity The identity of the node.\n * @param addresses The addresses for the wallet.\n */\nasync function finaliseWallet(\n\tengineCore: IEngineCore,\n\tenvVars: INodeEnvironmentVariables,\n\tfinalIdentity: string,\n\taddresses: string[]\n): Promise<void> {\n\tif (Is.arrayValue(addresses)) {\n\t\tconst defaultWalletConnectorType = engineCore.getRegisteredInstanceType(\"walletConnector\");\n\n\t\t// If we are using entity storage for wallet the identity associated with the\n\t\t// address will be wrong, so fix it\n\t\tif (defaultWalletConnectorType.startsWith(WalletConnectorType.EntityStorage)) {\n\t\t\tconst walletAddress =\n\t\t\t\tEntityStorageConnectorFactory.get<IEntityStorageConnector<WalletAddress>>(\n\t\t\t\t\tnameofKebabCase<WalletAddress>()\n\t\t\t\t);\n\t\t\tconst addr = await walletAddress.get(addresses[0]);\n\t\t\tif (!Is.empty(addr)) {\n\t\t\t\taddr.identity = finalIdentity;\n\t\t\t\tawait walletAddress.set(addr);\n\t\t\t}\n\t\t}\n\t}\n}\n\n/**\n * Bootstrap the wallet for the node.\n * @param engineCore The engine core for the node.\n * @param envVars The environment variables for the node.\n * @param identity The identity to create the wallet for.\n * @returns The addresses for the wallet.\n */\nasync function generateWallet(\n\tengineCore: IEngineCore,\n\tenvVars: INodeEnvironmentVariables,\n\tidentity: string\n): Promise<string[]> {\n\tconst defaultWalletConnectorType = engineCore.getRegisteredInstanceType(\"walletConnector\");\n\n\tconst walletConnector = WalletConnectorFactory.get(defaultWalletConnectorType);\n\tconst addresses = await walletConnector.getAddresses(identity, 0, 0, 5);\n\n\tconst balance = await walletConnector.getBalance(identity, addresses[0]);\n\tif (balance === 0n) {\n\t\tlet address0 = addresses[0];\n\n\t\tif (\n\t\t\tdefaultWalletConnectorType.startsWith(WalletConnectorType.Iota) &&\n\t\t\tIs.stringValue(envVars.iotaExplorerEndpoint)\n\t\t) {\n\t\t\taddress0 = `${StringHelper.trimTrailingSlashes(envVars.iotaExplorerEndpoint)}/address/${address0}?network=${envVars.iotaNetwork}`;\n\t\t}\n\n\t\tengineCore.logInfo(I18n.formatMessage(\"node.fundingWallet\", { address: address0 }));\n\n\t\t// Add some funds to the wallet from the faucet\n\t\tawait walletConnector.ensureBalance(identity, addresses[0], 1000000000n);\n\t} else {\n\t\tengineCore.logInfo(I18n.formatMessage(\"node.fundedWallet\"));\n\t}\n\treturn addresses;\n}\n\n/**\n * Bootstrap the identity for the node.\n * @param engineCore The engine core for the node.\n * @param envVars The environment variables for the node.\n * @param controller The controller for the identity.\n * @param identity The existing identity if there is one.\n * @param identityType The type of identity.\n * @returns The addresses for the wallet.\n */\nasync function generateIdentity(\n\tengineCore: IEngineCore,\n\tenvVars: INodeEnvironmentVariables,\n\tcontroller: string,\n\tidentity: string,\n\tidentityType: \"node\" | \"organization\" | \"user\"\n): Promise<string> {\n\tconst defaultIdentityConnectorType = engineCore.getRegisteredInstanceType(\"identityConnector\");\n\n\t// Now create an identity for the node controlled by the address we just funded\n\tconst identityConnector = IdentityConnectorFactory.get(defaultIdentityConnectorType);\n\n\tlet identityDocument;\n\n\ttry {\n\t\tconst defaultIdentityResolverConnectorType = engineCore.getRegisteredInstanceType(\n\t\t\t\"identityResolverConnector\"\n\t\t);\n\n\t\tconst identityResolverConnector = IdentityResolverConnectorFactory.get(\n\t\t\tdefaultIdentityResolverConnectorType\n\t\t);\n\t\tidentityDocument = await identityResolverConnector.resolveDocument(identity);\n\t\tengineCore.logInfo(I18n.formatMessage(\"node.existingIdentity\", { identity }));\n\t} catch {}\n\n\tif (Is.empty(identityDocument)) {\n\t\tengineCore.logInfo(I18n.formatMessage(\"node.generatingIdentity\", { identityType }));\n\n\t\tidentityDocument = await identityConnector.createDocument(controller);\n\n\t\tengineCore.logInfo(\n\t\t\tI18n.formatMessage(\"node.createdIdentity\", { identity: identityDocument.id })\n\t\t);\n\t}\n\n\tif (defaultIdentityConnectorType.startsWith(IdentityConnectorType.Iota)) {\n\t\tconst didUrn = Urn.fromValidString(identityDocument.id);\n\t\tconst didParts = didUrn.parts();\n\t\tconst objectId = didParts[3];\n\n\t\tif (Is.stringValue(envVars.iotaExplorerEndpoint)) {\n\t\t\tengineCore.logInfo(\n\t\t\t\tI18n.formatMessage(\"node.identityExplorer\", {\n\t\t\t\t\turl: `${StringHelper.trimTrailingSlashes(envVars.iotaExplorerEndpoint)}/object/${objectId}?network=${envVars.iotaNetwork}`\n\t\t\t\t})\n\t\t\t);\n\t\t}\n\t}\n\treturn identityDocument.id;\n}\n"]}

package/dist/es/models/nodeExtensionMethods.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=nodeExtensionMethods.js.map

package/dist/es/models/nodeExtensionMethods.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"nodeExtensionMethods.js","sourceRoot":"","sources":["../../../src/models/nodeExtensionMethods.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IEngineCore, IEngineServer } from \"@twin.org/engine-models\";\nimport type { INodeEngineConfig } from \"./INodeEngineConfig.js\";\nimport type { INodeEnvironmentVariables } from \"./INodeEnvironmentVariables.js\";\n\n/**\n * The type for the initialise method of an extension module.\n * @param envVars The environment variables for the node.\n * @param nodeEngineConfig The node engine config.\n */\nexport type NodeExtensionInitialiseMethod = (\n\tenvVars: INodeEnvironmentVariables,\n\tnodeEngineConfig: INodeEngineConfig\n) => Promise<void>;\n\n/**\n * The type for the initialise engine method of an extension module.\n * This is called when the engine has been constructed but not yet started.\n * @param engineCore The engine core instance.\n */\nexport type NodeExtensionInitialiseEngineMethod = (engineCore: IEngineCore) => Promise<void>;\n\n/**\n * The type for the initialise engine server method of an extension module.\n * This is called when the engine server has been constructed but not yet started.\n * @param engineCore The engine core instance.\n * @param engineServer The engine server instance.\n */\nexport type NodeExtensionInitialiseEngineServerMethod = (\n\tengineCore: IEngineCore,\n\tengineServer: IEngineServer\n) => Promise<void>;\n\n/**\n * The type for the shutdown method of an extension module.\n * This is called when the engine is shutting down.\n */\nexport type NodeExtensionShutdownMethod = () => Promise<void>;\n"]}

package/dist/es/models/nodeFeatures.js

@@ -1,21 +0,0 @@
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The features that can be enabled on the node.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-export const NodeFeatures = {
-    /**
-     * NodeId - generates an identity for the node if not provided in config.
-     */
-    NodeId: "node-identity",
-    /**
-     * NodeAdminUser - generates an admin user for the node if not provided in config.
-     */
-    NodeAdminUser: "node-admin-user",
-    /**
-     * NodeWallet - generates wallets for any identities that need them.
-     */
-    NodeWallet: "node-wallet"
-};
-//# sourceMappingURL=nodeFeatures.js.map

package/dist/es/models/nodeFeatures.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"nodeFeatures.js","sourceRoot":"","sources":["../../../src/models/nodeFeatures.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,YAAY,GAAG;IAC3B;;OAEG;IACH,MAAM,EAAE,eAAe;IAEvB;;OAEG;IACH,aAAa,EAAE,iBAAiB;IAEhC;;OAEG;IACH,UAAU,EAAE,aAAa;CAChB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The features that can be enabled on the node.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const NodeFeatures = {\n\t/**\n\t * NodeId - generates an identity for the node if not provided in config.\n\t */\n\tNodeId: \"node-identity\",\n\n\t/**\n\t * NodeAdminUser - generates an admin user for the node if not provided in config.\n\t */\n\tNodeAdminUser: \"node-admin-user\",\n\n\t/**\n\t * NodeWallet - generates wallets for any identities that need them.\n\t */\n\tNodeWallet: \"node-wallet\"\n} as const;\n\n/**\n * The features that can be enabled on the node.\n */\nexport type NodeFeatures = (typeof NodeFeatures)[keyof typeof NodeFeatures];\n"]}

package/dist/es/server.js

@@ -1,81 +0,0 @@
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-import { GeneralError, I18n, Is } from "@twin.org/core";
-import { Engine } from "@twin.org/engine";
-import { FileStateStorage } from "@twin.org/engine-core";
-import { EngineCoreFactory } from "@twin.org/engine-models";
-import { EngineServer } from "@twin.org/engine-server";
-import { BlobStorageConnectorType, EntityStorageConnectorType } from "@twin.org/engine-types";
-import { bootstrap } from "./bootstrap.js";
-import { extensionsInitialiseEngine, extensionsInitialiseEngineServer, shutdownExtensions } from "./builders/extensionsBuilder.js";
-let isStarted = false;
-/**
- * Start the engine server.
- * @param nodeOptions Optional run options for the engine server.
- * @param nodeEngineConfig The configuration for the engine server.
- * @param envVars The environment variables.
- * @param availableContextIdKeys The context ID keys available for operation.
- * @returns The engine server.
- */
-export async function start(nodeOptions, nodeEngineConfig, envVars, availableContextIdKeys) {
-    const entityStorageConnectorType = envVars.entityStorageConnectorType?.split(",") ?? [];
-    const blobStorageConnectorType = envVars.blobStorageConnectorType?.split(",") ?? [];
-    // If the blob storage or entity storage is configured with file connectors
-    // then we need to make sure the storageFileRoot is set
-    if ((entityStorageConnectorType.includes(EntityStorageConnectorType.File) ||
-        blobStorageConnectorType.includes(BlobStorageConnectorType.File) ||
-        Is.empty(nodeOptions?.stateStorage)) &&
-        !Is.stringValue(envVars.storageFileRoot)) {
-        throw new GeneralError("node", "storageFileRootNotSet", {
-            storageFileRoot: `${nodeOptions?.envPrefix ?? ""}STORAGE_FILE_ROOT`
-        });
-    }
-    // Create the engine instance using file state storage unless one is configured in options
-    const engine = new Engine({
-        config: nodeEngineConfig,
-        stateStorage: nodeOptions?.stateStorage ?? new FileStateStorage(envVars.stateFilename ?? ""),
-        customBootstrap: async (core, engineContext) => bootstrap(core, engineContext, envVars)
-    });
-    if (Is.arrayValue(availableContextIdKeys)) {
-        const added = [];
-        for (const availableContextIdKey of availableContextIdKeys) {
-            if (!added.includes(availableContextIdKey.key)) {
-                engine.addContextIdKey(availableContextIdKey.key, availableContextIdKey.componentFeatures);
-                added.push(availableContextIdKey.key);
-            }
-        }
-    }
-    // Construct the server with the engine.
-    const server = new EngineServer({ engineCore: engine });
-    // Extend the engine.
-    if (Is.function(nodeOptions?.extendEngine)) {
-        await engine.logInfo(I18n.formatMessage("node.extendingEngine"));
-        await nodeOptions.extendEngine(engine);
-    }
-    await extensionsInitialiseEngine(envVars, engine);
-    // Extend the engine server.
-    if (Is.function(nodeOptions?.extendEngineServer)) {
-        await engine.logInfo(I18n.formatMessage("node.extendingEngineServer"));
-        await nodeOptions?.extendEngineServer(server);
-    }
-    await extensionsInitialiseEngineServer(envVars, engine, server);
-    // Need to register the engine with the factory so that background tasks
-    // can clone it to spawn new instances.
-    EngineCoreFactory.register("engine", () => engine);
-    // Start the server, which also starts the engine.
-    isStarted = await server.start();
-    if (isStarted) {
-        return {
-            engine,
-            server,
-            shutdown: async () => {
-                if (isStarted) {
-                    isStarted = false;
-                    await shutdownExtensions(envVars, engine);
-                    await server.stop();
-                }
-            }
-        };
-    }
-}
-//# sourceMappingURL=server.js.map

package/dist/es/server.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"server.js","sourceRoot":"","sources":["../../src/server.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD,OAAO,EAAE,wBAAwB,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AAC9F,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EACN,0BAA0B,EAC1B,gCAAgC,EAChC,kBAAkB,EAClB,MAAM,iCAAiC,CAAC;AAMzC,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CAC1B,WAAqC,EACrC,gBAAmC,EACnC,OAAkC,EAClC,sBAAuE;IASvE,MAAM,0BAA0B,GAAG,OAAO,CAAC,0BAA0B,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;IACxF,MAAM,wBAAwB,GAAG,OAAO,CAAC,wBAAwB,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;IAEpF,2EAA2E;IAC3E,uDAAuD;IACvD,IACC,CAAC,0BAA0B,CAAC,QAAQ,CAAC,0BAA0B,CAAC,IAAI,CAAC;QACpE,wBAAwB,CAAC,QAAQ,CAAC,wBAAwB,CAAC,IAAI,CAAC;QAChE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;QACrC,CAAC,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,eAAe,CAAC,EACvC,CAAC;QACF,MAAM,IAAI,YAAY,CAAC,MAAM,EAAE,uBAAuB,EAAE;YACvD,eAAe,EAAE,GAAG,WAAW,EAAE,SAAS,IAAI,EAAE,mBAAmB;SACnE,CAAC,CAAC;IACJ,CAAC;IAED,0FAA0F;IAC1F,MAAM,MAAM,GAAG,IAAI,MAAM,CAAwC;QAChE,MAAM,EAAE,gBAAgB;QACxB,YAAY,EAAE,WAAW,EAAE,YAAY,IAAI,IAAI,gBAAgB,CAAC,OAAO,CAAC,aAAa,IAAI,EAAE,CAAC;QAC5F,eAAe,EAAE,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,CAAC;KACvF,CAAC,CAAC;IAEH,IAAI,EAAE,CAAC,UAAU,CAAC,sBAAsB,CAAC,EAAE,CAAC;QAC3C,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,KAAK,MAAM,qBAAqB,IAAI,sBAAsB,EAAE,CAAC;YAC5D,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC;gBAChD,MAAM,CAAC,eAAe,CAAC,qBAAqB,CAAC,GAAG,EAAE,qBAAqB,CAAC,iBAAiB,CAAC,CAAC;gBAC3F,KAAK,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC;YACvC,CAAC;QACF,CAAC;IACF,CAAC;IAED,wCAAwC;IACxC,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAC;IAExD,qBAAqB;IACrB,IAAI,EAAE,CAAC,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC,EAAE,CAAC;QAC5C,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC,CAAC;QACjE,MAAM,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAED,MAAM,0BAA0B,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAElD,4BAA4B;IAC5B,IAAI,EAAE,CAAC,QAAQ,CAAC,WAAW,EAAE,kBAAkB,CAAC,EAAE,CAAC;QAClD,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,4BAA4B,CAAC,CAAC,CAAC;QACvE,MAAM,WAAW,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,gCAAgC,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAEhE,wEAAwE;IACxE,uCAAuC;IACvC,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC;IAEnD,kDAAkD;IAClD,SAAS,GAAG,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;IAEjC,IAAI,SAAS,EAAE,CAAC;QACf,OAAO;YACN,MAAM;YACN,MAAM;YACN,QAAQ,EAAE,KAAK,IAAI,EAAE;gBACpB,IAAI,SAAS,EAAE,CAAC;oBACf,SAAS,GAAG,KAAK,CAAC;oBAClB,MAAM,kBAAkB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;oBAC1C,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;gBACrB,CAAC;YACF,CAAC;SACD,CAAC;IACH,CAAC;AACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { GeneralError, I18n, Is } from \"@twin.org/core\";\nimport { Engine } from \"@twin.org/engine\";\nimport { FileStateStorage } from \"@twin.org/engine-core\";\nimport { EngineCoreFactory } from \"@twin.org/engine-models\";\nimport { EngineServer } from \"@twin.org/engine-server\";\nimport type { IEngineServerConfig } from \"@twin.org/engine-server-types\";\nimport { BlobStorageConnectorType, EntityStorageConnectorType } from \"@twin.org/engine-types\";\nimport { bootstrap } from \"./bootstrap.js\";\nimport {\n\textensionsInitialiseEngine,\n\textensionsInitialiseEngineServer,\n\tshutdownExtensions\n} from \"./builders/extensionsBuilder.js\";\nimport type { INodeEngineConfig } from \"./models/INodeEngineConfig.js\";\nimport type { INodeEngineState } from \"./models/INodeEngineState.js\";\nimport type { INodeEnvironmentVariables } from \"./models/INodeEnvironmentVariables.js\";\nimport type { INodeOptions } from \"./models/INodeOptions.js\";\n\nlet isStarted = false;\n\n/**\n * Start the engine server.\n * @param nodeOptions Optional run options for the engine server.\n * @param nodeEngineConfig The configuration for the engine server.\n * @param envVars The environment variables.\n * @param availableContextIdKeys The context ID keys available for operation.\n * @returns The engine server.\n */\nexport async function start(\n\tnodeOptions: INodeOptions | undefined,\n\tnodeEngineConfig: INodeEngineConfig,\n\tenvVars: INodeEnvironmentVariables,\n\tavailableContextIdKeys?: { key: string; componentFeatures: string[] }[]\n): Promise<\n\t| {\n\t\t\tengine: Engine<IEngineServerConfig, INodeEngineState>;\n\t\t\tserver: EngineServer;\n\t\t\tshutdown: () => Promise<void>;\n\t  }\n\t| undefined\n> {\n\tconst entityStorageConnectorType = envVars.entityStorageConnectorType?.split(\",\") ?? [];\n\tconst blobStorageConnectorType = envVars.blobStorageConnectorType?.split(\",\") ?? [];\n\n\t// If the blob storage or entity storage is configured with file connectors\n\t// then we need to make sure the storageFileRoot is set\n\tif (\n\t\t(entityStorageConnectorType.includes(EntityStorageConnectorType.File) ||\n\t\t\tblobStorageConnectorType.includes(BlobStorageConnectorType.File) ||\n\t\t\tIs.empty(nodeOptions?.stateStorage)) &&\n\t\t!Is.stringValue(envVars.storageFileRoot)\n\t) {\n\t\tthrow new GeneralError(\"node\", \"storageFileRootNotSet\", {\n\t\t\tstorageFileRoot: `${nodeOptions?.envPrefix ?? \"\"}STORAGE_FILE_ROOT`\n\t\t});\n\t}\n\n\t// Create the engine instance using file state storage unless one is configured in options\n\tconst engine = new Engine<IEngineServerConfig, INodeEngineState>({\n\t\tconfig: nodeEngineConfig,\n\t\tstateStorage: nodeOptions?.stateStorage ?? new FileStateStorage(envVars.stateFilename ?? \"\"),\n\t\tcustomBootstrap: async (core, engineContext) => bootstrap(core, engineContext, envVars)\n\t});\n\n\tif (Is.arrayValue(availableContextIdKeys)) {\n\t\tconst added: string[] = [];\n\t\tfor (const availableContextIdKey of availableContextIdKeys) {\n\t\t\tif (!added.includes(availableContextIdKey.key)) {\n\t\t\t\tengine.addContextIdKey(availableContextIdKey.key, availableContextIdKey.componentFeatures);\n\t\t\t\tadded.push(availableContextIdKey.key);\n\t\t\t}\n\t\t}\n\t}\n\n\t// Construct the server with the engine.\n\tconst server = new EngineServer({ engineCore: engine });\n\n\t// Extend the engine.\n\tif (Is.function(nodeOptions?.extendEngine)) {\n\t\tawait engine.logInfo(I18n.formatMessage(\"node.extendingEngine\"));\n\t\tawait nodeOptions.extendEngine(engine);\n\t}\n\n\tawait extensionsInitialiseEngine(envVars, engine);\n\n\t// Extend the engine server.\n\tif (Is.function(nodeOptions?.extendEngineServer)) {\n\t\tawait engine.logInfo(I18n.formatMessage(\"node.extendingEngineServer\"));\n\t\tawait nodeOptions?.extendEngineServer(server);\n\t}\n\n\tawait extensionsInitialiseEngineServer(envVars, engine, server);\n\n\t// Need to register the engine with the factory so that background tasks\n\t// can clone it to spawn new instances.\n\tEngineCoreFactory.register(\"engine\", () => engine);\n\n\t// Start the server, which also starts the engine.\n\tisStarted = await server.start();\n\n\tif (isStarted) {\n\t\treturn {\n\t\t\tengine,\n\t\t\tserver,\n\t\t\tshutdown: async () => {\n\t\t\t\tif (isStarted) {\n\t\t\t\t\tisStarted = false;\n\t\t\t\t\tawait shutdownExtensions(envVars, engine);\n\t\t\t\t\tawait server.stop();\n\t\t\t\t}\n\t\t\t}\n\t\t};\n\t}\n}\n"]}

package/dist/types/bootstrap.d.ts

@@ -1,68 +0,0 @@
-import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
-import { type IEngineServerConfig } from "@twin.org/engine-server-types";
-import type { INodeEngineState } from "./models/INodeEngineState.js";
-import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables.js";
-import { NodeFeatures } from "./models/nodeFeatures.js";
-/**
- * Bootstrap the application.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- */
-export declare function bootstrap(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, INodeEngineState>, envVars: INodeEnvironmentVariables): Promise<void>;
-/**
- * Bootstrap the node creating any necessary resources.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- * @param features The features that are enabled on the node. The features that are enabled on the node.
- */
-export declare function bootstrapNodeId(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
-/**
- * Bootstrap the node creating any necessary resources.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- * @param features The features that are enabled on the node. The features that are enabled on the node.
- */
-export declare function bootstrapTenantId(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
-/**
- * Bootstrap the user.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- * @param features The features that are enabled on the node.
- */
-export declare function bootstrapNodeAdminUser(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
-/**
- * Bootstrap the immutable proof verification methods.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- * @param features The features that are enabled on the node.
- */
-export declare function bootstrapImmutableProofMethod(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
-/**
- * Bootstrap the keys for blob encryption.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- * @param features The features that are enabled on the node.
- */
-export declare function bootstrapBlobEncryption(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
-/**
- * Bootstrap the JWT signing key.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- * @param features The features that are enabled on the node.
- */
-export declare function bootstrapAuth(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
-/**
- * Bootstrap the synchronised storage blob encryption and verification methods.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- * @param features The features that are enabled on the node.
- */
-export declare function bootstrapSynchronisedStorage(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;

package/dist/types/identity.d.ts

@@ -1,14 +0,0 @@
-import type { IEngineCore } from "@twin.org/engine-models";
-import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables.js";
-/**
- * Generate an identity and fund it.
- * @param engineCore The engine core for the node.
- * @param envVars The environment variables for the node.
- * @param configIdentity A identity from config to use.
- * @param configMnemonic A mnemonic from config to use.
- * @param controller The controller for the identity.
- * @param identityType The type of identity.
- * @param addWallet Whether to add a wallet for the identity.
- * @returns The identity that was generated.
- */
-export declare function createIdentity(engineCore: IEngineCore, envVars: INodeEnvironmentVariables, configIdentity: string | undefined, configMnemonic: string | undefined, controller: string | undefined, identityType: "node" | "organization" | "user", addWallet: boolean): Promise<string>;

package/dist/types/models/nodeExtensionMethods.d.ts

@@ -1,27 +0,0 @@
-import type { IEngineCore, IEngineServer } from "@twin.org/engine-models";
-import type { INodeEngineConfig } from "./INodeEngineConfig.js";
-import type { INodeEnvironmentVariables } from "./INodeEnvironmentVariables.js";
-/**
- * The type for the initialise method of an extension module.
- * @param envVars The environment variables for the node.
- * @param nodeEngineConfig The node engine config.
- */
-export type NodeExtensionInitialiseMethod = (envVars: INodeEnvironmentVariables, nodeEngineConfig: INodeEngineConfig) => Promise<void>;
-/**
- * The type for the initialise engine method of an extension module.
- * This is called when the engine has been constructed but not yet started.
- * @param engineCore The engine core instance.
- */
-export type NodeExtensionInitialiseEngineMethod = (engineCore: IEngineCore) => Promise<void>;
-/**
- * The type for the initialise engine server method of an extension module.
- * This is called when the engine server has been constructed but not yet started.
- * @param engineCore The engine core instance.
- * @param engineServer The engine server instance.
- */
-export type NodeExtensionInitialiseEngineServerMethod = (engineCore: IEngineCore, engineServer: IEngineServer) => Promise<void>;
-/**
- * The type for the shutdown method of an extension module.
- * This is called when the engine is shutting down.
- */
-export type NodeExtensionShutdownMethod = () => Promise<void>;

package/dist/types/models/nodeFeatures.d.ts

@@ -1,21 +0,0 @@
-/**
- * The features that can be enabled on the node.
- */
-export declare const NodeFeatures: {
-    /**
-     * NodeId - generates an identity for the node if not provided in config.
-     */
-    readonly NodeId: "node-identity";
-    /**
-     * NodeAdminUser - generates an admin user for the node if not provided in config.
-     */
-    readonly NodeAdminUser: "node-admin-user";
-    /**
-     * NodeWallet - generates wallets for any identities that need them.
-     */
-    readonly NodeWallet: "node-wallet";
-};
-/**
- * The features that can be enabled on the node.
- */
-export type NodeFeatures = (typeof NodeFeatures)[keyof typeof NodeFeatures];

package/docs/detailed-guide.md

@@ -1,129 +0,0 @@
-# TWIN Node - Detailed Documentation
-
-## Overview
-
-TWIN Node provides the foundational components for running TWIN nodes, including dynamic extension loading, protocol-based module resolution, and lifecycle management.
-
-## Protocol-Based Extension Loading
-
-The TWIN Node supports dynamic extension loading from multiple sources:
-
-### Local Files
-
-Load extensions from your filesystem:
-
-```bash
-TWIN_EXTENSIONS="./my-extension.mjs"
-```
-
-### NPM Packages
-
-Automatically install and load npm packages:
-
-```bash
-TWIN_EXTENSIONS="npm:@twin.org/package"
-```
-
-### HTTPS URLs
-
-Download and cache remote extensions:
-
-```bash
-TWIN_EXTENSIONS="https://example.com/extension.mjs"
-```
-
-## Extension Lifecycle Hooks
-
-Extensions can implement lifecycle hooks to customize node behavior at different stages:
-
-- **`extensionInitialise`** - Called before engine initialization
-- **`extensionInitialiseEngine`** - Called during engine initialization
-- **`extensionInitialiseEngineServer`** - Called during server initialization
-- **`extensionShutdown`** - Called during graceful shutdown
-
-### Example Extension
-
-```javascript
-// my-extension.mjs
-export function extensionInitialise() {
-  console.log('Extension initializing...');
-}
-
-export function extensionInitialiseEngine(engine) {
-  console.log('Configuring engine...');
-  // Add custom components, routes, etc.
-}
-
-export function extensionInitialiseEngineServer(server) {
-  console.log('Configuring server...');
-  // Add middleware, routes, etc.
-}
-
-export function extensionShutdown() {
-  console.log('Extension shutting down...');
-  // Cleanup resources
-}
-```
-
-## Configuration Options
-
-### Cache Management
-
-- `TWIN_EXTENSIONS_CACHE_TTL_HOURS` - TTL for HTTPS extensions cache (default: 24)
-- `TWIN_EXTENSIONS_FORCE_REFRESH` - Force refresh all cached extensions (default: false)
-- `TWIN_EXTENSIONS_CACHE_DIRECTORY` - Custom cache directory (default: ".tmp")
-
-### Security
-
-- `TWIN_EXTENSIONS_MAX_SIZE_MB` - Maximum size for HTTPS downloads (default: 10)
-- `TWIN_EXTENSIONS_CLEAR_CACHE` - Clear cache on startup (default: false)
-
-## API Reference
-
-### Core Functions
-
-#### `overrideModuleImport(executionDirectory, envVars)`
-
-Sets up protocol-based module resolution for extensions.
-
-#### `buildConfiguration(options)`
-
-Builds node configuration from environment variables and options.
-
-#### `start(options)`
-
-Starts the TWIN node with the specified configuration.
-
-### Utility Functions
-
-#### `parseModuleProtocol(moduleName)`
-
-Parses module name to determine protocol type (npm, https, local, etc.).
-
-#### `handleNpmProtocol(packageName, executionDirectory, cacheDirectory)`
-
-Handles installation and resolution of npm packages.
-
-#### `handleHttpsProtocol(url, executionDirectory, maxSizeMb, cacheDirectory, ttlHours, forceRefresh)`
-
-Handles download and caching of HTTPS extensions.
-
-## Security Considerations
-
-- **HTTPS Only**: Remote extensions must use HTTPS protocol
-- **Size Limits**: Downloads are limited by `TWIN_EXTENSIONS_MAX_SIZE_MB`
-- **Cache TTL**: Extensions are automatically refreshed based on TTL
-- **Security Warnings**: Warnings are displayed when loading remote extensions
-
-## Troubleshooting
-
-### Common Issues
-
-1. **Extension not found**: Check that the path/URL is correct and accessible
-2. **Cache issues**: Use `TWIN_EXTENSIONS_FORCE_REFRESH=true` to force refresh
-3. **Size limit exceeded**: Increase `TWIN_EXTENSIONS_MAX_SIZE_MB` if needed
-4. **Network issues**: Ensure HTTPS URLs are accessible and not blocked by firewall
-
-### Debug Mode
-
-Set `NODE_ENV=development` for additional debug output during extension loading.

package/docs/reference/functions/bootstrap.md

@@ -1,29 +0,0 @@
-# Function: bootstrap()
-
-> **bootstrap**(`engineCore`, `context`, `envVars`): `Promise`\<`void`\>
-
-Bootstrap the application.
-
-## Parameters
-
-### engineCore
-
-`IEngineCore`
-
-The engine core for the node.
-
-### context
-
-`IEngineCoreContext`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
-
-The context for the node.
-
-### envVars
-
-[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
-
-The environment variables for the node.
-
-## Returns
-
-`Promise`\<`void`\>