wormhole-explorer/api
agodnic e85fa82784
[API] Remove redundant checks (#150)
Remove redundant nil checks in `api/handlers/governor/repository.go`.
2023-02-10 15:57:11 -03:00
..
docs feature/fix_api_v1_governor_responses_to_camelcase (#136) 2023-02-03 18:46:16 -03:00
handlers [API] Remove redundant checks (#150) 2023-02-10 15:57:11 -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] Change status code for enqueued VAAs endpoint (#151) 2023-02-10 14:31:33 -03:00
rpc [API] Add appId parameter to GET /api/v1/vaas (#114) 2023-02-01 09:59:51 -03:00
.gitignore
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
go.mod
go.sum
main.go Add pprof all components (#134) 2023-02-03 15:18:44 -03:00

README.md

API

How to build

make build

Config

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

  • WORMSCAN_DB_MONGO
  • WORMSCAN_DB_NAME
  • WORMSCAN_PORT

for example:

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

API Documentation

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