@arkiv-network/sdk 0.3.2-dev.1 → 0.3.2-dev.3

package/dist/{queryBuilder-D-bqHg3w.cjs → queryBuilder-DEkfSiCF.cjs}

@@ -157,6 +157,38 @@ var QueryResult = class {
 //#endregion
 //#region src/query/queryBuilder.ts
 /**
+* 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 The OrderByAttribute instance
+*
+* @example
+* const ascAttribute = asc("name", "string")
+*/
+function asc(attributeName, attributeType) {
+	return {
+		name: attributeName,
+		type: attributeType,
+		order: "asc"
+	};
+}
+/**
+* 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 The OrderByAttribute instance
+*
+* @example
+* const descAttribute = desc("name", "string")
+*/
+function desc(attributeName, attributeType) {
+	return {
+		name: attributeName,
+		type: attributeType,
+		order: "desc"
+	};
+}
+/**
 * 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
@@ -190,26 +222,23 @@ var QueryBuilder = class {
 		this._ownedBy = ownedBy;
 		return 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.
-	* @param attributeName - The name of the attribute to order by
-	* @param attributeType - The type of the attribute to order by (string or number)
-	* @param descending - The boolean value to set the order by descending
-	* @returns The QueryBuilder instance
-	*
-	* @example
-	* const builder = new QueryBuilder(client)
-	* builder.orderBy("name", "string", true)
-	*/
-	orderBy(attributeName, attributeType, descending = void 0) {
+	orderBy(attributeNameOrOrderByAttribute, attributeType, order = "asc") {
 		if (!this._orderBy) this._orderBy = [];
-		this._orderBy.push({
-			name: attributeName,
-			type: attributeType === "number" ? "numeric" : attributeType,
-			desc: !!descending
-		});
+		const pushOrderByAttribute = ({ name, type, order: order$1 }) => {
+			this._orderBy?.push({
+				name,
+				type: type === "number" ? "numeric" : type,
+				desc: order$1 === "desc"
+			});
+		};
+		if (typeof attributeNameOrOrderByAttribute === "string") {
+			if (!attributeType) throw new Error("attributeType is required when using positional orderBy arguments");
+			pushOrderByAttribute({
+				name: attributeNameOrOrderByAttribute,
+				type: attributeType,
+				order
+			});
+		} else pushOrderByAttribute(attributeNameOrOrderByAttribute);
 		return this;
 	}
 	/**
@@ -400,6 +429,18 @@ Object.defineProperty(exports, 'QueryResult', {
     return QueryResult;
   }
 });
+Object.defineProperty(exports, 'asc', {
+  enumerable: true,
+  get: function () {
+    return asc;
+  }
+});
+Object.defineProperty(exports, 'desc', {
+  enumerable: true,
+  get: function () {
+    return desc;
+  }
+});
 Object.defineProperty(exports, 'entityFromRpcResult', {
   enumerable: true,
   get: function () {

package/dist/{queryBuilder-DkhyyeFr.d.cts → queryBuilder-Dc_ii8LH.d.cts}

@@ -1,4 +1,4 @@
-import { g as ArkivClient, t as Entity } from "./entity-jTQZmEAd.cjs";
+import { g as ArkivClient, t as Entity } from "./entity-0JJeFAgO.cjs";
 import { Hex } from "viem";
 
 //#region src/query/predicate.d.ts
@@ -129,6 +129,31 @@ declare class QueryResult {
 }
 //#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 The OrderByAttribute instance
+ *
+ * @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 The OrderByAttribute instance
+ *
+ * @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.
@@ -163,14 +188,27 @@ declare class QueryBuilder {
    * The order of the attributes is important. The first attribute is the primary 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)
-   * @param descending - The boolean value to set the order by descending
+   * @param order - The order to set the order by (asc or desc)
+   * @returns The QueryBuilder instance
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * builder.orderBy("name", "string", "desc")
+   */
+  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("name", "string", true)
+   * builder.orderBy(asc("name", "string"))
+   * builder.orderBy(desc("name", "string"))
    */
-  orderBy(attributeName: string, attributeType: "string" | "number", descending?: boolean | undefined): this;
+  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
@@ -272,5 +310,5 @@ declare class QueryBuilder {
   count(): Promise<1>;
 }
 //#endregion
-export { PredicateType as a, gt as c, lte as d, neq as f, PredicateContainerType as i, gte as l, or as m, QueryResult as n, and as o, not as p, Predicate as r, eq as s, QueryBuilder as t, lt as u };
-//# sourceMappingURL=queryBuilder-DkhyyeFr.d.cts.map
+export { Predicate as a, and as c, gte as d, lt as f, or as g, not as h, QueryResult as i, eq as l, neq as m, asc as n, PredicateContainerType as o, lte as p, desc as r, PredicateType as s, QueryBuilder as t, gt as u };
+//# sourceMappingURL=queryBuilder-Dc_ii8LH.d.cts.map

package/dist/queryBuilder-Dc_ii8LH.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryBuilder-Dc_ii8LH.d.cts","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;;ACrB7C;;;;;;;;;;ACIK,iBFgCW,GAAA,CEhCK,UAAA,EFgCW,SEhCX,EAAA,CAAA,EFgCyB,SEhCzB;AAerB;AAiBA;AAaA;;;;;;;;AAmPa,iBFlPG,EAAA,CEkPH,GAAA,EAAA,MAAA,EAAA,KAAA,EAAA,MAAA,GAAA,MAAA,CAAA,EFlP4C,SEkP5C;;;;;;;;;;;iBFpOG,GAAA,uCAA0C;;;;;;;;;;;iBAc1C,EAAA,uCAAyC;;;;;;;;;;;iBAczC,GAAA,uCAA0C;;;;;;;;;;;iBAc1C,EAAA,uCAAyC;;;;;;;;;;;iBAczC,GAAA,uCAA0C;;;;;;;;;;iBAa1C,GAAA,eAAkB;;;cCrIrB,WAAA;YACD;EDLA,QAAA,eAAa;EACb,QAAA,OAAA;EAEA,QAAA,MAAS;EAET,QAAA,aAAA;EAKA,QAAA,aAAA;EACM,IAAA,YAAA,CAAA,CAAA,ECEI,YDFJ;EAAS,IAAA,MAAA,CAAA,CAAA,EAAA,MAAA,GAAA,SAAA;EAcX,WAAE,CAAA,QAAa,ECHjB,MDG+B,EAAA,EAAA,YAAS,ECFpC,YDEoC,EAAA,MAAA,EAAA,MAAA,GAAA,SAAA,EAAA,KAAA,EAAA,MAAA,GAAA,SAAA,EAAA,YAAA,EAAA,MAAA,GAAA,SAAA;EAetC,IAAA,CAAA,CAAG,ECJP,ODIO,CAAA,IAAa,CAAA;EAchB,WAAE,CAAA,CAAA,EAAA,OAAuC;AAczD;;;AApEA,KEQK,gBAAA,GFRoB;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;;;;ACrIA;;;;;AAgCY,iBCII,IAAA,CDJJ,aAAA,EAAA,MAAA,EAAA,aAAA,EAAA,QAAA,GAAA,QAAA,CAAA,ECIqE,gBDJrE;;;;;AC9B+B;AAiB3C;AAiBgB,cAaH,YAAA,CAboE;EAapE,QAAA,OAAY;EAYH,QAAA,QAAA;EAcH,QAAA,QAAA;EA+BS,QAAA,aAAA;EAuIR,QAAA,eAAA;EAAc,QAAA,aAAA;EAmBrB,QAAA,YAAA;EAAA,QAAA,MAAA;EAgCA,QAAA,OAAA;EAAA,QAAA,WAAA;sBAvOS;;;;;;;;;;mBAcH;;;;;;;;;;;;;;;;;;;;;;;;;;;4BA+BS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAuIR,cAAc;;;;;;;;;;;WAmBrB,QAAA;;;;;;;;;;WAgCA"}

package/dist/types/index.cjs

@@ -0,0 +1 @@
+require('../types-CBTc19th.cjs');

package/dist/types/index.d.cts

@@ -1,2 +1,2 @@
-import { _ as ArkivRpcSchema, a as MutateEntitiesReturnType, b as RpcQueryOptions, c as ExtendEntityParameters, d as DeleteEntityReturnType, f as CreateEntityParameters, h as ChangeOwnershipReturnType, i as MutateEntitiesParameters, l as ExtendEntityReturnType, m as ChangeOwnershipParameters, n as TxParams, o as UpdateEntityParameters, p as CreateEntityReturnType, r as Attribute, s as UpdateEntityReturnType, t as Entity, u as DeleteEntityParameters, v as RpcEntity, x as MimeType, y as RpcIncludeData } from "../entity-jTQZmEAd.cjs";
+import { _ as ArkivRpcSchema, a as MutateEntitiesReturnType, b as RpcQueryOptions, c as ExtendEntityParameters, d as DeleteEntityReturnType, f as CreateEntityParameters, h as ChangeOwnershipReturnType, i as MutateEntitiesParameters, l as ExtendEntityReturnType, m as ChangeOwnershipParameters, n as TxParams, o as UpdateEntityParameters, p as CreateEntityReturnType, r as Attribute, s as UpdateEntityReturnType, t as Entity, u as DeleteEntityParameters, v as RpcEntity, x as MimeType, y as RpcIncludeData } from "../entity-0JJeFAgO.cjs";
 export { ArkivRpcSchema, Attribute, ChangeOwnershipParameters, ChangeOwnershipReturnType, CreateEntityParameters, CreateEntityReturnType, DeleteEntityParameters, DeleteEntityReturnType, Entity, ExtendEntityParameters, ExtendEntityReturnType, MimeType, MutateEntitiesParameters, MutateEntitiesReturnType, RpcEntity, RpcIncludeData, RpcQueryOptions, TxParams, UpdateEntityParameters, UpdateEntityReturnType };

package/dist/types/index.d.ts

@@ -1,2 +1,2 @@
-import { _ as ArkivRpcSchema, a as MutateEntitiesReturnType, b as RpcQueryOptions, c as ExtendEntityParameters, d as DeleteEntityReturnType, f as CreateEntityParameters, h as ChangeOwnershipReturnType, i as MutateEntitiesParameters, l as ExtendEntityReturnType, m as ChangeOwnershipParameters, n as TxParams, o as UpdateEntityParameters, p as CreateEntityReturnType, r as Attribute, s as UpdateEntityReturnType, t as Entity, u as DeleteEntityParameters, v as RpcEntity, x as MimeType, y as RpcIncludeData } from "../entity-DvQtQL8v.js";
+import { _ as ArkivRpcSchema, a as MutateEntitiesReturnType, b as RpcQueryOptions, c as ExtendEntityParameters, d as DeleteEntityReturnType, f as CreateEntityParameters, h as ChangeOwnershipReturnType, i as MutateEntitiesParameters, l as ExtendEntityReturnType, m as ChangeOwnershipParameters, n as TxParams, o as UpdateEntityParameters, p as CreateEntityReturnType, r as Attribute, s as UpdateEntityReturnType, t as Entity, u as DeleteEntityParameters, v as RpcEntity, x as MimeType, y as RpcIncludeData } from "../entity-BG8YycYJ.js";
 export { ArkivRpcSchema, Attribute, ChangeOwnershipParameters, ChangeOwnershipReturnType, CreateEntityParameters, CreateEntityReturnType, DeleteEntityParameters, DeleteEntityReturnType, Entity, ExtendEntityParameters, ExtendEntityReturnType, MimeType, MutateEntitiesParameters, MutateEntitiesReturnType, RpcEntity, RpcIncludeData, RpcQueryOptions, TxParams, UpdateEntityParameters, UpdateEntityReturnType };

package/dist/types/index.js

@@ -0,0 +1 @@
+import "../types-Cv8NMtbo.js";

package/dist/utils/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/utils/expirationTime.ts","../../src/utils/payload.ts"],"sourcesContent":[],"mappings":";;;cAEa;;;EAAA,SAAA,EAAA,CAAA,KAUZ,EAAA,MAAA,EAAA,GADkB,MAAI;;;;ECTP,SAAA,EAAA,CAAA,KAAa,EAAA,MAAA,EAAA,GAAgB,MAAA;EAI7B,UAAA,EAAA,CAAA,MAAe,EAAA,MAAA,EAAA,GAAgB,MAAA;mBDK5B;;;;iBCTH,aAAA,gBAA6B;iBAI7B,eAAA,gBAA+B"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/utils/expirationTime.ts","../../src/utils/payload.ts"],"sourcesContent":[],"mappings":";;;cAEa;;;EAAA,SAAA,EAAA,CAAA,KAUZ,EAAA,MAAA,EAAA,GADkB,MAAI;;;;ECTP,SAAA,EAAA,CAAA,KAAa,EAAA,MAAA,EAAgB,GAAA,MAAA;EAI7B,UAAA,EAAA,CAAA,MAAe,EAAA,MAAA,EAAgB,GAAA,MAAA;mBDK5B;;;;iBCTH,aAAA,gBAA6B;iBAI7B,eAAA,gBAA+B"}

package/package.json

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

package/src/actions/public/getEntity.ts

@@ -1,14 +1,29 @@
-import type { Hex } from "viem"
+import { bytesToHex, type Hex, hexToBytes } from "viem"
 import type { ArkivClient } from "../../clients/baseClient"
 import { NoEntityFoundError } from "../../query/errors"
 import { entityFromRpcResult } from "../../utils/entities"
 
 export async function getEntity(client: ArkivClient, key: Hex) {
+  // Normalize the key into bytes
+  let bytes: Uint8Array
+  try {
+    bytes = hexToBytes(key)
+  } catch {
+    throw new Error(`Invalid key format: ${key}. Key must be a valid hex string.`)
+  }
+
+  if (bytes.length !== 32) {
+    throw new Error(
+      `Invalid key length: ${bytes.length} bytes. Key must be 32 bytes (64 hex characters) long.`,
+    )
+  }
+
+  const hexKey = bytesToHex(bytes)
+
   const result = await client.request({
     method: "arkiv_query",
-    params: [`$key = ${key}`],
+    params: [`$key = ${hexKey}`],
   })
-  console.debug("GetEntity result", result)
 
   if (!result.data) {
     throw new NoEntityFoundError()

package/src/clients/createPublicClient.ts

@@ -25,9 +25,9 @@ export type PublicArkivClient<
 /**
  * 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.golemdb.io/ts-sdk/clients/public
+ * - 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.golemdb.io/json-rpc/), and [Kaolin JSON-RPC API](https://kaolin.holesky.golemdb.io/rpc) methods such as retrieving block numbers, transactions, reading from smart contracts, etc through [Public Actions](/docs/actions/public/introduction).
+ * 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 config - {@link PublicClientConfig}
  * @returns A Arkiv Public Client. {@link PublicArkivClient}

package/src/clients/createWalletClient.ts

@@ -25,9 +25,9 @@ export type WalletArkivClient<
 /**
  * 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.golemdb.io/ts-sdk/clients/public
+ * - 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.golemdb.io/json-rpc/), and [Kaolin JSON-RPC API](https://kaolin.holesky.golemdb.io/rpc) methods such as retrieving block numbers, transactions, reading from smart contracts, etc through [Public Actions](/docs/actions/public/introduction).
+ * 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 config - {@link PublicClientConfig}
  * @returns A Arkiv Public Client. {@link PublicArkivClient}

package/src/clients/decorators/arkivPublic.ts

@@ -34,7 +34,7 @@ export type PublicArkivActions<
   /**
    * Returns the entity with the given key.
    *
-   * - Docs: https://docs.golemdb.io/ts-sdk/actions/public/getEntity
+   * - Docs: https://docs.arkiv.network/ts-sdk/actions/public/getEntity
    *
    * @param args - {entityKey}
    * @returns The entity with the given key. {@link Entity}
@@ -59,7 +59,7 @@ export type PublicArkivActions<
    * 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
+   * - Docs: https://docs.arkiv.network/ts-sdk/actions/public/query
    *
    * @returns A QueryBuilder instance for building and executing queries. {@link QueryBuilder}
    *

package/src/clients/decorators/arkivWallet.ts

@@ -49,7 +49,8 @@ export type WalletArkivActions<
     /**
      * Returns the entity with the given key.
      *
-     * - Docs: https://docs.golemdb.io/ts-sdk/actions/public/getEntity
+     * - Docs: https://docs.arkiv.network/ts-sdk/actions/public/getEntity
+     * - JSON-RPC Methods: [`eth_sendRawTransaction`](https://docs.arkiv.network/dev/json-rpc-api/#mutateEntities)
      *
      * @param args - {entityKey}
      * @returns The entity with the given key. {@link Entity}
@@ -82,8 +83,8 @@ export type WalletArkivActions<
     /**
      * 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)
+     * - 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 args - {entityKey, data}
      * @returns The entity with the given key. {@link Entity}
@@ -105,8 +106,8 @@ export type WalletArkivActions<
     /**
      * 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)
+     * - 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 args - {entityKey}
      * @returns The entity with the given key. {@link Entity}
@@ -135,8 +136,8 @@ export type WalletArkivActions<
     /**
      * 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)
+     * - 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 args - {entityKey, data}
      * @returns The entity with the given key. {@link Entity}
@@ -167,8 +168,8 @@ export type WalletArkivActions<
     /**
      * Changes the ownership of the entity with the given address.
      *
-     * - Docs: https://docs.golemdb.io/ts-sdk/actions/wallet/changeOwnership
-     * - JSON-RPC Methods: [`golembase_ownershipChange`](https://docs.golemdb.io/dev/json-rpc-api/#golembase_ownershipChange)
+     * - 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 args - {entityKey, newOwner}
      * @returns The entity with the given address. {@link Entity}
@@ -181,8 +182,8 @@ export type WalletArkivActions<
     /**
      * 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)
+     * - Docs: https://docs.arkiv.network/ts-sdk/actions/wallet/mutateEntities
+     * - JSON-RPC Methods: [`golembase_mutateEntities`](https://docs.arkiv.network/dev/json-rpc-api/#golembase_mutateEntities)
      *
      * @param args - {data}
      * @returns The entity with the given key. {@link Entity}

package/src/index.ts

@@ -1,15 +1,5 @@
-// Re-export commonly used viem types for convenience
-export type {
-  Account,
-  Address,
-  Chain,
-  Hex,
-  PublicClientConfig,
-  RpcSchema,
-  Transport,
-} from "viem"
-
-export { http, toBytes, toHex, toRlp, webSocket } from "viem"
+// Re-export all viem stuff
+export * from "viem"
 
 // export main arkiv stuff
 export type { ArkivClient } from "./clients/baseClient"
@@ -19,25 +9,4 @@ export type { WalletArkivClient } from "./clients/createWalletClient"
 export { createWalletClient } from "./clients/createWalletClient"
 
 // re-export arkiv types in main index file
-export type {
-  ArkivRpcSchema,
-  Attribute,
-  ChangeOwnershipParameters,
-  ChangeOwnershipReturnType,
-  CreateEntityParameters,
-  CreateEntityReturnType,
-  DeleteEntityParameters,
-  DeleteEntityReturnType,
-  Entity,
-  ExtendEntityParameters,
-  ExtendEntityReturnType,
-  MimeType,
-  MutateEntitiesParameters,
-  MutateEntitiesReturnType,
-  RpcEntity,
-  RpcIncludeData,
-  RpcQueryOptions,
-  TxParams,
-  UpdateEntityParameters,
-  UpdateEntityReturnType,
-} from "./types"
+export * from "./types"

package/src/query/engine.test.ts

@@ -267,7 +267,7 @@ describe("processQuery tests", () => {
     const predicates = [{ type: "eq" as const, key: "key", value: "value" }]
     await processQuery(client, {
       predicates,
-      orderBy: [{ name: "key", type: "string", descending: true }],
+      orderBy: [{ name: "key", type: "string", desc: true }],
       limit: undefined,
       cursor: undefined,
       ownedBy: undefined,
@@ -278,7 +278,7 @@ describe("processQuery tests", () => {
       params: [
         `key = "value"`,
         {
-          orderBy: [{ name: "key", type: "string", descending: true }],
+          orderBy: [{ name: "key", type: "string", desc: true }],
           includeData: {
             key: true,
             attributes: false,
@@ -299,7 +299,7 @@ describe("processQuery tests", () => {
       limit: undefined,
       cursor: undefined,
       ownedBy: undefined,
-      orderBy: [{ name: "key", type: "string", descending: true }],
+      orderBy: [{ name: "key", type: "string", desc: true }],
       validAtBlock: undefined,
       withAttributes: undefined,
       withMetadata: undefined,
@@ -310,7 +310,7 @@ describe("processQuery tests", () => {
       params: [
         "",
         {
-          orderBy: [{ name: "key", type: "string", descending: true }],
+          orderBy: [{ name: "key", type: "string", desc: true }],
           includeData: {
             key: true,
             attributes: false,

package/src/query/queryBuilder.test.ts

@@ -4,7 +4,7 @@ import { Entity } from "../types/entity"
 import * as entitiesUtils from "../utils/entities"
 import * as engine from "./engine"
 import { and, eq, gt, gte, neq, or } from "./predicate"
-import { QueryBuilder } from "./queryBuilder"
+import { asc, QueryBuilder } from "./queryBuilder"
 
 describe("QueryBuilder", () => {
   let mockClient: ArkivClient
@@ -177,13 +177,34 @@ describe("QueryBuilder", () => {
       })
     })
 
-    test("orderBy() sets orderBy", async () => {
+    test("orderBy() sets orderBy ascending", async () => {
       mockProcessQuery.mockResolvedValue({
         data: [],
       })
 
       const builder = new QueryBuilder(mockClient)
-      await builder.orderBy("name", "string", true).fetch()
+      await builder.orderBy("name", "string", "asc").fetch()
+
+      expect(mockProcessQuery).toHaveBeenCalledWith(mockClient, {
+        predicates: [],
+        limit: undefined,
+        offset: undefined,
+        ownedBy: undefined,
+        orderBy: [{ name: "name", type: "string", desc: false }],
+        validAtBlock: undefined,
+        withAttributes: undefined,
+        withMetadata: undefined,
+        withPayload: undefined,
+      })
+    })
+
+    test("orderBy() sets orderBy descending", async () => {
+      mockProcessQuery.mockResolvedValue({
+        data: [],
+      })
+
+      const builder = new QueryBuilder(mockClient)
+      await builder.orderBy("name", "string", "desc").fetch()
 
       expect(mockProcessQuery).toHaveBeenCalledWith(mockClient, {
         predicates: [],
@@ -198,6 +219,26 @@ describe("QueryBuilder", () => {
       })
     })
 
+    test("orderBy() with helper function", async () => {
+      mockProcessQuery.mockResolvedValue({
+        data: [],
+      })
+
+      const builder = new QueryBuilder(mockClient)
+      await builder.orderBy(asc("name", "string")).fetch()
+
+      expect(mockProcessQuery).toHaveBeenCalledWith(mockClient, {
+        predicates: [],
+        limit: undefined,
+        offset: undefined,
+        ownedBy: undefined,
+        orderBy: [{ name: "name", type: "string", desc: false }],
+        validAtBlock: undefined,
+        withAttributes: undefined,
+        withMetadata: undefined,
+        withPayload: undefined,
+      })
+    })
     test("limit() sets limit", async () => {
       mockProcessQuery.mockResolvedValue({
         data: [],

package/src/query/queryBuilder.ts

@@ -6,6 +6,45 @@ import { processQuery } from "./engine"
 import type { Predicate } from "./predicate"
 import { QueryResult } from "./queryResult"
 
+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 The OrderByAttribute instance
+ *
+ * @example
+ * const ascAttribute = asc("name", "string")
+ */
+export function asc(attributeName: string, attributeType: "string" | "number"): OrderByAttribute {
+  return {
+    name: attributeName,
+    type: attributeType,
+    order: "asc",
+  }
+}
+
+/**
+ * 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 The OrderByAttribute instance
+ *
+ * @example
+ * const descAttribute = desc("name", "string")
+ */
+export function desc(attributeName: string, attributeType: "string" | "number"): OrderByAttribute {
+  return {
+    name: attributeName,
+    type: attributeType,
+    order: "desc",
+  }
+}
 /**
  * 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.
@@ -49,26 +88,57 @@ export class QueryBuilder {
    * The order of the attributes is important. The first attribute is the primary 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)
-   * @param descending - The boolean value to set the order by descending
+   * @param order - The order to set the order by (asc or desc)
+   * @returns The QueryBuilder instance
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * builder.orderBy("name", "string", "desc")
+   */
+  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("name", "string", true)
+   * builder.orderBy(asc("name", "string"))
+   * builder.orderBy(desc("name", "string"))
    */
+  orderBy(orderByAttribute: OrderByAttribute): this
   orderBy(
-    attributeName: string,
-    attributeType: "string" | "number",
-    descending: boolean | undefined = undefined,
+    attributeNameOrOrderByAttribute: string | OrderByAttribute,
+    attributeType?: "string" | "number",
+    order: "asc" | "desc" = "asc",
   ) {
     if (!this._orderBy) {
       this._orderBy = []
     }
-    this._orderBy.push({
-      name: attributeName,
-      type: attributeType === "number" ? "numeric" : attributeType,
-      desc: !!descending,
-    } as RpcOrderByAttribute)
+
+    const pushOrderByAttribute = ({ name, type, order }: OrderByAttribute) => {
+      this._orderBy?.push({
+        name,
+        type: type === "number" ? "numeric" : type,
+        desc: order === "desc",
+      })
+    }
+
+    if (typeof attributeNameOrOrderByAttribute === "string") {
+      if (!attributeType) {
+        throw new Error("attributeType is required when using positional orderBy arguments")
+      }
+      pushOrderByAttribute({
+        name: attributeNameOrOrderByAttribute,
+        type: attributeType,
+        order,
+      })
+    } else {
+      pushOrderByAttribute(attributeNameOrOrderByAttribute)
+    }
+
     return this
   }
 

package/src/types/rpcSchema.ts

@@ -35,11 +35,6 @@ export type RpcIncludeData = {
 }
 
 export type ArkivRpcSchema = [
-  {
-    Method: "golembase_getStorageValue"
-    Parameters?: [entityId: Hex]
-    ReturnType: string
-  },
   {
     Method: "arkiv_query"
     Parameters?: [query: string, queryOptions?: RpcQueryOptions]