arnaucube/hermez-node
1
0
Fork 0
mirror of https://github.com/arnaucube/hermez-node.git synced 2026-02-07 03:16:45 +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

8
api/apitypes/apitypes.go
View File

@@ -1,3 +1,11 @@
/*
Package apitypes is used to map the common types used across the node with the format expected by the API.
This is done using different strategies:
- Marshallers: they get triggered when the API marshals the response structs into JSONs
- Scanners/Valuers: they get triggered when a struct is sent/received to/from the SQL database
- Adhoc functions: when the already mentioned strategies are not suitable, functions are added to the structs to facilitate the conversions
*/
package apitypes
import (