ApiCoreInterfaces
Interface: WorkerNodeConfig
Defined in: packages/core/src/node/worker.ts:33
What a worker needs to start a node: NodeConfig, less what can't be sent
to it. The signer stays on the page, and the stores are described.
Extends
Pick<NodeConfig, |"accountKey"|"contactKey"|"contactsSpace"|"sessionTtlSeconds"|"sessionKey"|"cache">
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
accountKey? | readonly | Uint8Array<ArrayBufferLike> | The account key (deriveAccountKey(seed)): the node then follows the account registry and opens the contacts space | NodeConfig.accountKey | packages/core/src/node/types.ts:79 |
cache? | readonly | CacheConfig | Hold only the collections this node uses, once a space names a keeper to hold the rest | NodeConfig.cache | packages/core/src/node/types.ts:117 |
contactKey? | readonly | Uint8Array<ArrayBufferLike> | The account's contact key (deriveContactKeyBytes(seed)), to open contact requests and knocks, in shared spaces and in the inbox. Its public half is published on the account's profiles. | NodeConfig.contactKey | packages/core/src/node/types.ts:84 |
contactsSpace? | readonly | string | The account's contacts space, for a node given it without the account key (an app granted contacts) | NodeConfig.contactsSpace | packages/core/src/node/types.ts:86 |
network? | readonly | Pick<NodeNetworkConfig, "relays" | "nodes" | "hosts" | "iceServers"> | - | - | packages/core/src/node/worker.ts:38 |
sessionKey? | readonly | CryptoKeyPair | The key to sign with, when the signer already named it. Default: one claimed from writerKey, else a fresh one | NodeConfig.sessionKey | packages/core/src/node/types.ts:105 |
sessionTtlSeconds? | readonly | number | Seconds each session delegation lasts; renewed before it runs out. Default 3600. | NodeConfig.sessionTtlSeconds | packages/core/src/node/types.ts:103 |
stores | readonly | WorkerStores | - | - | packages/core/src/node/worker.ts:37 |