History

Eduard S e6fb0a03de Reorganize smart contract types, udate eth tests, etc. - Move smart contract constants and structs for variables to common/{ethrollup.go, ethauction.go, ethwdelayer.go}: - This removes repeated code of the structs for variables - Allows reusing the constants and variables from all modules without import cycles - Remove unused common/scvars.go - In common.BlockData, split data from each smart contract into a sepparate field (Rollup, Auction, WDelayer). This affects the structures that til uses as output, and HistoryDB in the AddBlockSCData. - In Synchronizer: - Pass starting block of each smart contract as config, instead of incorrectly using the genesis block found in the acution constant (which has a very different meaning) - Use variable structs from common instead of an internal copy - Synchronize more stuff (resolve some TODOs) - Fix some issues found after initial testing with ganache - In eth: - In auction.go: Add method to get constants - Update README to use ganache instead of buidlerevm as local blockchain for testing - Update env variables and test vectors to pass the tests with the deployment in the ganache testnet. - Use ethereum keys derived from paths (hdwallet) in testing to avoid hardcoding private keys and generate the same keys from a mnemonic used in the ganache tesnet.		4 years ago
..
README.md	Add GET histroy-transactions endpoint	4 years ago
accountcreationauths.go	Refactor api exits	4 years ago
accountcreationauths_test.go	Refactor account creation auth endpoints	4 years ago
api.go	Impl account creation auth endpoints	4 years ago
api_test.go	Reorganize smart contract types, udate eth tests, etc.	4 years ago
batch.go	Imp api get full-batches	4 years ago
batch_test.go	Imp api get full-batches	4 years ago
bids.go	API add bids endpoint	4 years ago
bids_test.go	API add bids endpoint	4 years ago
coordinator.go	API Coordinator Refactor	4 years ago
coordinator_test.go	API Coordinator Refactor	4 years ago
dbtoapistructs.go	Reorganize smart contract types, udate eth tests, etc.	4 years ago
docker-compose.yml	Add GET histroy-transactions endpoint	4 years ago
exits.go	Refactor api exits	4 years ago
exits_test.go	Refactor api exits	4 years ago
handlers.go	Refactor api exits	4 years ago
parsers.go	API add bids endpoint	4 years ago
parsers_test.go	API add bids endpoint	4 years ago
run.sh	Add struct get state endpoint	4 years ago
state.go	Reorganize smart contract types, udate eth tests, etc.	4 years ago
swagger.yml	API add bids endpoint	4 years ago
token.go	API Update tokens endpoint	4 years ago
token_test.go	API Coordinator Refactor	4 years ago
txshistory.go	Refactor api txs	4 years ago
txshistory_test.go	Refactor api exits	4 years ago
txspool.go	Refactor api txs	4 years ago
txspool_test.go	Refactor api txs	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://loclahost: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).