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 38c8e82879
[API] Remove unused path parameters (#131) 
Remove unused path parameters in `GET /api/v1/vaas/{chain_id}/{emitter}/{seq}`
 		2023-02-03 15:44:46 -03:00
..
docs [API] Remove unused path parameters (#131) 2023-02-03 15:44:46 -03:00
handlers [API] Add appId parameter to GET /api/v1/vaas (#114) 2023-02-01 09:59:51 -03:00
internal Add pprof all components (#134) 2023-02-03 15:18:44 -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] Remove unused path parameters (#131) 2023-02-03 15:44:46 -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
…
Makefile add version endpoint (#118) 2023-02-01 10:46:22 -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

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