@mysten/kiosk 0.14.5 → 1.0.0

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

@@ -1,89 +0,0 @@
-import { bcs } from "@mysten/sui/bcs";
-import { Transaction } from "@mysten/sui/transactions";
-import { normalizeSuiAddress } from "@mysten/sui/utils";
-import { lock } from "../kiosk.js";
-async function resolveRoyaltyRule(params) {
-  const {
-    kioskClient,
-    transaction: tx,
-    itemType,
-    price,
-    packageId,
-    transferRequest,
-    policyId
-  } = params;
-  const feeTx = new Transaction();
-  feeTx.moveCall({
-    target: `${packageId}::royalty_rule::fee_amount`,
-    typeArguments: [itemType],
-    arguments: [feeTx.object(policyId), feeTx.pure.u64(price || "0")]
-  });
-  const policyObj = tx.object(policyId);
-  const { results } = await kioskClient.client.devInspectTransactionBlock({
-    sender: tx.getData().sender || normalizeSuiAddress("0x0"),
-    transactionBlock: feeTx
-  });
-  let amount = null;
-  if (results) {
-    const returnedAmount = results?.[0].returnValues?.[0]?.[0];
-    if (returnedAmount) {
-      amount = BigInt(bcs.U64.parse(new Uint8Array(returnedAmount)));
-    }
-  }
-  if (!amount) {
-    [amount] = tx.moveCall({
-      target: `${packageId}::royalty_rule::fee_amount`,
-      typeArguments: [itemType],
-      arguments: [policyObj, tx.pure.u64(price || "0")]
-    });
-  }
-  const feeCoin = tx.splitCoins(tx.gas, [amount]);
-  tx.moveCall({
-    target: `${packageId}::royalty_rule::pay`,
-    typeArguments: [itemType],
-    arguments: [policyObj, transferRequest, feeCoin]
-  });
-}
-function resolveKioskLockRule(params) {
-  const {
-    transaction: tx,
-    packageId,
-    itemType,
-    kiosk,
-    kioskCap,
-    policyId,
-    purchasedItem,
-    transferRequest
-  } = params;
-  if (!kiosk || !kioskCap) throw new Error("Missing Owned Kiosk or Owned Kiosk Cap");
-  lock(tx, itemType, kiosk, kioskCap, policyId, purchasedItem);
-  tx.moveCall({
-    target: `${packageId}::kiosk_lock_rule::prove`,
-    typeArguments: [itemType],
-    arguments: [transferRequest, tx.object(kiosk)]
-  });
-}
-function resolvePersonalKioskRule(params) {
-  const { transaction: tx, packageId, itemType, kiosk, transferRequest } = params;
-  if (!kiosk) throw new Error("Missing owned Kiosk.");
-  tx.moveCall({
-    target: `${packageId}::personal_kiosk_rule::prove`,
-    typeArguments: [itemType],
-    arguments: [tx.object(kiosk), transferRequest]
-  });
-}
-function resolveFloorPriceRule(params) {
-  const { transaction: tx, packageId, itemType, policyId, transferRequest } = params;
-  tx.moveCall({
-    target: `${packageId}::floor_price_rule::prove`,
-    typeArguments: [itemType],
-    arguments: [tx.object(policyId), transferRequest]
-  });
-}
-export {
-  resolveFloorPriceRule,
-  resolveKioskLockRule,
-  resolvePersonalKioskRule,
-  resolveRoyaltyRule
-};
-//# sourceMappingURL=resolve.js.map

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

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../../src/tx/rules/resolve.ts"],
-  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport { bcs } from '@mysten/sui/bcs';\nimport type { TransactionArgument } from '@mysten/sui/transactions';\nimport { Transaction } from '@mysten/sui/transactions';\nimport { normalizeSuiAddress } from '@mysten/sui/utils';\n\nimport type { RuleResolvingParams } from '../../types/index.js';\nimport { lock } from '../kiosk.js';\n\n/**\n * A helper to resolve the royalty rule.\n */\nexport async function resolveRoyaltyRule(params: RuleResolvingParams) {\n\tconst {\n\t\tkioskClient,\n\t\ttransaction: tx,\n\t\titemType,\n\t\tprice,\n\t\tpackageId,\n\t\ttransferRequest,\n\t\tpolicyId,\n\t} = params;\n\n\t// We attempt to resolve the fee amount outside of the PTB so that the split amount is known before the transaction is sent.\n\t// This improves the display of the transaction within the wallet.\n\n\tconst feeTx = new Transaction();\n\n\t// calculates the amount\n\tfeeTx.moveCall({\n\t\ttarget: `${packageId}::royalty_rule::fee_amount`,\n\t\ttypeArguments: [itemType],\n\t\targuments: [feeTx.object(policyId), feeTx.pure.u64(price || '0')],\n\t});\n\n\tconst policyObj = tx.object(policyId);\n\n\tconst { results } = await kioskClient.client.devInspectTransactionBlock({\n\t\tsender: tx.getData().sender || normalizeSuiAddress('0x0'),\n\t\ttransactionBlock: feeTx,\n\t});\n\n\tlet amount: TransactionArgument | bigint | null = null;\n\tif (results) {\n\t\tconst returnedAmount = results?.[0].returnValues?.[0]?.[0];\n\t\tif (returnedAmount) {\n\t\t\tamount = BigInt(bcs.U64.parse(new Uint8Array(returnedAmount as number[])));\n\t\t}\n\t}\n\n\t// We were not able to calculate the amount outside of the transaction, so fall back to resolving it within the PTB\n\tif (!amount) {\n\t\t[amount] = tx.moveCall({\n\t\t\ttarget: `${packageId}::royalty_rule::fee_amount`,\n\t\t\ttypeArguments: [itemType],\n\t\t\targuments: [policyObj, tx.pure.u64(price || '0')],\n\t\t});\n\t}\n\n\t// splits the coin.\n\tconst feeCoin = tx.splitCoins(tx.gas, [amount]);\n\n\t// pays the policy\n\ttx.moveCall({\n\t\ttarget: `${packageId}::royalty_rule::pay`,\n\t\ttypeArguments: [itemType],\n\t\targuments: [policyObj, transferRequest, feeCoin],\n\t});\n}\n\nexport function resolveKioskLockRule(params: RuleResolvingParams) {\n\tconst {\n\t\ttransaction: tx,\n\t\tpackageId,\n\t\titemType,\n\t\tkiosk,\n\t\tkioskCap,\n\t\tpolicyId,\n\t\tpurchasedItem,\n\t\ttransferRequest,\n\t} = params;\n\n\tif (!kiosk || !kioskCap) throw new Error('Missing Owned Kiosk or Owned Kiosk Cap');\n\n\tlock(tx, itemType, kiosk, kioskCap, policyId, purchasedItem);\n\n\t// proves that the item is locked in the kiosk to the TP.\n\ttx.moveCall({\n\t\ttarget: `${packageId}::kiosk_lock_rule::prove`,\n\t\ttypeArguments: [itemType],\n\t\targuments: [transferRequest, tx.object(kiosk)],\n\t});\n}\n\n/**\n * A helper to resolve the personalKioskRule.\n * @param params\n */\nexport function resolvePersonalKioskRule(params: RuleResolvingParams) {\n\tconst { transaction: tx, packageId, itemType, kiosk, transferRequest } = params;\n\n\tif (!kiosk) throw new Error('Missing owned Kiosk.');\n\n\t// proves that the destination kiosk is personal.\n\ttx.moveCall({\n\t\ttarget: `${packageId}::personal_kiosk_rule::prove`,\n\t\ttypeArguments: [itemType],\n\t\targuments: [tx.object(kiosk), transferRequest],\n\t});\n}\n\n/**\n * Resolves the floor price rule.\n */\nexport function resolveFloorPriceRule(params: RuleResolvingParams) {\n\tconst { transaction: tx, packageId, itemType, policyId, transferRequest } = params;\n\n\t// proves that the destination kiosk is personal\n\ttx.moveCall({\n\t\ttarget: `${packageId}::floor_price_rule::prove`,\n\t\ttypeArguments: [itemType],\n\t\targuments: [tx.object(policyId), transferRequest],\n\t});\n}\n"],
-  "mappings": "AAGA,SAAS,WAAW;AAEpB,SAAS,mBAAmB;AAC5B,SAAS,2BAA2B;AAGpC,SAAS,YAAY;AAKrB,eAAsB,mBAAmB,QAA6B;AACrE,QAAM;AAAA,IACL;AAAA,IACA,aAAa;AAAA,IACb;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACD,IAAI;AAKJ,QAAM,QAAQ,IAAI,YAAY;AAG9B,QAAM,SAAS;AAAA,IACd,QAAQ,GAAG,SAAS;AAAA,IACpB,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,MAAM,OAAO,QAAQ,GAAG,MAAM,KAAK,IAAI,SAAS,GAAG,CAAC;AAAA,EACjE,CAAC;AAED,QAAM,YAAY,GAAG,OAAO,QAAQ;AAEpC,QAAM,EAAE,QAAQ,IAAI,MAAM,YAAY,OAAO,2BAA2B;AAAA,IACvE,QAAQ,GAAG,QAAQ,EAAE,UAAU,oBAAoB,KAAK;AAAA,IACxD,kBAAkB;AAAA,EACnB,CAAC;AAED,MAAI,SAA8C;AAClD,MAAI,SAAS;AACZ,UAAM,iBAAiB,UAAU,CAAC,EAAE,eAAe,CAAC,IAAI,CAAC;AACzD,QAAI,gBAAgB;AACnB,eAAS,OAAO,IAAI,IAAI,MAAM,IAAI,WAAW,cAA0B,CAAC,CAAC;AAAA,IAC1E;AAAA,EACD;AAGA,MAAI,CAAC,QAAQ;AACZ,KAAC,MAAM,IAAI,GAAG,SAAS;AAAA,MACtB,QAAQ,GAAG,SAAS;AAAA,MACpB,eAAe,CAAC,QAAQ;AAAA,MACxB,WAAW,CAAC,WAAW,GAAG,KAAK,IAAI,SAAS,GAAG,CAAC;AAAA,IACjD,CAAC;AAAA,EACF;AAGA,QAAM,UAAU,GAAG,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC;AAG9C,KAAG,SAAS;AAAA,IACX,QAAQ,GAAG,SAAS;AAAA,IACpB,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,WAAW,iBAAiB,OAAO;AAAA,EAChD,CAAC;AACF;AAEO,SAAS,qBAAqB,QAA6B;AACjE,QAAM;AAAA,IACL,aAAa;AAAA,IACb;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACD,IAAI;AAEJ,MAAI,CAAC,SAAS,CAAC,SAAU,OAAM,IAAI,MAAM,wCAAwC;AAEjF,OAAK,IAAI,UAAU,OAAO,UAAU,UAAU,aAAa;AAG3D,KAAG,SAAS;AAAA,IACX,QAAQ,GAAG,SAAS;AAAA,IACpB,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,iBAAiB,GAAG,OAAO,KAAK,CAAC;AAAA,EAC9C,CAAC;AACF;AAMO,SAAS,yBAAyB,QAA6B;AACrE,QAAM,EAAE,aAAa,IAAI,WAAW,UAAU,OAAO,gBAAgB,IAAI;AAEzE,MAAI,CAAC,MAAO,OAAM,IAAI,MAAM,sBAAsB;AAGlD,KAAG,SAAS;AAAA,IACX,QAAQ,GAAG,SAAS;AAAA,IACpB,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,GAAG,OAAO,KAAK,GAAG,eAAe;AAAA,EAC9C,CAAC;AACF;AAKO,SAAS,sBAAsB,QAA6B;AAClE,QAAM,EAAE,aAAa,IAAI,WAAW,UAAU,UAAU,gBAAgB,IAAI;AAG5E,KAAG,SAAS;AAAA,IACX,QAAQ,GAAG,SAAS;AAAA,IACpB,eAAe,CAAC,QAAQ;AAAA,IACxB,WAAW,CAAC,GAAG,OAAO,QAAQ,GAAG,eAAe;AAAA,EACjD,CAAC;AACF;",
-  "names": []
-}

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

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

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

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

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

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

package/dist/esm/types/index.d.ts

@@ -1,27 +0,0 @@
-import type { SuiClient } from '@mysten/sui/client';
-import type { TransactionObjectArgument } from '@mysten/sui/transactions';
-import type { BaseRulePackageIds } from '../constants.js';
-export * from './kiosk.js';
-export * from './transfer-policy.js';
-/**
- * A valid argument for any of the Kiosk functions.
- */
-export type ObjectArgument = string | TransactionObjectArgument;
-/**
- * A Network selector.
- * Kiosk SDK supports mainnet & testnet.
- * Pass `custom` for any other network (devnet, localnet).
- */
-export declare enum Network {
-    MAINNET = "mainnet",
-    TESTNET = "testnet",
-    CUSTOM = "custom"
-}
-/**
- * The Client Options for Both KioskClient & TransferPolicyManager.
- */
-export type KioskClientOptions = {
-    client: SuiClient;
-    network: Network;
-    packageIds?: BaseRulePackageIds;
-};

package/dist/esm/types/index.js

@@ -1,12 +0,0 @@
-export * from "./kiosk.js";
-export * from "./transfer-policy.js";
-var Network = /* @__PURE__ */ ((Network2) => {
-  Network2["MAINNET"] = "mainnet";
-  Network2["TESTNET"] = "testnet";
-  Network2["CUSTOM"] = "custom";
-  return Network2;
-})(Network || {});
-export {
-  Network
-};
-//# sourceMappingURL=index.js.map

package/dist/esm/types/index.js.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/types/index.ts"],
-  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { SuiClient } from '@mysten/sui/client';\nimport type { TransactionObjectArgument } from '@mysten/sui/transactions';\n\nimport type { BaseRulePackageIds } from '../constants.js';\n\nexport * from './kiosk.js';\nexport * from './transfer-policy.js';\n\n/**\n * A valid argument for any of the Kiosk functions.\n */\nexport type ObjectArgument = string | TransactionObjectArgument;\n\n/**\n * A Network selector.\n * Kiosk SDK supports mainnet & testnet.\n * Pass `custom` for any other network (devnet, localnet).\n */\nexport enum Network {\n\tMAINNET = 'mainnet',\n\tTESTNET = 'testnet',\n\tCUSTOM = 'custom',\n}\n\n/**\n * The Client Options for Both KioskClient & TransferPolicyManager.\n */\nexport type KioskClientOptions = {\n\tclient: SuiClient;\n\tnetwork: Network;\n\tpackageIds?: BaseRulePackageIds;\n};\n"],
-  "mappings": "AAQA,cAAc;AACd,cAAc;AAYP,IAAK,UAAL,kBAAKA,aAAL;AACN,EAAAA,SAAA,aAAU;AACV,EAAAA,SAAA,aAAU;AACV,EAAAA,SAAA,YAAS;AAHE,SAAAA;AAAA,GAAA;",
-  "names": ["Network"]
-}

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

@@ -1,160 +0,0 @@
-import type { PaginatedObjectsResponse, SuiObjectData, SuiObjectDataOptions } from '@mysten/sui/client';
-import type { TransactionArgument } from '@mysten/sui/transactions';
-import type { ObjectArgument } from './index.js';
-/** The Kiosk module. */
-export declare const KIOSK_MODULE = "0x2::kiosk";
-/** The Kiosk type. */
-export declare const KIOSK_TYPE = "0x2::kiosk::Kiosk";
-/** The Kiosk Owner Cap Type */
-export declare const KIOSK_OWNER_CAP = "0x2::kiosk::KioskOwnerCap";
-/** The Kiosk Item Type */
-export declare const KIOSK_ITEM = "0x2::kiosk::Item";
-/** The Kiosk Listing Type */
-export declare const KIOSK_LISTING = "0x2::kiosk::Listing";
-/** The Kiosk Lock Type */
-export declare const KIOSK_LOCK = "0x2::kiosk::Lock";
-/** The Kiosk PurchaseCap type */
-export declare const KIOSK_PURCHASE_CAP = "0x2::kiosk::PurchaseCap";
-/**
- * The Kiosk object fields (for BCS queries).
- */
-export type Kiosk = {
-    id: string;
-    profits: string;
-    owner: string;
-    itemCount: number;
-    allowExtensions: boolean;
-};
-/**
- * PurchaseCap object fields (for BCS queries).
- */
-export type PurchaseCap = {
-    id: string;
-    kioskId: string;
-    itemId: string;
-    minPrice: string;
-};
-/**
- * The response type of a successful purchase flow.
- * Returns the item, and a `canTransfer` param.
- */
-export type PurchaseAndResolvePoliciesResponse = {
-    item: TransactionArgument;
-    canTransfer: boolean;
-};
-/**
- * Optional parameters for `purchaseAndResolvePolicies` flow.
- * This gives us the chance to extend the function in further releases
- * without introducing more breaking changes.
- */
-export type PurchaseOptionalParams = {
-    ownedKiosk?: ObjectArgument;
-    ownedKioskCap?: ObjectArgument;
-};
-/**
- * A dynamic field `Listing { ID, isExclusive }` attached to the Kiosk.
- * Holds a `u64` value - the price of the item.
- */
-export type KioskListing = {
-    /** The ID of the Item */
-    objectId: string;
-    /**
-     * Whether or not there's a `PurchaseCap` issued. `true` means that
-     * the listing is controlled by some logic and can't be purchased directly.
-     *
-     * TODO: consider renaming the field for better indication.
-     */
-    isExclusive: boolean;
-    /** The ID of the listing */
-    listingId: string;
-    price?: string;
-};
-/**
- * A dynamic field `Item { ID }` attached to the Kiosk.
- * Holds an Item `T`. The type of the item is known upfront.
- */
-export type KioskItem = {
-    /** The ID of the Item */
-    objectId: string;
-    /** The type of the Item */
-    type: string;
-    /** Whether the item is Locked (there must be a `Lock` Dynamic Field) */
-    isLocked: boolean;
-    /** Optional listing */
-    listing?: KioskListing;
-    /** The ID of the kiosk the item is placed in */
-    kioskId: string;
-    /** Optional Kiosk Data */
-    data?: SuiObjectData;
-};
-/** The overview type returned from `getKiosk` */
-export type KioskExtensionOverview = {
-    /** The ID of the extension's DF */
-    objectId: string;
-    /** The inner type of the Extension */
-    type: string;
-};
-/**
- * Hold the KioskExtension data
- */
-export type KioskExtension = KioskExtensionOverview & {
-    /** These fields are only there if we have `withExtensions` flag */
-    isEnabled: boolean;
-    permissions: string;
-    storageId: string;
-    storageSize: number;
-};
-/**
- * Aggregated data from the Kiosk.
- */
-export type KioskData = {
-    items: KioskItem[];
-    itemIds: string[];
-    listingIds: string[];
-    kiosk?: Kiosk;
-    extensions: KioskExtensionOverview[];
-};
-export type PagedKioskData = {
-    data: KioskData;
-    nextCursor: string | null | undefined;
-    hasNextPage: boolean;
-};
-export type FetchKioskOptions = {
-    /** Include the base kiosk object, which includes the profits, the owner and the base fields. */
-    withKioskFields?: boolean;
-    /** Include the listing prices. */
-    withListingPrices?: boolean;
-    /** Include the objects for the Items in the kiosk. Defaults to `display` only. */
-    withObjects?: boolean;
-    /** Pass the data options for the objects, when fetching, in case you want to query other details. */
-    objectOptions?: SuiObjectDataOptions;
-};
-export type OwnedKiosks = {
-    kioskOwnerCaps: KioskOwnerCap[];
-    kioskIds: string[];
-} & Omit<PaginatedObjectsResponse, 'data'>;
-export type KioskOwnerCap = {
-    isPersonal?: boolean;
-    objectId: string;
-    kioskId: string;
-    digest: string;
-    version: string;
-};
-export type PurchaseOptions = {
-    extraArgs?: Record<string, any>;
-};
-export type ItemId = {
-    itemType: string;
-    itemId: string;
-};
-export type ItemReference = {
-    itemType: string;
-    item: ObjectArgument;
-};
-export type ItemValue = {
-    itemType: string;
-    item: TransactionArgument;
-};
-export type Price = {
-    price: string | bigint;
-};

package/dist/esm/types/kiosk.js

@@ -1,17 +0,0 @@
-const KIOSK_MODULE = "0x2::kiosk";
-const KIOSK_TYPE = `${KIOSK_MODULE}::Kiosk`;
-const KIOSK_OWNER_CAP = `${KIOSK_MODULE}::KioskOwnerCap`;
-const KIOSK_ITEM = `${KIOSK_MODULE}::Item`;
-const KIOSK_LISTING = `${KIOSK_MODULE}::Listing`;
-const KIOSK_LOCK = `${KIOSK_MODULE}::Lock`;
-const KIOSK_PURCHASE_CAP = `${KIOSK_MODULE}::PurchaseCap`;
-export {
-  KIOSK_ITEM,
-  KIOSK_LISTING,
-  KIOSK_LOCK,
-  KIOSK_MODULE,
-  KIOSK_OWNER_CAP,
-  KIOSK_PURCHASE_CAP,
-  KIOSK_TYPE
-};
-//# sourceMappingURL=kiosk.js.map

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

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/types/kiosk.ts"],
-  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport type {\n\tPaginatedObjectsResponse,\n\tSuiObjectData,\n\tSuiObjectDataOptions,\n} from '@mysten/sui/client';\nimport type { TransactionArgument } from '@mysten/sui/transactions';\n\nimport type { ObjectArgument } from './index.js';\n\n/** The Kiosk module. */\nexport const KIOSK_MODULE = '0x2::kiosk';\n\n/** The Kiosk type. */\nexport const KIOSK_TYPE = `${KIOSK_MODULE}::Kiosk`;\n\n/** The Kiosk Owner Cap Type */\nexport const KIOSK_OWNER_CAP = `${KIOSK_MODULE}::KioskOwnerCap`;\n\n/** The Kiosk Item Type */\nexport const KIOSK_ITEM = `${KIOSK_MODULE}::Item`;\n\n/** The Kiosk Listing Type */\nexport const KIOSK_LISTING = `${KIOSK_MODULE}::Listing`;\n\n/** The Kiosk Lock Type */\nexport const KIOSK_LOCK = `${KIOSK_MODULE}::Lock`;\n\n/** The Kiosk PurchaseCap type */\nexport const KIOSK_PURCHASE_CAP = `${KIOSK_MODULE}::PurchaseCap`;\n\n/**\n * The Kiosk object fields (for BCS queries).\n */\nexport type Kiosk = {\n\tid: string;\n\tprofits: string;\n\towner: string;\n\titemCount: number;\n\tallowExtensions: boolean;\n};\n\n/**\n * PurchaseCap object fields (for BCS queries).\n */\nexport type PurchaseCap = {\n\tid: string;\n\tkioskId: string;\n\titemId: string;\n\tminPrice: string;\n};\n\n/**\n * The response type of a successful purchase flow.\n * Returns the item, and a `canTransfer` param.\n */\nexport type PurchaseAndResolvePoliciesResponse = {\n\titem: TransactionArgument;\n\tcanTransfer: boolean;\n};\n\n/**\n * Optional parameters for `purchaseAndResolvePolicies` flow.\n * This gives us the chance to extend the function in further releases\n * without introducing more breaking changes.\n */\nexport type PurchaseOptionalParams = {\n\townedKiosk?: ObjectArgument;\n\townedKioskCap?: ObjectArgument;\n};\n\n/**\n * A dynamic field `Listing { ID, isExclusive }` attached to the Kiosk.\n * Holds a `u64` value - the price of the item.\n */\nexport type KioskListing = {\n\t/** The ID of the Item */\n\tobjectId: string;\n\t/**\n\t * Whether or not there's a `PurchaseCap` issued. `true` means that\n\t * the listing is controlled by some logic and can't be purchased directly.\n\t *\n\t * TODO: consider renaming the field for better indication.\n\t */\n\tisExclusive: boolean;\n\t/** The ID of the listing */\n\tlistingId: string;\n\tprice?: string;\n};\n\n/**\n * A dynamic field `Item { ID }` attached to the Kiosk.\n * Holds an Item `T`. The type of the item is known upfront.\n */\nexport type KioskItem = {\n\t/** The ID of the Item */\n\tobjectId: string;\n\t/** The type of the Item */\n\ttype: string;\n\t/** Whether the item is Locked (there must be a `Lock` Dynamic Field) */\n\tisLocked: boolean;\n\t/** Optional listing */\n\tlisting?: KioskListing;\n\t/** The ID of the kiosk the item is placed in */\n\tkioskId: string;\n\t/** Optional Kiosk Data */\n\tdata?: SuiObjectData;\n};\n\n/** The overview type returned from `getKiosk` */\nexport type KioskExtensionOverview = {\n\t/** The ID of the extension's DF */\n\tobjectId: string;\n\t/** The inner type of the Extension */\n\ttype: string;\n};\n/**\n * Hold the KioskExtension data\n */\nexport type KioskExtension = KioskExtensionOverview & {\n\t/** These fields are only there if we have `withExtensions` flag */\n\tisEnabled: boolean;\n\tpermissions: string;\n\tstorageId: string;\n\tstorageSize: number;\n};\n\n/**\n * Aggregated data from the Kiosk.\n */\nexport type KioskData = {\n\titems: KioskItem[];\n\titemIds: string[];\n\tlistingIds: string[];\n\tkiosk?: Kiosk;\n\textensions: KioskExtensionOverview[]; // type will be defined on later versions of the SDK.\n};\n\nexport type PagedKioskData = {\n\tdata: KioskData;\n\tnextCursor: string | null | undefined;\n\thasNextPage: boolean;\n};\n\nexport type FetchKioskOptions = {\n\t/** Include the base kiosk object, which includes the profits, the owner and the base fields. */\n\twithKioskFields?: boolean;\n\t/** Include the listing prices. */\n\twithListingPrices?: boolean;\n\t/** Include the objects for the Items in the kiosk. Defaults to `display` only. */\n\twithObjects?: boolean;\n\t/** Pass the data options for the objects, when fetching, in case you want to query other details. */\n\tobjectOptions?: SuiObjectDataOptions;\n};\n\nexport type OwnedKiosks = {\n\tkioskOwnerCaps: KioskOwnerCap[];\n\tkioskIds: string[];\n} & Omit<PaginatedObjectsResponse, 'data'>;\n\nexport type KioskOwnerCap = {\n\tisPersonal?: boolean;\n\tobjectId: string;\n\tkioskId: string;\n\tdigest: string;\n\tversion: string;\n};\n\nexport type PurchaseOptions = {\n\textraArgs?: Record<string, any>;\n};\n\nexport type ItemId = { itemType: string; itemId: string };\nexport type ItemReference = { itemType: string; item: ObjectArgument };\nexport type ItemValue = { itemType: string; item: TransactionArgument };\nexport type Price = { price: string | bigint };\n"],
-  "mappings": "AAaO,MAAM,eAAe;AAGrB,MAAM,aAAa,GAAG,YAAY;AAGlC,MAAM,kBAAkB,GAAG,YAAY;AAGvC,MAAM,aAAa,GAAG,YAAY;AAGlC,MAAM,gBAAgB,GAAG,YAAY;AAGrC,MAAM,aAAa,GAAG,YAAY;AAGlC,MAAM,qBAAqB,GAAG,YAAY;",
-  "names": []
-}

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

@@ -1,53 +0,0 @@
-import type { ObjectOwner } from '@mysten/sui/client';
-import type { Transaction, TransactionObjectArgument } from '@mysten/sui/transactions';
-import type { KioskClient } from '../client/kiosk-client.js';
-import type { ObjectArgument } from './index.js';
-/** The Transfer Policy module. */
-export declare const TRANSFER_POLICY_MODULE = "0x2::transfer_policy";
-/** Name of the event emitted when a TransferPolicy for T is created. */
-export declare const TRANSFER_POLICY_CREATED_EVENT = "0x2::transfer_policy::TransferPolicyCreated";
-/** The Transfer Policy Type */
-export declare const TRANSFER_POLICY_TYPE = "0x2::transfer_policy::TransferPolicy";
-/** The Transfer Policy Cap Type */
-export declare const TRANSFER_POLICY_CAP_TYPE = "0x2::transfer_policy::TransferPolicyCap";
-/** The Kiosk Lock Rule */
-export declare const KIOSK_LOCK_RULE = "kiosk_lock_rule::Rule";
-/** The Royalty rule */
-export declare const ROYALTY_RULE = "royalty_rule::Rule";
-/**
- * The Transfer Policy Cap in a consumable way.
- */
-export type TransferPolicyCap = {
-    policyId: string;
-    policyCapId: string;
-    type: string;
-};
-/** The `TransferPolicy` object */
-export type TransferPolicy = {
-    id: string;
-    type: string;
-    balance: string;
-    rules: string[];
-    owner: ObjectOwner;
-};
-/** Event emitted when a TransferPolicy is created. */
-export type TransferPolicyCreated = {
-    id: string;
-};
-export type RuleResolvingParams = {
-    transaction: Transaction;
-    /** @deprecated use transaction instead */
-    transactionBlock: Transaction;
-    itemType: string;
-    itemId: string;
-    price: string;
-    policyId: ObjectArgument;
-    sellerKiosk: ObjectArgument;
-    kiosk: ObjectArgument;
-    kioskCap: ObjectArgument;
-    transferRequest: TransactionObjectArgument;
-    purchasedItem: TransactionObjectArgument;
-    packageId: string;
-    extraArgs: Record<string, any>;
-    kioskClient: KioskClient;
-};

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

@@ -1,15 +0,0 @@
-const TRANSFER_POLICY_MODULE = "0x2::transfer_policy";
-const TRANSFER_POLICY_CREATED_EVENT = `${TRANSFER_POLICY_MODULE}::TransferPolicyCreated`;
-const TRANSFER_POLICY_TYPE = `${TRANSFER_POLICY_MODULE}::TransferPolicy`;
-const TRANSFER_POLICY_CAP_TYPE = `${TRANSFER_POLICY_MODULE}::TransferPolicyCap`;
-const KIOSK_LOCK_RULE = "kiosk_lock_rule::Rule";
-const ROYALTY_RULE = "royalty_rule::Rule";
-export {
-  KIOSK_LOCK_RULE,
-  ROYALTY_RULE,
-  TRANSFER_POLICY_CAP_TYPE,
-  TRANSFER_POLICY_CREATED_EVENT,
-  TRANSFER_POLICY_MODULE,
-  TRANSFER_POLICY_TYPE
-};
-//# sourceMappingURL=transfer-policy.js.map

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

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/types/transfer-policy.ts"],
-  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { ObjectOwner } from '@mysten/sui/client';\nimport type { Transaction, TransactionObjectArgument } from '@mysten/sui/transactions';\n\nimport type { KioskClient } from '../client/kiosk-client.js';\nimport type { ObjectArgument } from './index.js';\n\n/** The Transfer Policy module. */\nexport const TRANSFER_POLICY_MODULE = '0x2::transfer_policy';\n\n/** Name of the event emitted when a TransferPolicy for T is created. */\nexport const TRANSFER_POLICY_CREATED_EVENT = `${TRANSFER_POLICY_MODULE}::TransferPolicyCreated`;\n\n/** The Transfer Policy Type */\nexport const TRANSFER_POLICY_TYPE = `${TRANSFER_POLICY_MODULE}::TransferPolicy`;\n\n/** The Transfer Policy Cap Type */\nexport const TRANSFER_POLICY_CAP_TYPE = `${TRANSFER_POLICY_MODULE}::TransferPolicyCap`;\n\n/** The Kiosk Lock Rule */\nexport const KIOSK_LOCK_RULE = 'kiosk_lock_rule::Rule';\n\n/** The Royalty rule */\nexport const ROYALTY_RULE = 'royalty_rule::Rule';\n\n/**\n * The Transfer Policy Cap in a consumable way.\n */\nexport type TransferPolicyCap = {\n\tpolicyId: string;\n\tpolicyCapId: string;\n\ttype: string;\n};\n\n/** The `TransferPolicy` object */\nexport type TransferPolicy = {\n\tid: string;\n\ttype: string;\n\tbalance: string;\n\trules: string[];\n\towner: ObjectOwner;\n};\n\n/** Event emitted when a TransferPolicy is created. */\nexport type TransferPolicyCreated = {\n\tid: string;\n};\n\n// The object a Rule resolving function accepts\n// It can accept a set of fixed fields, that are part of every purchase flow as well any extra arguments to resolve custom policies!\n// Each rule resolving function should check that the key it's seeking is in the object\n// e.g. `if(!'my_key' in ruleParams!) throw new Error(\"Can't resolve that rule!\")`\nexport type RuleResolvingParams = {\n\ttransaction: Transaction;\n\t/** @deprecated use transaction instead */\n\ttransactionBlock: Transaction;\n\titemType: string;\n\titemId: string;\n\tprice: string;\n\tpolicyId: ObjectArgument;\n\tsellerKiosk: ObjectArgument;\n\tkiosk: ObjectArgument;\n\tkioskCap: ObjectArgument;\n\ttransferRequest: TransactionObjectArgument;\n\tpurchasedItem: TransactionObjectArgument;\n\tpackageId: string;\n\textraArgs: Record<string, any>; // extraParams contains more possible {key, values} to pass for custom rules.\n\tkioskClient: KioskClient;\n};\n"],
-  "mappings": "AAUO,MAAM,yBAAyB;AAG/B,MAAM,gCAAgC,GAAG,sBAAsB;AAG/D,MAAM,uBAAuB,GAAG,sBAAsB;AAGtD,MAAM,2BAA2B,GAAG,sBAAsB;AAG1D,MAAM,kBAAkB;AAGxB,MAAM,eAAe;",
-  "names": []
-}

package/dist/esm/utils.d.ts

@@ -1,51 +0,0 @@
-import type { DynamicFieldInfo, PaginationArguments, SuiClient, SuiObjectData, SuiObjectDataFilter, SuiObjectDataOptions, SuiObjectResponse } from '@mysten/sui/client';
-import type { Kiosk, KioskData, KioskListing, TransferPolicyCap } from './types/index.js';
-export declare function getKioskObject(client: SuiClient, id: string): Promise<Kiosk>;
-export declare function extractKioskData(data: DynamicFieldInfo[], listings: KioskListing[], lockedItemIds: string[], kioskId: string): KioskData;
-/**
- * A helper that attaches the listing prices to kiosk listings.
- */
-export declare function attachListingsAndPrices(kioskData: KioskData, listings: KioskListing[], listingObjects: SuiObjectResponse[]): void;
-/**
- * A helper that attaches the listing prices to kiosk listings.
- */
-export declare function attachObjects(kioskData: KioskData, objects: SuiObjectData[]): void;
-/**
- * A Helper to attach locked state to items in Kiosk Data.
- */
-export declare function attachLockedItems(kioskData: KioskData, lockedItemIds: string[]): void;
-/**
- * A helper to fetch all DF pages.
- * We need that to fetch the kiosk DFs consistently, until we have
- * RPC calls that allow filtering of Type / batch fetching of spec
- */
-export declare function getAllDynamicFields(client: SuiClient, parentId: string, pagination: PaginationArguments<string>): Promise<DynamicFieldInfo[]>;
-/**
- * A helper to fetch all objects that works with pagination.
- * It will fetch all objects in the array, and limit it to 50/request.
- * Requests are sent using `Promise.all`.
- */
-export declare function getAllObjects(client: SuiClient, ids: string[], options: SuiObjectDataOptions, limit?: number): Promise<SuiObjectResponse[]>;
-/**
- * A helper to return all owned objects, with an optional filter.
- * It parses all the pages and returns the data.
- */
-export declare function getAllOwnedObjects({ client, owner, filter, limit, options, }: {
-    client: SuiClient;
-    owner: string;
-    filter?: SuiObjectDataFilter;
-    options?: SuiObjectDataOptions;
-    limit?: number;
-}): Promise<SuiObjectResponse[]>;
-/**
- * Converts a number to basis points.
- * Supports up to 2 decimal points.
- * E.g 9.95 -> 995
- * @param percentage A percentage amount in the range [0, 100] including decimals.
- */
-export declare function percentageToBasisPoints(percentage: number): number;
-/**
- * A helper to parse a transfer policy Cap into a usable object.
- */
-export declare function parseTransferPolicyCapObject(item: SuiObjectResponse): TransferPolicyCap | undefined;
-export declare function getNormalizedRuleType(rule: string): string;