vega-frontend-monorepo/specs

User interface acceptance criteria

This folder contains descriptions of things that users do when interacting with Vega. The information they need and why they are doing them. These can be referenced in testing and used as input for building new interfaces.

The acceptance criteria are organized into files, with each file representing a high level user task. These have been listed with the most "upstream" being first, and grouped into similar tasks.

Each file contains blocks that relate to a low level user task. The block states what the user is trying to do or the context they are in, has a bullet for each thing they need, then states why they are doing it...

When doing a thing, I...

• must be able to see some particular number [0000-CODE-000] ...so I can decide if I want to continue.

Each bullet is worded so that it contains a must, should, could, or would like to. This gives app developers some indication of the priority of user needs. At the end of each bullet is a code that can be referenced in tests etc.

These acceptance criteria are not final or intended to be "the truth" but a useful tool, they will be improved over time as more people feedback on using Vega.

A user is normally interacting with at least 2 applications when doing tasks on Vega, A Dapp or interface designed to help users complete specific tasks and a Wallet that is only used to authenticate a user's actions and broadcast them to the network.

0000 Wallets, signing transactions and network selection

• 0001-WALL Get and use a Vega wallet (This mostly relates to use of a wallet app, for cryptography and broadcast to network)

These files contain generic user needs for interacting with wallets that are true for all types of interactions that require a wallet. More specific requirements are mentioned where these are referenced. They describe what the user needs from the dapp not the wallet.

• 0002-WCON Connect Vega wallet to a Dapp & select keys
• 0003-WTXN Submit Vega transaction
• 0004-EWAL Connect Ethereum wallet to a Dapp
• 0005-ETXN Submit Ethereum transaction
• 0006-NETW Network and node selection

1000 Bridges, Transfers and Vesting

• 1001-DEPO Deposit
• 1002-WITH Withdraw
• 1003-TRAN Transfer
• 1004-ASSO Associate governance token with a Vega key
• 1005-VEST View and redeem vested tokens

1101 Browser Wallet

The specs no longer exist in this repo and can be found here

2000 Staking

• 2001-STKE Staking validators
• 2002-SINC Review staking income

3000 Governance

• 3001-VOTE See proposals and Vote on changes
• 3002-PROP Select proposal type
• 3003-PMAN Propose new Market
• 3004-PMAC Propose change(s) to market
• 3005-PASN Propose new asset
• 3006-PASC Propose change(s) to asset
• 3007-PNEC Propose change to network parameter(s)
• 3008-PFRO Propose something "Freeform"

4000 Treasury

• 4001-TRES View treasury rewards TODO

5000 Liquidity provision

• 5001-LIQF Find and understand liquidity provision opportunities TODO
• 5002-LIQP Provide liquidity TODO
• 5003-LIQI View liquidity provision rewards TODO

6000 Markets and analysis

• 6001-MARK Find markets
• 6002-MARD View market specification
• 6003-ORDB Analyze Order book
• 6004-PHIS Analyze price history TODO
• 6005-THIS Analyze trade history
• 6006-DEPC View depth chart
• 6007-CHAR View chart

7000 Collateral, Orders, Positions, Fills and Funding

• 7001-COLL View my collateral / accounts
• 7002-SORD Submit an order
• 7003-MORD Manage my orders
• 7004-POSI View my positions
• 7005-FILL View my trades/fills
• 7006-FEES View my trading fees TODO
• 7007-LEEN View ledger entries
• 7008-FUND View my funding payment

8000 Understand transactions and blocks

• 8001-BLOX Transaction and block content TODO

Appendixes

• Display display rules