@mysten/kiosk 0.0.0-experimental-20230530145812 → 0.0.0-experimental-20230602192304

package/CHANGELOG.md

@@ -1,14 +1,20 @@
 # @mysten/kiosk
 
-## 0.0.0-experimental-20230530145812
+## 0.0.0-experimental-20230602192304
+
+### Minor Changes
+
+- 968304368d: Support kiosk_lock_rule and environment support for rules package. Breaks `purchaseAndResolvePolicies` as it changes signature and return format.
+
+## 0.2.0
 
 ### Minor Changes
 
 - c322a230da: Fix fetchKiosk consistency/naming, include locked state in items
 
-## 1.0.0
+## 0.1.0
 
-### Major Changes
+### Minor Changes
 
 - 4ea96d909a: Kiosk SDK for managing, querying and interacting with Kiosk and TransferPolicy objects
 

package/README.md

@@ -53,10 +53,10 @@ const getKiosk = async () => {
 </details>
 
 <details>
-<summary>Purchasing an item (currently supports royalty rule deployed on testnet or no rules)</summary>
+<summary>Purchasing an item (currently supports royalty rule, kiosk_lock_rule, no rules, (combination works too))</summary>
 
 ```typescript
-import { fetchKiosk } from '@mysten/kiosk';
+import { queryTransferPolicy, purchaseAndResolvePolicies, place, testnetEnvironment } from '@mysten/kiosk';
 import { Connection, JsonRpcProvider } from '@mysten/sui.js';
 
 const provider = new JsonRpcProvider(
@@ -76,6 +76,9 @@ const item = {
     price: "20000000000" // in MIST
   }
 }
+const ownedKiosk = `0xMyKioskAddress`;
+const ownedKioskCap = `0xMyKioskOwnerCap`;
+
 const purchaseItem = async (item, kioskId) => {
 
   // fetch the policy of the item (could be an array, if there's more than one transfer policy)
@@ -85,14 +88,25 @@ const purchaseItem = async (item, kioskId) => {
   // initialize tx block.
   const tx = new TransactionBlock();
 
-  // Purchases the item. Right now it also resolves a royalty rule, if one exists.
-  // There will be some additional work to support further rules & custom ones soon.
-  const purchasedItem = purchaseAndResolvePolicies(tx, item.type, item.listing, kioskId, item.objectId, policy[0]);
+  // Both are required if you there is a `kiosk_lock_rule`.
+  // Optional otherwise. Function will throw an error if there's a kiosk_lock_rule and these are missing.
+  const extraParams = {
+    ownedKiosk,
+    ownedKioskCap
+  }
+  // Define the environment.
+  // To use a custom package address for rules, you could call:
+  // const environment = customEnvironment('<PackageAddress>');
+  const environment = testnetEnvironment;
 
-  // now we need to decide what to do with the item
-  // ... e.g. place() // places the item to the user's kiosk.
-  // (NOT YET SUPPORTED BUT WORTH MENTIONING if the item has the `kiosk_lock` rule, the resolver will place it in the kiosk automatically.
-  // For now, to support this rule, we need to manually resolve the `kiosk_lock` rule and place it in our owned kiosk.)
+  // Extra params. Optional, but required if the user tries to resolve a `kiosk_lock_rule`.
+  // Purchases the item. Supports `kiosk_lock_rule`, `royalty_rule` (accepts combination too).
+  const result = purchaseAndResolvePolicies(tx, item.type, item.listing.price, kioskId, item.objectId, policy[0], environment, extraParams);
+
+  // result = {item: <the_purchased_item>, canTransfer: true/false // depending on whether there was a kiosk lock rule }
+  // if the item didn't have a kiosk_lock_rule, we need to do something with it.
+  // for e..g place it in our own kiosk. (demonstrated below)
+  if(result.canTransfer) place(tx, item.type, ownedKiosk, ownedKioskCap , result.item);
 
   // ...finally, sign PTB & execute it.
 
@@ -158,12 +172,16 @@ import { TransactionBlock } from '@mysten/sui.js';
 const withdraw = async () => {
   const kiosk = 'SomeKioskId';
   const kioskCap = 'KioskCapObjectId';
+  const address = '0xSomeAddressThatReceivesTheFunds';
   const amount = '100000';
 
   const tx = new TransactionBlock();
 
   withdrawFromKiosk(tx, kiosk, kioskCap, amount);
 
+  // transfer the Coin to self or any other address.
+  tx.transferObjects([coin], tx.pure(address, 'address'));
+
   // ... continue to sign and execute the transaction
   // ...
 };

package/dist/bcs.d.ts

@@ -1,33 +1,2 @@
-import { ObjectOwner, bcs } from '@mysten/sui.js';
-/**
- * The Kiosk object fields (for BCS queries).
- */
-export type Kiosk = {
-    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;
-};
-/** Event emitted when a TransferPolicy is created. */
-export type TransferPolicyCreated = {
-    id: string;
-};
-/** The `TransferPolicy` object */
-export type TransferPolicy = {
-    id: string;
-    type: string;
-    balance: string;
-    rules: string[];
-    owner: ObjectOwner;
-};
+import { bcs } from '@mysten/sui.js';
 export { bcs };

package/dist/constants.d.ts

@@ -0,0 +1,4 @@
+/** The Transer Policy Rules package address on testnet */
+export declare const TESTNET_RULES_PACKAGE_ADDRESS = "bd8fc1947cf119350184107a3087e2dc27efefa0dd82e25a1f699069fe81a585";
+/** The transfer policy rules package address on mainnet */
+export declare const MAINNET_RULES_PACKAGE_ADDRESS = "0x434b5bd8f6a7b05fede0ff46c6e511d71ea326ed38056e3bcd681d2d7c2a7879";

package/dist/index.d.ts

@@ -4,3 +4,5 @@ export * from './query/kiosk';
 export * from './bcs';
 export * from './utils';
 export * from './query/transfer-policy';
+export * from './types';
+export * from './constants';

package/dist/index.js

@@ -20,12 +20,20 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  KIOSK_ITEM: () => KIOSK_ITEM,
+  KIOSK_LISTING: () => KIOSK_LISTING,
+  KIOSK_LOCK: () => KIOSK_LOCK,
+  KIOSK_LOCK_RULE: () => KIOSK_LOCK_RULE,
   KIOSK_MODULE: () => KIOSK_MODULE,
   KIOSK_OWNER_CAP: () => KIOSK_OWNER_CAP,
+  KIOSK_PURCHASE_CAP: () => KIOSK_PURCHASE_CAP,
   KIOSK_TYPE: () => KIOSK_TYPE,
+  MAINNET_RULES_PACKAGE_ADDRESS: () => MAINNET_RULES_PACKAGE_ADDRESS,
+  ROYALTY_RULE: () => ROYALTY_RULE,
+  TESTNET_RULES_PACKAGE_ADDRESS: () => TESTNET_RULES_PACKAGE_ADDRESS,
   TRANSFER_POLICY_CREATED_EVENT: () => TRANSFER_POLICY_CREATED_EVENT,
   TRANSFER_POLICY_MODULE: () => TRANSFER_POLICY_MODULE,
-  TRANSFER_POLICY_RULES_PACKAGE_ADDRESS: () => TRANSFER_POLICY_RULES_PACKAGE_ADDRESS,
+  TRANSFER_POLICY_TYPE: () => TRANSFER_POLICY_TYPE,
   attachListingsAndPrices: () => attachListingsAndPrices,
   attachLockedItems: () => attachLockedItems,
   bcs: () => import_sui.bcs,
@@ -36,13 +44,16 @@ __export(src_exports, {
   createKiosk: () => createKiosk,
   createKioskAndShare: () => createKioskAndShare,
   createTransferPolicy: () => createTransferPolicy,
+  customEnvironment: () => customEnvironment,
   delist: () => delist,
   extractKioskData: () => extractKioskData,
   fetchKiosk: () => fetchKiosk,
   getKioskObject: () => getKioskObject,
+  getRulePackageAddress: () => getRulePackageAddress,
   getTypeWithoutPackageAddress: () => getTypeWithoutPackageAddress,
   list: () => list,
   lock: () => lock,
+  mainnetEnvironment: () => mainnetEnvironment,
   objArg: () => objArg,
   place: () => place,
   placeAndList: () => placeAndList,
@@ -50,9 +61,12 @@ __export(src_exports, {
   purchaseAndResolvePolicies: () => purchaseAndResolvePolicies,
   queryTransferPolicy: () => queryTransferPolicy,
   removeTransferPolicyRule: () => removeTransferPolicyRule,
+  resolveKioskLockRule: () => resolveKioskLockRule,
   resolveRoyaltyRule: () => resolveRoyaltyRule,
   returnValue: () => returnValue,
+  rulesPackageAddresses: () => rulesPackageAddresses,
   take: () => take,
+  testnetEnvironment: () => testnetEnvironment,
   withdrawFromKiosk: () => withdrawFromKiosk,
   withdrawFromPolicy: () => withdrawFromPolicy
 });
@@ -63,29 +77,65 @@ var import_sui2 = require("@mysten/sui.js");
 
 // src/bcs.ts
 var import_sui = require("@mysten/sui.js");
-import_sui.bcs.registerStructType("0x2::kiosk::Kiosk", {
+
+// src/types/kiosk.ts
+var KIOSK_MODULE = "0x2::kiosk";
+var KIOSK_TYPE = `${KIOSK_MODULE}::Kiosk`;
+var KIOSK_OWNER_CAP = `${KIOSK_MODULE}::KioskOwnerCap`;
+var KIOSK_ITEM = `${KIOSK_MODULE}::Item`;
+var KIOSK_LISTING = `${KIOSK_MODULE}::Listing`;
+var KIOSK_LOCK = `${KIOSK_MODULE}::Lock`;
+var KIOSK_PURCHASE_CAP = `${KIOSK_MODULE}::PurchaseCap`;
+
+// src/types/transfer-policy.ts
+var TRANSFER_POLICY_MODULE = "0x2::transfer_policy";
+var TRANSFER_POLICY_CREATED_EVENT = `${TRANSFER_POLICY_MODULE}::TransferPolicyCreated`;
+var TRANSFER_POLICY_TYPE = `${TRANSFER_POLICY_MODULE}::TransferPolicy`;
+var KIOSK_LOCK_RULE = "kiosk_lock_rule::Rule";
+var ROYALTY_RULE = "royalty_rule::Rule";
+
+// src/types/env.ts
+var testnetEnvironment = { env: "testnet" };
+var mainnetEnvironment = { env: "mainnet" };
+var customEnvironment = (address) => ({
+  env: "custom",
+  address
+});
+
+// src/bcs.ts
+import_sui.bcs.registerStructType(KIOSK_TYPE, {
   id: "address",
   profits: "u64",
   owner: "address",
   itemCount: "u32",
   allowExtensions: "bool"
 });
-import_sui.bcs.registerStructType("0x2::kiosk::PurchaseCap", {
+import_sui.bcs.registerStructType(KIOSK_PURCHASE_CAP, {
   id: "address",
   kioskId: "address",
   itemId: "address",
   minPrice: "u64"
 });
-import_sui.bcs.registerStructType("0x2::transfer_policy::TransferPolicyCreated", {
+import_sui.bcs.registerStructType(TRANSFER_POLICY_CREATED_EVENT, {
   id: "address"
 });
-import_sui.bcs.registerStructType("0x2::transfer_policy::TransferPolicy", {
+import_sui.bcs.registerStructType(TRANSFER_POLICY_TYPE, {
   id: "address",
   balance: "u64",
   rules: ["vector", "string"]
 });
 
+// src/constants.ts
+var TESTNET_RULES_PACKAGE_ADDRESS = "bd8fc1947cf119350184107a3087e2dc27efefa0dd82e25a1f699069fe81a585";
+var MAINNET_RULES_PACKAGE_ADDRESS = "0x434b5bd8f6a7b05fede0ff46c6e511d71ea326ed38056e3bcd681d2d7c2a7879";
+
 // src/utils.ts
+var rulesPackageAddresses = {
+  mainnet: MAINNET_RULES_PACKAGE_ADDRESS,
+  testnet: TESTNET_RULES_PACKAGE_ADDRESS,
+  devnet: "",
+  custom: null
+};
 function objArg(tx, arg) {
   if (typeof arg === "string") {
     return tx.object(arg);
@@ -109,7 +159,7 @@ async function getKioskObject(provider, id) {
   if (!queryRes.data.bcs || !("bcsBytes" in queryRes.data.bcs)) {
     throw new Error(`Invalid kiosk query: ${id}, expected object, got package`);
   }
-  return import_sui.bcs.de("0x2::kiosk::Kiosk", queryRes.data.bcs.bcsBytes, "base64");
+  return import_sui.bcs.de(KIOSK_TYPE, queryRes.data.bcs.bcsBytes, "base64");
 }
 function extractKioskData(data, listings, lockedItemIds) {
   return data.reduce(
@@ -141,10 +191,10 @@ function extractKioskData(data, listings, lockedItemIds) {
     { items: [], itemIds: [], listingIds: [], extensions: [] }
   );
 }
-var getTypeWithoutPackageAddress = (type) => {
+function getTypeWithoutPackageAddress(type) {
   return type.split("::").slice(-2).join("::");
-};
-var attachListingsAndPrices = (kioskData, listings, listingObjects) => {
+}
+function attachListingsAndPrices(kioskData, listings, listingObjects) {
   const itemListings = listings.reduce(
     (acc, item, idx) => {
       acc[item.objectId] = { ...item };
@@ -161,8 +211,8 @@ var attachListingsAndPrices = (kioskData, listings, listingObjects) => {
   kioskData.items.map((item) => {
     item.listing = itemListings[item.objectId] || void 0;
   });
-};
-var attachLockedItems = (kioskData, lockedItemIds) => {
+}
+function attachLockedItems(kioskData, lockedItemIds) {
   const lockedStatuses = lockedItemIds.reduce(
     (acc, item) => {
       acc[item] = true;
@@ -173,11 +223,17 @@ var attachLockedItems = (kioskData, lockedItemIds) => {
   kioskData.items.map((item) => {
     item.isLocked = lockedStatuses[item.objectId] || false;
   });
-};
+}
+function getRulePackageAddress(environment) {
+  if (environment.env === "custom") {
+    if (!environment.address)
+      throw new Error("Please supply the custom package address for rules.");
+    return environment.address;
+  }
+  return rulesPackageAddresses[environment.env];
+}
 
 // src/tx/transfer-policy.ts
-var TRANSFER_POLICY_MODULE = "0x2::transfer_policy";
-var TRANSFER_POLICY_RULES_PACKAGE_ADDRESS = "bd8fc1947cf119350184107a3087e2dc27efefa0dd82e25a1f699069fe81a585";
 function createTransferPolicy(tx, itemType, publisher) {
   let [transferPolicy, transferPolicyCap] = tx.moveCall({
     target: `${TRANSFER_POLICY_MODULE}::new`,
@@ -192,7 +248,7 @@ function createTransferPolicy(tx, itemType, publisher) {
   return transferPolicyCap;
 }
 function withdrawFromPolicy(tx, itemType, policy, policyCap, amount) {
-  let amountArg = amount !== null ? tx.pure(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],
@@ -214,25 +270,30 @@ function removeTransferPolicyRule(tx, itemType, ruleType, configType, policy, po
     arguments: [objArg(tx, policy), policyCap]
   });
 }
-function resolveRoyaltyRule(tx, itemType, price, policyId, transferRequest) {
+function resolveRoyaltyRule(tx, itemType, price, policyId, transferRequest, environment) {
   const policyObj = objArg(tx, policyId);
   const [amount] = tx.moveCall({
-    target: `${TRANSFER_POLICY_RULES_PACKAGE_ADDRESS}::royalty_rule::fee_amount`,
+    target: `${getRulePackageAddress(environment)}::royalty_rule::fee_amount`,
     typeArguments: [itemType],
     arguments: [policyObj, objArg(tx, price)]
   });
   const feeCoin = tx.splitCoins(tx.gas, [amount]);
   tx.moveCall({
-    target: `${TRANSFER_POLICY_RULES_PACKAGE_ADDRESS}::royalty_rule::pay`,
+    target: `${getRulePackageAddress(environment)}::royalty_rule::pay`,
     typeArguments: [itemType],
     arguments: [policyObj, transferRequest, feeCoin]
   });
 }
+function resolveKioskLockRule(tx, itemType, item, kiosk, kioskCap, policyId, transferRequest, environment) {
+  lock(tx, itemType, kiosk, kioskCap, policyId, item);
+  tx.moveCall({
+    target: `${getRulePackageAddress(environment)}::kiosk_lock_rule::prove`,
+    typeArguments: [itemType],
+    arguments: [transferRequest, objArg(tx, kiosk)]
+  });
+}
 
 // src/tx/kiosk.ts
-var KIOSK_MODULE = "0x2::kiosk";
-var KIOSK_TYPE = `${KIOSK_MODULE}::Kiosk`;
-var KIOSK_OWNER_CAP = `${KIOSK_MODULE}::KioskOwnerCap`;
 function createKiosk(tx) {
   let [kiosk, kioskOwnerCap] = tx.moveCall({
     target: `${KIOSK_MODULE}::new`
@@ -329,7 +390,12 @@ function purchase(tx, itemType, kiosk, itemId, payment) {
   return [item, transferRequest];
 }
 function withdrawFromKiosk(tx, kiosk, kioskCap, amount) {
-  let amountArg = amount !== null ? tx.pure(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 [coin] = tx.moveCall({
     target: `${KIOSK_MODULE}::withdraw`,
     arguments: [objArg(tx, kiosk), objArg(tx, kioskCap), amountArg]
@@ -379,27 +445,46 @@ function returnValue(tx, itemType, kiosk, item, promise) {
     arguments: [objArg(tx, kiosk), item, promise]
   });
 }
-function purchaseAndResolvePolicies(tx, itemType, listing, kioskId, itemId, policy) {
-  if (!listing || listing?.price === void 0)
-    return null;
-  const coin = tx.splitCoins(tx.gas, [tx.pure(listing.price)]);
+function purchaseAndResolvePolicies(tx, itemType, price, kiosk, itemId, policy, environment, extraParams) {
+  if (price === void 0 || typeof price !== "string")
+    throw new Error(`Price of the listing is not supplied.`);
+  const coin = tx.splitCoins(tx.gas, [tx.pure(price, "u64")]);
   const [purchasedItem, transferRequest] = purchase(
     tx,
     itemType,
-    kioskId,
+    kiosk,
     itemId,
     coin
   );
+  let hasKioskLockRule = false;
   for (let rule of policy.rules) {
     const ruleWithoutAddr = getTypeWithoutPackageAddress(rule);
     switch (ruleWithoutAddr) {
-      case "royalty_rule::Rule":
+      case ROYALTY_RULE:
         resolveRoyaltyRule(
           tx,
           itemType,
-          listing.price,
+          price,
           policy.id,
-          transferRequest
+          transferRequest,
+          environment
+        );
+        break;
+      case KIOSK_LOCK_RULE:
+        if (!extraParams?.ownedKiosk || !extraParams?.ownedKioskCap)
+          throw new Error(
+            `This item type ${itemType} has a 'kiosk_lock_rule', but function call is missing user's kiosk and kioskCap params`
+          );
+        hasKioskLockRule = true;
+        resolveKioskLockRule(
+          tx,
+          itemType,
+          purchasedItem,
+          extraParams.ownedKiosk,
+          extraParams.ownedKioskCap,
+          policy.id,
+          transferRequest,
+          environment
         );
         break;
       default:
@@ -407,7 +492,10 @@ function purchaseAndResolvePolicies(tx, itemType, listing, kioskId, itemId, poli
     }
   }
   confirmRequest(tx, itemType, policy.id, transferRequest);
-  return purchasedItem;
+  return {
+    item: purchasedItem,
+    canTransfer: !hasKioskLockRule
+  };
 }
 
 // src/query/kiosk.ts
@@ -440,7 +528,6 @@ async function fetchKiosk(provider, kioskId, pagination, options) {
 }
 
 // src/query/transfer-policy.ts
-var TRANSFER_POLICY_CREATED_EVENT = `0x2::transfer_policy::TransferPolicyCreated`;
 async function queryTransferPolicy(provider, type) {
   const { data } = await provider.queryEvents({
     query: {
@@ -458,14 +545,10 @@ async function queryTransferPolicy(provider, type) {
         `Invalid policy: ${policy?.objectId}, expected object, got package`
       );
     }
-    let parsed = import_sui.bcs.de(
-      "0x2::transfer_policy::TransferPolicy",
-      policy.bcs.bcsBytes,
-      "base64"
-    );
+    let parsed = import_sui.bcs.de(TRANSFER_POLICY_TYPE, policy.bcs.bcsBytes, "base64");
     return {
       id: policy?.objectId,
-      type: `0x2::transfer_policy::TransferPolicy<${type}>`,
+      type: `${TRANSFER_POLICY_TYPE}<${type}>`,
       owner: policy?.owner,
       rules: parsed.rules,
       balance: parsed.balance
@@ -474,12 +557,20 @@ async function queryTransferPolicy(provider, type) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  KIOSK_ITEM,
+  KIOSK_LISTING,
+  KIOSK_LOCK,
+  KIOSK_LOCK_RULE,
   KIOSK_MODULE,
   KIOSK_OWNER_CAP,
+  KIOSK_PURCHASE_CAP,
   KIOSK_TYPE,
+  MAINNET_RULES_PACKAGE_ADDRESS,
+  ROYALTY_RULE,
+  TESTNET_RULES_PACKAGE_ADDRESS,
   TRANSFER_POLICY_CREATED_EVENT,
   TRANSFER_POLICY_MODULE,
-  TRANSFER_POLICY_RULES_PACKAGE_ADDRESS,
+  TRANSFER_POLICY_TYPE,
   attachListingsAndPrices,
   attachLockedItems,
   bcs,
@@ -490,13 +581,16 @@ async function queryTransferPolicy(provider, type) {
   createKiosk,
   createKioskAndShare,
   createTransferPolicy,
+  customEnvironment,
   delist,
   extractKioskData,
   fetchKiosk,
   getKioskObject,
+  getRulePackageAddress,
   getTypeWithoutPackageAddress,
   list,
   lock,
+  mainnetEnvironment,
   objArg,
   place,
   placeAndList,
@@ -504,9 +598,12 @@ async function queryTransferPolicy(provider, type) {
   purchaseAndResolvePolicies,
   queryTransferPolicy,
   removeTransferPolicyRule,
+  resolveKioskLockRule,
   resolveRoyaltyRule,
   returnValue,
+  rulesPackageAddresses,
   take,
+  testnetEnvironment,
   withdrawFromKiosk,
   withdrawFromPolicy
 });