@mysten/kiosk 0.14.6 → 1.0.1

package/dist/client/kiosk-transaction.mjs

@@ -0,0 +1,472 @@
+import { _new, borrowVal, delist, list, lock, place, placeAndList, purchase, returnVal, take, withdraw } from "../contracts/0x2/kiosk.mjs";
+import { getNormalizedRuleType } from "../utils.mjs";
+import { _new as _new$1, borrowVal as borrowVal$1, returnVal as returnVal$1, transferToSender } from "../contracts/kiosk/personal_kiosk.mjs";
+import { confirmRequest } from "../contracts/0x2/transfer_policy.mjs";
+import { createKioskAndShare } from "../tx/kiosk.mjs";
+
+//#region src/client/kiosk-transaction.ts
+/**
+* A helper for building transactions that involve kiosk.
+*/
+var KioskTransaction = class {
+	#pendingShare;
+	#pendingTransfer;
+	#promise;
+	#personalCap;
+	#finalized = false;
+	constructor({ transaction, kioskClient, cap }) {
+		this.transaction = transaction;
+		this.kioskClient = kioskClient;
+		if (cap) this.setCap(cap);
+	}
+	/**
+	* 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.#validateFinalizedStatus();
+		this.#setPendingStatuses({
+			share: true,
+			transfer: true
+		});
+		const [kiosk, cap] = this.transaction.add(_new({}));
+		this.kiosk = kiosk;
+		this.kioskCap = cap;
+		return 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) {
+		this.#pendingShare = true;
+		return this.create().convertToPersonal(borrow);
+	}
+	/**
+	* Converts a kiosk to a Personal (Soulbound) Kiosk.
+	* Requires initialization by either calling `ktxb.create()` or `ktxb.setCap()`.
+	*/
+	convertToPersonal(borrow) {
+		this.#validateKioskIsSet();
+		const packageId = this.kioskClient.getRulePackageId("personalKioskRulePackageId");
+		const [cap] = this.transaction.add(_new$1({
+			package: packageId,
+			arguments: {
+				kiosk: this.kiosk,
+				cap: this.kioskCap
+			}
+		}));
+		if (borrow) this.#borrowFromPersonalCap(cap);
+		else this.#personalCap = cap;
+		this.#setPendingStatuses({ transfer: true });
+		return this;
+	}
+	/**
+	* Single function way to create a kiosk, share it and transfer the cap to the specified address.
+	*/
+	createAndShare(address) {
+		this.#validateFinalizedStatus();
+		const cap = createKioskAndShare(this.transaction);
+		this.transaction.transferObjects([cap], address);
+		return this;
+	}
+	/**
+	* Shares the kiosk.
+	*/
+	share() {
+		this.#validateKioskIsSet();
+		this.#setPendingStatuses({ share: false });
+		this.transaction.moveCall({
+			target: "0x2::transfer::public_share_object",
+			arguments: [this.kiosk],
+			typeArguments: ["0x2::kiosk::Kiosk"]
+		});
+		return this;
+	}
+	/**
+	* Should be called only after `create` is called.
+	* It shares the kiosk & transfers the cap to the specified address.
+	*/
+	shareAndTransferCap(address) {
+		if (this.#personalCap) throw new Error("You can only call `shareAndTransferCap` on a non-personal kiosk.");
+		this.#setPendingStatuses({ transfer: false });
+		this.share();
+		this.transaction.transferObjects([this.kioskCap], address);
+		return 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 }, callback) {
+		this.#validateKioskIsSet();
+		const [itemObj, promise] = this.transaction.add(borrowVal({
+			arguments: [
+				this.kiosk,
+				this.kioskCap,
+				itemId
+			],
+			typeArguments: [itemType]
+		}));
+		callback(itemObj);
+		return this.return({
+			itemType,
+			item: itemObj,
+			promise
+		});
+	}
+	/**
+	* Borrows an item from the kiosk.
+	* This will fail if the item is listed for sale.
+	*
+	* Requires calling `return`.
+	*/
+	borrow({ itemType, itemId }) {
+		this.#validateKioskIsSet();
+		const [itemObj, promise] = this.transaction.add(borrowVal({
+			arguments: [
+				this.kiosk,
+				this.kioskCap,
+				itemId
+			],
+			typeArguments: [itemType]
+		}));
+		return [itemObj, promise];
+	}
+	/**
+	* Returns the item back to the kiosk.
+	* Accepts the parameters returned from the `borrow` function.
+	*/
+	return({ itemType, item, promise }) {
+		this.#validateKioskIsSet();
+		this.transaction.add(returnVal({
+			arguments: [
+				this.kiosk,
+				item,
+				promise
+			],
+			typeArguments: [itemType]
+		}));
+		return this;
+	}
+	/**
+	* A function to withdraw from kiosk
+	* @param address Where to transfer the coin.
+	* @param amount The amount we aim to withdraw.
+	*/
+	withdraw(address, amount) {
+		this.#validateKioskIsSet();
+		const [coin] = this.transaction.add(withdraw({ arguments: [
+			this.kiosk,
+			this.kioskCap,
+			amount == null ? null : BigInt(amount)
+		] }));
+		this.transaction.transferObjects([coin], address);
+		return 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 }) {
+		this.#validateKioskIsSet();
+		const itemArg = typeof item === "string" ? this.transaction.object(item) : item;
+		this.transaction.add(place({
+			arguments: [
+				this.kiosk,
+				this.kioskCap,
+				itemArg
+			],
+			typeArguments: [itemType]
+		}));
+		return 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 }) {
+		this.#validateKioskIsSet();
+		const itemArg = typeof item === "string" ? this.transaction.object(item) : item;
+		const priceArg = typeof price === "string" ? BigInt(price) : price;
+		this.transaction.add(placeAndList({
+			arguments: [
+				this.kiosk,
+				this.kioskCap,
+				itemArg,
+				priceArg
+			],
+			typeArguments: [itemType]
+		}));
+		return 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 }) {
+		this.#validateKioskIsSet();
+		const priceArg = typeof price === "string" ? BigInt(price) : price;
+		this.transaction.add(list({
+			arguments: [
+				this.kiosk,
+				this.kioskCap,
+				itemId,
+				priceArg
+			],
+			typeArguments: [itemType]
+		}));
+		return 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 }) {
+		this.#validateKioskIsSet();
+		this.transaction.add(delist({
+			arguments: [
+				this.kiosk,
+				this.kioskCap,
+				itemId
+			],
+			typeArguments: [itemType]
+		}));
+		return 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 }) {
+		this.#validateKioskIsSet();
+		const [item] = this.transaction.add(take({
+			arguments: [
+				this.kiosk,
+				this.kioskCap,
+				itemId
+			],
+			typeArguments: [itemType]
+		}));
+		return item;
+	}
+	/**
+	* 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 }) {
+		this.#validateKioskIsSet();
+		const item = this.take({
+			itemType,
+			itemId
+		});
+		this.transaction.transferObjects([item], address);
+		return 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 }) {
+		this.#validateKioskIsSet();
+		const itemArg = itemId ? this.transaction.object(itemId) : typeof item === "string" ? this.transaction.object(item) : item;
+		const policyArg = typeof policy === "string" ? this.transaction.object(policy) : policy;
+		this.transaction.add(lock({
+			arguments: [
+				this.kiosk,
+				this.kioskCap,
+				policyArg,
+				itemArg
+			],
+			typeArguments: [itemType]
+		}));
+		return 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 }) {
+		const [coin] = this.transaction.splitCoins(this.transaction.gas, [price]);
+		const kioskArg = typeof sellerKiosk === "string" ? this.transaction.object(sellerKiosk) : sellerKiosk;
+		const [item, transferRequest] = this.transaction.add(purchase({
+			arguments: [
+				kioskArg,
+				itemId,
+				coin
+			],
+			typeArguments: [itemType]
+		}));
+		return [item, transferRequest];
+	}
+	/**
+	* 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.
+	*/
+	async purchaseAndResolve({ itemType, itemId, price, sellerKiosk, extraArgs }) {
+		this.#validateKioskIsSet();
+		const policies = await this.kioskClient.getTransferPolicies({ type: itemType });
+		if (policies.length === 0) throw new Error(`The type ${itemType} doesn't have a Transfer Policy so it can't be traded through kiosk.`);
+		const policy = policies[0];
+		const [purchasedItem, transferRequest] = this.purchase({
+			itemType,
+			itemId,
+			price,
+			sellerKiosk
+		});
+		let canTransferOutsideKiosk = true;
+		for (const rule of policy.rules) {
+			const ruleDefinition = this.kioskClient.rules.find((x) => getNormalizedRuleType(x.rule) === getNormalizedRuleType(rule));
+			if (!ruleDefinition) throw new Error(`No resolver for the following rule: ${rule}.`);
+			if (ruleDefinition.hasLockingRule) canTransferOutsideKiosk = false;
+			await ruleDefinition.resolveRuleFunction({
+				packageId: ruleDefinition.packageId,
+				transaction: this.transaction,
+				itemType,
+				itemId,
+				price: price.toString(),
+				sellerKiosk,
+				policyId: policy.id,
+				transferRequest,
+				purchasedItem,
+				kiosk: this.kiosk,
+				kioskCap: this.kioskCap,
+				extraArgs: extraArgs || {},
+				kioskClient: this.kioskClient
+			});
+		}
+		this.transaction.add(confirmRequest({
+			arguments: [this.transaction.object(policy.id), transferRequest],
+			typeArguments: [itemType]
+		}));
+		if (canTransferOutsideKiosk) this.place({
+			itemType,
+			item: purchasedItem
+		});
+		return 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) {
+		this.#validateFinalizedStatus();
+		this.kiosk = this.transaction.object(cap.kioskId);
+		if (!cap.isPersonal) {
+			this.kioskCap = this.transaction.object(cap.objectId);
+			return;
+		}
+		return this.#borrowFromPersonalCap(cap.objectId);
+	}
+	/**
+	*	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() {
+		this.#validateKioskIsSet();
+		if (this.#pendingShare) this.share();
+		if (!this.#personalCap) {
+			if (this.#pendingTransfer) throw new Error("You need to transfer the `kioskOwnerCap` by calling `shareAndTransferCap()` before wrap");
+			return;
+		}
+		if (this.#promise) {
+			const packageId = this.kioskClient.getRulePackageId("personalKioskRulePackageId");
+			this.transaction.add(returnVal$1({
+				package: packageId,
+				arguments: {
+					self: this.#personalCap,
+					cap: this.kioskCap,
+					borrow: this.#promise
+				}
+			}));
+		}
+		if (this.#pendingTransfer) {
+			const packageId = this.kioskClient.getRulePackageId("personalKioskRulePackageId");
+			this.transaction.add(transferToSender({
+				package: packageId,
+				arguments: { self: this.#personalCap }
+			}));
+		}
+		this.#finalized = true;
+	}
+	setKioskCap(cap) {
+		this.#validateFinalizedStatus();
+		this.kioskCap = cap;
+		return this;
+	}
+	setKiosk(kiosk) {
+		this.#validateFinalizedStatus();
+		this.kiosk = kiosk;
+		return this;
+	}
+	getKiosk() {
+		this.#validateFinalizedStatus();
+		if (!this.kiosk) throw new Error("Kiosk is not set.");
+		return this.kiosk;
+	}
+	getKioskCap() {
+		this.#validateFinalizedStatus();
+		if (!this.kioskCap) throw new Error("Kiosk cap is not set");
+		return this.kioskCap;
+	}
+	/**
+	* A function to borrow from `personalCap`.
+	*/
+	#borrowFromPersonalCap(personalCap) {
+		const packageId = this.kioskClient.getRulePackageId("personalKioskRulePackageId");
+		const personalCapArg = typeof personalCap === "string" ? this.transaction.object(personalCap) : personalCap;
+		const [kioskCap, promise] = this.transaction.add(borrowVal$1({
+			package: packageId,
+			arguments: { self: personalCapArg }
+		}));
+		this.kioskCap = kioskCap;
+		this.#personalCap = personalCapArg;
+		this.#promise = promise;
+		return this;
+	}
+	#setPendingStatuses({ share, transfer }) {
+		if (transfer !== void 0) this.#pendingTransfer = transfer;
+		if (share !== void 0) this.#pendingShare = share;
+	}
+	#validateKioskIsSet() {
+		this.#validateFinalizedStatus();
+		if (!this.kiosk || !this.kioskCap) throw new Error("You need to initialize the client by either supplying an existing owner cap or by creating a new by calling `.create()`");
+	}
+	#validateFinalizedStatus() {
+		if (this.#finalized) throw new Error("You can't add more transactions to a finalized kiosk transaction.");
+	}
+};
+
+//#endregion
+export { KioskTransaction };
+//# sourceMappingURL=kiosk-transaction.mjs.map

package/dist/client/kiosk-transaction.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"kiosk-transaction.mjs","names":["#validateFinalizedStatus","#setPendingStatuses","kioskContract._new","#pendingShare","#validateKioskIsSet","personalKioskContract._new","#borrowFromPersonalCap","#personalCap","kioskContract.borrowVal","kioskContract.returnVal","kioskContract.withdraw","kioskContract.place","kioskContract.placeAndList","kioskContract.list","kioskContract.delist","kioskContract.take","kioskContract.lock","kioskContract.purchase","transferPolicyContract.confirmRequest","#pendingTransfer","#promise","personalKioskContract.returnVal","personalKioskContract.transferToSender","#finalized","personalKioskContract.borrowVal"],"sources":["../../src/client/kiosk-transaction.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport type {\n\tTransaction,\n\tTransactionArgument,\n\tTransactionObjectArgument,\n} from '@mysten/sui/transactions';\n\nimport * as kioskContract from '../contracts/0x2/kiosk.js';\nimport * as transferPolicyContract from '../contracts/0x2/transfer_policy.js';\nimport * as personalKioskContract from '../contracts/kiosk/personal_kiosk.js';\nimport { createKioskAndShare } from '../tx/kiosk.js';\nimport type {\n\tItemId,\n\tItemReference,\n\tItemValue,\n\tKioskOwnerCap,\n\tObjectArgument,\n\tPrice,\n\tPurchaseOptions,\n} from '../types/index.js';\nimport { getNormalizedRuleType } from '../utils.js';\nimport type { KioskClient } from './kiosk-client.js';\n\nexport type KioskTransactionParams = {\n\t/** The Transaction for this run */\n\ttransaction: Transaction;\n\n\t/**\n\t * You can create a new KioskClient by calling `new KioskClient()`\n\t */\n\tkioskClient: KioskClient;\n\t/**\n\t * You can optionally pass in the `cap` as returned\n\t * from `kioskClient.getOwnedKiosks` when initializing the client\n\t * Otherwise, you can set it by calling `kioskTransaction.setCap()`\n\t */\n\tcap?: KioskOwnerCap;\n};\n\n/**\n * A helper for building transactions that involve kiosk.\n */\nexport class KioskTransaction {\n\ttransaction: Transaction;\n\tkioskClient: KioskClient;\n\tkiosk?: TransactionObjectArgument;\n\tkioskCap?: TransactionObjectArgument;\n\t// If we're pending `share` of a new kiosk, `finalize()` will share it.\n\t#pendingShare?: boolean;\n\t// If we're pending transferring of the cap, `finalize()` will either error or transfer the cap if it's a new personal.\n\t#pendingTransfer?: boolean;\n\t// The promise that the personalCap will be returned on `finalize()`.\n\t#promise?: TransactionArgument | undefined;\n\t// The personal kiosk argument.\n\t#personalCap?: TransactionObjectArgument;\n\t// A flag that checks whether kiosk TX is finalized.\n\t#finalized: boolean = false;\n\n\tconstructor({ transaction, kioskClient, cap }: KioskTransactionParams) {\n\t\tthis.transaction = transaction;\n\t\tthis.kioskClient = kioskClient;\n\n\t\tif (cap) this.setCap(cap);\n\t}\n\n\t/**\n\t * Creates a kiosk and saves `kiosk` and `kioskOwnerCap` in state.\n\t * Helpful if we want to chain some actions before sharing + transferring the cap to the specified address.\n\t * @param borrow If true, the `kioskOwnerCap` is borrowed from the `PersonalKioskCap` to be used in next transactions.\n\t */\n\tcreate() {\n\t\tthis.#validateFinalizedStatus();\n\t\tthis.#setPendingStatuses({\n\t\t\tshare: true,\n\t\t\ttransfer: true,\n\t\t});\n\t\tconst [kiosk, cap] = this.transaction.add(kioskContract._new({}));\n\t\tthis.kiosk = kiosk;\n\t\tthis.kioskCap = cap;\n\t\treturn this;\n\t}\n\n\t/**\n\t * Creates a personal kiosk & shares it.\n\t * The `PersonalKioskCap` is transferred to the signer.\n\t * @param borrow If true, the `kioskOwnerCap` is borrowed from the `PersonalKioskCap` to be used in next transactions.\n\t */\n\tcreatePersonal(borrow?: boolean) {\n\t\tthis.#pendingShare = true;\n\t\treturn this.create().convertToPersonal(borrow);\n\t}\n\n\t/**\n\t * Converts a kiosk to a Personal (Soulbound) Kiosk.\n\t * Requires initialization by either calling `ktxb.create()` or `ktxb.setCap()`.\n\t */\n\tconvertToPersonal(borrow?: boolean) {\n\t\tthis.#validateKioskIsSet();\n\n\t\tconst packageId = this.kioskClient.getRulePackageId('personalKioskRulePackageId');\n\n\t\tconst [cap] = this.transaction.add(\n\t\t\tpersonalKioskContract._new({\n\t\t\t\tpackage: packageId,\n\t\t\t\targuments: {\n\t\t\t\t\tkiosk: this.kiosk!,\n\t\t\t\t\tcap: this.kioskCap!,\n\t\t\t\t},\n\t\t\t}),\n\t\t);\n\n\t\t// if we enable `borrow`, we borrow the kioskCap from the cap.\n\t\tif (borrow) this.#borrowFromPersonalCap(cap);\n\t\telse this.#personalCap = cap;\n\n\t\tthis.#setPendingStatuses({ transfer: true });\n\t\treturn this;\n\t}\n\n\t/**\n\t * Single function way to create a kiosk, share it and transfer the cap to the specified address.\n\t */\n\tcreateAndShare(address: string) {\n\t\tthis.#validateFinalizedStatus();\n\t\tconst cap = createKioskAndShare(this.transaction);\n\t\tthis.transaction.transferObjects([cap], address);\n\t\treturn this;\n\t}\n\n\t/**\n\t * Shares the kiosk.\n\t */\n\tshare() {\n\t\tthis.#validateKioskIsSet();\n\t\tthis.#setPendingStatuses({ share: false });\n\t\tthis.transaction.moveCall({\n\t\t\ttarget: '0x2::transfer::public_share_object',\n\t\t\targuments: [this.kiosk!],\n\t\t\ttypeArguments: ['0x2::kiosk::Kiosk'],\n\t\t});\n\t\treturn this;\n\t}\n\n\t/**\n\t * Should be called only after `create` is called.\n\t * It shares the kiosk & transfers the cap to the specified address.\n\t */\n\tshareAndTransferCap(address: string) {\n\t\tif (this.#personalCap)\n\t\t\tthrow new Error('You can only call `shareAndTransferCap` on a non-personal kiosk.');\n\t\tthis.#setPendingStatuses({ transfer: false });\n\t\tthis.share();\n\t\tthis.transaction.transferObjects([this.kioskCap!], address);\n\t\treturn this;\n\t}\n\n\t/**\n\t * A function to borrow an item from a kiosk & execute any function with it.\n\t * Example: You could borrow a Fren out of a kiosk, attach an accessory (or mix), and return it.\n\t */\n\tborrowTx({ itemType, itemId }: ItemId, callback: (item: TransactionArgument) => void) {\n\t\tthis.#validateKioskIsSet();\n\t\tconst [itemObj, promise] = this.transaction.add(\n\t\t\tkioskContract.borrowVal({\n\t\t\t\targuments: [this.kiosk!, this.kioskCap!, itemId],\n\t\t\t\ttypeArguments: [itemType],\n\t\t\t}),\n\t\t);\n\n\t\tcallback(itemObj);\n\n\t\treturn this.return({ itemType, item: itemObj, promise });\n\t}\n\n\t/**\n\t * Borrows an item from the kiosk.\n\t * This will fail if the item is listed for sale.\n\t *\n\t * Requires calling `return`.\n\t */\n\tborrow({ itemType, itemId }: ItemId): [TransactionArgument, TransactionArgument] {\n\t\tthis.#validateKioskIsSet();\n\t\tconst [itemObj, promise] = this.transaction.add(\n\t\t\tkioskContract.borrowVal({\n\t\t\t\targuments: [this.kiosk!, this.kioskCap!, itemId],\n\t\t\t\ttypeArguments: [itemType],\n\t\t\t}),\n\t\t);\n\n\t\treturn [itemObj, promise];\n\t}\n\n\t/**\n\t * Returns the item back to the kiosk.\n\t * Accepts the parameters returned from the `borrow` function.\n\t */\n\treturn({ itemType, item, promise }: ItemValue & { promise: TransactionArgument }) {\n\t\tthis.#validateKioskIsSet();\n\t\tthis.transaction.add(\n\t\t\tkioskContract.returnVal({\n\t\t\t\targuments: [this.kiosk!, item, promise],\n\t\t\t\ttypeArguments: [itemType],\n\t\t\t}),\n\t\t);\n\t\treturn this;\n\t}\n\n\t/**\n\t * A function to withdraw from kiosk\n\t * @param address Where to transfer the coin.\n\t * @param amount The amount we aim to withdraw.\n\t */\n\twithdraw(address: string, amount?: string | bigint | number) {\n\t\tthis.#validateKioskIsSet();\n\n\t\tconst [coin] = this.transaction.add(\n\t\t\tkioskContract.withdraw({\n\t\t\t\targuments: [this.kiosk!, this.kioskCap!, amount == null ? null : BigInt(amount)],\n\t\t\t}),\n\t\t);\n\t\tthis.transaction.transferObjects([coin], address);\n\t\treturn this;\n\t}\n\n\t/**\n\t * A function to place an item in the kiosk.\n\t * @param itemType The type `T` of the item\n\t * @param item The ID or Transaction Argument of the item\n\t */\n\tplace({ itemType, item }: ItemReference) {\n\t\tthis.#validateKioskIsSet();\n\t\tconst itemArg = typeof item === 'string' ? this.transaction.object(item) : item;\n\t\tthis.transaction.add(\n\t\t\tkioskContract.place({\n\t\t\t\targuments: [this.kiosk!, this.kioskCap!, itemArg],\n\t\t\t\ttypeArguments: [itemType],\n\t\t\t}),\n\t\t);\n\t\treturn this;\n\t}\n\n\t/**\n\t * A function to place an item in the kiosk and list it for sale in one transaction.\n\t * @param itemType The type `T` of the item\n\t * @param item The ID or Transaction Argument of the item\n\t * @param price The price in MIST\n\t */\n\tplaceAndList({ itemType, item, price }: ItemReference & Price) {\n\t\tthis.#validateKioskIsSet();\n\t\tconst itemArg = typeof item === 'string' ? this.transaction.object(item) : item;\n\t\tconst priceArg = typeof price === 'string' ? BigInt(price) : price;\n\t\tthis.transaction.add(\n\t\t\tkioskContract.placeAndList({\n\t\t\t\targuments: [this.kiosk!, this.kioskCap!, itemArg, priceArg],\n\t\t\t\ttypeArguments: [itemType],\n\t\t\t}),\n\t\t);\n\t\treturn this;\n\t}\n\n\t/**\n\t * A function to list an item in the kiosk.\n\t * @param itemType The type `T` of the item\n\t * @param itemId The ID of the item\n\t * @param price The price in MIST\n\t */\n\tlist({ itemType, itemId, price }: ItemId & { price: string | bigint }) {\n\t\tthis.#validateKioskIsSet();\n\t\tconst priceArg = typeof price === 'string' ? BigInt(price) : price;\n\t\tthis.transaction.add(\n\t\t\tkioskContract.list({\n\t\t\t\targuments: [this.kiosk!, this.kioskCap!, itemId, priceArg],\n\t\t\t\ttypeArguments: [itemType],\n\t\t\t}),\n\t\t);\n\t\treturn this;\n\t}\n\n\t/**\n\t * A function to delist an item from the kiosk.\n\t * @param itemType The type `T` of the item\n\t * @param itemId The ID of the item\n\t */\n\tdelist({ itemType, itemId }: ItemId) {\n\t\tthis.#validateKioskIsSet();\n\t\tthis.transaction.add(\n\t\t\tkioskContract.delist({\n\t\t\t\targuments: [this.kiosk!, this.kioskCap!, itemId],\n\t\t\t\ttypeArguments: [itemType],\n\t\t\t}),\n\t\t);\n\t\treturn this;\n\t}\n\n\t/**\n\t * A function to take an item from the kiosk. The transaction won't succeed if the item is listed or locked.\n\n\t * @param itemType The type `T` of the item\n\t * @param itemId The ID of the item\n\t */\n\ttake({ itemType, itemId }: ItemId): TransactionObjectArgument {\n\t\tthis.#validateKioskIsSet();\n\t\tconst [item] = this.transaction.add(\n\t\t\tkioskContract.take({\n\t\t\t\targuments: [this.kiosk!, this.kioskCap!, itemId],\n\t\t\t\ttypeArguments: [itemType],\n\t\t\t}),\n\t\t);\n\t\treturn item;\n\t}\n\n\t/**\n\t * Transfer a non-locked/non-listed item to an address.\n\t *\n\t * @param itemType The type `T` of the item\n\t * @param itemId The ID of the item\n\t * @param address The destination address\n\t */\n\ttransfer({ itemType, itemId, address }: ItemId & { address: string }) {\n\t\tthis.#validateKioskIsSet();\n\t\tconst item = this.take({ itemType, itemId });\n\t\tthis.transaction.transferObjects([item], address);\n\t\treturn this;\n\t}\n\n\t/**\n\t * A function to take lock an item in the kiosk.\n\n\t * @param itemType The type `T` of the item\n\t * @param item The ID or Transaction Argument of the item\n\t * @param itemId The ID of the item - Deprecated: Use `item` instead.\n\t * @param policy The Policy ID or Transaction Argument for item T\n\t */\n\tlock({\n\t\titemType,\n\t\titem,\n\t\titemId,\n\t\tpolicy,\n\t}: ItemReference & { policy: ObjectArgument; itemId?: string }) {\n\t\tthis.#validateKioskIsSet();\n\t\tconst itemArg = itemId\n\t\t\t? this.transaction.object(itemId)\n\t\t\t: typeof item === 'string'\n\t\t\t\t? this.transaction.object(item)\n\t\t\t\t: item;\n\t\tconst policyArg = typeof policy === 'string' ? this.transaction.object(policy) : policy;\n\t\tthis.transaction.add(\n\t\t\tkioskContract.lock({\n\t\t\t\targuments: [this.kiosk!, this.kioskCap!, policyArg, itemArg],\n\t\t\t\ttypeArguments: [itemType],\n\t\t\t}),\n\t\t);\n\t\treturn this;\n\t}\n\n\t/**\n\t * Purchase an item from a seller's kiosk.\n\t * Returns [item, transferRequest]\n\t * Can be called like: `const [item, transferRequest] = kioskTx.purchase({...})`\n\t * @param itemType The type `T` of the item\n\t * @param itemId The ID of the item\n\t * @param price The price in MIST\n\t * @param sellerKiosk The kiosk which is selling the item. Can be an id or an object argument.\n\t */\n\tpurchase({\n\t\titemType,\n\t\titemId,\n\t\tprice,\n\t\tsellerKiosk,\n\t}: ItemId & Price & { sellerKiosk: ObjectArgument }): [\n\t\tTransactionObjectArgument,\n\t\tTransactionObjectArgument,\n\t] {\n\t\t// Split the coin for the amount of the listing.\n\t\tconst [coin] = this.transaction.splitCoins(this.transaction.gas, [price]);\n\t\tconst kioskArg =\n\t\t\ttypeof sellerKiosk === 'string' ? this.transaction.object(sellerKiosk) : sellerKiosk;\n\t\tconst [item, transferRequest] = this.transaction.add(\n\t\t\tkioskContract.purchase({\n\t\t\t\targuments: [kioskArg, itemId, coin],\n\t\t\t\ttypeArguments: [itemType],\n\t\t\t}),\n\t\t);\n\t\treturn [item, transferRequest];\n\t}\n\n\t/**\n\t * A function to purchase and resolve a transfer policy.\n\t * If the transfer policy has the `lock` rule, the item is locked in the kiosk.\n\t * Otherwise, the item is placed in the kiosk.\n\t * @param itemType The type of the item\n\t * @param itemId The id of the item\n\t * @param price The price of the specified item\n\t * @param sellerKiosk The kiosk which is selling the item. Can be an id or an object argument.\n\t * @param extraArgs Used to pass arguments for custom rule resolvers.\n\t */\n\tasync purchaseAndResolve({\n\t\titemType,\n\t\titemId,\n\t\tprice,\n\t\tsellerKiosk,\n\t\textraArgs,\n\t}: ItemId & Price & { sellerKiosk: ObjectArgument } & PurchaseOptions) {\n\t\tthis.#validateKioskIsSet();\n\t\t// Get a list of the transfer policies.\n\t\tconst policies = await this.kioskClient.getTransferPolicies({ type: itemType });\n\n\t\tif (policies.length === 0) {\n\t\t\tthrow new Error(\n\t\t\t\t`The type ${itemType} doesn't have a Transfer Policy so it can't be traded through kiosk.`,\n\t\t\t);\n\t\t}\n\n\t\tconst policy = policies[0]; // we now pick the first one. We need to add an option to define which one.\n\n\t\t// initialize the purchase `kiosk::purchase`\n\t\tconst [purchasedItem, transferRequest] = this.purchase({\n\t\t\titemType,\n\t\t\titemId,\n\t\t\tprice,\n\t\t\tsellerKiosk,\n\t\t});\n\n\t\tlet canTransferOutsideKiosk = true;\n\n\t\tfor (const rule of policy.rules) {\n\t\t\tconst ruleDefinition = this.kioskClient.rules.find(\n\t\t\t\t(x) => getNormalizedRuleType(x.rule) === getNormalizedRuleType(rule),\n\t\t\t);\n\t\t\tif (!ruleDefinition) throw new Error(`No resolver for the following rule: ${rule}.`);\n\n\t\t\tif (ruleDefinition.hasLockingRule) canTransferOutsideKiosk = false;\n\n\t\t\tawait ruleDefinition.resolveRuleFunction({\n\t\t\t\tpackageId: ruleDefinition.packageId,\n\t\t\t\ttransaction: this.transaction,\n\t\t\t\titemType,\n\t\t\t\titemId,\n\t\t\t\tprice: price.toString(),\n\t\t\t\tsellerKiosk,\n\t\t\t\tpolicyId: policy.id,\n\t\t\t\ttransferRequest,\n\t\t\t\tpurchasedItem,\n\t\t\t\tkiosk: this.kiosk!,\n\t\t\t\tkioskCap: this.kioskCap!,\n\t\t\t\textraArgs: extraArgs || {},\n\t\t\t\tkioskClient: this.kioskClient,\n\t\t\t});\n\t\t}\n\n\t\tthis.transaction.add(\n\t\t\ttransferPolicyContract.confirmRequest({\n\t\t\t\targuments: [this.transaction.object(policy.id), transferRequest],\n\t\t\t\ttypeArguments: [itemType],\n\t\t\t}),\n\t\t);\n\n\t\tif (canTransferOutsideKiosk) this.place({ itemType, item: purchasedItem });\n\n\t\treturn this;\n\t}\n\n\t/**\n\t * A function to setup the client using an existing `ownerCap`,\n\t * as return from the `kioskClient.getOwnedKiosks` function.\n\t * @param cap `KioskOwnerCap` object as returned from `getOwnedKiosks` SDK call.\n\t */\n\tsetCap(cap: KioskOwnerCap) {\n\t\tthis.#validateFinalizedStatus();\n\t\tthis.kiosk = this.transaction.object(cap.kioskId);\n\t\tif (!cap.isPersonal) {\n\t\t\tthis.kioskCap = this.transaction.object(cap.objectId);\n\t\t\treturn;\n\t\t}\n\n\t\treturn this.#borrowFromPersonalCap(cap.objectId);\n\t}\n\n\t/**\n\t *\tA function that ends up the kiosk building tx & returns the `kioskOwnerCap` back to the\n\t *  `PersonalKioskCap`, in case we are operating on a personal kiosk.\n\t * \tIt will also share the `kiosk` if it's not shared, and finalize the transfer of the personal cap if it's pending.\n\t */\n\tfinalize() {\n\t\tthis.#validateKioskIsSet();\n\t\t// If we're pending the sharing of the new kiosk, share it.\n\t\tif (this.#pendingShare) this.share();\n\n\t\t// If we're operating on a non-personal kiosk, we don't need to do anything else.\n\t\tif (!this.#personalCap) {\n\t\t\t// If we're pending transfer though, we inform user to call `shareAndTransferCap()`.\n\t\t\tif (this.#pendingTransfer)\n\t\t\t\tthrow new Error(\n\t\t\t\t\t'You need to transfer the `kioskOwnerCap` by calling `shareAndTransferCap()` before wrap',\n\t\t\t\t);\n\t\t\treturn;\n\t\t}\n\n\t\t// if we have a promise, return the `ownerCap` back to the personal cap.\n\t\tif (this.#promise) {\n\t\t\tconst packageId = this.kioskClient.getRulePackageId('personalKioskRulePackageId');\n\n\t\t\tthis.transaction.add(\n\t\t\t\tpersonalKioskContract.returnVal({\n\t\t\t\t\tpackage: packageId,\n\t\t\t\t\targuments: {\n\t\t\t\t\t\tself: this.#personalCap,\n\t\t\t\t\t\tcap: this.kioskCap!,\n\t\t\t\t\t\tborrow: this.#promise,\n\t\t\t\t\t},\n\t\t\t\t}),\n\t\t\t);\n\t\t}\n\n\t\t// If we are pending transferring the personalCap, we do it here.\n\t\tif (this.#pendingTransfer) {\n\t\t\tconst packageId = this.kioskClient.getRulePackageId('personalKioskRulePackageId');\n\n\t\t\tthis.transaction.add(\n\t\t\t\tpersonalKioskContract.transferToSender({\n\t\t\t\t\tpackage: packageId,\n\t\t\t\t\targuments: { self: this.#personalCap },\n\t\t\t\t}),\n\t\t\t);\n\t\t}\n\n\t\t// Mark the transaction as finalized, so no other functions can be called.\n\t\tthis.#finalized = true;\n\t}\n\n\t// Some setters in case we want custom behavior.\n\tsetKioskCap(cap: TransactionObjectArgument) {\n\t\tthis.#validateFinalizedStatus();\n\t\tthis.kioskCap = cap;\n\t\treturn this;\n\t}\n\n\tsetKiosk(kiosk: TransactionObjectArgument) {\n\t\tthis.#validateFinalizedStatus();\n\t\tthis.kiosk = kiosk;\n\t\treturn this;\n\t}\n\n\t// Some getters\n\t/*\n\t * Returns the active transaction's kiosk, or undefined if `setCap` or `create()` hasn't been called yet.\n\t */\n\tgetKiosk() {\n\t\tthis.#validateFinalizedStatus();\n\t\tif (!this.kiosk) throw new Error('Kiosk is not set.');\n\t\treturn this.kiosk;\n\t}\n\n\t/*\n\t * Returns the active transaction's kioskOwnerCap, or undefined if `setCap` or `create()` hasn't been called yet.\n\t */\n\tgetKioskCap() {\n\t\tthis.#validateFinalizedStatus();\n\t\tif (!this.kioskCap) throw new Error('Kiosk cap is not set');\n\t\treturn this.kioskCap;\n\t}\n\n\t/**\n\t * A function to borrow from `personalCap`.\n\t */\n\t#borrowFromPersonalCap(personalCap: ObjectArgument) {\n\t\tconst packageId = this.kioskClient.getRulePackageId('personalKioskRulePackageId');\n\t\tconst personalCapArg =\n\t\t\ttypeof personalCap === 'string' ? this.transaction.object(personalCap) : personalCap;\n\t\tconst [kioskCap, promise] = this.transaction.add(\n\t\t\tpersonalKioskContract.borrowVal({\n\t\t\t\tpackage: packageId,\n\t\t\t\targuments: { self: personalCapArg },\n\t\t\t}),\n\t\t);\n\n\t\tthis.kioskCap = kioskCap;\n\t\tthis.#personalCap = personalCapArg;\n\t\tthis.#promise = promise;\n\n\t\treturn this;\n\t}\n\n\t#setPendingStatuses({ share, transfer }: { share?: boolean; transfer?: boolean }) {\n\t\tif (transfer !== undefined) this.#pendingTransfer = transfer;\n\t\tif (share !== undefined) this.#pendingShare = share;\n\t}\n\n\t#validateKioskIsSet() {\n\t\tthis.#validateFinalizedStatus();\n\n\t\tif (!this.kiosk || !this.kioskCap)\n\t\t\tthrow new Error(\n\t\t\t\t'You need to initialize the client by either supplying an existing owner cap or by creating a new by calling `.create()`',\n\t\t\t);\n\t}\n\n\t// Validates that `finalize`\n\t#validateFinalizedStatus() {\n\t\tif (this.#finalized)\n\t\t\tthrow new Error(\"You can't add more transactions to a finalized kiosk transaction.\");\n\t}\n}\n"],"mappings":";;;;;;;;;;AA4CA,IAAa,mBAAb,MAA8B;CAM7B;CAEA;CAEA;CAEA;CAEA,aAAsB;CAEtB,YAAY,EAAE,aAAa,aAAa,OAA+B;AACtE,OAAK,cAAc;AACnB,OAAK,cAAc;AAEnB,MAAI,IAAK,MAAK,OAAO,IAAI;;;;;;;CAQ1B,SAAS;AACR,QAAKA,yBAA0B;AAC/B,QAAKC,mBAAoB;GACxB,OAAO;GACP,UAAU;GACV,CAAC;EACF,MAAM,CAAC,OAAO,OAAO,KAAK,YAAY,IAAIC,KAAmB,EAAE,CAAC,CAAC;AACjE,OAAK,QAAQ;AACb,OAAK,WAAW;AAChB,SAAO;;;;;;;CAQR,eAAe,QAAkB;AAChC,QAAKC,eAAgB;AACrB,SAAO,KAAK,QAAQ,CAAC,kBAAkB,OAAO;;;;;;CAO/C,kBAAkB,QAAkB;AACnC,QAAKC,oBAAqB;EAE1B,MAAM,YAAY,KAAK,YAAY,iBAAiB,6BAA6B;EAEjF,MAAM,CAAC,OAAO,KAAK,YAAY,IAC9BC,OAA2B;GAC1B,SAAS;GACT,WAAW;IACV,OAAO,KAAK;IACZ,KAAK,KAAK;IACV;GACD,CAAC,CACF;AAGD,MAAI,OAAQ,OAAKC,sBAAuB,IAAI;MACvC,OAAKC,cAAe;AAEzB,QAAKN,mBAAoB,EAAE,UAAU,MAAM,CAAC;AAC5C,SAAO;;;;;CAMR,eAAe,SAAiB;AAC/B,QAAKD,yBAA0B;EAC/B,MAAM,MAAM,oBAAoB,KAAK,YAAY;AACjD,OAAK,YAAY,gBAAgB,CAAC,IAAI,EAAE,QAAQ;AAChD,SAAO;;;;;CAMR,QAAQ;AACP,QAAKI,oBAAqB;AAC1B,QAAKH,mBAAoB,EAAE,OAAO,OAAO,CAAC;AAC1C,OAAK,YAAY,SAAS;GACzB,QAAQ;GACR,WAAW,CAAC,KAAK,MAAO;GACxB,eAAe,CAAC,oBAAoB;GACpC,CAAC;AACF,SAAO;;;;;;CAOR,oBAAoB,SAAiB;AACpC,MAAI,MAAKM,YACR,OAAM,IAAI,MAAM,mEAAmE;AACpF,QAAKN,mBAAoB,EAAE,UAAU,OAAO,CAAC;AAC7C,OAAK,OAAO;AACZ,OAAK,YAAY,gBAAgB,CAAC,KAAK,SAAU,EAAE,QAAQ;AAC3D,SAAO;;;;;;CAOR,SAAS,EAAE,UAAU,UAAkB,UAA+C;AACrF,QAAKG,oBAAqB;EAC1B,MAAM,CAAC,SAAS,WAAW,KAAK,YAAY,IAC3CI,UAAwB;GACvB,WAAW;IAAC,KAAK;IAAQ,KAAK;IAAW;IAAO;GAChD,eAAe,CAAC,SAAS;GACzB,CAAC,CACF;AAED,WAAS,QAAQ;AAEjB,SAAO,KAAK,OAAO;GAAE;GAAU,MAAM;GAAS;GAAS,CAAC;;;;;;;;CASzD,OAAO,EAAE,UAAU,UAA8D;AAChF,QAAKJ,oBAAqB;EAC1B,MAAM,CAAC,SAAS,WAAW,KAAK,YAAY,IAC3CI,UAAwB;GACvB,WAAW;IAAC,KAAK;IAAQ,KAAK;IAAW;IAAO;GAChD,eAAe,CAAC,SAAS;GACzB,CAAC,CACF;AAED,SAAO,CAAC,SAAS,QAAQ;;;;;;CAO1B,OAAO,EAAE,UAAU,MAAM,WAAyD;AACjF,QAAKJ,oBAAqB;AAC1B,OAAK,YAAY,IAChBK,UAAwB;GACvB,WAAW;IAAC,KAAK;IAAQ;IAAM;IAAQ;GACvC,eAAe,CAAC,SAAS;GACzB,CAAC,CACF;AACD,SAAO;;;;;;;CAQR,SAAS,SAAiB,QAAmC;AAC5D,QAAKL,oBAAqB;EAE1B,MAAM,CAAC,QAAQ,KAAK,YAAY,IAC/BM,SAAuB,EACtB,WAAW;GAAC,KAAK;GAAQ,KAAK;GAAW,UAAU,OAAO,OAAO,OAAO,OAAO;GAAC,EAChF,CAAC,CACF;AACD,OAAK,YAAY,gBAAgB,CAAC,KAAK,EAAE,QAAQ;AACjD,SAAO;;;;;;;CAQR,MAAM,EAAE,UAAU,QAAuB;AACxC,QAAKN,oBAAqB;EAC1B,MAAM,UAAU,OAAO,SAAS,WAAW,KAAK,YAAY,OAAO,KAAK,GAAG;AAC3E,OAAK,YAAY,IAChBO,MAAoB;GACnB,WAAW;IAAC,KAAK;IAAQ,KAAK;IAAW;IAAQ;GACjD,eAAe,CAAC,SAAS;GACzB,CAAC,CACF;AACD,SAAO;;;;;;;;CASR,aAAa,EAAE,UAAU,MAAM,SAAgC;AAC9D,QAAKP,oBAAqB;EAC1B,MAAM,UAAU,OAAO,SAAS,WAAW,KAAK,YAAY,OAAO,KAAK,GAAG;EAC3E,MAAM,WAAW,OAAO,UAAU,WAAW,OAAO,MAAM,GAAG;AAC7D,OAAK,YAAY,IAChBQ,aAA2B;GAC1B,WAAW;IAAC,KAAK;IAAQ,KAAK;IAAW;IAAS;IAAS;GAC3D,eAAe,CAAC,SAAS;GACzB,CAAC,CACF;AACD,SAAO;;;;;;;;CASR,KAAK,EAAE,UAAU,QAAQ,SAA8C;AACtE,QAAKR,oBAAqB;EAC1B,MAAM,WAAW,OAAO,UAAU,WAAW,OAAO,MAAM,GAAG;AAC7D,OAAK,YAAY,IAChBS,KAAmB;GAClB,WAAW;IAAC,KAAK;IAAQ,KAAK;IAAW;IAAQ;IAAS;GAC1D,eAAe,CAAC,SAAS;GACzB,CAAC,CACF;AACD,SAAO;;;;;;;CAQR,OAAO,EAAE,UAAU,UAAkB;AACpC,QAAKT,oBAAqB;AAC1B,OAAK,YAAY,IAChBU,OAAqB;GACpB,WAAW;IAAC,KAAK;IAAQ,KAAK;IAAW;IAAO;GAChD,eAAe,CAAC,SAAS;GACzB,CAAC,CACF;AACD,SAAO;;;;;;;;CASR,KAAK,EAAE,UAAU,UAA6C;AAC7D,QAAKV,oBAAqB;EAC1B,MAAM,CAAC,QAAQ,KAAK,YAAY,IAC/BW,KAAmB;GAClB,WAAW;IAAC,KAAK;IAAQ,KAAK;IAAW;IAAO;GAChD,eAAe,CAAC,SAAS;GACzB,CAAC,CACF;AACD,SAAO;;;;;;;;;CAUR,SAAS,EAAE,UAAU,QAAQ,WAAyC;AACrE,QAAKX,oBAAqB;EAC1B,MAAM,OAAO,KAAK,KAAK;GAAE;GAAU;GAAQ,CAAC;AAC5C,OAAK,YAAY,gBAAgB,CAAC,KAAK,EAAE,QAAQ;AACjD,SAAO;;;;;;;;;;CAWR,KAAK,EACJ,UACA,MACA,QACA,UAC+D;AAC/D,QAAKA,oBAAqB;EAC1B,MAAM,UAAU,SACb,KAAK,YAAY,OAAO,OAAO,GAC/B,OAAO,SAAS,WACf,KAAK,YAAY,OAAO,KAAK,GAC7B;EACJ,MAAM,YAAY,OAAO,WAAW,WAAW,KAAK,YAAY,OAAO,OAAO,GAAG;AACjF,OAAK,YAAY,IAChBY,KAAmB;GAClB,WAAW;IAAC,KAAK;IAAQ,KAAK;IAAW;IAAW;IAAQ;GAC5D,eAAe,CAAC,SAAS;GACzB,CAAC,CACF;AACD,SAAO;;;;;;;;;;;CAYR,SAAS,EACR,UACA,QACA,OACA,eAIC;EAED,MAAM,CAAC,QAAQ,KAAK,YAAY,WAAW,KAAK,YAAY,KAAK,CAAC,MAAM,CAAC;EACzE,MAAM,WACL,OAAO,gBAAgB,WAAW,KAAK,YAAY,OAAO,YAAY,GAAG;EAC1E,MAAM,CAAC,MAAM,mBAAmB,KAAK,YAAY,IAChDC,SAAuB;GACtB,WAAW;IAAC;IAAU;IAAQ;IAAK;GACnC,eAAe,CAAC,SAAS;GACzB,CAAC,CACF;AACD,SAAO,CAAC,MAAM,gBAAgB;;;;;;;;;;;;CAa/B,MAAM,mBAAmB,EACxB,UACA,QACA,OACA,aACA,aACsE;AACtE,QAAKb,oBAAqB;EAE1B,MAAM,WAAW,MAAM,KAAK,YAAY,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAE/E,MAAI,SAAS,WAAW,EACvB,OAAM,IAAI,MACT,YAAY,SAAS,sEACrB;EAGF,MAAM,SAAS,SAAS;EAGxB,MAAM,CAAC,eAAe,mBAAmB,KAAK,SAAS;GACtD;GACA;GACA;GACA;GACA,CAAC;EAEF,IAAI,0BAA0B;AAE9B,OAAK,MAAM,QAAQ,OAAO,OAAO;GAChC,MAAM,iBAAiB,KAAK,YAAY,MAAM,MAC5C,MAAM,sBAAsB,EAAE,KAAK,KAAK,sBAAsB,KAAK,CACpE;AACD,OAAI,CAAC,eAAgB,OAAM,IAAI,MAAM,uCAAuC,KAAK,GAAG;AAEpF,OAAI,eAAe,eAAgB,2BAA0B;AAE7D,SAAM,eAAe,oBAAoB;IACxC,WAAW,eAAe;IAC1B,aAAa,KAAK;IAClB;IACA;IACA,OAAO,MAAM,UAAU;IACvB;IACA,UAAU,OAAO;IACjB;IACA;IACA,OAAO,KAAK;IACZ,UAAU,KAAK;IACf,WAAW,aAAa,EAAE;IAC1B,aAAa,KAAK;IAClB,CAAC;;AAGH,OAAK,YAAY,IAChBc,eAAsC;GACrC,WAAW,CAAC,KAAK,YAAY,OAAO,OAAO,GAAG,EAAE,gBAAgB;GAChE,eAAe,CAAC,SAAS;GACzB,CAAC,CACF;AAED,MAAI,wBAAyB,MAAK,MAAM;GAAE;GAAU,MAAM;GAAe,CAAC;AAE1E,SAAO;;;;;;;CAQR,OAAO,KAAoB;AAC1B,QAAKlB,yBAA0B;AAC/B,OAAK,QAAQ,KAAK,YAAY,OAAO,IAAI,QAAQ;AACjD,MAAI,CAAC,IAAI,YAAY;AACpB,QAAK,WAAW,KAAK,YAAY,OAAO,IAAI,SAAS;AACrD;;AAGD,SAAO,MAAKM,sBAAuB,IAAI,SAAS;;;;;;;CAQjD,WAAW;AACV,QAAKF,oBAAqB;AAE1B,MAAI,MAAKD,aAAe,MAAK,OAAO;AAGpC,MAAI,CAAC,MAAKI,aAAc;AAEvB,OAAI,MAAKY,gBACR,OAAM,IAAI,MACT,0FACA;AACF;;AAID,MAAI,MAAKC,SAAU;GAClB,MAAM,YAAY,KAAK,YAAY,iBAAiB,6BAA6B;AAEjF,QAAK,YAAY,IAChBC,YAAgC;IAC/B,SAAS;IACT,WAAW;KACV,MAAM,MAAKd;KACX,KAAK,KAAK;KACV,QAAQ,MAAKa;KACb;IACD,CAAC,CACF;;AAIF,MAAI,MAAKD,iBAAkB;GAC1B,MAAM,YAAY,KAAK,YAAY,iBAAiB,6BAA6B;AAEjF,QAAK,YAAY,IAChBG,iBAAuC;IACtC,SAAS;IACT,WAAW,EAAE,MAAM,MAAKf,aAAc;IACtC,CAAC,CACF;;AAIF,QAAKgB,YAAa;;CAInB,YAAY,KAAgC;AAC3C,QAAKvB,yBAA0B;AAC/B,OAAK,WAAW;AAChB,SAAO;;CAGR,SAAS,OAAkC;AAC1C,QAAKA,yBAA0B;AAC/B,OAAK,QAAQ;AACb,SAAO;;CAOR,WAAW;AACV,QAAKA,yBAA0B;AAC/B,MAAI,CAAC,KAAK,MAAO,OAAM,IAAI,MAAM,oBAAoB;AACrD,SAAO,KAAK;;CAMb,cAAc;AACb,QAAKA,yBAA0B;AAC/B,MAAI,CAAC,KAAK,SAAU,OAAM,IAAI,MAAM,uBAAuB;AAC3D,SAAO,KAAK;;;;;CAMb,uBAAuB,aAA6B;EACnD,MAAM,YAAY,KAAK,YAAY,iBAAiB,6BAA6B;EACjF,MAAM,iBACL,OAAO,gBAAgB,WAAW,KAAK,YAAY,OAAO,YAAY,GAAG;EAC1E,MAAM,CAAC,UAAU,WAAW,KAAK,YAAY,IAC5CwB,YAAgC;GAC/B,SAAS;GACT,WAAW,EAAE,MAAM,gBAAgB;GACnC,CAAC,CACF;AAED,OAAK,WAAW;AAChB,QAAKjB,cAAe;AACpB,QAAKa,UAAW;AAEhB,SAAO;;CAGR,oBAAoB,EAAE,OAAO,YAAqD;AACjF,MAAI,aAAa,OAAW,OAAKD,kBAAmB;AACpD,MAAI,UAAU,OAAW,OAAKhB,eAAgB;;CAG/C,sBAAsB;AACrB,QAAKH,yBAA0B;AAE/B,MAAI,CAAC,KAAK,SAAS,CAAC,KAAK,SACxB,OAAM,IAAI,MACT,0HACA;;CAIH,2BAA2B;AAC1B,MAAI,MAAKuB,UACR,OAAM,IAAI,MAAM,oEAAoE"}

package/dist/client/tp-transaction.d.mts

@@ -0,0 +1,139 @@
+import { KioskClient } from "./kiosk-client.mjs";
+import { TransferPolicyCap } from "../types/transfer-policy.mjs";
+import { ObjectArgument } from "../types/index.mjs";
+import { Transaction } from "@mysten/sui/transactions";
+
+//#region src/client/tp-transaction.d.ts
+type TransferPolicyBaseParams = {
+  type: string;
+  publisher: ObjectArgument;
+  skipCheck?: boolean;
+};
+type TransferPolicyTransactionParams = {
+  kioskClient: KioskClient;
+  transaction: Transaction;
+  cap?: TransferPolicyCap;
+};
+declare class TransferPolicyTransaction {
+  #private;
+  transaction: Transaction;
+  kioskClient: KioskClient;
+  policy?: ObjectArgument;
+  policyCap?: ObjectArgument;
+  type?: string;
+  constructor({
+    kioskClient,
+    transaction,
+    cap
+  }: TransferPolicyTransactionParams);
+  /**
+   * A function to create a new transfer policy.
+   * Checks if there's already an existing transfer policy to prevent
+   * double transfer polciy mistakes.
+   * There's an optional `skipCheck` flag that will just create the policy
+   * without checking
+   *
+   * @param type The Type (`T`) for which we're creating the transfer policy.
+   * @param publisher The Publisher Object Id.
+   * @param address Address to save the `TransferPolicyCap` object to.
+   * @param skipCheck (Optional) skip checking if a transfer policy already exists
+   */
+  createAndShare({
+    type,
+    publisher,
+    address,
+    skipCheck
+  }: TransferPolicyBaseParams & {
+    address: string;
+  }): Promise<void>;
+  /**
+   * A convenient function to create a Transfer Policy and attach some rules
+   * before sharing it (so you can prepare it in a single PTB)
+   * @param type The Type (`T`) for which we're creating the transfer policy.
+   * @param publisher The Publisher Object Id.
+   * @param address Address to save the `TransferPolicyCap` object to.
+   * @param skipCheck (Optional) skip checking if a transfer policy already exists
+   */
+  create({
+    type,
+    publisher,
+    skipCheck
+  }: TransferPolicyBaseParams): Promise<TransferPolicyTransaction>;
+  /**
+   * This can be called after calling the `create` function to share the `TransferPolicy`,
+   * and transfer the `TransferPolicyCap` to the specified address
+   *
+   * @param address The address to transfer the `TransferPolicyCap`
+   */
+  shareAndTransferCap(address: string): void;
+  /**
+   * Setup the TransferPolicy by passing a `cap` returned from `kioskClient.getOwnedTransferPolicies` or
+   * `kioskClient.getOwnedTransferPoliciesByType`.
+   * @param policyCapId The `TransferPolicyCap`
+   */
+  setCap({
+    policyId,
+    policyCapId,
+    type
+  }: TransferPolicyCap): this;
+  /**
+   * Withdraw from the transfer policy's profits.
+   * @param address Address to transfer the profits to.
+   * @param amount (Optional) amount parameter. Will withdraw all profits if the amount is not specified.
+   */
+  withdraw(address: string, amount?: string | bigint): this;
+  /**
+   *  Adds the Kiosk Royalty rule to the Transfer Policy.
+   *  You can pass the percentage, as well as a minimum amount.
+   *  The royalty that will be paid is the MAX(percentage, minAmount).
+   * 	You can pass 0 in either value if you want only percentage royalty, or a fixed amount fee.
+   * 	(but you should define at least one of them for the rule to make sense).
+   *
+   * 	@param percentageBps The royalty percentage in basis points. Use `percentageToBasisPoints` helper to convert from percentage [0,100].
+   * 	@param minAmount The minimum royalty amount per request in MIST.
+   */
+  addRoyaltyRule(percentageBps: number | string,
+  // this is in basis points.
+  minAmount: number | string): this;
+  /**
+   * Adds the Kiosk Lock Rule to the Transfer Policy.
+   * This Rule forces buyer to lock the item in the kiosk, preserving strong royalties.
+   */
+  addLockRule(): this;
+  /**
+   * Attaches the Personal Kiosk Rule, making a purchase valid only for `SoulBound` kiosks.
+   */
+  addPersonalKioskRule(): this;
+  /**
+   * A function to add the floor price rule to a transfer policy.
+   * @param minPrice The minimum price in MIST.
+   */
+  addFloorPriceRule(minPrice: string | bigint): this;
+  /**
+   * Generic helper to remove a rule, not from the SDK's base ruleset.
+   * @param ruleType The Rule Type
+   * @param configType The Config Type
+   */
+  removeRule({
+    ruleType,
+    configType
+  }: {
+    ruleType: string;
+    configType: string;
+  }): void;
+  /**
+   * Removes the lock rule.
+   */
+  removeLockRule(): this;
+  /**
+   * Removes the Royalty rule
+   */
+  removeRoyaltyRule(): this;
+  removePersonalKioskRule(): this;
+  removeFloorPriceRule(): this;
+  getPolicy(): ObjectArgument;
+  getPolicyCap(): ObjectArgument;
+}
+//#endregion
+export { TransferPolicyBaseParams, TransferPolicyTransaction, TransferPolicyTransactionParams };
+//# sourceMappingURL=tp-transaction.d.mts.map

package/dist/client/tp-transaction.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tp-transaction.d.mts","names":[],"sources":["../../src/client/tp-transaction.ts"],"sourcesContent":[],"mappings":";;;;;;KAcY,wBAAA;;aAEA;EAFA,SAAA,CAAA,EAAA,OAAA;AAMZ,CAAA;AACc,KADF,+BAAA,GACE;EACA,WAAA,EADA,WACA;EACP,WAAA,EADO,WACP;EAAiB,GAAA,CAAA,EAAjB,iBAAiB;AAGxB,CAAA;AACc,cADD,yBAAA,CACC;EACA,CAAA,OAAA;EACJ,WAAA,EAFI,WAEJ;EACG,WAAA,EAFC,WAED;EAGE,MAAA,CAAA,EAJL,cAIK;EAAa,SAAA,CAAA,EAHf,cAGe;EAAa,IAAA,CAAA,EAAA,MAAA;EAAO,WAAA,CAAA;IAAA,WAAA;IAAA,WAAA;IAAA;EAAA,CAAA,EAAA,+BAAA;EAmB9C;;;;;;;;;;;;EA6EQ,cAAA,CAAA;IAAA,IAAA;IAAA,SAAA;IAAA,OAAA;IAAA;EAAuB,CAAvB,EAzEN,wBAyEM,GAAA;IAAU,OAAA,EAAA,MAAA;EAAa,CAAA,CAAA,EAvE/B,OAuE+B,CAAA,IAAA,CAAA;EAAQ;;;;;;;;;;;;KAlDrC,2BAA2B,QAAQ;;;;;;;;;;;;;;;;;KAkDE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eA0P/B;kBAKG"}