minca
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

PropertyModifierTypeDescriptionInherited fromDefined in
accountKey?readonlyUint8Array<ArrayBufferLike>The account key (deriveAccountKey(seed)): the node then follows the account registry and opens the contacts spaceNodeConfig.accountKeypackages/core/src/node/types.ts:79
cache?readonlyCacheConfigHold only the collections this node uses, once a space names a keeper to hold the restNodeConfig.cachepackages/core/src/node/types.ts:117
contactKey?readonlyUint8Array<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.contactKeypackages/core/src/node/types.ts:84
contactsSpace?readonlystringThe account's contacts space, for a node given it without the account key (an app granted contacts)NodeConfig.contactsSpacepackages/core/src/node/types.ts:86
network?readonlyPick<NodeNetworkConfig, "relays" | "nodes" | "hosts" | "iceServers">--packages/core/src/node/worker.ts:38
sessionKey?readonlyCryptoKeyPairThe key to sign with, when the signer already named it. Default: one claimed from writerKey, else a fresh oneNodeConfig.sessionKeypackages/core/src/node/types.ts:105
sessionTtlSeconds?readonlynumberSeconds each session delegation lasts; renewed before it runs out. Default 3600.NodeConfig.sessionTtlSecondspackages/core/src/node/types.ts:103
storesreadonlyWorkerStores--packages/core/src/node/worker.ts:37

On this page