--- 8e6c420ff692bc8aae8628299599f4d5a643969362d59cdd0499ec8289dfea25.68987336 +++ crescendo-migration.85981134 @@ -6,6 +6,7 @@ import FlovatarPack from 0x921ea449dffec68a import MetadataViews from 0x1d7e57aa55817448 import FlovatarDustToken from 0x921ea449dffec68a +import ViewResolver from 0x1d7e57aa55817448 /* @@ -22,1312 +23,1459 @@ */ -pub contract Flovatar: NonFungibleToken { +access(all) +contract Flovatar: NonFungibleToken{ + access(all) + let CollectionStoragePath: StoragePath + + access(all) + let CollectionPublicPath: PublicPath + + access(all) + let AdminStoragePath: StoragePath + + // These will be used in the Marketplace to pay out + // royalties to the creator and to the marketplace + access(account) + var royaltyCut: UFix64 + + access(account) + var marketplaceCut: UFix64 + + // Here we keep track of all the Flovatar unique combinations and names + // that people will generate to make sure that there are no duplicates + access(all) + var totalSupply: UInt64 + + access(contract) + let mintedCombinations:{ String: Bool} + + access(contract) + let mintedNames:{ String: Bool} + + access(all) + event ContractInitialized() + + access(all) + event Withdraw(id: UInt64, from: Address?) + + access(all) + event Deposit(id: UInt64, to: Address?) + + access(all) + event Created(id: UInt64, metadata: Metadata) + + access(all) + event Updated(id: UInt64) + + access(all) + event NameSet(id: UInt64, name: String) + + access(all) + event PositionChanged(id: UInt64, position: String) + + access(all) + event StoryAdded(id: UInt64, story: String) + + access(all) + event Unlocked3DFile(id: UInt64) + + access(all) + event UnlockedChat(id: UInt64) + + access(all) + struct Royalties{ + access(all) + let royalty: [Royalty] + + init(royalty: [Royalty]){ + self.royalty = royalty + } + } + + access(all) + enum RoyaltyType: UInt8{ + access(all) + case fixed + + access(all) + case percentage + } + + access(all) + struct Royalty{ + access(all) + let wallet: Capability<&{FungibleToken.Receiver}> + + access(all) + let cut: UFix64 + + //can be percentage + access(all) + let type: RoyaltyType + + init(wallet: Capability<&{FungibleToken.Receiver}>, cut: UFix64, type: RoyaltyType){ + self.wallet = wallet + self.cut = cut + self.type = type + } + } + + // This Metadata struct contains all the most important informations about the Flovatar + access(all) + struct Metadata{ + access(all) + let mint: UInt64 + + access(all) + let series: UInt32 + + access(all) + let svg: String + + access(all) + let combination: String + + access(all) + let creatorAddress: Address + + access(self) + let components:{ String: UInt64} + + access(all) + let rareCount: UInt8 + + access(all) + let epicCount: UInt8 + + access(all) + let legendaryCount: UInt8 + + init(mint: UInt64, series: UInt32, svg: String, combination: String, creatorAddress: Address, components:{ String: UInt64}, rareCount: UInt8, epicCount: UInt8, legendaryCount: UInt8){ + self.mint = mint + self.series = series + self.svg = svg + self.combination = combination + self.creatorAddress = creatorAddress + self.components = components + self.rareCount = rareCount + self.epicCount = epicCount + self.legendaryCount = legendaryCount + } + + access(all) + fun getComponents():{ String: UInt64}{ + return self.components + } + } - pub let CollectionStoragePath: StoragePath - pub let CollectionPublicPath: PublicPath - pub let AdminStoragePath: StoragePath + access(all) entitlement PrivateEnt + + // The public interface can show metadata and the content for the Flovatar. + // In addition to it, it provides methods to access the additional optional + // components (accessory, hat, eyeglasses, background) for everyone. + access(all) + resource interface Public{ + access(all) + let id: UInt64 + + access(contract) + let metadata: Metadata + + access(contract) + let royalties: Royalties + + // these three are added because I think they will be in the standard. At least Dieter thinks it will be needed + access(contract) + var name: String + + access(all) + let description: String + + access(all) + let schema: String? + + access(all) + fun getName(): String + + access(all) + fun getAccessory(): UInt64? + + access(all) + fun getHat(): UInt64? + + access(all) + fun getEyeglasses(): UInt64? + + access(all) + fun getBackground(): UInt64? + + access(all) + fun getSvg(): String + + access(all) + fun getMetadata(): Metadata + + access(all) + fun getRoyalties(): Royalties + + access(all) + fun getBio():{ String: String} + + access(all) + fun getRarityScore(): UFix64 + } + + //The private interface can update the Accessory, Hat, Eyeglasses and Background + //for the Flovatar and is accessible only to the owner of the NFT + access(all) + resource interface Private{ + access(Flovatar.PrivateEnt) + fun setName(name: String, vault: @{FungibleToken.Vault}): String + + access(Flovatar.PrivateEnt) + fun addStory(text: String, vault: @{FungibleToken.Vault}): String + + access(Flovatar.PrivateEnt) + fun unlock3DFile(vault: @{FungibleToken.Vault}) + + access(Flovatar.PrivateEnt) + fun unlockChat(vault: @{FungibleToken.Vault}) + + access(Flovatar.PrivateEnt) + fun setPosition(latitude: Fix64, longitude: Fix64, vault: @{FungibleToken.Vault}): String + + access(Flovatar.PrivateEnt) + fun setAccessory(component: @FlovatarComponent.NFT): @FlovatarComponent.NFT? + + access(Flovatar.PrivateEnt) + fun setHat(component: @FlovatarComponent.NFT): @FlovatarComponent.NFT? + + access(Flovatar.PrivateEnt) + fun setEyeglasses(component: @FlovatarComponent.NFT): @FlovatarComponent.NFT? + + access(Flovatar.PrivateEnt) + fun setBackground(component: @FlovatarComponent.NFT): @FlovatarComponent.NFT? + + access(Flovatar.PrivateEnt) + fun removeAccessory(): @FlovatarComponent.NFT? + + access(Flovatar.PrivateEnt) + fun removeHat(): @FlovatarComponent.NFT? + + access(Flovatar.PrivateEnt) + fun removeEyeglasses(): @FlovatarComponent.NFT? + + access(Flovatar.PrivateEnt) + fun removeBackground(): @FlovatarComponent.NFT? + } + + //The NFT resource that implements both Private and Public interfaces + access(all) + resource NFT: NonFungibleToken.NFT, Public, Private{ + access(all) + let id: UInt64 + + access(contract) + let metadata: Metadata + + access(contract) + let royalties: Royalties + + access(contract) + var accessory: @FlovatarComponent.NFT? + + access(contract) + var hat: @FlovatarComponent.NFT? + + access(contract) + var eyeglasses: @FlovatarComponent.NFT? + + access(contract) + var background: @FlovatarComponent.NFT? + + access(contract) + var name: String + + access(all) + let description: String + + access(all) + let schema: String? + + access(self) + let bio:{ String: String} + + init(metadata: Metadata, royalties: Royalties){ + Flovatar.totalSupply = Flovatar.totalSupply + UInt64(1) + self.id = Flovatar.totalSupply + self.metadata = metadata + self.royalties = royalties + self.accessory <- nil + self.hat <- nil + self.eyeglasses <- nil + self.background <- nil + self.schema = nil + self.name = "" + self.description = "" + self.bio ={} + } + + access(all) + fun getID(): UInt64{ + return self.id + } + + access(all) + fun getMetadata(): Metadata{ + return self.metadata + } + + access(all) + fun getRoyalties(): Royalties{ + return self.royalties + } + + access(all) + fun getBio():{ String: String}{ + return self.bio + } + + access(all) + fun getName(): String{ + return self.name + } + + // This will allow to change the Name of the Flovatar only once. + // It checks for the current name is empty, otherwise it will throw an error. + // $DUST vault must contain 100 tokens that will be burned in the process + access(Flovatar.PrivateEnt) + fun setName(name: String, vault: @{FungibleToken.Vault}): String{ + pre{ + // TODO: Make sure that the text of the name is sanitized + //and that bad words are not accepted? + name.length > 2: + "The name is too short" + name.length < 32: + "The name is too long" + self.name == "": + "The name has already been set" + vault.balance == 100.0: + "The amount of $DUST is not correct" + vault.isInstance(Type<@FlovatarDustToken.Vault>()): + "Vault not of the right Token Type" + } + + // Makes sure that the name is available and not taken already + if Flovatar.checkNameAvailable(name: name) == false{ + panic("This name has already been taken") + } + destroy vault + self.name = name + + // Adds the name to the array to remember it + Flovatar.addMintedName(name: name) + emit NameSet(id: self.id, name: name) + return self.name + } + + // This will allow to add a text Story to the Flovatar Bio. + // The String will be concatenated each time. + // There is a limit of 300 characters per story but there is no limit in the full concatenated story length + // $DUST vault must contain 50 tokens that will be burned in the process + access(Flovatar.PrivateEnt) + fun addStory(text: String, vault: @{FungibleToken.Vault}): String{ + pre{ + // TODO: Make sure that the text of the name is sanitized + //and that bad words are not accepted? + text.length > 0: + "The text is too short" + text.length <= 300: + "The text is too long" + vault.balance == 50.0: + "The amount of $DUST is not correct" + vault.isInstance(Type<@FlovatarDustToken.Vault>()): + "Vault not of the right Token Type" + } + destroy vault + let currentStory: String = self.bio["story"] ?? "" + let story: String = currentStory.concat("\n").concat(text) + self.bio.insert(key: "story", story) + emit StoryAdded(id: self.id, story: story) + return story + } + + // This will unlock the 3D files for a Flovatar. + // $DUST vault must contain 150 tokens that will be burned in the process + access(Flovatar.PrivateEnt) + fun unlock3DFile(vault: @{FungibleToken.Vault}){ + pre{ + self.bio["3d"] == nil: + "The 3D File has been already unlocked" + vault.balance == 150.0: + "The amount of $DUST is not correct" + vault.isInstance(Type<@FlovatarDustToken.Vault>()): + "Vault not of the right Token Type" + } + destroy vault + self.bio.insert(key: "3d", "true") + emit Unlocked3DFile(id: self.id) + } + + // This will enable the chat customization for a Flovatar. + // $DUST vault must contain 5000 tokens that will be burned in the process + access(Flovatar.PrivateEnt) + fun unlockChat(vault: @{FungibleToken.Vault}){ + pre{ + self.bio["chat"] == nil: + "The Chat has been already unlocked" + vault.balance == 5000.0: + "The amount of $DUST is not correct" + vault.isInstance(Type<@FlovatarDustToken.Vault>()): + "Vault not of the right Token Type" + } + destroy vault + self.bio.insert(key: "chat", "true") + emit UnlockedChat(id: self.id) + } + + // This will allow to set the GPS location of a Flovatar + // It can be run multiple times and each time it will override the previous state + // $DUST vault must contain 10 tokens that will be burned in the process + access(Flovatar.PrivateEnt) + fun setPosition(latitude: Fix64, longitude: Fix64, vault: @{FungibleToken.Vault}): String{ + pre{ + latitude >= -90.0: + "The latitude is out of range" + latitude <= 90.0: + "The latitude is out of range" + longitude >= -180.0: + "The longitude is out of range" + longitude <= 180.0: + "The longitude is out of range" + vault.balance == 10.0: + "The amount of $DUST is not correct" + vault.isInstance(Type<@FlovatarDustToken.Vault>()): + "Vault not of the right Token Type" + } + destroy vault + let position: String = latitude.toString().concat(",").concat(longitude.toString()) + self.bio.insert(key: "position", position) + emit PositionChanged(id: self.id, position: position) + return position + } + + access(all) + fun getAccessory(): UInt64?{ + return self.accessory?.templateId + } + + // This will allow to change the Accessory of the Flovatar any time. + // It checks for the right category and series before executing. + access(Flovatar.PrivateEnt) + fun setAccessory(component: @FlovatarComponent.NFT): @FlovatarComponent.NFT?{ + if(component.getCategory() != "accessory") { + panic("The component needs to be an accessory") + } + if(component.getSeries() != self.metadata.series) { + panic("The accessory belongs to a different series") + } + emit Updated(id: self.id) + let compNFT <- self.accessory <- component + return <-compNFT + } + + // This will allow to remove the Accessory of the Flovatar any time. + access(Flovatar.PrivateEnt) + fun removeAccessory(): @FlovatarComponent.NFT?{ + emit Updated(id: self.id) + let compNFT <- self.accessory <- nil + return <-compNFT + } + + access(all) + fun getHat(): UInt64?{ + return self.hat?.templateId + } + + // This will allow to change the Hat of the Flovatar any time. + // It checks for the right category and series before executing. + access(Flovatar.PrivateEnt) + fun setHat(component: @FlovatarComponent.NFT): @FlovatarComponent.NFT?{ + if(component.getCategory() != "hat") { + panic("The component needs to be a hat") + } + if(component.getSeries() != self.metadata.series) { + panic("The hat belongs to a different series") + } + emit Updated(id: self.id) + let compNFT <- self.hat <- component + return <-compNFT + } + + // This will allow to remove the Hat of the Flovatar any time. + access(Flovatar.PrivateEnt) + fun removeHat(): @FlovatarComponent.NFT?{ + emit Updated(id: self.id) + let compNFT <- self.hat <- nil + return <-compNFT + } + + access(all) + fun getEyeglasses(): UInt64?{ + return self.eyeglasses?.templateId + } + + // This will allow to change the Eyeglasses of the Flovatar any time. + // It checks for the right category and series before executing. + access(Flovatar.PrivateEnt) + fun setEyeglasses(component: @FlovatarComponent.NFT): @FlovatarComponent.NFT?{ + if(component.getCategory() != "eyeglasses") { + panic("The component needs to be a pair of eyeglasses") + } + if(component.getSeries() != self.metadata.series) { + panic("The eyeglasses belongs to a different series") + } + emit Updated(id: self.id) + let compNFT <- self.eyeglasses <- component + return <-compNFT + } + + // This will allow to remove the Eyeglasses of the Flovatar any time. + access(Flovatar.PrivateEnt) + fun removeEyeglasses(): @FlovatarComponent.NFT?{ + emit Updated(id: self.id) + let compNFT <- self.eyeglasses <- nil + return <-compNFT + } + + access(all) + fun getBackground(): UInt64?{ + return self.background?.templateId + } + + // This will allow to change the Background of the Flovatar any time. + // It checks for the right category and series before executing. + access(Flovatar.PrivateEnt) + fun setBackground(component: @FlovatarComponent.NFT): @FlovatarComponent.NFT?{ + if(component.getCategory() != "background") { + panic("The component needs to be a background") + } + if(component.getSeries() != self.metadata.series) { + panic("The background belongs to a different series") + } + emit Updated(id: self.id) + let compNFT <- self.background <- component + return <-compNFT + } + + // This will allow to remove the Background of the Flovatar any time. + access(Flovatar.PrivateEnt) + fun removeBackground(): @FlovatarComponent.NFT?{ + emit Updated(id: self.id) + let compNFT <- self.background <- nil + return <-compNFT + } + + // This function will return the full SVG of the Flovatar. It will take the + // optional components (Accessory, Hat, Eyeglasses and Background) from their + // original Template resources, while all the other unmutable components are + // taken from the Metadata directly. + access(all) + fun getSvg(): String{ + var svg: String = "") + return svg + } + + access(all) + fun getRarityScore(): UFix64{ + var rareCount: UInt8 = self.metadata.rareCount + var epicCount: UInt8 = self.metadata.epicCount + var legendaryCount: UInt8 = self.metadata.legendaryCount + var totalBoosters: UInt8 = legendaryCount + epicCount + rareCount + let totalCommon: UInt8 = totalBoosters > UInt8(6) ? 0 : UInt8(6) - totalBoosters + if totalBoosters > UInt8(6){ + if rareCount > UInt8(0){ + rareCount = rareCount - UInt8(1) + } else if epicCount > UInt8(0){ + epicCount = epicCount - UInt8(1) + } else if legendaryCount > UInt8(0){ + legendaryCount = legendaryCount - UInt8(1) + } + } + let score: UInt64 = UInt64(legendaryCount) * UInt64(125) + UInt64(epicCount) * UInt64(25) + UInt64(rareCount) * UInt64(5) + UInt64(totalCommon) + let min: UInt64 = 6 + let max: UInt64 = 6 * 125 + let scoreFix: UFix64 = UFix64(score - min) * UFix64(100.0) / UFix64(max - min) + return scoreFix + } + + access(all) + view fun getViews(): [Type]{ + return [ + Type(), + Type(), + Type(), + Type(), + Type(), + Type(), + Type(), + Type(), + Type() + ] + } + + access(all) + fun resolveView(_ view: Type): AnyStruct?{ + if view == Type(){ + return MetadataViews.ExternalURL("https://flovatar.com/flovatars/".concat(self.id.toString())) + } + if view == Type(){ + let royalties: [MetadataViews.Royalty] = [] + var count: Int = 0 + for royalty in self.royalties.royalty{ + royalties.append(MetadataViews.Royalty(receiver: royalty.wallet, cut: royalty.cut, description: "Flovatar Royalty ".concat(count.toString()))) + count = count + Int(1) + } + return MetadataViews.Royalties(royalties) + } + if view == Type(){ + return MetadataViews.Serial(self.id) + } + if view == Type(){ + let editionInfo = MetadataViews.Edition(name: "Flovatar Series 1", number: self.id, max: UInt64(9999)) + let editionList: [MetadataViews.Edition] = [editionInfo] + return MetadataViews.Editions(editionList) + } + if view == Type(){ + let mediaSquare = MetadataViews.Media(file: MetadataViews.HTTPFile(url: "https://images.flovatar.com/logo.svg"), mediaType: "image/svg+xml") + let mediaBanner = MetadataViews.Media(file: MetadataViews.HTTPFile(url: "https://images.flovatar.com/logo-horizontal.svg"), mediaType: "image/svg+xml") + return MetadataViews.NFTCollectionDisplay(name: "Flovatar", description: "Flovatar is pioneering a new way to unleash community creativity in Web3 by allowing users to be co-creators of their prized NFTs, instead of just being passive collectors.", externalURL: MetadataViews.ExternalURL("https://flovatar.com"), squareImage: mediaSquare, bannerImage: mediaBanner, socials:{ "discord": MetadataViews.ExternalURL("https://discord.gg/flovatar"), "twitter": MetadataViews.ExternalURL("https://twitter.com/flovatar"), "instagram": MetadataViews.ExternalURL("https://instagram.com/flovatar_nft"), "tiktok": MetadataViews.ExternalURL("https://www.tiktok.com/@flovatar")}) + } + if view == Type(){ + return MetadataViews.Display(name: self.name == "" ? "Flovatar #".concat(self.id.toString()) : self.name, description: self.description, thumbnail: MetadataViews.HTTPFile(url: "https://images.flovatar.com/flovatar/svg/".concat(self.id.toString()).concat(".svg"))) + } + if view == Type(){ + let traits: [MetadataViews.Trait] = [] + let components:{ String: UInt64} = self.metadata.getComponents() + for k in components.keys{ + if let template = FlovatarComponentTemplate.getComponentTemplate(id: components[k]!){ + let trait = MetadataViews.Trait(name: k, value: template.name, displayType: "String", rarity: MetadataViews.Rarity(score: nil, max: nil, description: template.rarity)) + traits.append(trait) + } + } + if let accessory = self.getAccessory(){ + if let template = FlovatarComponentTemplate.getComponentTemplate(id: accessory){ + let trait = MetadataViews.Trait(name: template.category, value: template.name, displayType: "String", rarity: MetadataViews.Rarity(score: nil, max: nil, description: template.rarity)) + traits.append(trait) + } + } + if let background = self.getBackground(){ + if let template = FlovatarComponentTemplate.getComponentTemplate(id: background){ + let trait = MetadataViews.Trait(name: template.category, value: template.name, displayType: "String", rarity: MetadataViews.Rarity(score: nil, max: nil, description: template.rarity)) + traits.append(trait) + } + } + if let eyeglasses = self.getEyeglasses(){ + if let template = FlovatarComponentTemplate.getComponentTemplate(id: eyeglasses){ + let trait = MetadataViews.Trait(name: template.category, value: template.name, displayType: "String", rarity: MetadataViews.Rarity(score: nil, max: nil, description: template.rarity)) + traits.append(trait) + } + } + if let hat = self.getHat(){ + if let template = FlovatarComponentTemplate.getComponentTemplate(id: hat){ + let trait = MetadataViews.Trait(name: template.category, value: template.name, displayType: "String", rarity: MetadataViews.Rarity(score: nil, max: nil, description: template.rarity)) + traits.append(trait) + } + } + return MetadataViews.Traits(traits) + } + if view == Type(){ + return MetadataViews.Rarity(score: self.getRarityScore(), max: 100.0, description: nil) + } + if view == Type(){ + return MetadataViews.NFTCollectionData(storagePath: Flovatar.CollectionStoragePath, publicPath: Flovatar.CollectionPublicPath, publicCollection: Type<&Flovatar.Collection>(), publicLinkedType: Type<&Flovatar.Collection>(), createEmptyCollectionFunction: fun (): @{NonFungibleToken.Collection}{ + return <-Flovatar.createEmptyCollection(nftType: Type<@Flovatar.Collection>()) + }) + } + if view == Type(){ + let contractLevel = Flovatar.resolveContractView( + resourceType: nil, + viewType: Type() + ) as! MetadataViews.EVMBridgedMetadata? + ?? panic("Could not resolve contract-level EVMBridgedMetadata") + + return MetadataViews.EVMBridgedMetadata( + name: contractLevel.name, + symbol: contractLevel.symbol, + uri: MetadataViews.URI( + baseURI: "https://flovatar.com/flovatars/json/", + value: self.id.toString() + ) + ) + } + return nil + } + + access(all) + fun createEmptyCollection(): @{NonFungibleToken.Collection}{ + return <-create Collection() + } + } + + // Standard NFT collectionPublic interface that can also borrowFlovatar as the correct type + access(all) + resource interface CollectionPublic{ + access(all) + fun deposit(token: @{NonFungibleToken.NFT}) + + access(all) + fun getIDs(): [UInt64] + + access(all) + view fun borrowNFT(_ id: UInt64): &{NonFungibleToken.NFT}? + + access(all) + fun borrowFlovatar(id: UInt64): &Flovatar.NFT?{ + // If the result isn't nil, the id of the returned reference + // should be the same as the argument to the function + post{ + result == nil || result?.id == id: + "Cannot borrow Flovatar reference: The ID of the returned reference is incorrect" + } + } + } + + // Main Collection to manage all the Flovatar NFT + access(all) + resource Collection: CollectionPublic, NonFungibleToken.Collection { + // dictionary of NFT conforming tokens + // NFT is a resource type with an `UInt64` ID field + access(all) + var ownedNFTs: @{UInt64:{ NonFungibleToken.NFT}} + + init(){ + self.ownedNFTs <-{} + } + + // withdraw removes an NFT from the collection and moves it to the caller + access(NonFungibleToken.Withdraw) + fun withdraw(withdrawID: UInt64): @{NonFungibleToken.NFT}{ + let token <- self.ownedNFTs.remove(key: withdrawID) ?? panic("missing NFT") + emit Withdraw(id: token.id, from: self.owner?.address) + return <-token + } + + // deposit takes a NFT and adds it to the collections dictionary + // and adds the ID to the id array + access(all) + fun deposit(token: @{NonFungibleToken.NFT}){ + let token <- token as! @Flovatar.NFT + let id: UInt64 = token.id + + // add the new token to the dictionary which removes the old one + let oldToken <- self.ownedNFTs[id] <- token + emit Deposit(id: id, to: self.owner?.address) + destroy oldToken + } + + // getIDs returns an array of the IDs that are in the collection + access(all) + view fun getIDs(): [UInt64]{ + return self.ownedNFTs.keys + } + + // borrowNFT gets a reference to an NFT in the collection + // so that the caller can read its metadata and call its methods + access(all) + view fun borrowNFT(_ id: UInt64): &{NonFungibleToken.NFT}?{ + return (&self.ownedNFTs[id] as &{NonFungibleToken.NFT}?) + } + + // borrowFlovatar returns a borrowed reference to a Flovatar + // so that the caller can read data and call methods from it. + access(all) + fun borrowFlovatar(id: UInt64): &Flovatar.NFT?{ + if self.ownedNFTs[id] != nil { + let ref = (&self.ownedNFTs[id] as &{NonFungibleToken.NFT}?) + let flovatarNFT = ref as! &Flovatar.NFT + return flovatarNFT + } else { + return nil + } + } + + /* + // borrowFlovatarPrivate returns a borrowed reference to a Flovatar using the Private interface + // so that the caller can read data and call methods from it, like setting the optional components. + access(all) + fun borrowFlovatarPrivate(id: UInt64): &{Flovatar.Private}?{ + if self.ownedNFTs[id] != nil{ + let ref = (&self.ownedNFTs[id] as &{NonFungibleToken.NFT}?)! + return ref as! &Flovatar.NFT + } else{ + return nil + } + } + */ - // These will be used in the Marketplace to pay out - // royalties to the creator and to the marketplace - access(account) var royaltyCut: UFix64 - access(account) var marketplaceCut: UFix64 - // Here we keep track of all the Flovatar unique combinations and names - // that people will generate to make sure that there are no duplicates - pub var totalSupply: UInt64 - access(contract) let mintedCombinations: {String: Bool} - access(contract) let mintedNames: {String: Bool} + access(all) + view fun borrowViewResolver(id: UInt64): &{ViewResolver.Resolver}?{ + if let nft = &self.ownedNFTs[id] as &{NonFungibleToken.NFT}? { + return nft as &{ViewResolver.Resolver} + } + return nil + } + + + /// getSupportedNFTTypes returns a list of NFT types that this receiver accepts + access(all) + view fun getSupportedNFTTypes(): {Type: Bool} { + let supportedTypes: {Type: Bool} = {} + supportedTypes[Type<@Flovatar.NFT>()] = true + return supportedTypes + } - pub event ContractInitialized() - pub event Withdraw(id: UInt64, from: Address?) - pub event Deposit(id: UInt64, to: Address?) - pub event Created(id: UInt64, metadata: Metadata) - pub event Updated(id: UInt64) - pub event NameSet(id: UInt64, name: String) - pub event PositionChanged(id: UInt64, position: String) - pub event StoryAdded(id: UInt64, story: String) - pub event Unlocked3DFile(id: UInt64) - pub event UnlockedChat(id: UInt64) + /// Returns whether or not the given type is accepted by the collection + /// A collection that can accept any type should just return true by default + access(all) + view fun isSupportedNFTType(type: Type): Bool { + return type == Type<@Flovatar.NFT>() + } + + access(all) + fun createEmptyCollection(): @{NonFungibleToken.Collection}{ + return <-Flovatar.createEmptyCollection(nftType: Type<@Flovatar.NFT>()) + } - pub struct Royalties{ - pub let royalty: [Royalty] - init(royalty: [Royalty]) { - self.royalty=royalty - } - } + access(all) view fun getLength(): Int { + return self.ownedNFTs.length + } + } + + // public function that anyone can call to create a new empty collection + access(all) + fun createEmptyCollection(nftType: Type): @{NonFungibleToken.Collection}{ + return <-create Collection() + } - pub enum RoyaltyType: UInt8{ - pub case fixed - pub case percentage - } - pub struct Royalty{ - pub let wallet:Capability<&{FungibleToken.Receiver}> - pub let cut: UFix64 - //can be percentage - pub let type: RoyaltyType - init(wallet:Capability<&{FungibleToken.Receiver}>, cut: UFix64, type: RoyaltyType ){ - self.wallet=wallet - self.cut=cut - self.type=type - } - } + access(all) + view fun getContractViews(resourceType: Type?): [Type] { + return [ + Type(), + Type(), + Type() + ] + } - // This Metadata struct contains all the most important informations about the Flovatar - pub struct Metadata { - pub let mint: UInt64 - pub let series: UInt32 - pub let svg: String - pub let combination: String - pub let creatorAddress: Address - access(self) let components: {String: UInt64} - pub let rareCount: UInt8 - pub let epicCount: UInt8 - pub let legendaryCount: UInt8 + access(all) fun resolveContractView(resourceType: Type?, viewType: Type): AnyStruct? { + switch viewType { + case Type(): + let collectionData = MetadataViews.NFTCollectionData( + storagePath: self.CollectionStoragePath, + publicPath: self.CollectionPublicPath, + publicCollection: Type<&Flovatar.Collection>(), + publicLinkedType: Type<&Flovatar.Collection>(), + createEmptyCollectionFunction: (fun(): @{NonFungibleToken.Collection} { + return <-Flovatar.createEmptyCollection(nftType: Type<@Flovatar.NFT>()) + }) + ) + return collectionData + case Type(): + let media = MetadataViews.Media( + file: MetadataViews.HTTPFile( + url: "https://images.flovatar.com/logo.svg" + ), + mediaType: "image/svg+xml" + ) + let mediaBanner = MetadataViews.Media( + file: MetadataViews.HTTPFile( + url: "https://images.flovatar.com/logo-horizontal.svg" + ), + mediaType: "image/svg+xml" + ) + return MetadataViews.NFTCollectionDisplay( + name: "Flovatar Collection", + description: "Flovatar is pioneering a new way to unleash community creativity in Web3 by allowing users to be co-creators of their prized NFTs, instead of just being passive collectors.", + externalURL: MetadataViews.ExternalURL("https://flovatar.com"), + squareImage: media, + bannerImage: mediaBanner, + socials: { + "twitter": MetadataViews.ExternalURL("https://x.com/flovatar"), + "discord": MetadataViews.ExternalURL("https://discord.gg/flovatar"), + "instagram": MetadataViews.ExternalURL("https://instagram.com/flovatar_nft"), + "tiktok": MetadataViews.ExternalURL("https://www.tiktok.com/@flovatar") + } + ) + case Type(): + // Implementing this view gives the project control over how the bridged NFT is represented as an ERC721 + // when bridged to EVM on Flow via the public infrastructure bridge. + // Compose the contract-level URI. In this case, the contract metadata is located on some HTTP host, + // but it could be IPFS, S3, a data URL containing the JSON directly, etc. + return MetadataViews.EVMBridgedMetadata( + name: "Flovatar", + symbol: "FLVT", + uri: MetadataViews.URI( + baseURI: nil, // setting baseURI as nil sets the given value as the uri field value + value: "https://flovatar.com" + ) + ) + } + return nil + } - init( - mint: UInt64, - series: UInt32, - svg: String, - combination: String, - creatorAddress: Address, - components: {String: UInt64}, - rareCount: UInt8, - epicCount: UInt8, - legendaryCount: UInt8 - ) { - self.mint = mint - self.series = series - self.svg = svg - self.combination = combination - self.creatorAddress = creatorAddress - self.components = components - self.rareCount = rareCount - self.epicCount = epicCount - self.legendaryCount = legendaryCount - } - pub fun getComponents(): {String: UInt64} { - return self.components - } - } + + // This struct is used to send a data representation of the Flovatars + // when retrieved using the contract helper methods outside the collection. + access(all) + struct FlovatarData{ + access(all) + let id: UInt64 + + access(all) + let name: String + + access(all) + let metadata: Flovatar.Metadata + + access(all) + let accessoryId: UInt64? + + access(all) + let hatId: UInt64? + + access(all) + let eyeglassesId: UInt64? + + access(all) + let backgroundId: UInt64? + + access(all) + let bio:{ String: String} + + init(id: UInt64, name: String, metadata: Flovatar.Metadata, accessoryId: UInt64?, hatId: UInt64?, eyeglassesId: UInt64?, backgroundId: UInt64?, bio:{ String: String}){ + self.id = id + self.name = name + self.metadata = metadata + self.accessoryId = accessoryId + self.hatId = hatId + self.eyeglassesId = eyeglassesId + self.backgroundId = backgroundId + self.bio = bio + } + } + + // This function will look for a specific Flovatar on a user account and return a FlovatarData if found + access(all) + fun getFlovatar(address: Address, flovatarId: UInt64): FlovatarData?{ + let account = getAccount(address) + if let flovatarCollection = account.capabilities.borrow<&Flovatar.Collection>(Flovatar.CollectionPublicPath){ + if !flovatarCollection.isInstance(Type<@Flovatar.Collection>()){ + panic("The Collection is not from the correct Type") + } + if let flovatar = flovatarCollection.borrowFlovatar(id: flovatarId){ + return FlovatarData(id: flovatarId, name: (flovatar!).getName(), metadata: (flovatar!).getMetadata(), accessoryId: (flovatar!).getAccessory(), hatId: (flovatar!).getHat(), eyeglassesId: (flovatar!).getEyeglasses(), backgroundId: (flovatar!).getBackground(), bio: (flovatar!).getBio()) + } + } + return nil + } + + // This function will look for a specific Flovatar on a user account and return the Score + access(all) + fun getFlovatarRarityScore(address: Address, flovatarId: UInt64): UFix64?{ + let account = getAccount(address) + if let flovatarCollection = account.capabilities.borrow<&Flovatar.Collection>(Flovatar.CollectionPublicPath){ + if !flovatarCollection.isInstance(Type<@Flovatar.Collection>()){ + panic("The Collection is not from the correct Type") + } + if let flovatar = flovatarCollection.borrowFlovatar(id: flovatarId){ + return flovatar.getRarityScore() + } + } + + return nil + } + + // This function will return all Flovatars on a user account and return an array of FlovatarData + access(all) + fun getFlovatars(address: Address): [FlovatarData]{ + var flovatarData: [FlovatarData] = [] + let account = getAccount(address) + if let flovatarCollection = account.capabilities.borrow<&Flovatar.Collection>(Flovatar.CollectionPublicPath){ + if !flovatarCollection.isInstance(Type<@Flovatar.Collection>()){ + panic("The Collection is not from the correct Type") + } + for id in flovatarCollection.getIDs(){ + var flovatar = flovatarCollection.borrowFlovatar(id: id) + let flovatarMetadata = (flovatar!).getMetadata() + let newMetadata = Metadata(mint: flovatarMetadata.mint, series: flovatarMetadata.series, svg: "", combination: flovatarMetadata.combination, creatorAddress: flovatarMetadata.creatorAddress, components: flovatarMetadata.getComponents(), rareCount: flovatarMetadata.rareCount, epicCount: flovatarMetadata.epicCount, legendaryCount: flovatarMetadata.legendaryCount) + flovatarData.append(FlovatarData(id: id, name: (flovatar!).getName(), metadata: newMetadata, accessoryId: (flovatar!).getAccessory(), hatId: (flovatar!).getHat(), eyeglassesId: (flovatar!).getEyeglasses(), backgroundId: (flovatar!).getBackground(), bio: (flovatar!).getBio())) + } + } + + return flovatarData + } + + // This returns all the previously minted combinations, so that duplicates won't be allowed + access(all) + fun getMintedCombinations(): [String]{ + return Flovatar.mintedCombinations.keys + } + + // This returns all the previously minted names, so that duplicates won't be allowed + access(all) + fun getMintedNames(): [String]{ + return Flovatar.mintedNames.keys + } + + // This function will add a minted combination to the array + access(account) + fun addMintedCombination(combination: String){ + Flovatar.mintedCombinations.insert(key: combination, true) + } + + // This function will add a new name to the array + access(account) + fun addMintedName(name: String){ + Flovatar.mintedNames.insert(key: name, true) + } + + // This helper function will generate a string from a list of components, + // to be used as a sort of barcode to keep the inventory of the minted + // Flovatars and to avoid duplicates + access(all) + fun getCombinationString(body: UInt64, hair: UInt64, facialHair: UInt64?, eyes: UInt64, nose: UInt64, mouth: UInt64, clothing: UInt64): String{ + let facialHairString = facialHair != nil ? (facialHair!).toString() : "x" + return "B".concat(body.toString()).concat("H").concat(hair.toString()).concat("F").concat(facialHairString).concat("E").concat(eyes.toString()).concat("N").concat(nose.toString()).concat("M").concat(mouth.toString()).concat("C").concat(clothing.toString()) + } + + // This function will get a list of component IDs and will check if the + // generated string is unique or if someone already used it before. + access(all) + fun checkCombinationAvailable(body: UInt64, hair: UInt64, facialHair: UInt64?, eyes: UInt64, nose: UInt64, mouth: UInt64, clothing: UInt64): Bool{ + let combinationString = Flovatar.getCombinationString(body: body, hair: hair, facialHair: facialHair, eyes: eyes, nose: nose, mouth: mouth, clothing: clothing) + return !Flovatar.mintedCombinations.containsKey(combinationString) + } + + // This will check if a specific Name has already been taken + // and assigned to some Flovatar + access(all) + fun checkNameAvailable(name: String): Bool{ + return name.length > 2 && name.length < 32 && !Flovatar.mintedNames.containsKey(name) + } + + // This is a public function that anyone can call to generate a new Flovatar + // A list of components resources needs to be passed to executed. + // It will check first for uniqueness of the combination + name and will then + // generate the Flovatar and burn all the passed components. + // The Spark NFT will entitle to use any common basic component (body, hair, etc.) + // In order to use special rare components a boost of the same rarity will be needed + // for each component used + access(all) + fun createFlovatar(spark: @FlovatarComponent.NFT, body: UInt64, hair: UInt64, facialHair: UInt64?, eyes: UInt64, nose: UInt64, mouth: UInt64, clothing: UInt64, accessory: @FlovatarComponent.NFT?, hat: @FlovatarComponent.NFT?, eyeglasses: @FlovatarComponent.NFT?, background: @FlovatarComponent.NFT?, rareBoost: @[FlovatarComponent.NFT], epicBoost: @[FlovatarComponent.NFT], legendaryBoost: @[FlovatarComponent.NFT], address: Address): @Flovatar.NFT{ + if(spark.getCategory() != "spark"){ + panic("The spark component belongs to the wrong category") + } + let bodyTemplate: FlovatarComponentTemplate.ComponentTemplateData = FlovatarComponentTemplate.getComponentTemplate(id: body)! + let hairTemplate: FlovatarComponentTemplate.ComponentTemplateData = FlovatarComponentTemplate.getComponentTemplate(id: hair)! + let eyesTemplate: FlovatarComponentTemplate.ComponentTemplateData = FlovatarComponentTemplate.getComponentTemplate(id: eyes)! + let noseTemplate: FlovatarComponentTemplate.ComponentTemplateData = FlovatarComponentTemplate.getComponentTemplate(id: nose)! + let mouthTemplate: FlovatarComponentTemplate.ComponentTemplateData = FlovatarComponentTemplate.getComponentTemplate(id: mouth)! + let clothingTemplate: FlovatarComponentTemplate.ComponentTemplateData = FlovatarComponentTemplate.getComponentTemplate(id: clothing)! + + // Make sure that all components belong to the correct category + if bodyTemplate.category != "body"{ + panic("The body component belongs to the wrong category") + } + if hairTemplate.category != "hair"{ + panic("The hair component belongs to the wrong category") + } + if eyesTemplate.category != "eyes"{ + panic("The eyes component belongs to the wrong category") + } + if noseTemplate.category != "nose"{ + panic("The nose component belongs to the wrong category") + } + if mouthTemplate.category != "mouth"{ + panic("The mouth component belongs to the wrong category") + } + if clothingTemplate.category != "clothing"{ + panic("The clothing component belongs to the wrong category") + } + let sparkSeries = spark.getSeries() + // Make sure that all the components belong to the same series like the spark + if bodyTemplate.series != sparkSeries{ + panic("The body doesn't belong to the correct series") + } + if hairTemplate.series != sparkSeries{ + panic("The hair doesn't belong to the correct series") + } + if eyesTemplate.series != sparkSeries{ + panic("The eyes doesn't belong to the correct series") + } + if noseTemplate.series != sparkSeries{ + panic("The nose doesn't belong to the correct series") + } + if mouthTemplate.series != sparkSeries{ + panic("The mouth doesn't belong to the correct series") + } + if clothingTemplate.series != sparkSeries{ + panic("The clothing doesn't belong to the correct series") + } + + // Make more checks for the additional components to check for the right category and uniqueness + var facialHairTemplate: FlovatarComponentTemplate.ComponentTemplateData? = nil + if facialHair != nil{ + facialHairTemplate = FlovatarComponentTemplate.getComponentTemplate(id: facialHair!) + if facialHairTemplate?.category != "facialHair"{ + panic("The facial hair component belongs to the wrong category") + } + if facialHairTemplate?.series != sparkSeries{ + panic("The facial hair doesn't belong to the correct series") + } + } + if accessory != nil{ + if !accessory?.checkCategorySeries(category: "accessory", series: sparkSeries)!{ + panic("The accessory component belongs to the wrong category or the wrong series") + } + } + if hat != nil{ + if !hat?.checkCategorySeries(category: "hat", series: sparkSeries)!{ + panic("The hat component belongs to the wrong category or the wrong series") + } + } + if eyeglasses != nil{ + if !eyeglasses?.checkCategorySeries(category: "eyeglasses", series: sparkSeries)!{ + panic("The eyeglasses component belongs to the wrong category or the wrong series") + } + } + if background != nil{ + if !background?.checkCategorySeries(category: "background", series: sparkSeries)!{ + panic("The background component belongs to the wrong category or the wrong series") + } + } + + //Make sure that all the Rarity Boosts are from the correct category + var i: Int = 0 + while i < rareBoost.length{ + if !rareBoost[i].isBooster(rarity: "rare"){ + panic("The rare boost belongs to the wrong category") + } + if rareBoost[i].getSeries() != sparkSeries{ + panic("The rare boost doesn't belong to the correct series") + } + i = i + 1 + } + i = 0 + while i < epicBoost.length{ + if !epicBoost[i].isBooster(rarity: "epic"){ + panic("The epic boost belongs to the wrong category") + } + if epicBoost[i].getSeries() != sparkSeries{ + panic("The epic boost doesn't belong to the correct series") + } + i = i + 1 + } + i = 0 + while i < legendaryBoost.length{ + if !legendaryBoost[i].isBooster(rarity: "legendary"){ + panic("The legendary boost belongs to the wrong category") + } + if legendaryBoost[i].getSeries() != sparkSeries{ + panic("The legendary boost doesn't belong to the correct series") + } + i = i + 1 + } + + //Keep count of the necessary rarity boost for the selected templates + var rareCount: UInt8 = 0 + var epicCount: UInt8 = 0 + var legendaryCount: UInt8 = 0 + if bodyTemplate.rarity == "rare"{ + rareCount = rareCount + 1 + } + if hairTemplate.rarity == "rare"{ + rareCount = rareCount + 1 + } + if eyesTemplate.rarity == "rare"{ + rareCount = rareCount + 1 + } + if noseTemplate.rarity == "rare"{ + rareCount = rareCount + 1 + } + if mouthTemplate.rarity == "rare"{ + rareCount = rareCount + 1 + } + if clothingTemplate.rarity == "rare"{ + rareCount = rareCount + 1 + } + if bodyTemplate.rarity == "epic"{ + epicCount = epicCount + 1 + } + if hairTemplate.rarity == "epic"{ + epicCount = epicCount + 1 + } + if eyesTemplate.rarity == "epic"{ + epicCount = epicCount + 1 + } + if noseTemplate.rarity == "epic"{ + epicCount = epicCount + 1 + } + if mouthTemplate.rarity == "epic"{ + epicCount = epicCount + 1 + } + if clothingTemplate.rarity == "epic"{ + epicCount = epicCount + 1 + } + if bodyTemplate.rarity == "legendary"{ + legendaryCount = legendaryCount + 1 + } + if hairTemplate.rarity == "legendary"{ + legendaryCount = legendaryCount + 1 + } + if eyesTemplate.rarity == "legendary"{ + legendaryCount = legendaryCount + 1 + } + if noseTemplate.rarity == "legendary"{ + legendaryCount = legendaryCount + 1 + } + if mouthTemplate.rarity == "legendary"{ + legendaryCount = legendaryCount + 1 + } + if clothingTemplate.rarity == "legendary"{ + legendaryCount = legendaryCount + 1 + } + if facialHairTemplate != nil{ + if facialHairTemplate?.rarity == "rare"{ + rareCount = rareCount + 1 + } + if facialHairTemplate?.rarity == "epic"{ + epicCount = epicCount + 1 + } + if facialHairTemplate?.rarity == "legendary"{ + legendaryCount = legendaryCount + 1 + } + } + if Int(rareCount) != rareBoost.length{ + panic("The rare boosts are not equal the ones needed") + } + if Int(epicCount) != epicBoost.length{ + panic("The epic boosts are not equal the ones needed") + } + if Int(legendaryCount) != legendaryBoost.length{ + panic("The epic boosts are not equal the ones needed") + } + + // Generates the combination string to check for uniqueness. + // This is like a barcode that defines exactly which components were used + // to create the Flovatar + let combinationString = Flovatar.getCombinationString(body: body, hair: hair, facialHair: facialHair, eyes: eyes, nose: nose, mouth: mouth, clothing: clothing) + + // Makes sure that the combination is available and not taken already + if Flovatar.mintedCombinations.containsKey(combinationString) == true{ + panic("This combination has already been taken") + } + let facialHairSvg: String = facialHairTemplate != nil ? facialHairTemplate?.svg! : "" + let svg = (bodyTemplate.svg!).concat(clothingTemplate.svg!).concat(hairTemplate.svg!).concat(eyesTemplate.svg!).concat(noseTemplate.svg!).concat(mouthTemplate.svg!).concat(facialHairSvg) + + // TODO fix this with optional if possible. If I define it as UInt64? + // instead of UInt64 it's throwing an error even if it's defined in Metadata struct + let facialHairId: UInt64 = facialHair != nil ? facialHair! : 0 + + // Creates the metadata for the new Flovatar + let metadata = Metadata(mint: Flovatar.totalSupply + UInt64(1), series: spark.getSeries(), svg: svg, combination: combinationString, creatorAddress: address, components:{ "body": body, "hair": hair, "facialHair": facialHairId, "eyes": eyes, "nose": nose, "mouth": mouth, "clothing": clothing}, rareCount: rareCount, epicCount: epicCount, legendaryCount: legendaryCount) + let royalties: [Royalty] = [] + let creatorAccount = getAccount(address) + royalties.append(Royalty(wallet: creatorAccount.capabilities.get<&FlowToken.Vault>(/public/flowTokenReceiver), cut: Flovatar.getRoyaltyCut(), type: RoyaltyType.percentage)) + royalties.append(Royalty(wallet: self.account.capabilities.get<&FlowToken.Vault>(/public/flowTokenReceiver), cut: Flovatar.getMarketplaceCut(), type: RoyaltyType.percentage)) + + // Mint the new Flovatar NFT by passing the metadata to it + var newNFT <- create NFT(metadata: metadata, royalties: Royalties(royalty: royalties)) + + // Adds the combination to the arrays to remember it + Flovatar.addMintedCombination(combination: combinationString) + + // Checks for any additional optional component (accessory, hat, + // eyeglasses, background) and assigns it to the Flovatar if present. + if accessory != nil{ + let temp <- newNFT.setAccessory(component: <-accessory!) + destroy temp + } else{ + destroy accessory + } + if hat != nil{ + let temp <- newNFT.setHat(component: <-hat!) + destroy temp + } else{ + destroy hat + } + if eyeglasses != nil{ + let temp <- newNFT.setEyeglasses(component: <-eyeglasses!) + destroy temp + } else{ + destroy eyeglasses + } + if background != nil{ + let temp <- newNFT.setBackground(component: <-background!) + destroy temp + } else{ + destroy background + } + + // Emits the Created event to notify about its existence + emit Created(id: newNFT.id, metadata: metadata) + + // Destroy all the spark and the rarity boost since they are not needed anymore. + destroy spark + while rareBoost.length > 0{ + let boost <- rareBoost.remove(at: 0) + destroy boost + } + destroy rareBoost + while epicBoost.length > 0{ + let boost <- epicBoost.remove(at: 0) + destroy boost + } + destroy epicBoost + while legendaryBoost.length > 0{ + let boost <- legendaryBoost.remove(at: 0) + destroy boost + } + destroy legendaryBoost + return <-newNFT + } + + // These functions will return the current Royalty cuts for + // both the Creator and the Marketplace. + access(all) + fun getRoyaltyCut(): UFix64{ + return self.royaltyCut + } + + access(all) + fun getMarketplaceCut(): UFix64{ + return self.marketplaceCut + } + + // Only Admins will be able to call the set functions to + // manage Royalties and Marketplace cuts. + access(account) + fun setRoyaltyCut(value: UFix64){ + self.royaltyCut = value + } + + access(account) + fun setMarketplaceCut(value: UFix64){ + self.marketplaceCut = value + } + + // This is the main Admin resource that will allow the owner + // to generate new Templates, Components and Packs + access(all) + resource Admin{ + - // The public interface can show metadata and the content for the Flovatar. - // In addition to it, it provides methods to access the additional optional - // components (accessory, hat, eyeglasses, background) for everyone. - pub resource interface Public { - pub let id: UInt64 - access(contract) let metadata: Metadata - access(contract) let royalties: Royalties - // these three are added because I think they will be in the standard. At least Dieter thinks it will be needed - access(contract) var name: String - pub let description: String - pub let schema: String? - pub fun getName(): String - pub fun getAccessory(): UInt64? - pub fun getHat(): UInt64? - pub fun getEyeglasses(): UInt64? - pub fun getBackground(): UInt64? - - pub fun getSvg(): String - pub fun getMetadata(): Metadata - pub fun getRoyalties(): Royalties - pub fun getBio(): {String: String} - pub fun getRarityScore(): UFix64 - } - - //The private interface can update the Accessory, Hat, Eyeglasses and Background - //for the Flovatar and is accessible only to the owner of the NFT - pub resource interface Private { - pub fun setName(name: String, vault: @FungibleToken.Vault): String - pub fun addStory(text: String, vault: @FungibleToken.Vault): String - pub fun unlock3DFile(vault: @FungibleToken.Vault) - pub fun unlockChat(vault: @FungibleToken.Vault) - pub fun setPosition(latitude: Fix64, longitude: Fix64, vault: @FungibleToken.Vault): String - pub fun setAccessory(component: @FlovatarComponent.NFT): @FlovatarComponent.NFT? - pub fun setHat(component: @FlovatarComponent.NFT): @FlovatarComponent.NFT? - pub fun setEyeglasses(component: @FlovatarComponent.NFT): @FlovatarComponent.NFT? - pub fun setBackground(component: @FlovatarComponent.NFT): @FlovatarComponent.NFT? - pub fun removeAccessory(): @FlovatarComponent.NFT? - pub fun removeHat(): @FlovatarComponent.NFT? - pub fun removeEyeglasses(): @FlovatarComponent.NFT? - pub fun removeBackground(): @FlovatarComponent.NFT? - } - - //The NFT resource that implements both Private and Public interfaces - pub resource NFT: NonFungibleToken.INFT, Public, Private, MetadataViews.Resolver { - pub let id: UInt64 - access(contract) let metadata: Metadata - access(contract) let royalties: Royalties - access(contract) var accessory: @FlovatarComponent.NFT? - access(contract) var hat: @FlovatarComponent.NFT? - access(contract) var eyeglasses: @FlovatarComponent.NFT? - access(contract) var background: @FlovatarComponent.NFT? - - access(contract) var name: String - pub let description: String - pub let schema: String? - access(self) let bio: {String: String} - - init(metadata: Metadata, - royalties: Royalties) { - Flovatar.totalSupply = Flovatar.totalSupply + UInt64(1) - - self.id = Flovatar.totalSupply - self.metadata = metadata - self.royalties = royalties - self.accessory <- nil - self.hat <- nil - self.eyeglasses <- nil - self.background <- nil - - self.schema = nil - self.name = "" - self.description = "" - self.bio = {} - } - - destroy() { - destroy self.accessory - destroy self.hat - destroy self.eyeglasses - destroy self.background - } - - pub fun getID(): UInt64 { - return self.id - } - - pub fun getMetadata(): Metadata { - return self.metadata - } - - pub fun getRoyalties(): Royalties { - return self.royalties - } - - pub fun getBio(): {String: String} { - return self.bio - } - - pub fun getName(): String { - return self.name - } - - // This will allow to change the Name of the Flovatar only once. - // It checks for the current name is empty, otherwise it will throw an error. - // $DUST vault must contain 100 tokens that will be burned in the process - pub fun setName(name: String, vault: @FungibleToken.Vault): String { - pre { - // TODO: Make sure that the text of the name is sanitized - //and that bad words are not accepted? - name.length > 2 : "The name is too short" - name.length < 32 : "The name is too long" - self.name == "" : "The name has already been set" - vault.balance == 100.0 : "The amount of $DUST is not correct" - vault.isInstance(Type<@FlovatarDustToken.Vault>()) : "Vault not of the right Token Type" - } - - // Makes sure that the name is available and not taken already - if(Flovatar.checkNameAvailable(name: name) == false){ - panic("This name has already been taken") - } - - destroy vault - self.name = name - - - // Adds the name to the array to remember it - Flovatar.addMintedName(name: name) - emit NameSet(id: self.id, name: name) - - return self.name - } - - // This will allow to add a text Story to the Flovatar Bio. - // The String will be concatenated each time. - // There is a limit of 300 characters per story but there is no limit in the full concatenated story length - // $DUST vault must contain 50 tokens that will be burned in the process - pub fun addStory(text: String, vault: @FungibleToken.Vault): String { - pre { - // TODO: Make sure that the text of the name is sanitized - //and that bad words are not accepted? - text.length > 0 : "The text is too short" - text.length <= 300 : "The text is too long" - vault.balance == 50.0 : "The amount of $DUST is not correct" - vault.isInstance(Type<@FlovatarDustToken.Vault>()) : "Vault not of the right Token Type" - } - - destroy vault - let currentStory: String = self.bio["story"] ?? "" - let story: String = currentStory.concat("\n").concat(text) - self.bio.insert(key: "story", story) - - emit StoryAdded(id: self.id, story: story) - - return story - } - - // This will unlock the 3D files for a Flovatar. - // $DUST vault must contain 150 tokens that will be burned in the process - pub fun unlock3DFile(vault: @FungibleToken.Vault) { - pre { - self.bio["3d"] == nil : "The 3D File has been already unlocked" - vault.balance == 150.0 : "The amount of $DUST is not correct" - vault.isInstance(Type<@FlovatarDustToken.Vault>()) : "Vault not of the right Token Type" - } - - destroy vault - self.bio.insert(key: "3d", "true") - - emit Unlocked3DFile(id: self.id) - - } - - // This will enable the chat customization for a Flovatar. - // $DUST vault must contain 5000 tokens that will be burned in the process - pub fun unlockChat(vault: @FungibleToken.Vault) { - pre { - self.bio["chat"] == nil : "The Chat has been already unlocked" - vault.balance == 5000.0 : "The amount of $DUST is not correct" - vault.isInstance(Type<@FlovatarDustToken.Vault>()) : "Vault not of the right Token Type" - } - - destroy vault - self.bio.insert(key: "chat", "true") - - emit UnlockedChat(id: self.id) - - } - - // This will allow to set the GPS location of a Flovatar - // It can be run multiple times and each time it will override the previous state - // $DUST vault must contain 10 tokens that will be burned in the process - pub fun setPosition(latitude: Fix64, longitude: Fix64, vault: @FungibleToken.Vault): String { - pre { - latitude >= -90.0 : "The latitude is out of range" - latitude <= 90.0 : "The latitude is out of range" - longitude >= -180.0 : "The longitude is out of range" - longitude <= 180.0 : "The longitude is out of range" - vault.balance == 10.0 : "The amount of $DUST is not correct" - vault.isInstance(Type<@FlovatarDustToken.Vault>()) : "Vault not of the right Token Type" - } - - destroy vault - let position: String = latitude.toString().concat(",").concat(longitude.toString()) - self.bio.insert(key: "position", position) - - emit PositionChanged(id: self.id, position: position) - - return position - } - - pub fun getAccessory(): UInt64? { - return self.accessory?.templateId - } - - // This will allow to change the Accessory of the Flovatar any time. - // It checks for the right category and series before executing. - pub fun setAccessory(component: @FlovatarComponent.NFT): @FlovatarComponent.NFT? { - pre { - component.getCategory() == "accessory" : "The component needs to be an accessory" - component.getSeries() == self.metadata.series : "The accessory belongs to a different series" - } - - emit Updated(id: self.id) - - let compNFT <- self.accessory <- component - return <- compNFT - } - - // This will allow to remove the Accessory of the Flovatar any time. - pub fun removeAccessory(): @FlovatarComponent.NFT? { - emit Updated(id: self.id) - let compNFT <- self.accessory <- nil - return <-compNFT - } - - pub fun getHat(): UInt64? { - return self.hat?.templateId - } - - // This will allow to change the Hat of the Flovatar any time. - // It checks for the right category and series before executing. - pub fun setHat(component: @FlovatarComponent.NFT): @FlovatarComponent.NFT? { - pre { - component.getCategory() == "hat" : "The component needs to be a hat" - component.getSeries() == self.metadata.series : "The hat belongs to a different series" - } - - emit Updated(id: self.id) - - let compNFT <- self.hat <- component - return <-compNFT - } - - // This will allow to remove the Hat of the Flovatar any time. - pub fun removeHat(): @FlovatarComponent.NFT? { - emit Updated(id: self.id) - let compNFT <- self.hat <- nil - return <-compNFT - } - - pub fun getEyeglasses(): UInt64? { - return self.eyeglasses?.templateId - } - - // This will allow to change the Eyeglasses of the Flovatar any time. - // It checks for the right category and series before executing. - pub fun setEyeglasses(component: @FlovatarComponent.NFT): @FlovatarComponent.NFT? { - pre { - component.getCategory() == "eyeglasses" : "The component needs to be a pair of eyeglasses" - component.getSeries() == self.metadata.series : "The eyeglasses belongs to a different series" - } - - emit Updated(id: self.id) - - let compNFT <- self.eyeglasses <-component - return <-compNFT - } - - // This will allow to remove the Eyeglasses of the Flovatar any time. - pub fun removeEyeglasses(): @FlovatarComponent.NFT? { - emit Updated(id: self.id) - let compNFT <- self.eyeglasses <- nil - return <-compNFT - } - - pub fun getBackground(): UInt64? { - return self.background?.templateId - } - - // This will allow to change the Background of the Flovatar any time. - // It checks for the right category and series before executing. - pub fun setBackground(component: @FlovatarComponent.NFT): @FlovatarComponent.NFT? { - pre { - component.getCategory() == "background" : "The component needs to be a background" - component.getSeries() == self.metadata.series : "The accessory belongs to a different series" - } - - emit Updated(id: self.id) - - let compNFT <- self.background <- component - return <-compNFT - } - - // This will allow to remove the Background of the Flovatar any time. - pub fun removeBackground(): @FlovatarComponent.NFT? { - emit Updated(id: self.id) - let compNFT <- self.background <- nil - return <-compNFT - } - - // This function will return the full SVG of the Flovatar. It will take the - // optional components (Accessory, Hat, Eyeglasses and Background) from their - // original Template resources, while all the other unmutable components are - // taken from the Metadata directly. - pub fun getSvg(): String { - var svg: String = "") - - return svg - - } - - pub fun getRarityScore(): UFix64{ - var rareCount: UInt8 = self.metadata.rareCount - var epicCount: UInt8 = self.metadata.epicCount - var legendaryCount: UInt8 = self.metadata.legendaryCount - - var totalBoosters: UInt8 = legendaryCount + epicCount + rareCount; - let totalCommon: UInt8 = (totalBoosters > UInt8(6)) ? 0 : (UInt8(6) - totalBoosters); - - if(totalBoosters > UInt8(6)){ - if(rareCount > UInt8(0)) { - rareCount = rareCount - UInt8(1); - } else if(epicCount > UInt8(0)) { - epicCount = epicCount - UInt8(1); - } else if(legendaryCount > UInt8(0)) { - legendaryCount = legendaryCount - UInt8(1); - } - } - - let score: UInt64 = (UInt64(legendaryCount) * UInt64(125)) + (UInt64(epicCount) * UInt64(25)) + (UInt64(rareCount) * UInt64(5)) + UInt64(totalCommon); - let min: UInt64 = 6; - let max: UInt64 = 6 * 125; - - let scoreFix: UFix64 = UFix64(score - min) * UFix64(100.0) / UFix64(max - min) ; - return scoreFix - } - - pub fun getViews() : [Type] { - var views : [Type]=[] - views.append(Type()) - views.append(Type()) - views.append(Type()) - views.append(Type()) - views.append(Type()) - views.append(Type()) - views.append(Type()) - views.append(Type()) - return views - } - pub fun resolveView(_ type: Type): AnyStruct? { - - if type == Type() { - return MetadataViews.ExternalURL("https://flovatar.com/flovatars/".concat(self.id.toString())) - } - - if type == Type() { - let royalties : [MetadataViews.Royalty] = [] - var count: Int = 0 - for royalty in self.royalties.royalty { - royalties.append(MetadataViews.Royalty(recepient: royalty.wallet, cut: royalty.cut, description: "Flovatar Royalty ".concat(count.toString()))) - count = count + Int(1) - } - return MetadataViews.Royalties(cutInfos: royalties) - } - - if type == Type() { - return MetadataViews.Serial(self.id) - } - - if type == Type() { - let editionInfo = MetadataViews.Edition(name: "Flovatar Series 1", number: self.id, max: UInt64(9999)) - let editionList: [MetadataViews.Edition] = [editionInfo] - return MetadataViews.Editions( - editionList - ) - } - - if type == Type() { - let mediaSquare = MetadataViews.Media( - file: MetadataViews.HTTPFile( - url: "https://images.flovatar.com/logo.svg" - ), - mediaType: "image/svg+xml" - ) - let mediaBanner = MetadataViews.Media( - file: MetadataViews.HTTPFile( - url: "https://images.flovatar.com/logo-horizontal.svg" - ), - mediaType: "image/svg+xml" - ) - return MetadataViews.NFTCollectionDisplay( - name: "Flovatar", - description: "Flovatar is pioneering a new way to unleash community creativity in Web3 by allowing users to be co-creators of their prized NFTs, instead of just being passive collectors.", - externalURL: MetadataViews.ExternalURL("https://flovatar.com"), - squareImage: mediaSquare, - bannerImage: mediaBanner, - socials: { - "discord": MetadataViews.ExternalURL("https://discord.gg/flovatar"), - "twitter": MetadataViews.ExternalURL("https://twitter.com/flovatar"), - "instagram": MetadataViews.ExternalURL("https://instagram.com/flovatar_nft"), - "tiktok": MetadataViews.ExternalURL("https://www.tiktok.com/@flovatar") - } - ) - } - - if type == Type() { - return MetadataViews.Display( - name: self.name == "" ? "Flovatar #".concat(self.id.toString()) : self.name, - description: self.description, - thumbnail: MetadataViews.HTTPFile( - url: "https://images.flovatar.com/flovatar/svg/".concat(self.id.toString()).concat(".svg") - ) - ) - } - - if type == Type() { - let traits: [MetadataViews.Trait] = [] - let components: {String: UInt64} = self.metadata.getComponents() - - for k in components.keys { - if let template = FlovatarComponentTemplate.getComponentTemplate(id: components[k]!) { - let trait = MetadataViews.Trait(name: k, value: template.name, displayType:"String", rarity: MetadataViews.Rarity(score:nil, max:nil, description: template.rarity)) - traits.append(trait) - } - } - if let accessory = self.getAccessory() { - if let template = FlovatarComponentTemplate.getComponentTemplate(id: accessory) { - let trait = MetadataViews.Trait(name: template.category, value: template.name, displayType:"String", rarity: MetadataViews.Rarity(score:nil, max:nil, description: template.rarity)) - traits.append(trait) - } - } - if let background = self.getBackground() { - if let template = FlovatarComponentTemplate.getComponentTemplate(id: background) { - let trait = MetadataViews.Trait(name: template.category, value: template.name, displayType:"String", rarity: MetadataViews.Rarity(score:nil, max:nil, description: template.rarity)) - traits.append(trait) - } - } - if let eyeglasses = self.getEyeglasses() { - if let template = FlovatarComponentTemplate.getComponentTemplate(id: eyeglasses) { - let trait = MetadataViews.Trait(name: template.category, value: template.name, displayType:"String", rarity: MetadataViews.Rarity(score:nil, max:nil, description: template.rarity)) - traits.append(trait) - } - } - if let hat = self.getHat() { - if let template = FlovatarComponentTemplate.getComponentTemplate(id: hat) { - let trait = MetadataViews.Trait(name: template.category, value: template.name, displayType:"String", rarity: MetadataViews.Rarity(score:nil, max:nil, description: template.rarity)) - traits.append(trait) - } - } - - return MetadataViews.Traits(traits) - } - - if type == Type() { - return MetadataViews.Rarity(score: self.getRarityScore(), max: 100.0, description: nil) - } - - if type == Type() { - return MetadataViews.NFTCollectionData( - storagePath: Flovatar.CollectionStoragePath, - publicPath: Flovatar.CollectionPublicPath, - providerPath: /private/FlovatarCollection, - publicCollection: Type<&Flovatar.Collection{NonFungibleToken.CollectionPublic, NonFungibleToken.Receiver, MetadataViews.ResolverCollection, Flovatar.CollectionPublic}>(), - publicLinkedType: Type<&Flovatar.Collection{NonFungibleToken.CollectionPublic, NonFungibleToken.Receiver, MetadataViews.ResolverCollection, Flovatar.CollectionPublic}>(), - providerLinkedType: Type<&Flovatar.Collection{NonFungibleToken.Provider, NonFungibleToken.CollectionPublic, NonFungibleToken.Receiver, MetadataViews.ResolverCollection, Flovatar.CollectionPublic}>(), - createEmptyCollectionFunction: fun(): @NonFungibleToken.Collection {return <- Flovatar.createEmptyCollection()} - ) - } - - return nil - } - } - - - // Standard NFT collectionPublic interface that can also borrowFlovatar as the correct type - pub resource interface CollectionPublic { - pub fun deposit(token: @NonFungibleToken.NFT) - pub fun getIDs(): [UInt64] - pub fun borrowNFT(id: UInt64): &NonFungibleToken.NFT - pub fun borrowFlovatar(id: UInt64): &Flovatar.NFT{Flovatar.Public, MetadataViews.Resolver}? { - // If the result isn't nil, the id of the returned reference - // should be the same as the argument to the function - post { - (result == nil) || (result?.id == id): - "Cannot borrow Flovatar reference: The ID of the returned reference is incorrect" - } - } - } - - // Main Collection to manage all the Flovatar NFT - pub resource Collection: CollectionPublic, NonFungibleToken.Provider, NonFungibleToken.Receiver, NonFungibleToken.CollectionPublic, MetadataViews.ResolverCollection { - // dictionary of NFT conforming tokens - // NFT is a resource type with an `UInt64` ID field - pub var ownedNFTs: @{UInt64: NonFungibleToken.NFT} - - init () { - self.ownedNFTs <- {} - } - - // withdraw removes an NFT from the collection and moves it to the caller - pub fun withdraw(withdrawID: UInt64): @NonFungibleToken.NFT { - let token <- self.ownedNFTs.remove(key: withdrawID) ?? panic("missing NFT") - - emit Withdraw(id: token.id, from: self.owner?.address) - - return <- token - } - - // deposit takes a NFT and adds it to the collections dictionary - // and adds the ID to the id array - pub fun deposit(token: @NonFungibleToken.NFT) { - let token <- token as! @Flovatar.NFT - - let id: UInt64 = token.id - - // add the new token to the dictionary which removes the old one - let oldToken <- self.ownedNFTs[id] <- token - - emit Deposit(id: id, to: self.owner?.address) - - destroy oldToken - } - - // getIDs returns an array of the IDs that are in the collection - pub fun getIDs(): [UInt64] { - return self.ownedNFTs.keys - } - - // borrowNFT gets a reference to an NFT in the collection - // so that the caller can read its metadata and call its methods - pub fun borrowNFT(id: UInt64): &NonFungibleToken.NFT { - return (&self.ownedNFTs[id] as &NonFungibleToken.NFT?)! - } - - // borrowFlovatar returns a borrowed reference to a Flovatar - // so that the caller can read data and call methods from it. - pub fun borrowFlovatar(id: UInt64): &Flovatar.NFT{Flovatar.Public, MetadataViews.Resolver}? { - if self.ownedNFTs[id] != nil { - let ref = (&self.ownedNFTs[id] as auth &NonFungibleToken.NFT?)! - let flovatarNFT = ref as! &Flovatar.NFT - return flovatarNFT as &Flovatar.NFT{Flovatar.Public, MetadataViews.Resolver} - } else { - return nil - } - } - - // borrowFlovatarPrivate returns a borrowed reference to a Flovatar using the Private interface - // so that the caller can read data and call methods from it, like setting the optional components. - pub fun borrowFlovatarPrivate(id: UInt64): &{Flovatar.Private}? { - if self.ownedNFTs[id] != nil { - let ref = (&self.ownedNFTs[id] as auth &NonFungibleToken.NFT?)! - return ref as! &Flovatar.NFT - } else { - return nil - } - } - - destroy() { - destroy self.ownedNFTs - } - - pub fun borrowViewResolver(id: UInt64): &AnyResource{MetadataViews.Resolver} { - pre { - self.ownedNFTs[id] != nil : "NFT does not exist" - } - let nft = (&self.ownedNFTs[id] as auth &NonFungibleToken.NFT?)! - let flovatarNFT = nft as! &Flovatar.NFT - return flovatarNFT as &AnyResource{MetadataViews.Resolver} - } - } - - // public function that anyone can call to create a new empty collection - pub fun createEmptyCollection(): @NonFungibleToken.Collection { - return <- create Collection() - } - - // This struct is used to send a data representation of the Flovatars - // when retrieved using the contract helper methods outside the collection. - pub struct FlovatarData { - pub let id: UInt64 - pub let name: String - pub let metadata: Flovatar.Metadata - pub let accessoryId: UInt64? - pub let hatId: UInt64? - pub let eyeglassesId: UInt64? - pub let backgroundId: UInt64? - pub let bio: {String: String} - init( - id: UInt64, - name: String, - metadata: Flovatar.Metadata, - accessoryId: UInt64?, - hatId: UInt64?, - eyeglassesId: UInt64?, - backgroundId: UInt64?, - bio: {String: String} - ) { - self.id = id - self.name = name - self.metadata = metadata - self.accessoryId = accessoryId - self.hatId = hatId - self.eyeglassesId = eyeglassesId - self.backgroundId = backgroundId - self.bio = bio - } - } - - - // This function will look for a specific Flovatar on a user account and return a FlovatarData if found - pub fun getFlovatar(address: Address, flovatarId: UInt64) : FlovatarData? { - - let account = getAccount(address) - if let flovatarCollection = account.getCapability(self.CollectionPublicPath).borrow<&{Flovatar.CollectionPublic}>() { - if(!flovatarCollection.isInstance(Type<@Flovatar.Collection>())) { - panic("The Collection is not from the correct Type") - } - if let flovatar = flovatarCollection.borrowFlovatar(id: flovatarId) { - return FlovatarData( - id: flovatarId, - name: flovatar!.getName(), - metadata: flovatar!.getMetadata(), - accessoryId: flovatar!.getAccessory(), - hatId: flovatar!.getHat(), - eyeglassesId: flovatar!.getEyeglasses(), - backgroundId: flovatar!.getBackground(), - bio: flovatar!.getBio() - ) - } - } - return nil - } - // This function will look for a specific Flovatar on a user account and return the Score - pub fun getFlovatarRarityScore(address: Address, flovatarId: UInt64) : UFix64? { - - let account = getAccount(address) - - if let flovatarCollection = account.getCapability(self.CollectionPublicPath).borrow<&{Flovatar.CollectionPublic}>() { - if(!flovatarCollection.isInstance(Type<@Flovatar.Collection>())) { - panic("The Collection is not from the correct Type") - } - if let flovatar = flovatarCollection.borrowFlovatar(id: flovatarId) { - return flovatar.getRarityScore() - } - } - return nil - } - - // This function will return all Flovatars on a user account and return an array of FlovatarData - pub fun getFlovatars(address: Address) : [FlovatarData] { - - var flovatarData: [FlovatarData] = [] - let account = getAccount(address) - - if let flovatarCollection = account.getCapability(self.CollectionPublicPath).borrow<&{Flovatar.CollectionPublic}>() { - if(!flovatarCollection.isInstance(Type<@Flovatar.Collection>())) { - panic("The Collection is not from the correct Type") - } - for id in flovatarCollection.getIDs() { - var flovatar = flovatarCollection.borrowFlovatar(id: id) - let flovatarMetadata = flovatar!.getMetadata() - let newMetadata = Metadata( - mint: flovatarMetadata.mint, - series: flovatarMetadata.series, - svg: "", - combination: flovatarMetadata.combination, - creatorAddress: flovatarMetadata.creatorAddress, - components: flovatarMetadata.getComponents(), - rareCount: flovatarMetadata.rareCount, - epicCount: flovatarMetadata.epicCount, - legendaryCount: flovatarMetadata.legendaryCount - ) - flovatarData.append(FlovatarData( - id: id, - name: flovatar!.getName(), - metadata: newMetadata, - accessoryId: flovatar!.getAccessory(), - hatId: flovatar!.getHat(), - eyeglassesId: flovatar!.getEyeglasses(), - backgroundId: flovatar!.getBackground(), - bio: flovatar!.getBio() - )) - } - } - return flovatarData - } - - - // This returns all the previously minted combinations, so that duplicates won't be allowed - pub fun getMintedCombinations() : [String] { - return Flovatar.mintedCombinations.keys - } - // This returns all the previously minted names, so that duplicates won't be allowed - pub fun getMintedNames() : [String] { - return Flovatar.mintedNames.keys - } - - // This function will add a minted combination to the array - access(account) fun addMintedCombination(combination: String) { - Flovatar.mintedCombinations.insert(key: combination, true) - } - // This function will add a new name to the array - access(account) fun addMintedName(name: String) { - Flovatar.mintedNames.insert(key: name, true) - } - - // This helper function will generate a string from a list of components, - // to be used as a sort of barcode to keep the inventory of the minted - // Flovatars and to avoid duplicates - pub fun getCombinationString( - body: UInt64, - hair: UInt64, - facialHair: UInt64?, - eyes: UInt64, - nose: UInt64, - mouth: UInt64, - clothing: UInt64 - ) : String { - let facialHairString = (facialHair != nil) ? facialHair!.toString() : "x" - return "B".concat(body.toString()).concat("H").concat(hair.toString()).concat("F").concat(facialHairString).concat("E").concat(eyes.toString()).concat("N").concat(nose.toString()).concat("M").concat(mouth.toString()).concat("C").concat(clothing.toString()) - } - - // This function will get a list of component IDs and will check if the - // generated string is unique or if someone already used it before. - pub fun checkCombinationAvailable( - body: UInt64, - hair: UInt64, - facialHair: UInt64?, - eyes: UInt64, - nose: UInt64, - mouth: UInt64, - clothing: UInt64 - ) : Bool { - let combinationString = Flovatar.getCombinationString( - body: body, - hair: hair, - facialHair: facialHair, - eyes: eyes, - nose: nose, - mouth: mouth, - clothing: clothing - ) - return ! Flovatar.mintedCombinations.containsKey(combinationString) - } - - // This will check if a specific Name has already been taken - // and assigned to some Flovatar - pub fun checkNameAvailable(name: String) : Bool { - return name.length > 2 && name.length < 32 && ! Flovatar.mintedNames.containsKey(name) - } - - - // This is a public function that anyone can call to generate a new Flovatar - // A list of components resources needs to be passed to executed. - // It will check first for uniqueness of the combination + name and will then - // generate the Flovatar and burn all the passed components. - // The Spark NFT will entitle to use any common basic component (body, hair, etc.) - // In order to use special rare components a boost of the same rarity will be needed - // for each component used - pub fun createFlovatar( - spark: @FlovatarComponent.NFT, - body: UInt64, - hair: UInt64, - facialHair: UInt64?, - eyes: UInt64, - nose: UInt64, - mouth: UInt64, - clothing: UInt64, - accessory: @FlovatarComponent.NFT?, - hat: @FlovatarComponent.NFT?, - eyeglasses: @FlovatarComponent.NFT?, - background: @FlovatarComponent.NFT?, - rareBoost: @[FlovatarComponent.NFT], - epicBoost: @[FlovatarComponent.NFT], - legendaryBoost: @[FlovatarComponent.NFT], - address: Address - ) : @Flovatar.NFT { - - pre { - // Make sure that the spark component belongs to the correct category - spark.getCategory() == "spark" : "The spark component belongs to the wrong category" - } - - let bodyTemplate: FlovatarComponentTemplate.ComponentTemplateData = FlovatarComponentTemplate.getComponentTemplate(id: body)! - let hairTemplate: FlovatarComponentTemplate.ComponentTemplateData = FlovatarComponentTemplate.getComponentTemplate(id: hair)! - let eyesTemplate: FlovatarComponentTemplate.ComponentTemplateData = FlovatarComponentTemplate.getComponentTemplate(id: eyes)! - let noseTemplate: FlovatarComponentTemplate.ComponentTemplateData = FlovatarComponentTemplate.getComponentTemplate(id: nose)! - let mouthTemplate: FlovatarComponentTemplate.ComponentTemplateData = FlovatarComponentTemplate.getComponentTemplate(id: mouth)! - let clothingTemplate: FlovatarComponentTemplate.ComponentTemplateData = FlovatarComponentTemplate.getComponentTemplate(id: clothing)! - - - // Make sure that all components belong to the correct category - if(bodyTemplate.category != "body") { panic("The body component belongs to the wrong category") } - if(hairTemplate.category != "hair") { panic("The hair component belongs to the wrong category") } - if(eyesTemplate.category != "eyes") { panic("The eyes component belongs to the wrong category") } - if(noseTemplate.category != "nose") { panic("The nose component belongs to the wrong category") } - if(mouthTemplate.category != "mouth") { panic("The mouth component belongs to the wrong category") } - if(clothingTemplate.category != "clothing") { panic("The clothing component belongs to the wrong category") } - - let sparkSeries = spark.getSeries(); - // Make sure that all the components belong to the same series like the spark - if(bodyTemplate.series != sparkSeries) { panic("The body doesn't belong to the correct series") } - if(hairTemplate.series != sparkSeries) { panic("The hair doesn't belong to the correct series") } - if(eyesTemplate.series != sparkSeries) { panic("The eyes doesn't belong to the correct series") } - if(noseTemplate.series != sparkSeries) { panic("The nose doesn't belong to the correct series") } - if(mouthTemplate.series != sparkSeries) { panic("The mouth doesn't belong to the correct series") } - if(clothingTemplate.series != sparkSeries) { panic("The clothing doesn't belong to the correct series") } - - // Make more checks for the additional components to check for the right category and uniqueness - var facialHairTemplate: FlovatarComponentTemplate.ComponentTemplateData? = nil - if(facialHair != nil){ - facialHairTemplate = FlovatarComponentTemplate.getComponentTemplate(id: facialHair!) - if(facialHairTemplate?.category != "facialHair"){ - panic("The facial hair component belongs to the wrong category") - } - if(facialHairTemplate?.series != sparkSeries){ - panic("The facial hair doesn't belong to the correct series") - } - } - - - if(accessory != nil){ - if(!(accessory?.checkCategorySeries(category: "accessory", series: sparkSeries)!)){ - panic("The accessory component belongs to the wrong category or the wrong series") - } - } - - if(hat != nil){ - if(!(hat?.checkCategorySeries(category: "hat", series: sparkSeries)!)){ - panic("The hat component belongs to the wrong category or the wrong series") - } - } - - if(eyeglasses != nil){ - if(!(eyeglasses?.checkCategorySeries(category: "eyeglasses", series: sparkSeries)!)){ - panic("The eyeglasses component belongs to the wrong category or the wrong series") - } - } - - if(background != nil){ - if(!(background?.checkCategorySeries(category: "background", series: sparkSeries)!)){ - panic("The background component belongs to the wrong category or the wrong series") - } - } - - - //Make sure that all the Rarity Boosts are from the correct category - var i: Int = 0 - while( i < rareBoost.length) { - if(!rareBoost[i].isBooster(rarity: "rare")) { - panic("The rare boost belongs to the wrong category") - } - if(rareBoost[i].getSeries() != sparkSeries) { - panic("The rare boost doesn't belong to the correct series") - } - i = i + 1 - } - i = 0 - while( i < epicBoost.length) { - if(!epicBoost[i].isBooster(rarity: "epic")) { - panic("The epic boost belongs to the wrong category") - } - if(epicBoost[i].getSeries() != sparkSeries) { - panic("The epic boost doesn't belong to the correct series") - } - i = i + 1 - } - i = 0 - while( i < legendaryBoost.length) { - if(!legendaryBoost[i].isBooster(rarity: "legendary")) { - panic("The legendary boost belongs to the wrong category") - } - if(legendaryBoost[i].getSeries() != sparkSeries) { - panic("The legendary boost doesn't belong to the correct series") - } - i = i + 1 - } - - //Keep count of the necessary rarity boost for the selected templates - var rareCount: UInt8 = 0 - var epicCount: UInt8 = 0 - var legendaryCount: UInt8 = 0 - - if(bodyTemplate.rarity == "rare"){ rareCount = rareCount + 1 } - if(hairTemplate.rarity == "rare"){ rareCount = rareCount + 1 } - if(eyesTemplate.rarity == "rare"){ rareCount = rareCount + 1 } - if(noseTemplate.rarity == "rare"){ rareCount = rareCount + 1 } - if(mouthTemplate.rarity == "rare"){ rareCount = rareCount + 1 } - if(clothingTemplate.rarity == "rare"){ rareCount = rareCount + 1 } - - if(bodyTemplate.rarity == "epic"){ epicCount = epicCount + 1 } - if(hairTemplate.rarity == "epic"){ epicCount = epicCount + 1 } - if(eyesTemplate.rarity == "epic"){ epicCount = epicCount + 1 } - if(noseTemplate.rarity == "epic"){ epicCount = epicCount + 1 } - if(mouthTemplate.rarity == "epic"){ epicCount = epicCount + 1 } - if(clothingTemplate.rarity == "epic"){ epicCount = epicCount + 1 } - - if(bodyTemplate.rarity == "legendary"){ legendaryCount = legendaryCount + 1 } - if(hairTemplate.rarity == "legendary"){ legendaryCount = legendaryCount + 1 } - if(eyesTemplate.rarity == "legendary"){ legendaryCount = legendaryCount + 1 } - if(noseTemplate.rarity == "legendary"){ legendaryCount = legendaryCount + 1 } - if(mouthTemplate.rarity == "legendary"){ legendaryCount = legendaryCount + 1 } - if(clothingTemplate.rarity == "legendary"){ legendaryCount = legendaryCount + 1 } - - - if(facialHairTemplate != nil){ - if(facialHairTemplate?.rarity == "rare"){ rareCount = rareCount + 1} - if(facialHairTemplate?.rarity == "epic"){ epicCount = epicCount + 1} - if(facialHairTemplate?.rarity == "legendary"){ legendaryCount = legendaryCount + 1} - } - - if(Int(rareCount) != rareBoost.length){ - panic("The rare boosts are not equal the ones needed") - } - if(Int(epicCount) != epicBoost.length){ - panic("The epic boosts are not equal the ones needed") - } - if(Int(legendaryCount) != legendaryBoost.length){ - panic("The epic boosts are not equal the ones needed") - } - - - - - // Generates the combination string to check for uniqueness. - // This is like a barcode that defines exactly which components were used - // to create the Flovatar - let combinationString = Flovatar.getCombinationString( - body: body, - hair: hair, - facialHair: facialHair, - eyes: eyes, - nose: nose, - mouth: mouth, - clothing: clothing) - - // Makes sure that the combination is available and not taken already - if(Flovatar.mintedCombinations.containsKey(combinationString) == true) { - panic("This combination has already been taken") - } - - let facialHairSvg:String = facialHairTemplate != nil ? facialHairTemplate?.svg! : "" - let svg = (bodyTemplate.svg!).concat(clothingTemplate.svg!).concat(hairTemplate.svg!).concat(eyesTemplate.svg!).concat(noseTemplate.svg!).concat(mouthTemplate.svg!).concat(facialHairSvg) - - // TODO fix this with optional if possible. If I define it as UInt64? - // instead of UInt64 it's throwing an error even if it's defined in Metadata struct - let facialHairId: UInt64 = facialHair != nil ? facialHair! : 0 - - // Creates the metadata for the new Flovatar - let metadata = Metadata( - mint: Flovatar.totalSupply + UInt64(1), - series: spark.getSeries(), - svg: svg, - combination: combinationString, - creatorAddress: address, - components: { - "body": body, - "hair": hair, - "facialHair": facialHairId, - "eyes": eyes, - "nose": nose, - "mouth": mouth, - "clothing": clothing - }, - rareCount: rareCount, - epicCount: epicCount, - legendaryCount: legendaryCount - ) - - let royalties: [Royalty] = [] - - let creatorAccount = getAccount(address) - royalties.append(Royalty( - wallet: creatorAccount.getCapability<&FlowToken.Vault{FungibleToken.Receiver}>(/public/flowTokenReceiver), - cut: Flovatar.getRoyaltyCut(), - type: RoyaltyType.percentage - )) - - royalties.append(Royalty( - wallet: self.account.getCapability<&FlowToken.Vault{FungibleToken.Receiver}>(/public/flowTokenReceiver), - cut: Flovatar.getMarketplaceCut(), - type: RoyaltyType.percentage - )) - - // Mint the new Flovatar NFT by passing the metadata to it - var newNFT <- create NFT(metadata: metadata, royalties: Royalties(royalty: royalties)) - - // Adds the combination to the arrays to remember it - Flovatar.addMintedCombination(combination: combinationString) - - - // Checks for any additional optional component (accessory, hat, - // eyeglasses, background) and assigns it to the Flovatar if present. - if(accessory != nil){ - let temp <- newNFT.setAccessory(component: <-accessory!) - destroy temp - } else { - destroy accessory - } - if(hat != nil){ - let temp <- newNFT.setHat(component: <-hat!) - destroy temp - } else { - destroy hat - } - if(eyeglasses != nil){ - let temp <- newNFT.setEyeglasses(component: <-eyeglasses!) - destroy temp - } else { - destroy eyeglasses - } - if(background != nil){ - let temp <- newNFT.setBackground(component: <-background!) - destroy temp - } else { - destroy background - } - - // Emits the Created event to notify about its existence - emit Created(id: newNFT.id, metadata: metadata) - - // Destroy all the spark and the rarity boost since they are not needed anymore. - - destroy spark - - while(rareBoost.length > 0){ - let boost <- rareBoost.remove(at: 0) - destroy boost - } - destroy rareBoost - - while(epicBoost.length > 0){ - let boost <- epicBoost.remove(at: 0) - destroy boost - } - destroy epicBoost - - while(legendaryBoost.length > 0){ - let boost <- legendaryBoost.remove(at: 0) - destroy boost - } - destroy legendaryBoost - - return <- newNFT - } - - - - // These functions will return the current Royalty cuts for - // both the Creator and the Marketplace. - pub fun getRoyaltyCut(): UFix64{ - return self.royaltyCut - } - pub fun getMarketplaceCut(): UFix64{ - return self.marketplaceCut - } - // Only Admins will be able to call the set functions to - // manage Royalties and Marketplace cuts. - access(account) fun setRoyaltyCut(value: UFix64){ - self.royaltyCut = value - } - access(account) fun setMarketplaceCut(value: UFix64){ - self.marketplaceCut = value - } - - - - - // This is the main Admin resource that will allow the owner - // to generate new Templates, Components and Packs - pub resource Admin { - - //This will create a new FlovatarComponentTemplate that - // contains all the SVG and basic informations to represent - // a specific part of the Flovatar (body, hair, eyes, mouth, etc.) - // More info in the FlovatarComponentTemplate.cdc file - pub fun createComponentTemplate( - name: String, - category: String, - color: String, - description: String, - svg: String, - series: UInt32, - maxMintableComponents: UInt64, - rarity: String - ) : @FlovatarComponentTemplate.ComponentTemplate { - return <- FlovatarComponentTemplate.createComponentTemplate( - name: name, - category: category, - color: color, - description: description, - svg: svg, - series: series, - maxMintableComponents: maxMintableComponents, - rarity: rarity - ) - } - - // This will mint a new Component based from a selected Template - pub fun createComponent(templateId: UInt64) : @FlovatarComponent.NFT { - return <- FlovatarComponent.createComponent(templateId: templateId) - } - // This will mint Components in batch and return a Collection instead of the single NFT - pub fun batchCreateComponents(templateId: UInt64, quantity: UInt64) : @FlovatarComponent.Collection { - return <- FlovatarComponent.batchCreateComponents(templateId: templateId, quantity: quantity) - } - - // This function will generate a new Pack containing a set of components. - // A random string is passed to manage permissions for the - // purchase of it (more info on FlovatarPack.cdc). - // Finally the sale price is set as well. - pub fun createPack( - components: @[FlovatarComponent.NFT], - randomString: String, - price: UFix64, - sparkCount: UInt32, - series: UInt32, - name: String - ) : @FlovatarPack.Pack { - - return <- FlovatarPack.createPack( - components: <-components, - randomString: randomString, - price: price, - sparkCount: sparkCount, - series: series, - name: name - ) - } - - // With this function you can generate a new Admin resource - // and pass it to another user if needed - pub fun createNewAdmin(): @Admin { - return <-create Admin() - } - - // Helper functions to update the Royalty cut - pub fun setRoyaltyCut(value: UFix64) { - Flovatar.setRoyaltyCut(value: value) - } - - // Helper functions to update the Marketplace cut - pub fun setMarketplaceCut(value: UFix64) { - Flovatar.setMarketplaceCut(value: value) - } - } - - - - - - init() { - self.CollectionPublicPath = /public/FlovatarCollection - self.CollectionStoragePath = /storage/FlovatarCollection - self.AdminStoragePath = /storage/FlovatarAdmin - - // Initialize the total supply - self.totalSupply = UInt64(0) - self.mintedCombinations = {} - self.mintedNames = {} - - // Set the default Royalty and Marketplace cuts - self.royaltyCut = 0.01 - self.marketplaceCut = 0.05 - - self.account.save<@NonFungibleToken.Collection>(<- Flovatar.createEmptyCollection(), to: Flovatar.CollectionStoragePath) - self.account.link<&{Flovatar.CollectionPublic}>(Flovatar.CollectionPublicPath, target: Flovatar.CollectionStoragePath) - - // Put the Admin resource in storage - self.account.save<@Admin>(<- create Admin(), to: self.AdminStoragePath) - - emit ContractInitialized() + //This will create a new FlovatarComponentTemplate that + // contains all the SVG and basic informations to represent + // a specific part of the Flovatar (body, hair, eyes, mouth, etc.) + // More info in the FlovatarComponentTemplate.cdc file + access(all) + fun createComponentTemplate(name: String, category: String, color: String, description: String, svg: String, series: UInt32, maxMintableComponents: UInt64, rarity: String): @FlovatarComponentTemplate.ComponentTemplate{ + return <-FlovatarComponentTemplate.createComponentTemplate(name: name, category: category, color: color, description: description, svg: svg, series: series, maxMintableComponents: maxMintableComponents, rarity: rarity) + } + + // This will mint a new Component based from a selected Template + access(all) + fun createComponent(templateId: UInt64): @FlovatarComponent.NFT{ + return <-FlovatarComponent.createComponent(templateId: templateId) + } + + // This will mint Components in batch and return a Collection instead of the single NFT + access(all) + fun batchCreateComponents(templateId: UInt64, quantity: UInt64): @FlovatarComponent.Collection{ + return <-FlovatarComponent.batchCreateComponents(templateId: templateId, quantity: quantity) + } + + // This function will generate a new Pack containing a set of components. + // A random string is passed to manage permissions for the + // purchase of it (more info on FlovatarPack.cdc). + // Finally the sale price is set as well. + access(all) + fun createPack(components: @[FlovatarComponent.NFT], randomString: String, price: UFix64, sparkCount: UInt32, series: UInt32, name: String): @FlovatarPack.Pack{ + return <-FlovatarPack.createPack(components: <-components, randomString: randomString, price: price, sparkCount: sparkCount, series: series, name: name) + } + + + // With this function you can generate a new Admin resource + // and pass it to another user if needed + access(all) + fun createNewAdmin(): @Admin{ + return <-create Admin() + } + + // Helper functions to update the Royalty cut + access(all) + fun setRoyaltyCut(value: UFix64){ + Flovatar.setRoyaltyCut(value: value) + } + + // Helper functions to update the Marketplace cut + access(all) + fun setMarketplaceCut(value: UFix64){ + Flovatar.setMarketplaceCut(value: value) + } } + + init(){ + self.CollectionPublicPath = /public/FlovatarCollection + self.CollectionStoragePath = /storage/FlovatarCollection + self.AdminStoragePath = /storage/FlovatarAdmin + + // Initialize the total supply + self.totalSupply = UInt64(0) + self.mintedCombinations ={} + self.mintedNames ={} + + // Set the default Royalty and Marketplace cuts + self.royaltyCut = 0.01 + self.marketplaceCut = 0.05 + self.account.storage.save<@{NonFungibleToken.Collection}>(<-Flovatar.createEmptyCollection(nftType: Type<@Flovatar.Collection>()), to: Flovatar.CollectionStoragePath) + var capability_1 = self.account.capabilities.storage.issue<&{Flovatar.CollectionPublic}>(Flovatar.CollectionStoragePath) + self.account.capabilities.publish(capability_1, at: Flovatar.CollectionPublicPath) + + // Put the Admin resource in storage + self.account.storage.save<@Admin>(<-create Admin(), to: self.AdminStoragePath) + emit ContractInitialized() + } }

🔔For EVM on Flow Block Explorer go to…

Contract