Refactor AuthAccount and PublicAccount types to Cadence #2418

turbolent · 2023-04-03T21:47:39Z

Work towards #2293

Description

Refactor the AuthAccount and PublicAccount types, as well as their nested types (e.g. AuthAccount.Contracts) to Cadence.

Also, improve the docstrings and sync the definition with the documentation.

This makes it easier to change definitions, as well as easy to add new nested types, e.g. as going to be introduced by the Capability Controllers FLIP.

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

… types, to Cadence

SupunS

Nice!

SupunS · 2023-04-05T23:02:39Z

runtime/sema/authaccount.cdc

@@ -0,0 +1,297 @@
+
+pub struct AuthAccount {


github-actions · 2023-04-05T23:28:38Z

Cadence Benchstat comparison

This branch with compared with the base branch onflow:master commit 574c3ca
The command for i in {1..N}; do go test ./... -run=XXX -bench=. -benchmem -shuffle=on; done was used.
Bench tests were run a total of 7 times on each branch.

Collapsed results for better readability

	old.txt	new.txt
	time/op		delta
CheckContractInterfaceFungibleTokenConformance-2	119µs ± 0%	125µs ± 0%	~	(p=1.000 n=1+1)
ContractInterfaceFungibleToken-2	38.9µs ± 0%	38.5µs ± 0%	~	(p=1.000 n=1+1)
ExportType/composite_type-2	467ns ± 0%	353ns ± 0%	~	(p=1.000 n=1+1)
ExportType/simple_type-2	58.0ns ± 0%	52.9ns ± 0%	~	(p=1.000 n=1+1)
InterpretRecursionFib-2	2.44ms ± 0%	2.39ms ± 0%	~	(p=1.000 n=1+1)
NewInterpreter/new_interpreter-2	1.13µs ± 0%	1.12µs ± 0%	~	(p=1.000 n=1+1)
NewInterpreter/new_sub-interpreter-2	597ns ± 0%	607ns ± 0%	~	(p=1.000 n=1+1)
ParseArray-2	8.15ms ± 0%	9.10ms ± 0%	~	(p=1.000 n=1+1)
ParseDeploy/byte_array-2	12.2ms ± 0%	12.1ms ± 0%	~	(p=1.000 n=1+1)
ParseDeploy/decode_hex-2	1.22ms ± 0%	1.21ms ± 0%	~	(p=1.000 n=1+1)
ParseFungibleToken/With_memory_metering-2	193µs ± 0%	186µs ± 0%	~	(p=1.000 n=1+1)
ParseFungibleToken/Without_memory_metering-2	148µs ± 0%	148µs ± 0%	~	(p=1.000 n=1+1)
ParseInfix-2	7.01µs ± 0%	7.05µs ± 0%	~	(p=1.000 n=1+1)
QualifiedIdentifierCreation/One_level-2	2.35ns ± 0%	2.34ns ± 0%	~	(p=1.000 n=1+1)
QualifiedIdentifierCreation/Three_levels-2	133ns ± 0%	133ns ± 0%	~	(p=1.000 n=1+1)
RuntimeResourceDictionaryValues-2	5.39ms ± 0%	5.15ms ± 0%	~	(p=1.000 n=1+1)
RuntimeScriptNoop-2	4.03µs ± 0%	7.31µs ± 0%	~	(p=1.000 n=1+1)
SuperTypeInference/arrays-2	335ns ± 0%	306ns ± 0%	~	(p=1.000 n=1+1)
SuperTypeInference/composites-2	135ns ± 0%	134ns ± 0%	~	(p=1.000 n=1+1)
SuperTypeInference/integers-2	98.7ns ± 0%	96.3ns ± 0%	~	(p=1.000 n=1+1)
ValueIsSubtypeOfSemaType-2	93.9ns ± 0%	94.9ns ± 0%	~	(p=1.000 n=1+1)

	alloc/op		delta
CheckContractInterfaceFungibleTokenConformance-2	48.9kB ± 0%	48.9kB ± 0%	~	(all equal)
ContractInterfaceFungibleToken-2	23.2kB ± 0%	23.2kB ± 0%	~	(all equal)
ExportType/composite_type-2	136B ± 0%	136B ± 0%	~	(all equal)
ExportType/simple_type-2	0.00B	0.00B	~	(all equal)
InterpretRecursionFib-2	1.00MB ± 0%	1.00MB ± 0%	~	(p=1.000 n=1+1)
NewInterpreter/new_interpreter-2	768B ± 0%	768B ± 0%	~	(all equal)
NewInterpreter/new_sub-interpreter-2	200B ± 0%	200B ± 0%	~	(all equal)
ParseArray-2	2.73MB ± 0%	2.80MB ± 0%	~	(p=1.000 n=1+1)
ParseDeploy/byte_array-2	4.27MB ± 0%	4.09MB ± 0%	~	(p=1.000 n=1+1)
ParseDeploy/decode_hex-2	214kB ± 0%	214kB ± 0%	~	(p=1.000 n=1+1)
ParseFungibleToken/With_memory_metering-2	28.9kB ± 0%	28.9kB ± 0%	~	(p=1.000 n=1+1)
ParseFungibleToken/Without_memory_metering-2	28.9kB ± 0%	28.9kB ± 0%	~	(all equal)
ParseInfix-2	1.91kB ± 0%	1.92kB ± 0%	~	(p=1.000 n=1+1)
QualifiedIdentifierCreation/One_level-2	0.00B	0.00B	~	(all equal)
QualifiedIdentifierCreation/Three_levels-2	64.0B ± 0%	64.0B ± 0%	~	(all equal)
RuntimeResourceDictionaryValues-2	2.28MB ± 0%	2.28MB ± 0%	~	(p=1.000 n=1+1)
RuntimeScriptNoop-2	2.70kB ± 0%	2.70kB ± 0%	~	(all equal)
SuperTypeInference/arrays-2	96.0B ± 0%	96.0B ± 0%	~	(all equal)
SuperTypeInference/composites-2	0.00B	0.00B	~	(all equal)
SuperTypeInference/integers-2	0.00B	0.00B	~	(all equal)
ValueIsSubtypeOfSemaType-2	48.0B ± 0%	48.0B ± 0%	~	(all equal)

	allocs/op		delta
CheckContractInterfaceFungibleTokenConformance-2	806 ± 0%	806 ± 0%	~	(all equal)
ContractInterfaceFungibleToken-2	370 ± 0%	370 ± 0%	~	(all equal)
ExportType/composite_type-2	3.00 ± 0%	3.00 ± 0%	~	(all equal)
ExportType/simple_type-2	0.00	0.00	~	(all equal)
InterpretRecursionFib-2	18.9k ± 0%	18.9k ± 0%	~	(all equal)
NewInterpreter/new_interpreter-2	13.0 ± 0%	13.0 ± 0%	~	(all equal)
NewInterpreter/new_sub-interpreter-2	4.00 ± 0%	4.00 ± 0%	~	(all equal)
ParseArray-2	59.6k ± 0%	59.6k ± 0%	~	(all equal)
ParseDeploy/byte_array-2	89.4k ± 0%	89.4k ± 0%	~	(all equal)
ParseDeploy/decode_hex-2	63.0 ± 0%	63.0 ± 0%	~	(all equal)
ParseFungibleToken/With_memory_metering-2	768 ± 0%	768 ± 0%	~	(all equal)
ParseFungibleToken/Without_memory_metering-2	768 ± 0%	768 ± 0%	~	(all equal)
ParseInfix-2	48.0 ± 0%	48.0 ± 0%	~	(all equal)
QualifiedIdentifierCreation/One_level-2	0.00	0.00	~	(all equal)
QualifiedIdentifierCreation/Three_levels-2	2.00 ± 0%	2.00 ± 0%	~	(all equal)
RuntimeResourceDictionaryValues-2	36.9k ± 0%	36.9k ± 0%	~	(all equal)
RuntimeScriptNoop-2	43.0 ± 0%	43.0 ± 0%	~	(all equal)
SuperTypeInference/arrays-2	3.00 ± 0%	3.00 ± 0%	~	(all equal)
SuperTypeInference/composites-2	0.00	0.00	~	(all equal)
SuperTypeInference/integers-2	0.00	0.00	~	(all equal)
ValueIsSubtypeOfSemaType-2	1.00 ± 0%	1.00 ± 0%	~	(all equal)

codecov · 2023-04-05T23:36:24Z

Codecov Report

Merging #2418 (8288421) into master (c77f9af) will decrease coverage by 0.10%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master    #2418      +/-   ##
==========================================
- Coverage   78.60%   78.51%   -0.10%     
==========================================
  Files         316      314       -2     
  Lines       68994    68669     -325     
==========================================
- Hits        54236    53914     -322     
+ Misses      12953    12949       -4     
- Partials     1805     1806       +1

Flag	Coverage Δ
unittests	`78.51% <100.00%> (-0.10%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
runtime/stdlib/flow.go	`86.66% <ø> (ø)`
runtime/interpreter/account.go	`93.16% <100.00%> (+0.30%)`	⬆️
runtime/interpreter/accountcontracts.go	`77.46% <100.00%> (ø)`
runtime/interpreter/accountinbox.go	`73.07% <100.00%> (ø)`
runtime/interpreter/accountkeys.go	`74.19% <100.00%> (ø)`
runtime/interpreter/interpreter.go	`89.78% <100.00%> (ø)`
runtime/sema/authaccount.gen.go	`100.00% <100.00%> (ø)`
runtime/sema/authaccount.go	`100.00% <100.00%> (ø)`
runtime/sema/publicaccount.gen.go	`100.00% <100.00%> (ø)`
runtime/stdlib/account.go	`86.81% <100.00%> (+0.13%)`	⬆️

... and 1 file with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

turbolent added 2 commits April 3, 2023 14:00

refactor AuthAccount and PublicAccount types, as well as their nested…

32e8af8

… types, to Cadence

update documentation

6fa530e

turbolent added the Improvement label Apr 3, 2023

turbolent self-assigned this Apr 3, 2023

turbolent requested review from SupunS, dsainati1 and joshuahannan as code owners April 3, 2023 21:47

dsainati1 approved these changes Apr 4, 2023

View reviewed changes

remove old code

8288421

This was referenced Apr 4, 2023

Add Auth/PublicAccount.Storage/AccountCapabilities #2422

Merged

Add ID field to Capability type and value #2424

Merged

SupunS approved these changes Apr 5, 2023

View reviewed changes

runtime/sema/authaccount.cdc

@@ -0,0 +1,297 @@

pub struct AuthAccount {

Copy link

Member

SupunS Apr 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😍

Base automatically changed from bastian/nested-type-code-generation to master April 5, 2023 23:23

turbolent closed this Apr 5, 2023

turbolent reopened this Apr 5, 2023

turbolent enabled auto-merge April 5, 2023 23:25

turbolent disabled auto-merge April 6, 2023 00:00

turbolent merged commit 347953b into master Apr 6, 2023
14 of 16 checks passed

turbolent deleted the bastian/refactor-account-types branch April 6, 2023 00:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor AuthAccount and PublicAccount types to Cadence #2418

Refactor AuthAccount and PublicAccount types to Cadence #2418

turbolent commented Apr 3, 2023 •

edited

SupunS left a comment

SupunS Apr 5, 2023

github-actions bot commented Apr 5, 2023

codecov bot commented Apr 5, 2023

Refactor AuthAccount and PublicAccount types to Cadence #2418

Refactor AuthAccount and PublicAccount types to Cadence #2418

Conversation

turbolent commented Apr 3, 2023 • edited

Description

SupunS left a comment

Choose a reason for hiding this comment

SupunS Apr 5, 2023

Choose a reason for hiding this comment

github-actions bot commented Apr 5, 2023

Cadence Benchstat comparison

codecov bot commented Apr 5, 2023

Codecov Report

turbolent commented Apr 3, 2023 •

edited