@mysten/kiosk 0.7.13 → 0.8.1

package/dist/esm/query/transfer-policy.d.ts

@@ -0,0 +1,28 @@
+import type { SuiClient } from '@mysten/sui.js/client';
+import type { TransferPolicy, TransferPolicyCap } from '../types/index.js';
+/**
+ * Searches the `TransferPolicy`-s for the given type. The seach is performed via
+ * the `TransferPolicyCreated` event. The policy can either be owned or shared,
+ * and the caller needs to filter the results accordingly (ie single owner can not
+ * be accessed by anyone but the owner).
+ *
+ * @param provider
+ * @param type
+ */
+export declare function queryTransferPolicy(client: SuiClient, type: string): Promise<TransferPolicy[]>;
+/**
+ * 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.
+ * @returns TransferPolicyCap Object ID | undefined if not found.
+ */
+export declare function queryTransferPolicyCapsByType(client: SuiClient, address: string, type: string): Promise<TransferPolicyCap[]>;
+/**
+ * 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.
+ * @returns TransferPolicyCap Object ID | undefined if not found.
+ */
+export declare function queryOwnedTransferPolicies(client: SuiClient, address: string): Promise<TransferPolicyCap[] | undefined>;

package/dist/esm/query/transfer-policy.js

@@ -0,0 +1,78 @@
+import { isValidSuiAddress } from "@mysten/sui.js/utils";
+import { bcs } from "../bcs.js";
+import {
+  TRANSFER_POLICY_CAP_TYPE,
+  TRANSFER_POLICY_CREATED_EVENT,
+  TRANSFER_POLICY_TYPE
+} from "../types/index.js";
+import { getAllOwnedObjects, parseTransferPolicyCapObject } from "../utils.js";
+async function queryTransferPolicy(client, type) {
+  const { data } = await client.queryEvents({
+    query: {
+      MoveEventType: `${TRANSFER_POLICY_CREATED_EVENT}<${type}>`
+    }
+  });
+  const search = data.map((event) => event.parsedJson);
+  const policies = await client.multiGetObjects({
+    ids: search.map((policy) => policy.id),
+    options: { showBcs: true, showOwner: true }
+  });
+  return policies.filter((policy) => !!policy && "data" in policy).map(({ data: policy }) => {
+    if (!policy || !policy.bcs || !("bcsBytes" in policy.bcs)) {
+      throw new Error(`Invalid policy: ${policy?.objectId}, expected object, got package`);
+    }
+    const 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
+    };
+  });
+}
+async function queryTransferPolicyCapsByType(client, address, type) {
+  if (!isValidSuiAddress(address))
+    return [];
+  const filter = {
+    MatchAll: [
+      {
+        StructType: `${TRANSFER_POLICY_CAP_TYPE}<${type}>`
+      }
+    ]
+  };
+  const data = await getAllOwnedObjects({
+    client,
+    filter,
+    owner: address
+  });
+  return data.map((item) => parseTransferPolicyCapObject(item)).filter((item) => !!item);
+}
+async function queryOwnedTransferPolicies(client, address) {
+  if (!isValidSuiAddress(address))
+    return;
+  const filter = {
+    MatchAll: [
+      {
+        MoveModule: {
+          module: "transfer_policy",
+          package: "0x2"
+        }
+      }
+    ]
+  };
+  const data = await getAllOwnedObjects({ client, owner: address, filter });
+  const policies = [];
+  for (const item of data) {
+    const data2 = parseTransferPolicyCapObject(item);
+    if (data2)
+      policies.push(data2);
+  }
+  return policies;
+}
+export {
+  queryOwnedTransferPolicies,
+  queryTransferPolicy,
+  queryTransferPolicyCapsByType
+};
+//# sourceMappingURL=transfer-policy.js.map

package/dist/esm/query/transfer-policy.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/query/transfer-policy.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { SuiClient } from '@mysten/sui.js/client';\nimport { isValidSuiAddress } from '@mysten/sui.js/utils';\n\nimport { bcs } from '../bcs.js';\nimport type { TransferPolicy, TransferPolicyCap } from '../types/index.js';\nimport {\n\tTRANSFER_POLICY_CAP_TYPE,\n\tTRANSFER_POLICY_CREATED_EVENT,\n\tTRANSFER_POLICY_TYPE,\n} from '../types/index.js';\nimport { getAllOwnedObjects, parseTransferPolicyCapObject } from '../utils.js';\n\n/**\n * Searches the `TransferPolicy`-s for the given type. The seach is performed via\n * the `TransferPolicyCreated` event. The policy can either be owned or shared,\n * and the caller needs to filter the results accordingly (ie single owner can not\n * be accessed by anyone but the owner).\n *\n * @param provider\n * @param type\n */\nexport async function queryTransferPolicy(\n\tclient: SuiClient,\n\ttype: string,\n): Promise<TransferPolicy[]> {\n\t// console.log('event type: %s', `${TRANSFER_POLICY_CREATED_EVENT}<${type}>`);\n\tconst { data } = await client.queryEvents({\n\t\tquery: {\n\t\t\tMoveEventType: `${TRANSFER_POLICY_CREATED_EVENT}<${type}>`,\n\t\t},\n\t});\n\n\tconst search = data.map((event) => event.parsedJson as { id: string });\n\tconst policies = await client.multiGetObjects({\n\t\tids: search.map((policy) => policy.id),\n\t\toptions: { showBcs: true, showOwner: true },\n\t});\n\n\treturn policies\n\t\t.filter((policy) => !!policy && 'data' in policy)\n\t\t.map(({ data: policy }) => {\n\t\t\t// should never happen; policies are objects and fetched via an event.\n\t\t\t// policies are filtered for null and undefined above.\n\t\t\tif (!policy || !policy.bcs || !('bcsBytes' in policy.bcs)) {\n\t\t\t\tthrow new Error(`Invalid policy: ${policy?.objectId}, expected object, got package`);\n\t\t\t}\n\n\t\t\tconst parsed = bcs.de(TRANSFER_POLICY_TYPE, policy.bcs.bcsBytes, 'base64');\n\n\t\t\treturn {\n\t\t\t\tid: policy?.objectId,\n\t\t\t\ttype: `${TRANSFER_POLICY_TYPE}<${type}>`,\n\t\t\t\towner: policy?.owner!,\n\t\t\t\trules: parsed.rules,\n\t\t\t\tbalance: parsed.balance,\n\t\t\t} as TransferPolicy;\n\t\t});\n}\n\n/**\n * A function to fetch all the user's kiosk Caps\n * And a list of the kiosk address ids.\n * Returns a list of `kioskOwnerCapIds` and `kioskIds`.\n * Extra options allow pagination.\n * @returns TransferPolicyCap Object ID | undefined if not found.\n */\nexport async function queryTransferPolicyCapsByType(\n\tclient: SuiClient,\n\taddress: string,\n\ttype: string,\n): Promise<TransferPolicyCap[]> {\n\tif (!isValidSuiAddress(address)) return [];\n\n\tconst filter = {\n\t\tMatchAll: [\n\t\t\t{\n\t\t\t\tStructType: `${TRANSFER_POLICY_CAP_TYPE}<${type}>`,\n\t\t\t},\n\t\t],\n\t};\n\n\t// fetch owned kiosk caps, paginated.\n\tconst data = await getAllOwnedObjects({\n\t\tclient,\n\t\tfilter,\n\t\towner: address,\n\t});\n\n\treturn data\n\t\t.map((item) => parseTransferPolicyCapObject(item))\n\t\t.filter((item) => !!item) as TransferPolicyCap[];\n}\n\n/**\n * A function to fetch all the user's kiosk Caps\n * And a list of the kiosk address ids.\n * Returns a list of `kioskOwnerCapIds` and `kioskIds`.\n * Extra options allow pagination.\n * @returns TransferPolicyCap Object ID | undefined if not found.\n */\nexport async function queryOwnedTransferPolicies(\n\tclient: SuiClient,\n\taddress: string,\n): Promise<TransferPolicyCap[] | undefined> {\n\tif (!isValidSuiAddress(address)) return;\n\n\tconst filter = {\n\t\tMatchAll: [\n\t\t\t{\n\t\t\t\tMoveModule: {\n\t\t\t\t\tmodule: 'transfer_policy',\n\t\t\t\t\tpackage: '0x2',\n\t\t\t\t},\n\t\t\t},\n\t\t],\n\t};\n\n\t// fetch all owned kiosk caps, paginated.\n\tconst data = await getAllOwnedObjects({ client, owner: address, filter });\n\n\tconst policies: TransferPolicyCap[] = [];\n\n\tfor (const item of data) {\n\t\tconst data = parseTransferPolicyCapObject(item);\n\t\tif (data) policies.push(data);\n\t}\n\n\treturn policies;\n}\n"],
+  "mappings": "AAIA,SAAS,yBAAyB;AAElC,SAAS,WAAW;AAEpB;AAAA,EACC;AAAA,EACA;AAAA,EACA;AAAA,OACM;AACP,SAAS,oBAAoB,oCAAoC;AAWjE,eAAsB,oBACrB,QACA,MAC4B;AAE5B,QAAM,EAAE,KAAK,IAAI,MAAM,OAAO,YAAY;AAAA,IACzC,OAAO;AAAA,MACN,eAAe,GAAG,iCAAiC;AAAA,IACpD;AAAA,EACD,CAAC;AAED,QAAM,SAAS,KAAK,IAAI,CAAC,UAAU,MAAM,UAA4B;AACrE,QAAM,WAAW,MAAM,OAAO,gBAAgB;AAAA,IAC7C,KAAK,OAAO,IAAI,CAAC,WAAW,OAAO,EAAE;AAAA,IACrC,SAAS,EAAE,SAAS,MAAM,WAAW,KAAK;AAAA,EAC3C,CAAC;AAED,SAAO,SACL,OAAO,CAAC,WAAW,CAAC,CAAC,UAAU,UAAU,MAAM,EAC/C,IAAI,CAAC,EAAE,MAAM,OAAO,MAAM;AAG1B,QAAI,CAAC,UAAU,CAAC,OAAO,OAAO,EAAE,cAAc,OAAO,MAAM;AAC1D,YAAM,IAAI,MAAM,mBAAmB,QAAQ,wCAAwC;AAAA,IACpF;AAEA,UAAM,SAAS,IAAI,GAAG,sBAAsB,OAAO,IAAI,UAAU,QAAQ;AAEzE,WAAO;AAAA,MACN,IAAI,QAAQ;AAAA,MACZ,MAAM,GAAG,wBAAwB;AAAA,MACjC,OAAO,QAAQ;AAAA,MACf,OAAO,OAAO;AAAA,MACd,SAAS,OAAO;AAAA,IACjB;AAAA,EACD,CAAC;AACH;AASA,eAAsB,8BACrB,QACA,SACA,MAC+B;AAC/B,MAAI,CAAC,kBAAkB,OAAO;AAAG,WAAO,CAAC;AAEzC,QAAM,SAAS;AAAA,IACd,UAAU;AAAA,MACT;AAAA,QACC,YAAY,GAAG,4BAA4B;AAAA,MAC5C;AAAA,IACD;AAAA,EACD;AAGA,QAAM,OAAO,MAAM,mBAAmB;AAAA,IACrC;AAAA,IACA;AAAA,IACA,OAAO;AAAA,EACR,CAAC;AAED,SAAO,KACL,IAAI,CAAC,SAAS,6BAA6B,IAAI,CAAC,EAChD,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI;AAC1B;AASA,eAAsB,2BACrB,QACA,SAC2C;AAC3C,MAAI,CAAC,kBAAkB,OAAO;AAAG;AAEjC,QAAM,SAAS;AAAA,IACd,UAAU;AAAA,MACT;AAAA,QACC,YAAY;AAAA,UACX,QAAQ;AAAA,UACR,SAAS;AAAA,QACV;AAAA,MACD;AAAA,IACD;AAAA,EACD;AAGA,QAAM,OAAO,MAAM,mBAAmB,EAAE,QAAQ,OAAO,SAAS,OAAO,CAAC;AAExE,QAAM,WAAgC,CAAC;AAEvC,aAAW,QAAQ,MAAM;AACxB,UAAMA,QAAO,6BAA6B,IAAI;AAC9C,QAAIA;AAAM,eAAS,KAAKA,KAAI;AAAA,EAC7B;AAEA,SAAO;AACR;",
+  "names": ["data"]
+}

package/dist/esm/tx/kiosk.d.ts

@@ -0,0 +1,71 @@
+import type { TransactionArgument, TransactionBlock, TransactionObjectArgument } from '@mysten/sui.js/transactions';
+import type { ObjectArgument } from '../types/index.js';
+/**
+ * Create a new shared Kiosk and returns the [kiosk, kioskOwnerCap] tuple.
+ */
+export declare function createKiosk(tx: TransactionBlock): [TransactionObjectArgument, TransactionObjectArgument];
+/**
+ * Calls the `kiosk::new()` function and shares the kiosk.
+ * Returns the `kioskOwnerCap` object.
+ */
+export declare function createKioskAndShare(tx: TransactionBlock): TransactionObjectArgument;
+/**
+ * Converts Transfer Policy to a shared object.
+ */
+export declare function shareKiosk(tx: TransactionBlock, kiosk: TransactionArgument): void;
+/**
+ * Call the `kiosk::place<T>(Kiosk, KioskOwnerCap, Item)` function.
+ * Place an item to the Kiosk.
+ */
+export declare function place(tx: TransactionBlock, itemType: string, kiosk: ObjectArgument, kioskCap: ObjectArgument, item: ObjectArgument): void;
+/**
+ * Call the `kiosk::lock<T>(Kiosk, KioskOwnerCap, TransferPolicy, Item)`
+ * function. Lock an item in the Kiosk.
+ *
+ * Unlike `place` this function requires a `TransferPolicy` to exist
+ * and be passed in. This is done to make sure the item does not get
+ * locked without an option to take it out.
+ */
+export declare function lock(tx: TransactionBlock, itemType: string, kiosk: ObjectArgument, kioskCap: ObjectArgument, policy: ObjectArgument, item: ObjectArgument): void;
+/**
+ * Call the `kiosk::take<T>(Kiosk, KioskOwnerCap, ID)` function.
+ * Take an item from the Kiosk.
+ */
+export declare function take(tx: TransactionBlock, itemType: string, kiosk: ObjectArgument, kioskCap: ObjectArgument, itemId: string): TransactionObjectArgument;
+/**
+ * Call the `kiosk::list<T>(Kiosk, KioskOwnerCap, ID, u64)` function.
+ * List an item for sale.
+ */
+export declare function list(tx: TransactionBlock, itemType: string, kiosk: ObjectArgument, kioskCap: ObjectArgument, itemId: string, price: string | bigint): void;
+/**
+ * Call the `kiosk::list<T>(Kiosk, KioskOwnerCap, ID, u64)` function.
+ * List an item for sale.
+ */
+export declare function delist(tx: TransactionBlock, itemType: string, kiosk: ObjectArgument, kioskCap: ObjectArgument, itemId: string): void;
+/**
+ * Call the `kiosk::place_and_list<T>(Kiosk, KioskOwnerCap, Item, u64)` function.
+ * Place an item to the Kiosk and list it for sale.
+ */
+export declare function placeAndList(tx: TransactionBlock, itemType: string, kiosk: ObjectArgument, kioskCap: ObjectArgument, item: ObjectArgument, price: string | bigint): void;
+/**
+ * Call the `kiosk::purchase<T>(Kiosk, ID, Coin<SUI>)` function and receive an Item and
+ * a TransferRequest which needs to be dealt with (via a matching TransferPolicy).
+ */
+export declare function purchase(tx: TransactionBlock, itemType: string, kiosk: ObjectArgument, itemId: string, payment: ObjectArgument): [TransactionObjectArgument, TransactionObjectArgument];
+/**
+ * Call the `kiosk::withdraw(Kiosk, KioskOwnerCap, Option<u64>)` function and receive a Coin<SUI>.
+ * If the amount is null, then the entire balance will be withdrawn.
+ */
+export declare function withdrawFromKiosk(tx: TransactionBlock, kiosk: ObjectArgument, kioskCap: ObjectArgument, amount?: string | bigint | number): TransactionObjectArgument;
+/**
+ * Call the `kiosk::borrow_value<T>(Kiosk, KioskOwnerCap, ID): T` function.
+ * Immutably borrow an item from the Kiosk and return it in the end.
+ *
+ * Requires calling `returnValue` to return the item.
+ */
+export declare function borrowValue(tx: TransactionBlock, itemType: string, kiosk: ObjectArgument, kioskCap: ObjectArgument, itemId: string): [TransactionArgument, TransactionArgument];
+/**
+ * Call the `kiosk::return_value<T>(Kiosk, Item, Borrow)` function.
+ * Return an item to the Kiosk after it was `borrowValue`-d.
+ */
+export declare function returnValue(tx: TransactionBlock, itemType: string, kiosk: ObjectArgument, item: TransactionArgument, promise: TransactionArgument): void;

package/dist/esm/tx/kiosk.js

@@ -0,0 +1,110 @@
+import { bcs } from "@mysten/sui.js/bcs";
+import { KIOSK_MODULE, KIOSK_TYPE } from "../types/index.js";
+function createKiosk(tx) {
+  const [kiosk, kioskOwnerCap] = tx.moveCall({
+    target: `${KIOSK_MODULE}::new`
+  });
+  return [kiosk, kioskOwnerCap];
+}
+function createKioskAndShare(tx) {
+  const [kiosk, kioskOwnerCap] = createKiosk(tx);
+  shareKiosk(tx, kiosk);
+  return kioskOwnerCap;
+}
+function shareKiosk(tx, kiosk) {
+  tx.moveCall({
+    target: `0x2::transfer::public_share_object`,
+    typeArguments: [KIOSK_TYPE],
+    arguments: [kiosk]
+  });
+}
+function place(tx, itemType, kiosk, kioskCap, item) {
+  tx.moveCall({
+    target: `${KIOSK_MODULE}::place`,
+    typeArguments: [itemType],
+    arguments: [tx.object(kiosk), tx.object(kioskCap), tx.object(item)]
+  });
+}
+function lock(tx, itemType, kiosk, kioskCap, policy, item) {
+  tx.moveCall({
+    target: `${KIOSK_MODULE}::lock`,
+    typeArguments: [itemType],
+    arguments: [tx.object(kiosk), tx.object(kioskCap), tx.object(policy), tx.object(item)]
+  });
+}
+function take(tx, itemType, kiosk, kioskCap, itemId) {
+  const [item] = tx.moveCall({
+    target: `${KIOSK_MODULE}::take`,
+    typeArguments: [itemType],
+    arguments: [tx.object(kiosk), tx.object(kioskCap), tx.pure.id(itemId)]
+  });
+  return item;
+}
+function list(tx, itemType, kiosk, kioskCap, itemId, price) {
+  tx.moveCall({
+    target: `${KIOSK_MODULE}::list`,
+    typeArguments: [itemType],
+    arguments: [tx.object(kiosk), tx.object(kioskCap), tx.pure.id(itemId), tx.pure.u64(price)]
+  });
+}
+function delist(tx, itemType, kiosk, kioskCap, itemId) {
+  tx.moveCall({
+    target: `${KIOSK_MODULE}::delist`,
+    typeArguments: [itemType],
+    arguments: [tx.object(kiosk), tx.object(kioskCap), tx.pure.id(itemId)]
+  });
+}
+function placeAndList(tx, itemType, kiosk, kioskCap, item, price) {
+  tx.moveCall({
+    target: `${KIOSK_MODULE}::place_and_list`,
+    typeArguments: [itemType],
+    arguments: [tx.object(kiosk), tx.object(kioskCap), tx.object(item), tx.pure.u64(price)]
+  });
+}
+function purchase(tx, itemType, kiosk, itemId, payment) {
+  const [item, transferRequest] = tx.moveCall({
+    target: `${KIOSK_MODULE}::purchase`,
+    typeArguments: [itemType],
+    arguments: [tx.object(kiosk), tx.pure.id(itemId), tx.object(payment)]
+  });
+  return [item, transferRequest];
+}
+function withdrawFromKiosk(tx, kiosk, kioskCap, amount) {
+  const amountArg = bcs.option(bcs.u64()).serialize(amount);
+  const [coin] = tx.moveCall({
+    target: `${KIOSK_MODULE}::withdraw`,
+    arguments: [tx.object(kiosk), tx.object(kioskCap), amountArg]
+  });
+  return coin;
+}
+function borrowValue(tx, itemType, kiosk, kioskCap, itemId) {
+  const [item, promise] = tx.moveCall({
+    target: `${KIOSK_MODULE}::borrow_val`,
+    typeArguments: [itemType],
+    arguments: [tx.object(kiosk), tx.object(kioskCap), tx.pure.id(itemId)]
+  });
+  return [item, promise];
+}
+function returnValue(tx, itemType, kiosk, item, promise) {
+  tx.moveCall({
+    target: `${KIOSK_MODULE}::return_val`,
+    typeArguments: [itemType],
+    arguments: [tx.object(kiosk), item, promise]
+  });
+}
+export {
+  borrowValue,
+  createKiosk,
+  createKioskAndShare,
+  delist,
+  list,
+  lock,
+  place,
+  placeAndList,
+  purchase,
+  returnValue,
+  shareKiosk,
+  take,
+  withdrawFromKiosk
+};
+//# sourceMappingURL=kiosk.js.map

package/dist/esm/tx/kiosk.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/tx/kiosk.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport { bcs } from '@mysten/sui.js/bcs';\nimport type {\n\tTransactionArgument,\n\tTransactionBlock,\n\tTransactionObjectArgument,\n} from '@mysten/sui.js/transactions';\n\nimport type { ObjectArgument } from '../types/index.js';\nimport { KIOSK_MODULE, KIOSK_TYPE } from '../types/index.js';\n\n/**\n * Create a new shared Kiosk and returns the [kiosk, kioskOwnerCap] tuple.\n */\nexport function createKiosk(\n\ttx: TransactionBlock,\n): [TransactionObjectArgument, TransactionObjectArgument] {\n\tconst [kiosk, kioskOwnerCap] = tx.moveCall({\n\t\ttarget: `${KIOSK_MODULE}::new`,\n\t});\n\n\treturn [kiosk, kioskOwnerCap];\n}\n\n/**\n * Calls the `kiosk::new()` function and shares the kiosk.\n * Returns the `kioskOwnerCap` object.\n */\nexport function createKioskAndShare(tx: TransactionBlock): TransactionObjectArgument {\n\tconst [kiosk, kioskOwnerCap] = createKiosk(tx);\n\tshareKiosk(tx, kiosk);\n\treturn kioskOwnerCap;\n}\n\n/**\n * Converts Transfer Policy to a shared object.\n */\nexport function shareKiosk(tx: TransactionBlock, kiosk: TransactionArgument) {\n\ttx.moveCall({\n\t\ttarget: `0x2::transfer::public_share_object`,\n\t\ttypeArguments: [KIOSK_TYPE],\n\t\targuments: [kiosk],\n\t});\n}\n\n/**\n * Call the `kiosk::place<T>(Kiosk, KioskOwnerCap, Item)` function.\n * Place an item to the Kiosk.\n */\nexport function place(\n\ttx: TransactionBlock,\n\titemType: string,\n\tkiosk: ObjectArgument,\n\tkioskCap: ObjectArgument,\n\titem: ObjectArgument,\n): void {\n\ttx.moveCall({\n\t\ttarget: `${KIOSK_MODULE}::place`,\n\t\ttypeArguments: [itemType],\n\t\targuments: [tx.object(kiosk), tx.object(kioskCap), tx.object(item)],\n\t});\n}\n\n/**\n * Call the `kiosk::lock<T>(Kiosk, KioskOwnerCap, TransferPolicy, Item)`\n * function. Lock an item in the Kiosk.\n *\n * Unlike `place` this function requires a `TransferPolicy` to exist\n * and be passed in. This is done to make sure the item does not get\n * locked without an option to take it out.\n */\nexport function lock(\n\ttx: TransactionBlock,\n\titemType: string,\n\tkiosk: ObjectArgument,\n\tkioskCap: ObjectArgument,\n\tpolicy: ObjectArgument,\n\titem: ObjectArgument,\n): void {\n\ttx.moveCall({\n\t\ttarget: `${KIOSK_MODULE}::lock`,\n\t\ttypeArguments: [itemType],\n\t\targuments: [tx.object(kiosk), tx.object(kioskCap), tx.object(policy), tx.object(item)],\n\t});\n}\n\n/**\n * Call the `kiosk::take<T>(Kiosk, KioskOwnerCap, ID)` function.\n * Take an item from the Kiosk.\n */\nexport function take(\n\ttx: TransactionBlock,\n\titemType: string,\n\tkiosk: ObjectArgument,\n\tkioskCap: ObjectArgument,\n\titemId: string,\n): TransactionObjectArgument {\n\tconst [item] = tx.moveCall({\n\t\ttarget: `${KIOSK_MODULE}::take`,\n\t\ttypeArguments: [itemType],\n\t\targuments: [tx.object(kiosk), tx.object(kioskCap), tx.pure.id(itemId)],\n\t});\n\n\treturn item;\n}\n\n/**\n * Call the `kiosk::list<T>(Kiosk, KioskOwnerCap, ID, u64)` function.\n * List an item for sale.\n */\nexport function list(\n\ttx: TransactionBlock,\n\titemType: string,\n\tkiosk: ObjectArgument,\n\tkioskCap: ObjectArgument,\n\titemId: string,\n\tprice: string | bigint,\n): void {\n\ttx.moveCall({\n\t\ttarget: `${KIOSK_MODULE}::list`,\n\t\ttypeArguments: [itemType],\n\t\targuments: [tx.object(kiosk), tx.object(kioskCap), tx.pure.id(itemId), tx.pure.u64(price)],\n\t});\n}\n\n/**\n * Call the `kiosk::list<T>(Kiosk, KioskOwnerCap, ID, u64)` function.\n * List an item for sale.\n */\nexport function delist(\n\ttx: TransactionBlock,\n\titemType: string,\n\tkiosk: ObjectArgument,\n\tkioskCap: ObjectArgument,\n\titemId: string,\n): void {\n\ttx.moveCall({\n\t\ttarget: `${KIOSK_MODULE}::delist`,\n\t\ttypeArguments: [itemType],\n\t\targuments: [tx.object(kiosk), tx.object(kioskCap), tx.pure.id(itemId)],\n\t});\n}\n\n/**\n * Call the `kiosk::place_and_list<T>(Kiosk, KioskOwnerCap, Item, u64)` function.\n * Place an item to the Kiosk and list it for sale.\n */\nexport function placeAndList(\n\ttx: TransactionBlock,\n\titemType: string,\n\tkiosk: ObjectArgument,\n\tkioskCap: ObjectArgument,\n\titem: ObjectArgument,\n\tprice: string | bigint,\n): void {\n\ttx.moveCall({\n\t\ttarget: `${KIOSK_MODULE}::place_and_list`,\n\t\ttypeArguments: [itemType],\n\t\targuments: [tx.object(kiosk), tx.object(kioskCap), tx.object(item), tx.pure.u64(price)],\n\t});\n}\n\n/**\n * Call the `kiosk::purchase<T>(Kiosk, ID, Coin<SUI>)` function and receive an Item and\n * a TransferRequest which needs to be dealt with (via a matching TransferPolicy).\n */\nexport function purchase(\n\ttx: TransactionBlock,\n\titemType: string,\n\tkiosk: ObjectArgument,\n\titemId: string,\n\tpayment: ObjectArgument,\n): [TransactionObjectArgument, TransactionObjectArgument] {\n\tconst [item, transferRequest] = tx.moveCall({\n\t\ttarget: `${KIOSK_MODULE}::purchase`,\n\t\ttypeArguments: [itemType],\n\t\targuments: [tx.object(kiosk), tx.pure.id(itemId), tx.object(payment)],\n\t});\n\n\treturn [item, transferRequest];\n}\n\n/**\n * Call the `kiosk::withdraw(Kiosk, KioskOwnerCap, Option<u64>)` function and receive a Coin<SUI>.\n * If the amount is null, then the entire balance will be withdrawn.\n */\nexport function withdrawFromKiosk(\n\ttx: TransactionBlock,\n\tkiosk: ObjectArgument,\n\tkioskCap: ObjectArgument,\n\tamount?: string | bigint | number,\n): TransactionObjectArgument {\n\tconst amountArg = bcs.option(bcs.u64()).serialize(amount);\n\n\tconst [coin] = tx.moveCall({\n\t\ttarget: `${KIOSK_MODULE}::withdraw`,\n\t\targuments: [tx.object(kiosk), tx.object(kioskCap), amountArg],\n\t});\n\n\treturn coin;\n}\n\n/**\n * Call the `kiosk::borrow_value<T>(Kiosk, KioskOwnerCap, ID): T` function.\n * Immutably borrow an item from the Kiosk and return it in the end.\n *\n * Requires calling `returnValue` to return the item.\n */\nexport function borrowValue(\n\ttx: TransactionBlock,\n\titemType: string,\n\tkiosk: ObjectArgument,\n\tkioskCap: ObjectArgument,\n\titemId: string,\n): [TransactionArgument, TransactionArgument] {\n\tconst [item, promise] = tx.moveCall({\n\t\ttarget: `${KIOSK_MODULE}::borrow_val`,\n\t\ttypeArguments: [itemType],\n\t\targuments: [tx.object(kiosk), tx.object(kioskCap), tx.pure.id(itemId)],\n\t});\n\n\treturn [item, promise];\n}\n\n/**\n * Call the `kiosk::return_value<T>(Kiosk, Item, Borrow)` function.\n * Return an item to the Kiosk after it was `borrowValue`-d.\n */\nexport function returnValue(\n\ttx: TransactionBlock,\n\titemType: string,\n\tkiosk: ObjectArgument,\n\titem: TransactionArgument,\n\tpromise: TransactionArgument,\n): void {\n\ttx.moveCall({\n\t\ttarget: `${KIOSK_MODULE}::return_val`,\n\t\ttypeArguments: [itemType],\n\t\targuments: [tx.object(kiosk), item, promise],\n\t});\n}\n"],
+  "mappings": "AAGA,SAAS,WAAW;AAQpB,SAAS,cAAc,kBAAkB;AAKlC,SAAS,YACf,IACyD;AACzD,QAAM,CAAC,OAAO,aAAa,IAAI,GAAG,SAAS;AAAA,IAC1C,QAAQ,GAAG;AAAA,EACZ,CAAC;AAED,SAAO,CAAC,OAAO,aAAa;AAC7B;AAMO,SAAS,oBAAoB,IAAiD;AACpF,QAAM,CAAC,OAAO,aAAa,IAAI,YAAY,EAAE;AAC7C,aAAW,IAAI,KAAK;AACpB,SAAO;AACR;AAKO,SAAS,WAAW,IAAsB,OAA4B;AAC5E,KAAG,SAAS;AAAA,IACX,QAAQ;AAAA,IACR,eAAe,CAAC,UAAU;AAAA,IAC1B,WAAW,CAAC,KAAK;AAAA,EAClB,CAAC;AACF;AAMO,SAAS,MACf,IACA,UACA,OACA,UACA,MACO;AACP,KAAG,SAAS;AAAA,IACX,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,GAAG,OAAO,KAAK,GAAG,GAAG,OAAO,QAAQ,GAAG,GAAG,OAAO,IAAI,CAAC;AAAA,EACnE,CAAC;AACF;AAUO,SAAS,KACf,IACA,UACA,OACA,UACA,QACA,MACO;AACP,KAAG,SAAS;AAAA,IACX,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,GAAG,OAAO,KAAK,GAAG,GAAG,OAAO,QAAQ,GAAG,GAAG,OAAO,MAAM,GAAG,GAAG,OAAO,IAAI,CAAC;AAAA,EACtF,CAAC;AACF;AAMO,SAAS,KACf,IACA,UACA,OACA,UACA,QAC4B;AAC5B,QAAM,CAAC,IAAI,IAAI,GAAG,SAAS;AAAA,IAC1B,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,GAAG,OAAO,KAAK,GAAG,GAAG,OAAO,QAAQ,GAAG,GAAG,KAAK,GAAG,MAAM,CAAC;AAAA,EACtE,CAAC;AAED,SAAO;AACR;AAMO,SAAS,KACf,IACA,UACA,OACA,UACA,QACA,OACO;AACP,KAAG,SAAS;AAAA,IACX,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,GAAG,OAAO,KAAK,GAAG,GAAG,OAAO,QAAQ,GAAG,GAAG,KAAK,GAAG,MAAM,GAAG,GAAG,KAAK,IAAI,KAAK,CAAC;AAAA,EAC1F,CAAC;AACF;AAMO,SAAS,OACf,IACA,UACA,OACA,UACA,QACO;AACP,KAAG,SAAS;AAAA,IACX,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,GAAG,OAAO,KAAK,GAAG,GAAG,OAAO,QAAQ,GAAG,GAAG,KAAK,GAAG,MAAM,CAAC;AAAA,EACtE,CAAC;AACF;AAMO,SAAS,aACf,IACA,UACA,OACA,UACA,MACA,OACO;AACP,KAAG,SAAS;AAAA,IACX,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,GAAG,OAAO,KAAK,GAAG,GAAG,OAAO,QAAQ,GAAG,GAAG,OAAO,IAAI,GAAG,GAAG,KAAK,IAAI,KAAK,CAAC;AAAA,EACvF,CAAC;AACF;AAMO,SAAS,SACf,IACA,UACA,OACA,QACA,SACyD;AACzD,QAAM,CAAC,MAAM,eAAe,IAAI,GAAG,SAAS;AAAA,IAC3C,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,GAAG,OAAO,KAAK,GAAG,GAAG,KAAK,GAAG,MAAM,GAAG,GAAG,OAAO,OAAO,CAAC;AAAA,EACrE,CAAC;AAED,SAAO,CAAC,MAAM,eAAe;AAC9B;AAMO,SAAS,kBACf,IACA,OACA,UACA,QAC4B;AAC5B,QAAM,YAAY,IAAI,OAAO,IAAI,IAAI,CAAC,EAAE,UAAU,MAAM;AAExD,QAAM,CAAC,IAAI,IAAI,GAAG,SAAS;AAAA,IAC1B,QAAQ,GAAG;AAAA,IACX,WAAW,CAAC,GAAG,OAAO,KAAK,GAAG,GAAG,OAAO,QAAQ,GAAG,SAAS;AAAA,EAC7D,CAAC;AAED,SAAO;AACR;AAQO,SAAS,YACf,IACA,UACA,OACA,UACA,QAC6C;AAC7C,QAAM,CAAC,MAAM,OAAO,IAAI,GAAG,SAAS;AAAA,IACnC,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,GAAG,OAAO,KAAK,GAAG,GAAG,OAAO,QAAQ,GAAG,GAAG,KAAK,GAAG,MAAM,CAAC;AAAA,EACtE,CAAC;AAED,SAAO,CAAC,MAAM,OAAO;AACtB;AAMO,SAAS,YACf,IACA,UACA,OACA,MACA,SACO;AACP,KAAG,SAAS;AAAA,IACX,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,GAAG,OAAO,KAAK,GAAG,MAAM,OAAO;AAAA,EAC5C,CAAC;AACF;",
+  "names": []
+}

package/dist/esm/tx/personal-kiosk.d.ts

@@ -0,0 +1,7 @@
+import type { TransactionBlock, TransactionObjectArgument } from '@mysten/sui.js/transactions';
+import type { ObjectArgument } from '../types/index.js';
+export declare function convertToPersonalTx(tx: TransactionBlock, kiosk: ObjectArgument, kioskOwnerCap: ObjectArgument, packageId: string): TransactionObjectArgument;
+/**
+ * Transfers the personal kiosk Cap to the sender.
+ */
+export declare function transferPersonalCapTx(tx: TransactionBlock, personalKioskCap: TransactionObjectArgument, packageId: string): void;

package/dist/esm/tx/personal-kiosk.js

@@ -0,0 +1,18 @@
+function convertToPersonalTx(tx, kiosk, kioskOwnerCap, packageId) {
+  const personalKioskCap = tx.moveCall({
+    target: `${packageId}::personal_kiosk::new`,
+    arguments: [tx.object(kiosk), tx.object(kioskOwnerCap)]
+  });
+  return personalKioskCap;
+}
+function transferPersonalCapTx(tx, personalKioskCap, packageId) {
+  tx.moveCall({
+    target: `${packageId}::personal_kiosk::transfer_to_sender`,
+    arguments: [personalKioskCap]
+  });
+}
+export {
+  convertToPersonalTx,
+  transferPersonalCapTx
+};
+//# sourceMappingURL=personal-kiosk.js.map

package/dist/esm/tx/personal-kiosk.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/tx/personal-kiosk.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { TransactionBlock, TransactionObjectArgument } from '@mysten/sui.js/transactions';\n\nimport type { ObjectArgument } from '../types/index.js';\n\nexport function convertToPersonalTx(\n\ttx: TransactionBlock,\n\tkiosk: ObjectArgument,\n\tkioskOwnerCap: ObjectArgument,\n\tpackageId: string,\n): TransactionObjectArgument {\n\tconst personalKioskCap = tx.moveCall({\n\t\ttarget: `${packageId}::personal_kiosk::new`,\n\t\targuments: [tx.object(kiosk), tx.object(kioskOwnerCap)],\n\t});\n\n\treturn personalKioskCap;\n}\n\n/**\n * Transfers the personal kiosk Cap to the sender.\n */\nexport function transferPersonalCapTx(\n\ttx: TransactionBlock,\n\tpersonalKioskCap: TransactionObjectArgument,\n\tpackageId: string,\n) {\n\ttx.moveCall({\n\t\ttarget: `${packageId}::personal_kiosk::transfer_to_sender`,\n\t\targuments: [personalKioskCap],\n\t});\n}\n"],
+  "mappings": "AAOO,SAAS,oBACf,IACA,OACA,eACA,WAC4B;AAC5B,QAAM,mBAAmB,GAAG,SAAS;AAAA,IACpC,QAAQ,GAAG;AAAA,IACX,WAAW,CAAC,GAAG,OAAO,KAAK,GAAG,GAAG,OAAO,aAAa,CAAC;AAAA,EACvD,CAAC;AAED,SAAO;AACR;AAKO,SAAS,sBACf,IACA,kBACA,WACC;AACD,KAAG,SAAS;AAAA,IACX,QAAQ,GAAG;AAAA,IACX,WAAW,CAAC,gBAAgB;AAAA,EAC7B,CAAC;AACF;",
+  "names": []
+}

package/dist/esm/tx/rules/attach.d.ts

@@ -0,0 +1,7 @@
+import type { TransactionBlock } from '@mysten/sui.js/transactions';
+import type { ObjectArgument } from '../../types/index.js';
+export declare function attachKioskLockRuleTx(tx: TransactionBlock, type: string, policy: ObjectArgument, policyCap: ObjectArgument, packageId: string): void;
+export declare function attachRoyaltyRuleTx(tx: TransactionBlock, type: string, policy: ObjectArgument, policyCap: ObjectArgument, percentageBps: number | string, // this is in basis points.
+minAmount: number | string, packageId: string): void;
+export declare function attachPersonalKioskRuleTx(tx: TransactionBlock, type: string, policy: ObjectArgument, policyCap: ObjectArgument, packageId: string): void;
+export declare function attachFloorPriceRuleTx(tx: TransactionBlock, type: string, policy: ObjectArgument, policyCap: ObjectArgument, minPrice: string | bigint, packageId: string): void;

package/dist/esm/tx/rules/attach.js

@@ -0,0 +1,42 @@
+function attachKioskLockRuleTx(tx, type, policy, policyCap, packageId) {
+  tx.moveCall({
+    target: `${packageId}::kiosk_lock_rule::add`,
+    typeArguments: [type],
+    arguments: [tx.object(policy), tx.object(policyCap)]
+  });
+}
+function attachRoyaltyRuleTx(tx, type, policy, policyCap, percentageBps, minAmount, packageId) {
+  if (Number(percentageBps) < 0 || Number(percentageBps) > 1e4)
+    throw new Error("Invalid basis point percentage. Use a value between [0,10000].");
+  tx.moveCall({
+    target: `${packageId}::royalty_rule::add`,
+    typeArguments: [type],
+    arguments: [
+      tx.object(policy),
+      tx.object(policyCap),
+      tx.pure.u16(Number(percentageBps)),
+      tx.pure.u64(minAmount)
+    ]
+  });
+}
+function attachPersonalKioskRuleTx(tx, type, policy, policyCap, packageId) {
+  tx.moveCall({
+    target: `${packageId}::personal_kiosk_rule::add`,
+    typeArguments: [type],
+    arguments: [tx.object(policy), tx.object(policyCap)]
+  });
+}
+function attachFloorPriceRuleTx(tx, type, policy, policyCap, minPrice, packageId) {
+  tx.moveCall({
+    target: `${packageId}::floor_price_rule::add`,
+    typeArguments: [type],
+    arguments: [tx.object(policy), tx.object(policyCap), tx.pure.u64(minPrice)]
+  });
+}
+export {
+  attachFloorPriceRuleTx,
+  attachKioskLockRuleTx,
+  attachPersonalKioskRuleTx,
+  attachRoyaltyRuleTx
+};
+//# sourceMappingURL=attach.js.map

package/dist/esm/tx/rules/attach.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/tx/rules/attach.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { TransactionBlock } from '@mysten/sui.js/transactions';\n\nimport type { ObjectArgument } from '../../types/index.js';\n\nexport function attachKioskLockRuleTx(\n\ttx: TransactionBlock,\n\ttype: string,\n\tpolicy: ObjectArgument,\n\tpolicyCap: ObjectArgument,\n\tpackageId: string,\n) {\n\ttx.moveCall({\n\t\ttarget: `${packageId}::kiosk_lock_rule::add`,\n\t\ttypeArguments: [type],\n\t\targuments: [tx.object(policy), tx.object(policyCap)],\n\t});\n}\n\nexport function attachRoyaltyRuleTx(\n\ttx: TransactionBlock,\n\ttype: string,\n\tpolicy: ObjectArgument,\n\tpolicyCap: ObjectArgument,\n\tpercentageBps: number | string, // this is in basis points.\n\tminAmount: number | string,\n\tpackageId: string,\n) {\n\tif (Number(percentageBps) < 0 || Number(percentageBps) > 10_000)\n\t\tthrow new Error('Invalid basis point percentage. Use a value between [0,10000].');\n\n\ttx.moveCall({\n\t\ttarget: `${packageId}::royalty_rule::add`,\n\t\ttypeArguments: [type],\n\t\targuments: [\n\t\t\ttx.object(policy),\n\t\t\ttx.object(policyCap),\n\t\t\ttx.pure.u16(Number(percentageBps)),\n\t\t\ttx.pure.u64(minAmount),\n\t\t],\n\t});\n}\n\nexport function attachPersonalKioskRuleTx(\n\ttx: TransactionBlock,\n\ttype: string,\n\tpolicy: ObjectArgument,\n\tpolicyCap: ObjectArgument,\n\tpackageId: string,\n) {\n\ttx.moveCall({\n\t\ttarget: `${packageId}::personal_kiosk_rule::add`,\n\t\ttypeArguments: [type],\n\t\targuments: [tx.object(policy), tx.object(policyCap)],\n\t});\n}\n\nexport function attachFloorPriceRuleTx(\n\ttx: TransactionBlock,\n\ttype: string,\n\tpolicy: ObjectArgument,\n\tpolicyCap: ObjectArgument,\n\tminPrice: string | bigint,\n\tpackageId: string,\n) {\n\ttx.moveCall({\n\t\ttarget: `${packageId}::floor_price_rule::add`,\n\t\ttypeArguments: [type],\n\t\targuments: [tx.object(policy), tx.object(policyCap), tx.pure.u64(minPrice)],\n\t});\n}\n"],
+  "mappings": "AAOO,SAAS,sBACf,IACA,MACA,QACA,WACA,WACC;AACD,KAAG,SAAS;AAAA,IACX,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,IAAI;AAAA,IACpB,WAAW,CAAC,GAAG,OAAO,MAAM,GAAG,GAAG,OAAO,SAAS,CAAC;AAAA,EACpD,CAAC;AACF;AAEO,SAAS,oBACf,IACA,MACA,QACA,WACA,eACA,WACA,WACC;AACD,MAAI,OAAO,aAAa,IAAI,KAAK,OAAO,aAAa,IAAI;AACxD,UAAM,IAAI,MAAM,gEAAgE;AAEjF,KAAG,SAAS;AAAA,IACX,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,IAAI;AAAA,IACpB,WAAW;AAAA,MACV,GAAG,OAAO,MAAM;AAAA,MAChB,GAAG,OAAO,SAAS;AAAA,MACnB,GAAG,KAAK,IAAI,OAAO,aAAa,CAAC;AAAA,MACjC,GAAG,KAAK,IAAI,SAAS;AAAA,IACtB;AAAA,EACD,CAAC;AACF;AAEO,SAAS,0BACf,IACA,MACA,QACA,WACA,WACC;AACD,KAAG,SAAS;AAAA,IACX,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,IAAI;AAAA,IACpB,WAAW,CAAC,GAAG,OAAO,MAAM,GAAG,GAAG,OAAO,SAAS,CAAC;AAAA,EACpD,CAAC;AACF;AAEO,SAAS,uBACf,IACA,MACA,QACA,WACA,UACA,WACC;AACD,KAAG,SAAS;AAAA,IACX,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,IAAI;AAAA,IACpB,WAAW,CAAC,GAAG,OAAO,MAAM,GAAG,GAAG,OAAO,SAAS,GAAG,GAAG,KAAK,IAAI,QAAQ,CAAC;AAAA,EAC3E,CAAC;AACF;",
+  "names": []
+}

package/dist/esm/tx/rules/resolve.d.ts

@@ -0,0 +1,15 @@
+import type { RuleResolvingParams } from '../../types/index.js';
+/**
+ * A helper to resolve the royalty rule.
+ */
+export declare function resolveRoyaltyRule(params: RuleResolvingParams): void;
+export declare function resolveKioskLockRule(params: RuleResolvingParams): void;
+/**
+ * A helper to resolve the personalKioskRule.
+ * @param params
+ */
+export declare function resolvePersonalKioskRule(params: RuleResolvingParams): void;
+/**
+ * Resolves the floor price rule.
+ */
+export declare function resolveFloorPriceRule(params: RuleResolvingParams): void;

package/dist/esm/tx/rules/resolve.js

@@ -0,0 +1,61 @@
+import { lock } from "../kiosk.js";
+function resolveRoyaltyRule(params) {
+  const { transactionBlock: txb, itemType, price, packageId, transferRequest, policyId } = params;
+  const policyObj = txb.object(policyId);
+  const [amount] = txb.moveCall({
+    target: `${packageId}::royalty_rule::fee_amount`,
+    typeArguments: [itemType],
+    arguments: [policyObj, txb.pure.u64(price || "0")]
+  });
+  const feeCoin = txb.splitCoins(txb.gas, [amount]);
+  txb.moveCall({
+    target: `${packageId}::royalty_rule::pay`,
+    typeArguments: [itemType],
+    arguments: [policyObj, transferRequest, feeCoin]
+  });
+}
+function resolveKioskLockRule(params) {
+  const {
+    transactionBlock: txb,
+    packageId,
+    itemType,
+    kiosk,
+    kioskCap,
+    policyId,
+    purchasedItem,
+    transferRequest
+  } = params;
+  if (!kiosk || !kioskCap)
+    throw new Error("Missing Owned Kiosk or Owned Kiosk Cap");
+  lock(txb, itemType, kiosk, kioskCap, policyId, purchasedItem);
+  txb.moveCall({
+    target: `${packageId}::kiosk_lock_rule::prove`,
+    typeArguments: [itemType],
+    arguments: [transferRequest, txb.object(kiosk)]
+  });
+}
+function resolvePersonalKioskRule(params) {
+  const { transactionBlock: txb, packageId, itemType, kiosk, transferRequest } = params;
+  if (!kiosk)
+    throw new Error("Missing owned Kiosk.");
+  txb.moveCall({
+    target: `${packageId}::personal_kiosk_rule::prove`,
+    typeArguments: [itemType],
+    arguments: [txb.object(kiosk), transferRequest]
+  });
+}
+function resolveFloorPriceRule(params) {
+  const { transactionBlock: txb, packageId, itemType, policyId, transferRequest } = params;
+  txb.moveCall({
+    target: `${packageId}::floor_price_rule::prove`,
+    typeArguments: [itemType],
+    arguments: [txb.object(policyId), transferRequest]
+  });
+}
+export {
+  resolveFloorPriceRule,
+  resolveKioskLockRule,
+  resolvePersonalKioskRule,
+  resolveRoyaltyRule
+};
+//# sourceMappingURL=resolve.js.map

package/dist/esm/tx/rules/resolve.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/tx/rules/resolve.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { RuleResolvingParams } from '../../types/index.js';\nimport { lock } from '../kiosk.js';\n\n/**\n * A helper to resolve the royalty rule.\n */\nexport function resolveRoyaltyRule(params: RuleResolvingParams) {\n\tconst { transactionBlock: txb, itemType, price, packageId, transferRequest, policyId } = params;\n\n\tconst policyObj = txb.object(policyId);\n\n\t// calculates the amount\n\tconst [amount] = txb.moveCall({\n\t\ttarget: `${packageId}::royalty_rule::fee_amount`,\n\t\ttypeArguments: [itemType],\n\t\targuments: [policyObj, txb.pure.u64(price || '0')],\n\t});\n\n\t// splits the coin.\n\tconst feeCoin = txb.splitCoins(txb.gas, [amount]);\n\n\t// pays the policy\n\ttxb.moveCall({\n\t\ttarget: `${packageId}::royalty_rule::pay`,\n\t\ttypeArguments: [itemType],\n\t\targuments: [policyObj, transferRequest, feeCoin],\n\t});\n}\n\nexport function resolveKioskLockRule(params: RuleResolvingParams) {\n\tconst {\n\t\ttransactionBlock: txb,\n\t\tpackageId,\n\t\titemType,\n\t\tkiosk,\n\t\tkioskCap,\n\t\tpolicyId,\n\t\tpurchasedItem,\n\t\ttransferRequest,\n\t} = params;\n\n\tif (!kiosk || !kioskCap) throw new Error('Missing Owned Kiosk or Owned Kiosk Cap');\n\n\tlock(txb, itemType, kiosk, kioskCap, policyId, purchasedItem);\n\n\t// proves that the item is locked in the kiosk to the TP.\n\ttxb.moveCall({\n\t\ttarget: `${packageId}::kiosk_lock_rule::prove`,\n\t\ttypeArguments: [itemType],\n\t\targuments: [transferRequest, txb.object(kiosk)],\n\t});\n}\n\n/**\n * A helper to resolve the personalKioskRule.\n * @param params\n */\nexport function resolvePersonalKioskRule(params: RuleResolvingParams) {\n\tconst { transactionBlock: txb, packageId, itemType, kiosk, transferRequest } = params;\n\n\tif (!kiosk) throw new Error('Missing owned Kiosk.');\n\n\t// proves that the destination kiosk is personal.\n\ttxb.moveCall({\n\t\ttarget: `${packageId}::personal_kiosk_rule::prove`,\n\t\ttypeArguments: [itemType],\n\t\targuments: [txb.object(kiosk), transferRequest],\n\t});\n}\n\n/**\n * Resolves the floor price rule.\n */\nexport function resolveFloorPriceRule(params: RuleResolvingParams) {\n\tconst { transactionBlock: txb, packageId, itemType, policyId, transferRequest } = params;\n\n\t// proves that the destination kiosk is personal\n\ttxb.moveCall({\n\t\ttarget: `${packageId}::floor_price_rule::prove`,\n\t\ttypeArguments: [itemType],\n\t\targuments: [txb.object(policyId), transferRequest],\n\t});\n}\n"],
+  "mappings": "AAIA,SAAS,YAAY;AAKd,SAAS,mBAAmB,QAA6B;AAC/D,QAAM,EAAE,kBAAkB,KAAK,UAAU,OAAO,WAAW,iBAAiB,SAAS,IAAI;AAEzF,QAAM,YAAY,IAAI,OAAO,QAAQ;AAGrC,QAAM,CAAC,MAAM,IAAI,IAAI,SAAS;AAAA,IAC7B,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,WAAW,IAAI,KAAK,IAAI,SAAS,GAAG,CAAC;AAAA,EAClD,CAAC;AAGD,QAAM,UAAU,IAAI,WAAW,IAAI,KAAK,CAAC,MAAM,CAAC;AAGhD,MAAI,SAAS;AAAA,IACZ,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,WAAW,iBAAiB,OAAO;AAAA,EAChD,CAAC;AACF;AAEO,SAAS,qBAAqB,QAA6B;AACjE,QAAM;AAAA,IACL,kBAAkB;AAAA,IAClB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACD,IAAI;AAEJ,MAAI,CAAC,SAAS,CAAC;AAAU,UAAM,IAAI,MAAM,wCAAwC;AAEjF,OAAK,KAAK,UAAU,OAAO,UAAU,UAAU,aAAa;AAG5D,MAAI,SAAS;AAAA,IACZ,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,iBAAiB,IAAI,OAAO,KAAK,CAAC;AAAA,EAC/C,CAAC;AACF;AAMO,SAAS,yBAAyB,QAA6B;AACrE,QAAM,EAAE,kBAAkB,KAAK,WAAW,UAAU,OAAO,gBAAgB,IAAI;AAE/E,MAAI,CAAC;AAAO,UAAM,IAAI,MAAM,sBAAsB;AAGlD,MAAI,SAAS;AAAA,IACZ,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,IAAI,OAAO,KAAK,GAAG,eAAe;AAAA,EAC/C,CAAC;AACF;AAKO,SAAS,sBAAsB,QAA6B;AAClE,QAAM,EAAE,kBAAkB,KAAK,WAAW,UAAU,UAAU,gBAAgB,IAAI;AAGlF,MAAI,SAAS;AAAA,IACZ,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,IAAI,OAAO,QAAQ,GAAG,eAAe;AAAA,EAClD,CAAC;AACF;",
+  "names": []
+}

package/dist/esm/tx/transfer-policy.d.ts

@@ -0,0 +1,29 @@
+import type { TransactionArgument, TransactionBlock, TransactionObjectArgument } from '@mysten/sui.js/transactions';
+import type { ObjectArgument } from '../types/index.js';
+/**
+ * Call the `transfer_policy::new` function to create a new transfer policy.
+ * Returns `transferPolicyCap`
+ */
+export declare function createTransferPolicy(tx: TransactionBlock, itemType: string, publisher: ObjectArgument): TransactionObjectArgument;
+/**
+ * Creates a transfer Policy and returns both the Policy and the Cap.
+ * Used if we want to use the policy before making it a shared object.
+ */
+export declare function createTransferPolicyWithoutSharing(tx: TransactionBlock, itemType: string, publisher: ObjectArgument): [TransactionObjectArgument, TransactionObjectArgument];
+/**
+ * Converts Transfer Policy to a shared object.
+ */
+export declare function shareTransferPolicy(tx: TransactionBlock, itemType: string, transferPolicy: TransactionObjectArgument): void;
+/**
+ * Call the `transfer_policy::withdraw` function to withdraw profits from a transfer policy.
+ */
+export declare function withdrawFromPolicy(tx: TransactionBlock, itemType: string, policy: ObjectArgument, policyCap: ObjectArgument, amount?: string | bigint | null): TransactionObjectArgument;
+/**
+ * Call the `transfer_policy::confirm_request` function to unblock the
+ * transaction.
+ */
+export declare function confirmRequest(tx: TransactionBlock, itemType: string, policy: ObjectArgument, request: TransactionArgument): void;
+/**
+ * Calls the `transfer_policy::remove_rule` function to remove a Rule from the transfer policy's ruleset.
+ */
+export declare function removeTransferPolicyRule(tx: TransactionBlock, itemType: string, ruleType: string, configType: string, policy: ObjectArgument, policyCap: ObjectArgument): void;

package/dist/esm/tx/transfer-policy.js

@@ -0,0 +1,58 @@
+import { bcs } from "@mysten/sui.js/bcs";
+import { TRANSFER_POLICY_MODULE, TRANSFER_POLICY_TYPE } from "../types/index.js";
+function createTransferPolicy(tx, itemType, publisher) {
+  const [transferPolicy, transferPolicyCap] = createTransferPolicyWithoutSharing(
+    tx,
+    itemType,
+    publisher
+  );
+  shareTransferPolicy(tx, itemType, transferPolicy);
+  return transferPolicyCap;
+}
+function createTransferPolicyWithoutSharing(tx, itemType, publisher) {
+  const [transferPolicy, transferPolicyCap] = tx.moveCall({
+    target: `${TRANSFER_POLICY_MODULE}::new`,
+    typeArguments: [itemType],
+    arguments: [tx.object(publisher)]
+  });
+  return [transferPolicy, transferPolicyCap];
+}
+function shareTransferPolicy(tx, itemType, transferPolicy) {
+  tx.moveCall({
+    target: `0x2::transfer::public_share_object`,
+    typeArguments: [`${TRANSFER_POLICY_TYPE}<${itemType}>`],
+    arguments: [transferPolicy]
+  });
+}
+function withdrawFromPolicy(tx, itemType, policy, policyCap, amount) {
+  const amountArg = bcs.option(bcs.u64()).serialize(amount);
+  const [profits] = tx.moveCall({
+    target: `${TRANSFER_POLICY_MODULE}::withdraw`,
+    typeArguments: [itemType],
+    arguments: [tx.object(policy), tx.object(policyCap), amountArg]
+  });
+  return profits;
+}
+function confirmRequest(tx, itemType, policy, request) {
+  tx.moveCall({
+    target: `${TRANSFER_POLICY_MODULE}::confirm_request`,
+    typeArguments: [itemType],
+    arguments: [tx.object(policy), request]
+  });
+}
+function removeTransferPolicyRule(tx, itemType, ruleType, configType, policy, policyCap) {
+  tx.moveCall({
+    target: `${TRANSFER_POLICY_MODULE}::remove_rule`,
+    typeArguments: [itemType, ruleType, configType],
+    arguments: [tx.object(policy), tx.object(policyCap)]
+  });
+}
+export {
+  confirmRequest,
+  createTransferPolicy,
+  createTransferPolicyWithoutSharing,
+  removeTransferPolicyRule,
+  shareTransferPolicy,
+  withdrawFromPolicy
+};
+//# sourceMappingURL=transfer-policy.js.map

package/dist/esm/tx/transfer-policy.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/tx/transfer-policy.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport { bcs } from '@mysten/sui.js/bcs';\nimport type {\n\tTransactionArgument,\n\tTransactionBlock,\n\tTransactionObjectArgument,\n} from '@mysten/sui.js/transactions';\n\nimport type { ObjectArgument } from '../types/index.js';\nimport { TRANSFER_POLICY_MODULE, TRANSFER_POLICY_TYPE } from '../types/index.js';\n\n/**\n * Call the `transfer_policy::new` function to create a new transfer policy.\n * Returns `transferPolicyCap`\n */\nexport function createTransferPolicy(\n\ttx: TransactionBlock,\n\titemType: string,\n\tpublisher: ObjectArgument,\n): TransactionObjectArgument {\n\tconst [transferPolicy, transferPolicyCap] = createTransferPolicyWithoutSharing(\n\t\ttx,\n\t\titemType,\n\t\tpublisher,\n\t);\n\n\tshareTransferPolicy(tx, itemType, transferPolicy);\n\n\treturn transferPolicyCap;\n}\n\n/**\n * Creates a transfer Policy and returns both the Policy and the Cap.\n * Used if we want to use the policy before making it a shared object.\n */\nexport function createTransferPolicyWithoutSharing(\n\ttx: TransactionBlock,\n\titemType: string,\n\tpublisher: ObjectArgument,\n): [TransactionObjectArgument, TransactionObjectArgument] {\n\tconst [transferPolicy, transferPolicyCap] = tx.moveCall({\n\t\ttarget: `${TRANSFER_POLICY_MODULE}::new`,\n\t\ttypeArguments: [itemType],\n\t\targuments: [tx.object(publisher)],\n\t});\n\n\treturn [transferPolicy, transferPolicyCap];\n}\n/**\n * Converts Transfer Policy to a shared object.\n */\nexport function shareTransferPolicy(\n\ttx: TransactionBlock,\n\titemType: string,\n\ttransferPolicy: TransactionObjectArgument,\n) {\n\ttx.moveCall({\n\t\ttarget: `0x2::transfer::public_share_object`,\n\t\ttypeArguments: [`${TRANSFER_POLICY_TYPE}<${itemType}>`],\n\t\targuments: [transferPolicy],\n\t});\n}\n\n/**\n * Call the `transfer_policy::withdraw` function to withdraw profits from a transfer policy.\n */\nexport function withdrawFromPolicy(\n\ttx: TransactionBlock,\n\titemType: string,\n\tpolicy: ObjectArgument,\n\tpolicyCap: ObjectArgument,\n\tamount?: string | bigint | null,\n): TransactionObjectArgument {\n\tconst amountArg = bcs.option(bcs.u64()).serialize(amount);\n\n\tconst [profits] = tx.moveCall({\n\t\ttarget: `${TRANSFER_POLICY_MODULE}::withdraw`,\n\t\ttypeArguments: [itemType],\n\t\targuments: [tx.object(policy), tx.object(policyCap), amountArg],\n\t});\n\n\treturn profits;\n}\n\n/**\n * Call the `transfer_policy::confirm_request` function to unblock the\n * transaction.\n */\nexport function confirmRequest(\n\ttx: TransactionBlock,\n\titemType: string,\n\tpolicy: ObjectArgument,\n\trequest: TransactionArgument,\n): void {\n\ttx.moveCall({\n\t\ttarget: `${TRANSFER_POLICY_MODULE}::confirm_request`,\n\t\ttypeArguments: [itemType],\n\t\targuments: [tx.object(policy), request],\n\t});\n}\n\n/**\n * Calls the `transfer_policy::remove_rule` function to remove a Rule from the transfer policy's ruleset.\n */\nexport function removeTransferPolicyRule(\n\ttx: TransactionBlock,\n\titemType: string,\n\truleType: string,\n\tconfigType: string,\n\tpolicy: ObjectArgument,\n\tpolicyCap: ObjectArgument,\n): void {\n\ttx.moveCall({\n\t\ttarget: `${TRANSFER_POLICY_MODULE}::remove_rule`,\n\t\ttypeArguments: [itemType, ruleType, configType],\n\t\targuments: [tx.object(policy), tx.object(policyCap)],\n\t});\n}\n"],
+  "mappings": "AAGA,SAAS,WAAW;AAQpB,SAAS,wBAAwB,4BAA4B;AAMtD,SAAS,qBACf,IACA,UACA,WAC4B;AAC5B,QAAM,CAAC,gBAAgB,iBAAiB,IAAI;AAAA,IAC3C;AAAA,IACA;AAAA,IACA;AAAA,EACD;AAEA,sBAAoB,IAAI,UAAU,cAAc;AAEhD,SAAO;AACR;AAMO,SAAS,mCACf,IACA,UACA,WACyD;AACzD,QAAM,CAAC,gBAAgB,iBAAiB,IAAI,GAAG,SAAS;AAAA,IACvD,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,GAAG,OAAO,SAAS,CAAC;AAAA,EACjC,CAAC;AAED,SAAO,CAAC,gBAAgB,iBAAiB;AAC1C;AAIO,SAAS,oBACf,IACA,UACA,gBACC;AACD,KAAG,SAAS;AAAA,IACX,QAAQ;AAAA,IACR,eAAe,CAAC,GAAG,wBAAwB,WAAW;AAAA,IACtD,WAAW,CAAC,cAAc;AAAA,EAC3B,CAAC;AACF;AAKO,SAAS,mBACf,IACA,UACA,QACA,WACA,QAC4B;AAC5B,QAAM,YAAY,IAAI,OAAO,IAAI,IAAI,CAAC,EAAE,UAAU,MAAM;AAExD,QAAM,CAAC,OAAO,IAAI,GAAG,SAAS;AAAA,IAC7B,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,GAAG,OAAO,MAAM,GAAG,GAAG,OAAO,SAAS,GAAG,SAAS;AAAA,EAC/D,CAAC;AAED,SAAO;AACR;AAMO,SAAS,eACf,IACA,UACA,QACA,SACO;AACP,KAAG,SAAS;AAAA,IACX,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,GAAG,OAAO,MAAM,GAAG,OAAO;AAAA,EACvC,CAAC;AACF;AAKO,SAAS,yBACf,IACA,UACA,UACA,YACA,QACA,WACO;AACP,KAAG,SAAS;AAAA,IACX,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,UAAU,UAAU,UAAU;AAAA,IAC9C,WAAW,CAAC,GAAG,OAAO,MAAM,GAAG,GAAG,OAAO,SAAS,CAAC;AAAA,EACpD,CAAC;AACF;",
+  "names": []
+}