wormhole-explorer/api
Gabriel Zimmermann 02e3561226
Adds circulating supply endpoint / service / controller (#1771)
* Adds circulating supply endpoint / service / controller

* modify supply endpoint to response in json format, add docs

---------

Co-authored-by: Agustin Pazos <agpazos85@gmail.com>
2024-10-07 16:30:45 -03:00
..
cacheable [1695]Add all protocols to /protocols/stats endpoint (#1737) 2024-10-01 16:37:59 -03:00
docs Adds circulating supply endpoint / service / controller (#1771) 2024-10-07 16:30:45 -03:00
handlers Adds circulating supply endpoint / service / controller (#1771) 2024-10-07 16:30:45 -03:00
internal 1621 new endpoint for ntt token dashboard (#1641) 2024-09-04 10:56:18 -03:00
middleware 1621 new endpoint for ntt token dashboard (#1641) 2024-09-04 10:56:18 -03:00
response Create an api endpoint to call vaa payload parser component (#596) 2023-08-10 11:02:14 -03:00
routes Adds circulating supply endpoint / service / controller (#1771) 2024-10-07 16:30:45 -03:00
rpc Update last guadian set automatically from eth contract (#1414) 2024-05-27 11:01:16 -03:00
.gitignore
Dockerfile update go version in api (#1581) 2024-08-01 14:57:59 -03:00
Makefile
README.md Relays api endpoint (#689) 2023-09-13 10:23:10 -03:00
go.mod [1527] Add support for gossip batched observations (#1676) 2024-10-02 15:40:44 -03:00
go.sum [1527] Add support for gossip batched observations (#1676) 2024-10-02 15:40:44 -03:00
main.go Adds circulating supply endpoint / service / controller (#1771) 2024-10-07 16:30:45 -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