wormhole-explorer/api
agodnic f7543a1054
Remove field `vaa.NativeTxHash` from JSON model (#462)
### Description

Remove the `NativeTxHash` from the JSON model returned by `GET /api/v1/vaas`. That field was never meant to be exposed to the API users.
2023-06-27 10:12:55 -03:00
..
cacheable Fix intermittent failure in x-chain-activity endpoint (#420) 2023-06-20 10:34:20 -03:00
docs Fix intermittent failure in x-chain-activity endpoint (#420) 2023-06-20 10:34:20 -03:00
handlers Remove field `vaa.NativeTxHash` from JSON model (#462) 2023-06-27 10:12:55 -03:00
internal Add cache to dashboard endpoints (#441) 2023-06-21 17:00:29 -03:00
middleware Fix intermittent failure in x-chain-activity endpoint (#420) 2023-06-20 10:34:20 -03:00
response Add parsedPayload query param to /vaa/:chainID/:address/:sequence (#102) 2023-01-27 13:47:17 -03:00
routes Fix intermittent failure in x-chain-activity endpoint (#420) 2023-06-20 10:34:20 -03:00
rpc Add route `GET /api/v1/address/{address}` (#228) 2023-04-12 15:51:33 -03:00
types Fix transaction hash search for Sui (#448) 2023-06-22 10:32:17 -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 update storage version and improve error log (#438) 2023-06-21 12:31:40 -03:00
go.sum update storage version and improve error log (#438) 2023-06-21 12:31:40 -03:00
main.go 446 create prometheus metrics (#457) 2023-06-26 12:47:22 -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