wormhole-explorer/api
ftocal e55f6e35e3
Fix operations query by txHash when the vaa was processed correctly (#1255)
Co-authored-by: walker-16 <agpazos85@gmail.com>
2024-03-27 10:58:50 -03:00
..
cacheable Fallback metrics endpoint (#921) 2023-12-19 12:24:58 -03:00
docs [Issue:1052] Create job for fetching contributor stats and storing in db (#1144) 2024-02-22 14:58:45 -03:00
handlers Fix operations query by txHash when the vaa was processed correctly (#1255) 2024-03-27 10:58:50 -03:00
internal [ISSUE-1213] Refactor of top-contributors stats and activity job (#1215) 2024-03-18 10:21:42 -03:00
middleware Add top-100-corridors endpoint (#1065) 2024-01-30 15:27:48 -03:00
response
routes [ISSUE-1089] Collect CCTP - Metrics (#1165) 2024-03-11 17:33:36 -03:00
rpc
.gitignore
Dockerfile
Makefile
README.md
go.mod Changes to support ci/cd workflow in staging environment (#1166) 2024-02-29 11:14:31 -03:00
go.sum Changes to support ci/cd workflow in staging environment (#1166) 2024-02-29 11:14:31 -03:00
main.go [ISSUE-1213] Refactor of top-contributors stats and activity job (#1215) 2024-03-18 10:21:42 -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