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

package/dist/_types/clients/createWalletClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createWalletClient.d.ts","sourceRoot":"","sources":["../../../src/clients/createWalletClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,OAAO,EACP,OAAO,EACP,KAAK,EACL,MAAM,EACN,YAAY,EACZ,QAAQ,EACR,SAAS,EACT,SAAS,EACT,kBAAkB,EAClB,MAAM,MAAM,CAAA;AAEb,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAExD,OAAO,EAAE,KAAK,kBAAkB,EAAsB,MAAM,0BAA0B,CAAA;AAEtF,MAAM,MAAM,iBAAiB,CAC5B,SAAS,SAAS,SAAS,GAAG,SAAS,EACvC,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,EACzD,SAAS,SAAS,SAAS,GAAG,SAAS,GAAG,cAAc,IACrD,QAAQ,CACX,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,kBAAkB,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAC3F,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,kBAAkB,CACjC,SAAS,SAAS,SAAS,EAC3B,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EAC3C,gBAAgB,SAAS,OAAO,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,EAClE,SAAS,SAAS,SAAS,GAAG,SAAS,GAAG,cAAc,EAExD,UAAU,EAAE,kBAAkB,CAAC,SAAS,EAAE,KAAK,EAAE,gBAAgB,EAAE,SAAS,CAAC,GAC3E,iBAAiB,CAAC,SAAS,EAAE,KAAK,EAAE,YAAY,CAAC,gBAAgB,CAAC,EAAE,SAAS,CAAC,CAkBhF"}

package/dist/_types/clients/decorators/arkivPublic.d.ts

@@ -0,0 +1,136 @@
+import type { Account, Chain, Client, Hex, PublicActions, Transport } from "viem";
+import { QueryBuilder } from "../../query/queryBuilder";
+import type { Entity } from "../../types/entity";
+import type { OnEntityCreatedEvent, OnEntityDeletedEvent, OnEntityExpiredEvent, OnEntityExpiresInExtendedEvent, OnEntityUpdatedEvent } from "../../types/events";
+export type PublicArkivActions<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined> = Pick<PublicActions<transport, chain, account>, "getBalance" | "getBlock" | "getBlockNumber" | "getChainId" | "getLogs" | "getTransaction" | "getTransactionCount" | "getTransactionReceipt" | "waitForTransactionReceipt" | "watchEvent"> & {
+    /**
+     * Returns the entity with the given key.
+     *
+     * - Docs: https://docs.golemdb.io/ts-sdk/actions/public/getEntity
+     * - JSON-RPC Methods: [`golembase_getStorageValue`](https://docs.golemdb.io/dev/json-rpc-api/#golembase_getstoragevalue)
+     * - JSON-RPC Methods: [`golembase_getEntityMetaData`](https://docs.golemdb.io/dev/json-rpc-api/#golembase_getEntityMetaData)
+     *
+     * @param args - {entityKey}
+     * @returns The entity with the given key. {@link Entity}
+     *
+     * @example
+     * import { createPublicClient, http } from 'arkiv'
+     * import { kaolin } from 'arkiv/chains'
+     *
+     * const client = createPublicClient({
+     *   chain: kaolin,
+     *   transport: http(),
+     * })
+     * const entity = await client.getEntity("0x123")
+     * // {
+     * //   key: "0x123",
+     * //   value: "0x123",
+     * // }
+     */
+    getEntity: (key: Hex) => Promise<Entity>;
+    /**
+     * Returns a QueryBuilder instance for building and executing queries.
+     * The QueryBuilder object follows the Builder pattern, allowing you to chain methods to build a query and then execute it.
+     *
+     * - Docs: https://docs.golemdb.io/ts-sdk/actions/public/query
+     *
+     * @returns A QueryBuilder instance for building and executing queries. {@link QueryBuilder}
+     *
+     * @example
+     * import { createPublicClient, http } from 'arkiv'
+     * import { kaolin } from 'arkiv/chains'
+     *
+     * const client = createPublicClient({
+     *   chain: kaolin,
+     *   transport: http(),
+     * })
+     * const query = client.buildQuery()
+     * const entities = await query.where("key", "=", "value").ownedBy("0x123").fetch()
+     *
+     */
+    buildQuery: () => QueryBuilder;
+    /**
+     * Returns a QueryResult instance for fetching the results of a raw query.
+     * @returns A QueryResult instance for fetching the results of a raw query. {@link QueryResult}
+     *
+     * @example
+     * import { createPublicClient, http } from 'arkiv'
+     * import { kaolin } from 'arkiv/chains'
+     *
+     * const client = createPublicClient({
+     *   chain: kaolin,
+     *   transport: http(),
+     * })
+     * const queryResult = client.query('key = value && $owner = 0x123')
+     *
+     */
+    query: (query: string) => Promise<Entity[]>;
+    /**
+     * Returns the number of entities in the DBChain.
+     * @returns The number of entities in the DBChain. {@link number}
+     *
+     * @example
+     * import { createPublicClient, http } from 'arkiv'
+     * import { kaolin } from 'arkiv/chains'
+     *
+     * const client = createPublicClient({
+     *   chain: kaolin,
+     *   transport: http(),
+     * })
+     * const entityCount = await client.getEntityCount()
+     * // entityCount = 0
+     */
+    getEntityCount: () => Promise<number>;
+    /**
+     * Returns the current block timing.
+     * @returns The current block timing. {@link GetBlockTimingReturnType}
+     *
+     * @example
+     * import { createPublicClient, http } from 'arkiv'
+     * import { kaolin } from 'arkiv/chains'
+     *
+     * const client = createPublicClient({
+     *   chain: kaolin,
+     *   transport: http(),
+     * })
+     * const blockTiming = await client.getBlockTiming()
+     * // {
+     * //   currentBlock: 10n, // block number
+     * //   currentBlockTime: 1234567890, // block timestamp
+     * //   blockDuration: 2, // in seconds
+     * // }
+     */
+    getBlockTiming: () => Promise<{
+        currentBlock: bigint;
+        currentBlockTime: number;
+        blockDuration: number;
+    }>;
+    subscribeEntityEvents: ({ onError, onEntityCreated, onEntityUpdated, onEntityDeleted, onEntityExpiresInExtended, }: {
+        onError?: (error: Error) => void;
+        onEntityCreated?: (event: OnEntityCreatedEvent) => void;
+        onEntityUpdated?: (event: OnEntityUpdatedEvent) => void;
+        onEntityDeleted?: (event: OnEntityDeletedEvent) => void;
+        onEntityExpired?: (event: OnEntityExpiredEvent) => void;
+        onEntityExpiresInExtended?: (event: OnEntityExpiresInExtendedEvent) => void;
+    }, pollingInterval?: number, fromBlock?: bigint) => Promise<() => void>;
+};
+export declare function publicArkivActions<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined>(client: Client<transport, chain, account>): {
+    getEntity: (key: Hex) => Promise<Entity>;
+    query: (rawQuery: string) => Promise<Entity[]>;
+    buildQuery: () => QueryBuilder;
+    getBlockTiming: () => Promise<{
+        currentBlock: bigint;
+        currentBlockTime: number;
+        blockDuration: number;
+    }>;
+    getEntityCount: () => Promise<number>;
+    subscribeEntityEvents: ({ onError, onEntityCreated, onEntityUpdated, onEntityDeleted, onEntityExpired, onEntityExpiresInExtended, }: {
+        onError?: (error: Error) => void;
+        onEntityCreated?: (event: OnEntityCreatedEvent) => void;
+        onEntityUpdated?: (event: OnEntityUpdatedEvent) => void;
+        onEntityDeleted?: (event: OnEntityDeletedEvent) => void;
+        onEntityExpired?: (event: OnEntityExpiredEvent) => void;
+        onEntityExpiresInExtended?: (event: OnEntityExpiresInExtendedEvent) => void;
+    }, pollingInterval?: number, fromBlock?: bigint) => Promise<() => void>;
+};
+//# sourceMappingURL=arkivPublic.d.ts.map

package/dist/_types/clients/decorators/arkivPublic.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"arkivPublic.d.ts","sourceRoot":"","sources":["../../../../src/clients/decorators/arkivPublic.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AAMjF,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AACvD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,KAAK,EACX,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACpB,8BAA8B,EAC9B,oBAAoB,EACpB,MAAM,oBAAoB,CAAA;AAE3B,MAAM,MAAM,kBAAkB,CAC7B,SAAS,SAAS,SAAS,GAAG,SAAS,EACvC,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,IACtD,IAAI,CACP,aAAa,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,EACtC,YAAY,GACZ,UAAU,GACV,gBAAgB,GAChB,YAAY,GACZ,SAAS,GACT,gBAAgB,GAChB,qBAAqB,GACrB,uBAAuB,GACvB,2BAA2B,GAC3B,YAAY,CACd,GAAG;IACH;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,SAAS,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;IAExC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,UAAU,EAAE,MAAM,YAAY,CAAA;IAE9B;;;;;;;;;;;;;;OAcG;IACH,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;IAE3C;;;;;;;;;;;;;;OAcG;IACH,cAAc,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAA;IAErC;;;;;;;;;;;;;;;;;;OAkBG;IACH,cAAc,EAAE,MAAM,OAAO,CAAC;QAC7B,YAAY,EAAE,MAAM,CAAA;QACpB,gBAAgB,EAAE,MAAM,CAAA;QACxB,aAAa,EAAE,MAAM,CAAA;KACrB,CAAC,CAAA;IAEF,qBAAqB,EAAE,CACtB,EACC,OAAO,EACP,eAAe,EACf,eAAe,EACf,eAAe,EACf,yBAAyB,GACzB,EAAE;QACF,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;QAChC,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,IAAI,CAAA;QACvD,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,IAAI,CAAA;QACvD,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,IAAI,CAAA;QACvD,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,IAAI,CAAA;QACvD,yBAAyB,CAAC,EAAE,CAAC,KAAK,EAAE,8BAA8B,KAAK,IAAI,CAAA;KAC3E,EACD,eAAe,CAAC,EAAE,MAAM,EACxB,SAAS,CAAC,EAAE,MAAM,KACd,OAAO,CAAC,MAAM,IAAI,CAAC,CAAA;CACxB,CAAA;AAED,wBAAgB,kBAAkB,CACjC,SAAS,SAAS,SAAS,GAAG,SAAS,EACvC,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,EACxD,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC;qBAExB,GAAG;sBACF,MAAM;;;;;;;;yIAYpB;QACF,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;QAChC,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,IAAI,CAAA;QACvD,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,IAAI,CAAA;QACvD,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,IAAI,CAAA;QACvD,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,IAAI,CAAA;QACvD,yBAAyB,CAAC,EAAE,CAAC,KAAK,EAAE,8BAA8B,KAAK,IAAI,CAAA;KAC3E,oBACiB,MAAM,cACZ,MAAM;EAgBpB"}

package/dist/_types/clients/decorators/arkivWallet.d.ts

@@ -0,0 +1,167 @@
+import type { Account, Chain, Client, Transport, WalletActions } from "viem";
+import { type CreateEntityParameters, type CreateEntityReturnType } from "../../actions/wallet/createEntity";
+import type { DeleteEntityParameters, DeleteEntityReturnType } from "../../actions/wallet/deleteEntity";
+import type { ExtendEntityParameters, ExtendEntityReturnType } from "../../actions/wallet/extendEntity";
+import type { MutateEntitiesParameters, MutateEntitiesReturnType } from "../../actions/wallet/mutateEntities";
+import type { UpdateEntityParameters, UpdateEntityReturnType } from "../../actions/wallet/updateEntity";
+import type { TxParams } from "../../types";
+import type { PublicArkivActions } from "./arkivPublic";
+export type WalletArkivActions<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined> = PublicArkivActions<transport, chain, account> & Pick<WalletActions<chain, account>, "sendTransaction" | "sendTransactionSync" | "sendRawTransaction" | "sendRawTransactionSync" | "signMessage" | "signTransaction"> & {
+    /**
+     * Returns the entity with the given key.
+     *
+     * - Docs: https://docs.golemdb.io/ts-sdk/actions/public/getEntity
+     * - JSON-RPC Methods: [`golembase_getStorageValue`](https://docs.golemdb.io/dev/json-rpc-api/#golembase_getstoragevalue)
+     * - JSON-RPC Methods: [`golembase_getEntityMetaData`](https://docs.golemdb.io/dev/json-rpc-api/#golembase_getEntityMetaData)
+     *
+     * @param args - {entityKey}
+     * @returns The entity with the given key. {@link Entity}
+     *
+     * @example
+     * import { createPublicClient, http } from 'arkiv'
+     * import { kaolin } from 'arkiv/chains'
+     *
+     * const client = createPublicClient({
+     *   chain: kaolin,
+     *   transport: http(),
+     * })
+     * const { entityKey, txHash } = await client.createEntity({
+     *   payload: toBytes(JSON.stringify({ entity: { entityType: "testType", entityId: "testId" } })),
+     *   annotations: [{ key: "testKey", value: "testValue" }],
+     *   expiresIn: 1000,
+     * })
+     * console.log("entityKey", entityKey)
+     * console.log("txHash", txHash)
+     * // {
+     * //   entityKey: "0x123",
+     * //   txHash: "0x123",
+     * // }
+     */
+    createEntity: (data: CreateEntityParameters, txParams?: TxParams) => Promise<CreateEntityReturnType>;
+    /**
+     * Updates the entity with the given key.
+     *
+     * - Docs: https://docs.golemdb.io/ts-sdk/actions/wallet/updateEntity
+     * - JSON-RPC Methods: [`golembase_updateEntity`](https://docs.golemdb.io/dev/json-rpc-api/#golembase_updateEntity)
+     *
+     * @param args - {entityKey, data}
+     * @returns The entity with the given key. {@link Entity}
+     *
+     * @example
+     * import { createWalletClient, http } from 'arkiv'
+     * import { kaolin } from 'arkiv/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: kaolin,
+     *   transport: http(),
+     * })
+     */
+    updateEntity: (data: UpdateEntityParameters, txParams?: TxParams) => Promise<UpdateEntityReturnType>;
+    /**
+     * Deletes the entity with the given key.
+     *
+     * - Docs: https://docs.golemdb.io/ts-sdk/actions/wallet/deleteEntity
+     * - JSON-RPC Methods: [`golembase_deleteEntity`](https://docs.golemdb.io/dev/json-rpc-api/#golembase_deleteEntity)
+     *
+     * @param args - {entityKey}
+     * @returns The entity with the given key. {@link Entity}
+     *
+     * @example
+     * import { createWalletClient, http } from 'arkiv'
+     * import { kaolin } from 'arkiv/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: kaolin,
+     *   transport: http(),
+     * })
+     * const { entityKey, txHash } = await client.deleteEntity({ entityKey: "0x123" })
+     * console.log("entityKey", entityKey)
+     * console.log("txHash", txHash)
+     * // {
+     * //   entityKey: "0x123",
+     * //   txHash: "0x123",
+     * // }
+     */
+    deleteEntity: (data: DeleteEntityParameters, txParams?: TxParams) => Promise<DeleteEntityReturnType>;
+    /**
+     * Extends the entity with the given key.
+     *
+     * - Docs: https://docs.golemdb.io/ts-sdk/actions/wallet/extendEntity
+     * - JSON-RPC Methods: [`golembase_extendEntity`](https://docs.golemdb.io/dev/json-rpc-api/#golembase_extendEntity)
+     *
+     * @param args - {entityKey, data}
+     * @returns The entity with the given key. {@link Entity}
+     *
+     * @example
+     * import { createWalletClient, http } from 'arkiv'
+     * import { kaolin } from 'arkiv/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: kaolin,
+     *   transport: http(),
+     * })
+     * const { entityKey, txHash } = await client.extendEntity("0x123", {
+     *   expiresIn: 1000,
+     * })
+     * console.log("entityKey", entityKey)
+     * console.log("txHash", txHash)
+     * // {
+     * //   entityKey: "0x123",
+     * //   txHash: "0x123",
+     * // }
+     */
+    extendEntity: (data: ExtendEntityParameters, txParams?: TxParams) => Promise<ExtendEntityReturnType>;
+    /**
+     * Mutates the entities with the given keys.
+     *
+     * - Docs: https://docs.golemdb.io/ts-sdk/actions/wallet/mutateEntities
+     * - JSON-RPC Methods: [`golembase_mutateEntities`](https://docs.golemdb.io/dev/json-rpc-api/#golembase_mutateEntities)
+     *
+     * @param args - {data}
+     * @returns The entity with the given key. {@link Entity}
+     *
+     * @example
+     * import { createWalletClient, http } from 'arkiv'
+     * import { kaolin } from 'arkiv/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: kaolin,
+     *   transport: http(),
+     * })
+     * const { entityKey, txHash } = await client.mutateEntities({
+     *   creates: [{
+     *     payload: toBytes(JSON.stringify({ entity: { entityType: "testType", entityId: "testId" } })),
+     *     annotations: [{ key: "testKey", value: "testValue" }],
+     *     expiresIn: 1000,
+     *   }],
+     *   updates: [{
+     *     entityKey: "0x123",
+     *     payload: toBytes(JSON.stringify({ entity: { entityType: "testType", entityId: "testId" } })),
+     *     annotations: [{ key: "testKey", value: "testValue" }],
+     *     expiresIn: 1000,
+     *   }],
+     *   deletes: [{
+     *     entityKey: "0x321",
+     *   }],
+     *   extensions: [{
+     *     entityKey: "0x1234",
+     *     expiresIn: 1000,
+     *   }],
+     * })
+     * console.log("entityKey", entityKey)
+     * console.log("txHash", txHash)
+     * // {
+     * //   entityKey: "0x123",
+     * //   txHash: "0x123",
+     * // }
+     */
+    mutateEntities: (data: MutateEntitiesParameters, txParams?: TxParams) => Promise<MutateEntitiesReturnType>;
+};
+export declare function walletArkivActions<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined>(client: Client<transport, chain, account>): {
+    createEntity: (data: CreateEntityParameters, txParams?: TxParams) => Promise<CreateEntityReturnType>;
+    updateEntity: (data: UpdateEntityParameters, txParams?: TxParams) => Promise<UpdateEntityReturnType>;
+    deleteEntity: (data: DeleteEntityParameters, txParams?: TxParams) => Promise<DeleteEntityReturnType>;
+    extendEntity: (data: ExtendEntityParameters, txParams?: TxParams) => Promise<ExtendEntityReturnType>;
+    mutateEntities: (data: MutateEntitiesParameters, txParams?: TxParams) => Promise<MutateEntitiesReturnType>;
+};
+//# sourceMappingURL=arkivWallet.d.ts.map

package/dist/_types/clients/decorators/arkivWallet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"arkivWallet.d.ts","sourceRoot":"","sources":["../../../../src/clients/decorators/arkivWallet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,MAAM,CAAA;AAC5E,OAAO,EACN,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAE3B,MAAM,mCAAmC,CAAA;AAC1C,OAAO,KAAK,EACX,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,mCAAmC,CAAA;AAE1C,OAAO,KAAK,EACX,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,mCAAmC,CAAA;AAE1C,OAAO,KAAK,EACX,wBAAwB,EACxB,wBAAwB,EACxB,MAAM,qCAAqC,CAAA;AAE5C,OAAO,KAAK,EACX,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,mCAAmC,CAAA;AAG1C,OAAO,KAAK,EAAU,QAAQ,EAAE,MAAM,aAAa,CAAA;AACnD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAEvD,MAAM,MAAM,kBAAkB,CAC7B,SAAS,SAAS,SAAS,GAAG,SAAS,EACvC,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,IACtD,kBAAkB,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,GAChD,IAAI,CACH,aAAa,CAAC,KAAK,EAAE,OAAO,CAAC,EAC3B,iBAAiB,GACjB,qBAAqB,GACrB,oBAAoB,GACpB,wBAAwB,GACxB,aAAa,GACb,iBAAiB,CACnB,GAAG;IACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,YAAY,EAAE,CACb,IAAI,EAAE,sBAAsB,EAC5B,QAAQ,CAAC,EAAE,QAAQ,KACf,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAEpC;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,EAAE,CACb,IAAI,EAAE,sBAAsB,EAC5B,QAAQ,CAAC,EAAE,QAAQ,KACf,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAEpC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,YAAY,EAAE,CACb,IAAI,EAAE,sBAAsB,EAC5B,QAAQ,CAAC,EAAE,QAAQ,KACf,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,YAAY,EAAE,CACb,IAAI,EAAE,sBAAsB,EAC5B,QAAQ,CAAC,EAAE,QAAQ,KACf,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,cAAc,EAAE,CACf,IAAI,EAAE,wBAAwB,EAC9B,QAAQ,CAAC,EAAE,QAAQ,KACf,OAAO,CAAC,wBAAwB,CAAC,CAAA;CACtC,CAAA;AAEF,wBAAgB,kBAAkB,CACjC,SAAS,SAAS,SAAS,GAAG,SAAS,EACvC,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,EACxD,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC;yBAEpB,sBAAsB,aAAa,QAAQ;yBAE3C,sBAAsB,aAAa,QAAQ;yBAE3C,sBAAsB,aAAa,QAAQ;yBAE3C,sBAAsB,aAAa,QAAQ;2BAEzC,wBAAwB,aAAa,QAAQ;EAGrE"}

package/dist/_types/consts.d.ts

@@ -0,0 +1,3 @@
+export declare const ARKIV_ADDRESS: `0x${string}`;
+export declare const BLOCK_TIME = 2;
+//# sourceMappingURL=consts.d.ts.map

package/dist/_types/consts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consts.d.ts","sourceRoot":"","sources":["../../src/consts.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,aAAa,EAAmD,KAAK,MAAM,EAAE,CAAA;AAC1F,eAAO,MAAM,UAAU,IAAI,CAAA"}

package/dist/_types/index.d.ts

@@ -0,0 +1,11 @@
+export type { Account, Address, Chain, Hex, PublicClientConfig, RpcSchema, Transport, } from "viem";
+export { http, toBytes, toHex, toRlp, webSocket } from "viem";
+export type { ArkivClient } from "./clients/baseClient";
+export type { PublicArkivClient } from "./clients/createPublicClient";
+export { createPublicClient } from "./clients/createPublicClient";
+export type { WalletArkivClient } from "./clients/createWalletClient";
+export { createWalletClient } from "./clients/createWalletClient";
+export type { Annotation } from "./types/annotation";
+export type { Entity } from "./types/entity";
+export type { ArkivRpcSchema } from "./types/rpcSchema";
+//# sourceMappingURL=index.d.ts.map

package/dist/_types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,YAAY,EACX,OAAO,EACP,OAAO,EACP,KAAK,EACL,GAAG,EACH,kBAAkB,EAClB,SAAS,EACT,SAAS,GACT,MAAM,MAAM,CAAA;AAEb,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AAC7D,YAAY,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AACvD,YAAY,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAA;AACjE,YAAY,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAA;AACjE,YAAY,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AACpD,YAAY,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,YAAY,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA"}

package/dist/_types/query/engine.d.ts

@@ -0,0 +1,18 @@
+import type { Hex } from "viem";
+import type { ArkivClient } from "../clients/baseClient";
+import type { Predicate } from "./predicate";
+export declare function processQuery(client: ArkivClient, queryParams: {
+    predicates: Predicate[];
+    limit: number | undefined;
+    cursor: string | undefined;
+    ownedBy: Hex | undefined;
+    validAtBlock?: bigint | undefined;
+    withAnnotations?: boolean | undefined;
+    withMetadata?: boolean | undefined;
+    withPayload?: boolean | undefined;
+}): Promise<{
+    data: [import("../types/rpcSchema").RpcEntity];
+    blockNumber: bigint;
+    cursor: string;
+}>;
+//# sourceMappingURL=engine.d.ts.map

package/dist/_types/query/engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.d.ts","sourceRoot":"","sources":["../../../src/query/engine.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,MAAM,CAAA;AAC/B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAqC5C,wBAAsB,YAAY,CACjC,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE;IACZ,UAAU,EAAE,SAAS,EAAE,CAAA;IACvB,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,OAAO,EAAE,GAAG,GAAG,SAAS,CAAA;IACxB,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACjC,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACrC,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAClC,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CACjC;;;;GAyDD"}

package/dist/_types/query/errors.d.ts

@@ -0,0 +1,13 @@
+export declare class NoMoreResultsError extends Error {
+    constructor();
+}
+export declare class NoCursorOrLimitError extends Error {
+    constructor();
+}
+export declare class OffsetCannotBeLessThanZeroError extends Error {
+    constructor();
+}
+export declare class NoEntityFoundError extends Error {
+    constructor();
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/_types/query/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/query/errors.ts"],"names":[],"mappings":"AAAA,qBAAa,kBAAmB,SAAQ,KAAK;;CAI5C;AAED,qBAAa,oBAAqB,SAAQ,KAAK;;CAI9C;AAED,qBAAa,+BAAgC,SAAQ,KAAK;;CAIzD;AAED,qBAAa,kBAAmB,SAAQ,KAAK;;CAI5C"}

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