@twin.org/node-core 0.0.2-next.3 → 0.0.2-next.5
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/cjs/index.cjs +263 -162
- package/dist/esm/index.mjs +264 -163
- package/dist/types/bootstrap.d.ts +9 -9
- package/dist/types/builders/engineServerEnvBuilder.d.ts +2 -1
- package/dist/types/models/IEngineEnvironmentVariables.d.ts +63 -9
- package/dist/types/models/INodeOptions.d.ts +4 -0
- package/dist/types/models/nodeFeatures.d.ts +4 -0
- package/docs/changelog.md +14 -0
- package/docs/reference/functions/{bootstrapAttestationMethod.md → bootstrapSynchronisedStorage.md} +3 -3
- package/docs/reference/functions/buildEngineServerConfiguration.md +7 -1
- package/docs/reference/index.md +1 -1
- package/docs/reference/interfaces/IEngineEnvironmentVariables.md +133 -15
- package/docs/reference/interfaces/INodeEnvironmentVariables.md +183 -21
- package/docs/reference/interfaces/INodeOptions.md +8 -0
- package/docs/reference/variables/NodeFeatures.md +6 -0
- package/locales/en.json +6 -4
- package/package.json +2 -2
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { IEngineCore, IEngineCoreContext, IEngineState } from "@twin.org/engine-models";
|
|
2
|
-
import type
|
|
2
|
+
import { type IEngineServerConfig } from "@twin.org/engine-server-types";
|
|
3
3
|
import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables";
|
|
4
4
|
import { NodeFeatures } from "./models/nodeFeatures";
|
|
5
5
|
/**
|
|
@@ -25,14 +25,6 @@ export declare function bootstrapNodeIdentity(engineCore: IEngineCore, context:
|
|
|
25
25
|
* @param features The features that are enabled on the node.
|
|
26
26
|
*/
|
|
27
27
|
export declare function bootstrapNodeUser(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, IEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
|
|
28
|
-
/**
|
|
29
|
-
* Bootstrap the attestation verification methods.
|
|
30
|
-
* @param engineCore The engine core for the node.
|
|
31
|
-
* @param context The context for the node.
|
|
32
|
-
* @param envVars The environment variables for the node.
|
|
33
|
-
* @param features The features that are enabled on the node.
|
|
34
|
-
*/
|
|
35
|
-
export declare function bootstrapAttestationMethod(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, IEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
|
|
36
28
|
/**
|
|
37
29
|
* Bootstrap the immutable proof verification methods.
|
|
38
30
|
* @param engineCore The engine core for the node.
|
|
@@ -57,3 +49,11 @@ export declare function bootstrapBlobEncryption(engineCore: IEngineCore, context
|
|
|
57
49
|
* @param features The features that are enabled on the node.
|
|
58
50
|
*/
|
|
59
51
|
export declare function bootstrapAuth(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, IEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
|
|
52
|
+
/**
|
|
53
|
+
* Bootstrap the synchronised storage blob encryption and verification methods.
|
|
54
|
+
* @param engineCore The engine core for the node.
|
|
55
|
+
* @param context The context for the node.
|
|
56
|
+
* @param envVars The environment variables for the node.
|
|
57
|
+
* @param features The features that are enabled on the node.
|
|
58
|
+
*/
|
|
59
|
+
export declare function bootstrapSynchronisedStorage(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, IEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
|
|
@@ -8,6 +8,7 @@ import type { IEngineServerEnvironmentVariables } from "../models/IEngineServerE
|
|
|
8
8
|
* @param coreEngineConfig The core engine config.
|
|
9
9
|
* @param serverInfo The server information.
|
|
10
10
|
* @param openApiSpecPath The path to the open api spec.
|
|
11
|
+
* @param favIconPath The path to the favicon.
|
|
11
12
|
* @returns The the config for the core and the server.
|
|
12
13
|
*/
|
|
13
|
-
export declare function buildEngineServerConfiguration(envVars: IEngineServerEnvironmentVariables, coreEngineConfig: IEngineCoreConfig, serverInfo: IServerInfo, openApiSpecPath?: string): IEngineServerConfig;
|
|
14
|
+
export declare function buildEngineServerConfiguration(envVars: IEngineServerEnvironmentVariables, coreEngineConfig: IEngineCoreConfig, serverInfo: IServerInfo, openApiSpecPath?: string, favIconPath?: string): IEngineServerConfig;
|
|
@@ -23,10 +23,6 @@ export interface IEngineEnvironmentVariables {
|
|
|
23
23
|
* The default entity storage connector to use, defaults to the first one in the list.
|
|
24
24
|
*/
|
|
25
25
|
entityStorageConnectorDefault?: string;
|
|
26
|
-
/**
|
|
27
|
-
* Entity storage connector for decentralized storage
|
|
28
|
-
*/
|
|
29
|
-
entityStorageConnectorDecentralised?: string;
|
|
30
26
|
/**
|
|
31
27
|
* A prefix for all the table in entity-storage, can be empty.
|
|
32
28
|
*/
|
|
@@ -177,17 +173,22 @@ export interface IEngineEnvironmentVariables {
|
|
|
177
173
|
*/
|
|
178
174
|
blobStorageConnectorDefault?: string;
|
|
179
175
|
/**
|
|
180
|
-
* Blog storage connector
|
|
176
|
+
* Blog storage connector which has public access.
|
|
181
177
|
*/
|
|
182
|
-
|
|
178
|
+
blobStorageConnectorPublic?: string;
|
|
183
179
|
/**
|
|
184
180
|
* Enable encryption for the blob storage.
|
|
185
181
|
*/
|
|
186
182
|
blobStorageEnableEncryption?: string;
|
|
187
183
|
/**
|
|
188
|
-
* The encryption key for the blob storage.
|
|
184
|
+
* The id of the encryption key for the blob storage.
|
|
185
|
+
*/
|
|
186
|
+
blobStorageEncryptionKeyId?: string;
|
|
187
|
+
/**
|
|
188
|
+
* A symmetric encryption key for the blob storage, should be ChaCha20Poly1305 in base64 format.
|
|
189
|
+
* If encryption is enabled but a key is not provided one will be generated.
|
|
189
190
|
*/
|
|
190
|
-
|
|
191
|
+
blobStorageSymmetricEncryptionKey?: string;
|
|
191
192
|
/**
|
|
192
193
|
* A prefix for all the blobs in blob-storage, can be empty.
|
|
193
194
|
*/
|
|
@@ -376,6 +377,59 @@ export interface IEngineEnvironmentVariables {
|
|
|
376
377
|
* The type of the default data extractor, can be a comma separated list: json-path.
|
|
377
378
|
*/
|
|
378
379
|
dataExtractorConnectors?: string;
|
|
380
|
+
/**
|
|
381
|
+
* Is the synchronised storage enabled, defaults to false.
|
|
382
|
+
*/
|
|
383
|
+
synchronisedStorageEnabled?: string;
|
|
384
|
+
/**
|
|
385
|
+
* Url which points to the api for a trusted synchronised storage node, not required if this is a trusted node.
|
|
386
|
+
*/
|
|
387
|
+
synchronisedStorageTrustedUrl?: string;
|
|
388
|
+
/**
|
|
389
|
+
* The key for the smart contract which contains the verifiable storage pointer store for synchronised storage.
|
|
390
|
+
* This only required if using a custom verifiable storage item, otherwise it will default the the network name.
|
|
391
|
+
*/
|
|
392
|
+
synchronisedStorageVerifiableStorageKeyId?: string;
|
|
393
|
+
/**
|
|
394
|
+
* The identity verification method id to use with synchronised storage for signing/verifying changesets.
|
|
395
|
+
* Defaults to synchronised-storage-assertion.
|
|
396
|
+
*/
|
|
397
|
+
synchronisedStorageVerificationMethodId?: string;
|
|
398
|
+
/**
|
|
399
|
+
* The key from the vault which is used to encrypt the synchronised storage blobs.
|
|
400
|
+
* Only required for trusted nodes, as regular nodes will request from the trusted nodes.
|
|
401
|
+
* Defaults to synchronised-storage-blob-encryption
|
|
402
|
+
*/
|
|
403
|
+
synchronisedStorageBlobStorageEncryptionKeyId?: string;
|
|
404
|
+
/**
|
|
405
|
+
* The key used for blob encryption, should be ChaCha20Poly1305 encoded as base64.
|
|
406
|
+
* Only required for trusted nodes, as regular nodes will not write encrypted data.
|
|
407
|
+
*/
|
|
408
|
+
synchronisedStorageBlobStorageKey?: string;
|
|
409
|
+
/**
|
|
410
|
+
* How often to check for entity updates in minutes.
|
|
411
|
+
* @default 5
|
|
412
|
+
*/
|
|
413
|
+
synchronisedStorageEntityUpdateIntervalMinutes?: string;
|
|
414
|
+
/**
|
|
415
|
+
* Interval to perform consolidation of changesets, only used if this is a trusted node.
|
|
416
|
+
* @default 60
|
|
417
|
+
*/
|
|
418
|
+
synchronisedStorageConsolidationIntervalMinutes?: string;
|
|
419
|
+
/**
|
|
420
|
+
* The number of entities to process in a single consolidation batch, only used if this is a trusted node.
|
|
421
|
+
* @default 1000
|
|
422
|
+
*/
|
|
423
|
+
synchronisedStorageConsolidationBatchSize?: string;
|
|
424
|
+
/**
|
|
425
|
+
* The maximum number of consolidations to keep in storage, only used if this is a trusted node.
|
|
426
|
+
* @default 5
|
|
427
|
+
*/
|
|
428
|
+
synchronisedStorageMaxConsolidations?: string;
|
|
429
|
+
/**
|
|
430
|
+
* Is the federated catalogue enabled, defaults to false.
|
|
431
|
+
*/
|
|
432
|
+
federatedCatalogueEnabled?: string;
|
|
379
433
|
/**
|
|
380
434
|
* Federated catalog TTL for the cache.
|
|
381
435
|
*/
|
|
@@ -389,7 +443,7 @@ export interface IEngineEnvironmentVariables {
|
|
|
389
443
|
*/
|
|
390
444
|
rightsManagementEnabled?: string;
|
|
391
445
|
/**
|
|
392
|
-
* Is the task scheduler enabled, defaults to
|
|
446
|
+
* Is the task scheduler enabled, defaults to false.
|
|
393
447
|
*/
|
|
394
448
|
taskSchedulerEnabled?: string;
|
|
395
449
|
}
|
|
@@ -45,6 +45,10 @@ export interface INodeOptions {
|
|
|
45
45
|
* The path to the OpenAPI spec file, defaults to docs/open-api/spec.json.
|
|
46
46
|
*/
|
|
47
47
|
openApiSpecFile?: string;
|
|
48
|
+
/**
|
|
49
|
+
* The path to the favicon, defaults to static/favicon.png.
|
|
50
|
+
*/
|
|
51
|
+
favIconFile?: string;
|
|
48
52
|
/**
|
|
49
53
|
* Method to extend the engine environment variables with any additional custom configuration.
|
|
50
54
|
*/
|
|
@@ -10,6 +10,10 @@ export declare const NodeFeatures: {
|
|
|
10
10
|
* NodeUser - generates a user for the node if not provided in config.
|
|
11
11
|
*/
|
|
12
12
|
readonly NodeUser: "node-user";
|
|
13
|
+
/**
|
|
14
|
+
* NodeWallet - generates a wallet for the node and funds it when there is a faucet available.
|
|
15
|
+
*/
|
|
16
|
+
readonly NodeWallet: "node-wallet";
|
|
13
17
|
};
|
|
14
18
|
/**
|
|
15
19
|
* The features that can be enabled on the node.
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# @twin.org/node-core - Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.2-next.5](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.4...node-core-v0.0.2-next.5) (2025-08-21)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* update framework core ([8bd769a](https://github.com/twinfoundation/node/commit/8bd769a4451f5f1f6be3f115a5e94eeb05bce7f1))
|
|
9
|
+
|
|
10
|
+
## [0.0.2-next.4](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.3...node-core-v0.0.2-next.4) (2025-08-14)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
|
|
15
|
+
* add synchronised storage config ([e315869](https://github.com/twinfoundation/node/commit/e315869adbffcd7fe5d3ce151dd35f662f6134a9))
|
|
16
|
+
|
|
3
17
|
## [0.0.2-next.3](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.2...node-core-v0.0.2-next.3) (2025-07-21)
|
|
4
18
|
|
|
5
19
|
|
package/docs/reference/functions/{bootstrapAttestationMethod.md → bootstrapSynchronisedStorage.md}
RENAMED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
# Function:
|
|
1
|
+
# Function: bootstrapSynchronisedStorage()
|
|
2
2
|
|
|
3
|
-
> **
|
|
3
|
+
> **bootstrapSynchronisedStorage**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
|
|
4
4
|
|
|
5
|
-
Bootstrap the
|
|
5
|
+
Bootstrap the synchronised storage blob encryption and verification methods.
|
|
6
6
|
|
|
7
7
|
## Parameters
|
|
8
8
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Function: buildEngineServerConfiguration()
|
|
2
2
|
|
|
3
|
-
> **buildEngineServerConfiguration**(`envVars`, `coreEngineConfig`, `serverInfo`, `openApiSpecPath?`): `IEngineServerConfig`
|
|
3
|
+
> **buildEngineServerConfiguration**(`envVars`, `coreEngineConfig`, `serverInfo`, `openApiSpecPath?`, `favIconPath?`): `IEngineServerConfig`
|
|
4
4
|
|
|
5
5
|
Handles the configuration of the server.
|
|
6
6
|
|
|
@@ -30,6 +30,12 @@ The server information.
|
|
|
30
30
|
|
|
31
31
|
The path to the open api spec.
|
|
32
32
|
|
|
33
|
+
### favIconPath?
|
|
34
|
+
|
|
35
|
+
`string`
|
|
36
|
+
|
|
37
|
+
The path to the favicon.
|
|
38
|
+
|
|
33
39
|
## Returns
|
|
34
40
|
|
|
35
41
|
`IEngineServerConfig`
|
package/docs/reference/index.md
CHANGED
|
@@ -20,10 +20,10 @@
|
|
|
20
20
|
- [bootstrap](functions/bootstrap.md)
|
|
21
21
|
- [bootstrapNodeIdentity](functions/bootstrapNodeIdentity.md)
|
|
22
22
|
- [bootstrapNodeUser](functions/bootstrapNodeUser.md)
|
|
23
|
-
- [bootstrapAttestationMethod](functions/bootstrapAttestationMethod.md)
|
|
24
23
|
- [bootstrapImmutableProofMethod](functions/bootstrapImmutableProofMethod.md)
|
|
25
24
|
- [bootstrapBlobEncryption](functions/bootstrapBlobEncryption.md)
|
|
26
25
|
- [bootstrapAuth](functions/bootstrapAuth.md)
|
|
26
|
+
- [bootstrapSynchronisedStorage](functions/bootstrapSynchronisedStorage.md)
|
|
27
27
|
- [buildEngineConfiguration](functions/buildEngineConfiguration.md)
|
|
28
28
|
- [buildEngineServerConfiguration](functions/buildEngineServerConfiguration.md)
|
|
29
29
|
- [run](functions/run.md)
|
|
@@ -49,14 +49,6 @@ The default entity storage connector to use, defaults to the first one in the li
|
|
|
49
49
|
|
|
50
50
|
***
|
|
51
51
|
|
|
52
|
-
### entityStorageConnectorDecentralised?
|
|
53
|
-
|
|
54
|
-
> `optional` **entityStorageConnectorDecentralised**: `string`
|
|
55
|
-
|
|
56
|
-
Entity storage connector for decentralized storage
|
|
57
|
-
|
|
58
|
-
***
|
|
59
|
-
|
|
60
52
|
### entityStorageTablePrefix?
|
|
61
53
|
|
|
62
54
|
> `optional` **entityStorageTablePrefix**: `string`
|
|
@@ -354,11 +346,11 @@ The default blob storage connector to use, defaults to the first one in the list
|
|
|
354
346
|
|
|
355
347
|
***
|
|
356
348
|
|
|
357
|
-
###
|
|
349
|
+
### blobStorageConnectorPublic?
|
|
358
350
|
|
|
359
|
-
> `optional` **
|
|
351
|
+
> `optional` **blobStorageConnectorPublic**: `string`
|
|
360
352
|
|
|
361
|
-
Blog storage connector
|
|
353
|
+
Blog storage connector which has public access.
|
|
362
354
|
|
|
363
355
|
***
|
|
364
356
|
|
|
@@ -370,11 +362,20 @@ Enable encryption for the blob storage.
|
|
|
370
362
|
|
|
371
363
|
***
|
|
372
364
|
|
|
373
|
-
###
|
|
365
|
+
### blobStorageEncryptionKeyId?
|
|
366
|
+
|
|
367
|
+
> `optional` **blobStorageEncryptionKeyId**: `string`
|
|
368
|
+
|
|
369
|
+
The id of the encryption key for the blob storage.
|
|
370
|
+
|
|
371
|
+
***
|
|
372
|
+
|
|
373
|
+
### blobStorageSymmetricEncryptionKey?
|
|
374
374
|
|
|
375
|
-
> `optional` **
|
|
375
|
+
> `optional` **blobStorageSymmetricEncryptionKey**: `string`
|
|
376
376
|
|
|
377
|
-
|
|
377
|
+
A symmetric encryption key for the blob storage, should be ChaCha20Poly1305 in base64 format.
|
|
378
|
+
If encryption is enabled but a key is not provided one will be generated.
|
|
378
379
|
|
|
379
380
|
***
|
|
380
381
|
|
|
@@ -754,6 +755,123 @@ The type of the default data extractor, can be a comma separated list: json-path
|
|
|
754
755
|
|
|
755
756
|
***
|
|
756
757
|
|
|
758
|
+
### synchronisedStorageEnabled?
|
|
759
|
+
|
|
760
|
+
> `optional` **synchronisedStorageEnabled**: `string`
|
|
761
|
+
|
|
762
|
+
Is the synchronised storage enabled, defaults to false.
|
|
763
|
+
|
|
764
|
+
***
|
|
765
|
+
|
|
766
|
+
### synchronisedStorageTrustedUrl?
|
|
767
|
+
|
|
768
|
+
> `optional` **synchronisedStorageTrustedUrl**: `string`
|
|
769
|
+
|
|
770
|
+
Url which points to the api for a trusted synchronised storage node, not required if this is a trusted node.
|
|
771
|
+
|
|
772
|
+
***
|
|
773
|
+
|
|
774
|
+
### synchronisedStorageVerifiableStorageKeyId?
|
|
775
|
+
|
|
776
|
+
> `optional` **synchronisedStorageVerifiableStorageKeyId**: `string`
|
|
777
|
+
|
|
778
|
+
The key for the smart contract which contains the verifiable storage pointer store for synchronised storage.
|
|
779
|
+
This only required if using a custom verifiable storage item, otherwise it will default the the network name.
|
|
780
|
+
|
|
781
|
+
***
|
|
782
|
+
|
|
783
|
+
### synchronisedStorageVerificationMethodId?
|
|
784
|
+
|
|
785
|
+
> `optional` **synchronisedStorageVerificationMethodId**: `string`
|
|
786
|
+
|
|
787
|
+
The identity verification method id to use with synchronised storage for signing/verifying changesets.
|
|
788
|
+
Defaults to synchronised-storage-assertion.
|
|
789
|
+
|
|
790
|
+
***
|
|
791
|
+
|
|
792
|
+
### synchronisedStorageBlobStorageEncryptionKeyId?
|
|
793
|
+
|
|
794
|
+
> `optional` **synchronisedStorageBlobStorageEncryptionKeyId**: `string`
|
|
795
|
+
|
|
796
|
+
The key from the vault which is used to encrypt the synchronised storage blobs.
|
|
797
|
+
Only required for trusted nodes, as regular nodes will request from the trusted nodes.
|
|
798
|
+
Defaults to synchronised-storage-blob-encryption
|
|
799
|
+
|
|
800
|
+
***
|
|
801
|
+
|
|
802
|
+
### synchronisedStorageBlobStorageKey?
|
|
803
|
+
|
|
804
|
+
> `optional` **synchronisedStorageBlobStorageKey**: `string`
|
|
805
|
+
|
|
806
|
+
The key used for blob encryption, should be ChaCha20Poly1305 encoded as base64.
|
|
807
|
+
Only required for trusted nodes, as regular nodes will not write encrypted data.
|
|
808
|
+
|
|
809
|
+
***
|
|
810
|
+
|
|
811
|
+
### synchronisedStorageEntityUpdateIntervalMinutes?
|
|
812
|
+
|
|
813
|
+
> `optional` **synchronisedStorageEntityUpdateIntervalMinutes**: `string`
|
|
814
|
+
|
|
815
|
+
How often to check for entity updates in minutes.
|
|
816
|
+
|
|
817
|
+
#### Default
|
|
818
|
+
|
|
819
|
+
```ts
|
|
820
|
+
5
|
|
821
|
+
```
|
|
822
|
+
|
|
823
|
+
***
|
|
824
|
+
|
|
825
|
+
### synchronisedStorageConsolidationIntervalMinutes?
|
|
826
|
+
|
|
827
|
+
> `optional` **synchronisedStorageConsolidationIntervalMinutes**: `string`
|
|
828
|
+
|
|
829
|
+
Interval to perform consolidation of changesets, only used if this is a trusted node.
|
|
830
|
+
|
|
831
|
+
#### Default
|
|
832
|
+
|
|
833
|
+
```ts
|
|
834
|
+
60
|
|
835
|
+
```
|
|
836
|
+
|
|
837
|
+
***
|
|
838
|
+
|
|
839
|
+
### synchronisedStorageConsolidationBatchSize?
|
|
840
|
+
|
|
841
|
+
> `optional` **synchronisedStorageConsolidationBatchSize**: `string`
|
|
842
|
+
|
|
843
|
+
The number of entities to process in a single consolidation batch, only used if this is a trusted node.
|
|
844
|
+
|
|
845
|
+
#### Default
|
|
846
|
+
|
|
847
|
+
```ts
|
|
848
|
+
1000
|
|
849
|
+
```
|
|
850
|
+
|
|
851
|
+
***
|
|
852
|
+
|
|
853
|
+
### synchronisedStorageMaxConsolidations?
|
|
854
|
+
|
|
855
|
+
> `optional` **synchronisedStorageMaxConsolidations**: `string`
|
|
856
|
+
|
|
857
|
+
The maximum number of consolidations to keep in storage, only used if this is a trusted node.
|
|
858
|
+
|
|
859
|
+
#### Default
|
|
860
|
+
|
|
861
|
+
```ts
|
|
862
|
+
5
|
|
863
|
+
```
|
|
864
|
+
|
|
865
|
+
***
|
|
866
|
+
|
|
867
|
+
### federatedCatalogueEnabled?
|
|
868
|
+
|
|
869
|
+
> `optional` **federatedCatalogueEnabled**: `string`
|
|
870
|
+
|
|
871
|
+
Is the federated catalogue enabled, defaults to false.
|
|
872
|
+
|
|
873
|
+
***
|
|
874
|
+
|
|
757
875
|
### federatedCatalogueCacheTtlMs?
|
|
758
876
|
|
|
759
877
|
> `optional` **federatedCatalogueCacheTtlMs**: `number`
|
|
@@ -782,4 +900,4 @@ Is the rights management enabled, defaults to false.
|
|
|
782
900
|
|
|
783
901
|
> `optional` **taskSchedulerEnabled**: `string`
|
|
784
902
|
|
|
785
|
-
Is the task scheduler enabled, defaults to
|
|
903
|
+
Is the task scheduler enabled, defaults to false.
|
|
@@ -69,18 +69,6 @@ The default entity storage connector to use, defaults to the first one in the li
|
|
|
69
69
|
|
|
70
70
|
***
|
|
71
71
|
|
|
72
|
-
### entityStorageConnectorDecentralised?
|
|
73
|
-
|
|
74
|
-
> `optional` **entityStorageConnectorDecentralised**: `string`
|
|
75
|
-
|
|
76
|
-
Entity storage connector for decentralized storage
|
|
77
|
-
|
|
78
|
-
#### Inherited from
|
|
79
|
-
|
|
80
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`entityStorageConnectorDecentralised`](IEngineEnvironmentVariables.md#entitystorageconnectordecentralised)
|
|
81
|
-
|
|
82
|
-
***
|
|
83
|
-
|
|
84
72
|
### entityStorageTablePrefix?
|
|
85
73
|
|
|
86
74
|
> `optional` **entityStorageTablePrefix**: `string`
|
|
@@ -526,15 +514,15 @@ The default blob storage connector to use, defaults to the first one in the list
|
|
|
526
514
|
|
|
527
515
|
***
|
|
528
516
|
|
|
529
|
-
###
|
|
517
|
+
### blobStorageConnectorPublic?
|
|
530
518
|
|
|
531
|
-
> `optional` **
|
|
519
|
+
> `optional` **blobStorageConnectorPublic**: `string`
|
|
532
520
|
|
|
533
|
-
Blog storage connector
|
|
521
|
+
Blog storage connector which has public access.
|
|
534
522
|
|
|
535
523
|
#### Inherited from
|
|
536
524
|
|
|
537
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
525
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageConnectorPublic`](IEngineEnvironmentVariables.md#blobstorageconnectorpublic)
|
|
538
526
|
|
|
539
527
|
***
|
|
540
528
|
|
|
@@ -550,15 +538,28 @@ Enable encryption for the blob storage.
|
|
|
550
538
|
|
|
551
539
|
***
|
|
552
540
|
|
|
553
|
-
###
|
|
541
|
+
### blobStorageEncryptionKeyId?
|
|
542
|
+
|
|
543
|
+
> `optional` **blobStorageEncryptionKeyId**: `string`
|
|
544
|
+
|
|
545
|
+
The id of the encryption key for the blob storage.
|
|
546
|
+
|
|
547
|
+
#### Inherited from
|
|
548
|
+
|
|
549
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageEncryptionKeyId`](IEngineEnvironmentVariables.md#blobstorageencryptionkeyid)
|
|
550
|
+
|
|
551
|
+
***
|
|
552
|
+
|
|
553
|
+
### blobStorageSymmetricEncryptionKey?
|
|
554
554
|
|
|
555
|
-
> `optional` **
|
|
555
|
+
> `optional` **blobStorageSymmetricEncryptionKey**: `string`
|
|
556
556
|
|
|
557
|
-
|
|
557
|
+
A symmetric encryption key for the blob storage, should be ChaCha20Poly1305 in base64 format.
|
|
558
|
+
If encryption is enabled but a key is not provided one will be generated.
|
|
558
559
|
|
|
559
560
|
#### Inherited from
|
|
560
561
|
|
|
561
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
562
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageSymmetricEncryptionKey`](IEngineEnvironmentVariables.md#blobstoragesymmetricencryptionkey)
|
|
562
563
|
|
|
563
564
|
***
|
|
564
565
|
|
|
@@ -1126,6 +1127,167 @@ The type of the default data extractor, can be a comma separated list: json-path
|
|
|
1126
1127
|
|
|
1127
1128
|
***
|
|
1128
1129
|
|
|
1130
|
+
### synchronisedStorageEnabled?
|
|
1131
|
+
|
|
1132
|
+
> `optional` **synchronisedStorageEnabled**: `string`
|
|
1133
|
+
|
|
1134
|
+
Is the synchronised storage enabled, defaults to false.
|
|
1135
|
+
|
|
1136
|
+
#### Inherited from
|
|
1137
|
+
|
|
1138
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageEnabled`](IEngineEnvironmentVariables.md#synchronisedstorageenabled)
|
|
1139
|
+
|
|
1140
|
+
***
|
|
1141
|
+
|
|
1142
|
+
### synchronisedStorageTrustedUrl?
|
|
1143
|
+
|
|
1144
|
+
> `optional` **synchronisedStorageTrustedUrl**: `string`
|
|
1145
|
+
|
|
1146
|
+
Url which points to the api for a trusted synchronised storage node, not required if this is a trusted node.
|
|
1147
|
+
|
|
1148
|
+
#### Inherited from
|
|
1149
|
+
|
|
1150
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageTrustedUrl`](IEngineEnvironmentVariables.md#synchronisedstoragetrustedurl)
|
|
1151
|
+
|
|
1152
|
+
***
|
|
1153
|
+
|
|
1154
|
+
### synchronisedStorageVerifiableStorageKeyId?
|
|
1155
|
+
|
|
1156
|
+
> `optional` **synchronisedStorageVerifiableStorageKeyId**: `string`
|
|
1157
|
+
|
|
1158
|
+
The key for the smart contract which contains the verifiable storage pointer store for synchronised storage.
|
|
1159
|
+
This only required if using a custom verifiable storage item, otherwise it will default the the network name.
|
|
1160
|
+
|
|
1161
|
+
#### Inherited from
|
|
1162
|
+
|
|
1163
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageVerifiableStorageKeyId`](IEngineEnvironmentVariables.md#synchronisedstorageverifiablestoragekeyid)
|
|
1164
|
+
|
|
1165
|
+
***
|
|
1166
|
+
|
|
1167
|
+
### synchronisedStorageVerificationMethodId?
|
|
1168
|
+
|
|
1169
|
+
> `optional` **synchronisedStorageVerificationMethodId**: `string`
|
|
1170
|
+
|
|
1171
|
+
The identity verification method id to use with synchronised storage for signing/verifying changesets.
|
|
1172
|
+
Defaults to synchronised-storage-assertion.
|
|
1173
|
+
|
|
1174
|
+
#### Inherited from
|
|
1175
|
+
|
|
1176
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageVerificationMethodId`](IEngineEnvironmentVariables.md#synchronisedstorageverificationmethodid)
|
|
1177
|
+
|
|
1178
|
+
***
|
|
1179
|
+
|
|
1180
|
+
### synchronisedStorageBlobStorageEncryptionKeyId?
|
|
1181
|
+
|
|
1182
|
+
> `optional` **synchronisedStorageBlobStorageEncryptionKeyId**: `string`
|
|
1183
|
+
|
|
1184
|
+
The key from the vault which is used to encrypt the synchronised storage blobs.
|
|
1185
|
+
Only required for trusted nodes, as regular nodes will request from the trusted nodes.
|
|
1186
|
+
Defaults to synchronised-storage-blob-encryption
|
|
1187
|
+
|
|
1188
|
+
#### Inherited from
|
|
1189
|
+
|
|
1190
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageBlobStorageEncryptionKeyId`](IEngineEnvironmentVariables.md#synchronisedstorageblobstorageencryptionkeyid)
|
|
1191
|
+
|
|
1192
|
+
***
|
|
1193
|
+
|
|
1194
|
+
### synchronisedStorageBlobStorageKey?
|
|
1195
|
+
|
|
1196
|
+
> `optional` **synchronisedStorageBlobStorageKey**: `string`
|
|
1197
|
+
|
|
1198
|
+
The key used for blob encryption, should be ChaCha20Poly1305 encoded as base64.
|
|
1199
|
+
Only required for trusted nodes, as regular nodes will not write encrypted data.
|
|
1200
|
+
|
|
1201
|
+
#### Inherited from
|
|
1202
|
+
|
|
1203
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageBlobStorageKey`](IEngineEnvironmentVariables.md#synchronisedstorageblobstoragekey)
|
|
1204
|
+
|
|
1205
|
+
***
|
|
1206
|
+
|
|
1207
|
+
### synchronisedStorageEntityUpdateIntervalMinutes?
|
|
1208
|
+
|
|
1209
|
+
> `optional` **synchronisedStorageEntityUpdateIntervalMinutes**: `string`
|
|
1210
|
+
|
|
1211
|
+
How often to check for entity updates in minutes.
|
|
1212
|
+
|
|
1213
|
+
#### Default
|
|
1214
|
+
|
|
1215
|
+
```ts
|
|
1216
|
+
5
|
|
1217
|
+
```
|
|
1218
|
+
|
|
1219
|
+
#### Inherited from
|
|
1220
|
+
|
|
1221
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageEntityUpdateIntervalMinutes`](IEngineEnvironmentVariables.md#synchronisedstorageentityupdateintervalminutes)
|
|
1222
|
+
|
|
1223
|
+
***
|
|
1224
|
+
|
|
1225
|
+
### synchronisedStorageConsolidationIntervalMinutes?
|
|
1226
|
+
|
|
1227
|
+
> `optional` **synchronisedStorageConsolidationIntervalMinutes**: `string`
|
|
1228
|
+
|
|
1229
|
+
Interval to perform consolidation of changesets, only used if this is a trusted node.
|
|
1230
|
+
|
|
1231
|
+
#### Default
|
|
1232
|
+
|
|
1233
|
+
```ts
|
|
1234
|
+
60
|
|
1235
|
+
```
|
|
1236
|
+
|
|
1237
|
+
#### Inherited from
|
|
1238
|
+
|
|
1239
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageConsolidationIntervalMinutes`](IEngineEnvironmentVariables.md#synchronisedstorageconsolidationintervalminutes)
|
|
1240
|
+
|
|
1241
|
+
***
|
|
1242
|
+
|
|
1243
|
+
### synchronisedStorageConsolidationBatchSize?
|
|
1244
|
+
|
|
1245
|
+
> `optional` **synchronisedStorageConsolidationBatchSize**: `string`
|
|
1246
|
+
|
|
1247
|
+
The number of entities to process in a single consolidation batch, only used if this is a trusted node.
|
|
1248
|
+
|
|
1249
|
+
#### Default
|
|
1250
|
+
|
|
1251
|
+
```ts
|
|
1252
|
+
1000
|
|
1253
|
+
```
|
|
1254
|
+
|
|
1255
|
+
#### Inherited from
|
|
1256
|
+
|
|
1257
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageConsolidationBatchSize`](IEngineEnvironmentVariables.md#synchronisedstorageconsolidationbatchsize)
|
|
1258
|
+
|
|
1259
|
+
***
|
|
1260
|
+
|
|
1261
|
+
### synchronisedStorageMaxConsolidations?
|
|
1262
|
+
|
|
1263
|
+
> `optional` **synchronisedStorageMaxConsolidations**: `string`
|
|
1264
|
+
|
|
1265
|
+
The maximum number of consolidations to keep in storage, only used if this is a trusted node.
|
|
1266
|
+
|
|
1267
|
+
#### Default
|
|
1268
|
+
|
|
1269
|
+
```ts
|
|
1270
|
+
5
|
|
1271
|
+
```
|
|
1272
|
+
|
|
1273
|
+
#### Inherited from
|
|
1274
|
+
|
|
1275
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageMaxConsolidations`](IEngineEnvironmentVariables.md#synchronisedstoragemaxconsolidations)
|
|
1276
|
+
|
|
1277
|
+
***
|
|
1278
|
+
|
|
1279
|
+
### federatedCatalogueEnabled?
|
|
1280
|
+
|
|
1281
|
+
> `optional` **federatedCatalogueEnabled**: `string`
|
|
1282
|
+
|
|
1283
|
+
Is the federated catalogue enabled, defaults to false.
|
|
1284
|
+
|
|
1285
|
+
#### Inherited from
|
|
1286
|
+
|
|
1287
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueEnabled`](IEngineEnvironmentVariables.md#federatedcatalogueenabled)
|
|
1288
|
+
|
|
1289
|
+
***
|
|
1290
|
+
|
|
1129
1291
|
### federatedCatalogueCacheTtlMs?
|
|
1130
1292
|
|
|
1131
1293
|
> `optional` **federatedCatalogueCacheTtlMs**: `number`
|
|
@@ -1166,7 +1328,7 @@ Is the rights management enabled, defaults to false.
|
|
|
1166
1328
|
|
|
1167
1329
|
> `optional` **taskSchedulerEnabled**: `string`
|
|
1168
1330
|
|
|
1169
|
-
Is the task scheduler enabled, defaults to
|
|
1331
|
+
Is the task scheduler enabled, defaults to false.
|
|
1170
1332
|
|
|
1171
1333
|
#### Inherited from
|
|
1172
1334
|
|
|
@@ -85,6 +85,14 @@ The path to the OpenAPI spec file, defaults to docs/open-api/spec.json.
|
|
|
85
85
|
|
|
86
86
|
***
|
|
87
87
|
|
|
88
|
+
### favIconFile?
|
|
89
|
+
|
|
90
|
+
> `optional` **favIconFile**: `string`
|
|
91
|
+
|
|
92
|
+
The path to the favicon, defaults to static/favicon.png.
|
|
93
|
+
|
|
94
|
+
***
|
|
95
|
+
|
|
88
96
|
### extendEnvVars()?
|
|
89
97
|
|
|
90
98
|
> `optional` **extendEnvVars**: (`envVars`) => `Promise`\<`void`\>
|