Class PolykeyAgent

Readonly acl

Readonly certManager

Readonly clientService

Readonly db

Readonly discovery

Readonly fs

Readonly gestaltGraph

Readonly identitiesManager

Readonly keyRing

Readonly logger

Readonly nodeConnectionManager

Readonly nodeGraph

Readonly nodeManager

Readonly nodePath

Readonly notificationsManager

Readonly schema

Readonly sessionManager

Readonly sigchain

Readonly status

Readonly taskManager

Readonly vaultManager

agentServiceHost

• get agentServiceHost(): Host

• Returns Host

agentServicePort

• get agentServicePort(): Port

• Returns Port

clientServiceHost

• get clientServiceHost(): Host

• Returns Host

clientServicePort

• get clientServicePort(): Port

• Returns Port

Static createPolykeyAgent

• createPolykeyAgent(__namedParameters): Promise<PolykeyAgent>

• Create the Polykey Agent.

  All optional configuration is deep-merged with defaults.

  If any of the optional dependencies is injected, their lifecycle will not be managed by PolykeyAgent. Furthermore, if you inject an optional dependency, make sure you are injecting all upstream transitive dependencies at the same time. For example if you inject acl, you must also inject db.

  Parameters

  • __namedParameters: {
        fresh?: boolean;
        fs?: FileSystem;
        logger?: Logger;
        options?: {
            agentServiceHost?: string;
            agentServicePort?: number;
            client?: { connectTimeoutTime?: number | undefined; keepAliveTimeoutTime?: number | undefined; keepAliveIntervalTime?: number | undefined; };
            clientServiceHost?: string;
            clientServicePort?: number;
            ipv6Only?: boolean;
            keys?: ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; passwordMemLimit?: { ...; } | undefined; strictMemoryL...) | ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; ... 4 more ...; certRenewLeadTime?: number | undefined...) | ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; ... 4 more ...; certRenewLeadTime?: number | undefined...) | ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; ... 4 more ...; certRenewLeadTime?: number | undefined...);
            nodePath?: string;
            nodes?: { connectionIdleTimeoutTime?: number | undefined; connectionFindConcurrencyLimit?: number | undefined; connectionConnectTimeoutTime?: number | undefined; connectionKeepAliveTimeoutTime?: number | undefined; connectionKeepAliveIntervalTime?: number | undefined; connectionHolePunchIntervalTime?: number | undefined; rp...;
            rpc?: { callTimeoutTime?: number | undefined; parserBufferSize?: number | undefined; };
            seedNodes?: { [x: string & { readonly [brand]: "NodeIdEncoded"; }]: { host?: { [x: number]: string | undefined; toString?: {} | undefined; charAt?: {} | undefined; charCodeAt?: {} | undefined; concat?: {} | undefined; ... 46 more ...; readonly [brand]?: "Host" | undefined; } | { ...; } | undefined; port?: { ...; } | undefined; ...;
            workers?: number;
        };
        password: string;
    }

    • Optional fresh?: boolean

    • Optional fs?: FileSystem

    • Optional logger?: Logger

    • Optional options?: {
          agentServiceHost?: string;
          agentServicePort?: number;
          client?: { connectTimeoutTime?: number | undefined; keepAliveTimeoutTime?: number | undefined; keepAliveIntervalTime?: number | undefined; };
          clientServiceHost?: string;
          clientServicePort?: number;
          ipv6Only?: boolean;
          keys?: ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; passwordMemLimit?: { ...; } | undefined; strictMemoryL...) | ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; ... 4 more ...; certRenewLeadTime?: number | undefined...) | ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; ... 4 more ...; certRenewLeadTime?: number | undefined...) | ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; ... 4 more ...; certRenewLeadTime?: number | undefined...);
          nodePath?: string;
          nodes?: { connectionIdleTimeoutTime?: number | undefined; connectionFindConcurrencyLimit?: number | undefined; connectionConnectTimeoutTime?: number | undefined; connectionKeepAliveTimeoutTime?: number | undefined; connectionKeepAliveIntervalTime?: number | undefined; connectionHolePunchIntervalTime?: number | undefined; rp...;
          rpc?: { callTimeoutTime?: number | undefined; parserBufferSize?: number | undefined; };
          seedNodes?: { [x: string & { readonly [brand]: "NodeIdEncoded"; }]: { host?: { [x: number]: string | undefined; toString?: {} | undefined; charAt?: {} | undefined; charCodeAt?: {} | undefined; concat?: {} | undefined; ... 46 more ...; readonly [brand]?: "Host" | undefined; } | { ...; } | undefined; port?: { ...; } | undefined; ...;
          workers?: number;
      }

      • Optional agentServiceHost?: string

      • Optional agentServicePort?: number

      • Optional client?: { connectTimeoutTime?: number | undefined; keepAliveTimeoutTime?: number | undefined; keepAliveIntervalTime?: number | undefined; }

      • Optional clientServiceHost?: string

      • Optional clientServicePort?: number

      • Optional ipv6Only?: boolean

      • Optional keys?: ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; passwordMemLimit?: { ...; } | undefined; strictMemoryL...) | ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; ... 4 more ...; certRenewLeadTime?: number | undefined...) | ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; ... 4 more ...; certRenewLeadTime?: number | undefined...) | ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; ... 4 more ...; certRenewLeadTime?: number | undefined...)

      • Optional nodePath?: string

      • Optional nodes?: { connectionIdleTimeoutTime?: number | undefined; connectionFindConcurrencyLimit?: number | undefined; connectionConnectTimeoutTime?: number | undefined; connectionKeepAliveTimeoutTime?: number | undefined; connectionKeepAliveIntervalTime?: number | undefined; connectionHolePunchIntervalTime?: number | undefined; rp...

      • Optional rpc?: { callTimeoutTime?: number | undefined; parserBufferSize?: number | undefined; }

      • Optional seedNodes?: { [x: string & { readonly [brand]: "NodeIdEncoded"; }]: { host?: { [x: number]: string | undefined; toString?: {} | undefined; charAt?: {} | undefined; charCodeAt?: {} | undefined; concat?: {} | undefined; ... 46 more ...; readonly [brand]?: "Host" | undefined; } | { ...; } | undefined; port?: { ...; } | undefined; ...

      • Optional workers?: number

    • password: string

  Returns Promise<PolykeyAgent>