@aztec/foundation 0.0.0-test.0

package/dest/worker/data_store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data_store.d.ts","sourceRoot":"","sources":["../../src/worker/data_store.ts"],"names":[],"mappings":";;AAAA;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;;;OAIG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAE9C;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAChD"}

package/dest/worker/data_store.js

@@ -0,0 +1,3 @@
+/**
+ * Simple read/write interface for wasm modules.
+ */ export { };

package/dest/worker/index.d.ts

@@ -0,0 +1,3 @@
+export { WorkerPool } from './worker_pool.js';
+export type { WasmWorker } from './wasm_worker.js';
+//# sourceMappingURL=index.d.ts.map

package/dest/worker/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/worker/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,YAAY,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC"}

package/dest/worker/index.js

@@ -0,0 +1 @@
+export { WorkerPool } from './worker_pool.js';

package/dest/worker/node/index.d.ts

@@ -0,0 +1,3 @@
+export * from './node_worker.js';
+export * from './node_data_store.js';
+//# sourceMappingURL=index.d.ts.map

package/dest/worker/node/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/worker/node/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC"}

package/dest/worker/node/index.js

@@ -0,0 +1,2 @@
+export * from './node_worker.js';
+export * from './node_data_store.js';

package/dest/worker/node/node_data_store.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import type { DataStore } from '../data_store.js';
+/**
+ * Cache for data used by wasm module.
+ */
+export declare class NodeDataStore implements DataStore {
+    private db;
+    constructor(path?: string);
+    get(key: string): Promise<Buffer | undefined>;
+    set(key: string, value: Buffer): Promise<void>;
+}
+//# sourceMappingURL=node_data_store.d.ts.map

package/dest/worker/node/node_data_store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node_data_store.d.ts","sourceRoot":"","sources":["../../../src/worker/node/node_data_store.ts"],"names":[],"mappings":";;AAIA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAElD;;GAEG;AACH,qBAAa,aAAc,YAAW,SAAS;IAC7C,OAAO,CAAC,EAAE,CAAU;gBAGR,IAAI,CAAC,EAAE,MAAM;IAMnB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAI7C,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGrD"}

package/dest/worker/node/node_data_store.js

@@ -0,0 +1,20 @@
+import leveldown from 'leveldown';
+import levelup from 'levelup';
+import memdown from 'memdown';
+/**
+ * Cache for data used by wasm module.
+ */ export class NodeDataStore {
+    db;
+    // eslint-disable-next-line
+    constructor(path){
+        // Hack: Cast as any to work around packages "broken" with node16 resolution
+        // See https://github.com/microsoft/TypeScript/issues/49160
+        this.db = levelup(path ? leveldown(path) : memdown());
+    }
+    async get(key) {
+        return await this.db.get(key).catch(()=>{});
+    }
+    async set(key, value) {
+        await this.db.put(key, value);
+    }
+}

package/dest/worker/node/node_worker.d.ts

@@ -0,0 +1,6 @@
+import type { WasmWorker } from '../wasm_worker.js';
+/**
+ * Creates a node worker.
+ */
+export declare function createNodeWorker(filepath: string, initialMem?: number, maxMem?: number): Promise<WasmWorker>;
+//# sourceMappingURL=node_worker.d.ts.map

package/dest/worker/node/node_worker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node_worker.d.ts","sourceRoot":"","sources":["../../../src/worker/node/node_worker.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;GAEG;AACH,wBAAsB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAalH"}

package/dest/worker/node/node_worker.js

@@ -0,0 +1,22 @@
+import { Worker } from 'worker_threads';
+import { NodeConnector, TransportClient, createDispatchProxy } from '../../transport/index.js';
+import { WasmModule } from '../../wasm/wasm_module.js';
+/**
+ * Creates a node worker.
+ */ export async function createNodeWorker(filepath, initialMem, maxMem) {
+    const worker = new Worker(filepath);
+    const transportConnect = new NodeConnector(worker);
+    const transportClient = new TransportClient(transportConnect);
+    await transportClient.open();
+    const remoteModule = createDispatchProxy(WasmModule, transportClient);
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises
+    remoteModule.destroyWorker = async ()=>{
+        await transportClient.request({
+            fn: '__destroyWorker__',
+            args: []
+        });
+        transportClient.close();
+    };
+    await remoteModule.init(initialMem, maxMem);
+    return remoteModule;
+}

package/dest/worker/node/start_node_module.d.ts

@@ -0,0 +1,7 @@
+import type { WasmModule } from '../../wasm/wasm_module.js';
+/**
+ * Start the transport server corresponding to this module.
+ * @param module - The WasmModule to host.
+ */
+export declare function startNodeModule(module: WasmModule): void;
+//# sourceMappingURL=start_node_module.d.ts.map

package/dest/worker/node/start_node_module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"start_node_module.d.ts","sourceRoot":"","sources":["../../../src/worker/node/start_node_module.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAM5D;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,UAAU,QAgBjD"}

package/dest/worker/node/start_node_module.js

@@ -0,0 +1,31 @@
+import { parentPort } from 'worker_threads';
+import { NodeListener, TransportServer } from '../../transport/index.js';
+if (!parentPort) {
+    throw new Error('InvalidWorker');
+}
+/**
+ * Start the transport server corresponding to this module.
+ * @param module - The WasmModule to host.
+ */ export function startNodeModule(module) {
+    const dispatch = async ({ fn, args })=>{
+        if (fn === '__destroyWorker__') {
+            transportServer.stop();
+            return;
+        }
+        if (!module[fn]) {
+            throw new Error(`dispatch error, function not found: ${fn}`);
+        }
+        return await module[fn](...args);
+    };
+    const transportListener = new NodeListener();
+    const transportServer = new TransportServer(transportListener, dispatch);
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises
+    module.addLogger((...args)=>transportServer.broadcast({
+            fn: 'emit',
+            args: [
+                'log',
+                ...args
+            ]
+        }));
+    transportServer.start();
+}

package/dest/worker/wasm_worker.d.ts

@@ -0,0 +1,9 @@
+import type { Proxify } from '../transport/index.js';
+import type { WasmModule } from '../wasm/wasm_module.js';
+/**
+ * Represents either a WASM web worker, or node.js worker.
+ */
+export type WasmWorker = Proxify<WasmModule> & {
+    destroyWorker(): void;
+};
+//# sourceMappingURL=wasm_worker.d.ts.map

package/dest/worker/wasm_worker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wasm_worker.d.ts","sourceRoot":"","sources":["../../src/worker/wasm_worker.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG;IAAE,aAAa,IAAI,IAAI,CAAA;CAAE,CAAC"}

package/dest/worker/wasm_worker.js

@@ -0,0 +1,3 @@
+/**
+ * Represents either a WASM web worker, or node.js worker.
+ */ export { };

package/dest/worker/worker_pool.d.ts

@@ -0,0 +1,40 @@
+import type { WasmWorker } from './wasm_worker.js';
+/**
+ * Type of a worker factory.
+ * Used to customize WorkerPool worker construction.
+ */
+export type CreateWorker = (name: string, minMem: number, maxMem: number) => WasmWorker;
+/**
+ * Allocates a pool of WasmWorker's.
+ * Worker 0 is allocated MAX_PAGES memory pages. This is because worker 0 will need to hold the proving key
+ * (i.e. Has state), whereas the others are pure compute (they hold a little crs state).
+ */
+export declare class WorkerPool {
+    /**
+     * The maximum number of memory pages to be used by the webassembly.
+     */
+    static MAX_PAGES: number;
+    /**
+     * The workers in the pool.
+     */
+    private workers;
+    /**
+     * Create an instance and initialize the workers.
+     * @param createWorker - Worker factory.
+     * @param poolSize - Pool size.
+     * @returns An initialized WorkerPool.
+     */
+    static new(createWorker: CreateWorker, poolSize: number): Promise<WorkerPool>;
+    /**
+     * Initialize the workers.
+     * @param createWorker - Worker factory().
+     * @param poolSize - Pool size.
+     * @param maxMem - Max memory pages.
+     */
+    init(createWorker: CreateWorker, poolSize: number, maxMem?: number): Promise<void>;
+    /**
+     * Tell all workers in the pool to stop processing.
+     */
+    destroy(): Promise<void>;
+}
+//# sourceMappingURL=worker_pool.d.ts.map

package/dest/worker/worker_pool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker_pool.d.ts","sourceRoot":"","sources":["../../src/worker/worker_pool.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAInD;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,UAAU,CAAC;AACxF;;;;GAIG;AACH,qBAAa,UAAU;IAYrB;;OAEG;IACH,OAAc,SAAS,SAAQ;IAC/B;;OAEG;IACH,OAAO,CAAC,OAAO,CAAoB;IAEnC;;;;;OAKG;WACU,GAAG,CAAC,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM;IAM7D;;;;;OAKG;IACU,IAAI,CAAC,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,SAAuB;IAY7F;;OAEG;IACU,OAAO;CAGrB"}

package/dest/worker/worker_pool.js

@@ -0,0 +1,51 @@
+import { createLogger } from '../log/index.js';
+const log = createLogger('foundation:worker_pool');
+/**
+ * Allocates a pool of WasmWorker's.
+ * Worker 0 is allocated MAX_PAGES memory pages. This is because worker 0 will need to hold the proving key
+ * (i.e. Has state), whereas the others are pure compute (they hold a little crs state).
+ */ export class WorkerPool {
+    // TODO(AD): Revisit what this means in aztec 3 context
+    // --
+    // Introduction of low mem prover work (polynomial cache) may actually increase mem usage when the backing store isn't
+    // enabled. We were seeing intermittent failings related to memory in production for some users when limiting to
+    // 6660 (416MB). It would be nice to understand why this is (the non determinism and/or the increased mem usage).
+    // For now, increasing mem usage to 512MB. This maybe preferable to backing out the low mem work, but
+    // ironically may break the chance of us using it in mobile.
+    // We *could* enable the low memory backing store, but this needs a little bit of work to actually
+    // read/write from indexeddb, performance testing, and actual further memory load testing.
+    // At this point it's hard to know what our memory savings would be relative to just fully reverting the LMP.
+    // public static MAX_PAGES = 6660;
+    /**
+   * The maximum number of memory pages to be used by the webassembly.
+   */ static MAX_PAGES = 8192;
+    /**
+   * The workers in the pool.
+   */ workers = [];
+    /**
+   * Create an instance and initialize the workers.
+   * @param createWorker - Worker factory.
+   * @param poolSize - Pool size.
+   * @returns An initialized WorkerPool.
+   */ static async new(createWorker, poolSize) {
+        const pool = new WorkerPool();
+        await pool.init(createWorker, poolSize);
+        return pool;
+    }
+    /**
+   * Initialize the workers.
+   * @param createWorker - Worker factory().
+   * @param poolSize - Pool size.
+   * @param maxMem - Max memory pages.
+   */ async init(createWorker, poolSize, maxMem = WorkerPool.MAX_PAGES) {
+        log.debug(`creating ${poolSize} workers...`);
+        const start = new Date().getTime();
+        this.workers = await Promise.all(Array(poolSize).fill(0).map((_, i)=>createWorker(`${i}`, i === 0 ? Math.min(WorkerPool.MAX_PAGES, maxMem) : 768, maxMem)));
+        log.debug(`created workers: ${new Date().getTime() - start}ms`);
+    }
+    /**
+   * Tell all workers in the pool to stop processing.
+   */ async destroy() {
+        await Promise.all(this.workers.map((w)=>w.destroyWorker()));
+    }
+}

package/package.json

@@ -0,0 +1,176 @@
+{
+  "name": "@aztec/foundation",
+  "version": "0.0.0-test.0",
+  "type": "module",
+  "main": "./dest/index.js",
+  "types": "./dest/index.d.ts",
+  "exports": {
+    "./eslint": "./.eslintrc.cjs",
+    "./eslint.docs": "./.eslintrc.docs.cjs",
+    "./prettier": "./.prettierrc.json",
+    "./abi": "./dest/abi/index.js",
+    "./async-map": "./dest/async-map/index.js",
+    "./async-pool": "./dest/async-pool/index.js",
+    "./collection": "./dest/collection/index.js",
+    "./config": "./dest/config/index.js",
+    "./crypto": "./dest/crypto/index.js",
+    "./crypto/sync": "./dest/crypto/sync/index.js",
+    "./decorators": "./dest/decorators/index.js",
+    "./error": "./dest/error/index.js",
+    "./eth-address": "./dest/eth-address/index.js",
+    "./eth-signature": "./dest/eth-signature/index.js",
+    "./queue": "./dest/queue/index.js",
+    "./fs": "./dest/fs/index.js",
+    "./buffer": "./dest/buffer/index.js",
+    "./json-rpc": "./dest/json-rpc/index.js",
+    "./json-rpc/client": "./dest/json-rpc/client/index.js",
+    "./json-rpc/server": "./dest/json-rpc/server/index.js",
+    "./json-rpc/undici": "./dest/json-rpc/client/undici.js",
+    "./json-rpc/test": "./dest/json-rpc/test/index.js",
+    "./iterable": "./dest/iterable/index.js",
+    "./log": "./dest/log/index.js",
+    "./mutex": "./dest/mutex/index.js",
+    "./fields": "./dest/fields/index.js",
+    "./retry": "./dest/retry/index.js",
+    "./running-promise": "./dest/running-promise/index.js",
+    "./serialize": "./dest/serialize/index.js",
+    "./sleep": "./dest/sleep/index.js",
+    "./timer": "./dest/timer/index.js",
+    "./transport": "./dest/transport/index.js",
+    "./trees": "./dest/trees/index.js",
+    "./wasm": "./dest/wasm/index.js",
+    "./worker": "./dest/worker/index.js",
+    "./bigint-buffer": "./dest/bigint-buffer/index.js",
+    "./types": "./dest/types/index.js",
+    "./schemas": "./dest/schemas/index.js",
+    "./url": "./dest/url/index.js",
+    "./committable": "./dest/committable/index.js",
+    "./noir": "./dest/noir/index.js",
+    "./testing": "./dest/testing/index.js",
+    "./testing/files": "./dest/testing/files/index.js",
+    "./array": "./dest/array/index.js",
+    "./validation": "./dest/validation/index.js",
+    "./promise": "./dest/promise/index.js",
+    "./string": "./dest/string/index.js",
+    "./message": "./dest/message/index.js"
+  },
+  "scripts": {
+    "build": "yarn clean && tsc -b",
+    "build:dev": "tsc -b --watch",
+    "clean": "rm -rf ./dest .tsbuildinfo",
+    "generate": "true",
+    "formatting": "run -T prettier --check ./src && run -T eslint ./src",
+    "formatting:fix": "run -T eslint --fix ./src && run -T prettier -w ./src",
+    "test": "NODE_NO_WARNINGS=1 node --experimental-vm-modules ../node_modules/.bin/jest --passWithNoTests --maxWorkers=${JEST_MAX_WORKERS:-8}"
+  },
+  "inherits": [
+    "../package.common.json"
+  ],
+  "jest": {
+    "transform": {
+      "^.+\\.tsx?$": [
+        "@swc/jest",
+        {
+          "jsc": {
+            "parser": {
+              "syntax": "typescript",
+              "decorators": true
+            },
+            "transform": {
+              "decoratorVersion": "2022-03"
+            }
+          }
+        }
+      ]
+    },
+    "moduleNameMapper": {
+      "^(\\.{1,2}/.*)\\.[cm]?js$": "$1"
+    },
+    "testRegex": "./src/.*\\.test\\.(js|mjs|ts)$",
+    "rootDir": "./src",
+    "extensionsToTreatAsEsm": [
+      ".ts"
+    ],
+    "reporters": [
+      "default"
+    ],
+    "testTimeout": 120000,
+    "setupFilesAfterEnv": [
+      "../../foundation/src/jest/setup.mjs"
+    ],
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
+  },
+  "dependencies": {
+    "@aztec/bb.js": "0.0.0-test.0",
+    "@koa/cors": "^5.0.0",
+    "@noble/curves": "^1.2.0",
+    "bn.js": "^5.2.1",
+    "c-kzg": "4.0.0-alpha.1",
+    "colorette": "^2.0.20",
+    "debug": "^4.3.4",
+    "detect-node": "^2.1.0",
+    "elliptic": "^6.5.4",
+    "hash.js": "^1.1.7",
+    "koa": "^2.14.2",
+    "koa-bodyparser": "^4.4.0",
+    "koa-compress": "^5.1.0",
+    "koa-router": "^12.0.0",
+    "leveldown": "^6.1.1",
+    "levelup": "^5.1.1",
+    "lodash.chunk": "^4.2.0",
+    "lodash.clonedeepwith": "^4.5.0",
+    "memdown": "^6.1.1",
+    "pako": "^2.1.0",
+    "pino": "^9.5.0",
+    "pino-pretty": "^13.0.0",
+    "sha3": "^2.1.4",
+    "undici": "^7.3.0",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.5.0",
+    "@libp2p/interface": "1.3.1",
+    "@types/bn.js": "^5.1.3",
+    "@types/debug": "^4.1.7",
+    "@types/detect-node": "^2.0.0",
+    "@types/elliptic": "^6.4.16",
+    "@types/jest": "^29.5.0",
+    "@types/koa": "^2.13.5",
+    "@types/koa-bodyparser": "^4.3.10",
+    "@types/koa-compress": "^4.0.3",
+    "@types/koa-router": "^7.4.4",
+    "@types/koa__cors": "^4.0.0",
+    "@types/leveldown": "^4.0.3",
+    "@types/levelup": "^5.1.2",
+    "@types/lodash.chunk": "^4.2.9",
+    "@types/lodash.clonedeepwith": "^4.5.7",
+    "@types/memdown": "^3.0.1",
+    "@types/node": "^18.7.23",
+    "@types/pako": "^2.0.0",
+    "@types/supertest": "^2.0.12",
+    "@typescript-eslint/eslint-plugin": "^6.2.1",
+    "@typescript-eslint/parser": "^6.2.1",
+    "comlink": "^4.4.1",
+    "eslint": "^8.21.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-jsdoc": "^40.1.0",
+    "eslint-plugin-no-only-tests": "^3.1.0",
+    "eslint-plugin-tsdoc": "^0.2.17",
+    "jest": "^29.5.0",
+    "prettier": "^2.7.1",
+    "supertest": "^6.3.3",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.4",
+    "viem": "2.22.8"
+  },
+  "files": [
+    "dest",
+    "src",
+    "!*.test.*"
+  ],
+  "engines": {
+    "node": ">=18"
+  }
+}

package/src/array/array.ts

@@ -0,0 +1,150 @@
+import type { Tuple } from '../serialize/index.js';
+
+export type { FieldsOf } from '../types/index.js';
+
+/**
+ * Create an array over an integer range.
+ * @param n - The number of integers.
+ * @param offset - The starting number.
+ * @returns The array of numbers.
+ */
+export function range(n: number, offset = 0) {
+  const ret: number[] = [];
+  for (let i = 0; i < n; i++) {
+    ret.push(offset + i);
+  }
+  return ret;
+}
+
+/**
+ * Create an array over an integer range, filled with a function 'fn'.
+ * This is used over e.g. lodash because it resolved to a tuple type, needed for our fixed array type safety.
+ * @param n - The number of integers.
+ * @param fn - The generator function.
+ * @returns The array of numbers.
+ */
+export function makeTuple<T, N extends number>(length: N, fn: (i: number) => T, offset = 0) {
+  return Array.from({ length }, (_: any, i: number) => fn(i + offset)) as Tuple<T, N>;
+}
+
+/**
+ * Create an array over an integer range, filled with a function 'fn'.
+ * This is used over e.g. lodash because it resolved to a tuple type, needed for our fixed array type safety.
+ * @param n - The number of integers.
+ * @param fn - The generator function.
+ * @returns The array of numbers.
+ */
+export async function makeTupleAsync<T, N extends number>(length: N, fn: (i: number) => Promise<T>, offset = 0) {
+  return (await Promise.all(
+    Array(length)
+      .fill(0)
+      .map(async (_: any, i: number) => await fn(i + offset)),
+  )) as Tuple<T, N>;
+}
+
+/**
+ * Create an array over an integer range, filled with a function 'fn'. However, the latter half of the array are set to zeros.
+ * see `makeTuple` above.
+ * @param n - The number of integers.
+ * @param fn - The generator function.
+ * @returns The array of numbers.
+ */
+export function makeHalfFullTuple<T, N extends number>(
+  length: N,
+  fn: (i: number) => T,
+  offset = 0,
+  makeEmpty: () => T,
+) {
+  return Array.from({ length }, (_: any, i: number) => (i < length / 2 ? fn(i + offset) : makeEmpty())) as Tuple<T, N>;
+}
+
+/**
+ * Assert a member of an object is a certain length.
+ * @param obj - An object.
+ * @param member - A member string.
+ * @param length - The length.
+ */
+export function assertMemberLength<
+  F extends string,
+  T extends {
+    [f in F]: {
+      /**
+       * A property which the tested member of the object T has to have.
+       */
+      length: number;
+    };
+  },
+>(obj: T, member: F, length: number) {
+  if (obj[member].length !== length) {
+    throw new Error(`Expected ${member} to have length ${length} but was ${obj[member].length}`);
+  }
+}
+
+/**
+ * Assert all subarrays in a member of an object are a certain length.
+ * @param obj - An object.
+ * @param member - A member string.
+ * @param length - The expected length for each subarray.
+ */
+export function assertItemsLength<
+  F extends string,
+  T extends {
+    [f in F]: {
+      /**
+       * A property which the tested member of the object T has to have.
+       */
+      length: number;
+    }[];
+  },
+>(obj: T, member: F, length: number) {
+  const arrays = obj[member];
+  for (let i = 0; i < arrays.length; i++) {
+    if (arrays[i].length !== length) {
+      throw new Error(`Expected ${member}[${i}] to have length ${length} but was ${arrays[i].length}`);
+    }
+  }
+}
+
+/**
+ * Checks that the permutation is valid. Throws an error if it is not.
+ * @param original - The original array.
+ * @param permutation - The array which is allegedly a permutation of the original.
+ * @param indexes - The indices of the original array which the permutation should map to.
+ * @param isEqual - A function to compare the elements of the original and permutation arrays.
+ */
+export function assertPermutation<T>(
+  original: T[],
+  permutation: T[],
+  indexes: number[],
+  isEqual: (a: T, b: T) => boolean,
+): void {
+  if (original.length !== permutation.length || original.length !== indexes.length) {
+    throw new Error(`Invalid lengths: ${original.length}, ${permutation.length}, ${indexes.length}`);
+  }
+
+  const seenValue = new Set<number>();
+  for (let i = 0; i < indexes.length; i++) {
+    const index = indexes[i];
+    const permutedValue = permutation[i];
+    const originalValueAtIndex = original[index];
+
+    if (!isEqual(permutedValue, originalValueAtIndex)) {
+      throw new Error(`Invalid permutation at index ${index}: ${permutedValue} !== ${originalValueAtIndex}`);
+    }
+    if (seenValue.has(index)) {
+      throw new Error(`Duplicate index in permutation: ${index}`);
+    }
+    seenValue.add(index);
+  }
+}
+
+export function assertRightPadded<T>(arr: T[], isEmpty: (item: T) => boolean) {
+  let seenEmpty = false;
+  for (let i = 0; i < arr.length; i++) {
+    if (isEmpty(arr[i])) {
+      seenEmpty = true;
+    } else if (seenEmpty) {
+      throw new Error(`Non-empty element at index [${i}] after empty element`);
+    }
+  }
+}

package/src/array/index.ts

@@ -0,0 +1 @@
+export * from './array.js';

package/src/async-map/index.ts

@@ -0,0 +1,18 @@
+/**
+ * Maps an array of elements by applying an asynchronous function to each element in sequence,
+ * and returns a new array with the results. The function receives each element of the array
+ * and its index as arguments, and should return a Promise that resolves to the desired value.
+ *
+ * @typeParam T - The original array element type.
+ * @typeParam U - The resulting array element type.
+ * @param arr - The array to map.
+ * @param fn - The async function to apply on each element of the array.
+ * @returns A Promise that resolves to a new array containing the mapped values.
+ */
+export async function asyncMap<T, U>(arr: T[], fn: (e: T, i: number) => Promise<U>): Promise<U[]> {
+  const results: U[] = [];
+  for (let i = 0; i < arr.length; ++i) {
+    results.push(await fn(arr[i], i));
+  }
+  return results;
+}