@mysten/kiosk 0.7.5 → 0.7.7

package/package.json

@@ -2,11 +2,12 @@
   "name": "@mysten/kiosk",
   "author": "Mysten Labs <build@mystenlabs.com>",
   "description": "Sui Kiosk library",
-  "version": "0.7.5",
+  "version": "0.7.7",
   "license": "Apache-2.0",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
+  "sideEffects": false,
   "files": [
     "dist",
     "src",
@@ -24,7 +25,7 @@
     }
   },
   "dependencies": {
-    "@mysten/sui.js": "0.43.3"
+    "@mysten/sui.js": "0.45.0"
   },
   "devDependencies": {
     "cross-env": "^7.0.3",
@@ -40,7 +41,7 @@
     "build": "pnpm build:types && pnpm build:tsup",
     "build:tsup": "tsup ./src/index.ts --format esm,cjs --sourcemap",
     "build:types": "tsc --build",
-    "test": "echo \"Error: no test specified\"",
+    "test": "echo 'No unit tests for kiosk SDK'",
     "pre-commit": "pnpm prettier:fix && pnpm lint && pnpm build",
     "prettier:check": "prettier -c --ignore-unknown .",
     "prettier:fix": "prettier -w --ignore-unknown .",

package/src/client/kiosk-client.ts

@@ -13,7 +13,7 @@ import {
 	type BaseRulePackageIds,
 	type TransferPolicyRule,
 } from '../constants';
-import { fetchKiosk, getOwnedKiosks } from '../query/kiosk';
+import { fetchKiosk, fetchKioskExtension, getOwnedKiosks } from '../query/kiosk';
 import {
 	queryOwnedTransferPolicies,
 	queryTransferPolicy,
@@ -87,6 +87,15 @@ export class KioskClient {
 		).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 }: { kioskId: string; type: string }) {
+		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`)

package/src/query/kiosk.ts

@@ -13,6 +13,7 @@ import { isValidSuiAddress } from '@mysten/sui.js/utils';
 import {
 	FetchKioskOptions,
 	KIOSK_OWNER_CAP,
+	KioskExtension,
 	KioskListing,
 	OwnedKiosks,
 	PagedKioskData,
@@ -151,3 +152,34 @@ export async function getOwnedKiosks(
 		kioskIds: kioskIdList,
 	};
 }
+
+// Get a kiosk extension data for a given kioskId and extensionType.
+export async function fetchKioskExtension(
+	client: SuiClient,
+	kioskId: string,
+	extensionType: string,
+): Promise<KioskExtension | null> {
+	const extension = await client.getDynamicFieldObject({
+		parentId: kioskId,
+		name: {
+			type: `0x2::kiosk_extension::ExtensionKey<${extensionType}>`,
+			value: {
+				dummy_field: false,
+			},
+		},
+	});
+
+	if (!extension.data) return null;
+
+	const fields = (extension?.data?.content as { fields: { [k: string]: any } })?.fields?.value
+		?.fields;
+
+	return {
+		objectId: extension.data.objectId,
+		type: extensionType,
+		isEnabled: fields?.is_enabled,
+		permissions: fields?.permissions,
+		storageId: fields?.storage?.fields?.id?.id,
+		storageSize: fields?.storage?.fields?.size,
+	};
+}

package/src/types/kiosk.ts

@@ -108,6 +108,25 @@ export type KioskItem = {
 	/** Optional Kiosk Data */
 	data?: SuiObjectData;
 };
+
+/** The overview type returned from `getKiosk` */
+export type KioskExtensionOverview = {
+	/** The ID of the extension's DF */
+	objectId: string;
+	/** The inner type of the Extension */
+	type: string;
+};
+/**
+ * Hold the KioskExtension data
+ */
+export type KioskExtension = KioskExtensionOverview & {
+	/** These fields are only there if we have `withExtensions` flag */
+	isEnabled: boolean;
+	permissions: string;
+	storageId: string;
+	storageSize: number;
+};
+
 /**
  * Aggregated data from the Kiosk.
  */
@@ -116,7 +135,7 @@ export type KioskData = {
 	itemIds: string[];
 	listingIds: string[];
 	kiosk?: Kiosk;
-	extensions: any[]; // type will be defined on later versions of the SDK.
+	extensions: KioskExtensionOverview[]; // type will be defined on later versions of the SDK.
 };
 
 export type PagedKioskData = {

package/src/utils.ts

@@ -13,7 +13,7 @@ import {
 	type DynamicFieldInfo,
 } from '@mysten/sui.js/client';
 import { TransactionBlock, TransactionObjectArgument } from '@mysten/sui.js/transactions';
-import { normalizeSuiAddress } from '@mysten/sui.js/utils';
+import { normalizeStructTag, normalizeSuiAddress, parseStructTag } from '@mysten/sui.js/utils';
 
 import { bcs } from './bcs';
 import {
@@ -80,41 +80,42 @@ export function extractKioskData(
 ): KioskData {
 	return data.reduce<KioskData>(
 		(acc: KioskData, val: DynamicFieldInfo) => {
-			const type = getTypeWithoutPackageAddress(val.name.type);
-
-			switch (type) {
-				case 'kiosk::Item':
-					acc.itemIds.push(val.objectId);
-					acc.items.push({
-						objectId: val.objectId,
-						type: val.objectType,
-						isLocked: false,
-						kioskId,
-					});
-					break;
-				case 'kiosk::Listing':
-					acc.listingIds.push(val.objectId);
-					listings.push({
-						objectId: (val.name.value as { id: string }).id,
-						listingId: val.objectId,
-						isExclusive: (val.name.value as { is_exclusive: boolean }).is_exclusive,
-					});
-					break;
-				case 'kiosk::Lock':
-					lockedItemIds?.push((val.name.value as { id: string }).id);
-					break;
+			const type = val.name.type;
+
+			if (type.startsWith('0x2::kiosk::Item')) {
+				acc.itemIds.push(val.objectId);
+				acc.items.push({
+					objectId: val.objectId,
+					type: val.objectType,
+					isLocked: false,
+					kioskId,
+				});
 			}
+			if (type.startsWith('0x2::kiosk::Listing')) {
+				acc.listingIds.push(val.objectId);
+				listings.push({
+					objectId: (val.name.value as { id: string }).id,
+					listingId: val.objectId,
+					isExclusive: (val.name.value as { is_exclusive: boolean }).is_exclusive,
+				});
+			}
+			if (type.startsWith('0x2::kiosk::Lock')) {
+				lockedItemIds?.push((val.name.value as { id: string }).id);
+			}
+
+			if (type.startsWith('0x2::kiosk_extension::ExtensionKey')) {
+				acc.extensions.push({
+					objectId: val.objectId,
+					type: normalizeStructTag(parseStructTag(val.name.type).typeParams[0]),
+				});
+			}
+
 			return acc;
 		},
 		{ items: [], itemIds: [], listingIds: [], extensions: [] },
 	);
 }
 
-// e.g. 0x2::kiosk::Item -> kiosk::Item
-export function getTypeWithoutPackageAddress(type: string) {
-	return type.split('::').slice(-2).join('::');
-}
-
 /**
  * A helper that attaches the listing prices to kiosk listings.
  */