package
0.79.0-preview.4
Repository: https://github.com/vegaprotocol/vega.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
RegisterTradingDataServiceHandler registers the http handlers for service TradingDataService to "mux".
RegisterTradingDataServiceHandlerClient registers the http handlers for service TradingDataService to "mux".
RegisterTradingDataServiceHandlerFromEndpoint is same as RegisterTradingDataServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterTradingDataServiceHandlerServer registers the http handlers for service TradingDataService to "mux".
No description provided by the author

# Constants

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
AMM bounds are too wide for the given commitment resulting in too many zero volume price levels.
Commitment is below the global limit set by the network parameter `market.amm.minCommitmentQuantum`.
AMM's lower price is too far from the base price for the given commitment resulting in too many zero volume price levels.
No description provided by the author
AMM's upper price is too far from the base price for the given commitment resulting in too many zero volume price levels.
LedgerEntryField_LEDGER_ENTRY_FIELD_ACCOUNT_FROM_ID
No description provided by the author
LedgerEntryField_LEDGER_ENTRY_FIELD_ACCOUNT_TO_ID
No description provided by the author
LedgerEntryField_LEDGER_ENTRY_FIELD_TRANSFER_TYPE
No description provided by the author
LedgerEntryField_LEDGER_ENTRY_FIELD_UNSPECIFIED
No description provided by the author
List all proposals.
Proposal to cancel a transfer.
List change Vega network parameter proposals.
New asset proposals.
Proposal for new automated purchase auction.
Proposals for creating a new free form proposal.
List new market proposals.
Propose a new spot market.
Propose a new transfer.
No description provided by the author
Update asset proposals.
List update market proposals.
Proposal for updating the state of a market.
Proposal to update the referral program.
Update an existing spot market.
Proposal to update the volume discount program.
Matches transfers that have dispatch strategy scope of individual set.
Matches transfers that have dispatch strategy scope of team set.
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

# Variables

Enum value maps for AccountField.
Enum value maps for AccountField.
Enum value maps for EstimateAMMBoundsResponse_AMMError.
Enum value maps for EstimateAMMBoundsResponse_AMMError.
No description provided by the author
Enum value maps for LedgerEntryField.
Enum value maps for LedgerEntryField.
Enum value maps for ListGovernanceDataRequest_Type.
Enum value maps for ListGovernanceDataRequest_Type.
Enum value maps for ListTransfersRequest_Scope.
Enum value maps for ListTransfersRequest_Scope.
Enum value maps for Table.
Enum value maps for Table.
TradingDataService_ServiceDesc is the grpc.ServiceDesc for TradingDataService service.
Enum value maps for TransferDirection.
Enum value maps for TransferDirection.

# Structs

Represents the current balance of an account for an asset on Vega, for a particular owner or party.
Account data item with the corresponding cursor.
Account filter is used to filter account data.
Page of accounts data and corresponding page information.
'Initial image' snapshot containing current account balances - may be sent over several response messages.
List of account updates in the last block.
AggregatedBalance data contains the balance of the set of requested accounts combined with corresponding party ID, market ID and account type details.
Page of aggregated balance objects and corresponding page information.
Aggregated balance data with the corresponding cursor.
Page of aggregated ledger entries data and corresponding page information.
Represents the aggregated ledger entry data with corresponding cursor for it.
Represents an aggregated view of ledger entry data, sender and receiver accounts, details and balances for both sides after the transfer has been made.
No description provided by the author
No description provided by the author
Assets data with the corresponding cursor.
Page of asset data and corresponding page information.
Represents the high, low, open, and closing prices for an interval of trading, referred to commonly as a candlestick or candle.
Page of candles data and corresponding page information.
Candle data with the corresponding cursor.
Actual data regarding a checkpoint.
Checkpoint data with the corresponding cursor.
Page of checkpoints data and corresponding page information.
Estimates the additional funds needed to support the specified position.
Page of core snapshot data and corresponding page information.
Core snapshot data with the corresponding cursor.
Date range for queries that can return historical data Timestamps should be provided as unix time in Unix nanoseconds and are inclusive.
Delegation data with the corresponding cursor.
Page of delegations data and corresponding page information.
Deposits data with the corresponding cursor.
Page of deposits data received and corresponding page information.
Page of rewards summary data for epoch and corresponding page information.
Rewards summary data for epoch with the corresponding cursor.
Signature bundle data to be added.
Signature bundle data that is to be added with the corresponding cursor.
Page of signature data items to be added and corresponding page information.
Signature data that is to be added with the corresponding cursor.
Signature bundle data to be removed.
Signature bundle data to be removed, with the corresponding cursor.
Page of signature data items to be removed and corresponding page information.
Signature data to be removed with the corresponding cursor.
No description provided by the author
No description provided by the author
Request to fetch the estimated fee if an order were to trade immediately.
Response that is received from EstimateFeeRequest, contains the estimated fees for a given order.
Request to fetch the estimated MarginLevels if an order were to trade immediately Deprecated: Do not use.
Response to an estimate margin request, containing the estimated margin levels for a given order Deprecated: Do not use.
Request for the estimated margin level, margin account balance change, and liquidation price for the specified position.
Response for the estimated margin level, margin account balance change, and liquidation price for the specified position.
Request an estimation of transfer fee and discount.
Results of estimation of transfer fee and the fee discount.
Ethereum key rotation data with the corresponding cursor.
Page of Ethereum key rotations data and corresponding page information.
Request that is sent when exporting ledger entries to csv.
Request to export network history data in CSV format.
No description provided by the author
A funding payment for a party on a perpetual market.
Page of funding payment data and corresponding page information.
Funding payment data with the corresponding cursor.
Page of funding period data and corresponding page information.
Page of funding period data points and corresponding page information.
Funding period data point with the corresponding cursor.
Funding period data with the corresponding cursor.
Data relating to a game.
No description provided by the author
No description provided by the author
Game information and corresponding cursor.
Page of party game scores data and corresponding page information.
No description provided by the author
No description provided by the author
Page of games data and corresponding page information.
Page of team game scores data and corresponding page information.
No description provided by the author
No description provided by the author
Request to get the addresses of active network history peers.
Response containing the addresses of active network history peers.
Request for obtaining asset.
Response from getting an asset.
Request that is used when querying balance history.
Response that is received when querying for balance history.
Request to get the current referral program.
Response containing the current referral program.
Request to get the current referral program.
Response containing the current referral program.
Request to get the current volume rebate program.
Response containing the current volume rebate program.
Request to get data about a specific deposit by ID.
Response that is received from getting deposit data.
Request to fetch epoch data Provide either the epoch ID or the block height to get the epoch for.
Response from getting epoch.
Request for listing the signature bundle to an ERC-20 token in the collateral bridge.
Response from listing the signature bundle to an ERC-20 token in the collateral bridge.
Request for the signature bundle to update the token limits i.e.
Response for the signature bundle to update the token limits i.e.
Request to get all information required to bundle the call to finalise the withdrawal on the erc20 bridge.
Response with all information required to bundle the call to finalise the withdrawal on the erc20 bridge function withdraw_asset(address asset_source, uint256 asset_id, uint256 amount, uint256 expiry, uint256 nonce, bytes memory signatures).
Request that is sent to retrieve fees statistics for a given party.
Response that is sent when requesting fees statistics for a given party.
Request that is sent to retrieve fees statistics.
Response that is sent when requesting fees statistics.
Request to get governance data.
Response from getting governance data.
Request for the latest trade that occurred on Vega for a given market.
Response for the latest trade that occurred on Vega for a given market.
Request that is sent when listing the latest market data for a given market.
Response that is received when listing the latest market data for a given market.
Request that is sent when requesting latest market depth data.
Response that is received when latest market depth data is queried.
Request that is sent for getting Market Data History.
Response that is received when querying Market Data History.
Request for getting a market by ID.
Response from getting a market by ID.
Request to get the most recent history segment.
Response from getting most recent history segment.
Request to get network data.
Response from getting network data.
Request to get the nodes network history bootstrap peers.
Response containing the nodes network history bootstrap peers.
Request to get the status of network history.
Response containing the status of network history.
Request that is used to query current network limits.
Response received when querying the current network limits.
Request for a single network parameter.
Response that is received when getting a network parameter.
Request to get node data.
Response from getting node.
Request to get a specific oracle spec by its ID.
Response for a oracle spec.
Request that is sent when executing the query for getting a single order.
Response received from the query for getting a single order.
Request to get a party's activity streaks across epochs.
Response when getting a party's activity streaks across epochs.
No description provided by the author
No description provided by the author
Request to get party by ID.
Response from getting party by ID.
Request sent to get statistics about the vesting rewards for a party.
Vesting reward statistics for a given party.
Request to get protocol upgrade status.
Response from getting protocol upgrade status.
Request to get a referral set's stats.
Response containing the volume discount statistics for the given epoch.
Request to get risk factor.
Response that is received from getting a risk factor.
Request to get stake.
Response that is received from requesting stake information.
Request that is sent when executing the query for getting a single stop order.
Response received from the query for getting a single stop order.
Request to retrieve the time weighted notional position for a party and asset.
Response containing the time weighted notional position for a party and asset.
Get total transfer fee discount available.
Returns total transfer fee discount available.
Request that is sent for getting a transfer by ID.
Response that is received when querying transfers by ID.
Request to get the current time of the Vega network.
Response for the current consensus coordinated time on the Vega network, referred to as "VegaTime".
Request sent to list the vesting and locked balances for a party.
List of vesting and locked balances for a party.
Request to get the volume discount statistics for a given epoch.
Response containing the volume discount statistics for the given epoch.
Request to get the volume rebate statistics for a given epoch.
Response containing the volume rebate statistics for the given epoch.
Request to get a specific withdrawal by ID.
Response for a withdrawal request.
Page of governance data and corresponding page information.
Governance data with the corresponding cursor.
Describes a network history segment.
List of individuals that are participating in a game.
Data relating to an individual participating in a game.
Request that is sent when querying node information.
Response that is received from the node information query.
Maps an interval for a given market to its corresponding candle ID.
Page of key rotations data and corresponding page information.
Key rotation data with the corresponding cursor.
Ledger entry filter sets filters on returned set of ledger entries.
Liquidation estimate for both worst and best case possible.
Liquidation price estimate for either only the current open volume and position given some or all buy orders get filled, or position given some or all sell orders get filled.
Liquidity provider information.
Page of liquidity provider data and corresponding page information.
Liquidity provider data with the corresponding cursor.
Liquidity provider commitment.
Page of liquidity provisions data and corresponding page information.
Liquidity provision data with the corresponding cursor.
Page of liquidity provisions data and corresponding page information.
Liquidity provision data with the corresponding cursor.
Request that is sent when listing accounts.
Response that is received from listing accounts query.
Request for listing liquidity provisions.
Response from listing liquidity provisions.
Request to list all the nodes history segments.
Response with a list of all the nodes history segments.
Request to list positions, given the position filter is supplied.
Response to query for listing of positions, given the filter is supplied.
No description provided by the author
No description provided by the author
Request for listing assets data.
Response from listing assets.
Request to use when querying balances changes.
Response that is received from querying balances changes.
Request that is used when listing candles for a market at an interval.
Response for list of candles for a market at an interval.
Request that is used to fetch a list of supported intervals for the given market along with the corresponding candle ID.
List of mapped pairs `interval` -> `candle ID` for a given market.
Request to get all checkpoints.
Response message containing all checkpoints requested.
Request type for ListCoreSnapshots; fetches a paginated list of the core snapshots.
Response from a ListCoreSnapshots RPC call; a paginated list of the core snapshots.
Request for listing delegations.
Response from listing delegations.
Request to list all deposits for a given party.
Response from listing deposits.
Request to list all entities that were created by the given transaction hash.
Response from listing entities that were created for a given transaction hash.
Request to get summary of reward per epoch for a given range of epochs.
Return message with reward details in for a single party.
Request for adding a signature bundle to the signer list of a multisig contract for a particular validator.
Response from adding a signature bundle to the signer list of a multisig contract for a particular validator.
Request for removing a signature bundle from the signer list of the multisig contract for a particular validator.
Response when removing a signature bundle from the signer list of the multisig contract for a particular validator.
Request to list ethereum key rotations for nodes, optionally filtered by node.
Response message containing Ethereum key rotations.
Request to list a a party's funding payments.
Response from listing funding payments.
No description provided by the author
Response from listing funding period data points.
Request to list a perpetual market's funding periods.
Response from listing funding periods.
Request that is sent when executing a query for a list of party game scores.
Response received from the query for getting a list of game scores for teams.
Request to retrieve games data.
Response containing games data.
Request that is sent when executing a query for a list of team game scores.
Response received from the query for getting a list of game scores for teams.
Request to list governance data.
Response from listing governance data.
Request to list all key rotations.
Response message containing Vega key rotations.
Request that is sent when listing the latest market data for every market.
Response that is received when listing the latest market data for every market.
Request that is sent when listing ledger entries.
Response that is received when listing ledger entries.
Request for listing active liquidity providers for a given market.
Response for listing liquidity providers.
Request for listing liquidity provisions.
Response from listing liquidity provisions.
Request for listing margin levels.
Response from listing margin levels.
Request for listing markets.
Response from listing markets.
Message requesting for the list of all network parameters.
Response containing all of the Vega network parameters.
Request to specify the ID of the resource to retrieve aggregated signatures for.
Response to specify the ID of the resource to retrieve aggregated signatures for.
Request to list nodes.
Response from listing nodes.
Request to get all seen oracle data.
Response to get all seen oracle data.
Request to get all active oracle specs.
Response to get all active oracle specs.
Request that is sent when executing a query for a list of orders.
Response that is received from the query to list orders.
Request that is sent when listing possible order versions.
Response that is received when listing possible order versions.
Paid liquidity fees request.
Paid liquidity fees response.
Request to list profiles by party ID.
Response from listing parties' profiles.
Request to list parties by ID.
Response from listing parties.
Request to retrieve party margin modes.
Response containing party margin modes.
Request used to list all positions for a party.
Response for a list of positions for a party Deprecated: Do not use.
Request type for ListProtocolUpgradeProposals; fetches a paginated list of protocol upgrade proposals.
Response type from a ListProtocolUpgradeProposals RPC call; a paginated list of protocol upgrade proposals.
Request to retrieve information about a referral set's referees.
Response containing information about a referral set's referees.
Request to retrieve information about a referral set or sets.
Response containing information about a referral set or sets.
Request to get reward details for a party.
Response for listing reward details for a single party.
Request to get reward details for a party.
Response from listing reward details in for a single party.
Request that is sent when executing a query for a list of stop orders.
Response that is received from the query to list stop orders.
Request for listing successor markets.
Response from a list successor markets request.
Request to list all team members' statistics.
Response for the list team members' statistics request containing the statistics.
Request that is sent when listing the referee history for a given team.
Response that is sent when listing the referee history for a given team.
Request that is sent when listing the referees for a given team.
Response that is sent when listing the referees for a given team.
Request to list all teams.
Response for the list teams request containing the team information.
Request to list all teams' statistics.
Response for the list teams' statistics request containing the statistics.
Request to list trades.
Response from listing trades.
Request that is sent to list transfers.
Response that is received when listing transfers.
Request that is used to list governance votes.
Response that is received when listing Votes.
List all withdrawals for a given party.
Response from listing withdrawals data.
Page of margins data and corresponding page information.
Margin data with the corresponding cursor.
Margin level estimate for both worst and best case possible.
Page of markets and corresponding page information.
Page of market data items and corresponding page information.
Market data with the corresponding cursor.
Market information with the corresponding cursor.
No description provided by the author
Page of network parameters and corresponding page information.
Network parameter with the corresponding cursor.
Represents a basic node without any epoch specific details like delegations, staking, rewards etc.
Node data with the corresponding cursor.
Page of node data and corresponding page information.
Nodes signature edge with the corresponding cursor.
Page of node signatures and corresponding page information.
Request that is sent when getting a subscription to a stream of accounts.
Response that is received when subscribing to a stream of accounts.
No description provided by the author
No description provided by the author
Request that is used to subscribe to a stream of candles.
Response that is received when subscribing to a stream of candles.
Request to subscribe to all event related to delegations, with the given filters.
Response with all events related to delegations, with the given filters.
Request to subscribe to a stream of one or more event types from the Vega event bus.
Response to a subscribed stream of events from the Vega event bus.
Request for governance subscription.
Response from governance subscription.
Request to subscribe to ledger movements.
Response from ledger movements subscription.
Request sent to subscribe to liquidity provisions.
Response from liquidity provisions subscription.
Request to subscribe to a stream of MarginLevels data.
Response from subscribing to margin levels data.
Request that is sent for market data subscription.
Response that is received for market data subscription.
Request that is sent to get market depth subscription.
Response that is received for MarketDepth subscription.
Request that is sent for market depth update subscription.
Response that is received for market depth update subscription.
Request to subscribe to a stream of orders.
Response that is received from an orders subscription.
No description provided by the author
No description provided by the author
Request that is used to subscribe to a stream of positions.
Response received from a positions subscription request.
No description provided by the author
No description provided by the author
Request sent for subscribing to rewards.
Response that is received from subscribing to rewards data.
Request to subscribe to a stream of trades.
Stream of trades.
Request to subscribe to a stream of users' transaction results.
Stream of transaction results.
Request that is sent to subscribe to votes.
Response that is received from votes subscription.
Page of oracle data and corresponding page information.
Oracle data item with the corresponding cursor.
Oracle specs data item with the corresponding cursor.
Page of oracle specs and corresponding page information.
Page of orders data and corresponding page information.
Order data with the corresponding cursor.
Order filter that contains all filtering conditions and values that are applied to the orders listing.
Basic description of an order.
'Initial image' of live orders, may be sent over multiple response messages.
List of order updates in the last block.
Page information for cursor based pagination.
All data returned from the API is ordered in a well-defined manner.
Paid liquidity fees data and corresponding page information.
Paid liquidity fees data with the corresponding cursor.
Page of profile data per party and corresponding page information.
Page of parties data and corresponding page information.
Party data with the corresponding cursor.
Margin mode selected for the given party and market.
Party margin mode information and corresponding cursor.
Page of party margin modes data and corresponding page information.
Party's profile data with the corresponding cursor.
Request to ping the data node.
Ping response from the data node.
Page of positions and corresponding page information.
Position data with the corresponding cursor.
Filter to apply to the ListAllPositionsRequest.
'Initial image' of current positions, may be sent over multiple response messages.
List of position updates in the last block.
Page of protocol upgrade proposals and corresponding page information.
Protocol upgrade proposal data with the corresponding cursor.
No description provided by the author
No description provided by the author
Referral program details.
Data relating to a referral set.
Page of referral set data and corresponding page information.
Referral set data with the corresponding cursor.
Data relating to referees that have joined a referral set.
Page of data about the referral set's referees and corresponding page information.
Data about the Referral set's referees with the corresponding cursor.
Referral set statistics for a given epoch for a party.
Page of volume discount stats data and corresponding page information.
Referral set stats data with the corresponding cursor.
Rewards data with the corresponding cursor.
Page of rewards data and corresponding page information.
Filter to restrict the results returned by the ListEpochRewardSummaries.
Stake linking data with the corresponding cursor.
Page of stake data and corresponding page information.
Page of stop orders data and corresponding page information.
Order data with the corresponding cursor.
Stop order filter Stop order filter that contains all filtering conditions and values that are applied to the stop orders listing.
Successor market information includes the market that is a member of the succession line and any governance data that is associated with proposals for child markets whether enacted or not.
Page of successor market records and corresponding page information.
Successor market record with the corresponding cursor for paginated results.
Team record containing the team information.
Page of team data and corresponding page information.
Team data item with the corresponding cursor.
List of teams that are participating in a game.
Data relating to a team participating in a game.
Breakdown of a team's participation in a game.
Page of team members' statistics and corresponding page information.
Team member's statistics record containing the team member's information.
Team member data item with the corresponding cursor.
A team's referee info.
Page of team referee data and corresponding page information.
Team referee data item with the corresponding cursor.
A referee's team change information.
Page of history data about a referee's team membership and corresponding page information.
Team referee history data item with the corresponding cursor.
Page of teams' statistics and corresponding page information.
Team's statistics record containing the team information.
Team data item with the corresponding cursor.
Time weighted notional position for a party and asset at a given epoch.
Page of trades and corresponding page information.
Trade data item with the corresponding cursor..
Page of transfers data items and corresponding page information.
Transfers data with the corresponding cursor.
No description provided by the author
UnimplementedTradingDataServiceServer must be embedded to have forward compatible implementations.
Volume discount program details.
Volume discount statistics for a given epoch for all parties.
Page of volume discount stats data and corresponding page information.
Volume discount stats data with the corresponding cursor.
Volume rebate program details.
Volume discount statistics for a given epoch for all parties.
Page of volume rebate stats data and corresponding page information.
Volume rebate stats data with the corresponding cursor.
Page of vote data items and corresponding page information.
Votes data with the corresponding cursor.
Withdrawals data with the corresponding cursor.
Page of withdrawals data and corresponding page information.

# Interfaces

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
No description provided by the author
No description provided by the author
TradingDataServiceClient is the client API for TradingDataService service.
TradingDataServiceServer is the server API for TradingDataService service.
UnsafeTradingDataServiceServer may be embedded to opt out of forward compatibility for this service.

# Type aliases

List of the properties of an account, used for grouping.
No description provided by the author
List of fields for a ledger entry.
Filter for the types of governance proposals to view.
Defines the types of a dispatch strategy's scope the API can filter on.
No description provided by the author
Direction of a transfer.