@arkiv-network/sdk 0.5.0-dev.3 → 0.5.0-dev.5

package/dist/queryBuilder-XIln1aIM.d.ts

@@ -0,0 +1,317 @@
+import { D as ArkivClient, a as Entity } from "./query-DybEplzd.js";
+import { Hex } from "viem";
+
+//#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/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
+export { or as _, QueryResult as a, PredicateType as c, gt as d, gte as f, not as g, neq as h, desc as i, and as l, lte as m, QueryBuilder as n, Predicate as o, lt as p, asc as r, PredicateContainerType as s, OrderByAttribute as t, eq as u };
+//# sourceMappingURL=queryBuilder-XIln1aIM.d.ts.map

package/dist/queryBuilder-XIln1aIM.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryBuilder-XIln1aIM.d.ts","names":[],"sources":["../src/query/predicate.ts","../src/query/queryResult.ts","../src/query/queryBuilder.ts"],"sourcesContent":[],"mappings":";;;;KAAY,aAAA;KACA,sBAAA;KAEA,SAAA;QAEA;EALA,GAAA,EAAA,MAAA;EACA,KAAA,EAAA,MAAA,GAAA,MAAA;AAEZ,CAAA,GAAY;EAEA,IAAA,EAKA,sBALA;EAKA,UAAA,EACM,SADN,EAAA;CACM;;AAclB;AAeA;AAcA;AAcA;AAcA;AAcA;AAcA;AAcA;AAaA;;iBAhHgB,EAAA,aAAe,cAAc;;AClB7C;;;;;;;;;;ACCY,iBFgCI,GAAA,CEhCY,UAAA,EFgCI,SEhCJ,EAAA,CAAA,EFgCkB,SEhClB;AAe5B;AAiBA;AAaA;;;;;;;;AAsPa,iBFrPG,EAAA,CEqPH,GAAA,EAAA,MAAA,EAAA,KAAA,EAAA,MAAA,GAAA,MAAA,CAAA,EFrP4C,SEqP5C;;;;;;;;;;;iBFvOG,GAAA,uCAA0C;;;;;;;;;;;iBAc1C,EAAA,uCAAyC;;;;;;;;;;;iBAczC,GAAA,uCAA0C;;;;;;;;;;;iBAc1C,EAAA,uCAAyC;;;;;;;;;;;iBAczC,GAAA,uCAA0C;;;;;;;;;;iBAa1C,GAAA,eAAkB;;;cClIrB,WAAA;YACD;EDRA,QAAA,eAAa;EACb,QAAA,OAAA;EAEA,QAAA,MAAS;EAET,QAAA,aAAA;EAKA,QAAA,aAAA;EACM,IAAA,YAAA,CAAA,CAAA,ECKI,YDLJ;EAAS,IAAA,MAAA,CAAA,CAAA,EAAA,MAAA,GAAA,SAAA;EAcX,WAAE,CAAA,QAAa,ECAjB,MDA+B,EAAA,EAAA,YAAS,ECCpC,YDDoC,EAAA,MAAA,EAAA,MAAA,GAAA,SAAA,EAAA,KAAA,EAAA,MAAA,GAAA,SAAA,EAAA,YAAA,EAAA,MAAA,GAAA,SAAA;EAetC,IAAA,CAAA,CAAG,ECDP,ODCO,CAAA,IAAa,CAAA;EAchB,WAAE,CAAA,CAAA,EAAA,OAAuC;AAczD;;;AApEY,KEQA,gBAAA,GFRa;EACb,IAAA,EAAA,MAAA;EAEA,IAAA,EAAA,QAAS,GAAA,QAAA;EAET,KAAA,EAAA,KAAA,GAAA,MAAA;CAKA;;;AAeZ;AAeA;AAcA;AAcA;AAcA;AAcA;AAcA;AAcgB,iBErGA,GAAA,CFqG0C,aAAS,EAAA,MAAA,EAAA,aAAA,EAAA,QAAA,GAAA,QAAA,CAAA,EErGa,gBFqGb;AAanE;;;;AClIA;;;;;AAgCY,iBCCI,IAAA,CDDJ,aAAA,EAAA,MAAA,EAAA,aAAA,EAAA,QAAA,GAAA,QAAA,CAAA,ECCqE,gBDDrE;;;;;AC/BZ;AAeA;AAiBgB,cAaH,YAAA,CAboE;EAapE,QAAA,OAAY;EAYH,QAAA,QAAA;EAcH,QAAA,QAAA;EAkCS,QAAA,aAAA;EAuIR,QAAA,eAAA;EAAc,QAAA,aAAA;EAmBrB,QAAA,YAAA;EAAA,QAAA,MAAA;EAgCA,QAAA,OAAA;EAAA,QAAA,WAAA;sBA1OS;;;;;;;;;;mBAcH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4BAkCS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAuIR,cAAc;;;;;;;;;;;WAmBrB,QAAA;;;;;;;;;;WAgCA"}

package/dist/types/index.d.cts

@@ -1,3 +1,2 @@
-import { $ as RpcIncludeData, A as CreateEntityParameters, C as MutateEntitiesReturnType, D as ExtendEntityReturnType, E as ExtendEntityParameters, J as QueryOptionsIncludeData, M as ChangeOwnershipParameters, N as ChangeOwnershipReturnType, O as DeleteEntityParameters, P as GetBlockTimingReturnType, Q as RpcEntity, S as MutateEntitiesParameters, T as UpdateEntityReturnType, Y as QueryOptionsOrderBy, Z as ArkivRpcSchema, _ as OnEntityExpiredEvent, b as OnEntityUpdatedEvent, et as RpcOrderByAttribute, g as OnEntityDeletedEvent, h as OnEntityCreatedEvent, j as CreateEntityReturnType, k as DeleteEntityReturnType, m as TxParams, nt as MimeType, p as Entity, q as QueryOptions, tt as RpcQueryOptions, v as OnEntityExpiresInExtendedEvent, w as UpdateEntityParameters, x as Attribute, y as OnEntityOwnerChangedEvent } from "../index-DQGx5KZ6.cjs";
-import "../payload-D3fyOBWn.cjs";
-export { ArkivRpcSchema, Attribute, ChangeOwnershipParameters, ChangeOwnershipReturnType, CreateEntityParameters, CreateEntityReturnType, DeleteEntityParameters, DeleteEntityReturnType, Entity, ExtendEntityParameters, ExtendEntityReturnType, GetBlockTimingReturnType, MimeType, MutateEntitiesParameters, MutateEntitiesReturnType, OnEntityCreatedEvent, OnEntityDeletedEvent, OnEntityExpiredEvent, OnEntityExpiresInExtendedEvent, OnEntityOwnerChangedEvent, OnEntityUpdatedEvent, QueryOptions, QueryOptionsIncludeData, QueryOptionsOrderBy, RpcEntity, RpcIncludeData, RpcOrderByAttribute, RpcQueryOptions, TxParams, UpdateEntityParameters, UpdateEntityReturnType };
+import { A as RpcIncludeData, C as CreateEntityReturnType, E as GetBlockTimingReturnType, M as RpcQueryOptions, N as MimeType, O as ArkivRpcSchema, S as CreateEntityParameters, T as ChangeOwnershipReturnType, _ as UpdateEntityReturnType, a as Entity, b as DeleteEntityParameters, c as OnEntityDeletedEvent, d as OnEntityOwnerChangedEvent, f as OnEntityUpdatedEvent, g as UpdateEntityParameters, h as MutateEntitiesReturnType, i as QueryReturnType, j as RpcOrderByAttribute, k as RpcEntity, l as OnEntityExpiredEvent, m as MutateEntitiesParameters, n as QueryOptionsIncludeData, o as TxParams, p as Attribute, r as QueryOptionsOrderBy, s as OnEntityCreatedEvent, t as QueryOptions, u as OnEntityExpiresInExtendedEvent, v as ExtendEntityParameters, w as ChangeOwnershipParameters, x as DeleteEntityReturnType, y as ExtendEntityReturnType } from "../query-C0dwQYxT.cjs";
+export { ArkivRpcSchema, Attribute, ChangeOwnershipParameters, ChangeOwnershipReturnType, CreateEntityParameters, CreateEntityReturnType, DeleteEntityParameters, DeleteEntityReturnType, Entity, ExtendEntityParameters, ExtendEntityReturnType, GetBlockTimingReturnType, MimeType, MutateEntitiesParameters, MutateEntitiesReturnType, OnEntityCreatedEvent, OnEntityDeletedEvent, OnEntityExpiredEvent, OnEntityExpiresInExtendedEvent, OnEntityOwnerChangedEvent, OnEntityUpdatedEvent, QueryOptions, QueryOptionsIncludeData, QueryOptionsOrderBy, QueryReturnType, RpcEntity, RpcIncludeData, RpcOrderByAttribute, RpcQueryOptions, TxParams, UpdateEntityParameters, UpdateEntityReturnType };

package/dist/types/index.d.ts

@@ -1,3 +1,2 @@
-import { $ as RpcIncludeData, A as CreateEntityParameters, C as MutateEntitiesReturnType, D as ExtendEntityReturnType, E as ExtendEntityParameters, J as QueryOptionsIncludeData, M as ChangeOwnershipParameters, N as ChangeOwnershipReturnType, O as DeleteEntityParameters, P as GetBlockTimingReturnType, Q as RpcEntity, S as MutateEntitiesParameters, T as UpdateEntityReturnType, Y as QueryOptionsOrderBy, Z as ArkivRpcSchema, _ as OnEntityExpiredEvent, b as OnEntityUpdatedEvent, et as RpcOrderByAttribute, g as OnEntityDeletedEvent, h as OnEntityCreatedEvent, j as CreateEntityReturnType, k as DeleteEntityReturnType, m as TxParams, nt as MimeType, p as Entity, q as QueryOptions, tt as RpcQueryOptions, v as OnEntityExpiresInExtendedEvent, w as UpdateEntityParameters, x as Attribute, y as OnEntityOwnerChangedEvent } from "../index-B801JxcV.js";
-import "../payload-BI2NXPDf.js";
-export { ArkivRpcSchema, Attribute, ChangeOwnershipParameters, ChangeOwnershipReturnType, CreateEntityParameters, CreateEntityReturnType, DeleteEntityParameters, DeleteEntityReturnType, Entity, ExtendEntityParameters, ExtendEntityReturnType, GetBlockTimingReturnType, MimeType, MutateEntitiesParameters, MutateEntitiesReturnType, OnEntityCreatedEvent, OnEntityDeletedEvent, OnEntityExpiredEvent, OnEntityExpiresInExtendedEvent, OnEntityOwnerChangedEvent, OnEntityUpdatedEvent, QueryOptions, QueryOptionsIncludeData, QueryOptionsOrderBy, RpcEntity, RpcIncludeData, RpcOrderByAttribute, RpcQueryOptions, TxParams, UpdateEntityParameters, UpdateEntityReturnType };
+import { A as RpcIncludeData, C as CreateEntityReturnType, E as GetBlockTimingReturnType, M as RpcQueryOptions, N as MimeType, O as ArkivRpcSchema, S as CreateEntityParameters, T as ChangeOwnershipReturnType, _ as UpdateEntityReturnType, a as Entity, b as DeleteEntityParameters, c as OnEntityDeletedEvent, d as OnEntityOwnerChangedEvent, f as OnEntityUpdatedEvent, g as UpdateEntityParameters, h as MutateEntitiesReturnType, i as QueryReturnType, j as RpcOrderByAttribute, k as RpcEntity, l as OnEntityExpiredEvent, m as MutateEntitiesParameters, n as QueryOptionsIncludeData, o as TxParams, p as Attribute, r as QueryOptionsOrderBy, s as OnEntityCreatedEvent, t as QueryOptions, u as OnEntityExpiresInExtendedEvent, v as ExtendEntityParameters, w as ChangeOwnershipParameters, x as DeleteEntityReturnType, y as ExtendEntityReturnType } from "../query-DybEplzd.js";
+export { ArkivRpcSchema, Attribute, ChangeOwnershipParameters, ChangeOwnershipReturnType, CreateEntityParameters, CreateEntityReturnType, DeleteEntityParameters, DeleteEntityReturnType, Entity, ExtendEntityParameters, ExtendEntityReturnType, GetBlockTimingReturnType, MimeType, MutateEntitiesParameters, MutateEntitiesReturnType, OnEntityCreatedEvent, OnEntityDeletedEvent, OnEntityExpiredEvent, OnEntityExpiresInExtendedEvent, OnEntityOwnerChangedEvent, OnEntityUpdatedEvent, QueryOptions, QueryOptionsIncludeData, QueryOptionsOrderBy, QueryReturnType, RpcEntity, RpcIncludeData, RpcOrderByAttribute, RpcQueryOptions, TxParams, UpdateEntityParameters, UpdateEntityReturnType };

package/dist/utils/index.d.cts

@@ -1,4 +1,4 @@
-import { n as stringToPayload, t as jsonToPayload } from "../payload-D3fyOBWn.cjs";
+import { n as stringToPayload, t as jsonToPayload } from "../payload-CJN8fTvX.cjs";
 export * from "viem/utils";
 
 //#region src/utils/expirationTime.d.ts

package/dist/utils/index.d.ts

@@ -1,4 +1,4 @@
-import { n as stringToPayload, t as jsonToPayload } from "../payload-BI2NXPDf.js";
+import { n as stringToPayload, t as jsonToPayload } from "../payload-Da9gJMG5.js";
 export * from "viem/utils";
 
 //#region src/utils/expirationTime.d.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkiv-network/sdk",
-  "version": "0.5.0-dev.3",
+  "version": "0.5.0-dev.5",
   "description": "TypeScript client library for Arkiv's blockchains interactions",
   "type": "module",
   "target": "esnext",

package/src/actions/public/getEntity.ts

@@ -1,6 +1,6 @@
 import { bytesToHex, type Hex, hexToBytes } from "viem"
 import type { ArkivClient } from "../../clients/baseClient"
-import { NoEntityFoundError } from "../../query/errors"
+import { NoEntityFoundError } from "../../errors"
 import { entityFromRpcResult } from "../../utils/entities"
 
 export async function getEntity(client: ArkivClient, key: Hex) {

package/src/actions/public/query.ts

@@ -1,4 +1,5 @@
 import type { ArkivClient } from "../../clients/baseClient"
+import type { Entity } from "../../types/entity"
 import type { RpcQueryOptions } from "../../types/rpcSchema"
 import { entityFromRpcResult } from "../../utils/entities"
 
@@ -21,6 +22,12 @@ export type QueryOptions = {
   cursor?: string | undefined
 }
 
+export type QueryReturnType = {
+  entities: Entity[]
+  cursor: string | undefined
+  blockNumber: bigint | undefined
+}
+
 export async function query(client: ArkivClient, query: string, queryOptions?: QueryOptions) {
   const rpcQueryOptions: RpcQueryOptions = {
     includeData: {
@@ -56,5 +63,9 @@ export async function query(client: ArkivClient, query: string, queryOptions?: Q
 
   const entities = await Promise.all(result.data.map((entity) => entityFromRpcResult(entity)))
 
-  return entities
+  return {
+    entities,
+    cursor: result.cursor,
+    blockNumber: BigInt(result.blockNumber),
+  }
 }

package/src/clients/decorators/arkivPublic.ts

@@ -2,7 +2,7 @@ import type { Account, Chain, Client, Hex, PublicActions, Transport } from "viem
 import { getBlockTiming } from "../../actions/public/getBlockTiming"
 import { getEntity } from "../../actions/public/getEntity"
 import { getEntityCount } from "../../actions/public/getEntityCount"
-import { type QueryOptions, query } from "../../actions/public/query"
+import { type QueryOptions, type QueryReturnType, query } from "../../actions/public/query"
 import { subscribeEntityEvents } from "../../actions/public/subscribeEntityEvents"
 import { QueryBuilder } from "../../query/queryBuilder"
 import type { Entity } from "../../types/entity"
@@ -82,7 +82,7 @@ export type PublicArkivActions<
    * 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}
+   * @returns A QueryReturnType instance - {@link QueryReturnType}
    *
    * @example
    * import { createPublicClient, http } from 'arkiv'
@@ -93,7 +93,7 @@ export type PublicArkivActions<
    *   transport: http(),
    * })
    * const queryResult = client.query('key = value && $owner = 0x123')
-   * // queryResult = [{ key: "0x123", value: "0x123" }]
+   * // queryResult = { entities: [{ key: "0x123", value: "0x123" }], cursor: undefined, blockNumber: undefined }
    * const queryResultWithOptions = client.query('key = value && $owner = 0x123', {
    *   includeData: {
    *     attributes: false,
@@ -105,9 +105,9 @@ export type PublicArkivActions<
    *   cursor: undefined,
    *   atBlock: undefined,
    * })
-   * // queryResultWithOptions = [{ key: "0x123", value: "0x123" }]
+   * // queryResultWithOptions = { entities: [{ key: "0x123", value: "0x123" }], cursor: "...", blockNumber: 32223n }
    */
-  query: (query: string, queryOptions?: QueryOptions) => Promise<Entity[]>
+  query: (query: string, queryOptions?: QueryOptions) => Promise<QueryReturnType>
 
   /**
    * Returns the number of entities in the DBChain.

package/src/clients/decorators/arkivWallet.ts

@@ -39,10 +39,10 @@ export type WalletArkivActions<
   Pick<
     WalletActions<chain, account>,
     | "addChain"
+    | "sendCalls"
+    | "waitForCallsStatus"
     | "sendTransaction"
-    | "sendTransactionSync"
     | "sendRawTransaction"
-    | "sendRawTransactionSync"
     | "signMessage"
     | "signTransaction"
   > & {

package/src/{query/errors.ts → errors.ts}

@@ -1,17 +1,27 @@
+export class EntityMutationError extends Error {
+  constructor(message: string) {
+    super(message)
+    this.name = "EntityMutationError"
+  }
+}
+
 export class NoMoreResultsError extends Error {
   constructor() {
     super("No more results")
+    this.name = "NoMoreResultsError"
   }
 }
 
 export class NoCursorOrLimitError extends Error {
   constructor() {
     super("Cursor and limit must be defined to fetch next")
+    this.name = "NoCursorOrLimitError"
   }
 }
 
 export class NoEntityFoundError extends Error {
   constructor() {
     super("No entity found")
+    this.name = "NoEntityFoundError"
   }
 }

package/src/index.ts

@@ -13,10 +13,10 @@ export type { WalletArkivClient } from "./clients/createWalletClient"
 export { createWalletClient } from "./clients/createWalletClient"
 export type { PublicArkivActions } from "./clients/decorators/arkivPublic"
 export type { WalletArkivActions } from "./clients/decorators/arkivWallet"
-
+// re-export errors
+export * from "./errors"
 // re-export arkiv types in main index file
 export * from "./types"
-
 // re-export chosen utils
 export { chainFromName } from "./utils/chains"
 export { jsonToPayload, stringToPayload } from "./utils/payload"

package/src/query/index.ts

@@ -1,4 +1,3 @@
-export * from "./errors"
 export * from "./predicate"
 export * from "./queryBuilder"
 export * from "./queryResult"

package/src/query/queryResult.test.ts

@@ -1,6 +1,6 @@
 import { beforeEach, describe, expect, jest, test } from "bun:test"
+import { NoCursorOrLimitError, NoMoreResultsError } from "../errors"
 import { Entity } from "../types/entity"
-import { NoCursorOrLimitError, NoMoreResultsError } from "./errors"
 import type { QueryBuilder } from "./queryBuilder"
 import { QueryResult } from "./queryResult"
 

package/src/query/queryResult.ts

@@ -1,6 +1,6 @@
+import { NoCursorOrLimitError, NoMoreResultsError } from "../errors"
 import type { Entity } from "../types/entity"
 import { getLogger } from "../utils/logger"
-import { NoCursorOrLimitError, NoMoreResultsError } from "./errors"
 import type { QueryBuilder } from "./queryBuilder"
 
 const logger = getLogger("query:result")

package/src/types/index.ts

@@ -3,6 +3,7 @@ export type {
   QueryOptions,
   QueryOptionsIncludeData,
   QueryOptionsOrderBy,
+  QueryReturnType,
 } from "../actions/public/query"
 export type {
   ChangeOwnershipParameters,

package/src/types/rpcSchema.ts

@@ -48,7 +48,7 @@ export type ArkivRpcSchema = [
     Parameters?: [query: string, queryOptions?: RpcQueryOptions]
     ReturnType: {
       data: RpcEntity[]
-      blockNumber: bigint
+      blockNumber: number
       cursor: string
     }
   },

package/src/utils/arkivTransactions.ts

@@ -1,4 +1,4 @@
-import { type Hex, toBytes, toHex, toRlp } from "viem"
+import { type Hex, TransactionExecutionError, toBytes, toHex, toRlp } from "viem"
 import type { ChangeOwnershipParameters } from "../actions/wallet/changeOwnership"
 import type { CreateEntityParameters } from "../actions/wallet/createEntity"
 import type { DeleteEntityParameters } from "../actions/wallet/deleteEntity"
@@ -7,6 +7,7 @@ import type { UpdateEntityParameters } from "../actions/wallet/updateEntity"
 import type { ArkivClient } from "../clients/baseClient"
 import type { WalletArkivClient } from "../clients/createWalletClient"
 import { ARKIV_ADDRESS, BLOCK_TIME } from "../consts"
+import { EntityMutationError } from "../errors"
 import type { TxParams } from "../types"
 import { compress } from "./compression"
 import { getLogger } from "./logger"
@@ -30,7 +31,10 @@ export function opsToTxData({
     key: string
     value: T
   }): [Hex, Hex] {
-    return [toHex(attribute.key), toHex(attribute.value)]
+    return [
+      toHex(attribute.key),
+      toHex(typeof attribute.value === "number" && attribute.value === 0 ? "" : attribute.value),
+    ]
   }
 
   const payload = [
@@ -85,19 +89,36 @@ export async function sendArkivTransaction(client: ArkivClient, data: Hex, txPar
     ...txParams,
   })
 
-  const compressed = await compress(toBytes(data))
-  const txHash = await walletClient.sendTransaction({
-    account: client.account,
-    chain: client.chain,
-    to: ARKIV_ADDRESS,
-    value: 0n,
-    data: toHex(compressed),
-    ...txParams,
-  })
+  try {
+    const compressed = await compress(toBytes(data))
+    const txHash = await walletClient.sendTransaction({
+      account: client.account,
+      chain: client.chain,
+      to: ARKIV_ADDRESS,
+      value: 0n,
+      data: toHex(compressed),
+      ...txParams,
+    })
 
-  const receipt = await walletClient.waitForTransactionReceipt({ hash: txHash })
+    const receipt = await walletClient.waitForTransactionReceipt({ hash: txHash })
+    logger("Tx receipt %o", receipt)
+    if (receipt.status === "reverted") {
+      logger("Reverted transaction %o", receipt)
+      throw new EntityMutationError(
+        `Transaction ${receipt.transactionHash} reverted. Please make sure the data for entities doesn't contain invalid characters or invalid data types.`,
+      )
+    }
 
-  logger("Tx receipt %o", receipt)
+    return receipt
+  } catch (error) {
+    let message = "Transaction failed"
+    if (error instanceof TransactionExecutionError) {
+      message += `: ${error.details}`
+    } else if (error instanceof EntityMutationError) {
+      throw error
+    }
 
-  return receipt
+    logger("%s Detailed error stack: %o", message, error)
+    throw new EntityMutationError(message)
+  }
 }