History

agodnic 3e01b42f20 [API] Fix incorrect route in swagger docs (#165 ) The API's swagger documentation exposes a route `GET /api/v1/governor/max_available/:chain`, but instead it should be `GET /api/v1/governor/notional/max_available/:chain`.		2023-02-23 16:54:40 -03:00
..
docs	[API] Fix incorrect route in swagger docs (#165 )	2023-02-23 16:54:40 -03:00
handlers	[API] Several fixes in `GET /api/v1/governor/limit` (#153 )	2023-02-10 15:58:10 -03:00
internal	[API] Fix issue in MongoDB aggregation pipeline (#147 )	2023-02-10 15:55:45 -03:00
middleware	[API] Several fixes related to pagination (#144 )	2023-02-09 14:28:39 -03:00
response	Add parsedPayload query param to /vaa/:chainID/:address/:sequence (#102 )	2023-01-27 13:47:17 -03:00
routes	[API] Fix incorrect route in swagger docs (#165 )	2023-02-23 16:54:40 -03:00
rpc	[API] Add appId parameter to GET /api/v1/vaas (#114 )	2023-02-01 09:59:51 -03:00
.gitignore	[API/FLY/SPY] Update .gitignore (#87 )	2023-01-24 12:02:41 -03:00
Dockerfile	add make to docker	2023-02-05 09:52:56 -03:00
Makefile	add make to docker	2023-02-05 09:52:56 -03:00
README.md	add swagger doc, makefile and readme (#53 )	2023-01-10 12:32:07 -03:00
go.mod	Feature/add grpc support (#73 )	2023-01-23 11:45:09 -03:00
go.sum	Feature/add grpc support (#73 )	2023-01-23 11:45:09 -03:00
main.go	Add pprof all components (#134 )	2023-02-03 15:18:44 -03:00

API

How to build

make build

You will need to set some env variables with the prefix WORMSCAN

for example:

WORMSCAN_DB_URL=mongodb://localhost:27017/wormhole WORMSCAN_PORT=5555 ./api

Documentation is automagically generated via swaggo using annotations on code and placed inside doc/ folder.

To install swag tool run this

go install github.com/swaggo/swag/cmd/swag@latest

To generate or update the doc run:

make doc