wormhole-explorer/api
agodnic 0f1797e44a
[API] Add `toChain` filter to `GET /api/v1/vaas/{emitterChain}/{emitterAddr}` (#598)
### Description

This pull request adds the parameter `toChain` to the endpoint `GET /api/v1/vaas/{emitterChain}/{emitterAddress}`.

Other VAA-related endpoints do not support this parameter.

Additionally, for performance reasons, a composite index must be created in MongoDB: `db.parsedVaa.createIndex({"emitterChain": -1, "emitterAddr": -1, "rawStandardizedProperties.toChain": -1, "indexedAt": -1})`
2023-08-01 16:38:34 -03:00
..
cacheable
docs [API] Add `toChain` filter to `GET /api/v1/vaas/{emitterChain}/{emitterAddr}` (#598) 2023-08-01 16:38:34 -03:00
handlers [API] Add `toChain` filter to `GET /api/v1/vaas/{emitterChain}/{emitterAddr}` (#598) 2023-08-01 16:38:34 -03:00
internal Update base URL for the external TVL API (#560) 2023-07-19 15:03:28 -03:00
middleware [API] Add `toChain` filter to `GET /api/v1/vaas/{emitterChain}/{emitterAddr}` (#598) 2023-08-01 16:38:34 -03:00
response
routes [API] Add `toChain` filter to `GET /api/v1/vaas/{emitterChain}/{emitterAddr}` (#598) 2023-08-01 16:38:34 -03:00
rpc
types
.gitignore
Dockerfile
Makefile
README.md
go.mod Add environment to promethes metrics for api (#507) 2023-07-05 16:15:29 -03:00
go.sum Add environment to promethes metrics for api (#507) 2023-07-05 16:15:29 -03:00
main.go Refactor: disable fiber message on API startup (#594) 2023-07-28 12:27:09 -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