@mysten/kiosk 0.14.5 → 1.0.0

package/dist/esm/bcs.js.map

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

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

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

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

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

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

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/client/kiosk-client.ts"],
-  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { PaginationArguments, SuiClient } from '@mysten/sui/client';\n\nimport {\n\tFLOOR_PRICE_RULE_ADDRESS,\n\tgetBaseRules,\n\tKIOSK_LOCK_RULE_ADDRESS,\n\tPERSONAL_KIOSK_RULE_ADDRESS,\n\tROYALTY_RULE_ADDRESS,\n\trules,\n} from '../constants.js';\nimport type { BaseRulePackageIds, TransferPolicyRule } from '../constants.js';\nimport { fetchKiosk, fetchKioskExtension, getOwnedKiosks } from '../query/kiosk.js';\nimport {\n\tqueryOwnedTransferPolicies,\n\tqueryTransferPolicy,\n\tqueryTransferPolicyCapsByType,\n} from '../query/transfer-policy.js';\nimport { Network } from '../types/index.js';\nimport type {\n\tFetchKioskOptions,\n\tKioskClientOptions,\n\tKioskData,\n\tOwnedKiosks,\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\tclient: SuiClient;\n\tnetwork: Network;\n\trules: TransferPolicyRule[];\n\tpackageIds?: BaseRulePackageIds;\n\n\tconstructor(options: KioskClientOptions) {\n\t\tthis.client = options.client;\n\t\tthis.network = options.network;\n\t\tthis.rules = rules; // add all the default rules.\n\t\tthis.packageIds = options.packageIds;\n\n\t\t// Add the custom Package Ids too on the rule list.\n\t\t// Only adds the rules that are passed in the packageId object.\n\t\tif (options.packageIds) this.rules.push(...getBaseRules(options.packageIds));\n\t}\n\n\t/// Querying\n\n\t/**\n\t * Get an addresses's owned kiosks.\n\t * @param address The address for which we want to retrieve the kiosks.\n\t * @param pagination Optional pagination arguments.\n\t * @returns An Object containing all the `kioskOwnerCap` objects as well as the kioskIds.\n\t */\n\tasync getOwnedKiosks({\n\t\taddress,\n\t\tpagination,\n\t}: {\n\t\taddress: string;\n\t\tpagination?: PaginationArguments<string>;\n\t}): Promise<OwnedKiosks> {\n\t\tconst personalPackageId =\n\t\t\tthis.packageIds?.personalKioskRulePackageId || PERSONAL_KIOSK_RULE_ADDRESS[this.network];\n\n\t\treturn getOwnedKiosks(this.client, address, {\n\t\t\tpagination,\n\t\t\tpersonalKioskType: personalPackageId\n\t\t\t\t? `${personalPackageId}::personal_kiosk::PersonalKioskCap`\n\t\t\t\t: '',\n\t\t});\n\t}\n\n\t/**\n\t * Fetches the kiosk contents.\n\t * @param id The ID of the kiosk to fetch.\n\t * @param options Optional to control the fetch behavior.\n\t * @returns\n\t */\n\tasync getKiosk({ id, options }: { id: string; options?: FetchKioskOptions }): Promise<KioskData> {\n\t\treturn (await fetchKiosk(this.client, id, {}, options || {})).data;\n\t}\n\n\t/**\n\t * Fetch the extension data (if any) for a kiosk, by type\n\t * @param kioskId The ID of the kiosk to lookup\n\t * @param extensionType The Type of the extension (can be used from by using the type returned by `getKiosk()`)\n\t */\n\tasync getKioskExtension({ kioskId, type }: { kioskId: string; type: string }) {\n\t\treturn fetchKioskExtension(this.client, kioskId, type);\n\t}\n\n\t/**\n\t * Query the Transfer Policy(ies) for type `T`.\n\t * @param type The Type we're querying for (E.g `0xMyAddress::hero::Hero`)\n\t */\n\tasync getTransferPolicies({ type }: { type: string }) {\n\t\treturn queryTransferPolicy(this.client, type);\n\t}\n\n\t/**\n\t * Query all the owned transfer policies for an address.\n\t * Returns `TransferPolicyCap` which uncludes `policyId, policyCapId, type`.\n\t * @param address The address we're searching the owned transfer policies for.\n\t */\n\tasync getOwnedTransferPolicies({ address }: { address: string }) {\n\t\treturn queryOwnedTransferPolicies(this.client, address);\n\t}\n\n\t/**\n\t * Query the Transfer Policy Cap for type `T`, owned by `address`\n\t * @param type The Type `T` for the object\n\t * @param address The address that owns the cap.\n\t */\n\tasync getOwnedTransferPoliciesByType({ type, address }: { type: string; address: string }) {\n\t\treturn queryTransferPolicyCapsByType(this.client, address, type);\n\t}\n\n\t// Someone would just have to create a `kiosk-client.ts` file in their project, initialize a KioskClient\n\t// and call the `addRuleResolver` function. Each rule has a `resolve` function.\n\t// The resolve function is automatically called on `purchaseAndResolve` function call.\n\taddRuleResolver(rule: TransferPolicyRule) {\n\t\tif (this.rules.find((x) => x.rule === rule.rule))\n\t\t\tthrow new Error(`Rule ${rule.rule} resolver already exists.`);\n\t\tthis.rules.push(rule);\n\t}\n\n\t/**\n\t * A convenient helper to get the packageIds for our supported ruleset,\n\t * based on `kioskClient` configuration.\n\t */\n\tgetRulePackageId(\n\t\trule:\n\t\t\t| 'kioskLockRulePackageId'\n\t\t\t| 'royaltyRulePackageId'\n\t\t\t| 'personalKioskRulePackageId'\n\t\t\t| 'floorPriceRulePackageId',\n\t) {\n\t\tconst rules = this.packageIds || {};\n\t\tconst network = this.network;\n\n\t\t/// Check existence of rule based on network and throw an error if it's not found.\n\t\t/// We always have a fallback for testnet or mainnet.\n\t\tif (!rules[rule] && network !== Network.MAINNET && network !== Network.TESTNET) {\n\t\t\tthrow new Error(`Missing packageId for rule ${rule}`);\n\t\t}\n\n\t\tswitch (rule) {\n\t\t\tcase 'kioskLockRulePackageId':\n\t\t\t\treturn rules[rule] || KIOSK_LOCK_RULE_ADDRESS[network];\n\t\t\tcase 'royaltyRulePackageId':\n\t\t\t\treturn rules[rule] || ROYALTY_RULE_ADDRESS[network];\n\t\t\tcase 'personalKioskRulePackageId':\n\t\t\t\treturn rules[rule] || PERSONAL_KIOSK_RULE_ADDRESS[network];\n\t\t\tcase 'floorPriceRulePackageId':\n\t\t\t\treturn rules[rule] || FLOOR_PRICE_RULE_ADDRESS[network];\n\t\t}\n\t}\n}\n"],
-  "mappings": "AAKA;AAAA,EACC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACM;AAEP,SAAS,YAAY,qBAAqB,sBAAsB;AAChE;AAAA,EACC;AAAA,EACA;AAAA,EACA;AAAA,OACM;AACP,SAAS,eAAe;AAcjB,MAAM,YAAY;AAAA,EAMxB,YAAY,SAA6B;AACxC,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,EAC5E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,eAAe;AAAA,IACpB;AAAA,IACA;AAAA,EACD,GAGyB;AACxB,UAAM,oBACL,KAAK,YAAY,8BAA8B,4BAA4B,KAAK,OAAO;AAExF,WAAO,eAAe,KAAK,QAAQ,SAAS;AAAA,MAC3C;AAAA,MACA,mBAAmB,oBAChB,GAAG,iBAAiB,uCACpB;AAAA,IACJ,CAAC;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,SAAS,EAAE,IAAI,QAAQ,GAAoE;AAChG,YAAQ,MAAM,WAAW,KAAK,QAAQ,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC,GAAG;AAAA,EAC/D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,kBAAkB,EAAE,SAAS,KAAK,GAAsC;AAC7E,WAAO,oBAAoB,KAAK,QAAQ,SAAS,IAAI;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,oBAAoB,EAAE,KAAK,GAAqB;AACrD,WAAO,oBAAoB,KAAK,QAAQ,IAAI;AAAA,EAC7C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,yBAAyB,EAAE,QAAQ,GAAwB;AAChE,WAAO,2BAA2B,KAAK,QAAQ,OAAO;AAAA,EACvD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,+BAA+B,EAAE,MAAM,QAAQ,GAAsC;AAC1F,WAAO,8BAA8B,KAAK,QAAQ,SAAS,IAAI;AAAA,EAChE;AAAA;AAAA;AAAA;AAAA,EAKA,gBAAgB,MAA0B;AACzC,QAAI,KAAK,MAAM,KAAK,CAAC,MAAM,EAAE,SAAS,KAAK,IAAI;AAC9C,YAAM,IAAI,MAAM,QAAQ,KAAK,IAAI,2BAA2B;AAC7D,SAAK,MAAM,KAAK,IAAI;AAAA,EACrB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,iBACC,MAKC;AACD,UAAMA,SAAQ,KAAK,cAAc,CAAC;AAClC,UAAM,UAAU,KAAK;AAIrB,QAAI,CAACA,OAAM,IAAI,KAAK,YAAY,QAAQ,WAAW,YAAY,QAAQ,SAAS;AAC/E,YAAM,IAAI,MAAM,8BAA8B,IAAI,EAAE;AAAA,IACrD;AAEA,YAAQ,MAAM;AAAA,MACb,KAAK;AACJ,eAAOA,OAAM,IAAI,KAAK,wBAAwB,OAAO;AAAA,MACtD,KAAK;AACJ,eAAOA,OAAM,IAAI,KAAK,qBAAqB,OAAO;AAAA,MACnD,KAAK;AACJ,eAAOA,OAAM,IAAI,KAAK,4BAA4B,OAAO;AAAA,MAC1D,KAAK;AACJ,eAAOA,OAAM,IAAI,KAAK,yBAAyB,OAAO;AAAA,IACxD;AAAA,EACD;AACD;",
-  "names": ["rules"]
-}

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

@@ -1,186 +0,0 @@
-import type { Transaction, TransactionArgument, TransactionObjectArgument } from '@mysten/sui/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 Transaction for this run */
-    transaction: Transaction;
-    /** @deprecated use transaction instead */
-    transactionBlock?: Transaction;
-    /**
-     * You can create a new KioskClient by calling `new KioskClient()`
-     */
-    kioskClient: KioskClient;
-    /**
-     * You can optionally pass in the `cap` as returned
-     * from `kioskClient.getOwnedKiosks` when initializing the client
-     * Otherwise, you can set it by calling `kioskTransaction.setCap()`
-     */
-    cap?: KioskOwnerCap;
-};
-/**
- * A helper for building transactions that involve kiosk.
- */
-export declare class KioskTransaction {
-    #private;
-    transaction: Transaction;
-    kioskClient: KioskClient;
-    kiosk?: TransactionObjectArgument;
-    kioskCap?: TransactionObjectArgument;
-    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.
-     * @param borrow If true, the `kioskOwnerCap` is borrowed from the `PersonalKioskCap` to be used in next transactions.
-     */
-    create(): this;
-    /**
-     * Creates a personal kiosk & shares it.
-     * The `PersonalKioskCap` is transferred to the signer.
-     * @param borrow If true, the `kioskOwnerCap` is borrowed from the `PersonalKioskCap` to be used in next transactions.
-     */
-    createPersonal(borrow?: boolean): this;
-    /**
-     * Converts a kiosk to a Personal (Soulbound) Kiosk.
-     * Requires initialization by either calling `ktxb.create()` or `ktxb.setCap()`.
-     */
-    convertToPersonal(borrow?: boolean): this;
-    /**
-     * Single function way to create a kiosk, share it and transfer the cap to the specified address.
-     */
-    createAndShare(address: string): this;
-    /**
-     * Shares the kiosk.
-     */
-    share(): this;
-    /**
-     * Should be called only after `create` is called.
-     * It shares the kiosk & transfers the cap to the specified address.
-     */
-    shareAndTransferCap(address: string): this;
-    /**
-     * 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): this;
-    /**
-     * Borrows an item from the kiosk.
-     * This will fail if the item is listed for sale.
-     *
-     * Requires calling `return`.
-     */
-    borrow({ itemType, itemId }: ItemId): [TransactionArgument, TransactionArgument];
-    /**
-     * Returns the item back to the kiosk.
-     * Accepts the parameters returned from the `borrow` function.
-     */
-    return({ itemType, item, promise }: ItemValue & {
-        promise: TransactionArgument;
-    }): this;
-    /**
-     * A function to withdraw from kiosk
-     * @param address Where to trasnfer the coin.
-     * @param amount The amount we aim to withdraw.
-     */
-    withdraw(address: string, amount?: string | bigint | number): this;
-    /**
-     * A function to place an item in the kiosk.
-     * @param itemType The type `T` of the item
-     * @param item The ID or Transaction Argument of the item
-     */
-    place({ itemType, item }: ItemReference): this;
-    /**
-     * 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 MIST
-     */
-    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 MIST
-     */
-    list({ itemType, itemId, price }: ItemId & {
-        price: string | bigint;
-    }): this;
-    /**
-     * A function to delist an item from the kiosk.
-     * @param itemType The type `T` of the item
-     * @param itemId The ID of the item
-     */
-    delist({ itemType, itemId }: ItemId): this;
-    /**
-     * A function to take an item from the kiosk. The transaction won't succeed if the item is listed or locked.
-
-     * @param itemType The type `T` of the item
-     * @param itemId The ID of the item
-     */
-    take({ itemType, itemId }: ItemId): TransactionObjectArgument;
-    /**
-     * Transfer a non-locked/non-listed item to an address.
-     *
-     * @param itemType The type `T` of the item
-     * @param itemId The ID of the item
-     * @param address The destination address
-     */
-    transfer({ itemType, itemId, address }: ItemId & {
-        address: string;
-    }): this;
-    /**
-     * A function to take lock an item in the kiosk.
-
-     * @param itemType The type `T` of the item
-     * @param item The ID or Transaction Argument of the item
-     * @param itemId The ID of the item - Deprecated: Use `item` instead.
-     * @param policy The Policy ID or Transaction Argument for item T
-     */
-    lock({ itemType, item, itemId, policy, }: ItemReference & {
-        policy: ObjectArgument;
-        itemId?: string;
-    }): this;
-    /**
-     * Purchase an item from a seller's kiosk.
-     * Returns [item, transferRequest]
-     * 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 MIST
-     * @param sellerKiosk The kiosk which is selling the item. Can be an id or an object argument.
-     */
-    purchase({ itemType, itemId, price, sellerKiosk, }: ItemId & Price & {
-        sellerKiosk: ObjectArgument;
-    }): [
-        TransactionObjectArgument,
-        TransactionObjectArgument
-    ];
-    /**
-     * A function to purchase and resolve a transfer policy.
-     * If the transfer policy has the `lock` rule, the item is locked in the kiosk.
-     * Otherwise, the item is placed in the kiosk.
-     * @param itemType The type of the item
-     * @param itemId The id of the item
-     * @param price The price of the specified item
-     * @param sellerKiosk The kiosk which is selling the item. Can be an id or an object argument.
-     * @param extraArgs Used to pass arguments for custom rule resolvers.
-     */
-    purchaseAndResolve({ itemType, itemId, price, sellerKiosk, extraArgs, }: ItemId & Price & {
-        sellerKiosk: ObjectArgument;
-    } & PurchaseOptions): Promise<this>;
-    /**
-     * A function to setup the client using an existing `ownerCap`,
-     * as return from the `kioskClient.getOwnedKiosks` function.
-     * @param cap `KioskOwnerCap` object as returned from `getOwnedKiosks` SDK call.
-     */
-    setCap(cap: KioskOwnerCap): this | undefined;
-    /**
-     *	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.
-     */
-    finalize(): void;
-    setKioskCap(cap: TransactionObjectArgument): this;
-    setKiosk(kiosk: TransactionObjectArgument): this;
-    getKiosk(): TransactionObjectArgument;
-    getKioskCap(): TransactionObjectArgument;
-}