@arkiv-network/sdk 0.0.36-dev.1 → 0.0.36-dev.4

package/dist/_cjs/query/predicate.js

@@ -0,0 +1,130 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.or = or;
+exports.and = and;
+exports.eq = eq;
+exports.neq = neq;
+exports.gt = gt;
+exports.gte = gte;
+exports.lt = lt;
+exports.lte = lte;
+exports.not = not;
+/**
+ * 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)] }
+ *
+ */
+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)] }
+ *
+ */
+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" }
+ */
+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" }
+ */
+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" }
+ */
+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" }
+ */
+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" }
+ */
+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" }
+ */
+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: "" }
+ */
+function not(key) {
+    return { type: "not", key, value: "" };
+}
+//# sourceMappingURL=predicate.js.map

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

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

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

@@ -0,0 +1,132 @@
+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 _validAtBlock;
+    private _withAnnotations;
+    private _withMetadata;
+    private _withPayload;
+    private _limit;
+    private _cursor;
+    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 withPayload flag which will return the payload for the entities if true
+     * @param withPayload - The boolean value to set
+     * @returns The QueryBuilder instance
+     *
+     * @example
+     * const builder = new QueryBuilder(client)
+     * builder.withPayload(true)
+     */
+    withPayload(withPayload?: 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 cursor for the query - it is advances setting which rather shouldn't be used manually but it is provided from query result if limit is used (pagination).
+     * @param cursor - The cursor to set which tells to RPC Query server where to start or continue the query.
+     * @returns The QueryBuilder instance
+     *
+     * @example
+     * const builder = new QueryBuilder(client)
+     * builder.offset(10)
+     */
+    cursor(cursor: string): this;
+    /**
+     * Sets the validAtBlock for the query which tells at which block height the state we are intested.
+     * If not set, the latest block is  used.
+     * @param validAtBlock - The block number to set
+     * @returns The QueryBuilder instance
+     *
+     * @example
+     * const builder = new QueryBuilder(client)
+     * builder.validAtBlock(10000)
+     */
+    validAtBlock(validAtBlock: bigint): 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/_cjs/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,aAAa,CAAoB;IACzC,OAAO,CAAC,gBAAgB,CAAqB;IAC7C,OAAO,CAAC,aAAa,CAAqB;IAC1C,OAAO,CAAC,YAAY,CAAqB;IACzC,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,WAAW,CAAC,WAAW,GAAE,OAAc;IAKvC;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM;IAKnB;;;;;;;;OAQG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM;IAKrB;;;;;;;;;OASG;IACH,YAAY,CAAC,YAAY,EAAE,MAAM;IAKjC;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,SAAS;IASzC;;;;;;;;;OASG;IACG,KAAK;IAsBX;;;;;;;;OAQG;IACG,KAAK;CAcX"}

package/dist/_cjs/query/queryBuilder.js

@@ -0,0 +1,194 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryBuilder = void 0;
+const entities_1 = require("../utils/entities");
+const engine_1 = require("./engine");
+const queryResult_1 = require("./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}
+ */
+class QueryBuilder {
+    _client;
+    _ownedBy;
+    _validAtBlock;
+    _withAnnotations;
+    _withMetadata;
+    _withPayload;
+    _limit;
+    _cursor;
+    _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 withPayload flag which will return the payload for the entities if true
+     * @param withPayload - The boolean value to set
+     * @returns The QueryBuilder instance
+     *
+     * @example
+     * const builder = new QueryBuilder(client)
+     * builder.withPayload(true)
+     */
+    withPayload(withPayload = true) {
+        this._withPayload = withPayload;
+        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 cursor for the query - it is advances setting which rather shouldn't be used manually but it is provided from query result if limit is used (pagination).
+     * @param cursor - The cursor to set which tells to RPC Query server where to start or continue the query.
+     * @returns The QueryBuilder instance
+     *
+     * @example
+     * const builder = new QueryBuilder(client)
+     * builder.offset(10)
+     */
+    cursor(cursor) {
+        this._cursor = cursor;
+        return this;
+    }
+    /**
+     * Sets the validAtBlock for the query which tells at which block height the state we are intested.
+     * If not set, the latest block is  used.
+     * @param validAtBlock - The block number to set
+     * @returns The QueryBuilder instance
+     *
+     * @example
+     * const builder = new QueryBuilder(client)
+     * builder.validAtBlock(10000)
+     */
+    validAtBlock(validAtBlock) {
+        this._validAtBlock = validAtBlock;
+        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 (0, engine_1.processQuery)(this._client, {
+            predicates: this._predicates,
+            limit: this._limit,
+            cursor: this._cursor,
+            ownedBy: this._ownedBy,
+            validAtBlock: this._validAtBlock,
+            withAnnotations: this._withAnnotations,
+            withMetadata: this._withMetadata,
+            withPayload: this._withPayload,
+        });
+        const entities = await Promise.all(queryResult.data.map((entity) => (0, entities_1.entityFromRpcResult)(entity)));
+        this.cursor(queryResult.cursor);
+        this.validAtBlock(queryResult.blockNumber);
+        return new queryResult_1.QueryResult(entities, this, this._cursor, this._limit, this._validAtBlock);
+    }
+    /**
+     * 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 (0, engine_1.processQuery)(this._client, {
+            predicates: this._predicates,
+            limit: this._limit,
+            cursor: this._cursor,
+            ownedBy: this._ownedBy,
+            validAtBlock: this._validAtBlock,
+            withAnnotations: false,
+            withMetadata: false,
+            withPayload: false,
+        });
+        return queryResult.data.length ?? 0;
+    }
+}
+exports.QueryBuilder = QueryBuilder;
+//# sourceMappingURL=queryBuilder.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"queryBuilder.js","sourceRoot":"","sources":["../../../src/query/queryBuilder.ts"],"names":[],"mappings":";;;AAEA,gDAAuD;AACvD,qCAAuC;AAEvC,+CAA2C;AAE3C;;;;;GAKG;AACH,MAAa,YAAY;IAChB,OAAO,CAAa;IACpB,QAAQ,CAAiB;IACzB,aAAa,CAAoB;IACjC,gBAAgB,CAAqB;IACrC,aAAa,CAAqB;IAClC,YAAY,CAAqB;IACjC,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,WAAW,CAAC,cAAuB,IAAI;QACtC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAA;QAC/B,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;;;;;;;;;OASG;IACH,YAAY,CAAC,YAAoB;QAChC,IAAI,CAAC,aAAa,GAAG,YAAY,CAAA;QACjC,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,IAAA,qBAAY,EAAC,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,YAAY,EAAE,IAAI,CAAC,aAAa;YAChC,eAAe,EAAE,IAAI,CAAC,gBAAgB;YACtC,YAAY,EAAE,IAAI,CAAC,aAAa;YAChC,WAAW,EAAE,IAAI,CAAC,YAAY;SAC9B,CAAC,CAAA;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CACjC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAA,8BAAmB,EAAC,MAAM,CAAC,CAAC,CAC7D,CAAA;QAED,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;QAC/B,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,WAAW,CAAC,CAAA;QAE1C,OAAO,IAAI,yBAAW,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,CAAA;IACtF,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK;QACV,MAAM,WAAW,GAAG,MAAM,IAAA,qBAAY,EAAC,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,YAAY,EAAE,IAAI,CAAC,aAAa;YAChC,eAAe,EAAE,KAAK;YACtB,YAAY,EAAE,KAAK;YACnB,WAAW,EAAE,KAAK;SAClB,CAAC,CAAA;QAEF,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,CAAA;IACpC,CAAC;CACD;AAnMD,oCAmMC"}

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

@@ -0,0 +1,15 @@
+import type { Entity } from "../types/entity";
+import type { QueryBuilder } from "./queryBuilder";
+export declare class QueryResult {
+    entities: Entity[];
+    private _endOfIteration;
+    private _cursor;
+    private _limit;
+    private _validAtBlock;
+    private _queryBuilder;
+    get queryBuilder(): QueryBuilder;
+    get cursor(): string | undefined;
+    constructor(entities: Entity[], queryBuilder: QueryBuilder, cursor: string | undefined, limit: number | undefined, validAtBlock: bigint | undefined);
+    next(): Promise<void>;
+}
+//# sourceMappingURL=queryResult.d.ts.map

package/dist/_cjs/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,eAAe,CAAS;IAChC,OAAO,CAAC,OAAO,CAAoB;IACnC,OAAO,CAAC,MAAM,CAAoB;IAClC,OAAO,CAAC,aAAa,CAAoB;IACzC,OAAO,CAAC,aAAa,CAAc;IAGnC,IAAI,YAAY,IAAI,YAAY,CAE/B;IAED,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAE/B;gBAGA,QAAQ,EAAE,MAAM,EAAE,EAClB,YAAY,EAAE,YAAY,EAC1B,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,YAAY,EAAE,MAAM,GAAG,SAAS;IAU3B,IAAI;CAoBV"}

package/dist/_cjs/query/queryResult.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryResult = void 0;
+const errors_1 = require("./errors");
+class QueryResult {
+    entities;
+    _endOfIteration;
+    _cursor;
+    _limit;
+    _validAtBlock;
+    _queryBuilder;
+    // Public getters for internal state
+    get queryBuilder() {
+        return this._queryBuilder;
+    }
+    get cursor() {
+        return this._cursor;
+    }
+    constructor(entities, queryBuilder, cursor, limit, validAtBlock) {
+        this.entities = entities;
+        this._queryBuilder = queryBuilder;
+        this._endOfIteration = !limit || entities.length < limit;
+        this._cursor = cursor;
+        this._limit = limit;
+        this._validAtBlock = validAtBlock;
+    }
+    async next() {
+        if (this._cursor === undefined || this._limit === undefined) {
+            throw new errors_1.NoCursorOrLimitError();
+        }
+        if (this._endOfIteration) {
+            throw new errors_1.NoMoreResultsError();
+        }
+        this._queryBuilder.cursor(this._cursor);
+        const result = await this._queryBuilder.fetch();
+        this.entities = result.entities;
+        // Update the query builder reference
+        this._queryBuilder = result.queryBuilder;
+        // Check if we've reached the end (no more cursor or we got fewer entities than limit)
+        this._endOfIteration = !result.cursor || result.entities.length < this._limit;
+        // Update the cursor
+        this._cursor = result.cursor;
+        // TODO check current block height and if it is not too old
+        console.debug("Current block height for next page: ", this._validAtBlock);
+    }
+}
+exports.QueryResult = QueryResult;
+//# sourceMappingURL=queryResult.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"queryResult.js","sourceRoot":"","sources":["../../../src/query/queryResult.ts"],"names":[],"mappings":";;;AACA,qCAAmE;AAGnE,MAAa,WAAW;IACvB,QAAQ,CAAU;IACV,eAAe,CAAS;IACxB,OAAO,CAAoB;IAC3B,MAAM,CAAoB;IAC1B,aAAa,CAAoB;IACjC,aAAa,CAAc;IAEnC,oCAAoC;IACpC,IAAI,YAAY;QACf,OAAO,IAAI,CAAC,aAAa,CAAA;IAC1B,CAAC;IAED,IAAI,MAAM;QACT,OAAO,IAAI,CAAC,OAAO,CAAA;IACpB,CAAC;IAED,YACC,QAAkB,EAClB,YAA0B,EAC1B,MAA0B,EAC1B,KAAyB,EACzB,YAAgC;QAEhC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,aAAa,GAAG,YAAY,CAAA;QACjC,IAAI,CAAC,eAAe,GAAG,CAAC,KAAK,IAAI,QAAQ,CAAC,MAAM,GAAG,KAAK,CAAA;QACxD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QACnB,IAAI,CAAC,aAAa,GAAG,YAAY,CAAA;IAClC,CAAC;IAED,KAAK,CAAC,IAAI;QACT,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC7D,MAAM,IAAI,6BAAoB,EAAE,CAAA;QACjC,CAAC;QACD,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YAC1B,MAAM,IAAI,2BAAkB,EAAE,CAAA;QAC/B,CAAC;QACD,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACvC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAA;QAC/C,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAA;QAC/B,qCAAqC;QACrC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,YAAY,CAAA;QACxC,sFAAsF;QACtF,IAAI,CAAC,eAAe,GAAG,CAAC,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;QAC7E,oBAAoB;QACpB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAA;QAE5B,2DAA2D;QAC3D,OAAO,CAAC,KAAK,CAAC,sCAAsC,EAAE,IAAI,CAAC,aAAa,CAAC,CAAA;IAC1E,CAAC;CACD;AApDD,kCAoDC"}

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

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

package/dist/_cjs/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/_cjs/types/annotation.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=annotation.js.map

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

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

package/dist/_cjs/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: bigint;
+    payload: Uint8Array;
+    annotations: Annotation[];
+    constructor(key: Hex, owner: Hex, expiresAtBlock: bigint, payload: Uint8Array, annotations: Annotation[]);
+    toText(): string;
+    toJson(): any;
+}
+//# sourceMappingURL=entity.d.ts.map

package/dist/_cjs/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"}

package/dist/_cjs/types/entity.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Entity = void 0;
+const viem_1 = require("viem");
+class Entity {
+    key;
+    owner;
+    expiresAtBlock;
+    payload;
+    annotations;
+    constructor(key, owner, expiresAtBlock, payload, annotations) {
+        this.key = key;
+        this.owner = owner;
+        this.expiresAtBlock = expiresAtBlock;
+        this.payload = payload;
+        this.annotations = annotations;
+    }
+    toText() {
+        return (0, viem_1.bytesToString)(this.payload);
+    }
+    toJson() {
+        return {
+            $key: this.key,
+            $annotations: this.annotations,
+            $owner: this.owner,
+            $expiresAtBlock: this.expiresAtBlock,
+            ...JSON.parse((0, viem_1.bytesToString)(this.payload)),
+        };
+    }
+}
+exports.Entity = Entity;
+//# sourceMappingURL=entity.js.map

package/dist/_cjs/types/entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity.js","sourceRoot":"","sources":["../../../src/types/entity.ts"],"names":[],"mappings":";;;AAAA,+BAA8C;AAG9C,MAAa,MAAM;IAClB,GAAG,CAAK;IACR,KAAK,CAAK;IACV,cAAc,CAAQ;IACtB,OAAO,CAAY;IACnB,WAAW,CAAc;IAEzB,YACC,GAAQ,EACR,KAAU,EACV,cAAsB,EACtB,OAAmB,EACnB,WAAyB;QAEzB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAA;QACpC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;IAC/B,CAAC;IAED,MAAM;QACL,OAAO,IAAA,oBAAa,EAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACnC,CAAC;IAED,MAAM;QACL,OAAO;YACN,IAAI,EAAE,IAAI,CAAC,GAAG;YACd,YAAY,EAAE,IAAI,CAAC,WAAW;YAC9B,MAAM,EAAE,IAAI,CAAC,KAAK;YAClB,eAAe,EAAE,IAAI,CAAC,cAAc;YACpC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAA,oBAAa,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC1C,CAAA;IACF,CAAC;CACD;AAlCD,wBAkCC"}

package/dist/_cjs/types/events.d.ts

@@ -0,0 +1,30 @@
+import type { Hex } from "viem";
+export type OnEntityCreatedEvent = {
+    entityKey: Hex;
+    owner: Hex;
+    expirationBlock: number;
+    cost: bigint;
+};
+export type OnEntityUpdatedEvent = {
+    entityKey: Hex;
+    owner: Hex;
+    oldExpirationBlock: number;
+    newExpirationBlock: number;
+    cost: bigint;
+};
+export type OnEntityDeletedEvent = {
+    entityKey: Hex;
+    owner: Hex;
+};
+export type OnEntityExpiredEvent = {
+    entityKey: Hex;
+    owner: Hex;
+};
+export type OnEntityExpiresInExtendedEvent = {
+    entityKey: Hex;
+    owner: Hex;
+    oldExpirationBlock: number;
+    newExpirationBlock: number;
+    cost: bigint;
+};
+//# sourceMappingURL=events.d.ts.map

package/dist/_cjs/types/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../src/types/events.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,MAAM,CAAA;AAE/B,MAAM,MAAM,oBAAoB,GAAG;IAClC,SAAS,EAAE,GAAG,CAAA;IACd,KAAK,EAAE,GAAG,CAAA;IACV,eAAe,EAAE,MAAM,CAAA;IACvB,IAAI,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IAClC,SAAS,EAAE,GAAG,CAAA;IACd,KAAK,EAAE,GAAG,CAAA;IACV,kBAAkB,EAAE,MAAM,CAAA;IAC1B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,IAAI,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IAClC,SAAS,EAAE,GAAG,CAAA;IACd,KAAK,EAAE,GAAG,CAAA;CACV,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IAClC,SAAS,EAAE,GAAG,CAAA;IACd,KAAK,EAAE,GAAG,CAAA;CACV,CAAA;AAED,MAAM,MAAM,8BAA8B,GAAG;IAC5C,SAAS,EAAE,GAAG,CAAA;IACd,KAAK,EAAE,GAAG,CAAA;IACV,kBAAkB,EAAE,MAAM,CAAA;IAC1B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,IAAI,EAAE,MAAM,CAAA;CACZ,CAAA"}

package/dist/_cjs/types/events.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=events.js.map

package/dist/_cjs/types/events.js.map

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