@iota/kiosk 0.1.1 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @iota/kiosk
 
+## 0.2.0
+
+### Minor Changes
+
+-   6eabd18: Changes for compatibility with the node, simplification of exposed APIs and general
+    improvements.
+
+### Patch Changes
+
+-   Updated dependencies [6eabd18]
+    -   @iota/iota-sdk@0.3.0
+
+## 0.1.2
+
+### Patch Changes
+
+-   Updated dependencies [d423314]
+-   Updated dependencies [b91a3d5]
+-   Updated dependencies [a3c1937]
+    -   @iota/iota-sdk@0.2.0
+
 ## 0.1.1
 
 ### Patch Changes

package/README.md

@@ -3,6 +3,6 @@
 This Kiosk SDK library provides different utilities to interact/create/manage a
 [Kiosk](https://github.com/iotaledger/iota/tree/main/kiosk).
 
-[You can read the documentation and see examples by clicking here.]()
+[You can read the documentation and see examples by clicking here.](https://wiki.iota.org/references/ts-sdk/kiosk)
 
-[If you are migrating from `0.6.x`, you can follow these instructions]()
+[If you are migrating from `0.6.x`, you can follow these instructions](https://wiki.iota.org/references/ts-sdk/kiosk/from-v1)

package/dist/cjs/bcs.d.ts

@@ -1,2 +1,38 @@
-import { bcs } from '@iota/iota-sdk/bcs';
-export { bcs };
+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/cjs/bcs.js

@@ -18,30 +18,32 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var bcs_exports = {};
 __export(bcs_exports, {
-  bcs: () => import_bcs.bcs
+  KioskPurchaseCap: () => KioskPurchaseCap,
+  KioskType: () => KioskType,
+  TransferPolicyCreatedEvent: () => TransferPolicyCreatedEvent,
+  TransferPolicyType: () => TransferPolicyType
 });
 module.exports = __toCommonJS(bcs_exports);
 var import_bcs = require("@iota/iota-sdk/bcs");
 var import_types = require("./types/index.js");
-import_bcs.bcs.registerStructType(import_types.KIOSK_TYPE, {
-  id: "address",
-  profits: "u64",
-  owner: "address",
-  itemCount: "u32",
-  allowExtensions: "bool"
+const KioskType = import_bcs.bcs.struct(import_types.KIOSK_TYPE, {
+  id: import_bcs.bcs.Address,
+  profits: import_bcs.bcs.u64(),
+  owner: import_bcs.bcs.Address,
+  itemCount: import_bcs.bcs.u32()
 });
-import_bcs.bcs.registerStructType(import_types.KIOSK_PURCHASE_CAP, {
-  id: "address",
-  kioskId: "address",
-  itemId: "address",
-  minPrice: "u64"
+const KioskPurchaseCap = import_bcs.bcs.struct(import_types.KIOSK_PURCHASE_CAP, {
+  id: import_bcs.bcs.Address,
+  kioskId: import_bcs.bcs.Address,
+  itemId: import_bcs.bcs.Address,
+  minPrice: import_bcs.bcs.u64()
 });
-import_bcs.bcs.registerStructType(import_types.TRANSFER_POLICY_CREATED_EVENT, {
-  id: "address"
+const TransferPolicyCreatedEvent = import_bcs.bcs.struct(import_types.TRANSFER_POLICY_CREATED_EVENT, {
+  id: import_bcs.bcs.Address
 });
-import_bcs.bcs.registerStructType(import_types.TRANSFER_POLICY_TYPE, {
-  id: "address",
-  balance: "u64",
-  rules: ["vector", "string"]
+const TransferPolicyType = import_bcs.bcs.struct(import_types.TRANSFER_POLICY_TYPE, {
+  id: import_bcs.bcs.Address,
+  balance: import_bcs.bcs.u64(),
+  rules: import_bcs.bcs.vector(import_bcs.bcs.string())
 });
 //# sourceMappingURL=bcs.js.map

package/dist/cjs/bcs.js.map

@@ -1,7 +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.\nbcs.registerStructType(KIOSK_TYPE, {\n    id: 'address',\n    profits: 'u64',\n    owner: 'address',\n    itemCount: 'u32',\n    allowExtensions: 'bool',\n});\n\n// Register the `PurchaseCap` for faster queries.\nbcs.registerStructType(KIOSK_PURCHASE_CAP, {\n    id: 'address',\n    kioskId: 'address',\n    itemId: 'address',\n    minPrice: 'u64',\n});\n\n// Register the `TransferPolicyCreated` event data.\nbcs.registerStructType(TRANSFER_POLICY_CREATED_EVENT, {\n    id: 'address',\n});\n\nbcs.registerStructType(TRANSFER_POLICY_TYPE, {\n    id: 'address',\n    balance: 'u64',\n    rules: ['vector', 'string'],\n});\n\nexport { bcs };\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAIA,iBAAoB;AAEpB,mBAKO;AAGP,eAAI,mBAAmB,yBAAY;AAAA,EAC/B,IAAI;AAAA,EACJ,SAAS;AAAA,EACT,OAAO;AAAA,EACP,WAAW;AAAA,EACX,iBAAiB;AACrB,CAAC;AAGD,eAAI,mBAAmB,iCAAoB;AAAA,EACvC,IAAI;AAAA,EACJ,SAAS;AAAA,EACT,QAAQ;AAAA,EACR,UAAU;AACd,CAAC;AAGD,eAAI,mBAAmB,4CAA+B;AAAA,EAClD,IAAI;AACR,CAAC;AAED,eAAI,mBAAmB,mCAAsB;AAAA,EACzC,IAAI;AAAA,EACJ,SAAS;AAAA,EACT,OAAO,CAAC,UAAU,QAAQ;AAC9B,CAAC;",
+  "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": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAIA,iBAAoB;AAEpB,mBAKO;AAGA,MAAM,YAAY,eAAI,OAAO,yBAAY;AAAA,EAC5C,IAAI,eAAI;AAAA,EACR,SAAS,eAAI,IAAI;AAAA,EACjB,OAAO,eAAI;AAAA,EACX,WAAW,eAAI,IAAI;AACvB,CAAC;AAGM,MAAM,mBAAmB,eAAI,OAAO,iCAAoB;AAAA,EAC3D,IAAI,eAAI;AAAA,EACR,SAAS,eAAI;AAAA,EACb,QAAQ,eAAI;AAAA,EACZ,UAAU,eAAI,IAAI;AACtB,CAAC;AAGM,MAAM,6BAA6B,eAAI,OAAO,4CAA+B;AAAA,EAChF,IAAI,eAAI;AACZ,CAAC;AAEM,MAAM,qBAAqB,eAAI,OAAO,mCAAsB;AAAA,EAC/D,IAAI,eAAI;AAAA,EACR,SAAS,eAAI,IAAI;AAAA,EACjB,OAAO,eAAI,OAAO,eAAI,OAAO,CAAC;AAClC,CAAC;",
   "names": []
 }

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

@@ -1,5 +1,5 @@
 import type { NetworkId } from '@iota/iota-sdk/client';
-import type { IotaClient } 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';
 /**
@@ -17,10 +17,12 @@ export declare class KioskClient {
     /**
      * 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 }: {
+    getOwnedKiosks({ address, pagination, }: {
         address: string;
+        pagination?: PaginationArguments<string>;
     }): Promise<OwnedKiosks>;
     /**
      * Fetches the kiosk contents.

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

@@ -31,18 +31,22 @@ class KioskClient {
     this.network = options.network;
     this.rules = import_constants.rules;
     this.packageIds = options.packageIds;
-    if (options.packageIds)
-      this.rules.push(...(0, import_constants.getBaseRules)(options.packageIds));
+    if (options.packageIds) this.rules.push(...(0, import_constants.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 }) {
+  async getOwnedKiosks({
+    address,
+    pagination
+  }) {
     const personalPackageId = this.packageIds?.personalKioskRulePackageId || (0, import_client.getNetwork)(this.network).kiosk?.personalKioskRulePackageId || "";
     return (0, import_kiosk.getOwnedKiosks)(this.client, address, {
+      pagination,
       personalKioskType: personalPackageId ? `${personalPackageId}::personal_kiosk::PersonalKioskCap` : ""
     });
   }
@@ -112,10 +116,11 @@ class KioskClient {
     const rules2 = this.packageIds || {};
     const network = this.network;
     const networkKiosk = (0, import_client.getNetwork)(network).kiosk;
-    if (!rules2[rule] || !networkKiosk) {
+    const rulePackageId = rules2[rule] || networkKiosk?.[rule];
+    if (!rulePackageId) {
       throw new Error(`Missing packageId for rule ${rule}`);
     }
-    return rules2[rule] || networkKiosk[rule];
+    return rulePackageId;
   }
 }
 //# sourceMappingURL=kiosk-client.js.map

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

@@ -1,7 +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 { 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     * @returns An Object containing all the `kioskOwnerCap` objects as well as the kioskIds.\n     */\n    async getOwnedKiosks({ address }: { address: string }): Promise<OwnedKiosks> {\n        const personalPackageId =\n            this.packageIds?.personalKioskRulePackageId ||\n            getNetwork(this.network).kiosk?.personalKioskRulePackageId ||\n            '';\n\n        return getOwnedKiosks(this.client, address, {\n            personalKioskType: personalPackageId\n                ? `${personalPackageId}::personal_kiosk::PersonalKioskCap`\n                : '',\n        });\n    }\n\n    /**\n     * Fetches the kiosk contents.\n     * @param kioskId The ID of the kiosk to fetch.\n     * @param options Optioal\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        /// Check existence of rule based on network and throw an error if it's not found.\n        if (!rules[rule] || !networkKiosk) {\n            throw new Error(`Missing packageId for rule ${rule}`);\n        }\n\n        return rules[rule] || networkKiosk[rule];\n    }\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAKA,oBAA2B;AAG3B,uBAAoC;AAEpC,mBAAgE;AAChE,6BAIO;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;AAAY,WAAK,MAAM,KAAK,OAAG,+BAAa,QAAQ,UAAU,CAAC;AAAA,EAC/E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,eAAe,EAAE,QAAQ,GAA8C;AACzE,UAAM,oBACF,KAAK,YAAY,kCACjB,0BAAW,KAAK,OAAO,EAAE,OAAO,8BAChC;AAEJ,eAAO,6BAAe,KAAK,QAAQ,SAAS;AAAA,MACxC,mBAAmB,oBACb,GAAG,wDACH;AAAA,IACV,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,SAAS;AAAA,IACX;AAAA,IACA;AAAA,EACJ,GAGuB;AACnB,YACI,UAAM;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,eAAO,kCAAoB,KAAK,QAAQ,SAAS,IAAI;AAAA,EACzD;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,oBAAoB,EAAE,KAAK,GAAqB;AAClD,eAAO,4CAAoB,KAAK,QAAQ,IAAI;AAAA,EAChD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,yBAAyB,EAAE,QAAQ,GAAwB;AAC7D,eAAO,mDAA2B,KAAK,QAAQ,OAAO;AAAA,EAC1D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,+BAA+B,EAAE,MAAM,QAAQ,GAAsC;AACvF,eAAO,sDAA8B,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,+BAA+B;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,mBAAe,0BAAW,OAAO,EAAE;AAGzC,QAAI,CAACA,OAAM,IAAI,KAAK,CAAC,cAAc;AAC/B,YAAM,IAAI,MAAM,8BAA8B,MAAM;AAAA,IACxD;AAEA,WAAOA,OAAM,IAAI,KAAK,aAAa,IAAI;AAAA,EAC3C;AACJ;",
+  "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 kioskId The ID of the kiosk to fetch.\n     * @param options Optioal\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": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAKA,oBAA2B;AAG3B,uBAAoC;AAEpC,mBAAgE;AAChE,6BAIO;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,OAAG,+BAAa,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,kCACjB,0BAAW,KAAK,OAAO,EAAE,OAAO,8BAChC;AAEJ,eAAO,6BAAe,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,UAAM;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,eAAO,kCAAoB,KAAK,QAAQ,SAAS,IAAI;AAAA,EACzD;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,oBAAoB,EAAE,KAAK,GAAqB;AAClD,eAAO,4CAAoB,KAAK,QAAQ,IAAI;AAAA,EAChD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,yBAAyB,EAAE,QAAQ,GAAwB;AAC7D,eAAO,mDAA2B,KAAK,QAAQ,OAAO;AAAA,EAC1D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,+BAA+B,EAAE,MAAM,QAAQ,GAAsC;AACvF,eAAO,sDAA8B,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,mBAAe,0BAAW,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"]
 }

package/dist/cjs/client/kiosk-transaction.d.ts

@@ -1,9 +1,11 @@
-import type { TransactionArgument, TransactionBlock, TransactionObjectArgument } from '@iota/iota-sdk/transactions';
+import type { Transaction, TransactionArgument, TransactionObjectArgument } from '@iota/iota-sdk/transactions';
 import type { ItemId, ItemReference, ItemValue, KioskOwnerCap, ObjectArgument, Price, PurchaseOptions } from '../types/index.js';
 import type { KioskClient } from './kiosk-client.js';
 export type KioskTransactionParams = {
-    /** The TransactionBlock for this run */
-    transactionBlock: TransactionBlock;
+    /** The Transaction for this run */
+    transaction: Transaction;
+    /** @deprecated use transaction instead */
+    transactionBlock?: Transaction;
     /**
      * You can create a new KioskClient by calling `new KioskClient()`
      */
@@ -20,11 +22,11 @@ export type KioskTransactionParams = {
  */
 export declare class KioskTransaction {
     #private;
-    transactionBlock: TransactionBlock;
+    transaction: Transaction;
     kioskClient: KioskClient;
     kiosk?: TransactionObjectArgument;
     kioskCap?: TransactionObjectArgument;
-    constructor({ transactionBlock, kioskClient, cap }: KioskTransactionParams);
+    constructor({ transactionBlock, transaction, kioskClient, cap, }: KioskTransactionParams);
     /**
      * Creates a kiosk and saves `kiosk` and `kioskOwnerCap` in state.
      * Helpful if we want to chain some actions before sharing + transferring the cap to the specified address.
@@ -57,7 +59,6 @@ export declare class KioskTransaction {
     shareAndTransferCap(address: string): void;
     /**
      * A function to borrow an item from a kiosk & execute any function with it.
-     * Example: You could borrow a Fren out of a kiosk, attach an accessory (or mix), and return it.
      */
     borrowTx({ itemType, itemId }: ItemId, callback: (item: TransactionArgument) => void): void;
     /**
@@ -90,14 +91,14 @@ export declare class KioskTransaction {
      * A function to place an item in the kiosk and list it for sale in one transaction.
      * @param itemType The type `T` of the item
      * @param item The ID or Transaction Argument of the item
-     * @param price The price in nano
+     * @param price The price in NANOS
      */
     placeAndList({ itemType, item, price }: ItemReference & Price): this;
     /**
      * A function to list an item in the kiosk.
      * @param itemType The type `T` of the item
      * @param itemId The ID of the item
-     * @param price The price in nano
+     * @param price The price in NANOS
      */
     list({ itemType, itemId, price }: ItemId & {
         price: string | bigint;
@@ -143,7 +144,7 @@ export declare class KioskTransaction {
      * Can be called like: `const [item, transferRequest] = kioskTx.purchase({...})`
      * @param itemType The type `T` of the item
      * @param itemId The ID of the item
-     * @param price The price in nano
+     * @param price The price in NANOS
      * @param sellerKiosk The kiosk which is selling the item. Can be an id or an object argument.
      */
     purchase({ itemType, itemId, price, sellerKiosk, }: ItemId & Price & {
@@ -172,7 +173,7 @@ export declare class KioskTransaction {
      */
     setCap(cap: KioskOwnerCap): this | undefined;
     /**
-     *	A function that ends up the kiosk building txb & returns the `kioskOwnerCap` back to the
+     *	A function that ends up the kiosk building tx & returns the `kioskOwnerCap` back to the
      *  `PersonalKioskCap`, in case we are operating on a personal kiosk.
      * 	It will also share the `kiosk` if it's not shared, and finalize the transfer of the personal cap if it's pending.
      */