@mysten/kiosk 0.5.3 → 0.7.0

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

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

package/dist/constants.d.ts

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

package/dist/index.d.ts

@@ -1,9 +1,6 @@
-export * from './tx/kiosk';
-export * from './tx/transfer-policy';
-export * from './tx/rules';
-export * from './query/kiosk';
-export * from './bcs';
 export * from './utils';
-export * from './query/transfer-policy';
 export * from './types';
 export * from './constants';
+export * from './client/kiosk-client';
+export * from './client/tp-transaction';
+export * from './client/kiosk-transaction';