General code for tracking pending moves in a GSP #79
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Allow the ZmqSubscriber to have more than one socket, and read from them in a multiplexed fashion using zmq::poll. For now, we still have at most one socket open, but that will change when we support also receiving notifications about pending moves.
This extends the ZmqSubscriber class so that it can listen to pending move notifications in addition to block attach/detach ones. This works both if the notifications are on a separate address or on the same as block messages.
Expose the getrawmempool method of Xaya Core in the RPC stub. This method will be useful for the handling of pending moves (because we can use it to compare our list of pending moves to the real mempool and make sure we expunge spurious entries from time to time).
This creates the new class GameProcessorWithContext, which holds the game ID, chain and Xaya Core RPC connection. That way, we can reuse that code for the upcoming processor of pending moves.
This adds the new class PendingMoveProcessor, which allows subclasses to receive updates about pending moves and build a "pending state". It has logic to track currently known pending moves, sync them with Xaya Core's mempool using getrawmempool, and to construct the "correct" pending state when blocks or new transactions come in.
This adds support for tracking pending moves to the Game class. It will auto-detect the ZMQ endpoint for pending moves alongside of the one for block notifications. Also, one can (optionally) attach a PendingMoveProcessor instance, which will then be kept up-to-date with incoming moves and block attaches/detaches.
Allow the default main functions to install a PendingMoveProcessor. To do so, the instance must be created and managed outside of the default main, and passed to it in the GameDaemonConfiguration struct.
This adds the new method Game::GetPendingJsonState, which exposes the pending state (if it is tracked) as JSON from the Game instance. It is also exposed by the default GameRpcServer with the new method "getpendingstate".
domob1812
added a commit
that referenced
this pull request
Aug 7, 2019
General code for tracking pending moves in a GSP
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This set of changes adds core support for tracking pending moves in a GSP (as described in #43). It defines an abstract class
PendingMoveProcessor, which games can subclass if they want to do game-specific processing of a "pending state". If this feature is enabled, then libxayagame will listen to thezmqgamependingnotifications sent from Xaya Core and keep the pending state updated as well as is possible.Note that with these changes in, there are still some things to do that will come later: Support in mover and integration tests with it, a
waitforchangeequivalent for the pending state, and support forSQLiteGamewith integration in Xayaships.