arnaucube/hermez-node
1
0
Fork 0
mirror of https://github.com/arnaucube/hermez-node.git synced 2026-02-07 11:26:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add package level documentation for db, historydb, l2db and api/...

Browse Source
This commit is contained in:
arnaubennassar
2021-03-26 16:08:02 +01:00
parent 6c1c157bc3
commit 4c99640b8c
6 changed files with 92 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
api/stateapiupdater/stateapiupdater.go
View File

@@ -1,3 +1,10 @@
/*
Package stateapiupdater is responsible for generating and storing the object response of the GET /state endpoint exposed through the api package.
This object is extensively defined at the OpenAPI spec located at api/swagger.yml.
Deployment considerations: in a setup where multiple processes are used (dedicated api process, separated coord / sync, ...), only one process should care
of using this package.
*/
package stateapiupdater
import (