@arkiv-network/sdk 0.4.5 → 0.5.0-dev.2

package/dist/index-DQGx5KZ6.d.cts

@@ -0,0 +1,1003 @@
+import { Account, Address, Chain, Client, Hash, Hex, ParseAccount, Prettify, PublicActions, PublicClientConfig, RpcSchema, Transport, WalletActions, WalletClientConfig } from "viem";
+
+//#region src/types/mimeTypes.d.ts
+type MimeType = "text/plain" | "text/html" | "text/css" | "text/csv" | "text/xml" | "text/javascript" | "application/json" | "application/xml" | "application/pdf" | "application/zip" | "application/gzip" | "application/octet-stream" | "application/javascript" | "application/x-www-form-urlencoded" | "image/png" | "image/jpeg" | "image/webp" | "image/gif" | "image/svg+xml" | "audio/mpeg" | "audio/wav" | "audio/ogg" | "video/mp4" | "video/webm" | "video/ogg" | "multipart/form-data";
+//#endregion
+//#region src/types/rpcSchema.d.ts
+type RpcEntity = {
+  key: Hex;
+  contentType: MimeType;
+  value: string;
+  expiresAt: string;
+  createdAtBlock: string;
+  lastModifiedAtBlock: string;
+  transactionIndexInBlock: string;
+  operationIndexInTransaction: string;
+  owner: Hex;
+  stringAttributes?: [{
+    key: string;
+    value: string;
+  }];
+  numericAttributes?: [{
+    key: string;
+    value: number;
+  }];
+};
+type RpcOrderByAttribute = {
+  name: string;
+  type: "string" | "numeric";
+  desc: boolean;
+};
+type RpcQueryOptions = {
+  atBlock?: number;
+  includeData?: RpcIncludeData;
+  orderBy?: RpcOrderByAttribute[];
+  resultsPerPage?: number;
+  cursor?: string;
+};
+type RpcIncludeData = {
+  key?: boolean;
+  attributes?: boolean;
+  payload?: boolean;
+  contentType?: boolean;
+  expiration?: boolean;
+  owner?: boolean;
+  createdAtBlock?: boolean;
+  lastModifiedAtBlock?: boolean;
+  transactionIndexInBlock?: boolean;
+  operationIndexInTransaction?: boolean;
+};
+type ArkivRpcSchema = [{
+  Method: "arkiv_query";
+  Parameters?: [query: string, queryOptions?: RpcQueryOptions];
+  ReturnType: {
+    data: RpcEntity[];
+    blockNumber: bigint;
+    cursor: string;
+  };
+}, {
+  Method: "arkiv_getBlockTiming";
+  Parameters?: [];
+  ReturnType: {
+    current_block: bigint;
+    current_block_time: number;
+    duration: number;
+  };
+}, {
+  Method: "arkiv_getEntityCount";
+  Parameters?: [];
+  ReturnType: number;
+}];
+//#endregion
+//#region src/clients/baseClient.d.ts
+type ArkivClient<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, accountOrAddress extends Account | undefined = Account | undefined, rpcSchema extends RpcSchema | undefined = ArkivRpcSchema> = Client<transport, chain, accountOrAddress, rpcSchema>;
+//#endregion
+//#region src/actions/public/query.d.ts
+type QueryOptionsIncludeData = {
+  attributes?: boolean;
+  payload?: boolean;
+  metadata?: boolean;
+};
+type QueryOptionsOrderBy = {
+  name: string;
+  type: "string" | "numeric";
+  desc: "asc" | "desc";
+};
+type QueryOptions = {
+  includeData?: QueryOptionsIncludeData;
+  atBlock?: bigint;
+  orderBy?: QueryOptionsOrderBy[];
+  resultsPerPage?: number | undefined;
+  cursor?: string | undefined;
+};
+//#endregion
+//#region src/query/predicate.d.ts
+type PredicateType = "eq" | "neq" | "gt" | "gte" | "lt" | "lte" | "not";
+type PredicateContainerType = "or" | "and";
+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)] }
+ *
+ */
+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)] }
+ *
+ */
+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" }
+ */
+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" }
+ */
+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" }
+ */
+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" }
+ */
+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" }
+ */
+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" }
+ */
+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: "" }
+ */
+declare function not(key: string): Predicate;
+//#endregion
+//#region src/actions/public/getBlockTiming.d.ts
+type GetBlockTimingReturnType = {
+  currentBlock: bigint;
+  currentBlockTime: number;
+  blockDuration: number;
+};
+//#endregion
+//#region src/actions/wallet/changeOwnership.d.ts
+/**
+ * Parameters for the deleteEntity function.
+ * - entityKey: The key of the entity to delete.
+ */
+type ChangeOwnershipParameters = {
+  entityKey: Hex;
+  newOwner: Hex;
+};
+/**
+ * Return type for the deleteEntity function.
+ * - entityKey: The key of the entity.
+ * - txHash: The transaction hash.
+ */
+type ChangeOwnershipReturnType = {
+  entityKey: Hex;
+  txHash: string;
+};
+//#endregion
+//#region src/actions/wallet/createEntity.d.ts
+/**
+ * Parameters for the createEntity function.
+ * - payload: The payload of the entity.
+ * - attributes: The attributes of the entity.
+ * - contentType: The content type of the entity.
+ * - expiresIn: The expires in of the entity in seconds.
+ */
+type CreateEntityParameters = {
+  payload: Uint8Array;
+  attributes: Attribute[];
+  contentType: MimeType;
+  expiresIn: number;
+};
+/**
+ * Return type for the createEntity function.
+ * - entityKey: The key of the entity.
+ * - txHash: The transaction hash.
+ */
+type CreateEntityReturnType = {
+  entityKey: Hex;
+  txHash: Hash;
+};
+//#endregion
+//#region src/actions/wallet/deleteEntity.d.ts
+/**
+ * Parameters for the deleteEntity function.
+ * - entityKey: The key of the entity to delete.
+ */
+type DeleteEntityParameters = {
+  entityKey: Hex;
+};
+/**
+ * Return type for the deleteEntity function.
+ * - entityKey: The key of the entity.
+ * - txHash: The transaction hash.
+ */
+type DeleteEntityReturnType = {
+  entityKey: Hex;
+  txHash: Hash;
+};
+//#endregion
+//#region src/actions/wallet/extendEntity.d.ts
+/**
+ * Parameters for the extendEntity function.
+ * - entityKey: The key of the entity to extend.
+ * - expiresIn: The expires in of the entity in seconds.
+ */
+type ExtendEntityParameters = {
+  entityKey: Hex;
+  expiresIn: number;
+};
+/**
+ * Return type for the extendEntity function.
+ * - entityKey: The key of the entity.
+ * - txHash: The transaction hash.
+ */
+type ExtendEntityReturnType = {
+  entityKey: Hex;
+  txHash: Hash;
+};
+//#endregion
+//#region src/actions/wallet/updateEntity.d.ts
+/**
+ * Parameters for the updateEntity function.
+ * - entityKey: The key of the entity to update.
+ * - payload: The payload of the entity.
+ * - attributes: The attributes of the entity.
+ * - contentType: The content type of the entity.
+ * - expiresIn: The expires in of the entity in seconds.
+ */
+type UpdateEntityParameters = {
+  entityKey: Hex;
+  payload: Uint8Array;
+  attributes: Attribute[];
+  contentType: MimeType;
+  expiresIn: number;
+};
+/**
+ * Return type for the updateEntity function.
+ * - entityKey: The key of the entity.
+ * - txHash: The transaction hash.
+ */
+type UpdateEntityReturnType = {
+  entityKey: Hex;
+  txHash: Hash;
+};
+//#endregion
+//#region src/actions/wallet/mutateEntities.d.ts
+/**
+ * Parameters for the mutateEntities function.
+ * - creates: The creates to perform.
+ * - updates: The updates to perform.
+ * - deletes: The deletes to perform.
+ * - extensions: The extensions to perform.
+ */
+type MutateEntitiesParameters = {
+  creates?: CreateEntityParameters[];
+  updates?: UpdateEntityParameters[];
+  deletes?: DeleteEntityParameters[];
+  extensions?: ExtendEntityParameters[];
+  ownershipChanges?: ChangeOwnershipParameters[];
+};
+/**
+ * Return type for the mutateEntities function.
+ * - txHash: The transaction hash.
+ * - createdEntities: The keys of the created entities.
+ * - updatedEntities: The keys of the updated entities.
+ * - deletedEntities: The keys of the deleted entities.
+ * - extendedEntities: The keys of the extended entities.
+ * - ownershipChanges: The keys of the ownership changes.
+ */
+type MutateEntitiesReturnType = {
+  txHash: Hash;
+  createdEntities: Hex[];
+  updatedEntities: Hex[];
+  deletedEntities: Hex[];
+  extendedEntities: Hex[];
+  ownershipChanges: Hex[];
+};
+//#endregion
+//#region src/types/attributes.d.ts
+type Attribute = {
+  key: string;
+  value: string | number;
+};
+//#endregion
+//#region src/types/events.d.ts
+type OnEntityCreatedEvent = {
+  entityKey: Hex;
+  owner: Hex;
+  expirationBlock: number;
+  cost: bigint;
+};
+type OnEntityUpdatedEvent = {
+  entityKey: Hex;
+  owner: Hex;
+  oldExpirationBlock: number;
+  newExpirationBlock: number;
+  cost: bigint;
+};
+type OnEntityDeletedEvent = {
+  entityKey: Hex;
+  owner: Hex;
+};
+type OnEntityExpiredEvent = {
+  entityKey: Hex;
+  owner: Hex;
+};
+type OnEntityExpiresInExtendedEvent = {
+  entityKey: Hex;
+  owner: Hex;
+  oldExpirationBlock: number;
+  newExpirationBlock: number;
+  cost: bigint;
+};
+type OnEntityOwnerChangedEvent = {
+  entityKey: Hex;
+  oldOwner: Hex;
+  newOwner: Hex;
+};
+//#endregion
+//#region src/types/txParams.d.ts
+type TxParams = {
+  gas?: bigint;
+  nonce?: number;
+  gasPrice?: bigint;
+  maxFeePerGas?: never;
+  maxPriorityFeePerGas?: never;
+} | {
+  gas?: bigint;
+  nonce?: number;
+  maxFeePerGas?: bigint;
+  maxPriorityFeePerGas?: bigint;
+  gasPrice?: never;
+};
+//#endregion
+//#region src/types/entity.d.ts
+declare class Entity {
+  key: Hex;
+  contentType: MimeType | undefined;
+  owner: Hex | undefined;
+  expiresAtBlock: bigint | undefined;
+  createdAtBlock: bigint | undefined;
+  lastModifiedAtBlock: bigint | undefined;
+  transactionIndexInBlock: bigint | undefined;
+  operationIndexInTransaction: bigint | undefined;
+  payload: Uint8Array | undefined;
+  attributes: Attribute[];
+  constructor(key: Hex, contentType: MimeType | undefined, owner: Hex | undefined, expiresAtBlock: bigint | undefined, createdAtBlock: bigint | undefined, lastModifiedAtBlock: bigint | undefined, transactionIndexInBlock: bigint | undefined, operationIndexInTransaction: bigint | undefined, payload: Uint8Array | undefined, attributes: Attribute[]);
+  toText(): string;
+  toJson(): any;
+}
+//#endregion
+//#region src/query/queryResult.d.ts
+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>;
+  hasNextPage(): boolean;
+}
+//#endregion
+//#region src/query/queryBuilder.d.ts
+type OrderByAttribute = {
+  name: string;
+  type: "string" | "number";
+  order: "asc" | "desc";
+};
+/**
+ * Helper function to create an ascending order by attribute
+ * @param attributeName - The name of the attribute to order by
+ * @param attributeType - The type of the attribute to order by (string or number)
+ * @returns Input for orderBy method
+ *
+ * @example
+ * const ascAttribute = asc("name", "string")
+ */
+declare function asc(attributeName: string, attributeType: "string" | "number"): OrderByAttribute;
+/**
+ * Helper function to create a descending order by attribute
+ * @param attributeName - The name of the attribute to order by
+ * @param attributeType - The type of the attribute to order by (string or number)
+ * @returns Input for orderBy method
+ *
+ * @example
+ * const descAttribute = desc("name", "string")
+ */
+declare function desc(attributeName: string, attributeType: "string" | "number"): OrderByAttribute;
+/**
+ * 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}
+ */
+declare class QueryBuilder {
+  private _client;
+  private _ownedBy;
+  private _orderBy;
+  private _validAtBlock;
+  private _withAttributes;
+  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 orderBy for the query.
+   * It can be called multiple times to order by multiple attributes.
+   * The order of the attributes is important. The first attribute is the primary order by attribute.
+   * You can use the helper functions asc() and desc() as input for this method.
+   * @param attributeName - The name of the attribute to order by
+   * @param attributeType - The type of the attribute to order by (string or number)
+   * @param order - The order to set the order by (asc or desc)
+   * @returns The QueryBuilder instance
+   *
+   * @example
+   * const builder = client.buildQuery()
+   * builder.orderBy("name", "string", "desc")
+   * builder.orderBy(asc("name", "string"))
+   * builder.orderBy(desc("name", "string"))
+   */
+  orderBy(attributeName: string, attributeType: "string" | "number", order?: "asc" | "desc"): this;
+  /**
+   * Sets the orderBy for the query.
+   * This method takes the OrderByAttribute object as an argument and is mainly
+   * used to use the helper functions asc() and desc() to create the OrderByAttribute instances.
+   * @param orderByAttribute - The OrderByAttribute instance to set
+   * @returns The QueryBuilder instance
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * builder.orderBy(asc("name", "string"))
+   * builder.orderBy(desc("name", "string"))
+   */
+  orderBy(orderByAttribute: OrderByAttribute): this;
+  /**
+   * Sets the withAttributes flag which will return the attributes for the entities if true
+   * @param withAttributes - The boolean value to set
+   * @returns The QueryBuilder instance
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * builder.withAttributes(true)
+   */
+  withAttributes(withAttributes?: 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<number>;
+}
+//#endregion
+//#region src/clients/decorators/arkivPublic.d.ts
+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.arkiv.network/ts-sdk/actions/public/getEntity
+   *
+   * @param key - The entity key (hex string)
+   * @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.arkiv.network/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.
+   * If no query options are provided, all payload is included, but no metadata (like owner, expiredAt, etc.) and attributes.
+   * @param query - The raw query string
+   * @param queryOptions - The optional query options - {@link QueryOptions}
+   * @returns An array of entities matching the query. {@link Entity}
+   *
+   * @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')
+   * // queryResult = [{ key: "0x123", value: "0x123" }]
+   * const queryResultWithOptions = client.query('key = value && $owner = 0x123', {
+   *   includeData: {
+   *     attributes: false,
+   *     payload: true,
+   *     metadata: true,
+   *   },
+   *   orderBy: [{ name: "key", type: "string", desc: "asc" }],
+   *   resultsPerPage: 10,
+   *   cursor: undefined,
+   *   atBlock: undefined,
+   * })
+   * // queryResultWithOptions = [{ key: "0x123", value: "0x123" }]
+   */
+  query: (query: string, queryOptions?: QueryOptions) => Promise<Entity[]>;
+  /**
+   * Returns the number of entities in the DBChain.
+   * @returns The number of entities in the DBChain
+   *
+   * @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;
+  }>;
+  /**
+   * Subscribes to entity events.
+   * Takes an object with event handlers: {onError, onEntityCreated, onEntityUpdated, onEntityDeleted, onEntityExpiresInExtended}
+   * @param pollingInterval - The polling interval in milliseconds
+   * @param fromBlock - The block number to start from
+   * @returns A function to unsubscribe from the events
+   *
+   * @example
+   * import { createPublicClient, http } from 'arkiv'
+   * import { kaolin } from 'arkiv/chains'
+   *
+   * const client = createPublicClient({
+   *   chain: kaolin,
+   *   transport: http(),
+   * })
+   * const unsubscribe = await client.subscribeEntityEvents({
+   *   onError: (error) => console.error("subscribeEntityEvents error", error),
+   * })
+   * unsubscribe() // unsubscribe from the events
+   */
+  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>;
+};
+//#endregion
+//#region src/clients/createPublicClient.d.ts
+type PublicArkivClient<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, accountOrAddress extends Account | undefined = undefined, rpcSchema extends RpcSchema | undefined = ArkivRpcSchema> = Prettify<Client<transport, chain, accountOrAddress, rpcSchema, PublicArkivActions<transport, chain>>>;
+/**
+ * Creates a Public Client with a given [Transport](https://viem.sh/docs/clients/intro) configured for a [Chain](https://viem.sh/docs/clients/chains).
+ *
+ * - Docs: https://docs.arkiv.network/ts-sdk/clients/public
+ *
+ * A Public Client is an interface to "public" [Ethereum JSON-RPC API](https://ethereum.org/en/developers/docs/apis/json-rpc/), [Arkiv JSON-RPC API](https://docs.arkiv.network/json-rpc/), and [Kaolin JSON-RPC API](https://kaolin.holesky.arkiv.network/rpc) methods such as retrieving block numbers, transactions, reading from smart contracts, etc through [Public Actions](/docs/actions/public/introduction).
+ *
+ * @param parameters - Configuration object for the public client (chain, transport, etc.)
+ * @returns A Arkiv Public Client. {@link PublicArkivClient}
+ *
+ * @example
+ * import { createPublicClient, http } from 'arkiv'
+ * import { kaolin } from 'arkiv/chains'
+ *
+ * const client = createPublicClient({
+ *   chain: kaolin,
+ *   transport: http(),
+ * })
+ */
+declare function createPublicClient<transport extends Transport, chain extends Chain | undefined = undefined, accountOrAddress extends Account | Address | undefined = undefined, rpcSchema extends RpcSchema | undefined = ArkivRpcSchema>(parameters: PublicClientConfig<transport, chain, accountOrAddress, rpcSchema>): PublicArkivClient<transport, chain, ParseAccount<accountOrAddress>, rpcSchema>;
+//#endregion
+//#region src/clients/decorators/arkivWallet.d.ts
+type WalletArkivActions<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined> = Pick<PublicActions<transport, chain, account>, "waitForTransactionReceipt"> & Pick<WalletActions<chain, account>, "addChain" | "sendTransaction" | "sendTransactionSync" | "sendRawTransaction" | "sendRawTransactionSync" | "signMessage" | "signTransaction"> & {
+  /**
+   * Creates a new entity.
+   *
+   * - Docs: https://docs.arkiv.network/ts-sdk/actions/wallet/createEntity
+   * - JSON-RPC Methods: [`eth_sendRawTransaction`](https://docs.arkiv.network/dev/json-rpc-api/#mutateEntities)
+   *
+   * @param data - The entity creation parameters
+   * @param txParams - Optional transaction parameters
+   * @returns The created entity with transaction hash
+   *
+   * @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" } })),
+   *   attributes: [{ 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.arkiv.network/ts-sdk/actions/wallet/updateEntity
+   * - JSON-RPC Methods: [`eth_sendRawTransaction`](https://docs.arkiv.network/dev/json-rpc-api/#mutateEntities)
+   *
+   * @param data - The entity update parameters
+   * @param txParams - Optional transaction parameters
+   * @returns The updated entity with transaction hash
+   *
+   * @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.arkiv.network/ts-sdk/actions/wallet/deleteEntity
+   * - JSON-RPC Methods: [`eth_sendRawTransaction`](https://docs.arkiv.network/dev/json-rpc-api/#mutateEntities)
+   *
+   * @param data - The entity deletion parameters
+   * @param txParams - Optional transaction parameters
+   * @returns The deleted entity with transaction hash
+   *
+   * @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.arkiv.network/ts-sdk/actions/wallet/extendEntity
+   * - JSON-RPC Methods: [`eth_sendRawTransaction`](https://docs.arkiv.network/dev/json-rpc-api/#mutateEntities)
+   *
+   * @param data - The entity update parameters
+   * @param txParams - Optional transaction parameters
+   * @returns The updated entity with transaction hash
+   *
+   * @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>;
+  /**
+   * Changes the ownership of the entity with the given address.
+   *
+   * - Docs: https://docs.arkiv.network/ts-sdk/actions/wallet/changeOwnership
+   * - JSON-RPC Methods: [`eth_sendRawTransaction`](https://docs.arkiv.network/dev/json-rpc-api/#mutateEntities)
+   *
+   * @param data - The ownership change parameters
+   * @param txParams - Optional transaction parameters
+   * @returns The entity with updated ownership and transaction hash
+   */
+  changeOwnership: (data: ChangeOwnershipParameters, txParams?: TxParams) => Promise<ChangeOwnershipReturnType>;
+  /**
+   * Mutates the entities with the given keys.
+   *
+   * - Docs: https://docs.arkiv.network/ts-sdk/actions/wallet/mutateEntities
+   * - JSON-RPC Methods: [`eth_sendRawTransaction`](https://docs.arkiv.network/dev/json-rpc-api/#mutateEntities)
+   *
+   * @param data - The mutation parameters (creates, updates, deletes, extensions)
+   * @param txParams - Optional transaction parameters
+   * @returns The mutation result with transaction hash
+   *
+   * @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" } })),
+   *     attriubutes: [{ key: "testKey", value: "testValue" }],
+   *     expiresIn: 1000,
+   *   }],
+   *   updates: [{
+   *     entityKey: "0x123",
+   *     payload: toBytes(JSON.stringify({ entity: { entityType: "testType", entityId: "testId" } })),
+   *     attributes: [{ 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>;
+};
+//#endregion
+//#region src/clients/createWalletClient.d.ts
+type WalletArkivClient<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined, rpcSchema extends RpcSchema | undefined = ArkivRpcSchema> = Prettify<Client<transport, chain, account, rpcSchema, WalletArkivActions<transport, chain, account>>>;
+/**
+ * Creates a Public Client with a given [Transport](https://viem.sh/docs/clients/intro) configured for a [Chain](https://viem.sh/docs/clients/chains).
+ *
+ * - Docs: https://docs.arkiv.network/ts-sdk/clients/public
+ *
+ * A Public Client is an interface to "public" [Ethereum JSON-RPC API](https://ethereum.org/en/developers/docs/apis/json-rpc/), [Arkiv JSON-RPC API](https://docs.arkiv.network/json-rpc/), and [Kaolin JSON-RPC API](https://kaolin.holesky.arkiv.network/rpc) methods such as retrieving block numbers, transactions, reading from smart contracts, etc through [Public Actions](/docs/actions/public/introduction).
+ *
+ * @param parameters - Configuration object for the wallet client (chain, transport, account, etc.)
+ * @returns A Arkiv Wallet Client. {@link WalletArkivClient}
+ *
+ * @example
+ * import { createPublicClient, http } from 'arkiv'
+ * import { kaolin } from 'arkiv/chains'
+ *
+ * const client = createPublicClient({
+ *   chain: kaolin,
+ *   transport: http(),
+ * })
+ */
+declare function createWalletClient<transport extends Transport, chain extends Chain | undefined = undefined, accountOrAddress extends Account | Address | undefined = undefined, rpcSchema extends RpcSchema | undefined = ArkivRpcSchema>(parameters: WalletClientConfig<transport, chain, accountOrAddress, rpcSchema>): WalletArkivClient<transport, chain, ParseAccount<accountOrAddress>, rpcSchema>;
+//#endregion
+//#region src/utils/chains.d.ts
+/**
+ * Get a chain from its name
+ * @param name - The name of the chain, case insensitive
+ * @returns The chain
+ * @throws An error if the chain is not found
+ */
+declare function chainFromName(name: string): Chain;
+//#endregion
+export { RpcIncludeData as $, CreateEntityParameters as A, gt as B, MutateEntitiesReturnType as C, ExtendEntityReturnType as D, ExtendEntityParameters as E, Predicate as F, not as G, lt as H, PredicateContainerType as I, QueryOptionsIncludeData as J, or as K, PredicateType as L, ChangeOwnershipParameters as M, ChangeOwnershipReturnType as N, DeleteEntityParameters as O, GetBlockTimingReturnType as P, RpcEntity as Q, and as R, MutateEntitiesParameters as S, UpdateEntityReturnType as T, lte as U, gte as V, neq as W, ArkivClient as X, QueryOptionsOrderBy as Y, ArkivRpcSchema as Z, OnEntityExpiredEvent as _, PublicArkivClient as a, OnEntityUpdatedEvent as b, OrderByAttribute as c, desc as d, RpcOrderByAttribute as et, QueryResult as f, OnEntityDeletedEvent as g, OnEntityCreatedEvent as h, WalletArkivActions as i, CreateEntityReturnType as j, DeleteEntityReturnType as k, QueryBuilder as l, TxParams as m, WalletArkivClient as n, MimeType as nt, createPublicClient as o, Entity as p, QueryOptions as q, createWalletClient as r, PublicArkivActions as s, chainFromName as t, RpcQueryOptions as tt, asc as u, OnEntityExpiresInExtendedEvent as v, UpdateEntityParameters as w, Attribute as x, OnEntityOwnerChangedEvent as y, eq as z };
+//# sourceMappingURL=index-DQGx5KZ6.d.cts.map