@pkcprotocol/pkc-js 0.0.11

package/dist/browser/schema.js

@@ -0,0 +1,104 @@
+import { z } from "zod";
+import { parseIpfsRawOptionToIpfsOptions } from "./util.js";
+import { UserAgentSchema } from "./schema/schema.js";
+import version from "./version.js";
+// This file will have misc schemas, as well as PKC class schema
+export const ChainTickerSchema = z.string().min(1);
+export const nonNegativeIntStringSchema = z
+    .string()
+    .regex(/^\d+$/)
+    .refine((val) => parseInt(val) >= 0, {
+    message: "Must be a non-negative integer"
+});
+export const Uint8ArraySchema = z.custom((value) => value instanceof Uint8Array, { message: "Expected Uint8Array" });
+const IpfsGatewayUrlSchema = z.url().startsWith("http", "IPFS gateway URL must start with http:// or https://");
+const RpcUrlSchema = z.url().startsWith("ws", "PKC RPC URL must start with ws:// or wss://"); // Optional websocket URLs of PKC RPC servers, required to run a community from a browser/electron/webview
+const KuboRpcCreateClientOptionSchema = z.custom(); // Kubo-rpc-client library will do the validation for us
+const DirectoryPathSchema = z.string(); // TODO add validation for path
+export const NameResolverSchema = z.object({
+    key: z.string().min(1),
+    resolve: z.custom((val) => typeof val === "function", {
+        message: "resolve must be a function"
+    }),
+    canResolve: z.custom((val) => typeof val === "function", {
+        message: "canResolve must be a function"
+    }),
+    provider: z.string().min(1),
+    dataPath: z.string().optional(), // Optional filesystem path for persistent cache storage. Resolvers can use this to store cached resolution results across restarts.
+    destroy: z
+        .custom((val) => typeof val === "function", {
+        message: "destroy must be a function"
+    })
+        .optional()
+});
+// Serialized variant without function props — for RPC transport where functions can't survive JSON serialization
+export const NameResolverSerializedSchema = NameResolverSchema.omit({ resolve: true, canResolve: true, destroy: true });
+const TransformKuboRpcClientOptionsSchema = KuboRpcCreateClientOptionSchema.array().transform((options) => options.map(parseIpfsRawOptionToIpfsOptions));
+const ParsedKuboRpcClientOptionsSchema = z.custom();
+export const PKCUserOptionBaseSchema = z.object({
+    ipfsGatewayUrls: IpfsGatewayUrlSchema.array().optional(),
+    kuboRpcClientsOptions: TransformKuboRpcClientOptionsSchema.optional(),
+    httpRoutersOptions: z.string().url().startsWith("http", "HTTP router URL must start with http:// or https://").array().optional(),
+    pubsubKuboRpcClientsOptions: TransformKuboRpcClientOptionsSchema.optional(),
+    pkcRpcClientsOptions: RpcUrlSchema.array().nonempty().optional(),
+    dataPath: DirectoryPathSchema.optional(),
+    resolveAuthorNames: z.boolean(),
+    nameResolvers: NameResolverSchema.array().optional(),
+    libp2pJsClientsOptions: z
+        .object({
+        key: z.string().min(1),
+        libp2pOptions: z.custom().default({}),
+        heliaOptions: z.custom().default({})
+    })
+        .array()
+        .max(1, "Only one libp2pJsClientOptions is allowed at the moment")
+        .optional(),
+    validatePages: z.boolean(), // if false, pkc-js will not validate pages in commentUpdate/Community/getPage
+    userAgent: UserAgentSchema,
+    // Options for tests only. Should not be used in production
+    publishInterval: z.number().positive(), // in ms, the time to wait for community instances to publish updates. Default is 20s
+    updateInterval: z.number().positive(), // in ms, the time to wait for comment/community instances to check for updates. Default is 1min
+    noData: z.boolean(), // if true, dataPath is ignored, all database and cache data is saved in memory
+    challenges: z.record(z.string(), z.custom()).optional() // instance-level challenge registry, shadows built-in challenges by name
+});
+const defaultPubsubKuboRpcClientsOptions = [
+    { url: "https://pubsubprovider.xyz/api/v0" },
+    { url: "https://plebpubsub.xyz/api/v0" }
+];
+const defaultIpfsGatewayUrls = ["https://ipfsgateway.xyz", "https://gateway.plebpubsub.xyz", "https://gateway.forumindex.com"];
+export const PKCUserOptionsSchema = PKCUserOptionBaseSchema.extend({
+    // used in await PKC({PKCOption}), will set defaults here
+    ipfsGatewayUrls: PKCUserOptionBaseSchema.shape.ipfsGatewayUrls
+        .default([...defaultIpfsGatewayUrls])
+        .transform((val) => (val === undefined ? [...defaultIpfsGatewayUrls] : val)),
+    pubsubKuboRpcClientsOptions: PKCUserOptionBaseSchema.shape.pubsubKuboRpcClientsOptions.default([...defaultPubsubKuboRpcClientsOptions]),
+    httpRoutersOptions: PKCUserOptionBaseSchema.shape.httpRoutersOptions.default([
+        "https://peers.pleb.bot",
+        "https://routing.lol",
+        "https://peers.forumindex.com",
+        "https://peers.plebpubsub.xyz"
+    ]),
+    resolveAuthorNames: PKCUserOptionBaseSchema.shape.resolveAuthorNames.default(true),
+    publishInterval: PKCUserOptionBaseSchema.shape.publishInterval.default(20000),
+    updateInterval: PKCUserOptionBaseSchema.shape.updateInterval.default(60000),
+    noData: PKCUserOptionBaseSchema.shape.noData.default(false),
+    validatePages: PKCUserOptionBaseSchema.shape.validatePages.default(true),
+    userAgent: PKCUserOptionBaseSchema.shape.userAgent.default(version.USER_AGENT)
+}).transform((args) => {
+    if (JSON.stringify(args.pubsubKuboRpcClientsOptions) === JSON.stringify(defaultPubsubKuboRpcClientsOptions) &&
+        args.libp2pJsClientsOptions) {
+        return {
+            ...args,
+            pubsubKuboRpcClientsOptions: []
+        };
+    }
+    else
+        return args;
+});
+export const PKCParsedOptionsSchema = PKCUserOptionBaseSchema.extend({
+    // used to parse responses from rpc when calling getSettings
+    kuboRpcClientsOptions: ParsedKuboRpcClientOptionsSchema.optional(),
+    pubsubKuboRpcClientsOptions: ParsedKuboRpcClientOptionsSchema.optional(),
+    nameResolvers: NameResolverSchema.array().optional()
+}).strict();
+//# sourceMappingURL=schema.js.map

package/dist/browser/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,+BAA+B,EAAE,MAAM,WAAW,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,OAAO,MAAM,cAAc,CAAC;AAMnC,gEAAgE;AAEhE,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAEnD,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC;KACtC,MAAM,EAAE;KACR,KAAK,CAAC,OAAO,CAAC;KACd,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;IACjC,OAAO,EAAE,gCAAgC;CAC5C,CAAC,CAAC;AAEP,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CACpC,CAAC,KAAK,EAAwC,EAAE,CAAC,KAAK,YAAY,UAAU,EAC5E,EAAE,OAAO,EAAE,qBAAqB,EAAE,CACrC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,MAAM,EAAE,sDAAsD,CAAC,CAAC;AAEhH,MAAM,YAAY,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,6CAA6C,CAAC,CAAC,CAAC,0GAA0G;AAExM,MAAM,+BAA+B,GAAG,CAAC,CAAC,MAAM,EAA6B,CAAC,CAAC,wDAAwD;AAEvI,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,+BAA+B;AAEvE,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACtB,OAAO,EAAE,CAAC,CAAC,MAAM,CAMf,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,UAAU,EAAE;QAClC,OAAO,EAAE,4BAA4B;KACxC,CAAC;IACF,UAAU,EAAE,CAAC,CAAC,MAAM,CAAsC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,UAAU,EAAE;QAC1F,OAAO,EAAE,+BAA+B;KAC3C,CAAC;IACF,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,oIAAoI;IACrK,OAAO,EAAE,CAAC;SACL,MAAM,CAAsB,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,UAAU,EAAE;QAC7D,OAAO,EAAE,4BAA4B;KACxC,CAAC;SACD,QAAQ,EAAE;CAClB,CAAC,CAAC;AAEH,iHAAiH;AACjH,MAAM,CAAC,MAAM,4BAA4B,GAAG,kBAAkB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;AAExH,MAAM,mCAAmC,GAAG,+BAA+B,CAAC,KAAK,EAAE,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE,CACtG,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAC/C,CAAC;AAEF,MAAM,gCAAgC,GAAG,CAAC,CAAC,MAAM,EAAwD,CAAC;AAO1G,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,eAAe,EAAE,oBAAoB,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;IACxD,qBAAqB,EAAE,mCAAmC,CAAC,QAAQ,EAAE;IACrE,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,MAAM,EAAE,qDAAqD,CAAC,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;IACjI,2BAA2B,EAAE,mCAAmC,CAAC,QAAQ,EAAE;IAC3E,oBAAoB,EAAE,YAAY,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAChE,QAAQ,EAAE,mBAAmB,CAAC,QAAQ,EAAE;IACxC,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE;IAC/B,aAAa,EAAE,kBAAkB,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;IACpD,sBAAsB,EAAE,CAAC;SACpB,MAAM,CAAC;QACJ,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QACtB,aAAa,EAAE,CAAC,CAAC,MAAM,EAA0B,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7D,YAAY,EAAE,CAAC,CAAC,MAAM,EAAyB,CAAC,OAAO,CAAC,EAAE,CAAC;KAC9D,CAAC;SACD,KAAK,EAAE;SACP,GAAG,CAAC,CAAC,EAAE,yDAAyD,CAAC;SACjE,QAAQ,EAAE;IACf,aAAa,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,8EAA8E;IAC1G,SAAS,EAAE,eAAe;IAC1B,2DAA2D;IAC3D,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,qFAAqF;IAC7H,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,gGAAgG;IACvI,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,+EAA+E;IACpG,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAA6B,CAAC,CAAC,QAAQ,EAAE,CAAC,yEAAyE;CAC/J,CAAC,CAAC;AAEH,MAAM,kCAAkC,GAAG;IACvC,EAAE,GAAG,EAAE,mCAAmC,EAAE;IAC5C,EAAE,GAAG,EAAE,+BAA+B,EAAE;CAClC,CAAC;AAEX,MAAM,sBAAsB,GAAG,CAAC,yBAAyB,EAAE,gCAAgC,EAAE,gCAAgC,CAAU,CAAC;AAExI,MAAM,CAAC,MAAM,oBAAoB,GAAG,uBAAuB,CAAC,MAAM,CAAC;IAC/D,yDAAyD;IACzD,eAAe,EAAE,uBAAuB,CAAC,KAAK,CAAC,eAAe;SACzD,OAAO,CAAC,CAAC,GAAG,sBAAsB,CAAC,CAAC;SACpC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAChF,2BAA2B,EAAE,uBAAuB,CAAC,KAAK,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,GAAG,kCAAkC,CAAC,CAAC;IACvI,kBAAkB,EAAE,uBAAuB,CAAC,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC;QACzE,wBAAwB;QACxB,qBAAqB;QACrB,8BAA8B;QAC9B,8BAA8B;KACjC,CAAC;IACF,kBAAkB,EAAE,uBAAuB,CAAC,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,IAAI,CAAC;IAClF,eAAe,EAAE,uBAAuB,CAAC,KAAK,CAAC,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC;IAC7E,cAAc,EAAE,uBAAuB,CAAC,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC;IAC3E,MAAM,EAAE,uBAAuB,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;IAC3D,aAAa,EAAE,uBAAuB,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC;IACxE,SAAS,EAAE,uBAAuB,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC;CACjF,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;IAClB,IACI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,2BAA2B,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,kCAAkC,CAAC;QACvG,IAAI,CAAC,sBAAsB,EAC7B,CAAC;QACC,OAAO;YACH,GAAG,IAAI;YACP,2BAA2B,EAAE,EAA+E;SAC/G,CAAC;IACN,CAAC;;QAAM,OAAO,IAAI,CAAC;AACvB,CAAC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,sBAAsB,GAAG,uBAAuB,CAAC,MAAM,CAAC;IACjE,4DAA4D;IAC5D,qBAAqB,EAAE,gCAAgC,CAAC,QAAQ,EAAE;IAClE,2BAA2B,EAAE,gCAAgC,CAAC,QAAQ,EAAE;IACxE,aAAa,EAAE,kBAAkB,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;CACvD,CAAC,CAAC,MAAM,EAAE,CAAC"}

package/dist/browser/signer/constants.d.ts

@@ -0,0 +1,2 @@
+import type { CreatePublicationOptions } from "../types.js";
+export declare const keysToOmitFromSignedPropertyNames: (keyof Pick<CreatePublicationOptions, "signer" | "challengeRequest" | "communityAddress">)[];

package/dist/browser/signer/constants.js

@@ -0,0 +1,3 @@
+// Signer section
+export const keysToOmitFromSignedPropertyNames = ["signer", "challengeRequest", "communityAddress"];
+//# sourceMappingURL=constants.js.map

package/dist/browser/signer/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/signer/constants.ts"],"names":[],"mappings":"AAAA,iBAAiB;AAIjB,MAAM,CAAC,MAAM,iCAAiC,GAE7C,CAAC,QAAQ,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,CAAC"}

package/dist/browser/signer/encryption.d.ts

@@ -0,0 +1,21 @@
+import type { Encrypted } from "./types.js";
+export declare const encryptStringAesGcm: (plaintext: string, key: Uint8Array, iv?: Uint8Array) => Promise<{
+    ciphertext: Uint8Array<ArrayBufferLike>;
+    iv: Uint8Array<ArrayBufferLike>;
+    tag: Uint8Array<ArrayBufferLike>;
+}>;
+export declare const decryptStringAesGcm: (ciphertext: Uint8Array, key: Uint8Array, iv: Uint8Array, tag: Uint8Array) => Promise<string>;
+export declare const encryptEd25519AesGcm: (plaintext: string, privateKeyBase64: string, publicKeyBase64: string) => Promise<{
+    ciphertext: Uint8Array<ArrayBufferLike>;
+    iv: Uint8Array<ArrayBufferLike>;
+    tag: Uint8Array<ArrayBufferLike>;
+    type: string;
+}>;
+export declare const encryptEd25519AesGcmPublicKeyBuffer: (plaintext: string, privateKeyBase64: string, publicKeyBuffer: Uint8Array) => Promise<{
+    ciphertext: Uint8Array<ArrayBufferLike>;
+    iv: Uint8Array<ArrayBufferLike>;
+    tag: Uint8Array<ArrayBufferLike>;
+    type: string;
+}>;
+export declare const decryptEd25519AesGcm: (encrypted: Encrypted, privateKeyBase64: string, publicKeyBase64: string) => Promise<string>;
+export declare const decryptEd25519AesGcmPublicKeyBuffer: (encrypted: Encrypted, privateKeyBase64: string, publicKeyBuffer: Uint8Array) => Promise<string>;

package/dist/browser/signer/encryption.js

@@ -0,0 +1,122 @@
+import forge from "node-forge";
+import { fromString as uint8ArrayFromString } from "uint8arrays/from-string";
+import * as ed from "@noble/ed25519";
+const isProbablyBuffer = (arg) => arg && typeof arg !== "string" && typeof arg !== "number";
+const uint8ArrayToNodeForgeBuffer = (uint8Array) => {
+    const forgeBuffer = forge.util.createBuffer();
+    for (const byte of uint8Array) {
+        forgeBuffer.putByte(byte);
+    }
+    return forgeBuffer;
+};
+// NOTE: never pass the last param 'iv', only used for testing, it must always be random
+export const encryptStringAesGcm = async (plaintext, key, iv) => {
+    if (!plaintext || typeof plaintext !== "string")
+        throw Error(`encryptStringAesGcm plaintext '${plaintext}' not a string`);
+    if (!isProbablyBuffer(key))
+        throw Error(`encryptStringAesGcm invalid key '${key}' not buffer`);
+    // use random 12 bytes uint8 array for iv
+    if (!iv) {
+        iv = ed.utils.randomPrivateKey().slice(0, 12);
+    }
+    // node-forge doesn't accept uint8Array
+    const keyAsForgeBuffer = uint8ArrayToNodeForgeBuffer(key);
+    const ivAsForgeBuffer = uint8ArrayToNodeForgeBuffer(iv);
+    const cipher = forge.cipher.createCipher("AES-GCM", keyAsForgeBuffer);
+    cipher.start({ iv: ivAsForgeBuffer });
+    cipher.update(forge.util.createBuffer(plaintext, "utf8"));
+    cipher.finish();
+    return {
+        ciphertext: uint8ArrayFromString(cipher.output.toHex(), "base16"),
+        iv,
+        // AES-GCM has authentication tag https://en.wikipedia.org/wiki/Galois/Counter_Mode
+        tag: uint8ArrayFromString(cipher.mode.tag.toHex(), "base16")
+    };
+};
+export const decryptStringAesGcm = async (ciphertext, key, iv, tag) => {
+    if (!isProbablyBuffer(ciphertext))
+        throw Error(`decryptStringAesGcm invalid ciphertext '${ciphertext}' not buffer`);
+    if (!isProbablyBuffer(key))
+        throw Error(`decryptStringAesGcm invalid key '${key}' not buffer`);
+    if (!isProbablyBuffer(iv))
+        throw Error(`decryptStringAesGcm invalid iv '${iv}' not buffer`);
+    if (!isProbablyBuffer(tag))
+        throw Error(`decryptStringAesGcm invalid tag '${tag}' not buffer`);
+    // node-forge doesn't accept uint8Array
+    const keyAsForgeBuffer = uint8ArrayToNodeForgeBuffer(key);
+    const ivAsForgeBuffer = uint8ArrayToNodeForgeBuffer(iv);
+    const tagAsForgeBuffer = uint8ArrayToNodeForgeBuffer(tag);
+    const cipher = forge.cipher.createDecipher("AES-GCM", keyAsForgeBuffer);
+    cipher.start({ iv: ivAsForgeBuffer, tag: tagAsForgeBuffer });
+    cipher.update(uint8ArrayToNodeForgeBuffer(ciphertext));
+    cipher.finish();
+    const decrypted = cipher.output.toString();
+    return decrypted;
+};
+export const encryptEd25519AesGcm = async (plaintext, privateKeyBase64, publicKeyBase64) => {
+    if (!publicKeyBase64 || typeof publicKeyBase64 !== "string")
+        throw Error(`encryptEd25519AesGcm publicKeyBase64 '${publicKeyBase64}' not a string`);
+    const publicKeyBuffer = uint8ArrayFromString(publicKeyBase64, "base64");
+    return encryptEd25519AesGcmPublicKeyBuffer(plaintext, privateKeyBase64, publicKeyBuffer);
+};
+export const encryptEd25519AesGcmPublicKeyBuffer = async (plaintext, privateKeyBase64, publicKeyBuffer) => {
+    if (!plaintext || typeof plaintext !== "string")
+        throw Error(`encryptEd25519AesGcm plaintext '${plaintext}' not a string`);
+    if (!privateKeyBase64 || typeof privateKeyBase64 !== "string")
+        throw Error(`encryptEd25519AesGcm privateKeyBase64 not a string`);
+    const privateKeyBuffer = uint8ArrayFromString(privateKeyBase64, "base64");
+    if (privateKeyBuffer.length !== 32)
+        throw Error(`encryptEd25519AesGcm publicKeyBase64 ed25519 public key length not 32 bytes (${privateKeyBuffer.length} bytes)`);
+    if (publicKeyBuffer.length !== 32)
+        throw Error(`encryptEd25519AesGcm publicKeyBase64 '${publicKeyBuffer}' ed25519 public key length not 32 bytes (${publicKeyBuffer.length} bytes)`);
+    // add random padding to prevent linking encrypted publications by sizes
+    // TODO: eventually use an algorithm to find the most anonymous padding length
+    const randomPaddingLength = Math.round(Math.random() * 5000);
+    let padding = "";
+    while (padding.length < randomPaddingLength) {
+        padding += " ";
+    }
+    // compute the shared secret of the sender and recipient and use it as the encryption key
+    // do not publish this secret https://datatracker.ietf.org/doc/html/rfc7748#section-6.1
+    const aesGcmKey = await ed.getSharedSecret(privateKeyBuffer, publicKeyBuffer);
+    // use 16 bytes key for AES-128
+    const aesGcmKey16Bytes = aesGcmKey.slice(0, 16);
+    // AES GCM using 128-bit key https://en.wikipedia.org/wiki/Galois/Counter_Mode
+    const { ciphertext, iv, tag } = await encryptStringAesGcm(plaintext + padding, aesGcmKey16Bytes);
+    const encrypted = {
+        ciphertext,
+        iv,
+        // AES-GCM has authentication tag https://en.wikipedia.org/wiki/Galois/Counter_Mode
+        tag,
+        type: "ed25519-aes-gcm"
+    };
+    return encrypted;
+};
+export const decryptEd25519AesGcm = async (encrypted, privateKeyBase64, publicKeyBase64) => {
+    if (!privateKeyBase64 || typeof privateKeyBase64 !== "string")
+        throw Error(`decryptEd25519AesGcm ${privateKeyBase64} privateKeyBase64 not a string`);
+    if (!publicKeyBase64 || typeof publicKeyBase64 !== "string")
+        throw Error(`decryptEd25519AesGcm publicKeyBase64 '${publicKeyBase64}' not a string`);
+    const publicKeyBuffer = uint8ArrayFromString(publicKeyBase64, "base64");
+    return decryptEd25519AesGcmPublicKeyBuffer(encrypted, privateKeyBase64, publicKeyBuffer);
+};
+export const decryptEd25519AesGcmPublicKeyBuffer = async (encrypted, privateKeyBase64, publicKeyBuffer) => {
+    if (!privateKeyBase64 || typeof privateKeyBase64 !== "string")
+        throw Error(`decryptEd25519AesGcm ${privateKeyBase64} privateKeyBase64 not a string`);
+    const privateKeyBuffer = uint8ArrayFromString(privateKeyBase64, "base64");
+    if (privateKeyBuffer.length !== 32)
+        throw Error(`decryptEd25519AesGcm publicKeyBase64 ed25519 public key length not 32 bytes (${privateKeyBuffer.length} bytes)`);
+    if (publicKeyBuffer.length !== 32)
+        throw Error(`decryptEd25519AesGcm publicKeyBuffer '${publicKeyBuffer}' ed25519 public key length not 32 bytes (${publicKeyBuffer.length} bytes)`);
+    // compute the shared secret of the sender and recipient and use it as the encryption key
+    // do not publish this secret https://datatracker.ietf.org/doc/html/rfc7748#section-6.1
+    const aesGcmKey = await ed.getSharedSecret(privateKeyBuffer, publicKeyBuffer);
+    // use 16 bytes key for AES-128
+    const aesGcmKey16Bytes = aesGcmKey.slice(0, 16);
+    // AES GCM using 128-bit key https://en.wikipedia.org/wiki/Galois/Counter_Mode
+    let decrypted = await decryptStringAesGcm(encrypted.ciphertext, aesGcmKey16Bytes, encrypted.iv, encrypted.tag);
+    // remove padding
+    decrypted = decrypted.replace(/ *$/, "");
+    return decrypted;
+};
+//# sourceMappingURL=encryption.js.map

package/dist/browser/signer/encryption.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"encryption.js","sourceRoot":"","sources":["../../../src/signer/encryption.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,YAAY,CAAC;AAE/B,OAAO,EAAE,UAAU,IAAI,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC7E,OAAO,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAGrC,MAAM,gBAAgB,GAAG,CAAC,GAAQ,EAAE,EAAE,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,QAAQ,CAAC;AAEjG,MAAM,2BAA2B,GAAG,CAAC,UAAsB,EAAE,EAAE;IAC3D,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;IAC9C,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;QAC5B,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IACD,OAAO,WAAW,CAAC;AACvB,CAAC,CAAC;AAEF,wFAAwF;AACxF,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,EAAE,SAAiB,EAAE,GAAe,EAAE,EAAe,EAAE,EAAE;IAC7F,IAAI,CAAC,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ;QAAE,MAAM,KAAK,CAAC,kCAAkC,SAAS,gBAAgB,CAAC,CAAC;IAC1H,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC;QAAE,MAAM,KAAK,CAAC,oCAAoC,GAAG,cAAc,CAAC,CAAC;IAE/F,yCAAyC;IACzC,IAAI,CAAC,EAAE,EAAE,CAAC;QACN,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAClD,CAAC;IAED,uCAAuC;IACvC,MAAM,gBAAgB,GAAG,2BAA2B,CAAC,GAAG,CAAC,CAAC;IAC1D,MAAM,eAAe,GAAG,2BAA2B,CAAC,EAAE,CAAC,CAAC;IAExD,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;IACtE,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,eAAe,EAAE,CAAC,CAAC;IACtC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1D,MAAM,CAAC,MAAM,EAAE,CAAC;IAEhB,OAAO;QACH,UAAU,EAAE,oBAAoB,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,QAAQ,CAAC;QACjE,EAAE;QACF,mFAAmF;QACnF,GAAG,EAAE,oBAAoB,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,QAAQ,CAAC;KAC/D,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,EAAE,UAAsB,EAAE,GAAe,EAAE,EAAc,EAAE,GAAe,EAAE,EAAE;IAClH,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC;QAAE,MAAM,KAAK,CAAC,2CAA2C,UAAU,cAAc,CAAC,CAAC;IACpH,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC;QAAE,MAAM,KAAK,CAAC,oCAAoC,GAAG,cAAc,CAAC,CAAC;IAC/F,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC;QAAE,MAAM,KAAK,CAAC,mCAAmC,EAAE,cAAc,CAAC,CAAC;IAC5F,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC;QAAE,MAAM,KAAK,CAAC,oCAAoC,GAAG,cAAc,CAAC,CAAC;IAE/F,uCAAuC;IACvC,MAAM,gBAAgB,GAAG,2BAA2B,CAAC,GAAG,CAAC,CAAC;IAC1D,MAAM,eAAe,GAAG,2BAA2B,CAAC,EAAE,CAAC,CAAC;IACxD,MAAM,gBAAgB,GAAG,2BAA2B,CAAC,GAAG,CAAC,CAAC;IAE1D,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;IACxE,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,eAAe,EAAE,GAAG,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAC7D,MAAM,CAAC,MAAM,CAAC,2BAA2B,CAAC,UAAU,CAAC,CAAC,CAAC;IACvD,MAAM,CAAC,MAAM,EAAE,CAAC;IAChB,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;IAC3C,OAAO,SAAS,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,EAAE,SAAiB,EAAE,gBAAwB,EAAE,eAAuB,EAAE,EAAE;IAC/G,IAAI,CAAC,eAAe,IAAI,OAAO,eAAe,KAAK,QAAQ;QACvD,MAAM,KAAK,CAAC,yCAAyC,eAAe,gBAAgB,CAAC,CAAC;IAC1F,MAAM,eAAe,GAAG,oBAAoB,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;IAExE,OAAO,mCAAmC,CAAC,SAAS,EAAE,gBAAgB,EAAE,eAAe,CAAC,CAAC;AAC7F,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,mCAAmC,GAAG,KAAK,EAAE,SAAiB,EAAE,gBAAwB,EAAE,eAA2B,EAAE,EAAE;IAClI,IAAI,CAAC,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ;QAAE,MAAM,KAAK,CAAC,mCAAmC,SAAS,gBAAgB,CAAC,CAAC;IAC3H,IAAI,CAAC,gBAAgB,IAAI,OAAO,gBAAgB,KAAK,QAAQ;QAAE,MAAM,KAAK,CAAC,oDAAoD,CAAC,CAAC;IACjI,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IAC1E,IAAI,gBAAgB,CAAC,MAAM,KAAK,EAAE;QAC9B,MAAM,KAAK,CAAC,gFAAgF,gBAAgB,CAAC,MAAM,SAAS,CAAC,CAAC;IAClI,IAAI,eAAe,CAAC,MAAM,KAAK,EAAE;QAC7B,MAAM,KAAK,CACP,yCAAyC,eAAe,6CAA6C,eAAe,CAAC,MAAM,SAAS,CACvI,CAAC;IAEN,wEAAwE;IACxE,8EAA8E;IAC9E,MAAM,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IAC7D,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,OAAO,OAAO,CAAC,MAAM,GAAG,mBAAmB,EAAE,CAAC;QAC1C,OAAO,IAAI,GAAG,CAAC;IACnB,CAAC;IAED,yFAAyF;IACzF,uFAAuF;IACvF,MAAM,SAAS,GAAG,MAAM,EAAE,CAAC,eAAe,CAAC,gBAAgB,EAAE,eAAe,CAAC,CAAC;IAC9E,+BAA+B;IAC/B,MAAM,gBAAgB,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAEhD,8EAA8E;IAC9E,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,MAAM,mBAAmB,CAAC,SAAS,GAAG,OAAO,EAAE,gBAAgB,CAAC,CAAC;IAEjG,MAAM,SAAS,GAAc;QACzB,UAAU;QACV,EAAE;QACF,mFAAmF;QACnF,GAAG;QACH,IAAI,EAAE,iBAAiB;KAC1B,CAAC;IACF,OAAO,SAAS,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,EAAE,SAAoB,EAAE,gBAAwB,EAAE,eAAuB,EAAE,EAAE;IAClH,IAAI,CAAC,gBAAgB,IAAI,OAAO,gBAAgB,KAAK,QAAQ;QACzD,MAAM,KAAK,CAAC,wBAAwB,gBAAgB,gCAAgC,CAAC,CAAC;IAC1F,IAAI,CAAC,eAAe,IAAI,OAAO,eAAe,KAAK,QAAQ;QACvD,MAAM,KAAK,CAAC,yCAAyC,eAAe,gBAAgB,CAAC,CAAC;IAC1F,MAAM,eAAe,GAAG,oBAAoB,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;IAExE,OAAO,mCAAmC,CAAC,SAAS,EAAE,gBAAgB,EAAE,eAAe,CAAC,CAAC;AAC7F,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,mCAAmC,GAAG,KAAK,EAAE,SAAoB,EAAE,gBAAwB,EAAE,eAA2B,EAAE,EAAE;IACrI,IAAI,CAAC,gBAAgB,IAAI,OAAO,gBAAgB,KAAK,QAAQ;QACzD,MAAM,KAAK,CAAC,wBAAwB,gBAAgB,gCAAgC,CAAC,CAAC;IAC1F,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IAC1E,IAAI,gBAAgB,CAAC,MAAM,KAAK,EAAE;QAC9B,MAAM,KAAK,CAAC,gFAAgF,gBAAgB,CAAC,MAAM,SAAS,CAAC,CAAC;IAClI,IAAI,eAAe,CAAC,MAAM,KAAK,EAAE;QAC7B,MAAM,KAAK,CACP,yCAAyC,eAAe,6CAA6C,eAAe,CAAC,MAAM,SAAS,CACvI,CAAC;IAEN,yFAAyF;IACzF,uFAAuF;IACvF,MAAM,SAAS,GAAG,MAAM,EAAE,CAAC,eAAe,CAAC,gBAAgB,EAAE,eAAe,CAAC,CAAC;IAC9E,+BAA+B;IAC/B,MAAM,gBAAgB,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAEhD,8EAA8E;IAC9E,IAAI,SAAS,GAAG,MAAM,mBAAmB,CAAC,SAAS,CAAC,UAAU,EAAE,gBAAgB,EAAE,SAAS,CAAC,EAAE,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC;IAE/G,iBAAiB;IACjB,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAEzC,OAAO,SAAS,CAAC;AACrB,CAAC,CAAC"}

package/dist/browser/signer/index.d.ts

@@ -0,0 +1,21 @@
+import type { SignerType } from "./types.js";
+export { verifyCommentIpfs, verifyCommentPubsubMessage, verifyCommunity, verifyVote } from "./signatures.js";
+export { encryptEd25519AesGcm, decryptEd25519AesGcm, decryptEd25519AesGcmPublicKeyBuffer } from "./encryption.js";
+import { CreateSignerOptions } from "./types.js";
+export declare class Signer implements SignerType {
+    type: "ed25519";
+    privateKey: string;
+    publicKey?: string;
+    address: string;
+    shortAddress: string;
+    ipfsKey?: Uint8Array;
+    ipnsKeyName?: string;
+    constructor(props: SignerType);
+}
+export declare class SignerWithPublicKeyAddress extends Signer {
+    publicKey: string;
+    constructor(props: SignerType & {
+        publicKey: string;
+    });
+}
+export declare const createSigner: (createSignerOptions?: CreateSignerOptions) => Promise<SignerWithPublicKeyAddress>;

package/dist/browser/signer/index.js

@@ -0,0 +1,49 @@
+import { generatePrivateKey, getPublicKeyFromPrivateKey, getPKCAddressFromPrivateKey } from "./util.js";
+import { hideClassPrivateProps, shortifyAddress } from "../util.js";
+export { verifyCommentIpfs, verifyCommentPubsubMessage, verifyCommunity, verifyVote } from "./signatures.js";
+export { encryptEd25519AesGcm, decryptEd25519AesGcm, decryptEd25519AesGcmPublicKeyBuffer } from "./encryption.js";
+import { CreateSignerSchema } from "../schema/schema.js";
+export class Signer {
+    constructor(props) {
+        this.type = props.type;
+        this.privateKey = props.privateKey;
+        this.publicKey = props.publicKey;
+        this.address = props.address;
+        this.shortAddress = shortifyAddress(this.address);
+        this.ipnsKeyName = props.ipnsKeyName;
+        this.ipfsKey =
+            props.ipfsKey?.constructor?.name === "Object"
+                ? new Uint8Array(Object.values(props.ipfsKey))
+                : props.ipfsKey
+                    ? new Uint8Array(props.ipfsKey)
+                    : undefined;
+        hideClassPrivateProps(this);
+    }
+}
+export class SignerWithPublicKeyAddress extends Signer {
+    constructor(props) {
+        super(props);
+        this.publicKey = props.publicKey;
+    }
+}
+export const createSigner = async (createSignerOptions) => {
+    let privateKey;
+    let type;
+    if (!createSignerOptions) {
+        type = "ed25519";
+        privateKey = await generatePrivateKey();
+    }
+    else {
+        const parsed = CreateSignerSchema.parse(createSignerOptions);
+        privateKey = parsed.privateKey;
+        type = parsed.type;
+    }
+    const [publicKey, address] = await Promise.all([getPublicKeyFromPrivateKey(privateKey), getPKCAddressFromPrivateKey(privateKey)]);
+    return new SignerWithPublicKeyAddress({
+        type,
+        publicKey,
+        address,
+        privateKey
+    });
+};
+//# sourceMappingURL=index.js.map

package/dist/browser/signer/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/signer/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,MAAM,WAAW,CAAC;AACxG,OAAO,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AACpE,OAAO,EAAE,iBAAiB,EAAE,0BAA0B,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7G,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,mCAAmC,EAAE,MAAM,iBAAiB,CAAC;AAClH,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAGzD,MAAM,OAAO,MAAM;IASf,YAAY,KAAiB;QACzB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QACnC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC7B,IAAI,CAAC,YAAY,GAAG,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClD,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QAErC,IAAI,CAAC,OAAO;YACR,KAAK,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,KAAK,QAAQ;gBACzC,CAAC,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAC9C,CAAC,CAAC,KAAK,CAAC,OAAO;oBACb,CAAC,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC;oBAC/B,CAAC,CAAC,SAAS,CAAC;QACtB,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;CACJ;AAED,MAAM,OAAO,0BAA2B,SAAQ,MAAM;IAElD,YAAY,KAAyC;QACjD,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;IACrC,CAAC;CACJ;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAAE,mBAAyC,EAAuC,EAAE;IACjH,IAAI,UAA6C,CAAC;IAClD,IAAI,IAAiC,CAAC;IACtC,IAAI,CAAC,mBAAmB,EAAE,CAAC;QACvB,IAAI,GAAG,SAAS,CAAC;QACjB,UAAU,GAAG,MAAM,kBAAkB,EAAE,CAAC;IAC5C,CAAC;SAAM,CAAC;QACJ,MAAM,MAAM,GAAG,kBAAkB,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;QAC7D,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;QAC/B,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;IACvB,CAAC;IAED,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,0BAA0B,CAAC,UAAU,CAAC,EAAE,2BAA2B,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAElI,OAAO,IAAI,0BAA0B,CAAC;QAClC,IAAI;QACJ,SAAS;QACT,OAAO;QACP,UAAU;KACb,CAAC,CAAC;AACP,CAAC,CAAC"}

package/dist/browser/signer/signatures.d.ts

@@ -0,0 +1,200 @@
+import { PKC } from "../pkc/pkc.js";
+import type { ChallengeAnswerMessageSignature, ChallengeAnswerMessageType, ChallengeMessageSignature, ChallengeMessageType, ChallengeRequestMessageSignature, ChallengeRequestMessageType, ChallengeVerificationMessageSignature, ChallengeVerificationMessageType, DecryptedChallengeVerification } from "../pubsub-messages/types.js";
+import Logger from "../logger.js";
+import { messages } from "../errors.js";
+import { BaseClientsManager } from "../clients/base-client-manager.js";
+import type { CommunityIpfsType, CommunitySignature } from "../community/types.js";
+import type { JsonSignature, PubsubMsgToSign, PubsubSignature, SignerType } from "./types.js";
+import type { CommentEditOptionsToSign, CommentEditPubsubMessagePublication, CommentEditSignature } from "../publications/comment-edit/types.js";
+import type { VoteOptionsToSign, VotePubsubMessagePublication, VoteSignature } from "../publications/vote/types.js";
+import type { CommentIpfsType, CommentIpfsWithCidDefined, CommentIpfsWithCidPostCidDefined, CommentOptionsToSign, CommentPubsubMessagePublication, CommentPubsubMessagPublicationSignature, CommentUpdateForChallengeVerification, CommentUpdateForChallengeVerificationSignature, CommentUpdateSignature, CommentUpdateType } from "../publications/comment/types.js";
+import type { ModQueuePageIpfs, PageIpfs } from "../pages/types.js";
+import type { CommentModerationOptionsToSign, CommentModerationPubsubMessagePublication, CommentModerationSignature } from "../publications/comment-moderation/types.js";
+import type { CommunityEditPublicationOptionsToSign, CommunityEditPublicationSignature, CommunityEditPubsubMessagePublication } from "../publications/community-edit/types.js";
+export type ValidationResult = {
+    valid: true;
+} | {
+    valid: false;
+    reason: string;
+};
+export declare const signBufferEd25519: (bufferToSign: Uint8Array, privateKeyBase64: string) => Promise<Uint8Array<ArrayBufferLike>>;
+export declare const verifyBufferEd25519: (bufferToSign: Uint8Array, bufferSignature: Uint8Array, publicKeyBase64: string) => Promise<boolean>;
+export declare function _signJson(signedPropertyNames: JsonSignature["signedPropertyNames"], cleanedPublication: Object, // should call cleanUpBeforePublish before calling _signJson
+signer: SignerType, log: Logger): Promise<JsonSignature>;
+export declare function _signPubsubMsg({ signedPropertyNames, msg, // should call cleanUpBeforePublish before calling _signPubsubMsg
+signer, log }: {
+    signedPropertyNames: PubsubSignature["signedPropertyNames"];
+    msg: PubsubMsgToSign;
+    signer: SignerType;
+    log: Logger;
+}): Promise<PubsubSignature>;
+export declare function cleanUpBeforePublishing<T>(msg: T): T;
+export declare function signComment({ comment, pkc }: {
+    comment: CommentOptionsToSign;
+    pkc: PKC;
+}): Promise<CommentPubsubMessagPublicationSignature>;
+export declare function signCommentUpdate({ update, signer }: {
+    update: Omit<CommentUpdateType, "signature">;
+    signer: SignerType;
+}): Promise<CommentUpdateSignature>;
+export declare function signCommentUpdateForChallengeVerification({ update, signer }: {
+    update: Omit<DecryptedChallengeVerification["commentUpdate"], "signature">;
+    signer: SignerType;
+}): Promise<CommentUpdateForChallengeVerificationSignature>;
+export declare function signVote({ vote, pkc }: {
+    vote: VoteOptionsToSign;
+    pkc: PKC;
+}): Promise<VoteSignature>;
+export declare function signCommunityEdit({ communityEdit, pkc }: {
+    communityEdit: CommunityEditPublicationOptionsToSign;
+    pkc: PKC;
+}): Promise<CommunityEditPublicationSignature>;
+export declare function signCommentEdit({ edit, pkc }: {
+    edit: CommentEditOptionsToSign;
+    pkc: PKC;
+}): Promise<CommentEditSignature>;
+export declare function signCommentModeration({ commentMod, pkc }: {
+    commentMod: CommentModerationOptionsToSign;
+    pkc: PKC;
+}): Promise<CommentModerationSignature>;
+export declare function signCommunity({ community, signer }: {
+    community: Omit<CommunityIpfsType, "signature">;
+    signer: SignerType;
+}): Promise<CommunitySignature>;
+export declare function signChallengeRequest({ request, signer }: {
+    request: Omit<ChallengeRequestMessageType, "signature">;
+    signer: SignerType;
+}): Promise<ChallengeRequestMessageSignature>;
+export declare function signChallengeMessage({ challengeMessage, signer }: {
+    challengeMessage: Omit<ChallengeMessageType, "signature">;
+    signer: SignerType;
+}): Promise<ChallengeMessageSignature>;
+export declare function signChallengeAnswer({ challengeAnswer, signer }: {
+    challengeAnswer: Omit<ChallengeAnswerMessageType, "signature">;
+    signer: SignerType;
+}): Promise<ChallengeAnswerMessageSignature>;
+export declare function signChallengeVerification({ challengeVerification, signer }: {
+    challengeVerification: Omit<ChallengeVerificationMessageType, "signature">;
+    signer: SignerType;
+}): Promise<ChallengeVerificationMessageSignature>;
+export declare function verifyVote({ vote, resolveAuthorNames, clientsManager }: {
+    vote: VotePubsubMessagePublication;
+    resolveAuthorNames: boolean;
+    clientsManager: BaseClientsManager;
+}): Promise<ValidationResult>;
+export declare function verifyCommunityEdit({ communityEdit, resolveAuthorNames, clientsManager }: {
+    communityEdit: CommunityEditPubsubMessagePublication;
+    resolveAuthorNames: boolean;
+    clientsManager: BaseClientsManager;
+}): Promise<ValidationResult>;
+export declare function verifyCommentEdit({ edit, resolveAuthorNames, clientsManager }: {
+    edit: CommentEditPubsubMessagePublication;
+    resolveAuthorNames: boolean;
+    clientsManager: BaseClientsManager;
+}): Promise<ValidationResult>;
+export declare function verifyCommentModeration({ moderation, resolveAuthorNames, clientsManager }: {
+    moderation: CommentModerationPubsubMessagePublication;
+    resolveAuthorNames: boolean;
+    clientsManager: BaseClientsManager;
+}): Promise<ValidationResult>;
+export declare function verifyCommentPubsubMessage({ comment, resolveAuthorNames, clientsManager, abortSignal }: {
+    comment: CommentPubsubMessagePublication;
+    resolveAuthorNames: boolean;
+    clientsManager: BaseClientsManager;
+    abortSignal?: AbortSignal;
+}): Promise<{
+    valid: true;
+} | {
+    valid: false;
+    reason: string;
+} | {
+    valid: boolean;
+    reason: messages;
+}>;
+export declare function verifyCommentIpfs(opts: {
+    comment: CommentIpfsType;
+    calculatedCommentCid: string;
+    resolveAuthorNames: boolean;
+    clientsManager: BaseClientsManager;
+    communityAddressFromInstance?: string;
+    abortSignal?: AbortSignal;
+}): ReturnType<typeof verifyCommentPubsubMessage>;
+export declare function verifyCommunity({ community, communityIpnsName, resolveAuthorNames, clientsManager, validatePages, cacheIfValid, abortSignal }: {
+    community: CommunityIpfsType;
+    communityIpnsName: string;
+    resolveAuthorNames: boolean;
+    clientsManager: BaseClientsManager;
+    validatePages: boolean;
+    cacheIfValid?: boolean;
+    abortSignal?: AbortSignal;
+}): Promise<ValidationResult>;
+export declare function verifyCommentUpdate({ update, resolveAuthorNames, clientsManager, community, comment, validatePages, validateUpdateSignature, abortSignal }: {
+    update: CommentUpdateType | CommentUpdateForChallengeVerification | ModQueuePageIpfs["comments"][0]["commentUpdate"];
+    resolveAuthorNames: boolean;
+    clientsManager: BaseClientsManager;
+    community: CommunityForVerifyingPages;
+    comment: Pick<CommentIpfsWithCidPostCidDefined, "signature" | "cid" | "depth" | "postCid">;
+    validatePages: boolean;
+    validateUpdateSignature: boolean;
+    abortSignal?: AbortSignal;
+}): Promise<ValidationResult>;
+export declare function verifyChallengeRequest({ request, validateTimestampRange }: {
+    request: ChallengeRequestMessageType;
+    validateTimestampRange: boolean;
+}): Promise<ValidationResult>;
+export declare function verifyChallengeMessage({ challenge, pubsubTopic, validateTimestampRange }: {
+    challenge: ChallengeMessageType;
+    pubsubTopic: string;
+    validateTimestampRange: boolean;
+}): Promise<ValidationResult>;
+export declare function verifyChallengeAnswer({ answer, validateTimestampRange }: {
+    answer: ChallengeAnswerMessageType;
+    validateTimestampRange: boolean;
+}): Promise<ValidationResult>;
+export declare function verifyChallengeVerification({ verification, pubsubTopic, validateTimestampRange }: {
+    verification: ChallengeVerificationMessageType;
+    pubsubTopic: string;
+    validateTimestampRange: boolean;
+}): Promise<ValidationResult>;
+type ParentCommentForVerifyingPages = Pick<CommentIpfsWithCidPostCidDefined, "cid" | "depth" | "postCid"> | Pick<CommentIpfsWithCidDefined, "postCid"> | {
+    cid: undefined;
+    depth: -1;
+    postCid: undefined;
+};
+type CommunityForVerifyingPages = {
+    address: string;
+    signature?: CommunityIpfsType["signature"];
+};
+export declare function verifyPageComment({ pageComment, community, parentComment, resolveAuthorNames, clientsManager, validatePages, validateUpdateSignature, abortSignal }: {
+    pageComment: (PageIpfs | ModQueuePageIpfs)["comments"][0];
+    community: CommunityForVerifyingPages;
+    parentComment: ParentCommentForVerifyingPages | undefined;
+    resolveAuthorNames: boolean;
+    clientsManager: BaseClientsManager;
+    validatePages: boolean;
+    validateUpdateSignature: boolean;
+    abortSignal?: AbortSignal;
+}): Promise<ValidationResult>;
+export declare function verifyPage({ pageCid, pageSortName, page, resolveAuthorNames, clientsManager, community, parentComment, validatePages, validateUpdateSignature, abortSignal }: {
+    pageCid: string | undefined;
+    pageSortName: string | undefined;
+    page: PageIpfs;
+    resolveAuthorNames: boolean;
+    clientsManager: BaseClientsManager;
+    community: CommunityForVerifyingPages;
+    parentComment: ParentCommentForVerifyingPages;
+    validatePages: boolean;
+    validateUpdateSignature: boolean;
+    abortSignal?: AbortSignal;
+}): Promise<ValidationResult>;
+export declare function verifyModQueuePage({ pageCid, page, resolveAuthorNames, clientsManager, community, validatePages, validateUpdateSignature, abortSignal }: {
+    pageCid: string | undefined;
+    page: ModQueuePageIpfs;
+    resolveAuthorNames: boolean;
+    clientsManager: BaseClientsManager;
+    community: CommunityForVerifyingPages;
+    validatePages: boolean;
+    validateUpdateSignature: boolean;
+    abortSignal?: AbortSignal;
+}): Promise<ValidationResult>;
+export {};