@mysten/kiosk 0.0.0-experimental-20230530145812 → 0.0.0-experimental-20230602192304
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +9 -3
- package/README.md +27 -9
- package/dist/bcs.d.ts +1 -32
- package/dist/constants.d.ts +4 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +136 -39
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +121 -38
- package/dist/index.mjs.map +1 -1
- package/dist/query/kiosk.d.ts +1 -1
- package/dist/query/transfer-policy.d.ts +1 -3
- package/dist/tx/kiosk.d.ts +6 -11
- package/dist/tx/transfer-policy.d.ts +8 -6
- package/dist/types/env.d.ts +13 -0
- package/dist/types/index.d.ts +8 -0
- package/dist/types/kiosk.d.ts +52 -0
- package/dist/types/transfer-policy.d.ts +23 -0
- package/dist/utils.d.ts +14 -8
- package/package.json +1 -1
- package/src/bcs.ts +11 -40
- package/src/constants.ts +10 -0
- package/src/index.ts +2 -0
- package/src/query/kiosk.ts +1 -1
- package/src/query/transfer-policy.ts +8 -10
- package/src/tx/kiosk.ts +65 -28
- package/src/tx/transfer-policy.ts +38 -13
- package/src/types/env.ts +22 -0
- package/src/types/index.ts +21 -0
- package/src/types/kiosk.ts +66 -0
- package/src/types/transfer-policy.ts +33 -0
- package/src/utils.ts +39 -19
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/utils.ts","../src/bcs.ts","../src/tx/transfer-policy.ts","../src/tx/kiosk.ts","../src/query/kiosk.ts","../src/query/transfer-policy.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport {\n JsonRpcProvider,\n ObjectId,\n SharedObjectRef,\n SuiObjectRef,\n SuiObjectResponse,\n TransactionArgument,\n TransactionBlock,\n getObjectFields,\n} from '@mysten/sui.js';\nimport { KioskData, KioskListing } from './query/kiosk';\nimport { DynamicFieldInfo } from '@mysten/sui.js/dist/types/dynamic_fields';\nimport { bcs, Kiosk } from './bcs';\n\n/**\n * A valid argument for any of the Kiosk functions.\n */\nexport type ObjectArgument =\n | string\n | TransactionArgument\n | SharedObjectRef\n | SuiObjectRef;\n\n/**\n * Convert any valid input into a TransactionArgument.\n *\n * @param tx The transaction to use for creating the argument.\n * @param arg The argument to convert.\n * @returns The converted TransactionArgument.\n */\nexport function objArg(\n tx: TransactionBlock,\n arg: string | SharedObjectRef | SuiObjectRef | TransactionArgument,\n): TransactionArgument {\n if (typeof arg === 'string') {\n return tx.object(arg);\n }\n\n if ('digest' in arg && 'version' in arg && 'objectId' in arg) {\n return tx.objectRef(arg);\n }\n\n if ('objectId' in arg && 'initialSharedVersion' in arg && 'mutable' in arg) {\n return tx.sharedObjectRef(arg);\n }\n\n if ('kind' in arg) {\n return arg;\n }\n\n throw new Error('Invalid argument type');\n}\n\nexport async function getKioskObject(\n provider: JsonRpcProvider,\n id: string,\n): Promise<Kiosk> {\n const queryRes = await provider.getObject({ id, options: { showBcs: true } });\n\n if (!queryRes || queryRes.error || !queryRes.data) {\n throw new Error(`Kiosk ${id} not found; ${queryRes.error}`);\n }\n\n if (!queryRes.data.bcs || !('bcsBytes' in queryRes.data.bcs)) {\n throw new Error(`Invalid kiosk query: ${id}, expected object, got package`);\n }\n\n return bcs.de('0x2::kiosk::Kiosk', queryRes.data.bcs!.bcsBytes, 'base64');\n}\n\n// helper to extract kiosk data from dynamic fields.\nexport function extractKioskData(\n data: DynamicFieldInfo[],\n listings: KioskListing[],\n lockedItemIds: string[],\n): KioskData {\n return data.reduce<KioskData>(\n (acc: KioskData, val: DynamicFieldInfo) => {\n const type = getTypeWithoutPackageAddress(val.name.type);\n\n switch (type) {\n case 'kiosk::Item':\n acc.itemIds.push(val.objectId);\n acc.items.push({\n objectId: val.objectId,\n type: val.objectType,\n isLocked: false,\n });\n break;\n case 'kiosk::Listing':\n acc.listingIds.push(val.objectId);\n listings.push({\n objectId: val.name.value.id,\n listingId: val.objectId,\n isExclusive: val.name.value.is_exclusive,\n });\n break;\n case 'kiosk::Lock':\n lockedItemIds?.push(val.name.value.id);\n break;\n }\n return acc;\n },\n { items: [], itemIds: [], listingIds: [], extensions: [] },\n );\n}\n\n// e.g. 0x2::kiosk::Item -> kiosk::Item\nexport const getTypeWithoutPackageAddress = (type: string) => {\n return type.split('::').slice(-2).join('::');\n};\n\n/**\n * A helper that attaches the listing prices to kiosk listings.\n */\nexport const attachListingsAndPrices = (\n kioskData: KioskData,\n listings: KioskListing[],\n listingObjects: SuiObjectResponse[],\n) => {\n // map item listings as {item_id: KioskListing}\n // for easier mapping on the nex\n const itemListings = listings.reduce<Record<ObjectId, KioskListing>>(\n (acc: Record<ObjectId, KioskListing>, item, idx) => {\n acc[item.objectId] = { ...item };\n\n // return in case we don't have any listing objects.\n // that's the case when we don't have the `listingPrices` included.\n if (listingObjects.length === 0) return acc;\n\n const data = getObjectFields(listingObjects[idx]);\n if (!data) return acc;\n\n acc[item.objectId].price = data.value;\n return acc;\n },\n {},\n );\n\n kioskData.items.map((item) => {\n item.listing = itemListings[item.objectId] || undefined;\n });\n};\n\n/**\n * A Helper to attach locked state to items in Kiosk Data.\n */\nexport const attachLockedItems = (\n kioskData: KioskData,\n lockedItemIds: ObjectId[],\n) => {\n // map lock status in an array of type { item_id: true }\n const lockedStatuses = lockedItemIds.reduce<Record<ObjectId, boolean>>(\n (acc: Record<ObjectId, boolean>, item: string) => {\n acc[item] = true;\n return acc;\n },\n {},\n );\n\n // parse lockedItemIds and attach their locked status.\n kioskData.items.map((item) => {\n item.isLocked = lockedStatuses[item.objectId] || false;\n });\n};\n","// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport { ObjectOwner, bcs } from '@mysten/sui.js';\n\n/**\n * The Kiosk object fields (for BCS queries).\n */\nexport type Kiosk = {\n id: string;\n profits: string;\n owner: string;\n itemCount: number;\n allowExtensions: boolean;\n};\n\n// Register the `Kiosk` struct for faster queries.\nbcs.registerStructType('0x2::kiosk::Kiosk', {\n id: 'address',\n profits: 'u64',\n owner: 'address',\n itemCount: 'u32',\n allowExtensions: 'bool',\n});\n\n/**\n * PurchaseCap object fields (for BCS queries).\n */\nexport type PurchaseCap = {\n id: string;\n kioskId: string;\n itemId: string;\n minPrice: string;\n};\n\n// Register the `PurchaseCap` for faster queries.\nbcs.registerStructType('0x2::kiosk::PurchaseCap', {\n id: 'address',\n kioskId: 'address',\n itemId: 'address',\n minPrice: 'u64',\n});\n\n/** Event emitted when a TransferPolicy is created. */\nexport type TransferPolicyCreated = {\n id: string;\n};\n\n// Register the `TransferPolicyCreated` event data.\nbcs.registerStructType('0x2::transfer_policy::TransferPolicyCreated', {\n id: 'address',\n});\n\n/** The `TransferPolicy` object */\nexport type TransferPolicy = {\n id: string;\n type: string;\n balance: string;\n rules: string[];\n owner: ObjectOwner;\n};\n\nbcs.registerStructType('0x2::transfer_policy::TransferPolicy', {\n id: 'address',\n balance: 'u64',\n rules: ['vector', 'string'],\n});\n\nexport { bcs };\n","// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport { TransactionArgument, TransactionBlock } from '@mysten/sui.js';\nimport { ObjectArgument, objArg } from '../utils';\n\n/** The Transfer Policy module. */\nexport const TRANSFER_POLICY_MODULE = '0x2::transfer_policy';\n\n/** The Transer Policy Rules package address */\n// TODO: Figure out how we serve this for both testnet & mainnet (different package)\nexport const TRANSFER_POLICY_RULES_PACKAGE_ADDRESS =\n 'bd8fc1947cf119350184107a3087e2dc27efefa0dd82e25a1f699069fe81a585';\n\n/**\n * Call the `transfer_policy::new` function to create a new transfer policy.\n * Returns `transferPolicyCap`\n */\nexport function createTransferPolicy(\n tx: TransactionBlock,\n itemType: string,\n publisher: ObjectArgument,\n): TransactionArgument {\n let [transferPolicy, transferPolicyCap] = tx.moveCall({\n target: `${TRANSFER_POLICY_MODULE}::new`,\n typeArguments: [itemType],\n arguments: [objArg(tx, publisher)],\n });\n\n tx.moveCall({\n target: `0x2::transfer::public_share_object`,\n typeArguments: [itemType],\n arguments: [transferPolicy],\n });\n\n return transferPolicyCap;\n}\n\n/**\n * Call the `transfer_policy::withdraw` function to withdraw profits from a transfer policy.\n */\nexport function withdrawFromPolicy(\n tx: TransactionBlock,\n itemType: string,\n policy: ObjectArgument,\n policyCap: ObjectArgument,\n amount: string | bigint | null,\n): TransactionArgument {\n let amountArg =\n amount !== null\n ? tx.pure(amount, 'Option<u64>')\n : tx.pure({ None: true }, 'Option<u64>');\n\n let [profits] = tx.moveCall({\n target: `${TRANSFER_POLICY_MODULE}::withdraw`,\n typeArguments: [itemType],\n arguments: [objArg(tx, policy), objArg(tx, policyCap), amountArg],\n });\n\n return profits;\n}\n\n/**\n * Call the `transfer_policy::confirm_request` function to unblock the\n * transaction.\n */\nexport function confirmRequest(\n tx: TransactionBlock,\n itemType: string,\n policy: ObjectArgument,\n request: TransactionArgument,\n): void {\n tx.moveCall({\n target: `${TRANSFER_POLICY_MODULE}::confirm_request`,\n typeArguments: [itemType],\n arguments: [objArg(tx, policy), request],\n });\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 tx: TransactionBlock,\n itemType: string,\n ruleType: string,\n configType: string,\n policy: ObjectArgument,\n policyCap: TransactionArgument,\n): void {\n tx.moveCall({\n target: `${TRANSFER_POLICY_MODULE}::remove_rule`,\n typeArguments: [itemType, ruleType, configType],\n arguments: [objArg(tx, policy), policyCap],\n });\n}\n\n/**\n * Calculates the amount to be paid for the royalty rule to be resolved,\n * splits the coin to pass the exact amount,\n * then calls the `royalty_rule::pay` function to resolve the royalty rule.\n */\nexport function resolveRoyaltyRule(\n tx: TransactionBlock,\n itemType: string,\n price: string,\n policyId: string,\n transferRequest: TransactionArgument,\n) {\n const policyObj = objArg(tx, policyId);\n // calculates the amount\n const [amount] = tx.moveCall({\n target: `${TRANSFER_POLICY_RULES_PACKAGE_ADDRESS}::royalty_rule::fee_amount`,\n typeArguments: [itemType],\n arguments: [policyObj, objArg(tx, price)],\n });\n\n // splits the coin.\n const feeCoin = tx.splitCoins(tx.gas, [amount]);\n\n // pays the policy\n tx.moveCall({\n target: `${TRANSFER_POLICY_RULES_PACKAGE_ADDRESS}::royalty_rule::pay`,\n typeArguments: [itemType],\n arguments: [policyObj, transferRequest, feeCoin],\n });\n}\n","// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport {\n SuiAddress,\n TransactionArgument,\n TransactionBlock,\n} from '@mysten/sui.js';\n\nimport { ObjectArgument, getTypeWithoutPackageAddress, objArg } from '../utils';\nimport { KioskListing } from '../query/kiosk';\nimport { TransferPolicy } from '../bcs';\nimport { confirmRequest, resolveRoyaltyRule } from './transfer-policy';\n\n/** The Kiosk module. */\nexport const KIOSK_MODULE = '0x2::kiosk';\n\n/** The Kiosk type. */\nexport const KIOSK_TYPE = `${KIOSK_MODULE}::Kiosk`;\n\n/** The Kiosk Owner Cap Type */\nexport const KIOSK_OWNER_CAP = `${KIOSK_MODULE}::KioskOwnerCap`;\n\n/**\n * Create a new shared Kiosk and returns the [kiosk, kioskOwnerCap] tuple.\n */\nexport function createKiosk(\n tx: TransactionBlock,\n): [TransactionArgument, TransactionArgument] {\n let [kiosk, kioskOwnerCap] = tx.moveCall({\n target: `${KIOSK_MODULE}::new`,\n });\n\n return [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): TransactionArgument {\n let [kiosk, kioskOwnerCap] = tx.moveCall({\n target: `${KIOSK_MODULE}::new`,\n });\n\n tx.moveCall({\n target: `0x2::transfer::public_share_object`,\n typeArguments: [KIOSK_TYPE],\n arguments: [kiosk],\n });\n\n return kioskOwnerCap;\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 tx: TransactionBlock,\n itemType: string,\n kiosk: ObjectArgument,\n kioskCap: ObjectArgument,\n item: ObjectArgument,\n): void {\n tx.moveCall({\n target: `${KIOSK_MODULE}::place`,\n typeArguments: [itemType],\n arguments: [objArg(tx, kiosk), objArg(tx, kioskCap), objArg(tx, item)],\n });\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 tx: TransactionBlock,\n itemType: string,\n kiosk: ObjectArgument,\n kioskCap: ObjectArgument,\n policy: ObjectArgument,\n item: ObjectArgument,\n): void {\n tx.moveCall({\n target: `${KIOSK_MODULE}::lock`,\n typeArguments: [itemType],\n arguments: [\n objArg(tx, kiosk),\n objArg(tx, kioskCap),\n objArg(tx, policy),\n objArg(tx, item),\n ],\n });\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 tx: TransactionBlock,\n itemType: string,\n kiosk: ObjectArgument,\n kioskCap: ObjectArgument,\n itemId: SuiAddress,\n): TransactionArgument {\n let [item] = tx.moveCall({\n target: `${KIOSK_MODULE}::take`,\n typeArguments: [itemType],\n arguments: [\n objArg(tx, kiosk),\n objArg(tx, kioskCap),\n tx.pure(itemId, 'address'),\n ],\n });\n\n return 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 tx: TransactionBlock,\n itemType: string,\n kiosk: ObjectArgument,\n kioskCap: ObjectArgument,\n itemId: SuiAddress,\n price: string | bigint,\n): void {\n tx.moveCall({\n target: `${KIOSK_MODULE}::list`,\n typeArguments: [itemType],\n arguments: [\n objArg(tx, kiosk),\n objArg(tx, kioskCap),\n tx.pure(itemId, 'address'),\n tx.pure(price, 'u64'),\n ],\n });\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 tx: TransactionBlock,\n itemType: string,\n kiosk: ObjectArgument,\n kioskCap: ObjectArgument,\n itemId: SuiAddress,\n): void {\n tx.moveCall({\n target: `${KIOSK_MODULE}::delist`,\n typeArguments: [itemType],\n arguments: [\n objArg(tx, kiosk),\n objArg(tx, kioskCap),\n tx.pure(itemId, 'address'),\n ],\n });\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 tx: TransactionBlock,\n itemType: string,\n kiosk: ObjectArgument,\n kioskCap: ObjectArgument,\n item: ObjectArgument,\n price: string | bigint,\n): void {\n tx.moveCall({\n target: `${KIOSK_MODULE}::place_and_list`,\n typeArguments: [itemType],\n arguments: [\n objArg(tx, kiosk),\n objArg(tx, kioskCap),\n objArg(tx, item),\n tx.pure(price, 'u64'),\n ],\n });\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 tx: TransactionBlock,\n itemType: string,\n kiosk: ObjectArgument,\n itemId: SuiAddress,\n payment: ObjectArgument,\n): [TransactionArgument, TransactionArgument] {\n let [item, transferRequest] = tx.moveCall({\n target: `${KIOSK_MODULE}::purchase`,\n typeArguments: [itemType],\n arguments: [\n objArg(tx, kiosk),\n tx.pure(itemId, 'address'),\n objArg(tx, payment),\n ],\n });\n\n return [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 tx: TransactionBlock,\n kiosk: ObjectArgument,\n kioskCap: ObjectArgument,\n amount: string | bigint | null,\n): TransactionArgument {\n let amountArg =\n amount !== null\n ? tx.pure(amount, 'Option<u64>')\n : tx.pure({ None: true }, 'Option<u64>');\n\n let [coin] = tx.moveCall({\n target: `${KIOSK_MODULE}::withdraw`,\n arguments: [objArg(tx, kiosk), objArg(tx, kioskCap), amountArg],\n });\n\n return coin;\n}\n\n/**\n * Call the `kiosk::borrow<T>(Kiosk, KioskOwnerCap, ID): &T` function.\n * Immutably borrow an item from the Kiosk.\n */\nexport function borrow(\n tx: TransactionBlock,\n itemType: string,\n kiosk: ObjectArgument,\n kioskCap: ObjectArgument,\n itemId: SuiAddress,\n): TransactionArgument {\n let [item] = tx.moveCall({\n target: `${KIOSK_MODULE}::borrow`,\n typeArguments: [itemType],\n arguments: [\n objArg(tx, kiosk),\n objArg(tx, kioskCap),\n tx.pure(itemId, 'address'),\n ],\n });\n\n return item;\n}\n\n/**\n * Call the `kiosk::borrow_mut<T>(Kiosk, KioskOwnerCap, ID): &mut T` function.\n * Mutably borrow an item from the Kiosk.\n */\nexport function borrowMut(\n tx: TransactionBlock,\n itemType: string,\n kiosk: ObjectArgument,\n kioskCap: ObjectArgument,\n itemId: SuiAddress,\n): TransactionArgument {\n let [item] = tx.moveCall({\n target: `${KIOSK_MODULE}::borrow_mut`,\n typeArguments: [itemType],\n arguments: [\n objArg(tx, kiosk),\n objArg(tx, kioskCap),\n tx.pure(itemId, 'address'),\n ],\n });\n\n return item;\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 tx: TransactionBlock,\n itemType: string,\n kiosk: ObjectArgument,\n kioskCap: ObjectArgument,\n itemId: SuiAddress,\n): [TransactionArgument, TransactionArgument] {\n let [item, promise] = tx.moveCall({\n target: `${KIOSK_MODULE}::borrow_val`,\n typeArguments: [itemType],\n arguments: [\n objArg(tx, kiosk),\n objArg(tx, kioskCap),\n tx.pure(itemId, 'address'),\n ],\n });\n\n return [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 tx: TransactionBlock,\n itemType: string,\n kiosk: ObjectArgument,\n item: TransactionArgument,\n promise: TransactionArgument,\n): void {\n tx.moveCall({\n target: `${KIOSK_MODULE}::return_val`,\n typeArguments: [itemType],\n arguments: [objArg(tx, kiosk), item, promise],\n });\n}\n\n/**\n * Completes the full purchase flow that includes:\n * 1. Purchasing the item.\n * 2. Resolving all the transfer policies (if any).\n * 3. Returns the PurchasedItem OR places the item in the user's kiosk (if there's a kiosk lock policy).\n */\nexport function purchaseAndResolvePolicies(\n tx: TransactionBlock,\n itemType: string,\n listing: KioskListing,\n kioskId: string,\n itemId: string,\n policy: TransferPolicy,\n): TransactionArgument | null {\n // if we don't pass the listing or the listing doens't have a price, return.\n if (!listing || listing?.price === undefined) return null;\n\n // Split the coin for the amount of the listing.\n const coin = tx.splitCoins(tx.gas, [tx.pure(listing.price)]);\n\n // initialize the purchase `kiosk::purchase`\n const [purchasedItem, transferRequest] = purchase(\n tx,\n itemType,\n kioskId,\n itemId,\n coin,\n );\n\n // Start resolving rules.\n // For now, we only support royalty rule.\n // Will need some tweaking to make it function properly with the other\n // ruleset.\n for (let rule of policy.rules) {\n const ruleWithoutAddr = getTypeWithoutPackageAddress(rule);\n\n switch (ruleWithoutAddr) {\n case 'royalty_rule::Rule':\n resolveRoyaltyRule(\n tx,\n itemType,\n listing.price,\n policy.id,\n transferRequest,\n );\n break;\n default:\n break;\n }\n }\n\n // confirm the Transfer Policy request.\n confirmRequest(tx, itemType, policy.id, transferRequest);\n\n return purchasedItem;\n}\n","// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport {\n JsonRpcProvider,\n ObjectId,\n ObjectType,\n PaginationArguments,\n SuiAddress,\n} from '@mysten/sui.js';\nimport {\n attachListingsAndPrices,\n attachLockedItems,\n extractKioskData,\n getKioskObject,\n} from '../utils';\nimport { Kiosk } from '../bcs';\n\n/**\n * A dynamic field `Listing { ID, isExclusive }` attached to the Kiosk.\n * Holds a `u64` value - the price of the item.\n */\nexport type KioskListing = {\n /** The ID of the Item */\n objectId: ObjectId;\n /**\n * Whether or not there's a `PurchaseCap` issued. `true` means that\n * the listing is controlled by some logic and can't be purchased directly.\n *\n * TODO: consider renaming the field for better indication.\n */\n isExclusive: boolean;\n /** The ID of the listing */\n listingId: ObjectId;\n price?: string;\n};\n\n/**\n * A dynamic field `Item { ID }` attached to the Kiosk.\n * Holds an Item `T`. The type of the item is known upfront.\n */\nexport type KioskItem = {\n /** The ID of the Item */\n objectId: ObjectId;\n /** The type of the Item */\n type: ObjectType;\n /** Whether the item is Locked (there must be a `Lock` Dynamic Field) */\n isLocked: boolean;\n /** Optional listing */\n listing?: KioskListing;\n};\n/**\n * Aggregated data from the Kiosk.\n */\nexport type KioskData = {\n items: KioskItem[];\n itemIds: ObjectId[];\n listingIds: ObjectId[];\n kiosk?: Kiosk;\n extensions: any[]; // type will be defined on later versions of the SDK.\n};\n\nexport type PagedKioskData = {\n data: KioskData;\n nextCursor: string | null;\n hasNextPage: boolean;\n};\n\nexport type FetchKioskOptions = {\n withKioskFields?: boolean;\n withListingPrices?: boolean;\n};\n\nexport async function fetchKiosk(\n provider: JsonRpcProvider,\n kioskId: SuiAddress,\n pagination: PaginationArguments<string>,\n options: FetchKioskOptions,\n): Promise<PagedKioskData> {\n const { data, nextCursor, hasNextPage } = await provider.getDynamicFields({\n parentId: kioskId,\n ...pagination,\n });\n\n const listings: KioskListing[] = [];\n const lockedItemIds: ObjectId[] = [];\n\n // extracted kiosk data.\n const kioskData = extractKioskData(data, listings, lockedItemIds);\n\n // split the fetching in two queries as we are most likely passing different options for each kind.\n // For items, we usually seek the Display.\n // For listings we usually seek the DF value (price) / exclusivity.\n const [kiosk, listingObjects] = await Promise.all([\n options.withKioskFields\n ? getKioskObject(provider, kioskId)\n : Promise.resolve(undefined),\n options.withListingPrices\n ? provider.multiGetObjects({\n ids: kioskData.listingIds,\n options: {\n showContent: true,\n },\n })\n : Promise.resolve([]),\n ]);\n\n if (options.withKioskFields) kioskData.kiosk = kiosk;\n // attach items listings. IF we have `options.withListingPrices === true`, it will also attach the prices.\n attachListingsAndPrices(kioskData, listings, listingObjects);\n // add `locked` status to items that are locked.\n attachLockedItems(kioskData, lockedItemIds);\n\n return {\n data: kioskData,\n nextCursor,\n hasNextPage,\n };\n}\n","// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport { JsonRpcProvider } from '@mysten/sui.js';\nimport { TransferPolicy, bcs } from '../bcs';\n\n/** Name of the event emitted when a TransferPolicy for T is created. */\nexport const TRANSFER_POLICY_CREATED_EVENT = `0x2::transfer_policy::TransferPolicyCreated`;\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 provider: JsonRpcProvider,\n type: string,\n): Promise<TransferPolicy[]> {\n // console.log('event type: %s', `${TRANSFER_POLICY_CREATED_EVENT}<${type}>`);\n const { data } = await provider.queryEvents({\n query: {\n MoveEventType: `${TRANSFER_POLICY_CREATED_EVENT}<${type}>`,\n },\n });\n\n const search = data.map((event) => event.parsedJson as { id: string });\n const policies = await provider.multiGetObjects({\n ids: search.map((policy) => policy.id),\n options: { showBcs: true, showOwner: true },\n });\n\n return policies\n .filter((policy) => !!policy && 'data' in policy)\n .map(({ data: policy }) => {\n // should never happen; policies are objects and fetched via an event.\n // policies are filtered for null and undefined above.\n if (!policy || !policy.bcs || !('bcsBytes' in policy.bcs)) {\n throw new Error(\n `Invalid policy: ${policy?.objectId}, expected object, got package`,\n );\n }\n\n let parsed = bcs.de(\n '0x2::transfer_policy::TransferPolicy',\n policy.bcs.bcsBytes,\n 'base64',\n );\n\n return {\n id: policy?.objectId,\n type: `0x2::transfer_policy::TransferPolicy<${type}>`,\n owner: policy?.owner!,\n rules: parsed.rules,\n balance: parsed.balance,\n } as TransferPolicy;\n });\n}\n"],"mappings":";AAGA;AAAA,EAQE;AAAA,OACK;;;ACTP,SAAsB,WAAW;AAcjC,IAAI,mBAAmB,qBAAqB;AAAA,EAC1C,IAAI;AAAA,EACJ,SAAS;AAAA,EACT,OAAO;AAAA,EACP,WAAW;AAAA,EACX,iBAAiB;AACnB,CAAC;AAaD,IAAI,mBAAmB,2BAA2B;AAAA,EAChD,IAAI;AAAA,EACJ,SAAS;AAAA,EACT,QAAQ;AAAA,EACR,UAAU;AACZ,CAAC;AAQD,IAAI,mBAAmB,+CAA+C;AAAA,EACpE,IAAI;AACN,CAAC;AAWD,IAAI,mBAAmB,wCAAwC;AAAA,EAC7D,IAAI;AAAA,EACJ,SAAS;AAAA,EACT,OAAO,CAAC,UAAU,QAAQ;AAC5B,CAAC;;;ADjCM,SAAS,OACd,IACA,KACqB;AACrB,MAAI,OAAO,QAAQ,UAAU;AAC3B,WAAO,GAAG,OAAO,GAAG;AAAA,EACtB;AAEA,MAAI,YAAY,OAAO,aAAa,OAAO,cAAc,KAAK;AAC5D,WAAO,GAAG,UAAU,GAAG;AAAA,EACzB;AAEA,MAAI,cAAc,OAAO,0BAA0B,OAAO,aAAa,KAAK;AAC1E,WAAO,GAAG,gBAAgB,GAAG;AAAA,EAC/B;AAEA,MAAI,UAAU,KAAK;AACjB,WAAO;AAAA,EACT;AAEA,QAAM,IAAI,MAAM,uBAAuB;AACzC;AAEA,eAAsB,eACpB,UACA,IACgB;AAChB,QAAM,WAAW,MAAM,SAAS,UAAU,EAAE,IAAI,SAAS,EAAE,SAAS,KAAK,EAAE,CAAC;AAE5E,MAAI,CAAC,YAAY,SAAS,SAAS,CAAC,SAAS,MAAM;AACjD,UAAM,IAAI,MAAM,SAAS,iBAAiB,SAAS,OAAO;AAAA,EAC5D;AAEA,MAAI,CAAC,SAAS,KAAK,OAAO,EAAE,cAAc,SAAS,KAAK,MAAM;AAC5D,UAAM,IAAI,MAAM,wBAAwB,kCAAkC;AAAA,EAC5E;AAEA,SAAO,IAAI,GAAG,qBAAqB,SAAS,KAAK,IAAK,UAAU,QAAQ;AAC1E;AAGO,SAAS,iBACd,MACA,UACA,eACW;AACX,SAAO,KAAK;AAAA,IACV,CAAC,KAAgB,QAA0B;AACzC,YAAM,OAAO,6BAA6B,IAAI,KAAK,IAAI;AAEvD,cAAQ,MAAM;AAAA,QACZ,KAAK;AACH,cAAI,QAAQ,KAAK,IAAI,QAAQ;AAC7B,cAAI,MAAM,KAAK;AAAA,YACb,UAAU,IAAI;AAAA,YACd,MAAM,IAAI;AAAA,YACV,UAAU;AAAA,UACZ,CAAC;AACD;AAAA,QACF,KAAK;AACH,cAAI,WAAW,KAAK,IAAI,QAAQ;AAChC,mBAAS,KAAK;AAAA,YACZ,UAAU,IAAI,KAAK,MAAM;AAAA,YACzB,WAAW,IAAI;AAAA,YACf,aAAa,IAAI,KAAK,MAAM;AAAA,UAC9B,CAAC;AACD;AAAA,QACF,KAAK;AACH,yBAAe,KAAK,IAAI,KAAK,MAAM,EAAE;AACrC;AAAA,MACJ;AACA,aAAO;AAAA,IACT;AAAA,IACA,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,GAAG,YAAY,CAAC,GAAG,YAAY,CAAC,EAAE;AAAA,EAC3D;AACF;AAGO,IAAM,+BAA+B,CAAC,SAAiB;AAC5D,SAAO,KAAK,MAAM,IAAI,EAAE,MAAM,EAAE,EAAE,KAAK,IAAI;AAC7C;AAKO,IAAM,0BAA0B,CACrC,WACA,UACA,mBACG;AAGH,QAAM,eAAe,SAAS;AAAA,IAC5B,CAAC,KAAqC,MAAM,QAAQ;AAClD,UAAI,KAAK,QAAQ,IAAI,EAAE,GAAG,KAAK;AAI/B,UAAI,eAAe,WAAW;AAAG,eAAO;AAExC,YAAM,OAAO,gBAAgB,eAAe,GAAG,CAAC;AAChD,UAAI,CAAC;AAAM,eAAO;AAElB,UAAI,KAAK,QAAQ,EAAE,QAAQ,KAAK;AAChC,aAAO;AAAA,IACT;AAAA,IACA,CAAC;AAAA,EACH;AAEA,YAAU,MAAM,IAAI,CAAC,SAAS;AAC5B,SAAK,UAAU,aAAa,KAAK,QAAQ,KAAK;AAAA,EAChD,CAAC;AACH;AAKO,IAAM,oBAAoB,CAC/B,WACA,kBACG;AAEH,QAAM,iBAAiB,cAAc;AAAA,IACnC,CAAC,KAAgC,SAAiB;AAChD,UAAI,IAAI,IAAI;AACZ,aAAO;AAAA,IACT;AAAA,IACA,CAAC;AAAA,EACH;AAGA,YAAU,MAAM,IAAI,CAAC,SAAS;AAC5B,SAAK,WAAW,eAAe,KAAK,QAAQ,KAAK;AAAA,EACnD,CAAC;AACH;;;AEhKO,IAAM,yBAAyB;AAI/B,IAAM,wCACX;AAMK,SAAS,qBACd,IACA,UACA,WACqB;AACrB,MAAI,CAAC,gBAAgB,iBAAiB,IAAI,GAAG,SAAS;AAAA,IACpD,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,OAAO,IAAI,SAAS,CAAC;AAAA,EACnC,CAAC;AAED,KAAG,SAAS;AAAA,IACV,QAAQ;AAAA,IACR,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,cAAc;AAAA,EAC5B,CAAC;AAED,SAAO;AACT;AAKO,SAAS,mBACd,IACA,UACA,QACA,WACA,QACqB;AACrB,MAAI,YACF,WAAW,OACP,GAAG,KAAK,QAAQ,aAAa,IAC7B,GAAG,KAAK,EAAE,MAAM,KAAK,GAAG,aAAa;AAE3C,MAAI,CAAC,OAAO,IAAI,GAAG,SAAS;AAAA,IAC1B,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,OAAO,IAAI,MAAM,GAAG,OAAO,IAAI,SAAS,GAAG,SAAS;AAAA,EAClE,CAAC;AAED,SAAO;AACT;AAMO,SAAS,eACd,IACA,UACA,QACA,SACM;AACN,KAAG,SAAS;AAAA,IACV,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,OAAO,IAAI,MAAM,GAAG,OAAO;AAAA,EACzC,CAAC;AACH;AAKO,SAAS,yBACd,IACA,UACA,UACA,YACA,QACA,WACM;AACN,KAAG,SAAS;AAAA,IACV,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,UAAU,UAAU,UAAU;AAAA,IAC9C,WAAW,CAAC,OAAO,IAAI,MAAM,GAAG,SAAS;AAAA,EAC3C,CAAC;AACH;AAOO,SAAS,mBACd,IACA,UACA,OACA,UACA,iBACA;AACA,QAAM,YAAY,OAAO,IAAI,QAAQ;AAErC,QAAM,CAAC,MAAM,IAAI,GAAG,SAAS;AAAA,IAC3B,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,WAAW,OAAO,IAAI,KAAK,CAAC;AAAA,EAC1C,CAAC;AAGD,QAAM,UAAU,GAAG,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC;AAG9C,KAAG,SAAS;AAAA,IACV,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,WAAW,iBAAiB,OAAO;AAAA,EACjD,CAAC;AACH;;;AC/GO,IAAM,eAAe;AAGrB,IAAM,aAAa,GAAG;AAGtB,IAAM,kBAAkB,GAAG;AAK3B,SAAS,YACd,IAC4C;AAC5C,MAAI,CAAC,OAAO,aAAa,IAAI,GAAG,SAAS;AAAA,IACvC,QAAQ,GAAG;AAAA,EACb,CAAC;AAED,SAAO,CAAC,OAAO,aAAa;AAC9B;AAMO,SAAS,oBAAoB,IAA2C;AAC7E,MAAI,CAAC,OAAO,aAAa,IAAI,GAAG,SAAS;AAAA,IACvC,QAAQ,GAAG;AAAA,EACb,CAAC;AAED,KAAG,SAAS;AAAA,IACV,QAAQ;AAAA,IACR,eAAe,CAAC,UAAU;AAAA,IAC1B,WAAW,CAAC,KAAK;AAAA,EACnB,CAAC;AAED,SAAO;AACT;AAMO,SAAS,MACd,IACA,UACA,OACA,UACA,MACM;AACN,KAAG,SAAS;AAAA,IACV,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,OAAO,IAAI,KAAK,GAAG,OAAO,IAAI,QAAQ,GAAG,OAAO,IAAI,IAAI,CAAC;AAAA,EACvE,CAAC;AACH;AAUO,SAAS,KACd,IACA,UACA,OACA,UACA,QACA,MACM;AACN,KAAG,SAAS;AAAA,IACV,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW;AAAA,MACT,OAAO,IAAI,KAAK;AAAA,MAChB,OAAO,IAAI,QAAQ;AAAA,MACnB,OAAO,IAAI,MAAM;AAAA,MACjB,OAAO,IAAI,IAAI;AAAA,IACjB;AAAA,EACF,CAAC;AACH;AAMO,SAAS,KACd,IACA,UACA,OACA,UACA,QACqB;AACrB,MAAI,CAAC,IAAI,IAAI,GAAG,SAAS;AAAA,IACvB,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW;AAAA,MACT,OAAO,IAAI,KAAK;AAAA,MAChB,OAAO,IAAI,QAAQ;AAAA,MACnB,GAAG,KAAK,QAAQ,SAAS;AAAA,IAC3B;AAAA,EACF,CAAC;AAED,SAAO;AACT;AAMO,SAAS,KACd,IACA,UACA,OACA,UACA,QACA,OACM;AACN,KAAG,SAAS;AAAA,IACV,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW;AAAA,MACT,OAAO,IAAI,KAAK;AAAA,MAChB,OAAO,IAAI,QAAQ;AAAA,MACnB,GAAG,KAAK,QAAQ,SAAS;AAAA,MACzB,GAAG,KAAK,OAAO,KAAK;AAAA,IACtB;AAAA,EACF,CAAC;AACH;AAMO,SAAS,OACd,IACA,UACA,OACA,UACA,QACM;AACN,KAAG,SAAS;AAAA,IACV,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW;AAAA,MACT,OAAO,IAAI,KAAK;AAAA,MAChB,OAAO,IAAI,QAAQ;AAAA,MACnB,GAAG,KAAK,QAAQ,SAAS;AAAA,IAC3B;AAAA,EACF,CAAC;AACH;AAMO,SAAS,aACd,IACA,UACA,OACA,UACA,MACA,OACM;AACN,KAAG,SAAS;AAAA,IACV,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW;AAAA,MACT,OAAO,IAAI,KAAK;AAAA,MAChB,OAAO,IAAI,QAAQ;AAAA,MACnB,OAAO,IAAI,IAAI;AAAA,MACf,GAAG,KAAK,OAAO,KAAK;AAAA,IACtB;AAAA,EACF,CAAC;AACH;AAMO,SAAS,SACd,IACA,UACA,OACA,QACA,SAC4C;AAC5C,MAAI,CAAC,MAAM,eAAe,IAAI,GAAG,SAAS;AAAA,IACxC,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW;AAAA,MACT,OAAO,IAAI,KAAK;AAAA,MAChB,GAAG,KAAK,QAAQ,SAAS;AAAA,MACzB,OAAO,IAAI,OAAO;AAAA,IACpB;AAAA,EACF,CAAC;AAED,SAAO,CAAC,MAAM,eAAe;AAC/B;AAMO,SAAS,kBACd,IACA,OACA,UACA,QACqB;AACrB,MAAI,YACF,WAAW,OACP,GAAG,KAAK,QAAQ,aAAa,IAC7B,GAAG,KAAK,EAAE,MAAM,KAAK,GAAG,aAAa;AAE3C,MAAI,CAAC,IAAI,IAAI,GAAG,SAAS;AAAA,IACvB,QAAQ,GAAG;AAAA,IACX,WAAW,CAAC,OAAO,IAAI,KAAK,GAAG,OAAO,IAAI,QAAQ,GAAG,SAAS;AAAA,EAChE,CAAC;AAED,SAAO;AACT;AAMO,SAAS,OACd,IACA,UACA,OACA,UACA,QACqB;AACrB,MAAI,CAAC,IAAI,IAAI,GAAG,SAAS;AAAA,IACvB,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW;AAAA,MACT,OAAO,IAAI,KAAK;AAAA,MAChB,OAAO,IAAI,QAAQ;AAAA,MACnB,GAAG,KAAK,QAAQ,SAAS;AAAA,IAC3B;AAAA,EACF,CAAC;AAED,SAAO;AACT;AAMO,SAAS,UACd,IACA,UACA,OACA,UACA,QACqB;AACrB,MAAI,CAAC,IAAI,IAAI,GAAG,SAAS;AAAA,IACvB,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW;AAAA,MACT,OAAO,IAAI,KAAK;AAAA,MAChB,OAAO,IAAI,QAAQ;AAAA,MACnB,GAAG,KAAK,QAAQ,SAAS;AAAA,IAC3B;AAAA,EACF,CAAC;AAED,SAAO;AACT;AAQO,SAAS,YACd,IACA,UACA,OACA,UACA,QAC4C;AAC5C,MAAI,CAAC,MAAM,OAAO,IAAI,GAAG,SAAS;AAAA,IAChC,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW;AAAA,MACT,OAAO,IAAI,KAAK;AAAA,MAChB,OAAO,IAAI,QAAQ;AAAA,MACnB,GAAG,KAAK,QAAQ,SAAS;AAAA,IAC3B;AAAA,EACF,CAAC;AAED,SAAO,CAAC,MAAM,OAAO;AACvB;AAMO,SAAS,YACd,IACA,UACA,OACA,MACA,SACM;AACN,KAAG,SAAS;AAAA,IACV,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,OAAO,IAAI,KAAK,GAAG,MAAM,OAAO;AAAA,EAC9C,CAAC;AACH;AAQO,SAAS,2BACd,IACA,UACA,SACA,SACA,QACA,QAC4B;AAE5B,MAAI,CAAC,WAAW,SAAS,UAAU;AAAW,WAAO;AAGrD,QAAM,OAAO,GAAG,WAAW,GAAG,KAAK,CAAC,GAAG,KAAK,QAAQ,KAAK,CAAC,CAAC;AAG3D,QAAM,CAAC,eAAe,eAAe,IAAI;AAAA,IACvC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAMA,WAAS,QAAQ,OAAO,OAAO;AAC7B,UAAM,kBAAkB,6BAA6B,IAAI;AAEzD,YAAQ,iBAAiB;AAAA,MACvB,KAAK;AACH;AAAA,UACE;AAAA,UACA;AAAA,UACA,QAAQ;AAAA,UACR,OAAO;AAAA,UACP;AAAA,QACF;AACA;AAAA,MACF;AACE;AAAA,IACJ;AAAA,EACF;AAGA,iBAAe,IAAI,UAAU,OAAO,IAAI,eAAe;AAEvD,SAAO;AACT;;;AC3TA,eAAsB,WACpB,UACA,SACA,YACA,SACyB;AACzB,QAAM,EAAE,MAAM,YAAY,YAAY,IAAI,MAAM,SAAS,iBAAiB;AAAA,IACxE,UAAU;AAAA,IACV,GAAG;AAAA,EACL,CAAC;AAED,QAAM,WAA2B,CAAC;AAClC,QAAM,gBAA4B,CAAC;AAGnC,QAAM,YAAY,iBAAiB,MAAM,UAAU,aAAa;AAKhE,QAAM,CAAC,OAAO,cAAc,IAAI,MAAM,QAAQ,IAAI;AAAA,IAChD,QAAQ,kBACJ,eAAe,UAAU,OAAO,IAChC,QAAQ,QAAQ,MAAS;AAAA,IAC7B,QAAQ,oBACJ,SAAS,gBAAgB;AAAA,MACvB,KAAK,UAAU;AAAA,MACf,SAAS;AAAA,QACP,aAAa;AAAA,MACf;AAAA,IACF,CAAC,IACD,QAAQ,QAAQ,CAAC,CAAC;AAAA,EACxB,CAAC;AAED,MAAI,QAAQ;AAAiB,cAAU,QAAQ;AAE/C,0BAAwB,WAAW,UAAU,cAAc;AAE3D,oBAAkB,WAAW,aAAa;AAE1C,SAAO;AAAA,IACL,MAAM;AAAA,IACN;AAAA,IACA;AAAA,EACF;AACF;;;AC/GO,IAAM,gCAAgC;AAW7C,eAAsB,oBACpB,UACA,MAC2B;AAE3B,QAAM,EAAE,KAAK,IAAI,MAAM,SAAS,YAAY;AAAA,IAC1C,OAAO;AAAA,MACL,eAAe,GAAG,iCAAiC;AAAA,IACrD;AAAA,EACF,CAAC;AAED,QAAM,SAAS,KAAK,IAAI,CAAC,UAAU,MAAM,UAA4B;AACrE,QAAM,WAAW,MAAM,SAAS,gBAAgB;AAAA,IAC9C,KAAK,OAAO,IAAI,CAAC,WAAW,OAAO,EAAE;AAAA,IACrC,SAAS,EAAE,SAAS,MAAM,WAAW,KAAK;AAAA,EAC5C,CAAC;AAED,SAAO,SACJ,OAAO,CAAC,WAAW,CAAC,CAAC,UAAU,UAAU,MAAM,EAC/C,IAAI,CAAC,EAAE,MAAM,OAAO,MAAM;AAGzB,QAAI,CAAC,UAAU,CAAC,OAAO,OAAO,EAAE,cAAc,OAAO,MAAM;AACzD,YAAM,IAAI;AAAA,QACR,mBAAmB,QAAQ;AAAA,MAC7B;AAAA,IACF;AAEA,QAAI,SAAS,IAAI;AAAA,MACf;AAAA,MACA,OAAO,IAAI;AAAA,MACX;AAAA,IACF;AAEA,WAAO;AAAA,MACL,IAAI,QAAQ;AAAA,MACZ,MAAM,wCAAwC;AAAA,MAC9C,OAAO,QAAQ;AAAA,MACf,OAAO,OAAO;AAAA,MACd,SAAS,OAAO;AAAA,IAClB;AAAA,EACF,CAAC;AACL;","names":[]}
|
|
1
|
+
{"version":3,"sources":["../src/utils.ts","../src/bcs.ts","../src/types/kiosk.ts","../src/types/transfer-policy.ts","../src/types/env.ts","../src/constants.ts","../src/tx/transfer-policy.ts","../src/tx/kiosk.ts","../src/query/kiosk.ts","../src/query/transfer-policy.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport {\n JsonRpcProvider,\n ObjectId,\n SharedObjectRef,\n SuiObjectRef,\n SuiObjectResponse,\n TransactionArgument,\n TransactionBlock,\n getObjectFields,\n} from '@mysten/sui.js';\nimport { KioskData, KioskListing } from './query/kiosk';\nimport { DynamicFieldInfo } from '@mysten/sui.js/dist/types/dynamic_fields';\nimport { bcs } from './bcs';\nimport { KIOSK_TYPE, Kiosk, RulesEnvironmentParam } from './types';\nimport {\n MAINNET_RULES_PACKAGE_ADDRESS,\n TESTNET_RULES_PACKAGE_ADDRESS,\n} from './constants';\n\n/* A simple map to the rule package addresses */\n// TODO: Supply the mainnet and devnet addresses.\nexport const rulesPackageAddresses = {\n mainnet: MAINNET_RULES_PACKAGE_ADDRESS,\n testnet: TESTNET_RULES_PACKAGE_ADDRESS,\n devnet: '',\n custom: null,\n};\n\n/**\n * Convert any valid input into a TransactionArgument.\n *\n * @param tx The transaction to use for creating the argument.\n * @param arg The argument to convert.\n * @returns The converted TransactionArgument.\n */\nexport function objArg(\n tx: TransactionBlock,\n arg: string | SharedObjectRef | SuiObjectRef | TransactionArgument,\n): TransactionArgument {\n if (typeof arg === 'string') {\n return tx.object(arg);\n }\n\n if ('digest' in arg && 'version' in arg && 'objectId' in arg) {\n return tx.objectRef(arg);\n }\n\n if ('objectId' in arg && 'initialSharedVersion' in arg && 'mutable' in arg) {\n return tx.sharedObjectRef(arg);\n }\n\n if ('kind' in arg) {\n return arg;\n }\n\n throw new Error('Invalid argument type');\n}\n\nexport async function getKioskObject(\n provider: JsonRpcProvider,\n id: string,\n): Promise<Kiosk> {\n const queryRes = await provider.getObject({ id, options: { showBcs: true } });\n\n if (!queryRes || queryRes.error || !queryRes.data) {\n throw new Error(`Kiosk ${id} not found; ${queryRes.error}`);\n }\n\n if (!queryRes.data.bcs || !('bcsBytes' in queryRes.data.bcs)) {\n throw new Error(`Invalid kiosk query: ${id}, expected object, got package`);\n }\n\n return bcs.de(KIOSK_TYPE, queryRes.data.bcs!.bcsBytes, 'base64');\n}\n\n// helper to extract kiosk data from dynamic fields.\nexport function extractKioskData(\n data: DynamicFieldInfo[],\n listings: KioskListing[],\n lockedItemIds: string[],\n): KioskData {\n return data.reduce<KioskData>(\n (acc: KioskData, val: DynamicFieldInfo) => {\n const type = getTypeWithoutPackageAddress(val.name.type);\n\n switch (type) {\n case 'kiosk::Item':\n acc.itemIds.push(val.objectId);\n acc.items.push({\n objectId: val.objectId,\n type: val.objectType,\n isLocked: false,\n });\n break;\n case 'kiosk::Listing':\n acc.listingIds.push(val.objectId);\n listings.push({\n objectId: val.name.value.id,\n listingId: val.objectId,\n isExclusive: val.name.value.is_exclusive,\n });\n break;\n case 'kiosk::Lock':\n lockedItemIds?.push(val.name.value.id);\n break;\n }\n return acc;\n },\n { items: [], itemIds: [], listingIds: [], extensions: [] },\n );\n}\n\n// e.g. 0x2::kiosk::Item -> kiosk::Item\nexport function getTypeWithoutPackageAddress(type: string) {\n return type.split('::').slice(-2).join('::');\n}\n\n/**\n * A helper that attaches the listing prices to kiosk listings.\n */\nexport function attachListingsAndPrices(\n kioskData: KioskData,\n listings: KioskListing[],\n listingObjects: SuiObjectResponse[],\n) {\n // map item listings as {item_id: KioskListing}\n // for easier mapping on the nex\n const itemListings = listings.reduce<Record<ObjectId, KioskListing>>(\n (acc: Record<ObjectId, KioskListing>, item, idx) => {\n acc[item.objectId] = { ...item };\n\n // return in case we don't have any listing objects.\n // that's the case when we don't have the `listingPrices` included.\n if (listingObjects.length === 0) return acc;\n\n const data = getObjectFields(listingObjects[idx]);\n if (!data) return acc;\n\n acc[item.objectId].price = data.value;\n return acc;\n },\n {},\n );\n\n kioskData.items.map((item) => {\n item.listing = itemListings[item.objectId] || undefined;\n });\n}\n\n/**\n * A Helper to attach locked state to items in Kiosk Data.\n */\nexport function attachLockedItems(\n kioskData: KioskData,\n lockedItemIds: ObjectId[],\n) {\n // map lock status in an array of type { item_id: true }\n const lockedStatuses = lockedItemIds.reduce<Record<ObjectId, boolean>>(\n (acc: Record<ObjectId, boolean>, item: string) => {\n acc[item] = true;\n return acc;\n },\n {},\n );\n\n // parse lockedItemIds and attach their locked status.\n kioskData.items.map((item) => {\n item.isLocked = lockedStatuses[item.objectId] || false;\n });\n}\n\n/**\n * A helper to get a rule's environment address.\n */\nexport function getRulePackageAddress(\n environment: RulesEnvironmentParam,\n): string {\n // if we have custom environment, we return it.\n if (environment.env === 'custom') {\n if (!environment.address)\n throw new Error('Please supply the custom package address for rules.');\n return environment.address;\n }\n return rulesPackageAddresses[environment.env];\n}\n","// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport { bcs } from '@mysten/sui.js';\nimport {\n KIOSK_PURCHASE_CAP,\n KIOSK_TYPE,\n TRANSFER_POLICY_CREATED_EVENT,\n TRANSFER_POLICY_TYPE,\n} from './types';\n\n// Register the `Kiosk` struct for faster queries.\nbcs.registerStructType(KIOSK_TYPE, {\n id: 'address',\n profits: 'u64',\n owner: 'address',\n itemCount: 'u32',\n allowExtensions: 'bool',\n});\n\n// Register the `PurchaseCap` for faster queries.\nbcs.registerStructType(KIOSK_PURCHASE_CAP, {\n id: 'address',\n kioskId: 'address',\n itemId: 'address',\n minPrice: 'u64',\n});\n\n// Register the `TransferPolicyCreated` event data.\nbcs.registerStructType(TRANSFER_POLICY_CREATED_EVENT, {\n id: 'address',\n});\n\nbcs.registerStructType(TRANSFER_POLICY_TYPE, {\n id: 'address',\n balance: 'u64',\n rules: ['vector', 'string'],\n});\n\nexport { bcs };\n","// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport { TransactionArgument } from '@mysten/sui.js';\nimport { ObjectArgument } from '.';\n\n/** The Kiosk module. */\nexport const KIOSK_MODULE = '0x2::kiosk';\n\n/** The Kiosk type. */\nexport const KIOSK_TYPE = `${KIOSK_MODULE}::Kiosk`;\n\n/** The Kiosk Owner Cap Type */\nexport const KIOSK_OWNER_CAP = `${KIOSK_MODULE}::KioskOwnerCap`;\n\n/** The Kiosk Item Type */\nexport const KIOSK_ITEM = `${KIOSK_MODULE}::Item`;\n\n/** The Kiosk Listing Type */\nexport const KIOSK_LISTING = `${KIOSK_MODULE}::Listing`;\n\n/** The Kiosk Lock Type */\nexport const KIOSK_LOCK = `${KIOSK_MODULE}::Lock`;\n\n/** The Kiosk PurchaseCap type */\nexport const KIOSK_PURCHASE_CAP = `${KIOSK_MODULE}::PurchaseCap`;\n\n/**\n * The Kiosk object fields (for BCS queries).\n */\nexport type Kiosk = {\n id: string;\n profits: string;\n owner: string;\n itemCount: number;\n allowExtensions: boolean;\n};\n\n/**\n * PurchaseCap object fields (for BCS queries).\n */\nexport type PurchaseCap = {\n id: string;\n kioskId: string;\n itemId: string;\n minPrice: string;\n};\n\n/**\n * The response type of a successful purchase flow.\n * Returns the item, and a `canTransfer` param.\n */\nexport type PurchaseAndResolvePoliciesResponse = {\n item: TransactionArgument;\n canTransfer: boolean;\n};\n\n/**\n * Optional parameters for `purchaseAndResolvePolicies` flow.\n * This gives us the chance to extend the function in further releases\n * without introducing more breaking changes.\n */\nexport type PurchaseOptionalParams = {\n ownedKiosk?: ObjectArgument;\n ownedKioskCap?: ObjectArgument;\n};\n","// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport { ObjectOwner } from '@mysten/sui.js';\n\n/** The Transfer Policy module. */\nexport const TRANSFER_POLICY_MODULE = '0x2::transfer_policy';\n\n/** Name of the event emitted when a TransferPolicy for T is created. */\nexport const TRANSFER_POLICY_CREATED_EVENT = `${TRANSFER_POLICY_MODULE}::TransferPolicyCreated`;\n\n/** The Transfer Policy Type */\nexport const TRANSFER_POLICY_TYPE = `${TRANSFER_POLICY_MODULE}::TransferPolicy`;\n\n/** The Kiosk Lock Rule */\nexport const KIOSK_LOCK_RULE = 'kiosk_lock_rule::Rule';\n\n/** The Royalty rule */\nexport const ROYALTY_RULE = 'royalty_rule::Rule';\n\n/** The `TransferPolicy` object */\nexport type TransferPolicy = {\n id: string;\n type: string;\n balance: string;\n rules: string[];\n owner: ObjectOwner;\n};\n\n/** Event emitted when a TransferPolicy is created. */\nexport type TransferPolicyCreated = {\n id: string;\n};\n","// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport { SuiAddress } from '@mysten/sui.js';\n\n/* A list of environments. */\nexport type Environment = 'mainnet' | 'testnet' | 'devnet' | 'custom';\n\n/** A Parameter to support enivronments for rules. */\nexport type RulesEnvironmentParam = { env: Environment; address?: SuiAddress };\n\n/** A default Testnet Environment object */\nexport const testnetEnvironment: RulesEnvironmentParam = { env: 'testnet' };\n\n/** A default Mainnet Environment object */\nexport const mainnetEnvironment: RulesEnvironmentParam = { env: 'mainnet' };\n\n/** A helper to easily export a custom environment */\nexport const customEnvironment = (address: string): RulesEnvironmentParam => ({\n env: 'custom',\n address,\n});\n","// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\n/** The Transer Policy Rules package address on testnet */\nexport const TESTNET_RULES_PACKAGE_ADDRESS =\n 'bd8fc1947cf119350184107a3087e2dc27efefa0dd82e25a1f699069fe81a585';\n\n/** The transfer policy rules package address on mainnet */\nexport const MAINNET_RULES_PACKAGE_ADDRESS =\n '0x434b5bd8f6a7b05fede0ff46c6e511d71ea326ed38056e3bcd681d2d7c2a7879';\n","// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport { TransactionArgument, TransactionBlock } from '@mysten/sui.js';\nimport { getRulePackageAddress, objArg } from '../utils';\nimport { lock } from './kiosk';\nimport {\n ObjectArgument,\n RulesEnvironmentParam,\n TRANSFER_POLICY_MODULE,\n} from '../types';\n\n/**\n * Call the `transfer_policy::new` function to create a new transfer policy.\n * Returns `transferPolicyCap`\n */\nexport function createTransferPolicy(\n tx: TransactionBlock,\n itemType: string,\n publisher: ObjectArgument,\n): TransactionArgument {\n let [transferPolicy, transferPolicyCap] = tx.moveCall({\n target: `${TRANSFER_POLICY_MODULE}::new`,\n typeArguments: [itemType],\n arguments: [objArg(tx, publisher)],\n });\n\n tx.moveCall({\n target: `0x2::transfer::public_share_object`,\n typeArguments: [itemType],\n arguments: [transferPolicy],\n });\n\n return transferPolicyCap;\n}\n\n/**\n * Call the `transfer_policy::withdraw` function to withdraw profits from a transfer policy.\n */\nexport function withdrawFromPolicy(\n tx: TransactionBlock,\n itemType: string,\n policy: ObjectArgument,\n policyCap: ObjectArgument,\n amount: string | bigint | null,\n): TransactionArgument {\n let amountArg =\n amount !== null\n ? tx.pure({ Some: amount }, 'Option<u64>')\n : tx.pure({ None: true }, 'Option<u64>');\n\n let [profits] = tx.moveCall({\n target: `${TRANSFER_POLICY_MODULE}::withdraw`,\n typeArguments: [itemType],\n arguments: [objArg(tx, policy), objArg(tx, policyCap), amountArg],\n });\n\n return profits;\n}\n\n/**\n * Call the `transfer_policy::confirm_request` function to unblock the\n * transaction.\n */\nexport function confirmRequest(\n tx: TransactionBlock,\n itemType: string,\n policy: ObjectArgument,\n request: TransactionArgument,\n): void {\n tx.moveCall({\n target: `${TRANSFER_POLICY_MODULE}::confirm_request`,\n typeArguments: [itemType],\n arguments: [objArg(tx, policy), request],\n });\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 tx: TransactionBlock,\n itemType: string,\n ruleType: string,\n configType: string,\n policy: ObjectArgument,\n policyCap: TransactionArgument,\n): void {\n tx.moveCall({\n target: `${TRANSFER_POLICY_MODULE}::remove_rule`,\n typeArguments: [itemType, ruleType, configType],\n arguments: [objArg(tx, policy), policyCap],\n });\n}\n\n/**\n * Calculates the amount to be paid for the royalty rule to be resolved,\n * splits the coin to pass the exact amount,\n * then calls the `royalty_rule::pay` function to resolve the royalty rule.\n */\nexport function resolveRoyaltyRule(\n tx: TransactionBlock,\n itemType: string,\n price: string,\n policyId: ObjectArgument,\n transferRequest: TransactionArgument,\n environment: RulesEnvironmentParam,\n) {\n const policyObj = objArg(tx, policyId);\n // calculates the amount\n const [amount] = tx.moveCall({\n target: `${getRulePackageAddress(environment)}::royalty_rule::fee_amount`,\n typeArguments: [itemType],\n arguments: [policyObj, objArg(tx, price)],\n });\n\n // splits the coin.\n const feeCoin = tx.splitCoins(tx.gas, [amount]);\n\n // pays the policy\n tx.moveCall({\n target: `${getRulePackageAddress(environment)}::royalty_rule::pay`,\n typeArguments: [itemType],\n arguments: [policyObj, transferRequest, feeCoin],\n });\n}\n\n/**\n * Locks the item in the supplied kiosk and\n * proves to the `kiosk_lock` rule that the item was indeed locked,\n * by calling the `kiosk_lock_rule::prove` function to resolve it.\n */\nexport function resolveKioskLockRule(\n tx: TransactionBlock,\n itemType: string,\n item: TransactionArgument,\n kiosk: ObjectArgument,\n kioskCap: ObjectArgument,\n policyId: ObjectArgument,\n transferRequest: TransactionArgument,\n environment: RulesEnvironmentParam,\n) {\n // lock item in the kiosk.\n lock(tx, itemType, kiosk, kioskCap, policyId, item);\n\n // proves that the item is locked in the kiosk to the TP.\n tx.moveCall({\n target: `${getRulePackageAddress(environment)}::kiosk_lock_rule::prove`,\n typeArguments: [itemType],\n arguments: [transferRequest, objArg(tx, kiosk)],\n });\n}\n","// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport {\n SuiAddress,\n TransactionArgument,\n TransactionBlock,\n} from '@mysten/sui.js';\n\nimport { getTypeWithoutPackageAddress, objArg } from '../utils';\nimport {\n confirmRequest,\n resolveKioskLockRule,\n resolveRoyaltyRule,\n} from './transfer-policy';\nimport {\n KIOSK_LOCK_RULE,\n KIOSK_MODULE,\n KIOSK_TYPE,\n ObjectArgument,\n PurchaseAndResolvePoliciesResponse,\n PurchaseOptionalParams,\n ROYALTY_RULE,\n RulesEnvironmentParam,\n TransferPolicy,\n} from '../types';\n\n/**\n * Create a new shared Kiosk and returns the [kiosk, kioskOwnerCap] tuple.\n */\nexport function createKiosk(\n tx: TransactionBlock,\n): [TransactionArgument, TransactionArgument] {\n let [kiosk, kioskOwnerCap] = tx.moveCall({\n target: `${KIOSK_MODULE}::new`,\n });\n\n return [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): TransactionArgument {\n let [kiosk, kioskOwnerCap] = tx.moveCall({\n target: `${KIOSK_MODULE}::new`,\n });\n\n tx.moveCall({\n target: `0x2::transfer::public_share_object`,\n typeArguments: [KIOSK_TYPE],\n arguments: [kiosk],\n });\n\n return kioskOwnerCap;\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 tx: TransactionBlock,\n itemType: string,\n kiosk: ObjectArgument,\n kioskCap: ObjectArgument,\n item: ObjectArgument,\n): void {\n tx.moveCall({\n target: `${KIOSK_MODULE}::place`,\n typeArguments: [itemType],\n arguments: [objArg(tx, kiosk), objArg(tx, kioskCap), objArg(tx, item)],\n });\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 tx: TransactionBlock,\n itemType: string,\n kiosk: ObjectArgument,\n kioskCap: ObjectArgument,\n policy: ObjectArgument,\n item: ObjectArgument,\n): void {\n tx.moveCall({\n target: `${KIOSK_MODULE}::lock`,\n typeArguments: [itemType],\n arguments: [\n objArg(tx, kiosk),\n objArg(tx, kioskCap),\n objArg(tx, policy),\n objArg(tx, item),\n ],\n });\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 tx: TransactionBlock,\n itemType: string,\n kiosk: ObjectArgument,\n kioskCap: ObjectArgument,\n itemId: SuiAddress,\n): TransactionArgument {\n let [item] = tx.moveCall({\n target: `${KIOSK_MODULE}::take`,\n typeArguments: [itemType],\n arguments: [\n objArg(tx, kiosk),\n objArg(tx, kioskCap),\n tx.pure(itemId, 'address'),\n ],\n });\n\n return 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 tx: TransactionBlock,\n itemType: string,\n kiosk: ObjectArgument,\n kioskCap: ObjectArgument,\n itemId: SuiAddress,\n price: string | bigint,\n): void {\n tx.moveCall({\n target: `${KIOSK_MODULE}::list`,\n typeArguments: [itemType],\n arguments: [\n objArg(tx, kiosk),\n objArg(tx, kioskCap),\n tx.pure(itemId, 'address'),\n tx.pure(price, 'u64'),\n ],\n });\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 tx: TransactionBlock,\n itemType: string,\n kiosk: ObjectArgument,\n kioskCap: ObjectArgument,\n itemId: SuiAddress,\n): void {\n tx.moveCall({\n target: `${KIOSK_MODULE}::delist`,\n typeArguments: [itemType],\n arguments: [\n objArg(tx, kiosk),\n objArg(tx, kioskCap),\n tx.pure(itemId, 'address'),\n ],\n });\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 tx: TransactionBlock,\n itemType: string,\n kiosk: ObjectArgument,\n kioskCap: ObjectArgument,\n item: ObjectArgument,\n price: string | bigint,\n): void {\n tx.moveCall({\n target: `${KIOSK_MODULE}::place_and_list`,\n typeArguments: [itemType],\n arguments: [\n objArg(tx, kiosk),\n objArg(tx, kioskCap),\n objArg(tx, item),\n tx.pure(price, 'u64'),\n ],\n });\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 tx: TransactionBlock,\n itemType: string,\n kiosk: ObjectArgument,\n itemId: SuiAddress,\n payment: ObjectArgument,\n): [TransactionArgument, TransactionArgument] {\n let [item, transferRequest] = tx.moveCall({\n target: `${KIOSK_MODULE}::purchase`,\n typeArguments: [itemType],\n arguments: [\n objArg(tx, kiosk),\n tx.pure(itemId, 'address'),\n objArg(tx, payment),\n ],\n });\n\n return [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 tx: TransactionBlock,\n kiosk: ObjectArgument,\n kioskCap: ObjectArgument,\n amount: string | bigint | null,\n): TransactionArgument {\n let amountArg =\n amount !== null\n ? tx.pure(\n {\n Some: amount,\n },\n 'Option<u64>',\n )\n : tx.pure({ None: true }, 'Option<u64>');\n\n let [coin] = tx.moveCall({\n target: `${KIOSK_MODULE}::withdraw`,\n arguments: [objArg(tx, kiosk), objArg(tx, kioskCap), amountArg],\n });\n\n return coin;\n}\n\n/**\n * Call the `kiosk::borrow<T>(Kiosk, KioskOwnerCap, ID): &T` function.\n * Immutably borrow an item from the Kiosk.\n */\nexport function borrow(\n tx: TransactionBlock,\n itemType: string,\n kiosk: ObjectArgument,\n kioskCap: ObjectArgument,\n itemId: SuiAddress,\n): TransactionArgument {\n let [item] = tx.moveCall({\n target: `${KIOSK_MODULE}::borrow`,\n typeArguments: [itemType],\n arguments: [\n objArg(tx, kiosk),\n objArg(tx, kioskCap),\n tx.pure(itemId, 'address'),\n ],\n });\n\n return item;\n}\n\n/**\n * Call the `kiosk::borrow_mut<T>(Kiosk, KioskOwnerCap, ID): &mut T` function.\n * Mutably borrow an item from the Kiosk.\n */\nexport function borrowMut(\n tx: TransactionBlock,\n itemType: string,\n kiosk: ObjectArgument,\n kioskCap: ObjectArgument,\n itemId: SuiAddress,\n): TransactionArgument {\n let [item] = tx.moveCall({\n target: `${KIOSK_MODULE}::borrow_mut`,\n typeArguments: [itemType],\n arguments: [\n objArg(tx, kiosk),\n objArg(tx, kioskCap),\n tx.pure(itemId, 'address'),\n ],\n });\n\n return item;\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 tx: TransactionBlock,\n itemType: string,\n kiosk: ObjectArgument,\n kioskCap: ObjectArgument,\n itemId: SuiAddress,\n): [TransactionArgument, TransactionArgument] {\n let [item, promise] = tx.moveCall({\n target: `${KIOSK_MODULE}::borrow_val`,\n typeArguments: [itemType],\n arguments: [\n objArg(tx, kiosk),\n objArg(tx, kioskCap),\n tx.pure(itemId, 'address'),\n ],\n });\n\n return [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 tx: TransactionBlock,\n itemType: string,\n kiosk: ObjectArgument,\n item: TransactionArgument,\n promise: TransactionArgument,\n): void {\n tx.moveCall({\n target: `${KIOSK_MODULE}::return_val`,\n typeArguments: [itemType],\n arguments: [objArg(tx, kiosk), item, promise],\n });\n}\n\n/**\n * Completes the full purchase flow that includes:\n * 1. Purchasing the item.\n * 2. Resolving all the transfer policies (if any).\n * 3. Returns the item and whether the user can transfer it or not.\n *\n * If the item can be transferred, there's an extra transaction required by the user\n * to transfer it to an address or place it in their kiosk.\n */\nexport function purchaseAndResolvePolicies(\n tx: TransactionBlock,\n itemType: string,\n price: string,\n kiosk: ObjectArgument,\n itemId: SuiAddress,\n policy: TransferPolicy,\n environment: RulesEnvironmentParam,\n extraParams?: PurchaseOptionalParams,\n): PurchaseAndResolvePoliciesResponse {\n // if we don't pass the listing or the listing doens't have a price, return.\n if (price === undefined || typeof price !== 'string')\n throw new Error(`Price of the listing is not supplied.`);\n\n // Split the coin for the amount of the listing.\n const coin = tx.splitCoins(tx.gas, [tx.pure(price, 'u64')]);\n\n // initialize the purchase `kiosk::purchase`\n const [purchasedItem, transferRequest] = purchase(\n tx,\n itemType,\n kiosk,\n itemId,\n coin,\n );\n\n // Start resolving rules.\n // Right now we support `kiosk_lock_rule` and `royalty_rule`.\n // They can also be supplied in parallel (supports combination).\n let hasKioskLockRule = false;\n\n for (let rule of policy.rules) {\n const ruleWithoutAddr = getTypeWithoutPackageAddress(rule);\n\n switch (ruleWithoutAddr) {\n case ROYALTY_RULE:\n resolveRoyaltyRule(\n tx,\n itemType,\n price,\n policy.id,\n transferRequest,\n environment,\n );\n break;\n case KIOSK_LOCK_RULE:\n if (!extraParams?.ownedKiosk || !extraParams?.ownedKioskCap)\n throw new Error(\n `This item type ${itemType} has a 'kiosk_lock_rule', but function call is missing user's kiosk and kioskCap params`,\n );\n hasKioskLockRule = true;\n resolveKioskLockRule(\n tx,\n itemType,\n purchasedItem,\n extraParams.ownedKiosk,\n extraParams.ownedKioskCap,\n policy.id,\n transferRequest,\n environment,\n );\n break;\n default:\n break;\n }\n }\n\n // confirm the Transfer Policy request.\n confirmRequest(tx, itemType, policy.id, transferRequest);\n\n return {\n item: purchasedItem,\n canTransfer: !hasKioskLockRule,\n };\n}\n","// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport {\n JsonRpcProvider,\n ObjectId,\n ObjectType,\n PaginationArguments,\n SuiAddress,\n} from '@mysten/sui.js';\nimport {\n attachListingsAndPrices,\n attachLockedItems,\n extractKioskData,\n getKioskObject,\n} from '../utils';\nimport { Kiosk } from '../types';\n\n/**\n * A dynamic field `Listing { ID, isExclusive }` attached to the Kiosk.\n * Holds a `u64` value - the price of the item.\n */\nexport type KioskListing = {\n /** The ID of the Item */\n objectId: ObjectId;\n /**\n * Whether or not there's a `PurchaseCap` issued. `true` means that\n * the listing is controlled by some logic and can't be purchased directly.\n *\n * TODO: consider renaming the field for better indication.\n */\n isExclusive: boolean;\n /** The ID of the listing */\n listingId: ObjectId;\n price?: string;\n};\n\n/**\n * A dynamic field `Item { ID }` attached to the Kiosk.\n * Holds an Item `T`. The type of the item is known upfront.\n */\nexport type KioskItem = {\n /** The ID of the Item */\n objectId: ObjectId;\n /** The type of the Item */\n type: ObjectType;\n /** Whether the item is Locked (there must be a `Lock` Dynamic Field) */\n isLocked: boolean;\n /** Optional listing */\n listing?: KioskListing;\n};\n/**\n * Aggregated data from the Kiosk.\n */\nexport type KioskData = {\n items: KioskItem[];\n itemIds: ObjectId[];\n listingIds: ObjectId[];\n kiosk?: Kiosk;\n extensions: any[]; // type will be defined on later versions of the SDK.\n};\n\nexport type PagedKioskData = {\n data: KioskData;\n nextCursor: string | null;\n hasNextPage: boolean;\n};\n\nexport type FetchKioskOptions = {\n withKioskFields?: boolean;\n withListingPrices?: boolean;\n};\n\nexport async function fetchKiosk(\n provider: JsonRpcProvider,\n kioskId: SuiAddress,\n pagination: PaginationArguments<string>,\n options: FetchKioskOptions,\n): Promise<PagedKioskData> {\n const { data, nextCursor, hasNextPage } = await provider.getDynamicFields({\n parentId: kioskId,\n ...pagination,\n });\n\n const listings: KioskListing[] = [];\n const lockedItemIds: ObjectId[] = [];\n\n // extracted kiosk data.\n const kioskData = extractKioskData(data, listings, lockedItemIds);\n\n // split the fetching in two queries as we are most likely passing different options for each kind.\n // For items, we usually seek the Display.\n // For listings we usually seek the DF value (price) / exclusivity.\n const [kiosk, listingObjects] = await Promise.all([\n options.withKioskFields\n ? getKioskObject(provider, kioskId)\n : Promise.resolve(undefined),\n options.withListingPrices\n ? provider.multiGetObjects({\n ids: kioskData.listingIds,\n options: {\n showContent: true,\n },\n })\n : Promise.resolve([]),\n ]);\n\n if (options.withKioskFields) kioskData.kiosk = kiosk;\n // attach items listings. IF we have `options.withListingPrices === true`, it will also attach the prices.\n attachListingsAndPrices(kioskData, listings, listingObjects);\n // add `locked` status to items that are locked.\n attachLockedItems(kioskData, lockedItemIds);\n\n return {\n data: kioskData,\n nextCursor,\n hasNextPage,\n };\n}\n","// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport { JsonRpcProvider } from '@mysten/sui.js';\nimport { bcs } from '../bcs';\nimport {\n TRANSFER_POLICY_CREATED_EVENT,\n TRANSFER_POLICY_TYPE,\n TransferPolicy,\n} from '../types';\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 provider: JsonRpcProvider,\n type: string,\n): Promise<TransferPolicy[]> {\n // console.log('event type: %s', `${TRANSFER_POLICY_CREATED_EVENT}<${type}>`);\n const { data } = await provider.queryEvents({\n query: {\n MoveEventType: `${TRANSFER_POLICY_CREATED_EVENT}<${type}>`,\n },\n });\n\n const search = data.map((event) => event.parsedJson as { id: string });\n const policies = await provider.multiGetObjects({\n ids: search.map((policy) => policy.id),\n options: { showBcs: true, showOwner: true },\n });\n\n return policies\n .filter((policy) => !!policy && 'data' in policy)\n .map(({ data: policy }) => {\n // should never happen; policies are objects and fetched via an event.\n // policies are filtered for null and undefined above.\n if (!policy || !policy.bcs || !('bcsBytes' in policy.bcs)) {\n throw new Error(\n `Invalid policy: ${policy?.objectId}, expected object, got package`,\n );\n }\n\n let parsed = bcs.de(TRANSFER_POLICY_TYPE, policy.bcs.bcsBytes, 'base64');\n\n return {\n id: policy?.objectId,\n type: `${TRANSFER_POLICY_TYPE}<${type}>`,\n owner: policy?.owner!,\n rules: parsed.rules,\n balance: parsed.balance,\n } as TransferPolicy;\n });\n}\n"],"mappings":";AAGA;AAAA,EAQE;AAAA,OACK;;;ACTP,SAAS,WAAW;;;ACIb,IAAM,eAAe;AAGrB,IAAM,aAAa,GAAG;AAGtB,IAAM,kBAAkB,GAAG;AAG3B,IAAM,aAAa,GAAG;AAGtB,IAAM,gBAAgB,GAAG;AAGzB,IAAM,aAAa,GAAG;AAGtB,IAAM,qBAAqB,GAAG;;;ACnB9B,IAAM,yBAAyB;AAG/B,IAAM,gCAAgC,GAAG;AAGzC,IAAM,uBAAuB,GAAG;AAGhC,IAAM,kBAAkB;AAGxB,IAAM,eAAe;;;ACNrB,IAAM,qBAA4C,EAAE,KAAK,UAAU;AAGnE,IAAM,qBAA4C,EAAE,KAAK,UAAU;AAGnE,IAAM,oBAAoB,CAAC,aAA4C;AAAA,EAC5E,KAAK;AAAA,EACL;AACF;;;AHTA,IAAI,mBAAmB,YAAY;AAAA,EACjC,IAAI;AAAA,EACJ,SAAS;AAAA,EACT,OAAO;AAAA,EACP,WAAW;AAAA,EACX,iBAAiB;AACnB,CAAC;AAGD,IAAI,mBAAmB,oBAAoB;AAAA,EACzC,IAAI;AAAA,EACJ,SAAS;AAAA,EACT,QAAQ;AAAA,EACR,UAAU;AACZ,CAAC;AAGD,IAAI,mBAAmB,+BAA+B;AAAA,EACpD,IAAI;AACN,CAAC;AAED,IAAI,mBAAmB,sBAAsB;AAAA,EAC3C,IAAI;AAAA,EACJ,SAAS;AAAA,EACT,OAAO,CAAC,UAAU,QAAQ;AAC5B,CAAC;;;AIjCM,IAAM,gCACX;AAGK,IAAM,gCACX;;;ALeK,IAAM,wBAAwB;AAAA,EACnC,SAAS;AAAA,EACT,SAAS;AAAA,EACT,QAAQ;AAAA,EACR,QAAQ;AACV;AASO,SAAS,OACd,IACA,KACqB;AACrB,MAAI,OAAO,QAAQ,UAAU;AAC3B,WAAO,GAAG,OAAO,GAAG;AAAA,EACtB;AAEA,MAAI,YAAY,OAAO,aAAa,OAAO,cAAc,KAAK;AAC5D,WAAO,GAAG,UAAU,GAAG;AAAA,EACzB;AAEA,MAAI,cAAc,OAAO,0BAA0B,OAAO,aAAa,KAAK;AAC1E,WAAO,GAAG,gBAAgB,GAAG;AAAA,EAC/B;AAEA,MAAI,UAAU,KAAK;AACjB,WAAO;AAAA,EACT;AAEA,QAAM,IAAI,MAAM,uBAAuB;AACzC;AAEA,eAAsB,eACpB,UACA,IACgB;AAChB,QAAM,WAAW,MAAM,SAAS,UAAU,EAAE,IAAI,SAAS,EAAE,SAAS,KAAK,EAAE,CAAC;AAE5E,MAAI,CAAC,YAAY,SAAS,SAAS,CAAC,SAAS,MAAM;AACjD,UAAM,IAAI,MAAM,SAAS,iBAAiB,SAAS,OAAO;AAAA,EAC5D;AAEA,MAAI,CAAC,SAAS,KAAK,OAAO,EAAE,cAAc,SAAS,KAAK,MAAM;AAC5D,UAAM,IAAI,MAAM,wBAAwB,kCAAkC;AAAA,EAC5E;AAEA,SAAO,IAAI,GAAG,YAAY,SAAS,KAAK,IAAK,UAAU,QAAQ;AACjE;AAGO,SAAS,iBACd,MACA,UACA,eACW;AACX,SAAO,KAAK;AAAA,IACV,CAAC,KAAgB,QAA0B;AACzC,YAAM,OAAO,6BAA6B,IAAI,KAAK,IAAI;AAEvD,cAAQ,MAAM;AAAA,QACZ,KAAK;AACH,cAAI,QAAQ,KAAK,IAAI,QAAQ;AAC7B,cAAI,MAAM,KAAK;AAAA,YACb,UAAU,IAAI;AAAA,YACd,MAAM,IAAI;AAAA,YACV,UAAU;AAAA,UACZ,CAAC;AACD;AAAA,QACF,KAAK;AACH,cAAI,WAAW,KAAK,IAAI,QAAQ;AAChC,mBAAS,KAAK;AAAA,YACZ,UAAU,IAAI,KAAK,MAAM;AAAA,YACzB,WAAW,IAAI;AAAA,YACf,aAAa,IAAI,KAAK,MAAM;AAAA,UAC9B,CAAC;AACD;AAAA,QACF,KAAK;AACH,yBAAe,KAAK,IAAI,KAAK,MAAM,EAAE;AACrC;AAAA,MACJ;AACA,aAAO;AAAA,IACT;AAAA,IACA,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,GAAG,YAAY,CAAC,GAAG,YAAY,CAAC,EAAE;AAAA,EAC3D;AACF;AAGO,SAAS,6BAA6B,MAAc;AACzD,SAAO,KAAK,MAAM,IAAI,EAAE,MAAM,EAAE,EAAE,KAAK,IAAI;AAC7C;AAKO,SAAS,wBACd,WACA,UACA,gBACA;AAGA,QAAM,eAAe,SAAS;AAAA,IAC5B,CAAC,KAAqC,MAAM,QAAQ;AAClD,UAAI,KAAK,QAAQ,IAAI,EAAE,GAAG,KAAK;AAI/B,UAAI,eAAe,WAAW;AAAG,eAAO;AAExC,YAAM,OAAO,gBAAgB,eAAe,GAAG,CAAC;AAChD,UAAI,CAAC;AAAM,eAAO;AAElB,UAAI,KAAK,QAAQ,EAAE,QAAQ,KAAK;AAChC,aAAO;AAAA,IACT;AAAA,IACA,CAAC;AAAA,EACH;AAEA,YAAU,MAAM,IAAI,CAAC,SAAS;AAC5B,SAAK,UAAU,aAAa,KAAK,QAAQ,KAAK;AAAA,EAChD,CAAC;AACH;AAKO,SAAS,kBACd,WACA,eACA;AAEA,QAAM,iBAAiB,cAAc;AAAA,IACnC,CAAC,KAAgC,SAAiB;AAChD,UAAI,IAAI,IAAI;AACZ,aAAO;AAAA,IACT;AAAA,IACA,CAAC;AAAA,EACH;AAGA,YAAU,MAAM,IAAI,CAAC,SAAS;AAC5B,SAAK,WAAW,eAAe,KAAK,QAAQ,KAAK;AAAA,EACnD,CAAC;AACH;AAKO,SAAS,sBACd,aACQ;AAER,MAAI,YAAY,QAAQ,UAAU;AAChC,QAAI,CAAC,YAAY;AACf,YAAM,IAAI,MAAM,qDAAqD;AACvE,WAAO,YAAY;AAAA,EACrB;AACA,SAAO,sBAAsB,YAAY,GAAG;AAC9C;;;AM3KO,SAAS,qBACd,IACA,UACA,WACqB;AACrB,MAAI,CAAC,gBAAgB,iBAAiB,IAAI,GAAG,SAAS;AAAA,IACpD,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,OAAO,IAAI,SAAS,CAAC;AAAA,EACnC,CAAC;AAED,KAAG,SAAS;AAAA,IACV,QAAQ;AAAA,IACR,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,cAAc;AAAA,EAC5B,CAAC;AAED,SAAO;AACT;AAKO,SAAS,mBACd,IACA,UACA,QACA,WACA,QACqB;AACrB,MAAI,YACF,WAAW,OACP,GAAG,KAAK,EAAE,MAAM,OAAO,GAAG,aAAa,IACvC,GAAG,KAAK,EAAE,MAAM,KAAK,GAAG,aAAa;AAE3C,MAAI,CAAC,OAAO,IAAI,GAAG,SAAS;AAAA,IAC1B,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,OAAO,IAAI,MAAM,GAAG,OAAO,IAAI,SAAS,GAAG,SAAS;AAAA,EAClE,CAAC;AAED,SAAO;AACT;AAMO,SAAS,eACd,IACA,UACA,QACA,SACM;AACN,KAAG,SAAS;AAAA,IACV,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,OAAO,IAAI,MAAM,GAAG,OAAO;AAAA,EACzC,CAAC;AACH;AAKO,SAAS,yBACd,IACA,UACA,UACA,YACA,QACA,WACM;AACN,KAAG,SAAS;AAAA,IACV,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,UAAU,UAAU,UAAU;AAAA,IAC9C,WAAW,CAAC,OAAO,IAAI,MAAM,GAAG,SAAS;AAAA,EAC3C,CAAC;AACH;AAOO,SAAS,mBACd,IACA,UACA,OACA,UACA,iBACA,aACA;AACA,QAAM,YAAY,OAAO,IAAI,QAAQ;AAErC,QAAM,CAAC,MAAM,IAAI,GAAG,SAAS;AAAA,IAC3B,QAAQ,GAAG,sBAAsB,WAAW;AAAA,IAC5C,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,WAAW,OAAO,IAAI,KAAK,CAAC;AAAA,EAC1C,CAAC;AAGD,QAAM,UAAU,GAAG,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC;AAG9C,KAAG,SAAS;AAAA,IACV,QAAQ,GAAG,sBAAsB,WAAW;AAAA,IAC5C,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,WAAW,iBAAiB,OAAO;AAAA,EACjD,CAAC;AACH;AAOO,SAAS,qBACd,IACA,UACA,MACA,OACA,UACA,UACA,iBACA,aACA;AAEA,OAAK,IAAI,UAAU,OAAO,UAAU,UAAU,IAAI;AAGlD,KAAG,SAAS;AAAA,IACV,QAAQ,GAAG,sBAAsB,WAAW;AAAA,IAC5C,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,iBAAiB,OAAO,IAAI,KAAK,CAAC;AAAA,EAChD,CAAC;AACH;;;ACzHO,SAAS,YACd,IAC4C;AAC5C,MAAI,CAAC,OAAO,aAAa,IAAI,GAAG,SAAS;AAAA,IACvC,QAAQ,GAAG;AAAA,EACb,CAAC;AAED,SAAO,CAAC,OAAO,aAAa;AAC9B;AAMO,SAAS,oBAAoB,IAA2C;AAC7E,MAAI,CAAC,OAAO,aAAa,IAAI,GAAG,SAAS;AAAA,IACvC,QAAQ,GAAG;AAAA,EACb,CAAC;AAED,KAAG,SAAS;AAAA,IACV,QAAQ;AAAA,IACR,eAAe,CAAC,UAAU;AAAA,IAC1B,WAAW,CAAC,KAAK;AAAA,EACnB,CAAC;AAED,SAAO;AACT;AAMO,SAAS,MACd,IACA,UACA,OACA,UACA,MACM;AACN,KAAG,SAAS;AAAA,IACV,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,OAAO,IAAI,KAAK,GAAG,OAAO,IAAI,QAAQ,GAAG,OAAO,IAAI,IAAI,CAAC;AAAA,EACvE,CAAC;AACH;AAUO,SAAS,KACd,IACA,UACA,OACA,UACA,QACA,MACM;AACN,KAAG,SAAS;AAAA,IACV,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW;AAAA,MACT,OAAO,IAAI,KAAK;AAAA,MAChB,OAAO,IAAI,QAAQ;AAAA,MACnB,OAAO,IAAI,MAAM;AAAA,MACjB,OAAO,IAAI,IAAI;AAAA,IACjB;AAAA,EACF,CAAC;AACH;AAMO,SAAS,KACd,IACA,UACA,OACA,UACA,QACqB;AACrB,MAAI,CAAC,IAAI,IAAI,GAAG,SAAS;AAAA,IACvB,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW;AAAA,MACT,OAAO,IAAI,KAAK;AAAA,MAChB,OAAO,IAAI,QAAQ;AAAA,MACnB,GAAG,KAAK,QAAQ,SAAS;AAAA,IAC3B;AAAA,EACF,CAAC;AAED,SAAO;AACT;AAMO,SAAS,KACd,IACA,UACA,OACA,UACA,QACA,OACM;AACN,KAAG,SAAS;AAAA,IACV,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW;AAAA,MACT,OAAO,IAAI,KAAK;AAAA,MAChB,OAAO,IAAI,QAAQ;AAAA,MACnB,GAAG,KAAK,QAAQ,SAAS;AAAA,MACzB,GAAG,KAAK,OAAO,KAAK;AAAA,IACtB;AAAA,EACF,CAAC;AACH;AAMO,SAAS,OACd,IACA,UACA,OACA,UACA,QACM;AACN,KAAG,SAAS;AAAA,IACV,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW;AAAA,MACT,OAAO,IAAI,KAAK;AAAA,MAChB,OAAO,IAAI,QAAQ;AAAA,MACnB,GAAG,KAAK,QAAQ,SAAS;AAAA,IAC3B;AAAA,EACF,CAAC;AACH;AAMO,SAAS,aACd,IACA,UACA,OACA,UACA,MACA,OACM;AACN,KAAG,SAAS;AAAA,IACV,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW;AAAA,MACT,OAAO,IAAI,KAAK;AAAA,MAChB,OAAO,IAAI,QAAQ;AAAA,MACnB,OAAO,IAAI,IAAI;AAAA,MACf,GAAG,KAAK,OAAO,KAAK;AAAA,IACtB;AAAA,EACF,CAAC;AACH;AAMO,SAAS,SACd,IACA,UACA,OACA,QACA,SAC4C;AAC5C,MAAI,CAAC,MAAM,eAAe,IAAI,GAAG,SAAS;AAAA,IACxC,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW;AAAA,MACT,OAAO,IAAI,KAAK;AAAA,MAChB,GAAG,KAAK,QAAQ,SAAS;AAAA,MACzB,OAAO,IAAI,OAAO;AAAA,IACpB;AAAA,EACF,CAAC;AAED,SAAO,CAAC,MAAM,eAAe;AAC/B;AAMO,SAAS,kBACd,IACA,OACA,UACA,QACqB;AACrB,MAAI,YACF,WAAW,OACP,GAAG;AAAA,IACD;AAAA,MACE,MAAM;AAAA,IACR;AAAA,IACA;AAAA,EACF,IACA,GAAG,KAAK,EAAE,MAAM,KAAK,GAAG,aAAa;AAE3C,MAAI,CAAC,IAAI,IAAI,GAAG,SAAS;AAAA,IACvB,QAAQ,GAAG;AAAA,IACX,WAAW,CAAC,OAAO,IAAI,KAAK,GAAG,OAAO,IAAI,QAAQ,GAAG,SAAS;AAAA,EAChE,CAAC;AAED,SAAO;AACT;AAMO,SAAS,OACd,IACA,UACA,OACA,UACA,QACqB;AACrB,MAAI,CAAC,IAAI,IAAI,GAAG,SAAS;AAAA,IACvB,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW;AAAA,MACT,OAAO,IAAI,KAAK;AAAA,MAChB,OAAO,IAAI,QAAQ;AAAA,MACnB,GAAG,KAAK,QAAQ,SAAS;AAAA,IAC3B;AAAA,EACF,CAAC;AAED,SAAO;AACT;AAMO,SAAS,UACd,IACA,UACA,OACA,UACA,QACqB;AACrB,MAAI,CAAC,IAAI,IAAI,GAAG,SAAS;AAAA,IACvB,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW;AAAA,MACT,OAAO,IAAI,KAAK;AAAA,MAChB,OAAO,IAAI,QAAQ;AAAA,MACnB,GAAG,KAAK,QAAQ,SAAS;AAAA,IAC3B;AAAA,EACF,CAAC;AAED,SAAO;AACT;AAQO,SAAS,YACd,IACA,UACA,OACA,UACA,QAC4C;AAC5C,MAAI,CAAC,MAAM,OAAO,IAAI,GAAG,SAAS;AAAA,IAChC,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW;AAAA,MACT,OAAO,IAAI,KAAK;AAAA,MAChB,OAAO,IAAI,QAAQ;AAAA,MACnB,GAAG,KAAK,QAAQ,SAAS;AAAA,IAC3B;AAAA,EACF,CAAC;AAED,SAAO,CAAC,MAAM,OAAO;AACvB;AAMO,SAAS,YACd,IACA,UACA,OACA,MACA,SACM;AACN,KAAG,SAAS;AAAA,IACV,QAAQ,GAAG;AAAA,IACX,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,OAAO,IAAI,KAAK,GAAG,MAAM,OAAO;AAAA,EAC9C,CAAC;AACH;AAWO,SAAS,2BACd,IACA,UACA,OACA,OACA,QACA,QACA,aACA,aACoC;AAEpC,MAAI,UAAU,UAAa,OAAO,UAAU;AAC1C,UAAM,IAAI,MAAM,uCAAuC;AAGzD,QAAM,OAAO,GAAG,WAAW,GAAG,KAAK,CAAC,GAAG,KAAK,OAAO,KAAK,CAAC,CAAC;AAG1D,QAAM,CAAC,eAAe,eAAe,IAAI;AAAA,IACvC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAKA,MAAI,mBAAmB;AAEvB,WAAS,QAAQ,OAAO,OAAO;AAC7B,UAAM,kBAAkB,6BAA6B,IAAI;AAEzD,YAAQ,iBAAiB;AAAA,MACvB,KAAK;AACH;AAAA,UACE;AAAA,UACA;AAAA,UACA;AAAA,UACA,OAAO;AAAA,UACP;AAAA,UACA;AAAA,QACF;AACA;AAAA,MACF,KAAK;AACH,YAAI,CAAC,aAAa,cAAc,CAAC,aAAa;AAC5C,gBAAM,IAAI;AAAA,YACR,kBAAkB;AAAA,UACpB;AACF,2BAAmB;AACnB;AAAA,UACE;AAAA,UACA;AAAA,UACA;AAAA,UACA,YAAY;AAAA,UACZ,YAAY;AAAA,UACZ,OAAO;AAAA,UACP;AAAA,UACA;AAAA,QACF;AACA;AAAA,MACF;AACE;AAAA,IACJ;AAAA,EACF;AAGA,iBAAe,IAAI,UAAU,OAAO,IAAI,eAAe;AAEvD,SAAO;AAAA,IACL,MAAM;AAAA,IACN,aAAa,CAAC;AAAA,EAChB;AACF;;;AChWA,eAAsB,WACpB,UACA,SACA,YACA,SACyB;AACzB,QAAM,EAAE,MAAM,YAAY,YAAY,IAAI,MAAM,SAAS,iBAAiB;AAAA,IACxE,UAAU;AAAA,IACV,GAAG;AAAA,EACL,CAAC;AAED,QAAM,WAA2B,CAAC;AAClC,QAAM,gBAA4B,CAAC;AAGnC,QAAM,YAAY,iBAAiB,MAAM,UAAU,aAAa;AAKhE,QAAM,CAAC,OAAO,cAAc,IAAI,MAAM,QAAQ,IAAI;AAAA,IAChD,QAAQ,kBACJ,eAAe,UAAU,OAAO,IAChC,QAAQ,QAAQ,MAAS;AAAA,IAC7B,QAAQ,oBACJ,SAAS,gBAAgB;AAAA,MACvB,KAAK,UAAU;AAAA,MACf,SAAS;AAAA,QACP,aAAa;AAAA,MACf;AAAA,IACF,CAAC,IACD,QAAQ,QAAQ,CAAC,CAAC;AAAA,EACxB,CAAC;AAED,MAAI,QAAQ;AAAiB,cAAU,QAAQ;AAE/C,0BAAwB,WAAW,UAAU,cAAc;AAE3D,oBAAkB,WAAW,aAAa;AAE1C,SAAO;AAAA,IACL,MAAM;AAAA,IACN;AAAA,IACA;AAAA,EACF;AACF;;;AClGA,eAAsB,oBACpB,UACA,MAC2B;AAE3B,QAAM,EAAE,KAAK,IAAI,MAAM,SAAS,YAAY;AAAA,IAC1C,OAAO;AAAA,MACL,eAAe,GAAG,iCAAiC;AAAA,IACrD;AAAA,EACF,CAAC;AAED,QAAM,SAAS,KAAK,IAAI,CAAC,UAAU,MAAM,UAA4B;AACrE,QAAM,WAAW,MAAM,SAAS,gBAAgB;AAAA,IAC9C,KAAK,OAAO,IAAI,CAAC,WAAW,OAAO,EAAE;AAAA,IACrC,SAAS,EAAE,SAAS,MAAM,WAAW,KAAK;AAAA,EAC5C,CAAC;AAED,SAAO,SACJ,OAAO,CAAC,WAAW,CAAC,CAAC,UAAU,UAAU,MAAM,EAC/C,IAAI,CAAC,EAAE,MAAM,OAAO,MAAM;AAGzB,QAAI,CAAC,UAAU,CAAC,OAAO,OAAO,EAAE,cAAc,OAAO,MAAM;AACzD,YAAM,IAAI;AAAA,QACR,mBAAmB,QAAQ;AAAA,MAC7B;AAAA,IACF;AAEA,QAAI,SAAS,IAAI,GAAG,sBAAsB,OAAO,IAAI,UAAU,QAAQ;AAEvE,WAAO;AAAA,MACL,IAAI,QAAQ;AAAA,MACZ,MAAM,GAAG,wBAAwB;AAAA,MACjC,OAAO,QAAQ;AAAA,MACf,OAAO,OAAO;AAAA,MACd,SAAS,OAAO;AAAA,IAClB;AAAA,EACF,CAAC;AACL;","names":[]}
|
package/dist/query/kiosk.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { JsonRpcProvider, ObjectId, ObjectType, PaginationArguments, SuiAddress } from '@mysten/sui.js';
|
|
2
|
-
import { Kiosk } from '../
|
|
2
|
+
import { Kiosk } from '../types';
|
|
3
3
|
/**
|
|
4
4
|
* A dynamic field `Listing { ID, isExclusive }` attached to the Kiosk.
|
|
5
5
|
* Holds a `u64` value - the price of the item.
|
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
import { JsonRpcProvider } from '@mysten/sui.js';
|
|
2
|
-
import { TransferPolicy } from '../
|
|
3
|
-
/** Name of the event emitted when a TransferPolicy for T is created. */
|
|
4
|
-
export declare const TRANSFER_POLICY_CREATED_EVENT = "0x2::transfer_policy::TransferPolicyCreated";
|
|
2
|
+
import { TransferPolicy } from '../types';
|
|
5
3
|
/**
|
|
6
4
|
* Searches the `TransferPolicy`-s for the given type. The seach is performed via
|
|
7
5
|
* the `TransferPolicyCreated` event. The policy can either be owned or shared,
|
package/dist/tx/kiosk.d.ts
CHANGED
|
@@ -1,13 +1,5 @@
|
|
|
1
1
|
import { SuiAddress, TransactionArgument, TransactionBlock } from '@mysten/sui.js';
|
|
2
|
-
import { ObjectArgument } from '../
|
|
3
|
-
import { KioskListing } from '../query/kiosk';
|
|
4
|
-
import { TransferPolicy } from '../bcs';
|
|
5
|
-
/** The Kiosk module. */
|
|
6
|
-
export declare const KIOSK_MODULE = "0x2::kiosk";
|
|
7
|
-
/** The Kiosk type. */
|
|
8
|
-
export declare const KIOSK_TYPE: string;
|
|
9
|
-
/** The Kiosk Owner Cap Type */
|
|
10
|
-
export declare const KIOSK_OWNER_CAP: string;
|
|
2
|
+
import { ObjectArgument, PurchaseAndResolvePoliciesResponse, PurchaseOptionalParams, RulesEnvironmentParam, TransferPolicy } from '../types';
|
|
11
3
|
/**
|
|
12
4
|
* Create a new shared Kiosk and returns the [kiosk, kioskOwnerCap] tuple.
|
|
13
5
|
*/
|
|
@@ -87,6 +79,9 @@ export declare function returnValue(tx: TransactionBlock, itemType: string, kios
|
|
|
87
79
|
* Completes the full purchase flow that includes:
|
|
88
80
|
* 1. Purchasing the item.
|
|
89
81
|
* 2. Resolving all the transfer policies (if any).
|
|
90
|
-
* 3. Returns the
|
|
82
|
+
* 3. Returns the item and whether the user can transfer it or not.
|
|
83
|
+
*
|
|
84
|
+
* If the item can be transferred, there's an extra transaction required by the user
|
|
85
|
+
* to transfer it to an address or place it in their kiosk.
|
|
91
86
|
*/
|
|
92
|
-
export declare function purchaseAndResolvePolicies(tx: TransactionBlock, itemType: string,
|
|
87
|
+
export declare function purchaseAndResolvePolicies(tx: TransactionBlock, itemType: string, price: string, kiosk: ObjectArgument, itemId: SuiAddress, policy: TransferPolicy, environment: RulesEnvironmentParam, extraParams?: PurchaseOptionalParams): PurchaseAndResolvePoliciesResponse;
|
|
@@ -1,9 +1,5 @@
|
|
|
1
1
|
import { TransactionArgument, TransactionBlock } from '@mysten/sui.js';
|
|
2
|
-
import { ObjectArgument } from '../
|
|
3
|
-
/** The Transfer Policy module. */
|
|
4
|
-
export declare const TRANSFER_POLICY_MODULE = "0x2::transfer_policy";
|
|
5
|
-
/** The Transer Policy Rules package address */
|
|
6
|
-
export declare const TRANSFER_POLICY_RULES_PACKAGE_ADDRESS = "bd8fc1947cf119350184107a3087e2dc27efefa0dd82e25a1f699069fe81a585";
|
|
2
|
+
import { ObjectArgument, RulesEnvironmentParam } from '../types';
|
|
7
3
|
/**
|
|
8
4
|
* Call the `transfer_policy::new` function to create a new transfer policy.
|
|
9
5
|
* Returns `transferPolicyCap`
|
|
@@ -27,4 +23,10 @@ export declare function removeTransferPolicyRule(tx: TransactionBlock, itemType:
|
|
|
27
23
|
* splits the coin to pass the exact amount,
|
|
28
24
|
* then calls the `royalty_rule::pay` function to resolve the royalty rule.
|
|
29
25
|
*/
|
|
30
|
-
export declare function resolveRoyaltyRule(tx: TransactionBlock, itemType: string, price: string, policyId:
|
|
26
|
+
export declare function resolveRoyaltyRule(tx: TransactionBlock, itemType: string, price: string, policyId: ObjectArgument, transferRequest: TransactionArgument, environment: RulesEnvironmentParam): void;
|
|
27
|
+
/**
|
|
28
|
+
* Locks the item in the supplied kiosk and
|
|
29
|
+
* proves to the `kiosk_lock` rule that the item was indeed locked,
|
|
30
|
+
* by calling the `kiosk_lock_rule::prove` function to resolve it.
|
|
31
|
+
*/
|
|
32
|
+
export declare function resolveKioskLockRule(tx: TransactionBlock, itemType: string, item: TransactionArgument, kiosk: ObjectArgument, kioskCap: ObjectArgument, policyId: ObjectArgument, transferRequest: TransactionArgument, environment: RulesEnvironmentParam): void;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { SuiAddress } from '@mysten/sui.js';
|
|
2
|
+
export type Environment = 'mainnet' | 'testnet' | 'devnet' | 'custom';
|
|
3
|
+
/** A Parameter to support enivronments for rules. */
|
|
4
|
+
export type RulesEnvironmentParam = {
|
|
5
|
+
env: Environment;
|
|
6
|
+
address?: SuiAddress;
|
|
7
|
+
};
|
|
8
|
+
/** A default Testnet Environment object */
|
|
9
|
+
export declare const testnetEnvironment: RulesEnvironmentParam;
|
|
10
|
+
/** A default Mainnet Environment object */
|
|
11
|
+
export declare const mainnetEnvironment: RulesEnvironmentParam;
|
|
12
|
+
/** A helper to easily export a custom environment */
|
|
13
|
+
export declare const customEnvironment: (address: string) => RulesEnvironmentParam;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { SharedObjectRef, SuiObjectRef, TransactionArgument } from '@mysten/sui.js';
|
|
2
|
+
export * from './kiosk';
|
|
3
|
+
export * from './transfer-policy';
|
|
4
|
+
export * from './env';
|
|
5
|
+
/**
|
|
6
|
+
* A valid argument for any of the Kiosk functions.
|
|
7
|
+
*/
|
|
8
|
+
export type ObjectArgument = string | TransactionArgument | SharedObjectRef | SuiObjectRef;
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
import { TransactionArgument } from '@mysten/sui.js';
|
|
2
|
+
import { ObjectArgument } from '.';
|
|
3
|
+
/** The Kiosk module. */
|
|
4
|
+
export declare const KIOSK_MODULE = "0x2::kiosk";
|
|
5
|
+
/** The Kiosk type. */
|
|
6
|
+
export declare const KIOSK_TYPE: string;
|
|
7
|
+
/** The Kiosk Owner Cap Type */
|
|
8
|
+
export declare const KIOSK_OWNER_CAP: string;
|
|
9
|
+
/** The Kiosk Item Type */
|
|
10
|
+
export declare const KIOSK_ITEM: string;
|
|
11
|
+
/** The Kiosk Listing Type */
|
|
12
|
+
export declare const KIOSK_LISTING: string;
|
|
13
|
+
/** The Kiosk Lock Type */
|
|
14
|
+
export declare const KIOSK_LOCK: string;
|
|
15
|
+
/** The Kiosk PurchaseCap type */
|
|
16
|
+
export declare const KIOSK_PURCHASE_CAP: string;
|
|
17
|
+
/**
|
|
18
|
+
* The Kiosk object fields (for BCS queries).
|
|
19
|
+
*/
|
|
20
|
+
export type Kiosk = {
|
|
21
|
+
id: string;
|
|
22
|
+
profits: string;
|
|
23
|
+
owner: string;
|
|
24
|
+
itemCount: number;
|
|
25
|
+
allowExtensions: boolean;
|
|
26
|
+
};
|
|
27
|
+
/**
|
|
28
|
+
* PurchaseCap object fields (for BCS queries).
|
|
29
|
+
*/
|
|
30
|
+
export type PurchaseCap = {
|
|
31
|
+
id: string;
|
|
32
|
+
kioskId: string;
|
|
33
|
+
itemId: string;
|
|
34
|
+
minPrice: string;
|
|
35
|
+
};
|
|
36
|
+
/**
|
|
37
|
+
* The response type of a successful purchase flow.
|
|
38
|
+
* Returns the item, and a `canTransfer` param.
|
|
39
|
+
*/
|
|
40
|
+
export type PurchaseAndResolvePoliciesResponse = {
|
|
41
|
+
item: TransactionArgument;
|
|
42
|
+
canTransfer: boolean;
|
|
43
|
+
};
|
|
44
|
+
/**
|
|
45
|
+
* Optional parameters for `purchaseAndResolvePolicies` flow.
|
|
46
|
+
* This gives us the chance to extend the function in further releases
|
|
47
|
+
* without introducing more breaking changes.
|
|
48
|
+
*/
|
|
49
|
+
export type PurchaseOptionalParams = {
|
|
50
|
+
ownedKiosk?: ObjectArgument;
|
|
51
|
+
ownedKioskCap?: ObjectArgument;
|
|
52
|
+
};
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { ObjectOwner } from '@mysten/sui.js';
|
|
2
|
+
/** The Transfer Policy module. */
|
|
3
|
+
export declare const TRANSFER_POLICY_MODULE = "0x2::transfer_policy";
|
|
4
|
+
/** Name of the event emitted when a TransferPolicy for T is created. */
|
|
5
|
+
export declare const TRANSFER_POLICY_CREATED_EVENT: string;
|
|
6
|
+
/** The Transfer Policy Type */
|
|
7
|
+
export declare const TRANSFER_POLICY_TYPE: string;
|
|
8
|
+
/** The Kiosk Lock Rule */
|
|
9
|
+
export declare const KIOSK_LOCK_RULE = "kiosk_lock_rule::Rule";
|
|
10
|
+
/** The Royalty rule */
|
|
11
|
+
export declare const ROYALTY_RULE = "royalty_rule::Rule";
|
|
12
|
+
/** The `TransferPolicy` object */
|
|
13
|
+
export type TransferPolicy = {
|
|
14
|
+
id: string;
|
|
15
|
+
type: string;
|
|
16
|
+
balance: string;
|
|
17
|
+
rules: string[];
|
|
18
|
+
owner: ObjectOwner;
|
|
19
|
+
};
|
|
20
|
+
/** Event emitted when a TransferPolicy is created. */
|
|
21
|
+
export type TransferPolicyCreated = {
|
|
22
|
+
id: string;
|
|
23
|
+
};
|
package/dist/utils.d.ts
CHANGED
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
import { JsonRpcProvider, ObjectId, SharedObjectRef, SuiObjectRef, SuiObjectResponse, TransactionArgument, TransactionBlock } from '@mysten/sui.js';
|
|
2
2
|
import { KioskData, KioskListing } from './query/kiosk';
|
|
3
3
|
import { DynamicFieldInfo } from '@mysten/sui.js/dist/types/dynamic_fields';
|
|
4
|
-
import { Kiosk } from './
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
4
|
+
import { Kiosk, RulesEnvironmentParam } from './types';
|
|
5
|
+
export declare const rulesPackageAddresses: {
|
|
6
|
+
mainnet: string;
|
|
7
|
+
testnet: string;
|
|
8
|
+
devnet: string;
|
|
9
|
+
custom: null;
|
|
10
|
+
};
|
|
9
11
|
/**
|
|
10
12
|
* Convert any valid input into a TransactionArgument.
|
|
11
13
|
*
|
|
@@ -16,12 +18,16 @@ export type ObjectArgument = string | TransactionArgument | SharedObjectRef | Su
|
|
|
16
18
|
export declare function objArg(tx: TransactionBlock, arg: string | SharedObjectRef | SuiObjectRef | TransactionArgument): TransactionArgument;
|
|
17
19
|
export declare function getKioskObject(provider: JsonRpcProvider, id: string): Promise<Kiosk>;
|
|
18
20
|
export declare function extractKioskData(data: DynamicFieldInfo[], listings: KioskListing[], lockedItemIds: string[]): KioskData;
|
|
19
|
-
export declare
|
|
21
|
+
export declare function getTypeWithoutPackageAddress(type: string): string;
|
|
20
22
|
/**
|
|
21
23
|
* A helper that attaches the listing prices to kiosk listings.
|
|
22
24
|
*/
|
|
23
|
-
export declare
|
|
25
|
+
export declare function attachListingsAndPrices(kioskData: KioskData, listings: KioskListing[], listingObjects: SuiObjectResponse[]): void;
|
|
24
26
|
/**
|
|
25
27
|
* A Helper to attach locked state to items in Kiosk Data.
|
|
26
28
|
*/
|
|
27
|
-
export declare
|
|
29
|
+
export declare function attachLockedItems(kioskData: KioskData, lockedItemIds: ObjectId[]): void;
|
|
30
|
+
/**
|
|
31
|
+
* A helper to get a rule's environment address.
|
|
32
|
+
*/
|
|
33
|
+
export declare function getRulePackageAddress(environment: RulesEnvironmentParam): string;
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@mysten/kiosk",
|
|
3
3
|
"author": "Mysten Labs <build@mystenlabs.com>",
|
|
4
4
|
"description": "Sui Kiosk library",
|
|
5
|
-
"version": "0.0.0-experimental-
|
|
5
|
+
"version": "0.0.0-experimental-20230602192304",
|
|
6
6
|
"license": "Apache-2.0",
|
|
7
7
|
"main": "./dist/index.js",
|
|
8
8
|
"module": "./dist/index.mjs",
|
package/src/bcs.ts
CHANGED
|
@@ -1,21 +1,16 @@
|
|
|
1
1
|
// Copyright (c) Mysten Labs, Inc.
|
|
2
2
|
// SPDX-License-Identifier: Apache-2.0
|
|
3
3
|
|
|
4
|
-
import {
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
profits: string;
|
|
12
|
-
owner: string;
|
|
13
|
-
itemCount: number;
|
|
14
|
-
allowExtensions: boolean;
|
|
15
|
-
};
|
|
4
|
+
import { bcs } from '@mysten/sui.js';
|
|
5
|
+
import {
|
|
6
|
+
KIOSK_PURCHASE_CAP,
|
|
7
|
+
KIOSK_TYPE,
|
|
8
|
+
TRANSFER_POLICY_CREATED_EVENT,
|
|
9
|
+
TRANSFER_POLICY_TYPE,
|
|
10
|
+
} from './types';
|
|
16
11
|
|
|
17
12
|
// Register the `Kiosk` struct for faster queries.
|
|
18
|
-
bcs.registerStructType(
|
|
13
|
+
bcs.registerStructType(KIOSK_TYPE, {
|
|
19
14
|
id: 'address',
|
|
20
15
|
profits: 'u64',
|
|
21
16
|
owner: 'address',
|
|
@@ -23,44 +18,20 @@ bcs.registerStructType('0x2::kiosk::Kiosk', {
|
|
|
23
18
|
allowExtensions: 'bool',
|
|
24
19
|
});
|
|
25
20
|
|
|
26
|
-
/**
|
|
27
|
-
* PurchaseCap object fields (for BCS queries).
|
|
28
|
-
*/
|
|
29
|
-
export type PurchaseCap = {
|
|
30
|
-
id: string;
|
|
31
|
-
kioskId: string;
|
|
32
|
-
itemId: string;
|
|
33
|
-
minPrice: string;
|
|
34
|
-
};
|
|
35
|
-
|
|
36
21
|
// Register the `PurchaseCap` for faster queries.
|
|
37
|
-
bcs.registerStructType(
|
|
22
|
+
bcs.registerStructType(KIOSK_PURCHASE_CAP, {
|
|
38
23
|
id: 'address',
|
|
39
24
|
kioskId: 'address',
|
|
40
25
|
itemId: 'address',
|
|
41
26
|
minPrice: 'u64',
|
|
42
27
|
});
|
|
43
28
|
|
|
44
|
-
/** Event emitted when a TransferPolicy is created. */
|
|
45
|
-
export type TransferPolicyCreated = {
|
|
46
|
-
id: string;
|
|
47
|
-
};
|
|
48
|
-
|
|
49
29
|
// Register the `TransferPolicyCreated` event data.
|
|
50
|
-
bcs.registerStructType(
|
|
30
|
+
bcs.registerStructType(TRANSFER_POLICY_CREATED_EVENT, {
|
|
51
31
|
id: 'address',
|
|
52
32
|
});
|
|
53
33
|
|
|
54
|
-
|
|
55
|
-
export type TransferPolicy = {
|
|
56
|
-
id: string;
|
|
57
|
-
type: string;
|
|
58
|
-
balance: string;
|
|
59
|
-
rules: string[];
|
|
60
|
-
owner: ObjectOwner;
|
|
61
|
-
};
|
|
62
|
-
|
|
63
|
-
bcs.registerStructType('0x2::transfer_policy::TransferPolicy', {
|
|
34
|
+
bcs.registerStructType(TRANSFER_POLICY_TYPE, {
|
|
64
35
|
id: 'address',
|
|
65
36
|
balance: 'u64',
|
|
66
37
|
rules: ['vector', 'string'],
|
package/src/constants.ts
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
// Copyright (c) Mysten Labs, Inc.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
+
|
|
4
|
+
/** The Transer Policy Rules package address on testnet */
|
|
5
|
+
export const TESTNET_RULES_PACKAGE_ADDRESS =
|
|
6
|
+
'bd8fc1947cf119350184107a3087e2dc27efefa0dd82e25a1f699069fe81a585';
|
|
7
|
+
|
|
8
|
+
/** The transfer policy rules package address on mainnet */
|
|
9
|
+
export const MAINNET_RULES_PACKAGE_ADDRESS =
|
|
10
|
+
'0x434b5bd8f6a7b05fede0ff46c6e511d71ea326ed38056e3bcd681d2d7c2a7879';
|
package/src/index.ts
CHANGED
package/src/query/kiosk.ts
CHANGED
|
@@ -2,10 +2,12 @@
|
|
|
2
2
|
// SPDX-License-Identifier: Apache-2.0
|
|
3
3
|
|
|
4
4
|
import { JsonRpcProvider } from '@mysten/sui.js';
|
|
5
|
-
import {
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
5
|
+
import { bcs } from '../bcs';
|
|
6
|
+
import {
|
|
7
|
+
TRANSFER_POLICY_CREATED_EVENT,
|
|
8
|
+
TRANSFER_POLICY_TYPE,
|
|
9
|
+
TransferPolicy,
|
|
10
|
+
} from '../types';
|
|
9
11
|
|
|
10
12
|
/**
|
|
11
13
|
* Searches the `TransferPolicy`-s for the given type. The seach is performed via
|
|
@@ -44,15 +46,11 @@ export async function queryTransferPolicy(
|
|
|
44
46
|
);
|
|
45
47
|
}
|
|
46
48
|
|
|
47
|
-
let parsed = bcs.de(
|
|
48
|
-
'0x2::transfer_policy::TransferPolicy',
|
|
49
|
-
policy.bcs.bcsBytes,
|
|
50
|
-
'base64',
|
|
51
|
-
);
|
|
49
|
+
let parsed = bcs.de(TRANSFER_POLICY_TYPE, policy.bcs.bcsBytes, 'base64');
|
|
52
50
|
|
|
53
51
|
return {
|
|
54
52
|
id: policy?.objectId,
|
|
55
|
-
type:
|
|
53
|
+
type: `${TRANSFER_POLICY_TYPE}<${type}>`,
|
|
56
54
|
owner: policy?.owner!,
|
|
57
55
|
rules: parsed.rules,
|
|
58
56
|
balance: parsed.balance,
|