Add guard statement by turbolent · Pull Request #4432 · onflow/cadence

turbolent · 2026-02-06T16:30:49Z

Description

Implement FLIP 355: Cadence Guard Statement

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 · 2026-02-06T16:31:03Z

Dependency Review

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

Scanned Files

None

github-actions · 2026-02-06T16:39:05Z

Benchstat comparison

Base branch: onflow:master
Base commit: ac5e83e

Results

	old.txt	new.txt
	time/op		delta
pkg:github.com/onflow/cadence/bbq/compiler goos:linux goarch:amd64
CompileFungibleTokenTransferTransaction-4	128µs ± 0%	127µs ± 0%	~	(p=1.000 n=1+1)
CompileTime-4	36.2µs ± 0%	35.5µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/runtime goos:linux goarch:amd64
ContractFunctionInvocation-4	409µs ± 0%	408µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
ContractImport-4	222µs ± 0%	219µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
Emit-4	4.55ms ± 0%	4.49ms ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/runtime goos:linux goarch:amd64
ExportType/composite_type-4	271ns ± 0%	266ns ± 0%	~	(p=1.000 n=1+1)
ExportType/simple_type-4	78.0ns ± 0%	77.9ns ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
FTTransfer-4	165µs ± 0%	166µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/sema goos:linux goarch:amd64
FlowTokenContract-4	605µs ± 0%	597µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
ImperativeFib-4	23.6µs ± 0%	22.9µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
ImperativeFib-4	24.0µs ± 0%	24.7µs ± 0%	~	(p=1.000 n=1+1)
ImperativeFibNewCompilerNewVM-4	48.6µs ± 0%	49.3µs ± 0%	~	(p=1.000 n=1+1)
ImperativeFibNewVM-4	27.1µ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.20ms ± 0%	2.22ms ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
InterpreterFTTransfer-4	147µs ± 0%	142µs ± 0%	~	(p=1.000 n=1+1)
InterpreterImperativeFib-4	23.0µs ± 0%	22.7µs ± 0%	~	(p=1.000 n=1+1)
InterpreterNewStruct-4	66.6µs ± 0%	66.7µs ± 0%	~	(p=1.000 n=1+1)
MethodCall/concrete_type_method_call-4	41.7µs ± 0%	41.5µs ± 0%	~	(p=1.000 n=1+1)
MethodCall/interface_method_call-4	64.5µs ± 0%	63.7µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
NewInterpreter/new_interpreter-4	837ns ± 0%	897ns ± 0%	~	(p=1.000 n=1+1)
NewInterpreter/new_sub-interpreter-4	315ns ± 0%	326ns ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
NewResource-4	98.7µs ± 0%	99.5µs ± 0%	~	(p=1.000 n=1+1)
NewStruct-4	43.8µs ± 0%	43.8µs ± 0%	~	(p=1.000 n=1+1)
NewStructRaw-4	3.62µs ± 0%	3.75µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/parser goos:linux goarch:amd64
ParseArray-4	6.08ms ± 0%	6.20ms ± 0%	~	(p=1.000 n=1+1)
ParseDeploy/byte_array-4	8.87ms ± 0%	8.85ms ± 0%	~	(p=1.000 n=1+1)
ParseDeploy/decode_hex-4	929µs ± 0%	930µs ± 0%	~	(p=1.000 n=1+1)
ParseFungibleToken/With_memory_metering-4	162µs ± 0%	164µs ± 0%	~	(p=1.000 n=1+1)
ParseFungibleToken/Without_memory_metering-4	118µs ± 0%	117µs ± 0%	~	(p=1.000 n=1+1)
ParseInfix-4	5.11µs ± 0%	5.16µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/sema goos:linux goarch:amd64
QualifiedIdentifierCreation/One_level-4	1.87ns ± 0%	2.49ns ± 0%	~	(p=1.000 n=1+1)
QualifiedIdentifierCreation/Three_levels-4	80.5ns ± 0%	81.0ns ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
RecursionFib-4	1.40ms ± 0%	1.35ms ± 0%	~	(p=1.000 n=1+1)
RuntimeFungibleTokenTransfer-4	758µs ± 0%	748µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/runtime goos:linux goarch:amd64
RuntimeFungibleTokenTransferInterpreter-4	637µs ± 0%	618µs ± 0%	~	(p=1.000 n=1+1)
RuntimeFungibleTokenTransferVM-4	706µs ± 0%	702µs ± 0%	~	(p=1.000 n=1+1)
RuntimeResourceDictionaryValues-4	2.67ms ± 0%	2.65ms ± 0%	~	(p=1.000 n=1+1)
RuntimeResourceTracking-4	11.0ms ± 0%	11.5ms ± 0%	~	(p=1.000 n=1+1)
RuntimeScriptNoop-4	14.2µs ± 0%	14.8µs ± 0%	~	(p=1.000 n=1+1)
RuntimeVMInvokeContractImperativeFib-4	41.1µs ± 0%	40.7µs ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/sema goos:linux goarch:amd64
SuperTypeInference/arrays-4	223ns ± 0%	224ns ± 0%	~	(p=1.000 n=1+1)
SuperTypeInference/composites-4	95.6ns ± 0%	93.8ns ± 0%	~	(p=1.000 n=1+1)
SuperTypeInference/integers-4	318ns ± 0%	323ns ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
ValueIsSubtypeOfSemaType-4	61.4ns ± 0%	59.5ns ± 0%	~	(p=1.000 n=1+1)

	alloc/op		delta
pkg:github.com/onflow/cadence/bbq/compiler goos:linux goarch:amd64
CompileFungibleTokenTransferTransaction-4	81.9kB ± 0%	81.9kB ± 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	153kB ± 0%	153kB ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
ContractImport-4	80.0kB ± 0%	80.1kB ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
Emit-4	1.49MB ± 0%	1.49MB ± 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%	~	(p=1.000 n=1+1)
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%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
InterpreterFTTransfer-4	50.6kB ± 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.6kB ± 0%	~	(p=1.000 n=1+1)
MethodCall/concrete_type_method_call-4	10.2kB ± 0%	10.2kB ± 0%	~	(p=1.000 n=1+1)
MethodCall/interface_method_call-4	17.7kB ± 0%	17.7kB ± 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%	~	(p=1.000 n=1+1)
NewStruct-4	12.9kB ± 0%	13.0kB ± 0%	~	(p=1.000 n=1+1)
NewStructRaw-4	2.60kB ± 0%	2.57kB ± 0%	~	(p=1.000 n=1+1)
pkg:github.com/onflow/cadence/parser goos:linux goarch:amd64
ParseArray-4	2.77MB ± 0%	2.66MB ± 0%	~	(p=1.000 n=1+1)
ParseDeploy/byte_array-4	4.13MB ± 0%	4.13MB ± 0%	~	(p=1.000 n=1+1)
ParseDeploy/decode_hex-4	214kB ± 0%	214kB ± 0%	~	(p=1.000 n=1+1)
ParseFungibleToken/With_memory_metering-4	30.3kB ± 0%	30.3kB ± 0%	~	(p=1.000 n=1+1)
ParseFungibleToken/Without_memory_metering-4	30.3kB ± 0%	30.3kB ± 0%	~	(p=1.000 n=1+1)
ParseInfix-4	1.92kB ± 0%	1.92kB ± 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%	170kB ± 0%	~	(p=1.000 n=1+1)
RuntimeFungibleTokenTransferVM-4	192kB ± 0%	192kB ± 0%	~	(p=1.000 n=1+1)
RuntimeResourceDictionaryValues-4	1.77MB ± 0%	1.77MB ± 0%	~	(p=1.000 n=1+1)
RuntimeResourceTracking-4	8.62MB ± 0%	8.62MB ± 0%	~	(p=1.000 n=1+1)
RuntimeScriptNoop-4	8.06kB ± 0%	8.05kB ± 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/bbq/compiler goos:linux goarch:amd64
CompileFungibleTokenTransferTransaction-4	559 ± 0%	559 ± 0%	~	(all equal)
CompileTime-4	202 ± 0%	202 ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/runtime goos:linux goarch:amd64
ContractFunctionInvocation-4	2.47k ± 0%	2.47k ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/bbq/vm/test goos:linux goarch:amd64
ContractImport-4	1.30k ± 0%	1.30k ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/interpreter goos:linux goarch:amd64
Emit-4	40.0k ± 0%	40.0k ± 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	334 ± 0%	334 ± 0%	~	(all equal)
MethodCall/interface_method_call-4	494 ± 0%	494 ± 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	38.0 ± 0%	38.0 ± 0%	~	(all equal)
pkg:github.com/onflow/cadence/parser goos:linux goarch:amd64
ParseArray-4	59.6k ± 0%	59.6k ± 0%	~	(p=1.000 n=1+1)
ParseDeploy/byte_array-4	89.4k ± 0%	89.4k ± 0%	~	(p=1.000 n=1+1)
ParseDeploy/decode_hex-4	64.0 ± 0%	64.0 ± 0%	~	(all equal)
ParseFungibleToken/With_memory_metering-4	786 ± 0%	786 ± 0%	~	(all equal)
ParseFungibleToken/Without_memory_metering-4	786 ± 0%	786 ± 0%	~	(all equal)
ParseInfix-4	48.0 ± 0%	48.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.72k ± 0%	3.72k ± 0%	~	(all equal)
RuntimeResourceDictionaryValues-4	36.7k ± 0%	36.7k ± 0%	~	(all equal)
RuntimeResourceTracking-4	144k ± 0%	144k ± 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)

turbolent added 8 commits February 5, 2026 15:52

add AST node for guard statement

4808555

implement new visitor method

7a9445b

adjust old parser

c882fbe

parse guard statements

a01f587

type check guard statements

0257190

interpret guard statements

863e484

compile guard statements

d6131bf

add more tests

4fac0d0

turbolent self-assigned this Feb 6, 2026

turbolent requested review from RZhang05 and SupunS as code owners February 6, 2026 16:30

turbolent added the Feature label Feb 6, 2026

turbolent added 2 commits February 6, 2026 08:45

Merge branch 'master' into bastian/guard-statement

23157ec

fix lint

acd06d0

turbolent mentioned this pull request Feb 6, 2026

FLIP 355: Cadence Guard Statement onflow/flips#355

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add guard statement#4432

Add guard statement#4432
turbolent wants to merge 10 commits intomasterfrom
bastian/guard-statement

turbolent commented Feb 6, 2026

Uh oh!

github-actions bot commented Feb 6, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Feb 6, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

turbolent commented Feb 6, 2026

Description

Uh oh!

github-actions bot commented Feb 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Dependency Review

Scanned Files

Uh oh!

github-actions bot commented Feb 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Benchstat comparison

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

github-actions bot commented Feb 6, 2026 •

edited

Loading

github-actions bot commented Feb 6, 2026 •

edited

Loading