@peerbit/log 1.0.2

package/lib/esm/hrtime.js

@@ -0,0 +1,71 @@
+/*
+
+MIT License
+
+Copyright (c) 2020 Vlad Tansky
+Copyright (c) 2022 dao.xyz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+*/
+const _perfomancePolyfill = () => {
+    // based on https://gist.github.com/paulirish/5438650 copyright Paul Irish 2015.
+    if ("performance" in window === false) {
+        window.performance = {};
+    }
+    Date.now =
+        Date.now ||
+            (() => {
+                // thanks IE8
+                return new Date().getTime();
+            });
+    if ("now" in window.performance === false) {
+        let nowOffset = Date.now();
+        if (performance.timing && performance.timing.navigationStart) {
+            nowOffset = performance.timing.navigationStart;
+        }
+        window.performance.now = () => Date.now() - nowOffset;
+    }
+};
+const _hrtime = (previousTimestamp) => {
+    _perfomancePolyfill();
+    const baseNow = Math.floor((Date.now() - performance.now()) * 1e-3);
+    const clocktime = performance.now() * 1e-3;
+    let seconds = Math.floor(clocktime) + baseNow;
+    let nanoseconds = Math.floor((clocktime % 1) * 1e9);
+    if (previousTimestamp) {
+        seconds = seconds - previousTimestamp[0];
+        nanoseconds = nanoseconds - previousTimestamp[1];
+        if (nanoseconds < 0) {
+            seconds--;
+            nanoseconds += 1e9;
+        }
+    }
+    return [seconds, nanoseconds];
+};
+const NS_PER_SEC = 1e9;
+_hrtime.bigint = (time) => {
+    const diff = _hrtime(time);
+    return BigInt(diff[0] * NS_PER_SEC + diff[1]);
+};
+export default typeof process === "undefined" ||
+    typeof process.hrtime === "undefined"
+    ? _hrtime
+    : process.hrtime;
+//# sourceMappingURL=hrtime.js.map

package/lib/esm/hrtime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hrtime.js","sourceRoot":"","sources":["../../src/hrtime.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;EAyBE;AAEF,MAAM,mBAAmB,GAAG,GAAG,EAAE;IAChC,gFAAgF;IAChF,IAAI,aAAa,IAAI,MAAM,KAAK,KAAK,EAAE;QACrC,MAAM,CAAC,WAAmB,GAAG,EAAE,CAAC;KACjC;IAED,IAAI,CAAC,GAAG;QACP,IAAI,CAAC,GAAG;YACR,CAAC,GAAG,EAAE;gBACL,aAAa;gBACb,OAAO,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;YAC7B,CAAC,CAAC,CAAC;IAEJ,IAAI,KAAK,IAAI,MAAM,CAAC,WAAW,KAAK,KAAK,EAAE;QAC1C,IAAI,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAE3B,IAAI,WAAW,CAAC,MAAM,IAAI,WAAW,CAAC,MAAM,CAAC,eAAe,EAAE;YAC7D,SAAS,GAAG,WAAW,CAAC,MAAM,CAAC,eAAe,CAAC;SAC/C;QAED,MAAM,CAAC,WAAW,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;KACtD;AACF,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,CAAC,iBAAoC,EAAoB,EAAE;IAC1E,mBAAmB,EAAE,CAAC;IACtB,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;IACpE,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;IAC3C,IAAI,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC;IAC9C,IAAI,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;IAEpD,IAAI,iBAAiB,EAAE;QACtB,OAAO,GAAG,OAAO,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;QACzC,WAAW,GAAG,WAAW,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;QACjD,IAAI,WAAW,GAAG,CAAC,EAAE;YACpB,OAAO,EAAE,CAAC;YACV,WAAW,IAAI,GAAG,CAAC;SACnB;KACD;IACD,OAAO,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;AAC/B,CAAC,CAAC;AACF,MAAM,UAAU,GAAG,GAAG,CAAC;AACvB,OAAO,CAAC,MAAM,GAAG,CAAC,IAAuB,EAAU,EAAE;IACpD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/C,CAAC,CAAC;AAEF,eAAe,OAAO,OAAO,KAAK,WAAW;IAC7C,OAAO,OAAO,CAAC,MAAM,KAAK,WAAW;IACpC,CAAC,CAAC,OAAO;IACT,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC"}

package/lib/esm/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./log.js";
+export * from "./log-sorting.js";
+export * from "./log-errors.js";
+export * from "./snapshot.js";
+export * from "./entry.js";
+export * from "./utils.js";
+export * from "./clock.js";
+export * from "./encoding.js";
+export * from "./trim.js";
+export * from "./change.js";
+export type { TrimToByteLengthOption, TrimToLengthOption } from "./trim.js";

package/lib/esm/index.js

@@ -0,0 +1,11 @@
+export * from "./log.js";
+export * from "./log-sorting.js";
+export * from "./log-errors.js";
+export * from "./snapshot.js";
+export * from "./entry.js";
+export * from "./utils.js";
+export * from "./clock.js";
+export * from "./encoding.js";
+export * from "./trim.js";
+export * from "./change.js";
+//# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC"}

package/lib/esm/is-defined.d.ts

@@ -0,0 +1 @@
+export declare const isDefined: (arg: any) => boolean;

package/lib/esm/is-defined.js

@@ -0,0 +1,2 @@
+export const isDefined = (arg) => arg !== undefined && arg !== null;
+//# sourceMappingURL=is-defined.js.map

package/lib/esm/is-defined.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-defined.js","sourceRoot":"","sources":["../../src/is-defined.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAQ,EAAE,EAAE,CAAC,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,CAAC"}

package/lib/esm/log-errors.d.ts

@@ -0,0 +1,5 @@
+export declare const BlockStoreNotDefinedError: () => Error;
+export declare const LogNotDefinedError: () => Error;
+export declare const NotALogError: () => Error;
+export declare const CannotJoinWithDifferentId: () => Error;
+export declare const LtOrLteMustBeStringOrArray: () => Error;

package/lib/esm/log-errors.js

@@ -0,0 +1,6 @@
+export const BlockStoreNotDefinedError = () => new Error("Block store not defined");
+export const LogNotDefinedError = () => new Error("Log instance not defined");
+export const NotALogError = () => new Error("Given argument is not an instance of Log");
+export const CannotJoinWithDifferentId = () => new Error("Can't join logs with different IDs");
+export const LtOrLteMustBeStringOrArray = () => new Error("lt or lte must be a string or array of Entries");
+//# sourceMappingURL=log-errors.js.map

package/lib/esm/log-errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"log-errors.js","sourceRoot":"","sources":["../../src/log-errors.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,yBAAyB,GAAG,GAAG,EAAE,CAC7C,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;AACtC,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,EAAE,CAAC,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;AAC9E,MAAM,CAAC,MAAM,YAAY,GAAG,GAAG,EAAE,CAChC,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;AACvD,MAAM,CAAC,MAAM,yBAAyB,GAAG,GAAG,EAAE,CAC7C,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;AACjD,MAAM,CAAC,MAAM,0BAA0B,GAAG,GAAG,EAAE,CAC9C,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC"}

package/lib/esm/log-sorting.d.ts

@@ -0,0 +1,44 @@
+import { Entry } from "./entry.js";
+export type ISortFunction = <T>(a: Entry<T>, b: Entry<T>, resolveConflict?: (a: Entry<T>, b: Entry<T>) => number) => number;
+/**
+ * Sort two entries as Last-Write-Wins (LWW).
+ *
+ * Last Write Wins is a conflict resolution strategy for sorting elements
+ * where the element with a greater clock (latest) is chosen as the winner.
+ *
+ * @param {Entry} a First entry
+ * @param {Entry} b Second entry
+ * @returns {number} 1 if a is latest, -1 if b is latest
+ */
+export declare const LastWriteWins: ISortFunction;
+/**
+ * Sort two entries by their hash.
+ *
+ * @param {Entry} a First entry
+ * @param {Entry} b Second entry
+ * @returns {number} 1 if a is latest, -1 if b is latest
+ */
+export declare const SortByEntryHash: ISortFunction;
+/**
+ * Sort two entries by their clock time.
+ * @param {Entry} a First entry to compare
+ * @param {Entry} b Second entry to compare
+ * @param {function(a, b)} resolveConflict A function to call if entries are concurrent (happened at the same time). The function should take in two entries and return 1 if the first entry should be chosen and -1 if the second entry should be chosen.
+ * @returns {number} 1 if a is greater, -1 if b is greater
+ */
+export declare const SortByClocks: ISortFunction;
+/**
+ * Sort two entries by their clock id.
+ * @param {Entry} a First entry to compare
+ * @param {Entry} b Second entry to compare
+ * @param {function(a, b)} resolveConflict A function to call if the clocks ids are the same. The function should take in two entries and return 1 if the first entry should be chosen and -1 if the second entry should be chosen.
+ * @returns {number} 1 if a is greater, -1 if b is greater
+ */
+export declare const SortByClockId: ISortFunction;
+/**
+ * A wrapper function to throw an error if the results of a passed function return zero
+ * @param {function(a, b)} [tiebreaker] The tiebreaker function to validate.
+ * @returns {function(a, b)} 1 if a is greater, -1 if b is greater
+ * @throws {Error} if func ever returns 0
+ */
+export declare const NoZeroes: (func: ISortFunction) => <T>(a: Entry<T>, b: Entry<T>) => number;

package/lib/esm/log-sorting.js

@@ -0,0 +1,86 @@
+import { LamportClock as Clock } from "./clock.js";
+import { compare } from "@peerbit/uint8arrays";
+const First = (a, b) => a;
+/**
+ * Sort two entries as Last-Write-Wins (LWW).
+ *
+ * Last Write Wins is a conflict resolution strategy for sorting elements
+ * where the element with a greater clock (latest) is chosen as the winner.
+ *
+ * @param {Entry} a First entry
+ * @param {Entry} b Second entry
+ * @returns {number} 1 if a is latest, -1 if b is latest
+ */
+export const LastWriteWins = (a, b) => {
+    // Ultimate conflict resolution (take the first/left arg)
+    // Sort two entries by their clock id, if the same always take the first
+    const sortById = (a, b) => SortByClockId(a, b, First);
+    // Sort two entries by their clock time, if concurrent,
+    // determine sorting using provided conflict resolution function
+    const sortByEntryClocks = (a, b) => SortByClocks(a, b, sortById);
+    // Sort entries by clock time as the primary sort criteria
+    return sortByEntryClocks(a, b);
+};
+/**
+ * Sort two entries by their hash.
+ *
+ * @param {Entry} a First entry
+ * @param {Entry} b Second entry
+ * @returns {number} 1 if a is latest, -1 if b is latest
+ */
+export const SortByEntryHash = (a, b) => {
+    // Ultimate conflict resolution (compare hashes)
+    const compareHash = (a, b) => a.hash < b.hash ? -1 : 1;
+    // Sort two entries by their clock id, if the same then compare hashes
+    const sortById = (a, b) => SortByClockId(a, b, compareHash);
+    // Sort two entries by their clock time, if concurrent,
+    // determine sorting using provided conflict resolution function
+    const sortByEntryClocks = (a, b) => SortByClocks(a, b, sortById);
+    // Sort entries by clock time as the primary sort criteria
+    return sortByEntryClocks(a, b);
+};
+/**
+ * Sort two entries by their clock time.
+ * @param {Entry} a First entry to compare
+ * @param {Entry} b Second entry to compare
+ * @param {function(a, b)} resolveConflict A function to call if entries are concurrent (happened at the same time). The function should take in two entries and return 1 if the first entry should be chosen and -1 if the second entry should be chosen.
+ * @returns {number} 1 if a is greater, -1 if b is greater
+ */
+export const SortByClocks = (a, b, resolveConflict) => {
+    // Compare the clocks
+    const diff = Clock.compare(a.metadata.clock, b.metadata.clock);
+    // If the clocks are concurrent, use the provided
+    // conflict resolution function to determine which comes first
+    return diff === 0 ? (resolveConflict || First)(a, b) : diff;
+};
+/**
+ * Sort two entries by their clock id.
+ * @param {Entry} a First entry to compare
+ * @param {Entry} b Second entry to compare
+ * @param {function(a, b)} resolveConflict A function to call if the clocks ids are the same. The function should take in two entries and return 1 if the first entry should be chosen and -1 if the second entry should be chosen.
+ * @returns {number} 1 if a is greater, -1 if b is greater
+ */
+export const SortByClockId = (a, b, resolveConflict) => {
+    // Sort by ID if clocks are concurrent,
+    // take the entry with a "greater" clock id
+    const clockCompare = compare(a.metadata.clock.id, b.metadata.clock.id);
+    return clockCompare === 0 ? (resolveConflict || First)(a, b) : clockCompare;
+};
+/**
+ * A wrapper function to throw an error if the results of a passed function return zero
+ * @param {function(a, b)} [tiebreaker] The tiebreaker function to validate.
+ * @returns {function(a, b)} 1 if a is greater, -1 if b is greater
+ * @throws {Error} if func ever returns 0
+ */
+export const NoZeroes = (func) => {
+    const comparator = (a, b) => {
+        // Validate by calling the function
+        const result = func(a, b, (a, b) => -1);
+        if (result === 0) {
+            throw Error(`Your log's tiebreaker function, ${func.name}, has returned zero and therefore cannot be`);
+        }
+        return result;
+    };
+    return comparator;
+};
+//# sourceMappingURL=log-sorting.js.map

package/lib/esm/log-sorting.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"log-sorting.js","sourceRoot":"","sources":["../../src/log-sorting.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,IAAI,KAAK,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAE/C,MAAM,KAAK,GAAG,CAAC,CAAM,EAAE,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC;AAOpC;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,aAAa,GAAkB,CAAI,CAAW,EAAE,CAAW,EAAE,EAAE;IAC3E,yDAAyD;IACzD,wEAAwE;IACxE,MAAM,QAAQ,GAAG,CAAC,CAAW,EAAE,CAAW,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;IAC1E,uDAAuD;IACvD,gEAAgE;IAChE,MAAM,iBAAiB,GAAG,CAAC,CAAW,EAAE,CAAW,EAAE,EAAE,CACtD,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC9B,0DAA0D;IAC1D,OAAO,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAChC,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,eAAe,GAAkB,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;IACtD,gDAAgD;IAChD,MAAM,WAAW,GAAG,CAAC,CAAa,EAAE,CAAa,EAAE,EAAE,CACpD,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1B,sEAAsE;IACtE,MAAM,QAAQ,GAAG,CAAC,CAAa,EAAE,CAAa,EAAE,EAAE,CACjD,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,WAAW,CAAC,CAAC;IAClC,uDAAuD;IACvD,gEAAgE;IAChE,MAAM,iBAAiB,GAAG,CAAC,CAAa,EAAE,CAAa,EAAE,EAAE,CAC1D,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC9B,0DAA0D;IAC1D,OAAO,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAChC,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,YAAY,GAAkB,CAC1C,CAAW,EACX,CAAW,EACX,eAA0D,EACzD,EAAE;IACH,qBAAqB;IACrB,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC/D,iDAAiD;IACjD,8DAA8D;IAC9D,OAAO,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAC7D,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,aAAa,GAAkB,CAAC,CAAC,EAAE,CAAC,EAAE,eAAe,EAAE,EAAE;IACrE,uCAAuC;IACvC,2CAA2C;IAC3C,MAAM,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACvE,OAAO,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;AAC7E,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,IAAmB,EAAE,EAAE;IAC/C,MAAM,UAAU,GAAG,CAAI,CAAW,EAAE,CAAW,EAAE,EAAE;QAClD,mCAAmC;QACnC,MAAM,MAAM,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACxC,IAAI,MAAM,KAAK,CAAC,EAAE;YACjB,MAAM,KAAK,CACV,mCAAmC,IAAI,CAAC,IAAI,6CAA6C,CACzF,CAAC;SACF;QACD,OAAO,MAAM,CAAC;IACf,CAAC,CAAC;IAEF,OAAO,UAAU,CAAC;AACnB,CAAC,CAAC"}

package/lib/esm/log.d.ts

@@ -0,0 +1,205 @@
+import { SignatureWithKey, Identity, Keychain, X25519Keypair } from "@peerbit/crypto";
+import { SimpleLevel } from "@peerbit/lazy-level";
+import { EntryIndex } from "./entry-index.js";
+import * as Sorting from "./log-sorting.js";
+import { EncryptionTemplateMaybeEncrypted, Entry, Payload, CanAppend, EntryType } from "./entry.js";
+import { HLC, LamportClock, Timestamp } from "./clock.js";
+import { Encoding } from "./encoding.js";
+import { CacheUpdateOptions, HeadsIndex } from "./heads.js";
+import { Values } from "./values.js";
+import { TrimOptions } from "./trim.js";
+import { Change } from "./change.js";
+import { EntryWithRefs } from "./entry-with-refs.js";
+import { Blocks } from "@peerbit/blocks-interface";
+export type LogEvents<T> = {
+    onChange?: (change: Change<T>) => void;
+};
+export type MemoryProperties = {
+    cache?: SimpleLevel;
+};
+export type LogProperties<T> = {
+    keychain?: Keychain;
+    encoding?: Encoding<T>;
+    clock?: LamportClock;
+    sortFn?: Sorting.ISortFunction;
+    trim?: TrimOptions;
+    canAppend?: CanAppend<T>;
+};
+export type LogOptions<T> = LogProperties<T> & LogEvents<T> & MemoryProperties;
+export type AppendOptions<T> = {
+    type?: EntryType;
+    gidSeed?: Uint8Array;
+    nexts?: Entry<any>[];
+    identity?: Identity;
+    signers?: ((data: Uint8Array) => Promise<SignatureWithKey> | SignatureWithKey)[];
+    onGidsShadowed?: (gids: string[]) => void;
+    trim?: TrimOptions;
+    timestamp?: Timestamp;
+    encryption?: {
+        keypair: X25519Keypair;
+        reciever: EncryptionTemplateMaybeEncrypted;
+    };
+};
+export declare class Log<T> {
+    private _id;
+    private _sortFn;
+    private _storage;
+    private _hlc;
+    private _identity;
+    private _entryIndex;
+    private _headsIndex;
+    private _values;
+    private _nextsIndex;
+    private _keychain?;
+    private _encoding;
+    private _trim;
+    private _entryCache;
+    private _canAppend?;
+    private _onChange?;
+    private _closed;
+    private _memory?;
+    private _joining;
+    constructor(properties?: {
+        id?: Uint8Array;
+    });
+    open(store: Blocks, identity: Identity, options?: LogOptions<T>): Promise<void>;
+    private _idString;
+    get idString(): string;
+    static createIdString(id: Uint8Array): string;
+    get id(): Uint8Array;
+    set id(id: Uint8Array);
+    /**
+     * Returns the length of the log.
+     */
+    get length(): number;
+    get values(): Values<T>;
+    /**
+     * Checks if a entry is part of the log
+     * @param {string} hash The hash of the entry
+     * @returns {boolean}
+     */
+    has(cid: string): boolean;
+    /**
+     * Get all entries sorted. Don't use this method anywhere where performance matters
+     */
+    toArray(): Promise<Entry<T>[]>;
+    /**
+     * Returns the head index
+     */
+    get headsIndex(): HeadsIndex<T>;
+    get memory(): SimpleLevel | undefined;
+    /**
+     * Don't use this anywhere performance matters
+     */
+    getHeads(): Promise<Entry<T>[]>;
+    /**
+     * Returns an array of Entry objects that reference entries which
+     * are not in the log currently.
+     * @returns {Array<Entry<T>>}
+     */
+    getTails(): Promise<Entry<T>[]>;
+    /**
+     * Returns an array of hashes that are referenced by entries which
+     * are not in the log currently.
+     * @returns {Array<string>} Array of hashes
+     */
+    getTailHashes(): Promise<string[]>;
+    /**
+     * Get local HLC
+     */
+    get hlc(): HLC;
+    get identity(): Identity;
+    get storage(): Blocks;
+    get nextsIndex(): Map<string, Set<string>>;
+    get entryIndex(): EntryIndex<T>;
+    get keychain(): Keychain | undefined;
+    get encoding(): Encoding<T>;
+    get sortFn(): Sorting.ISortFunction;
+    get closed(): boolean;
+    /**
+     * Set the identity for the log
+     * @param {Identity} [identity] The identity to be set
+     */
+    setIdentity(identity: Identity): void;
+    /**
+     * Find an entry.
+     * @param {string} [hash] The hashes of the entry
+     */
+    get(hash: string, options?: {
+        timeout?: number;
+    }): Promise<Entry<T> | undefined>;
+    traverse(rootEntries: Entry<T>[], amount?: number, endHash?: string): Promise<{
+        [key: string]: Entry<T>;
+    }>;
+    getReferenceSamples(from: Entry<T>, options?: {
+        pointerCount?: number;
+        memoryLimit?: number;
+    }): Promise<Entry<T>[]>;
+    /**
+     * Append an entry to the log.
+     * @param {Entry} entry Entry to add
+     * @return {Log} New Log containing the appended value
+     */
+    append(data: T, options?: AppendOptions<T>): Promise<{
+        entry: Entry<T>;
+        removed: Entry<T>[];
+    }>;
+    reset(entries: Entry<T>[], heads?: (string | Entry<T>)[]): Promise<void>;
+    remove(entry: Entry<T> | Entry<T>[], options?: {
+        recursively?: boolean;
+    }): Promise<Change<T>>;
+    iterator(options?: {
+        from?: "tail" | "head";
+        amount?: number;
+    }): IterableIterator<string>;
+    trim(option?: TrimOptions | undefined): Promise<Entry<T>[]>;
+    /**
+     *
+     * @param entries
+     * @returns change
+     */
+    join(entriesOrLog: (string | Entry<T> | EntryWithRefs<T>)[] | Log<T>, options?: {
+        verifySignatures?: boolean;
+        trim?: TrimOptions;
+        timeout?: number;
+    } & CacheUpdateOptions): Promise<void>;
+    private joinEntry;
+    private processEntry;
+    deleteRecursively(from: Entry<any> | Entry<any>[], skipFirst?: boolean): Promise<Entry<T>[]>;
+    delete(entry: Entry<any>): Promise<void>;
+    /**
+     * Returns the log entries as a formatted string.
+     * @returns {string}
+     * @example
+     * two
+     * └─one
+     *   └─three
+     */
+    toString(payloadMapper?: (payload: Payload<T>) => string): Promise<string>;
+    idle(): Promise<void>;
+    close(): Promise<void>;
+    drop(): Promise<void>;
+    load(opts?: ({
+        fetchEntryTimeout?: number;
+    } & ({} | {
+        heads?: true;
+    })) & {
+        reload: boolean;
+    }): Promise<void>;
+    static fromEntry<T>(store: Blocks, identity: Identity, entryOrHash: string | string[] | Entry<T> | Entry<T>[], options?: {
+        id?: Uint8Array;
+        timeout?: number;
+    } & LogOptions<T>): Promise<Log<T>>;
+    /**
+     * Find heads from a collection of entries.
+     *
+     * Finds entries that are the heads of this collection,
+     * ie. entries that are not referenced by other entries.
+     *
+     * @param {Array<Entry<T>>} entries Entries to search heads from
+     * @returns {Array<Entry<T>>}
+     */
+    static findHeads<T>(entries: Entry<T>[]): Entry<T>[];
+    static findTails<T>(entries: Entry<T>[]): Entry<T>[];
+    static findTailHashes(entries: Entry<any>[]): string[];
+}