@flowtyio/flow-contracts 0.0.14 → 0.0.16

package/contracts/dapper/offers/OffersV2.cdc

@@ -0,0 +1,344 @@
+import "FungibleToken"
+import "NonFungibleToken"
+import "DapperUtilityCoin"
+import "MetadataViews"
+import "Resolver"
+
+// OffersV2
+//
+// Contract holds the Offer resource and a public method to create them.
+//
+// Each Offer can have one or more royalties of the sale price that
+// goes to one or more addresses.
+//
+// Owners of NFT can watch for OfferAvailable events and check
+// the Offer amount to see if they wish to accept the offer.
+//
+// Marketplaces and other aggregators can watch for OfferAvailable events
+// and list offers of interest to logged in users.
+//
+pub contract OffersV2 {
+    // OfferAvailable
+    // An Offer has been created and added to the users DapperOffer resource.
+    //
+
+    pub event OfferAvailable(
+        offerAddress: Address,
+        offerId: UInt64,
+        nftType: Type,
+        offerAmount: UFix64,
+        royalties: {Address:UFix64},
+        offerType: String,
+        offerParamsString: {String:String},
+        offerParamsUFix64: {String:UFix64},
+        offerParamsUInt64: {String:UInt64},
+        paymentVaultType: Type,
+    )
+
+    // OfferCompleted
+    // The Offer has been resolved. The offer has either been accepted
+    //  by the NFT owner, or the offer has been removed and destroyed.
+    //
+    pub event OfferCompleted(
+        purchased: Bool,
+        acceptingAddress: Address?,
+        offerAddress: Address,
+        offerId: UInt64,
+        nftType: Type,
+        offerAmount: UFix64,
+        royalties: {Address:UFix64},
+        offerType: String,
+        offerParamsString: {String:String},
+        offerParamsUFix64: {String:UFix64},
+        offerParamsUInt64: {String:UInt64},
+        paymentVaultType: Type,
+        nftId: UInt64?,
+    )
+
+    // Royalty
+    // A struct representing a recipient that must be sent a certain amount
+    // of the payment when a NFT is sold.
+    //
+    pub struct Royalty {
+        pub let receiver: Capability<&{FungibleToken.Receiver}>
+        pub let amount: UFix64
+
+        init(receiver: Capability<&{FungibleToken.Receiver}>, amount: UFix64) {
+            self.receiver = receiver
+            self.amount = amount
+        }
+    }
+
+    // OfferDetails
+    // A struct containing Offers' data.
+    //
+    pub struct OfferDetails {
+        // The ID of the offer
+        pub let offerId: UInt64
+        // The Type of the NFT
+        pub let nftType: Type
+        // The Type of the FungibleToken that payments must be made in.
+        pub let paymentVaultType: Type
+        // The Offer amount for the NFT
+        pub let offerAmount: UFix64
+        // Flag to tracked the purchase state
+        pub var purchased: Bool
+        // This specifies the division of payment between recipients.
+        pub let royalties: [Royalty]
+        // Used to hold Offer metadata and offer type information
+        pub let offerParamsString: {String: String}
+        pub let offerParamsUFix64: {String:UFix64}
+        pub let offerParamsUInt64: {String:UInt64}
+
+        // setToPurchased
+        // Irreversibly set this offer as purchased.
+        //
+        access(contract) fun setToPurchased() {
+            self.purchased = true
+        }
+
+        // initializer
+        //
+        init(
+            offerId: UInt64,
+            nftType: Type,
+            offerAmount: UFix64,
+            royalties: [Royalty],
+            offerParamsString: {String: String},
+            offerParamsUFix64: {String:UFix64},
+            offerParamsUInt64: {String:UInt64},
+            paymentVaultType: Type,
+        ) {
+            self.offerId = offerId
+            self.nftType = nftType
+            self.offerAmount = offerAmount
+            self.purchased = false
+            self.royalties = royalties
+            self.offerParamsString = offerParamsString
+            self.offerParamsUFix64 = offerParamsUFix64
+            self.offerParamsUInt64 = offerParamsUInt64
+            self.paymentVaultType = paymentVaultType
+        }
+    }
+
+    // OfferPublic
+    // An interface providing a useful public interface to an Offer resource.
+    //
+    pub resource interface OfferPublic {
+        // accept
+        // This will accept the offer if provided with the NFT id that matches the Offer
+        //
+        pub fun accept(
+            item: @AnyResource{NonFungibleToken.INFT, MetadataViews.Resolver},
+            receiverCapability: Capability<&{FungibleToken.Receiver}>,
+        ): Void
+        // getDetails
+        // Return Offer details
+        //
+        pub fun getDetails(): OfferDetails
+    }
+
+
+    pub resource Offer: OfferPublic {
+        // The OfferDetails struct of the Offer
+        access(self) let details: OfferDetails
+        // The vault which will handle the payment if the Offer is accepted.
+        access(contract) let vaultRefCapability: Capability<&{FungibleToken.Provider, FungibleToken.Balance}>
+        // Receiver address for the NFT when/if the Offer is accepted.
+        access(contract) let nftReceiverCapability: Capability<&{NonFungibleToken.CollectionPublic}>
+        // Resolver capability for the offer type
+        access(contract) let resolverCapability: Capability<&{Resolver.ResolverPublic}>
+
+        init(
+            vaultRefCapability: Capability<&{FungibleToken.Provider, FungibleToken.Balance}>,
+            nftReceiverCapability: Capability<&{NonFungibleToken.CollectionPublic}>,
+            nftType: Type,
+            amount: UFix64,
+            royalties: [Royalty],
+            offerParamsString: {String: String},
+            offerParamsUFix64: {String:UFix64},
+            offerParamsUInt64: {String:UInt64},
+            resolverCapability: Capability<&{Resolver.ResolverPublic}>,
+        ) {
+            pre {
+                nftReceiverCapability.check(): "reward capability not valid"
+            }
+            self.vaultRefCapability = vaultRefCapability
+            self.nftReceiverCapability = nftReceiverCapability
+            self.resolverCapability = resolverCapability
+            var price: UFix64 = amount
+            let royaltyInfo: {Address:UFix64} = {}
+
+            for royalty in royalties {
+                assert(royalty.receiver.check(), message: "invalid royalty receiver")
+                price = price - royalty.amount
+                royaltyInfo[royalty.receiver.address] = royalty.amount
+            }
+
+            assert(price > 0.0, message: "price must be > 0")
+
+            self.details = OfferDetails(
+                offerId: self.uuid,
+                nftType: nftType,
+                offerAmount: amount,
+                royalties: royalties,
+                offerParamsString: offerParamsString,
+                offerParamsUFix64: offerParamsUFix64,
+                offerParamsUInt64: offerParamsUInt64,
+                paymentVaultType: vaultRefCapability.getType(),
+            )
+
+            emit OfferAvailable(
+                offerAddress: nftReceiverCapability.address,
+                offerId: self.details.offerId,
+                nftType: self.details.nftType,
+                offerAmount: self.details.offerAmount,
+                royalties: royaltyInfo,
+                offerType: offerParamsString["_type"] ?? "unknown",
+                offerParamsString: self.details.offerParamsString,
+                offerParamsUFix64: self.details.offerParamsUFix64,
+                offerParamsUInt64: self.details.offerParamsUInt64,
+                paymentVaultType: self.details.paymentVaultType,
+            )
+        }
+
+        // accept
+        // Accept the offer if...
+        // - Calling from an Offer that hasn't been purchased/desetoryed.
+        // - Provided with a NFT matching the NFT id within the Offer details.
+        // - Provided with a NFT matching the NFT Type within the Offer details.
+        //
+        pub fun accept(
+                item: @AnyResource{NonFungibleToken.INFT, MetadataViews.Resolver},
+                receiverCapability: Capability<&{FungibleToken.Receiver}>,
+            ): Void {
+
+            pre {
+                !self.details.purchased: "Offer has already been purchased"
+                item.isInstance(self.details.nftType): "item NFT is not of specified type"
+            }
+
+            let resolverCapability = self.resolverCapability.borrow() ?? panic("could not borrow resolver")
+            let resolverResult = resolverCapability.checkOfferResolver(
+                item: &item as &AnyResource{NonFungibleToken.INFT, MetadataViews.Resolver},
+                offerParamsString: self.details.offerParamsString,
+                offerParamsUInt64: self.details.offerParamsUInt64,
+                offerParamsUFix64: self.details.offerParamsUFix64,
+            )
+
+            if !resolverResult {
+                panic("Resolver failed, invalid NFT please check Offer criteria")
+            }
+
+            self.details.setToPurchased()
+            let nft <- item as! @NonFungibleToken.NFT
+            let nftId: UInt64 = nft.id
+            self.nftReceiverCapability.borrow()!.deposit(token: <- nft)
+
+            let initalDucSupply = self.vaultRefCapability.borrow()!.balance
+            let payment <- self.vaultRefCapability.borrow()!.withdraw(amount: self.details.offerAmount)
+
+            // Payout royalties
+            for royalty in self.details.royalties {
+                if let receiver = royalty.receiver.borrow() {
+                    let amount = royalty.amount
+                    let part <- payment.withdraw(amount: amount)
+                    receiver.deposit(from: <- part)
+                }
+            }
+
+            receiverCapability.borrow()!.deposit(from: <- payment)
+
+            // If a DUC vault is being used for payment we must assert that no DUC is leaking from the transactions.
+            let isDucVault = self.vaultRefCapability.isInstance(
+                Type<Capability<&DapperUtilityCoin.Vault{FungibleToken.Provider, FungibleToken.Balance}>>()
+            )
+
+            if isDucVault {
+                assert(self.vaultRefCapability.borrow()!.balance == initalDucSupply, message: "DUC is leaking")
+            }
+
+            emit OfferCompleted(
+                purchased: self.details.purchased,
+                acceptingAddress: receiverCapability.address,
+                offerAddress: self.nftReceiverCapability.address,
+                offerId: self.details.offerId,
+                nftType: self.details.nftType,
+                offerAmount: self.details.offerAmount,
+                royalties: self.getRoyaltyInfo(),
+                offerType: self.details.offerParamsString["_type"] ?? "unknown",
+                offerParamsString: self.details.offerParamsString,
+                offerParamsUFix64: self.details.offerParamsUFix64,
+                offerParamsUInt64: self.details.offerParamsUInt64,
+                paymentVaultType: self.details.paymentVaultType,
+                nftId: nftId,
+            )
+        }
+
+        // getDetails
+        // Return Offer details
+        //
+        pub fun getDetails(): OfferDetails {
+            return self.details
+        }
+
+        // getRoyaltyInfo
+        // Return royalty details
+        //
+        pub fun getRoyaltyInfo(): {Address:UFix64} {
+            let royaltyInfo: {Address:UFix64} = {}
+
+            for royalty in self.details.royalties {
+                royaltyInfo[royalty.receiver.address] = royalty.amount
+            }
+            return royaltyInfo;
+        }
+
+        destroy() {
+            if !self.details.purchased {
+                emit OfferCompleted(
+                    purchased: self.details.purchased,
+                    acceptingAddress: nil,
+                    offerAddress: self.nftReceiverCapability.address,
+                    offerId: self.details.offerId,
+                    nftType: self.details.nftType,
+                    offerAmount: self.details.offerAmount,
+                    royalties: self.getRoyaltyInfo(),
+                    offerType: self.details.offerParamsString["_type"] ?? "unknown",
+                    offerParamsString: self.details.offerParamsString,
+                    offerParamsUFix64: self.details.offerParamsUFix64,
+                    offerParamsUInt64: self.details.offerParamsUInt64,
+                    paymentVaultType: self.details.paymentVaultType,
+                    nftId: nil,
+                )
+            }
+        }
+    }
+
+    // makeOffer
+    pub fun makeOffer(
+        vaultRefCapability: Capability<&{FungibleToken.Provider, FungibleToken.Balance}>,
+        nftReceiverCapability: Capability<&{NonFungibleToken.CollectionPublic}>,
+        nftType: Type,
+        amount: UFix64,
+        royalties: [Royalty],
+        offerParamsString: {String:String},
+        offerParamsUFix64: {String:UFix64},
+        offerParamsUInt64: {String:UInt64},
+        resolverCapability: Capability<&{Resolver.ResolverPublic}>,
+    ): @Offer {
+        let newOfferResource <- create Offer(
+            vaultRefCapability: vaultRefCapability,
+            nftReceiverCapability: nftReceiverCapability,
+            nftType: nftType,
+            amount: amount,
+            royalties: royalties,
+            offerParamsString: offerParamsString,
+            offerParamsUFix64: offerParamsUFix64,
+            offerParamsUInt64: offerParamsUInt64,
+            resolverCapability: resolverCapability,
+        )
+        return <-newOfferResource
+    }
+}
+ 

package/contracts/dapper/offers/Resolver.cdc

@@ -0,0 +1,70 @@
+import "NonFungibleToken"
+import "MetadataViews"
+import "TopShot"
+
+pub contract Resolver {
+    // Current list of supported resolution rules.
+    pub enum ResolverType: UInt8 {
+        pub case NFT
+        pub case TopShotEdition
+        pub case MetadataViewsEditions
+    }
+
+    // Public resource interface that defines a method signature for checkOfferResolver
+    // which is used within the Resolver resource for offer acceptance validation
+    pub resource interface ResolverPublic {
+        pub fun checkOfferResolver(
+         item: &AnyResource{NonFungibleToken.INFT, MetadataViews.Resolver},
+         offerParamsString: {String:String},
+         offerParamsUInt64: {String:UInt64},
+         offerParamsUFix64: {String:UFix64}): Bool
+    }
+
+
+    // Resolver resource holds the Offer exchange resolution rules.
+    pub resource OfferResolver: ResolverPublic {
+        // checkOfferResolver
+        // Holds the validation rules for resolver each type of supported ResolverType
+        // Function returns TRUE if the provided nft item passes the criteria for exchange
+        pub fun checkOfferResolver(
+         item: &AnyResource{NonFungibleToken.INFT, MetadataViews.Resolver},
+         offerParamsString: {String:String},
+         offerParamsUInt64: {String:UInt64},
+         offerParamsUFix64: {String:UFix64}): Bool {
+            if offerParamsString["resolver"] == ResolverType.NFT.rawValue.toString() {
+                assert(item.id.toString() == offerParamsString["nftId"], message: "item NFT does not have specified ID")
+                return true
+            } else if offerParamsString["resolver"] == ResolverType.TopShotEdition.rawValue.toString() {
+                // // Get the Top Shot specific metadata for this NFT
+                let view = item.resolveView(Type<TopShot.TopShotMomentMetadataView>())!
+                let metadata = view as! TopShot.TopShotMomentMetadataView
+                if offerParamsString["playId"] == metadata.playID.toString() && offerParamsString["setId"] == metadata.setID.toString() {
+                    return true
+                }
+            } else if offerParamsString["resolver"] == ResolverType.MetadataViewsEditions.rawValue.toString() {
+                if let views = item.resolveView(Type<MetadataViews.Editions>()) {
+                    let editions = views as! [MetadataViews.Edition]
+                    var hasCorrectMetadataView = false
+                    for edition in editions {
+                        if edition.name == offerParamsString["editionName"] {
+                            hasCorrectMetadataView = true
+                        }
+                    }
+                    assert(hasCorrectMetadataView == true, message: "editionId does not exist on NFT")
+                    return true
+                } else {
+                    panic("NFT does not use MetadataViews.Editions")
+                }
+            } else {
+                panic("Invalid Resolver on Offer")
+            }
+
+            return false
+        }
+
+    }
+
+    pub fun createResolver(): @OfferResolver {
+        return <-create OfferResolver()
+    }
+}

package/contracts/flow-utils/AddressUtils.cdc

@@ -0,0 +1,109 @@
+import "StringUtils"
+
+pub contract AddressUtils {
+
+    pub fun withoutPrefix(_ input: String): String {
+        var address = input
+
+        // get rid of 0x
+        if address.length > 1 && address.utf8[1] == 120 {
+            address = address.slice(from: 2, upTo: address.length)
+        }
+
+        // ensure even length
+        if address.length % 2 == 1 {
+            address = "0".concat(address)
+        }
+        return address
+    }
+
+    pub fun parseUInt64(_ input: AnyStruct): UInt64? {
+        var stringValue = ""
+
+        if let string = input as? String {
+            stringValue = string
+        } else if let address = input as? Address {
+            stringValue = address.toString()
+        } else if let type = input as? Type {
+            let parts = StringUtils.split(type.identifier, ".")
+            if parts.length == 1 {
+                return nil
+            }
+            stringValue = parts[1]
+        } else {
+            return nil
+        }
+
+        let address = self.withoutPrefix(stringValue)
+        let bytes = address.decodeHex()
+        var r: UInt64 = 0
+        var length = bytes.length
+        for byte in bytes {
+            length = length - 1
+            r = r + (UInt64(byte) << UInt64(length * 8))
+        }
+        return r
+    }
+
+    pub fun parseAddress(_ input: AnyStruct): Address? {
+        if let parsed = self.parseUInt64(input) {
+            return Address(parsed)
+        }
+        return nil
+    }
+
+    pub fun isValidAddress(_ input: AnyStruct, forNetwork: String): Bool {
+        let address = self.parseUInt64(input)
+        if address == nil {
+            return false
+        }
+
+        let codeWords: {String: UInt64} = {
+            "MAINNET" : 0,
+            "TESTNET" : 0x6834ba37b3980209,
+            "EMULATOR": 0x1cb159857af02018
+        }
+
+        let parityCheckMatrixColumns: [UInt64] = [
+            0x00001, 0x00002, 0x00004, 0x00008, 0x00010, 0x00020, 0x00040, 0x00080,
+            0x00100, 0x00200, 0x00400, 0x00800, 0x01000, 0x02000, 0x04000, 0x08000,
+            0x10000, 0x20000, 0x40000, 0x7328d, 0x6689a, 0x6112f, 0x6084b, 0x433fd,
+            0x42aab, 0x41951, 0x233ce, 0x22a81, 0x21948, 0x1ef60, 0x1deca, 0x1c639,
+            0x1bdd8, 0x1a535, 0x194ac, 0x18c46, 0x1632b, 0x1529b, 0x14a43, 0x13184,
+            0x12942, 0x118c1, 0x0f812, 0x0e027, 0x0d00e, 0x0c83c, 0x0b01d, 0x0a831,
+            0x0982b, 0x07034, 0x0682a, 0x05819, 0x03807, 0x007d2, 0x00727, 0x0068e,
+            0x0067c, 0x0059d, 0x004eb, 0x003b4, 0x0036a, 0x002d9, 0x001c7, 0x0003f
+        ]
+
+        var parity: UInt64 = 0
+        var codeWord: UInt64 = codeWords[forNetwork]!
+        codeWord = codeWord ^ address!
+
+        if codeWord == 0 {
+            return false
+        }
+
+        for column in parityCheckMatrixColumns{
+            if codeWord & 1 == 1 {
+                parity = parity ^ column
+            }
+            codeWord = codeWord >> 1
+        }
+
+        return parity == 0 && codeWord == 0
+    }
+
+    pub fun getNetworkFromAddress(_ input: AnyStruct): String? {
+        for network in ["MAINNET", "TESTNET", "EMULATOR"]{
+            if self.isValidAddress(input, forNetwork: network){
+                return network
+            }
+        }
+        return nil
+    }
+
+    pub fun currentNetwork(): String {
+        return self.getNetworkFromAddress(self.account.address)!
+    }
+
+}

package/contracts/flow-utils/ArrayUtils.cdc

@@ -0,0 +1,69 @@
+// Copied from https://github.com/bluesign/flow-utils/blob/dnz/cadence/contracts/ArrayUtils.cdc with minor adjustments
+
+pub contract ArrayUtils {
+
+    pub fun rangeFunc(_ start: Int, _ end: Int, _ f: ((Int): Void)) {
+        var current = start
+        while current < end {
+            f(current)
+            current = current + 1
+        }
+    }
+
+    pub fun range(_ start: Int, _ end: Int): [Int] {
+        var res: [Int] = []
+        self.rangeFunc(start, end, fun (i: Int) {
+            res.append(i)
+        })
+        return res
+    }
+
+    pub fun reverse(_ array: [Int]): [Int] {
+        var res: [Int] = []
+        var i: Int = array.length - 1
+        while i >= 0 {
+            res.append(array[i])
+            i = i - 1
+        }
+        return res
+    }
+
+    pub fun transform(_ array: &[AnyStruct], _ f : ((AnyStruct): AnyStruct)){
+        for i in self.range(0, array.length){
+            array[i] = f(array[i])
+        }
+    }
+
+    pub fun iterate(_ array: [AnyStruct], _ f : ((AnyStruct): Bool)){
+        for item in array{
+            if !f(item){
+                break
+            }
+        }
+    }
+
+    pub fun map(_ array: [AnyStruct], _ f : ((AnyStruct): AnyStruct)) : [AnyStruct] {
+        var res : [AnyStruct] = []
+        for item in array{
+            res.append(f(item))
+        }
+        return res
+    }
+
+    pub fun mapStrings(_ array: [String], _ f: ((String) : String) ) : [String] {
+        var res : [String] = []
+        for item in array{
+            res.append(f(item))
+        }
+        return res
+    }
+
+    pub fun reduce(_ array: [AnyStruct], _ initial: AnyStruct, _ f : ((AnyStruct, AnyStruct): AnyStruct)) : AnyStruct{
+        var res: AnyStruct = f(initial, array[0])
+        for i in self.range(1, array.length){
+            res =  f(res, array[i])
+        }
+        return res
+    }
+
+}

package/contracts/flow-utils/StringUtils.cdc

@@ -0,0 +1,97 @@
+import "ArrayUtils"
+
+pub contract StringUtils {
+   
+    pub fun format(_ s: String, _ args: {String:String}): String{
+      var formatted = s
+      for key in args.keys{
+        formatted = StringUtils.replaceAll(formatted, "{".concat(key).concat("}"), args[key]!)
+      }
+      return formatted
+    }
+
+    pub fun explode(_ s: String): [String]{
+        var chars : [String] =  []
+        for i in ArrayUtils.range(0, s.length){
+            chars.append(s[i].toString())
+        }  
+        return chars
+    }
+
+    pub fun trimLeft(_ s: String): String{
+        for i in ArrayUtils.range(0, s.length){
+            if s[i] != " "{
+                return s.slice(from: i, upTo: s.length)
+            }
+        }
+        return ""
+    }
+
+    pub fun trim(_ s: String): String{
+        return self.trimLeft(s)
+    }
+
+    pub fun replaceAll(_ s: String, _ search: String, _ replace: String): String{
+        return self.join(self.split(s, search), replace)
+    }
+
+    pub fun hasPrefix(_ s: String, _ prefix: String) : Bool{
+        return s.length >= prefix.length && s.slice(from:0, upTo: prefix.length)==prefix
+    }
+
+    pub fun hasSuffix(_ s: String, _ suffix: String) : Bool{
+        return s.length >= suffix.length && s.slice(from:s.length-suffix.length, upTo: s.length)==suffix
+    }
+
+    pub fun index(_ s : String, _ substr : String, _ startIndex: Int): Int?{
+        for i in ArrayUtils.range(startIndex,s.length-substr.length+1){
+            if s[i]==substr[0] && s.slice(from:i, upTo:i+substr.length) == substr{
+                return i
+            }
+        }
+        return nil
+    }
+
+    pub fun count(_ s: String, _ substr: String): Int{
+        var pos = [self.index(s, substr, 0)]
+        while pos[0]!=nil {
+            pos.insert(at:0, self.index(s, substr, pos[0]!+pos.length*substr.length+1))
+        }
+        return pos.length-1
+    }
+
+    pub fun contains(_ s: String, _ substr: String): Bool {
+        if let index =  self.index(s, substr, 0) {
+            return true
+        }
+        return false
+    }
+
+    pub fun substringUntil(_ s: String, _ until: String, _ startIndex: Int): String{
+        if let index = self.index( s, until, startIndex){
+            return s.slice(from:startIndex, upTo: index)
+        }
+        return s.slice(from:startIndex, upTo:s.length)
+    }
+
+    pub fun split(_ s: String, _ delimiter: String): [String] {
+        let segments: [String] = [] 
+        var p = 0
+        while p<=s.length{
+            var preDelimiter = self.substringUntil(s, delimiter, p)
+            segments.append(preDelimiter)
+            p = p + preDelimiter.length + delimiter.length 
+        }
+        return segments 
+    }
+
+    pub fun join(_ strs: [String], _ separator: String): String {
+        var joinedStr = ""
+        for s in strs {
+            joinedStr = joinedStr.concat(s).concat(separator)
+        }
+        return joinedStr.slice(from: 0, upTo: joinedStr.length - separator.length)
+    }
+
+
+}