wormhole-explorer/api
agodnic b3ec0bcc9e
[API] Fix pagination in `GET /api/v1/governor/notional/available/{chainId}` (#168)
### Summary

Changes:
* Fix `page` and `pageSize` parameters in `GET /api/v1/governor/notional/available/{chainId}`.
* Sort results by ascending guardian address to enforce deterministic output.

Tracking issue: https://github.com/wormhole-foundation/wormhole-explorer/issues/162
2023-03-01 10:44:27 -03:00
..
docs [API] Remove unused query params from swagger docs (#166) 2023-02-24 10:47:20 -03:00
handlers [API] Fix pagination in `GET /api/v1/governor/notional/available/{chainId}` (#168) 2023-03-01 10:44:27 -03:00
internal [API] Remove unused query params from swagger docs (#166) 2023-02-24 10:47:20 -03:00
middleware [API] Accept additional address formats (#170) 2023-02-28 17:50:23 -03:00
response Add parsedPayload query param to /vaa/:chainID/:address/:sequence (#102) 2023-01-27 13:47:17 -03:00
routes [API] Accept additional address formats (#170) 2023-02-28 17:50:23 -03:00
rpc [API] Accept additional address formats (#170) 2023-02-28 17:50:23 -03:00
types [API] Accept additional address formats (#170) 2023-02-28 17:50:23 -03:00
.gitignore
Dockerfile add make to docker 2023-02-05 09:52:56 -03:00
Makefile add make to docker 2023-02-05 09:52:56 -03:00
README.md
go.mod
go.sum
main.go Add pprof all components (#134) 2023-02-03 15:18:44 -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