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
Mariano 5d27910bca remove unnecessary break 2024-04-26 11:25:53 -03:00
..
cacheable Fallback metrics endpoint (#921) 2023-12-19 12:24:58 -03:00
docs update endpoint name 2024-04-26 09:55:48 -03:00
handlers remove unnecessary break 2024-04-26 11:25:53 -03:00
internal [ISSUE-1213] Refactor of top-contributors stats and activity job (#1215) 2024-03-18 10:21:42 -03:00
middleware change endpoint signature 2024-04-26 09:55:48 -03:00
response Create an api endpoint to call vaa payload parser component (#596) 2023-08-10 11:02:14 -03:00
routes update endpoint name 2024-04-26 09:55:48 -03:00
rpc Store duplicate vaas on a secondary collection (#1308) 2024-04-22 14:26:07 -03:00
.gitignore
…
Dockerfile Store duplicate vaas on a secondary collection (#1308) 2024-04-22 14:26:07 -03:00
Makefile add make to docker 2023-02-05 09:52:56 -03:00
README.md Relays api endpoint (#689) 2023-09-13 10:23:10 -03:00
go.mod Fix go dependencies in api and pipeline (#1344) 2024-04-23 11:41:06 -03:00
go.sum Fix go dependencies in api and pipeline (#1344) 2024-04-23 11:41:06 -03:00
main.go Add cache to governor endpoints (#1271) 2024-04-03 14:58:04 -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_DB_NAME=wormhole WORMSCAN_PORT=5555 WORMSCAN_RUNMODE=DEVELOPMENT ./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