@mysten/kiosk 0.0.0-experimental-20231212183109 → 0.0.0-experimental-20240104225555

package/dist/esm/client/kiosk-transaction.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/client/kiosk-transaction.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport {\n\tTransactionObjectArgument,\n\ttype TransactionArgument,\n\ttype TransactionBlock,\n} from '@mysten/sui.js/transactions';\n\nimport * as kioskTx from '../tx/kiosk';\nimport { convertToPersonalTx, transferPersonalCapTx } from '../tx/personal-kiosk';\nimport { confirmRequest } from '../tx/transfer-policy';\nimport {\n\tItemId,\n\tItemReference,\n\tItemValue,\n\tKioskOwnerCap,\n\tObjectArgument,\n\tPrice,\n\tPurchaseOptions,\n} from '../types';\nimport { getNormalizedRuleType } from '../utils';\nimport { type KioskClient } from './kiosk-client';\n\nexport type KioskTransactionParams = {\n\t/** The TransactionBlock for this run */\n\ttransactionBlock: TransactionBlock;\n\t/**\n\t * You can create a new KioskClient by calling `new KioskClient()`\n\t */\n\tkioskClient: KioskClient;\n\t/**\n\t * You can optionally pass in the `cap` as returned\n\t * from `kioskClient.getOwnedKiosks` when initializing the client\n\t * Otherwise, you can set it by calling `kioskTransaction.setCap()`\n\t */\n\tcap?: KioskOwnerCap;\n};\n\n/**\n * A helper for building transactions that involve kiosk.\n */\nexport class KioskTransaction {\n\ttransactionBlock: TransactionBlock;\n\tkioskClient: KioskClient;\n\tkiosk?: TransactionObjectArgument;\n\tkioskCap?: TransactionObjectArgument;\n\t// If we're pending `share` of a new kiosk, `finalize()` will share it.\n\t#pendingShare?: boolean;\n\t// If we're pending transferring of the cap, `finalize()` will either error or transfer the cap if it's a new personal.\n\t#pendingTransfer?: boolean;\n\t// The promise that the personalCap will be returned on `finalize()`.\n\t#promise?: TransactionArgument | undefined;\n\t// The personal kiosk argument.\n\t#personalCap?: TransactionObjectArgument;\n\t// A flag that checks whether kiosk TX is finalized.\n\t#finalized: boolean = false;\n\n\tconstructor({ transactionBlock, kioskClient, cap }: KioskTransactionParams) {\n\t\tthis.transactionBlock = transactionBlock;\n\t\tthis.kioskClient = kioskClient;\n\n\t\tif (cap) this.setCap(cap);\n\t}\n\n\t/**\n\t * Creates a kiosk and saves `kiosk` and `kioskOwnerCap` in state.\n\t * Helpful if we want to chain some actions before sharing + transferring the cap to the specified address.\n\t * @param borrow If true, the `kioskOwnerCap` is borrowed from the `PersonalKioskCap` to be used in next transactions.\n\t */\n\tcreate() {\n\t\tthis.#validateFinalizedStatus();\n\t\tthis.#setPendingStatuses({\n\t\t\tshare: true,\n\t\t\ttransfer: true,\n\t\t});\n\t\tconst [kiosk, cap] = kioskTx.createKiosk(this.transactionBlock);\n\t\tthis.kiosk = kiosk;\n\t\tthis.kioskCap = cap;\n\t\treturn this;\n\t}\n\n\t/**\n\t * Creates a personal kiosk & shares it.\n\t * The `PersonalKioskCap` is transferred to the signer.\n\t * @param borrow If true, the `kioskOwnerCap` is borrowed from the `PersonalKioskCap` to be used in next transactions.\n\t */\n\tcreatePersonal(borrow?: boolean) {\n\t\tthis.#pendingShare = true;\n\t\treturn this.create().convertToPersonal(borrow);\n\t}\n\n\t/**\n\t * Converts a kiosk to a Personal (Soulbound) Kiosk.\n\t * Requires initialization by either calling `ktxb.create()` or `ktxb.setCap()`.\n\t */\n\tconvertToPersonal(borrow?: boolean) {\n\t\tthis.#validateKioskIsSet();\n\n\t\tconst cap = convertToPersonalTx(\n\t\t\tthis.transactionBlock,\n\t\t\tthis.kiosk!,\n\t\t\tthis.kioskCap!,\n\t\t\tthis.kioskClient.getRulePackageId('personalKioskRulePackageId'),\n\t\t);\n\n\t\t// if we enable `borrow`, we borrow the kioskCap from the cap.\n\t\tif (borrow) this.#borrowFromPersonalCap(cap);\n\t\telse this.#personalCap = cap;\n\n\t\tthis.#setPendingStatuses({ transfer: true });\n\t\treturn this;\n\t}\n\n\t/**\n\t * Single function way to create a kiosk, share it and transfer the cap to the specified address.\n\t */\n\tcreateAndShare(address: string) {\n\t\tthis.#validateFinalizedStatus();\n\t\tconst cap = kioskTx.createKioskAndShare(this.transactionBlock);\n\t\tthis.transactionBlock.transferObjects([cap], this.transactionBlock.pure.address(address));\n\t}\n\n\t/**\n\t * Shares the kiosk.\n\t */\n\tshare() {\n\t\tthis.#validateKioskIsSet();\n\t\tthis.#setPendingStatuses({ share: false });\n\t\tkioskTx.shareKiosk(this.transactionBlock, this.kiosk!);\n\t}\n\n\t/**\n\t * Should be called only after `create` is called.\n\t * It shares the kiosk & transfers the cap to the specified address.\n\t */\n\tshareAndTransferCap(address: string) {\n\t\tif (this.#personalCap)\n\t\t\tthrow new Error('You can only call `shareAndTransferCap` on a non-personal kiosk.');\n\t\tthis.#setPendingStatuses({ transfer: false });\n\t\tthis.share();\n\t\tthis.transactionBlock.transferObjects(\n\t\t\t[this.kioskCap!],\n\t\t\tthis.transactionBlock.pure.address(address),\n\t\t);\n\t}\n\n\t/**\n\t * A function to borrow an item from a kiosk & execute any function with it.\n\t * Example: You could borrow a Fren out of a kiosk, attach an accessory (or mix), and return it.\n\t */\n\tborrowTx({ itemType, itemId }: ItemId, callback: (item: TransactionArgument) => void) {\n\t\tthis.#validateKioskIsSet();\n\t\tconst [itemObj, promise] = kioskTx.borrowValue(\n\t\t\tthis.transactionBlock,\n\t\t\titemType,\n\t\t\tthis.kiosk!,\n\t\t\tthis.kioskCap!,\n\t\t\titemId,\n\t\t);\n\n\t\tcallback(itemObj);\n\n\t\tthis.return({ itemType, item: itemObj, promise });\n\t}\n\n\t/**\n\t * Borrows an item from the kiosk.\n\t * This will fail if the item is listed for sale.\n\t *\n\t * Requires calling `return`.\n\t */\n\tborrow({ itemType, itemId }: ItemId): [TransactionArgument, TransactionArgument] {\n\t\tthis.#validateKioskIsSet();\n\t\tconst [itemObj, promise] = kioskTx.borrowValue(\n\t\t\tthis.transactionBlock,\n\t\t\titemType,\n\t\t\tthis.kiosk!,\n\t\t\tthis.kioskCap!,\n\t\t\titemId,\n\t\t);\n\n\t\treturn [itemObj, promise];\n\t}\n\n\t/**\n\t * Returns the item back to the kiosk.\n\t * Accepts the parameters returned from the `borrow` function.\n\t */\n\treturn({ itemType, item, promise }: ItemValue & { promise: TransactionArgument }) {\n\t\tthis.#validateKioskIsSet();\n\t\tkioskTx.returnValue(this.transactionBlock, itemType, this.kiosk!, item, promise);\n\t\treturn this;\n\t}\n\n\t/**\n\t * A function to withdraw from kiosk\n\t * @param address Where to trasnfer the coin.\n\t * @param amount The amount we aim to withdraw.\n\t */\n\twithdraw(address: string, amount?: string | bigint | number) {\n\t\tthis.#validateKioskIsSet();\n\t\tconst coin = kioskTx.withdrawFromKiosk(\n\t\t\tthis.transactionBlock,\n\t\t\tthis.kiosk!,\n\t\t\tthis.kioskCap!,\n\t\t\tamount,\n\t\t);\n\t\tthis.transactionBlock.transferObjects([coin], this.transactionBlock.pure.address(address));\n\t\treturn this;\n\t}\n\n\t/**\n\t * A function to place an item in the kiosk.\n\t * @param itemType The type `T` of the item\n\t * @param item The ID or Transaction Argument of the item\n\t */\n\tplace({ itemType, item }: ItemReference) {\n\t\tthis.#validateKioskIsSet();\n\t\tkioskTx.place(this.transactionBlock, itemType, this.kiosk!, this.kioskCap!, item);\n\t\treturn this;\n\t}\n\n\t/**\n\t * A function to place an item in the kiosk and list it for sale in one transaction.\n\t * @param itemType The type `T` of the item\n\t * @param item The ID or Transaction Argument of the item\n\t * @param price The price in MIST\n\t */\n\tplaceAndList({ itemType, item, price }: ItemReference & Price) {\n\t\tthis.#validateKioskIsSet();\n\t\tkioskTx.placeAndList(this.transactionBlock, itemType, this.kiosk!, this.kioskCap!, item, price);\n\t\treturn this;\n\t}\n\n\t/**\n\t * A function to list an item in the kiosk.\n\t * @param itemType The type `T` of the item\n\t * @param itemId The ID of the item\n\t * @param price The price in MIST\n\t */\n\tlist({ itemType, itemId, price }: ItemId & { price: string | bigint }) {\n\t\tthis.#validateKioskIsSet();\n\t\tkioskTx.list(this.transactionBlock, itemType, this.kiosk!, this.kioskCap!, itemId, price);\n\t\treturn this;\n\t}\n\n\t/**\n\t * A function to delist an item from the kiosk.\n\t * @param itemType The type `T` of the item\n\t * @param itemId The ID of the item\n\t */\n\tdelist({ itemType, itemId }: ItemId) {\n\t\tthis.#validateKioskIsSet();\n\t\tkioskTx.delist(this.transactionBlock, itemType, this.kiosk!, this.kioskCap!, itemId);\n\t\treturn this;\n\t}\n\n\t/**\n\t * A function to take an item from the kiosk. The transaction won't succeed if the item is listed or locked.\n\n\t * @param itemType The type `T` of the item\n\t * @param itemId The ID of the item\n\t */\n\ttake({ itemType, itemId }: ItemId): TransactionObjectArgument {\n\t\tthis.#validateKioskIsSet();\n\t\treturn kioskTx.take(this.transactionBlock, itemType, this.kiosk!, this.kioskCap!, itemId);\n\t}\n\n\t/**\n\t * Transfer a non-locked/non-listed item to an address.\n\t *\n\t * @param itemType The type `T` of the item\n\t * @param itemId The ID of the item\n\t * @param address The destination address\n\t */\n\ttransfer({ itemType, itemId, address }: ItemId & { address: string }) {\n\t\tthis.#validateKioskIsSet();\n\t\tconst item = this.take({ itemType, itemId });\n\t\tthis.transactionBlock.transferObjects([item], this.transactionBlock.pure.address(address));\n\t\treturn this;\n\t}\n\n\t/**\n\t * A function to take lock an item in the kiosk.\n\n\t * @param itemType The type `T` of the item\n\t * @param itemId The ID of the item\n\t * @param policy The Policy ID or Transaction Argument for item T\n\t */\n\tlock({ itemType, itemId, policy }: ItemId & { policy: ObjectArgument }) {\n\t\tthis.#validateKioskIsSet();\n\t\tkioskTx.lock(this.transactionBlock, itemType, this.kiosk!, this.kioskCap!, policy, itemId);\n\t\treturn this;\n\t}\n\n\t/**\n\t * Purchase an item from a seller's kiosk.\n\t * Returns [item, transferRequest]\n\t * Can be called like: `const [item, transferRequest] = kioskTx.purchase({...})`\n\t * @param itemType The type `T` of the item\n\t * @param itemId The ID of the item\n\t * @param price The price in MIST\n\t * @param sellerKiosk The kiosk which is selling the item. Can be an id or an object argument.\n\t */\n\tpurchase({\n\t\titemType,\n\t\titemId,\n\t\tprice,\n\t\tsellerKiosk,\n\t}: ItemId & Price & { sellerKiosk: ObjectArgument }): [\n\t\tTransactionObjectArgument,\n\t\tTransactionObjectArgument,\n\t] {\n\t\t// Split the coin for the amount of the listing.\n\t\tconst coin = this.transactionBlock.splitCoins(this.transactionBlock.gas, [\n\t\t\tthis.transactionBlock.pure.u64(price),\n\t\t]);\n\t\treturn kioskTx.purchase(this.transactionBlock, itemType, sellerKiosk, itemId, coin);\n\t}\n\n\t/**\n\t * A function to purchase and resolve a transfer policy.\n\t * If the transfer policy has the `lock` rule, the item is locked in the kiosk.\n\t * Otherwise, the item is placed in the kiosk.\n\t * @param itemType The type of the item\n\t * @param itemId The id of the item\n\t * @param price The price of the specified item\n\t * @param sellerKiosk The kiosk which is selling the item. Can be an id or an object argument.\n\t * @param extraArgs Used to pass arguments for custom rule resolvers.\n\t */\n\tasync purchaseAndResolve({\n\t\titemType,\n\t\titemId,\n\t\tprice,\n\t\tsellerKiosk,\n\t\textraArgs,\n\t}: ItemId & Price & { sellerKiosk: ObjectArgument } & PurchaseOptions) {\n\t\tthis.#validateKioskIsSet();\n\t\t// Get a list of the transfer policies.\n\t\tconst policies = await this.kioskClient.getTransferPolicies({ type: itemType });\n\n\t\tif (policies.length === 0) {\n\t\t\tthrow new Error(\n\t\t\t\t`The type ${itemType} doesn't have a Transfer Policy so it can't be traded through kiosk.`,\n\t\t\t);\n\t\t}\n\n\t\tconst policy = policies[0]; // we now pick the first one. We need to add an option to define which one.\n\n\t\t// initialize the purchase `kiosk::purchase`\n\t\tconst [purchasedItem, transferRequest] = this.purchase({\n\t\t\titemType,\n\t\t\titemId,\n\t\t\tprice,\n\t\t\tsellerKiosk,\n\t\t});\n\n\t\tlet canTransferOutsideKiosk = true;\n\n\t\tfor (const rule of policy.rules) {\n\t\t\tconst ruleDefinition = this.kioskClient.rules.find(\n\t\t\t\t(x) => getNormalizedRuleType(x.rule) === getNormalizedRuleType(rule),\n\t\t\t);\n\t\t\tif (!ruleDefinition) throw new Error(`No resolver for the following rule: ${rule}.`);\n\n\t\t\tif (ruleDefinition.hasLockingRule) canTransferOutsideKiosk = false;\n\n\t\t\truleDefinition.resolveRuleFunction({\n\t\t\t\tpackageId: ruleDefinition.packageId,\n\t\t\t\ttransactionBlock: this.transactionBlock,\n\t\t\t\titemType,\n\t\t\t\titemId,\n\t\t\t\tprice: price.toString(),\n\t\t\t\tsellerKiosk,\n\t\t\t\tpolicyId: policy.id,\n\t\t\t\ttransferRequest,\n\t\t\t\tpurchasedItem,\n\t\t\t\tkiosk: this.kiosk!,\n\t\t\t\tkioskCap: this.kioskCap!,\n\t\t\t\textraArgs: extraArgs || {},\n\t\t\t});\n\t\t}\n\n\t\tconfirmRequest(this.transactionBlock, itemType, policy.id, transferRequest);\n\n\t\tif (canTransferOutsideKiosk) this.place({ itemType, item: purchasedItem });\n\n\t\treturn this;\n\t}\n\n\t/**\n\t * A function to setup the client using an existing `ownerCap`,\n\t * as return from the `kioskClient.getOwnedKiosks` function.\n\t * @param cap `KioskOwnerCap` object as returned from `getOwnedKiosks` SDK call.\n\t */\n\tsetCap(cap: KioskOwnerCap) {\n\t\tthis.#validateFinalizedStatus();\n\t\tthis.kiosk = this.transactionBlock.object(cap.kioskId);\n\t\tif (!cap.isPersonal) {\n\t\t\tthis.kioskCap = this.transactionBlock.object(cap.objectId);\n\t\t\treturn;\n\t\t}\n\n\t\treturn this.#borrowFromPersonalCap(cap.objectId);\n\t}\n\n\t/**\n\t *\tA function that ends up the kiosk building txb & returns the `kioskOwnerCap` back to the\n\t *  `PersonalKioskCap`, in case we are operating on a personal kiosk.\n\t * \tIt will also share the `kiosk` if it's not shared, and finalize the transfer of the personal cap if it's pending.\n\t */\n\tfinalize() {\n\t\tthis.#validateKioskIsSet();\n\t\t// If we're pending the sharing of the new kiosk, share it.\n\t\tif (this.#pendingShare) this.share();\n\n\t\t// If we're operating on a non-personal kiosk, we don't need to do anything else.\n\t\tif (!this.#personalCap) {\n\t\t\t// If we're pending transfer though, we inform user to call `shareAndTransferCap()`.\n\t\t\tif (this.#pendingTransfer)\n\t\t\t\tthrow new Error(\n\t\t\t\t\t'You need to transfer the `kioskOwnerCap` by calling `shareAndTransferCap()` before wrap',\n\t\t\t\t);\n\t\t\treturn;\n\t\t}\n\n\t\tconst packageId = this.kioskClient.getRulePackageId('personalKioskRulePackageId');\n\n\t\t// if we have a promise, return the `ownerCap` back to the personal cap.\n\t\tif (this.#promise) {\n\t\t\tthis.transactionBlock.moveCall({\n\t\t\t\ttarget: `${packageId}::personal_kiosk::return_val`,\n\t\t\t\targuments: [\n\t\t\t\t\tthis.#personalCap,\n\t\t\t\t\tthis.transactionBlock.object(this.kioskCap!),\n\t\t\t\t\tthis.#promise!,\n\t\t\t\t],\n\t\t\t});\n\t\t}\n\n\t\t// If we are pending transferring the personalCap, we do it here.\n\t\tif (this.#pendingTransfer)\n\t\t\ttransferPersonalCapTx(this.transactionBlock, this.#personalCap, packageId);\n\n\t\t// Mark the transaction block as finalized, so no other functions can be called.\n\t\tthis.#finalized = true;\n\t}\n\n\t// Some setters in case we want custom behavior.\n\tsetKioskCap(cap: TransactionObjectArgument) {\n\t\tthis.#validateFinalizedStatus();\n\t\tthis.kioskCap = cap;\n\t\treturn this;\n\t}\n\n\tsetKiosk(kiosk: TransactionObjectArgument) {\n\t\tthis.#validateFinalizedStatus();\n\t\tthis.kiosk = kiosk;\n\t\treturn this;\n\t}\n\n\t// Some getters\n\t/*\n\t * Returns the active transaction's kiosk, or undefined if `setCap` or `create()` hasn't been called yet.\n\t */\n\tgetKiosk() {\n\t\tthis.#validateFinalizedStatus();\n\t\tif (!this.kiosk) throw new Error('Kiosk is not set.');\n\t\treturn this.kiosk;\n\t}\n\n\t/*\n\t * Returns the active transaction's kioskOwnerCap, or undefined if `setCap` or `create()` hasn't been called yet.\n\t */\n\tgetKioskCap() {\n\t\tthis.#validateFinalizedStatus();\n\t\tif (!this.kioskCap) throw new Error('Kiosk cap is not set');\n\t\treturn this.kioskCap;\n\t}\n\n\t/**\n\t * A function to borrow from `personalCap`.\n\t */\n\t#borrowFromPersonalCap(personalCap: ObjectArgument) {\n\t\tconst [kioskCap, promise] = this.transactionBlock.moveCall({\n\t\t\ttarget: `${this.kioskClient.getRulePackageId(\n\t\t\t\t'personalKioskRulePackageId',\n\t\t\t)}::personal_kiosk::borrow_val`,\n\t\t\targuments: [this.transactionBlock.object(personalCap)],\n\t\t});\n\n\t\tthis.kioskCap = kioskCap;\n\t\tthis.#personalCap = this.transactionBlock.object(personalCap);\n\t\tthis.#promise = promise;\n\n\t\treturn this;\n\t}\n\n\t#setPendingStatuses({ share, transfer }: { share?: boolean; transfer?: boolean }) {\n\t\tif (transfer !== undefined) this.#pendingTransfer = transfer;\n\t\tif (share !== undefined) this.#pendingShare = share;\n\t}\n\n\t#validateKioskIsSet() {\n\t\tthis.#validateFinalizedStatus();\n\n\t\tif (!this.kiosk || !this.kioskCap)\n\t\t\tthrow new Error(\n\t\t\t\t'You need to initialize the client by either supplying an existing owner cap or by creating a new by calling `.create()`',\n\t\t\t);\n\t}\n\n\t// Validates that `finalize`\n\t#validateFinalizedStatus() {\n\t\tif (this.#finalized)\n\t\t\tthrow new Error(\"You can't add more transactions to a finalized kiosk transaction block.\");\n\t}\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;AAAA;AASA,YAAY,aAAa;AACzB,SAAS,qBAAqB,6BAA6B;AAC3D,SAAS,sBAAsB;AAU/B,SAAS,6BAA6B;AAqB/B,MAAM,iBAAiB;AAAA,EAgB7B,YAAY,EAAE,kBAAkB,aAAa,IAAI,GAA2B;AA0a5E;AAAA;AAAA;AAAA;AAeA;AAKA;AAUA;AAAA;AAldA;AAAA;AAEA;AAAA;AAEA;AAAA;AAEA;AAAA;AAEA;AAAA,mCAAsB;AAGrB,SAAK,mBAAmB;AACxB,SAAK,cAAc;AAEnB,QAAI;AAAK,WAAK,OAAO,GAAG;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAS;AACR,0BAAK,sDAAL;AACA,0BAAK,4CAAL,WAAyB;AAAA,MACxB,OAAO;AAAA,MACP,UAAU;AAAA,IACX;AACA,UAAM,CAAC,OAAO,GAAG,IAAI,QAAQ,YAAY,KAAK,gBAAgB;AAC9D,SAAK,QAAQ;AACb,SAAK,WAAW;AAChB,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,eAAe,QAAkB;AAChC,uBAAK,eAAgB;AACrB,WAAO,KAAK,OAAO,EAAE,kBAAkB,MAAM;AAAA,EAC9C;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,kBAAkB,QAAkB;AACnC,0BAAK,4CAAL;AAEA,UAAM,MAAM;AAAA,MACX,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK,YAAY,iBAAiB,4BAA4B;AAAA,IAC/D;AAGA,QAAI;AAAQ,4BAAK,kDAAL,WAA4B;AAAA;AACnC,yBAAK,cAAe;AAEzB,0BAAK,4CAAL,WAAyB,EAAE,UAAU,KAAK;AAC1C,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA,EAKA,eAAe,SAAiB;AAC/B,0BAAK,sDAAL;AACA,UAAM,MAAM,QAAQ,oBAAoB,KAAK,gBAAgB;AAC7D,SAAK,iBAAiB,gBAAgB,CAAC,GAAG,GAAG,KAAK,iBAAiB,KAAK,QAAQ,OAAO,CAAC;AAAA,EACzF;AAAA;AAAA;AAAA;AAAA,EAKA,QAAQ;AACP,0BAAK,4CAAL;AACA,0BAAK,4CAAL,WAAyB,EAAE,OAAO,MAAM;AACxC,YAAQ,WAAW,KAAK,kBAAkB,KAAK,KAAM;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,oBAAoB,SAAiB;AACpC,QAAI,mBAAK;AACR,YAAM,IAAI,MAAM,kEAAkE;AACnF,0BAAK,4CAAL,WAAyB,EAAE,UAAU,MAAM;AAC3C,SAAK,MAAM;AACX,SAAK,iBAAiB;AAAA,MACrB,CAAC,KAAK,QAAS;AAAA,MACf,KAAK,iBAAiB,KAAK,QAAQ,OAAO;AAAA,IAC3C;AAAA,EACD;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAS,EAAE,UAAU,OAAO,GAAW,UAA+C;AACrF,0BAAK,4CAAL;AACA,UAAM,CAAC,SAAS,OAAO,IAAI,QAAQ;AAAA,MAClC,KAAK;AAAA,MACL;AAAA,MACA,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,IACD;AAEA,aAAS,OAAO;AAEhB,SAAK,OAAO,EAAE,UAAU,MAAM,SAAS,QAAQ,CAAC;AAAA,EACjD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAO,EAAE,UAAU,OAAO,GAAuD;AAChF,0BAAK,4CAAL;AACA,UAAM,CAAC,SAAS,OAAO,IAAI,QAAQ;AAAA,MAClC,KAAK;AAAA,MACL;AAAA,MACA,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,IACD;AAEA,WAAO,CAAC,SAAS,OAAO;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,OAAO,EAAE,UAAU,MAAM,QAAQ,GAAiD;AACjF,0BAAK,4CAAL;AACA,YAAQ,YAAY,KAAK,kBAAkB,UAAU,KAAK,OAAQ,MAAM,OAAO;AAC/E,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAS,SAAiB,QAAmC;AAC5D,0BAAK,4CAAL;AACA,UAAM,OAAO,QAAQ;AAAA,MACpB,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,IACD;AACA,SAAK,iBAAiB,gBAAgB,CAAC,IAAI,GAAG,KAAK,iBAAiB,KAAK,QAAQ,OAAO,CAAC;AACzF,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,EAAE,UAAU,KAAK,GAAkB;AACxC,0BAAK,4CAAL;AACA,YAAQ,MAAM,KAAK,kBAAkB,UAAU,KAAK,OAAQ,KAAK,UAAW,IAAI;AAChF,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,aAAa,EAAE,UAAU,MAAM,MAAM,GAA0B;AAC9D,0BAAK,4CAAL;AACA,YAAQ,aAAa,KAAK,kBAAkB,UAAU,KAAK,OAAQ,KAAK,UAAW,MAAM,KAAK;AAC9F,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,KAAK,EAAE,UAAU,QAAQ,MAAM,GAAwC;AACtE,0BAAK,4CAAL;AACA,YAAQ,KAAK,KAAK,kBAAkB,UAAU,KAAK,OAAQ,KAAK,UAAW,QAAQ,KAAK;AACxF,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,EAAE,UAAU,OAAO,GAAW;AACpC,0BAAK,4CAAL;AACA,YAAQ,OAAO,KAAK,kBAAkB,UAAU,KAAK,OAAQ,KAAK,UAAW,MAAM;AACnF,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,KAAK,EAAE,UAAU,OAAO,GAAsC;AAC7D,0BAAK,4CAAL;AACA,WAAO,QAAQ,KAAK,KAAK,kBAAkB,UAAU,KAAK,OAAQ,KAAK,UAAW,MAAM;AAAA,EACzF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,SAAS,EAAE,UAAU,QAAQ,QAAQ,GAAiC;AACrE,0BAAK,4CAAL;AACA,UAAM,OAAO,KAAK,KAAK,EAAE,UAAU,OAAO,CAAC;AAC3C,SAAK,iBAAiB,gBAAgB,CAAC,IAAI,GAAG,KAAK,iBAAiB,KAAK,QAAQ,OAAO,CAAC;AACzF,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,KAAK,EAAE,UAAU,QAAQ,OAAO,GAAwC;AACvE,0BAAK,4CAAL;AACA,YAAQ,KAAK,KAAK,kBAAkB,UAAU,KAAK,OAAQ,KAAK,UAAW,QAAQ,MAAM;AACzF,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,SAAS;AAAA,IACR;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACD,GAGE;AAED,UAAM,OAAO,KAAK,iBAAiB,WAAW,KAAK,iBAAiB,KAAK;AAAA,MACxE,KAAK,iBAAiB,KAAK,IAAI,KAAK;AAAA,IACrC,CAAC;AACD,WAAO,QAAQ,SAAS,KAAK,kBAAkB,UAAU,aAAa,QAAQ,IAAI;AAAA,EACnF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,MAAM,mBAAmB;AAAA,IACxB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACD,GAAuE;AACtE,0BAAK,4CAAL;AAEA,UAAM,WAAW,MAAM,KAAK,YAAY,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAE9E,QAAI,SAAS,WAAW,GAAG;AAC1B,YAAM,IAAI;AAAA,QACT,YAAY;AAAA,MACb;AAAA,IACD;AAEA,UAAM,SAAS,SAAS,CAAC;AAGzB,UAAM,CAAC,eAAe,eAAe,IAAI,KAAK,SAAS;AAAA,MACtD;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACD,CAAC;AAED,QAAI,0BAA0B;AAE9B,eAAW,QAAQ,OAAO,OAAO;AAChC,YAAM,iBAAiB,KAAK,YAAY,MAAM;AAAA,QAC7C,CAAC,MAAM,sBAAsB,EAAE,IAAI,MAAM,sBAAsB,IAAI;AAAA,MACpE;AACA,UAAI,CAAC;AAAgB,cAAM,IAAI,MAAM,uCAAuC,OAAO;AAEnF,UAAI,eAAe;AAAgB,kCAA0B;AAE7D,qBAAe,oBAAoB;AAAA,QAClC,WAAW,eAAe;AAAA,QAC1B,kBAAkB,KAAK;AAAA,QACvB;AAAA,QACA;AAAA,QACA,OAAO,MAAM,SAAS;AAAA,QACtB;AAAA,QACA,UAAU,OAAO;AAAA,QACjB;AAAA,QACA;AAAA,QACA,OAAO,KAAK;AAAA,QACZ,UAAU,KAAK;AAAA,QACf,WAAW,aAAa,CAAC;AAAA,MAC1B,CAAC;AAAA,IACF;AAEA,mBAAe,KAAK,kBAAkB,UAAU,OAAO,IAAI,eAAe;AAE1E,QAAI;AAAyB,WAAK,MAAM,EAAE,UAAU,MAAM,cAAc,CAAC;AAEzE,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,KAAoB;AAC1B,0BAAK,sDAAL;AACA,SAAK,QAAQ,KAAK,iBAAiB,OAAO,IAAI,OAAO;AACrD,QAAI,CAAC,IAAI,YAAY;AACpB,WAAK,WAAW,KAAK,iBAAiB,OAAO,IAAI,QAAQ;AACzD;AAAA,IACD;AAEA,WAAO,sBAAK,kDAAL,WAA4B,IAAI;AAAA,EACxC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,WAAW;AACV,0BAAK,4CAAL;AAEA,QAAI,mBAAK;AAAe,WAAK,MAAM;AAGnC,QAAI,CAAC,mBAAK,eAAc;AAEvB,UAAI,mBAAK;AACR,cAAM,IAAI;AAAA,UACT;AAAA,QACD;AACD;AAAA,IACD;AAEA,UAAM,YAAY,KAAK,YAAY,iBAAiB,4BAA4B;AAGhF,QAAI,mBAAK,WAAU;AAClB,WAAK,iBAAiB,SAAS;AAAA,QAC9B,QAAQ,GAAG;AAAA,QACX,WAAW;AAAA,UACV,mBAAK;AAAA,UACL,KAAK,iBAAiB,OAAO,KAAK,QAAS;AAAA,UAC3C,mBAAK;AAAA,QACN;AAAA,MACD,CAAC;AAAA,IACF;AAGA,QAAI,mBAAK;AACR,4BAAsB,KAAK,kBAAkB,mBAAK,eAAc,SAAS;AAG1E,uBAAK,YAAa;AAAA,EACnB;AAAA;AAAA,EAGA,YAAY,KAAgC;AAC3C,0BAAK,sDAAL;AACA,SAAK,WAAW;AAChB,WAAO;AAAA,EACR;AAAA,EAEA,SAAS,OAAkC;AAC1C,0BAAK,sDAAL;AACA,SAAK,QAAQ;AACb,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,WAAW;AACV,0BAAK,sDAAL;AACA,QAAI,CAAC,KAAK;AAAO,YAAM,IAAI,MAAM,mBAAmB;AACpD,WAAO,KAAK;AAAA,EACb;AAAA;AAAA;AAAA;AAAA,EAKA,cAAc;AACb,0BAAK,sDAAL;AACA,QAAI,CAAC,KAAK;AAAU,YAAM,IAAI,MAAM,sBAAsB;AAC1D,WAAO,KAAK;AAAA,EACb;AAuCD;AAtdC;AAEA;AAEA;AAEA;AAEA;AA4aA;AAAA,2BAAsB,SAAC,aAA6B;AACnD,QAAM,CAAC,UAAU,OAAO,IAAI,KAAK,iBAAiB,SAAS;AAAA,IAC1D,QAAQ,GAAG,KAAK,YAAY;AAAA,MAC3B;AAAA,IACD;AAAA,IACA,WAAW,CAAC,KAAK,iBAAiB,OAAO,WAAW,CAAC;AAAA,EACtD,CAAC;AAED,OAAK,WAAW;AAChB,qBAAK,cAAe,KAAK,iBAAiB,OAAO,WAAW;AAC5D,qBAAK,UAAW;AAEhB,SAAO;AACR;AAEA;AAAA,wBAAmB,SAAC,EAAE,OAAO,SAAS,GAA4C;AACjF,MAAI,aAAa;AAAW,uBAAK,kBAAmB;AACpD,MAAI,UAAU;AAAW,uBAAK,eAAgB;AAC/C;AAEA;AAAA,wBAAmB,WAAG;AACrB,wBAAK,sDAAL;AAEA,MAAI,CAAC,KAAK,SAAS,CAAC,KAAK;AACxB,UAAM,IAAI;AAAA,MACT;AAAA,IACD;AACF;AAGA;AAAA,6BAAwB,WAAG;AAC1B,MAAI,mBAAK;AACR,UAAM,IAAI,MAAM,yEAAyE;AAC3F;",
+  "names": []
+}

package/dist/esm/client/tp-transaction.d.ts

@@ -0,0 +1,112 @@
+import { type TransactionBlock } from '@mysten/sui.js/transactions';
+import { TransferPolicyCap, type ObjectArgument } from '../types';
+import { KioskClient } from './kiosk-client';
+export type TransferPolicyBaseParams = {
+    type: string;
+    publisher: ObjectArgument;
+    skipCheck?: boolean;
+};
+export type TransferPolicyTransactionParams = {
+    kioskClient: KioskClient;
+    transactionBlock: TransactionBlock;
+    cap?: TransferPolicyCap;
+};
+export declare class TransferPolicyTransaction {
+    #private;
+    transactionBlock: TransactionBlock;
+    kioskClient: KioskClient;
+    policy?: ObjectArgument;
+    policyCap?: ObjectArgument;
+    type?: string;
+    constructor({ kioskClient, transactionBlock, cap }: TransferPolicyTransactionParams);
+    /**
+     * A function to create a new transfer policy.
+     * Checks if there's already an existing transfer policy to prevent
+     * double transfer polciy mistakes.
+     * There's an optional `skipCheck` flag that will just create the policy
+     * without checking
+     *
+     * @param type The Type (`T`) for which we're creating the transfer policy.
+     * @param publisher The Publisher Object Id.
+     * @param address Address to save the `TransferPolicyCap` object to.
+     * @param skipCheck (Optional) skip checking if a transfer policy already exists
+     */
+    createAndShare({ type, publisher, address, skipCheck, }: TransferPolicyBaseParams & {
+        address: string;
+    }): Promise<void>;
+    /**
+     * A convenient function to create a Transfer Policy and attach some rules
+     * before sharing it (so you can prepare it in a single PTB)
+     * @param type The Type (`T`) for which we're creating the transfer policy.
+     * @param publisher The Publisher Object Id.
+     * @param address Address to save the `TransferPolicyCap` object to.
+     * @param skipCheck (Optional) skip checking if a transfer policy already exists
+     */
+    create({ type, publisher, skipCheck, }: TransferPolicyBaseParams): Promise<TransferPolicyTransaction>;
+    /**
+     * This can be called after calling the `create` function to share the `TransferPolicy`,
+     * and transfer the `TransferPolicyCap` to the specified address
+     *
+     * @param address The address to transfer the `TransferPolicyCap`
+     */
+    shareAndTransferCap(address: string): void;
+    /**
+     * Setup the TransferPolicy by passing a `cap` returned from `kioskClient.getOwnedTransferPolicies` or
+     * `kioskClient.getOwnedTransferPoliciesByType`.
+     * @param policyCapId The `TransferPolicyCap`
+     */
+    setCap({ policyId, policyCapId, type }: TransferPolicyCap): this;
+    /**
+     * Withdraw from the transfer policy's profits.
+     * @param address Address to transfer the profits to.
+     * @param amount (Optional) amount parameter. Will withdraw all profits if the amount is not specified.
+     */
+    withdraw(address: string, amount?: string | bigint): this;
+    /**
+     *  Adds the Kiosk Royalty rule to the Transfer Policy.
+     *  You can pass the percentage, as well as a minimum amount.
+     *  The royalty that will be paid is the MAX(percentage, minAmount).
+     * 	You can pass 0 in either value if you want only percentage royalty, or a fixed amount fee.
+     * 	(but you should define at least one of them for the rule to make sense).
+     *
+     * 	@param percentageBps The royalty percentage in basis points. Use `percentageToBasisPoints` helper to convert from percentage [0,100].
+     * 	@param minAmount The minimum royalty amount per request in MIST.
+     */
+    addRoyaltyRule(percentageBps: number | string, // this is in basis points.
+    minAmount: number | string): this;
+    /**
+     * Adds the Kiosk Lock Rule to the Transfer Policy.
+     * This Rule forces buyer to lock the item in the kiosk, preserving strong royalties.
+     */
+    addLockRule(): this;
+    /**
+     * Attaches the Personal Kiosk Rule, making a purchase valid only for `SoulBound` kiosks.
+     */
+    addPersonalKioskRule(): this;
+    /**
+     * A function to add the floor price rule to a transfer policy.
+     * @param minPrice The minimum price in MIST.
+     */
+    addFloorPriceRule(minPrice: string | bigint): this;
+    /**
+     * Generic helper to remove a rule, not from the SDK's base ruleset.
+     * @param ruleType The Rule Type
+     * @param configType The Config Type
+     */
+    removeRule({ ruleType, configType }: {
+        ruleType: string;
+        configType: string;
+    }): void;
+    /**
+     * Removes the lock rule.
+     */
+    removeLockRule(): this;
+    /**
+     * Removes the Royalty rule
+     */
+    removeRoyaltyRule(): this;
+    removePersonalKioskRule(): this;
+    removeFloorPriceRule(): this;
+    getPolicy(): ObjectArgument;
+    getPolicyCap(): ObjectArgument;
+}

package/dist/esm/client/tp-transaction.js

@@ -0,0 +1,308 @@
+var __accessCheck = (obj, member, msg) => {
+  if (!member.has(obj))
+    throw TypeError("Cannot " + msg);
+};
+var __privateAdd = (obj, member, value) => {
+  if (member.has(obj))
+    throw TypeError("Cannot add the same private member more than once");
+  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+};
+var __privateMethod = (obj, member, method) => {
+  __accessCheck(obj, member, "access private method");
+  return method;
+};
+var _validateInputs, validateInputs_fn, _setup, setup_fn;
+import {
+  attachFloorPriceRuleTx,
+  attachKioskLockRuleTx,
+  attachPersonalKioskRuleTx,
+  attachRoyaltyRuleTx
+} from "../tx/rules/attach";
+import {
+  createTransferPolicy,
+  createTransferPolicyWithoutSharing,
+  removeTransferPolicyRule,
+  shareTransferPolicy,
+  withdrawFromPolicy
+} from "../tx/transfer-policy";
+class TransferPolicyTransaction {
+  constructor({ kioskClient, transactionBlock, cap }) {
+    // Internal function that that the policy's Id + Cap + type have been set.
+    __privateAdd(this, _validateInputs);
+    /**
+     * Setup the state of the TransferPolicyTransaction.
+     */
+    __privateAdd(this, _setup);
+    this.kioskClient = kioskClient;
+    this.transactionBlock = transactionBlock;
+    if (cap)
+      this.setCap(cap);
+  }
+  /**
+   * A function to create a new transfer policy.
+   * Checks if there's already an existing transfer policy to prevent
+   * double transfer polciy mistakes.
+   * There's an optional `skipCheck` flag that will just create the policy
+   * without checking
+   *
+   * @param type The Type (`T`) for which we're creating the transfer policy.
+   * @param publisher The Publisher Object Id.
+   * @param address Address to save the `TransferPolicyCap` object to.
+   * @param skipCheck (Optional) skip checking if a transfer policy already exists
+   */
+  async createAndShare({
+    type,
+    publisher,
+    address,
+    skipCheck
+  }) {
+    if (!skipCheck) {
+      const policies = await this.kioskClient.getTransferPolicies({ type });
+      if (policies.length > 0)
+        throw new Error("There's already transfer policy for this Type.");
+    }
+    const cap = createTransferPolicy(this.transactionBlock, type, publisher);
+    this.transactionBlock.transferObjects([cap], this.transactionBlock.pure.address(address));
+  }
+  /**
+   * A convenient function to create a Transfer Policy and attach some rules
+   * before sharing it (so you can prepare it in a single PTB)
+   * @param type The Type (`T`) for which we're creating the transfer policy.
+   * @param publisher The Publisher Object Id.
+   * @param address Address to save the `TransferPolicyCap` object to.
+   * @param skipCheck (Optional) skip checking if a transfer policy already exists
+   */
+  async create({
+    type,
+    publisher,
+    skipCheck
+  }) {
+    if (!skipCheck) {
+      const policies = await this.kioskClient.getTransferPolicies({ type });
+      if (policies.length > 0)
+        throw new Error("There's already transfer policy for this Type.");
+    }
+    const [policy, policyCap] = createTransferPolicyWithoutSharing(
+      this.transactionBlock,
+      type,
+      publisher
+    );
+    __privateMethod(this, _setup, setup_fn).call(this, policy, policyCap, type);
+    return this;
+  }
+  /**
+   * This can be called after calling the `create` function to share the `TransferPolicy`,
+   * and transfer the `TransferPolicyCap` to the specified address
+   *
+   * @param address The address to transfer the `TransferPolicyCap`
+   */
+  shareAndTransferCap(address) {
+    if (!this.type || !this.policyCap || !this.policy)
+      throw new Error("This function can only be called after `transferPolicyManager.create`");
+    shareTransferPolicy(this.transactionBlock, this.type, this.policy);
+    this.transactionBlock.transferObjects(
+      [this.policyCap],
+      this.transactionBlock.pure.address(address)
+    );
+  }
+  /**
+   * Setup the TransferPolicy by passing a `cap` returned from `kioskClient.getOwnedTransferPolicies` or
+   * `kioskClient.getOwnedTransferPoliciesByType`.
+   * @param policyCapId The `TransferPolicyCap`
+   */
+  setCap({ policyId, policyCapId, type }) {
+    return __privateMethod(this, _setup, setup_fn).call(this, policyId, policyCapId, type);
+  }
+  /**
+   * Withdraw from the transfer policy's profits.
+   * @param address Address to transfer the profits to.
+   * @param amount (Optional) amount parameter. Will withdraw all profits if the amount is not specified.
+   */
+  withdraw(address, amount) {
+    __privateMethod(this, _validateInputs, validateInputs_fn).call(this);
+    const coin = withdrawFromPolicy(
+      this.transactionBlock,
+      this.type,
+      this.policy,
+      this.policyCap,
+      amount
+    );
+    this.transactionBlock.transferObjects([coin], this.transactionBlock.pure.address(address));
+    return this;
+  }
+  /**
+   *  Adds the Kiosk Royalty rule to the Transfer Policy.
+   *  You can pass the percentage, as well as a minimum amount.
+   *  The royalty that will be paid is the MAX(percentage, minAmount).
+   * 	You can pass 0 in either value if you want only percentage royalty, or a fixed amount fee.
+   * 	(but you should define at least one of them for the rule to make sense).
+   *
+   * 	@param percentageBps The royalty percentage in basis points. Use `percentageToBasisPoints` helper to convert from percentage [0,100].
+   * 	@param minAmount The minimum royalty amount per request in MIST.
+   */
+  addRoyaltyRule(percentageBps, minAmount) {
+    __privateMethod(this, _validateInputs, validateInputs_fn).call(this);
+    attachRoyaltyRuleTx(
+      this.transactionBlock,
+      this.type,
+      this.policy,
+      this.policyCap,
+      percentageBps,
+      minAmount,
+      this.kioskClient.getRulePackageId("royaltyRulePackageId")
+    );
+    return this;
+  }
+  /**
+   * Adds the Kiosk Lock Rule to the Transfer Policy.
+   * This Rule forces buyer to lock the item in the kiosk, preserving strong royalties.
+   */
+  addLockRule() {
+    __privateMethod(this, _validateInputs, validateInputs_fn).call(this);
+    attachKioskLockRuleTx(
+      this.transactionBlock,
+      this.type,
+      this.policy,
+      this.policyCap,
+      this.kioskClient.getRulePackageId("kioskLockRulePackageId")
+    );
+    return this;
+  }
+  /**
+   * Attaches the Personal Kiosk Rule, making a purchase valid only for `SoulBound` kiosks.
+   */
+  addPersonalKioskRule() {
+    __privateMethod(this, _validateInputs, validateInputs_fn).call(this);
+    attachPersonalKioskRuleTx(
+      this.transactionBlock,
+      this.type,
+      this.policy,
+      this.policyCap,
+      this.kioskClient.getRulePackageId("personalKioskRulePackageId")
+    );
+    return this;
+  }
+  /**
+   * A function to add the floor price rule to a transfer policy.
+   * @param minPrice The minimum price in MIST.
+   */
+  addFloorPriceRule(minPrice) {
+    __privateMethod(this, _validateInputs, validateInputs_fn).call(this);
+    attachFloorPriceRuleTx(
+      this.transactionBlock,
+      this.type,
+      this.policy,
+      this.policyCap,
+      minPrice,
+      this.kioskClient.getRulePackageId("floorPriceRulePackageId")
+    );
+    return this;
+  }
+  /**
+   * Generic helper to remove a rule, not from the SDK's base ruleset.
+   * @param ruleType The Rule Type
+   * @param configType The Config Type
+   */
+  removeRule({ ruleType, configType }) {
+    __privateMethod(this, _validateInputs, validateInputs_fn).call(this);
+    removeTransferPolicyRule(
+      this.transactionBlock,
+      this.type,
+      ruleType,
+      configType,
+      this.policy,
+      this.policyCap
+    );
+  }
+  /**
+   * Removes the lock rule.
+   */
+  removeLockRule() {
+    __privateMethod(this, _validateInputs, validateInputs_fn).call(this);
+    const packageId = this.kioskClient.getRulePackageId("kioskLockRulePackageId");
+    removeTransferPolicyRule(
+      this.transactionBlock,
+      this.type,
+      `${packageId}::kiosk_lock_rule::Rule`,
+      `${packageId}::kiosk_lock_rule::Config`,
+      this.policy,
+      this.policyCap
+    );
+    return this;
+  }
+  /**
+   * Removes the Royalty rule
+   */
+  removeRoyaltyRule() {
+    __privateMethod(this, _validateInputs, validateInputs_fn).call(this);
+    const packageId = this.kioskClient.getRulePackageId("royaltyRulePackageId");
+    removeTransferPolicyRule(
+      this.transactionBlock,
+      this.type,
+      `${packageId}::royalty_rule::Rule`,
+      `${packageId}::royalty_rule::Config`,
+      this.policy,
+      this.policyCap
+    );
+    return this;
+  }
+  removePersonalKioskRule() {
+    __privateMethod(this, _validateInputs, validateInputs_fn).call(this);
+    const packageId = this.kioskClient.getRulePackageId("personalKioskRulePackageId");
+    removeTransferPolicyRule(
+      this.transactionBlock,
+      this.type,
+      `${packageId}::personal_kiosk_rule::Rule`,
+      `bool`,
+      this.policy,
+      this.policyCap
+    );
+    return this;
+  }
+  removeFloorPriceRule() {
+    __privateMethod(this, _validateInputs, validateInputs_fn).call(this);
+    const packageId = this.kioskClient.getRulePackageId("floorPriceRulePackageId");
+    removeTransferPolicyRule(
+      this.transactionBlock,
+      this.type,
+      `${packageId}::floor_price_rule::Rule`,
+      `${packageId}::floor_price_rule::Config`,
+      this.policy,
+      this.policyCap
+    );
+    return this;
+  }
+  getPolicy() {
+    if (!this.policy)
+      throw new Error("Policy not set.");
+    return this.policy;
+  }
+  getPolicyCap() {
+    if (!this.policyCap)
+      throw new Error("Transfer Policy Cap not set.");
+    return this.policyCap;
+  }
+}
+_validateInputs = new WeakSet();
+validateInputs_fn = function() {
+  const genericErrorMessage = `Please use 'setCap()' to setup the TransferPolicy.`;
+  if (!this.policy)
+    throw new Error(`${genericErrorMessage} Missing: Transfer Policy Object.`);
+  if (!this.policyCap)
+    throw new Error(`${genericErrorMessage} Missing: TransferPolicyCap Object ID`);
+  if (!this.type)
+    throw new Error(
+      `${genericErrorMessage} Missing: Transfer Policy object type (e.g. {packageId}::item::Item)`
+    );
+};
+_setup = new WeakSet();
+setup_fn = function(policyId, policyCap, type) {
+  this.policy = policyId;
+  this.policyCap = policyCap;
+  this.type = type;
+  return this;
+};
+export {
+  TransferPolicyTransaction
+};
+//# sourceMappingURL=tp-transaction.js.map

package/dist/esm/client/tp-transaction.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/client/tp-transaction.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport { TransactionObjectArgument, type TransactionBlock } from '@mysten/sui.js/transactions';\n\nimport {\n\tattachFloorPriceRuleTx,\n\tattachKioskLockRuleTx,\n\tattachPersonalKioskRuleTx,\n\tattachRoyaltyRuleTx,\n} from '../tx/rules/attach';\nimport {\n\tcreateTransferPolicy,\n\tcreateTransferPolicyWithoutSharing,\n\tremoveTransferPolicyRule,\n\tshareTransferPolicy,\n\twithdrawFromPolicy,\n} from '../tx/transfer-policy';\nimport { TransferPolicyCap, type ObjectArgument } from '../types';\nimport { KioskClient } from './kiosk-client';\n\nexport type TransferPolicyBaseParams = {\n\ttype: string;\n\tpublisher: ObjectArgument;\n\tskipCheck?: boolean;\n};\n\nexport type TransferPolicyTransactionParams = {\n\tkioskClient: KioskClient;\n\ttransactionBlock: TransactionBlock;\n\tcap?: TransferPolicyCap;\n};\n\nexport class TransferPolicyTransaction {\n\ttransactionBlock: TransactionBlock;\n\tkioskClient: KioskClient;\n\tpolicy?: ObjectArgument;\n\tpolicyCap?: ObjectArgument;\n\ttype?: string;\n\n\tconstructor({ kioskClient, transactionBlock, cap }: TransferPolicyTransactionParams) {\n\t\tthis.kioskClient = kioskClient;\n\t\tthis.transactionBlock = transactionBlock;\n\t\tif (cap) this.setCap(cap);\n\t}\n\n\t/**\n\t * A function to create a new transfer policy.\n\t * Checks if there's already an existing transfer policy to prevent\n\t * double transfer polciy mistakes.\n\t * There's an optional `skipCheck` flag that will just create the policy\n\t * without checking\n\t *\n\t * @param type The Type (`T`) for which we're creating the transfer policy.\n\t * @param publisher The Publisher Object Id.\n\t * @param address Address to save the `TransferPolicyCap` object to.\n\t * @param skipCheck (Optional) skip checking if a transfer policy already exists\n\t */\n\tasync createAndShare({\n\t\ttype,\n\t\tpublisher,\n\t\taddress,\n\t\tskipCheck,\n\t}: TransferPolicyBaseParams & {\n\t\taddress: string;\n\t}) {\n\t\tif (!skipCheck) {\n\t\t\tconst policies = await this.kioskClient.getTransferPolicies({ type });\n\t\t\tif (policies.length > 0) throw new Error(\"There's already transfer policy for this Type.\");\n\t\t}\n\t\tconst cap = createTransferPolicy(this.transactionBlock, type, publisher);\n\t\tthis.transactionBlock.transferObjects([cap], this.transactionBlock.pure.address(address));\n\t}\n\n\t/**\n\t * A convenient function to create a Transfer Policy and attach some rules\n\t * before sharing it (so you can prepare it in a single PTB)\n\t * @param type The Type (`T`) for which we're creating the transfer policy.\n\t * @param publisher The Publisher Object Id.\n\t * @param address Address to save the `TransferPolicyCap` object to.\n\t * @param skipCheck (Optional) skip checking if a transfer policy already exists\n\t */\n\tasync create({\n\t\ttype,\n\t\tpublisher,\n\t\tskipCheck,\n\t}: TransferPolicyBaseParams): Promise<TransferPolicyTransaction> {\n\t\tif (!skipCheck) {\n\t\t\tconst policies = await this.kioskClient.getTransferPolicies({ type });\n\t\t\tif (policies.length > 0) throw new Error(\"There's already transfer policy for this Type.\");\n\t\t}\n\t\tconst [policy, policyCap] = createTransferPolicyWithoutSharing(\n\t\t\tthis.transactionBlock,\n\t\t\ttype,\n\t\t\tpublisher,\n\t\t);\n\n\t\tthis.#setup(policy, policyCap, type); // sets the client's TP to the newly created one.\n\t\treturn this;\n\t}\n\n\t/**\n\t * This can be called after calling the `create` function to share the `TransferPolicy`,\n\t * and transfer the `TransferPolicyCap` to the specified address\n\t *\n\t * @param address The address to transfer the `TransferPolicyCap`\n\t */\n\tshareAndTransferCap(address: string) {\n\t\tif (!this.type || !this.policyCap || !this.policy)\n\t\t\tthrow new Error('This function can only be called after `transferPolicyManager.create`');\n\n\t\tshareTransferPolicy(this.transactionBlock, this.type, this.policy as TransactionObjectArgument);\n\t\tthis.transactionBlock.transferObjects(\n\t\t\t[this.policyCap as TransactionObjectArgument],\n\t\t\tthis.transactionBlock.pure.address(address),\n\t\t);\n\t}\n\n\t/**\n\t * Setup the TransferPolicy by passing a `cap` returned from `kioskClient.getOwnedTransferPolicies` or\n\t * `kioskClient.getOwnedTransferPoliciesByType`.\n\t * @param policyCapId The `TransferPolicyCap`\n\t */\n\tsetCap({ policyId, policyCapId, type }: TransferPolicyCap) {\n\t\treturn this.#setup(policyId, policyCapId, type);\n\t}\n\n\t/**\n\t * Withdraw from the transfer policy's profits.\n\t * @param address Address to transfer the profits to.\n\t * @param amount (Optional) amount parameter. Will withdraw all profits if the amount is not specified.\n\t */\n\twithdraw(address: string, amount?: string | bigint) {\n\t\tthis.#validateInputs();\n\t\t// Withdraw coin for specified amount (or none)\n\t\tconst coin = withdrawFromPolicy(\n\t\t\tthis.transactionBlock,\n\t\t\tthis.type!,\n\t\t\tthis.policy!,\n\t\t\tthis.policyCap!,\n\t\t\tamount,\n\t\t);\n\n\t\tthis.transactionBlock.transferObjects([coin], this.transactionBlock.pure.address(address));\n\n\t\treturn this;\n\t}\n\n\t/**\n\t *  Adds the Kiosk Royalty rule to the Transfer Policy.\n\t *  You can pass the percentage, as well as a minimum amount.\n\t *  The royalty that will be paid is the MAX(percentage, minAmount).\n\t * \tYou can pass 0 in either value if you want only percentage royalty, or a fixed amount fee.\n\t * \t(but you should define at least one of them for the rule to make sense).\n\t *\n\t * \t@param percentageBps The royalty percentage in basis points. Use `percentageToBasisPoints` helper to convert from percentage [0,100].\n\t * \t@param minAmount The minimum royalty amount per request in MIST.\n\t */\n\taddRoyaltyRule(\n\t\tpercentageBps: number | string, // this is in basis points.\n\t\tminAmount: number | string,\n\t) {\n\t\tthis.#validateInputs();\n\n\t\t// Hard-coding package Ids as these don't change.\n\t\t// Also, it's hard to keep versioning as with network wipes, mainnet\n\t\t// and testnet will conflict.\n\t\tattachRoyaltyRuleTx(\n\t\t\tthis.transactionBlock,\n\t\t\tthis.type!,\n\t\t\tthis.policy!,\n\t\t\tthis.policyCap!,\n\t\t\tpercentageBps,\n\t\t\tminAmount,\n\t\t\tthis.kioskClient.getRulePackageId('royaltyRulePackageId'),\n\t\t);\n\t\treturn this;\n\t}\n\n\t/**\n\t * Adds the Kiosk Lock Rule to the Transfer Policy.\n\t * This Rule forces buyer to lock the item in the kiosk, preserving strong royalties.\n\t */\n\taddLockRule() {\n\t\tthis.#validateInputs();\n\n\t\tattachKioskLockRuleTx(\n\t\t\tthis.transactionBlock,\n\t\t\tthis.type!,\n\t\t\tthis.policy!,\n\t\t\tthis.policyCap!,\n\t\t\tthis.kioskClient.getRulePackageId('kioskLockRulePackageId'),\n\t\t);\n\t\treturn this;\n\t}\n\n\t/**\n\t * Attaches the Personal Kiosk Rule, making a purchase valid only for `SoulBound` kiosks.\n\t */\n\taddPersonalKioskRule() {\n\t\tthis.#validateInputs();\n\n\t\tattachPersonalKioskRuleTx(\n\t\t\tthis.transactionBlock,\n\t\t\tthis.type!,\n\t\t\tthis.policy!,\n\t\t\tthis.policyCap!,\n\t\t\tthis.kioskClient.getRulePackageId('personalKioskRulePackageId'),\n\t\t);\n\t\treturn this;\n\t}\n\n\t/**\n\t * A function to add the floor price rule to a transfer policy.\n\t * @param minPrice The minimum price in MIST.\n\t */\n\taddFloorPriceRule(minPrice: string | bigint) {\n\t\tthis.#validateInputs();\n\n\t\tattachFloorPriceRuleTx(\n\t\t\tthis.transactionBlock,\n\t\t\tthis.type!,\n\t\t\tthis.policy!,\n\t\t\tthis.policyCap!,\n\t\t\tminPrice,\n\t\t\tthis.kioskClient.getRulePackageId('floorPriceRulePackageId'),\n\t\t);\n\t\treturn this;\n\t}\n\n\t/**\n\t * Generic helper to remove a rule, not from the SDK's base ruleset.\n\t * @param ruleType The Rule Type\n\t * @param configType The Config Type\n\t */\n\tremoveRule({ ruleType, configType }: { ruleType: string; configType: string }) {\n\t\tthis.#validateInputs();\n\n\t\tremoveTransferPolicyRule(\n\t\t\tthis.transactionBlock,\n\t\t\tthis.type!,\n\t\t\truleType,\n\t\t\tconfigType,\n\t\t\tthis.policy!,\n\t\t\tthis.policyCap!,\n\t\t);\n\t}\n\n\t/**\n\t * Removes the lock rule.\n\t */\n\tremoveLockRule() {\n\t\tthis.#validateInputs();\n\n\t\tconst packageId = this.kioskClient.getRulePackageId('kioskLockRulePackageId');\n\n\t\tremoveTransferPolicyRule(\n\t\t\tthis.transactionBlock,\n\t\t\tthis.type!,\n\t\t\t`${packageId}::kiosk_lock_rule::Rule`,\n\t\t\t`${packageId}::kiosk_lock_rule::Config`,\n\t\t\tthis.policy!,\n\t\t\tthis.policyCap!,\n\t\t);\n\t\treturn this;\n\t}\n\n\t/**\n\t * Removes the Royalty rule\n\t */\n\tremoveRoyaltyRule() {\n\t\tthis.#validateInputs();\n\n\t\tconst packageId = this.kioskClient.getRulePackageId('royaltyRulePackageId');\n\n\t\tremoveTransferPolicyRule(\n\t\t\tthis.transactionBlock,\n\t\t\tthis.type!,\n\t\t\t`${packageId}::royalty_rule::Rule`,\n\t\t\t`${packageId}::royalty_rule::Config`,\n\t\t\tthis.policy!,\n\t\t\tthis.policyCap!,\n\t\t);\n\t\treturn this;\n\t}\n\n\tremovePersonalKioskRule() {\n\t\tthis.#validateInputs();\n\n\t\tconst packageId = this.kioskClient.getRulePackageId('personalKioskRulePackageId');\n\n\t\tremoveTransferPolicyRule(\n\t\t\tthis.transactionBlock,\n\t\t\tthis.type!,\n\t\t\t`${packageId}::personal_kiosk_rule::Rule`,\n\t\t\t`bool`,\n\t\t\tthis.policy!,\n\t\t\tthis.policyCap!,\n\t\t);\n\t\treturn this;\n\t}\n\n\tremoveFloorPriceRule() {\n\t\tthis.#validateInputs();\n\n\t\tconst packageId = this.kioskClient.getRulePackageId('floorPriceRulePackageId');\n\n\t\tremoveTransferPolicyRule(\n\t\t\tthis.transactionBlock,\n\t\t\tthis.type!,\n\t\t\t`${packageId}::floor_price_rule::Rule`,\n\t\t\t`${packageId}::floor_price_rule::Config`,\n\t\t\tthis.policy!,\n\t\t\tthis.policyCap!,\n\t\t);\n\t\treturn this;\n\t}\n\n\tgetPolicy() {\n\t\tif (!this.policy) throw new Error('Policy not set.');\n\t\treturn this.policy;\n\t}\n\n\tgetPolicyCap() {\n\t\tif (!this.policyCap) throw new Error('Transfer Policy Cap not set.');\n\t\treturn this.policyCap;\n\t}\n\n\t// Internal function that that the policy's Id + Cap + type have been set.\n\t#validateInputs() {\n\t\tconst genericErrorMessage = `Please use 'setCap()' to setup the TransferPolicy.`;\n\t\tif (!this.policy) throw new Error(`${genericErrorMessage} Missing: Transfer Policy Object.`);\n\t\tif (!this.policyCap)\n\t\t\tthrow new Error(`${genericErrorMessage} Missing: TransferPolicyCap Object ID`);\n\t\tif (!this.type)\n\t\t\tthrow new Error(\n\t\t\t\t`${genericErrorMessage} Missing: Transfer Policy object type (e.g. {packageId}::item::Item)`,\n\t\t\t);\n\t}\n\n\t/**\n\t * Setup the state of the TransferPolicyTransaction.\n\t */\n\t#setup(policyId: ObjectArgument, policyCap: ObjectArgument, type: string) {\n\t\tthis.policy = policyId;\n\t\tthis.policyCap = policyCap;\n\t\tthis.type = type;\n\t\treturn this;\n\t}\n}\n"],
+  "mappings": ";;;;;;;;;;;;;AAAA;AAKA;AAAA,EACC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACM;AACP;AAAA,EACC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACM;AAgBA,MAAM,0BAA0B;AAAA,EAOtC,YAAY,EAAE,aAAa,kBAAkB,IAAI,GAAoC;AAiSrF;AAAA;AAcA;AAAA;AAAA;AAAA;AA9SC,SAAK,cAAc;AACnB,SAAK,mBAAmB;AACxB,QAAI;AAAK,WAAK,OAAO,GAAG;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,MAAM,eAAe;AAAA,IACpB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACD,GAEG;AACF,QAAI,CAAC,WAAW;AACf,YAAM,WAAW,MAAM,KAAK,YAAY,oBAAoB,EAAE,KAAK,CAAC;AACpE,UAAI,SAAS,SAAS;AAAG,cAAM,IAAI,MAAM,gDAAgD;AAAA,IAC1F;AACA,UAAM,MAAM,qBAAqB,KAAK,kBAAkB,MAAM,SAAS;AACvE,SAAK,iBAAiB,gBAAgB,CAAC,GAAG,GAAG,KAAK,iBAAiB,KAAK,QAAQ,OAAO,CAAC;AAAA,EACzF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,OAAO;AAAA,IACZ;AAAA,IACA;AAAA,IACA;AAAA,EACD,GAAiE;AAChE,QAAI,CAAC,WAAW;AACf,YAAM,WAAW,MAAM,KAAK,YAAY,oBAAoB,EAAE,KAAK,CAAC;AACpE,UAAI,SAAS,SAAS;AAAG,cAAM,IAAI,MAAM,gDAAgD;AAAA,IAC1F;AACA,UAAM,CAAC,QAAQ,SAAS,IAAI;AAAA,MAC3B,KAAK;AAAA,MACL;AAAA,MACA;AAAA,IACD;AAEA,0BAAK,kBAAL,WAAY,QAAQ,WAAW;AAC/B,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,oBAAoB,SAAiB;AACpC,QAAI,CAAC,KAAK,QAAQ,CAAC,KAAK,aAAa,CAAC,KAAK;AAC1C,YAAM,IAAI,MAAM,uEAAuE;AAExF,wBAAoB,KAAK,kBAAkB,KAAK,MAAM,KAAK,MAAmC;AAC9F,SAAK,iBAAiB;AAAA,MACrB,CAAC,KAAK,SAAsC;AAAA,MAC5C,KAAK,iBAAiB,KAAK,QAAQ,OAAO;AAAA,IAC3C;AAAA,EACD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,EAAE,UAAU,aAAa,KAAK,GAAsB;AAC1D,WAAO,sBAAK,kBAAL,WAAY,UAAU,aAAa;AAAA,EAC3C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAS,SAAiB,QAA0B;AACnD,0BAAK,oCAAL;AAEA,UAAM,OAAO;AAAA,MACZ,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,IACD;AAEA,SAAK,iBAAiB,gBAAgB,CAAC,IAAI,GAAG,KAAK,iBAAiB,KAAK,QAAQ,OAAO,CAAC;AAEzF,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,eACC,eACA,WACC;AACD,0BAAK,oCAAL;AAKA;AAAA,MACC,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,MACA;AAAA,MACA,KAAK,YAAY,iBAAiB,sBAAsB;AAAA,IACzD;AACA,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,cAAc;AACb,0BAAK,oCAAL;AAEA;AAAA,MACC,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK,YAAY,iBAAiB,wBAAwB;AAAA,IAC3D;AACA,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA,EAKA,uBAAuB;AACtB,0BAAK,oCAAL;AAEA;AAAA,MACC,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK,YAAY,iBAAiB,4BAA4B;AAAA,IAC/D;AACA,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,kBAAkB,UAA2B;AAC5C,0BAAK,oCAAL;AAEA;AAAA,MACC,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,MACA,KAAK,YAAY,iBAAiB,yBAAyB;AAAA,IAC5D;AACA,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,WAAW,EAAE,UAAU,WAAW,GAA6C;AAC9E,0BAAK,oCAAL;AAEA;AAAA,MACC,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,MACA;AAAA,MACA,KAAK;AAAA,MACL,KAAK;AAAA,IACN;AAAA,EACD;AAAA;AAAA;AAAA;AAAA,EAKA,iBAAiB;AAChB,0BAAK,oCAAL;AAEA,UAAM,YAAY,KAAK,YAAY,iBAAiB,wBAAwB;AAE5E;AAAA,MACC,KAAK;AAAA,MACL,KAAK;AAAA,MACL,GAAG;AAAA,MACH,GAAG;AAAA,MACH,KAAK;AAAA,MACL,KAAK;AAAA,IACN;AACA,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA,EAKA,oBAAoB;AACnB,0BAAK,oCAAL;AAEA,UAAM,YAAY,KAAK,YAAY,iBAAiB,sBAAsB;AAE1E;AAAA,MACC,KAAK;AAAA,MACL,KAAK;AAAA,MACL,GAAG;AAAA,MACH,GAAG;AAAA,MACH,KAAK;AAAA,MACL,KAAK;AAAA,IACN;AACA,WAAO;AAAA,EACR;AAAA,EAEA,0BAA0B;AACzB,0BAAK,oCAAL;AAEA,UAAM,YAAY,KAAK,YAAY,iBAAiB,4BAA4B;AAEhF;AAAA,MACC,KAAK;AAAA,MACL,KAAK;AAAA,MACL,GAAG;AAAA,MACH;AAAA,MACA,KAAK;AAAA,MACL,KAAK;AAAA,IACN;AACA,WAAO;AAAA,EACR;AAAA,EAEA,uBAAuB;AACtB,0BAAK,oCAAL;AAEA,UAAM,YAAY,KAAK,YAAY,iBAAiB,yBAAyB;AAE7E;AAAA,MACC,KAAK;AAAA,MACL,KAAK;AAAA,MACL,GAAG;AAAA,MACH,GAAG;AAAA,MACH,KAAK;AAAA,MACL,KAAK;AAAA,IACN;AACA,WAAO;AAAA,EACR;AAAA,EAEA,YAAY;AACX,QAAI,CAAC,KAAK;AAAQ,YAAM,IAAI,MAAM,iBAAiB;AACnD,WAAO,KAAK;AAAA,EACb;AAAA,EAEA,eAAe;AACd,QAAI,CAAC,KAAK;AAAW,YAAM,IAAI,MAAM,8BAA8B;AACnE,WAAO,KAAK;AAAA,EACb;AAuBD;AApBC;AAAA,oBAAe,WAAG;AACjB,QAAM,sBAAsB;AAC5B,MAAI,CAAC,KAAK;AAAQ,UAAM,IAAI,MAAM,GAAG,sDAAsD;AAC3F,MAAI,CAAC,KAAK;AACT,UAAM,IAAI,MAAM,GAAG,0DAA0D;AAC9E,MAAI,CAAC,KAAK;AACT,UAAM,IAAI;AAAA,MACT,GAAG;AAAA,IACJ;AACF;AAKA;AAAA,WAAM,SAAC,UAA0B,WAA2B,MAAc;AACzE,OAAK,SAAS;AACd,OAAK,YAAY;AACjB,OAAK,OAAO;AACZ,SAAO;AACR;",
+  "names": []
+}

package/dist/esm/constants.d.ts

@@ -0,0 +1,30 @@
+import { Network, type ObjectArgument, type RuleResolvingParams } from './types';
+/**
+ * The base rule package ids that can be extended
+ */
+export type BaseRulePackageIds = {
+    royaltyRulePackageId?: string;
+    kioskLockRulePackageId?: string;
+    personalKioskRulePackageId?: string;
+    floorPriceRulePackageId?: string;
+};
+/**
+ * The Transfer Policy rule.
+ */
+export type TransferPolicyRule = {
+    rule: string;
+    packageId: string;
+    resolveRuleFunction: (rule: RuleResolvingParams) => ObjectArgument | void;
+    hasLockingRule?: boolean;
+};
+export declare const ROYALTY_RULE_ADDRESS: Record<Network, string>;
+export declare const KIOSK_LOCK_RULE_ADDRESS: Record<Network, string>;
+export declare const FLOOR_PRICE_RULE_ADDRESS: Record<Network, string>;
+export declare const PERSONAL_KIOSK_RULE_ADDRESS: Record<Network, string>;
+/**
+ * Constructs a list of rule resolvers based on the params.
+ */
+export declare function getBaseRules({ royaltyRulePackageId, kioskLockRulePackageId, personalKioskRulePackageId, floorPriceRulePackageId, }: BaseRulePackageIds): TransferPolicyRule[];
+export declare const testnetRules: TransferPolicyRule[];
+export declare const mainnetRules: TransferPolicyRule[];
+export declare const rules: TransferPolicyRule[];

package/dist/esm/constants.js

@@ -0,0 +1,87 @@
+import {
+  resolveFloorPriceRule,
+  resolveKioskLockRule,
+  resolvePersonalKioskRule,
+  resolveRoyaltyRule
+} from "./tx/rules//resolve";
+import { Network } from "./types";
+const ROYALTY_RULE_ADDRESS = {
+  [Network.TESTNET]: "bd8fc1947cf119350184107a3087e2dc27efefa0dd82e25a1f699069fe81a585",
+  [Network.MAINNET]: "0x434b5bd8f6a7b05fede0ff46c6e511d71ea326ed38056e3bcd681d2d7c2a7879",
+  [Network.CUSTOM]: ""
+};
+const KIOSK_LOCK_RULE_ADDRESS = {
+  [Network.TESTNET]: "bd8fc1947cf119350184107a3087e2dc27efefa0dd82e25a1f699069fe81a585",
+  [Network.MAINNET]: "0x434b5bd8f6a7b05fede0ff46c6e511d71ea326ed38056e3bcd681d2d7c2a7879",
+  [Network.CUSTOM]: ""
+};
+const FLOOR_PRICE_RULE_ADDRESS = {
+  [Network.TESTNET]: "0x06f6bdd3f2e2e759d8a4b9c252f379f7a05e72dfe4c0b9311cdac27b8eb791b1",
+  [Network.MAINNET]: "0x34cc6762780f4f6f153c924c0680cfe2a1fb4601e7d33cc28a92297b62de1e0e",
+  [Network.CUSTOM]: ""
+};
+const PERSONAL_KIOSK_RULE_ADDRESS = {
+  [Network.TESTNET]: "0x06f6bdd3f2e2e759d8a4b9c252f379f7a05e72dfe4c0b9311cdac27b8eb791b1",
+  [Network.MAINNET]: "0x0cb4bcc0560340eb1a1b929cabe56b33fc6449820ec8c1980d69bb98b649b802",
+  [Network.CUSTOM]: ""
+};
+function getBaseRules({
+  royaltyRulePackageId,
+  kioskLockRulePackageId,
+  personalKioskRulePackageId,
+  floorPriceRulePackageId
+}) {
+  const rules2 = [];
+  if (royaltyRulePackageId) {
+    rules2.push({
+      rule: `${royaltyRulePackageId}::royalty_rule::Rule`,
+      packageId: royaltyRulePackageId,
+      resolveRuleFunction: resolveRoyaltyRule
+    });
+  }
+  if (kioskLockRulePackageId) {
+    rules2.push({
+      rule: `${kioskLockRulePackageId}::kiosk_lock_rule::Rule`,
+      packageId: kioskLockRulePackageId,
+      resolveRuleFunction: resolveKioskLockRule,
+      hasLockingRule: true
+    });
+  }
+  if (personalKioskRulePackageId) {
+    rules2.push({
+      rule: `${personalKioskRulePackageId}::personal_kiosk_rule::Rule`,
+      packageId: personalKioskRulePackageId,
+      resolveRuleFunction: resolvePersonalKioskRule
+    });
+  }
+  if (floorPriceRulePackageId) {
+    rules2.push({
+      rule: `${floorPriceRulePackageId}::floor_price_rule::Rule`,
+      packageId: floorPriceRulePackageId,
+      resolveRuleFunction: resolveFloorPriceRule
+    });
+  }
+  return rules2;
+}
+const testnetRules = getBaseRules({
+  royaltyRulePackageId: ROYALTY_RULE_ADDRESS[Network.TESTNET],
+  kioskLockRulePackageId: KIOSK_LOCK_RULE_ADDRESS[Network.TESTNET],
+  personalKioskRulePackageId: PERSONAL_KIOSK_RULE_ADDRESS[Network.TESTNET],
+  floorPriceRulePackageId: FLOOR_PRICE_RULE_ADDRESS[Network.TESTNET]
+});
+const mainnetRules = getBaseRules({
+  royaltyRulePackageId: ROYALTY_RULE_ADDRESS[Network.MAINNET],
+  kioskLockRulePackageId: KIOSK_LOCK_RULE_ADDRESS[Network.MAINNET]
+});
+const rules = [...testnetRules, ...mainnetRules];
+export {
+  FLOOR_PRICE_RULE_ADDRESS,
+  KIOSK_LOCK_RULE_ADDRESS,
+  PERSONAL_KIOSK_RULE_ADDRESS,
+  ROYALTY_RULE_ADDRESS,
+  getBaseRules,
+  mainnetRules,
+  rules,
+  testnetRules
+};
+//# sourceMappingURL=constants.js.map

package/dist/esm/constants.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/constants.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport {\n\tresolveFloorPriceRule,\n\tresolveKioskLockRule,\n\tresolvePersonalKioskRule,\n\tresolveRoyaltyRule,\n} from './tx/rules//resolve';\nimport { Network, type ObjectArgument, type RuleResolvingParams } from './types';\n\n/**\n * The base rule package ids that can be extended\n */\nexport type BaseRulePackageIds = {\n\troyaltyRulePackageId?: string;\n\tkioskLockRulePackageId?: string;\n\tpersonalKioskRulePackageId?: string;\n\tfloorPriceRulePackageId?: string;\n};\n\n/**\n * The Transfer Policy rule.\n */\nexport type TransferPolicyRule = {\n\trule: string;\n\tpackageId: string;\n\tresolveRuleFunction: (rule: RuleResolvingParams) => ObjectArgument | void;\n\thasLockingRule?: boolean;\n};\n\nexport const ROYALTY_RULE_ADDRESS: Record<Network, string> = {\n\t[Network.TESTNET]: 'bd8fc1947cf119350184107a3087e2dc27efefa0dd82e25a1f699069fe81a585',\n\t[Network.MAINNET]: '0x434b5bd8f6a7b05fede0ff46c6e511d71ea326ed38056e3bcd681d2d7c2a7879',\n\t[Network.CUSTOM]: '',\n};\n\nexport const KIOSK_LOCK_RULE_ADDRESS: Record<Network, string> = {\n\t[Network.TESTNET]: 'bd8fc1947cf119350184107a3087e2dc27efefa0dd82e25a1f699069fe81a585',\n\t[Network.MAINNET]: '0x434b5bd8f6a7b05fede0ff46c6e511d71ea326ed38056e3bcd681d2d7c2a7879',\n\t[Network.CUSTOM]: '',\n};\n\nexport const FLOOR_PRICE_RULE_ADDRESS: Record<Network, string> = {\n\t[Network.TESTNET]: '0x06f6bdd3f2e2e759d8a4b9c252f379f7a05e72dfe4c0b9311cdac27b8eb791b1',\n\t[Network.MAINNET]: '0x34cc6762780f4f6f153c924c0680cfe2a1fb4601e7d33cc28a92297b62de1e0e',\n\t[Network.CUSTOM]: '',\n};\n\nexport const PERSONAL_KIOSK_RULE_ADDRESS: Record<Network, string> = {\n\t[Network.TESTNET]: '0x06f6bdd3f2e2e759d8a4b9c252f379f7a05e72dfe4c0b9311cdac27b8eb791b1',\n\t[Network.MAINNET]: '0x0cb4bcc0560340eb1a1b929cabe56b33fc6449820ec8c1980d69bb98b649b802',\n\t[Network.CUSTOM]: '',\n};\n\n/**\n * Constructs a list of rule resolvers based on the params.\n */\nexport function getBaseRules({\n\troyaltyRulePackageId,\n\tkioskLockRulePackageId,\n\tpersonalKioskRulePackageId,\n\tfloorPriceRulePackageId,\n}: BaseRulePackageIds): TransferPolicyRule[] {\n\tconst rules = [];\n\n\tif (royaltyRulePackageId) {\n\t\trules.push({\n\t\t\trule: `${royaltyRulePackageId}::royalty_rule::Rule`,\n\t\t\tpackageId: royaltyRulePackageId,\n\t\t\tresolveRuleFunction: resolveRoyaltyRule,\n\t\t});\n\t}\n\n\tif (kioskLockRulePackageId) {\n\t\trules.push({\n\t\t\trule: `${kioskLockRulePackageId}::kiosk_lock_rule::Rule`,\n\t\t\tpackageId: kioskLockRulePackageId,\n\t\t\tresolveRuleFunction: resolveKioskLockRule,\n\t\t\thasLockingRule: true,\n\t\t});\n\t}\n\n\tif (personalKioskRulePackageId) {\n\t\trules.push({\n\t\t\trule: `${personalKioskRulePackageId}::personal_kiosk_rule::Rule`,\n\t\t\tpackageId: personalKioskRulePackageId,\n\t\t\tresolveRuleFunction: resolvePersonalKioskRule,\n\t\t});\n\t}\n\n\tif (floorPriceRulePackageId) {\n\t\trules.push({\n\t\t\trule: `${floorPriceRulePackageId}::floor_price_rule::Rule`,\n\t\t\tpackageId: floorPriceRulePackageId,\n\t\t\tresolveRuleFunction: resolveFloorPriceRule,\n\t\t});\n\t}\n\n\treturn rules;\n}\n\n// A list of testnet's base rules.\nexport const testnetRules: TransferPolicyRule[] = getBaseRules({\n\troyaltyRulePackageId: ROYALTY_RULE_ADDRESS[Network.TESTNET],\n\tkioskLockRulePackageId: KIOSK_LOCK_RULE_ADDRESS[Network.TESTNET],\n\tpersonalKioskRulePackageId: PERSONAL_KIOSK_RULE_ADDRESS[Network.TESTNET],\n\tfloorPriceRulePackageId: FLOOR_PRICE_RULE_ADDRESS[Network.TESTNET],\n});\n\n// A list of mainnet's base rules.\nexport const mainnetRules: TransferPolicyRule[] = getBaseRules({\n\troyaltyRulePackageId: ROYALTY_RULE_ADDRESS[Network.MAINNET],\n\tkioskLockRulePackageId: KIOSK_LOCK_RULE_ADDRESS[Network.MAINNET],\n});\n\nexport const rules: TransferPolicyRule[] = [...testnetRules, ...mainnetRules];\n"],
+  "mappings": "AAGA;AAAA,EACC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACM;AACP,SAAS,eAA8D;AAsBhE,MAAM,uBAAgD;AAAA,EAC5D,CAAC,QAAQ,OAAO,GAAG;AAAA,EACnB,CAAC,QAAQ,OAAO,GAAG;AAAA,EACnB,CAAC,QAAQ,MAAM,GAAG;AACnB;AAEO,MAAM,0BAAmD;AAAA,EAC/D,CAAC,QAAQ,OAAO,GAAG;AAAA,EACnB,CAAC,QAAQ,OAAO,GAAG;AAAA,EACnB,CAAC,QAAQ,MAAM,GAAG;AACnB;AAEO,MAAM,2BAAoD;AAAA,EAChE,CAAC,QAAQ,OAAO,GAAG;AAAA,EACnB,CAAC,QAAQ,OAAO,GAAG;AAAA,EACnB,CAAC,QAAQ,MAAM,GAAG;AACnB;AAEO,MAAM,8BAAuD;AAAA,EACnE,CAAC,QAAQ,OAAO,GAAG;AAAA,EACnB,CAAC,QAAQ,OAAO,GAAG;AAAA,EACnB,CAAC,QAAQ,MAAM,GAAG;AACnB;AAKO,SAAS,aAAa;AAAA,EAC5B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACD,GAA6C;AAC5C,QAAMA,SAAQ,CAAC;AAEf,MAAI,sBAAsB;AACzB,IAAAA,OAAM,KAAK;AAAA,MACV,MAAM,GAAG;AAAA,MACT,WAAW;AAAA,MACX,qBAAqB;AAAA,IACtB,CAAC;AAAA,EACF;AAEA,MAAI,wBAAwB;AAC3B,IAAAA,OAAM,KAAK;AAAA,MACV,MAAM,GAAG;AAAA,MACT,WAAW;AAAA,MACX,qBAAqB;AAAA,MACrB,gBAAgB;AAAA,IACjB,CAAC;AAAA,EACF;AAEA,MAAI,4BAA4B;AAC/B,IAAAA,OAAM,KAAK;AAAA,MACV,MAAM,GAAG;AAAA,MACT,WAAW;AAAA,MACX,qBAAqB;AAAA,IACtB,CAAC;AAAA,EACF;AAEA,MAAI,yBAAyB;AAC5B,IAAAA,OAAM,KAAK;AAAA,MACV,MAAM,GAAG;AAAA,MACT,WAAW;AAAA,MACX,qBAAqB;AAAA,IACtB,CAAC;AAAA,EACF;AAEA,SAAOA;AACR;AAGO,MAAM,eAAqC,aAAa;AAAA,EAC9D,sBAAsB,qBAAqB,QAAQ,OAAO;AAAA,EAC1D,wBAAwB,wBAAwB,QAAQ,OAAO;AAAA,EAC/D,4BAA4B,4BAA4B,QAAQ,OAAO;AAAA,EACvE,yBAAyB,yBAAyB,QAAQ,OAAO;AAClE,CAAC;AAGM,MAAM,eAAqC,aAAa;AAAA,EAC9D,sBAAsB,qBAAqB,QAAQ,OAAO;AAAA,EAC1D,wBAAwB,wBAAwB,QAAQ,OAAO;AAChE,CAAC;AAEM,MAAM,QAA8B,CAAC,GAAG,cAAc,GAAG,YAAY;",
+  "names": ["rules"]
+}

package/dist/esm/index.d.ts

@@ -0,0 +1,6 @@
+export * from './utils';
+export * from './types';
+export * from './constants';
+export * from './client/kiosk-client';
+export * from './client/tp-transaction';
+export * from './client/kiosk-transaction';