@iota/kiosk 0.1.0

package/dist/cjs/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var src_exports = {};
+module.exports = __toCommonJS(src_exports);
+__reExport(src_exports, require("./utils.js"), module.exports);
+__reExport(src_exports, require("./types/index.js"), module.exports);
+__reExport(src_exports, require("./constants.js"), module.exports);
+__reExport(src_exports, require("./client/kiosk-client.js"), module.exports);
+__reExport(src_exports, require("./client/tp-transaction.js"), module.exports);
+__reExport(src_exports, require("./client/kiosk-transaction.js"), module.exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/index.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// Modifications Copyright (c) 2024 IOTA Stiftung\n// SPDX-License-Identifier: Apache-2.0\n\nexport * from './utils.js';\nexport * from './types/index.js';\nexport * from './constants.js';\nexport * from './client/kiosk-client.js';\nexport * from './client/tp-transaction.js';\nexport * from './client/kiosk-transaction.js';\n"],
+  "mappings": ";;;;;;;;;;;;;;;AAAA;AAAA;AAIA,wBAAc,uBAJd;AAKA,wBAAc,6BALd;AAMA,wBAAc,2BANd;AAOA,wBAAc,qCAPd;AAQA,wBAAc,uCARd;AASA,wBAAc,0CATd;",
+  "names": []
+}

package/dist/cjs/package.json

@@ -0,0 +1,5 @@
+{
+  "private": true,
+  "type": "commonjs",
+  "sideEffects": false
+}

package/dist/cjs/query/kiosk.d.ts

@@ -0,0 +1,14 @@
+import type { PaginationArguments, IotaClient } from '@iota/iota-sdk/client';
+import type { FetchKioskOptions, KioskExtension, OwnedKiosks, PagedKioskData } from '../types/index.js';
+export declare function fetchKiosk(client: IotaClient, kioskId: string, pagination: PaginationArguments<string>, options: FetchKioskOptions): Promise<PagedKioskData>;
+/**
+ * A function to fetch all the user's kiosk Caps
+ * And a list of the kiosk address ids.
+ * Returns a list of `kioskOwnerCapIds` and `kioskIds`.
+ * Extra options allow pagination.
+ */
+export declare function getOwnedKiosks(client: IotaClient, address: string, options?: {
+    pagination?: PaginationArguments<string>;
+    personalKioskType: string;
+}): Promise<OwnedKiosks>;
+export declare function fetchKioskExtension(client: IotaClient, kioskId: string, extensionType: string): Promise<KioskExtension | null>;

package/dist/cjs/query/kiosk.js

@@ -0,0 +1,128 @@
+"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 kiosk_exports = {};
+__export(kiosk_exports, {
+  fetchKiosk: () => fetchKiosk,
+  fetchKioskExtension: () => fetchKioskExtension,
+  getOwnedKiosks: () => getOwnedKiosks
+});
+module.exports = __toCommonJS(kiosk_exports);
+var import_utils = require("@iota/iota-sdk/utils");
+var import_types = require("../types/index.js");
+var import_utils2 = require("../utils.js");
+async function fetchKiosk(client, kioskId, pagination, options) {
+  const data = await (0, import_utils2.getAllDynamicFields)(client, kioskId, pagination);
+  const listings = [];
+  const lockedItemIds = [];
+  const kioskData = (0, import_utils2.extractKioskData)(data, listings, lockedItemIds, kioskId);
+  const [kiosk, listingObjects, items] = await Promise.all([
+    options.withKioskFields ? (0, import_utils2.getKioskObject)(client, kioskId) : Promise.resolve(void 0),
+    options.withListingPrices ? (0, import_utils2.getAllObjects)(client, kioskData.listingIds, {
+      showContent: true
+    }) : Promise.resolve([]),
+    options.withObjects ? (0, import_utils2.getAllObjects)(
+      client,
+      kioskData.itemIds,
+      options.objectOptions || { showDisplay: true }
+    ) : Promise.resolve([])
+  ]);
+  if (options.withKioskFields)
+    kioskData.kiosk = kiosk;
+  (0, import_utils2.attachListingsAndPrices)(kioskData, listings, listingObjects);
+  (0, import_utils2.attachLockedItems)(kioskData, lockedItemIds);
+  (0, import_utils2.attachObjects)(
+    kioskData,
+    items.filter((x) => !!x.data).map((x) => x.data)
+  );
+  return {
+    data: kioskData,
+    nextCursor: null,
+    hasNextPage: false
+  };
+}
+async function getOwnedKiosks(client, address, options) {
+  if (!(0, import_utils.isValidIotaAddress)(address))
+    return {
+      nextCursor: null,
+      hasNextPage: false,
+      kioskOwnerCaps: [],
+      kioskIds: []
+    };
+  const filter = {
+    MatchAny: [
+      {
+        StructType: import_types.KIOSK_OWNER_CAP
+      }
+    ]
+  };
+  if (options?.personalKioskType) {
+    filter.MatchAny.push({
+      StructType: options.personalKioskType
+    });
+  }
+  const { data, hasNextPage, nextCursor } = await client.getOwnedObjects({
+    owner: address,
+    filter,
+    options: {
+      showContent: true,
+      showType: true
+    },
+    ...options?.pagination || {}
+  });
+  const kioskIdList = data?.map((x) => {
+    const fields = x.data?.content?.dataType === "moveObject" ? x.data.content.fields : null;
+    return fields?.cap ? fields?.cap?.fields?.for : fields?.for;
+  });
+  const filteredData = data.filter((x) => "data" in x).map((x) => x.data);
+  return {
+    nextCursor,
+    hasNextPage,
+    kioskOwnerCaps: filteredData.map((x, idx) => ({
+      isPersonal: x.type !== import_types.KIOSK_OWNER_CAP,
+      digest: x.digest,
+      version: x.version,
+      objectId: x.objectId,
+      kioskId: kioskIdList[idx]
+    })),
+    kioskIds: kioskIdList
+  };
+}
+async function fetchKioskExtension(client, kioskId, extensionType) {
+  const extension = await client.getDynamicFieldObject({
+    parentId: kioskId,
+    name: {
+      type: `0x2::kiosk_extension::ExtensionKey<${extensionType}>`,
+      value: {
+        dummy_field: false
+      }
+    }
+  });
+  if (!extension.data)
+    return null;
+  const fields = extension?.data?.content?.fields?.value?.fields;
+  return {
+    objectId: extension.data.objectId,
+    type: extensionType,
+    isEnabled: fields?.is_enabled,
+    permissions: fields?.permissions,
+    storageId: fields?.storage?.fields?.id?.id,
+    storageSize: fields?.storage?.fields?.size
+  };
+}
+//# sourceMappingURL=kiosk.js.map

package/dist/cjs/query/kiosk.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/query/kiosk.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    PaginationArguments,\n    IotaClient,\n    IotaObjectData,\n    IotaObjectDataFilter,\n    IotaObjectResponse,\n} from '@iota/iota-sdk/client';\nimport { isValidIotaAddress } from '@iota/iota-sdk/utils';\n\nimport type {\n    FetchKioskOptions,\n    KioskExtension,\n    KioskListing,\n    OwnedKiosks,\n    PagedKioskData,\n} from '../types/index.js';\nimport { KIOSK_OWNER_CAP } from '../types/index.js';\nimport {\n    attachListingsAndPrices,\n    attachLockedItems,\n    attachObjects,\n    extractKioskData,\n    getAllDynamicFields,\n    getAllObjects,\n    getKioskObject,\n} from '../utils.js';\n\nexport async function fetchKiosk(\n    client: IotaClient,\n    kioskId: string,\n    pagination: PaginationArguments<string>,\n    options: FetchKioskOptions,\n): Promise<PagedKioskData> {\n    // TODO: Replace the `getAllDynamicFields` with a paginated\n    // response, once we have better RPC support for\n    // type filtering & batch fetching.\n    // This can't work with pagination currently.\n    const data = await getAllDynamicFields(client, kioskId, pagination);\n\n    const listings: KioskListing[] = [];\n    const lockedItemIds: string[] = [];\n\n    // extracted kiosk data.\n    const kioskData = extractKioskData(data, listings, lockedItemIds, kioskId);\n\n    // split the fetching in two queries as we are most likely passing different options for each kind.\n    // For items, we usually seek the Display.\n    // For listings we usually seek the DF value (price) / exclusivity.\n    const [kiosk, listingObjects, items] = await Promise.all([\n        options.withKioskFields ? getKioskObject(client, kioskId) : Promise.resolve(undefined),\n        options.withListingPrices\n            ? getAllObjects(client, kioskData.listingIds, {\n                  showContent: true,\n              })\n            : Promise.resolve([]),\n        options.withObjects\n            ? getAllObjects(\n                  client,\n                  kioskData.itemIds,\n                  options.objectOptions || { showDisplay: true },\n              )\n            : Promise.resolve([]),\n    ]);\n\n    if (options.withKioskFields) kioskData.kiosk = kiosk;\n    // attach items listings. IF we have `options.withListingPrices === true`, it will also attach the prices.\n    attachListingsAndPrices(kioskData, listings, listingObjects);\n    // add `locked` status to items that are locked.\n    attachLockedItems(kioskData, lockedItemIds);\n\n    // Attach the objects for the queried items.\n    attachObjects(\n        kioskData,\n        items.filter((x) => !!x.data).map((x) => x.data!),\n    );\n\n    return {\n        data: kioskData,\n        nextCursor: null,\n        hasNextPage: false,\n    };\n}\n\n/**\n * A function to fetch all the user's kiosk Caps\n * And a list of the kiosk address ids.\n * Returns a list of `kioskOwnerCapIds` and `kioskIds`.\n * Extra options allow pagination.\n */\nexport async function getOwnedKiosks(\n    client: IotaClient,\n    address: string,\n    options?: {\n        pagination?: PaginationArguments<string>;\n        personalKioskType: string;\n    },\n): Promise<OwnedKiosks> {\n    if (!isValidIotaAddress(address))\n        return {\n            nextCursor: null,\n            hasNextPage: false,\n            kioskOwnerCaps: [],\n            kioskIds: [],\n        };\n\n    const filter: IotaObjectDataFilter = {\n        MatchAny: [\n            {\n                StructType: KIOSK_OWNER_CAP,\n            },\n        ],\n    };\n\n    if (options?.personalKioskType) {\n        filter.MatchAny.push({\n            StructType: options.personalKioskType,\n        });\n    }\n\n    // fetch owned kiosk caps, paginated.\n    const { data, hasNextPage, nextCursor } = await client.getOwnedObjects({\n        owner: address,\n        filter,\n        options: {\n            showContent: true,\n            showType: true,\n        },\n        ...(options?.pagination || {}),\n    });\n\n    // get kioskIds from the OwnerCaps.\n    const kioskIdList = data?.map((x: IotaObjectResponse) => {\n        const fields = x.data?.content?.dataType === 'moveObject' ? x.data.content.fields : null;\n        // @ts-expect-error TODO: should i remove ts ignore here?\n        return (fields?.cap ? fields?.cap?.fields?.for : fields?.for) as string;\n        // return (fields as { for: string })?.for;\n    });\n\n    // clean up data that might have an error in them.\n    // only return valid objects.\n    const filteredData = data.filter((x) => 'data' in x).map((x) => x.data) as IotaObjectData[];\n\n    return {\n        nextCursor,\n        hasNextPage,\n        kioskOwnerCaps: filteredData.map((x, idx) => ({\n            isPersonal: x.type !== KIOSK_OWNER_CAP,\n            digest: x.digest,\n            version: x.version,\n            objectId: x.objectId,\n            kioskId: kioskIdList[idx],\n        })),\n        kioskIds: kioskIdList,\n    };\n}\n\n// Get a kiosk extension data for a given kioskId and extensionType.\nexport async function fetchKioskExtension(\n    client: IotaClient,\n    kioskId: string,\n    extensionType: string,\n): Promise<KioskExtension | null> {\n    const extension = await client.getDynamicFieldObject({\n        parentId: kioskId,\n        name: {\n            type: `0x2::kiosk_extension::ExtensionKey<${extensionType}>`,\n            value: {\n                dummy_field: false,\n            },\n        },\n    });\n\n    if (!extension.data) return null;\n\n    const fields = (extension?.data?.content as { fields: { [k: string]: any } })?.fields?.value\n        ?.fields;\n\n    return {\n        objectId: extension.data.objectId,\n        type: extensionType,\n        isEnabled: fields?.is_enabled,\n        permissions: fields?.permissions,\n        storageId: fields?.storage?.fields?.id?.id,\n        storageSize: fields?.storage?.fields?.size,\n    };\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAWA,mBAAmC;AASnC,mBAAgC;AAChC,IAAAA,gBAQO;AAEP,eAAsB,WAClB,QACA,SACA,YACA,SACuB;AAKvB,QAAM,OAAO,UAAM,mCAAoB,QAAQ,SAAS,UAAU;AAElE,QAAM,WAA2B,CAAC;AAClC,QAAM,gBAA0B,CAAC;AAGjC,QAAM,gBAAY,gCAAiB,MAAM,UAAU,eAAe,OAAO;AAKzE,QAAM,CAAC,OAAO,gBAAgB,KAAK,IAAI,MAAM,QAAQ,IAAI;AAAA,IACrD,QAAQ,sBAAkB,8BAAe,QAAQ,OAAO,IAAI,QAAQ,QAAQ,MAAS;AAAA,IACrF,QAAQ,wBACF,6BAAc,QAAQ,UAAU,YAAY;AAAA,MACxC,aAAa;AAAA,IACjB,CAAC,IACD,QAAQ,QAAQ,CAAC,CAAC;AAAA,IACxB,QAAQ,kBACF;AAAA,MACI;AAAA,MACA,UAAU;AAAA,MACV,QAAQ,iBAAiB,EAAE,aAAa,KAAK;AAAA,IACjD,IACA,QAAQ,QAAQ,CAAC,CAAC;AAAA,EAC5B,CAAC;AAED,MAAI,QAAQ;AAAiB,cAAU,QAAQ;AAE/C,6CAAwB,WAAW,UAAU,cAAc;AAE3D,uCAAkB,WAAW,aAAa;AAG1C;AAAA,IACI;AAAA,IACA,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAK;AAAA,EACpD;AAEA,SAAO;AAAA,IACH,MAAM;AAAA,IACN,YAAY;AAAA,IACZ,aAAa;AAAA,EACjB;AACJ;AAQA,eAAsB,eAClB,QACA,SACA,SAIoB;AACpB,MAAI,KAAC,iCAAmB,OAAO;AAC3B,WAAO;AAAA,MACH,YAAY;AAAA,MACZ,aAAa;AAAA,MACb,gBAAgB,CAAC;AAAA,MACjB,UAAU,CAAC;AAAA,IACf;AAEJ,QAAM,SAA+B;AAAA,IACjC,UAAU;AAAA,MACN;AAAA,QACI,YAAY;AAAA,MAChB;AAAA,IACJ;AAAA,EACJ;AAEA,MAAI,SAAS,mBAAmB;AAC5B,WAAO,SAAS,KAAK;AAAA,MACjB,YAAY,QAAQ;AAAA,IACxB,CAAC;AAAA,EACL;AAGA,QAAM,EAAE,MAAM,aAAa,WAAW,IAAI,MAAM,OAAO,gBAAgB;AAAA,IACnE,OAAO;AAAA,IACP;AAAA,IACA,SAAS;AAAA,MACL,aAAa;AAAA,MACb,UAAU;AAAA,IACd;AAAA,IACA,GAAI,SAAS,cAAc,CAAC;AAAA,EAChC,CAAC;AAGD,QAAM,cAAc,MAAM,IAAI,CAAC,MAA0B;AACrD,UAAM,SAAS,EAAE,MAAM,SAAS,aAAa,eAAe,EAAE,KAAK,QAAQ,SAAS;AAEpF,WAAQ,QAAQ,MAAM,QAAQ,KAAK,QAAQ,MAAM,QAAQ;AAAA,EAE7D,CAAC;AAID,QAAM,eAAe,KAAK,OAAO,CAAC,MAAM,UAAU,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI;AAEtE,SAAO;AAAA,IACH;AAAA,IACA;AAAA,IACA,gBAAgB,aAAa,IAAI,CAAC,GAAG,SAAS;AAAA,MAC1C,YAAY,EAAE,SAAS;AAAA,MACvB,QAAQ,EAAE;AAAA,MACV,SAAS,EAAE;AAAA,MACX,UAAU,EAAE;AAAA,MACZ,SAAS,YAAY,GAAG;AAAA,IAC5B,EAAE;AAAA,IACF,UAAU;AAAA,EACd;AACJ;AAGA,eAAsB,oBAClB,QACA,SACA,eAC8B;AAC9B,QAAM,YAAY,MAAM,OAAO,sBAAsB;AAAA,IACjD,UAAU;AAAA,IACV,MAAM;AAAA,MACF,MAAM,sCAAsC;AAAA,MAC5C,OAAO;AAAA,QACH,aAAa;AAAA,MACjB;AAAA,IACJ;AAAA,EACJ,CAAC;AAED,MAAI,CAAC,UAAU;AAAM,WAAO;AAE5B,QAAM,SAAU,WAAW,MAAM,SAA8C,QAAQ,OACjF;AAEN,SAAO;AAAA,IACH,UAAU,UAAU,KAAK;AAAA,IACzB,MAAM;AAAA,IACN,WAAW,QAAQ;AAAA,IACnB,aAAa,QAAQ;AAAA,IACrB,WAAW,QAAQ,SAAS,QAAQ,IAAI;AAAA,IACxC,aAAa,QAAQ,SAAS,QAAQ;AAAA,EAC1C;AACJ;",
+  "names": ["import_utils"]
+}

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

@@ -0,0 +1,28 @@
+import type { IotaClient } from '@iota/iota-sdk/client';
+import type { TransferPolicy, TransferPolicyCap } from '../types/index.js';
+/**
+ * Searches the `TransferPolicy`-s for the given type. The search is performed via
+ * the `TransferPolicyCreated` event. The policy can either be owned or shared,
+ * and the caller needs to filter the results accordingly (ie single owner can not
+ * be accessed by anyone but the owner).
+ *
+ * @param provider
+ * @param type
+ */
+export declare function queryTransferPolicy(client: IotaClient, type: string): Promise<TransferPolicy[]>;
+/**
+ * A function to fetch all the user's kiosk Caps
+ * And a list of the kiosk address ids.
+ * Returns a list of `kioskOwnerCapIds` and `kioskIds`.
+ * Extra options allow pagination.
+ * @returns TransferPolicyCap Object ID | undefined if not found.
+ */
+export declare function queryTransferPolicyCapsByType(client: IotaClient, address: string, type: string): Promise<TransferPolicyCap[]>;
+/**
+ * A function to fetch all the user's kiosk Caps
+ * And a list of the kiosk address ids.
+ * Returns a list of `kioskOwnerCapIds` and `kioskIds`.
+ * Extra options allow pagination.
+ * @returns TransferPolicyCap Object ID | undefined if not found.
+ */
+export declare function queryOwnedTransferPolicies(client: IotaClient, address: string): Promise<TransferPolicyCap[] | undefined>;

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

@@ -0,0 +1,96 @@
+"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, {
+  queryOwnedTransferPolicies: () => queryOwnedTransferPolicies,
+  queryTransferPolicy: () => queryTransferPolicy,
+  queryTransferPolicyCapsByType: () => queryTransferPolicyCapsByType
+});
+module.exports = __toCommonJS(transfer_policy_exports);
+var import_utils = require("@iota/iota-sdk/utils");
+var import_bcs = require("../bcs.js");
+var import_types = require("../types/index.js");
+var import_utils2 = require("../utils.js");
+async function queryTransferPolicy(client, type) {
+  const { data } = await client.queryEvents({
+    query: {
+      MoveEventType: `${import_types.TRANSFER_POLICY_CREATED_EVENT}<${type}>`
+    }
+  });
+  const search = data.map((event) => event.parsedJson);
+  const policies = await client.multiGetObjects({
+    ids: search.map((policy) => policy.id),
+    options: { showBcs: true, showOwner: true }
+  });
+  return policies.filter((policy) => !!policy && "data" in policy).map(({ data: policy }) => {
+    if (!policy || !policy.bcs || !("bcsBytes" in policy.bcs)) {
+      throw new Error(
+        `Invalid policy: ${policy?.objectId}, expected object, got package`
+      );
+    }
+    const parsed = import_bcs.bcs.de(import_types.TRANSFER_POLICY_TYPE, policy.bcs.bcsBytes, "base64");
+    return {
+      id: policy?.objectId,
+      type: `${import_types.TRANSFER_POLICY_TYPE}<${type}>`,
+      owner: policy?.owner,
+      rules: parsed.rules,
+      balance: parsed.balance
+    };
+  });
+}
+async function queryTransferPolicyCapsByType(client, address, type) {
+  if (!(0, import_utils.isValidIotaAddress)(address))
+    return [];
+  const filter = {
+    MatchAll: [
+      {
+        StructType: `${import_types.TRANSFER_POLICY_CAP_TYPE}<${type}>`
+      }
+    ]
+  };
+  const data = await (0, import_utils2.getAllOwnedObjects)({
+    client,
+    filter,
+    owner: address
+  });
+  return data.map((item) => (0, import_utils2.parseTransferPolicyCapObject)(item)).filter((item) => !!item);
+}
+async function queryOwnedTransferPolicies(client, address) {
+  if (!(0, import_utils.isValidIotaAddress)(address))
+    return;
+  const filter = {
+    MatchAll: [
+      {
+        MoveModule: {
+          module: "transfer_policy",
+          package: "0x2"
+        }
+      }
+    ]
+  };
+  const data = await (0, import_utils2.getAllOwnedObjects)({ client, owner: address, filter });
+  const policies = [];
+  for (const item of data) {
+    const data2 = (0, import_utils2.parseTransferPolicyCapObject)(item);
+    if (data2)
+      policies.push(data2);
+  }
+  return policies;
+}
+//# sourceMappingURL=transfer-policy.js.map

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

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/query/transfer-policy.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// Modifications Copyright (c) 2024 IOTA Stiftung\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { IotaClient } from '@iota/iota-sdk/client';\nimport { isValidIotaAddress } from '@iota/iota-sdk/utils';\n\nimport { bcs } from '../bcs.js';\nimport type { TransferPolicy, TransferPolicyCap } from '../types/index.js';\nimport {\n    TRANSFER_POLICY_CAP_TYPE,\n    TRANSFER_POLICY_CREATED_EVENT,\n    TRANSFER_POLICY_TYPE,\n} from '../types/index.js';\nimport { getAllOwnedObjects, parseTransferPolicyCapObject } from '../utils.js';\n\n/**\n * Searches the `TransferPolicy`-s for the given type. The search is performed via\n * the `TransferPolicyCreated` event. The policy can either be owned or shared,\n * and the caller needs to filter the results accordingly (ie single owner can not\n * be accessed by anyone but the owner).\n *\n * @param provider\n * @param type\n */\nexport async function queryTransferPolicy(\n    client: IotaClient,\n    type: string,\n): Promise<TransferPolicy[]> {\n    // console.log('event type: %s', `${TRANSFER_POLICY_CREATED_EVENT}<${type}>`);\n    const { data } = await client.queryEvents({\n        query: {\n            MoveEventType: `${TRANSFER_POLICY_CREATED_EVENT}<${type}>`,\n        },\n    });\n\n    const search = data.map((event) => event.parsedJson as { id: string });\n    const policies = await client.multiGetObjects({\n        ids: search.map((policy) => policy.id),\n        options: { showBcs: true, showOwner: true },\n    });\n\n    return policies\n        .filter((policy) => !!policy && 'data' in policy)\n        .map(({ data: policy }) => {\n            // should never happen; policies are objects and fetched via an event.\n            // policies are filtered for null and undefined above.\n            if (!policy || !policy.bcs || !('bcsBytes' in policy.bcs)) {\n                throw new Error(\n                    `Invalid policy: ${policy?.objectId}, expected object, got package`,\n                );\n            }\n\n            const parsed = bcs.de(TRANSFER_POLICY_TYPE, policy.bcs.bcsBytes, 'base64');\n\n            return {\n                id: policy?.objectId,\n                type: `${TRANSFER_POLICY_TYPE}<${type}>`,\n                owner: policy?.owner,\n                rules: parsed.rules,\n                balance: parsed.balance,\n            } as TransferPolicy;\n        });\n}\n\n/**\n * A function to fetch all the user's kiosk Caps\n * And a list of the kiosk address ids.\n * Returns a list of `kioskOwnerCapIds` and `kioskIds`.\n * Extra options allow pagination.\n * @returns TransferPolicyCap Object ID | undefined if not found.\n */\nexport async function queryTransferPolicyCapsByType(\n    client: IotaClient,\n    address: string,\n    type: string,\n): Promise<TransferPolicyCap[]> {\n    if (!isValidIotaAddress(address)) return [];\n\n    const filter = {\n        MatchAll: [\n            {\n                StructType: `${TRANSFER_POLICY_CAP_TYPE}<${type}>`,\n            },\n        ],\n    };\n\n    // fetch owned kiosk caps, paginated.\n    const data = await getAllOwnedObjects({\n        client,\n        filter,\n        owner: address,\n    });\n\n    return data\n        .map((item) => parseTransferPolicyCapObject(item))\n        .filter((item) => !!item) as TransferPolicyCap[];\n}\n\n/**\n * A function to fetch all the user's kiosk Caps\n * And a list of the kiosk address ids.\n * Returns a list of `kioskOwnerCapIds` and `kioskIds`.\n * Extra options allow pagination.\n * @returns TransferPolicyCap Object ID | undefined if not found.\n */\nexport async function queryOwnedTransferPolicies(\n    client: IotaClient,\n    address: string,\n): Promise<TransferPolicyCap[] | undefined> {\n    if (!isValidIotaAddress(address)) return;\n\n    const filter = {\n        MatchAll: [\n            {\n                MoveModule: {\n                    module: 'transfer_policy',\n                    package: '0x2',\n                },\n            },\n        ],\n    };\n\n    // fetch all owned kiosk caps, paginated.\n    const data = await getAllOwnedObjects({ client, owner: address, filter });\n\n    const policies: TransferPolicyCap[] = [];\n\n    for (const item of data) {\n        const data = parseTransferPolicyCapObject(item);\n        if (data) policies.push(data);\n    }\n\n    return policies;\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAKA,mBAAmC;AAEnC,iBAAoB;AAEpB,mBAIO;AACP,IAAAA,gBAAiE;AAWjE,eAAsB,oBAClB,QACA,MACyB;AAEzB,QAAM,EAAE,KAAK,IAAI,MAAM,OAAO,YAAY;AAAA,IACtC,OAAO;AAAA,MACH,eAAe,GAAG,8CAAiC;AAAA,IACvD;AAAA,EACJ,CAAC;AAED,QAAM,SAAS,KAAK,IAAI,CAAC,UAAU,MAAM,UAA4B;AACrE,QAAM,WAAW,MAAM,OAAO,gBAAgB;AAAA,IAC1C,KAAK,OAAO,IAAI,CAAC,WAAW,OAAO,EAAE;AAAA,IACrC,SAAS,EAAE,SAAS,MAAM,WAAW,KAAK;AAAA,EAC9C,CAAC;AAED,SAAO,SACF,OAAO,CAAC,WAAW,CAAC,CAAC,UAAU,UAAU,MAAM,EAC/C,IAAI,CAAC,EAAE,MAAM,OAAO,MAAM;AAGvB,QAAI,CAAC,UAAU,CAAC,OAAO,OAAO,EAAE,cAAc,OAAO,MAAM;AACvD,YAAM,IAAI;AAAA,QACN,mBAAmB,QAAQ;AAAA,MAC/B;AAAA,IACJ;AAEA,UAAM,SAAS,eAAI,GAAG,mCAAsB,OAAO,IAAI,UAAU,QAAQ;AAEzE,WAAO;AAAA,MACH,IAAI,QAAQ;AAAA,MACZ,MAAM,GAAG,qCAAwB;AAAA,MACjC,OAAO,QAAQ;AAAA,MACf,OAAO,OAAO;AAAA,MACd,SAAS,OAAO;AAAA,IACpB;AAAA,EACJ,CAAC;AACT;AASA,eAAsB,8BAClB,QACA,SACA,MAC4B;AAC5B,MAAI,KAAC,iCAAmB,OAAO;AAAG,WAAO,CAAC;AAE1C,QAAM,SAAS;AAAA,IACX,UAAU;AAAA,MACN;AAAA,QACI,YAAY,GAAG,yCAA4B;AAAA,MAC/C;AAAA,IACJ;AAAA,EACJ;AAGA,QAAM,OAAO,UAAM,kCAAmB;AAAA,IAClC;AAAA,IACA;AAAA,IACA,OAAO;AAAA,EACX,CAAC;AAED,SAAO,KACF,IAAI,CAAC,aAAS,4CAA6B,IAAI,CAAC,EAChD,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI;AAChC;AASA,eAAsB,2BAClB,QACA,SACwC;AACxC,MAAI,KAAC,iCAAmB,OAAO;AAAG;AAElC,QAAM,SAAS;AAAA,IACX,UAAU;AAAA,MACN;AAAA,QACI,YAAY;AAAA,UACR,QAAQ;AAAA,UACR,SAAS;AAAA,QACb;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AAGA,QAAM,OAAO,UAAM,kCAAmB,EAAE,QAAQ,OAAO,SAAS,OAAO,CAAC;AAExE,QAAM,WAAgC,CAAC;AAEvC,aAAW,QAAQ,MAAM;AACrB,UAAMC,YAAO,4CAA6B,IAAI;AAC9C,QAAIA;AAAM,eAAS,KAAKA,KAAI;AAAA,EAChC;AAEA,SAAO;AACX;",
+  "names": ["import_utils", "data"]
+}

package/dist/cjs/tx/kiosk.d.ts

@@ -0,0 +1,71 @@
+import type { TransactionArgument, TransactionBlock, TransactionObjectArgument } from '@iota/iota-sdk/transactions';
+import type { ObjectArgument } from '../types/index.js';
+/**
+ * Create a new shared Kiosk and returns the [kiosk, kioskOwnerCap] tuple.
+ */
+export declare function createKiosk(tx: TransactionBlock): [TransactionObjectArgument, TransactionObjectArgument];
+/**
+ * Calls the `kiosk::new()` function and shares the kiosk.
+ * Returns the `kioskOwnerCap` object.
+ */
+export declare function createKioskAndShare(tx: TransactionBlock): TransactionObjectArgument;
+/**
+ * Converts Transfer Policy to a shared object.
+ */
+export declare function shareKiosk(tx: TransactionBlock, kiosk: TransactionArgument): void;
+/**
+ * Call the `kiosk::place<T>(Kiosk, KioskOwnerCap, Item)` function.
+ * Place an item to the Kiosk.
+ */
+export declare function place(tx: TransactionBlock, itemType: string, kiosk: ObjectArgument, kioskCap: ObjectArgument, item: ObjectArgument): void;
+/**
+ * Call the `kiosk::lock<T>(Kiosk, KioskOwnerCap, TransferPolicy, Item)`
+ * function. Lock an item in the Kiosk.
+ *
+ * Unlike `place` this function requires a `TransferPolicy` to exist
+ * and be passed in. This is done to make sure the item does not get
+ * locked without an option to take it out.
+ */
+export declare function lock(tx: TransactionBlock, itemType: string, kiosk: ObjectArgument, kioskCap: ObjectArgument, policy: ObjectArgument, item: ObjectArgument): void;
+/**
+ * Call the `kiosk::take<T>(Kiosk, KioskOwnerCap, ID)` function.
+ * Take an item from the Kiosk.
+ */
+export declare function take(tx: TransactionBlock, itemType: string, kiosk: ObjectArgument, kioskCap: ObjectArgument, itemId: string): TransactionObjectArgument;
+/**
+ * Call the `kiosk::list<T>(Kiosk, KioskOwnerCap, ID, u64)` function.
+ * List an item for sale.
+ */
+export declare function list(tx: TransactionBlock, itemType: string, kiosk: ObjectArgument, kioskCap: ObjectArgument, itemId: string, price: string | bigint): void;
+/**
+ * Call the `kiosk::list<T>(Kiosk, KioskOwnerCap, ID, u64)` function.
+ * List an item for sale.
+ */
+export declare function delist(tx: TransactionBlock, itemType: string, kiosk: ObjectArgument, kioskCap: ObjectArgument, itemId: string): void;
+/**
+ * Call the `kiosk::place_and_list<T>(Kiosk, KioskOwnerCap, Item, u64)` function.
+ * Place an item to the Kiosk and list it for sale.
+ */
+export declare function placeAndList(tx: TransactionBlock, itemType: string, kiosk: ObjectArgument, kioskCap: ObjectArgument, item: ObjectArgument, price: string | bigint): void;
+/**
+ * Call the `kiosk::purchase<T>(Kiosk, ID, Coin<IOTA>)` function and receive an Item and
+ * a TransferRequest which needs to be dealt with (via a matching TransferPolicy).
+ */
+export declare function purchase(tx: TransactionBlock, itemType: string, kiosk: ObjectArgument, itemId: string, payment: ObjectArgument): [TransactionObjectArgument, TransactionObjectArgument];
+/**
+ * Call the `kiosk::withdraw(Kiosk, KioskOwnerCap, Option<u64>)` function and receive a Coin<IOTA>.
+ * If the amount is null, then the entire balance will be withdrawn.
+ */
+export declare function withdrawFromKiosk(tx: TransactionBlock, kiosk: ObjectArgument, kioskCap: ObjectArgument, amount?: string | bigint | number): TransactionObjectArgument;
+/**
+ * Call the `kiosk::borrow_value<T>(Kiosk, KioskOwnerCap, ID): T` function.
+ * Immutably borrow an item from the Kiosk and return it in the end.
+ *
+ * Requires calling `returnValue` to return the item.
+ */
+export declare function borrowValue(tx: TransactionBlock, itemType: string, kiosk: ObjectArgument, kioskCap: ObjectArgument, itemId: string): [TransactionArgument, TransactionArgument];
+/**
+ * Call the `kiosk::return_value<T>(Kiosk, Item, Borrow)` function.
+ * Return an item to the Kiosk after it was `borrowValue`-d.
+ */
+export declare function returnValue(tx: TransactionBlock, itemType: string, kiosk: ObjectArgument, item: TransactionArgument, promise: TransactionArgument): void;

package/dist/cjs/tx/kiosk.js

@@ -0,0 +1,130 @@
+"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 kiosk_exports = {};
+__export(kiosk_exports, {
+  borrowValue: () => borrowValue,
+  createKiosk: () => createKiosk,
+  createKioskAndShare: () => createKioskAndShare,
+  delist: () => delist,
+  list: () => list,
+  lock: () => lock,
+  place: () => place,
+  placeAndList: () => placeAndList,
+  purchase: () => purchase,
+  returnValue: () => returnValue,
+  shareKiosk: () => shareKiosk,
+  take: () => take,
+  withdrawFromKiosk: () => withdrawFromKiosk
+});
+module.exports = __toCommonJS(kiosk_exports);
+var import_bcs = require("@iota/iota-sdk/bcs");
+var import_types = require("../types/index.js");
+function createKiosk(tx) {
+  const [kiosk, kioskOwnerCap] = tx.moveCall({
+    target: `${import_types.KIOSK_MODULE}::new`
+  });
+  return [kiosk, kioskOwnerCap];
+}
+function createKioskAndShare(tx) {
+  const [kiosk, kioskOwnerCap] = createKiosk(tx);
+  shareKiosk(tx, kiosk);
+  return kioskOwnerCap;
+}
+function shareKiosk(tx, kiosk) {
+  tx.moveCall({
+    target: `0x2::transfer::public_share_object`,
+    typeArguments: [import_types.KIOSK_TYPE],
+    arguments: [kiosk]
+  });
+}
+function place(tx, itemType, kiosk, kioskCap, item) {
+  tx.moveCall({
+    target: `${import_types.KIOSK_MODULE}::place`,
+    typeArguments: [itemType],
+    arguments: [tx.object(kiosk), tx.object(kioskCap), tx.object(item)]
+  });
+}
+function lock(tx, itemType, kiosk, kioskCap, policy, item) {
+  tx.moveCall({
+    target: `${import_types.KIOSK_MODULE}::lock`,
+    typeArguments: [itemType],
+    arguments: [tx.object(kiosk), tx.object(kioskCap), tx.object(policy), tx.object(item)]
+  });
+}
+function take(tx, itemType, kiosk, kioskCap, itemId) {
+  const [item] = tx.moveCall({
+    target: `${import_types.KIOSK_MODULE}::take`,
+    typeArguments: [itemType],
+    arguments: [tx.object(kiosk), tx.object(kioskCap), tx.pure.id(itemId)]
+  });
+  return item;
+}
+function list(tx, itemType, kiosk, kioskCap, itemId, price) {
+  tx.moveCall({
+    target: `${import_types.KIOSK_MODULE}::list`,
+    typeArguments: [itemType],
+    arguments: [tx.object(kiosk), tx.object(kioskCap), tx.pure.id(itemId), tx.pure.u64(price)]
+  });
+}
+function delist(tx, itemType, kiosk, kioskCap, itemId) {
+  tx.moveCall({
+    target: `${import_types.KIOSK_MODULE}::delist`,
+    typeArguments: [itemType],
+    arguments: [tx.object(kiosk), tx.object(kioskCap), tx.pure.id(itemId)]
+  });
+}
+function placeAndList(tx, itemType, kiosk, kioskCap, item, price) {
+  tx.moveCall({
+    target: `${import_types.KIOSK_MODULE}::place_and_list`,
+    typeArguments: [itemType],
+    arguments: [tx.object(kiosk), tx.object(kioskCap), tx.object(item), tx.pure.u64(price)]
+  });
+}
+function purchase(tx, itemType, kiosk, itemId, payment) {
+  const [item, transferRequest] = tx.moveCall({
+    target: `${import_types.KIOSK_MODULE}::purchase`,
+    typeArguments: [itemType],
+    arguments: [tx.object(kiosk), tx.pure.id(itemId), tx.object(payment)]
+  });
+  return [item, transferRequest];
+}
+function withdrawFromKiosk(tx, kiosk, kioskCap, amount) {
+  const amountArg = import_bcs.bcs.option(import_bcs.bcs.u64()).serialize(amount);
+  const [coin] = tx.moveCall({
+    target: `${import_types.KIOSK_MODULE}::withdraw`,
+    arguments: [tx.object(kiosk), tx.object(kioskCap), amountArg]
+  });
+  return coin;
+}
+function borrowValue(tx, itemType, kiosk, kioskCap, itemId) {
+  const [item, promise] = tx.moveCall({
+    target: `${import_types.KIOSK_MODULE}::borrow_val`,
+    typeArguments: [itemType],
+    arguments: [tx.object(kiosk), tx.object(kioskCap), tx.pure.id(itemId)]
+  });
+  return [item, promise];
+}
+function returnValue(tx, itemType, kiosk, item, promise) {
+  tx.moveCall({
+    target: `${import_types.KIOSK_MODULE}::return_val`,
+    typeArguments: [itemType],
+    arguments: [tx.object(kiosk), item, promise]
+  });
+}
+//# sourceMappingURL=kiosk.js.map

package/dist/cjs/tx/kiosk.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/tx/kiosk.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';\nimport type {\n    TransactionArgument,\n    TransactionBlock,\n    TransactionObjectArgument,\n} from '@iota/iota-sdk/transactions';\n\nimport type { ObjectArgument } from '../types/index.js';\nimport { KIOSK_MODULE, KIOSK_TYPE } from '../types/index.js';\n\n/**\n * Create a new shared Kiosk and returns the [kiosk, kioskOwnerCap] tuple.\n */\nexport function createKiosk(\n    tx: TransactionBlock,\n): [TransactionObjectArgument, TransactionObjectArgument] {\n    const [kiosk, kioskOwnerCap] = tx.moveCall({\n        target: `${KIOSK_MODULE}::new`,\n    });\n\n    return [kiosk, kioskOwnerCap];\n}\n\n/**\n * Calls the `kiosk::new()` function and shares the kiosk.\n * Returns the `kioskOwnerCap` object.\n */\nexport function createKioskAndShare(tx: TransactionBlock): TransactionObjectArgument {\n    const [kiosk, kioskOwnerCap] = createKiosk(tx);\n    shareKiosk(tx, kiosk);\n    return kioskOwnerCap;\n}\n\n/**\n * Converts Transfer Policy to a shared object.\n */\nexport function shareKiosk(tx: TransactionBlock, kiosk: TransactionArgument) {\n    tx.moveCall({\n        target: `0x2::transfer::public_share_object`,\n        typeArguments: [KIOSK_TYPE],\n        arguments: [kiosk],\n    });\n}\n\n/**\n * Call the `kiosk::place<T>(Kiosk, KioskOwnerCap, Item)` function.\n * Place an item to the Kiosk.\n */\nexport function place(\n    tx: TransactionBlock,\n    itemType: string,\n    kiosk: ObjectArgument,\n    kioskCap: ObjectArgument,\n    item: ObjectArgument,\n): void {\n    tx.moveCall({\n        target: `${KIOSK_MODULE}::place`,\n        typeArguments: [itemType],\n        arguments: [tx.object(kiosk), tx.object(kioskCap), tx.object(item)],\n    });\n}\n\n/**\n * Call the `kiosk::lock<T>(Kiosk, KioskOwnerCap, TransferPolicy, Item)`\n * function. Lock an item in the Kiosk.\n *\n * Unlike `place` this function requires a `TransferPolicy` to exist\n * and be passed in. This is done to make sure the item does not get\n * locked without an option to take it out.\n */\nexport function lock(\n    tx: TransactionBlock,\n    itemType: string,\n    kiosk: ObjectArgument,\n    kioskCap: ObjectArgument,\n    policy: ObjectArgument,\n    item: ObjectArgument,\n): void {\n    tx.moveCall({\n        target: `${KIOSK_MODULE}::lock`,\n        typeArguments: [itemType],\n        arguments: [tx.object(kiosk), tx.object(kioskCap), tx.object(policy), tx.object(item)],\n    });\n}\n\n/**\n * Call the `kiosk::take<T>(Kiosk, KioskOwnerCap, ID)` function.\n * Take an item from the Kiosk.\n */\nexport function take(\n    tx: TransactionBlock,\n    itemType: string,\n    kiosk: ObjectArgument,\n    kioskCap: ObjectArgument,\n    itemId: string,\n): TransactionObjectArgument {\n    const [item] = tx.moveCall({\n        target: `${KIOSK_MODULE}::take`,\n        typeArguments: [itemType],\n        arguments: [tx.object(kiosk), tx.object(kioskCap), tx.pure.id(itemId)],\n    });\n\n    return item;\n}\n\n/**\n * Call the `kiosk::list<T>(Kiosk, KioskOwnerCap, ID, u64)` function.\n * List an item for sale.\n */\nexport function list(\n    tx: TransactionBlock,\n    itemType: string,\n    kiosk: ObjectArgument,\n    kioskCap: ObjectArgument,\n    itemId: string,\n    price: string | bigint,\n): void {\n    tx.moveCall({\n        target: `${KIOSK_MODULE}::list`,\n        typeArguments: [itemType],\n        arguments: [tx.object(kiosk), tx.object(kioskCap), tx.pure.id(itemId), tx.pure.u64(price)],\n    });\n}\n\n/**\n * Call the `kiosk::list<T>(Kiosk, KioskOwnerCap, ID, u64)` function.\n * List an item for sale.\n */\nexport function delist(\n    tx: TransactionBlock,\n    itemType: string,\n    kiosk: ObjectArgument,\n    kioskCap: ObjectArgument,\n    itemId: string,\n): void {\n    tx.moveCall({\n        target: `${KIOSK_MODULE}::delist`,\n        typeArguments: [itemType],\n        arguments: [tx.object(kiosk), tx.object(kioskCap), tx.pure.id(itemId)],\n    });\n}\n\n/**\n * Call the `kiosk::place_and_list<T>(Kiosk, KioskOwnerCap, Item, u64)` function.\n * Place an item to the Kiosk and list it for sale.\n */\nexport function placeAndList(\n    tx: TransactionBlock,\n    itemType: string,\n    kiosk: ObjectArgument,\n    kioskCap: ObjectArgument,\n    item: ObjectArgument,\n    price: string | bigint,\n): void {\n    tx.moveCall({\n        target: `${KIOSK_MODULE}::place_and_list`,\n        typeArguments: [itemType],\n        arguments: [tx.object(kiosk), tx.object(kioskCap), tx.object(item), tx.pure.u64(price)],\n    });\n}\n\n/**\n * Call the `kiosk::purchase<T>(Kiosk, ID, Coin<IOTA>)` function and receive an Item and\n * a TransferRequest which needs to be dealt with (via a matching TransferPolicy).\n */\nexport function purchase(\n    tx: TransactionBlock,\n    itemType: string,\n    kiosk: ObjectArgument,\n    itemId: string,\n    payment: ObjectArgument,\n): [TransactionObjectArgument, TransactionObjectArgument] {\n    const [item, transferRequest] = tx.moveCall({\n        target: `${KIOSK_MODULE}::purchase`,\n        typeArguments: [itemType],\n        arguments: [tx.object(kiosk), tx.pure.id(itemId), tx.object(payment)],\n    });\n\n    return [item, transferRequest];\n}\n\n/**\n * Call the `kiosk::withdraw(Kiosk, KioskOwnerCap, Option<u64>)` function and receive a Coin<IOTA>.\n * If the amount is null, then the entire balance will be withdrawn.\n */\nexport function withdrawFromKiosk(\n    tx: TransactionBlock,\n    kiosk: ObjectArgument,\n    kioskCap: ObjectArgument,\n    amount?: string | bigint | number,\n): TransactionObjectArgument {\n    const amountArg = bcs.option(bcs.u64()).serialize(amount);\n\n    const [coin] = tx.moveCall({\n        target: `${KIOSK_MODULE}::withdraw`,\n        arguments: [tx.object(kiosk), tx.object(kioskCap), amountArg],\n    });\n\n    return coin;\n}\n\n/**\n * Call the `kiosk::borrow_value<T>(Kiosk, KioskOwnerCap, ID): T` function.\n * Immutably borrow an item from the Kiosk and return it in the end.\n *\n * Requires calling `returnValue` to return the item.\n */\nexport function borrowValue(\n    tx: TransactionBlock,\n    itemType: string,\n    kiosk: ObjectArgument,\n    kioskCap: ObjectArgument,\n    itemId: string,\n): [TransactionArgument, TransactionArgument] {\n    const [item, promise] = tx.moveCall({\n        target: `${KIOSK_MODULE}::borrow_val`,\n        typeArguments: [itemType],\n        arguments: [tx.object(kiosk), tx.object(kioskCap), tx.pure.id(itemId)],\n    });\n\n    return [item, promise];\n}\n\n/**\n * Call the `kiosk::return_value<T>(Kiosk, Item, Borrow)` function.\n * Return an item to the Kiosk after it was `borrowValue`-d.\n */\nexport function returnValue(\n    tx: TransactionBlock,\n    itemType: string,\n    kiosk: ObjectArgument,\n    item: TransactionArgument,\n    promise: TransactionArgument,\n): void {\n    tx.moveCall({\n        target: `${KIOSK_MODULE}::return_val`,\n        typeArguments: [itemType],\n        arguments: [tx.object(kiosk), item, promise],\n    });\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAIA,iBAAoB;AAQpB,mBAAyC;AAKlC,SAAS,YACZ,IACsD;AACtD,QAAM,CAAC,OAAO,aAAa,IAAI,GAAG,SAAS;AAAA,IACvC,QAAQ,GAAG;AAAA,EACf,CAAC;AAED,SAAO,CAAC,OAAO,aAAa;AAChC;AAMO,SAAS,oBAAoB,IAAiD;AACjF,QAAM,CAAC,OAAO,aAAa,IAAI,YAAY,EAAE;AAC7C,aAAW,IAAI,KAAK;AACpB,SAAO;AACX;AAKO,SAAS,WAAW,IAAsB,OAA4B;AACzE,KAAG,SAAS;AAAA,IACR,QAAQ;AAAA,IACR,eAAe,CAAC,uBAAU;AAAA,IAC1B,WAAW,CAAC,KAAK;AAAA,EACrB,CAAC;AACL;AAMO,SAAS,MACZ,IACA,UACA,OACA,UACA,MACI;AACJ,KAAG,SAAS;AAAA,IACR,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,GAAG,OAAO,KAAK,GAAG,GAAG,OAAO,QAAQ,GAAG,GAAG,OAAO,IAAI,CAAC;AAAA,EACtE,CAAC;AACL;AAUO,SAAS,KACZ,IACA,UACA,OACA,UACA,QACA,MACI;AACJ,KAAG,SAAS;AAAA,IACR,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,GAAG,OAAO,KAAK,GAAG,GAAG,OAAO,QAAQ,GAAG,GAAG,OAAO,MAAM,GAAG,GAAG,OAAO,IAAI,CAAC;AAAA,EACzF,CAAC;AACL;AAMO,SAAS,KACZ,IACA,UACA,OACA,UACA,QACyB;AACzB,QAAM,CAAC,IAAI,IAAI,GAAG,SAAS;AAAA,IACvB,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,GAAG,OAAO,KAAK,GAAG,GAAG,OAAO,QAAQ,GAAG,GAAG,KAAK,GAAG,MAAM,CAAC;AAAA,EACzE,CAAC;AAED,SAAO;AACX;AAMO,SAAS,KACZ,IACA,UACA,OACA,UACA,QACA,OACI;AACJ,KAAG,SAAS;AAAA,IACR,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,GAAG,OAAO,KAAK,GAAG,GAAG,OAAO,QAAQ,GAAG,GAAG,KAAK,GAAG,MAAM,GAAG,GAAG,KAAK,IAAI,KAAK,CAAC;AAAA,EAC7F,CAAC;AACL;AAMO,SAAS,OACZ,IACA,UACA,OACA,UACA,QACI;AACJ,KAAG,SAAS;AAAA,IACR,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,GAAG,OAAO,KAAK,GAAG,GAAG,OAAO,QAAQ,GAAG,GAAG,KAAK,GAAG,MAAM,CAAC;AAAA,EACzE,CAAC;AACL;AAMO,SAAS,aACZ,IACA,UACA,OACA,UACA,MACA,OACI;AACJ,KAAG,SAAS;AAAA,IACR,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,GAAG,OAAO,KAAK,GAAG,GAAG,OAAO,QAAQ,GAAG,GAAG,OAAO,IAAI,GAAG,GAAG,KAAK,IAAI,KAAK,CAAC;AAAA,EAC1F,CAAC;AACL;AAMO,SAAS,SACZ,IACA,UACA,OACA,QACA,SACsD;AACtD,QAAM,CAAC,MAAM,eAAe,IAAI,GAAG,SAAS;AAAA,IACxC,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,GAAG,OAAO,KAAK,GAAG,GAAG,KAAK,GAAG,MAAM,GAAG,GAAG,OAAO,OAAO,CAAC;AAAA,EACxE,CAAC;AAED,SAAO,CAAC,MAAM,eAAe;AACjC;AAMO,SAAS,kBACZ,IACA,OACA,UACA,QACyB;AACzB,QAAM,YAAY,eAAI,OAAO,eAAI,IAAI,CAAC,EAAE,UAAU,MAAM;AAExD,QAAM,CAAC,IAAI,IAAI,GAAG,SAAS;AAAA,IACvB,QAAQ,GAAG;AAAA,IACX,WAAW,CAAC,GAAG,OAAO,KAAK,GAAG,GAAG,OAAO,QAAQ,GAAG,SAAS;AAAA,EAChE,CAAC;AAED,SAAO;AACX;AAQO,SAAS,YACZ,IACA,UACA,OACA,UACA,QAC0C;AAC1C,QAAM,CAAC,MAAM,OAAO,IAAI,GAAG,SAAS;AAAA,IAChC,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,GAAG,OAAO,KAAK,GAAG,GAAG,OAAO,QAAQ,GAAG,GAAG,KAAK,GAAG,MAAM,CAAC;AAAA,EACzE,CAAC;AAED,SAAO,CAAC,MAAM,OAAO;AACzB;AAMO,SAAS,YACZ,IACA,UACA,OACA,MACA,SACI;AACJ,KAAG,SAAS;AAAA,IACR,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,GAAG,OAAO,KAAK,GAAG,MAAM,OAAO;AAAA,EAC/C,CAAC;AACL;",
+  "names": []
+}

package/dist/cjs/tx/personal-kiosk.d.ts

@@ -0,0 +1,7 @@
+import type { TransactionBlock, TransactionObjectArgument } from '@iota/iota-sdk/transactions';
+import type { ObjectArgument } from '../types/index.js';
+export declare function convertToPersonalTx(tx: TransactionBlock, kiosk: ObjectArgument, kioskOwnerCap: ObjectArgument, packageId: string): TransactionObjectArgument;
+/**
+ * Transfers the personal kiosk Cap to the sender.
+ */
+export declare function transferPersonalCapTx(tx: TransactionBlock, personalKioskCap: TransactionObjectArgument, packageId: string): void;

package/dist/cjs/tx/personal-kiosk.js

@@ -0,0 +1,38 @@
+"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 personal_kiosk_exports = {};
+__export(personal_kiosk_exports, {
+  convertToPersonalTx: () => convertToPersonalTx,
+  transferPersonalCapTx: () => transferPersonalCapTx
+});
+module.exports = __toCommonJS(personal_kiosk_exports);
+function convertToPersonalTx(tx, kiosk, kioskOwnerCap, packageId) {
+  const personalKioskCap = tx.moveCall({
+    target: `${packageId}::personal_kiosk::new`,
+    arguments: [tx.object(kiosk), tx.object(kioskOwnerCap)]
+  });
+  return personalKioskCap;
+}
+function transferPersonalCapTx(tx, personalKioskCap, packageId) {
+  tx.moveCall({
+    target: `${packageId}::personal_kiosk::transfer_to_sender`,
+    arguments: [personalKioskCap]
+  });
+}
+//# sourceMappingURL=personal-kiosk.js.map

package/dist/cjs/tx/personal-kiosk.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/tx/personal-kiosk.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// Modifications Copyright (c) 2024 IOTA Stiftung\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { TransactionBlock, TransactionObjectArgument } from '@iota/iota-sdk/transactions';\n\nimport type { ObjectArgument } from '../types/index.js';\n\nexport function convertToPersonalTx(\n    tx: TransactionBlock,\n    kiosk: ObjectArgument,\n    kioskOwnerCap: ObjectArgument,\n    packageId: string,\n): TransactionObjectArgument {\n    const personalKioskCap = tx.moveCall({\n        target: `${packageId}::personal_kiosk::new`,\n        arguments: [tx.object(kiosk), tx.object(kioskOwnerCap)],\n    });\n\n    return personalKioskCap;\n}\n\n/**\n * Transfers the personal kiosk Cap to the sender.\n */\nexport function transferPersonalCapTx(\n    tx: TransactionBlock,\n    personalKioskCap: TransactionObjectArgument,\n    packageId: string,\n) {\n    tx.moveCall({\n        target: `${packageId}::personal_kiosk::transfer_to_sender`,\n        arguments: [personalKioskCap],\n    });\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAQO,SAAS,oBACZ,IACA,OACA,eACA,WACyB;AACzB,QAAM,mBAAmB,GAAG,SAAS;AAAA,IACjC,QAAQ,GAAG;AAAA,IACX,WAAW,CAAC,GAAG,OAAO,KAAK,GAAG,GAAG,OAAO,aAAa,CAAC;AAAA,EAC1D,CAAC;AAED,SAAO;AACX;AAKO,SAAS,sBACZ,IACA,kBACA,WACF;AACE,KAAG,SAAS;AAAA,IACR,QAAQ,GAAG;AAAA,IACX,WAAW,CAAC,gBAAgB;AAAA,EAChC,CAAC;AACL;",
+  "names": []
+}

package/dist/cjs/tx/rules/attach.d.ts

@@ -0,0 +1,7 @@
+import type { TransactionBlock } from '@iota/iota-sdk/transactions';
+import type { ObjectArgument } from '../../types/index.js';
+export declare function attachKioskLockRuleTx(tx: TransactionBlock, type: string, policy: ObjectArgument, policyCap: ObjectArgument, packageId: string): void;
+export declare function attachRoyaltyRuleTx(tx: TransactionBlock, type: string, policy: ObjectArgument, policyCap: ObjectArgument, percentageBps: number | string, // this is in basis points.
+minAmount: number | string, packageId: string): void;
+export declare function attachPersonalKioskRuleTx(tx: TransactionBlock, type: string, policy: ObjectArgument, policyCap: ObjectArgument, packageId: string): void;
+export declare function attachFloorPriceRuleTx(tx: TransactionBlock, type: string, policy: ObjectArgument, policyCap: ObjectArgument, minPrice: string | bigint, packageId: string): void;