.. | ||
0001-WALL-wallet.md | ||
0002-WCON-connect_vega_wallet.md | ||
0003-WTXN-submit_vega_transaction.md | ||
0004-EWAL-connect_ethereum_wallet.md | ||
0005-ETXN-submit_ethereum_transaction.md | ||
0006-NETW-network-and-nodes.md | ||
1001-DEPO-desposit.md | ||
1002-WITH-withdraw.md | ||
1003-TRAN-transfer.md | ||
1004-ASSO-associate.md | ||
1005-VEST-vesting.md | ||
2001-STKE-staking.md | ||
2002-SINC-staking-income.md | ||
3001-VOTE-vote.md | ||
3002-PROP-propose.md | ||
3003-PMAN-propose_new_market.md | ||
3004-PMAC-propose_market_change.md | ||
3005-PASN-propose_new_asset.md | ||
3006-PASC-propose_asset_change.md | ||
3007-PNEC-propose_network.md | ||
3008-PFRO-propose_freeform.md | ||
3009-NTWU-network-upgrade.md | ||
4001-TRES-view_treasury_rewards.md | ||
5001-LIQF-liquidity_opportunities.md | ||
5002-LIQP-liquidity.md | ||
5003-LIQI-liquidity_income.md | ||
6001-MARK-find_markets.md | ||
6002-MDET-market-details.md | ||
6003-ORDB-order_book.md | ||
6005-THIS-trade_history.md | ||
6006-DEPC-chart_depth.md | ||
6007-CHAR-chart.md | ||
6501-ASSE-assets.md | ||
7001-COLL-collateral.md | ||
7002-SORD-submit_orders.md | ||
7003-MORD-manage_orders.md | ||
7004-POSI-positions.md | ||
7005-FILL-fills.md | ||
7006-FEES-fees.md | ||
8001-BLOX-transaction_and_blocks.md | ||
9001-DATA-data_display.md | ||
apps.json | ||
categories.json | ||
increment.py | ||
README.md |
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 keys0003-WTXN
Submit Vega transaction0004-EWAL
Connect Ethereum wallet to a Dapp0005-ETXN
Submit Ethereum transaction0006-NETW
Network and node selection
1000
Bridges, Transfers and Vesting
1001-DEPO
Deposit1002-WITH
Withdraw1003-TRAN
Transfer1004-ASSO
Associate governance token with a Vega key1005-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 validators2002-SINC
Review staking income
3000
Governance
3001-VOTE
See proposals and Vote on changes3002-PROP
Select proposal type3003-PMAN
Propose new Market3004-PMAC
Propose change(s) to market3005-PASN
Propose new asset3006-PASC
Propose change(s) to asset3007-PNEC
Propose change to network parameter(s)3008-PFRO
Propose something "Freeform"
4000
Treasury
4001-TRES
View treasury rewardsTODO
5000
Liquidity provision
5001-LIQF
Find and understand liquidity provision opportunitiesTODO
5002-LIQP
Provide liquidityTODO
5003-LIQI
View liquidity provision rewardsTODO
6000
Markets and analysis
6001-MARK
Find markets6002-MARD
View market specificationTODO
6003-ORDB
Analyze Order bookTODO
6004-PHIS
Analyze price historyTODO
6005-THIS
Analyze trade historyTODO
6006-DEPC
View depth chart6007-CHAR
View chart
7000
Collateral, Orders, Positions and Fills
7001-COLL
View my collateral / accounts7002-SORD
Submit an order7003-MORD
Manage my orders7004-POSI
View my positionsTODO
7005-FILL
View my trades/fills7006-FEES
View my trading feesTODO
8000
Understand transactions and blocks
8001-BLOX
Transaction and block contentTODO