Add Kiosk lock feature

Author: Suficio

contracts/kiosk/sources/kiosk/ob_kiosk.move

@@ -39,7 +39,7 @@ module ob_kiosk::ob_kiosk {
     use sui::dynamic_field::{Self as df};
     use sui::kiosk::{Self, Kiosk, KioskOwnerCap, uid, uid_mut as ext};
     use sui::object::{Self, ID, UID, uid_to_address};
-    use sui::coin;
+    use sui::coin::{Self, Coin};
     use sui::table::{Self, Table};
     use sui::transfer::{transfer, public_share_object, public_transfer};
     use sui::tx_context::{Self, TxContext, sender};
@@ -864,6 +864,140 @@ module ob_kiosk::ob_kiosk {
         });
     }
 
+    /// Deposit an NFT and lock it within the `Kiosk`
+    ///
+    /// Once an NFT is locked it can only be listed either with `list` or
+    /// `list_with_purchase_cap`.
+    ///
+    /// Useful for interacting with non-OB collections.
+    ///
+    /// #### Panics
+    ///
+    /// Panics if transaction sender is not owner or `Kiosk` is not
+    /// permissionless.
+    public fun lock<T: key + store>(
+        self: &mut Kiosk,
+        policy: &sui::transfer_policy::TransferPolicy<T>,
+        nft: T,
+        ctx: &mut TxContext,
+    ) {
+        assert_version_and_upgrade(ext(self));
+        assert_can_deposit<T>(self, ctx);
+
+        let cap = pop_cap(self);
+        kiosk::lock(self, &cap, policy, nft);
+        set_cap(self, cap);
+    }
+
+    /// List the NFT directly on the `Kiosk`
+    ///
+    /// #### Panics
+    ///
+    /// - Transaction sender is not owner or `Kiosk` is not permissionless
+    /// - NFT with type and `ID` does not exist on the `Kiosk`
+    /// - NFT is listed exclusively
+    public fun list<T: key + store>(
+        self: &mut Kiosk,
+        nft_id: ID,
+        price: u64,
+        ctx: &mut TxContext,
+    ) {
+        assert_version_and_upgrade(ext(self));
+        assert_permission(self, ctx);
+
+        let cap = pop_cap(self);
+        kiosk::list<T>(self, &cap, nft_id, price);
+        set_cap(self, cap);
+    }
+
+    /// List the NFT directly on the `Kiosk`
+    ///
+    /// #### Panics
+    ///
+    /// - Transaction sender is not owner or `Kiosk` is not permissionless
+    /// - NFT with type and `ID` does not exist on the `Kiosk`
+    /// - NFT is listed exclusively
+    public fun list_with_purchase_cap<T: key + store>(
+        self: &mut Kiosk,
+        nft_id: ID,
+        min_price: u64,
+        ctx: &mut TxContext,
+    ): sui::kiosk::PurchaseCap<T> {
+        assert_version_and_upgrade(ext(self));
+        assert_permission(self, ctx);
+
+        let cap = pop_cap(self);
+        let purchase_cap = kiosk::list_with_purchase_cap<T>(
+            self, &cap, nft_id, min_price, ctx,
+        );
+        set_cap(self, cap);
+
+        purchase_cap
+    }
+
+    /// Delist the NFT from the `Kiosk`
+    ///
+    /// #### Panics
+    ///
+    /// - Transaction sender is not owner or `Kiosk` is not permissionless
+    /// - NFT with type and `ID` does not exist on the `Kiosk`
+    /// - NFT is listed exclusively
+    /// - NFT is not listed
+    public fun delist<T: key + store>(
+        self: &mut Kiosk,
+        nft_id: ID,
+        ctx: &mut TxContext,
+    ) {
+        assert_version_and_upgrade(ext(self));
+        assert_permission(self, ctx);
+
+        let cap = pop_cap(self);
+        kiosk::delist<T>(self, &cap, nft_id);
+        set_cap(self, cap);
+    }
+
+    /// Withdraw funds from the `Kiosk`
+    ///
+    /// This is only applicable when NFTs were sold using
+    /// `sui::kiosk::purchase` or `sui::kiosk::purchase_with_cap`.
+    ///
+    /// #### Panics
+    ///
+    /// Panics if transaction sender is not owner or `Kiosk` is not
+    /// permissionless.
+    public fun withdraw(
+        self: &mut Kiosk,
+        amount: Option<u64>,
+        ctx: &mut TxContext,
+    ): Coin<sui::sui::SUI> {
+        assert_version_and_upgrade(ext(self));
+        assert_permission(self, ctx);
+
+        let cap = pop_cap(self);
+        let coin = kiosk::withdraw(self, &cap, amount, ctx);
+        set_cap(self, cap);
+
+        coin
+    }
+
+    /// Withdraw funds from the `Kiosk` and transfer
+    ///
+    /// This is only applicable when NFTs were sold using
+    /// `sui::kiosk::purchase` or `sui::kiosk::purchase_with_cap`.
+    ///
+    /// #### Panics
+    ///
+    /// Panics if transaction sender is not owner or `Kiosk` is not
+    /// permissionless.
+    public fun withdraw_and_transfer(
+        self: &mut Kiosk,
+        amount: Option<u64>,
+        ctx: &mut TxContext,
+    ) {
+        let coin = withdraw(self, amount, ctx);
+        public_transfer(coin, tx_context::sender(ctx));
+    }
+
     // === Private Functions ===
 
     /// Initializes a transfer transaction
@@ -1164,6 +1298,8 @@ module ob_kiosk::ob_kiosk {
         df::exists_(uid(self), NftRefsDfKey {})
     }
 
+    /// Returns whether the current transaction sender can deposit into `Kiosk`
+    ///
     /// Either sender is owner or permissionless deposits of `T` enabled.
     public fun can_deposit<T>(self: &mut Kiosk, ctx: &mut TxContext): bool {
         sender(ctx) == kiosk::owner(self) || can_deposit_permissionlessly<T>(self)
@@ -1189,7 +1325,6 @@ module ob_kiosk::ob_kiosk {
     /// Panics if `Kiosk` is not OriginByte `Kiosk`
     //
     // TODO: Replace with immutable API
-    // TODO: Consider removing test_only
     public fun nft_refs(self: &Kiosk): &Table<ID, NftRef> {
         is_ob_kiosk_imut(self);
         df::borrow(uid(self), NftRefsDfKey {})
@@ -1221,6 +1356,11 @@ module ob_kiosk::ob_kiosk {
         assert!(is_permissionless(self), EKioskNotPermissionless);
     }
 
+    /// Asserts that the transaction sender may deposit into `Kiosk`
+    ///
+    /// #### Panics
+    ///
+    /// Panics if sender is not owner or `Kiosk` is not permissionless.
     public fun assert_can_deposit<T>(self: &mut Kiosk, ctx: &mut TxContext) {
         assert!(can_deposit<T>(self, ctx), ECannotDeposit);
     }