@flowtyio/flow-contracts 0.1.0-beta.6 → 0.1.0-beta.7

package/contracts/flow-utils/AddressUtils.cdc

@@ -103,4 +103,4 @@ access(all) contract AddressUtils {
     access(all) fun currentNetwork(): String {
         return  self.getNetworkFromAddress(self.account.address) ?? panic("unknown network!")
     }
-}
+}

package/contracts/flow-utils/ArrayUtils.cdc

@@ -1,120 +1,68 @@
-import "FungibleToken"
-import "StringUtils"
-
-// ScopedFTProviders
-//
-// TO AVOID RISK, PLEASE DEPLOY YOUR OWN VERSION OF THIS CONTRACT SO THAT
-// MALICIOUS UPDATES ARE NOT POSSIBLE
-//
-// ScopedProviders are meant to solve the issue of unbounded access FungibleToken vaults
-// when a provider is called for.
-access(all) contract ScopedFTProviders {
-    access(all) struct interface FTFilter {
-        access(all) fun canWithdrawAmount(_ amount: UFix64): Bool
-        access(FungibleToken.Withdraw) fun markAmountWithdrawn(_ amount: UFix64)
-        access(all) fun getDetails(): {String: AnyStruct}
-    }
-
-    access(all) struct AllowanceFilter: FTFilter {
-        access(self) let allowance: UFix64
-        access(self) var allowanceUsed: UFix64
-
-        init(_ allowance: UFix64) {
-            self.allowance = allowance
-            self.allowanceUsed = 0.0
-        }
-
-        access(all) fun canWithdrawAmount(_ amount: UFix64): Bool {
-            return amount + self.allowanceUsed <= self.allowance
-        }
-
-        access(FungibleToken.Withdraw) fun markAmountWithdrawn(_ amount: UFix64) {
-            self.allowanceUsed = self.allowanceUsed + amount
-        }
-
-        access(all) fun getDetails(): {String: AnyStruct} {
-            return {
-                "allowance": self.allowance,
-                "allowanceUsed": self.allowanceUsed
-            }
+// Copied from https://github.com/bluesign/flow-utils/blob/dnz/cadence/contracts/ArrayUtils.cdc with minor adjustments
+
+access(all) contract ArrayUtils {
+    access(all) fun rangeFunc(_ start: Int, _ end: Int, _ f: fun (Int): Void) {
+        var current = start
+        while current < end {
+            f(current)
+            current = current + 1
         }
     }
 
-    // ScopedFTProvider
-    //
-    // A ScopedFTProvider is a wrapped FungibleTokenProvider with
-    // filters that can be defined by anyone using the ScopedFTProvider.
-    access(all) resource ScopedFTProvider: FungibleToken.Provider {
-        access(self) let provider: Capability<auth(FungibleToken.Withdraw) &{FungibleToken.Provider}>
-        access(self) var filters: [{FTFilter}]
-
-        // block timestamp that this provider can no longer be used after
-        access(self) let expiration: UFix64?
+    access(all) fun range(_ start: Int, _ end: Int): [Int] {
+        var res: [Int] = []
+        self.rangeFunc(start, end, fun (i: Int) {
+            res.append(i)
+        })
+        return res
+    }
 
-        access(all) init(provider: Capability<auth(FungibleToken.Withdraw) &{FungibleToken.Provider}>, filters: [{FTFilter}], expiration: UFix64?) {
-            self.provider = provider
-            self.filters = filters
-            self.expiration = expiration
+    access(all) fun reverse(_ array: [Int]): [Int] {
+        var res: [Int] = []
+        var i: Int = array.length - 1
+        while i >= 0 {
+            res.append(array[i])
+            i = i - 1
         }
+        return res
+    }
 
-        access(all) fun check(): Bool {
-            return self.provider.check()
+    access(all) fun transform(_ array: auth(Mutate) &[AnyStruct], _ f : fun (&AnyStruct, auth(Mutate) &[AnyStruct], Int)){
+        for i in self.range(0, array.length){
+            f(array[i], array, i)
         }
+    }
 
-        access(all) view fun isExpired(): Bool {
-            if let expiration = self.expiration {
-                return getCurrentBlock().timestamp >= expiration
+    access(all) fun iterate(_ array: [AnyStruct], _ f : fun (AnyStruct): Bool) {
+        for item in array{
+            if !f(item){
+                break
             }
-            return false
         }
+    }
 
-        access(all) fun canWithdraw(_ amount: UFix64): Bool {
-            if self.isExpired() {
-                return false
-            }
-
-            for filter in self.filters {
-                if !filter.canWithdrawAmount(amount) {
-                    return false
-                }
-            }
-
-            return true
+    access(all) fun map(_ array: [AnyStruct], _ f : fun (AnyStruct): AnyStruct) : [AnyStruct] {
+        var res : [AnyStruct] = []
+        for item in array{
+            res.append(f(item))
         }
+        return res
+    }
 
-        access(FungibleToken.Withdraw) fun withdraw(amount: UFix64): @{FungibleToken.Vault} {
-            pre {
-                !self.isExpired(): "provider has expired"
-            }
-
-            var i = 0
-            while i < self.filters.length {
-                if !self.filters[i].canWithdrawAmount(amount) {
-                    panic(StringUtils.join(["cannot withdraw tokens. filter of type", self.filters[i].getType().identifier, "failed."], " "))
-                }
-
-                self.filters[i].markAmountWithdrawn(amount)
-                i = i + 1
-            }
-
-            return <-self.provider.borrow()!.withdraw(amount: amount)
+    access(all) fun mapStrings(_ array: [String], _ f: fun (String) : String) : [String] {
+        var res : [String] = []
+        for item in array{
+            res.append(f(item))
         }
+        return res
+    }
 
-        access(all) fun getDetails(): [{String: AnyStruct}] {
-            let details: [{String: AnyStruct}] = []
-            for filter in self.filters {
-                details.append(filter.getDetails())
-            }
-
-            return details
+    access(all) fun reduce(_ array: [AnyStruct], _ initial: AnyStruct, _ f : fun (AnyStruct, AnyStruct): AnyStruct) : AnyStruct{
+        var res: AnyStruct = f(initial, array[0])
+        for i in self.range(1, array.length){
+            res =  f(res, array[i])
         }
+        return res
     }
 
-    access(all) fun createScopedFTProvider(
-        provider: Capability<auth(FungibleToken.Withdraw) &{FungibleToken.Provider}>,
-        filters: [{FTFilter}],
-        expiration: UFix64?
-    ): @ScopedFTProvider {
-        return <- create ScopedFTProvider(provider: provider, filters: filters, expiration: expiration)
-    }
-}
+}

package/contracts/flow-utils/ScopedFTProviders.cdc

@@ -8,14 +8,14 @@ import "StringUtils"
 //
 // ScopedProviders are meant to solve the issue of unbounded access FungibleToken vaults
 // when a provider is called for.
-pub contract ScopedFTProviders {
-    pub struct interface FTFilter {
-        pub fun canWithdrawAmount(_ amount: UFix64): Bool
-        pub fun markAmountWithdrawn(_ amount: UFix64)
-        pub fun getDetails(): {String: AnyStruct}
+access(all) contract ScopedFTProviders {
+    access(all) struct interface FTFilter {
+        access(all) view fun canWithdrawAmount(_ amount: UFix64): Bool
+        access(FungibleToken.Withdraw) fun markAmountWithdrawn(_ amount: UFix64)
+        access(all) fun getDetails(): {String: AnyStruct}
     }
 
-    pub struct AllowanceFilter: FTFilter {
+    access(all) struct AllowanceFilter: FTFilter {
         access(self) let allowance: UFix64
         access(self) var allowanceUsed: UFix64
 
@@ -24,15 +24,15 @@ pub contract ScopedFTProviders {
             self.allowanceUsed = 0.0
         }
 
-        pub fun canWithdrawAmount(_ amount: UFix64): Bool {
+        access(all) view fun canWithdrawAmount(_ amount: UFix64): Bool {
             return amount + self.allowanceUsed <= self.allowance
         }
 
-        pub fun markAmountWithdrawn(_ amount: UFix64) {
+        access(FungibleToken.Withdraw) fun markAmountWithdrawn(_ amount: UFix64) {
             self.allowanceUsed = self.allowanceUsed + amount
         }
 
-        pub fun getDetails(): {String: AnyStruct} {
+        access(all) fun getDetails(): {String: AnyStruct} {
             return {
                 "allowance": self.allowance,
                 "allowanceUsed": self.allowanceUsed
@@ -44,31 +44,31 @@ pub contract ScopedFTProviders {
     //
     // A ScopedFTProvider is a wrapped FungibleTokenProvider with
     // filters that can be defined by anyone using the ScopedFTProvider.
-    pub resource ScopedFTProvider: FungibleToken.Provider {
-        access(self) let provider: Capability<&{FungibleToken.Provider}>
+    access(all) resource ScopedFTProvider: FungibleToken.Provider {
+        access(self) let provider: Capability<auth(FungibleToken.Withdraw) &{FungibleToken.Provider}>
         access(self) var filters: [{FTFilter}]
 
         // block timestamp that this provider can no longer be used after
         access(self) let expiration: UFix64?
 
-        pub init(provider: Capability<&{FungibleToken.Provider}>, filters: [{FTFilter}], expiration: UFix64?) {
+        access(all) init(provider: Capability<auth(FungibleToken.Withdraw) &{FungibleToken.Provider}>, filters: [{FTFilter}], expiration: UFix64?) {
             self.provider = provider
             self.filters = filters
             self.expiration = expiration
         }
 
-        pub fun check(): Bool {
+        access(all) fun check(): Bool {
             return self.provider.check()
         }
 
-        pub fun isExpired(): Bool {
+        access(all) view fun isExpired(): Bool {
             if let expiration = self.expiration {
                 return getCurrentBlock().timestamp >= expiration
             }
             return false
         }
 
-        pub fun canWithdraw(_ amount: UFix64): Bool {
+        access(all) view fun canWithdraw(_ amount: UFix64): Bool {
             if self.isExpired() {
                 return false
             }
@@ -82,7 +82,11 @@ pub contract ScopedFTProviders {
             return true
         }
 
-        pub fun withdraw(amount: UFix64): @FungibleToken.Vault {
+        access(all) view fun isAvailableToWithdraw(amount: UFix64): Bool {
+            return self.canWithdraw(amount)
+        }
+
+        access(FungibleToken.Withdraw | FungibleToken.Withdraw) fun withdraw(amount: UFix64): @{FungibleToken.Vault} {
             pre {
                 !self.isExpired(): "provider has expired"
             }
@@ -100,7 +104,7 @@ pub contract ScopedFTProviders {
             return <-self.provider.borrow()!.withdraw(amount: amount)
         }
 
-        pub fun getDetails(): [{String: AnyStruct}] {
+        access(all) fun getDetails(): [{String: AnyStruct}] {
             let details: [{String: AnyStruct}] = []
             for filter in self.filters {
                 details.append(filter.getDetails())
@@ -110,11 +114,12 @@ pub contract ScopedFTProviders {
         }
     }
 
-    pub fun createScopedFTProvider(
-        provider: Capability<&{FungibleToken.Provider}>,
+    access(all) fun createScopedFTProvider(
+        provider: Capability<auth(FungibleToken.Withdraw) &{FungibleToken.Provider}>,
         filters: [{FTFilter}],
         expiration: UFix64?
     ): @ScopedFTProvider {
         return <- create ScopedFTProvider(provider: provider, filters: filters, expiration: expiration)
     }
 }
+

package/contracts/flow-utils/ScopedNFTProviders.cdc

@@ -32,11 +32,11 @@ access(all) contract ScopedNFTProviders {
         }
 
         access(all) fun canWithdraw(_ nft: &{NonFungibleToken.NFT}): Bool {
-            return self.ids[nft.getID()] != nil && self.ids[nft.getID()] == true
+            return self.ids[nft.id] != nil && self.ids[nft.id] == true
         }
 
         access(NonFungibleToken.Withdraw) fun markWithdrawn(_ nft: &{NonFungibleToken.NFT}) {
-            self.ids[nft.getID()] = false
+            self.ids[nft.id] = false
         }
 
         access(all) fun getDetails(): {String: AnyStruct} {
@@ -121,7 +121,7 @@ access(all) contract ScopedNFTProviders {
             return self.provider.check()
         }
 
-        access(NonFungibleToken.Withdraw) fun withdraw(withdrawID: UInt64): @{NonFungibleToken.NFT} {
+        access(NonFungibleToken.Withdraw | NonFungibleToken.Owner) fun withdraw(withdrawID: UInt64): @{NonFungibleToken.NFT} {
             pre {
                 !self.isExpired(): "provider has expired"
             }
@@ -160,3 +160,4 @@ access(all) contract ScopedNFTProviders {
         return <- create ScopedNFTProvider(provider: provider, filters: filters, expiration: expiration)
     }
 }
+

package/contracts/flow-utils/StringUtils.cdc

@@ -81,4 +81,4 @@ access(all) contract StringUtils {
     access(all) fun join(_ strs: [String], _ separator: String): String {
         return String.join(strs, separator: separator)
     }
-}
+}

package/contracts/lost-and-found/LostAndFound.cdc

@@ -125,7 +125,7 @@ access(all) contract LostAndFound {
             if self.type.isSubtype(of: Type<@{NonFungibleToken.NFT}>()) {
                 let ref = (&self.item as &AnyResource?)!
                 let nft = ref as! &{NonFungibleToken.NFT}
-                return nft.getID()
+                return nft.id
             }
             return nil
         }
@@ -135,7 +135,7 @@ access(all) contract LostAndFound {
             if self.type.isSubtype(of: Type<@{FungibleToken.Vault}>()) {
                 let ref = (&self.item as &AnyResource?)!
                 let ft = ref as! &{FungibleToken.Vault}
-                return ft.getBalance()
+                return ft.balance
             }
             return nil
         }
@@ -391,8 +391,8 @@ access(all) contract LostAndFound {
         }
     }
 
-    access(contract) fun getFlowProvider(): auth(FungibleToken.Withdrawable) &FlowToken.Vault {
-        return self.account.storage.borrow<auth(FungibleToken.Withdrawable) &FlowToken.Vault>(from: /storage/flowTokenVault)!
+    access(contract) fun getFlowProvider(): auth(FungibleToken.Withdraw) &FlowToken.Vault {
+        return self.account.storage.borrow<auth(FungibleToken.Withdraw) &FlowToken.Vault>(from: /storage/flowTokenVault)!
     }
 
     // ShelfManager is a light-weight wrapper to get our shelves into storage.
@@ -422,7 +422,7 @@ access(all) contract LostAndFound {
             item: @AnyResource,
             memo: String?,
             display: MetadataViews.Display?,
-            storagePayment: auth(FungibleToken.Withdrawable) &{FungibleToken.Vault},
+            storagePayment: auth(FungibleToken.Withdraw) &{FungibleToken.Vault},
             flowTokenRepayment: Capability<&FlowToken.Vault>?
         ) : UInt64 {
             pre {
@@ -598,7 +598,7 @@ access(all) contract LostAndFound {
         init(_ flowTokenRepayment: Capability<&FlowToken.Vault>, lowBalanceThreshold: UFix64?) {
             self.flowTokenRepayment = flowTokenRepayment
 
-            let vault <- FlowToken.createEmptyVault()
+            let vault <- FlowToken.createEmptyVault(vaultType: Type<@FlowToken.Vault>())
             self.flowTokenVault <- vault
             self.lowBalanceThreshold = lowBalanceThreshold 
         }
@@ -713,7 +713,7 @@ access(all) contract LostAndFound {
         item: @AnyResource,
         memo: String?,
         display: MetadataViews.Display?,
-        storagePayment: auth(FungibleToken.Withdrawable) &{FungibleToken.Vault},
+        storagePayment: auth(FungibleToken.Withdraw) &{FungibleToken.Vault},
         flowTokenRepayment: Capability<&FlowToken.Vault>?
     ) : UInt64 {
         pre {
@@ -730,7 +730,7 @@ access(all) contract LostAndFound {
         cap: Capability,
         memo: String?,
         display: MetadataViews.Display?,
-        storagePayment: auth(FungibleToken.Withdrawable) &{FungibleToken.Vault},
+        storagePayment: auth(FungibleToken.Withdraw) &{FungibleToken.Vault},
         flowTokenRepayment: Capability<&FlowToken.Vault>
     ) {
         if cap.check<&{NonFungibleToken.Collection}>() {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@flowtyio/flow-contracts",
-    "version": "0.1.0-beta.6",
+    "version": "0.1.0-beta.7",
     "main": "index.json",
     "description": "An NPM package for common flow contracts",
     "author": "flowtyio",