Skip to content
This repository was archived by the owner on Jan 18, 2023. It is now read-only.

Draft impl of Safe in orderbook #3

Open
porkbrain wants to merge 16 commits into
base: develop
Choose a base branch
from
Open

Draft impl of Safe in orderbook #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
2f402c8
Draft impl of safe in orderbook
porkbrain Oct 4, 2022
baa1bbb
Removing Fees generic
porkbrain Oct 4, 2022
d7406dd
Adding logic to buy_nft and cancel_ask
porkbrain Oct 4, 2022
43af1f0
Adding witness pattern for Trade
porkbrain Oct 6, 2022
f982f50
Adding an example foo_nft impl
porkbrain Oct 6, 2022
fd75c4c
Removing nft protocol
porkbrain Oct 6, 2022
ad2c559
Renaming function in foo_nft
porkbrain Oct 6, 2022
26a3e9c
Updating README with Safe
porkbrain Oct 6, 2022
fec3d59
Expanding on the idea of TradePayment
porkbrain Oct 6, 2022
d8f9f20
Posting a link to complication with Safe
porkbrain Oct 6, 2022
d19fd88
Using TradeIntermediate abstraction
porkbrain Oct 10, 2022
6594b65
Showcasing commissions
porkbrain Oct 11, 2022
cc74f7b
Using C for collection generic
porkbrain Oct 11, 2022
3a6cb38
Some more docs and TBDs about TradeCao
porkbrain Oct 11, 2022
3320b31
Finish trade is now an entry point
porkbrain Oct 11, 2022
a3822e0
Implementing whitelist
porkbrain Oct 17, 2022
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
6 changes: 2 additions & 4 deletions Move.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
[package]
name = "Syrup"
name = "LiquidityLayer"
version = "0.4.0"

[dependencies]
NftProtocol = { git = "https://github.com/Origin-Byte/nft-protocol", rev = "0.3.0" }
Sui = { git = "https://github.com/MystenLabs/sui.git", subdir = "crates/sui-framework", rev = "devnet-0.9.0" }

[addresses]
syrup = "0x0"
# nft_protocol = "0xe6d6f01725d469b7b04d9905e6b3151e8c4264cb"
liquidity_layer = "0x0"
8 changes: 3 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
- Sui v0.9.0

Working title: _syrup_ (to be changed)

NFT liquidity layer is a suite of modules which aim to bring NFT trading across
marketplaces to a single point, thereby concentrating the liquidity into a
common interface.
Expand All @@ -18,16 +20,12 @@ An ask is one NFT with a min price condition.

`Ask` is an object which is associated with a single NFT.
When `Ask` is created, we transfer the ownership of the NFT to this
new object.
When an `Ask` is matched with a bid, we transfer the ownership of the
`ask` object to the bid owner (buyer).
The buyer can then claim the NFT via `claim_nft` endpoint.
new object. To be more precise, we transfer the `safe::TransferCap`.

One can:

- create a new orderbook between a given collection and a BID token (witness
pattern protected)
- collect fees (witness pattern protected)
- set publicly accessible actions to be witness protected
- open a new BID
- cancel an existing BID they own
Expand Down
59 changes: 0 additions & 59 deletions examples/custom_collection.move
View file
Open in desktop

This file was deleted.

82 changes: 0 additions & 82 deletions examples/name_service.move
View file
Open in desktop

This file was deleted.

147 changes: 147 additions & 0 deletions sources/bidding.move
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
module liquidity_layer::bidding {
use liquidity_layer::collection::{Self, TradeReceipt, TradingWhitelist};
use liquidity_layer::err;
use liquidity_layer::safe::{Self, Safe, TransferCap};
use std::option::{Self, Option};
use sui::balance::{Self, Balance};
use sui::coin::{Self, Coin};
use sui::object::{Self, ID, UID};
use sui::transfer::{transfer, share_object};
use sui::tx_context::{Self, TxContext};

struct Bidding has key {
id: UID,
}

struct Bid<phantom FT> has key {
id: UID,
nft: ID,
buyer: address,
offer: Balance<FT>,
commission: Option<BidCommission<FT>>,
}

/// Enables collection of wallet/marketplace collection for buying NFTs.
/// 1. user bids via wallet to buy NFT for `p`, wallet wants fee `f`
/// 2. when executed, `p` goes to seller and `f` goes to wallet.
///
///
/// TODO: deduplicate with OB
struct BidCommission<phantom FT> has store {
/// This is given to the facilitator of the trade.
cut: Balance<FT>,
/// A new `Coin` object is created and sent to this address.
beneficiary: address,
}

/// TODO: deduplicate with OB
struct AskCommission has store, drop {
/// How many tokens of the transferred amount should go to the party
/// which holds the private key of `beneficiary` address.
///
/// Always less than ask price.
cut: u64,
/// A new `Coin` object is created and sent to this address.
beneficiary: address,
}

public entry fun create_bid<FT>(
_nft: address,
_amount: u64,
_wallet: &mut Coin<FT>,
_ctx: &mut TxContext,
) {
abort(0)
}

// TODO: opt commission
public entry fun sell_nft<W, C: key, FT>(
contract: &Bidding,
bid: &mut Bid<FT>,
nft_cap: TransferCap,
safe: &mut Safe<C>,
whitelist: &TradingWhitelist<W, C>,
ctx: &mut TxContext,
) {
assert!(
object::id(safe) == safe::transfer_cap_safe_id(&nft_cap),
err::nft_collection_mismatch(),
);
assert!(
bid.nft == safe::transfer_cap_nft_id(&nft_cap),
err::nft_collection_mismatch(),
);

let trade = collection::begin_nft_trade(&contract.id, ctx);
let ask_commission = option::none();
pay_for_nft(
&mut trade,
&mut bid.offer,
bid.buyer,
&mut ask_commission,
ctx,
);
option::destroy_none(ask_commission);

let nft = safe::trade_nft<W, C>(nft_cap, trade, whitelist, safe);
transfer(nft, bid.buyer);

transfer_bid_commission(&mut bid.commission, ctx);
}

// TODO: dedup
fun pay_for_nft<W, FT>(
trade: &mut TradeReceipt<W>,
paid: &mut Balance<FT>,
buyer: address,
maybe_commission: &mut Option<AskCommission>,
ctx: &mut TxContext,
) {
let amount = balance::value(paid);

if (option::is_some(maybe_commission)) {
// the `p`aid amount for the NFT and the commission `c`ut

let AskCommission {
cut, beneficiary,
} = option::extract(maybe_commission);

// `p` - `c` goes to seller
collection::add_nft_payment(
trade,
balance::split(paid, amount - cut),
buyer,
ctx,
);
// `c` goes to the marketplace
collection::add_nft_payment(
trade,
balance::split(paid, cut),
beneficiary,
ctx,
);
} else {
// no commission, all `p` goes to seller

collection::add_nft_payment(
trade,
balance::split(paid, amount),
buyer,
ctx,
);
};
}

// TODO: dedup
fun transfer_bid_commission<FT>(
commission: &mut Option<BidCommission<FT>>,
ctx: &mut TxContext,
) {
if (option::is_some(commission)) {
let BidCommission { beneficiary, cut } =
option::extract(commission);

transfer(coin::from_balance(cut, ctx), beneficiary);
};
}
}
Loading