Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "polykey",
"version": "2.0.1",
"version": "2.0.2",
"homepage": "https://polykey.com",
"author": "Matrix AI",
"contributors": [
Expand Down
77 changes: 7 additions & 70 deletions src/PolykeyAgent.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@
import type { JSONObject } from '@matrixai/rpc';
import type {
JSONObject,
JSONRPCRequest,
JSONRPCResponse,
MiddlewareFactory,
} from '@matrixai/rpc';
import type { DeepPartial, FileSystem, ObjectEmpty, POJO } from './types.js';
DeepPartial,
FileSystem,
ObjectEmpty,
POJO,
PolykeyAgentOptions,
} from './types.js';
import type { PolykeyWorkerManager } from './workers/types.js';
import type { TLSConfig } from './network/types.js';
import type { NodeAddress, NodeId, SeedNodes } from './nodes/types.js';
import type { PasswordOpsLimit, PasswordMemLimit } from './keys/types.js';
import type {
ClientRPCRequestParams,
ClientRPCResponseResult,
} from './client/types.js';
import path from 'node:path';
import process from 'process';
import Logger from '@matrixai/logger';
Expand Down Expand Up @@ -50,65 +46,6 @@ import * as clientMiddleware from './client/middleware.js';
import clientServerManifest from './client/handlers/index.js';
import agentServerManifest from './nodes/agent/handlers/index.js';

/**
* Optional configuration for `PolykeyAgent`.
*/
type PolykeyAgentOptions = {
nodePath: string;
clientServiceHost: string;
clientServicePort: number;
agentServiceHost: string;
agentServicePort: number;
network: string;
seedNodes: SeedNodes;
workers: number;
ipv6Only: boolean;
keys: {
passwordOpsLimit: PasswordOpsLimit;
passwordMemLimit: PasswordMemLimit;
strictMemoryLock: boolean;
certDuration: number;
certRenewLeadTime: number;
recoveryCode: string;
} & (
| ObjectEmpty
| { recoveryCode: string }
| { privateKey: Buffer }
| { privateKeyPath: string }
);
client: {
keepAliveTimeoutTime: number;
keepAliveIntervalTime: number;
rpcCallTimeoutTime: number;
rpcParserBufferSize: number;
rpcMiddlewareFactory?: MiddlewareFactory<
JSONRPCRequest<ClientRPCRequestParams>,
JSONRPCRequest<ClientRPCRequestParams>,
JSONRPCResponse<ClientRPCResponseResult>,
JSONRPCResponse<ClientRPCResponseResult>
>;
};
nodes: {
connectionIdleTimeoutTimeMin: number;
connectionIdleTimeoutTimeScale: number;
connectionFindConcurrencyLimit: number;
connectionConnectTimeoutTime: number;
connectionKeepAliveTimeoutTime: number;
connectionKeepAliveIntervalTime: number;
connectionHolePunchIntervalTime: number;
connectionInitialMaxStreamsBidi: number;
connectionInitialMaxStreamsUni: number;
rpcCallTimeoutTime: number;
rpcParserBufferSize: number;
dnsServers: Array<string> | undefined;
};
mdns: {
groups: Array<string>;
port: number;
};
versionMetadata: POJO;
};

interface PolykeyAgent extends createDestroyStartStop.CreateDestroyStartStop {}
@createDestroyStartStop.CreateDestroyStartStop(
new errors.ErrorPolykeyAgentRunning(),
Expand Down
71 changes: 71 additions & 0 deletions src/types.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
// eslint-disable-next-line no-restricted-imports -- Interim types for FileSystem
import type fs from 'node:fs';
import type {
JSONRPCRequest,
JSONRPCResponse,
MiddlewareFactory,
} from '@matrixai/rpc';
import type { PasswordOpsLimit, PasswordMemLimit } from './keys/types.js';
import type {
ClientRPCRequestParams,
ClientRPCResponseResult,
} from './client/types.js';
import type { SeedNodes } from './nodes/types.js';
export type * from 'acl/types.js';
export type * from 'audit/types.js';
export type * from 'claims/types.js';
Expand Down Expand Up @@ -187,6 +198,65 @@ type InverseRecord<
// eslint-disable-next-line
type ObjectEmpty = {};

/**
* Optional configuration for `PolykeyAgent`.
*/
type PolykeyAgentOptions = {
nodePath: string;
clientServiceHost: string;
clientServicePort: number;
agentServiceHost: string;
agentServicePort: number;
network: string;
seedNodes: SeedNodes;
workers: number;
ipv6Only: boolean;
keys: {
passwordOpsLimit: PasswordOpsLimit;
passwordMemLimit: PasswordMemLimit;
strictMemoryLock: boolean;
certDuration: number;
certRenewLeadTime: number;
recoveryCode: string;
} & (
| ObjectEmpty
| { recoveryCode: string }
| { privateKey: Buffer }
| { privateKeyPath: string }
);
client: {
keepAliveTimeoutTime: number;
keepAliveIntervalTime: number;
rpcCallTimeoutTime: number;
rpcParserBufferSize: number;
rpcMiddlewareFactory?: MiddlewareFactory<
JSONRPCRequest<ClientRPCRequestParams>,
JSONRPCRequest<ClientRPCRequestParams>,
JSONRPCResponse<ClientRPCResponseResult>,
JSONRPCResponse<ClientRPCResponseResult>
>;
};
nodes: {
connectionIdleTimeoutTimeMin: number;
connectionIdleTimeoutTimeScale: number;
connectionFindConcurrencyLimit: number;
connectionConnectTimeoutTime: number;
connectionKeepAliveTimeoutTime: number;
connectionKeepAliveIntervalTime: number;
connectionHolePunchIntervalTime: number;
connectionInitialMaxStreamsBidi: number;
connectionInitialMaxStreamsUni: number;
rpcCallTimeoutTime: number;
rpcParserBufferSize: number;
dnsServers: Array<string> | undefined;
};
mdns: {
groups: Array<string>;
port: number;
};
versionMetadata: POJO;
};

export type {
POJO,
JSONValue,
Expand All @@ -210,4 +280,5 @@ export type {
RecordKeyFromValue,
InverseRecord,
ObjectEmpty,
PolykeyAgentOptions,
};