@iota/kiosk 0.1.0
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 +12 -0
- package/LICENSE +201 -0
- package/README.md +8 -0
- package/dist/cjs/bcs.d.ts +2 -0
- package/dist/cjs/bcs.js +47 -0
- package/dist/cjs/bcs.js.map +7 -0
- package/dist/cjs/client/kiosk-client.d.ts +74 -0
- package/dist/cjs/client/kiosk-client.js +121 -0
- package/dist/cjs/client/kiosk-client.js.map +7 -0
- package/dist/cjs/client/kiosk-transaction.d.ts +184 -0
- package/dist/cjs/client/kiosk-transaction.js +511 -0
- package/dist/cjs/client/kiosk-transaction.js.map +7 -0
- package/dist/cjs/client/tp-transaction.d.ts +112 -0
- package/dist/cjs/client/tp-transaction.js +323 -0
- package/dist/cjs/client/tp-transaction.js.map +7 -0
- package/dist/cjs/constants.d.ts +24 -0
- package/dist/cjs/constants.js +66 -0
- package/dist/cjs/constants.js.map +7 -0
- package/dist/cjs/index.d.ts +6 -0
- package/dist/cjs/index.js +24 -0
- package/dist/cjs/index.js.map +7 -0
- package/dist/cjs/package.json +5 -0
- package/dist/cjs/query/kiosk.d.ts +14 -0
- package/dist/cjs/query/kiosk.js +128 -0
- package/dist/cjs/query/kiosk.js.map +7 -0
- package/dist/cjs/query/transfer-policy.d.ts +28 -0
- package/dist/cjs/query/transfer-policy.js +96 -0
- package/dist/cjs/query/transfer-policy.js.map +7 -0
- package/dist/cjs/tx/kiosk.d.ts +71 -0
- package/dist/cjs/tx/kiosk.js +130 -0
- package/dist/cjs/tx/kiosk.js.map +7 -0
- package/dist/cjs/tx/personal-kiosk.d.ts +7 -0
- package/dist/cjs/tx/personal-kiosk.js +38 -0
- package/dist/cjs/tx/personal-kiosk.js.map +7 -0
- package/dist/cjs/tx/rules/attach.d.ts +7 -0
- package/dist/cjs/tx/rules/attach.js +62 -0
- package/dist/cjs/tx/rules/attach.js.map +7 -0
- package/dist/cjs/tx/rules/resolve.d.ts +15 -0
- package/dist/cjs/tx/rules/resolve.js +81 -0
- package/dist/cjs/tx/rules/resolve.js.map +7 -0
- package/dist/cjs/tx/transfer-policy.d.ts +29 -0
- package/dist/cjs/tx/transfer-policy.js +78 -0
- package/dist/cjs/tx/transfer-policy.js.map +7 -0
- package/dist/cjs/types/index.d.ts +17 -0
- package/dist/cjs/types/index.js +20 -0
- package/dist/cjs/types/index.js.map +7 -0
- package/dist/cjs/types/kiosk.d.ts +160 -0
- package/dist/cjs/types/kiosk.js +37 -0
- package/dist/cjs/types/kiosk.js.map +7 -0
- package/dist/cjs/types/transfer-policy.d.ts +49 -0
- package/dist/cjs/types/transfer-policy.js +35 -0
- package/dist/cjs/types/transfer-policy.js.map +7 -0
- package/dist/cjs/utils.d.ts +51 -0
- package/dist/cjs/utils.js +204 -0
- package/dist/cjs/utils.js.map +7 -0
- package/dist/esm/bcs.d.ts +2 -0
- package/dist/esm/bcs.js +32 -0
- package/dist/esm/bcs.js.map +7 -0
- package/dist/esm/client/kiosk-client.d.ts +74 -0
- package/dist/esm/client/kiosk-client.js +105 -0
- package/dist/esm/client/kiosk-client.js.map +7 -0
- package/dist/esm/client/kiosk-transaction.d.ts +184 -0
- package/dist/esm/client/kiosk-transaction.js +481 -0
- package/dist/esm/client/kiosk-transaction.js.map +7 -0
- package/dist/esm/client/tp-transaction.d.ts +112 -0
- package/dist/esm/client/tp-transaction.js +314 -0
- package/dist/esm/client/tp-transaction.js.map +7 -0
- package/dist/esm/constants.d.ts +24 -0
- package/dist/esm/constants.js +51 -0
- package/dist/esm/constants.js.map +7 -0
- package/dist/esm/index.d.ts +6 -0
- package/dist/esm/index.js +7 -0
- package/dist/esm/index.js.map +7 -0
- package/dist/esm/package.json +5 -0
- package/dist/esm/query/kiosk.d.ts +14 -0
- package/dist/esm/query/kiosk.js +116 -0
- package/dist/esm/query/kiosk.js.map +7 -0
- package/dist/esm/query/transfer-policy.d.ts +28 -0
- package/dist/esm/query/transfer-policy.js +80 -0
- package/dist/esm/query/transfer-policy.js.map +7 -0
- package/dist/esm/tx/kiosk.d.ts +71 -0
- package/dist/esm/tx/kiosk.js +110 -0
- package/dist/esm/tx/kiosk.js.map +7 -0
- package/dist/esm/tx/personal-kiosk.d.ts +7 -0
- package/dist/esm/tx/personal-kiosk.js +18 -0
- package/dist/esm/tx/personal-kiosk.js.map +7 -0
- package/dist/esm/tx/rules/attach.d.ts +7 -0
- package/dist/esm/tx/rules/attach.js +42 -0
- package/dist/esm/tx/rules/attach.js.map +7 -0
- package/dist/esm/tx/rules/resolve.d.ts +15 -0
- package/dist/esm/tx/rules/resolve.js +61 -0
- package/dist/esm/tx/rules/resolve.js.map +7 -0
- package/dist/esm/tx/transfer-policy.d.ts +29 -0
- package/dist/esm/tx/transfer-policy.js +58 -0
- package/dist/esm/tx/transfer-policy.js.map +7 -0
- package/dist/esm/types/index.d.ts +17 -0
- package/dist/esm/types/index.js +3 -0
- package/dist/esm/types/index.js.map +7 -0
- package/dist/esm/types/kiosk.d.ts +160 -0
- package/dist/esm/types/kiosk.js +17 -0
- package/dist/esm/types/kiosk.js.map +7 -0
- package/dist/esm/types/transfer-policy.d.ts +49 -0
- package/dist/esm/types/transfer-policy.js +15 -0
- package/dist/esm/types/transfer-policy.js.map +7 -0
- package/dist/esm/utils.d.ts +51 -0
- package/dist/esm/utils.js +184 -0
- package/dist/esm/utils.js.map +7 -0
- package/dist/tsconfig.esm.tsbuildinfo +1 -0
- package/dist/tsconfig.tsbuildinfo +1 -0
- package/package.json +52 -0
- package/src/bcs.ts +42 -0
- package/src/client/kiosk-client.ts +159 -0
- package/src/client/kiosk-transaction.ts +542 -0
- package/src/client/tp-transaction.ts +360 -0
- package/src/constants.ts +85 -0
- package/src/index.ts +10 -0
- package/src/query/kiosk.ts +190 -0
- package/src/query/transfer-policy.ts +135 -0
- package/src/tx/kiosk.ts +244 -0
- package/src/tx/personal-kiosk.ts +35 -0
- package/src/tx/rules/attach.ts +74 -0
- package/src/tx/rules/resolve.ts +87 -0
- package/src/tx/transfer-policy.ts +121 -0
- package/src/types/index.ts +25 -0
- package/src/types/kiosk.ts +179 -0
- package/src/types/transfer-policy.ts +68 -0
- package/src/utils.ts +284 -0
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../../src/client/kiosk-transaction.ts"],
|
|
4
|
+
"sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// Modifications Copyright (c) 2024 IOTA Stiftung\n// SPDX-License-Identifier: Apache-2.0\n\nimport type {\n TransactionArgument,\n TransactionBlock,\n TransactionObjectArgument,\n} from '@iota/iota-sdk/transactions';\n\nimport * as kioskTx from '../tx/kiosk.js';\nimport { convertToPersonalTx, transferPersonalCapTx } from '../tx/personal-kiosk.js';\nimport { confirmRequest } from '../tx/transfer-policy.js';\nimport type {\n ItemId,\n ItemReference,\n ItemValue,\n KioskOwnerCap,\n ObjectArgument,\n Price,\n PurchaseOptions,\n} from '../types/index.js';\nimport { getNormalizedRuleType } from '../utils.js';\nimport type { KioskClient } from './kiosk-client.js';\n\nexport type KioskTransactionParams = {\n /** The TransactionBlock for this run */\n transactionBlock: TransactionBlock;\n /**\n * You can create a new KioskClient by calling `new KioskClient()`\n */\n kioskClient: KioskClient;\n /**\n * You can optionally pass in the `cap` as returned\n * from `kioskClient.getOwnedKiosks` when initializing the client\n * Otherwise, you can set it by calling `kioskTransaction.setCap()`\n */\n cap?: KioskOwnerCap;\n};\n\n/**\n * A helper for building transactions that involve kiosk.\n */\nexport class KioskTransaction {\n transactionBlock: TransactionBlock;\n kioskClient: KioskClient;\n kiosk?: TransactionObjectArgument;\n kioskCap?: TransactionObjectArgument;\n // If we're pending `share` of a new kiosk, `finalize()` will share it.\n #pendingShare?: boolean;\n // If we're pending transferring of the cap, `finalize()` will either error or transfer the cap if it's a new personal.\n #pendingTransfer?: boolean;\n // The promise that the personalCap will be returned on `finalize()`.\n #promise?: TransactionArgument | undefined;\n // The personal kiosk argument.\n #personalCap?: TransactionObjectArgument;\n // A flag that checks whether kiosk TX is finalized.\n #finalized: boolean = false;\n\n constructor({ transactionBlock, kioskClient, cap }: KioskTransactionParams) {\n this.transactionBlock = transactionBlock;\n this.kioskClient = kioskClient;\n\n if (cap) this.setCap(cap);\n }\n\n /**\n * Creates a kiosk and saves `kiosk` and `kioskOwnerCap` in state.\n * Helpful if we want to chain some actions before sharing + transferring the cap to the specified address.\n * @param borrow If true, the `kioskOwnerCap` is borrowed from the `PersonalKioskCap` to be used in next transactions.\n */\n create() {\n this.#validateFinalizedStatus();\n this.#setPendingStatuses({\n share: true,\n transfer: true,\n });\n const [kiosk, cap] = kioskTx.createKiosk(this.transactionBlock);\n this.kiosk = kiosk;\n this.kioskCap = cap;\n return this;\n }\n\n /**\n * Creates a personal kiosk & shares it.\n * The `PersonalKioskCap` is transferred to the signer.\n * @param borrow If true, the `kioskOwnerCap` is borrowed from the `PersonalKioskCap` to be used in next transactions.\n */\n createPersonal(borrow?: boolean) {\n this.#pendingShare = true;\n return this.create().convertToPersonal(borrow);\n }\n\n /**\n * Converts a kiosk to a Personal (Soulbound) Kiosk.\n * Requires initialization by either calling `ktxb.create()` or `ktxb.setCap()`.\n */\n convertToPersonal(borrow?: boolean) {\n this.#validateKioskIsSet();\n\n const cap = convertToPersonalTx(\n this.transactionBlock,\n this.kiosk!,\n this.kioskCap!,\n this.kioskClient.getRulePackageId('personalKioskRulePackageId'),\n );\n\n // if we enable `borrow`, we borrow the kioskCap from the cap.\n if (borrow) this.#borrowFromPersonalCap(cap);\n else this.#personalCap = cap;\n\n this.#setPendingStatuses({ transfer: true });\n return this;\n }\n\n /**\n * Single function way to create a kiosk, share it and transfer the cap to the specified address.\n */\n createAndShare(address: string) {\n this.#validateFinalizedStatus();\n const cap = kioskTx.createKioskAndShare(this.transactionBlock);\n this.transactionBlock.transferObjects([cap], this.transactionBlock.pure.address(address));\n }\n\n /**\n * Shares the kiosk.\n */\n share() {\n this.#validateKioskIsSet();\n this.#setPendingStatuses({ share: false });\n kioskTx.shareKiosk(this.transactionBlock, this.kiosk!);\n }\n\n /**\n * Should be called only after `create` is called.\n * It shares the kiosk & transfers the cap to the specified address.\n */\n shareAndTransferCap(address: string) {\n if (this.#personalCap)\n throw new Error('You can only call `shareAndTransferCap` on a non-personal kiosk.');\n this.#setPendingStatuses({ transfer: false });\n this.share();\n this.transactionBlock.transferObjects(\n [this.kioskCap!],\n this.transactionBlock.pure.address(address),\n );\n }\n\n /**\n * A function to borrow an item from a kiosk & execute any function with it.\n * Example: You could borrow a Fren out of a kiosk, attach an accessory (or mix), and return it.\n */\n borrowTx({ itemType, itemId }: ItemId, callback: (item: TransactionArgument) => void) {\n this.#validateKioskIsSet();\n const [itemObj, promise] = kioskTx.borrowValue(\n this.transactionBlock,\n itemType,\n this.kiosk!,\n this.kioskCap!,\n itemId,\n );\n\n callback(itemObj);\n\n this.return({ itemType, item: itemObj, promise });\n }\n\n /**\n * Borrows an item from the kiosk.\n * This will fail if the item is listed for sale.\n *\n * Requires calling `return`.\n */\n borrow({ itemType, itemId }: ItemId): [TransactionArgument, TransactionArgument] {\n this.#validateKioskIsSet();\n const [itemObj, promise] = kioskTx.borrowValue(\n this.transactionBlock,\n itemType,\n this.kiosk!,\n this.kioskCap!,\n itemId,\n );\n\n return [itemObj, promise];\n }\n\n /**\n * Returns the item back to the kiosk.\n * Accepts the parameters returned from the `borrow` function.\n */\n return({ itemType, item, promise }: ItemValue & { promise: TransactionArgument }) {\n this.#validateKioskIsSet();\n kioskTx.returnValue(this.transactionBlock, itemType, this.kiosk!, item, promise);\n return this;\n }\n\n /**\n * A function to withdraw from kiosk\n * @param address Where to transfer the coin.\n * @param amount The amount we aim to withdraw.\n */\n withdraw(address: string, amount?: string | bigint | number) {\n this.#validateKioskIsSet();\n const coin = kioskTx.withdrawFromKiosk(\n this.transactionBlock,\n this.kiosk!,\n this.kioskCap!,\n amount,\n );\n this.transactionBlock.transferObjects([coin], this.transactionBlock.pure.address(address));\n return this;\n }\n\n /**\n * A function to place an item in the kiosk.\n * @param itemType The type `T` of the item\n * @param item The ID or Transaction Argument of the item\n */\n place({ itemType, item }: ItemReference) {\n this.#validateKioskIsSet();\n kioskTx.place(this.transactionBlock, itemType, this.kiosk!, this.kioskCap!, item);\n return this;\n }\n\n /**\n * A function to place an item in the kiosk and list it for sale in one transaction.\n * @param itemType The type `T` of the item\n * @param item The ID or Transaction Argument of the item\n * @param price The price in nano\n */\n placeAndList({ itemType, item, price }: ItemReference & Price) {\n this.#validateKioskIsSet();\n kioskTx.placeAndList(\n this.transactionBlock,\n itemType,\n this.kiosk!,\n this.kioskCap!,\n item,\n price,\n );\n return this;\n }\n\n /**\n * A function to list an item in the kiosk.\n * @param itemType The type `T` of the item\n * @param itemId The ID of the item\n * @param price The price in nano\n */\n list({ itemType, itemId, price }: ItemId & { price: string | bigint }) {\n this.#validateKioskIsSet();\n kioskTx.list(this.transactionBlock, itemType, this.kiosk!, this.kioskCap!, itemId, price);\n return this;\n }\n\n /**\n * A function to delist an item from the kiosk.\n * @param itemType The type `T` of the item\n * @param itemId The ID of the item\n */\n delist({ itemType, itemId }: ItemId) {\n this.#validateKioskIsSet();\n kioskTx.delist(this.transactionBlock, itemType, this.kiosk!, this.kioskCap!, itemId);\n return this;\n }\n\n /**\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 take({ itemType, itemId }: ItemId): TransactionObjectArgument {\n this.#validateKioskIsSet();\n return kioskTx.take(this.transactionBlock, itemType, this.kiosk!, this.kioskCap!, itemId);\n }\n\n /**\n * Transfer a non-locked/non-listed item to an address.\n *\n * @param itemType The type `T` of the item\n * @param itemId The ID of the item\n * @param address The destination address\n */\n transfer({ itemType, itemId, address }: ItemId & { address: string }) {\n this.#validateKioskIsSet();\n const item = this.take({ itemType, itemId });\n this.transactionBlock.transferObjects([item], this.transactionBlock.pure.address(address));\n return this;\n }\n\n /**\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 item The ID or Transaction Argument of the item\n\t * @param itemId The ID of the item - Deprecated: Use `item` instead.\n\t * @param policy The Policy ID or Transaction Argument for item T\n\t */\n lock({\n itemType,\n item,\n itemId,\n policy,\n }: ItemReference & { policy: ObjectArgument; itemId?: string }) {\n this.#validateKioskIsSet();\n kioskTx.lock(\n this.transactionBlock,\n itemType,\n this.kiosk!,\n this.kioskCap!,\n policy,\n itemId ?? item,\n );\n return this;\n }\n\n /**\n * Purchase an item from a seller's kiosk.\n * Returns [item, transferRequest]\n * Can be called like: `const [item, transferRequest] = kioskTx.purchase({...})`\n * @param itemType The type `T` of the item\n * @param itemId The ID of the item\n * @param price The price in nano\n * @param sellerKiosk The kiosk which is selling the item. Can be an id or an object argument.\n */\n purchase({\n itemType,\n itemId,\n price,\n sellerKiosk,\n }: ItemId & Price & { sellerKiosk: ObjectArgument }): [\n TransactionObjectArgument,\n TransactionObjectArgument,\n ] {\n // Split the coin for the amount of the listing.\n const coin = this.transactionBlock.splitCoins(this.transactionBlock.gas, [\n this.transactionBlock.pure.u64(price),\n ]);\n return kioskTx.purchase(this.transactionBlock, itemType, sellerKiosk, itemId, coin);\n }\n\n /**\n * A function to purchase and resolve a transfer policy.\n * If the transfer policy has the `lock` rule, the item is locked in the kiosk.\n * Otherwise, the item is placed in the kiosk.\n * @param itemType The type of the item\n * @param itemId The id of the item\n * @param price The price of the specified item\n * @param sellerKiosk The kiosk which is selling the item. Can be an id or an object argument.\n * @param extraArgs Used to pass arguments for custom rule resolvers.\n */\n async purchaseAndResolve({\n itemType,\n itemId,\n price,\n sellerKiosk,\n extraArgs,\n }: ItemId & Price & { sellerKiosk: ObjectArgument } & PurchaseOptions) {\n this.#validateKioskIsSet();\n // Get a list of the transfer policies.\n const policies = await this.kioskClient.getTransferPolicies({ type: itemType });\n\n if (policies.length === 0) {\n throw new Error(\n `The type ${itemType} doesn't have a Transfer Policy so it can't be traded through kiosk.`,\n );\n }\n\n const policy = policies[0]; // we now pick the first one. We need to add an option to define which one.\n\n // initialize the purchase `kiosk::purchase`\n const [purchasedItem, transferRequest] = this.purchase({\n itemType,\n itemId,\n price,\n sellerKiosk,\n });\n\n let canTransferOutsideKiosk = true;\n\n for (const rule of policy.rules) {\n const ruleDefinition = this.kioskClient.rules.find(\n (x) => getNormalizedRuleType(x.rule) === getNormalizedRuleType(rule),\n );\n if (!ruleDefinition) throw new Error(`No resolver for the following rule: ${rule}.`);\n\n if (ruleDefinition.hasLockingRule) canTransferOutsideKiosk = false;\n\n ruleDefinition.resolveRuleFunction({\n packageId: ruleDefinition.packageId,\n transactionBlock: this.transactionBlock,\n itemType,\n itemId,\n price: price.toString(),\n sellerKiosk,\n policyId: policy.id,\n transferRequest,\n purchasedItem,\n kiosk: this.kiosk!,\n kioskCap: this.kioskCap!,\n extraArgs: extraArgs || {},\n });\n }\n\n confirmRequest(this.transactionBlock, itemType, policy.id, transferRequest);\n\n if (canTransferOutsideKiosk) this.place({ itemType, item: purchasedItem });\n\n return this;\n }\n\n /**\n * A function to setup the client using an existing `ownerCap`,\n * as return from the `kioskClient.getOwnedKiosks` function.\n * @param cap `KioskOwnerCap` object as returned from `getOwnedKiosks` SDK call.\n */\n setCap(cap: KioskOwnerCap) {\n this.#validateFinalizedStatus();\n this.kiosk = this.transactionBlock.object(cap.kioskId);\n if (!cap.isPersonal) {\n this.kioskCap = this.transactionBlock.object(cap.objectId);\n return;\n }\n\n return this.#borrowFromPersonalCap(cap.objectId);\n }\n\n /**\n *\tA function that ends up the kiosk building txb & returns the `kioskOwnerCap` back to the\n * `PersonalKioskCap`, in case we are operating on a personal kiosk.\n * \tIt will also share the `kiosk` if it's not shared, and finalize the transfer of the personal cap if it's pending.\n */\n finalize() {\n this.#validateKioskIsSet();\n // If we're pending the sharing of the new kiosk, share it.\n if (this.#pendingShare) this.share();\n\n // If we're operating on a non-personal kiosk, we don't need to do anything else.\n if (!this.#personalCap) {\n // If we're pending transfer though, we inform user to call `shareAndTransferCap()`.\n if (this.#pendingTransfer)\n throw new Error(\n 'You need to transfer the `kioskOwnerCap` by calling `shareAndTransferCap()` before wrap',\n );\n return;\n }\n\n const packageId = this.kioskClient.getRulePackageId('personalKioskRulePackageId');\n\n // if we have a promise, return the `ownerCap` back to the personal cap.\n if (this.#promise) {\n this.transactionBlock.moveCall({\n target: `${packageId}::personal_kiosk::return_val`,\n arguments: [\n this.#personalCap,\n this.transactionBlock.object(this.kioskCap!),\n this.#promise!,\n ],\n });\n }\n\n // If we are pending transferring the personalCap, we do it here.\n if (this.#pendingTransfer)\n transferPersonalCapTx(this.transactionBlock, this.#personalCap, packageId);\n\n // Mark the transaction block as finalized, so no other functions can be called.\n this.#finalized = true;\n }\n\n // Some setters in case we want custom behavior.\n setKioskCap(cap: TransactionObjectArgument) {\n this.#validateFinalizedStatus();\n this.kioskCap = cap;\n return this;\n }\n\n setKiosk(kiosk: TransactionObjectArgument) {\n this.#validateFinalizedStatus();\n this.kiosk = kiosk;\n return this;\n }\n\n // Some getters\n /*\n * Returns the active transaction's kiosk, or undefined if `setCap` or `create()` hasn't been called yet.\n */\n getKiosk() {\n this.#validateFinalizedStatus();\n if (!this.kiosk) throw new Error('Kiosk is not set.');\n return this.kiosk;\n }\n\n /*\n * Returns the active transaction's kioskOwnerCap, or undefined if `setCap` or `create()` hasn't been called yet.\n */\n getKioskCap() {\n this.#validateFinalizedStatus();\n if (!this.kioskCap) throw new Error('Kiosk cap is not set');\n return this.kioskCap;\n }\n\n /**\n * A function to borrow from `personalCap`.\n */\n #borrowFromPersonalCap(personalCap: ObjectArgument) {\n const [kioskCap, promise] = this.transactionBlock.moveCall({\n target: `${this.kioskClient.getRulePackageId(\n 'personalKioskRulePackageId',\n )}::personal_kiosk::borrow_val`,\n arguments: [this.transactionBlock.object(personalCap)],\n });\n\n this.kioskCap = kioskCap;\n this.#personalCap = this.transactionBlock.object(personalCap);\n this.#promise = promise;\n\n return this;\n }\n\n #setPendingStatuses({ share, transfer }: { share?: boolean; transfer?: boolean }) {\n if (transfer !== undefined) this.#pendingTransfer = transfer;\n if (share !== undefined) this.#pendingShare = share;\n }\n\n #validateKioskIsSet() {\n this.#validateFinalizedStatus();\n\n if (!this.kiosk || !this.kioskCap)\n throw new Error(\n 'You need to initialize the client by either supplying an existing owner cap or by creating a new by calling `.create()`',\n );\n }\n\n // Validates that `finalize`\n #validateFinalizedStatus() {\n if (this.#finalized)\n throw new Error(\n \"You can't add more transactions to a finalized kiosk transaction block.\",\n );\n }\n}\n"],
|
|
5
|
+
"mappings": ";;;;;;;;;;;;;;;;;;;;;;AAAA;AAUA,YAAY,aAAa;AACzB,SAAS,qBAAqB,6BAA6B;AAC3D,SAAS,sBAAsB;AAU/B,SAAS,6BAA6B;AAqB/B,MAAM,iBAAiB;AAAA,EAgB1B,YAAY,EAAE,kBAAkB,aAAa,IAAI,GAA2B;AA8b5E;AAAA;AAAA;AAAA;AAeA;AAKA;AAUA;AAAA;AAteA;AAAA;AAEA;AAAA;AAEA;AAAA;AAEA;AAAA;AAEA;AAAA,mCAAsB;AAGlB,SAAK,mBAAmB;AACxB,SAAK,cAAc;AAEnB,QAAI;AAAK,WAAK,OAAO,GAAG;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAS;AACL,0BAAK,sDAAL;AACA,0BAAK,4CAAL,WAAyB;AAAA,MACrB,OAAO;AAAA,MACP,UAAU;AAAA,IACd;AACA,UAAM,CAAC,OAAO,GAAG,IAAI,QAAQ,YAAY,KAAK,gBAAgB;AAC9D,SAAK,QAAQ;AACb,SAAK,WAAW;AAChB,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,eAAe,QAAkB;AAC7B,uBAAK,eAAgB;AACrB,WAAO,KAAK,OAAO,EAAE,kBAAkB,MAAM;AAAA,EACjD;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,kBAAkB,QAAkB;AAChC,0BAAK,4CAAL;AAEA,UAAM,MAAM;AAAA,MACR,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK,YAAY,iBAAiB,4BAA4B;AAAA,IAClE;AAGA,QAAI;AAAQ,4BAAK,kDAAL,WAA4B;AAAA;AACnC,yBAAK,cAAe;AAEzB,0BAAK,4CAAL,WAAyB,EAAE,UAAU,KAAK;AAC1C,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA,EAKA,eAAe,SAAiB;AAC5B,0BAAK,sDAAL;AACA,UAAM,MAAM,QAAQ,oBAAoB,KAAK,gBAAgB;AAC7D,SAAK,iBAAiB,gBAAgB,CAAC,GAAG,GAAG,KAAK,iBAAiB,KAAK,QAAQ,OAAO,CAAC;AAAA,EAC5F;AAAA;AAAA;AAAA;AAAA,EAKA,QAAQ;AACJ,0BAAK,4CAAL;AACA,0BAAK,4CAAL,WAAyB,EAAE,OAAO,MAAM;AACxC,YAAQ,WAAW,KAAK,kBAAkB,KAAK,KAAM;AAAA,EACzD;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,oBAAoB,SAAiB;AACjC,QAAI,mBAAK;AACL,YAAM,IAAI,MAAM,kEAAkE;AACtF,0BAAK,4CAAL,WAAyB,EAAE,UAAU,MAAM;AAC3C,SAAK,MAAM;AACX,SAAK,iBAAiB;AAAA,MAClB,CAAC,KAAK,QAAS;AAAA,MACf,KAAK,iBAAiB,KAAK,QAAQ,OAAO;AAAA,IAC9C;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAS,EAAE,UAAU,OAAO,GAAW,UAA+C;AAClF,0BAAK,4CAAL;AACA,UAAM,CAAC,SAAS,OAAO,IAAI,QAAQ;AAAA,MAC/B,KAAK;AAAA,MACL;AAAA,MACA,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,IACJ;AAEA,aAAS,OAAO;AAEhB,SAAK,OAAO,EAAE,UAAU,MAAM,SAAS,QAAQ,CAAC;AAAA,EACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAO,EAAE,UAAU,OAAO,GAAuD;AAC7E,0BAAK,4CAAL;AACA,UAAM,CAAC,SAAS,OAAO,IAAI,QAAQ;AAAA,MAC/B,KAAK;AAAA,MACL;AAAA,MACA,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,IACJ;AAEA,WAAO,CAAC,SAAS,OAAO;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,OAAO,EAAE,UAAU,MAAM,QAAQ,GAAiD;AAC9E,0BAAK,4CAAL;AACA,YAAQ,YAAY,KAAK,kBAAkB,UAAU,KAAK,OAAQ,MAAM,OAAO;AAC/E,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAS,SAAiB,QAAmC;AACzD,0BAAK,4CAAL;AACA,UAAM,OAAO,QAAQ;AAAA,MACjB,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,IACJ;AACA,SAAK,iBAAiB,gBAAgB,CAAC,IAAI,GAAG,KAAK,iBAAiB,KAAK,QAAQ,OAAO,CAAC;AACzF,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,EAAE,UAAU,KAAK,GAAkB;AACrC,0BAAK,4CAAL;AACA,YAAQ,MAAM,KAAK,kBAAkB,UAAU,KAAK,OAAQ,KAAK,UAAW,IAAI;AAChF,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,aAAa,EAAE,UAAU,MAAM,MAAM,GAA0B;AAC3D,0BAAK,4CAAL;AACA,YAAQ;AAAA,MACJ,KAAK;AAAA,MACL;AAAA,MACA,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,MACA;AAAA,IACJ;AACA,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,KAAK,EAAE,UAAU,QAAQ,MAAM,GAAwC;AACnE,0BAAK,4CAAL;AACA,YAAQ,KAAK,KAAK,kBAAkB,UAAU,KAAK,OAAQ,KAAK,UAAW,QAAQ,KAAK;AACxF,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,EAAE,UAAU,OAAO,GAAW;AACjC,0BAAK,4CAAL;AACA,YAAQ,OAAO,KAAK,kBAAkB,UAAU,KAAK,OAAQ,KAAK,UAAW,MAAM;AACnF,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,KAAK,EAAE,UAAU,OAAO,GAAsC;AAC1D,0BAAK,4CAAL;AACA,WAAO,QAAQ,KAAK,KAAK,kBAAkB,UAAU,KAAK,OAAQ,KAAK,UAAW,MAAM;AAAA,EAC5F;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,SAAS,EAAE,UAAU,QAAQ,QAAQ,GAAiC;AAClE,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,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,KAAK;AAAA,IACD;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACJ,GAAgE;AAC5D,0BAAK,4CAAL;AACA,YAAQ;AAAA,MACJ,KAAK;AAAA,MACL;AAAA,MACA,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,MACA,UAAU;AAAA,IACd;AACA,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,SAAS;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACJ,GAGE;AAEE,UAAM,OAAO,KAAK,iBAAiB,WAAW,KAAK,iBAAiB,KAAK;AAAA,MACrE,KAAK,iBAAiB,KAAK,IAAI,KAAK;AAAA,IACxC,CAAC;AACD,WAAO,QAAQ,SAAS,KAAK,kBAAkB,UAAU,aAAa,QAAQ,IAAI;AAAA,EACtF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,MAAM,mBAAmB;AAAA,IACrB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACJ,GAAuE;AACnE,0BAAK,4CAAL;AAEA,UAAM,WAAW,MAAM,KAAK,YAAY,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAE9E,QAAI,SAAS,WAAW,GAAG;AACvB,YAAM,IAAI;AAAA,QACN,YAAY;AAAA,MAChB;AAAA,IACJ;AAEA,UAAM,SAAS,SAAS,CAAC;AAGzB,UAAM,CAAC,eAAe,eAAe,IAAI,KAAK,SAAS;AAAA,MACnD;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ,CAAC;AAED,QAAI,0BAA0B;AAE9B,eAAW,QAAQ,OAAO,OAAO;AAC7B,YAAM,iBAAiB,KAAK,YAAY,MAAM;AAAA,QAC1C,CAAC,MAAM,sBAAsB,EAAE,IAAI,MAAM,sBAAsB,IAAI;AAAA,MACvE;AACA,UAAI,CAAC;AAAgB,cAAM,IAAI,MAAM,uCAAuC,OAAO;AAEnF,UAAI,eAAe;AAAgB,kCAA0B;AAE7D,qBAAe,oBAAoB;AAAA,QAC/B,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,MAC7B,CAAC;AAAA,IACL;AAEA,mBAAe,KAAK,kBAAkB,UAAU,OAAO,IAAI,eAAe;AAE1E,QAAI;AAAyB,WAAK,MAAM,EAAE,UAAU,MAAM,cAAc,CAAC;AAEzE,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,KAAoB;AACvB,0BAAK,sDAAL;AACA,SAAK,QAAQ,KAAK,iBAAiB,OAAO,IAAI,OAAO;AACrD,QAAI,CAAC,IAAI,YAAY;AACjB,WAAK,WAAW,KAAK,iBAAiB,OAAO,IAAI,QAAQ;AACzD;AAAA,IACJ;AAEA,WAAO,sBAAK,kDAAL,WAA4B,IAAI;AAAA,EAC3C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,WAAW;AACP,0BAAK,4CAAL;AAEA,QAAI,mBAAK;AAAe,WAAK,MAAM;AAGnC,QAAI,CAAC,mBAAK,eAAc;AAEpB,UAAI,mBAAK;AACL,cAAM,IAAI;AAAA,UACN;AAAA,QACJ;AACJ;AAAA,IACJ;AAEA,UAAM,YAAY,KAAK,YAAY,iBAAiB,4BAA4B;AAGhF,QAAI,mBAAK,WAAU;AACf,WAAK,iBAAiB,SAAS;AAAA,QAC3B,QAAQ,GAAG;AAAA,QACX,WAAW;AAAA,UACP,mBAAK;AAAA,UACL,KAAK,iBAAiB,OAAO,KAAK,QAAS;AAAA,UAC3C,mBAAK;AAAA,QACT;AAAA,MACJ,CAAC;AAAA,IACL;AAGA,QAAI,mBAAK;AACL,4BAAsB,KAAK,kBAAkB,mBAAK,eAAc,SAAS;AAG7E,uBAAK,YAAa;AAAA,EACtB;AAAA;AAAA,EAGA,YAAY,KAAgC;AACxC,0BAAK,sDAAL;AACA,SAAK,WAAW;AAChB,WAAO;AAAA,EACX;AAAA,EAEA,SAAS,OAAkC;AACvC,0BAAK,sDAAL;AACA,SAAK,QAAQ;AACb,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,WAAW;AACP,0BAAK,sDAAL;AACA,QAAI,CAAC,KAAK;AAAO,YAAM,IAAI,MAAM,mBAAmB;AACpD,WAAO,KAAK;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA,EAKA,cAAc;AACV,0BAAK,sDAAL;AACA,QAAI,CAAC,KAAK;AAAU,YAAM,IAAI,MAAM,sBAAsB;AAC1D,WAAO,KAAK;AAAA,EAChB;AAyCJ;AA5eI;AAEA;AAEA;AAEA;AAEA;AAgcA;AAAA,2BAAsB,SAAC,aAA6B;AAChD,QAAM,CAAC,UAAU,OAAO,IAAI,KAAK,iBAAiB,SAAS;AAAA,IACvD,QAAQ,GAAG,KAAK,YAAY;AAAA,MACxB;AAAA,IACJ;AAAA,IACA,WAAW,CAAC,KAAK,iBAAiB,OAAO,WAAW,CAAC;AAAA,EACzD,CAAC;AAED,OAAK,WAAW;AAChB,qBAAK,cAAe,KAAK,iBAAiB,OAAO,WAAW;AAC5D,qBAAK,UAAW;AAEhB,SAAO;AACX;AAEA;AAAA,wBAAmB,SAAC,EAAE,OAAO,SAAS,GAA4C;AAC9E,MAAI,aAAa;AAAW,uBAAK,kBAAmB;AACpD,MAAI,UAAU;AAAW,uBAAK,eAAgB;AAClD;AAEA;AAAA,wBAAmB,WAAG;AAClB,wBAAK,sDAAL;AAEA,MAAI,CAAC,KAAK,SAAS,CAAC,KAAK;AACrB,UAAM,IAAI;AAAA,MACN;AAAA,IACJ;AACR;AAGA;AAAA,6BAAwB,WAAG;AACvB,MAAI,mBAAK;AACL,UAAM,IAAI;AAAA,MACN;AAAA,IACJ;AACR;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
import type { TransactionBlock } from '@iota/iota-sdk/transactions';
|
|
2
|
+
import type { ObjectArgument, TransferPolicyCap } from '../types/index.js';
|
|
3
|
+
import type { KioskClient } from './kiosk-client.js';
|
|
4
|
+
export type TransferPolicyBaseParams = {
|
|
5
|
+
type: string;
|
|
6
|
+
publisher: ObjectArgument;
|
|
7
|
+
skipCheck?: boolean;
|
|
8
|
+
};
|
|
9
|
+
export type TransferPolicyTransactionParams = {
|
|
10
|
+
kioskClient: KioskClient;
|
|
11
|
+
transactionBlock: TransactionBlock;
|
|
12
|
+
cap?: TransferPolicyCap;
|
|
13
|
+
};
|
|
14
|
+
export declare class TransferPolicyTransaction {
|
|
15
|
+
#private;
|
|
16
|
+
transactionBlock: TransactionBlock;
|
|
17
|
+
kioskClient: KioskClient;
|
|
18
|
+
policy?: ObjectArgument;
|
|
19
|
+
policyCap?: ObjectArgument;
|
|
20
|
+
type?: string;
|
|
21
|
+
constructor({ kioskClient, transactionBlock, cap }: TransferPolicyTransactionParams);
|
|
22
|
+
/**
|
|
23
|
+
* A function to create a new transfer policy.
|
|
24
|
+
* Checks if there's already an existing transfer policy to prevent
|
|
25
|
+
* double transfer policy mistakes.
|
|
26
|
+
* There's an optional `skipCheck` flag that will just create the policy
|
|
27
|
+
* without checking
|
|
28
|
+
*
|
|
29
|
+
* @param type The Type (`T`) for which we're creating the transfer policy.
|
|
30
|
+
* @param publisher The Publisher Object Id.
|
|
31
|
+
* @param address Address to save the `TransferPolicyCap` object to.
|
|
32
|
+
* @param skipCheck (Optional) skip checking if a transfer policy already exists
|
|
33
|
+
*/
|
|
34
|
+
createAndShare({ type, publisher, address, skipCheck, }: TransferPolicyBaseParams & {
|
|
35
|
+
address: string;
|
|
36
|
+
}): Promise<void>;
|
|
37
|
+
/**
|
|
38
|
+
* A convenient function to create a Transfer Policy and attach some rules
|
|
39
|
+
* before sharing it (so you can prepare it in a single PTB)
|
|
40
|
+
* @param type The Type (`T`) for which we're creating the transfer policy.
|
|
41
|
+
* @param publisher The Publisher Object Id.
|
|
42
|
+
* @param address Address to save the `TransferPolicyCap` object to.
|
|
43
|
+
* @param skipCheck (Optional) skip checking if a transfer policy already exists
|
|
44
|
+
*/
|
|
45
|
+
create({ type, publisher, skipCheck, }: TransferPolicyBaseParams): Promise<TransferPolicyTransaction>;
|
|
46
|
+
/**
|
|
47
|
+
* This can be called after calling the `create` function to share the `TransferPolicy`,
|
|
48
|
+
* and transfer the `TransferPolicyCap` to the specified address
|
|
49
|
+
*
|
|
50
|
+
* @param address The address to transfer the `TransferPolicyCap`
|
|
51
|
+
*/
|
|
52
|
+
shareAndTransferCap(address: string): void;
|
|
53
|
+
/**
|
|
54
|
+
* Setup the TransferPolicy by passing a `cap` returned from `kioskClient.getOwnedTransferPolicies` or
|
|
55
|
+
* `kioskClient.getOwnedTransferPoliciesByType`.
|
|
56
|
+
* @param policyCapId The `TransferPolicyCap`
|
|
57
|
+
*/
|
|
58
|
+
setCap({ policyId, policyCapId, type }: TransferPolicyCap): this;
|
|
59
|
+
/**
|
|
60
|
+
* Withdraw from the transfer policy's profits.
|
|
61
|
+
* @param address Address to transfer the profits to.
|
|
62
|
+
* @param amount (Optional) amount parameter. Will withdraw all profits if the amount is not specified.
|
|
63
|
+
*/
|
|
64
|
+
withdraw(address: string, amount?: string | bigint): this;
|
|
65
|
+
/**
|
|
66
|
+
* Adds the Kiosk Royalty rule to the Transfer Policy.
|
|
67
|
+
* You can pass the percentage, as well as a minimum amount.
|
|
68
|
+
* The royalty that will be paid is the MAX(percentage, minAmount).
|
|
69
|
+
* You can pass 0 in either value if you want only percentage royalty, or a fixed amount fee.
|
|
70
|
+
* (but you should define at least one of them for the rule to make sense).
|
|
71
|
+
*
|
|
72
|
+
* @param percentageBps The royalty percentage in basis points. Use `percentageToBasisPoints` helper to convert from percentage [0,100].
|
|
73
|
+
* @param minAmount The minimum royalty amount per request in nano.
|
|
74
|
+
*/
|
|
75
|
+
addRoyaltyRule(percentageBps: number | string, // this is in basis points.
|
|
76
|
+
minAmount: number | string): this;
|
|
77
|
+
/**
|
|
78
|
+
* Adds the Kiosk Lock Rule to the Transfer Policy.
|
|
79
|
+
* This Rule forces buyer to lock the item in the kiosk, preserving strong royalties.
|
|
80
|
+
*/
|
|
81
|
+
addLockRule(): this;
|
|
82
|
+
/**
|
|
83
|
+
* Attaches the Personal Kiosk Rule, making a purchase valid only for `SoulBound` kiosks.
|
|
84
|
+
*/
|
|
85
|
+
addPersonalKioskRule(): this;
|
|
86
|
+
/**
|
|
87
|
+
* A function to add the floor price rule to a transfer policy.
|
|
88
|
+
* @param minPrice The minimum price in nano.
|
|
89
|
+
*/
|
|
90
|
+
addFloorPriceRule(minPrice: string | bigint): this;
|
|
91
|
+
/**
|
|
92
|
+
* Generic helper to remove a rule, not from the SDK's base ruleset.
|
|
93
|
+
* @param ruleType The Rule Type
|
|
94
|
+
* @param configType The Config Type
|
|
95
|
+
*/
|
|
96
|
+
removeRule({ ruleType, configType }: {
|
|
97
|
+
ruleType: string;
|
|
98
|
+
configType: string;
|
|
99
|
+
}): void;
|
|
100
|
+
/**
|
|
101
|
+
* Removes the lock rule.
|
|
102
|
+
*/
|
|
103
|
+
removeLockRule(): this;
|
|
104
|
+
/**
|
|
105
|
+
* Removes the Royalty rule
|
|
106
|
+
*/
|
|
107
|
+
removeRoyaltyRule(): this;
|
|
108
|
+
removePersonalKioskRule(): this;
|
|
109
|
+
removeFloorPriceRule(): this;
|
|
110
|
+
getPolicy(): ObjectArgument;
|
|
111
|
+
getPolicyCap(): ObjectArgument;
|
|
112
|
+
}
|
|
@@ -0,0 +1,314 @@
|
|
|
1
|
+
var __accessCheck = (obj, member, msg) => {
|
|
2
|
+
if (!member.has(obj))
|
|
3
|
+
throw TypeError("Cannot " + msg);
|
|
4
|
+
};
|
|
5
|
+
var __privateAdd = (obj, member, value) => {
|
|
6
|
+
if (member.has(obj))
|
|
7
|
+
throw TypeError("Cannot add the same private member more than once");
|
|
8
|
+
member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
|
|
9
|
+
};
|
|
10
|
+
var __privateMethod = (obj, member, method) => {
|
|
11
|
+
__accessCheck(obj, member, "access private method");
|
|
12
|
+
return method;
|
|
13
|
+
};
|
|
14
|
+
var _validateInputs, validateInputs_fn, _setup, setup_fn;
|
|
15
|
+
import {
|
|
16
|
+
attachFloorPriceRuleTx,
|
|
17
|
+
attachKioskLockRuleTx,
|
|
18
|
+
attachPersonalKioskRuleTx,
|
|
19
|
+
attachRoyaltyRuleTx
|
|
20
|
+
} from "../tx/rules/attach.js";
|
|
21
|
+
import {
|
|
22
|
+
createTransferPolicy,
|
|
23
|
+
createTransferPolicyWithoutSharing,
|
|
24
|
+
removeTransferPolicyRule,
|
|
25
|
+
shareTransferPolicy,
|
|
26
|
+
withdrawFromPolicy
|
|
27
|
+
} from "../tx/transfer-policy.js";
|
|
28
|
+
class TransferPolicyTransaction {
|
|
29
|
+
constructor({ kioskClient, transactionBlock, cap }) {
|
|
30
|
+
// Internal function that that the policy's Id + Cap + type have been set.
|
|
31
|
+
__privateAdd(this, _validateInputs);
|
|
32
|
+
/**
|
|
33
|
+
* Setup the state of the TransferPolicyTransaction.
|
|
34
|
+
*/
|
|
35
|
+
__privateAdd(this, _setup);
|
|
36
|
+
this.kioskClient = kioskClient;
|
|
37
|
+
this.transactionBlock = transactionBlock;
|
|
38
|
+
if (cap)
|
|
39
|
+
this.setCap(cap);
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* A function to create a new transfer policy.
|
|
43
|
+
* Checks if there's already an existing transfer policy to prevent
|
|
44
|
+
* double transfer policy mistakes.
|
|
45
|
+
* There's an optional `skipCheck` flag that will just create the policy
|
|
46
|
+
* without checking
|
|
47
|
+
*
|
|
48
|
+
* @param type The Type (`T`) for which we're creating the transfer policy.
|
|
49
|
+
* @param publisher The Publisher Object Id.
|
|
50
|
+
* @param address Address to save the `TransferPolicyCap` object to.
|
|
51
|
+
* @param skipCheck (Optional) skip checking if a transfer policy already exists
|
|
52
|
+
*/
|
|
53
|
+
async createAndShare({
|
|
54
|
+
type,
|
|
55
|
+
publisher,
|
|
56
|
+
address,
|
|
57
|
+
skipCheck
|
|
58
|
+
}) {
|
|
59
|
+
if (!skipCheck) {
|
|
60
|
+
const policies = await this.kioskClient.getTransferPolicies({ type });
|
|
61
|
+
if (policies.length > 0)
|
|
62
|
+
throw new Error("There's already transfer policy for this Type.");
|
|
63
|
+
}
|
|
64
|
+
const cap = createTransferPolicy(this.transactionBlock, type, publisher);
|
|
65
|
+
this.transactionBlock.transferObjects([cap], this.transactionBlock.pure.address(address));
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* A convenient function to create a Transfer Policy and attach some rules
|
|
69
|
+
* before sharing it (so you can prepare it in a single PTB)
|
|
70
|
+
* @param type The Type (`T`) for which we're creating the transfer policy.
|
|
71
|
+
* @param publisher The Publisher Object Id.
|
|
72
|
+
* @param address Address to save the `TransferPolicyCap` object to.
|
|
73
|
+
* @param skipCheck (Optional) skip checking if a transfer policy already exists
|
|
74
|
+
*/
|
|
75
|
+
async create({
|
|
76
|
+
type,
|
|
77
|
+
publisher,
|
|
78
|
+
skipCheck
|
|
79
|
+
}) {
|
|
80
|
+
if (!skipCheck) {
|
|
81
|
+
const policies = await this.kioskClient.getTransferPolicies({ type });
|
|
82
|
+
if (policies.length > 0)
|
|
83
|
+
throw new Error("There's already transfer policy for this Type.");
|
|
84
|
+
}
|
|
85
|
+
const [policy, policyCap] = createTransferPolicyWithoutSharing(
|
|
86
|
+
this.transactionBlock,
|
|
87
|
+
type,
|
|
88
|
+
publisher
|
|
89
|
+
);
|
|
90
|
+
__privateMethod(this, _setup, setup_fn).call(this, policy, policyCap, type);
|
|
91
|
+
return this;
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* This can be called after calling the `create` function to share the `TransferPolicy`,
|
|
95
|
+
* and transfer the `TransferPolicyCap` to the specified address
|
|
96
|
+
*
|
|
97
|
+
* @param address The address to transfer the `TransferPolicyCap`
|
|
98
|
+
*/
|
|
99
|
+
shareAndTransferCap(address) {
|
|
100
|
+
if (!this.type || !this.policyCap || !this.policy)
|
|
101
|
+
throw new Error(
|
|
102
|
+
"This function can only be called after `transferPolicyManager.create`"
|
|
103
|
+
);
|
|
104
|
+
shareTransferPolicy(
|
|
105
|
+
this.transactionBlock,
|
|
106
|
+
this.type,
|
|
107
|
+
this.policy
|
|
108
|
+
);
|
|
109
|
+
this.transactionBlock.transferObjects(
|
|
110
|
+
[this.policyCap],
|
|
111
|
+
this.transactionBlock.pure.address(address)
|
|
112
|
+
);
|
|
113
|
+
}
|
|
114
|
+
/**
|
|
115
|
+
* Setup the TransferPolicy by passing a `cap` returned from `kioskClient.getOwnedTransferPolicies` or
|
|
116
|
+
* `kioskClient.getOwnedTransferPoliciesByType`.
|
|
117
|
+
* @param policyCapId The `TransferPolicyCap`
|
|
118
|
+
*/
|
|
119
|
+
setCap({ policyId, policyCapId, type }) {
|
|
120
|
+
return __privateMethod(this, _setup, setup_fn).call(this, policyId, policyCapId, type);
|
|
121
|
+
}
|
|
122
|
+
/**
|
|
123
|
+
* Withdraw from the transfer policy's profits.
|
|
124
|
+
* @param address Address to transfer the profits to.
|
|
125
|
+
* @param amount (Optional) amount parameter. Will withdraw all profits if the amount is not specified.
|
|
126
|
+
*/
|
|
127
|
+
withdraw(address, amount) {
|
|
128
|
+
__privateMethod(this, _validateInputs, validateInputs_fn).call(this);
|
|
129
|
+
const coin = withdrawFromPolicy(
|
|
130
|
+
this.transactionBlock,
|
|
131
|
+
this.type,
|
|
132
|
+
this.policy,
|
|
133
|
+
this.policyCap,
|
|
134
|
+
amount
|
|
135
|
+
);
|
|
136
|
+
this.transactionBlock.transferObjects([coin], this.transactionBlock.pure.address(address));
|
|
137
|
+
return this;
|
|
138
|
+
}
|
|
139
|
+
/**
|
|
140
|
+
* Adds the Kiosk Royalty rule to the Transfer Policy.
|
|
141
|
+
* You can pass the percentage, as well as a minimum amount.
|
|
142
|
+
* The royalty that will be paid is the MAX(percentage, minAmount).
|
|
143
|
+
* You can pass 0 in either value if you want only percentage royalty, or a fixed amount fee.
|
|
144
|
+
* (but you should define at least one of them for the rule to make sense).
|
|
145
|
+
*
|
|
146
|
+
* @param percentageBps The royalty percentage in basis points. Use `percentageToBasisPoints` helper to convert from percentage [0,100].
|
|
147
|
+
* @param minAmount The minimum royalty amount per request in nano.
|
|
148
|
+
*/
|
|
149
|
+
addRoyaltyRule(percentageBps, minAmount) {
|
|
150
|
+
__privateMethod(this, _validateInputs, validateInputs_fn).call(this);
|
|
151
|
+
attachRoyaltyRuleTx(
|
|
152
|
+
this.transactionBlock,
|
|
153
|
+
this.type,
|
|
154
|
+
this.policy,
|
|
155
|
+
this.policyCap,
|
|
156
|
+
percentageBps,
|
|
157
|
+
minAmount,
|
|
158
|
+
this.kioskClient.getRulePackageId("royaltyRulePackageId")
|
|
159
|
+
);
|
|
160
|
+
return this;
|
|
161
|
+
}
|
|
162
|
+
/**
|
|
163
|
+
* Adds the Kiosk Lock Rule to the Transfer Policy.
|
|
164
|
+
* This Rule forces buyer to lock the item in the kiosk, preserving strong royalties.
|
|
165
|
+
*/
|
|
166
|
+
addLockRule() {
|
|
167
|
+
__privateMethod(this, _validateInputs, validateInputs_fn).call(this);
|
|
168
|
+
attachKioskLockRuleTx(
|
|
169
|
+
this.transactionBlock,
|
|
170
|
+
this.type,
|
|
171
|
+
this.policy,
|
|
172
|
+
this.policyCap,
|
|
173
|
+
this.kioskClient.getRulePackageId("kioskLockRulePackageId")
|
|
174
|
+
);
|
|
175
|
+
return this;
|
|
176
|
+
}
|
|
177
|
+
/**
|
|
178
|
+
* Attaches the Personal Kiosk Rule, making a purchase valid only for `SoulBound` kiosks.
|
|
179
|
+
*/
|
|
180
|
+
addPersonalKioskRule() {
|
|
181
|
+
__privateMethod(this, _validateInputs, validateInputs_fn).call(this);
|
|
182
|
+
attachPersonalKioskRuleTx(
|
|
183
|
+
this.transactionBlock,
|
|
184
|
+
this.type,
|
|
185
|
+
this.policy,
|
|
186
|
+
this.policyCap,
|
|
187
|
+
this.kioskClient.getRulePackageId("personalKioskRulePackageId")
|
|
188
|
+
);
|
|
189
|
+
return this;
|
|
190
|
+
}
|
|
191
|
+
/**
|
|
192
|
+
* A function to add the floor price rule to a transfer policy.
|
|
193
|
+
* @param minPrice The minimum price in nano.
|
|
194
|
+
*/
|
|
195
|
+
addFloorPriceRule(minPrice) {
|
|
196
|
+
__privateMethod(this, _validateInputs, validateInputs_fn).call(this);
|
|
197
|
+
attachFloorPriceRuleTx(
|
|
198
|
+
this.transactionBlock,
|
|
199
|
+
this.type,
|
|
200
|
+
this.policy,
|
|
201
|
+
this.policyCap,
|
|
202
|
+
minPrice,
|
|
203
|
+
this.kioskClient.getRulePackageId("floorPriceRulePackageId")
|
|
204
|
+
);
|
|
205
|
+
return this;
|
|
206
|
+
}
|
|
207
|
+
/**
|
|
208
|
+
* Generic helper to remove a rule, not from the SDK's base ruleset.
|
|
209
|
+
* @param ruleType The Rule Type
|
|
210
|
+
* @param configType The Config Type
|
|
211
|
+
*/
|
|
212
|
+
removeRule({ ruleType, configType }) {
|
|
213
|
+
__privateMethod(this, _validateInputs, validateInputs_fn).call(this);
|
|
214
|
+
removeTransferPolicyRule(
|
|
215
|
+
this.transactionBlock,
|
|
216
|
+
this.type,
|
|
217
|
+
ruleType,
|
|
218
|
+
configType,
|
|
219
|
+
this.policy,
|
|
220
|
+
this.policyCap
|
|
221
|
+
);
|
|
222
|
+
}
|
|
223
|
+
/**
|
|
224
|
+
* Removes the lock rule.
|
|
225
|
+
*/
|
|
226
|
+
removeLockRule() {
|
|
227
|
+
__privateMethod(this, _validateInputs, validateInputs_fn).call(this);
|
|
228
|
+
const packageId = this.kioskClient.getRulePackageId("kioskLockRulePackageId");
|
|
229
|
+
removeTransferPolicyRule(
|
|
230
|
+
this.transactionBlock,
|
|
231
|
+
this.type,
|
|
232
|
+
`${packageId}::kiosk_lock_rule::Rule`,
|
|
233
|
+
`${packageId}::kiosk_lock_rule::Config`,
|
|
234
|
+
this.policy,
|
|
235
|
+
this.policyCap
|
|
236
|
+
);
|
|
237
|
+
return this;
|
|
238
|
+
}
|
|
239
|
+
/**
|
|
240
|
+
* Removes the Royalty rule
|
|
241
|
+
*/
|
|
242
|
+
removeRoyaltyRule() {
|
|
243
|
+
__privateMethod(this, _validateInputs, validateInputs_fn).call(this);
|
|
244
|
+
const packageId = this.kioskClient.getRulePackageId("royaltyRulePackageId");
|
|
245
|
+
removeTransferPolicyRule(
|
|
246
|
+
this.transactionBlock,
|
|
247
|
+
this.type,
|
|
248
|
+
`${packageId}::royalty_rule::Rule`,
|
|
249
|
+
`${packageId}::royalty_rule::Config`,
|
|
250
|
+
this.policy,
|
|
251
|
+
this.policyCap
|
|
252
|
+
);
|
|
253
|
+
return this;
|
|
254
|
+
}
|
|
255
|
+
removePersonalKioskRule() {
|
|
256
|
+
__privateMethod(this, _validateInputs, validateInputs_fn).call(this);
|
|
257
|
+
const packageId = this.kioskClient.getRulePackageId("personalKioskRulePackageId");
|
|
258
|
+
removeTransferPolicyRule(
|
|
259
|
+
this.transactionBlock,
|
|
260
|
+
this.type,
|
|
261
|
+
`${packageId}::personal_kiosk_rule::Rule`,
|
|
262
|
+
`bool`,
|
|
263
|
+
this.policy,
|
|
264
|
+
this.policyCap
|
|
265
|
+
);
|
|
266
|
+
return this;
|
|
267
|
+
}
|
|
268
|
+
removeFloorPriceRule() {
|
|
269
|
+
__privateMethod(this, _validateInputs, validateInputs_fn).call(this);
|
|
270
|
+
const packageId = this.kioskClient.getRulePackageId("floorPriceRulePackageId");
|
|
271
|
+
removeTransferPolicyRule(
|
|
272
|
+
this.transactionBlock,
|
|
273
|
+
this.type,
|
|
274
|
+
`${packageId}::floor_price_rule::Rule`,
|
|
275
|
+
`${packageId}::floor_price_rule::Config`,
|
|
276
|
+
this.policy,
|
|
277
|
+
this.policyCap
|
|
278
|
+
);
|
|
279
|
+
return this;
|
|
280
|
+
}
|
|
281
|
+
getPolicy() {
|
|
282
|
+
if (!this.policy)
|
|
283
|
+
throw new Error("Policy not set.");
|
|
284
|
+
return this.policy;
|
|
285
|
+
}
|
|
286
|
+
getPolicyCap() {
|
|
287
|
+
if (!this.policyCap)
|
|
288
|
+
throw new Error("Transfer Policy Cap not set.");
|
|
289
|
+
return this.policyCap;
|
|
290
|
+
}
|
|
291
|
+
}
|
|
292
|
+
_validateInputs = new WeakSet();
|
|
293
|
+
validateInputs_fn = function() {
|
|
294
|
+
const genericErrorMessage = `Please use 'setCap()' to setup the TransferPolicy.`;
|
|
295
|
+
if (!this.policy)
|
|
296
|
+
throw new Error(`${genericErrorMessage} Missing: Transfer Policy Object.`);
|
|
297
|
+
if (!this.policyCap)
|
|
298
|
+
throw new Error(`${genericErrorMessage} Missing: TransferPolicyCap Object ID`);
|
|
299
|
+
if (!this.type)
|
|
300
|
+
throw new Error(
|
|
301
|
+
`${genericErrorMessage} Missing: Transfer Policy object type (e.g. {packageId}::item::Item)`
|
|
302
|
+
);
|
|
303
|
+
};
|
|
304
|
+
_setup = new WeakSet();
|
|
305
|
+
setup_fn = function(policyId, policyCap, type) {
|
|
306
|
+
this.policy = policyId;
|
|
307
|
+
this.policyCap = policyCap;
|
|
308
|
+
this.type = type;
|
|
309
|
+
return this;
|
|
310
|
+
};
|
|
311
|
+
export {
|
|
312
|
+
TransferPolicyTransaction
|
|
313
|
+
};
|
|
314
|
+
//# sourceMappingURL=tp-transaction.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../../src/client/tp-transaction.ts"],
|
|
4
|
+
"sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// Modifications Copyright (c) 2024 IOTA Stiftung\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { TransactionBlock, TransactionObjectArgument } from '@iota/iota-sdk/transactions';\n\nimport {\n attachFloorPriceRuleTx,\n attachKioskLockRuleTx,\n attachPersonalKioskRuleTx,\n attachRoyaltyRuleTx,\n} from '../tx/rules/attach.js';\nimport {\n createTransferPolicy,\n createTransferPolicyWithoutSharing,\n removeTransferPolicyRule,\n shareTransferPolicy,\n withdrawFromPolicy,\n} from '../tx/transfer-policy.js';\nimport type { ObjectArgument, TransferPolicyCap } from '../types/index.js';\nimport type { KioskClient } from './kiosk-client.js';\n\nexport type TransferPolicyBaseParams = {\n type: string;\n publisher: ObjectArgument;\n skipCheck?: boolean;\n};\n\nexport type TransferPolicyTransactionParams = {\n kioskClient: KioskClient;\n transactionBlock: TransactionBlock;\n cap?: TransferPolicyCap;\n};\n\nexport class TransferPolicyTransaction {\n transactionBlock: TransactionBlock;\n kioskClient: KioskClient;\n policy?: ObjectArgument;\n policyCap?: ObjectArgument;\n type?: string;\n\n constructor({ kioskClient, transactionBlock, cap }: TransferPolicyTransactionParams) {\n this.kioskClient = kioskClient;\n this.transactionBlock = transactionBlock;\n if (cap) this.setCap(cap);\n }\n\n /**\n * A function to create a new transfer policy.\n * Checks if there's already an existing transfer policy to prevent\n * double transfer policy mistakes.\n * There's an optional `skipCheck` flag that will just create the policy\n * without checking\n *\n * @param type The Type (`T`) for which we're creating the transfer policy.\n * @param publisher The Publisher Object Id.\n * @param address Address to save the `TransferPolicyCap` object to.\n * @param skipCheck (Optional) skip checking if a transfer policy already exists\n */\n async createAndShare({\n type,\n publisher,\n address,\n skipCheck,\n }: TransferPolicyBaseParams & {\n address: string;\n }) {\n if (!skipCheck) {\n const policies = await this.kioskClient.getTransferPolicies({ type });\n if (policies.length > 0)\n throw new Error(\"There's already transfer policy for this Type.\");\n }\n const cap = createTransferPolicy(this.transactionBlock, type, publisher);\n this.transactionBlock.transferObjects([cap], this.transactionBlock.pure.address(address));\n }\n\n /**\n * A convenient function to create a Transfer Policy and attach some rules\n * before sharing it (so you can prepare it in a single PTB)\n * @param type The Type (`T`) for which we're creating the transfer policy.\n * @param publisher The Publisher Object Id.\n * @param address Address to save the `TransferPolicyCap` object to.\n * @param skipCheck (Optional) skip checking if a transfer policy already exists\n */\n async create({\n type,\n publisher,\n skipCheck,\n }: TransferPolicyBaseParams): Promise<TransferPolicyTransaction> {\n if (!skipCheck) {\n const policies = await this.kioskClient.getTransferPolicies({ type });\n if (policies.length > 0)\n throw new Error(\"There's already transfer policy for this Type.\");\n }\n const [policy, policyCap] = createTransferPolicyWithoutSharing(\n this.transactionBlock,\n type,\n publisher,\n );\n\n this.#setup(policy, policyCap, type); // sets the client's TP to the newly created one.\n return this;\n }\n\n /**\n * This can be called after calling the `create` function to share the `TransferPolicy`,\n * and transfer the `TransferPolicyCap` to the specified address\n *\n * @param address The address to transfer the `TransferPolicyCap`\n */\n shareAndTransferCap(address: string) {\n if (!this.type || !this.policyCap || !this.policy)\n throw new Error(\n 'This function can only be called after `transferPolicyManager.create`',\n );\n\n shareTransferPolicy(\n this.transactionBlock,\n this.type,\n this.policy as TransactionObjectArgument,\n );\n this.transactionBlock.transferObjects(\n [this.policyCap as TransactionObjectArgument],\n this.transactionBlock.pure.address(address),\n );\n }\n\n /**\n * Setup the TransferPolicy by passing a `cap` returned from `kioskClient.getOwnedTransferPolicies` or\n * `kioskClient.getOwnedTransferPoliciesByType`.\n * @param policyCapId The `TransferPolicyCap`\n */\n setCap({ policyId, policyCapId, type }: TransferPolicyCap) {\n return this.#setup(policyId, policyCapId, type);\n }\n\n /**\n * Withdraw from the transfer policy's profits.\n * @param address Address to transfer the profits to.\n * @param amount (Optional) amount parameter. Will withdraw all profits if the amount is not specified.\n */\n withdraw(address: string, amount?: string | bigint) {\n this.#validateInputs();\n // Withdraw coin for specified amount (or none)\n const coin = withdrawFromPolicy(\n this.transactionBlock,\n this.type!,\n this.policy!,\n this.policyCap!,\n amount,\n );\n\n this.transactionBlock.transferObjects([coin], this.transactionBlock.pure.address(address));\n\n return this;\n }\n\n /**\n * Adds the Kiosk Royalty rule to the Transfer Policy.\n * You can pass the percentage, as well as a minimum amount.\n * The royalty that will be paid is the MAX(percentage, minAmount).\n * \tYou can pass 0 in either value if you want only percentage royalty, or a fixed amount fee.\n * \t(but you should define at least one of them for the rule to make sense).\n *\n * \t@param percentageBps The royalty percentage in basis points. Use `percentageToBasisPoints` helper to convert from percentage [0,100].\n * \t@param minAmount The minimum royalty amount per request in nano.\n */\n addRoyaltyRule(\n percentageBps: number | string, // this is in basis points.\n minAmount: number | string,\n ) {\n this.#validateInputs();\n\n // Hard-coding package Ids as these don't change.\n // Also, it's hard to keep versioning as with network wipes, mainnet\n // and testnet will conflict.\n attachRoyaltyRuleTx(\n this.transactionBlock,\n this.type!,\n this.policy!,\n this.policyCap!,\n percentageBps,\n minAmount,\n this.kioskClient.getRulePackageId('royaltyRulePackageId'),\n );\n return this;\n }\n\n /**\n * Adds the Kiosk Lock Rule to the Transfer Policy.\n * This Rule forces buyer to lock the item in the kiosk, preserving strong royalties.\n */\n addLockRule() {\n this.#validateInputs();\n\n attachKioskLockRuleTx(\n this.transactionBlock,\n this.type!,\n this.policy!,\n this.policyCap!,\n this.kioskClient.getRulePackageId('kioskLockRulePackageId'),\n );\n return this;\n }\n\n /**\n * Attaches the Personal Kiosk Rule, making a purchase valid only for `SoulBound` kiosks.\n */\n addPersonalKioskRule() {\n this.#validateInputs();\n\n attachPersonalKioskRuleTx(\n this.transactionBlock,\n this.type!,\n this.policy!,\n this.policyCap!,\n this.kioskClient.getRulePackageId('personalKioskRulePackageId'),\n );\n return this;\n }\n\n /**\n * A function to add the floor price rule to a transfer policy.\n * @param minPrice The minimum price in nano.\n */\n addFloorPriceRule(minPrice: string | bigint) {\n this.#validateInputs();\n\n attachFloorPriceRuleTx(\n this.transactionBlock,\n this.type!,\n this.policy!,\n this.policyCap!,\n minPrice,\n this.kioskClient.getRulePackageId('floorPriceRulePackageId'),\n );\n return this;\n }\n\n /**\n * Generic helper to remove a rule, not from the SDK's base ruleset.\n * @param ruleType The Rule Type\n * @param configType The Config Type\n */\n removeRule({ ruleType, configType }: { ruleType: string; configType: string }) {\n this.#validateInputs();\n\n removeTransferPolicyRule(\n this.transactionBlock,\n this.type!,\n ruleType,\n configType,\n this.policy!,\n this.policyCap!,\n );\n }\n\n /**\n * Removes the lock rule.\n */\n removeLockRule() {\n this.#validateInputs();\n\n const packageId = this.kioskClient.getRulePackageId('kioskLockRulePackageId');\n\n removeTransferPolicyRule(\n this.transactionBlock,\n this.type!,\n `${packageId}::kiosk_lock_rule::Rule`,\n `${packageId}::kiosk_lock_rule::Config`,\n this.policy!,\n this.policyCap!,\n );\n return this;\n }\n\n /**\n * Removes the Royalty rule\n */\n removeRoyaltyRule() {\n this.#validateInputs();\n\n const packageId = this.kioskClient.getRulePackageId('royaltyRulePackageId');\n\n removeTransferPolicyRule(\n this.transactionBlock,\n this.type!,\n `${packageId}::royalty_rule::Rule`,\n `${packageId}::royalty_rule::Config`,\n this.policy!,\n this.policyCap!,\n );\n return this;\n }\n\n removePersonalKioskRule() {\n this.#validateInputs();\n\n const packageId = this.kioskClient.getRulePackageId('personalKioskRulePackageId');\n\n removeTransferPolicyRule(\n this.transactionBlock,\n this.type!,\n `${packageId}::personal_kiosk_rule::Rule`,\n `bool`,\n this.policy!,\n this.policyCap!,\n );\n return this;\n }\n\n removeFloorPriceRule() {\n this.#validateInputs();\n\n const packageId = this.kioskClient.getRulePackageId('floorPriceRulePackageId');\n\n removeTransferPolicyRule(\n this.transactionBlock,\n this.type!,\n `${packageId}::floor_price_rule::Rule`,\n `${packageId}::floor_price_rule::Config`,\n this.policy!,\n this.policyCap!,\n );\n return this;\n }\n\n getPolicy() {\n if (!this.policy) throw new Error('Policy not set.');\n return this.policy;\n }\n\n getPolicyCap() {\n if (!this.policyCap) throw new Error('Transfer Policy Cap not set.');\n return this.policyCap;\n }\n\n // Internal function that that the policy's Id + Cap + type have been set.\n #validateInputs() {\n const genericErrorMessage = `Please use 'setCap()' to setup the TransferPolicy.`;\n if (!this.policy)\n throw new Error(`${genericErrorMessage} Missing: Transfer Policy Object.`);\n if (!this.policyCap)\n throw new Error(`${genericErrorMessage} Missing: TransferPolicyCap Object ID`);\n if (!this.type)\n throw new Error(\n `${genericErrorMessage} Missing: Transfer Policy object type (e.g. {packageId}::item::Item)`,\n );\n }\n\n /**\n * Setup the state of the TransferPolicyTransaction.\n */\n #setup(policyId: ObjectArgument, policyCap: ObjectArgument, type: string) {\n this.policy = policyId;\n this.policyCap = policyCap;\n this.type = type;\n return this;\n }\n}\n"],
|
|
5
|
+
"mappings": ";;;;;;;;;;;;;AAAA;AAMA;AAAA,EACI;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACG;AACP;AAAA,EACI;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACG;AAgBA,MAAM,0BAA0B;AAAA,EAOnC,YAAY,EAAE,aAAa,kBAAkB,IAAI,GAAoC;AAySrF;AAAA;AAeA;AAAA;AAAA;AAAA;AAvTI,SAAK,cAAc;AACnB,SAAK,mBAAmB;AACxB,QAAI;AAAK,WAAK,OAAO,GAAG;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,MAAM,eAAe;AAAA,IACjB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACJ,GAEG;AACC,QAAI,CAAC,WAAW;AACZ,YAAM,WAAW,MAAM,KAAK,YAAY,oBAAoB,EAAE,KAAK,CAAC;AACpE,UAAI,SAAS,SAAS;AAClB,cAAM,IAAI,MAAM,gDAAgD;AAAA,IACxE;AACA,UAAM,MAAM,qBAAqB,KAAK,kBAAkB,MAAM,SAAS;AACvE,SAAK,iBAAiB,gBAAgB,CAAC,GAAG,GAAG,KAAK,iBAAiB,KAAK,QAAQ,OAAO,CAAC;AAAA,EAC5F;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,OAAO;AAAA,IACT;AAAA,IACA;AAAA,IACA;AAAA,EACJ,GAAiE;AAC7D,QAAI,CAAC,WAAW;AACZ,YAAM,WAAW,MAAM,KAAK,YAAY,oBAAoB,EAAE,KAAK,CAAC;AACpE,UAAI,SAAS,SAAS;AAClB,cAAM,IAAI,MAAM,gDAAgD;AAAA,IACxE;AACA,UAAM,CAAC,QAAQ,SAAS,IAAI;AAAA,MACxB,KAAK;AAAA,MACL;AAAA,MACA;AAAA,IACJ;AAEA,0BAAK,kBAAL,WAAY,QAAQ,WAAW;AAC/B,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,oBAAoB,SAAiB;AACjC,QAAI,CAAC,KAAK,QAAQ,CAAC,KAAK,aAAa,CAAC,KAAK;AACvC,YAAM,IAAI;AAAA,QACN;AAAA,MACJ;AAEJ;AAAA,MACI,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,IACT;AACA,SAAK,iBAAiB;AAAA,MAClB,CAAC,KAAK,SAAsC;AAAA,MAC5C,KAAK,iBAAiB,KAAK,QAAQ,OAAO;AAAA,IAC9C;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,EAAE,UAAU,aAAa,KAAK,GAAsB;AACvD,WAAO,sBAAK,kBAAL,WAAY,UAAU,aAAa;AAAA,EAC9C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAS,SAAiB,QAA0B;AAChD,0BAAK,oCAAL;AAEA,UAAM,OAAO;AAAA,MACT,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,IACJ;AAEA,SAAK,iBAAiB,gBAAgB,CAAC,IAAI,GAAG,KAAK,iBAAiB,KAAK,QAAQ,OAAO,CAAC;AAEzF,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,eACI,eACA,WACF;AACE,0BAAK,oCAAL;AAKA;AAAA,MACI,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,MACA;AAAA,MACA,KAAK,YAAY,iBAAiB,sBAAsB;AAAA,IAC5D;AACA,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,cAAc;AACV,0BAAK,oCAAL;AAEA;AAAA,MACI,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK,YAAY,iBAAiB,wBAAwB;AAAA,IAC9D;AACA,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA,EAKA,uBAAuB;AACnB,0BAAK,oCAAL;AAEA;AAAA,MACI,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK,YAAY,iBAAiB,4BAA4B;AAAA,IAClE;AACA,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,kBAAkB,UAA2B;AACzC,0BAAK,oCAAL;AAEA;AAAA,MACI,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,MACA,KAAK,YAAY,iBAAiB,yBAAyB;AAAA,IAC/D;AACA,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,WAAW,EAAE,UAAU,WAAW,GAA6C;AAC3E,0BAAK,oCAAL;AAEA;AAAA,MACI,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,MACA;AAAA,MACA,KAAK;AAAA,MACL,KAAK;AAAA,IACT;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA,EAKA,iBAAiB;AACb,0BAAK,oCAAL;AAEA,UAAM,YAAY,KAAK,YAAY,iBAAiB,wBAAwB;AAE5E;AAAA,MACI,KAAK;AAAA,MACL,KAAK;AAAA,MACL,GAAG;AAAA,MACH,GAAG;AAAA,MACH,KAAK;AAAA,MACL,KAAK;AAAA,IACT;AACA,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA,EAKA,oBAAoB;AAChB,0BAAK,oCAAL;AAEA,UAAM,YAAY,KAAK,YAAY,iBAAiB,sBAAsB;AAE1E;AAAA,MACI,KAAK;AAAA,MACL,KAAK;AAAA,MACL,GAAG;AAAA,MACH,GAAG;AAAA,MACH,KAAK;AAAA,MACL,KAAK;AAAA,IACT;AACA,WAAO;AAAA,EACX;AAAA,EAEA,0BAA0B;AACtB,0BAAK,oCAAL;AAEA,UAAM,YAAY,KAAK,YAAY,iBAAiB,4BAA4B;AAEhF;AAAA,MACI,KAAK;AAAA,MACL,KAAK;AAAA,MACL,GAAG;AAAA,MACH;AAAA,MACA,KAAK;AAAA,MACL,KAAK;AAAA,IACT;AACA,WAAO;AAAA,EACX;AAAA,EAEA,uBAAuB;AACnB,0BAAK,oCAAL;AAEA,UAAM,YAAY,KAAK,YAAY,iBAAiB,yBAAyB;AAE7E;AAAA,MACI,KAAK;AAAA,MACL,KAAK;AAAA,MACL,GAAG;AAAA,MACH,GAAG;AAAA,MACH,KAAK;AAAA,MACL,KAAK;AAAA,IACT;AACA,WAAO;AAAA,EACX;AAAA,EAEA,YAAY;AACR,QAAI,CAAC,KAAK;AAAQ,YAAM,IAAI,MAAM,iBAAiB;AACnD,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,eAAe;AACX,QAAI,CAAC,KAAK;AAAW,YAAM,IAAI,MAAM,8BAA8B;AACnE,WAAO,KAAK;AAAA,EAChB;AAwBJ;AArBI;AAAA,oBAAe,WAAG;AACd,QAAM,sBAAsB;AAC5B,MAAI,CAAC,KAAK;AACN,UAAM,IAAI,MAAM,GAAG,sDAAsD;AAC7E,MAAI,CAAC,KAAK;AACN,UAAM,IAAI,MAAM,GAAG,0DAA0D;AACjF,MAAI,CAAC,KAAK;AACN,UAAM,IAAI;AAAA,MACN,GAAG;AAAA,IACP;AACR;AAKA;AAAA,WAAM,SAAC,UAA0B,WAA2B,MAAc;AACtE,OAAK,SAAS;AACd,OAAK,YAAY;AACjB,OAAK,OAAO;AACZ,SAAO;AACX;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { ObjectArgument, RuleResolvingParams } from './types/index.js';
|
|
2
|
+
/**
|
|
3
|
+
* The base rule package ids that can be extended
|
|
4
|
+
*/
|
|
5
|
+
export type BaseRulePackageIds = {
|
|
6
|
+
royaltyRulePackageId?: string;
|
|
7
|
+
kioskLockRulePackageId?: string;
|
|
8
|
+
personalKioskRulePackageId?: string;
|
|
9
|
+
floorPriceRulePackageId?: string;
|
|
10
|
+
};
|
|
11
|
+
/**
|
|
12
|
+
* The Transfer Policy rule.
|
|
13
|
+
*/
|
|
14
|
+
export type TransferPolicyRule = {
|
|
15
|
+
rule: string;
|
|
16
|
+
packageId: string;
|
|
17
|
+
resolveRuleFunction: (rule: RuleResolvingParams) => ObjectArgument | void;
|
|
18
|
+
hasLockingRule?: boolean;
|
|
19
|
+
};
|
|
20
|
+
/**
|
|
21
|
+
* Constructs a list of rule resolvers based on the params.
|
|
22
|
+
*/
|
|
23
|
+
export declare function getBaseRules({ royaltyRulePackageId, kioskLockRulePackageId, personalKioskRulePackageId, floorPriceRulePackageId, }: BaseRulePackageIds): TransferPolicyRule[];
|
|
24
|
+
export declare const rules: TransferPolicyRule[];
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import { getAllNetworks } from "@iota/iota-sdk/client";
|
|
2
|
+
import {
|
|
3
|
+
resolveFloorPriceRule,
|
|
4
|
+
resolveKioskLockRule,
|
|
5
|
+
resolvePersonalKioskRule,
|
|
6
|
+
resolveRoyaltyRule
|
|
7
|
+
} from "./tx/rules//resolve.js";
|
|
8
|
+
function getBaseRules({
|
|
9
|
+
royaltyRulePackageId,
|
|
10
|
+
kioskLockRulePackageId,
|
|
11
|
+
personalKioskRulePackageId,
|
|
12
|
+
floorPriceRulePackageId
|
|
13
|
+
}) {
|
|
14
|
+
const rules2 = [];
|
|
15
|
+
if (royaltyRulePackageId) {
|
|
16
|
+
rules2.push({
|
|
17
|
+
rule: `${royaltyRulePackageId}::royalty_rule::Rule`,
|
|
18
|
+
packageId: royaltyRulePackageId,
|
|
19
|
+
resolveRuleFunction: resolveRoyaltyRule
|
|
20
|
+
});
|
|
21
|
+
}
|
|
22
|
+
if (kioskLockRulePackageId) {
|
|
23
|
+
rules2.push({
|
|
24
|
+
rule: `${kioskLockRulePackageId}::kiosk_lock_rule::Rule`,
|
|
25
|
+
packageId: kioskLockRulePackageId,
|
|
26
|
+
resolveRuleFunction: resolveKioskLockRule,
|
|
27
|
+
hasLockingRule: true
|
|
28
|
+
});
|
|
29
|
+
}
|
|
30
|
+
if (personalKioskRulePackageId) {
|
|
31
|
+
rules2.push({
|
|
32
|
+
rule: `${personalKioskRulePackageId}::personal_kiosk_rule::Rule`,
|
|
33
|
+
packageId: personalKioskRulePackageId,
|
|
34
|
+
resolveRuleFunction: resolvePersonalKioskRule
|
|
35
|
+
});
|
|
36
|
+
}
|
|
37
|
+
if (floorPriceRulePackageId) {
|
|
38
|
+
rules2.push({
|
|
39
|
+
rule: `${floorPriceRulePackageId}::floor_price_rule::Rule`,
|
|
40
|
+
packageId: floorPriceRulePackageId,
|
|
41
|
+
resolveRuleFunction: resolveFloorPriceRule
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
return rules2;
|
|
45
|
+
}
|
|
46
|
+
const rules = Object.values(getAllNetworks()).filter((network) => network.kiosk).flatMap((network) => getBaseRules(network.kiosk));
|
|
47
|
+
export {
|
|
48
|
+
getBaseRules,
|
|
49
|
+
rules
|
|
50
|
+
};
|
|
51
|
+
//# sourceMappingURL=constants.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../src/constants.ts"],
|
|
4
|
+
"sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// Modifications Copyright (c) 2024 IOTA Stiftung\n// SPDX-License-Identifier: Apache-2.0\n\n// eslint-disable-next-line import/no-cycle\nimport type { KioskConfiguration } from '@iota/iota-sdk/client';\nimport { getAllNetworks } from '@iota/iota-sdk/client';\nimport {\n resolveFloorPriceRule,\n resolveKioskLockRule,\n resolvePersonalKioskRule,\n resolveRoyaltyRule,\n} from './tx/rules//resolve.js';\nimport type { ObjectArgument, RuleResolvingParams } from './types/index.js';\n\n/**\n * The base rule package ids that can be extended\n */\nexport type BaseRulePackageIds = {\n royaltyRulePackageId?: string;\n kioskLockRulePackageId?: string;\n personalKioskRulePackageId?: string;\n floorPriceRulePackageId?: string;\n};\n\n/**\n * The Transfer Policy rule.\n */\nexport type TransferPolicyRule = {\n rule: string;\n packageId: string;\n resolveRuleFunction: (rule: RuleResolvingParams) => ObjectArgument | void;\n hasLockingRule?: boolean;\n};\n\n/**\n * Constructs a list of rule resolvers based on the params.\n */\nexport function getBaseRules({\n royaltyRulePackageId,\n kioskLockRulePackageId,\n personalKioskRulePackageId,\n floorPriceRulePackageId,\n}: BaseRulePackageIds): TransferPolicyRule[] {\n const rules = [];\n\n if (royaltyRulePackageId) {\n rules.push({\n rule: `${royaltyRulePackageId}::royalty_rule::Rule`,\n packageId: royaltyRulePackageId,\n resolveRuleFunction: resolveRoyaltyRule,\n });\n }\n\n if (kioskLockRulePackageId) {\n rules.push({\n rule: `${kioskLockRulePackageId}::kiosk_lock_rule::Rule`,\n packageId: kioskLockRulePackageId,\n resolveRuleFunction: resolveKioskLockRule,\n hasLockingRule: true,\n });\n }\n\n if (personalKioskRulePackageId) {\n rules.push({\n rule: `${personalKioskRulePackageId}::personal_kiosk_rule::Rule`,\n packageId: personalKioskRulePackageId,\n resolveRuleFunction: resolvePersonalKioskRule,\n });\n }\n\n if (floorPriceRulePackageId) {\n rules.push({\n rule: `${floorPriceRulePackageId}::floor_price_rule::Rule`,\n packageId: floorPriceRulePackageId,\n resolveRuleFunction: resolveFloorPriceRule,\n });\n }\n\n return rules;\n}\n\nexport const rules: TransferPolicyRule[] = Object.values(getAllNetworks())\n .filter((network) => network.kiosk)\n .flatMap((network) => getBaseRules(network.kiosk as KioskConfiguration));\n"],
|
|
5
|
+
"mappings": "AAMA,SAAS,sBAAsB;AAC/B;AAAA,EACI;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACG;AA0BA,SAAS,aAAa;AAAA,EACzB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACJ,GAA6C;AACzC,QAAMA,SAAQ,CAAC;AAEf,MAAI,sBAAsB;AACtB,IAAAA,OAAM,KAAK;AAAA,MACP,MAAM,GAAG;AAAA,MACT,WAAW;AAAA,MACX,qBAAqB;AAAA,IACzB,CAAC;AAAA,EACL;AAEA,MAAI,wBAAwB;AACxB,IAAAA,OAAM,KAAK;AAAA,MACP,MAAM,GAAG;AAAA,MACT,WAAW;AAAA,MACX,qBAAqB;AAAA,MACrB,gBAAgB;AAAA,IACpB,CAAC;AAAA,EACL;AAEA,MAAI,4BAA4B;AAC5B,IAAAA,OAAM,KAAK;AAAA,MACP,MAAM,GAAG;AAAA,MACT,WAAW;AAAA,MACX,qBAAqB;AAAA,IACzB,CAAC;AAAA,EACL;AAEA,MAAI,yBAAyB;AACzB,IAAAA,OAAM,KAAK;AAAA,MACP,MAAM,GAAG;AAAA,MACT,WAAW;AAAA,MACX,qBAAqB;AAAA,IACzB,CAAC;AAAA,EACL;AAEA,SAAOA;AACX;AAEO,MAAM,QAA8B,OAAO,OAAO,eAAe,CAAC,EACpE,OAAO,CAAC,YAAY,QAAQ,KAAK,EACjC,QAAQ,CAAC,YAAY,aAAa,QAAQ,KAA2B,CAAC;",
|
|
6
|
+
"names": ["rules"]
|
|
7
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
export * from "./utils.js";
|
|
2
|
+
export * from "./types/index.js";
|
|
3
|
+
export * from "./constants.js";
|
|
4
|
+
export * from "./client/kiosk-client.js";
|
|
5
|
+
export * from "./client/tp-transaction.js";
|
|
6
|
+
export * from "./client/kiosk-transaction.js";
|
|
7
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../src/index.ts"],
|
|
4
|
+
"sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// Modifications Copyright (c) 2024 IOTA Stiftung\n// SPDX-License-Identifier: Apache-2.0\n\nexport * from './utils.js';\nexport * from './types/index.js';\nexport * from './constants.js';\nexport * from './client/kiosk-client.js';\nexport * from './client/tp-transaction.js';\nexport * from './client/kiosk-transaction.js';\n"],
|
|
5
|
+
"mappings": "AAIA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|