@iota/kiosk 0.0.0-dev-20251015065834

package/dist/cjs/utils.js

@@ -0,0 +1,201 @@
+"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("@iota/iota-sdk/utils");
+var import_bcs = require("./bcs.js");
+var import_types = require("./types/index.js");
+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 = Array.from(
+    { length: Math.ceil(ids.length / limit) },
+    (_, index) => ids.slice(index * limit, index * limit + limit)
+  );
+  const results = await Promise.all(
+    chunks.map((chunk) => {
+      return client.multiGetObjects({
+        ids: chunk,
+        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,
+    // eslint-disable-next-line @typescript-eslint/no-non-null-asserted-optional-chain
+    policyCapId: item.data?.objectId,
+    type: objectType
+  };
+}
+function getNormalizedRuleType(rule) {
+  const normalizedRuleAddress = rule.split("::");
+  normalizedRuleAddress[0] = (0, import_utils.normalizeIotaAddress)(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// Modifications Copyright (c) 2024 IOTA Stiftung\n// SPDX-License-Identifier: Apache-2.0\n\nimport type {\n    DynamicFieldInfo,\n    PaginationArguments,\n    IotaClient,\n    IotaObjectData,\n    IotaObjectDataFilter,\n    IotaObjectDataOptions,\n    IotaObjectResponse,\n} from '@iota/iota-sdk/client';\nimport {\n    fromBase64,\n    normalizeStructTag,\n    normalizeIotaAddress,\n    parseStructTag,\n} from '@iota/iota-sdk/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';\n\nconst DEFAULT_QUERY_LIMIT = 50;\n\nexport async function getKioskObject(client: IotaClient, id: string): Promise<Kiosk> {\n    const queryRes = await client.getObject({ id, options: { showBcs: true } });\n\n    if (!queryRes || queryRes.error || !queryRes.data) {\n        throw new Error(`Kiosk ${id} not found; ${queryRes.error}`);\n    }\n\n    if (!queryRes.data.bcs || !('bcsBytes' in queryRes.data.bcs)) {\n        throw new Error(`Invalid kiosk query: ${id}, expected object, got package`);\n    }\n\n    return KioskType.parse(fromBase64(queryRes.data.bcs!.bcsBytes));\n}\n\n// helper to extract kiosk data from dynamic fields.\nexport function extractKioskData(\n    data: DynamicFieldInfo[],\n    listings: KioskListing[],\n    lockedItemIds: string[],\n    kioskId: string,\n): KioskData {\n    return data.reduce<KioskData>(\n        (acc: KioskData, val: DynamicFieldInfo) => {\n            const type = val.name.type;\n\n            if (type.startsWith('0x2::kiosk::Item')) {\n                acc.itemIds.push(val.objectId);\n                acc.items.push({\n                    objectId: val.objectId,\n                    type: val.objectType,\n                    isLocked: false,\n                    kioskId,\n                });\n            }\n            if (type.startsWith('0x2::kiosk::Listing')) {\n                acc.listingIds.push(val.objectId);\n                listings.push({\n                    objectId: (val.name.value as { id: string }).id,\n                    listingId: val.objectId,\n                    isExclusive: (val.name.value as { is_exclusive: boolean }).is_exclusive,\n                });\n            }\n            if (type.startsWith('0x2::kiosk::Lock')) {\n                lockedItemIds?.push((val.name.value as { id: string }).id);\n            }\n\n            if (type.startsWith('0x2::kiosk_extension::ExtensionKey')) {\n                acc.extensions.push({\n                    objectId: val.objectId,\n                    type: normalizeStructTag(parseStructTag(val.name.type).typeParams[0]),\n                });\n            }\n\n            return acc;\n        },\n        { items: [], itemIds: [], listingIds: [], extensions: [] },\n    );\n}\n\n/**\n * A helper that attaches the listing prices to kiosk listings.\n */\nexport function attachListingsAndPrices(\n    kioskData: KioskData,\n    listings: KioskListing[],\n    listingObjects: IotaObjectResponse[],\n) {\n    // map item listings as {item_id: KioskListing}\n    // for easier mapping on the nex\n    const itemListings = listings.reduce<Record<string, KioskListing>>(\n        (acc: Record<string, KioskListing>, item, idx) => {\n            acc[item.objectId] = { ...item };\n\n            // return in case we don't have any listing objects.\n            // that's the case when we don't have the `listingPrices` included.\n            if (listingObjects.length === 0) return acc;\n\n            const content = listingObjects[idx].data?.content;\n            const data = content?.dataType === 'moveObject' ? content?.fields : null;\n\n            if (!data) return acc;\n\n            acc[item.objectId].price = (data as { value: string }).value;\n            return acc;\n        },\n        {},\n    );\n\n    kioskData.items.forEach((item) => {\n        item.listing = itemListings[item.objectId] || undefined;\n    });\n}\n\n/**\n * A helper that attaches the listing prices to kiosk listings.\n */\nexport function attachObjects(kioskData: KioskData, objects: IotaObjectData[]) {\n    const mapping = objects.reduce<Record<string, IotaObjectData>>(\n        (acc: Record<string, IotaObjectData>, obj) => {\n            acc[obj.objectId] = obj;\n            return acc;\n        },\n        {},\n    );\n\n    kioskData.items.forEach((item) => {\n        item.data = mapping[item.objectId] || undefined;\n    });\n}\n\n/**\n * A Helper to attach locked state to items in Kiosk Data.\n */\nexport function attachLockedItems(kioskData: KioskData, lockedItemIds: string[]) {\n    // map lock status in an array of type { item_id: true }\n    const lockedStatuses = lockedItemIds.reduce<Record<string, boolean>>(\n        (acc: Record<string, boolean>, item: string) => {\n            acc[item] = true;\n            return acc;\n        },\n        {},\n    );\n\n    // parse lockedItemIds and attach their locked status.\n    kioskData.items.forEach((item) => {\n        item.isLocked = lockedStatuses[item.objectId] || false;\n    });\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    client: IotaClient,\n    parentId: string,\n    pagination: PaginationArguments<string>,\n) {\n    let hasNextPage = true;\n    let cursor = undefined;\n    const data: DynamicFieldInfo[] = [];\n\n    while (hasNextPage) {\n        const result = await client.getDynamicFields({\n            parentId,\n            limit: pagination.limit || undefined,\n            cursor,\n        });\n        data.push(...result.data);\n        hasNextPage = result.hasNextPage;\n        cursor = result.nextCursor;\n    }\n\n    return 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    client: IotaClient,\n    ids: string[],\n    options: IotaObjectDataOptions,\n    limit: number = DEFAULT_QUERY_LIMIT,\n) {\n    const chunks = Array.from({ length: Math.ceil(ids.length / limit) }, (_, index) =>\n        ids.slice(index * limit, index * limit + limit),\n    );\n\n    const results = await Promise.all(\n        chunks.map((chunk) => {\n            return client.multiGetObjects({\n                ids: chunk,\n                options,\n            });\n        }),\n    );\n\n    return 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    client,\n    owner,\n    filter,\n    limit = DEFAULT_QUERY_LIMIT,\n    options = { showType: true, showContent: true },\n}: {\n    client: IotaClient;\n    owner: string;\n    filter?: IotaObjectDataFilter;\n    options?: IotaObjectDataOptions;\n    limit?: number;\n}) {\n    let hasNextPage = true;\n    let cursor = undefined;\n    const data: IotaObjectResponse[] = [];\n\n    while (hasNextPage) {\n        const result = await client.getOwnedObjects({\n            owner,\n            filter,\n            limit,\n            cursor,\n            options,\n        });\n        data.push(...result.data);\n        hasNextPage = result.hasNextPage;\n        cursor = result.nextCursor;\n    }\n\n    return 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    if (percentage < 0 || percentage > 100)\n        throw new Error('Percentage needs to be in the [0,100] range.');\n    return 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    item: IotaObjectResponse,\n): TransferPolicyCap | undefined {\n    const type = (item?.data?.content as { type: string })?.type;\n\n    //@ts-expect-error Silencing error here\n    const policy = item?.data?.content?.fields?.policy_id as string;\n\n    if (!type.includes(TRANSFER_POLICY_CAP_TYPE)) return undefined;\n\n    // Transform 0x2::transfer_policy::TransferPolicyCap<itemType> -> itemType\n    const objectType = type.replace(TRANSFER_POLICY_CAP_TYPE + '<', '').slice(0, -1);\n\n    return {\n        policyId: policy,\n        // eslint-disable-next-line @typescript-eslint/no-non-null-asserted-optional-chain\n        policyCapId: item.data?.objectId!,\n        type: objectType,\n    };\n}\n\n// Normalizes the packageId part of a rule's type.\nexport function getNormalizedRuleType(rule: string) {\n    const normalizedRuleAddress = rule.split('::');\n    normalizedRuleAddress[0] = normalizeIotaAddress(normalizedRuleAddress[0]);\n    return normalizedRuleAddress.join('::');\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAaA,mBAKO;AAEP,iBAA0B;AAE1B,mBAAyC;AAEzC,MAAM,sBAAsB;AAE5B,eAAsB,eAAe,QAAoB,IAA4B;AACjF,QAAM,WAAW,MAAM,OAAO,UAAU,EAAE,IAAI,SAAS,EAAE,SAAS,KAAK,EAAE,CAAC;AAE1E,MAAI,CAAC,YAAY,SAAS,SAAS,CAAC,SAAS,MAAM;AAC/C,UAAM,IAAI,MAAM,SAAS,EAAE,eAAe,SAAS,KAAK,EAAE;AAAA,EAC9D;AAEA,MAAI,CAAC,SAAS,KAAK,OAAO,EAAE,cAAc,SAAS,KAAK,MAAM;AAC1D,UAAM,IAAI,MAAM,wBAAwB,EAAE,gCAAgC;AAAA,EAC9E;AAEA,SAAO,qBAAU,UAAM,yBAAW,SAAS,KAAK,IAAK,QAAQ,CAAC;AAClE;AAGO,SAAS,iBACZ,MACA,UACA,eACA,SACS;AACT,SAAO,KAAK;AAAA,IACR,CAAC,KAAgB,QAA0B;AACvC,YAAM,OAAO,IAAI,KAAK;AAEtB,UAAI,KAAK,WAAW,kBAAkB,GAAG;AACrC,YAAI,QAAQ,KAAK,IAAI,QAAQ;AAC7B,YAAI,MAAM,KAAK;AAAA,UACX,UAAU,IAAI;AAAA,UACd,MAAM,IAAI;AAAA,UACV,UAAU;AAAA,UACV;AAAA,QACJ,CAAC;AAAA,MACL;AACA,UAAI,KAAK,WAAW,qBAAqB,GAAG;AACxC,YAAI,WAAW,KAAK,IAAI,QAAQ;AAChC,iBAAS,KAAK;AAAA,UACV,UAAW,IAAI,KAAK,MAAyB;AAAA,UAC7C,WAAW,IAAI;AAAA,UACf,aAAc,IAAI,KAAK,MAAoC;AAAA,QAC/D,CAAC;AAAA,MACL;AACA,UAAI,KAAK,WAAW,kBAAkB,GAAG;AACrC,uBAAe,KAAM,IAAI,KAAK,MAAyB,EAAE;AAAA,MAC7D;AAEA,UAAI,KAAK,WAAW,oCAAoC,GAAG;AACvD,YAAI,WAAW,KAAK;AAAA,UAChB,UAAU,IAAI;AAAA,UACd,UAAM,qCAAmB,6BAAe,IAAI,KAAK,IAAI,EAAE,WAAW,CAAC,CAAC;AAAA,QACxE,CAAC;AAAA,MACL;AAEA,aAAO;AAAA,IACX;AAAA,IACA,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,GAAG,YAAY,CAAC,GAAG,YAAY,CAAC,EAAE;AAAA,EAC7D;AACJ;AAKO,SAAS,wBACZ,WACA,UACA,gBACF;AAGE,QAAM,eAAe,SAAS;AAAA,IAC1B,CAAC,KAAmC,MAAM,QAAQ;AAC9C,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,IACX;AAAA,IACA,CAAC;AAAA,EACL;AAEA,YAAU,MAAM,QAAQ,CAAC,SAAS;AAC9B,SAAK,UAAU,aAAa,KAAK,QAAQ,KAAK;AAAA,EAClD,CAAC;AACL;AAKO,SAAS,cAAc,WAAsB,SAA2B;AAC3E,QAAM,UAAU,QAAQ;AAAA,IACpB,CAAC,KAAqC,QAAQ;AAC1C,UAAI,IAAI,QAAQ,IAAI;AACpB,aAAO;AAAA,IACX;AAAA,IACA,CAAC;AAAA,EACL;AAEA,YAAU,MAAM,QAAQ,CAAC,SAAS;AAC9B,SAAK,OAAO,QAAQ,KAAK,QAAQ,KAAK;AAAA,EAC1C,CAAC;AACL;AAKO,SAAS,kBAAkB,WAAsB,eAAyB;AAE7E,QAAM,iBAAiB,cAAc;AAAA,IACjC,CAAC,KAA8B,SAAiB;AAC5C,UAAI,IAAI,IAAI;AACZ,aAAO;AAAA,IACX;AAAA,IACA,CAAC;AAAA,EACL;AAGA,YAAU,MAAM,QAAQ,CAAC,SAAS;AAC9B,SAAK,WAAW,eAAe,KAAK,QAAQ,KAAK;AAAA,EACrD,CAAC;AACL;AAOA,eAAsB,oBAClB,QACA,UACA,YACF;AACE,MAAI,cAAc;AAClB,MAAI,SAAS;AACb,QAAM,OAA2B,CAAC;AAElC,SAAO,aAAa;AAChB,UAAM,SAAS,MAAM,OAAO,iBAAiB;AAAA,MACzC;AAAA,MACA,OAAO,WAAW,SAAS;AAAA,MAC3B;AAAA,IACJ,CAAC;AACD,SAAK,KAAK,GAAG,OAAO,IAAI;AACxB,kBAAc,OAAO;AACrB,aAAS,OAAO;AAAA,EACpB;AAEA,SAAO;AACX;AAOA,eAAsB,cAClB,QACA,KACA,SACA,QAAgB,qBAClB;AACE,QAAM,SAAS,MAAM;AAAA,IAAK,EAAE,QAAQ,KAAK,KAAK,IAAI,SAAS,KAAK,EAAE;AAAA,IAAG,CAAC,GAAG,UACrE,IAAI,MAAM,QAAQ,OAAO,QAAQ,QAAQ,KAAK;AAAA,EAClD;AAEA,QAAM,UAAU,MAAM,QAAQ;AAAA,IAC1B,OAAO,IAAI,CAAC,UAAU;AAClB,aAAO,OAAO,gBAAgB;AAAA,QAC1B,KAAK;AAAA,QACL;AAAA,MACJ,CAAC;AAAA,IACL,CAAC;AAAA,EACL;AAEA,SAAO,QAAQ,KAAK;AACxB;AAMA,eAAsB,mBAAmB;AAAA,EACrC;AAAA,EACA;AAAA,EACA;AAAA,EACA,QAAQ;AAAA,EACR,UAAU,EAAE,UAAU,MAAM,aAAa,KAAK;AAClD,GAMG;AACC,MAAI,cAAc;AAClB,MAAI,SAAS;AACb,QAAM,OAA6B,CAAC;AAEpC,SAAO,aAAa;AAChB,UAAM,SAAS,MAAM,OAAO,gBAAgB;AAAA,MACxC;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ,CAAC;AACD,SAAK,KAAK,GAAG,OAAO,IAAI;AACxB,kBAAc,OAAO;AACrB,aAAS,OAAO;AAAA,EACpB;AAEA,SAAO;AACX;AAQO,SAAS,wBAAwB,YAAoB;AACxD,MAAI,aAAa,KAAK,aAAa;AAC/B,UAAM,IAAI,MAAM,8CAA8C;AAClE,SAAO,KAAK,KAAK,aAAa,GAAG;AACrC;AAKO,SAAS,6BACZ,MAC6B;AAC7B,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,IACH,UAAU;AAAA;AAAA,IAEV,aAAa,KAAK,MAAM;AAAA,IACxB,MAAM;AAAA,EACV;AACJ;AAGO,SAAS,sBAAsB,MAAc;AAChD,QAAM,wBAAwB,KAAK,MAAM,IAAI;AAC7C,wBAAsB,CAAC,QAAI,mCAAqB,sBAAsB,CAAC,CAAC;AACxE,SAAO,sBAAsB,KAAK,IAAI;AAC1C;",
+  "names": []
+}

package/dist/esm/bcs.d.ts

@@ -0,0 +1,38 @@
+export declare const KioskType: import("@iota/iota-sdk/bcs").BcsType<{
+    id: string;
+    profits: string;
+    owner: string;
+    itemCount: number;
+}, {
+    id: string | Uint8Array;
+    profits: string | number | bigint;
+    owner: string | Uint8Array;
+    itemCount: number;
+}>;
+export declare const KioskPurchaseCap: import("@iota/iota-sdk/bcs").BcsType<{
+    id: string;
+    kioskId: string;
+    itemId: string;
+    minPrice: string;
+}, {
+    id: string | Uint8Array;
+    kioskId: string | Uint8Array;
+    itemId: string | Uint8Array;
+    minPrice: string | number | bigint;
+}>;
+export declare const TransferPolicyCreatedEvent: import("@iota/iota-sdk/bcs").BcsType<{
+    id: string;
+}, {
+    id: string | Uint8Array;
+}>;
+export declare const TransferPolicyType: import("@iota/iota-sdk/bcs").BcsType<{
+    id: string;
+    balance: string;
+    rules: string[];
+}, {
+    id: string | Uint8Array;
+    balance: string | number | bigint;
+    rules: Iterable<string> & {
+        length: number;
+    };
+}>;

package/dist/esm/bcs.js

@@ -0,0 +1,34 @@
+import { bcs } from "@iota/iota-sdk/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()
+});
+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// Modifications Copyright (c) 2024 IOTA Stiftung\n// SPDX-License-Identifier: Apache-2.0\n\nimport { bcs } from '@iota/iota-sdk/bcs';\n\nimport {\n    KIOSK_PURCHASE_CAP,\n    KIOSK_TYPE,\n    TRANSFER_POLICY_CREATED_EVENT,\n    TRANSFER_POLICY_TYPE,\n} from './types/index.js';\n\n// Register the `Kiosk` struct for faster queries.\nexport const KioskType = bcs.struct(KIOSK_TYPE, {\n    id: bcs.Address,\n    profits: bcs.u64(),\n    owner: bcs.Address,\n    itemCount: bcs.u32(),\n});\n\n// Register the `PurchaseCap` for faster queries.\nexport const KioskPurchaseCap = bcs.struct(KIOSK_PURCHASE_CAP, {\n    id: bcs.Address,\n    kioskId: bcs.Address,\n    itemId: bcs.Address,\n    minPrice: bcs.u64(),\n});\n\n// Register the `TransferPolicyCreated` event data.\nexport const TransferPolicyCreatedEvent = bcs.struct(TRANSFER_POLICY_CREATED_EVENT, {\n    id: bcs.Address,\n});\n\nexport const TransferPolicyType = bcs.struct(TRANSFER_POLICY_TYPE, {\n    id: bcs.Address,\n    balance: bcs.u64(),\n    rules: bcs.vector(bcs.string()),\n});\n"],
+  "mappings": "AAIA,SAAS,WAAW;AAEpB;AAAA,EACI;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACG;AAGA,MAAM,YAAY,IAAI,OAAO,YAAY;AAAA,EAC5C,IAAI,IAAI;AAAA,EACR,SAAS,IAAI,IAAI;AAAA,EACjB,OAAO,IAAI;AAAA,EACX,WAAW,IAAI,IAAI;AACvB,CAAC;AAGM,MAAM,mBAAmB,IAAI,OAAO,oBAAoB;AAAA,EAC3D,IAAI,IAAI;AAAA,EACR,SAAS,IAAI;AAAA,EACb,QAAQ,IAAI;AAAA,EACZ,UAAU,IAAI,IAAI;AACtB,CAAC;AAGM,MAAM,6BAA6B,IAAI,OAAO,+BAA+B;AAAA,EAChF,IAAI,IAAI;AACZ,CAAC;AAEM,MAAM,qBAAqB,IAAI,OAAO,sBAAsB;AAAA,EAC/D,IAAI,IAAI;AAAA,EACR,SAAS,IAAI,IAAI;AAAA,EACjB,OAAO,IAAI,OAAO,IAAI,OAAO,CAAC;AAClC,CAAC;",
+  "names": []
+}

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

@@ -0,0 +1,76 @@
+import type { NetworkId } from '@iota/iota-sdk/client';
+import type { PaginationArguments, IotaClient } from '@iota/iota-sdk/client';
+import type { BaseRulePackageIds, TransferPolicyRule } from '../constants.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: IotaClient;
+    network: NetworkId;
+    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,110 @@
+import { getNetwork } from "@iota/iota-sdk/client";
+import { getBaseRules, rules } from "../constants.js";
+import { fetchKiosk, fetchKioskExtension, getOwnedKiosks } from "../query/kiosk.js";
+import {
+  queryOwnedTransferPolicies,
+  queryTransferPolicy,
+  queryTransferPolicyCapsByType
+} from "../query/transfer-policy.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 || getNetwork(this.network).kiosk?.personalKioskRulePackageId || "";
+    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,
+      {
+        limit: 1e3
+      },
+      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;
+    const networkKiosk = getNetwork(network).kiosk;
+    const rulePackageId = rules2[rule] || networkKiosk?.[rule];
+    if (!rulePackageId) {
+      throw new Error(`Missing packageId for rule ${rule}`);
+    }
+    return rulePackageId;
+  }
+}
+export {
+  KioskClient
+};
+//# sourceMappingURL=kiosk-client.js.map

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

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/client/kiosk-client.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// Modifications Copyright (c) 2024 IOTA Stiftung\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { NetworkId } from '@iota/iota-sdk/client';\nimport { getNetwork } from '@iota/iota-sdk/client';\nimport type { PaginationArguments, IotaClient } from '@iota/iota-sdk/client';\n\nimport { getBaseRules, rules } from '../constants.js';\nimport type { BaseRulePackageIds, TransferPolicyRule } from '../constants.js';\nimport { fetchKiosk, fetchKioskExtension, getOwnedKiosks } from '../query/kiosk.js';\nimport {\n    queryOwnedTransferPolicies,\n    queryTransferPolicy,\n    queryTransferPolicyCapsByType,\n} from '../query/transfer-policy.js';\nimport type {\n    FetchKioskOptions,\n    KioskClientOptions,\n    KioskData,\n    OwnedKiosks,\n} from '../types/index.js';\n\n/**\n * A Client that allows you to interact with kiosk.\n * Offers utilities to query kiosk, craft transactions to edit your own kiosk,\n * purchase, manage transfer policies, create new kiosks etc.\n * If you pass packageIds, all functionality will be managed using these packages.\n */\nexport class KioskClient {\n    client: IotaClient;\n    network: NetworkId;\n    rules: TransferPolicyRule[];\n    packageIds?: BaseRulePackageIds;\n\n    constructor(options: KioskClientOptions) {\n        this.client = options.client;\n        this.network = options.network;\n        this.rules = rules; // add all the default rules.\n        this.packageIds = options.packageIds;\n\n        // Add the custom Package Ids too on the rule list.\n        // Only adds the rules that are passed in the packageId object.\n        if (options.packageIds) this.rules.push(...getBaseRules(options.packageIds));\n    }\n\n    /// Querying\n\n    /**\n     * Get an addresses's owned kiosks.\n     * @param address The address for which we want to retrieve the kiosks.\n     * @param pagination Optional pagination arguments.\n     * @returns An Object containing all the `kioskOwnerCap` objects as well as the kioskIds.\n     */\n    async getOwnedKiosks({\n        address,\n        pagination,\n    }: {\n        address: string;\n        pagination?: PaginationArguments<string>;\n    }): Promise<OwnedKiosks> {\n        const personalPackageId =\n            this.packageIds?.personalKioskRulePackageId ||\n            getNetwork(this.network).kiosk?.personalKioskRulePackageId ||\n            '';\n\n        return getOwnedKiosks(this.client, address, {\n            pagination,\n            personalKioskType: personalPackageId\n                ? `${personalPackageId}::personal_kiosk::PersonalKioskCap`\n                : '',\n        });\n    }\n\n    /**\n     * Fetches the kiosk contents.\n     * @param id The ID of the kiosk to fetch.\n     * @param options Optional to control the fetch behavior.\n     * @returns\n     */\n    async getKiosk({\n        id,\n        options,\n    }: {\n        id: string;\n        options?: FetchKioskOptions;\n    }): Promise<KioskData> {\n        return (\n            await fetchKiosk(\n                this.client,\n                id,\n                {\n                    limit: 1000,\n                },\n                options || {},\n            )\n        ).data;\n    }\n\n    /**\n     * Fetch the extension data (if any) for a kiosk, by type\n     * @param kioskId The ID of the kiosk to lookup\n     * @param extensionType The Type of the extension (can be used from by using the type returned by `getKiosk()`)\n     */\n    async getKioskExtension({ kioskId, type }: { kioskId: string; type: string }) {\n        return fetchKioskExtension(this.client, kioskId, type);\n    }\n\n    /**\n     * Query the Transfer Policy(ies) for type `T`.\n     * @param type The Type we're querying for (E.g `0xMyAddress::hero::Hero`)\n     */\n    async getTransferPolicies({ type }: { type: string }) {\n        return queryTransferPolicy(this.client, type);\n    }\n\n    /**\n     * Query all the owned transfer policies for an address.\n     * Returns `TransferPolicyCap` which uncludes `policyId, policyCapId, type`.\n     * @param address The address we're searching the owned transfer policies for.\n     */\n    async getOwnedTransferPolicies({ address }: { address: string }) {\n        return queryOwnedTransferPolicies(this.client, address);\n    }\n\n    /**\n     * Query the Transfer Policy Cap for type `T`, owned by `address`\n     * @param type The Type `T` for the object\n     * @param address The address that owns the cap.\n     */\n    async getOwnedTransferPoliciesByType({ type, address }: { type: string; address: string }) {\n        return queryTransferPolicyCapsByType(this.client, address, type);\n    }\n\n    // Someone would just have to create a `kiosk-client.ts` file in their project, initialize a KioskClient\n    // and call the `addRuleResolver` function. Each rule has a `resolve` function.\n    // The resolve function is automatically called on `purchaseAndResolve` function call.\n    addRuleResolver(rule: TransferPolicyRule) {\n        if (this.rules.find((x) => x.rule === rule.rule))\n            throw new Error(`Rule ${rule.rule} resolver already exists.`);\n        this.rules.push(rule);\n    }\n\n    /**\n     * A convenient helper to get the packageIds for our supported ruleset,\n     * based on `kioskClient` configuration.\n     */\n    getRulePackageId(\n        rule:\n            | 'kioskLockRulePackageId'\n            | 'royaltyRulePackageId'\n            | 'personalKioskRulePackageId'\n            | 'floorPriceRulePackageId',\n    ) {\n        const rules = this.packageIds || {};\n        const network = this.network;\n\n        const networkKiosk = getNetwork(network).kiosk;\n\n        const rulePackageId = rules[rule] || networkKiosk?.[rule];\n\n        /// Check existence of rule throw an error if it's not found.\n        if (!rulePackageId) {\n            throw new Error(`Missing packageId for rule ${rule}`);\n        }\n\n        return rulePackageId;\n    }\n}\n"],
+  "mappings": "AAKA,SAAS,kBAAkB;AAG3B,SAAS,cAAc,aAAa;AAEpC,SAAS,YAAY,qBAAqB,sBAAsB;AAChE;AAAA,EACI;AAAA,EACA;AAAA,EACA;AAAA,OACG;AAcA,MAAM,YAAY;AAAA,EAMrB,YAAY,SAA6B;AACrC,SAAK,SAAS,QAAQ;AACtB,SAAK,UAAU,QAAQ;AACvB,SAAK,QAAQ;AACb,SAAK,aAAa,QAAQ;AAI1B,QAAI,QAAQ,WAAY,MAAK,MAAM,KAAK,GAAG,aAAa,QAAQ,UAAU,CAAC;AAAA,EAC/E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,eAAe;AAAA,IACjB;AAAA,IACA;AAAA,EACJ,GAGyB;AACrB,UAAM,oBACF,KAAK,YAAY,8BACjB,WAAW,KAAK,OAAO,EAAE,OAAO,8BAChC;AAEJ,WAAO,eAAe,KAAK,QAAQ,SAAS;AAAA,MACxC;AAAA,MACA,mBAAmB,oBACb,GAAG,iBAAiB,uCACpB;AAAA,IACV,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,SAAS;AAAA,IACX;AAAA,IACA;AAAA,EACJ,GAGuB;AACnB,YACI,MAAM;AAAA,MACF,KAAK;AAAA,MACL;AAAA,MACA;AAAA,QACI,OAAO;AAAA,MACX;AAAA,MACA,WAAW,CAAC;AAAA,IAChB,GACF;AAAA,EACN;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,kBAAkB,EAAE,SAAS,KAAK,GAAsC;AAC1E,WAAO,oBAAoB,KAAK,QAAQ,SAAS,IAAI;AAAA,EACzD;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,oBAAoB,EAAE,KAAK,GAAqB;AAClD,WAAO,oBAAoB,KAAK,QAAQ,IAAI;AAAA,EAChD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,yBAAyB,EAAE,QAAQ,GAAwB;AAC7D,WAAO,2BAA2B,KAAK,QAAQ,OAAO;AAAA,EAC1D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,+BAA+B,EAAE,MAAM,QAAQ,GAAsC;AACvF,WAAO,8BAA8B,KAAK,QAAQ,SAAS,IAAI;AAAA,EACnE;AAAA;AAAA;AAAA;AAAA,EAKA,gBAAgB,MAA0B;AACtC,QAAI,KAAK,MAAM,KAAK,CAAC,MAAM,EAAE,SAAS,KAAK,IAAI;AAC3C,YAAM,IAAI,MAAM,QAAQ,KAAK,IAAI,2BAA2B;AAChE,SAAK,MAAM,KAAK,IAAI;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,iBACI,MAKF;AACE,UAAMA,SAAQ,KAAK,cAAc,CAAC;AAClC,UAAM,UAAU,KAAK;AAErB,UAAM,eAAe,WAAW,OAAO,EAAE;AAEzC,UAAM,gBAAgBA,OAAM,IAAI,KAAK,eAAe,IAAI;AAGxD,QAAI,CAAC,eAAe;AAChB,YAAM,IAAI,MAAM,8BAA8B,IAAI,EAAE;AAAA,IACxD;AAEA,WAAO;AAAA,EACX;AACJ;",
+  "names": ["rules"]
+}