Storage
Accounts allow storing storable objects, such as resources and structures.
An account exposes its storage through the storage field,
which has the type Account.Storage.
Account.Storage
_134access(all)_134struct Storage {_134 /// The current amount of storage used by the account in bytes._134 access(all)_134 let used: UInt64_134_134 /// The storage capacity of the account in bytes._134 access(all)_134 let capacity: UInt64_134_134 /// All public paths of this account._134 access(all)_134 let publicPaths: [PublicPath]_134_134 /// All storage paths of this account._134 access(all)_134 let storagePaths: [StoragePath]_134_134 /// Saves the given object into the account's storage at the given path._134 ///_134 /// Resources are moved into storage, and structures are copied._134 ///_134 /// If there is already an object stored under the given path, the program aborts._134 ///_134 /// The path must be a storage path, i.e., only the domain `storage` is allowed._134 access(Storage | SaveValue)_134 fun save<T: Storable>(_ value: T, to: StoragePath)_134_134 /// Reads the type of an object from the account's storage which is stored under the given path,_134 /// or nil if no object is stored under the given path._134 ///_134 /// If there is an object stored, the type of the object is returned without modifying the stored object._134 ///_134 /// The path must be a storage path, i.e., only the domain `storage` is allowed._134 access(all)_134 view fun type(at path: StoragePath): Type?_134_134 /// Loads an object from the account's storage which is stored under the given path,_134 /// or nil if no object is stored under the given path._134 ///_134 /// If there is an object stored,_134 /// the stored resource or structure is moved out of storage and returned as an optional._134 ///_134 /// When the function returns, the storage no longer contains an object under the given path._134 ///_134 /// The given type must be a supertype of the type of the loaded object._134 /// If it is not, the function panics._134 ///_134 /// The given type must not necessarily be exactly the same as the type of the loaded object._134 ///_134 /// The path must be a storage path, i.e., only the domain `storage` is allowed._134 access(Storage | LoadValue)_134 fun load<T: Storable>(from: StoragePath): T?_134_134 /// Returns a copy of a structure stored in account storage under the given path,_134 /// without removing it from storage,_134 /// or nil if no object is stored under the given path._134 ///_134 /// If there is a structure stored, it is copied._134 /// The structure stays stored in storage after the function returns._134 ///_134 /// The given type must be a supertype of the type of the copied structure._134 /// If it is not, the function panics._134 ///_134 /// The given type must not necessarily be exactly the same as the type of the copied structure._134 ///_134 /// The path must be a storage path, i.e., only the domain `storage` is allowed._134 access(Storage | CopyValue)_134 view fun copy<T: AnyStruct>(from: StoragePath): T?_134_134 /// Returns true if the object in account storage under the given path satisfies the given type,_134 /// i.e. could be borrowed using the given type._134 ///_134 /// The given type must not necessarily be exactly the same as the type of the borrowed object._134 ///_134 /// The path must be a storage path, i.e., only the domain `storage` is allowed._134 access(all)_134 view fun check<T: Any>(from: StoragePath): Bool_134_134 /// Returns a reference to an object in storage without removing it from storage._134 ///_134 /// If no object is stored under the given path, the function returns nil._134 /// If there is an object stored, a reference is returned as an optional,_134 /// provided it can be borrowed using the given type._134 /// If the stored object cannot be borrowed using the given type, the function panics._134 ///_134 /// The given type must not necessarily be exactly the same as the type of the borrowed object._134 ///_134 /// The path must be a storage path, i.e., only the domain `storage` is allowed_134 access(Storage | BorrowValue)_134 view fun borrow<T: &Any>(from: StoragePath): T?_134_134 /// Iterate over all the public paths of an account,_134 /// passing each path and type in turn to the provided callback function._134 ///_134 /// The callback function takes two arguments:_134 /// 1. The path of the stored object_134 /// 2. The run-time type of that object_134 ///_134 /// Iteration is stopped early if the callback function returns `false`._134 ///_134 /// The order of iteration is undefined._134 ///_134 /// If an object is stored under a new public path,_134 /// or an existing object is removed from a public path,_134 /// then the callback must stop iteration by returning false._134 /// Otherwise, iteration aborts._134 ///_134 access(all)_134 fun forEachPublic(_ function: fun(PublicPath, Type): Bool)_134_134 /// Iterate over all the stored paths of an account,_134 /// passing each path and type in turn to the provided callback function._134 ///_134 /// The callback function takes two arguments:_134 /// 1. The path of the stored object_134 /// 2. The run-time type of that object_134 ///_134 /// Iteration is stopped early if the callback function returns `false`._134 ///_134 /// If an object is stored under a new storage path,_134 /// or an existing object is removed from a storage path,_134 /// then the callback must stop iteration by returning false._134 /// Otherwise, iteration aborts._134 access(all)_134 fun forEachStored(_ function: fun (StoragePath, Type): Bool)_134}_134_134entitlement Storage_134_134entitlement SaveValue_134entitlement LoadValue_134entitlement CopyValue_134entitlement BorrowValue
Saving objects
_10access(Storage | SaveValue)_10fun save<T: Storable>(_ value: T, to: StoragePath)
The save function saves an object to account storage.
The function moves resources, and copies structures.
If there is already an object stored under the given path, the program aborts.
The path must be a storage path, it must have the domain storage.
T is the type parameter for the object type.
Cadence can infer this type parameter from the argument's type.
Getting object type information
_10access(all)_10view fun type(at path: StoragePath): Type?
The type function returns the type of the object stored under the given path,
or nil if the account does not store an object under the given path.
The function does not change the stored object.
The path must be a storage path, it must have the domain storage.
Removing objects
_10access(Storage | LoadValue)_10fun load<T: Storable>(from: StoragePath): T?
The load function loads an object from account storage.
If there is an object stored under the given path,
the function moves the stored resource or structure out of storage
and returns it as an optional.
If there is no object stored under the given path,
the function returns nil.
When the function returns with an object,
the storage no longer stores an object under the given path.
T is the type parameter for the object type.
Programs must explicitly provide a type argument for the parameter.
The type T must be a supertype of the type of the loaded object.
If it is not, the program aborts.
The given type does not necessarily need to be exactly the same as the type of the loaded object.
The path must be a storage path, it must have the domain storage.
Copying objects
_10access(Storage | CopyValue)_10view fun copy<T: AnyStruct>(from: StoragePath): T?
The copy function returns a copy of a structure stored in account storage,
without removing it from storage.
If there is a structure stored under the given path,
the function copies the stored structure and returns it as an optional.
If there is no structure stored under the given path,
the function returns nil.
When the function returns with an object,
the structure stays stored in storage after the function returns.
T is the type parameter for the structure type.
Programs must explicitly provide a type argument for the parameter.
The type T must be a supertype of the type of the copied structure.
If it is not, the program aborts.
The given type does not necessarily have to be exactly the same as the type of the copied structure.
The path must be a storage path, it must have the domain storage.
Accessing objects
_10access(Storage | BorrowValue)_10view fun borrow<T: &Any>(from: StoragePath): T?
The borrow function returns a reference to an objects stored in storage,
without removing the object from storage.
The function makes it convenient to work with objects in storage
without having to move them out of storage.
If there is a structure stored under the given path,
the function creates a reference to the object and returns the reference as an optional.
If there is no structure stored under the given path,
the function returns nil.
T is the type parameter for the object type.
Programs must explicitly provide a type argument for the parameter.
The type argument must be a reference to any type, &Any (Any is the supertype of all types).
The type T must be a supertype of the type of the borrowed object.
If it is not, the program aborts.
The given type does not necessarily have to be exactly the same as the type of the borrowed object.
The path must be a storage path, it must have the domain storage.
Example
_142// Declare a resource interface named `HasCount`, that has a field `count`_142//_142resource interface HasCount {_142 count: Int_142}_142_142// Declare a resource named `Counter` that conforms to `HasCount`_142//_142resource Counter: HasCount {_142 access(all)_142 var count: Int_142_142 access(all)_142 init(count: Int) {_142 self.count = count_142 }_142}_142_142// In this example, an authorized reference to an account_142// is available through the constant `account`._142_142// Create a new instance of the resource type `Counter`_142// and save it in the storage of the account._142//_142// The path `/storage/counter` is used to refer to the stored value._142// Its identifier `counter` was chosen freely and could be something else._142//_142account.storage.save(_142 <-create Counter(count: 42),_142 to: /storage/counter_142)_142_142// Run-time error: Storage already contains an object under path `/storage/counter`_142//_142account.storage.save(_142 <-create Counter(count: 123),_142 to: /storage/counter_142)_142_142// Load the `Counter` resource from storage path `/storage/counter`._142//_142// The new constant `counter` has the type `Counter?`, i.e., it is an optional,_142// and its value is the counter resource, that was saved at the beginning_142// of the example._142//_142let counter <- account.storage.load<@Counter>(from: /storage/counter)_142_142// The storage is now empty, there is no longer an object stored_142// under the path `/storage/counter`._142_142// Load the `Counter` resource again from storage path `/storage/counter`._142//_142// The new constant `counter2` has the type `Counter?` and is `nil`,_142// as nothing is stored under the path `/storage/counter` anymore,_142// because the previous load moved the counter out of storage._142//_142let counter2 <- account.storage.load<@Counter>(from: /storage/counter)_142_142// Create another new instance of the resource type `Counter`_142// and save it in the storage of the account._142//_142// The path `/storage/otherCounter` is used to refer to the stored value._142//_142account.storage.save(_142 <-create Counter(count: 123),_142 to: /storage/otherCounter_142)_142_142// Load the `Vault` resource from storage path `/storage/otherCounter`._142//_142// The new constant `vault` has the type `Vault?` and its value is `nil`,_142// as there is a resource with type `Counter` stored under the path,_142// which is not a subtype of the requested type `Vault`._142//_142let vault <- account.storage.load<@Vault>(from: /storage/otherCounter)_142_142// The storage still stores a `Counter` resource under the path `/storage/otherCounter`._142_142// Save the string "Hello, World" in storage_142// under the path `/storage/helloWorldMessage`._142_142account.storage.save(_142 "Hello, world!",_142 to: /storage/helloWorldMessage_142)_142_142// Copy the stored message from storage._142//_142// After the copy, the storage still stores the string under the path._142// Unlike `load`, `copy` does not remove the object from storage._142//_142let message = account.storage.copy<String>(from: /storage/helloWorldMessage)_142_142// Create a new instance of the resource type `Vault`_142// and save it in the storage of the account._142//_142account.storage.save(_142 <-createEmptyVault(),_142 to: /storage/vault_142)_142_142// Invalid: Cannot copy a resource, as this would allow arbitrary duplication._142//_142let vault <- account.storage.copy<@Vault>(from: /storage/vault)_142_142// Create a reference to the object stored under path `/storage/counter`,_142// typed as `&Counter`._142//_142// `counterRef` has type `&Counter?` and is a valid reference, i.e. non-`nil`,_142// because the borrow succeeded:_142//_142// There is an object stored under path `/storage/otherCounter`_142// and it has type `Counter`, so it can be borrowed as `&Counter`_142//_142let counterRef = account.storage.borrow<&Counter>(from: /storage/otherCounter)_142_142counterRef?.count // is `42`_142_142// Create a reference to the object stored under path `/storage/otherCounter`,_142// typed as `&{HasCount}`._142//_142// `hasCountRef` is non-`nil`, as there is an object stored under path `/storage/otherCounter`,_142// and the stored value of type `Counter` conforms to the requested type `{HasCount}`:_142// the type `Counter` implements the intersection type's interface `HasCount`_142_142let hasCountRef = account.storage.borrow<&{HasCount}>(from: /storage/otherCounter)_142_142// Create a reference to the object stored under path `/storage/otherCounter`,_142// typed as `&{SomethingElse}`._142//_142// `otherRef` is `nil`, as there is an object stored under path `/storage/otherCounter`,_142// but the stored value of type `Counter` does not conform to the requested type `{SomethingElse}`:_142// the type `Counter` does not implement the intersection type's interface `SomethingElse`_142_142let otherRef = account.storage.borrow<&{SomethingElse}>(from: /storage/otherCounter)_142_142// Create a reference to the object stored under path `/storage/nonExistent`,_142// typed as `&{HasCount}`._142//_142// `nonExistentRef` is `nil`, as there is nothing stored under path `/storage/nonExistent`_142//_142let nonExistentRef = account.storage.borrow<&{HasCount}>(from: /storage/nonExistent)
Iterating over stored objects
The following functions allow iterating over an account's storage:
_10fun forEachPublic(_ function: fun(PublicPath, Type): Bool)_10fun forEachStored(_ function: fun(StoragePath, Type): Bool)
The functions iterate over all stored objects in the particular domain, calling the callback function for each stored object, passing the path and the run-time type of the stored object.
The Bool value returned from the callback function determines whether iteration continues.
If the callback function returns true, iteration proceeds to the next stored object.
If the callback function returns false, the iteration function stops.
The specific order in which the objects are iterated over is undefined,
as is the behavior when a path is added or removed from storage.
The iteration functions skip broken objects.
An object could be broken due to invalid types associated with the stored value. For example, the contract for the stored object might have syntactic or semantic errors.
The order of iteration is undefined. Do not rely on any particular behavior.
Saving an object to a path or loading an object from storage during iteration can cause the order in which values are stored to change arbitrarily.
When a program continues to iterate after such an operation, the program aborts.
To avoid such errors, do not save objects to storage or load objects from storage during iteration.
If you do perform such an operation,
return false from the iteration callback to cause iteration to end after the mutation like so:
_17account.storage.save(1, to: /storage/foo1)_17account.storage.save(2, to: /storage/foo2)_17account.storage.save(3, to: /storage/foo3)_17account.storage.save("qux", to: /storage/foo4)_17_17account.storage.forEachStored(fun (path: StoragePath, type: Type): Bool {_17 if type == Type<String>() {_17 // Save a value to storage while iterating_17 account.storage.save("bar", to: /storage/foo5)_17_17 // Returning false here ends iteration after storage is modified,_17 // preventing the program from aborting_17 return false_17 }_17_17 return true_17})
Storage limit
An account's storage is limited by its storage capacity.
An account's storage used is the sum of the size of all the data that the account stores, in MB. An account's storage capacity is a value that is calculated from the amount of FLOW that is stored in the account's main FLOW token vault.
At the end of every transaction, the storage used is compared to the storage capacity. For all accounts involved in the transaction, if the account's storage used is greater than its storage capacity, the transaction fails.
An account exposes its storage used through the storage.used field,
and its storage capacity through the storage.capacity field.
The fields represent current values:
_13// Query the storage used before saving an object_13let storageUsedBefore = account.storage.used_13_13// Save a resource into storage_13account.storage.save(_13 <-create Counter(count: 123),_13 to: /storage/counter_13)_13_13// Query the storage used again after saving_13let storageUsedAfter = account.storage.used_13_13let storageUsedChanged = storageUsedAfter > storageUsedBefore // is true