wormhole-explorer/api
agodnic ed0985d502
[API] Add parsed payloads to `GET /api/v1/vaas` (#113)
Add query parameter `parsedPayload` to the endpoint `GET /api/v1/vaas`.
2023-01-31 15:24:34 -03:00
..
docs [API] Fix issues related to swaggo v1.8.10 (#96) 2023-01-26 12:04:01 -03:00
handlers [API] Add parsed payloads to `GET /api/v1/vaas` (#113) 2023-01-31 15:24:34 -03:00
internal Handle guardianSet by p2p enviroment in fly/api (#112) 2023-01-31 11:38:17 -03:00
middleware Add parsedPayload query param to /vaa/:chainID/:address/:sequence (#102) 2023-01-27 13:47:17 -03:00
response Add parsedPayload query param to /vaa/:chainID/:address/:sequence (#102) 2023-01-27 13:47:17 -03:00
routes [API] Add parsed payloads to `GET /api/v1/vaas` (#113) 2023-01-31 15:24:34 -03:00
rpc Handle guardianSet by p2p enviroment in fly/api (#112) 2023-01-31 11:38:17 -03:00
.gitignore [API/FLY/SPY] Update .gitignore (#87) 2023-01-24 12:02:41 -03:00
Dockerfile Add k8s deployment (#39) 2022-12-14 17:07:55 -03:00
Makefile add swagger doc, makefile and readme (#53) 2023-01-10 12:32:07 -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 Handle guardianSet by p2p enviroment in fly/api (#112) 2023-01-31 11:38:17 -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