@arkiv-network/sdk 0.0.25

package/dist/_esm/query/errors.js

@@ -0,0 +1,16 @@
+export class NoMoreResultsError extends Error {
+    constructor() {
+        super("No more results");
+    }
+}
+export class NoOffsetOrLimitError extends Error {
+    constructor() {
+        super("Offset and limit must be defined to fetch next or previous");
+    }
+}
+export class OffsetCannotBeLessThanZeroError extends Error {
+    constructor() {
+        super("Offset cannot be less than 0");
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/_esm/query/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/query/errors.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAC5C;QACC,KAAK,CAAC,iBAAiB,CAAC,CAAA;IACzB,CAAC;CACD;AAED,MAAM,OAAO,oBAAqB,SAAQ,KAAK;IAC9C;QACC,KAAK,CAAC,4DAA4D,CAAC,CAAA;IACpE,CAAC;CACD;AAED,MAAM,OAAO,+BAAgC,SAAQ,KAAK;IACzD;QACC,KAAK,CAAC,8BAA8B,CAAC,CAAA;IACtC,CAAC;CACD"}

package/dist/_esm/query/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./errors";
+export * from "./predicate";
+export * from "./queryBuilder";
+export * from "./queryResult";
+//# sourceMappingURL=index.d.ts.map

package/dist/_esm/query/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/query/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,eAAe,CAAA"}

package/dist/_esm/query/index.js

@@ -0,0 +1,5 @@
+export * from "./errors";
+export * from "./predicate";
+export * from "./queryBuilder";
+export * from "./queryResult";
+//# sourceMappingURL=index.js.map

package/dist/_esm/query/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/query/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,eAAe,CAAA"}

package/dist/_esm/query/predicate.d.ts

@@ -0,0 +1,111 @@
+export type PredicateType = "eq" | "neq" | "gt" | "gte" | "lt" | "lte" | "not";
+export type PredicateContainerType = "or" | "and";
+export type Predicate = {
+    type: PredicateType;
+    key: string;
+    value: string | number;
+} | {
+    type: PredicateContainerType;
+    predicates: Predicate[];
+};
+/**
+ * Creates an OR predicate
+ * @param predicates - The predicates to combine
+ * @returns The OR predicate
+ *
+ * @example
+ * const predicates = [eq("name", "John"), eq("age", 30)]
+ * const result = or(predicates)
+ * // result = { type: "or", predicates: [eq("name", "John"), eq("age", 30)] }
+ *
+ */
+export declare function or(predicates: Predicate[]): Predicate;
+/**
+ * Creates an AND predicate
+ * @param predicates - The predicates to combine
+ * @returns The AND predicate
+ *
+ * @example
+ * const predicates = [eq("name", "John"), eq("age", 30)]
+ * const result = and(predicates)
+ * // result = { type: "and", predicates: [eq("name", "John"), eq("age", 30)] }
+ *
+ */
+export declare function and(predicates: Predicate[]): Predicate;
+/**
+ * Creates an equality predicate
+ * @param key - The key to compare
+ * @param value - The value to compare
+ * @returns The equality predicate
+ *
+ * @example
+ * const predicate = eq("name", "John")
+ * // result = { type: "eq", key: "name", value: "John" }
+ */
+export declare function eq(key: string, value: string | number): Predicate;
+/**
+ * Creates a not equal predicate
+ * @param key - The key to compare
+ * @param value - The value to compare
+ * @returns The not equal predicate
+ *
+ * @example
+ * const predicate = neq("name", "John")
+ * // result = { type: "neq", key: "name", value: "John" }
+ */
+export declare function neq(key: string, value: string | number): Predicate;
+/**
+ * Creates a greater than predicate
+ * @param key - The key to compare
+ * @param value - The value to compare
+ * @returns The greater than predicate
+ *
+ * @example
+ * const predicate = gt("name", "John")
+ * // result = { type: "gt", key: "name", value: "John" }
+ */
+export declare function gt(key: string, value: string | number): Predicate;
+/**
+ * Creates a greater than or equal predicate
+ * @param key - The key to compare
+ * @param value - The value to compare
+ * @returns The greater than or equal predicate
+ *
+ * @example
+ * const predicate = gte("name", "John")
+ * // result = { type: "gte", key: "name", value: "John" }
+ */
+export declare function gte(key: string, value: string | number): Predicate;
+/**
+ * Creates a less than predicate
+ * @param key - The key to compare
+ * @param value - The value to compare
+ * @returns The less than predicate
+ *
+ * @example
+ * const predicate = lt("name", "John")
+ * // result = { type: "lt", key: "name", value: "John" }
+ */
+export declare function lt(key: string, value: string | number): Predicate;
+/**
+ * Creates a less than or equal predicate
+ * @param key - The key to compare
+ * @param value - The value to compare
+ * @returns The less than or equal predicate
+ *
+ * @example
+ * const predicate = lte("name", "John")
+ * // result = { type: "lte", key: "name", value: "John" }
+ */
+export declare function lte(key: string, value: string | number): Predicate;
+/**
+ * Creates a not predicate
+ * @param key - The key to compare
+ * @returns The not predicate
+ *
+ * @example
+ * const predicate = not("name")
+ * // result = { type: "not", key: "name", value: "" }
+ */
+export declare function not(key: string): Predicate;
+//# sourceMappingURL=predicate.d.ts.map

package/dist/_esm/query/predicate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"predicate.d.ts","sourceRoot":"","sources":["../../../src/query/predicate.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,GAAG,KAAK,CAAA;AAC9E,MAAM,MAAM,sBAAsB,GAAG,IAAI,GAAG,KAAK,CAAA;AAEjD,MAAM,MAAM,SAAS,GAClB;IACA,IAAI,EAAE,aAAa,CAAA;IACnB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;CACrB,GACD;IACA,IAAI,EAAE,sBAAsB,CAAA;IAC5B,UAAU,EAAE,SAAS,EAAE,CAAA;CACtB,CAAA;AAEJ;;;;;;;;;;GAUG;AACH,wBAAgB,EAAE,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,SAAS,CAErD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,GAAG,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,SAAS,CAEtD;AAED;;;;;;;;;GASG;AACH,wBAAgB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAEjE;AAED;;;;;;;;;GASG;AACH,wBAAgB,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAElE;AAED;;;;;;;;;GASG;AACH,wBAAgB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAEjE;AAED;;;;;;;;;GASG;AACH,wBAAgB,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAElE;AAED;;;;;;;;;GASG;AACH,wBAAgB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAEjE;AAED;;;;;;;;;GASG;AACH,wBAAgB,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAElE;AAED;;;;;;;;GAQG;AACH,wBAAgB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAE1C"}

package/dist/_esm/query/predicate.js

@@ -0,0 +1,119 @@
+/**
+ * Creates an OR predicate
+ * @param predicates - The predicates to combine
+ * @returns The OR predicate
+ *
+ * @example
+ * const predicates = [eq("name", "John"), eq("age", 30)]
+ * const result = or(predicates)
+ * // result = { type: "or", predicates: [eq("name", "John"), eq("age", 30)] }
+ *
+ */
+export function or(predicates) {
+    return { type: "or", predicates };
+}
+/**
+ * Creates an AND predicate
+ * @param predicates - The predicates to combine
+ * @returns The AND predicate
+ *
+ * @example
+ * const predicates = [eq("name", "John"), eq("age", 30)]
+ * const result = and(predicates)
+ * // result = { type: "and", predicates: [eq("name", "John"), eq("age", 30)] }
+ *
+ */
+export function and(predicates) {
+    return { type: "and", predicates };
+}
+/**
+ * Creates an equality predicate
+ * @param key - The key to compare
+ * @param value - The value to compare
+ * @returns The equality predicate
+ *
+ * @example
+ * const predicate = eq("name", "John")
+ * // result = { type: "eq", key: "name", value: "John" }
+ */
+export function eq(key, value) {
+    return { type: "eq", key, value };
+}
+/**
+ * Creates a not equal predicate
+ * @param key - The key to compare
+ * @param value - The value to compare
+ * @returns The not equal predicate
+ *
+ * @example
+ * const predicate = neq("name", "John")
+ * // result = { type: "neq", key: "name", value: "John" }
+ */
+export function neq(key, value) {
+    return { type: "neq", key, value };
+}
+/**
+ * Creates a greater than predicate
+ * @param key - The key to compare
+ * @param value - The value to compare
+ * @returns The greater than predicate
+ *
+ * @example
+ * const predicate = gt("name", "John")
+ * // result = { type: "gt", key: "name", value: "John" }
+ */
+export function gt(key, value) {
+    return { type: "gt", key, value };
+}
+/**
+ * Creates a greater than or equal predicate
+ * @param key - The key to compare
+ * @param value - The value to compare
+ * @returns The greater than or equal predicate
+ *
+ * @example
+ * const predicate = gte("name", "John")
+ * // result = { type: "gte", key: "name", value: "John" }
+ */
+export function gte(key, value) {
+    return { type: "gte", key, value };
+}
+/**
+ * Creates a less than predicate
+ * @param key - The key to compare
+ * @param value - The value to compare
+ * @returns The less than predicate
+ *
+ * @example
+ * const predicate = lt("name", "John")
+ * // result = { type: "lt", key: "name", value: "John" }
+ */
+export function lt(key, value) {
+    return { type: "lt", key, value };
+}
+/**
+ * Creates a less than or equal predicate
+ * @param key - The key to compare
+ * @param value - The value to compare
+ * @returns The less than or equal predicate
+ *
+ * @example
+ * const predicate = lte("name", "John")
+ * // result = { type: "lte", key: "name", value: "John" }
+ */
+export function lte(key, value) {
+    return { type: "lte", key, value };
+}
+/**
+ * Creates a not predicate
+ * @param key - The key to compare
+ * @returns The not predicate
+ *
+ * @example
+ * const predicate = not("name")
+ * // result = { type: "not", key: "name", value: "" }
+ */
+export function not(key) {
+    return { type: "not", key, value: "" };
+}
+//# sourceMappingURL=predicate.js.map

package/dist/_esm/query/predicate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"predicate.js","sourceRoot":"","sources":["../../../src/query/predicate.ts"],"names":[],"mappings":"AAcA;;;;;;;;;;GAUG;AACH,MAAM,UAAU,EAAE,CAAC,UAAuB;IACzC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,CAAA;AAClC,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,GAAG,CAAC,UAAuB;IAC1C,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,CAAA;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,EAAE,CAAC,GAAW,EAAE,KAAsB;IACrD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,CAAA;AAClC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,KAAsB;IACtD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAA;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,EAAE,CAAC,GAAW,EAAE,KAAsB;IACrD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,CAAA;AAClC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,KAAsB;IACtD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAA;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,EAAE,CAAC,GAAW,EAAE,KAAsB;IACrD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,CAAA;AAClC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,KAAsB;IACtD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAA;AACnC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,GAAG,CAAC,GAAW;IAC9B,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,CAAA;AACvC,CAAC"}

package/dist/_esm/query/queryBuilder.d.ts

@@ -0,0 +1,110 @@
+import type { Hex } from "viem";
+import type { ArkivClient } from "../clients/baseClient";
+import type { Predicate } from "./predicate";
+import { QueryResult } from "./queryResult";
+/**
+ * QueryBuilder is a helper class to build queries to the Arkiv DBChains.
+ * It can be used to fetch entities from the Arkiv DBChains. It follows the Builder pattern allowing chaining of methods.
+ * @param client - The Arkiv client
+ * @returns The QueryBuilder instance {@link QueryBuilder}
+ */
+export declare class QueryBuilder {
+    private _client;
+    private _ownedBy;
+    private _validBeforeBlock;
+    private _withAnnotations;
+    private _withMetadata;
+    private _limit;
+    private _offset;
+    private _predicates;
+    constructor(client: ArkivClient);
+    /**
+     * Sets the ownedBy filter
+     * @param ownedBy - The address of the owner
+     * @returns The QueryBuilder instance
+     *
+     * @example
+     * const builder = new QueryBuilder(client)
+     * builder.ownedBy("0x1234567890123456789012345678901234567890")
+     */
+    ownedBy(ownedBy: Hex): this;
+    /**
+     * Sets the withAnnotations flag which will return the annotations for the entities if true
+     * @param withAnnotations - The boolean value to set
+     * @returns The QueryBuilder instance
+     *
+     * @example
+     * const builder = new QueryBuilder(client)
+     * builder.withAnnotations(true)
+     */
+    withAnnotations(withAnnotations?: boolean): this;
+    /**
+     * Sets the withMetadata flag which will return the metadata (like owner, expiredAt, etc.) for the entities if true
+     * @param withMetadata - The boolean value to set
+     * @returns The QueryBuilder instance
+     *
+     * @example
+     * const builder = new QueryBuilder(client)
+     * builder.withMetadata(true)
+     */
+    withMetadata(withMetadata?: boolean): this;
+    /**
+     * Sets the limit for the query
+     * @param limit - The number of entities to return
+     * @returns The QueryBuilder instance
+     *
+     * @example
+     * const builder = new QueryBuilder(client)
+     * builder.limit(10)
+     */
+    limit(limit: number): this;
+    /**
+     * Sets the offset for the query
+     * @param offset - The number of entities to skip
+     * @returns The QueryBuilder instance
+     *
+     * @example
+     * const builder = new QueryBuilder(client)
+     * builder.offset(10)
+     */
+    offset(offset: number): this;
+    /**
+     * Sets the predicates for the query limiting the results. It can be a single predicate or an array of predicates combined with 'and'.
+     * Predicates can be nested using 'or' and 'and' predicates.
+     * @param predicates - The predicates to set
+     * @returns The QueryBuilder instance
+     *
+     * @example
+     * const builder = new QueryBuilder(client)
+     * builder.where(eq("name", "John"))
+     * builder.where([eq("name", "John"), eq("age", 30)])
+     * builder.where([eq("name", "John"), or([eq("age", 30), eq("age", 31)])])
+     * builder.where([eq("name", "John"), and([eq("age", 30), eq("age", 31)])])
+     * builder.where([eq("name", "John"), or([eq("age", 30), and([eq("age", 31), eq("age", 32)])])])
+     * builder.where([eq("name", "John"), and([eq("age", 30), or([eq("age", 31), eq("age", 32)])])])
+     * builder.where([eq("name", "John"), and([eq("age", 30), or([eq("age", 31), and([eq("age", 32), eq("age", 33)])])])])
+     */
+    where(predicates: Predicate[] | Predicate): this;
+    /**
+     * Fetches the entities from the query. Re
+     * It will return a QueryResult instance which can be used to fetch the next and previous pages.
+     * @returns The QueryResult instance {@link QueryResult}
+     *
+     * @example
+     * const builder = new QueryBuilder(client)
+     * const result = await builder.where(eq("name", "John")).fetch()
+     * // result = { entities: [Entity, Entity, Entity], next: async () => QueryResult, previous: async () => QueryResult }
+     */
+    fetch(): Promise<QueryResult>;
+    /**
+     * Counts the entities from the query.
+     * @returns The number of entities
+     *
+     * @example
+     * const builder = new QueryBuilder(client)
+     * const result = await builder.where(eq("name", "John")).count()
+     * // result = 10
+     */
+    count(): Promise<1>;
+}
+//# sourceMappingURL=queryBuilder.d.ts.map

package/dist/_esm/query/queryBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryBuilder.d.ts","sourceRoot":"","sources":["../../../src/query/queryBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,MAAM,CAAA;AAC/B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAGxD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAE3C;;;;;GAKG;AACH,qBAAa,YAAY;IACxB,OAAO,CAAC,OAAO,CAAa;IAC5B,OAAO,CAAC,QAAQ,CAAiB;IACjC,OAAO,CAAC,iBAAiB,CAAoB;IAC7C,OAAO,CAAC,gBAAgB,CAAqB;IAC7C,OAAO,CAAC,aAAa,CAAqB;IAC1C,OAAO,CAAC,MAAM,CAAoB;IAClC,OAAO,CAAC,OAAO,CAAoB;IACnC,OAAO,CAAC,WAAW,CAAa;gBAEpB,MAAM,EAAE,WAAW;IAK/B;;;;;;;;OAQG;IACH,OAAO,CAAC,OAAO,EAAE,GAAG;IAKpB;;;;;;;;OAQG;IACH,eAAe,CAAC,eAAe,GAAE,OAAc;IAK/C;;;;;;;;OAQG;IACH,YAAY,CAAC,YAAY,GAAE,OAAc;IAKzC;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM;IAKnB;;;;;;;;OAQG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM;IAKrB;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,SAAS;IASzC;;;;;;;;;OASG;IACG,KAAK;IAkBX;;;;;;;;OAQG;IACG,KAAK;CAaX"}

package/dist/_esm/query/queryBuilder.js

@@ -0,0 +1,158 @@
+import { entityFromRpcResult } from "../utils/entities";
+import { processQuery } from "./engine";
+import { QueryResult } from "./queryResult";
+/**
+ * QueryBuilder is a helper class to build queries to the Arkiv DBChains.
+ * It can be used to fetch entities from the Arkiv DBChains. It follows the Builder pattern allowing chaining of methods.
+ * @param client - The Arkiv client
+ * @returns The QueryBuilder instance {@link QueryBuilder}
+ */
+export class QueryBuilder {
+    _client;
+    _ownedBy;
+    _validBeforeBlock;
+    _withAnnotations;
+    _withMetadata;
+    _limit;
+    _offset;
+    _predicates;
+    constructor(client) {
+        this._client = client;
+        this._predicates = [];
+    }
+    /**
+     * Sets the ownedBy filter
+     * @param ownedBy - The address of the owner
+     * @returns The QueryBuilder instance
+     *
+     * @example
+     * const builder = new QueryBuilder(client)
+     * builder.ownedBy("0x1234567890123456789012345678901234567890")
+     */
+    ownedBy(ownedBy) {
+        this._ownedBy = ownedBy;
+        return this;
+    }
+    /**
+     * Sets the withAnnotations flag which will return the annotations for the entities if true
+     * @param withAnnotations - The boolean value to set
+     * @returns The QueryBuilder instance
+     *
+     * @example
+     * const builder = new QueryBuilder(client)
+     * builder.withAnnotations(true)
+     */
+    withAnnotations(withAnnotations = true) {
+        this._withAnnotations = withAnnotations;
+        return this;
+    }
+    /**
+     * Sets the withMetadata flag which will return the metadata (like owner, expiredAt, etc.) for the entities if true
+     * @param withMetadata - The boolean value to set
+     * @returns The QueryBuilder instance
+     *
+     * @example
+     * const builder = new QueryBuilder(client)
+     * builder.withMetadata(true)
+     */
+    withMetadata(withMetadata = true) {
+        this._withMetadata = withMetadata;
+        return this;
+    }
+    /**
+     * Sets the limit for the query
+     * @param limit - The number of entities to return
+     * @returns The QueryBuilder instance
+     *
+     * @example
+     * const builder = new QueryBuilder(client)
+     * builder.limit(10)
+     */
+    limit(limit) {
+        this._limit = limit;
+        return this;
+    }
+    /**
+     * Sets the offset for the query
+     * @param offset - The number of entities to skip
+     * @returns The QueryBuilder instance
+     *
+     * @example
+     * const builder = new QueryBuilder(client)
+     * builder.offset(10)
+     */
+    offset(offset) {
+        this._offset = offset;
+        return this;
+    }
+    /**
+     * Sets the predicates for the query limiting the results. It can be a single predicate or an array of predicates combined with 'and'.
+     * Predicates can be nested using 'or' and 'and' predicates.
+     * @param predicates - The predicates to set
+     * @returns The QueryBuilder instance
+     *
+     * @example
+     * const builder = new QueryBuilder(client)
+     * builder.where(eq("name", "John"))
+     * builder.where([eq("name", "John"), eq("age", 30)])
+     * builder.where([eq("name", "John"), or([eq("age", 30), eq("age", 31)])])
+     * builder.where([eq("name", "John"), and([eq("age", 30), eq("age", 31)])])
+     * builder.where([eq("name", "John"), or([eq("age", 30), and([eq("age", 31), eq("age", 32)])])])
+     * builder.where([eq("name", "John"), and([eq("age", 30), or([eq("age", 31), eq("age", 32)])])])
+     * builder.where([eq("name", "John"), and([eq("age", 30), or([eq("age", 31), and([eq("age", 32), eq("age", 33)])])])])
+     */
+    where(predicates) {
+        if (Array.isArray(predicates)) {
+            this._predicates.push(...predicates);
+        }
+        else {
+            this._predicates.push(predicates);
+        }
+        return this;
+    }
+    /**
+     * Fetches the entities from the query. Re
+     * It will return a QueryResult instance which can be used to fetch the next and previous pages.
+     * @returns The QueryResult instance {@link QueryResult}
+     *
+     * @example
+     * const builder = new QueryBuilder(client)
+     * const result = await builder.where(eq("name", "John")).fetch()
+     * // result = { entities: [Entity, Entity, Entity], next: async () => QueryResult, previous: async () => QueryResult }
+     */
+    async fetch() {
+        const queryResult = await processQuery(this._client, {
+            predicates: this._predicates,
+            limit: this._limit,
+            offset: this._offset,
+            ownedBy: this._ownedBy,
+            validBeforeBlock: this._validBeforeBlock,
+            withAnnotations: this._withAnnotations,
+            withMetadata: this._withMetadata,
+        });
+        const entities = await Promise.all(queryResult.map((entity) => entityFromRpcResult(this._client, entity.key, entity.value)));
+        return new QueryResult(entities, this, this._limit, this._offset);
+    }
+    /**
+     * Counts the entities from the query.
+     * @returns The number of entities
+     *
+     * @example
+     * const builder = new QueryBuilder(client)
+     * const result = await builder.where(eq("name", "John")).count()
+     * // result = 10
+     */
+    async count() {
+        const queryResult = await processQuery(this._client, {
+            predicates: this._predicates,
+            limit: this._limit,
+            offset: this._offset,
+            ownedBy: this._ownedBy,
+            validBeforeBlock: this._validBeforeBlock,
+            withAnnotations: this._withAnnotations,
+            withMetadata: this._withMetadata,
+        });
+        return queryResult.length;
+    }
+}
+//# sourceMappingURL=queryBuilder.js.map

package/dist/_esm/query/queryBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryBuilder.js","sourceRoot":"","sources":["../../../src/query/queryBuilder.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAEvC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAE3C;;;;;GAKG;AACH,MAAM,OAAO,YAAY;IAChB,OAAO,CAAa;IACpB,QAAQ,CAAiB;IACzB,iBAAiB,CAAoB;IACrC,gBAAgB,CAAqB;IACrC,aAAa,CAAqB;IAClC,MAAM,CAAoB;IAC1B,OAAO,CAAoB;IAC3B,WAAW,CAAa;IAEhC,YAAY,MAAmB;QAC9B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAA;IACtB,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,OAAY;QACnB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;QACvB,OAAO,IAAI,CAAA;IACZ,CAAC;IAED;;;;;;;;OAQG;IACH,eAAe,CAAC,kBAA2B,IAAI;QAC9C,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAA;QACvC,OAAO,IAAI,CAAA;IACZ,CAAC;IAED;;;;;;;;OAQG;IACH,YAAY,CAAC,eAAwB,IAAI;QACxC,IAAI,CAAC,aAAa,GAAG,YAAY,CAAA;QACjC,OAAO,IAAI,CAAA;IACZ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAa;QAClB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QACnB,OAAO,IAAI,CAAA;IACZ,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,MAAc;QACpB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,OAAO,IAAI,CAAA;IACZ,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,UAAmC;QACxC,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YAC/B,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAA;QACrC,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;QACD,OAAO,IAAI,CAAA;IACZ,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,KAAK;QACV,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE;YACpD,UAAU,EAAE,IAAI,CAAC,WAAW;YAC5B,KAAK,EAAE,IAAI,CAAC,MAAM;YAClB,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,OAAO,EAAE,IAAI,CAAC,QAAQ;YACtB,gBAAgB,EAAE,IAAI,CAAC,iBAAiB;YACxC,eAAe,EAAE,IAAI,CAAC,gBAAgB;YACtC,YAAY,EAAE,IAAI,CAAC,aAAa;SAChC,CAAC,CAAA;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CACjC,WAAW,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CACxF,CAAA;QAED,OAAO,IAAI,WAAW,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;IAClE,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK;QACV,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE;YACpD,UAAU,EAAE,IAAI,CAAC,WAAW;YAC5B,KAAK,EAAE,IAAI,CAAC,MAAM;YAClB,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,OAAO,EAAE,IAAI,CAAC,QAAQ;YACtB,gBAAgB,EAAE,IAAI,CAAC,iBAAiB;YACxC,eAAe,EAAE,IAAI,CAAC,gBAAgB;YACtC,YAAY,EAAE,IAAI,CAAC,aAAa;SAChC,CAAC,CAAA;QAEF,OAAO,WAAW,CAAC,MAAM,CAAA;IAC1B,CAAC;CACD"}

package/dist/_esm/query/queryResult.d.ts

@@ -0,0 +1,12 @@
+import type { Entity } from "../types/entity";
+import type { QueryBuilder } from "./queryBuilder";
+export declare class QueryResult {
+    entities: Entity[];
+    private limit;
+    private offset;
+    private queryBuilder;
+    constructor(entities: Entity[], queryBuilder: QueryBuilder, limit?: number | undefined, offset?: number | undefined);
+    next(): Promise<void>;
+    previous(): Promise<void>;
+}
+//# sourceMappingURL=queryResult.d.ts.map

package/dist/_esm/query/queryResult.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryResult.d.ts","sourceRoot":"","sources":["../../../src/query/queryResult.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAE7C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAElD,qBAAa,WAAW;IACvB,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,OAAO,CAAC,KAAK,CAAoB;IACjC,OAAO,CAAC,MAAM,CAAoB;IAClC,OAAO,CAAC,YAAY,CAAc;gBAGjC,QAAQ,EAAE,MAAM,EAAE,EAClB,YAAY,EAAE,YAAY,EAC1B,KAAK,GAAE,MAAM,GAAG,SAAqB,EACrC,MAAM,GAAE,MAAM,GAAG,SAAqB;IAQjC,IAAI;IAYJ,QAAQ;CAWd"}

package/dist/_esm/query/queryResult.js

@@ -0,0 +1,36 @@
+import { NoMoreResultsError, NoOffsetOrLimitError, OffsetCannotBeLessThanZeroError } from "./errors";
+export class QueryResult {
+    entities;
+    limit;
+    offset;
+    queryBuilder;
+    constructor(entities, queryBuilder, limit = undefined, offset = undefined) {
+        this.entities = entities;
+        this.limit = limit;
+        this.offset = offset;
+        this.queryBuilder = queryBuilder;
+    }
+    async next() {
+        if (this.offset === undefined || this.limit === undefined) {
+            throw new NoOffsetOrLimitError();
+        }
+        if (this.limit < this.entities.length) {
+            throw new NoMoreResultsError();
+        }
+        this.offset += this.limit;
+        const result = await this.queryBuilder.offset(this.offset).fetch();
+        this.entities = result.entities;
+    }
+    async previous() {
+        if (this.offset === undefined || this.limit === undefined) {
+            throw new NoOffsetOrLimitError();
+        }
+        if (this.offset - this.limit < 0) {
+            throw new OffsetCannotBeLessThanZeroError();
+        }
+        this.offset -= this.limit;
+        const result = await this.queryBuilder.offset(this.offset).fetch();
+        this.entities = result.entities;
+    }
+}
+//# sourceMappingURL=queryResult.js.map

package/dist/_esm/query/queryResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryResult.js","sourceRoot":"","sources":["../../../src/query/queryResult.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,+BAA+B,EAAE,MAAM,UAAU,CAAA;AAGpG,MAAM,OAAO,WAAW;IACvB,QAAQ,CAAU;IACV,KAAK,CAAoB;IACzB,MAAM,CAAoB;IAC1B,YAAY,CAAc;IAElC,YACC,QAAkB,EAClB,YAA0B,EAC1B,QAA4B,SAAS,EACrC,SAA6B,SAAS;QAEtC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;IACjC,CAAC;IAED,KAAK,CAAC,IAAI;QACT,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC3D,MAAM,IAAI,oBAAoB,EAAE,CAAA;QACjC,CAAC;QACD,IAAI,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YACvC,MAAM,IAAI,kBAAkB,EAAE,CAAA;QAC/B,CAAC;QACD,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,CAAA;QACzB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,CAAA;QAClE,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAA;IAChC,CAAC;IAED,KAAK,CAAC,QAAQ;QACb,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC3D,MAAM,IAAI,oBAAoB,EAAE,CAAA;QACjC,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,+BAA+B,EAAE,CAAA;QAC5C,CAAC;QACD,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,CAAA;QACzB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,CAAA;QAClE,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAA;IAChC,CAAC;CACD"}

package/dist/_esm/types/annotation.d.ts

@@ -0,0 +1,5 @@
+export type Annotation = {
+    key: string;
+    value: string | number;
+};
+//# sourceMappingURL=annotation.d.ts.map

package/dist/_esm/types/annotation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"annotation.d.ts","sourceRoot":"","sources":["../../../src/types/annotation.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB,CAAA"}

package/dist/_esm/types/annotation.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=annotation.js.map

package/dist/_esm/types/annotation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"annotation.js","sourceRoot":"","sources":["../../../src/types/annotation.ts"],"names":[],"mappings":""}

package/dist/_esm/types/entity.d.ts

@@ -0,0 +1,13 @@
+import { type Hex } from "viem";
+import type { Annotation } from "./annotation";
+export declare class Entity {
+    key: Hex;
+    owner: Hex;
+    expiresAtBlock: number;
+    payload: Uint8Array;
+    annotations: Annotation[];
+    constructor(key: Hex, owner: Hex, expiresAtBlock: number, payload: Uint8Array, annotations: Annotation[]);
+    toText(): string;
+    toJson(): any;
+}
+//# sourceMappingURL=entity.d.ts.map

package/dist/_esm/types/entity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../../../src/types/entity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,GAAG,EAAE,MAAM,MAAM,CAAA;AAC9C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAE9C,qBAAa,MAAM;IAClB,GAAG,EAAE,GAAG,CAAA;IACR,KAAK,EAAE,GAAG,CAAA;IACV,cAAc,EAAE,MAAM,CAAA;IACtB,OAAO,EAAE,UAAU,CAAA;IACnB,WAAW,EAAE,UAAU,EAAE,CAAA;gBAGxB,GAAG,EAAE,GAAG,EACR,KAAK,EAAE,GAAG,EACV,cAAc,EAAE,MAAM,EACtB,OAAO,EAAE,UAAU,EACnB,WAAW,EAAE,UAAU,EAAE;IAS1B,MAAM,IAAI,MAAM;IAIhB,MAAM,IAAI,GAAG;CASb"}