Skip to main content
Version: mainnet (v0.74)

events.proto

path vega/events/v1/events.proto

package vega.events.v1


Messages

AuctionEvent

Auction event indicating a change in auction state, for example starting or ending an auction

NameTypeDescription
market_idstringMarket ID for the event
opening_auctionboolTrue if the event indicates an auction opening and False otherwise
leaveboolTrue if the event indicates leaving auction mode and False otherwise
startint64Timestamp containing the start time for an auction
endint64Timestamp containing the end time for an auction
triggervega.AuctionTriggerReason this market is/was in auction
extension_triggervega.AuctionTriggerIf an auction was ongoing, but was extended for whatever reason, this field will be set to the trigger type indicating which component extended the auction

BeginBlock

BeginBlock

NameTypeDescription
heightuint64
timestampint64
hashstring

BusEvent

Bus event is a container for event bus events emitted by Vega

NameTypeDescription
idstringUnique event ID for the message
blockstringThe batch or block of transactions that the events relate to
typeBusEventTypeThe type of bus event. Must be one of the list below:
time_updateTimeUpdateTime update events
ledger_movementsLedgerMovementsTransfer responses update events
position_resolutionPositionResolutionPosition resolution events
ordervega.OrderOrder events
accountvega.AccountAccount events
partyvega.PartyParty events
tradevega.TradeTrade events
margin_levelsvega.MarginLevelsMargin level update events
proposalvega.ProposalProposal events for governance
votevega.VoteVote events for governance
market_datavega.MarketDataMarket data events
node_signaturevega.commands.v1.NodeSignatureNode signature events
loss_socializationLossSocializationLoss socialization events
settle_positionSettlePositionPosition settlement events
settle_distressedSettleDistressedPosition distressed events
market_createdvega.MarketMarket created events
assetvega.AssetAsset events
market_tickMarketTickMarket tick events
withdrawalvega.WithdrawalWithdrawal events
depositvega.DepositDeposit events
auctionAuctionEventAuction events
risk_factorvega.RiskFactorRisk factor events
network_parametervega.NetworkParameterNetwork parameter events
liquidity_provisionvega.LiquidityProvisionLiquidityProvision events
market_updatedvega.MarketMarket created events
oracle_specvega.OracleSpecOracleSpec events
oracle_datavega.OracleDataOracleData events
delegation_balanceDelegationBalanceEventDelegation balance events
validator_scoreValidatorScoreEventValidator score calculated
epoch_eventEpochEventEpoch update events
validator_updateValidatorUpdateValidator update events
stake_linkingStakeLinkingStaking event
reward_payoutRewardPayoutEventReward payout event
checkpointCheckpointEventCheckpoint was created
key_rotationKeyRotationKey rotation took place
state_varStateVarState variable consensus state transition update
network_limitsvega.NetworkLimitsNetwork limits events
transferTransferTransfer event
ranking_eventValidatorRankingEventRanking event
erc20_multisig_signer_eventERC20MultiSigSignerEventERC20 multi sig signer event
erc20_multisig_set_threshold_eventERC20MultiSigThresholdSetEventERC20 multi sig set threshold event
erc20_multisig_signer_addedERC20MultiSigSignerAddedERC20 multi sig signer added
erc20_multisig_signer_removedERC20MultiSigSignerRemovedERC20 multi sig signer removed
position_state_eventPositionStateEventPosition status for a party in a market
ethereum_key_rotationEthereumKeyRotationEthereum key rotation took place
protocol_upgrade_eventProtocolUpgradeEventProtocol upgrade proposal updates
begin_blockBeginBlockCore is starting to process a new block
end_blockEndBlockCore finished processing a block
protocol_upgrade_startedProtocolUpgradeStartedCore is starting a protocol upgrade
settle_marketSettleMarketSettle market event for data-node to update positions for settled markets
transaction_resultTransactionResultResult of a transaction processed by the network
core_snapshot_eventCoreSnapshotDataCore snapshot has been taken at the end of the block
protocol_upgrade_data_node_readyProtocolUpgradeDataNodeReadyCore snapshot has been taken at the end of the block
distressed_ordersDistressedOrdersParties that had their orders closed because they were distressed
expired_ordersExpiredOrdersOrders that expired for a given market
distressed_positionsDistressedPositionsOpen positions on the market that are/were distressed
stop_orderStopOrderEventA stop order event
funding_periodFundingPeriodStart or end of a funding period.
funding_period_data_pointFundingPeriodDataPointData point within a funding period.
team_createdTeamCreatedEvent notifying of the creation of a team.m
team_updatedTeamUpdatedEvent notifying of an update to a team.
referee_switched_teamRefereeSwitchedTeamEvent notifying that a referee switched teams.
referee_joined_teamRefereeJoinedTeamEvent notifying that a referee joined a team.
referral_program_startedReferralProgramStartedEvent notifying that a referral program has started.
referral_program_updatedReferralProgramUpdatedEvent notifying that a referral program has been updated.
referral_program_endedReferralProgramEndedEvent notifying that a referral program has ended.
referral_set_createdReferralSetCreatedEvent notifying a referral set has been created.
referee_joined_referral_setRefereeJoinedReferralSetEvent notifying a referee has joined a referral set.
party_activity_streakPartyActivityStreakEvent notifying of an update to a party's activity streak
volume_discount_program_startedVolumeDiscountProgramStartedEvent notifying that a volume discount program has started.
volume_discount_program_updatedVolumeDiscountProgramUpdatedEvent notifying that a volume discount program has been updated.
volume_discount_program_endedVolumeDiscountProgramEndedEvent notifying that a volume discount program has ended.
referral_set_stats_updatedReferralSetStatsUpdatedEvent notifying of an update to a referral set's statistics.
vesting_stats_updatedVestingStatsUpdatedEvent notifying of an update to the vesting statistics.
volume_discount_stats_updatedVolumeDiscountStatsUpdatedEvent notifying of an update to the volume discount statistics.
fees_statsFeesStatsEvent notifying of an update the fees stats for a market.
funding_paymentsFundingPaymentsEvent notifying of funding payments at the end of a funding period.
paid_liquidity_fees_statsPaidLiquidityFeesStatsEvent notifying of an update to the liqudity fees stats for a market.
vesting_balances_summaryVestingBalancesSummaryEvent notifying of an update to the vesting and locked balances.
transfer_feesTransferFeesEvent notifying of fees related to a transfer being paid.
transfer_fees_discountTransferFeesDiscountEvent notifying of a party's available discounts for transfer fees, per asset.
party_margin_mode_updatedPartyMarginModeUpdatedEvent notifying of a party's margin mode update on a market.
party_profile_updatedPartyProfileUpdatedEvent notifying of a party's profile update.
teams_stats_updatedTeamsStatsUpdatedEvent notifying of an update of teams' statistics.
marketMarketEventMarket tick events
tx_err_eventTxErrorEventTransaction error events, not included in the ALL event type
versionuint32Version of bus event
chain_idstring
tx_hashstring

CheckpointEvent

NameTypeDescription
hashstring
block_hashstring
block_heightuint64

CoreSnapshotData

CoreSnapshotData represents the core snapshot data.

NameTypeDescription
block_heightuint64Block height at which snapshot was taken
block_hashstringHash of the snapshot block
core_versionstringSemver version number of the core.
protocol_upgrade_blockboolIndicates if the snapshot is taken as part of protocol upgrade

DelegationBalanceEvent

DelegationBalanceEvent - updates on the delegation balance of a party to a node in the current epoch in effect

NameTypeDescription
partystring
node_idstring
amountstring
epoch_seqstring

DistressedOrders

Distressed order contains the party IDs for all parties that were distressed and had their orders closed, but did not need to be closed out after cancelling their orders

NameTypeDescription
market_idstringMarket ID for the event
partiesrepeated stringSlice of Party IDs i.e. each party's public key for the event

DistressedPositions

Distressed positions event contains the party IDs for all parties that were distressed, had their orders closed but because of insufficient volume on the book could not be fully closed out. These parties are distressed, but still hold an active position on the book as a result. Once enough volume is on the book to close them out, a SettleDistressed event will be sent. In case they manage to reduce their position, or meet the margin requirements, this status will be updated. Parties that are no longer distressed but active will be listed in the safe_parties field.

NameTypeDescription
market_idstringMarket ID for the event
distressed_partiesrepeated stringSlice of party IDs i.e. each party's public key, that are distressed but still have open volume
safe_partiesrepeated stringSlice of party IDs i.e. each party's public key, who were distressed but now can safely maintain their position

ERC20MultiSigSignerAdded

NameTypeDescription
signature_idstringID of the signature bundle
validator_idstringNode ID of the Vega node to be added
timestampint64Time at which this happened
new_signerstringEthereum address of the new signer
submitterstringAddress of the submitter of the transaction
noncestringNonce used.
epoch_seqstringEpoch that the node was added for

ERC20MultiSigSignerEvent

NameTypeDescription
idstring
typeERC20MultiSigSignerEvent.Type
signerstring
noncestring
block_timeint64
tx_hashstring
log_indexuint64
block_numberuint64

ERC20MultiSigSignerRemoved

NameTypeDescription
signature_submittersrepeated ERC20MultiSigSignerRemovedSubmitterList containing all the IDs of bundle generated There should be one bundle generated for every validators in the validator set
validator_idstringNode ID of the Vega node which is to be removed
timestampint64Time at which this happened
old_signerstringEthereum address of the signer to be removed
noncestringNonce used.
epoch_seqstringEpoch that the node was removed for

ERC20MultiSigSignerRemovedSubmitter

NameTypeDescription
signature_idstringSignature ID of the signer removed.
submitterstringAddress of the submitter of the transaction

ERC20MultiSigThresholdSetEvent

NameTypeDescription
idstring
new_thresholduint32
noncestring
block_timeint64
tx_hashstring
log_indexuint64
block_numberuint64

EndBlock

EndBlock

NameTypeDescription
heightuint64

EpochEvent

Epoch details

NameTypeDescription
sequint64Sequence number that increases by one each epoch
actionvega.EpochActionAction tells us what action is taking place
start_timeint64Vega time at which this epoch started
expire_timeint64Vega time at which this epoch should end
end_timeint64Vega time at which this epoch actually ended

EthereumKeyRotation

Event that contains information about an Ethereum key rotation

NameTypeDescription
node_idstringNode ID of the node that rotated their Ethereum key
old_addressstringEthereum address that was previously associated with the node
new_addressstringEthereum address that is newly associated with the node
block_heightuint64Block height when the key rotation took effect

ExpiredOrders

NameTypeDescription
market_idstringMarket ID for the event
order_idsrepeated stringSlice of expired order IDs

FeesStats

Fees rewards and discounts paid / received per parties during an epoch

NameTypeDescription
marketstringMarket the fees were paid in
assetstringSettlement asset of the market.
epoch_sequint64Epoch for which these stats where valid.
total_rewards_receivedrepeated PartyAmountTotal referral rewards received by the referrer of the referral set.
referrer_rewards_generatedrepeated ReferrerRewardsGeneratedReferral rewards generated by all referee taker fees.
referees_discount_appliedrepeated PartyAmountTotal referral discounts applied to all referee taker fees.
volume_discount_appliedrepeated PartyAmountTotal volume discounts applied to all referee taker fees.
total_maker_fees_receivedrepeated PartyAmountTotal maker fees received by the maker side.
maker_fees_generatedrepeated MakerFeesGeneratedMaker fees paid by all trade aggressors, and which makers the fees were paid to.
total_fees_paid_and_receivedrepeated PartyAmountTotal trading fees received and paid by the party.

FundingPayment

The amount gained or lost by a party as a result of a funding payment.

NameTypeDescription
party_idstringID of the party.
amountstringThe amount paid, this can be negative for parties who lost at the end of the funding period.

FundingPayments

Event notifying of funding payments at the end of a funding period.

NameTypeDescription
market_idstringID of the market.
sequint64Sequence number of the funding period associated with these payments.
paymentsrepeated FundingPaymentList of parties and the payment amounts, this can be negative for parties who lost at the end of the funding period.

FundingPeriod

Event notifying on the details of a funding interval for a perpetuals market.

NameTypeDescription
market_idstringID of the market for which this funding period relates to.
sequint64Sequence number of the funding period.
startint64Time in Unix nanoseconds when the funding period started.
endoptional int64Time in Unix nanoseconds when the funding period ended.
funding_paymentoptional stringFunding payment for this period as the difference between the time-weighted average price of the external and internal data point.
funding_rateoptional stringPercentage difference between the time-weighted average price of the external and internal data point.
internal_twapoptional stringTWAP for this period based on the internal data-points.
external_twapoptional stringTWAP for this period based on the external data-points.

FundingPeriodDataPoint

Event notifying a data point for a funding period.

NameTypeDescription
market_idstringMarket ID which the data point relates to.
sequint64Sequence number of the funding period this data point belongs to.
data_point_typeFundingPeriodDataPoint.SourceOrigin of the data point.
pricestringPrice of the asset as seen by this data point.
timestampint64Timestamp in Unix nanoseconds of when the data point was received.
twapstringThe TWAP for this source with this data-point added.

KeyRotation

Event that contains information about a Vega key rotation

NameTypeDescription
node_idstringNode ID of the node that rotated their Vega key
old_pub_keystringVega public key that was previously associated with the node
new_pub_keystringVega public key that is newly associated with the node
block_heightuint64Block height when the key rotation took effect

LedgerMovements

Transfer responses event contains a collection of transfer information

NameTypeDescription
ledger_movementsrepeated vega.LedgerMovementOne or more entries containing internal transfer information

LossSocialization

Loss socialization event contains details on the amount of wins unable to be distributed

NameTypeDescription
market_idstringMarket ID for the event
party_idstringParty ID (public key) for the event
amountstringAmount distributed

MakerFeesGenerated

Maker fees generated by the trade aggressor

NameTypeDescription
takerstringParty that paid the fees.
maker_fees_paidrepeated PartyAmountAmount of maker fees paid by the taker to the maker.

MarketEvent

MarketEvent - the common denominator for all market events interface has a method to return a string for logging

NameTypeDescription
market_idstringMarket ID for the event
payloadstringPayload is a unique information string

MarketTick

Market tick event contains the time value for when a particular market was last processed on Vega

NameTypeDescription
idstringMarket ID for the event
timeint64Timestamp containing latest update from Vega blockchain aka Vega-time

OneOffGovernanceTransfer

NameTypeDescription
deliver_onint64

OneOffTransfer

NameTypeDescription
deliver_onint64

PaidLiquidityFeesStats

NameTypeDescription
marketstringMarket the fees were paid in.
assetstringSettlement asset of the market.
epoch_sequint64Epoch for which these stats where valid.
total_fees_paidstringTotal fees paid across all parties.
fees_paid_per_partyrepeated PartyAmountFees paid per party.

PartyActivityStreak

The updated activity streak of a party at end of epoch

NameTypeDescription
partystringThe party.
active_foruint64How many epoch this party has been active for.
inactive_foruint64how many epoch this party has been inactive for.
is_activeboolIs this party considered active or not.
reward_distribution_activity_multiplierstringThe current rewards distribution multiplier for this party.
reward_vesting_activity_multiplierstringThe vesting multiplier for this party.
epochuint64The epoch this information is relevant to.
traded_volumestringParty's traded volume at the end of the given epoch
open_volumestringParty's open interest volume at the end of the given epoch

PartyAmount

A pair of a party and amount

NameTypeDescription
partystringReceiving party ID.
amountstringAmount received.
quantum_amountstringAmount value in quantum.

PartyLockedBalance

A party's locked balance for a given asset.

NameTypeDescription
assetstringAsset ID.
until_epochuint64Epoch in which the balance will be released.
balancestringLocked balance.

PartyMarginModeUpdated

NameTypeDescription
market_idstringUnique ID of the market in which the update happened.
party_idstringUnique ID of the party that updated their margin mode.
margin_modevega.MarginModeUpdated margin mode.
margin_factoroptional stringMargin factor for the market. Isolated mode only.
min_theoretical_margin_factoroptional stringMinimum theoretical margin factor for the market. Isolated mode only.
max_theoretical_leverageoptional stringMaximum theoretical leverage for the market. Isolated mode only.
at_epochuint64Epoch at which the update happened.

PartyProfileUpdated

NameTypeDescription
updated_profilevega.PartyProfileParty's profile updated.

PartyVestingBalance

Balance that is being vested for the party.

NameTypeDescription
assetstringAsset ID.
balancestringBalance that is vested.

PartyVestingStats

The vesting stats for a given party.

NameTypeDescription
party_idstringThe party.
reward_bonus_multiplierstringThe bonus multiplier applied on the reward.
quantum_balancestringThe balance of the party, in quantum.

PartyVestingSummary

Summary of a party's vesting balances

NameTypeDescription
partystringParty ID.
party_locked_balancesrepeated PartyLockedBalanceList of locked balances.
party_vesting_balancesrepeated PartyVestingBalanceList of vesting balances.

PartyVolumeDiscountStats

Volume discount stats for a given party.

NameTypeDescription
party_idstringParty ID.
discount_factorstringDiscount factor applied to fees.
running_volumestringThe party's running volume.

PositionResolution

Position resolution event contains information on distressed trades

NameTypeDescription
market_idstringMarket ID for the event
distressedint64Number of distressed traders
closedint64Number of close outs
mark_pricestringMark price as a string representing a scaled price

PositionStateEvent

Position state event contains the current position state for a single party in a single market

NameTypeDescription
party_idstringParty ID for this position update
market_idstringMarket ID for this position update
sizeint64Current position
potential_buysint64Potential orders
potential_sellsint64
vw_buy_pricestringVolume weighted prices
vw_sell_pricestring

ProtocolUpgradeDataNodeReady

Event indicating the data node is ready for protocol upgrade

NameTypeDescription
last_block_heightuint64

ProtocolUpgradeEvent

NameTypeDescription
upgrade_block_heightuint64Block height at which to perform the upgrade
vega_release_tagstringRelease tag for the vega binary
approversrepeated stringTendermint validators that have agreed to the upgrade
statusProtocolUpgradeProposalStatusStatus of the proposal

ProtocolUpgradeStarted

Event indicating the core is starting a protocol upgrade

NameTypeDescription
last_block_heightuint64

RecurringGovernanceTransfer

NameTypeDescription
start_epochuint64
end_epochoptional uint64
dispatch_strategyoptional vega.DispatchStrategy

RecurringTransfer

NameTypeDescription
start_epochuint64
end_epochoptional uint64
factorstring
dispatch_strategyvega.DispatchStrategy

RefereeJoinedReferralSet

NameTypeDescription
set_idstringUnique ID of the referral set the referee joined.
refereestringParty that joined the set.
joined_atint64Time in Unix nanoseconds when the party joined the set.
at_epochuint64Epoch at which the party joined the set.

RefereeJoinedTeam

NameTypeDescription
team_idstringThe unique identifier of the team the referee joined.
refereestringThe party that joined the team.
joined_atint64Time in Unix nanoseconds when the party joined a team.
at_epochuint64Epoch at which the party joined the team.

RefereeStats

NameTypeDescription
party_idstringUnique ID of the party.
discount_factorstringDiscount factor applied to the party.
epoch_notional_taker_volumestringCurrent referee notional taker volume

RefereeSwitchedTeam

NameTypeDescription
from_team_idstringThe unique identifier of the team the referee left.
to_team_idstringThe unique identifier of the team joined.
refereestringThe party that switched team.
switched_atint64Time in Unix nanoseconds when the party switched team. This time acts as the joining time.
at_epochuint64Epoch at which the party switched the team.

ReferralProgramEnded

NameTypeDescription
versionuint64Program update version.
idstringUnique ID of the referral program.
ended_atint64Time in Unix nanoseconds when the referral program ended.
at_epochuint64Epoch at which the referral program ended.

ReferralProgramStarted

NameTypeDescription
programvega.ReferralProgramReferral program that has started.
started_atint64Time in Unix nanoseconds when the referral program started.
at_epochuint64Epoch at which the referral program started.

ReferralProgramUpdated

NameTypeDescription
programvega.ReferralProgramThe updated referral program.
updated_atint64Time in Unix nanoseconds when the referral program was updated.
at_epochuint64Epoch at which the referral program was updated.

ReferralSetCreated

NameTypeDescription
set_idstringUnique ID of the created set.
referrerstringParty that created the set.
created_atint64Time in Unix nanoseconds when the set was created.
updated_atint64Time in Unix nanoseconds when the set was updated.

ReferralSetStatsUpdated

NameTypeDescription
set_idstringUnique ID of the set.
at_epochuint64Epoch at which the set's statistics are updated.
referral_set_running_notional_taker_volumestringRunning volume for the set based on the window length of the current referral program.
referees_statsrepeated RefereeStatsReferees' statistics for that epoch.
reward_factorstringReward factor applied to the trades.
rewards_multiplierstringRewards multiplier applied to the trades.
rewards_factor_multiplierstringRewards factor multiplier for the trades.
was_eligibleboolIndicates if the referral set was eligible to be part of the referral program.
referrer_taker_volumestringTaker volume of the referrer

ReferrerRewardsGenerated

Rewards generated for referrers by each of their referees

NameTypeDescription
referrerstringReferrer party.
generated_rewardrepeated PartyAmountAmount of rewards generated per party.

RewardPayoutEvent

NameTypeDescription
partystring
epoch_seqstring
assetstring
amountstring
percent_of_total_rewardstring
timestampint64
reward_typestring
locked_until_epochstring
quantum_amountstring
game_idoptional string

SettleDistressed

Settle distressed event contains information on distressed trading parties who are closed out Note: Any PositionResolution event (market level) will most likely be followed by a number of these events

NameTypeDescription
market_idstringMarket ID for the event
party_idstringParty ID i.e. a party's public key for the event
marginstringMargin value as an integer, for example `123456` is a correctly formatted price of `1.23456` assuming market configured to 5 decimal places
pricestringPrice as an integer, for example `123456` is a correctly formatted price of `1.23456` assuming market configured to 5 decimal places

SettleMarket

Settle market event to notify data node that a market has been settled so positions and PL can be updated accordingly

NameTypeDescription
market_idstringMarket ID for the event
pricestringPrice of settlement as a string
position_factorstringPosition factor - 10 ^ number of position decimal places

SettlePosition

Settle position event contains position settlement information for a party

NameTypeDescription
market_idstringMarket ID for the event
party_idstringParty ID (public key) for the event
pricestringPrice of settlement as a string
trade_settlementsrepeated TradeSettlementA collection of 1 or more trade settlements
position_factorstringPosition factor - 10 ^ number of position decimal places

StakeLinking

StakeLinking - an event notifying of stake being deposited or removed for a given party These events are emitted for every Staking deposit or removed accepted by the network

NameTypeDescription
idstringInternal ID for this staking event
typeStakeLinking.TypeStake linking event type.
tsint64Timestamp in Unix nanoseconds of when the event was emitted by Ethereum.
partystringParty to whom the event is directed at.
amountstringAmount of stake deposited or removed.
statusStakeLinking.StatusStatus of the event.
finalized_atint64Time at which the Vega network finalised the state of the event.
tx_hashstringHash of the transaction in which the event happened.
block_heightuint64Block when the event happened.
block_timeint64Block time.
log_indexuint64Log index.
ethereum_addressstringEthereum address from which the stake link was initiated.

StateVar

StateVar event updates on state changes in state variable consensus

NameTypeDescription
idstring
event_idstring
statestring

StopOrderEvent

NameTypeDescription
submissionvega.commands.v1.OrderSubmission
stop_ordervega.StopOrder

StreamStartEvent

NameTypeDescription
chain_idstring

TeamCreated

NameTypeDescription
team_idstringThe unique identifier of the created team.
referrerstringThe party that created the team.
namestringName of the team.
team_urloptional stringLink to the team's homepage.
avatar_urloptional stringLink to an image of the team's avatar.
created_atint64Time in Unix nanoseconds when the team is created.
closedboolTells if a party can join the team or not.
at_epochuint64Epoch at which the team was created.
allow_listrepeated stringList of public keys that are allowed to join the team.

TeamMemberStats

NameTypeDescription
party_idstringThe party ID of the team member.
notional_volumestringTeam members' notional volume for the epoch.

TeamStats

NameTypeDescription
team_idstringThe unique identifier of the team.
members_statsrepeated TeamMemberStatsStatistics for each team member.

TeamUpdated

NameTypeDescription
team_idstringThe unique identifier for the updated team.
namestringName of the team.
team_urloptional stringLink to the team's homepage.
avatar_urloptional stringLink to an image of the team's avatar.
closedboolTells if a party can join the team or not.
allow_listrepeated stringList of public keys that are allowed to join the team.

TeamsStatsUpdated

Stats for all teams.

NameTypeDescription
at_epochuint64Epoch at which the statistics are updated.
statsrepeated TeamStatsAll teams' stats.

TimeUpdate

Time update event contains the latest time update from Vega blockchain and indicates the start of a new block

NameTypeDescription
timestampint64Timestamp containing latest update from Vega blockchain aka Vega-time

TradeSettlement

Trade settlement is part of the settle position event

NameTypeDescription
sizeint64Size of trade settlement
pricestringPrice of settlement as string (in asset decimals)
market_pricestringPrice of settlement as a string (in market decimals)

TransactionResult

NameTypeDescription
party_idstringUnique party ID for the related party
statusboolStatus of the transaction, did it succeed or an error was raised.
hashstringHash of the transaction Transaction itself as received by the network
order_submissionvega.commands.v1.OrderSubmission
order_amendmentvega.commands.v1.OrderAmendment
order_cancellationvega.commands.v1.OrderCancellation
proposalvega.commands.v1.ProposalSubmission
vote_submissionvega.commands.v1.VoteSubmission
liquidity_provision_submissionvega.commands.v1.LiquidityProvisionSubmission
withdraw_submissionvega.commands.v1.WithdrawSubmission
delegate_submissionvega.commands.v1.DelegateSubmission
undelegate_submissionvega.commands.v1.UndelegateSubmission
liquidity_provision_cancellationvega.commands.v1.LiquidityProvisionCancellation
liquidity_provision_amendmentvega.commands.v1.LiquidityProvisionAmendment
transfervega.commands.v1.Transfer
cancel_transfervega.commands.v1.CancelTransfer
announce_nodevega.commands.v1.AnnounceNode
oracle_data_submissionvega.commands.v1.OracleDataSubmission
protocol_upgrade_proposalvega.commands.v1.ProtocolUpgradeProposal
issue_signaturesvega.commands.v1.IssueSignatures
batch_market_instructionsvega.commands.v1.BatchMarketInstructions
key_rotate_submissionvega.commands.v1.KeyRotateSubmission
ethereum_key_rotate_submissionvega.commands.v1.EthereumKeyRotateSubmission
stop_order_submissionvega.commands.v1.StopOrdersSubmission
stop_order_cancellationvega.commands.v1.StopOrdersCancellation
create_referral_setvega.commands.v1.CreateReferralSet
update_referral_setvega.commands.v1.UpdateReferralSet
apply_referral_codevega.commands.v1.ApplyReferralCode
update_margin_modevega.commands.v1.UpdateMarginMode
join_teamvega.commands.v1.JoinTeam
batch_proposalvega.commands.v1.BatchProposalSubmission
update_party_profilevega.commands.v1.UpdatePartyProfile
successTransactionResult.SuccessDetails
failureTransactionResult.FailureDetails

TransactionResult.FailureDetails

NameTypeDescription
errorstringError message explaining the reason for the transaction failing processing

TransactionResult.SuccessDetails

TBD

NameTypeDescription

Transfer

NameTypeDescription
idstring
fromstring
from_account_typevega.AccountType
tostring
to_account_typevega.AccountType
assetstring
amountstring
referencestring
statusTransfer.Status
timestampint64
reasonoptional string
game_idoptional stringID of the game this transfer was made in relation to. A transfer is made to members of a team or participants who take part in a game and are rewarded for their participation
one_offOneOffTransfer
recurringRecurringTransfer
one_off_governanceOneOffGovernanceTransfer
recurring_governanceRecurringGovernanceTransfer

TransferFees

NameTypeDescription
transfer_idstringTransfer that triggered the collection of fees.
amountstringAmount of fees paid.
epochuint64Epoch when the transfer was dispatched, and fees were paid.
discount_appliedstringAmount that was subtracted from the transfer fee based on available discounts.

TransferFeesDiscount

NameTypeDescription
partystringParty that the transfer fee discount applies to.
assetstringAsset that the transfer fee discount is relevant to.
amountstringAmount that the transfer fee was discounted by.
epochuint64Epoch in which the discount was first available.

TxErrorEvent

NameTypeDescription
party_idstringUnique party ID for the related party
err_msgstringError message describing what went wrong
order_submissionvega.commands.v1.OrderSubmission
order_amendmentvega.commands.v1.OrderAmendment
order_cancellationvega.commands.v1.OrderCancellation
proposalvega.commands.v1.ProposalSubmission
vote_submissionvega.commands.v1.VoteSubmission
liquidity_provision_submissionvega.commands.v1.LiquidityProvisionSubmission
withdraw_submissionvega.commands.v1.WithdrawSubmission
delegate_submissionvega.commands.v1.DelegateSubmission
undelegate_submissionvega.commands.v1.UndelegateSubmission
liquidity_provision_cancellationvega.commands.v1.LiquidityProvisionCancellation
liquidity_provision_amendmentvega.commands.v1.LiquidityProvisionAmendment
transfervega.commands.v1.Transfer
cancel_transfervega.commands.v1.CancelTransfer
announce_nodevega.commands.v1.AnnounceNode
oracle_data_submissionvega.commands.v1.OracleDataSubmission
protocol_upgrade_proposalvega.commands.v1.ProtocolUpgradeProposal
issue_signaturesvega.commands.v1.IssueSignatures
batch_market_instructionsvega.commands.v1.BatchMarketInstructions

ValidatorRankingEvent

Event that explains the status of the validator for the coming epoch

NameTypeDescription
node_idstring
stake_scorestringStake based score - no anti-whaling
performance_scorestringPerformance base score
ranking_scorestringFinal score
previous_statusstringStatus of the validator in the previous epoch
next_statusstringStatus of the validator in the next epoch
epoch_seqstringEpoch seq for which the status is valid
tm_voting_poweruint32Tendermint voting power of the validator

ValidatorScoreEvent

ValidatorScoreEvent is the score a validator gets for a given epoch

NameTypeDescription
node_idstring
epoch_seqstring
validator_scorestring
normalised_scorestring
validator_performancestring
raw_validator_scorestring
validator_statusstring
multisig_scorestring

ValidatorUpdate

Validator update event contains information about validator node

NameTypeDescription
node_idstringNode ID of the validator node
vega_pub_keystringVega public key of validator node
ethereum_addressstringEthereum public key of validator node
tm_pub_keystringPublic key of Tendermint
info_urlstringURL with more info on the node
countrystringCountry code (ISO 3166-1 alpha-2) for the location of the node
namestringName of the validator
avatar_urlstringAvatarURL of the validator
vega_pub_key_indexuint32Vega public key derivation index
addedboolFlag indicating if the validator has been added to or removed from vega
from_epochuint64Epoch in which the announced pending node will start participating in the network
submitter_addressstringEthereum public key being used as the submitter to allow automatic signature generation
epoch_sequint64Epoch in which the node was announced or removed from the network

VestingBalancesSummary

Summary of the vesting and locked balances for an epoch

NameTypeDescription
epoch_sequint64Epoch for which these balances are valid.
parties_vesting_summaryrepeated PartyVestingSummaryParties' summaries.

VestingStatsUpdated

Stats of all parties invested in the vesting program.

NameTypeDescription
at_epochuint64Epoch at which the vesting statistics are updated.
statsrepeated PartyVestingStatsAll parties stats.

VolumeDiscountProgramEnded

NameTypeDescription
versionuint64Program update version.
idstringUnique ID of the volume discount program.
ended_atint64Time in Unix nanoseconds when the referral program ended.
at_epochuint64Epoch at which the referral program ended.

VolumeDiscountProgramStarted

NameTypeDescription
programvega.VolumeDiscountProgramVolume discount program that has started.
started_atint64Time in Unix nanoseconds when the volume discount program started.
at_epochuint64Epoch at which the volume discount program started.

VolumeDiscountProgramUpdated

NameTypeDescription
programvega.VolumeDiscountProgramThe updated volume discount program.
updated_atint64Time in Unix nanoseconds when the volume discount program was updated.
at_epochuint64Epoch at which the volume discount program was updated.

VolumeDiscountStatsUpdated

Stats of all parties eligible for volume discount.

NameTypeDescription
at_epochuint64Epoch at which the volume discount statistics are updated.
statsrepeated PartyVolumeDiscountStatsAll parties' stats.

Enums

BusEventType

Bus event type is used to specify a type of event It has 2 styles of event: Single values (e.g. BUS_EVENT_TYPE_ORDER) where they represent one data item Group values (e.g. BUS_EVENT_TYPE_AUCTION) where they represent a group of data items

NameNumberDescription
BUS_EVENT_TYPE_UNSPECIFIED0Default value, always invalid
BUS_EVENT_TYPE_ALL1Events of ALL event types, used when filtering stream from event bus
BUS_EVENT_TYPE_TIME_UPDATE2Event for blockchain time updates
BUS_EVENT_TYPE_LEDGER_MOVEMENTS3Event for when a transfer happens internally, contains the transfer information
BUS_EVENT_TYPE_POSITION_RESOLUTION4Event indicating position resolution has occurred
BUS_EVENT_TYPE_ORDER5Event for order updates, both new and existing orders
BUS_EVENT_TYPE_ACCOUNT6Event for account updates
BUS_EVENT_TYPE_PARTY7Event for party updates
BUS_EVENT_TYPE_TRADE8Event indicating a new trade has occurred
BUS_EVENT_TYPE_MARGIN_LEVELS9Event indicating margin levels have changed for a party
BUS_EVENT_TYPE_PROPOSAL10Event for proposal updates (for governance)
BUS_EVENT_TYPE_VOTE11Event indicating a new vote has occurred (for governance)
BUS_EVENT_TYPE_MARKET_DATA12Event for market data updates
BUS_EVENT_TYPE_NODE_SIGNATURE13Event for a new signature for a Vega node
BUS_EVENT_TYPE_LOSS_SOCIALIZATION14Event indicating loss socialisation occurred for a party
BUS_EVENT_TYPE_SETTLE_POSITION15Event for when a position is being settled
BUS_EVENT_TYPE_SETTLE_DISTRESSED16Event for when a position is distressed
BUS_EVENT_TYPE_MARKET_CREATED17Event indicating a new market was created
BUS_EVENT_TYPE_ASSET18Event for when an asset is added to Vega
BUS_EVENT_TYPE_MARKET_TICK19Event indicating a market tick event
BUS_EVENT_TYPE_WITHDRAWAL20Event for when a withdrawal occurs
BUS_EVENT_TYPE_DEPOSIT21Event for when a deposit occurs
BUS_EVENT_TYPE_AUCTION22Event indicating a change in auction state, for example starting or ending an auction
BUS_EVENT_TYPE_RISK_FACTOR23Event indicating a risk factor has been updated
BUS_EVENT_TYPE_NETWORK_PARAMETER24Event indicating a network parameter has been added or updated
BUS_EVENT_TYPE_LIQUIDITY_PROVISION25Event indicating a liquidity provision has been created or updated
BUS_EVENT_TYPE_MARKET_UPDATED26Event indicating a new market was created
BUS_EVENT_TYPE_ORACLE_SPEC27Event indicating an oracle spec has been created or updated
BUS_EVENT_TYPE_ORACLE_DATA28Event indicating that an oracle data has been broadcast
BUS_EVENT_TYPE_DELEGATION_BALANCE29Event indicating that an delegation balance of a party to a node for current epoch has changed
BUS_EVENT_TYPE_VALIDATOR_SCORE30Event indicating the validator score for the given epoch
BUS_EVENT_TYPE_EPOCH_UPDATE31Event indicating the start or end of an epoch
BUS_EVENT_TYPE_VALIDATOR_UPDATE32Event indicating that validator node has been updated
BUS_EVENT_TYPE_STAKE_LINKING33Event indicating a new staking event have been processed by the network
BUS_EVENT_TYPE_REWARD_PAYOUT_EVENT34Event indicating the payout of a reward has been initiated
BUS_EVENT_TYPE_CHECKPOINT35Event indicating a new checkpoint was created
BUS_EVENT_TYPE_STREAM_START36Event indicating stream is starting
BUS_EVENT_TYPE_KEY_ROTATION37Event indicating key rotation took place
BUS_EVENT_TYPE_STATE_VAR38Event indicating state transitions in state variable consensus
BUS_EVENT_TYPE_NETWORK_LIMITS39Event indicating network limits set or updated
BUS_EVENT_TYPE_TRANSFER40Event indicating a update for a transfer
BUS_EVENT_TYPE_VALIDATOR_RANKING41Event indicating the ranking of validator and their status in Vega
BUS_EVENT_TYPE_ERC20_MULTI_SIG_SIGNER_EVENT42Event indicating a new multi sig signer event have been processed
BUS_EVENT_TYPE_ERC20_MULTI_SIG_SET_THRESHOLD43Event indicating the erc20 multi sig threshold have been updated
BUS_EVENT_TYPE_ERC20_MULTI_SIG_SIGNER_ADDED44Event indicating a new signer has been added to the ERC-20 multisig
BUS_EVENT_TYPE_ERC20_MULTI_SIG_SIGNER_REMOVED45Event indicating a signer has been removed from the ERC-20 multisig
BUS_EVENT_TYPE_POSITION_STATE46Event indicating that a party's position has changed
BUS_EVENT_TYPE_ETHEREUM_KEY_ROTATION47Event indicating Ethereum key rotation took place
BUS_EVENT_TYPE_PROTOCOL_UPGRADE_PROPOSAL48Event indicating protocol upgrade proposal updates
BUS_EVENT_TYPE_BEGIN_BLOCK49Event indicating the core is starting to process a new block
BUS_EVENT_TYPE_END_BLOCK50Event indicating the core finished to process a block
BUS_EVENT_TYPE_PROTOCOL_UPGRADE_STARTED51Event indicating the core is starting a protocol upgrade
BUS_EVENT_TYPE_SETTLE_MARKET52Event indicating the market has stopped and settled
BUS_EVENT_TYPE_TRANSACTION_RESULT53Event indicating the result of a transaction processed by the network
BUS_EVENT_TYPE_SNAPSHOT_TAKEN54Event indicating a snapshot was taken at this block height
BUS_EVENT_TYPE_PROTOCOL_UPGRADE_DATA_NODE_READY55Event data node uses to notify that it is ready to upgrade
BUS_EVENT_TYPE_DISTRESSED_ORDERS_CLOSED56Event indicating parties had orders closed because they were distressed, but were not closed out.
BUS_EVENT_TYPE_EXPIRED_ORDERS57Event indicating parties had orders closed because they were distressed, but were not closed out.
BUS_EVENT_TYPE_DISTRESSED_POSITIONS58Event indicating parties have become, or were, distressed but still have an active position.
BUS_EVENT_TYPE_SPOT_LIQUIDITY_PROVISION59Event indicating a spot liquidity provision has been created or updated.
BUS_EVENT_TYPE_STOP_ORDER60Event indicating a stop order has been submitted or updated.
BUS_EVENT_TYPE_FUNDING_PERIOD61Event indicating the start or end of a funding period.
BUS_EVENT_TYPE_FUNDING_PERIOD_DATA_POINT62Event indicating a data point for a funding period has been received.
BUS_EVENT_TYPE_TEAM_CREATED63Event indicating a team has been created.
BUS_EVENT_TYPE_TEAM_UPDATED64Event indicating a team has been updated.
BUS_EVENT_TYPE_REFEREE_SWITCHED_TEAM65Event indicating a referee switched team.
BUS_EVENT_TYPE_REFEREE_JOINED_TEAM66Event indicating a referee joined a team.
BUS_EVENT_TYPE_REFERRAL_PROGRAM_STARTED67Event indicating a referral program started.
BUS_EVENT_TYPE_REFERRAL_PROGRAM_UPDATED68Event indicating a referral program has been updated.
BUS_EVENT_TYPE_REFERRAL_PROGRAM_ENDED69Event indicating a referral program ended.
BUS_EVENT_TYPE_REFERRAL_SET_CREATED70Event indicating a set has been created.
BUS_EVENT_TYPE_REFEREE_JOINED_REFERRAL_SET71Event indicating a referee joined a set.
BUS_EVENT_TYPE_PARTY_ACTIVITY_STREAK72Event indicating the updated activity streak for a party
BUS_EVENT_TYPE_VOLUME_DISCOUNT_PROGRAM_STARTED73Event indicating a volume discount program started.
BUS_EVENT_TYPE_VOLUME_DISCOUNT_PROGRAM_UPDATED74Event indicating a volume discount program has been updated.
BUS_EVENT_TYPE_VOLUME_DISCOUNT_PROGRAM_ENDED75Event indicating a volume discount program ended.
BUS_EVENT_TYPE_REFERRAL_SET_STATS_UPDATED76Event indicating the updated statistics for a referral set.
BUS_EVENT_TYPE_VESTING_STATS_UPDATED77Event indicating the updated statistics for the vesting program.
BUS_EVENT_TYPE_VOLUME_DISCOUNT_STATS_UPDATED78Event indicating the updated statistics for the volume discount.
BUS_EVENT_TYPE_FEES_STATS_UPDATED79Event indicating the fees statistics per market at end of epoch
BUS_EVENT_TYPE_FUNDING_PAYMENTS80Event indicating a funding period has ended and resulted in funding payment transfers.
BUS_EVENT_TYPE_PAID_LIQUIDITY_FEES_STATS_UPDATED81Event used to report the updated paid liquidity fee statistics for the market at the end of the epoch
BUS_EVENT_TYPE_VESTING_SUMMARY82Event used to report the summary of vesting and locked balances at the end of the epoch
BUS_EVENT_TYPE_TRANSFER_FEES_PAID83Event used to link ledger entries to the transfer that triggered the fees being collected.
BUS_EVENT_TYPE_TRANSFER_FEES_DISCOUNT_UPDATED84Event indicating that a party's available transfer fee discount has changed, per asset.
BUS_EVENT_TYPE_PARTY_MARGIN_MODE_UPDATED85Event indicating that a party updated their margin mode on a market.
BUS_EVENT_TYPE_PARTY_PROFILE_UPDATED86Event indicating that a party updated their profile.
BUS_EVENT_TYPE_TEAMS_STATS_UPDATED87Event indicating that teams' statistics have been updated.
BUS_EVENT_TYPE_MARKET101Event indicating a market related event, for example when a market opens
BUS_EVENT_TYPE_TX_ERROR201Event used to report failed transactions back to a user, this is excluded from the ALL type

ERC20MultiSigSignerEvent.Type

NameNumberDescription
TYPE_UNSPECIFIED0
TYPE_ADDED1
TYPE_REMOVED2

FundingPeriodDataPoint.Source

NameNumberDescription
SOURCE_UNSPECIFIED0Default value
SOURCE_EXTERNAL1Data point is from an external data source, such as an oracle, and represents the spot price of the underlying asset.
SOURCE_INTERNAL2Data point from within Vega such as the mark price after performing mark-to-market.

ProtocolUpgradeProposalStatus

NameNumberDescription
PROTOCOL_UPGRADE_PROPOSAL_STATUS_UNSPECIFIED0
PROTOCOL_UPGRADE_PROPOSAL_STATUS_PENDING1The proposal is pending
PROTOCOL_UPGRADE_PROPOSAL_STATUS_APPROVED2The proposal is approved
PROTOCOL_UPGRADE_PROPOSAL_STATUS_REJECTED3The proposal is rejected

StakeLinking.Status

NameNumberDescription
STATUS_UNSPECIFIED0Default value
STATUS_PENDING1Indicates an event waiting for confirmation from the Vega network
STATUS_ACCEPTED2Indicates an event accepted by the Vega network
STATUS_REJECTED3Indicates an event rejected by the Vega network

StakeLinking.Type

NameNumberDescription
TYPE_UNSPECIFIED0Default value
TYPE_LINK1Indicate of a stake deposit instruction
TYPE_UNLINK2Indicate of a stake remove instruction

Transfer.Status

NameNumberDescription
STATUS_UNSPECIFIED0Default value
STATUS_PENDING1Indicates a transfer still being processed
STATUS_DONE2Indicates a transfer accepted by the Vega network
STATUS_REJECTED3Indicates a transfer rejected by the Vega network
STATUS_STOPPED4Indicates a transfer stopped by the Vega network e.g: no funds left to cover the transfer
STATUS_CANCELLED5Indicates a transfer cancelled by the user