@twin.org/node-core 0.9.2-next.1 → 0.9.2-next.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/es/builders/engineEnvBuilder.js +198 -111
- package/dist/es/builders/engineEnvBuilder.js.map +1 -1
- package/dist/es/builders/engineServerEnvBuilder.js +23 -26
- package/dist/es/builders/engineServerEnvBuilder.js.map +1 -1
- package/dist/es/builders/extensionsBuilder.js +5 -4
- package/dist/es/builders/extensionsBuilder.js.map +1 -1
- package/dist/es/builders/helper/envHelpers.js +174 -0
- package/dist/es/builders/helper/envHelpers.js.map +1 -0
- package/dist/es/cli.js +4 -3
- package/dist/es/cli.js.map +1 -1
- package/dist/es/commands/{bootstrapLegacy.js → bootstrapDev.js} +30 -29
- package/dist/es/commands/bootstrapDev.js.map +1 -0
- package/dist/es/commands/identityCreate.js +4 -26
- package/dist/es/commands/identityCreate.js.map +1 -1
- package/dist/es/commands/identityImports.js +2 -1
- package/dist/es/commands/identityImports.js.map +1 -1
- package/dist/es/commands/userCreate.js +8 -3
- package/dist/es/commands/userCreate.js.map +1 -1
- package/dist/es/commands/userUpdate.js +5 -2
- package/dist/es/commands/userUpdate.js.map +1 -1
- package/dist/es/index.js +1 -1
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/{IBootstrapLegacyEnvironmentVariables.js → IBootstrapDevEnvironmentVariables.js} +1 -1
- package/dist/es/models/IBootstrapDevEnvironmentVariables.js.map +1 -0
- package/dist/es/models/IEngineEnvironmentVariables.js.map +1 -1
- package/dist/es/models/IEnvironmentVariables.js.map +1 -1
- package/dist/es/models/{bootstrapLegacyEnvironmentVariableKeys.js → bootstrapDevEnvironmentVariableKeys.js} +6 -6
- package/dist/es/models/bootstrapDevEnvironmentVariableKeys.js.map +1 -0
- package/dist/es/models/engineEnvironmentVariableKeys.js +50 -4
- package/dist/es/models/engineEnvironmentVariableKeys.js.map +1 -1
- package/dist/es/models/engineServerEnvironmentVariableKeys.js +3 -3
- package/dist/es/models/engineServerEnvironmentVariableKeys.js.map +1 -1
- package/dist/es/models/nodeEnvironmentVariableKeys.js +1 -1
- package/dist/es/models/nodeEnvironmentVariableKeys.js.map +1 -1
- package/dist/es/node.js +6 -10
- package/dist/es/node.js.map +1 -1
- package/dist/es/start.js +3 -2
- package/dist/es/start.js.map +1 -1
- package/dist/types/builders/helper/envHelpers.d.ts +82 -0
- package/dist/types/commands/{bootstrapLegacy.d.ts → bootstrapDev.d.ts} +3 -3
- package/dist/types/index.d.ts +1 -1
- package/dist/types/models/{IBootstrapLegacyEnvironmentVariables.d.ts → IBootstrapDevEnvironmentVariables.d.ts} +2 -2
- package/dist/types/models/IEngineEnvironmentVariables.d.ts +202 -13
- package/dist/types/models/IEnvironmentVariables.d.ts +2 -2
- package/dist/types/models/bootstrapDevEnvironmentVariableKeys.d.ts +4 -0
- package/dist/types/node.d.ts +1 -1
- package/docs/changelog.md +72 -0
- package/docs/reference/functions/buildConfiguration.md +2 -2
- package/docs/reference/functions/buildEngineServerConfiguration.md +1 -1
- package/docs/reference/functions/run.md +1 -1
- package/docs/reference/functions/start.md +1 -1
- package/docs/reference/index.md +1 -1
- package/docs/reference/interfaces/{IBootstrapLegacyEnvironmentVariables.md → IBootstrapDevEnvironmentVariables.md} +2 -2
- package/docs/reference/interfaces/IEngineEnvironmentVariables.md +429 -20
- package/docs/reference/type-aliases/IEnvironmentVariables.md +1 -1
- package/locales/en.json +6 -5
- package/package.json +11 -4
- package/dist/es/commands/bootstrapLegacy.js.map +0 -1
- package/dist/es/models/IBootstrapLegacyEnvironmentVariables.js.map +0 -1
- package/dist/es/models/bootstrapLegacyEnvironmentVariableKeys.js.map +0 -1
- package/dist/types/models/bootstrapLegacyEnvironmentVariableKeys.d.ts +0 -4
|
@@ -131,6 +131,14 @@ export interface IEngineEnvironmentVariables {
|
|
|
131
131
|
* ScyllaDB port.
|
|
132
132
|
*/
|
|
133
133
|
scylladbPort?: string;
|
|
134
|
+
/**
|
|
135
|
+
* ScyllaDB connection pool: number of connections per local host.
|
|
136
|
+
*/
|
|
137
|
+
scylladbPoolCoreConnectionsPerHost?: string;
|
|
138
|
+
/**
|
|
139
|
+
* ScyllaDB connection pool: maximum requests per connection.
|
|
140
|
+
*/
|
|
141
|
+
scylladbPoolMaxRequestsPerConnection?: string;
|
|
134
142
|
/**
|
|
135
143
|
* MySQL host.
|
|
136
144
|
*/
|
|
@@ -138,7 +146,7 @@ export interface IEngineEnvironmentVariables {
|
|
|
138
146
|
/**
|
|
139
147
|
* MySQL port.
|
|
140
148
|
*/
|
|
141
|
-
mySqlPort?:
|
|
149
|
+
mySqlPort?: string;
|
|
142
150
|
/**
|
|
143
151
|
* MySQL username.
|
|
144
152
|
*/
|
|
@@ -151,6 +159,30 @@ export interface IEngineEnvironmentVariables {
|
|
|
151
159
|
* MySQL Database.
|
|
152
160
|
*/
|
|
153
161
|
mySqlDatabase?: string;
|
|
162
|
+
/**
|
|
163
|
+
* MySQL connection pool: maximum number of connections.
|
|
164
|
+
*/
|
|
165
|
+
mySqlPoolConnectionLimit?: string;
|
|
166
|
+
/**
|
|
167
|
+
* MySQL connection pool: maximum number of idle connections.
|
|
168
|
+
*/
|
|
169
|
+
mySqlPoolMaxIdle?: string;
|
|
170
|
+
/**
|
|
171
|
+
* MySQL connection pool: milliseconds before an idle connection is removed.
|
|
172
|
+
*/
|
|
173
|
+
mySqlPoolIdleTimeout?: string;
|
|
174
|
+
/**
|
|
175
|
+
* MySQL connection pool: enable TCP keep-alive.
|
|
176
|
+
*/
|
|
177
|
+
mySqlPoolEnableKeepAlive?: string;
|
|
178
|
+
/**
|
|
179
|
+
* MySQL connection pool: wait for a connection when pool is full.
|
|
180
|
+
*/
|
|
181
|
+
mySqlPoolWaitForConnections?: string;
|
|
182
|
+
/**
|
|
183
|
+
* MySQL connection pool: maximum queued requests (0 = unlimited).
|
|
184
|
+
*/
|
|
185
|
+
mySqlPoolQueueLimit?: string;
|
|
154
186
|
/**
|
|
155
187
|
* MongoDB host.
|
|
156
188
|
*/
|
|
@@ -158,7 +190,7 @@ export interface IEngineEnvironmentVariables {
|
|
|
158
190
|
/**
|
|
159
191
|
* MongoDB port.
|
|
160
192
|
*/
|
|
161
|
-
mongoDbPort?:
|
|
193
|
+
mongoDbPort?: string;
|
|
162
194
|
/**
|
|
163
195
|
* MongoDB username.
|
|
164
196
|
*/
|
|
@@ -171,6 +203,22 @@ export interface IEngineEnvironmentVariables {
|
|
|
171
203
|
* MongoDB Database.
|
|
172
204
|
*/
|
|
173
205
|
mongoDbDatabase?: string;
|
|
206
|
+
/**
|
|
207
|
+
* MongoDB connection pool: maximum number of connections.
|
|
208
|
+
*/
|
|
209
|
+
mongoDbPoolMaxPoolSize?: string;
|
|
210
|
+
/**
|
|
211
|
+
* MongoDB connection pool: minimum number of connections to maintain.
|
|
212
|
+
*/
|
|
213
|
+
mongoDbPoolMinPoolSize?: string;
|
|
214
|
+
/**
|
|
215
|
+
* MongoDB connection pool: milliseconds a connection can remain idle before removal.
|
|
216
|
+
*/
|
|
217
|
+
mongoDbPoolMaxIdleTime?: string;
|
|
218
|
+
/**
|
|
219
|
+
* MongoDB connection pool: milliseconds to wait for a connection before throwing.
|
|
220
|
+
*/
|
|
221
|
+
mongoDbPoolWaitQueueTimeout?: string;
|
|
174
222
|
/**
|
|
175
223
|
* PostgreSQl host.
|
|
176
224
|
*/
|
|
@@ -178,7 +226,7 @@ export interface IEngineEnvironmentVariables {
|
|
|
178
226
|
/**
|
|
179
227
|
* PostgreSQl port.
|
|
180
228
|
*/
|
|
181
|
-
postgreSqlPort?:
|
|
229
|
+
postgreSqlPort?: string;
|
|
182
230
|
/**
|
|
183
231
|
* PostgreSQl username.
|
|
184
232
|
*/
|
|
@@ -191,6 +239,22 @@ export interface IEngineEnvironmentVariables {
|
|
|
191
239
|
* PostgreSQl Database.
|
|
192
240
|
*/
|
|
193
241
|
postgreSqlDatabase?: string;
|
|
242
|
+
/**
|
|
243
|
+
* PostgreSQL connection pool: maximum number of connections.
|
|
244
|
+
*/
|
|
245
|
+
postgreSqlPoolMax?: string;
|
|
246
|
+
/**
|
|
247
|
+
* PostgreSQL connection pool: seconds a connection can remain idle before being closed.
|
|
248
|
+
*/
|
|
249
|
+
postgreSqlPoolIdleTimeout?: string;
|
|
250
|
+
/**
|
|
251
|
+
* PostgreSQL connection pool: seconds to wait when establishing a connection.
|
|
252
|
+
*/
|
|
253
|
+
postgreSqlPoolConnectTimeout?: string;
|
|
254
|
+
/**
|
|
255
|
+
* PostgreSQL connection pool: maximum seconds a connection can remain open.
|
|
256
|
+
*/
|
|
257
|
+
postgreSqlPoolMaxLifetime?: string;
|
|
194
258
|
/**
|
|
195
259
|
* The security token for accessing IPFS API.
|
|
196
260
|
*/
|
|
@@ -293,7 +357,7 @@ export interface IEngineEnvironmentVariables {
|
|
|
293
357
|
*/
|
|
294
358
|
hashicorpVaultEndpoint?: string;
|
|
295
359
|
/**
|
|
296
|
-
* The type of logging task connector, can be a comma separated list: console, entity-storage,
|
|
360
|
+
* The type of logging task connector, can be a comma separated list: console, entity-storage, open-telemetry, file.
|
|
297
361
|
*/
|
|
298
362
|
loggingConnector?: string;
|
|
299
363
|
/**
|
|
@@ -444,6 +508,34 @@ export interface IEngineEnvironmentVariables {
|
|
|
444
508
|
* Maximum number of values retained per telemetry metric (count-based history cap). Defaults to 1440.
|
|
445
509
|
*/
|
|
446
510
|
telemetryMetricsProducerMaxHistory?: string;
|
|
511
|
+
/**
|
|
512
|
+
* The mutex timeout in milliseconds for the telemetry connector.
|
|
513
|
+
*/
|
|
514
|
+
telemetryMutexTimeout?: string;
|
|
515
|
+
/**
|
|
516
|
+
* The type of tracing connector: entity-storage, open-telemetry.
|
|
517
|
+
*/
|
|
518
|
+
tracingConnector?: string;
|
|
519
|
+
/**
|
|
520
|
+
* The name of the Open Telemetry tracer to use, only required if using open-telemetry as tracing connector, defaults to twin-node.
|
|
521
|
+
*/
|
|
522
|
+
openTelemetryTracingTracerName?: string;
|
|
523
|
+
/**
|
|
524
|
+
* The version of the Open Telemetry tracing specification to use, only required if using open-telemetry as tracing connector, defaults to 1.0.0.
|
|
525
|
+
*/
|
|
526
|
+
openTelemetryTracingTracerVersion?: string;
|
|
527
|
+
/**
|
|
528
|
+
* The OTLP HTTP endpoint to push spans to, e.g. http://localhost:4318/v1/traces. Required when using open-telemetry as tracing connector.
|
|
529
|
+
*/
|
|
530
|
+
openTelemetryTracingEndpoint?: string;
|
|
531
|
+
/**
|
|
532
|
+
* The span processor: batch (default) or simple. Only used when TWIN_TRACING_CONNECTOR=open-telemetry.
|
|
533
|
+
*/
|
|
534
|
+
openTelemetryTracingProcessor?: string;
|
|
535
|
+
/**
|
|
536
|
+
* The mutex timeout in milliseconds for the tracing connector.
|
|
537
|
+
*/
|
|
538
|
+
tracingMutexTimeout?: string;
|
|
447
539
|
/**
|
|
448
540
|
* The type of faucet connector: entity-storage, iota.
|
|
449
541
|
*/
|
|
@@ -475,7 +567,23 @@ export interface IEngineEnvironmentVariables {
|
|
|
475
567
|
/**
|
|
476
568
|
* The TTL in milliseconds for caching resolved DIDs when using the IOTA identity connector. Omit to use the connector default.
|
|
477
569
|
*/
|
|
478
|
-
|
|
570
|
+
identityDidResolutionCacheTtl?: string;
|
|
571
|
+
/**
|
|
572
|
+
* The maximum number of DID documents to hold in the resolution cache. Only used when using the IOTA identity connector and caching is enabled.
|
|
573
|
+
*/
|
|
574
|
+
identityDidResolutionCacheCapacity?: string;
|
|
575
|
+
/**
|
|
576
|
+
* The mutex timeout in milliseconds for the DID resolution cache. Only used when using the IOTA identity connector and caching is enabled.
|
|
577
|
+
*/
|
|
578
|
+
identityDidResolutionCacheMutexTimeout?: string;
|
|
579
|
+
/**
|
|
580
|
+
* The number of times to retry resolving a DID after a write operation (create, update, or delete) to confirm propagation. Only used when using the IOTA identity connector.
|
|
581
|
+
*/
|
|
582
|
+
identityDidResolutionRetries?: string;
|
|
583
|
+
/**
|
|
584
|
+
* The delay in milliseconds between DID resolution retries after a write operation. Only used when using the IOTA identity connector.
|
|
585
|
+
*/
|
|
586
|
+
identityDidResolutionRetryDelay?: string;
|
|
479
587
|
/**
|
|
480
588
|
* The type of identity resolver connector: entity-storage, iota.
|
|
481
589
|
*/
|
|
@@ -532,6 +640,51 @@ export interface IEngineEnvironmentVariables {
|
|
|
532
640
|
* The identity verification method id to use with immutable proofs.
|
|
533
641
|
*/
|
|
534
642
|
immutableProofVerificationMethodId?: string;
|
|
643
|
+
/**
|
|
644
|
+
* The number of times to retry a proof task when it fails, 0 to disable retries.
|
|
645
|
+
* @default 5
|
|
646
|
+
*/
|
|
647
|
+
immutableProofTaskRetryCount?: string;
|
|
648
|
+
/**
|
|
649
|
+
* The interval in seconds to wait between proof task retries.
|
|
650
|
+
* @default 5
|
|
651
|
+
*/
|
|
652
|
+
immutableProofTaskRetryInterval?: string;
|
|
653
|
+
/**
|
|
654
|
+
* The time in minutes to retain the record of a failed proof task.
|
|
655
|
+
* Set to -1 to retain failures forever.
|
|
656
|
+
* @default 10080
|
|
657
|
+
*/
|
|
658
|
+
immutableProofTaskFailureRetainFor?: string;
|
|
659
|
+
/**
|
|
660
|
+
* How often in minutes the immutable proof reconciliation sweep runs.
|
|
661
|
+
* @default 30
|
|
662
|
+
*/
|
|
663
|
+
immutableProofSweepInterval?: string;
|
|
664
|
+
/**
|
|
665
|
+
* The minimum age in minutes before a proof with no notarization is considered stuck.
|
|
666
|
+
* @default 180
|
|
667
|
+
*/
|
|
668
|
+
immutableProofSweepStaleThreshold?: string;
|
|
669
|
+
/**
|
|
670
|
+
* The number of sweep attempts made before a proof is parked.
|
|
671
|
+
* @default 5
|
|
672
|
+
*/
|
|
673
|
+
immutableProofSweepMaxAttempts?: string;
|
|
674
|
+
/**
|
|
675
|
+
* The maximum number of proofs to re-enqueue per tenant per sweep cycle.
|
|
676
|
+
* @default 10
|
|
677
|
+
*/
|
|
678
|
+
immutableProofSweepBatchLimit?: string;
|
|
679
|
+
/**
|
|
680
|
+
* The minimum time in minutes between sweep attempts for the same proof.
|
|
681
|
+
* @default 60
|
|
682
|
+
*/
|
|
683
|
+
immutableProofSweepBackoff?: string;
|
|
684
|
+
/**
|
|
685
|
+
* ISO 8601 date-time used to treat older missing-task proofs as retryable.
|
|
686
|
+
*/
|
|
687
|
+
immutableProofSweepAssumeRetryableBefore?: string;
|
|
535
688
|
/**
|
|
536
689
|
* The type of attestation connector: entity-storage, iota.
|
|
537
690
|
*/
|
|
@@ -663,13 +816,41 @@ export interface IEngineEnvironmentVariables {
|
|
|
663
816
|
* @default 3600
|
|
664
817
|
*/
|
|
665
818
|
dataspaceActivityLogsCleanupInterval?: string;
|
|
819
|
+
/**
|
|
820
|
+
* The TTL in milliseconds for the dataspace agreement cache.
|
|
821
|
+
*/
|
|
822
|
+
dataspaceAgreementCacheTtl?: string;
|
|
823
|
+
/**
|
|
824
|
+
* The mutex timeout in milliseconds for the dataspace agreement cache.
|
|
825
|
+
*/
|
|
826
|
+
dataspaceAgreementCacheMutexTimeout?: string;
|
|
827
|
+
/**
|
|
828
|
+
* The number of times to retry failed data plane tasks.
|
|
829
|
+
*/
|
|
830
|
+
dataspaceRetryCount?: string;
|
|
831
|
+
/**
|
|
832
|
+
* Maximum HTTP retry attempts per push delivery task execution.
|
|
833
|
+
*/
|
|
834
|
+
dataspacePushRetryCount?: string;
|
|
835
|
+
/**
|
|
836
|
+
* Base delay in milliseconds for exponential backoff between push HTTP retries.
|
|
837
|
+
*/
|
|
838
|
+
dataspacePushRetryBaseDelay?: string;
|
|
839
|
+
/**
|
|
840
|
+
* Timeout in milliseconds for each push delivery HTTP POST request.
|
|
841
|
+
*/
|
|
842
|
+
dataspacePushTimeout?: string;
|
|
843
|
+
/**
|
|
844
|
+
* Interval in milliseconds between orphaned push subscription cleanup scans.
|
|
845
|
+
*/
|
|
846
|
+
dataspacePushSubscriptionCleanupInterval?: string;
|
|
666
847
|
/**
|
|
667
848
|
* Base route path for the data plane service (path only, not full URL).
|
|
668
849
|
* Combined with the public origin to form the `dataAddress.endpoint` sent to PULL consumers
|
|
669
850
|
* and the inbox URL sent to PUSH providers.
|
|
670
851
|
*
|
|
671
852
|
* This must be the mount-point prefix of the data plane routes, NOT a specific route path.
|
|
672
|
-
* Do NOT append sub-paths such as `/entities` or `/inbox`
|
|
853
|
+
* Do NOT append sub-paths such as `/entities` or `/inbox` - those are appended automatically
|
|
673
854
|
* by each transfer handler and by the data plane REST client.
|
|
674
855
|
*
|
|
675
856
|
* REQUIRED if PULL or PUSH transfers are supported.
|
|
@@ -695,6 +876,14 @@ export interface IEngineEnvironmentVariables {
|
|
|
695
876
|
* @default 30
|
|
696
877
|
*/
|
|
697
878
|
dataspaceStalledTransferTimeout?: string;
|
|
879
|
+
/**
|
|
880
|
+
* How long in seconds a provider transfer may stay idle before the idle policy marks it as stalled.
|
|
881
|
+
*/
|
|
882
|
+
dataspaceProviderTransferIdleTimeout?: string;
|
|
883
|
+
/**
|
|
884
|
+
* How frequently in seconds the provider idle transfer policy sweep runs.
|
|
885
|
+
*/
|
|
886
|
+
dataspaceProviderTransferPolicySweepInterval?: string;
|
|
698
887
|
/**
|
|
699
888
|
* Path under which the dataspace control plane is mounted (path only, not full URL).
|
|
700
889
|
* This must match the control-plane REST mount, as it is combined with the public
|
|
@@ -715,6 +904,10 @@ export interface IEngineEnvironmentVariables {
|
|
|
715
904
|
* This allows components that take a long time to initialize to be healthy before the first health check is performed.
|
|
716
905
|
*/
|
|
717
906
|
healthStartupInterval?: string;
|
|
907
|
+
/**
|
|
908
|
+
* The interval in seconds for running the application health lifecycle (init, application, teardown), defaults to 300.
|
|
909
|
+
*/
|
|
910
|
+
healthApplicationInterval?: string;
|
|
718
911
|
/**
|
|
719
912
|
* The type of the automation action to create, comma separate for more than one connector.
|
|
720
913
|
* values: fetch
|
|
@@ -723,7 +916,7 @@ export interface IEngineEnvironmentVariables {
|
|
|
723
916
|
/**
|
|
724
917
|
* The default mutex timeout in milliseconds, used when no component-specific timeout is set, defaults to 5000 if omitted.
|
|
725
918
|
*/
|
|
726
|
-
|
|
919
|
+
mutexTimeoutDefault?: string;
|
|
727
920
|
/**
|
|
728
921
|
* The mutex timeout in milliseconds for the auditable item graph component.
|
|
729
922
|
*/
|
|
@@ -745,13 +938,9 @@ export interface IEngineEnvironmentVariables {
|
|
|
745
938
|
*/
|
|
746
939
|
loggingMutexTimeout?: string;
|
|
747
940
|
/**
|
|
748
|
-
* The mutex timeout in milliseconds for the memory entity storage
|
|
749
|
-
*/
|
|
750
|
-
entityStorageMemoryMutexTimeout?: string;
|
|
751
|
-
/**
|
|
752
|
-
* The mutex timeout in milliseconds for the file entity storage connector.
|
|
941
|
+
* The mutex timeout in milliseconds for the memory and file entity storage connectors.
|
|
753
942
|
*/
|
|
754
|
-
|
|
943
|
+
entityStorageMutexTimeout?: string;
|
|
755
944
|
/**
|
|
756
945
|
* The mutex timeout in milliseconds for the rights management component.
|
|
757
946
|
*/
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { IBootstrapDevEnvironmentVariables } from "./IBootstrapDevEnvironmentVariables.js";
|
|
2
2
|
import type { IEngineEnvironmentVariables } from "./IEngineEnvironmentVariables.js";
|
|
3
3
|
import type { IEngineServerEnvironmentVariables } from "./IEngineServerEnvironmentVariables.js";
|
|
4
4
|
import type { INodeEnvironmentVariables } from "./INodeEnvironmentVariables.js";
|
|
5
5
|
/**
|
|
6
6
|
* The environment variables.
|
|
7
7
|
*/
|
|
8
|
-
export type IEnvironmentVariables =
|
|
8
|
+
export type IEnvironmentVariables = IBootstrapDevEnvironmentVariables & INodeEnvironmentVariables & IEngineEnvironmentVariables & IEngineServerEnvironmentVariables;
|
package/dist/types/node.d.ts
CHANGED
|
@@ -7,7 +7,7 @@ import type { INodeEngineConfig } from "./models/INodeEngineConfig.js";
|
|
|
7
7
|
import type { INodeEngineState } from "./models/INodeEngineState.js";
|
|
8
8
|
import type { INodeOptions } from "./models/INodeOptions.js";
|
|
9
9
|
/**
|
|
10
|
-
* Run the
|
|
10
|
+
* Run the node.
|
|
11
11
|
* @param nodeOptions Optional configuration options for running the server.
|
|
12
12
|
* @param args Optional command line arguments.
|
|
13
13
|
* @returns A promise that resolves when the server is started containing a shutdown method.
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,77 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.9.2-next.11](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.2-next.10...node-core-v0.9.2-next.11) (2026-08-14)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* add tenant override ([#337](https://github.com/iotaledger/twin-node/issues/337)) ([b4ea765](https://github.com/iotaledger/twin-node/commit/b4ea7656e2557c19053365dd5d4af14d0d945cd5))
|
|
9
|
+
|
|
10
|
+
## [0.9.2-next.10](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.2-next.9...node-core-v0.9.2-next.10) (2026-08-12)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
|
|
15
|
+
* update dependencies ([34a5d51](https://github.com/iotaledger/twin-node/commit/34a5d5100140f6e642e8aaa1b4da5304b8ce6f0a))
|
|
16
|
+
|
|
17
|
+
## [0.9.2-next.9](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.2-next.8...node-core-v0.9.2-next.9) (2026-08-12)
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Features
|
|
21
|
+
|
|
22
|
+
* pool env vars ([#331](https://github.com/iotaledger/twin-node/issues/331)) ([338ea61](https://github.com/iotaledger/twin-node/commit/338ea612b37aa4d15971c8a09def47bee9395d0c))
|
|
23
|
+
|
|
24
|
+
## [0.9.2-next.8](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.2-next.7...node-core-v0.9.2-next.8) (2026-08-11)
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
### Features
|
|
28
|
+
|
|
29
|
+
* add additional env vars ([#328](https://github.com/iotaledger/twin-node/issues/328)) ([6ca8718](https://github.com/iotaledger/twin-node/commit/6ca87184bc4d78829c957ea055d3c281aca6cf9f))
|
|
30
|
+
|
|
31
|
+
## [0.9.2-next.7](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.2-next.6...node-core-v0.9.2-next.7) (2026-08-10)
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
### Features
|
|
35
|
+
|
|
36
|
+
* additional env vars and validation ([#324](https://github.com/iotaledger/twin-node/issues/324)) ([6b01e8c](https://github.com/iotaledger/twin-node/commit/6b01e8c10f9aa7181f51f13534d8164db3e7322d))
|
|
37
|
+
|
|
38
|
+
## [0.9.2-next.6](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.2-next.5...node-core-v0.9.2-next.6) (2026-08-07)
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
### Features
|
|
42
|
+
|
|
43
|
+
* add tracing support ([a4986fc](https://github.com/iotaledger/twin-node/commit/a4986fc4af603ee461ec8d18ff502dddbc43edec))
|
|
44
|
+
* register task scheduler when immutable proof is enabled ([#320](https://github.com/iotaledger/twin-node/issues/320)) ([b1d9c81](https://github.com/iotaledger/twin-node/commit/b1d9c81e0ec267292c6eaba8a6228eff1c41a9f0))
|
|
45
|
+
* update docs ([61e5a00](https://github.com/iotaledger/twin-node/commit/61e5a004089a0c11ec03e354b076604ecdeb4817))
|
|
46
|
+
|
|
47
|
+
## [0.9.2-next.5](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.2-next.4...node-core-v0.9.2-next.5) (2026-08-03)
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
### Features
|
|
51
|
+
|
|
52
|
+
* update dependencies ([#316](https://github.com/iotaledger/twin-node/issues/316)) ([f3fe328](https://github.com/iotaledger/twin-node/commit/f3fe3281a80f34763c923eacca58364273a550b7))
|
|
53
|
+
|
|
54
|
+
## [0.9.2-next.4](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.2-next.3...node-core-v0.9.2-next.4) (2026-08-03)
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
### Bug Fixes
|
|
58
|
+
|
|
59
|
+
* wire includeErrorStack debug flag into auth and tenant processor configs ([#313](https://github.com/iotaledger/twin-node/issues/313)) ([3c69c51](https://github.com/iotaledger/twin-node/commit/3c69c51bfdd65305efe2fbe9da508e684a4245d1))
|
|
60
|
+
|
|
61
|
+
## [0.9.2-next.3](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.2-next.2...node-core-v0.9.2-next.3) (2026-07-30)
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
### Features
|
|
65
|
+
|
|
66
|
+
* bootstrap-legacy rename ([#310](https://github.com/iotaledger/twin-node/issues/310)) ([53af8a2](https://github.com/iotaledger/twin-node/commit/53af8a2e797e90bb601416215247cd8649dd6220))
|
|
67
|
+
|
|
68
|
+
## [0.9.2-next.2](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.2-next.1...node-core-v0.9.2-next.2) (2026-07-29)
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
### Features
|
|
72
|
+
|
|
73
|
+
* immutable proof config ([#307](https://github.com/iotaledger/twin-node/issues/307)) ([9257495](https://github.com/iotaledger/twin-node/commit/92574953329647756aa6ab4cca80b1707e14a33f))
|
|
74
|
+
|
|
3
75
|
## [0.9.2-next.1](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.2-next.0...node-core-v0.9.2-next.1) (2026-07-28)
|
|
4
76
|
|
|
5
77
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Function: buildConfiguration()
|
|
2
2
|
|
|
3
|
-
> **buildConfiguration**(`processEnv`, `options`, `serverInfo`): `Promise`\<\{ `nodeEnvVars`: [`
|
|
3
|
+
> **buildConfiguration**(`processEnv`, `options`, `serverInfo`): `Promise`\<\{ `nodeEnvVars`: [`IBootstrapDevEnvironmentVariables`](../interfaces/IBootstrapDevEnvironmentVariables.md) & [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md) & [`IEngineEnvironmentVariables`](../interfaces/IEngineEnvironmentVariables.md) & [`IEngineServerEnvironmentVariables`](../interfaces/IEngineServerEnvironmentVariables.md) & `object`; `nodeEngineConfig`: [`INodeEngineConfig`](../interfaces/INodeEngineConfig.md); `availableContextIdKeys`: `object`[]; \}\>
|
|
4
4
|
|
|
5
5
|
Build the configuration for the TWIN Node.
|
|
6
6
|
|
|
@@ -24,7 +24,7 @@ The server information.
|
|
|
24
24
|
|
|
25
25
|
## Returns
|
|
26
26
|
|
|
27
|
-
`Promise`\<\{ `nodeEnvVars`: [`
|
|
27
|
+
`Promise`\<\{ `nodeEnvVars`: [`IBootstrapDevEnvironmentVariables`](../interfaces/IBootstrapDevEnvironmentVariables.md) & [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md) & [`IEngineEnvironmentVariables`](../interfaces/IEngineEnvironmentVariables.md) & [`IEngineServerEnvironmentVariables`](../interfaces/IEngineServerEnvironmentVariables.md) & `object`; `nodeEngineConfig`: [`INodeEngineConfig`](../interfaces/INodeEngineConfig.md); `availableContextIdKeys`: `object`[]; \}\>
|
|
28
28
|
|
|
29
29
|
A promise that resolves to the engine server configuration, environment prefix, environment variables,
|
|
30
30
|
and options.
|
|
@@ -8,7 +8,7 @@ Handles the configuration of the server.
|
|
|
8
8
|
|
|
9
9
|
### envVars
|
|
10
10
|
|
|
11
|
-
[`
|
|
11
|
+
[`IBootstrapDevEnvironmentVariables`](../interfaces/IBootstrapDevEnvironmentVariables.md) & [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md) & [`IEngineEnvironmentVariables`](../interfaces/IEngineEnvironmentVariables.md) & [`IEngineServerEnvironmentVariables`](../interfaces/IEngineServerEnvironmentVariables.md) & `object`
|
|
12
12
|
|
|
13
13
|
The environment variables for the engine server.
|
|
14
14
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **run**(`nodeOptions?`, `args?`): `Promise`\<\{ `engine`: `Engine`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>; `server`: `EngineServer`; `shutdown`: () => `Promise`\<`void`\>; \} \| `undefined`\>
|
|
4
4
|
|
|
5
|
-
Run the
|
|
5
|
+
Run the node.
|
|
6
6
|
|
|
7
7
|
## Parameters
|
|
8
8
|
|
|
@@ -20,7 +20,7 @@ The configuration for the engine server.
|
|
|
20
20
|
|
|
21
21
|
### envVars
|
|
22
22
|
|
|
23
|
-
[`
|
|
23
|
+
[`IBootstrapDevEnvironmentVariables`](../interfaces/IBootstrapDevEnvironmentVariables.md) & [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md) & [`IEngineEnvironmentVariables`](../interfaces/IEngineEnvironmentVariables.md) & [`IEngineServerEnvironmentVariables`](../interfaces/IEngineServerEnvironmentVariables.md)
|
|
24
24
|
|
|
25
25
|
The environment variables.
|
|
26
26
|
|
package/docs/reference/index.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
## Interfaces
|
|
4
4
|
|
|
5
|
-
- [
|
|
5
|
+
- [IBootstrapDevEnvironmentVariables](interfaces/IBootstrapDevEnvironmentVariables.md)
|
|
6
6
|
- [ICacheMetadata](interfaces/ICacheMetadata.md)
|
|
7
7
|
- [ICliArgs](interfaces/ICliArgs.md)
|
|
8
8
|
- [ICliCommand](interfaces/ICliCommand.md)
|