@mysten/kiosk 0.7.13 → 0.8.1

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

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

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

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

package/dist/esm/constants.d.ts

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

package/dist/esm/constants.js

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

package/dist/esm/constants.js.map

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

package/dist/esm/index.d.ts

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

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+export * from "./utils.js";
+export * from "./types/index.js";
+export * from "./constants.js";
+export * from "./client/kiosk-client.js";
+export * from "./client/tp-transaction.js";
+export * from "./client/kiosk-transaction.js";
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/index.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\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"],
+  "mappings": "AAGA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;",
+  "names": []
+}

package/dist/esm/package.json

@@ -0,0 +1,5 @@
+{
+  "private": true,
+  "type": "module",
+  "sideEffects": false
+}

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

@@ -0,0 +1,14 @@
+import type { PaginationArguments, SuiClient } from '@mysten/sui.js/client';
+import type { FetchKioskOptions, KioskExtension, OwnedKiosks, PagedKioskData } from '../types/index.js';
+export declare function fetchKiosk(client: SuiClient, kioskId: string, pagination: PaginationArguments<string>, options: FetchKioskOptions): Promise<PagedKioskData>;
+/**
+ * A function to fetch all the user's kiosk Caps
+ * And a list of the kiosk address ids.
+ * Returns a list of `kioskOwnerCapIds` and `kioskIds`.
+ * Extra options allow pagination.
+ */
+export declare function getOwnedKiosks(client: SuiClient, address: string, options?: {
+    pagination?: PaginationArguments<string>;
+    personalKioskType: string;
+}): Promise<OwnedKiosks>;
+export declare function fetchKioskExtension(client: SuiClient, kioskId: string, extensionType: string): Promise<KioskExtension | null>;

package/dist/esm/query/kiosk.js

@@ -0,0 +1,112 @@
+import { isValidSuiAddress } from "@mysten/sui.js/utils";
+import { KIOSK_OWNER_CAP } from "../types/index.js";
+import {
+  attachListingsAndPrices,
+  attachLockedItems,
+  attachObjects,
+  extractKioskData,
+  getAllDynamicFields,
+  getAllObjects,
+  getKioskObject
+} from "../utils.js";
+async function fetchKiosk(client, kioskId, pagination, options) {
+  const data = await getAllDynamicFields(client, kioskId, pagination);
+  const listings = [];
+  const lockedItemIds = [];
+  const kioskData = extractKioskData(data, listings, lockedItemIds, kioskId);
+  const [kiosk, listingObjects, items] = await Promise.all([
+    options.withKioskFields ? getKioskObject(client, kioskId) : Promise.resolve(void 0),
+    options.withListingPrices ? getAllObjects(client, kioskData.listingIds, {
+      showContent: true
+    }) : Promise.resolve([]),
+    options.withObjects ? getAllObjects(client, kioskData.itemIds, options.objectOptions || { showDisplay: true }) : Promise.resolve([])
+  ]);
+  if (options.withKioskFields)
+    kioskData.kiosk = kiosk;
+  attachListingsAndPrices(kioskData, listings, listingObjects);
+  attachLockedItems(kioskData, lockedItemIds);
+  attachObjects(
+    kioskData,
+    items.filter((x) => !!x.data).map((x) => x.data)
+  );
+  return {
+    data: kioskData,
+    nextCursor: null,
+    hasNextPage: false
+  };
+}
+async function getOwnedKiosks(client, address, options) {
+  if (!isValidSuiAddress(address))
+    return {
+      nextCursor: null,
+      hasNextPage: false,
+      kioskOwnerCaps: [],
+      kioskIds: []
+    };
+  const filter = {
+    MatchAny: [
+      {
+        StructType: KIOSK_OWNER_CAP
+      }
+    ]
+  };
+  if (options?.personalKioskType) {
+    filter.MatchAny.push({
+      StructType: options.personalKioskType
+    });
+  }
+  const { data, hasNextPage, nextCursor } = await client.getOwnedObjects({
+    owner: address,
+    filter,
+    options: {
+      showContent: true,
+      showType: true
+    },
+    ...options?.pagination || {}
+  });
+  const kioskIdList = data?.map((x) => {
+    const fields = x.data?.content?.dataType === "moveObject" ? x.data.content.fields : null;
+    return fields?.cap ? fields?.cap?.fields?.for : fields?.for;
+  });
+  const filteredData = data.filter((x) => "data" in x).map((x) => x.data);
+  return {
+    nextCursor,
+    hasNextPage,
+    kioskOwnerCaps: filteredData.map((x, idx) => ({
+      isPersonal: x.type !== KIOSK_OWNER_CAP,
+      digest: x.digest,
+      version: x.version,
+      objectId: x.objectId,
+      kioskId: kioskIdList[idx]
+    })),
+    kioskIds: kioskIdList
+  };
+}
+async function fetchKioskExtension(client, kioskId, extensionType) {
+  const extension = await client.getDynamicFieldObject({
+    parentId: kioskId,
+    name: {
+      type: `0x2::kiosk_extension::ExtensionKey<${extensionType}>`,
+      value: {
+        dummy_field: false
+      }
+    }
+  });
+  if (!extension.data)
+    return null;
+  const fields = extension?.data?.content?.fields?.value?.fields;
+  return {
+    objectId: extension.data.objectId,
+    type: extensionType,
+    isEnabled: fields?.is_enabled,
+    permissions: fields?.permissions,
+    storageId: fields?.storage?.fields?.id?.id,
+    storageSize: fields?.storage?.fields?.size
+  };
+}
+export {
+  fetchKiosk,
+  fetchKioskExtension,
+  getOwnedKiosks
+};
+//# sourceMappingURL=kiosk.js.map

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

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/query/kiosk.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport type {\n\tPaginationArguments,\n\tSuiClient,\n\tSuiObjectData,\n\tSuiObjectDataFilter,\n\tSuiObjectResponse,\n} from '@mysten/sui.js/client';\nimport { isValidSuiAddress } from '@mysten/sui.js/utils';\n\nimport type {\n\tFetchKioskOptions,\n\tKioskExtension,\n\tKioskListing,\n\tOwnedKiosks,\n\tPagedKioskData,\n} from '../types/index.js';\nimport { KIOSK_OWNER_CAP } from '../types/index.js';\nimport {\n\tattachListingsAndPrices,\n\tattachLockedItems,\n\tattachObjects,\n\textractKioskData,\n\tgetAllDynamicFields,\n\tgetAllObjects,\n\tgetKioskObject,\n} from '../utils.js';\n\nexport async function fetchKiosk(\n\tclient: SuiClient,\n\tkioskId: string,\n\tpagination: PaginationArguments<string>,\n\toptions: FetchKioskOptions,\n): Promise<PagedKioskData> {\n\t// TODO: Replace the `getAllDynamicFields` with a paginated\n\t// response, once we have better RPC support for\n\t// type filtering & batch fetching.\n\t// This can't work with pagination currently.\n\tconst data = await getAllDynamicFields(client, kioskId, pagination);\n\n\tconst listings: KioskListing[] = [];\n\tconst lockedItemIds: string[] = [];\n\n\t// extracted kiosk data.\n\tconst kioskData = extractKioskData(data, listings, lockedItemIds, kioskId);\n\n\t// split the fetching in two queries as we are most likely passing different options for each kind.\n\t// For items, we usually seek the Display.\n\t// For listings we usually seek the DF value (price) / exclusivity.\n\tconst [kiosk, listingObjects, items] = await Promise.all([\n\t\toptions.withKioskFields ? getKioskObject(client, kioskId) : Promise.resolve(undefined),\n\t\toptions.withListingPrices\n\t\t\t? getAllObjects(client, kioskData.listingIds, {\n\t\t\t\t\tshowContent: true,\n\t\t\t  })\n\t\t\t: Promise.resolve([]),\n\t\toptions.withObjects\n\t\t\t? getAllObjects(client, kioskData.itemIds, options.objectOptions || { showDisplay: true })\n\t\t\t: Promise.resolve([]),\n\t]);\n\n\tif (options.withKioskFields) kioskData.kiosk = kiosk;\n\t// attach items listings. IF we have `options.withListingPrices === true`, it will also attach the prices.\n\tattachListingsAndPrices(kioskData, listings, listingObjects);\n\t// add `locked` status to items that are locked.\n\tattachLockedItems(kioskData, lockedItemIds);\n\n\t// Attach the objects for the queried items.\n\tattachObjects(\n\t\tkioskData,\n\t\titems.filter((x) => !!x.data).map((x) => x.data!),\n\t);\n\n\treturn {\n\t\tdata: kioskData,\n\t\tnextCursor: null,\n\t\thasNextPage: false,\n\t};\n}\n\n/**\n * A function to fetch all the user's kiosk Caps\n * And a list of the kiosk address ids.\n * Returns a list of `kioskOwnerCapIds` and `kioskIds`.\n * Extra options allow pagination.\n */\nexport async function getOwnedKiosks(\n\tclient: SuiClient,\n\taddress: string,\n\toptions?: {\n\t\tpagination?: PaginationArguments<string>;\n\t\tpersonalKioskType: string;\n\t},\n): Promise<OwnedKiosks> {\n\tif (!isValidSuiAddress(address))\n\t\treturn {\n\t\t\tnextCursor: null,\n\t\t\thasNextPage: false,\n\t\t\tkioskOwnerCaps: [],\n\t\t\tkioskIds: [],\n\t\t};\n\n\tconst filter: SuiObjectDataFilter = {\n\t\tMatchAny: [\n\t\t\t{\n\t\t\t\tStructType: KIOSK_OWNER_CAP,\n\t\t\t},\n\t\t],\n\t};\n\n\tif (options?.personalKioskType) {\n\t\tfilter.MatchAny.push({\n\t\t\tStructType: options.personalKioskType,\n\t\t});\n\t}\n\n\t// fetch owned kiosk caps, paginated.\n\tconst { data, hasNextPage, nextCursor } = await client.getOwnedObjects({\n\t\towner: address,\n\t\tfilter,\n\t\toptions: {\n\t\t\tshowContent: true,\n\t\t\tshowType: true,\n\t\t},\n\t\t...(options?.pagination || {}),\n\t});\n\n\t// get kioskIds from the OwnerCaps.\n\tconst kioskIdList = data?.map((x: SuiObjectResponse) => {\n\t\tconst fields = x.data?.content?.dataType === 'moveObject' ? x.data.content.fields : null;\n\t\t// @ts-ignore-next-line TODO: should i remove ts ignore here?\n\t\treturn (fields?.cap ? fields?.cap?.fields?.for : fields?.for) as string;\n\t\t// return (fields as { for: string })?.for;\n\t});\n\n\t// clean up data that might have an error in them.\n\t// only return valid objects.\n\tconst filteredData = data.filter((x) => 'data' in x).map((x) => x.data) as SuiObjectData[];\n\n\treturn {\n\t\tnextCursor,\n\t\thasNextPage,\n\t\tkioskOwnerCaps: filteredData.map((x, idx) => ({\n\t\t\tisPersonal: x.type !== KIOSK_OWNER_CAP,\n\t\t\tdigest: x.digest,\n\t\t\tversion: x.version,\n\t\t\tobjectId: x.objectId,\n\t\t\tkioskId: kioskIdList[idx],\n\t\t})),\n\t\tkioskIds: kioskIdList,\n\t};\n}\n\n// Get a kiosk extension data for a given kioskId and extensionType.\nexport async function fetchKioskExtension(\n\tclient: SuiClient,\n\tkioskId: string,\n\textensionType: string,\n): Promise<KioskExtension | null> {\n\tconst extension = await client.getDynamicFieldObject({\n\t\tparentId: kioskId,\n\t\tname: {\n\t\t\ttype: `0x2::kiosk_extension::ExtensionKey<${extensionType}>`,\n\t\t\tvalue: {\n\t\t\t\tdummy_field: false,\n\t\t\t},\n\t\t},\n\t});\n\n\tif (!extension.data) return null;\n\n\tconst fields = (extension?.data?.content as { fields: { [k: string]: any } })?.fields?.value\n\t\t?.fields;\n\n\treturn {\n\t\tobjectId: extension.data.objectId,\n\t\ttype: extensionType,\n\t\tisEnabled: fields?.is_enabled,\n\t\tpermissions: fields?.permissions,\n\t\tstorageId: fields?.storage?.fields?.id?.id,\n\t\tstorageSize: fields?.storage?.fields?.size,\n\t};\n}\n"],
+  "mappings": "AAUA,SAAS,yBAAyB;AASlC,SAAS,uBAAuB;AAChC;AAAA,EACC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACM;AAEP,eAAsB,WACrB,QACA,SACA,YACA,SAC0B;AAK1B,QAAM,OAAO,MAAM,oBAAoB,QAAQ,SAAS,UAAU;AAElE,QAAM,WAA2B,CAAC;AAClC,QAAM,gBAA0B,CAAC;AAGjC,QAAM,YAAY,iBAAiB,MAAM,UAAU,eAAe,OAAO;AAKzE,QAAM,CAAC,OAAO,gBAAgB,KAAK,IAAI,MAAM,QAAQ,IAAI;AAAA,IACxD,QAAQ,kBAAkB,eAAe,QAAQ,OAAO,IAAI,QAAQ,QAAQ,MAAS;AAAA,IACrF,QAAQ,oBACL,cAAc,QAAQ,UAAU,YAAY;AAAA,MAC5C,aAAa;AAAA,IACb,CAAC,IACD,QAAQ,QAAQ,CAAC,CAAC;AAAA,IACrB,QAAQ,cACL,cAAc,QAAQ,UAAU,SAAS,QAAQ,iBAAiB,EAAE,aAAa,KAAK,CAAC,IACvF,QAAQ,QAAQ,CAAC,CAAC;AAAA,EACtB,CAAC;AAED,MAAI,QAAQ;AAAiB,cAAU,QAAQ;AAE/C,0BAAwB,WAAW,UAAU,cAAc;AAE3D,oBAAkB,WAAW,aAAa;AAG1C;AAAA,IACC;AAAA,IACA,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAK;AAAA,EACjD;AAEA,SAAO;AAAA,IACN,MAAM;AAAA,IACN,YAAY;AAAA,IACZ,aAAa;AAAA,EACd;AACD;AAQA,eAAsB,eACrB,QACA,SACA,SAIuB;AACvB,MAAI,CAAC,kBAAkB,OAAO;AAC7B,WAAO;AAAA,MACN,YAAY;AAAA,MACZ,aAAa;AAAA,MACb,gBAAgB,CAAC;AAAA,MACjB,UAAU,CAAC;AAAA,IACZ;AAED,QAAM,SAA8B;AAAA,IACnC,UAAU;AAAA,MACT;AAAA,QACC,YAAY;AAAA,MACb;AAAA,IACD;AAAA,EACD;AAEA,MAAI,SAAS,mBAAmB;AAC/B,WAAO,SAAS,KAAK;AAAA,MACpB,YAAY,QAAQ;AAAA,IACrB,CAAC;AAAA,EACF;AAGA,QAAM,EAAE,MAAM,aAAa,WAAW,IAAI,MAAM,OAAO,gBAAgB;AAAA,IACtE,OAAO;AAAA,IACP;AAAA,IACA,SAAS;AAAA,MACR,aAAa;AAAA,MACb,UAAU;AAAA,IACX;AAAA,IACA,GAAI,SAAS,cAAc,CAAC;AAAA,EAC7B,CAAC;AAGD,QAAM,cAAc,MAAM,IAAI,CAAC,MAAyB;AACvD,UAAM,SAAS,EAAE,MAAM,SAAS,aAAa,eAAe,EAAE,KAAK,QAAQ,SAAS;AAEpF,WAAQ,QAAQ,MAAM,QAAQ,KAAK,QAAQ,MAAM,QAAQ;AAAA,EAE1D,CAAC;AAID,QAAM,eAAe,KAAK,OAAO,CAAC,MAAM,UAAU,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI;AAEtE,SAAO;AAAA,IACN;AAAA,IACA;AAAA,IACA,gBAAgB,aAAa,IAAI,CAAC,GAAG,SAAS;AAAA,MAC7C,YAAY,EAAE,SAAS;AAAA,MACvB,QAAQ,EAAE;AAAA,MACV,SAAS,EAAE;AAAA,MACX,UAAU,EAAE;AAAA,MACZ,SAAS,YAAY,GAAG;AAAA,IACzB,EAAE;AAAA,IACF,UAAU;AAAA,EACX;AACD;AAGA,eAAsB,oBACrB,QACA,SACA,eACiC;AACjC,QAAM,YAAY,MAAM,OAAO,sBAAsB;AAAA,IACpD,UAAU;AAAA,IACV,MAAM;AAAA,MACL,MAAM,sCAAsC;AAAA,MAC5C,OAAO;AAAA,QACN,aAAa;AAAA,MACd;AAAA,IACD;AAAA,EACD,CAAC;AAED,MAAI,CAAC,UAAU;AAAM,WAAO;AAE5B,QAAM,SAAU,WAAW,MAAM,SAA8C,QAAQ,OACpF;AAEH,SAAO;AAAA,IACN,UAAU,UAAU,KAAK;AAAA,IACzB,MAAM;AAAA,IACN,WAAW,QAAQ;AAAA,IACnB,aAAa,QAAQ;AAAA,IACrB,WAAW,QAAQ,SAAS,QAAQ,IAAI;AAAA,IACxC,aAAa,QAAQ,SAAS,QAAQ;AAAA,EACvC;AACD;",
+  "names": []
+}