Naming convention

[fredo]

We are facing confusions because we do not have proper naming. This results in confusion during discussions, naming in code is not consistent and we are transporting inner workings to the public in the engine room release with our explorer.
I suggest we come up with consistent naming.

I'll start a list below. Please feel free to add other objects/processes which we should name and feel free to add suggestions.

General

• Overall shutterized flow

Components

• SubmitEncryptedTransaction
• Plain text transaction
• inclusion time
• identity

States

• not found
• pending encrypted transaction
• submitted
• released keys
• included/executed

Suggestions

General

• Overall shutterized flow -> Shielded Transaction (derived from the marketing rebranding)

Components

• SubmitEncryptedTransaction -> Encrypted Transaction / Submission Transaction
• Plain text transaction -> User Transaction / User Operation
• inclusion time

States

• not found
• pending encrypted transaction
• submitted
• released keys
• included/executed

[fredo]

Current Votes

Overall Flow

Shielded Transaction Flow 5

SubmitEncryptedTransaction Call

Encrypted Transaction 2
Encrypted Mempool Transaction 1
Submission Transaction 1
Sequencer Transaction 2

Encrypted data (call data of the above)

encrypted data 1
encrypted User Transaction 4

The user's transaction

User Transaction 5

Decided

Happy Case States

Not Found
Pending Encrypted Transaction
Submitted
Pending User Transaction
Included