arnaucube
/
hermez-node
mirror of https://github.com/arnaucube/hermez-node.git
1
1
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
721 Commits
26 Branches
2 Tags
2.8 MiB
 
 
 
Tree: 7833cb11de
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '7833cb11de'
${ noResults }
hermez-node/api
Danilo Pantani 7833cb11de fix some code and comment typos 3 years ago
..
README.md Swagger Review 3 years ago
account.go fix some code and comment typos 3 years ago
account_test.go Add Last db view in kvdb and statedb 3 years ago
accountcreationauths.go fix some code and comment typos 3 years ago
accountcreationauths_test.go Account API 3 years ago
api.go Add forge delay to api get state 3 years ago
api_test.go fix some code and comment typos 3 years ago
aux_test.go Improve swagger doc 3 years ago
batch.go fix some code and comment typos 3 years ago
batch_test.go empty array instead of 404 3 years ago
bids.go fix some code and comment typos 3 years ago
bids_test.go empty array instead of 404 3 years ago
config.go Update AccountCreationAuth & fix auth.HashToSign 3 years ago
config_test.go Update AccountCreationAuth & fix auth.HashToSign 3 years ago
coordinator.go fix some code and comment typos 3 years ago
coordinator_test.go Fix repeated items when coordinator is updated 3 years ago
docker-compose.yml Add GET histroy-transactions endpoint 3 years ago
exits.go fix some code and comment typos 3 years ago
exits_test.go Swagger improvements 3 years ago
handlers.go fix some code and comment typos 3 years ago
parsers.go fix some code and comment typos 3 years ago
parsers_test.go mv of babyjub.PublicKey to babyjub.PublicKeyComp 3 years ago
run.sh Add struct get state endpoint 3 years ago
slots.go fix some code and comment typos 3 years ago
slots_test.go Fix repeated items when coordinator is updated 3 years ago
state.go Add forge delay to api get state 3 years ago
state_test.go Change how TX per Batch is calculated in state API endpoint 3 years ago
swagger.yml Add forge delay to api get state 3 years ago
token.go fix some code and comment typos 3 years ago
token_test.go Fix errors when fromItem is not provided 3 years ago
txshistory.go fix some code and comment typos 3 years ago
txshistory_test.go fix some code and comment typos 3 years ago
txspool.go fix some code and comment typos 3 years ago
txspool_test.go fix some code and comment typos 3 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).