History

Eduard S 3b99953007 Redo coordinator structure, connect API to node - API: - Modify the constructor so that hardcoded rollup constants don't need to be passed (introduce a `Config` and use `configAPI` internally) - Common: - Update rollup constants with proper *big.Int when required - Add BidCoordinator and Slot structs used by the HistoryDB and Synchronizer. - Add helper methods to AuctionConstants - AuctionVariables: Add column `DefaultSlotSetBidSlotNum` (in the SQL table: `default_slot_set_bid_slot_num`), which indicates at which slotNum does the `DefaultSlotSetBid` specified starts applying. - Config: - Move coordinator exclusive configuration from the node config to the coordinator config - Coordinator: - Reorganize the code towards having the goroutines started and stopped from the coordinator itself instead of the node. - Remove all stop and stopped channels, and use context.Context and sync.WaitGroup instead. - Remove BatchInfo setters and assing variables directly - In ServerProof and ServerProofPool use context instead stop channel. - Use message passing to notify the coordinator about sync updates and reorgs - Introduce the Pipeline, which can be started and stopped by the Coordinator - Introduce the TxManager, which manages ethereum transactions (the TxManager is also in charge of making the forge call to the rollup smart contract). The TxManager keeps ethereum transactions and: 1. Waits for the transaction to be accepted 2. Waits for the transaction to be confirmed for N blocks - In forge logic, first prepare a batch and then wait for an available server proof to have all work ready once the proof server is ready. - Remove the `isForgeSequence` method which was querying the smart contract, and instead use notifications sent by the Synchronizer to figure out if it's forging time. - Update test (which is a minimal test to manually see if the coordinator starts) - HistoryDB: - Add method to get the number of batches in a slot (used to detect when a slot has passed the bid winner forging deadline) - Add method to get the best bid and associated coordinator of a slot (used to detect the forgerAddress that can forge the slot) - General: - Rename some instances of `currentBlock` to `lastBlock` to be more clear. - Node: - Connect the API to the node and call the methods to update cached state when the sync advances blocks. - Call methods to update Coordinator state when the sync advances blocks and finds reorgs. - Synchronizer: - Add Auction field in the Stats, which contain the current slot with info about highest bidder and other related info required to know who can forge in the current block. - Better organization of cached state: - On Sync, update the internal cached state - On Init or Reorg, load the state from HistoryDB into the internal cached state.		4 years ago
..
README.md	Swagger Review	4 years ago
account.go	Refactor api pagination	4 years ago
account_test.go	Integrate til into api	4 years ago
accountcreationauths.go	Put api DBs into struct	4 years ago
accountcreationauths_test.go	Account API	4 years ago
api.go	Redo coordinator structure, connect API to node	4 years ago
api_test.go	Redo coordinator structure, connect API to node	4 years ago
aux_test.go	Add til api test first commit	4 years ago
batch.go	Integrate til into api	4 years ago
batch_test.go	Integrate til into api	4 years ago
bids.go	Refactor api pagination	4 years ago
bids_test.go	Integrate til into api	4 years ago
config.go	Redo coordinator structure, connect API to node	4 years ago
config_test.go	Redo coordinator structure, connect API to node	4 years ago
coordinator.go	Refactor api pagination	4 years ago
coordinator_test.go	Integrate til into api	4 years ago
docker-compose.yml	Add GET histroy-transactions endpoint	4 years ago
exits.go	Refactor api pagination	4 years ago
exits_test.go	Integrate til into api	4 years ago
handlers.go	Put api DBs into struct	4 years ago
parsers.go	Redo coordinator structure, connect API to node	4 years ago
parsers_test.go	API add bids endpoint	4 years ago
run.sh	Add struct get state endpoint	4 years ago
slots.go	Integrate til into api	4 years ago
slots_test.go	Integrate til into api	4 years ago
state.go	Integrate til into api	4 years ago
state_test.go	Integrate til into api	4 years ago
swagger.yml	Integrate til into api	4 years ago
token.go	Refactor api pagination	4 years ago
token_test.go	Integrate til into api	4 years ago
txshistory.go	Refactor api pagination	4 years ago
txshistory_test.go	Integrate til into api	4 years ago
txspool.go	Put api DBs into struct	4 years ago
txspool_test.go	Integrate til into api	4 years ago

README.md

Hermez API

Easy to deploy and scale API for Hermez operators. You will need to have docker and docker-compose installed on your machine in order to use this repo.

Documentation

As of now the documentation is not hosted anywhere, but you can easily do it yourself by running ./run.sh doc and then opening the documentation in your browser

Mock Up

To use a mock up of the endpoints in the API run ./run.sh doc (UI + mock up server) or ./run.sh mock (only mock up server). You can play with the mocked up endpoints using the web UI, importing swagger.yml into Postman or using your preferred language and using http://localhost:4010 as base URL.

Editor

It is recomended to edit swagger.yml using a dedicated editor as they provide spec validation and real time visualization. Of course you can use your prefered editor. To use the editor run ./run.sh editor and then opening the editor in your browser. Keep in mind that you will need to manually save the file otherwise you will lose the changes you made once you close your browser seshion or stop the server.

Note: Your browser may cache the swagger definition, so in order to see updated changes it may be needed to refresh the page without cache (Ctrl + Shift + R).