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

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/consts-Bz0LZQZY.js

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

package/dist/consts-Bz0LZQZY.js.map

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

package/dist/consts-CxT1-RXU.cjs

@@ -0,0 +1,18 @@
+
+//#region src/consts.ts
+const ARKIV_ADDRESS = "0x4400000000000000000000000000000000000044";
+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/entity-BhSXaB23.cjs

@@ -0,0 +1,81 @@
+let viem = require("viem");
+
+//#region src/types/entity.ts
+let EntityOperationType = /* @__PURE__ */ function(EntityOperationType$1) {
+	EntityOperationType$1[EntityOperationType$1["Create"] = 1] = "Create";
+	EntityOperationType$1[EntityOperationType$1["Update"] = 2] = "Update";
+	EntityOperationType$1[EntityOperationType$1["Extend"] = 3] = "Extend";
+	EntityOperationType$1[EntityOperationType$1["Transfer"] = 4] = "Transfer";
+	EntityOperationType$1[EntityOperationType$1["Delete"] = 5] = "Delete";
+	EntityOperationType$1[EntityOperationType$1["Expire"] = 6] = "Expire";
+	return EntityOperationType$1;
+}({});
+var Entity = class {
+	key;
+	contentType;
+	owner;
+	creator;
+	expiresAtBlock;
+	createdAtBlock;
+	lastModifiedAtBlock;
+	transactionIndexInBlock;
+	operationIndexInTransaction;
+	payload;
+	attributes;
+	constructor(key, contentType = void 0, owner = void 0, creator = void 0, expiresAtBlock = void 0, createdAtBlock = void 0, lastModifiedAtBlock = void 0, transactionIndexInBlock = void 0, operationIndexInTransaction = void 0, payload = void 0, attributes) {
+		this.key = key;
+		this.owner = owner;
+		this.creator = creator;
+		this.expiresAtBlock = expiresAtBlock;
+		this.createdAtBlock = createdAtBlock;
+		this.lastModifiedAtBlock = lastModifiedAtBlock;
+		this.transactionIndexInBlock = transactionIndexInBlock;
+		this.operationIndexInTransaction = operationIndexInTransaction;
+		this.payload = payload;
+		this.attributes = attributes;
+		this.contentType = contentType;
+	}
+	/**
+	* Converts the entity payload from bytes to a string and returns it.
+	* Throws an error if the payload is undefined, which may occur if the entity was not queried with the withPayload option.
+	* Throws an error if the conversion from bytes to string fails.
+	* @returns The entity payload as a string.
+	*/
+	toText() {
+		if (this.payload === void 0) throw new Error("Entity has no payload – it was probably queried without withPayload(true) via QueryBuilder");
+		try {
+			return (0, viem.bytesToString)(this.payload);
+		} catch (e) {
+			throw new Error(`Failed to convert entity payload to text: ${e instanceof Error ? e.message : String(e)}`, { cause: e });
+		}
+	}
+	/**
+	* Parses the entity payload as JSON and returns the resulting object.
+	* Throws an error if the payload is undefined, which may occur if the entity was not queried with the withPayload option.
+	* Throws an error if the payload is empty or cannot be parsed as JSON.
+	* @returns The parsed JSON object from the entity payload.
+	*/
+	toJson() {
+		const text = this.toText();
+		if (!text) throw new Error("Entity has empty payload, cannot parse as JSON");
+		try {
+			return JSON.parse(text);
+		} catch (e) {
+			throw new Error(`Failed to parse entity payload as JSON: ${e instanceof Error ? e.message : String(e)}`, { cause: e });
+		}
+	}
+};
+
+//#endregion
+Object.defineProperty(exports, 'Entity', {
+  enumerable: true,
+  get: function () {
+    return Entity;
+  }
+});
+Object.defineProperty(exports, 'EntityOperationType', {
+  enumerable: true,
+  get: function () {
+    return EntityOperationType;
+  }
+});

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

@@ -1,4 +1,4 @@
-import { Account, Chain, Client, Hash, Hex, RpcSchema, Transport } from "viem";
+import { Account, Address, Chain, Client, Hash, Hex, RpcSchema, Transport } 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";
@@ -15,15 +15,17 @@ type RpcEntity = {
   operationIndexInTransaction: Hex;
   owner: Hex;
   creator: Hex;
-  stringAttributes?: [{
+  attributes?: {
     key: string;
     value: string;
-  }];
-  numericAttributes?: [{
-    key: string;
-    value: Hex;
-  }];
+    valueType: RpcAttributeValueType;
+  }[];
 };
+declare enum RpcAttributeValueType {
+  Uint = 1,
+  String = 2,
+  EntityKey = 3,
+}
 type RpcOrderByAttribute = {
   name: string;
   type: "string" | "numeric";
@@ -81,17 +83,52 @@ type GetBlockTimingReturnType = {
   blockDuration: number;
 };
 //#endregion
+//#region src/actions/public/query.d.ts
+type QueryOptionsIncludeData = {
+  attributes?: boolean;
+  payload?: boolean;
+  metadata?: boolean;
+};
+/**
+ * @deprecated Server-side ordering is not supported by the network. Sort the fetched
+ * entities in JavaScript instead (e.g. `entities.sort(...)`). This type will be removed
+ * in a future release.
+ */
+type QueryOptionsOrderBy = {
+  name: string;
+  type: "string" | "numeric";
+  desc: "asc" | "desc";
+};
+type QueryOptions = {
+  includeData?: QueryOptionsIncludeData;
+  atBlock?: bigint;
+  /**
+   * @deprecated Server-side ordering is not supported by the network, so this option has no
+   * effect on the returned order. Sort the fetched entities in JavaScript instead
+   * (e.g. `entities.sort(...)`). This option will be removed in a future release.
+   */
+  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.
- * - entityKey: The key of the entity to delete.
+ * Parameters for the changeOwnership function.
+ * - entityKey: The key of the entity.
+ * - newOwner: The address of the new owner.
  */
 type ChangeOwnershipParameters = {
   entityKey: Hex;
   newOwner: Hex;
 };
 /**
- * Return type for the deleteEntity function.
+ * Return type for the changeOwnership function.
  * - entityKey: The key of the entity.
  * - txHash: The transaction hash.
  */
@@ -104,14 +141,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 +193,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 +219,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,44 +284,64 @@ type MutateEntitiesReturnType = {
 };
 //#endregion
 //#region src/types/attributes.d.ts
+/**
+ * An entity attribute (key/value pair).
+ *
+ * Arkiv supports string, Hex and number values.
+ *
+ * Hex values are stored as the on-chain `EntityKey` type **only when they are
+ * exactly 32 bytes** (66 characters, e.g. an entity key). Hex-looking strings
+ * of any other length are stored as plain strings: they round-trip unchanged
+ * and compare lexicographically, not as hex.
+ *
+ * Numeric values **must be non-negative integers** (they are stored on-chain
+ * as unsigned 256-bit) — passing a non-integer (e.g. `1.5`) or negative number
+ * 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.
+ *
+ * To store a negative value, offset it into the non-negative range (subtracting
+ * the offset on read) or store it as a string.
+ */
 type Attribute = {
   key: string;
-  value: string | number;
+  value: number | string | Hex;
 };
 //#endregion
 //#region src/types/events.d.ts
 type OnEntityCreatedEvent = {
   entityKey: Hex;
-  owner: Hex;
-  expirationBlock: number;
-  cost: bigint;
+  owner: Address;
+  expiresAt: number;
+  entityHash: Hex;
 };
 type OnEntityUpdatedEvent = {
   entityKey: Hex;
-  owner: Hex;
-  oldExpirationBlock: number;
-  newExpirationBlock: number;
-  cost: bigint;
+  owner: Address;
+  expiresAt: number;
+  entityHash: Hex;
 };
 type OnEntityDeletedEvent = {
   entityKey: Hex;
-  owner: Hex;
+  owner: Address;
 };
 type OnEntityExpiredEvent = {
   entityKey: Hex;
-  owner: Hex;
+  owner: Address;
 };
 type OnEntityExpiresInExtendedEvent = {
   entityKey: Hex;
-  owner: Hex;
-  oldExpirationBlock: number;
-  newExpirationBlock: number;
-  cost: bigint;
+  owner: Address;
+  expiresAt: number;
+  entityHash: Hex;
 };
 type OnEntityOwnerChangedEvent = {
   entityKey: Hex;
-  oldOwner: Hex;
-  newOwner: Hex;
+  owner: Address;
+  entityHash: Hex;
 };
 //#endregion
 //#region src/types/txParams.d.ts
@@ -278,9 +360,17 @@ type TxParams = {
 };
 //#endregion
 //#region src/types/entity.d.ts
+declare enum EntityOperationType {
+  Create = 1,
+  Update = 2,
+  Extend = 3,
+  Transfer = 4,
+  Delete = 5,
+  Expire = 6,
+}
 declare class Entity {
   key: Hex;
-  contentType: MimeType | undefined;
+  contentType: MimeType | `${string}/${string}` | undefined;
   owner: Hex | undefined;
   creator: Hex | undefined;
   expiresAtBlock: bigint | undefined;
@@ -290,7 +380,7 @@ declare class Entity {
   operationIndexInTransaction: bigint | undefined;
   payload: Uint8Array | undefined;
   attributes: Attribute[];
-  constructor(key: Hex, contentType: MimeType | undefined, owner: Hex | undefined, creator: 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 | `${string}/${string}` | undefined, owner: Hex | undefined, creator: Hex | undefined, expiresAtBlock: bigint | undefined, createdAtBlock: bigint | undefined, lastModifiedAtBlock: bigint | undefined, transactionIndexInBlock: bigint | undefined, operationIndexInTransaction: bigint | undefined, payload: Uint8Array | undefined, attributes: Attribute[]);
   /**
    * Converts the entity payload from bytes to a string and returns it.
    * Throws an error if the payload is undefined, which may occur if the entity was not queried with the withPayload option.
@@ -307,29 +397,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 { RpcEntity as A, QueryOptions as C, GetBlockTimingReturnType as D, QueryReturnType as E, RpcOrderByAttribute as M, RpcQueryOptions as N, ArkivClient as O, MimeType as P, ChangeOwnershipReturnType as S, QueryOptionsOrderBy as T, DeleteEntityParameters as _, OnEntityDeletedEvent as a, CreateEntityReturnType as b, OnEntityOwnerChangedEvent as c, MutateEntitiesParameters as d, MutateEntitiesReturnType as f, ExtendEntityReturnType as g, ExtendEntityParameters as h, OnEntityCreatedEvent as i, RpcIncludeData as j, ArkivRpcSchema as k, OnEntityUpdatedEvent as l, UpdateEntityReturnType as m, EntityOperationType as n, OnEntityExpiredEvent as o, UpdateEntityParameters as p, TxParams as r, OnEntityExpiresInExtendedEvent as s, Entity as t, Attribute as u, DeleteEntityReturnType as v, QueryOptionsIncludeData as w, ChangeOwnershipParameters as x, CreateEntityParameters as y };
+//# sourceMappingURL=entity-CN41IOrq.d.cts.map

package/dist/entity-CN41IOrq.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity-CN41IOrq.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,UAAA,CAAA,EAAA;IACI,GAAA,EAAA,MAAA;IACtB,KAAA,EAAA,MAAA;IACE,SAAA,EAC6C,qBAD7C;EAC6C,CAAA,EAAA;CAAqB;AAGjE,aAAA,qBAAA;EAMA,IAAA,GAAA,CAAA;EAMA,MAAA,GAAA,CAAA;EACA,SAAA,GAAA,CAAA;;AAEA,KATA,mBAAA,GASA;EACO,IAAA,EAAA,MAAA;EAAG,IAAA,EAAA,QAAA,GAAA,SAAA;EAIV,IAAA,EAAA,OAAA;AAcZ,CAAA;AAGgD,KAzBpC,eAAA,GAyBoC;EAEpC,OAAA,CAAA,EA1BA,GA0BA;EACO,WAAA,CAAA,EA1BH,cA0BG;EAAG,OAAA,CAAA,EAzBV,mBAyBU,EAAA;mBAxBH;;;AC9BP,KDkCA,cAAA,GClCW;EACH,GAAA,CAAA,EAAA,OAAA;EAAY,UAAA,CAAA,EAAA,OAAA;EAChB,OAAA,CAAA,EAAA,OAAA;EAAoB,WAAA,CAAA,EAAA,OAAA;EACT,UAAA,CAAA,EAAA,OAAA;EAAsB,KAAA,CAAA,EAAA,OAAA;EAC7B,OAAA,CAAA,EAAA,OAAA;EAAwB,cAAA,CAAA,EAAA,OAAA;EACjC,mBAAA,CAAA,EAAA,OAAA;EAAW,uBAAA,CAAA,EAAA,OAAA;EAAO,2BAAA,CAAA,EAAA,OAAA;CAAkB;AAA3C,KD2CQ,cAAA,GC3CR,CAAM;;8CD8CsC;;IEjDpC,IAAA,EFmDA,SEnDA,EAAA;iBFoDO;;;AGnDP,CAAA,EAUA;EAMA,MAAA,EAAA,sBACI;EAYJ,UAAA,CAAA,EAAA,EAAe;;;;ICtBf,QAAA,EAAA,MAAA;EAUA,CAAA;;;ECDA,UAAA,CAAA,EAAA,EAAA;EACD,UAAA,EAAA,MAAA;AAEG,CAAA,CACC;;;KJvBH,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;;;;ACGpB;;;;;AAMuB,KGOX,mBAAA,GHPW;EACI,IAAA,EAAA,MAAA;EACI,IAAA,EAAA,QAAA,GAAA,SAAA;EACtB,IAAA,EAAA,KAAA,GAAA,MAAA;CACE;AAC6C,KGQ5C,YAAA,GHR4C;EAAqB,WAAA,CAAA,EGS7D,uBHT6D;EAGjE,OAAA,CAAA,EAAA,MAAA;EAMA;AAMZ;;;;EAImB,OAAA,CAAA,EGHP,mBHGO,EAAA;EAAG,cAAA,CAAA,EAAA,MAAA,GAAA,SAAA;EAIV,MAAA,CAAA,EAAA,MAAA,GAAc,SAAA;AAc1B,CAAA;AAGgD,KGnBpC,eAAA,GHmBoC;EAEpC,QAAA,EGpBA,MHoBA,EAAA;EACO,MAAA,EAAA,MAAA,GAAA,SAAA;EAAG,WAAA,EAAA,MAAA,GAAA,SAAA;;;;ADzDtB;;;;ACGA;AACO,KISK,yBAAA,GJTL;EACQ,SAAA,EISF,GJTE;EAEF,QAAA,EIQD,GJRC;CACK;;;;;;AAMsC,KIS5C,yBAAA,GJT4C;EAAqB,SAAA,EIUhE,GJVgE;EAGjE,MAAA,EAAA,MAAA;AAMZ,CAAA;;;ADvBA;;;;ACGA;;;;;;;;;;AAWwD,KKQ5C,sBAAA,GLR4C;EAAqB,OAAA,EKSlE,ULTkE;EAGjE;EAMA,UAAA,EKEE,SLFF,EAAmB;EAMnB,WAAA,EKHG,QLGY,GAAA,MAAA;EACf;;EAEA,SAAA,EAAA,MAAA;CACO;;AAInB;AAcA;;;AAMmB,KKpBP,sBAAA,GLoBO;EAAG,SAAA,EKnBT,GLmBS;UKlBZ;;;;ANvCV;;;;ACGY,KMSA,sBAAA,GNTS;EACd,SAAA,EMSM,GNTN;CACQ;;;;;;AAON,KMSG,sBAAA,GNTH;EACE,SAAA,EMSE,GNTF;EAC6C,MAAA,EMS9C,INT8C;CAAqB;;;ADd7E;;;;ACGA;;;;AAKkB,KOQN,sBAAA,GPRM;EACK,SAAA,EOQV,GPRU;EACI;;EAElB,SAAA,EAAA,MAAA;CACE;;;AAIX;AAMA;AAMA;AACY,KOFA,sBAAA,GPEA;EACI,SAAA,EOFH,GPEG;EACJ,MAAA,EOFF,IPEE;CACO;;;ADjCnB;;;;ACGA;;;;;;;;;;;AAW6E,KQSjE,sBAAA,GRTiE;EAGjE,SAAA,EQOC,GRPD;EAMA,OAAA,EQED,URFC;EAMA;EACA,UAAA,EQHE,SRGF,EAAA;EACI,WAAA,EQHD,QRGC,GAAA,MAAA;EACJ;;EACU,SAAA,EAAA,MAAA;AAItB,CAAA;AAcA;;;;;KQZY,sBAAA;aACC;UACH;APtCV,CAAA;;;;;;;;;;ADSS,KSQG,wBAAA,GTRH;EACE,OAAA,CAAA,ESQC,sBTRD,EAAA;EAC6C,OAAA,CAAA,ESQ5C,sBTR4C,EAAA;EAAqB,OAAA,CAAA,ESSjE,sBTTiE,EAAA;EAGjE,UAAA,CAAA,ESOG,sBTPkB,EAAA;EAMrB,gBAAA,CAAA,ESES,yBTFU,EAAA;AAM/B,CAAA;;;;;;AAQA;AAcA;;;AAMmB,KSpBP,wBAAA,GToBO;EAAG,MAAA,ESnBZ,ITmBY;mBSlBH;mBACA;mBACA;ERtCP,gBAAW,EQuCH,GRvCG,EAAA;EACH,gBAAA,EQuCA,GRvCA,EAAA;CAAY;;;;;AFJhC;;;;ACGA;;;;;;;;;;;;AAcA;AAMA;AAMA;;AAEgB,KUPJ,SAAA,GVOI;EACJ,GAAA,EAAA,MAAA;EACO,KAAA,EAAA,MAAA,GAAA,MAAA,GUPQ,GVOR;CAAG;;;KW/BV,oBAAA;aACC;EZHD,KAAA,EYIH,OZJW;;cYMN;;AXHF,KWMA,oBAAA,GXNS;EACd,SAAA,EWMM,GXNN;EACQ,KAAA,EWMN,OXNM;EAEF,SAAA,EAAA,MAAA;EACK,UAAA,EWKJ,GXLI;CACK;AACI,KWMf,oBAAA,GXNe;EACI,SAAA,EWMlB,GXNkB;EACtB,KAAA,EWMA,OXNA;CACE;AAC6C,KWO5C,oBAAA,GXP4C;EAAqB,SAAA,EWQhE,GXRgE;EAGjE,KAAA,EWMH,OXNG;AAMZ,CAAA;AAMY,KWHA,8BAAA,GXGe;EACf,SAAA,EWHC,GXGD;EACI,KAAA,EWHP,OXGO;EACJ,SAAA,EAAA,MAAA;EACO,UAAA,EWHL,GXGK;CAAG;AAIV,KWJA,yBAAA,GXIc;EAcd,SAAA,EWjBC,GXiBD;EAGoC,KAAA,EWnBvC,OXmBuC;EAEpC,UAAA,EWpBE,GXoBF;CACO;;;KYzDP,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;;;aaPX,mBAAA;;EdFA,MAAA,GAAA,CAAA;;;;ECGA,MAAA,GAAA,CAAA;;AAKM,caML,MAAA,CbNK;EACK,GAAA,EaMhB,GbNgB;EACI,WAAA,EaMZ,QbNY,GAAA,GAAA,MAAA,IAAA,MAAA,EAAA,GAAA,SAAA;EACI,KAAA,EaMtB,GbNsB,GAAA,SAAA;EACtB,OAAA,EaME,GbNF,GAAA,SAAA;EACE,cAAA,EAAA,MAAA,GAAA,SAAA;EAC6C,cAAA,EAAA,MAAA,GAAA,SAAA;EAAqB,mBAAA,EAAA,MAAA,GAAA,SAAA;EAGjE,uBAAA,EAAqB,MAAA,GAAA,SAAA;EAMrB,2BAAmB,EAAA,MAAA,GAAA,SAAA;EAMnB,OAAA,EaLD,UbKgB,GAAA,SAAA;EACf,UAAA,EaLE,SbKF,EAAA;EACI,WAAA,CAAA,GAAA,EaHP,GbGO,EAAA,WAAA,EaFC,QbED,GAAA,GAAA,MAAA,IAAA,MAAA,EAAA,GAAA,SAAA,EAAA,KAAA,EaDL,GbCK,GAAA,SAAA,EAAA,OAAA,EaAH,GbAG,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,EaMH,UbNG,GAAA,SAAA,EAAA,UAAA,EaOA,SbPA,EAAA;EACJ;;;AAKZ;AAcA;;EAKY,MAAA,CAAA,CAAA,EAAA,MAAA;EACO;;;;;ACtDnB;EACoB,MAAA,CAAA,CAAA,EAAA,GAAA"}

package/dist/entity-DGfVyB-a.js

@@ -0,0 +1,71 @@
+import { bytesToString } from "viem";
+
+//#region src/types/entity.ts
+let EntityOperationType = /* @__PURE__ */ function(EntityOperationType$1) {
+	EntityOperationType$1[EntityOperationType$1["Create"] = 1] = "Create";
+	EntityOperationType$1[EntityOperationType$1["Update"] = 2] = "Update";
+	EntityOperationType$1[EntityOperationType$1["Extend"] = 3] = "Extend";
+	EntityOperationType$1[EntityOperationType$1["Transfer"] = 4] = "Transfer";
+	EntityOperationType$1[EntityOperationType$1["Delete"] = 5] = "Delete";
+	EntityOperationType$1[EntityOperationType$1["Expire"] = 6] = "Expire";
+	return EntityOperationType$1;
+}({});
+var Entity = class {
+	key;
+	contentType;
+	owner;
+	creator;
+	expiresAtBlock;
+	createdAtBlock;
+	lastModifiedAtBlock;
+	transactionIndexInBlock;
+	operationIndexInTransaction;
+	payload;
+	attributes;
+	constructor(key, contentType = void 0, owner = void 0, creator = void 0, expiresAtBlock = void 0, createdAtBlock = void 0, lastModifiedAtBlock = void 0, transactionIndexInBlock = void 0, operationIndexInTransaction = void 0, payload = void 0, attributes) {
+		this.key = key;
+		this.owner = owner;
+		this.creator = creator;
+		this.expiresAtBlock = expiresAtBlock;
+		this.createdAtBlock = createdAtBlock;
+		this.lastModifiedAtBlock = lastModifiedAtBlock;
+		this.transactionIndexInBlock = transactionIndexInBlock;
+		this.operationIndexInTransaction = operationIndexInTransaction;
+		this.payload = payload;
+		this.attributes = attributes;
+		this.contentType = contentType;
+	}
+	/**
+	* Converts the entity payload from bytes to a string and returns it.
+	* Throws an error if the payload is undefined, which may occur if the entity was not queried with the withPayload option.
+	* Throws an error if the conversion from bytes to string fails.
+	* @returns The entity payload as a string.
+	*/
+	toText() {
+		if (this.payload === void 0) throw new Error("Entity has no payload – it was probably queried without withPayload(true) via QueryBuilder");
+		try {
+			return bytesToString(this.payload);
+		} catch (e) {
+			throw new Error(`Failed to convert entity payload to text: ${e instanceof Error ? e.message : String(e)}`, { cause: e });
+		}
+	}
+	/**
+	* Parses the entity payload as JSON and returns the resulting object.
+	* Throws an error if the payload is undefined, which may occur if the entity was not queried with the withPayload option.
+	* Throws an error if the payload is empty or cannot be parsed as JSON.
+	* @returns The parsed JSON object from the entity payload.
+	*/
+	toJson() {
+		const text = this.toText();
+		if (!text) throw new Error("Entity has empty payload, cannot parse as JSON");
+		try {
+			return JSON.parse(text);
+		} catch (e) {
+			throw new Error(`Failed to parse entity payload as JSON: ${e instanceof Error ? e.message : String(e)}`, { cause: e });
+		}
+	}
+};
+
+//#endregion
+export { EntityOperationType as n, Entity as t };
+//# sourceMappingURL=entity-DGfVyB-a.js.map

package/dist/entity-DGfVyB-a.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity-DGfVyB-a.js","names":[],"sources":["../src/types/entity.ts"],"sourcesContent":["import { bytesToString, type Hex } from \"viem\"\n\nexport enum EntityOperationType {\n  Create = 1,\n  Update = 2,\n  Extend = 3,\n  Transfer = 4,\n  Delete = 5,\n  Expire = 6,\n}\n\nimport type { MimeType } from \"../types\"\nimport type { Attribute } from \"./attributes\"\n\nexport class Entity {\n  key: Hex\n  contentType: MimeType | `${string}/${string}` | undefined\n  owner: Hex | undefined\n  creator: Hex | undefined\n  expiresAtBlock: bigint | undefined\n  createdAtBlock: bigint | undefined\n  lastModifiedAtBlock: bigint | undefined\n  transactionIndexInBlock: bigint | undefined\n  operationIndexInTransaction: bigint | undefined\n  payload: Uint8Array | undefined\n  attributes: Attribute[]\n\n  constructor(\n    key: Hex,\n    contentType: MimeType | `${string}/${string}` | undefined = undefined,\n    owner: Hex | undefined = undefined,\n    creator: Hex | undefined = undefined,\n    expiresAtBlock: bigint | undefined = undefined,\n    createdAtBlock: bigint | undefined = undefined,\n    lastModifiedAtBlock: bigint | undefined = undefined,\n    transactionIndexInBlock: bigint | undefined = undefined,\n    operationIndexInTransaction: bigint | undefined = undefined,\n    payload: Uint8Array | undefined = undefined,\n    attributes: Attribute[],\n  ) {\n    this.key = key\n    this.owner = owner\n    this.creator = creator\n    this.expiresAtBlock = expiresAtBlock\n    this.createdAtBlock = createdAtBlock\n    this.lastModifiedAtBlock = lastModifiedAtBlock\n    this.transactionIndexInBlock = transactionIndexInBlock\n    this.operationIndexInTransaction = operationIndexInTransaction\n    this.payload = payload\n    this.attributes = attributes\n    this.contentType = contentType\n  }\n\n  /**\n   * Converts the entity payload from bytes to a string and returns it.\n   * Throws an error if the payload is undefined, which may occur if the entity was not queried with the withPayload option.\n   * Throws an error if the conversion from bytes to string fails.\n   * @returns The entity payload as a string.\n   */\n  toText(): string {\n    if (this.payload === undefined) {\n      throw new Error(\n        \"Entity has no payload – it was probably queried without withPayload(true) via QueryBuilder\",\n      )\n    }\n    try {\n      return bytesToString(this.payload)\n    } catch (e) {\n      throw new Error(\n        `Failed to convert entity payload to text: ${e instanceof Error ? e.message : String(e)}`,\n        { cause: e },\n      )\n    }\n  }\n\n  /**\n   * Parses the entity payload as JSON and returns the resulting object.\n   * Throws an error if the payload is undefined, which may occur if the entity was not queried with the withPayload option.\n   * Throws an error if the payload is empty or cannot be parsed as JSON.\n   * @returns The parsed JSON object from the entity payload.\n   */\n  toJson(): any {\n    const text = this.toText()\n    if (!text) {\n      throw new Error(\"Entity has empty payload, cannot parse as JSON\")\n    }\n    try {\n      return JSON.parse(text)\n    } catch (e) {\n      throw new Error(\n        `Failed to parse entity payload as JSON: ${e instanceof Error ? e.message : String(e)}`,\n        { cause: e },\n      )\n    }\n  }\n}\n"],"mappings":";;;AAEA,IAAY,sEAAL;AACL;AACA;AACA;AACA;AACA;AACA;;;AAMF,IAAa,SAAb,MAAoB;CAClB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CAEA,YACE,KACA,cAA4D,QAC5D,QAAyB,QACzB,UAA2B,QAC3B,iBAAqC,QACrC,iBAAqC,QACrC,sBAA0C,QAC1C,0BAA8C,QAC9C,8BAAkD,QAClD,UAAkC,QAClC,YACA;AACA,OAAK,MAAM;AACX,OAAK,QAAQ;AACb,OAAK,UAAU;AACf,OAAK,iBAAiB;AACtB,OAAK,iBAAiB;AACtB,OAAK,sBAAsB;AAC3B,OAAK,0BAA0B;AAC/B,OAAK,8BAA8B;AACnC,OAAK,UAAU;AACf,OAAK,aAAa;AAClB,OAAK,cAAc;;;;;;;;CASrB,SAAiB;AACf,MAAI,KAAK,YAAY,OACnB,OAAM,IAAI,MACR,6FACD;AAEH,MAAI;AACF,UAAO,cAAc,KAAK,QAAQ;WAC3B,GAAG;AACV,SAAM,IAAI,MACR,6CAA6C,aAAa,QAAQ,EAAE,UAAU,OAAO,EAAE,IACvF,EAAE,OAAO,GAAG,CACb;;;;;;;;;CAUL,SAAc;EACZ,MAAM,OAAO,KAAK,QAAQ;AAC1B,MAAI,CAAC,KACH,OAAM,IAAI,MAAM,iDAAiD;AAEnE,MAAI;AACF,UAAO,KAAK,MAAM,KAAK;WAChB,GAAG;AACV,SAAM,IAAI,MACR,2CAA2C,aAAa,QAAQ,EAAE,UAAU,OAAO,EAAE,IACrF,EAAE,OAAO,GAAG,CACb"}