@twin.org/node-core 0.0.2-next.1 → 0.0.2-next.10

package/docs/reference/interfaces/INodeEnvironmentVariables.md

@@ -48,7 +48,8 @@ The name of the state file.
 
 > `optional` **entityStorageConnectorType**: `string`
 
-The type of the default entity storage: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb, mysql, mongodb, postgresql.
+The type of the entity storage to create, comma separate for more than one connector.
+values: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb, mysql, mongodb, postgresql
 
 #### Inherited from
 
@@ -56,39 +57,27 @@ The type of the default entity storage: file, memory, aws-dynamodb, azure-cosmos
 
 ***
 
-### entityStorageTablePrefix?
-
-> `optional` **entityStorageTablePrefix**: `string`
-
-A prefix for all the table in entity-storage, can be empty.
-
-#### Inherited from
+### entityStorageConnectorDefault?
 
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`entityStorageTablePrefix`](IEngineEnvironmentVariables.md#entitystoragetableprefix)
-
-***
-
-### entityFileEnable?
+> `optional` **entityStorageConnectorDefault**: `string`
 
-> `optional` **entityFileEnable**: `string`
-
-Enable the file entity storage connector.
+The default entity storage connector to use, defaults to the first one in the list.
 
 #### Inherited from
 
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`entityFileEnable`](IEngineEnvironmentVariables.md#entityfileenable)
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`entityStorageConnectorDefault`](IEngineEnvironmentVariables.md#entitystorageconnectordefault)
 
 ***
 
-### entityMemoryEnable?
+### entityStorageTablePrefix?
 
-> `optional` **entityMemoryEnable**: `string`
+> `optional` **entityStorageTablePrefix**: `string`
 
-Enable the memory entity storage connector.
+A prefix for all the table in entity-storage, can be empty.
 
 #### Inherited from
 
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`entityMemoryEnable`](IEngineEnvironmentVariables.md#entitymemoryenable)
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`entityStorageTablePrefix`](IEngineEnvironmentVariables.md#entitystoragetableprefix)
 
 ***
 
@@ -284,6 +273,18 @@ ScyllaDB local data center.
 
 ***
 
+### scylladbPort?
+
+> `optional` **scylladbPort**: `string`
+
+ScyllaDB port.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`scylladbPort`](IEngineEnvironmentVariables.md#scylladbport)
+
+***
+
 ### mySqlHost?
 
 > `optional` **mySqlHost**: `string`
@@ -492,7 +493,8 @@ The url for accessing IPFS API.
 
 > `optional` **blobStorageConnectorType**: `string`
 
-The type of the default blob storage: memory, file, ipfs, aws-s3, azure-storage, gcp-storage.
+The type of the entity storage to create, comma separate for more than one connector.
+values: memory, file, ipfs, aws-s3, azure-storage, gcp-storage.
 
 #### Inherited from
 
@@ -500,63 +502,76 @@ The type of the default blob storage: memory, file, ipfs, aws-s3, azure-storage,
 
 ***
 
-### blobStorageEnableEncryption?
+### blobStorageConnectorDefault?
 
-> `optional` **blobStorageEnableEncryption**: `string`
+> `optional` **blobStorageConnectorDefault**: `string`
 
-Enable encryption for the blob storage.
+The default blob storage connector to use, defaults to the first one in the list.
 
 #### Inherited from
 
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageEnableEncryption`](IEngineEnvironmentVariables.md#blobstorageenableencryption)
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageConnectorDefault`](IEngineEnvironmentVariables.md#blobstorageconnectordefault)
 
 ***
 
-### blobStorageEncryptionKey?
+### blobStorageConnectorPublic?
 
-> `optional` **blobStorageEncryptionKey**: `string`
+> `optional` **blobStorageConnectorPublic**: `string`
 
-The encryption key for the blob storage.
+Blog storage connector which has public access.
 
 #### Inherited from
 
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageEncryptionKey`](IEngineEnvironmentVariables.md#blobstorageencryptionkey)
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageConnectorPublic`](IEngineEnvironmentVariables.md#blobstorageconnectorpublic)
 
 ***
 
-### blobStoragePrefix?
+### blobStorageEnableEncryption?
 
-> `optional` **blobStoragePrefix**: `string`
+> `optional` **blobStorageEnableEncryption**: `string`
 
-A prefix for all the blobs in blob-storage, can be empty.
+Enable encryption for the blob storage.
 
 #### Inherited from
 
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStoragePrefix`](IEngineEnvironmentVariables.md#blobstorageprefix)
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageEnableEncryption`](IEngineEnvironmentVariables.md#blobstorageenableencryption)
+
+***
+
+### blobStorageEncryptionKeyId?
+
+> `optional` **blobStorageEncryptionKeyId**: `string`
+
+The id of the encryption key for the blob storage.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageEncryptionKeyId`](IEngineEnvironmentVariables.md#blobstorageencryptionkeyid)
 
 ***
 
-### blobFileEnable?
+### blobStorageSymmetricEncryptionKey?
 
-> `optional` **blobFileEnable**: `string`
+> `optional` **blobStorageSymmetricEncryptionKey**: `string`
 
-Enable the file blob storage connector.
+A symmetric encryption key for the blob storage, should be ChaCha20Poly1305 in base64 format.
+If encryption is enabled but a key is not provided one will be generated.
 
 #### Inherited from
 
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobFileEnable`](IEngineEnvironmentVariables.md#blobfileenable)
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageSymmetricEncryptionKey`](IEngineEnvironmentVariables.md#blobstoragesymmetricencryptionkey)
 
 ***
 
-### blobMemoryEnable?
+### blobStoragePrefix?
 
-> `optional` **blobMemoryEnable**: `string`
+> `optional` **blobStoragePrefix**: `string`
 
-Enable the memory blob storage connector.
+A prefix for all the blobs in blob-storage, can be empty.
 
 #### Inherited from
 
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobMemoryEnable`](IEngineEnvironmentVariables.md#blobmemoryenable)
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStoragePrefix`](IEngineEnvironmentVariables.md#blobstorageprefix)
 
 ***
 
@@ -1112,6 +1127,167 @@ The type of the default data extractor, can be a comma separated list: json-path
 
 ***
 
+### synchronisedStorageEnabled?
+
+> `optional` **synchronisedStorageEnabled**: `string`
+
+Is the synchronised storage enabled, defaults to false.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageEnabled`](IEngineEnvironmentVariables.md#synchronisedstorageenabled)
+
+***
+
+### synchronisedStorageTrustedUrl?
+
+> `optional` **synchronisedStorageTrustedUrl**: `string`
+
+Url which points to the api for a trusted synchronised storage node, not required if this is a trusted node.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageTrustedUrl`](IEngineEnvironmentVariables.md#synchronisedstoragetrustedurl)
+
+***
+
+### synchronisedStorageVerifiableStorageKeyId?
+
+> `optional` **synchronisedStorageVerifiableStorageKeyId**: `string`
+
+The key for the smart contract which contains the verifiable storage pointer store for synchronised storage.
+This only required if using a custom verifiable storage item, otherwise it will default the the network name.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageVerifiableStorageKeyId`](IEngineEnvironmentVariables.md#synchronisedstorageverifiablestoragekeyid)
+
+***
+
+### synchronisedStorageVerificationMethodId?
+
+> `optional` **synchronisedStorageVerificationMethodId**: `string`
+
+The identity verification method id to use with synchronised storage for signing/verifying changesets.
+Defaults to synchronised-storage-assertion.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageVerificationMethodId`](IEngineEnvironmentVariables.md#synchronisedstorageverificationmethodid)
+
+***
+
+### synchronisedStorageBlobStorageEncryptionKeyId?
+
+> `optional` **synchronisedStorageBlobStorageEncryptionKeyId**: `string`
+
+The key from the vault which is used to encrypt the synchronised storage blobs.
+Only required for trusted nodes, as regular nodes will request from the trusted nodes.
+Defaults to synchronised-storage-blob-encryption
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageBlobStorageEncryptionKeyId`](IEngineEnvironmentVariables.md#synchronisedstorageblobstorageencryptionkeyid)
+
+***
+
+### synchronisedStorageBlobStorageKey?
+
+> `optional` **synchronisedStorageBlobStorageKey**: `string`
+
+The key used for blob encryption, should be ChaCha20Poly1305 encoded as base64.
+Only required for trusted nodes, as regular nodes will not write encrypted data.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageBlobStorageKey`](IEngineEnvironmentVariables.md#synchronisedstorageblobstoragekey)
+
+***
+
+### synchronisedStorageEntityUpdateIntervalMinutes?
+
+> `optional` **synchronisedStorageEntityUpdateIntervalMinutes**: `string`
+
+How often to check for entity updates in minutes.
+
+#### Default
+
+```ts
+5
+```
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageEntityUpdateIntervalMinutes`](IEngineEnvironmentVariables.md#synchronisedstorageentityupdateintervalminutes)
+
+***
+
+### synchronisedStorageConsolidationIntervalMinutes?
+
+> `optional` **synchronisedStorageConsolidationIntervalMinutes**: `string`
+
+Interval to perform consolidation of changesets, only used if this is a trusted node.
+
+#### Default
+
+```ts
+60
+```
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageConsolidationIntervalMinutes`](IEngineEnvironmentVariables.md#synchronisedstorageconsolidationintervalminutes)
+
+***
+
+### synchronisedStorageConsolidationBatchSize?
+
+> `optional` **synchronisedStorageConsolidationBatchSize**: `string`
+
+The number of entities to process in a single consolidation batch, only used if this is a trusted node.
+
+#### Default
+
+```ts
+1000
+```
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageConsolidationBatchSize`](IEngineEnvironmentVariables.md#synchronisedstorageconsolidationbatchsize)
+
+***
+
+### synchronisedStorageMaxConsolidations?
+
+> `optional` **synchronisedStorageMaxConsolidations**: `string`
+
+The maximum number of consolidations to keep in storage, only used if this is a trusted node.
+
+#### Default
+
+```ts
+5
+```
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageMaxConsolidations`](IEngineEnvironmentVariables.md#synchronisedstoragemaxconsolidations)
+
+***
+
+### federatedCatalogueEnabled?
+
+> `optional` **federatedCatalogueEnabled**: `string`
+
+Is the federated catalogue enabled, defaults to false.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueEnabled`](IEngineEnvironmentVariables.md#federatedcatalogueenabled)
+
+***
+
 ### federatedCatalogueCacheTtlMs?
 
 > `optional` **federatedCatalogueCacheTtlMs**: `number`
@@ -1148,11 +1324,76 @@ Is the rights management enabled, defaults to false.
 
 ***
 
+### rightsManagementNegotiationMethodId?
+
+> `optional` **rightsManagementNegotiationMethodId**: `string`
+
+The rights management verification method id to use when signing/verifying negotiation requests.
+Defaults to policy-negotiation-assertion.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementNegotiationMethodId`](IEngineEnvironmentVariables.md#rightsmanagementnegotiationmethodid)
+
+***
+
+### rightsManagementNegotiators?
+
+> `optional` **rightsManagementNegotiators**: `string`
+
+The rights management configuration which includes the negotiator modules to load.
+Use the @json: prefix to specify the path to the JSON configuration file.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementNegotiators`](IEngineEnvironmentVariables.md#rightsmanagementnegotiators)
+
+***
+
+### rightsManagementInformationSources?
+
+> `optional` **rightsManagementInformationSources**: `string`
+
+The rights management configuration which includes the information sources modules to load.
+Use the @json: prefix to specify the path to the JSON configuration file.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementInformationSources`](IEngineEnvironmentVariables.md#rightsmanagementinformationsources)
+
+***
+
+### rightsManagementExecutionActions?
+
+> `optional` **rightsManagementExecutionActions**: `string`
+
+The rights management configuration which includes the execution actions modules to load.
+Use the @json: prefix to specify the path to the JSON configuration file.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementExecutionActions`](IEngineEnvironmentVariables.md#rightsmanagementexecutionactions)
+
+***
+
+### rightsManagementEnforcementProcessors?
+
+> `optional` **rightsManagementEnforcementProcessors**: `string`
+
+The rights management configuration which includes the enforcement processor modules to load.
+Use the @json: prefix to specify the path to the JSON configuration file.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementEnforcementProcessors`](IEngineEnvironmentVariables.md#rightsmanagementenforcementprocessors)
+
+***
+
 ### taskSchedulerEnabled?
 
 > `optional` **taskSchedulerEnabled**: `string`
 
-Is the task scheduler enabled, defaults to true.
+Is the task scheduler enabled, defaults to false.
 
 #### Inherited from
 
@@ -1160,6 +1401,31 @@ Is the task scheduler enabled, defaults to true.
 
 ***
 
+### dataSpaceConnectorEnabled?
+
+> `optional` **dataSpaceConnectorEnabled**: `string`
+
+Is the data space connector enabled, defaults to false.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataSpaceConnectorEnabled`](IEngineEnvironmentVariables.md#dataspaceconnectorenabled)
+
+***
+
+### dataSpaceConnectorApps?
+
+> `optional` **dataSpaceConnectorApps**: `string`
+
+The application configuration for the data space connector.
+Use the @json: prefix to specify the path to the JSON configuration file.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataSpaceConnectorApps`](IEngineEnvironmentVariables.md#dataspaceconnectorapps)
+
+***
+
 ### port?
 
 > `optional` **port**: `string`

package/docs/reference/interfaces/INodeOptions.md

@@ -85,6 +85,14 @@ The path to the OpenAPI spec file, defaults to docs/open-api/spec.json.
 
 ***
 
+### favIconFile?
+
+> `optional` **favIconFile**: `string`
+
+The path to the favicon, defaults to static/favicon.png.
+
+***
+
 ### extendEnvVars()?
 
 > `optional` **extendEnvVars**: (`envVars`) => `Promise`\<`void`\>

package/docs/reference/variables/NodeFeatures.md

@@ -4,7 +4,7 @@
 
 The features that can be enabled on the node.
 
-## Type declaration
+## Type Declaration
 
 ### NodeIdentity
 
@@ -17,3 +17,9 @@ NodeIdentity - generates an identity for the node if not provided in config.
 > `readonly` **NodeUser**: `"node-user"` = `"node-user"`
 
 NodeUser - generates a user for the node if not provided in config.
+
+### NodeWallet
+
+> `readonly` **NodeWallet**: `"node-wallet"` = `"node-wallet"`
+
+NodeWallet - generates a wallet for the node and funds it when there is a faucet available.

package/locales/en.json

@@ -19,12 +19,14 @@
 		"existingNodeUser": "Node user already exists \"{email}\"",
 		"creatingAuthKey": "Creating authentication key \"{keyName}\"",
 		"existingAuthKey": "Authentication key already exists \"{keyName}\"",
-		"addingAttestation": "Adding attestation verification method \"{methodId}\"",
-		"existingAttestation": "Attestation verification method already exists \"{methodId}\"",
-		"addingImmutableProof": "Adding immutable proof verification method \"{methodId}\"",
-		"existingImmutableProof": "Immutable proof verification method already exists \"{methodId}\"",
+		"addingVerificationMethod": "Adding {title} verification method \"{methodId}\"",
+		"existingVerificationMethod": "Verification method for {title} already exists \"{methodId}\"",
+		"addingBlobEncryptionKey": "Adding blob encryption key \"{keyName}\"",
 		"creatingBlobEncryptionKey": "Creating blob encryption key \"{keyName}\"",
+		"createdBlobEncryptionKey": "Created blob encryption key \"{keyName}\" with value \"{keyValue}\"",
 		"existingBlobEncryptionKey": "Blob encryption key already exists \"{keyName}\"",
+		"addingSynchronisedStorageBlobEncryptionKey": "Adding synchronised storage blob encryption key \"{keyName}\"",
+		"existingSynchronisedStorageBlobEncryptionKey": "Synchronised storage blob encryption key already exists \"{keyName}\"",
 		"creatingUserProfile": "Creating user profile \"{identity}\"",
 		"existingUserProfile": "User profile already exists \"{identity}\"",
 		"nodeIdentity": "Node identity \"{identity}\"",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/node-core",
-	"version": "0.0.2-next.1",
+	"version": "0.0.2-next.10",
 	"description": "TWIN Node Core for serving APIs using the specified configuration",
 	"repository": {
 		"type": "git",
@@ -17,6 +17,7 @@
 		"@twin.org/api-auth-entity-storage-service": "next",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
+		"@twin.org/data-space-connector-models": "next",
 		"@twin.org/engine": "next",
 		"@twin.org/engine-core": "next",
 		"@twin.org/engine-models": "next",
@@ -26,9 +27,11 @@
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-models": "next",
 		"@twin.org/identity-models": "next",
+		"@twin.org/modules": "next",
+		"@twin.org/rights-management-rest-client": "next",
 		"@twin.org/vault-models": "next",
 		"@twin.org/wallet-models": "next",
-		"dotenv": "16.5.0",
+		"dotenv": "17.2.1",
 		"schema-dts": "1.1.5"
 	},
 	"main": "./dist/cjs/index.cjs",