@haneullabs/kiosk 0.1.0

package/dist/cjs/types/transfer-policy.d.ts

@@ -0,0 +1,53 @@
+import type { ObjectOwner } from '@haneullabs/haneul/client';
+import type { Transaction, TransactionObjectArgument } from '@haneullabs/haneul/transactions';
+import type { KioskClient } from '../client/kiosk-client.js';
+import type { ObjectArgument } from './index.js';
+/** The Transfer Policy module. */
+export declare const TRANSFER_POLICY_MODULE = "0x2::transfer_policy";
+/** Name of the event emitted when a TransferPolicy for T is created. */
+export declare const TRANSFER_POLICY_CREATED_EVENT = "0x2::transfer_policy::TransferPolicyCreated";
+/** The Transfer Policy Type */
+export declare const TRANSFER_POLICY_TYPE = "0x2::transfer_policy::TransferPolicy";
+/** The Transfer Policy Cap Type */
+export declare const TRANSFER_POLICY_CAP_TYPE = "0x2::transfer_policy::TransferPolicyCap";
+/** The Kiosk Lock Rule */
+export declare const KIOSK_LOCK_RULE = "kiosk_lock_rule::Rule";
+/** The Royalty rule */
+export declare const ROYALTY_RULE = "royalty_rule::Rule";
+/**
+ * The Transfer Policy Cap in a consumable way.
+ */
+export type TransferPolicyCap = {
+    policyId: string;
+    policyCapId: string;
+    type: string;
+};
+/** The `TransferPolicy` object */
+export type TransferPolicy = {
+    id: string;
+    type: string;
+    balance: string;
+    rules: string[];
+    owner: ObjectOwner;
+};
+/** Event emitted when a TransferPolicy is created. */
+export type TransferPolicyCreated = {
+    id: string;
+};
+export type RuleResolvingParams = {
+    transaction: Transaction;
+    /** @deprecated use transaction instead */
+    transactionBlock: Transaction;
+    itemType: string;
+    itemId: string;
+    price: string;
+    policyId: ObjectArgument;
+    sellerKiosk: ObjectArgument;
+    kiosk: ObjectArgument;
+    kioskCap: ObjectArgument;
+    transferRequest: TransactionObjectArgument;
+    purchasedItem: TransactionObjectArgument;
+    packageId: string;
+    extraArgs: Record<string, any>;
+    kioskClient: KioskClient;
+};

package/dist/cjs/types/transfer-policy.js

@@ -0,0 +1,35 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var transfer_policy_exports = {};
+__export(transfer_policy_exports, {
+  KIOSK_LOCK_RULE: () => KIOSK_LOCK_RULE,
+  ROYALTY_RULE: () => ROYALTY_RULE,
+  TRANSFER_POLICY_CAP_TYPE: () => TRANSFER_POLICY_CAP_TYPE,
+  TRANSFER_POLICY_CREATED_EVENT: () => TRANSFER_POLICY_CREATED_EVENT,
+  TRANSFER_POLICY_MODULE: () => TRANSFER_POLICY_MODULE,
+  TRANSFER_POLICY_TYPE: () => TRANSFER_POLICY_TYPE
+});
+module.exports = __toCommonJS(transfer_policy_exports);
+const TRANSFER_POLICY_MODULE = "0x2::transfer_policy";
+const TRANSFER_POLICY_CREATED_EVENT = `${TRANSFER_POLICY_MODULE}::TransferPolicyCreated`;
+const TRANSFER_POLICY_TYPE = `${TRANSFER_POLICY_MODULE}::TransferPolicy`;
+const TRANSFER_POLICY_CAP_TYPE = `${TRANSFER_POLICY_MODULE}::TransferPolicyCap`;
+const KIOSK_LOCK_RULE = "kiosk_lock_rule::Rule";
+const ROYALTY_RULE = "royalty_rule::Rule";
+//# sourceMappingURL=transfer-policy.js.map

package/dist/cjs/types/transfer-policy.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/types/transfer-policy.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { ObjectOwner } from '@haneullabs/haneul/client';\nimport type { Transaction, TransactionObjectArgument } from '@haneullabs/haneul/transactions';\n\nimport type { KioskClient } from '../client/kiosk-client.js';\nimport type { ObjectArgument } from './index.js';\n\n/** The Transfer Policy module. */\nexport const TRANSFER_POLICY_MODULE = '0x2::transfer_policy';\n\n/** Name of the event emitted when a TransferPolicy for T is created. */\nexport const TRANSFER_POLICY_CREATED_EVENT = `${TRANSFER_POLICY_MODULE}::TransferPolicyCreated`;\n\n/** The Transfer Policy Type */\nexport const TRANSFER_POLICY_TYPE = `${TRANSFER_POLICY_MODULE}::TransferPolicy`;\n\n/** The Transfer Policy Cap Type */\nexport const TRANSFER_POLICY_CAP_TYPE = `${TRANSFER_POLICY_MODULE}::TransferPolicyCap`;\n\n/** The Kiosk Lock Rule */\nexport const KIOSK_LOCK_RULE = 'kiosk_lock_rule::Rule';\n\n/** The Royalty rule */\nexport const ROYALTY_RULE = 'royalty_rule::Rule';\n\n/**\n * The Transfer Policy Cap in a consumable way.\n */\nexport type TransferPolicyCap = {\n\tpolicyId: string;\n\tpolicyCapId: string;\n\ttype: string;\n};\n\n/** The `TransferPolicy` object */\nexport type TransferPolicy = {\n\tid: string;\n\ttype: string;\n\tbalance: string;\n\trules: string[];\n\towner: ObjectOwner;\n};\n\n/** Event emitted when a TransferPolicy is created. */\nexport type TransferPolicyCreated = {\n\tid: string;\n};\n\n// The object a Rule resolving function accepts\n// It can accept a set of fixed fields, that are part of every purchase flow as well any extra arguments to resolve custom policies!\n// Each rule resolving function should check that the key it's seeking is in the object\n// e.g. `if(!'my_key' in ruleParams!) throw new Error(\"Can't resolve that rule!\")`\nexport type RuleResolvingParams = {\n\ttransaction: Transaction;\n\t/** @deprecated use transaction instead */\n\ttransactionBlock: Transaction;\n\titemType: string;\n\titemId: string;\n\tprice: string;\n\tpolicyId: ObjectArgument;\n\tsellerKiosk: ObjectArgument;\n\tkiosk: ObjectArgument;\n\tkioskCap: ObjectArgument;\n\ttransferRequest: TransactionObjectArgument;\n\tpurchasedItem: TransactionObjectArgument;\n\tpackageId: string;\n\textraArgs: Record<string, any>; // extraParams contains more possible {key, values} to pass for custom rules.\n\tkioskClient: KioskClient;\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAUO,MAAM,yBAAyB;AAG/B,MAAM,gCAAgC,GAAG,sBAAsB;AAG/D,MAAM,uBAAuB,GAAG,sBAAsB;AAGtD,MAAM,2BAA2B,GAAG,sBAAsB;AAG1D,MAAM,kBAAkB;AAGxB,MAAM,eAAe;",
+  "names": []
+}

package/dist/cjs/utils.d.ts

@@ -0,0 +1,51 @@
+import type { DynamicFieldInfo, PaginationArguments, HaneulClient, HaneulObjectData, HaneulObjectDataFilter, HaneulObjectDataOptions, HaneulObjectResponse } from '@haneullabs/haneul/client';
+import type { Kiosk, KioskData, KioskListing, TransferPolicyCap } from './types/index.js';
+export declare function getKioskObject(client: HaneulClient, id: string): Promise<Kiosk>;
+export declare function extractKioskData(data: DynamicFieldInfo[], listings: KioskListing[], lockedItemIds: string[], kioskId: string): KioskData;
+/**
+ * A helper that attaches the listing prices to kiosk listings.
+ */
+export declare function attachListingsAndPrices(kioskData: KioskData, listings: KioskListing[], listingObjects: HaneulObjectResponse[]): void;
+/**
+ * A helper that attaches the listing prices to kiosk listings.
+ */
+export declare function attachObjects(kioskData: KioskData, objects: HaneulObjectData[]): void;
+/**
+ * A Helper to attach locked state to items in Kiosk Data.
+ */
+export declare function attachLockedItems(kioskData: KioskData, lockedItemIds: string[]): void;
+/**
+ * A helper to fetch all DF pages.
+ * We need that to fetch the kiosk DFs consistently, until we have
+ * RPC calls that allow filtering of Type / batch fetching of spec
+ */
+export declare function getAllDynamicFields(client: HaneulClient, parentId: string, pagination: PaginationArguments<string>): Promise<DynamicFieldInfo[]>;
+/**
+ * A helper to fetch all objects that works with pagination.
+ * It will fetch all objects in the array, and limit it to 50/request.
+ * Requests are sent using `Promise.all`.
+ */
+export declare function getAllObjects(client: HaneulClient, ids: string[], options: HaneulObjectDataOptions, limit?: number): Promise<HaneulObjectResponse[]>;
+/**
+ * A helper to return all owned objects, with an optional filter.
+ * It parses all the pages and returns the data.
+ */
+export declare function getAllOwnedObjects({ client, owner, filter, limit, options, }: {
+    client: HaneulClient;
+    owner: string;
+    filter?: HaneulObjectDataFilter;
+    options?: HaneulObjectDataOptions;
+    limit?: number;
+}): Promise<HaneulObjectResponse[]>;
+/**
+ * Converts a number to basis points.
+ * Supports up to 2 decimal points.
+ * E.g 9.95 -> 995
+ * @param percentage A percentage amount in the range [0, 100] including decimals.
+ */
+export declare function percentageToBasisPoints(percentage: number): number;
+/**
+ * A helper to parse a transfer policy Cap into a usable object.
+ */
+export declare function parseTransferPolicyCapObject(item: HaneulObjectResponse): TransferPolicyCap | undefined;
+export declare function getNormalizedRuleType(rule: string): string;

package/dist/cjs/utils.js

@@ -0,0 +1,198 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var utils_exports = {};
+__export(utils_exports, {
+  attachListingsAndPrices: () => attachListingsAndPrices,
+  attachLockedItems: () => attachLockedItems,
+  attachObjects: () => attachObjects,
+  extractKioskData: () => extractKioskData,
+  getAllDynamicFields: () => getAllDynamicFields,
+  getAllObjects: () => getAllObjects,
+  getAllOwnedObjects: () => getAllOwnedObjects,
+  getKioskObject: () => getKioskObject,
+  getNormalizedRuleType: () => getNormalizedRuleType,
+  parseTransferPolicyCapObject: () => parseTransferPolicyCapObject,
+  percentageToBasisPoints: () => percentageToBasisPoints
+});
+module.exports = __toCommonJS(utils_exports);
+var import_utils = require("@haneullabs/haneul/utils");
+var import_bcs = require("./bcs.js");
+var import_types = require("./types/index.js");
+var import_utils2 = require("@haneullabs/utils");
+const DEFAULT_QUERY_LIMIT = 50;
+async function getKioskObject(client, id) {
+  const queryRes = await client.getObject({ id, options: { showBcs: true } });
+  if (!queryRes || queryRes.error || !queryRes.data) {
+    throw new Error(`Kiosk ${id} not found; ${queryRes.error}`);
+  }
+  if (!queryRes.data.bcs || !("bcsBytes" in queryRes.data.bcs)) {
+    throw new Error(`Invalid kiosk query: ${id}, expected object, got package`);
+  }
+  return import_bcs.KioskType.parse((0, import_utils.fromBase64)(queryRes.data.bcs.bcsBytes));
+}
+function extractKioskData(data, listings, lockedItemIds, kioskId) {
+  return data.reduce(
+    (acc, val) => {
+      const type = val.name.type;
+      if (type.startsWith("0x2::kiosk::Item")) {
+        acc.itemIds.push(val.objectId);
+        acc.items.push({
+          objectId: val.objectId,
+          type: val.objectType,
+          isLocked: false,
+          kioskId
+        });
+      }
+      if (type.startsWith("0x2::kiosk::Listing")) {
+        acc.listingIds.push(val.objectId);
+        listings.push({
+          objectId: val.name.value.id,
+          listingId: val.objectId,
+          isExclusive: val.name.value.is_exclusive
+        });
+      }
+      if (type.startsWith("0x2::kiosk::Lock")) {
+        lockedItemIds?.push(val.name.value.id);
+      }
+      if (type.startsWith("0x2::kiosk_extension::ExtensionKey")) {
+        acc.extensions.push({
+          objectId: val.objectId,
+          type: (0, import_utils.normalizeStructTag)((0, import_utils.parseStructTag)(val.name.type).typeParams[0])
+        });
+      }
+      return acc;
+    },
+    { items: [], itemIds: [], listingIds: [], extensions: [] }
+  );
+}
+function attachListingsAndPrices(kioskData, listings, listingObjects) {
+  const itemListings = listings.reduce(
+    (acc, item, idx) => {
+      acc[item.objectId] = { ...item };
+      if (listingObjects.length === 0) return acc;
+      const content = listingObjects[idx].data?.content;
+      const data = content?.dataType === "moveObject" ? content?.fields : null;
+      if (!data) return acc;
+      acc[item.objectId].price = data.value;
+      return acc;
+    },
+    {}
+  );
+  kioskData.items.forEach((item) => {
+    item.listing = itemListings[item.objectId] || void 0;
+  });
+}
+function attachObjects(kioskData, objects) {
+  const mapping = objects.reduce(
+    (acc, obj) => {
+      acc[obj.objectId] = obj;
+      return acc;
+    },
+    {}
+  );
+  kioskData.items.forEach((item) => {
+    item.data = mapping[item.objectId] || void 0;
+  });
+}
+function attachLockedItems(kioskData, lockedItemIds) {
+  const lockedStatuses = lockedItemIds.reduce(
+    (acc, item) => {
+      acc[item] = true;
+      return acc;
+    },
+    {}
+  );
+  kioskData.items.forEach((item) => {
+    item.isLocked = lockedStatuses[item.objectId] || false;
+  });
+}
+async function getAllDynamicFields(client, parentId, pagination) {
+  let hasNextPage = true;
+  let cursor = void 0;
+  const data = [];
+  while (hasNextPage) {
+    const result = await client.getDynamicFields({
+      parentId,
+      limit: pagination.limit || void 0,
+      cursor
+    });
+    data.push(...result.data);
+    hasNextPage = result.hasNextPage;
+    cursor = result.nextCursor;
+  }
+  return data;
+}
+async function getAllObjects(client, ids, options, limit = DEFAULT_QUERY_LIMIT) {
+  const chunks = (0, import_utils2.chunk)(ids, limit);
+  const results = await Promise.all(
+    chunks.map((chunk2) => {
+      return client.multiGetObjects({
+        ids: chunk2,
+        options
+      });
+    })
+  );
+  return results.flat();
+}
+async function getAllOwnedObjects({
+  client,
+  owner,
+  filter,
+  limit = DEFAULT_QUERY_LIMIT,
+  options = { showType: true, showContent: true }
+}) {
+  let hasNextPage = true;
+  let cursor = void 0;
+  const data = [];
+  while (hasNextPage) {
+    const result = await client.getOwnedObjects({
+      owner,
+      filter,
+      limit,
+      cursor,
+      options
+    });
+    data.push(...result.data);
+    hasNextPage = result.hasNextPage;
+    cursor = result.nextCursor;
+  }
+  return data;
+}
+function percentageToBasisPoints(percentage) {
+  if (percentage < 0 || percentage > 100)
+    throw new Error("Percentage needs to be in the [0,100] range.");
+  return Math.ceil(percentage * 100);
+}
+function parseTransferPolicyCapObject(item) {
+  const type = item?.data?.content?.type;
+  const policy = item?.data?.content?.fields?.policy_id;
+  if (!type.includes(import_types.TRANSFER_POLICY_CAP_TYPE)) return void 0;
+  const objectType = type.replace(import_types.TRANSFER_POLICY_CAP_TYPE + "<", "").slice(0, -1);
+  return {
+    policyId: policy,
+    policyCapId: item.data?.objectId,
+    type: objectType
+  };
+}
+function getNormalizedRuleType(rule) {
+  const normalizedRuleAddress = rule.split("::");
+  normalizedRuleAddress[0] = (0, import_utils.normalizeHaneulAddress)(normalizedRuleAddress[0]);
+  return normalizedRuleAddress.join("::");
+}
+//# sourceMappingURL=utils.js.map

package/dist/cjs/utils.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/utils.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport type {\n\tDynamicFieldInfo,\n\tPaginationArguments,\n\tHaneulClient,\n\tHaneulObjectData,\n\tHaneulObjectDataFilter,\n\tHaneulObjectDataOptions,\n\tHaneulObjectResponse,\n} from '@haneullabs/haneul/client';\nimport {\n\tfromBase64,\n\tnormalizeStructTag,\n\tnormalizeHaneulAddress,\n\tparseStructTag,\n} from '@haneullabs/haneul/utils';\n\nimport { KioskType } from './bcs.js';\nimport type { Kiosk, KioskData, KioskListing, TransferPolicyCap } from './types/index.js';\nimport { TRANSFER_POLICY_CAP_TYPE } from './types/index.js';\nimport { chunk } from '@haneullabs/utils';\n\nconst DEFAULT_QUERY_LIMIT = 50;\n\nexport async function getKioskObject(client: HaneulClient, id: string): Promise<Kiosk> {\n\tconst queryRes = await client.getObject({ id, options: { showBcs: true } });\n\n\tif (!queryRes || queryRes.error || !queryRes.data) {\n\t\tthrow new Error(`Kiosk ${id} not found; ${queryRes.error}`);\n\t}\n\n\tif (!queryRes.data.bcs || !('bcsBytes' in queryRes.data.bcs)) {\n\t\tthrow new Error(`Invalid kiosk query: ${id}, expected object, got package`);\n\t}\n\n\treturn KioskType.parse(fromBase64(queryRes.data.bcs!.bcsBytes));\n}\n\n// helper to extract kiosk data from dynamic fields.\nexport function extractKioskData(\n\tdata: DynamicFieldInfo[],\n\tlistings: KioskListing[],\n\tlockedItemIds: string[],\n\tkioskId: string,\n): KioskData {\n\treturn data.reduce<KioskData>(\n\t\t(acc: KioskData, val: DynamicFieldInfo) => {\n\t\t\tconst type = val.name.type;\n\n\t\t\tif (type.startsWith('0x2::kiosk::Item')) {\n\t\t\t\tacc.itemIds.push(val.objectId);\n\t\t\t\tacc.items.push({\n\t\t\t\t\tobjectId: val.objectId,\n\t\t\t\t\ttype: val.objectType,\n\t\t\t\t\tisLocked: false,\n\t\t\t\t\tkioskId,\n\t\t\t\t});\n\t\t\t}\n\t\t\tif (type.startsWith('0x2::kiosk::Listing')) {\n\t\t\t\tacc.listingIds.push(val.objectId);\n\t\t\t\tlistings.push({\n\t\t\t\t\tobjectId: (val.name.value as { id: string }).id,\n\t\t\t\t\tlistingId: val.objectId,\n\t\t\t\t\tisExclusive: (val.name.value as { is_exclusive: boolean }).is_exclusive,\n\t\t\t\t});\n\t\t\t}\n\t\t\tif (type.startsWith('0x2::kiosk::Lock')) {\n\t\t\t\tlockedItemIds?.push((val.name.value as { id: string }).id);\n\t\t\t}\n\n\t\t\tif (type.startsWith('0x2::kiosk_extension::ExtensionKey')) {\n\t\t\t\tacc.extensions.push({\n\t\t\t\t\tobjectId: val.objectId,\n\t\t\t\t\ttype: normalizeStructTag(parseStructTag(val.name.type).typeParams[0]),\n\t\t\t\t});\n\t\t\t}\n\n\t\t\treturn acc;\n\t\t},\n\t\t{ items: [], itemIds: [], listingIds: [], extensions: [] },\n\t);\n}\n\n/**\n * A helper that attaches the listing prices to kiosk listings.\n */\nexport function attachListingsAndPrices(\n\tkioskData: KioskData,\n\tlistings: KioskListing[],\n\tlistingObjects: HaneulObjectResponse[],\n) {\n\t// map item listings as {item_id: KioskListing}\n\t// for easier mapping on the nex\n\tconst itemListings = listings.reduce<Record<string, KioskListing>>(\n\t\t(acc: Record<string, KioskListing>, item, idx) => {\n\t\t\tacc[item.objectId] = { ...item };\n\n\t\t\t// return in case we don't have any listing objects.\n\t\t\t// that's the case when we don't have the `listingPrices` included.\n\t\t\tif (listingObjects.length === 0) return acc;\n\n\t\t\tconst content = listingObjects[idx].data?.content;\n\t\t\tconst data = content?.dataType === 'moveObject' ? content?.fields : null;\n\n\t\t\tif (!data) return acc;\n\n\t\t\tacc[item.objectId].price = (data as { value: string }).value;\n\t\t\treturn acc;\n\t\t},\n\t\t{},\n\t);\n\n\tkioskData.items.forEach((item) => {\n\t\titem.listing = itemListings[item.objectId] || undefined;\n\t});\n}\n\n/**\n * A helper that attaches the listing prices to kiosk listings.\n */\nexport function attachObjects(kioskData: KioskData, objects: HaneulObjectData[]) {\n\tconst mapping = objects.reduce<Record<string, HaneulObjectData>>(\n\t\t(acc: Record<string, HaneulObjectData>, obj) => {\n\t\t\tacc[obj.objectId] = obj;\n\t\t\treturn acc;\n\t\t},\n\t\t{},\n\t);\n\n\tkioskData.items.forEach((item) => {\n\t\titem.data = mapping[item.objectId] || undefined;\n\t});\n}\n\n/**\n * A Helper to attach locked state to items in Kiosk Data.\n */\nexport function attachLockedItems(kioskData: KioskData, lockedItemIds: string[]) {\n\t// map lock status in an array of type { item_id: true }\n\tconst lockedStatuses = lockedItemIds.reduce<Record<string, boolean>>(\n\t\t(acc: Record<string, boolean>, item: string) => {\n\t\t\tacc[item] = true;\n\t\t\treturn acc;\n\t\t},\n\t\t{},\n\t);\n\n\t// parse lockedItemIds and attach their locked status.\n\tkioskData.items.forEach((item) => {\n\t\titem.isLocked = lockedStatuses[item.objectId] || false;\n\t});\n}\n\n/**\n * A helper to fetch all DF pages.\n * We need that to fetch the kiosk DFs consistently, until we have\n * RPC calls that allow filtering of Type / batch fetching of spec\n */\nexport async function getAllDynamicFields(\n\tclient: HaneulClient,\n\tparentId: string,\n\tpagination: PaginationArguments<string>,\n) {\n\tlet hasNextPage = true;\n\tlet cursor = undefined;\n\tconst data: DynamicFieldInfo[] = [];\n\n\twhile (hasNextPage) {\n\t\tconst result = await client.getDynamicFields({\n\t\t\tparentId,\n\t\t\tlimit: pagination.limit || undefined,\n\t\t\tcursor,\n\t\t});\n\t\tdata.push(...result.data);\n\t\thasNextPage = result.hasNextPage;\n\t\tcursor = result.nextCursor;\n\t}\n\n\treturn data;\n}\n\n/**\n * A helper to fetch all objects that works with pagination.\n * It will fetch all objects in the array, and limit it to 50/request.\n * Requests are sent using `Promise.all`.\n */\nexport async function getAllObjects(\n\tclient: HaneulClient,\n\tids: string[],\n\toptions: HaneulObjectDataOptions,\n\tlimit: number = DEFAULT_QUERY_LIMIT,\n) {\n\tconst chunks = chunk(ids, limit);\n\n\tconst results = await Promise.all(\n\t\tchunks.map((chunk) => {\n\t\t\treturn client.multiGetObjects({\n\t\t\t\tids: chunk,\n\t\t\t\toptions,\n\t\t\t});\n\t\t}),\n\t);\n\n\treturn results.flat();\n}\n\n/**\n * A helper to return all owned objects, with an optional filter.\n * It parses all the pages and returns the data.\n */\nexport async function getAllOwnedObjects({\n\tclient,\n\towner,\n\tfilter,\n\tlimit = DEFAULT_QUERY_LIMIT,\n\toptions = { showType: true, showContent: true },\n}: {\n\tclient: HaneulClient;\n\towner: string;\n\tfilter?: HaneulObjectDataFilter;\n\toptions?: HaneulObjectDataOptions;\n\tlimit?: number;\n}) {\n\tlet hasNextPage = true;\n\tlet cursor = undefined;\n\tconst data: HaneulObjectResponse[] = [];\n\n\twhile (hasNextPage) {\n\t\tconst result = await client.getOwnedObjects({\n\t\t\towner,\n\t\t\tfilter,\n\t\t\tlimit,\n\t\t\tcursor,\n\t\t\toptions,\n\t\t});\n\t\tdata.push(...result.data);\n\t\thasNextPage = result.hasNextPage;\n\t\tcursor = result.nextCursor;\n\t}\n\n\treturn data;\n}\n\n/**\n * Converts a number to basis points.\n * Supports up to 2 decimal points.\n * E.g 9.95 -> 995\n * @param percentage A percentage amount in the range [0, 100] including decimals.\n */\nexport function percentageToBasisPoints(percentage: number) {\n\tif (percentage < 0 || percentage > 100)\n\t\tthrow new Error('Percentage needs to be in the [0,100] range.');\n\treturn Math.ceil(percentage * 100);\n}\n\n/**\n * A helper to parse a transfer policy Cap into a usable object.\n */\nexport function parseTransferPolicyCapObject(\n\titem: HaneulObjectResponse,\n): TransferPolicyCap | undefined {\n\tconst type = (item?.data?.content as { type: string })?.type;\n\n\t//@ts-ignore-next-line\n\tconst policy = item?.data?.content?.fields?.policy_id as string;\n\n\tif (!type.includes(TRANSFER_POLICY_CAP_TYPE)) return undefined;\n\n\t// Transform 0x2::transfer_policy::TransferPolicyCap<itemType> -> itemType\n\tconst objectType = type.replace(TRANSFER_POLICY_CAP_TYPE + '<', '').slice(0, -1);\n\n\treturn {\n\t\tpolicyId: policy,\n\t\tpolicyCapId: item.data?.objectId!,\n\t\ttype: objectType,\n\t};\n}\n\n// Normalizes the packageId part of a rule's type.\nexport function getNormalizedRuleType(rule: string) {\n\tconst normalizedRuleAddress = rule.split('::');\n\tnormalizedRuleAddress[0] = normalizeHaneulAddress(normalizedRuleAddress[0]);\n\treturn normalizedRuleAddress.join('::');\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAYA,mBAKO;AAEP,iBAA0B;AAE1B,mBAAyC;AACzC,IAAAA,gBAAsB;AAEtB,MAAM,sBAAsB;AAE5B,eAAsB,eAAe,QAAsB,IAA4B;AACtF,QAAM,WAAW,MAAM,OAAO,UAAU,EAAE,IAAI,SAAS,EAAE,SAAS,KAAK,EAAE,CAAC;AAE1E,MAAI,CAAC,YAAY,SAAS,SAAS,CAAC,SAAS,MAAM;AAClD,UAAM,IAAI,MAAM,SAAS,EAAE,eAAe,SAAS,KAAK,EAAE;AAAA,EAC3D;AAEA,MAAI,CAAC,SAAS,KAAK,OAAO,EAAE,cAAc,SAAS,KAAK,MAAM;AAC7D,UAAM,IAAI,MAAM,wBAAwB,EAAE,gCAAgC;AAAA,EAC3E;AAEA,SAAO,qBAAU,UAAM,yBAAW,SAAS,KAAK,IAAK,QAAQ,CAAC;AAC/D;AAGO,SAAS,iBACf,MACA,UACA,eACA,SACY;AACZ,SAAO,KAAK;AAAA,IACX,CAAC,KAAgB,QAA0B;AAC1C,YAAM,OAAO,IAAI,KAAK;AAEtB,UAAI,KAAK,WAAW,kBAAkB,GAAG;AACxC,YAAI,QAAQ,KAAK,IAAI,QAAQ;AAC7B,YAAI,MAAM,KAAK;AAAA,UACd,UAAU,IAAI;AAAA,UACd,MAAM,IAAI;AAAA,UACV,UAAU;AAAA,UACV;AAAA,QACD,CAAC;AAAA,MACF;AACA,UAAI,KAAK,WAAW,qBAAqB,GAAG;AAC3C,YAAI,WAAW,KAAK,IAAI,QAAQ;AAChC,iBAAS,KAAK;AAAA,UACb,UAAW,IAAI,KAAK,MAAyB;AAAA,UAC7C,WAAW,IAAI;AAAA,UACf,aAAc,IAAI,KAAK,MAAoC;AAAA,QAC5D,CAAC;AAAA,MACF;AACA,UAAI,KAAK,WAAW,kBAAkB,GAAG;AACxC,uBAAe,KAAM,IAAI,KAAK,MAAyB,EAAE;AAAA,MAC1D;AAEA,UAAI,KAAK,WAAW,oCAAoC,GAAG;AAC1D,YAAI,WAAW,KAAK;AAAA,UACnB,UAAU,IAAI;AAAA,UACd,UAAM,qCAAmB,6BAAe,IAAI,KAAK,IAAI,EAAE,WAAW,CAAC,CAAC;AAAA,QACrE,CAAC;AAAA,MACF;AAEA,aAAO;AAAA,IACR;AAAA,IACA,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,GAAG,YAAY,CAAC,GAAG,YAAY,CAAC,EAAE;AAAA,EAC1D;AACD;AAKO,SAAS,wBACf,WACA,UACA,gBACC;AAGD,QAAM,eAAe,SAAS;AAAA,IAC7B,CAAC,KAAmC,MAAM,QAAQ;AACjD,UAAI,KAAK,QAAQ,IAAI,EAAE,GAAG,KAAK;AAI/B,UAAI,eAAe,WAAW,EAAG,QAAO;AAExC,YAAM,UAAU,eAAe,GAAG,EAAE,MAAM;AAC1C,YAAM,OAAO,SAAS,aAAa,eAAe,SAAS,SAAS;AAEpE,UAAI,CAAC,KAAM,QAAO;AAElB,UAAI,KAAK,QAAQ,EAAE,QAAS,KAA2B;AACvD,aAAO;AAAA,IACR;AAAA,IACA,CAAC;AAAA,EACF;AAEA,YAAU,MAAM,QAAQ,CAAC,SAAS;AACjC,SAAK,UAAU,aAAa,KAAK,QAAQ,KAAK;AAAA,EAC/C,CAAC;AACF;AAKO,SAAS,cAAc,WAAsB,SAA6B;AAChF,QAAM,UAAU,QAAQ;AAAA,IACvB,CAAC,KAAuC,QAAQ;AAC/C,UAAI,IAAI,QAAQ,IAAI;AACpB,aAAO;AAAA,IACR;AAAA,IACA,CAAC;AAAA,EACF;AAEA,YAAU,MAAM,QAAQ,CAAC,SAAS;AACjC,SAAK,OAAO,QAAQ,KAAK,QAAQ,KAAK;AAAA,EACvC,CAAC;AACF;AAKO,SAAS,kBAAkB,WAAsB,eAAyB;AAEhF,QAAM,iBAAiB,cAAc;AAAA,IACpC,CAAC,KAA8B,SAAiB;AAC/C,UAAI,IAAI,IAAI;AACZ,aAAO;AAAA,IACR;AAAA,IACA,CAAC;AAAA,EACF;AAGA,YAAU,MAAM,QAAQ,CAAC,SAAS;AACjC,SAAK,WAAW,eAAe,KAAK,QAAQ,KAAK;AAAA,EAClD,CAAC;AACF;AAOA,eAAsB,oBACrB,QACA,UACA,YACC;AACD,MAAI,cAAc;AAClB,MAAI,SAAS;AACb,QAAM,OAA2B,CAAC;AAElC,SAAO,aAAa;AACnB,UAAM,SAAS,MAAM,OAAO,iBAAiB;AAAA,MAC5C;AAAA,MACA,OAAO,WAAW,SAAS;AAAA,MAC3B;AAAA,IACD,CAAC;AACD,SAAK,KAAK,GAAG,OAAO,IAAI;AACxB,kBAAc,OAAO;AACrB,aAAS,OAAO;AAAA,EACjB;AAEA,SAAO;AACR;AAOA,eAAsB,cACrB,QACA,KACA,SACA,QAAgB,qBACf;AACD,QAAM,aAAS,qBAAM,KAAK,KAAK;AAE/B,QAAM,UAAU,MAAM,QAAQ;AAAA,IAC7B,OAAO,IAAI,CAACC,WAAU;AACrB,aAAO,OAAO,gBAAgB;AAAA,QAC7B,KAAKA;AAAA,QACL;AAAA,MACD,CAAC;AAAA,IACF,CAAC;AAAA,EACF;AAEA,SAAO,QAAQ,KAAK;AACrB;AAMA,eAAsB,mBAAmB;AAAA,EACxC;AAAA,EACA;AAAA,EACA;AAAA,EACA,QAAQ;AAAA,EACR,UAAU,EAAE,UAAU,MAAM,aAAa,KAAK;AAC/C,GAMG;AACF,MAAI,cAAc;AAClB,MAAI,SAAS;AACb,QAAM,OAA+B,CAAC;AAEtC,SAAO,aAAa;AACnB,UAAM,SAAS,MAAM,OAAO,gBAAgB;AAAA,MAC3C;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACD,CAAC;AACD,SAAK,KAAK,GAAG,OAAO,IAAI;AACxB,kBAAc,OAAO;AACrB,aAAS,OAAO;AAAA,EACjB;AAEA,SAAO;AACR;AAQO,SAAS,wBAAwB,YAAoB;AAC3D,MAAI,aAAa,KAAK,aAAa;AAClC,UAAM,IAAI,MAAM,8CAA8C;AAC/D,SAAO,KAAK,KAAK,aAAa,GAAG;AAClC;AAKO,SAAS,6BACf,MACgC;AAChC,QAAM,OAAQ,MAAM,MAAM,SAA8B;AAGxD,QAAM,SAAS,MAAM,MAAM,SAAS,QAAQ;AAE5C,MAAI,CAAC,KAAK,SAAS,qCAAwB,EAAG,QAAO;AAGrD,QAAM,aAAa,KAAK,QAAQ,wCAA2B,KAAK,EAAE,EAAE,MAAM,GAAG,EAAE;AAE/E,SAAO;AAAA,IACN,UAAU;AAAA,IACV,aAAa,KAAK,MAAM;AAAA,IACxB,MAAM;AAAA,EACP;AACD;AAGO,SAAS,sBAAsB,MAAc;AACnD,QAAM,wBAAwB,KAAK,MAAM,IAAI;AAC7C,wBAAsB,CAAC,QAAI,qCAAuB,sBAAsB,CAAC,CAAC;AAC1E,SAAO,sBAAsB,KAAK,IAAI;AACvC;",
+  "names": ["import_utils", "chunk"]
+}

package/dist/esm/bcs.d.ts

@@ -0,0 +1,23 @@
+export declare const KioskType: import("@haneullabs/haneul/bcs").BcsStruct<{
+    id: import("@haneullabs/haneul/bcs").BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+    profits: import("@haneullabs/haneul/bcs").BcsType<string, string | number | bigint, "u64">;
+    owner: import("@haneullabs/haneul/bcs").BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+    itemCount: import("@haneullabs/haneul/bcs").BcsType<number, number, "u32">;
+    allowExtensions: import("@haneullabs/haneul/bcs").BcsType<boolean, boolean, "bool">;
+}, string>;
+export declare const KioskPurchaseCap: import("@haneullabs/haneul/bcs").BcsStruct<{
+    id: import("@haneullabs/haneul/bcs").BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+    kioskId: import("@haneullabs/haneul/bcs").BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+    itemId: import("@haneullabs/haneul/bcs").BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+    minPrice: import("@haneullabs/haneul/bcs").BcsType<string, string | number | bigint, "u64">;
+}, string>;
+export declare const TransferPolicyCreatedEvent: import("@haneullabs/haneul/bcs").BcsStruct<{
+    id: import("@haneullabs/haneul/bcs").BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+}, string>;
+export declare const TransferPolicyType: import("@haneullabs/haneul/bcs").BcsStruct<{
+    id: import("@haneullabs/haneul/bcs").BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+    balance: import("@haneullabs/haneul/bcs").BcsType<string, string | number | bigint, "u64">;
+    rules: import("@haneullabs/haneul/bcs").BcsType<string[], Iterable<string> & {
+        length: number;
+    }, string>;
+}, string>;

package/dist/esm/bcs.js

@@ -0,0 +1,35 @@
+import { bcs } from "@haneullabs/haneul/bcs";
+import {
+  KIOSK_PURCHASE_CAP,
+  KIOSK_TYPE,
+  TRANSFER_POLICY_CREATED_EVENT,
+  TRANSFER_POLICY_TYPE
+} from "./types/index.js";
+const KioskType = bcs.struct(KIOSK_TYPE, {
+  id: bcs.Address,
+  profits: bcs.u64(),
+  owner: bcs.Address,
+  itemCount: bcs.u32(),
+  allowExtensions: bcs.bool()
+});
+const KioskPurchaseCap = bcs.struct(KIOSK_PURCHASE_CAP, {
+  id: bcs.Address,
+  kioskId: bcs.Address,
+  itemId: bcs.Address,
+  minPrice: bcs.u64()
+});
+const TransferPolicyCreatedEvent = bcs.struct(TRANSFER_POLICY_CREATED_EVENT, {
+  id: bcs.Address
+});
+const TransferPolicyType = bcs.struct(TRANSFER_POLICY_TYPE, {
+  id: bcs.Address,
+  balance: bcs.u64(),
+  rules: bcs.vector(bcs.string())
+});
+export {
+  KioskPurchaseCap,
+  KioskType,
+  TransferPolicyCreatedEvent,
+  TransferPolicyType
+};
+//# sourceMappingURL=bcs.js.map

package/dist/esm/bcs.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/bcs.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport { bcs } from '@haneullabs/haneul/bcs';\n\nimport {\n\tKIOSK_PURCHASE_CAP,\n\tKIOSK_TYPE,\n\tTRANSFER_POLICY_CREATED_EVENT,\n\tTRANSFER_POLICY_TYPE,\n} from './types/index.js';\n\n// Register the `Kiosk` struct for faster queries.\nexport const KioskType = bcs.struct(KIOSK_TYPE, {\n\tid: bcs.Address,\n\tprofits: bcs.u64(),\n\towner: bcs.Address,\n\titemCount: bcs.u32(),\n\tallowExtensions: bcs.bool(),\n});\n\n// Register the `PurchaseCap` for faster queries.\nexport const KioskPurchaseCap = bcs.struct(KIOSK_PURCHASE_CAP, {\n\tid: bcs.Address,\n\tkioskId: bcs.Address,\n\titemId: bcs.Address,\n\tminPrice: bcs.u64(),\n});\n\n// Register the `TransferPolicyCreated` event data.\nexport const TransferPolicyCreatedEvent = bcs.struct(TRANSFER_POLICY_CREATED_EVENT, {\n\tid: bcs.Address,\n});\n\nexport const TransferPolicyType = bcs.struct(TRANSFER_POLICY_TYPE, {\n\tid: bcs.Address,\n\tbalance: bcs.u64(),\n\trules: bcs.vector(bcs.string()),\n});\n"],
+  "mappings": "AAGA,SAAS,WAAW;AAEpB;AAAA,EACC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACM;AAGA,MAAM,YAAY,IAAI,OAAO,YAAY;AAAA,EAC/C,IAAI,IAAI;AAAA,EACR,SAAS,IAAI,IAAI;AAAA,EACjB,OAAO,IAAI;AAAA,EACX,WAAW,IAAI,IAAI;AAAA,EACnB,iBAAiB,IAAI,KAAK;AAC3B,CAAC;AAGM,MAAM,mBAAmB,IAAI,OAAO,oBAAoB;AAAA,EAC9D,IAAI,IAAI;AAAA,EACR,SAAS,IAAI;AAAA,EACb,QAAQ,IAAI;AAAA,EACZ,UAAU,IAAI,IAAI;AACnB,CAAC;AAGM,MAAM,6BAA6B,IAAI,OAAO,+BAA+B;AAAA,EACnF,IAAI,IAAI;AACT,CAAC;AAEM,MAAM,qBAAqB,IAAI,OAAO,sBAAsB;AAAA,EAClE,IAAI,IAAI;AAAA,EACR,SAAS,IAAI,IAAI;AAAA,EACjB,OAAO,IAAI,OAAO,IAAI,OAAO,CAAC;AAC/B,CAAC;",
+  "names": []
+}

package/dist/esm/client/kiosk-client.d.ts

@@ -0,0 +1,76 @@
+import type { PaginationArguments, HaneulClient } from '@haneullabs/haneul/client';
+import type { BaseRulePackageIds, TransferPolicyRule } from '../constants.js';
+import { Network } from '../types/index.js';
+import type { FetchKioskOptions, KioskClientOptions, KioskData, OwnedKiosks } from '../types/index.js';
+/**
+ * A Client that allows you to interact with kiosk.
+ * Offers utilities to query kiosk, craft transactions to edit your own kiosk,
+ * purchase, manage transfer policies, create new kiosks etc.
+ * If you pass packageIds, all functionality will be managed using these packages.
+ */
+export declare class KioskClient {
+    client: HaneulClient;
+    network: Network;
+    rules: TransferPolicyRule[];
+    packageIds?: BaseRulePackageIds;
+    constructor(options: KioskClientOptions);
+    /**
+     * Get an addresses's owned kiosks.
+     * @param address The address for which we want to retrieve the kiosks.
+     * @param pagination Optional pagination arguments.
+     * @returns An Object containing all the `kioskOwnerCap` objects as well as the kioskIds.
+     */
+    getOwnedKiosks({ address, pagination, }: {
+        address: string;
+        pagination?: PaginationArguments<string>;
+    }): Promise<OwnedKiosks>;
+    /**
+     * Fetches the kiosk contents.
+     * @param id The ID of the kiosk to fetch.
+     * @param options Optional to control the fetch behavior.
+     * @returns
+     */
+    getKiosk({ id, options }: {
+        id: string;
+        options?: FetchKioskOptions;
+    }): Promise<KioskData>;
+    /**
+     * Fetch the extension data (if any) for a kiosk, by type
+     * @param kioskId The ID of the kiosk to lookup
+     * @param extensionType The Type of the extension (can be used from by using the type returned by `getKiosk()`)
+     */
+    getKioskExtension({ kioskId, type }: {
+        kioskId: string;
+        type: string;
+    }): Promise<import("../types/kiosk.js").KioskExtension | null>;
+    /**
+     * Query the Transfer Policy(ies) for type `T`.
+     * @param type The Type we're querying for (E.g `0xMyAddress::hero::Hero`)
+     */
+    getTransferPolicies({ type }: {
+        type: string;
+    }): Promise<import("../types/transfer-policy.js").TransferPolicy[]>;
+    /**
+     * Query all the owned transfer policies for an address.
+     * Returns `TransferPolicyCap` which uncludes `policyId, policyCapId, type`.
+     * @param address The address we're searching the owned transfer policies for.
+     */
+    getOwnedTransferPolicies({ address }: {
+        address: string;
+    }): Promise<import("../types/transfer-policy.js").TransferPolicyCap[] | undefined>;
+    /**
+     * Query the Transfer Policy Cap for type `T`, owned by `address`
+     * @param type The Type `T` for the object
+     * @param address The address that owns the cap.
+     */
+    getOwnedTransferPoliciesByType({ type, address }: {
+        type: string;
+        address: string;
+    }): Promise<import("../types/transfer-policy.js").TransferPolicyCap[]>;
+    addRuleResolver(rule: TransferPolicyRule): void;
+    /**
+     * A convenient helper to get the packageIds for our supported ruleset,
+     * based on `kioskClient` configuration.
+     */
+    getRulePackageId(rule: 'kioskLockRulePackageId' | 'royaltyRulePackageId' | 'personalKioskRulePackageId' | 'floorPriceRulePackageId'): string;
+}

package/dist/esm/client/kiosk-client.js

@@ -0,0 +1,114 @@
+import {
+  FLOOR_PRICE_RULE_ADDRESS,
+  getBaseRules,
+  KIOSK_LOCK_RULE_ADDRESS,
+  PERSONAL_KIOSK_RULE_ADDRESS,
+  ROYALTY_RULE_ADDRESS,
+  rules
+} from "../constants.js";
+import { fetchKiosk, fetchKioskExtension, getOwnedKiosks } from "../query/kiosk.js";
+import {
+  queryOwnedTransferPolicies,
+  queryTransferPolicy,
+  queryTransferPolicyCapsByType
+} from "../query/transfer-policy.js";
+import { Network } from "../types/index.js";
+class KioskClient {
+  constructor(options) {
+    this.client = options.client;
+    this.network = options.network;
+    this.rules = rules;
+    this.packageIds = options.packageIds;
+    if (options.packageIds) this.rules.push(...getBaseRules(options.packageIds));
+  }
+  /// Querying
+  /**
+   * Get an addresses's owned kiosks.
+   * @param address The address for which we want to retrieve the kiosks.
+   * @param pagination Optional pagination arguments.
+   * @returns An Object containing all the `kioskOwnerCap` objects as well as the kioskIds.
+   */
+  async getOwnedKiosks({
+    address,
+    pagination
+  }) {
+    const personalPackageId = this.packageIds?.personalKioskRulePackageId || PERSONAL_KIOSK_RULE_ADDRESS[this.network];
+    return getOwnedKiosks(this.client, address, {
+      pagination,
+      personalKioskType: personalPackageId ? `${personalPackageId}::personal_kiosk::PersonalKioskCap` : ""
+    });
+  }
+  /**
+   * Fetches the kiosk contents.
+   * @param id The ID of the kiosk to fetch.
+   * @param options Optional to control the fetch behavior.
+   * @returns
+   */
+  async getKiosk({ id, options }) {
+    return (await fetchKiosk(this.client, id, {}, options || {})).data;
+  }
+  /**
+   * Fetch the extension data (if any) for a kiosk, by type
+   * @param kioskId The ID of the kiosk to lookup
+   * @param extensionType The Type of the extension (can be used from by using the type returned by `getKiosk()`)
+   */
+  async getKioskExtension({ kioskId, type }) {
+    return fetchKioskExtension(this.client, kioskId, type);
+  }
+  /**
+   * Query the Transfer Policy(ies) for type `T`.
+   * @param type The Type we're querying for (E.g `0xMyAddress::hero::Hero`)
+   */
+  async getTransferPolicies({ type }) {
+    return queryTransferPolicy(this.client, type);
+  }
+  /**
+   * Query all the owned transfer policies for an address.
+   * Returns `TransferPolicyCap` which uncludes `policyId, policyCapId, type`.
+   * @param address The address we're searching the owned transfer policies for.
+   */
+  async getOwnedTransferPolicies({ address }) {
+    return queryOwnedTransferPolicies(this.client, address);
+  }
+  /**
+   * Query the Transfer Policy Cap for type `T`, owned by `address`
+   * @param type The Type `T` for the object
+   * @param address The address that owns the cap.
+   */
+  async getOwnedTransferPoliciesByType({ type, address }) {
+    return queryTransferPolicyCapsByType(this.client, address, type);
+  }
+  // Someone would just have to create a `kiosk-client.ts` file in their project, initialize a KioskClient
+  // and call the `addRuleResolver` function. Each rule has a `resolve` function.
+  // The resolve function is automatically called on `purchaseAndResolve` function call.
+  addRuleResolver(rule) {
+    if (this.rules.find((x) => x.rule === rule.rule))
+      throw new Error(`Rule ${rule.rule} resolver already exists.`);
+    this.rules.push(rule);
+  }
+  /**
+   * A convenient helper to get the packageIds for our supported ruleset,
+   * based on `kioskClient` configuration.
+   */
+  getRulePackageId(rule) {
+    const rules2 = this.packageIds || {};
+    const network = this.network;
+    if (!rules2[rule] && network !== Network.MAINNET && network !== Network.TESTNET) {
+      throw new Error(`Missing packageId for rule ${rule}`);
+    }
+    switch (rule) {
+      case "kioskLockRulePackageId":
+        return rules2[rule] || KIOSK_LOCK_RULE_ADDRESS[network];
+      case "royaltyRulePackageId":
+        return rules2[rule] || ROYALTY_RULE_ADDRESS[network];
+      case "personalKioskRulePackageId":
+        return rules2[rule] || PERSONAL_KIOSK_RULE_ADDRESS[network];
+      case "floorPriceRulePackageId":
+        return rules2[rule] || FLOOR_PRICE_RULE_ADDRESS[network];
+    }
+  }
+}
+export {
+  KioskClient
+};
+//# sourceMappingURL=kiosk-client.js.map