@mysten/kiosk 0.3.0 → 0.3.2

package/package.json

@@ -2,7 +2,7 @@
   "name": "@mysten/kiosk",
   "author": "Mysten Labs <build@mystenlabs.com>",
   "description": "Sui Kiosk library",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "license": "Apache-2.0",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -24,27 +24,23 @@
     }
   },
   "dependencies": {
-    "@mysten/sui.js": "0.35.1"
+    "@mysten/sui.js": "0.37.0"
   },
   "devDependencies": {
-    "eslint": "^8.38.0",
-    "prettier": "^2.8.7",
     "tsup": "^6.7.0",
     "typescript": "^5.0.4"
   },
-  "prettier": {
-    "printWidth": 80,
-    "semi": true,
-    "singleQuote": true,
-    "trailingComma": "all"
-  },
   "scripts": {
     "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\"",
-    "lint": "eslint --max-warnings=0 ./src/**/**",
-    "prettier:fix": "prettier --write .",
-    "pre-commit": "pnpm prettier:fix && pnpm lint && pnpm build"
+    "pre-commit": "pnpm prettier:fix && pnpm lint && pnpm build",
+    "prettier:check": "prettier -c --ignore-unknown .",
+    "prettier:fix": "prettier -w --ignore-unknown .",
+    "eslint:check": "eslint --max-warnings=0 .",
+    "eslint:fix": "pnpm run eslint:check --fix",
+    "lint": "pnpm run eslint:check && pnpm run prettier:check",
+    "lint:fix": "pnpm run eslint:fix && pnpm run prettier:fix"
   }
 }

package/src/bcs.ts

@@ -3,38 +3,38 @@
 
 import { bcs } from '@mysten/sui.js';
 import {
-  KIOSK_PURCHASE_CAP,
-  KIOSK_TYPE,
-  TRANSFER_POLICY_CREATED_EVENT,
-  TRANSFER_POLICY_TYPE,
+	KIOSK_PURCHASE_CAP,
+	KIOSK_TYPE,
+	TRANSFER_POLICY_CREATED_EVENT,
+	TRANSFER_POLICY_TYPE,
 } from './types';
 
 // Register the `Kiosk` struct for faster queries.
 bcs.registerStructType(KIOSK_TYPE, {
-  id: 'address',
-  profits: 'u64',
-  owner: 'address',
-  itemCount: 'u32',
-  allowExtensions: 'bool',
+	id: 'address',
+	profits: 'u64',
+	owner: 'address',
+	itemCount: 'u32',
+	allowExtensions: 'bool',
 });
 
 // Register the `PurchaseCap` for faster queries.
 bcs.registerStructType(KIOSK_PURCHASE_CAP, {
-  id: 'address',
-  kioskId: 'address',
-  itemId: 'address',
-  minPrice: 'u64',
+	id: 'address',
+	kioskId: 'address',
+	itemId: 'address',
+	minPrice: 'u64',
 });
 
 // Register the `TransferPolicyCreated` event data.
 bcs.registerStructType(TRANSFER_POLICY_CREATED_EVENT, {
-  id: 'address',
+	id: 'address',
 });
 
 bcs.registerStructType(TRANSFER_POLICY_TYPE, {
-  id: 'address',
-  balance: 'u64',
-  rules: ['vector', 'string'],
+	id: 'address',
+	balance: 'u64',
+	rules: ['vector', 'string'],
 });
 
 export { bcs };

package/src/constants.ts

@@ -3,8 +3,8 @@
 
 /** The Transer Policy Rules package address on testnet */
 export const TESTNET_RULES_PACKAGE_ADDRESS =
-  'bd8fc1947cf119350184107a3087e2dc27efefa0dd82e25a1f699069fe81a585';
+	'bd8fc1947cf119350184107a3087e2dc27efefa0dd82e25a1f699069fe81a585';
 
 /** The transfer policy rules package address on mainnet */
 export const MAINNET_RULES_PACKAGE_ADDRESS =
-  '0x434b5bd8f6a7b05fede0ff46c6e511d71ea326ed38056e3bcd681d2d7c2a7879';
+	'0x434b5bd8f6a7b05fede0ff46c6e511d71ea326ed38056e3bcd681d2d7c2a7879';

package/src/query/kiosk.ts

@@ -2,118 +2,123 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import {
-  JsonRpcProvider,
-  ObjectId,
-  ObjectType,
-  PaginationArguments,
-  SuiAddress,
+	JsonRpcProvider,
+	ObjectId,
+	PaginationArguments,
+	SuiAddress,
+	SuiObjectData,
+	SuiObjectResponse,
+	getObjectFields,
+	isValidSuiAddress,
 } from '@mysten/sui.js';
 import {
-  attachListingsAndPrices,
-  attachLockedItems,
-  extractKioskData,
-  getKioskObject,
+	attachListingsAndPrices,
+	attachLockedItems,
+	extractKioskData,
+	getAllDynamicFields,
+	getKioskObject,
 } from '../utils';
-import { Kiosk } from '../types';
+import {
+	FetchKioskOptions,
+	KIOSK_OWNER_CAP,
+	KioskListing,
+	OwnedKiosks,
+	PagedKioskData,
+} from '../types';
 
-/**
- * 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;
-};
+export async function fetchKiosk(
+	provider: JsonRpcProvider,
+	kioskId: SuiAddress,
+	pagination: PaginationArguments<string>,
+	options: FetchKioskOptions,
+): Promise<PagedKioskData> {
+	// TODO: Replace the `getAllDynamicFields` with a paginated
+	// response, once we have better RPC support for
+	// type filtering & batch fetching.
+	// This can't work with pagination currently.
+	const data = await getAllDynamicFields(provider, kioskId, pagination);
 
-/**
- * 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.
-};
+	const listings: KioskListing[] = [];
+	const lockedItemIds: ObjectId[] = [];
 
-export type PagedKioskData = {
-  data: KioskData;
-  nextCursor: string | null;
-  hasNextPage: boolean;
-};
+	// extracted kiosk data.
+	const kioskData = extractKioskData(data, listings, lockedItemIds);
 
-export type FetchKioskOptions = {
-  withKioskFields?: boolean;
-  withListingPrices?: boolean;
-};
+	// split the fetching in two queries as we are most likely passing different options for each kind.
+	// For items, we usually seek the Display.
+	// For listings we usually seek the DF value (price) / exclusivity.
+	const [kiosk, listingObjects] = await Promise.all([
+		options.withKioskFields ? getKioskObject(provider, kioskId) : Promise.resolve(undefined),
+		options.withListingPrices
+			? provider.multiGetObjects({
+					ids: kioskData.listingIds,
+					options: {
+						showContent: true,
+					},
+			  })
+			: Promise.resolve([]),
+	]);
 
-export async function fetchKiosk(
-  provider: JsonRpcProvider,
-  kioskId: SuiAddress,
-  pagination: PaginationArguments<string>,
-  options: FetchKioskOptions,
-): Promise<PagedKioskData> {
-  const { data, nextCursor, hasNextPage } = await provider.getDynamicFields({
-    parentId: kioskId,
-    ...pagination,
-  });
+	if (options.withKioskFields) kioskData.kiosk = kiosk;
+	// attach items listings. IF we have `options.withListingPrices === true`, it will also attach the prices.
+	attachListingsAndPrices(kioskData, listings, listingObjects);
+	// add `locked` status to items that are locked.
+	attachLockedItems(kioskData, lockedItemIds);
 
-  const listings: KioskListing[] = [];
-  const lockedItemIds: ObjectId[] = [];
+	return {
+		data: kioskData,
+		nextCursor: null,
+		hasNextPage: false,
+	};
+}
+
+/**
+ * A function to fetch all the user's kiosk Caps
+ * And a list of the kiosk address ids.
+ * Returns a list of `kioskOwnerCapIds` and `kioskIds`.
+ * Extra options allow pagination.
+ */
+export async function getOwnedKiosks(
+	provider: JsonRpcProvider,
+	address: SuiAddress,
+	options?: {
+		pagination?: PaginationArguments<string>;
+	},
+): Promise<OwnedKiosks> {
+	if (!isValidSuiAddress(address))
+		return {
+			nextCursor: null,
+			hasNextPage: false,
+			kioskOwnerCaps: [],
+			kioskIds: [],
+		};
 
-  // extracted kiosk data.
-  const kioskData = extractKioskData(data, listings, lockedItemIds);
+	// fetch owned kiosk caps, paginated.
+	const { data, hasNextPage, nextCursor } = await provider.getOwnedObjects({
+		owner: address,
+		filter: { StructType: KIOSK_OWNER_CAP },
+		options: {
+			showContent: true,
+		},
+		...(options?.pagination || {}),
+	});
 
-  // split the fetching in two queries as we are most likely passing different options for each kind.
-  // For items, we usually seek the Display.
-  // For listings we usually seek the DF value (price) / exclusivity.
-  const [kiosk, listingObjects] = await Promise.all([
-    options.withKioskFields
-      ? getKioskObject(provider, kioskId)
-      : Promise.resolve(undefined),
-    options.withListingPrices
-      ? provider.multiGetObjects({
-          ids: kioskData.listingIds,
-          options: {
-            showContent: true,
-          },
-        })
-      : Promise.resolve([]),
-  ]);
+	// get kioskIds from the OwnerCaps.
+	const kioskIdList = data?.map((x: SuiObjectResponse) => getObjectFields(x)?.for);
 
-  if (options.withKioskFields) kioskData.kiosk = kiosk;
-  // attach items listings. IF we have `options.withListingPrices === true`, it will also attach the prices.
-  attachListingsAndPrices(kioskData, listings, listingObjects);
-  // add `locked` status to items that are locked.
-  attachLockedItems(kioskData, lockedItemIds);
+	// clean up data that might have an error in them.
+	// only return valid objects.
+	const filteredData = data.filter((x) => 'data' in x).map((x) => x.data) as SuiObjectData[];
 
-  return {
-    data: kioskData,
-    nextCursor,
-    hasNextPage,
-  };
+	return {
+		nextCursor,
+		hasNextPage,
+		kioskOwnerCaps: filteredData.map((x, idx) => ({
+			digest: x.digest,
+			version: x.version,
+			objectId: x.objectId,
+			kioskId: kioskIdList[idx],
+		})),
+		kioskIds: kioskIdList,
+	};
 }

package/src/query/transfer-policy.ts

@@ -3,11 +3,7 @@
 
 import { JsonRpcProvider } from '@mysten/sui.js';
 import { bcs } from '../bcs';
-import {
-  TRANSFER_POLICY_CREATED_EVENT,
-  TRANSFER_POLICY_TYPE,
-  TransferPolicy,
-} from '../types';
+import { TRANSFER_POLICY_CREATED_EVENT, TRANSFER_POLICY_TYPE, TransferPolicy } from '../types';
 
 /**
  * Searches the `TransferPolicy`-s for the given type. The seach is performed via
@@ -19,41 +15,39 @@ import {
  * @param type
  */
 export async function queryTransferPolicy(
-  provider: JsonRpcProvider,
-  type: string,
+	provider: JsonRpcProvider,
+	type: string,
 ): Promise<TransferPolicy[]> {
-  // console.log('event type: %s', `${TRANSFER_POLICY_CREATED_EVENT}<${type}>`);
-  const { data } = await provider.queryEvents({
-    query: {
-      MoveEventType: `${TRANSFER_POLICY_CREATED_EVENT}<${type}>`,
-    },
-  });
+	// console.log('event type: %s', `${TRANSFER_POLICY_CREATED_EVENT}<${type}>`);
+	const { data } = await provider.queryEvents({
+		query: {
+			MoveEventType: `${TRANSFER_POLICY_CREATED_EVENT}<${type}>`,
+		},
+	});
 
-  const search = data.map((event) => event.parsedJson as { id: string });
-  const policies = await provider.multiGetObjects({
-    ids: search.map((policy) => policy.id),
-    options: { showBcs: true, showOwner: true },
-  });
+	const search = data.map((event) => event.parsedJson as { id: string });
+	const policies = await provider.multiGetObjects({
+		ids: search.map((policy) => policy.id),
+		options: { showBcs: true, showOwner: true },
+	});
 
-  return policies
-    .filter((policy) => !!policy && 'data' in policy)
-    .map(({ data: policy }) => {
-      // should never happen; policies are objects and fetched via an event.
-      // policies are filtered for null and undefined above.
-      if (!policy || !policy.bcs || !('bcsBytes' in policy.bcs)) {
-        throw new Error(
-          `Invalid policy: ${policy?.objectId}, expected object, got package`,
-        );
-      }
+	return policies
+		.filter((policy) => !!policy && 'data' in policy)
+		.map(({ data: policy }) => {
+			// should never happen; policies are objects and fetched via an event.
+			// policies are filtered for null and undefined above.
+			if (!policy || !policy.bcs || !('bcsBytes' in policy.bcs)) {
+				throw new Error(`Invalid policy: ${policy?.objectId}, expected object, got package`);
+			}
 
-      let parsed = bcs.de(TRANSFER_POLICY_TYPE, policy.bcs.bcsBytes, 'base64');
+			let parsed = bcs.de(TRANSFER_POLICY_TYPE, policy.bcs.bcsBytes, 'base64');
 
-      return {
-        id: policy?.objectId,
-        type: `${TRANSFER_POLICY_TYPE}<${type}>`,
-        owner: policy?.owner!,
-        rules: parsed.rules,
-        balance: parsed.balance,
-      } as TransferPolicy;
-    });
+			return {
+				id: policy?.objectId,
+				type: `${TRANSFER_POLICY_TYPE}<${type}>`,
+				owner: policy?.owner!,
+				rules: parsed.rules,
+				balance: parsed.balance,
+			} as TransferPolicy;
+		});
 }