wormhole-explorer/api
Mariano 6bbfa7bf23
Add cache to protocols stats endpoints (/protocols/stats) (#1149)
* add cache to protocols stats endpoint

 add mock for cache

add unit test case for cache miss

 change from to current

* add configs

* add missing config for api-service.yaml

* add cache ttl for staging-mainnet
2024-03-04 15:55:53 -03:00
..
cacheable
docs [Issue:1052] Create job for fetching contributor stats and storing in db (#1144) 2024-02-22 14:58:45 -03:00
handlers Add cache to protocols stats endpoints (/protocols/stats) (#1149) 2024-03-04 15:55:53 -03:00
internal Add cache to protocols stats endpoints (/protocols/stats) (#1149) 2024-03-04 15:55:53 -03:00
middleware
response
routes [Issue:1052] Create job for fetching contributor stats and storing in db (#1144) 2024-02-22 14:58:45 -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 Add cache to protocols stats endpoints (/protocols/stats) (#1149) 2024-03-04 15:55:53 -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