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

package/README.md

@@ -1,18 +1,20 @@
 # arkivjs
 
 A TypeScript client library for Arkiv's blockchains interactions.
-The Arkiv SDK base strongly on Viem (Viem)[https://github.com/wevm/viem] library - it can be treated as Viem replacement extended of Arkiv's chains specific features.
+The Arkiv SDK builds strongly on the [Viem](https://github.com/wevm/viem) library - it extends Viem's clients with Arkiv's chain-specific features.
+
+[`viem`](https://viem.sh) is a **peer dependency**: install it alongside the SDK.
 
 ## Installation
 
 ```bash
-npm install @arkiv-network/sdk
+npm install @arkiv-network/sdk viem
 # or
-pnpm install @arkiv-network/sdk
+pnpm install @arkiv-network/sdk viem
 # or
-bun add @arkiv-network/sdk
+bun add @arkiv-network/sdk viem
 # or
-yarn add @arkiv-network/sdk
+yarn add @arkiv-network/sdk viem
 ```
 
 ## Usage
@@ -76,14 +78,15 @@ Modify the `"main"` entry to `"read_example.ts"` and set `"type"` to `"module"`
 }
 ```
 
-Install `@arkiv-network/sdk` using your preferred package manager:
+Install `@arkiv-network/sdk` along with its `viem` peer dependency using your preferred package manager:
 ```bash
-npm install @arkiv-network/sdk
+npm install @arkiv-network/sdk viem
 ```
 This command will update your `package.json` with a section like:
 ```json
 "dependencies": {
-  "@arkiv-network/sdk": "^0.6.0"
+  "@arkiv-network/sdk": "^0.6.0",
+  "viem": "^2.38.2"
 }
 ```
 It will also create a `node_modules` directory with all dependencies installed.
@@ -93,9 +96,10 @@ It will also create a `node_modules` directory with all dependencies installed.
 You can now use Arkiv's public client to query data. Paste the following in `read_example.ts`:
 
 ```typescript
-import { createPublicClient, http } from "@arkiv-network/sdk"
+import { createPublicClient } from "@arkiv-network/sdk"
 import { braga } from "@arkiv-network/sdk/chains"
 import { eq } from "@arkiv-network/sdk/query"
+import { http } from "viem"
 
 const publicClient = createPublicClient({
   chain: braga, // "braga" is Arkiv's testnet
@@ -110,13 +114,11 @@ console.log('Chain ID:', chainId);
 const entity = await publicClient.getEntity('0xcadb830a3414251d65e5c92cd28ecb648d9e73d85f2203eff631839d5421f9d7');
 console.log('Entity:', entity);
 
-// Build and execute a query using QueryBuilder
-const query = publicClient.buildQuery();
-const result = await query
+// Build and execute a query using select()
+const result = await publicClient
+  .select({ owner: true, attributes: true, payload: true })
   .where(eq('category', 'documentation'))
   .ownedBy('0x6186B0DbA9652262942d5A465d49686eb560834C')
-  .withAttributes(true)
-  .withPayload(true)
   .limit(10)
   .fetch();
 
@@ -129,6 +131,39 @@ if (result.hasNextPage()) {
 }
 ```
 
+#### Selecting fields with `select()`
+
+Pass nothing (or `"*"`) to fetch everything, or pass an object to fetch only specific fields:
+
+```typescript
+// All fields
+await publicClient.select().where(eq("category", "docs")).fetch();
+
+// Only the fields you need
+await publicClient.select({ key: true, owner: true, payload: true }).where(eq("category", "docs")).fetch();
+```
+
+**Select only what you need.** Every selected field is fetched over the network, so requesting
+data you won't use makes queries slower. Narrowing the selection keeps responses small and fast.
+
+The result type is inferred from your selection: reading a field you didn't select is a compile error. The `toText()` / `toJson()` payload
+helpers are available only when you select `payload`.
+
+```typescript
+const [entity] = (await publicClient.select({ owner: true, payload: true }).fetch()).entities;
+entity.owner;     // ✅ Hex
+entity.toJson();  // ✅ payload was selected
+entity.creator;   // ❌ compile error — not selected
+```
+
+> **Footgun:** pass the selection inline. A selection stored in a variable widens its `true` values
+> to `boolean`, so the result type can't be narrowed (you get `{}` and a compile error on every
+> field). If you need to reuse one, annotate it `as const`:
+> ```typescript
+> const fields = { owner: true, payload: true } as const;
+> await publicClient.select(fields).where(eq("category", "docs")).fetch();
+> ```
+
 ### Running the Example
 
 You have several options to run your TypeScript sample:
@@ -170,10 +205,11 @@ Now let's add storage (write) functionality.
 Create a file named `write_example.ts` with the following content:
 
 ```typescript
-import { createPublicClient, createWalletClient, http } from "@arkiv-network/sdk"
-import { privateKeyToAccount } from "@arkiv-network/sdk/accounts"
+import { createPublicClient, createWalletClient } from "@arkiv-network/sdk"
 import { braga } from "@arkiv-network/sdk/chains"
 import { ExpirationTime, jsonToPayload } from "@arkiv-network/sdk/utils"
+import { http } from "viem"
+import { privateKeyToAccount } from "viem/accounts"
 
 // Create a public client
 const publicClient = createPublicClient({

package/dist/chains/index.d.cts

@@ -1,4 +1,4 @@
-import * as viem0 from "viem";
+import * as viem17 from "viem";
 
 //#region src/chains/braga.d.ts
 declare const braga: {
@@ -11,13 +11,13 @@ declare const braga: {
   };
   blockTime?: number | undefined | undefined;
   contracts?: {
-    [x: string]: viem0.ChainContract | {
-      [sourceId: number]: viem0.ChainContract | undefined;
+    [x: string]: viem17.ChainContract | {
+      [sourceId: number]: viem17.ChainContract | undefined;
     } | undefined;
-    ensRegistry?: viem0.ChainContract | undefined;
-    ensUniversalResolver?: viem0.ChainContract | undefined;
-    multicall3?: viem0.ChainContract | undefined;
-    erc6492Verifier?: viem0.ChainContract | undefined;
+    ensRegistry?: viem17.ChainContract | undefined;
+    ensUniversalResolver?: viem17.ChainContract | undefined;
+    multicall3?: viem17.ChainContract | undefined;
+    erc6492Verifier?: viem17.ChainContract | undefined;
   } | undefined;
   ensTlds?: readonly string[] | undefined;
   id: 60138453102;
@@ -37,9 +37,9 @@ declare const braga: {
   sourceId?: number | undefined | undefined;
   testnet: true;
   custom?: Record<string, unknown> | undefined;
-  fees?: viem0.ChainFees<undefined> | undefined;
+  fees?: viem17.ChainFees<undefined> | undefined;
   formatters?: undefined;
-  serializers?: viem0.ChainSerializers<undefined, viem0.TransactionSerializable> | undefined;
+  serializers?: viem17.ChainSerializers<undefined, viem17.TransactionSerializable> | undefined;
   readonly network: "braga";
 };
 //#endregion
@@ -57,13 +57,13 @@ declare const kaolin: {
   };
   blockTime?: number | undefined | undefined;
   contracts?: {
-    [x: string]: viem0.ChainContract | {
-      [sourceId: number]: viem0.ChainContract | undefined;
+    [x: string]: viem17.ChainContract | {
+      [sourceId: number]: viem17.ChainContract | undefined;
     } | undefined;
-    ensRegistry?: viem0.ChainContract | undefined;
-    ensUniversalResolver?: viem0.ChainContract | undefined;
-    multicall3?: viem0.ChainContract | undefined;
-    erc6492Verifier?: viem0.ChainContract | undefined;
+    ensRegistry?: viem17.ChainContract | undefined;
+    ensUniversalResolver?: viem17.ChainContract | undefined;
+    multicall3?: viem17.ChainContract | undefined;
+    erc6492Verifier?: viem17.ChainContract | undefined;
   } | undefined;
   ensTlds?: readonly string[] | undefined;
   id: 60138453025;
@@ -83,9 +83,9 @@ declare const kaolin: {
   sourceId?: number | undefined | undefined;
   testnet: true;
   custom?: Record<string, unknown> | undefined;
-  fees?: viem0.ChainFees<undefined> | undefined;
+  fees?: viem17.ChainFees<undefined> | undefined;
   formatters?: undefined;
-  serializers?: viem0.ChainSerializers<undefined, viem0.TransactionSerializable> | undefined;
+  serializers?: viem17.ChainSerializers<undefined, viem17.TransactionSerializable> | undefined;
   readonly network: "kaolin";
 };
 //#endregion
@@ -105,13 +105,13 @@ declare const localhost: {
   } | undefined | undefined;
   blockTime?: number | undefined | undefined;
   contracts?: {
-    [x: string]: viem0.ChainContract | {
-      [sourceId: number]: viem0.ChainContract | undefined;
+    [x: string]: viem17.ChainContract | {
+      [sourceId: number]: viem17.ChainContract | undefined;
     } | undefined;
-    ensRegistry?: viem0.ChainContract | undefined;
-    ensUniversalResolver?: viem0.ChainContract | undefined;
-    multicall3?: viem0.ChainContract | undefined;
-    erc6492Verifier?: viem0.ChainContract | undefined;
+    ensRegistry?: viem17.ChainContract | undefined;
+    ensUniversalResolver?: viem17.ChainContract | undefined;
+    multicall3?: viem17.ChainContract | undefined;
+    erc6492Verifier?: viem17.ChainContract | undefined;
   } | undefined;
   ensTlds?: readonly string[] | undefined;
   id: 1337;
@@ -130,9 +130,9 @@ declare const localhost: {
   sourceId?: number | undefined | undefined;
   testnet?: boolean | undefined | undefined;
   custom?: Record<string, unknown> | undefined;
-  fees?: viem0.ChainFees<undefined> | undefined;
+  fees?: viem17.ChainFees<undefined> | undefined;
   formatters?: undefined;
-  serializers?: viem0.ChainSerializers<undefined, viem0.TransactionSerializable> | undefined;
+  serializers?: viem17.ChainSerializers<undefined, viem17.TransactionSerializable> | undefined;
 };
 //#endregion
 export { braga, kaolin, localhost };

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/chains/braga.ts","../../src/chains/kaolin.ts","../../src/chains/localhost.ts"],"sourcesContent":[],"mappings":";;;cAEa;;;MAuBX,SAAA,IAAA,EAAA,sBAAA;MAAA,SAAA,GAAA,EAAA,4CAAA;;;;;;iBAAA,KAAA,CAAA,aAAA;;;;;;;;ECpBW,OAAA,CAAA,EAuBX,SAAA,MAAA,EAAA,GAAA,SAAA;EAAA,EAAA,EAAA,WAAA;;;;;;;;;;;;;;EC1BW,QAAA,CAAA,EAAA,MAWX,GAAA,SAAA,GAAA,SAAA;EAAA,OAAA,EAAA,IAAA;;;;;;;;;;;;AFXW,cCGA,MDoBX,EAAA;EAAA,cAAA,EAAA;;;;;;;;;iBCGA,KAAA,CAAA,aAAA;;;;;IAvBW,UAuBX,CAAA,wBAAA,SAAA;IAAA,eAAA,CAAA,wBAAA,SAAA;;;;;;;;;;;;;;MC1BW,SAWX,SAAA,EAAA,SAAA,CAAA,yCAAA,CAAA;IAAA,CAAA;;;;;;;;;;;;cAXW;;;MFuBX,IAAA,EAAA,MAAA;MAAA,GAAA,EAAA,MAAA;;;;;;;;;;;iBEZA,KAAA,CAAA,aAAA;;;IDRW,WAuBX,CAAA,wBAAA,SAAA;IAAA,oBAAA,CAAA,wBAAA,SAAA;;;;;;;;;;;;;;IC1BW,SAWX,OAAA,EAAA;MAAA,SAAA,IAAA,EAAA,SAAA,CAAA,uBAAA,CAAA"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/chains/braga.ts","../../src/chains/kaolin.ts","../../src/chains/localhost.ts"],"sourcesContent":[],"mappings":";;;cAEa;;;MAuBX,SAAA,IAAA,EAAA,sBAAA;MAAA,SAAA,GAAA,EAAA,4CAAA;;;;;;iBAAA,MAAA,CAAA,aAAA;;;;;;;;ECpBW,OAAA,CAAA,EAuBX,SAAA,MAAA,EAAA,GAAA,SAAA;EAAA,EAAA,EAAA,WAAA;;;;;;;;;;;;;;EC1BW,QAAA,CAAA,EAAA,MAWX,GAAA,SAAA,GAAA,SAAA;EAAA,OAAA,EAAA,IAAA;;;;;;;;;;;;AFXW,cCGA,MDoBX,EAAA;EAAA,cAAA,EAAA;;;;;;;;;iBCGA,MAAA,CAAA,aAAA;;;;;IAvBW,UAuBX,CAAA,yBAAA,SAAA;IAAA,eAAA,CAAA,yBAAA,SAAA;;;;;;;;;;;;;;MC1BW,SAWX,SAAA,EAAA,SAAA,CAAA,yCAAA,CAAA;IAAA,CAAA;;;;;;;;;;;;cAXW;;;MFuBX,IAAA,EAAA,MAAA;MAAA,GAAA,EAAA,MAAA;;;;;;;;;;;iBEZA,MAAA,CAAA,aAAA;;;IDRW,WAuBX,CAAA,yBAAA,SAAA;IAAA,oBAAA,CAAA,yBAAA,SAAA;;;;;;;;;;;;;;IC1BW,SAWX,OAAA,EAAA;MAAA,SAAA,IAAA,EAAA,SAAA,CAAA,uBAAA,CAAA"}

package/dist/chains/index.d.ts

@@ -1,4 +1,4 @@
-import * as viem8 from "viem";
+import * as viem0 from "viem";
 
 //#region src/chains/braga.d.ts
 declare const braga: {
@@ -11,13 +11,13 @@ declare const braga: {
   };
   blockTime?: number | undefined | undefined;
   contracts?: {
-    [x: string]: viem8.ChainContract | {
-      [sourceId: number]: viem8.ChainContract | undefined;
+    [x: string]: viem0.ChainContract | {
+      [sourceId: number]: viem0.ChainContract | undefined;
     } | undefined;
-    ensRegistry?: viem8.ChainContract | undefined;
-    ensUniversalResolver?: viem8.ChainContract | undefined;
-    multicall3?: viem8.ChainContract | undefined;
-    erc6492Verifier?: viem8.ChainContract | undefined;
+    ensRegistry?: viem0.ChainContract | undefined;
+    ensUniversalResolver?: viem0.ChainContract | undefined;
+    multicall3?: viem0.ChainContract | undefined;
+    erc6492Verifier?: viem0.ChainContract | undefined;
   } | undefined;
   ensTlds?: readonly string[] | undefined;
   id: 60138453102;
@@ -37,9 +37,9 @@ declare const braga: {
   sourceId?: number | undefined | undefined;
   testnet: true;
   custom?: Record<string, unknown> | undefined;
-  fees?: viem8.ChainFees<undefined> | undefined;
+  fees?: viem0.ChainFees<undefined> | undefined;
   formatters?: undefined;
-  serializers?: viem8.ChainSerializers<undefined, viem8.TransactionSerializable> | undefined;
+  serializers?: viem0.ChainSerializers<undefined, viem0.TransactionSerializable> | undefined;
   readonly network: "braga";
 };
 //#endregion
@@ -57,13 +57,13 @@ declare const kaolin: {
   };
   blockTime?: number | undefined | undefined;
   contracts?: {
-    [x: string]: viem8.ChainContract | {
-      [sourceId: number]: viem8.ChainContract | undefined;
+    [x: string]: viem0.ChainContract | {
+      [sourceId: number]: viem0.ChainContract | undefined;
     } | undefined;
-    ensRegistry?: viem8.ChainContract | undefined;
-    ensUniversalResolver?: viem8.ChainContract | undefined;
-    multicall3?: viem8.ChainContract | undefined;
-    erc6492Verifier?: viem8.ChainContract | undefined;
+    ensRegistry?: viem0.ChainContract | undefined;
+    ensUniversalResolver?: viem0.ChainContract | undefined;
+    multicall3?: viem0.ChainContract | undefined;
+    erc6492Verifier?: viem0.ChainContract | undefined;
   } | undefined;
   ensTlds?: readonly string[] | undefined;
   id: 60138453025;
@@ -83,9 +83,9 @@ declare const kaolin: {
   sourceId?: number | undefined | undefined;
   testnet: true;
   custom?: Record<string, unknown> | undefined;
-  fees?: viem8.ChainFees<undefined> | undefined;
+  fees?: viem0.ChainFees<undefined> | undefined;
   formatters?: undefined;
-  serializers?: viem8.ChainSerializers<undefined, viem8.TransactionSerializable> | undefined;
+  serializers?: viem0.ChainSerializers<undefined, viem0.TransactionSerializable> | undefined;
   readonly network: "kaolin";
 };
 //#endregion
@@ -105,13 +105,13 @@ declare const localhost: {
   } | undefined | undefined;
   blockTime?: number | undefined | undefined;
   contracts?: {
-    [x: string]: viem8.ChainContract | {
-      [sourceId: number]: viem8.ChainContract | undefined;
+    [x: string]: viem0.ChainContract | {
+      [sourceId: number]: viem0.ChainContract | undefined;
     } | undefined;
-    ensRegistry?: viem8.ChainContract | undefined;
-    ensUniversalResolver?: viem8.ChainContract | undefined;
-    multicall3?: viem8.ChainContract | undefined;
-    erc6492Verifier?: viem8.ChainContract | undefined;
+    ensRegistry?: viem0.ChainContract | undefined;
+    ensUniversalResolver?: viem0.ChainContract | undefined;
+    multicall3?: viem0.ChainContract | undefined;
+    erc6492Verifier?: viem0.ChainContract | undefined;
   } | undefined;
   ensTlds?: readonly string[] | undefined;
   id: 1337;
@@ -130,9 +130,9 @@ declare const localhost: {
   sourceId?: number | undefined | undefined;
   testnet?: boolean | undefined | undefined;
   custom?: Record<string, unknown> | undefined;
-  fees?: viem8.ChainFees<undefined> | undefined;
+  fees?: viem0.ChainFees<undefined> | undefined;
   formatters?: undefined;
-  serializers?: viem8.ChainSerializers<undefined, viem8.TransactionSerializable> | undefined;
+  serializers?: viem0.ChainSerializers<undefined, viem0.TransactionSerializable> | undefined;
 };
 //#endregion
 export { braga, kaolin, localhost };

package/dist/consts-AUoL-v42.cjs

@@ -0,0 +1,18 @@
+
+//#region src/consts.ts
+const ARKIV_ADDRESS = "0x00000000000000000000000000000061726b6976";
+const BLOCK_TIME = 2;
+
+//#endregion
+Object.defineProperty(exports, 'ARKIV_ADDRESS', {
+  enumerable: true,
+  get: function () {
+    return ARKIV_ADDRESS;
+  }
+});
+Object.defineProperty(exports, 'BLOCK_TIME', {
+  enumerable: true,
+  get: function () {
+    return BLOCK_TIME;
+  }
+});

package/dist/consts-BV4PR-de.js

@@ -0,0 +1,7 @@
+//#region src/consts.ts
+const ARKIV_ADDRESS = "0x00000000000000000000000000000061726b6976";
+const BLOCK_TIME = 2;
+
+//#endregion
+export { BLOCK_TIME as n, ARKIV_ADDRESS as t };
+//# sourceMappingURL=consts-BV4PR-de.js.map

package/dist/consts-BV4PR-de.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"consts-BV4PR-de.js","names":[],"sources":["../src/consts.ts"],"sourcesContent":["export const ARKIV_ADDRESS = \"0x00000000000000000000000000000061726b6976\" as `0x${string}`\nexport const BLOCK_TIME = 2 // 2 seconds\n"],"mappings":";AAAA,MAAa,gBAAgB;AAC7B,MAAa,aAAa"}

package/dist/{query-CO6f35AE.d.cts → entity-BSU5-vyY.d.cts}

@@ -81,6 +81,30 @@ type GetBlockTimingReturnType = {
   blockDuration: number;
 };
 //#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;
+};
+type QueryReturnType = {
+  entities: Entity[];
+  cursor: string | undefined;
+  blockNumber: bigint | undefined;
+};
+//#endregion
 //#region src/actions/wallet/changeOwnership.d.ts
 /**
  * Parameters for the deleteEntity function.
@@ -104,14 +128,24 @@ type ChangeOwnershipReturnType = {
 /**
  * Parameters for the createEntity function.
  * - payload: The payload of the entity.
- * - attributes: The attributes of the entity.
+ * - attributes: The attributes of the entity. Attribute values may be strings
+ *   or numbers, but numeric values **must be integers**. To store a non-integer,
+ *   scale it to an integer (e.g. `1.5` -> `1500`) to preserve numeric ordering,
+ *   or pass it as a string (e.g. `"1.5"`). A non-integer numeric value throws an
+ *   {@link InvalidAttributeError}.
  * - contentType: The content type of the entity.
- * - expiresIn: The expires in of the entity in seconds.
+ * - expiresIn: How long until the entity expires, in seconds. Because Arkiv
+ *   measures expiration in blocks (1 block = 2 seconds), this **must be a
+ *   positive integer and a multiple of the block time (2 seconds)**
+ *   Invalid values throw an {@link InvalidExpirationError}.
  */
 type CreateEntityParameters = {
   payload: Uint8Array;
+  /** Entity attributes. Numeric values must be integers (scale non-integers, e.g. `1.5` -> `1500`, or use a string). Throws {@link InvalidAttributeError} otherwise. */
   attributes: Attribute[];
   contentType: MimeType | string;
+  /** Seconds until expiry. Must be a positive integer and a multiple of the 2s block time.
+   * Throws {@link InvalidExpirationError} otherwise. */
   expiresIn: number;
 };
 /**
@@ -146,10 +180,15 @@ type DeleteEntityReturnType = {
 /**
  * Parameters for the extendEntity function.
  * - entityKey: The key of the entity to extend.
- * - expiresIn: The expires in of the entity in seconds.
+ * - expiresIn: How long to extend the entity by, in seconds. Because Arkiv
+ *   measures expiration in blocks (1 block = 2 seconds), this **must be a
+ *   positive integer and a multiple of the block time (2 seconds)**.
+ *   Invalid values throw an {@link InvalidExpirationError}.
  */
 type ExtendEntityParameters = {
   entityKey: Hex;
+  /** Seconds to extend by. Must be a positive integer and a multiple of the 2s block time.
+   * Throws {@link InvalidExpirationError} otherwise. */
   expiresIn: number;
 };
 /**
@@ -167,15 +206,25 @@ type ExtendEntityReturnType = {
  * 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.
+ * - attributes: The attributes of the entity. Attribute values may be strings
+ *   or numbers, but numeric values **must be integers**. To store a non-integer,
+ *   scale it to an integer (e.g. `1.5` -> `1500`) to preserve numeric ordering,
+ *   or pass it as a string (e.g. `"1.5"`). A non-integer numeric value throws an
+ *   {@link InvalidAttributeError}.
  * - contentType: The content type of the entity.
- * - expiresIn: The expires in of the entity in seconds.
+ * - expiresIn: How long until the entity expires, in seconds. Because Arkiv
+ *   measures expiration in blocks (1 block = 2 seconds), this **must be a
+ *   positive integer and a multiple of the block time (2 seconds)**.
+ *   Invalid values throw an {@link InvalidExpirationError}.
  */
 type UpdateEntityParameters = {
   entityKey: Hex;
   payload: Uint8Array;
+  /** Entity attributes. Numeric values must be integers (scale non-integers, e.g. `1.5` -> `1500`, or use a string). Throws {@link InvalidAttributeError} otherwise. */
   attributes: Attribute[];
   contentType: MimeType | string;
+  /** Seconds until expiry. Must be a positive integer and a multiple of the 2s block time.
+   * Throws {@link InvalidExpirationError} otherwise. */
   expiresIn: number;
 };
 /**
@@ -222,8 +271,20 @@ type MutateEntitiesReturnType = {
 };
 //#endregion
 //#region src/types/attributes.d.ts
+/**
+ * An entity attribute (key/value pair).
+ *
+ * Arkiv supports both string and number values. Numeric values **must be
+ * integers** — passing a non-integer number (e.g. `1.5`) throws an
+ * {@link InvalidAttributeError} at mutation time. To store a non-integer value:
+ * - Scale it to an integer (e.g. `1.5` -> `1500`, dividing by the same factor on
+ *   read) to keep numeric ordering and range queries working.
+ * - Or pass it as a string (e.g. `"1.5"`), which sorts lexicographically and so
+ *   does not support numeric comparisons.
+ */
 type Attribute = {
   key: string;
+  /** Attribute value. A `number` must be an integer (scale non-integers, e.g. `1.5` -> `1500`, or use a string). Throws {@link InvalidAttributeError} otherwise. */
   value: string | number;
 };
 //#endregion
@@ -307,29 +368,5 @@ declare class Entity {
   toJson(): any;
 }
 //#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;
-};
-type QueryReturnType = {
-  entities: Entity[];
-  cursor: string | undefined;
-  blockNumber: bigint | undefined;
-};
-//#endregion
-export { RpcIncludeData as A, CreateEntityReturnType as C, ArkivClient as D, GetBlockTimingReturnType as E, RpcQueryOptions as M, MimeType as N, ArkivRpcSchema as O, CreateEntityParameters as S, ChangeOwnershipReturnType as T, UpdateEntityReturnType as _, Entity as a, DeleteEntityParameters as b, OnEntityDeletedEvent as c, OnEntityOwnerChangedEvent as d, OnEntityUpdatedEvent as f, UpdateEntityParameters as g, MutateEntitiesReturnType as h, QueryReturnType as i, RpcOrderByAttribute as j, RpcEntity as k, OnEntityExpiredEvent as l, MutateEntitiesParameters as m, QueryOptionsIncludeData as n, TxParams as o, Attribute as p, QueryOptionsOrderBy as r, OnEntityCreatedEvent as s, QueryOptions as t, OnEntityExpiresInExtendedEvent as u, ExtendEntityParameters as v, ChangeOwnershipParameters as w, DeleteEntityReturnType as x, ExtendEntityReturnType as y };
-//# sourceMappingURL=query-CO6f35AE.d.cts.map
+export { RpcIncludeData as A, QueryOptionsIncludeData as C, ArkivClient as D, GetBlockTimingReturnType as E, RpcQueryOptions as M, MimeType as N, ArkivRpcSchema as O, QueryOptions as S, QueryReturnType as T, DeleteEntityReturnType as _, OnEntityExpiredEvent as a, ChangeOwnershipParameters as b, OnEntityUpdatedEvent as c, MutateEntitiesReturnType as d, UpdateEntityParameters as f, DeleteEntityParameters as g, ExtendEntityReturnType as h, OnEntityDeletedEvent as i, RpcOrderByAttribute as j, RpcEntity as k, Attribute as l, ExtendEntityParameters as m, TxParams as n, OnEntityExpiresInExtendedEvent as o, UpdateEntityReturnType as p, OnEntityCreatedEvent as r, OnEntityOwnerChangedEvent as s, Entity as t, MutateEntitiesParameters as u, CreateEntityParameters as v, QueryOptionsOrderBy as w, ChangeOwnershipReturnType as x, CreateEntityReturnType as y };
+//# sourceMappingURL=entity-BSU5-vyY.d.cts.map

package/dist/entity-BSU5-vyY.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity-BSU5-vyY.d.cts","names":[],"sources":["../src/types/mimeTypes.ts","../src/types/rpcSchema.ts","../src/clients/baseClient.ts","../src/actions/public/getBlockTiming.ts","../src/actions/public/query.ts","../src/actions/wallet/changeOwnership.ts","../src/actions/wallet/createEntity.ts","../src/actions/wallet/deleteEntity.ts","../src/actions/wallet/extendEntity.ts","../src/actions/wallet/updateEntity.ts","../src/actions/wallet/mutateEntities.ts","../src/types/attributes.ts","../src/types/events.ts","../src/types/txParams.ts","../src/types/entity.ts"],"sourcesContent":[],"mappings":";;;KAAY,QAAA;;;KCGA,SAAA;EDHA,GAAA,ECIL,GDJK;eCKG;;aAEF;EAJD,cAAS,EAKH,GALG;EACd,mBAAA,EAKgB,GALhB;EACQ,uBAAA,EAKY,GALZ;EAEF,2BAAA,EAIkB,GAJlB;EACK,KAAA,EAIT,GAJS;EACK,OAAA,EAIZ,GAJY;EACI,gBAAA,CAAA,EAAA,CAAA;IACI,GAAA,EAAA,MAAA;IACtB,KAAA,EAAA,MAAA;EACE,CAAA,CAAA;EAEkC,iBAAA,CAAA,EAAA,CAAA;IAAG,GAAA,EAAA,MAAA;IAGpC,KAAA,EAHiC,GAGjC;EAMA,CAAA,CAAA;CACA;AACI,KARJ,mBAAA,GAQI;EACJ,IAAA,EAAA,MAAA;EACO,IAAA,EAAA,QAAA,GAAA,SAAA;EAAG,IAAA,EAAA,OAAA;AAItB,CAAA;AAcY,KAtBA,eAAA,GAsBc;EAGsB,OAAA,CAAA,EAxBpC,GAwBoC;EAEpC,WAAA,CAAA,EAzBI,cAyBJ;EACO,OAAA,CAAA,EAzBP,mBAyBO,EAAA;EAAG,cAAA,CAAA,EAxBH,GAwBG;;;KApBV,cAAA;EC7BA,GAAA,CAAA,EAAA,OAAA;EACQ,UAAA,CAAA,EAAA,OAAA;EAAY,OAAA,CAAA,EAAA,OAAA;EAChB,WAAA,CAAA,EAAA,OAAA;EAAoB,UAAA,CAAA,EAAA,OAAA;EACT,KAAA,CAAA,EAAA,OAAA;EAAsB,OAAA,CAAA,EAAA,OAAA;EAC7B,cAAA,CAAA,EAAA,OAAA;EAAwB,mBAAA,CAAA,EAAA,OAAA;EACjC,uBAAA,CAAA,EAAA,OAAA;EAAW,2BAAA,CAAA,EAAA,OAAA;CAAO;AAAkB,KDsCnC,cAAA,GCtCmC,CAA3C;EAAM,MAAA,EAAA,aAAA;8CDyCsC;;UAEpC;IE9CA,WAAA,EF+CO,GE/CP;;;GCCA;EAKA,MAAA,EAAA,sBAAmB;EAMnB,UAAA,CAAY,EAAA,EAAA;EAQZ,UAAA,EAAA;;;;ECbA,CAAA;AAUA,CAAA;;;ECAA,UAAA,EAAA,MAAA;AACD,CAAA,CAEG;;;KJtBF,8BACQ,YAAY,yBAChB,oBAAoB,4CACT,sBAAsB,uCAC7B,wBAAwB,kBACxC,OAAO,WAAW,OAAO,kBAAkB;;;KCHnC,wBAAA;;EHLA,gBAAQ,EAAA,MAAA;;;;;KIMR,uBAAA;EJNA,UAAA,CAAQ,EAAA,OAAA;;;;ACGR,KGQA,mBAAA,GHRS;EACd,IAAA,EAAA,MAAA;EACQ,IAAA,EAAA,QAAA,GAAA,SAAA;EAEF,IAAA,EAAA,KAAA,GAAA,MAAA;CACK;AACK,KGQX,YAAA,GHRW;EACI,WAAA,CAAA,EGQX,uBHRW;EACI,OAAA,CAAA,EAAA,MAAA;EACtB,OAAA,CAAA,EGQG,mBHRH,EAAA;EACE,cAAA,CAAA,EAAA,MAAA,GAAA,SAAA;EAEkC,MAAA,CAAA,EAAA,MAAA,GAAA,SAAA;CAAG;AAGpC,KGOA,eAAA,GHPmB;EAMnB,QAAA,EGEA,MHFA,EAAe;EACf,MAAA,EAAA,MAAA,GAAA,SAAA;EACI,WAAA,EAAA,MAAA,GAAA,SAAA;CACJ;;;AD3BZ;;;;ACGY,KISA,yBAAA,GJTS;EACd,SAAA,EISM,GJTN;EACQ,QAAA,EISH,GJTG;CAEF;;;;;;AAMF,KISC,yBAAA,GJTD;EAEkC,SAAA,EIQhC,GJRgC;EAAG,MAAA,EAAA,MAAA;AAGhD,CAAA;;;ADlBA;;;;ACGA;;;;;;;;;;AAY6C,KKOjC,sBAAA,GLPiC;EAAG,OAAA,EKQrC,ULRqC;EAGpC;EAMA,UAAA,EKCE,SLDa,EAAA;EACf,WAAA,EKCG,QLDH,GAAA,MAAA;EACI;;EAEG,SAAA,EAAA,MAAA;CAAG;AAItB;AAcA;;;;AAMsB,KKfV,sBAAA,GLeU;aKdT;UACH;;;;ANvCV;;;;ACGY,KMSA,sBAAA,GNTS;EACd,SAAA,EMSM,GNTN;CACQ;;;;;;AAON,KMSG,sBAAA,GNTH;EACE,SAAA,EMSE,GNTF;EAEkC,MAAA,EMQnC,INRmC;CAAG;;;ADfhD;;;;ACGA;;;;AAKkB,KOQN,sBAAA,GPRM;EACK,SAAA,EOQV,GPRU;EACI;;EAElB,SAAA,EAAA,MAAA;CACE;;;AAKX;AAMA;;AAEgB,KOEJ,sBAAA,GPFI;EACJ,SAAA,EOEC,GPFD;EACO,MAAA,EOET,IPFS;CAAG;;;AD5BtB;;;;ACGA;;;;;;;;;;;AAYgD,KQQpC,sBAAA,GRRoC;EAGpC,SAAA,EQMC,GRND;EAMA,OAAA,EQCD,URDgB;EACf;EACI,UAAA,EQCF,SRDE,EAAA;EACJ,WAAA,EQCG,QRDH,GAAA,MAAA;EACO;;EAIP,SAAA,EAAA,MAAc;AAc1B,CAAA;;;;;;KQPY,sBAAA;aACC;EPrCD,MAAA,EOsCF,IPtCE;CACQ;;;;;;;;;;ADQX,KSSG,wBAAA,GTTH;EACE,OAAA,CAAA,ESSC,sBTTD,EAAA;EAEkC,OAAA,CAAA,ESQjC,sBTRiC,EAAA;EAAG,OAAA,CAAA,ESSpC,sBTToC,EAAA;EAGpC,UAAA,CAAA,ESOG,sBTPgB,EAAA;EAMnB,gBAAA,CAAA,ESES,yBTFM,EAAA;CACf;;;;;AAOZ;AAcA;;;;AAMsB,KSmBV,wBAAA,GTnBU;USoBZ;mBACS;mBACA;ERvEP,eAAW,EQwEJ,GRxEI,EAAA;EACH,gBAAA,EQwEA,GRxEA,EAAA;EAAY,gBAAA,EQyEZ,GRzEY,EAAA;CAChB;;;;;;AFLhB;;;;ACGA;;;;AAKkB,KUGN,SAAA,GVHM;EACK,GAAA,EAAA,MAAA;EACI;EACI,KAAA,EAAA,MAAA,GAAA,MAAA;CACtB;;;KWVG,oBAAA;aACC;EZHD,KAAA,EYIH,GZJG;;;;ACGA,KWMA,oBAAA,GXNS;EACd,SAAA,EWMM,GXNN;EACQ,KAAA,EWMN,GXNM;EAEF,kBAAA,EAAA,MAAA;EACK,kBAAA,EAAA,MAAA;EACK,IAAA,EAAA,MAAA;CACI;AACI,KWMnB,oBAAA,GXNmB;EACtB,SAAA,EWMI,GXNJ;EACE,KAAA,EWMF,GXNE;CAEkC;AAAG,KWOpC,oBAAA,GXPoC;EAGpC,SAAA,EWKC,GXLD;EAMA,KAAA,EWAH,GXAG;CACA;AACI,KWCJ,8BAAA,GXDI;EACJ,SAAA,EWCC,GXDD;EACO,KAAA,EWCV,GXDU;EAAG,kBAAA,EAAA,MAAA;EAIV,kBAAc,EAAA,MAAA;EAcd,IAAA,EAAA,MAAA;CAGoC;AAEpC,KWhBA,yBAAA,GXgBA;EACO,SAAA,EWhBN,GXgBM;EAAG,QAAA,EWfV,GXeU;YWdV;;;;KCtCA,QAAA;;;EbAA,QAAA,CAAA,EAAQ,MAAA;;;;ECGR,GAAA,CAAA,EAAA,MAAS;EACd,KAAA,CAAA,EAAA,MAAA;EACQ,YAAA,CAAA,EAAA,MAAA;EAEF,oBAAA,CAAA,EAAA,MAAA;EACK,QAAA,CAAA,EAAA,KAAA;CACK;;;ADTX,ccIC,MAAA,CdJO;OcKb;eACQ;SACN;EbJG,OAAA,EaKD,GbLU,GAAA,SAAA;EACd,cAAA,EAAA,MAAA,GAAA,SAAA;EACQ,cAAA,EAAA,MAAA,GAAA,SAAA;EAEF,mBAAA,EAAA,MAAA,GAAA,SAAA;EACK,uBAAA,EAAA,MAAA,GAAA,SAAA;EACK,2BAAA,EAAA,MAAA,GAAA,SAAA;EACI,OAAA,EaIhB,UbJgB,GAAA,SAAA;EACI,UAAA,EaIjB,SbJiB,EAAA;EACtB,WAAA,CAAA,GAAA,EaMA,GbNA,EAAA,WAAA,EaOQ,QbPR,GAAA,SAAA,EAAA,KAAA,EaQE,GbRF,GAAA,SAAA,EAAA,OAAA,EaSI,GbTJ,GAAA,SAAA,EAAA,cAAA,EAAA,MAAA,GAAA,SAAA,EAAA,cAAA,EAAA,MAAA,GAAA,SAAA,EAAA,mBAAA,EAAA,MAAA,GAAA,SAAA,EAAA,uBAAA,EAAA,MAAA,GAAA,SAAA,EAAA,2BAAA,EAAA,MAAA,GAAA,SAAA,EAAA,OAAA,EaeI,UbfJ,GAAA,SAAA,EAAA,UAAA,EagBO,SbhBP,EAAA;EACE;;;AAKX;AAMA;;EAEgB,MAAA,CAAA,CAAA,EAAA,MAAA;EACJ;;;AAKZ;AAcA;;EAKY,MAAA,CAAA,CAAA,EAAA,GAAA"}