ApiCoreInterfaces
Interface: NodeConfig
Defined in: packages/core/src/node/types.ts:75
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
accountKey? | readonly | Uint8Array<ArrayBufferLike> | The account key (deriveAccountKey(seed)): the node then follows the account registry and opens the contacts space | packages/core/src/node/types.ts:79 |
accountName? | readonly | string | The account's name as a grant gives it: what knocks and a new inbox say until the account's profile reaches this node from its registry | packages/core/src/node/types.ts:91 |
cache? | readonly | CacheConfig | Hold only the collections this node uses, once a space names a keeper to hold the rest | packages/core/src/node/types.ts:117 |
collections? | readonly | readonly CollectionDef[] | Collection shapes to use where a space has none: checked on write, flagged (conforms) on read, never refused | packages/core/src/node/types.ts:99 |
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. | 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) | packages/core/src/node/types.ts:86 |
fetchFiles? | readonly | "all" | Fetch and keep every file of any size, as a keeper does. Default: others' files up to 5 MiB, dropping the least used past 256 MiB a space (spec 05 §16.6). setFileLimits changes either while the node runs. | packages/core/src/node/types.ts:115 |
mailbox? | readonly | MailboxClient | How the inbox and short links reach mailboxes. Default: createMailboxClient | packages/core/src/node/types.ts:93 |
network? | readonly | NodeNetworkConfig | Omit to stay offline | packages/core/src/node/types.ts:101 |
provider? | readonly | CryptoProvider | The cryptography to sign and check with. Default: P-256 over Web Crypto. | packages/core/src/node/types.ts:97 |
sessionKey? | readonly | CryptoKeyPair | The key to sign with, when the signer already named it. Default: one claimed from writerKey, else a fresh one | packages/core/src/node/types.ts:105 |
sessionTtlSeconds? | readonly | number | Seconds each session delegation lasts; renewed before it runs out. Default 3600. | packages/core/src/node/types.ts:103 |
signer | readonly | RootSigner | Who this node acts for. The root key only signs session delegations. | packages/core/src/node/types.ts:77 |
stores | readonly | StoreFactory | Where the registry and each space's store live | packages/core/src/node/types.ts:95 |
watchIntervalMs? | readonly | number | How often to look for another process's writes to a folder store, ms. 0 disables. Default 2000. | packages/core/src/node/types.ts:109 |
writerKey? | readonly | WriterKeySource | Where to keep a signing key across runs (browserWriterKeys). Without one, each run makes a new key. Ignored with sessionKey. | packages/core/src/node/types.ts:107 |