certusone
/
wormhole-explorer
mirror of https://github.com/certusone/wormhole-explorer.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
wormhole-explorer/api
History
agodnic d32405f737
[API] Update swagger docs (#120) 
Co-authored-by: Agustin Godnic <agustin@xlabs.xyz>
 		2023-02-01 14:11:40 -03:00
..
docs [API] Update swagger docs (#120) 2023-02-01 14:11:40 -03:00
handlers [API] Add appId parameter to GET /api/v1/vaas (#114) 2023-02-01 09:59:51 -03:00
internal add version endpoint (#118) 2023-02-01 10:46:22 -03:00
middleware [API] Add appId parameter to GET /api/v1/vaas (#114) 2023-02-01 09:59:51 -03:00
response Add parsedPayload query param to /vaa/:chainID/:address/:sequence (#102) 2023-01-27 13:47:17 -03:00
routes [API] Update swagger docs (#120) 2023-02-01 14:11:40 -03:00
rpc [API] Add appId parameter to GET /api/v1/vaas (#114) 2023-02-01 09:59:51 -03:00
.gitignore
…
Dockerfile
…
Makefile add version endpoint (#118) 2023-02-01 10:46:22 -03:00
README.md
…
go.mod
…
go.sum
…
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