@flowtyio/flow-contracts 0.1.0-beta.2 → 0.1.0-beta.4

package/contracts/Burner.cdc

@@ -0,0 +1,44 @@
+/// Burner is a contract that can facilitate the destruction of any resource on flow.
+///
+/// Contributors
+/// - Austin Kline - https://twitter.com/austin_flowty
+/// - Deniz Edincik - https://twitter.com/bluesign
+/// - Bastian Müller - https://twitter.com/turbolent
+access(all) contract Burner {
+    /// When Crescendo (Cadence 1.0) is released, custom destructors will be removed from cadece.
+    /// Burnable is an interface meant to replace this lost feature, allowing anyone to add a callback
+    /// method to ensure they do not destroy something which is not meant to be,
+    /// or to add logic based on destruction such as tracking the supply of a FT Collection
+    ///
+    /// NOTE: The only way to see benefit from this interface
+    /// is to always use the burn method in this contract. Anyone who owns a resource can always elect **not**
+    /// to destroy a resource this way
+    access(all) resource interface Burnable {
+        access(contract) fun burnCallback()
+    }
+
+    /// burn is a global method which will destroy any resource it is given.
+    /// If the provided resource implements the Burnable interface,
+    /// it will call the burnCallback method and then destroy afterwards.
+    access(all) fun burn(_ r: @AnyResource) {
+        if let s <- r as? @{Burnable} {
+            s.burnCallback()
+            destroy s
+        } else if let arr <- r as? @[AnyResource] {
+            while arr.length > 0 {
+                let item <- arr.removeFirst()
+                self.burn(<-item)
+            }
+            destroy arr
+        } else if let dict <- r as? @{HashableStruct: AnyResource} {
+            let keys = dict.keys
+            while keys.length > 0 {
+                let item <- dict.remove(key: keys.removeFirst())!
+                self.burn(<-item)
+            }
+            destroy dict
+        } else {
+            destroy r
+        }
+    }
+}

package/contracts/FlowStorageFees.cdc

@@ -1,17 +1,17 @@
 /*
  * The FlowStorageFees smart contract
  *
- * An account's storage capacity determines up to how much storage on chain it can use.
+ * An account's storage capacity determines up to how much storage on chain it can use. 
  * A storage capacity is calculated by multiplying the amount of reserved flow with `StorageFee.storageMegaBytesPerReservedFLOW`
  * The minimum amount of flow tokens reserved for storage capacity is `FlowStorageFees.minimumStorageReservation` this is paid during account creation, by the creator.
- *
- * At the end of all transactions, any account that had any value changed in their storage
+ * 
+ * At the end of all transactions, any account that had any value changed in their storage 
  * has their storage capacity checked against their storage used and their main flow token vault against the minimum reservation.
  * If any account fails this check the transaction wil fail.
- *
- * An account moving/deleting its `FlowToken.Vault` resource will result
+ * 
+ * An account moving/deleting its `FlowToken.Vault` resource will result 
  * in the transaction failing because the account will have no storage capacity.
- *
+ * 
  */
 
 import "FungibleToken"
@@ -26,8 +26,8 @@ access(all) contract FlowStorageFees {
     access(all) event MinimumStorageReservationChanged(_ minimumStorageReservation: UFix64)
 
     // Defines how much storage capacity every account has per reserved Flow token.
-    // definition is written per unit of flow instead of the inverse,
-    // so there is no loss of precision calculating storage from flow,
+    // definition is written per unit of flow instead of the inverse, 
+    // so there is no loss of precision calculating storage from flow, 
     // but there is loss of precision when calculating flow per storage.
     access(all) var storageMegaBytesPerReservedFLOW: UFix64
 
@@ -68,7 +68,7 @@ access(all) contract FlowStorageFees {
         let acct = getAccount(accountAddress)
 
         if let balanceRef = acct.capabilities.borrow<&FlowToken.Vault>(/public/flowTokenBalance) {
-            balance = balanceRef.getBalance()
+            balance = balanceRef.balance
         }
 
         return self.accountBalanceToAccountStorageCapacity(balance)
@@ -86,7 +86,7 @@ access(all) contract FlowStorageFees {
 
     // getAccountsCapacityForTransactionStorageCheck returns the storage capacity of a batch of accounts
     // This is used to check if a transaction will fail because of any account being over the storage capacity
-    // The payer is an exception as its storage capacity is derived from its balance minus the maximum possible transaction fees
+    // The payer is an exception as its storage capacity is derived from its balance minus the maximum possible transaction fees 
     // (transaction fees if the execution effort is at the execution efort limit, a.k.a.: computation limit, a.k.a.: gas limit)
     access(all) fun getAccountsCapacityForTransactionStorageCheck(accountAddresses: [Address], payer: Address, maxTxFees: UFix64): [UFix64] {
         let capacities: [UFix64] = []
@@ -97,13 +97,13 @@ access(all) contract FlowStorageFees {
             if let balanceRef = acct.capabilities.borrow<&FlowToken.Vault>(/public/flowTokenBalance) {
                 if accountAddress == payer {
                     // if the account is the payer, deduct the maximum possible transaction fees from the balance
-                    balance = balanceRef.getBalance().saturatingSubtract(maxTxFees)
+                    balance = balanceRef.balance.saturatingSubtract(maxTxFees)
                 } else {
-                    balance = balanceRef.getBalance()
+                    balance = balanceRef.balance
                 }
             }
 
-            capacities.append(self.accountBalanceToAccountStorageCapacity(balance))
+            capacities.append(self.accountBalanceToAccountStorageCapacity(balance)) 
         }
         return capacities
     }
@@ -117,7 +117,7 @@ access(all) contract FlowStorageFees {
             return 0.0
         }
 
-        // return balance multiplied with megabytes per flow
+        // return balance multiplied with megabytes per flow 
         return self.flowToStorageCapacity(balance)
     }
 
@@ -157,7 +157,7 @@ access(all) contract FlowStorageFees {
         var balance = 0.0
 
         if let balanceRef = acct.capabilities.borrow<&FlowToken.Vault>(/public/flowTokenBalance) {
-            balance = balanceRef.getBalance()
+            balance = balanceRef.balance
         }
 
         // get how much should be reserved for storage

package/contracts/FlowToken.cdc

@@ -1,16 +1,13 @@
 import "FungibleToken"
 import "MetadataViews"
 import "FungibleTokenMetadataViews"
-import "ViewResolver"
+import "Burner"
 
-access(all) contract FlowToken: ViewResolver {
+access(all) contract FlowToken: FungibleToken {
 
     // Total supply of Flow tokens in existence
     access(all) var totalSupply: UFix64
 
-    // Event that is emitted when the contract is created
-    access(all) event TokensInitialized(initialSupply: UFix64)
-
     // Event that is emitted when tokens are withdrawn from a Vault
     access(all) event TokensWithdrawn(amount: UFix64, from: Address?)
 
@@ -20,9 +17,6 @@ access(all) contract FlowToken: ViewResolver {
     // Event that is emitted when new tokens are minted
     access(all) event TokensMinted(amount: UFix64)
 
-    // Event that is emitted when tokens are destroyed
-    access(all) event TokensBurned(amount: UFix64)
-
     // Event that is emitted when a new minter resource is created
     access(all) event MinterCreated(allowedAmount: UFix64)
 
@@ -41,20 +35,24 @@ access(all) contract FlowToken: ViewResolver {
     // out of thin air. A special Minter resource needs to be defined to mint
     // new tokens.
     //
-    access(all) resource Vault: FungibleToken.Vault, FungibleToken.Provider, FungibleToken.Receiver, ViewResolver.Resolver {
+    access(all) resource Vault: FungibleToken.Vault {
 
         // holds the balance of a users tokens
         access(all) var balance: UFix64
 
-        access(all) view fun getBalance(): UFix64 {
-            return self.balance
-        }
-
         // initialize the balance at resource creation time
         init(balance: UFix64) {
             self.balance = balance
         }
 
+        /// Called when a fungible token is burned via the `Burner.burn()` method
+        access(contract) fun burnCallback() {
+            if self.balance > 0.0 {
+                FlowToken.totalSupply = FlowToken.totalSupply - self.balance
+            }
+            self.balance = 0.0
+        }
+
         /// getSupportedVaultTypes optionally returns a list of vault types that this receiver accepts
         access(all) view fun getSupportedVaultTypes(): {Type: Bool} {
             return {self.getType(): true}
@@ -64,14 +62,9 @@ access(all) contract FlowToken: ViewResolver {
             if (type == self.getType()) { return true } else { return false }
         }
 
-        /// Returns the storage path where the vault should typically be stored
-        access(all) view fun getDefaultStoragePath(): StoragePath? {
-            return /storage/flowTokenVault
-        }
-
-        /// Returns the public path where this vault should have a public capability
-        access(all) view fun getDefaultPublicPath(): PublicPath? {
-            return /public/flowTokenReceiver
+        /// Asks if the amount can be withdrawn from this vault
+        access(all) view fun isAvailableToWithdraw(amount: UFix64): Bool {
+            return amount <= self.balance
         }
 
         // withdraw
@@ -83,7 +76,7 @@ access(all) contract FlowToken: ViewResolver {
         // created Vault to the context that called so it can be deposited
         // elsewhere.
         //
-        access(FungibleToken.Withdrawable) fun withdraw(amount: UFix64): @{FungibleToken.Vault} {
+        access(FungibleToken.Withdraw) fun withdraw(amount: UFix64): @{FungibleToken.Vault} {
             self.balance = self.balance - amount
             emit TokensWithdrawn(amount: amount, from: self.owner?.address)
             return <-create Vault(balance: amount)
@@ -110,7 +103,7 @@ access(all) contract FlowToken: ViewResolver {
         ///         developers to know which parameter to pass to the resolveView() method.
         ///
         access(all) view fun getViews(): [Type]{
-            return FlowToken.getViews()
+            return FlowToken.getContractViews(resourceType: nil)
         }
 
         /// Get a Metadata View from FlowToken
@@ -119,7 +112,7 @@ access(all) contract FlowToken: ViewResolver {
         /// @return A structure representing the requested view.
         ///
         access(all) fun resolveView(_ view: Type): AnyStruct? {
-            return FlowToken.resolveView(view)
+            return FlowToken.resolveContractView(resourceType: nil, viewType: view)
         }
 
         access(all) fun createEmptyVault(): @{FungibleToken.Vault} {
@@ -134,11 +127,12 @@ access(all) contract FlowToken: ViewResolver {
     // and store the returned Vault in their storage in order to allow their
     // account to be able to receive deposits of this token type.
     //
-    access(all) fun createEmptyVault(): @FlowToken.Vault {
+    access(all) fun createEmptyVault(vaultType: Type): @FlowToken.Vault {
         return <-create Vault(balance: 0.0)
     }
 
-    access(all) view fun getViews(): [Type] {
+    /// Gets a list of the metadata views that this contract supports
+    access(all) view fun getContractViews(resourceType: Type?): [Type] {
         return [Type<FungibleTokenMetadataViews.FTView>(),
                 Type<FungibleTokenMetadataViews.FTDisplay>(),
                 Type<FungibleTokenMetadataViews.FTVaultData>(),
@@ -150,12 +144,12 @@ access(all) contract FlowToken: ViewResolver {
     /// @param view: The Type of the desired view.
     /// @return A structure representing the requested view.
     ///
-    access(all) fun resolveView(_ view: Type): AnyStruct? {
-        switch view {
+    access(all) fun resolveContractView(resourceType: Type?, viewType: Type): AnyStruct? {
+        switch viewType {
             case Type<FungibleTokenMetadataViews.FTView>():
                 return FungibleTokenMetadataViews.FTView(
-                    ftDisplay: self.resolveView(Type<FungibleTokenMetadataViews.FTDisplay>()) as! FungibleTokenMetadataViews.FTDisplay?,
-                    ftVaultData: self.resolveView(Type<FungibleTokenMetadataViews.FTVaultData>()) as! FungibleTokenMetadataViews.FTVaultData?
+                    ftDisplay: self.resolveContractView(resourceType: nil, viewType: Type<FungibleTokenMetadataViews.FTDisplay>()) as! FungibleTokenMetadataViews.FTDisplay?,
+                    ftVaultData: self.resolveContractView(resourceType: nil, viewType: Type<FungibleTokenMetadataViews.FTVaultData>()) as! FungibleTokenMetadataViews.FTVaultData?
                 )
             case Type<FungibleTokenMetadataViews.FTDisplay>():
                 let media = MetadataViews.Media(
@@ -176,16 +170,16 @@ access(all) contract FlowToken: ViewResolver {
                     }
                 )
             case Type<FungibleTokenMetadataViews.FTVaultData>():
+                let vaultRef = FlowToken.account.storage.borrow<auth(FungibleToken.Withdraw) &FlowToken.Vault>(from: /storage/flowTokenVault)
+			        ?? panic("Could not borrow reference to the contract's Vault!")
                 return FungibleTokenMetadataViews.FTVaultData(
                     storagePath: /storage/flowTokenVault,
                     receiverPath: /public/flowTokenReceiver,
                     metadataPath: /public/flowTokenBalance,
-                    providerPath: /private/flowTokenVault,
-                    receiverLinkedType: Type<&FlowToken.Vault>(),
-                    metadataLinkedType: Type<&FlowToken.Vault>(),
-                    providerLinkedType: Type<&FlowToken.Vault>(),
+                    receiverLinkedType: Type<&{FungibleToken.Receiver, FungibleToken.Vault}>(),
+                    metadataLinkedType: Type<&{FungibleToken.Balance, FungibleToken.Vault}>(),
                     createEmptyVaultFunction: (fun (): @{FungibleToken.Vault} {
-                        return <-FlowToken.createEmptyVault()
+                        return <-vaultRef.createEmptyVault()
                     })
                 )
             case Type<FungibleTokenMetadataViews.TotalSupply>():
@@ -203,15 +197,6 @@ access(all) contract FlowToken: ViewResolver {
             emit MinterCreated(allowedAmount: allowedAmount)
             return <-create Minter(allowedAmount: allowedAmount)
         }
-
-        // createNewBurner
-        //
-        // Function that creates and returns a new burner resource
-        //
-        access(all) fun createNewBurner(): @Burner {
-            emit BurnerCreated()
-            return <-create Burner()
-        }
     }
 
     // Minter
@@ -244,34 +229,6 @@ access(all) contract FlowToken: ViewResolver {
         }
     }
 
-    // Burner
-    //
-    // Resource object that token admin accounts can hold to burn tokens.
-    //
-    access(all) resource Burner {
-
-        // burnTokens
-        //
-        // Function that destroys a Vault instance, effectively burning the tokens.
-        //
-        // Note: the burned tokens are automatically subtracted from the
-        // total supply in the Vault destructor.
-        //
-        access(all) fun burnTokens(from: @FlowToken.Vault) {
-            FlowToken.burnTokens(from: <-from)
-        }
-    }
-
-    access(all) fun burnTokens(from: @FlowToken.Vault) {
-        let vault <- from as! @FlowToken.Vault
-        let amount = vault.balance
-        destroy vault
-        if amount > 0.0 {
-            FlowToken.totalSupply = FlowToken.totalSupply - amount
-            emit TokensBurned(amount: amount)
-        }
-    }
-
     /// Gets the Flow Logo XML URI from storage
     access(all) fun getLogoURI(): String {
         return FlowToken.account.storage.copy<String>(from: /storage/flowTokenLogoURI) ?? ""
@@ -284,9 +241,6 @@ access(all) contract FlowToken: ViewResolver {
         //
         let vault <- create Vault(balance: self.totalSupply)
 
-        // Example of how to resolve a metadata view for a Vault
-        let ftView = vault.resolveView(Type<FungibleTokenMetadataViews.FTView>())
-
         adminAccount.storage.save(<-vault, to: /storage/flowTokenVault)
 
         // Create a public capability to the stored Vault that only exposes
@@ -304,8 +258,5 @@ access(all) contract FlowToken: ViewResolver {
         let admin <- create Administrator()
         adminAccount.storage.save(<-admin, to: /storage/flowTokenAdmin)
 
-        // Emit an event that shows that the contract was initialized
-        emit TokensInitialized(initialSupply: self.totalSupply)
-
     }
 }

package/contracts/FungibleToken.cdc

@@ -32,6 +32,7 @@ to the Provider interface.
 */
 
 import "ViewResolver"
+import "Burner"
 
 /// FungibleToken
 ///
@@ -40,16 +41,28 @@ import "ViewResolver"
 /// utility methods that many projects will still want to have on their contracts,
 /// but they are by no means required. all that is required is that the token
 /// implements the `Vault` interface
-access(all) contract FungibleToken {
+access(all) contract interface FungibleToken: ViewResolver {
 
     // An entitlement for allowing the withdrawal of tokens from a Vault
-    access(all) entitlement Withdrawable
+    access(all) entitlement Withdraw
 
     /// The event that is emitted when tokens are withdrawn from a Vault
-    access(all) event Withdraw(amount: UFix64, from: Address?, type: String)
+    access(all) event Withdrawn(type: String, amount: UFix64, from: Address?, fromUUID: UInt64, withdrawnUUID: UInt64)
 
     /// The event that is emitted when tokens are deposited to a Vault
-    access(all) event Deposit(amount: UFix64, to: Address?, type: String)
+    access(all) event Deposited(type: String, amount: UFix64, to: Address?, toUUID: UInt64, depositedUUID: UInt64)
+
+    /// Event that is emitted when the global burn method is called with a non-zero balance
+    access(all) event Burned(type: String, amount: UFix64, fromUUID: UInt64)
+
+    /// Balance
+    ///
+    /// The interface that provides standard functions\
+    /// for getting balance information
+    ///
+    access(all) resource interface Balance {
+        access(all) var balance: UFix64
+    }
 
     /// Provider
     ///
@@ -62,27 +75,29 @@ access(all) contract FungibleToken {
     ///
     access(all) resource interface Provider {
 
-        /// withdraw subtracts tokens from the owner's Vault
+        /// Function to ask a provider if a specific amount of tokens
+        /// is available to be withdrawn
+        /// This could be useful to avoid panicing when calling withdraw
+        /// when the balance is unknown
+        /// Additionally, if the provider is pulling from multiple vaults
+        /// it only needs to check some of the vaults until the desired amount
+        /// is reached, potentially helping with performance.
+        /// 
+        access(all) view fun isAvailableToWithdraw(amount: UFix64): Bool
+
+        /// withdraw subtracts tokens from the implementing resource
         /// and returns a Vault with the removed tokens.
         ///
-        /// The function's access level is public, but this is not a problem
-        /// because only the owner storing the resource in their account
-        /// can initially call this function.
-        ///
-        /// The owner may grant other accounts access by creating a private
-        /// capability that allows specific other users to access
-        /// the provider resource through a reference.
-        ///
-        /// The owner may also grant all accounts access by creating a public
-        /// capability that allows all users to access the provider
-        /// resource through a reference.
+        /// The function's access level is `access(Withdraw)`
+        /// So in order to access it, one would either need the object itself
+        /// or an entitled reference with `Withdraw`.
         ///
-        access(Withdrawable) fun withdraw(amount: UFix64): @{Vault} {
+        access(Withdraw) fun withdraw(amount: UFix64): @{Vault} {
             post {
                 // `result` refers to the return value
-                result.getBalance() == amount:
+                result.balance == amount:
                     "Withdrawal amount must be the same as the balance of the withdrawn Vault"
-                emit Withdraw(amount: amount, from: self.owner?.address, type: self.getType().identifier)
+                emit Withdrawn(type: self.getType().identifier, amount: amount, from: self.owner?.address, fromUUID: self.uuid, withdrawnUUID: result.uuid)
             }
         }
     }
@@ -104,15 +119,11 @@ access(all) contract FungibleToken {
         access(all) fun deposit(from: @{Vault})
 
         /// getSupportedVaultTypes optionally returns a list of vault types that this receiver accepts
-        access(all) view fun getSupportedVaultTypes(): {Type: Bool} {
-            pre { true: "dummy" }
-        }
+        access(all) view fun getSupportedVaultTypes(): {Type: Bool}
 
         /// Returns whether or not the given type is accepted by the Receiver
         /// A vault that can accept any type should just return true by default
-        access(all) view fun isSupportedVaultType(type: Type): Bool {
-            pre { true: "dummy" }
-        }
+        access(all) view fun isSupportedVaultType(type: Type): Bool
     }
 
     /// Vault
@@ -120,17 +131,35 @@ access(all) contract FungibleToken {
     /// Ideally, this interface would also conform to Receiver, Balance, Transferor, Provider, and Resolver
     /// but that is not supported yet
     ///
-    access(all) resource interface Vault: Receiver, Provider, ViewResolver.Resolver {
-
-        //access(all) event ResourceDestroyed(balance: UFix64 = self.getBalance())
-
-        /// Get the balance of the vault
-        access(all) view fun getBalance(): UFix64
+    access(all) resource interface Vault: Receiver, Provider, Balance, ViewResolver.Resolver, Burner.Burnable {
+
+        /// Field that tracks the balance of a vault
+        access(all) var balance: UFix64
+
+        /// Called when a fungible token is burned via the `Burner.burn()` method
+        /// Implementations can do any bookkeeping or emit any events
+        /// that should be emitted when a vault is destroyed.
+        /// Many implementations will want to update the token's total supply
+        /// to reflect that the tokens have been burned and removed from the supply.
+        /// Implementations also need to set the balance to zero before the end of the function
+        /// This is to prevent vault owners from spamming fake Burned events.
+        access(contract) fun burnCallback() {
+            pre {
+                emit Burned(type: self.getType().identifier, amount: self.balance, fromUUID: self.uuid)
+            }
+            post {
+                self.balance == 0.0: "The balance must be set to zero during the burnCallback method so that it cannot be spammed"
+            }
+            self.balance = 0.0
+        }
 
         /// getSupportedVaultTypes optionally returns a list of vault types that this receiver accepts
+        /// The default implementation is included here because vaults are expected
+        /// to only accepted their own type, so they have no need to provide an implementation
+        /// for this function
         access(all) view fun getSupportedVaultTypes(): {Type: Bool} {
             // Below check is implemented to make sure that run-time type would
-            // only get returned when the parent resource conforms with `FungibleToken.Vault`.
+            // only get returned when the parent resource conforms with `FungibleToken.Vault`. 
             if self.getType().isSubtype(of: Type<@{FungibleToken.Vault}>()) {
                 return {self.getType(): true}
             } else {
@@ -140,36 +169,25 @@ access(all) contract FungibleToken {
             }
         }
 
+        /// Checks if the given type is supported by this Vault
         access(all) view fun isSupportedVaultType(type: Type): Bool {
             return self.getSupportedVaultTypes()[type] ?? false
         }
 
-        /// Returns the storage path where the vault should typically be stored
-        access(all) view fun getDefaultStoragePath(): StoragePath?
-
-        /// Returns the public path where this vault should have a public capability
-        access(all) view fun getDefaultPublicPath(): PublicPath?
-
-        /// Returns the public path where this vault's Receiver should have a public capability
-        /// Publishing a Receiver Capability at a different path enables alternate Receiver implementations to be used
-        /// in the same canonical namespace as the underlying Vault.
-        access(all) view fun getDefaultReceiverPath(): PublicPath? {
-            return nil
-        }
-
         /// withdraw subtracts `amount` from the Vault's balance
         /// and returns a new Vault with the subtracted balance
         ///
-        access(Withdrawable) fun withdraw(amount: UFix64): @{Vault} {
+        access(Withdraw) fun withdraw(amount: UFix64): @{Vault} {
             pre {
-                self.getBalance() >= amount:
+                self.balance >= amount:
                     "Amount withdrawn must be less than or equal than the balance of the Vault"
             }
             post {
+                result.getType() == self.getType(): "Must return the same vault type as self"
                 // use the special function `before` to get the value of the `balance` field
                 // at the beginning of the function execution
                 //
-                self.getBalance() == before(self.getBalance()) - amount:
+                self.balance == before(self.balance) - amount:
                     "New Vault balance must be the difference of the previous balance and the withdrawn Vault balance"
             }
         }
@@ -180,12 +198,12 @@ access(all) contract FungibleToken {
             // Assert that the concrete type of the deposited vault is the same
             // as the vault that is accepting the deposit
             pre {
-                from.isInstance(self.getType()):
+                from.isInstance(self.getType()): 
                     "Cannot deposit an incompatible token type"
-                emit Deposit(amount: from.getBalance(), to: self.owner?.address, type: from.getType().identifier)
+                emit Deposited(type: from.getType().identifier, amount: from.balance, to: self.owner?.address, toUUID: self.uuid, depositedUUID: from.uuid)
             }
             post {
-                self.getBalance() == before(self.getBalance()) + before(from.getBalance()):
+                self.balance == before(self.balance) + before(from.balance):
                     "New Vault balance must be the sum of the previous balance and the deposited Vault"
             }
         }
@@ -194,8 +212,17 @@ access(all) contract FungibleToken {
         ///
         access(all) fun createEmptyVault(): @{Vault} {
             post {
-                result.getBalance() == 0.0: "The newly created Vault must have zero balance"
+                result.balance == 0.0: "The newly created Vault must have zero balance"
             }
         }
     }
-}
+
+    /// createEmptyVault allows any user to create a new Vault that has a zero balance
+    ///
+    access(all) fun createEmptyVault(vaultType: Type): @{FungibleToken.Vault} {
+        post {
+            result.getType() == vaultType: "The returned vault does not match the desired type"
+            result.balance == 0.0: "The newly created Vault must have zero balance"
+        }
+    }
+}