Using Vega Console
What is Vega Console and how do I access it?
Vega Console is a stand-alone web-based client for trading and operating markets on Vega. It can be self-hosted or run in the cloud. The latest version of Vega Console for Fairground can be accessed by visiting https://console.fairground.wtf/. Release notes are published for each version.
How do I connect my Vega Wallet to Console?
If you don’t have a Vega Wallet you can download one from the repository. Once you have your wallet running you can launch Console via a proxy (instructions in the repository), and click on Local Wallet to enter the credentials you created. The proxy method avoids issues caused by the same origin rule, as some browsers prevent connections to
localhost as well as other sites.
If you are using a Vega hosted wallet (testnet only) you can simply select that option and enter your credentials into the username and password box.
Watch this video to see how to connect:
Once you’re connected, you can set up your workspace to suit how you prefer your trading interface to look. It will be saved on your device. The workspace switcher in the top navigation (between Search and Settings) allows you to switch between different workspaces, or use different workspaces on different screens. There are four pre-set workspaces, and they can be changed and saved. You can also add new workspaces.
Occasionally (but rarely) your workspaces may be reset when we release new features or bug fixes. If refreshing the page doesn’t fix any interface issues, you can reset your workspaces yourself by going to Settings > Reset. This will also log you out, but it won’t affect any open orders.
Place an order using the deal ticket.
You can track your open orders, positions, and history with the relevant views. You can add those views through search. Look for the magnifying glass in the top bar, or use Shift + S. Watch a short video on how to add views by searching in settings:
Once you have open positions, you can track how much of your collateral is used as margin. On Vega, your margin requirement is recalculated with every trade/order book change. A typical trading system will have an initial and maintenance margin for each position. Vega manages the default risk with a few new concepts, which you can read about in the whitepaper. Here’s a video that shows how to check your margin levels.
Your positions and collateral, and any markets or assets created by governance, will be reset every time the network is reset. The network is expected to stay up for at least 14 days at a time, but it’s possible that we’ll need to release new code more frequently than that.
If you’re looking for reference API documentation, you can find it in the Using Vega’s APIs section along with links to sample code and how-to guides.
How to deposit tokens to use on Vega
- You’ll need MetaMask (or another Ethereum wallet) to hold your testnet tokens and the Ropsten Ethereum you’ll need to pay gas. Depending on traffic on the Ropsten network, transactions may take awhile, but you can speed it up by increasing the amount you spend on gas.
In MetaMask, be sure to choose the Ropsten Test Network.
Connect to a Vega walletin Vega Console using your Vega wallet credentials.
Click on either the
Make a depositor
If it’s your first time using MetaMask with Vega Console, within MetaMask you will need to choose a MetaMask account and connect to Vega. (In Console you’ll see a message saying ‘Console has requested connection to your wallet.')
Choose which asset you want to deposit first, and click
Depositon the specific asset’s screen.
At this stage, if you do not have Ropsten Ethereum to pay gas, click on
Get some Ropsten Ethereum. This will open a link to a Ropsten Ethereum faucet. Put your MetaMask wallet address into the address field. Note: You can only use most Ropsten Ethereum faucet once per day.
Once your Ropsten Ethereum transaction is successful…
Click on the link text (e.g.
Get some BTC (test)). This will transfer a preset amount of the testnet asset to your Ethereum address and deposit it to your MetaMask wallet.
You’ll get a prompt from MetaMask (or your wallet) to
Confirmthe transaction, and to choose how much you’re willing to pay in gas. The more you pay, the quicker the transaction will be.
Once the transaction is complete…
Choose how much of your new testnet asset you want to deposit and type it in the field. Or, click on
use maximumto transfer it all into your Vega wallet.
You’ll get a prompt from MetaMask (or your wallet) to
The transaction will be confirmed by your MetaMask wallet, and then your Vega wallet. You can see the amount you’ve deposited for use on Vega in the Available field.
Now you can trade on any market that uses that testnet token as a settlement asset! Or, do steps 5-12 again for the other assets. (You should still have plenty of Ropsten Ethereum to pay gas, though.)
How to withdraw tokens from Vega
Make sure you’re connected to a Vega wallet, and have assets to withdraw. You’ll be able to withdraw assets that are not locked up in open positions, margins, or liquidity commitments.
Select the key you want to withdraw assets from.
Select the asset you want to withdraw. You can withdraw as much or as little as you want. Any collateral that Vega is using for your existing positions, margin or liquidity commitments, will not be available for withdrawal.
Input the Ropsten Ethereum wallet address you want to withdraw to, and how much you want to withdraw. If you want to use a connected wallet, click into the text box and click on “Use connected wallet”. You can manually type in the amount you want to withdraw, or click into the text box and click on “Use maximum available”.
When the withdrawal is ready, choose “Finish withdrawal”.
MetaMask (or your chosen wallet) will ask you to “Confirm” the transaction. If you choose not to withdraw/pay gas at this point, the funds are held for 24 hours on the bridge before being released back to your available collateral on Vega. You can finish the transaction at any point before those 24 hours are up.
- Once your withdrawal is complete, you’ll see the amount you withdrew in your connected Ropsten Ethereum wallet.
Views in Vega Console, and what information they show
|Deal ticket||Simplified view that covers the execution and intention of the trade, including the size, order to buy or sell, and its time in force for continuous trading. It shows only the relevant fields for the trading mode the market is in (e.g., continuous trading, auction mode).|
|Candle chart||Candlestick chart, available for each active market, where each candlestick shows the market’s open, high, low, and close price across several pre-defined time frames.|
|Order book||Dynamic list of buy and sell orders for each market, organised by price level, that represents the orders that are active at that point in time. You’ll see the 20 closest to the mid-point, per side.|
|Depth chart||Visualisation of the cumulative volume for each market. It can help you get a sense of the skew of the market (such as if there are more buys than sells, for example).|
|Market info||List of market specifications, live market data (e.g. best bid/ask) and in the future, governance information.|
|Trades||Running list of the 100 most recent orders that have been matched with another order, which resulted in a trade on the given market.|
|Watchlist (FX Futures)||List of each open market on the network, including a gavel icon if the market is in an auction.|
|Collateral||Indicator of how much you have of each asset’s balance, and how it’s being deployed.|
|Orders||View of your active and recently rejected orders (e.g., any portion of your trade that has not yet been filled). You’ll see all orders from your current session, plus up 50 orders from past sessions.|
|Positions||For each market that you have an open order or position on, displays your open volume, average entry price and latest mark price of the market. Also displays the margin allocated for the orders and positions, compared against the margin levels. You can see this by clicking on the allocated margin amount.|
|Fills||List of the last 100 trades that goes towards filling your orders, with the amount, price, and time for each transaction.|
|Order history||List of all of your orders (including open, closed, cancelled, and rejected) sorted by recency. You’ll see all orders from your current session, plus up 50 orders from past sessions.|
|Proposals||List of all governance proposals and the status of each, sorted by recency (e.g., new markets, new assets, and changes to markets, assets, and network).|
|Proposal detail: New market||Lists market specifications and governance actions for that market, and includes buttons for voting if relevant.|
|Asset details||Displays a description of the asset, as well as its ID in Vega, bridge contract address, and source.|
|Network stats||Information about the network, including latency, orders and trades per second across all markets, and the app and chain versions.|
If I’m having a problem with Vega Console, what should I do?
- Refresh the browser. If it keeps happening,
- Reset Console. Click on ‘Settings’ in the top right of Console, click on the button “Full reset: Log out and delete workspaces”. If resetting does not help, or you don’t have the option,
- Report the issue. Post it on the Nolt feedback board or share it with your Vega contact.
Which web browsers can I use with Vega Console?
We’ve primarily tested
- Modern Firefox version 70 or newer
- Google Chrome/Chromium version 75 or newer
- iOS/iPad OS Safari 12 or newer
- Brave Desktop version 1.4 or newer
Other browsers (Microsoft Edge, Android Browser) may work, but are currently untested. We’re still interested in bug reports, we just may not prioritise fixing for less-used browsers.
Which mobile phone browsers do you support?
Vega Console has only been tested on iPad OS. It does work on an iPhone, but has not been optimised for this. Try at your own risk.
As above, if you do try it with success, or find problems on other browsers, we are interested to hear them, but Console is currently targeting desktop browsers first and foremost.
Is there any other way to access Vega Fairground other than through Vega Console?
We do not currently provide any other user interface than Vega Console, for this version of testnet. You can, however, use the available APIs (gRPC, GraphQL, REST) to programmatically access the Vega network.
How can I update Vega Console workspaces when new default versions are released?
The most recent update to the default workspaces was in April 2021. If you’d like to start using the updated workspaces, and you don’t see them when you login into the Console window:
- Click on Settings in the top bar on Console.
- Click the yellow button “Full reset: Log out and delete workspaces”.
- Reconnect to the Vega Wallet.
At the moment, when you reset your workspaces, you’ll lose what you had before. If you don’t want to lose existing workspaces, you may not want to reset. Just like the previous workspaces, these can also be edited and will be saved to your Console.