@mysten/kiosk 0.14.6 → 1.0.1

package/src/client/kiosk-client.ts

@@ -1,7 +1,8 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import type { PaginationArguments, SuiClient } from '@mysten/sui/client';
+import type { PaginationArguments } from '@mysten/sui/jsonRpc';
+import type { ClientWithCoreApi, SuiClientTypes } from '@mysten/sui/client';
 
 import {
 	FLOOR_PRICE_RULE_ADDRESS,
@@ -18,7 +19,6 @@ import {
 	queryTransferPolicy,
 	queryTransferPolicyCapsByType,
 } from '../query/transfer-policy.js';
-import { Network } from '../types/index.js';
 import type {
 	FetchKioskOptions,
 	KioskClientOptions,
@@ -26,6 +26,43 @@ import type {
 	OwnedKiosks,
 } from '../types/index.js';
 
+export type KioskExtensionOptions<Name extends string = 'kiosk'> = {
+	name?: Name;
+	packageIds?: BaseRulePackageIds;
+};
+
+/**
+ * Creates a kiosk client extension that can be used with `client.$extend()`.
+ *
+ * @example
+ * ```ts
+ * import { SuiJsonRpcClient } from '@mysten/sui/jsonRpc';
+ * import { kiosk } from '@mysten/kiosk';
+ *
+ * const client = new SuiJsonRpcClient({
+ *   url: getJsonRpcFullnodeUrl('mainnet'),
+ *   network: 'mainnet',
+ * }).$extend(kiosk());
+ *
+ * const ownedKiosks = await client.kiosk.getOwnedKiosks({ address: '0x...' });
+ * ```
+ */
+export function kiosk<const Name extends string = 'kiosk'>({
+	name = 'kiosk' as Name,
+	packageIds,
+}: KioskExtensionOptions<Name> = {}) {
+	return {
+		name,
+		register: (client: ClientWithCoreApi) => {
+			return new KioskClient({
+				client,
+				network: client.network,
+				packageIds,
+			});
+		},
+	};
+}
+
 /**
  * A Client that allows you to interact with kiosk.
  * Offers utilities to query kiosk, craft transactions to edit your own kiosk,
@@ -33,8 +70,8 @@ import type {
  * If you pass packageIds, all functionality will be managed using these packages.
  */
 export class KioskClient {
-	client: SuiClient;
-	network: Network;
+	client: ClientWithCoreApi;
+	network: SuiClientTypes.Network;
 	rules: TransferPolicyRule[];
 	packageIds?: BaseRulePackageIds;
 
@@ -145,7 +182,7 @@ export class KioskClient {
 
 		/// Check existence of rule based on network and throw an error if it's not found.
 		/// We always have a fallback for testnet or mainnet.
-		if (!rules[rule] && network !== Network.MAINNET && network !== Network.TESTNET) {
+		if (!rules[rule] && network !== 'mainnet' && network !== 'testnet') {
 			throw new Error(`Missing packageId for rule ${rule}`);
 		}
 

package/src/client/kiosk-transaction.ts

@@ -7,9 +7,10 @@ import type {
 	TransactionObjectArgument,
 } from '@mysten/sui/transactions';
 
-import * as kioskTx from '../tx/kiosk.js';
-import { convertToPersonalTx, transferPersonalCapTx } from '../tx/personal-kiosk.js';
-import { confirmRequest } from '../tx/transfer-policy.js';
+import * as kioskContract from '../contracts/0x2/kiosk.js';
+import * as transferPolicyContract from '../contracts/0x2/transfer_policy.js';
+import * as personalKioskContract from '../contracts/kiosk/personal_kiosk.js';
+import { createKioskAndShare } from '../tx/kiosk.js';
 import type {
 	ItemId,
 	ItemReference,
@@ -26,8 +27,6 @@ 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()`
 	 */
@@ -59,12 +58,7 @@ export class KioskTransaction {
 	// A flag that checks whether kiosk TX is finalized.
 	#finalized: boolean = false;
 
-	constructor({
-		transactionBlock,
-		transaction = transactionBlock!,
-		kioskClient,
-		cap,
-	}: KioskTransactionParams) {
+	constructor({ transaction, kioskClient, cap }: KioskTransactionParams) {
 		this.transaction = transaction;
 		this.kioskClient = kioskClient;
 
@@ -82,7 +76,7 @@ export class KioskTransaction {
 			share: true,
 			transfer: true,
 		});
-		const [kiosk, cap] = kioskTx.createKiosk(this.transaction);
+		const [kiosk, cap] = this.transaction.add(kioskContract._new({}));
 		this.kiosk = kiosk;
 		this.kioskCap = cap;
 		return this;
@@ -105,11 +99,16 @@ export class KioskTransaction {
 	convertToPersonal(borrow?: boolean) {
 		this.#validateKioskIsSet();
 
-		const cap = convertToPersonalTx(
-			this.transaction,
-			this.kiosk!,
-			this.kioskCap!,
-			this.kioskClient.getRulePackageId('personalKioskRulePackageId'),
+		const packageId = this.kioskClient.getRulePackageId('personalKioskRulePackageId');
+
+		const [cap] = this.transaction.add(
+			personalKioskContract._new({
+				package: packageId,
+				arguments: {
+					kiosk: this.kiosk!,
+					cap: this.kioskCap!,
+				},
+			}),
 		);
 
 		// if we enable `borrow`, we borrow the kioskCap from the cap.
@@ -125,8 +124,8 @@ export class KioskTransaction {
 	 */
 	createAndShare(address: string) {
 		this.#validateFinalizedStatus();
-		const cap = kioskTx.createKioskAndShare(this.transaction);
-		this.transaction.transferObjects([cap], this.transaction.pure.address(address));
+		const cap = createKioskAndShare(this.transaction);
+		this.transaction.transferObjects([cap], address);
 		return this;
 	}
 
@@ -136,7 +135,11 @@ export class KioskTransaction {
 	share() {
 		this.#validateKioskIsSet();
 		this.#setPendingStatuses({ share: false });
-		kioskTx.shareKiosk(this.transaction, this.kiosk!);
+		this.transaction.moveCall({
+			target: '0x2::transfer::public_share_object',
+			arguments: [this.kiosk!],
+			typeArguments: ['0x2::kiosk::Kiosk'],
+		});
 		return this;
 	}
 
@@ -149,7 +152,7 @@ export class KioskTransaction {
 			throw new Error('You can only call `shareAndTransferCap` on a non-personal kiosk.');
 		this.#setPendingStatuses({ transfer: false });
 		this.share();
-		this.transaction.transferObjects([this.kioskCap!], this.transaction.pure.address(address));
+		this.transaction.transferObjects([this.kioskCap!], address);
 		return this;
 	}
 
@@ -159,12 +162,11 @@ export class KioskTransaction {
 	 */
 	borrowTx({ itemType, itemId }: ItemId, callback: (item: TransactionArgument) => void) {
 		this.#validateKioskIsSet();
-		const [itemObj, promise] = kioskTx.borrowValue(
-			this.transaction,
-			itemType,
-			this.kiosk!,
-			this.kioskCap!,
-			itemId,
+		const [itemObj, promise] = this.transaction.add(
+			kioskContract.borrowVal({
+				arguments: [this.kiosk!, this.kioskCap!, itemId],
+				typeArguments: [itemType],
+			}),
 		);
 
 		callback(itemObj);
@@ -180,12 +182,11 @@ export class KioskTransaction {
 	 */
 	borrow({ itemType, itemId }: ItemId): [TransactionArgument, TransactionArgument] {
 		this.#validateKioskIsSet();
-		const [itemObj, promise] = kioskTx.borrowValue(
-			this.transaction,
-			itemType,
-			this.kiosk!,
-			this.kioskCap!,
-			itemId,
+		const [itemObj, promise] = this.transaction.add(
+			kioskContract.borrowVal({
+				arguments: [this.kiosk!, this.kioskCap!, itemId],
+				typeArguments: [itemType],
+			}),
 		);
 
 		return [itemObj, promise];
@@ -197,19 +198,29 @@ export class KioskTransaction {
 	 */
 	return({ itemType, item, promise }: ItemValue & { promise: TransactionArgument }) {
 		this.#validateKioskIsSet();
-		kioskTx.returnValue(this.transaction, itemType, this.kiosk!, item, promise);
+		this.transaction.add(
+			kioskContract.returnVal({
+				arguments: [this.kiosk!, item, promise],
+				typeArguments: [itemType],
+			}),
+		);
 		return this;
 	}
 
 	/**
 	 * A function to withdraw from kiosk
-	 * @param address Where to trasnfer the coin.
+	 * @param address Where to transfer the coin.
 	 * @param amount The amount we aim to withdraw.
 	 */
 	withdraw(address: string, amount?: string | bigint | number) {
 		this.#validateKioskIsSet();
-		const coin = kioskTx.withdrawFromKiosk(this.transaction, this.kiosk!, this.kioskCap!, amount);
-		this.transaction.transferObjects([coin], this.transaction.pure.address(address));
+
+		const [coin] = this.transaction.add(
+			kioskContract.withdraw({
+				arguments: [this.kiosk!, this.kioskCap!, amount == null ? null : BigInt(amount)],
+			}),
+		);
+		this.transaction.transferObjects([coin], address);
 		return this;
 	}
 
@@ -220,7 +231,13 @@ export class KioskTransaction {
 	 */
 	place({ itemType, item }: ItemReference) {
 		this.#validateKioskIsSet();
-		kioskTx.place(this.transaction, itemType, this.kiosk!, this.kioskCap!, item);
+		const itemArg = typeof item === 'string' ? this.transaction.object(item) : item;
+		this.transaction.add(
+			kioskContract.place({
+				arguments: [this.kiosk!, this.kioskCap!, itemArg],
+				typeArguments: [itemType],
+			}),
+		);
 		return this;
 	}
 
@@ -232,7 +249,14 @@ export class KioskTransaction {
 	 */
 	placeAndList({ itemType, item, price }: ItemReference & Price) {
 		this.#validateKioskIsSet();
-		kioskTx.placeAndList(this.transaction, itemType, this.kiosk!, this.kioskCap!, item, price);
+		const itemArg = typeof item === 'string' ? this.transaction.object(item) : item;
+		const priceArg = typeof price === 'string' ? BigInt(price) : price;
+		this.transaction.add(
+			kioskContract.placeAndList({
+				arguments: [this.kiosk!, this.kioskCap!, itemArg, priceArg],
+				typeArguments: [itemType],
+			}),
+		);
 		return this;
 	}
 
@@ -244,7 +268,13 @@ export class KioskTransaction {
 	 */
 	list({ itemType, itemId, price }: ItemId & { price: string | bigint }) {
 		this.#validateKioskIsSet();
-		kioskTx.list(this.transaction, itemType, this.kiosk!, this.kioskCap!, itemId, price);
+		const priceArg = typeof price === 'string' ? BigInt(price) : price;
+		this.transaction.add(
+			kioskContract.list({
+				arguments: [this.kiosk!, this.kioskCap!, itemId, priceArg],
+				typeArguments: [itemType],
+			}),
+		);
 		return this;
 	}
 
@@ -255,7 +285,12 @@ export class KioskTransaction {
 	 */
 	delist({ itemType, itemId }: ItemId) {
 		this.#validateKioskIsSet();
-		kioskTx.delist(this.transaction, itemType, this.kiosk!, this.kioskCap!, itemId);
+		this.transaction.add(
+			kioskContract.delist({
+				arguments: [this.kiosk!, this.kioskCap!, itemId],
+				typeArguments: [itemType],
+			}),
+		);
 		return this;
 	}
 
@@ -267,7 +302,13 @@ export class KioskTransaction {
 	 */
 	take({ itemType, itemId }: ItemId): TransactionObjectArgument {
 		this.#validateKioskIsSet();
-		return kioskTx.take(this.transaction, itemType, this.kiosk!, this.kioskCap!, itemId);
+		const [item] = this.transaction.add(
+			kioskContract.take({
+				arguments: [this.kiosk!, this.kioskCap!, itemId],
+				typeArguments: [itemType],
+			}),
+		);
+		return item;
 	}
 
 	/**
@@ -280,7 +321,7 @@ export class KioskTransaction {
 	transfer({ itemType, itemId, address }: ItemId & { address: string }) {
 		this.#validateKioskIsSet();
 		const item = this.take({ itemType, itemId });
-		this.transaction.transferObjects([item], this.transaction.pure.address(address));
+		this.transaction.transferObjects([item], address);
 		return this;
 	}
 
@@ -299,7 +340,18 @@ export class KioskTransaction {
 		policy,
 	}: ItemReference & { policy: ObjectArgument; itemId?: string }) {
 		this.#validateKioskIsSet();
-		kioskTx.lock(this.transaction, itemType, this.kiosk!, this.kioskCap!, policy, itemId ?? item);
+		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(
+			kioskContract.lock({
+				arguments: [this.kiosk!, this.kioskCap!, policyArg, itemArg],
+				typeArguments: [itemType],
+			}),
+		);
 		return this;
 	}
 
@@ -322,10 +374,16 @@ export class KioskTransaction {
 		TransactionObjectArgument,
 	] {
 		// Split the coin for the amount of the listing.
-		const coin = this.transaction.splitCoins(this.transaction.gas, [
-			this.transaction.pure.u64(price),
-		]);
-		return kioskTx.purchase(this.transaction, itemType, sellerKiosk, itemId, coin);
+		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(
+			kioskContract.purchase({
+				arguments: [kioskArg, itemId, coin],
+				typeArguments: [itemType],
+			}),
+		);
+		return [item, transferRequest];
 	}
 
 	/**
@@ -377,7 +435,6 @@ export class KioskTransaction {
 
 			await ruleDefinition.resolveRuleFunction({
 				packageId: ruleDefinition.packageId,
-				transactionBlock: this.transaction,
 				transaction: this.transaction,
 				itemType,
 				itemId,
@@ -393,7 +450,12 @@ export class KioskTransaction {
 			});
 		}
 
-		confirmRequest(this.transaction, itemType, policy.id, transferRequest);
+		this.transaction.add(
+			transferPolicyContract.confirmRequest({
+				arguments: [this.transaction.object(policy.id), transferRequest],
+				typeArguments: [itemType],
+			}),
+		);
 
 		if (canTransferOutsideKiosk) this.place({ itemType, item: purchasedItem });
 
@@ -436,19 +498,33 @@ export class KioskTransaction {
 			return;
 		}
 
-		const packageId = this.kioskClient.getRulePackageId('personalKioskRulePackageId');
-
 		// if we have a promise, return the `ownerCap` back to the personal cap.
 		if (this.#promise) {
-			this.transaction.moveCall({
-				target: `${packageId}::personal_kiosk::return_val`,
-				arguments: [this.#personalCap, this.transaction.object(this.kioskCap!), this.#promise!],
-			});
+			const packageId = this.kioskClient.getRulePackageId('personalKioskRulePackageId');
+
+			this.transaction.add(
+				personalKioskContract.returnVal({
+					package: packageId,
+					arguments: {
+						self: this.#personalCap,
+						cap: this.kioskCap!,
+						borrow: this.#promise,
+					},
+				}),
+			);
 		}
 
 		// If we are pending transferring the personalCap, we do it here.
-		if (this.#pendingTransfer)
-			transferPersonalCapTx(this.transaction, this.#personalCap, packageId);
+		if (this.#pendingTransfer) {
+			const packageId = this.kioskClient.getRulePackageId('personalKioskRulePackageId');
+
+			this.transaction.add(
+				personalKioskContract.transferToSender({
+					package: packageId,
+					arguments: { self: this.#personalCap },
+				}),
+			);
+		}
 
 		// Mark the transaction as finalized, so no other functions can be called.
 		this.#finalized = true;
@@ -490,15 +566,18 @@ export class KioskTransaction {
 	 * A function to borrow from `personalCap`.
 	 */
 	#borrowFromPersonalCap(personalCap: ObjectArgument) {
-		const [kioskCap, promise] = this.transaction.moveCall({
-			target: `${this.kioskClient.getRulePackageId(
-				'personalKioskRulePackageId',
-			)}::personal_kiosk::borrow_val`,
-			arguments: [this.transaction.object(personalCap)],
-		});
+		const packageId = this.kioskClient.getRulePackageId('personalKioskRulePackageId');
+		const personalCapArg =
+			typeof personalCap === 'string' ? this.transaction.object(personalCap) : personalCap;
+		const [kioskCap, promise] = this.transaction.add(
+			personalKioskContract.borrowVal({
+				package: packageId,
+				arguments: { self: personalCapArg },
+			}),
+		);
 
 		this.kioskCap = kioskCap;
-		this.#personalCap = this.transaction.object(personalCap);
+		this.#personalCap = personalCapArg;
 		this.#promise = promise;
 
 		return this;