# Packages
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Functions
No description provided by the author
# Constants
This account is created to maintain liquidity providers funds commitments.
External account represents an external source (deposit/withdrawal).
Infrastructure accounts contain fees earned by providing infrastructure on Vega.
Liquidity accounts contain fees earned by providing liquidity on Vega markets.
This account is created to hold fees earned by placing orders that sit on the book and are then matched with an incoming order to create a trade - These fees reward parties who provide the best priced liquidity that actually allows trading to take place.
General accounts contains general funds for a party.
Global insurance account for the asset.
Global reward account for the asset.
Insurance pool accounts contain insurance pool funds for a market.
This account is created to lock funds to be withdrawn by parties.
Margin accounts contain margin funds for a party and each party will have multiple margin accounts, one for each market they have traded in
Margin account funds will alter as margin requirements on positions change.
Per asset account used to store pending transfers (if any).
Per asset reward account for fees received by liquidity providers.
Per asset reward account for fees received by makers.
Per asset reward account for market proposers when the market goes above some trading threshold.
Per asset reward account for fees paid by takers.
Settlement accounts exist only during settlement or mark-to-market.
Default value.
Asset is fully usable in the network.
Asset is pending listing from the bridge.
Asset is proposed and under vote.
Asset has been rejected from governance.
Default value, always invalid.
Batch auction.
Liquidity monitoring trigger.
Opening auction.
Price monitoring trigger.
Default value for AuctionTrigger, no auction triggered.
Blockchain is connected and receiving transactions.
Blockchain is disconnected.
Blockchain is replaying historic transactions.
Default value, always invalid.
The deposit has been cancelled by the network.
The deposit has been finalised and accounts have been updated.
The deposit is being processed by the network.
Default value, always invalid.
Dispatch metric that is using the total LP fees received in the market.
Dispatch metric that is using the total maker fees received in the market.
Dispatch metric that is using total value of the market if above the required threshold and not paid given proposer bonus yet.
Dispatch metric that is using the total taker fees paid in the market.
No description provided by the author
The epoch update is for the end of an epoch.
The epoch update is for a new epoch.
No description provided by the author
15 minutes.
1 day.
1 hour.
1 minute.
5 minutes.
6 hours.
Default value, always invalid.
The liquidity provision is active.
The liquidity provision was cancelled by the liquidity provider.
The liquidity provision is valid and accepted by network but have never been deployed.
The liquidity provision was invalid and got rejected.
The liquidity provision was stopped by the network.
The liquidity provision is valid and accepted by network, but orders aren't deployed.
The default value.
Enactment date reached and usual auction exit checks pass.
Market triggers cancellation condition or governance votes to close before market becomes Active.
Governance vote (to close).
Governance vote passes/wins.
The Governance proposal valid and accepted.
Outcome of governance votes is to reject the market.
Settlement triggered and completed as defined by product.
Price monitoring or liquidity monitoring trigger.
Defined by the product (i.e.
Default value, invalid.
Auction trading (FBA).
Normal trading.
Auction triggered by monitoring.
Not trading is allowed.
Opening auction.
Default value, this is invalid.
The node is non-validating.
No description provided by the author
The node is validating.
Used for active unfilled or partially filled orders.
Used for orders cancelled by the party that created the order.
Used for expired GTT orders.
Used for closed fully filled orders.
Order has been removed from the order book and has been parked, this applies to pegged orders only.
Used for closed partially filled IOC orders.
Used for orders when not enough collateral was available to fill the margin requirements.
Used for unfilled FOK or IOC orders, and for orders that were stopped by the network.
Default value, always invalid.
Fill or kill.
Good for auction.
Good for normal.
Good until cancelled.
Good until specified time.
Immediate or cancel.
Default value for TimeInForce, can be valid for an amend.
Used for Limit orders.
Used for Market orders.
Used for orders where the initiating party is the network (with distressed parties).
Default value, always invalid.
Amend failure because amend details do not match original order.
Buy pegged order cannot reference best ask price.
Amending from GFA or GFN is invalid.
Cannot amend a non pegged orders details.
Amending to FOK or IOC is invalid.
Amending to GFA or GFN is invalid.
Attempt to amend order to GTT without ExpiryAt.
Attempt to amend to GTC without an ExpiryAt value.
FOK orders are not allowed during auction.
IOC orders are not allowed during auction.
Order amend was submitted for an order field that cannot not be amended (e.g.
Attempt to amend ExpiryAt to a value before CreatedAt.
A GFA order has got to the market when it is in continuous trading mode.
A GFN order has got to the market when it is in auction mode.
Order was submitted with an incorrect or invalid market type.
The party has an insufficient balance, or does not have a general account to submit the order (no deposits made for the required asset).
Order was submitted, but the party did not have enough collateral to cover the fees for the order.
Unspecified internal error.
An order with `TimeInForce.TIME_IN_FORCE_GTT` was submitted or amended with an expiration that was badly formatted or otherwise invalid.
Order was submitted for a market that does not exist.
Order was submitted with an invalid identifier.
Order was submitted or amended with an invalid reference field.
Order was submitted with an invalid or missing party identifier.
Order was submitted with an invalid persistence for its type.
Order was amended with an invalid remaining size (e.g.
Order was submitted with an invalid or missing size (e.g.
Order was submitted with invalid time in force.
Order was submitted with an invalid type field.
Order was submitted, but the party did not have enough collateral to cover the order.
Order was submitted for a market that has closed.
Order was submitted, but the party did not have an account for this asset.
Pegged orders can only have TIF GTC or GTT.
Pegged orders must be LIMIT orders.
An FOK, IOC, or GFN order was rejected because it resulted in trades outside the price bounds.
Order not found in an order book or store.
Pegged order offset must be >= 0.
Pegged order offset must be > zero.
Order was amended with a sequence number that was not previous version + 1.
Failed to remove an order from the book.
Order was stopped as it would have traded with another order submitted from the same party.
Sell pegged order cannot reference best bid price.
Node was unable to get Vega (blockchain) time.
It is not possible to amend the price of an existing pegged order.
We are unable to re-price a pegged order because a market price is unavailable.
Default value, no error reported.
Pegged order must have a reference price.
Best ask price reference.
Best bid price reference.
Mid price reference.
Default value for PeggedReference, no reference given.
Proposal didn't get enough votes (either failing to gain required participation or majority level).
Proposal enacted.
Proposal enactment has failed - even though proposal has passed, its execution could not be performed.
Proposal is open for voting.
Proposal has gained enough support to be executed.
Proposal wasn't accepted (proposal terms failed validation due to wrong configuration or failing to meet network requirements).
Default value, always invalid.
Waiting for node validation of the proposal.
The specified close time is too late based on network parameters.
The specified close time is too early base on network parameters.
Market proposal market could not be instantiate in execution.
The specified enact time is too late based on network parameters.
The specified enact time is too early based on network parameters.
Proposal terms timestamps are not compatible (Validation < Closing < Enactment).
The party doesn't have enough equity-like share to propose an update on the market targeted by the proposal.
The proposer for this proposal as insufficient tokens.
The asset identifier is invalid or does not exist on the Vega network.
Asset proposal invalid asset details.
Market proposal have invalid fee.
Validation failed for freeform proposal.
Market proposal market contained invalid product definition.
The instrument quote name and base name were the same.
The market targeted by the proposal does not exist or is not eligible to modification.
Market proposal invalid risk parameter.
Market proposal have invalid shape.
Proposal was declined because vote didn't reach the majority threshold required.
Market proposal is missing a liquidity commitment.
A field is missing in a builtin asset source.
Market proposal is missing commitment amount.
The contract address is missing in the ERC20 asset source.
Invalid key in update network parameter proposal.
Invalid valid in update network parameter proposal.
Validation failed for network parameter proposal.
The proposal has no product.
No risk parameters were specified.
The proposal has no trading mode.
The proposal failed node validation.
Opening auction duration is more than the network minimum opening auction time.
Opening auction duration is less than the network minimum opening auction time.
Proposal declined because the participation threshold was not reached.
The market proposal decimal place is higher to the market settlement asset decimal places.
The market proposal contains too many price monitoring triggers.
Proposal has an unknown risk parameter type.
Proposal is an unknown type.
Default value.
The specified product is not supported.
The proposal has an unsupported trading mode.
Buy order.
Sell order.
Default value, always invalid.
Normal trading between two parties.
Trading initiated by the network with another party off the book, with a distressed party in order to zero-out the position of the party.
Trading initiated by the network with another party on the book, which helps to zero-out the positions of one or more distressed parties.
Default value, always invalid.
Bond too high.
Bond too low.
Bond slashing.
Close.
Deposit funds.
Receive infrastructure fee.
Pay infrastructure fee.
Receive liquidity fee.
Pay liquidity fee.
Loss.
Pay maker fee.
Receive maker fee.
Margin was confiscated.
Margin too high.
Margin too low.
Mark to market loss.
Mark to market win.
Stake reward.
Transfer funds.
Transfer funds.
Default value, always invalid.
Win.
Actual withdraw from system.
Lock amount for withdraw.
The node is an ersatz validator.
The node is a pending validator.
The node is a tendermint validator.
No description provided by the author
A vote against the proposal.
Default value, always invalid.
A vote in favour of the proposal.
The withdrawal went through and is fully finalised, the funds are removed from the Vega network and are unlocked on the foreign chain bridge, for example, on the Ethereum network.
The withdrawal is open and being processed by the network.
The withdrawal have been cancelled.
Default value, always invalid.
# Variables
Enum value maps for AccountType.
Enum value maps for AccountType.
Enum value maps for Asset_Status.
Enum value maps for Asset_Status.
Enum value maps for AuctionTrigger.
Enum value maps for AuctionTrigger.
Enum value maps for ChainStatus.
Enum value maps for ChainStatus.
Enum value maps for Deposit_Status.
Enum value maps for Deposit_Status.
Enum value maps for DispatchMetric.
Enum value maps for DispatchMetric.
Enum value maps for EpochAction.
Enum value maps for EpochAction.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Enum value maps for Interval.
Enum value maps for Interval.
Enum value maps for LiquidityProvision_Status.
Enum value maps for LiquidityProvision_Status.
Enum value maps for Market_State.
Enum value maps for Market_State.
Enum value maps for Market_TradingMode.
Enum value maps for Market_TradingMode.
Enum value maps for NodeStatus.
Enum value maps for NodeStatus.
Enum value maps for Order_Status.
Enum value maps for Order_Status.
Enum value maps for Order_TimeInForce.
Enum value maps for Order_TimeInForce.
Enum value maps for Order_Type.
Enum value maps for Order_Type.
Enum value maps for OrderError.
Enum value maps for OrderError.
Enum value maps for PeggedReference.
Enum value maps for PeggedReference.
Enum value maps for Proposal_State.
Enum value maps for Proposal_State.
Enum value maps for ProposalError.
Enum value maps for ProposalError.
Enum value maps for Side.
Enum value maps for Side.
Enum value maps for Trade_Type.
Enum value maps for Trade_Type.
Enum value maps for TransferType.
Enum value maps for TransferType.
Enum value maps for ValidatorNodeStatus.
Enum value maps for ValidatorNodeStatus.
Enum value maps for Vote_Value.
Enum value maps for Vote_Value.
Enum value maps for Withdrawal_Status.
Enum value maps for Withdrawal_Status.
# Structs
Represents an account for an asset on Vega for a particular owner or party.
The Vega representation of an external asset.
The Vega representation of an external asset.
No description provided by the author
No description provided by the author
The changes to apply on an existing asset.
No description provided by the author
An auction duration is used to configure 3 auction periods: 1.
AuctionIndicativeState is used to emit an event with the indicative price/volume per market during an auction.
A Vega internal asset.
A deposit for a Vega built-in asset.
An event related to a Vega built-in asset.
No description provided by the author
No description provided by the author
A withdrawal for a Vega built-in asset.
Represents the high, low, open, and closing prices for an interval of trading, referred to commonly as a candlestick or candle.
No description provided by the author
A deposit on to the Vega network.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Describes in both human readable and block time when an epoch spans.
An ERC20 token based asset, living on the ethereum network.
An asset deny-listing for an ERC20 token.
No description provided by the author
An asset allow-listing for an ERC20 token.
An asset deposit for an ERC20 token.
An event related to an ERC20 token.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
An event related to the ERC20 MultiSig.
No description provided by the author
No description provided by the author
No description provided by the author
A new signer added to the ERC20 bridge.
A signer removed from the ERC20 bridge.
The threshold have been updated on the multisigcontrol.
No description provided by the author
An asset withdrawal for an ERC20 token.
An extension of data required for the withdraw submissions.
Represents Vega domain specific error information over gRPC/Protobuf.
Ethereum configuration details.
No description provided by the author
Represents any fees paid by a party, resulting from a trade.
Fee factors definition.
Fees definition.
Asset value information used within a transfer.
Future product definition.
Future product configuration.
Governance data.
Instrument definition.
No description provided by the author
Instrument configuration.
No description provided by the author
Instrument metadata definition.
No description provided by the author
Represents a ledger entry on Vega.
LiquidityMonitoringParameters contains settings used for liquidity monitoring.
Represents a liquidity order.
A pair of a liquidity order and the id of the generated order by the core.
The equity like share of liquidity fee for each liquidity provider.
An Liquidity provider commitment.
Risk model parameters for log normal.
Risk model for log normal.
Margin Calculator definition.
Represents the margin levels for a party on a market at a given time.
Market definition.
Represents data generated by a market when open.
Represents market depth or order book data for the specified market on Vega.
Represents the changed market depth since the last update.
Time stamps for important times about creating, enacting etc the market.
No description provided by the author
Network limits, defined in the genesis file.
Represents a network parameter on Vega.
New asset on Vega.
Freeform proposal This message is just used as a placeholder to sort out the nature of the proposal once parsed.
New market on Vega.
A commitment of liquidity to be made by the party which proposes a market.
Configuration for a new market on Vega.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OracleSpecToFutureBinding tells on which property oracle data should be used as settlement price and which to use the trading terminated trigger.
An order can be submitted, amended and cancelled on Vega in an attempt to make trades with other parties.
Used when cancelling an Order.
Used when confirming an Order.
A party represents an entity who wishes to trade on or query a Vega network.
Pegged orders are limit orders where the price is specified in the form REFERENCE +/- OFFSET They can be used for any limit order that is valid during continuous trading.
Represents position data for a party on the specified market on Vega.
No description provided by the author
No description provided by the author
Represents a price level from market depth or order book data.
Represents a list of valid (at the current timestamp) price ranges per associated trigger.
PriceMonitoringParameters contains a collection of triggers to be used for a given market.
PriceMonitoringSettings contains the settings for price monitoring.
PriceMonitoringTrigger holds together price projection horizon τ, probability level p, and auction extension duration.
Governance proposal.
The rationale behind a proposal.
Terms for a governance proposal on Vega.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Details for a single reward payment.
No description provided by the author
Details for rewards for a single asset.
Risk factors are used to calculate the current risk associated with orders trading on a given market.
No description provided by the author
Scaling Factors (for use in margin calculation).
Risk model parameters for simple modelling.
Risk model for simple modelling.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TargetStakeParameters contains parameters used in target stake calculation.
A timestamp in nanoseconds since epoch See [`VegaTimeResponse`](#api.VegaTimeResponse).`timestamp`.
Tradable Instrument definition.
No description provided by the author
No description provided by the author
A trade occurs when an aggressive order crosses one or more passive orders on the order book for a market on Vega.
No description provided by the author
Represents a financial transfer within Vega.
Represents the balance for an account during a transfer.
Represents a request to transfer from one set of accounts to another.
Represents the response from a transfer.
No description provided by the author
Update an existing asset on Vega.
Future product configuration.
Instrument configuration.
No description provided by the author
Update an existing market on Vega.
Configuration to update a market on Vega.
No description provided by the author
No description provided by the author
Update network configuration on Vega.
No description provided by the author
Governance vote.
A withdrawal from the Vega network.
Withdrawal external details.
No description provided by the author
# Type aliases
Various collateral/account types as used by Vega.
No description provided by the author
Auction triggers indicate what condition triggered an auction (if market is in auction mode).
The Vega blockchain status as reported by the node the caller is connected to.
The status of the deposit.
No description provided by the author
What epoch action has occurred.
Represents a set of time intervals that are used when querying for candle-stick data.
Status of a liquidity provision order.
The current state of the Market.
The trading mode the market is currently running, also referred to as 'market state'.
Node status type.
Status values for an order See resulting status in [What order types are available to trade on Vega?](https://docs.testnet.vega.xyz/docs/trading-questions/#what-order-types-are-available-to-trade-on-vega) for more detail.
Time In Force for an order See [What order types are available to trade on Vega?](https://docs.testnet.vega.xyz/docs/trading-questions/#what-order-types-are-available-to-trade-on-vega) for more detail.
Type values for an order.
OrderError codes are returned in the `[Order](#vega.Order).reason` field - If there is an issue with an order during its life-cycle, it will be marked with `status.ORDER_STATUS_REJECTED`.
A pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point.
Proposal state transition: Open -> - Passed -> Enacted.
A list of possible errors that can cause a proposal to be in state rejected or failed.
A side relates to the direction of an order, to Buy, or Sell.
Type values for a trade.
Transfers can occur between parties on Vega, these are the types that indicate why a transfer took place.
Validation status of the node.
Vote value.
The status of the withdrawal.