package
0.79.0-preview.4
Repository: https://github.com/vegaprotocol/vega.git
Documentation: pkg.go.dev
# Functions
ErrorMap returns a map of error to code, which is a mapping between API errors and Vega API specific numeric codes.
NewDefaultConfig creates an instance of the package specific configuration, given a pointer to a logger instance to be used for logging within the package.
NewGRPC create a new instance of the GPRC api for the vega node.
# Variables
AccountService...
AccountService...
API Errors and descriptions.
ErrAmendOrder is returned when amending an order fails for some reason.
Blockchain...
API Errors and descriptions.
API Errors and descriptions.
API Errors and descriptions.
ErrCancelOrder is returned when cancelling an order fails for some reason.
CandleService...
ErrChainNotConnected signals to the user that he cannot access a given endpoint which require the chain, but the chain is actually offline.
ErrChannelClosed signals that the channel streaming data is closed.
ErrEmptyMissingMarketID signals to the caller that the request expected a market id but the field is missing or empty.
ErrEmptyMissingOrderID signals to the caller that the request expected an order id but the field is missing or empty.
ErrEmptyMissingOrderReference signals to the caller that the request expected an order reference but the field is missing or empty.
ErrEmptyMissingPartyID signals to the caller that the request expected a party id but the field is missing or empty.
ErrEmptyMissingSinceTimestamp signals to the caller that the request expected a timestamp but the field is missing or empty.
ErrInvalidMarketID signals that the market ID does not exists.
No description provided by the author
ErrMalformedRequest signals that the request was malformed.
API Errors and descriptions.
API Errors and descriptions.
API Errors and descriptions.
MarketService...
ErrMissingAsset signals that an asset was required but not specified.
ErrMissingDepositID is returned when the ID is missing from the request.
ErrMissingOracleSpecID is returned when the ID is missing from the request.
ErrMissingOrder signals that the actual payload is expected to contains an order.
API Errors and descriptions.
ErrMissingPartyID signals that the payload is expected to contain a party id.
ErrMissingProposalID returned if proposal with this id is missing.
ErrMissingProposalReference returned if proposal with this reference is not found.
ErrMissingWithdrawalID is returned when the ID is missing from the request.
ErrNotMapped is when an error cannot be found in the current error map/lookup table.
API Errors and descriptions.
OrderService...
API Errors and descriptions.
API Errors and descriptions.
API Errors and descriptions.
PartyService...
API Errors and descriptions.
RiskService...
ErrServerShutdown signals to the client that the server is shutting down.
ErrStreamClosed signals to the users that the grpc stream is closing.
ErrStreamInternal signals to the users that the grpc stream has an internal problem.
ErrSubmitOrder is returned when submitting an order fails for some reason.
No description provided by the author
TimeService...
API Errors and descriptions.
API Errors and descriptions.
TradeService...
API Errors and descriptions.
No description provided by the author
# Structs
Config represents the configuration of the api package.
GRPCServer represent the grpc api provided by the vega node.
RESTGatewayServiceConfig represent the configuration of the rest service.
# Interfaces
Blockchain ..
go:generate go run github.com/golang/mock/mockgen -destination mocks/event_service_mock.go -package mocks code.vegaprotocol.io/vega/core/api EventService.
EvtForwarder
go:generate go run github.com/golang/mock/mockgen -destination mocks/evt_forwarder_mock.go -package mocks code.vegaprotocol.io/vega/core/api EvtForwarder.
No description provided by the author
No description provided by the author
No description provided by the author
TimeService ..