wormhole-explorer/api
walker-16 ffeb5927f8
Add notional cache client (#241)
* Add notional cache client

* gracefull shutdown pubsub and distributed cache
2023-04-20 17:02:25 -03:00
..
docs [API/ANALYTICS] Scorecards endpoint (#232) 2023-04-20 16:01:10 -03:00
handlers [API/ANALYTICS] Scorecards endpoint (#232) 2023-04-20 16:01:10 -03:00
internal Add notional cache client (#241) 2023-04-20 17:02:25 -03:00
middleware Add route `GET /api/v1/address/{address}` (#228) 2023-04-12 15:51:33 -03:00
response Add parsedPayload query param to /vaa/:chainID/:address/:sequence (#102) 2023-01-27 13:47:17 -03:00
routes [API/ANALYTICS] Scorecards endpoint (#232) 2023-04-20 16:01:10 -03:00
rpc Add route `GET /api/v1/address/{address}` (#228) 2023-04-12 15:51:33 -03:00
types Add route `GET /api/v1/address/{address}` (#228) 2023-04-12 15:51:33 -03:00
.gitignore [API/FLY/SPY] Update .gitignore (#87) 2023-01-24 12:02:41 -03:00
Dockerfile [API/PARSER] Chain activity and last transaction endpoints (#175) 2023-03-07 16:25:42 -03:00
Makefile add make to docker 2023-02-05 09:52:56 -03:00
README.md
go.mod Add notional cache client (#241) 2023-04-20 17:02:25 -03:00
go.sum Add notional cache client (#241) 2023-04-20 17:02:25 -03:00
main.go Add notional cache client (#241) 2023-04-20 17:02:25 -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