Add Account.Storage.limitedToPaths

[turbolent]

Work towards #4314

Description

Add a new function access(Storage) fun limitedToPaths(_ paths: [Path]): auth(Storage) &Account.Storage to Account.Storage, that returns a reference to a new Account.Storage value that restricts all operations to the given paths (allowlist).

• load/borrow/copy on a non-allowed path return nil
• check on a non-allowed path returns false
• type on a non-allowed path returns nil
• save to a non-allowed path aborts with an error
• forEachStored/forEachPublic only iterate over allowed paths
• storagePaths/publicPaths only contain paths that are allowed

Calling limitedToPaths on existing limited storage value returns an even more restricted storage value, i.e. the set of allowed paths is the intersection of the existing and new path sets.

Passing an empty array pf paths blocks all paths (distinct from unlimited).

---

• Targeted PR against master branch
• Linked to Github issue with discussion and accepted design OR link to spec that describes this work
• Code follows the standards mentioned here
• Updated relevant documentation
• Re-reviewed Files changed in the Github PR explorer
• Added appropriate labels

[github-actions]

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

[github-actions]

Benchstat comparison

• Base branch: onflow:master
• Base commit: 6e7bbb2

Results

	old.txt	new.txt
	time/op		delta
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
ByteArrayTransfer-4	1.33µs ± 0%	1.21µs ± 0%	~	(p=1.000 n=1+1)
ByteArrayValueToByteSlice-4	87.2ns ± 0%	81.9ns ± 0%	~	(p=1.000 n=1+1)
ByteSliceToByteArrayValue-4	928ns ± 0%	980ns ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/bbq/compiler goos:linux goarch:amd64
CompileFungibleTokenTransferTransaction-4	129µs ± 0%	135µs ± 0%	~	(p=1.000 n=1+1)
CompileTime-4	37.5µs ± 0%	38.2µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/runtime goos:linux goarch:amd64
ContractFunctionInvocation-4	409µs ± 0%	413µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
ContractImport-4	216µs ± 0%	220µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
EMVAddressTransfer-4	3.46µs ± 0%	3.46µs ± 0%	~	(p=1.000 n=1+1)
Emit-4	4.53ms ± 0%	4.76ms ± 0%	~	(p=1.000 n=1+1)
EnumTransfer-4	1.36µs ± 0%	1.48µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/runtime goos:linux goarch:amd64
ExportType/composite_type-4	266ns ± 0%	269ns ± 0%	~	(p=1.000 n=1+1)
ExportType/simple_type-4	77.7ns ± 0%	77.6ns ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
FTTransfer-4	176µs ± 0%	177µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/sema goos:linux goarch:amd64
FlowTokenContract-4	618µs ± 0%	618µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
ImperativeFib-4	23.1µs ± 0%	23.9µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
ImperativeFib-4	24.8µs ± 0%	25.1µs ± 0%	~	(p=1.000 n=1+1)
ImperativeFibNewCompilerNewVM-4	50.1µs ± 0%	49.8µs ± 0%	~	(p=1.000 n=1+1)
ImperativeFibNewVM-4	28.3µs ± 0%	28.3µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
InterpretRecursionFib-4	2.30ms ± 0%	2.28ms ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
InterpreterFTTransfer-4	150µs ± 0%	149µs ± 0%	~	(p=1.000 n=1+1)
InterpreterImperativeFib-4	23.2µs ± 0%	23.0µs ± 0%	~	(p=1.000 n=1+1)
InterpreterNewStruct-4	65.0µs ± 0%	65.8µs ± 0%	~	(p=1.000 n=1+1)
MethodCall/concrete_type_method_call-4	42.0µs ± 0%	40.9µs ± 0%	~	(p=1.000 n=1+1)
MethodCall/interface_method_call-4	66.2µs ± 0%	66.8µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
NewInterpreter/new_interpreter-4	867ns ± 0%	867ns ± 0%	~	(p=1.000 n=1+1)
NewInterpreter/new_sub-interpreter-4	323ns ± 0%	327ns ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
NewResource-4	101µs ± 0%	102µs ± 0%	~	(p=1.000 n=1+1)
NewStruct-4	43.4µs ± 0%	42.0µs ± 0%	~	(p=1.000 n=1+1)
NewStructRaw-4	3.22µs ± 0%	3.26µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/sema goos:linux goarch:amd64
QualifiedIdentifierCreation/One_level-4	2.49ns ± 0%	1.86ns ± 0%	~	(p=1.000 n=1+1)
QualifiedIdentifierCreation/Three_levels-4	90.0ns ± 0%	82.7ns ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
RecursionFib-4	1.38ms ± 0%	1.41ms ± 0%	~	(p=1.000 n=1+1)
RuntimeFungibleTokenTransfer-4	786µs ± 0%	793µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/runtime goos:linux goarch:amd64
RuntimeFungibleTokenTransferInterpreter-4	635µs ± 0%	630µs ± 0%	~	(p=1.000 n=1+1)
RuntimeFungibleTokenTransferVM-4	690µs ± 0%	720µs ± 0%	~	(p=1.000 n=1+1)
RuntimeResourceDictionaryValues-4	2.69ms ± 0%	2.73ms ± 0%	~	(p=1.000 n=1+1)
RuntimeResourceTracking-4	10.0ms ± 0%	10.1ms ± 0%	~	(p=1.000 n=1+1)
RuntimeScriptNoop-4	15.0µs ± 0%	15.7µs ± 0%	~	(p=1.000 n=1+1)
RuntimeVMInvokeContractImperativeFib-4	40.0µs ± 0%	41.3µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/sema goos:linux goarch:amd64
SuperTypeInference/arrays-4	225ns ± 0%	236ns ± 0%	~	(p=1.000 n=1+1)
SuperTypeInference/composites-4	91.3ns ± 0%	94.0ns ± 0%	~	(p=1.000 n=1+1)
SuperTypeInference/integers-4	319ns ± 0%	313ns ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
ValueIsSubtypeOfSemaType-4	69.3ns ± 0%	59.2ns ± 0%	~	(p=1.000 n=1+1)
	alloc/op		delta
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
ByteArrayTransfer-4	1.07kB ± 0%	1.08kB ± 0%	~	(p=1.000 n=1+1)
ByteArrayValueToByteSlice-4	32.0B ± 0%	32.0B ± 0%	~	(all equal)
ByteSliceToByteArrayValue-4	853B ± 0%	850B ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/bbq/compiler goos:linux goarch:amd64
CompileFungibleTokenTransferTransaction-4	82.2kB ± 0%	82.2kB ± 0%	~	(p=1.000 n=1+1)
CompileTime-4	16.6kB ± 0%	16.6kB ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/runtime goos:linux goarch:amd64
ContractFunctionInvocation-4	146kB ± 0%	146kB ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
ContractImport-4	73.5kB ± 0%	73.5kB ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
EMVAddressTransfer-4	2.46kB ± 0%	2.45kB ± 0%	~	(p=1.000 n=1+1)
Emit-4	1.49MB ± 0%	1.50MB ± 0%	~	(p=1.000 n=1+1)
EnumTransfer-4	831B ± 0%	868B ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/runtime goos:linux goarch:amd64
ExportType/composite_type-4	120B ± 0%	120B ± 0%	~	(all equal)
ExportType/simple_type-4	0.00B	0.00B	~	(all equal)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
FTTransfer-4	53.4kB ± 0%	53.4kB ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/sema goos:linux goarch:amd64
FlowTokenContract-4	223kB ± 0%	223kB ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
ImperativeFib-4	8.30kB ± 0%	8.30kB ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
ImperativeFib-4	5.34kB ± 0%	5.34kB ± 0%	~	(all equal)
ImperativeFibNewCompilerNewVM-4	25.7kB ± 0%	25.7kB ± 0%	~	(all equal)
ImperativeFibNewVM-4	8.07kB ± 0%	8.07kB ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
InterpretRecursionFib-4	1.19MB ± 0%	1.19MB ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
InterpreterFTTransfer-4	50.7kB ± 0%	50.7kB ± 0%	~	(p=1.000 n=1+1)
InterpreterImperativeFib-4	8.29kB ± 0%	8.29kB ± 0%	~	(all equal)
InterpreterNewStruct-4	24.5kB ± 0%	24.4kB ± 0%	~	(p=1.000 n=1+1)
MethodCall/concrete_type_method_call-4	9.39kB ± 0%	9.35kB ± 0%	~	(p=1.000 n=1+1)
MethodCall/interface_method_call-4	16.8kB ± 0%	16.8kB ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
NewInterpreter/new_interpreter-4	976B ± 0%	976B ± 0%	~	(all equal)
NewInterpreter/new_sub-interpreter-4	232B ± 0%	232B ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
NewResource-4	43.3kB ± 0%	43.3kB ± 0%	~	(all equal)
NewStruct-4	13.1kB ± 0%	12.9kB ± 0%	~	(p=1.000 n=1+1)
NewStructRaw-4	1.70kB ± 0%	1.70kB ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/sema goos:linux goarch:amd64
QualifiedIdentifierCreation/One_level-4	0.00B	0.00B	~	(all equal)
QualifiedIdentifierCreation/Three_levels-4	64.0B ± 0%	64.0B ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
RecursionFib-4	244kB ± 0%	244kB ± 0%	~	(p=1.000 n=1+1)
RuntimeFungibleTokenTransfer-4	247kB ± 0%	247kB ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/runtime goos:linux goarch:amd64
RuntimeFungibleTokenTransferInterpreter-4	170kB ± 0%	171kB ± 0%	~	(p=1.000 n=1+1)
RuntimeFungibleTokenTransferVM-4	192kB ± 0%	192kB ± 0%	~	(p=1.000 n=1+1)
RuntimeResourceDictionaryValues-4	1.76MB ± 0%	1.77MB ± 0%	~	(p=1.000 n=1+1)
RuntimeResourceTracking-4	6.99MB ± 0%	6.98MB ± 0%	~	(p=1.000 n=1+1)
RuntimeScriptNoop-4	8.05kB ± 0%	8.07kB ± 0%	~	(p=1.000 n=1+1)
RuntimeVMInvokeContractImperativeFib-4	13.3kB ± 0%	13.3kB ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/sema goos:linux goarch:amd64
SuperTypeInference/arrays-4	72.0B ± 0%	72.0B ± 0%	~	(all equal)
SuperTypeInference/composites-4	0.00B	0.00B	~	(all equal)
SuperTypeInference/integers-4	0.00B	0.00B	~	(all equal)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
ValueIsSubtypeOfSemaType-4	32.0B ± 0%	32.0B ± 0%	~	(all equal)
	allocs/op		delta
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
ByteArrayTransfer-4	7.00 ± 0%	7.00 ± 0%	~	(all equal)
ByteArrayValueToByteSlice-4	1.00 ± 0%	1.00 ± 0%	~	(all equal)
ByteSliceToByteArrayValue-4	5.00 ± 0%	5.00 ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/bbq/compiler goos:linux goarch:amd64
CompileFungibleTokenTransferTransaction-4	563 ± 0%	563 ± 0%	~	(all equal)
CompileTime-4	202 ± 0%	202 ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/runtime goos:linux goarch:amd64
ContractFunctionInvocation-4	2.42k ± 0%	2.42k ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
ContractImport-4	1.25k ± 0%	1.25k ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
EMVAddressTransfer-4	29.0 ± 0%	29.0 ± 0%	~	(all equal)
Emit-4	40.0k ± 0%	40.0k ± 0%	~	(all equal)
EnumTransfer-4	13.0 ± 0%	13.0 ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/runtime goos:linux goarch:amd64
ExportType/composite_type-4	3.00 ± 0%	3.00 ± 0%	~	(all equal)
ExportType/simple_type-4	0.00	0.00	~	(all equal)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
FTTransfer-4	1.58k ± 0%	1.58k ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/sema goos:linux goarch:amd64
FlowTokenContract-4	3.58k ± 0%	3.58k ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
ImperativeFib-4	176 ± 0%	176 ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
ImperativeFib-4	262 ± 0%	262 ± 0%	~	(all equal)
ImperativeFibNewCompilerNewVM-4	470 ± 0%	470 ± 0%	~	(all equal)
ImperativeFibNewVM-4	306 ± 0%	306 ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
InterpretRecursionFib-4	17.7k ± 0%	17.7k ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
InterpreterFTTransfer-4	1.11k ± 0%	1.11k ± 0%	~	(all equal)
InterpreterImperativeFib-4	175 ± 0%	175 ± 0%	~	(all equal)
InterpreterNewStruct-4	418 ± 0%	418 ± 0%	~	(all equal)
MethodCall/concrete_type_method_call-4	328 ± 0%	328 ± 0%	~	(all equal)
MethodCall/interface_method_call-4	488 ± 0%	488 ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
NewInterpreter/new_interpreter-4	15.0 ± 0%	15.0 ± 0%	~	(all equal)
NewInterpreter/new_sub-interpreter-4	4.00 ± 0%	4.00 ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
NewResource-4	919 ± 0%	919 ± 0%	~	(all equal)
NewStruct-4	364 ± 0%	364 ± 0%	~	(all equal)
NewStructRaw-4	30.0 ± 0%	30.0 ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/sema goos:linux goarch:amd64
QualifiedIdentifierCreation/One_level-4	0.00	0.00	~	(all equal)
QualifiedIdentifierCreation/Three_levels-4	2.00 ± 0%	2.00 ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
RecursionFib-4	13.4k ± 0%	13.4k ± 0%	~	(all equal)
RuntimeFungibleTokenTransfer-4	4.28k ± 0%	4.28k ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/runtime goos:linux goarch:amd64
RuntimeFungibleTokenTransferInterpreter-4	3.27k ± 0%	3.27k ± 0%	~	(all equal)
RuntimeFungibleTokenTransferVM-4	3.73k ± 0%	3.73k ± 0%	~	(all equal)
RuntimeResourceDictionaryValues-4	36.7k ± 0%	36.7k ± 0%	~	(all equal)
RuntimeResourceTracking-4	129k ± 0%	129k ± 0%	~	(all equal)
RuntimeScriptNoop-4	114 ± 0%	114 ± 0%	~	(all equal)
RuntimeVMInvokeContractImperativeFib-4	424 ± 0%	424 ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/sema goos:linux goarch:amd64
SuperTypeInference/arrays-4	3.00 ± 0%	3.00 ± 0%	~	(all equal)
SuperTypeInference/composites-4	0.00	0.00	~	(all equal)
SuperTypeInference/integers-4	0.00	0.00	~	(all equal)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
ValueIsSubtypeOfSemaType-4	1.00 ± 0%	1.00 ± 0%	~	(all equal)