;; Title: STX-LiSTX lp-token
;; Version: 1.0.0
;; Provides automated market making functionality between two SIP-010 compliant tokens.
;; Forked from Charisma. Generated by Faktory Launchpad
;; Traits
(impl-trait 'SP2ZNGJ85ENDY6QRHQ5P2D4FXKGZWCKTB2T0Z55KS.charisma-traits-v1.sip010-ft-trait)
(impl-trait 'SP2ZNGJ85ENDY6QRHQ5P2D4FXKGZWCKTB2T0Z55KS.dexterity-traits-v0.liquidity-pool-trait)
;; Constants
(define-constant DEPLOYER tx-sender)
(define-constant CONTRACT (as-contract tx-sender))
(define-constant ERR_INVALID_OPERATION (err u400))
(define-constant ERR_UNAUTHORIZED (err u403))
(define-constant ERR_TOO_MUCH_SLIPPAGE (err u407))
(define-constant PRECISION u1000000)
(define-constant LP_REBATE u3000)
;; Opcodes
(define-constant OP_SWAP_A_TO_B 0x00)
(define-constant OP_SWAP_B_TO_A 0x01)
(define-constant OP_ADD_LIQUIDITY 0x02)
(define-constant OP_REMOVE_LIQUIDITY 0x03)
(define-constant OP_LOOKUP_RESERVES 0x04)
;; Define LP token
(define-fungible-token STX-LiSTX)
(define-data-var token-uri (optional (string-utf8 256)) none)
;; --- SIP10 Functions ---
(define-public (transfer (amount uint) (sender principal) (recipient principal) (memo (optional (buff 34))))
(begin
(asserts! (is-eq tx-sender sender) ERR_UNAUTHORIZED)
(try! (ft-transfer? STX-LiSTX amount sender recipient))
(match memo to-print (print to-print) 0x0000)
(print {
type: "transfer-lp",
sender: sender,
recipient: recipient,
amount: amount,
pool-contract: CONTRACT
})
(ok true)))
(define-read-only (get-name)
(ok "STX-LiSTX lp-token"))
(define-read-only (get-symbol)
(ok "STX-LiSTX"))
(define-read-only (get-decimals)
(ok u6))
(define-read-only (get-balance (who principal))
(ok (ft-get-balance STX-LiSTX who)))
(define-read-only (get-total-supply)
(ok (ft-get-supply STX-LiSTX)))
(define-read-only (get-token-uri)
(ok (var-get token-uri)))
(define-public (set-token-uri (uri (string-utf8 256)))
(if (is-eq contract-caller DEPLOYER)
(ok (var-set token-uri (some uri)))
ERR_UNAUTHORIZED))
;; --- Core Functions ---
(define-public (execute (amount uint) (opcode (optional (buff 16))))
(let (
(sender tx-sender)
(operation (get-byte (default-to 0x00 opcode) u0)))
(if (is-eq operation OP_SWAP_A_TO_B) (swap-a-to-b amount u0)
(if (is-eq operation OP_SWAP_B_TO_A) (swap-b-to-a amount u0)
(if (is-eq operation OP_ADD_LIQUIDITY) (add-liquidity amount)
(if (is-eq operation OP_REMOVE_LIQUIDITY) (remove-liquidity amount)
ERR_INVALID_OPERATION))))))
(define-read-only (quote (amount uint) (opcode (optional (buff 16))))
(let (
(operation (get-byte (default-to 0x00 opcode) u0)))
(if (is-eq operation OP_SWAP_A_TO_B) (ok (get-swap-quote amount (some 0x00)))
(if (is-eq operation OP_SWAP_B_TO_A) (ok (get-swap-quote amount (some 0x01)))
(if (is-eq operation OP_ADD_LIQUIDITY) (ok (get-liquidity-quote amount))
(if (is-eq operation OP_REMOVE_LIQUIDITY) (ok (get-liquidity-quote amount))
(if (is-eq operation OP_LOOKUP_RESERVES) (ok (get-reserves-quote))
ERR_INVALID_OPERATION)))))))
;; --- Execute Functions ---
(define-public (swap-a-to-b (amount uint) (min-y-out uint))
(let (
(sender tx-sender)
(delta (get-swap-quote amount (some 0x00)))
(dy-d (get dy delta)))
(asserts! (>= dy-d min-y-out) ERR_TOO_MUCH_SLIPPAGE)
;; Transfer token A to pool
(try! (stx-transfer? amount sender CONTRACT))
;; Transfer token B to sender
(try! (as-contract (contract-call? 'SM26NBC8SFHNW4P1Y4DFH27974P56WN86C92HPEHH.token-lqstx transfer dy-d CONTRACT sender none)))
(print {
type: "buy",
sender: sender,
token-in: "STX",
amount-in: amount,
token-out: 'SM26NBC8SFHNW4P1Y4DFH27974P56WN86C92HPEHH.token-lqstx,
amount-out: dy-d,
pool-reserves: (get-reserves-quote),
pool-contract: CONTRACT,
min-y-out: min-y-out
})
(ok delta)))
(define-public (swap-b-to-a (amount uint) (min-y-out uint))
(let (
(sender tx-sender)
(delta (get-swap-quote amount (some 0x01)))
(dy-d (get dy delta)))
(asserts! (>= dy-d min-y-out) ERR_TOO_MUCH_SLIPPAGE)
;; Transfer token B to pool
(try! (contract-call? 'SM26NBC8SFHNW4P1Y4DFH27974P56WN86C92HPEHH.token-lqstx transfer amount sender CONTRACT none))
;; Transfer token A to sender
(try! (as-contract (stx-transfer? dy-d CONTRACT sender)))
(print {
type: "sell",
sender: sender,
token-in: 'SM26NBC8SFHNW4P1Y4DFH27974P56WN86C92HPEHH.token-lqstx,
amount-in: amount,
token-out: "STX",
amount-out: dy-d,
pool-reserves: (get-reserves-quote),
pool-contract: CONTRACT,
min-y-out: min-y-out
})
(ok delta)))
(define-public (add-liquidity (amount uint))
(let (
(sender tx-sender)
(delta (get-liquidity-quote amount))
(dx-d (get dx delta))
(dy-d (get dy delta))
(dk-d (get dk delta)))
(try! (stx-transfer? dx-d sender CONTRACT))
(try! (contract-call? 'SM26NBC8SFHNW4P1Y4DFH27974P56WN86C92HPEHH.token-lqstx transfer dy-d sender CONTRACT none))
(try! (ft-mint? STX-LiSTX dk-d sender))
(print {
type: "add-liquidity",
sender: sender,
token-a: "STX",
token-a-amount: dx-d,
token-b: 'SM26NBC8SFHNW4P1Y4DFH27974P56WN86C92HPEHH.token-lqstx,
token-b-amount: dy-d,
lp-tokens: dk-d,
pool-reserves: (get-reserves-quote),
pool-contract: CONTRACT
})
(ok delta)))
(define-public (remove-liquidity (amount uint))
(let (
(sender tx-sender)
(delta (get-liquidity-quote amount))
(dx-d (get dx delta))
(dy-d (get dy delta))
(dk-d (get dk delta)))
(try! (ft-burn? STX-LiSTX dk-d sender))
(try! (as-contract (stx-transfer? dx-d CONTRACT sender)))
(try! (as-contract (contract-call? 'SM26NBC8SFHNW4P1Y4DFH27974P56WN86C92HPEHH.token-lqstx transfer dy-d CONTRACT sender none)))
(print {
type: "remove-liquidity",
sender: sender,
token-a: "STX",
token-a-amount: dx-d,
token-b: 'SM26NBC8SFHNW4P1Y4DFH27974P56WN86C92HPEHH.token-lqstx,
token-b-amount: dy-d,
lp-tokens: dk-d,
pool-reserves: (get-reserves-quote),
pool-contract: CONTRACT
})
(ok delta)))
;; --- Helper Functions ---
(define-private (get-byte (opcode (buff 16)) (position uint))
(default-to 0x00 (element-at? opcode position)))
(define-private (get-reserves)
{
a: (stx-get-balance CONTRACT),
b: (unwrap-panic (contract-call? 'SM26NBC8SFHNW4P1Y4DFH27974P56WN86C92HPEHH.token-lqstx get-balance CONTRACT))
})
;; --- Quote Functions ---
(define-read-only (get-swap-quote (amount uint) (opcode (optional (buff 16))))
(let (
(reserves (get-reserves))
(operation (get-byte (default-to 0x00 opcode) u0))
(is-a-in (is-eq operation OP_SWAP_A_TO_B))
(x (if is-a-in (get a reserves) (get b reserves)))
(y (if is-a-in (get b reserves) (get a reserves)))
(dx (/ (* amount (- PRECISION LP_REBATE)) PRECISION))
(numerator (* dx y))
(denominator (+ x dx))
(dy (/ numerator denominator)))
{
dx: dx,
dy: dy,
dk: u0
}))
(define-read-only (get-liquidity-quote (amount uint))
(let (
(k (ft-get-supply STX-LiSTX))
(reserves (get-reserves)))
{
dx: (if (> k u0) (/ (* amount (get a reserves)) k) amount),
dy: (if (> k u0) (/ (* amount (get b reserves)) k) amount),
dk: amount
}))
(define-read-only (get-reserves-quote)
(let (
(reserves (get-reserves))
(supply (ft-get-supply STX-LiSTX)))
{
dx: (get a reserves),
dy: (get b reserves),
dk: supply
}))