@twin.org/engine 0.0.1-next.80 → 0.0.1-next.81

package/dist/cjs/index.cjs

@@ -138,6 +138,7 @@ function buildEngineConfiguration(envVars) {
     configureEntityStorage(coreConfig, envVars);
     configureBlobStorage(coreConfig, envVars);
     configureVault(coreConfig, envVars);
+    configureDlt(coreConfig, envVars);
     configureLogging(coreConfig, envVars);
     configureBackgroundTask(coreConfig, envVars);
     configureEventBus(coreConfig, envVars);
@@ -160,6 +161,15 @@ function buildEngineConfiguration(envVars) {
     configureTaskScheduler(coreConfig, envVars);
     return coreConfig;
 }
+/**
+ * Helper function to get IOTA configuration from centralized dltConfig.
+ * @param coreConfig The core config.
+ * @returns The IOTA configuration if found, undefined otherwise.
+ */
+function getIotaConfig(coreConfig) {
+    const dltConfig = coreConfig.types.dltConfig?.find(config => config.type === engineTypes.DltConfigType.Iota && config.isDefault);
+    return dltConfig?.options?.config;
+}
 /**
  * Configures the entity storage.
  * @param coreConfig The core config.
@@ -612,16 +622,14 @@ function configureFaucet(coreConfig, envVars) {
         });
     }
     else if (envVars.faucetConnector === engineTypes.FaucetConnectorType.Iota) {
+        const iotaConfig = getIotaConfig(coreConfig);
         coreConfig.types.faucetConnector.push({
             type: engineTypes.FaucetConnectorType.Iota,
             options: {
                 config: {
                     endpoint: envVars.iotaFaucetEndpoint ?? "",
-                    clientOptions: {
-                        url: envVars.iotaNodeEndpoint ?? ""
-                    },
-                    network: envVars.iotaNetwork ?? "",
-                    coinType: core.Coerce.number(envVars.iotaCoinType)
+                    clientOptions: iotaConfig?.clientOptions ?? { url: "" },
+                    network: iotaConfig?.network ?? ""
                 }
             }
         });
@@ -640,16 +648,11 @@ function configureWallet(coreConfig, envVars) {
         });
     }
     else if (envVars.walletConnector === engineTypes.WalletConnectorType.Iota) {
+        const iotaConfig = getIotaConfig(coreConfig);
         coreConfig.types.walletConnector.push({
             type: engineTypes.WalletConnectorType.Iota,
             options: {
-                config: {
-                    clientOptions: {
-                        url: envVars.iotaNodeEndpoint ?? ""
-                    },
-                    network: envVars.iotaNetwork ?? "",
-                    coinType: core.Coerce.number(envVars.iotaCoinType)
-                }
+                config: iotaConfig ?? {}
             }
         });
     }
@@ -667,16 +670,11 @@ function configureNft(coreConfig, envVars) {
         });
     }
     else if (envVars.nftConnector === engineTypes.NftConnectorType.Iota) {
+        const iotaConfig = getIotaConfig(coreConfig);
         coreConfig.types.nftConnector.push({
             type: engineTypes.NftConnectorType.Iota,
             options: {
-                config: {
-                    clientOptions: {
-                        url: envVars.iotaNodeEndpoint ?? ""
-                    },
-                    network: envVars.iotaNetwork ?? "",
-                    coinType: core.Coerce.number(envVars.iotaCoinType)
-                }
+                config: iotaConfig ?? {}
             }
         });
     }
@@ -698,16 +696,11 @@ function configureVerifiableStorage(coreConfig, envVars) {
         });
     }
     else if (envVars.verifiableStorageConnector === engineTypes.VerifiableStorageConnectorType.Iota) {
+        const iotaConfig = getIotaConfig(coreConfig);
         coreConfig.types.verifiableStorageConnector.push({
             type: engineTypes.VerifiableStorageConnectorType.Iota,
             options: {
-                config: {
-                    clientOptions: {
-                        url: envVars.iotaNodeEndpoint ?? ""
-                    },
-                    network: envVars.iotaNetwork ?? "",
-                    coinType: core.Coerce.number(envVars.iotaCoinType)
-                }
+                config: iotaConfig ?? {}
             }
         });
     }
@@ -748,16 +741,11 @@ function configureIdentity(coreConfig, envVars) {
         });
     }
     else if (envVars.identityConnector === engineTypes.IdentityConnectorType.Iota) {
+        const iotaConfig = getIotaConfig(coreConfig);
         coreConfig.types.identityConnector.push({
             type: engineTypes.IdentityConnectorType.Iota,
             options: {
-                config: {
-                    clientOptions: {
-                        url: envVars.iotaNodeEndpoint ?? ""
-                    },
-                    network: envVars.iotaNetwork ?? "",
-                    coinType: core.Coerce.number(envVars.iotaCoinType)
-                }
+                config: iotaConfig ?? {}
             }
         });
     }
@@ -779,16 +767,11 @@ function configureIdentityResolver(coreConfig, envVars) {
         });
     }
     else if (envVars.identityResolverConnector === engineTypes.IdentityResolverConnectorType.Iota) {
+        const iotaConfig = getIotaConfig(coreConfig);
         coreConfig.types.identityResolverConnector.push({
             type: engineTypes.IdentityResolverConnectorType.Iota,
             options: {
-                config: {
-                    clientOptions: {
-                        url: envVars.iotaNodeEndpoint ?? ""
-                    },
-                    network: envVars.iotaNetwork ?? "",
-                    coinType: core.Coerce.number(envVars.iotaCoinType)
-                }
+                config: iotaConfig ?? {}
             }
         });
     }
@@ -975,6 +958,38 @@ function configureTaskScheduler(coreConfig, envVars) {
         });
     }
 }
+/**
+ * Configures the DLT.
+ * @param coreConfig The core config.
+ * @param envVars The environment variables.
+ */
+function configureDlt(coreConfig, envVars) {
+    // Create centralized DLT configuration for IOTA if essential IOTA variables are set
+    if (core.Is.stringValue(envVars.iotaNodeEndpoint) && core.Is.stringValue(envVars.iotaNetwork)) {
+        coreConfig.types.dltConfig ??= [];
+        const gasStationConfig = core.Is.stringValue(envVars.iotaGasStationEndpoint) &&
+            core.Is.stringValue(envVars.iotaGasStationAuthToken)
+            ? {
+                gasStationUrl: envVars.iotaGasStationEndpoint,
+                gasStationAuthToken: envVars.iotaGasStationAuthToken
+            }
+            : undefined;
+        coreConfig.types.dltConfig.push({
+            type: engineTypes.DltConfigType.Iota,
+            isDefault: true,
+            options: {
+                config: {
+                    clientOptions: {
+                        url: envVars.iotaNodeEndpoint ?? ""
+                    },
+                    network: envVars.iotaNetwork ?? "",
+                    coinType: core.Coerce.number(envVars.iotaCoinType),
+                    gasStation: gasStationConfig
+                }
+            }
+        });
+    }
+}
 
 exports.Engine = Engine;
 exports.EngineConfigHelper = EngineConfigHelper;

package/dist/esm/index.mjs

@@ -1,6 +1,6 @@
 import { EngineCore } from '@twin.org/engine-core';
 import { Guards, StringHelper, Is, Coerce } from '@twin.org/core';
-import { EntityStorageComponentType, EntityStorageConnectorType, BlobStorageConnectorType, BlobStorageComponentType, VaultConnectorType, LoggingConnectorType, LoggingComponentType, BackgroundTaskConnectorType, EventBusConnectorType, EventBusComponentType, TelemetryConnectorType, TelemetryComponentType, MessagingEmailConnectorType, MessagingSmsConnectorType, MessagingPushNotificationConnectorType, MessagingComponentType, FaucetConnectorType, WalletConnectorType, NftConnectorType, NftComponentType, VerifiableStorageConnectorType, VerifiableStorageComponentType, ImmutableProofComponentType, AuditableItemGraphComponentType, AuditableItemStreamComponentType, IdentityConnectorType, IdentityComponentType, IdentityResolverConnectorType, IdentityResolverComponentType, IdentityProfileConnectorType, IdentityProfileComponentType, AttestationConnectorType, AttestationComponentType, DataConverterConnectorType, DataExtractorConnectorType, DataProcessingComponentType, DocumentManagementComponentType, FederatedCatalogueComponentType, RightsManagementPapComponentType, RightsManagementComponentType, TaskSchedulerComponentType } from '@twin.org/engine-types';
+import { EntityStorageComponentType, EntityStorageConnectorType, BlobStorageConnectorType, BlobStorageComponentType, VaultConnectorType, DltConfigType, LoggingConnectorType, LoggingComponentType, BackgroundTaskConnectorType, EventBusConnectorType, EventBusComponentType, TelemetryConnectorType, TelemetryComponentType, MessagingEmailConnectorType, MessagingSmsConnectorType, MessagingPushNotificationConnectorType, MessagingComponentType, FaucetConnectorType, WalletConnectorType, NftConnectorType, NftComponentType, VerifiableStorageConnectorType, VerifiableStorageComponentType, ImmutableProofComponentType, AuditableItemGraphComponentType, AuditableItemStreamComponentType, IdentityConnectorType, IdentityComponentType, IdentityResolverConnectorType, IdentityResolverComponentType, IdentityProfileConnectorType, IdentityProfileComponentType, AttestationConnectorType, AttestationComponentType, DataConverterConnectorType, DataExtractorConnectorType, DataProcessingComponentType, DocumentManagementComponentType, FederatedCatalogueComponentType, RightsManagementPapComponentType, RightsManagementComponentType, TaskSchedulerComponentType } from '@twin.org/engine-types';
 import { EntitySchemaFactory } from '@twin.org/entity';
 import path from 'node:path';
 
@@ -136,6 +136,7 @@ function buildEngineConfiguration(envVars) {
     configureEntityStorage(coreConfig, envVars);
     configureBlobStorage(coreConfig, envVars);
     configureVault(coreConfig, envVars);
+    configureDlt(coreConfig, envVars);
     configureLogging(coreConfig, envVars);
     configureBackgroundTask(coreConfig, envVars);
     configureEventBus(coreConfig, envVars);
@@ -158,6 +159,15 @@ function buildEngineConfiguration(envVars) {
     configureTaskScheduler(coreConfig, envVars);
     return coreConfig;
 }
+/**
+ * Helper function to get IOTA configuration from centralized dltConfig.
+ * @param coreConfig The core config.
+ * @returns The IOTA configuration if found, undefined otherwise.
+ */
+function getIotaConfig(coreConfig) {
+    const dltConfig = coreConfig.types.dltConfig?.find(config => config.type === DltConfigType.Iota && config.isDefault);
+    return dltConfig?.options?.config;
+}
 /**
  * Configures the entity storage.
  * @param coreConfig The core config.
@@ -610,16 +620,14 @@ function configureFaucet(coreConfig, envVars) {
         });
     }
     else if (envVars.faucetConnector === FaucetConnectorType.Iota) {
+        const iotaConfig = getIotaConfig(coreConfig);
         coreConfig.types.faucetConnector.push({
             type: FaucetConnectorType.Iota,
             options: {
                 config: {
                     endpoint: envVars.iotaFaucetEndpoint ?? "",
-                    clientOptions: {
-                        url: envVars.iotaNodeEndpoint ?? ""
-                    },
-                    network: envVars.iotaNetwork ?? "",
-                    coinType: Coerce.number(envVars.iotaCoinType)
+                    clientOptions: iotaConfig?.clientOptions ?? { url: "" },
+                    network: iotaConfig?.network ?? ""
                 }
             }
         });
@@ -638,16 +646,11 @@ function configureWallet(coreConfig, envVars) {
         });
     }
     else if (envVars.walletConnector === WalletConnectorType.Iota) {
+        const iotaConfig = getIotaConfig(coreConfig);
         coreConfig.types.walletConnector.push({
             type: WalletConnectorType.Iota,
             options: {
-                config: {
-                    clientOptions: {
-                        url: envVars.iotaNodeEndpoint ?? ""
-                    },
-                    network: envVars.iotaNetwork ?? "",
-                    coinType: Coerce.number(envVars.iotaCoinType)
-                }
+                config: iotaConfig ?? {}
             }
         });
     }
@@ -665,16 +668,11 @@ function configureNft(coreConfig, envVars) {
         });
     }
     else if (envVars.nftConnector === NftConnectorType.Iota) {
+        const iotaConfig = getIotaConfig(coreConfig);
         coreConfig.types.nftConnector.push({
             type: NftConnectorType.Iota,
             options: {
-                config: {
-                    clientOptions: {
-                        url: envVars.iotaNodeEndpoint ?? ""
-                    },
-                    network: envVars.iotaNetwork ?? "",
-                    coinType: Coerce.number(envVars.iotaCoinType)
-                }
+                config: iotaConfig ?? {}
             }
         });
     }
@@ -696,16 +694,11 @@ function configureVerifiableStorage(coreConfig, envVars) {
         });
     }
     else if (envVars.verifiableStorageConnector === VerifiableStorageConnectorType.Iota) {
+        const iotaConfig = getIotaConfig(coreConfig);
         coreConfig.types.verifiableStorageConnector.push({
             type: VerifiableStorageConnectorType.Iota,
             options: {
-                config: {
-                    clientOptions: {
-                        url: envVars.iotaNodeEndpoint ?? ""
-                    },
-                    network: envVars.iotaNetwork ?? "",
-                    coinType: Coerce.number(envVars.iotaCoinType)
-                }
+                config: iotaConfig ?? {}
             }
         });
     }
@@ -746,16 +739,11 @@ function configureIdentity(coreConfig, envVars) {
         });
     }
     else if (envVars.identityConnector === IdentityConnectorType.Iota) {
+        const iotaConfig = getIotaConfig(coreConfig);
         coreConfig.types.identityConnector.push({
             type: IdentityConnectorType.Iota,
             options: {
-                config: {
-                    clientOptions: {
-                        url: envVars.iotaNodeEndpoint ?? ""
-                    },
-                    network: envVars.iotaNetwork ?? "",
-                    coinType: Coerce.number(envVars.iotaCoinType)
-                }
+                config: iotaConfig ?? {}
             }
         });
     }
@@ -777,16 +765,11 @@ function configureIdentityResolver(coreConfig, envVars) {
         });
     }
     else if (envVars.identityResolverConnector === IdentityResolverConnectorType.Iota) {
+        const iotaConfig = getIotaConfig(coreConfig);
         coreConfig.types.identityResolverConnector.push({
             type: IdentityResolverConnectorType.Iota,
             options: {
-                config: {
-                    clientOptions: {
-                        url: envVars.iotaNodeEndpoint ?? ""
-                    },
-                    network: envVars.iotaNetwork ?? "",
-                    coinType: Coerce.number(envVars.iotaCoinType)
-                }
+                config: iotaConfig ?? {}
             }
         });
     }
@@ -973,5 +956,37 @@ function configureTaskScheduler(coreConfig, envVars) {
         });
     }
 }
+/**
+ * Configures the DLT.
+ * @param coreConfig The core config.
+ * @param envVars The environment variables.
+ */
+function configureDlt(coreConfig, envVars) {
+    // Create centralized DLT configuration for IOTA if essential IOTA variables are set
+    if (Is.stringValue(envVars.iotaNodeEndpoint) && Is.stringValue(envVars.iotaNetwork)) {
+        coreConfig.types.dltConfig ??= [];
+        const gasStationConfig = Is.stringValue(envVars.iotaGasStationEndpoint) &&
+            Is.stringValue(envVars.iotaGasStationAuthToken)
+            ? {
+                gasStationUrl: envVars.iotaGasStationEndpoint,
+                gasStationAuthToken: envVars.iotaGasStationAuthToken
+            }
+            : undefined;
+        coreConfig.types.dltConfig.push({
+            type: DltConfigType.Iota,
+            isDefault: true,
+            options: {
+                config: {
+                    clientOptions: {
+                        url: envVars.iotaNodeEndpoint ?? ""
+                    },
+                    network: envVars.iotaNetwork ?? "",
+                    coinType: Coerce.number(envVars.iotaCoinType),
+                    gasStation: gasStationConfig
+                }
+            }
+        });
+    }
+}
 
 export { Engine, EngineConfigHelper, buildEngineConfiguration };

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

@@ -334,6 +334,14 @@ export interface IEngineEnvironmentVariables {
      * IOTA Explorer Endpoint.
      */
     iotaExplorerEndpoint?: string;
+    /**
+     * IOTA Gas Station Endpoint.
+     */
+    iotaGasStationEndpoint?: string;
+    /**
+     * IOTA Gas Station Authentication Token.
+     */
+    iotaGasStationAuthToken?: string;
     /**
      * Universal Resolver Endpoint.
      */

package/docs/changelog.md

@@ -1,5 +1,20 @@
 # @twin.org/engine - Changelog
 
+## [0.0.1-next.81](https://github.com/twinfoundation/engine/compare/engine-v0.0.1-next.80...engine-v0.0.1-next.81) (2025-07-07)
+
+
+### Features
+
+* gas station integration ([#17](https://github.com/twinfoundation/engine/issues/17)) ([a3f844a](https://github.com/twinfoundation/engine/commit/a3f844a7fc58c43b4d0700d8d4351062045e66e1))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.1-next.80 to 0.0.1-next.81
+    * @twin.org/engine-types bumped from 0.0.1-next.80 to 0.0.1-next.81
+
 ## [0.0.1-next.80](https://github.com/twinfoundation/engine/compare/engine-v0.0.1-next.79...engine-v0.0.1-next.80) (2025-06-23)
 
 

package/docs/examples.md

@@ -1 +1,35 @@
 # @twin.org/engine - Examples
+
+## Environment Variables
+
+The engine supports various environment variables for configuration. Here are some key examples:
+
+### IOTA DLT Configuration
+
+Basic IOTA configuration:
+
+```bash
+# IOTA Node Configuration
+IOTA_NODE_ENDPOINT="https://api.devnet.iota.cafe"
+IOTA_FAUCET_ENDPOINT="https://faucet.devnet.iota.cafe"
+IOTA_EXPLORER_ENDPOINT="https://explorer.iota.org/"
+IOTA_NETWORK="devnet"
+IOTA_COIN_TYPE="4218"
+```
+
+### IOTA Gas Station Configuration (Optional)
+
+The IOTA Gas Station pattern allows for sponsored transactions and improved UX:
+
+```bash
+# Gas Station Configuration
+IOTA_GAS_STATION_ENDPOINT="https://gas-station.example.com"
+IOTA_GAS_STATION_AUTH_TOKEN="your-auth-token"
+```
+
+**Configuration Options:**
+
+- `IOTA_GAS_STATION_ENDPOINT`: The URL of the gas station service
+- `IOTA_GAS_STATION_AUTH_TOKEN`: Authentication token for the gas station
+
+When gas station is configured, all IOTA-related connectors (wallet, nft, verifiable-storage, identity, identity-resolver) will automatically use the centralized configuration and have access to gas station functionality.

package/docs/reference/interfaces/IEngineEnvironmentVariables.md

@@ -668,6 +668,22 @@ IOTA Explorer Endpoint.
 
 ***
 
+### iotaGasStationEndpoint?
+
+> `optional` **iotaGasStationEndpoint**: `string`
+
+IOTA Gas Station Endpoint.
+
+***
+
+### iotaGasStationAuthToken?
+
+> `optional` **iotaGasStationAuthToken**: `string`
+
+IOTA Gas Station Authentication Token.
+
+***
+
 ### universalResolverEndpoint?
 
 > `optional` **universalResolverEndpoint**: `string`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine",
-	"version": "0.0.1-next.80",
+	"version": "0.0.1-next.81",
 	"description": "Engine implementation.",
 	"repository": {
 		"type": "git",
@@ -15,8 +15,8 @@
 	},
 	"dependencies": {
 		"@twin.org/core": "next",
-		"@twin.org/engine-core": "0.0.1-next.80",
-		"@twin.org/engine-types": "0.0.1-next.80",
+		"@twin.org/engine-core": "0.0.1-next.81",
+		"@twin.org/engine-types": "0.0.1-next.81",
 		"@twin.org/entity": "next"
 	},
 	"main": "./dist/cjs/index.cjs",