wormhole-explorer/api
agodnic d9d49ec919
Add 24h volume to scorecards (#274)
### Summary

This pull request adds volume metrics to influxdb. Also, it adds the 24h volume metric to `GET /api/v1/scorecards`.

Tracking issues: https://github.com/wormhole-foundation/wormhole-explorer/issues/221, https://github.com/wormhole-foundation/wormhole-explorer/issues/280

### Changes:
* The `parser` service no longer generates metrics for influxdb. All metrics-related code was removed from that service, that code was moved to the analytics service instead.
* New volume metrics were added to the analytics service.
* The notional cache was modified to use token names (i.e.: ticker symbols) as keys instead of chain IDs.
* The notional cache reader was moved to the `common/client/cache` package.
* A little bit of duplicated code between the cache reader and writer was removed.
* A 24h volume metric was added to `GET /api/v1/scorecards`.
* A dictionary that stores token metadata was added under `common/domain/tokenbridge.go`. More tokens will be added to it in the near future.
2023-05-04 20:17:03 -03:00
..
docs Fix endpoint last-txs to fit portal explorer requirements (#286) 2023-05-03 14:01:55 -03:00
handlers Add 24h volume to scorecards (#274) 2023-05-04 20:17:03 -03:00
internal Add 24h volume to scorecards (#274) 2023-05-04 20:17:03 -03:00
middleware Fix endpoint last-txs to fit portal explorer requirements (#286) 2023-05-03 14:01:55 -03:00
response Add parsedPayload query param to /vaa/:chainID/:address/:sequence (#102) 2023-01-27 13:47:17 -03:00
routes Add 24h volume to scorecards (#274) 2023-05-04 20:17:03 -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 add swagger doc, makefile and readme (#53) 2023-01-10 12:32:07 -03:00
go.mod 250 governornotionalavailable sending an invalid chainid returns invalid data (#270) 2023-04-27 13:56:18 -03:00
go.sum 250 governornotionalavailable sending an invalid chainid returns invalid data (#270) 2023-04-27 13:56:18 -03:00
main.go Add 24h volume to scorecards (#274) 2023-05-04 20:17:03 -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