Skip to content
This repository has been archived by the owner on Jan 24, 2024. It is now read-only.

Standardize language around deposits #61

Closed
maurelian opened this issue Dec 9, 2021 · 4 comments
Closed

Standardize language around deposits #61

maurelian opened this issue Dec 9, 2021 · 4 comments
Labels

Comments

@maurelian
Copy link
Collaborator

An item that came up here:

We have a lot of things using the term deposit, that are similar but different. It's kind of painful

  • Deposit
  • Deposit transaction
  • Deposit transaction type
  • L1 Transaction Deposits (Transaction)
  • L1 Attributes Deposits (Transaction)
@maurelian maurelian mentioned this issue Dec 9, 2021
3 tasks
@norswap
Copy link
Contributor

norswap commented Dec 10, 2021

There are two "axes of confusion":

  1. the transaction that is the deposit, vs the transaction that carries the deposit on L1
  2. a deposit-type transaction submitted by a user, vs the L1 attribute deposit transaction (also a deposit-type transaction)

Proposal:

  1. deposit-type transaction — a transaction that has a new EIP-2718 transaction type and is used for user deposits (3) and L1-attributes deposits (5)
  2. deposit transaction type — the type of deposit-type transactions
  3. user deposit or account deposit (?) — a deposit-type transaction originally submitted by a user (account) on L1
  4. deposit-submission transaction — the L1 transaction that submits a user deposit
  5. L1-attributes deposit — a deposit-type transaction that pushes the L1 attributes to the L1 attributes contract on L2

Note the unorthodox dashes in the names, I think this makes it clearer what is meant. The best example is in L1-attributes deposit, it clarifies that it's the attributes that are from L1, not the deposit.

Thoughts?

@protolambda
Copy link
Collaborator

@norswap Good list!

Instead of deposit-submission transaction I'd like deposit-origin transaction (since the deposit is created on-chain, instead of signed offchain and submitted like a L2 transaction).

user is clear vs system deposit, if we end up having more types of deposits than the L1-attributes one.

@norswap
Copy link
Contributor

norswap commented Dec 11, 2021

I'm cool with `system deposit.

I'm not entirely certain how "origin" implies L1 more than "submission" though? I think part of the definition of deposit is that it always comes from L1. We always use the formulation "users submit a deposit on L1". Also English-wise, I think it should at least be deposit-origination transaction (otherwise it can be understood as deposit relating to "the deposit origin" which isn't really a concept). I'd be cool with deposit-origination transaction if you prefer.

@norswap
Copy link
Contributor

norswap commented Jan 28, 2022

closed by #144

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

4 participants