Skip to content

Respect Sui royalties #502

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Suficio merged 1 commit into from
Aug 19, 2023
Merged

Respect Sui royalties #502

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
107 changes: 97 additions & 10 deletions contracts/kiosk/sources/kiosk/ob_kiosk.move
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
/// - Permissionless `Kiosk` needs to signer, apps don't have to wrap both
/// the `KioskOwnerCap` and the `Kiosk` in a smart contract.
module ob_kiosk::ob_kiosk {
use std::option::Option;
use std::option::{Self, Option};
use std::string::utf8;
use std::vector;
use std::type_name::{Self, TypeName};
Expand Down Expand Up @@ -535,6 +535,18 @@ module ob_kiosk::ob_kiosk {
(target_kiosk_id, target_token)
}

/// Deprecated, use `transfer_delegated_unlocked`
public fun transfer_delegated<T: key + store>(
_source: &mut Kiosk,
_target: &mut Kiosk,
_nft_id: ID,
_entity_id: &UID,
_price: u64,
_ctx: &mut TxContext,
): TransferRequest<T> {
abort(EDeprecatedApi)
}

/// Transfer NFT out of Kiosk that has been previously delegated
///
/// Handles the case that NFT could be locked or not in the source `Kiosk`.
Expand All @@ -543,57 +555,84 @@ module ob_kiosk::ob_kiosk {
/// Requires that address of sender was previously passed to
/// `auth_transfer`.
///
/// `paid` argument is used to pass the amount on which royalties must be
/// paid on the base Sui transfer request, whilst, `price` is used on the
/// OB request. Will panic if `paid` is provided for a non-locked NFT.
///
/// #### Panics
///
/// - Entity `UID` was not previously authorized for transfer
/// - NFT does not exist
/// - Target `Kiosk` deposit conditions were not met, see `deposit` method
/// - Source or target `Kiosk` are not OriginByte kiosks
public fun transfer_delegated<T: key + store>(
/// - Panics if `Coin<sui::sui::SUI>` is provided for an NFT that is not
/// locked
public fun transfer_delegated_unlocked<T: key + store>(
source: &mut Kiosk,
target: &mut Kiosk,
nft_id: ID,
entity_id: &UID,
price: u64,
paid: Option<Coin<sui::sui::SUI>>,
ctx: &mut TxContext,
): TransferRequest<T> {
assert_version_and_upgrade(ext(source));

let (nft, req) = transfer_nft_(source, nft_id, uid_to_address(entity_id), price, ctx);
let (nft, req) = transfer_nft_(source, nft_id, uid_to_address(entity_id), price, paid, ctx);
deposit(target, nft, ctx);
req
}

/// Transfer NFT out of Kiosk that has been previously delegated
///
/// NFT will be locked in the target `Kiosk`.
///
/// Handles the case that NFT could be locked or not in the source `Kiosk`.
/// NFT will be locked in the target `Kiosk`.
///
/// Requires that address of sender was previously passed to
/// `auth_transfer`.
///
/// `paid` argument is used to pass the amount on which royalties must be
/// paid on the base Sui transfer request, whilst, `price` is used on the
/// OB request. Will panic if `paid` is provided for a non-locked NFT.
///
/// #### Panics
///
/// - Entity `UID` was not previously authorized for transfer
/// - NFT does not exist
/// - Target `Kiosk` deposit conditions were not met, see `deposit` method
/// - Source or target `Kiosk` are not OriginByte kiosks
/// - Panics if `Coin<sui::sui::SUI>` is provided for an NFT that is not
/// locked
public fun transfer_delegated_locked<T: key + store>(
source: &mut Kiosk,
target: &mut Kiosk,
nft_id: ID,
entity_id: &UID,
price: u64,
paid: Option<Coin<sui::sui::SUI>>,
transfer_policy: &sui::transfer_policy::TransferPolicy<T>,
ctx: &mut TxContext,
): TransferRequest<T> {
assert_version_and_upgrade(ext(source));

let (nft, req) = transfer_nft_(source, nft_id, uid_to_address(entity_id), price, ctx);
let (nft, req) = transfer_nft_(source, nft_id, uid_to_address(entity_id), price, paid, ctx);
deposit_locked(target, transfer_policy, nft, ctx);
req
}

/// Deprecated, use `transfer_signed_unlocked`
public fun transfer_signed<T: key + store>(
_source: &mut Kiosk,
_target: &mut Kiosk,
_nft_id: ID,
_price: u64,
_ctx: &mut TxContext,
): TransferRequest<T> {
abort(EDeprecatedApi)
}

/// Transfer NFT out of Kiosk that has been previously delegated
///
/// Requires that address of sender was previously passed to
Expand All @@ -607,19 +646,57 @@ module ob_kiosk::ob_kiosk {
/// - NFT does not exist
/// - Target `Kiosk` deposit conditions were not met, see `deposit` method
/// - Source or target `Kiosk` are not OriginByte kiosks
public fun transfer_signed<T: key + store>(
/// - Panics if `Coin<sui::sui::SUI>` is provided for an NFT that is not
/// locked
public fun transfer_signed_unlocked<T: key + store>(
source: &mut Kiosk,
target: &mut Kiosk,
nft_id: ID,
price: u64,
paid: Option<Coin<sui::sui::SUI>>,
ctx: &mut TxContext,
): TransferRequest<T> {
assert_version_and_upgrade(ext(source));
// Exclusive transfers need to be settled via `transfer_delegated`
// otherwise it's possible to create dangling locks
assert_not_exclusively_listed(source, nft_id);

let (nft, req) = transfer_nft_(source, nft_id, sender(ctx), price, paid, ctx);
deposit(target, nft, ctx);
req
}

/// Transfer NFT out of Kiosk that has been previously delegated
///
/// NFT will be locked in the target `Kiosk`
///
/// Requires that address of sender was previously passed to
/// `auth_transfer` or transaction sender is `Kiosk` owner.
///
/// Will always work if transaction sender is the `Kiosk` owner.
///
/// #### Panics
///
/// - Sender was not previously authorized for transfer or is not owner
/// - NFT does not exist
/// - Target `Kiosk` deposit conditions were not met, see `deposit` method
/// - Source or target `Kiosk` are not OriginByte kiosks
/// - Panics if `Coin<sui::sui::SUI>` is provided for an NFT that is not
/// locked
public fun transfer_signed_locked<T: key + store>(
source: &mut Kiosk,
target: &mut Kiosk,
nft_id: ID,
price: u64,
paid: Option<Coin<sui::sui::SUI>>,
ctx: &mut TxContext,
): TransferRequest<T> {
assert_version_and_upgrade(ext(source));
// Exclusive transfers need to be settled via `transfer_delegated`
// otherwise it's possible to create dangling locks
assert_not_exclusively_listed(source, nft_id);

let (nft, req) = transfer_nft_(source, nft_id, sender(ctx), price, ctx);
let (nft, req) = transfer_nft_(source, nft_id, sender(ctx), price, paid, ctx);
deposit(target, nft, ctx);
req
}
Expand Down Expand Up @@ -920,20 +997,30 @@ module ob_kiosk::ob_kiosk {
/// - Originator is not authorized to withdraw and transaction sender is
/// not owner.
/// - NFT does not exist
/// - NFT is locked
/// - Panics if `Coin<sui::sui::SUI>` is provided for an NFT that is not
/// locked
fun transfer_nft_<T: key + store>(
self: &mut Kiosk,
nft_id: ID,
originator: address,
price: u64,
paid: Option<Coin<sui::sui::SUI>>,
ctx: &mut TxContext,
): (T, TransferRequest<T>) {
if (kiosk::is_locked(self, nft_id)) {
let (nft, req) = remove_locked_nft(
self, nft_id, originator, coin::zero(ctx), ctx,
);
let paid = if (option::is_some(&paid)) {
option::destroy_some(paid)
} else {
option::destroy_none(paid);
coin::zero(ctx)
};

let (nft, req) =
remove_locked_nft(self, nft_id, originator, paid, ctx);
(nft, transfer_request::from_sui<T>(req, nft_id, originator, ctx))
} else {
option::destroy_none(paid);

let nft = remove_nft(self, nft_id, originator, ctx);
(nft, transfer_request::new(nft_id, originator, object::id(self), price, ctx))
}
Expand Down
Loading