@mysten/kiosk 0.3.0 → 0.3.2

package/src/tx/transfer-policy.ts

@@ -5,9 +5,10 @@ import { TransactionArgument, TransactionBlock } from '@mysten/sui.js';
 import { getRulePackageAddress, objArg } from '../utils';
 import { lock } from './kiosk';
 import {
-  ObjectArgument,
-  RulesEnvironmentParam,
-  TRANSFER_POLICY_MODULE,
+	ObjectArgument,
+	RulesEnvironmentParam,
+	TRANSFER_POLICY_MODULE,
+	TRANSFER_POLICY_TYPE,
 } from '../types';
 
 /**
@@ -15,47 +16,47 @@ import {
  * Returns `transferPolicyCap`
  */
 export function createTransferPolicy(
-  tx: TransactionBlock,
-  itemType: string,
-  publisher: ObjectArgument,
+	tx: TransactionBlock,
+	itemType: string,
+	publisher: ObjectArgument,
 ): TransactionArgument {
-  let [transferPolicy, transferPolicyCap] = tx.moveCall({
-    target: `${TRANSFER_POLICY_MODULE}::new`,
-    typeArguments: [itemType],
-    arguments: [objArg(tx, publisher)],
-  });
+	let [transferPolicy, transferPolicyCap] = tx.moveCall({
+		target: `${TRANSFER_POLICY_MODULE}::new`,
+		typeArguments: [itemType],
+		arguments: [objArg(tx, publisher)],
+	});
 
-  tx.moveCall({
-    target: `0x2::transfer::public_share_object`,
-    typeArguments: [itemType],
-    arguments: [transferPolicy],
-  });
+	tx.moveCall({
+		target: `0x2::transfer::public_share_object`,
+		typeArguments: [`${TRANSFER_POLICY_TYPE}<${itemType}>`],
+		arguments: [transferPolicy],
+	});
 
-  return transferPolicyCap;
+	return transferPolicyCap;
 }
 
 /**
  * Call the `transfer_policy::withdraw` function to withdraw profits from a transfer policy.
  */
 export function withdrawFromPolicy(
-  tx: TransactionBlock,
-  itemType: string,
-  policy: ObjectArgument,
-  policyCap: ObjectArgument,
-  amount: string | bigint | null,
+	tx: TransactionBlock,
+	itemType: string,
+	policy: ObjectArgument,
+	policyCap: ObjectArgument,
+	amount: string | bigint | null,
 ): TransactionArgument {
-  let amountArg =
-    amount !== null
-      ? tx.pure({ Some: amount }, 'Option<u64>')
-      : tx.pure({ None: true }, 'Option<u64>');
+	let amountArg =
+		amount !== null
+			? tx.pure({ Some: amount }, 'Option<u64>')
+			: tx.pure({ None: true }, 'Option<u64>');
 
-  let [profits] = tx.moveCall({
-    target: `${TRANSFER_POLICY_MODULE}::withdraw`,
-    typeArguments: [itemType],
-    arguments: [objArg(tx, policy), objArg(tx, policyCap), amountArg],
-  });
+	let [profits] = tx.moveCall({
+		target: `${TRANSFER_POLICY_MODULE}::withdraw`,
+		typeArguments: [itemType],
+		arguments: [objArg(tx, policy), objArg(tx, policyCap), amountArg],
+	});
 
-  return profits;
+	return profits;
 }
 
 /**
@@ -63,34 +64,34 @@ export function withdrawFromPolicy(
  * transaction.
  */
 export function confirmRequest(
-  tx: TransactionBlock,
-  itemType: string,
-  policy: ObjectArgument,
-  request: TransactionArgument,
+	tx: TransactionBlock,
+	itemType: string,
+	policy: ObjectArgument,
+	request: TransactionArgument,
 ): void {
-  tx.moveCall({
-    target: `${TRANSFER_POLICY_MODULE}::confirm_request`,
-    typeArguments: [itemType],
-    arguments: [objArg(tx, policy), request],
-  });
+	tx.moveCall({
+		target: `${TRANSFER_POLICY_MODULE}::confirm_request`,
+		typeArguments: [itemType],
+		arguments: [objArg(tx, policy), request],
+	});
 }
 
 /**
  * Calls the `transfer_policy::remove_rule` function to remove a Rule from the transfer policy's ruleset.
  */
 export function removeTransferPolicyRule(
-  tx: TransactionBlock,
-  itemType: string,
-  ruleType: string,
-  configType: string,
-  policy: ObjectArgument,
-  policyCap: TransactionArgument,
+	tx: TransactionBlock,
+	itemType: string,
+	ruleType: string,
+	configType: string,
+	policy: ObjectArgument,
+	policyCap: TransactionArgument,
 ): void {
-  tx.moveCall({
-    target: `${TRANSFER_POLICY_MODULE}::remove_rule`,
-    typeArguments: [itemType, ruleType, configType],
-    arguments: [objArg(tx, policy), policyCap],
-  });
+	tx.moveCall({
+		target: `${TRANSFER_POLICY_MODULE}::remove_rule`,
+		typeArguments: [itemType, ruleType, configType],
+		arguments: [objArg(tx, policy), policyCap],
+	});
 }
 
 /**
@@ -99,30 +100,30 @@ export function removeTransferPolicyRule(
  * then calls the `royalty_rule::pay` function to resolve the royalty rule.
  */
 export function resolveRoyaltyRule(
-  tx: TransactionBlock,
-  itemType: string,
-  price: string,
-  policyId: ObjectArgument,
-  transferRequest: TransactionArgument,
-  environment: RulesEnvironmentParam,
+	tx: TransactionBlock,
+	itemType: string,
+	price: string,
+	policyId: ObjectArgument,
+	transferRequest: TransactionArgument,
+	environment: RulesEnvironmentParam,
 ) {
-  const policyObj = objArg(tx, policyId);
-  // calculates the amount
-  const [amount] = tx.moveCall({
-    target: `${getRulePackageAddress(environment)}::royalty_rule::fee_amount`,
-    typeArguments: [itemType],
-    arguments: [policyObj, objArg(tx, price)],
-  });
+	const policyObj = objArg(tx, policyId);
+	// calculates the amount
+	const [amount] = tx.moveCall({
+		target: `${getRulePackageAddress(environment)}::royalty_rule::fee_amount`,
+		typeArguments: [itemType],
+		arguments: [policyObj, objArg(tx, price)],
+	});
 
-  // splits the coin.
-  const feeCoin = tx.splitCoins(tx.gas, [amount]);
+	// splits the coin.
+	const feeCoin = tx.splitCoins(tx.gas, [amount]);
 
-  // pays the policy
-  tx.moveCall({
-    target: `${getRulePackageAddress(environment)}::royalty_rule::pay`,
-    typeArguments: [itemType],
-    arguments: [policyObj, transferRequest, feeCoin],
-  });
+	// pays the policy
+	tx.moveCall({
+		target: `${getRulePackageAddress(environment)}::royalty_rule::pay`,
+		typeArguments: [itemType],
+		arguments: [policyObj, transferRequest, feeCoin],
+	});
 }
 
 /**
@@ -131,22 +132,22 @@ export function resolveRoyaltyRule(
  * by calling the `kiosk_lock_rule::prove` function to resolve it.
  */
 export function resolveKioskLockRule(
-  tx: TransactionBlock,
-  itemType: string,
-  item: TransactionArgument,
-  kiosk: ObjectArgument,
-  kioskCap: ObjectArgument,
-  policyId: ObjectArgument,
-  transferRequest: TransactionArgument,
-  environment: RulesEnvironmentParam,
+	tx: TransactionBlock,
+	itemType: string,
+	item: TransactionArgument,
+	kiosk: ObjectArgument,
+	kioskCap: ObjectArgument,
+	policyId: ObjectArgument,
+	transferRequest: TransactionArgument,
+	environment: RulesEnvironmentParam,
 ) {
-  // lock item in the kiosk.
-  lock(tx, itemType, kiosk, kioskCap, policyId, item);
+	// lock item in the kiosk.
+	lock(tx, itemType, kiosk, kioskCap, policyId, item);
 
-  // proves that the item is locked in the kiosk to the TP.
-  tx.moveCall({
-    target: `${getRulePackageAddress(environment)}::kiosk_lock_rule::prove`,
-    typeArguments: [itemType],
-    arguments: [transferRequest, objArg(tx, kiosk)],
-  });
+	// proves that the item is locked in the kiosk to the TP.
+	tx.moveCall({
+		target: `${getRulePackageAddress(environment)}::kiosk_lock_rule::prove`,
+		typeArguments: [itemType],
+		arguments: [transferRequest, objArg(tx, kiosk)],
+	});
 }

package/src/types/env.ts

@@ -17,6 +17,6 @@ export const mainnetEnvironment: RulesEnvironmentParam = { env: 'mainnet' };
 
 /** A helper to easily export a custom environment */
 export const customEnvironment = (address: string): RulesEnvironmentParam => ({
-  env: 'custom',
-  address,
+	env: 'custom',
+	address,
 });

package/src/types/index.ts

@@ -1,11 +1,7 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import {
-  SharedObjectRef,
-  SuiObjectRef,
-  TransactionArgument,
-} from '@mysten/sui.js';
+import { SharedObjectRef, SuiObjectRef, TransactionArgument } from '@mysten/sui.js';
 
 export * from './kiosk';
 export * from './transfer-policy';
@@ -14,8 +10,4 @@ export * from './env';
 /**
  * A valid argument for any of the Kiosk functions.
  */
-export type ObjectArgument =
-  | string
-  | TransactionArgument
-  | SharedObjectRef
-  | SuiObjectRef;
+export type ObjectArgument = string | TransactionArgument | SharedObjectRef | SuiObjectRef;

package/src/types/kiosk.ts

@@ -1,7 +1,13 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { TransactionArgument } from '@mysten/sui.js';
+import {
+	ObjectDigest,
+	ObjectId,
+	ObjectType,
+	PaginatedObjectsResponse,
+	TransactionArgument,
+} from '@mysten/sui.js';
 import { ObjectArgument } from '.';
 
 /** The Kiosk module. */
@@ -29,21 +35,21 @@ export const KIOSK_PURCHASE_CAP = `${KIOSK_MODULE}::PurchaseCap`;
  * The Kiosk object fields (for BCS queries).
  */
 export type Kiosk = {
-  id: string;
-  profits: string;
-  owner: string;
-  itemCount: number;
-  allowExtensions: boolean;
+	id: string;
+	profits: string;
+	owner: string;
+	itemCount: number;
+	allowExtensions: boolean;
 };
 
 /**
  * PurchaseCap object fields (for BCS queries).
  */
 export type PurchaseCap = {
-  id: string;
-  kioskId: string;
-  itemId: string;
-  minPrice: string;
+	id: string;
+	kioskId: string;
+	itemId: string;
+	minPrice: string;
 };
 
 /**
@@ -51,8 +57,8 @@ export type PurchaseCap = {
  * Returns the item, and a `canTransfer` param.
  */
 export type PurchaseAndResolvePoliciesResponse = {
-  item: TransactionArgument;
-  canTransfer: boolean;
+	item: TransactionArgument;
+	canTransfer: boolean;
 };
 
 /**
@@ -61,6 +67,73 @@ export type PurchaseAndResolvePoliciesResponse = {
  * without introducing more breaking changes.
  */
 export type PurchaseOptionalParams = {
-  ownedKiosk?: ObjectArgument;
-  ownedKioskCap?: ObjectArgument;
+	ownedKiosk?: ObjectArgument;
+	ownedKioskCap?: ObjectArgument;
+};
+
+/**
+ * A dynamic field `Listing { ID, isExclusive }` attached to the Kiosk.
+ * Holds a `u64` value - the price of the item.
+ */
+export type KioskListing = {
+	/** The ID of the Item */
+	objectId: ObjectId;
+	/**
+	 * Whether or not there's a `PurchaseCap` issued. `true` means that
+	 * the listing is controlled by some logic and can't be purchased directly.
+	 *
+	 * TODO: consider renaming the field for better indication.
+	 */
+	isExclusive: boolean;
+	/** The ID of the listing */
+	listingId: ObjectId;
+	price?: string;
+};
+
+/**
+ * A dynamic field `Item { ID }` attached to the Kiosk.
+ * Holds an Item `T`. The type of the item is known upfront.
+ */
+export type KioskItem = {
+	/** The ID of the Item */
+	objectId: ObjectId;
+	/** The type of the Item */
+	type: ObjectType;
+	/** Whether the item is Locked (there must be a `Lock` Dynamic Field) */
+	isLocked: boolean;
+	/** Optional listing */
+	listing?: KioskListing;
+};
+/**
+ * Aggregated data from the Kiosk.
+ */
+export type KioskData = {
+	items: KioskItem[];
+	itemIds: ObjectId[];
+	listingIds: ObjectId[];
+	kiosk?: Kiosk;
+	extensions: any[]; // type will be defined on later versions of the SDK.
+};
+
+export type PagedKioskData = {
+	data: KioskData;
+	nextCursor: string | null;
+	hasNextPage: boolean;
+};
+
+export type FetchKioskOptions = {
+	withKioskFields?: boolean;
+	withListingPrices?: boolean;
+};
+
+export type OwnedKiosks = {
+	kioskOwnerCaps: KioskOwnerCap[];
+	kioskIds: ObjectId[];
+} & Omit<PaginatedObjectsResponse, 'data'>;
+
+export type KioskOwnerCap = {
+	objectId: ObjectId;
+	kioskId: ObjectId;
+	digest: ObjectDigest;
+	version: string;
 };

package/src/types/transfer-policy.ts

@@ -20,14 +20,14 @@ export const ROYALTY_RULE = 'royalty_rule::Rule';
 
 /** The `TransferPolicy` object */
 export type TransferPolicy = {
-  id: string;
-  type: string;
-  balance: string;
-  rules: string[];
-  owner: ObjectOwner;
+	id: string;
+	type: string;
+	balance: string;
+	rules: string[];
+	owner: ObjectOwner;
 };
 
 /** Event emitted when a TransferPolicy is created. */
 export type TransferPolicyCreated = {
-  id: string;
+	id: string;
 };