wormhole-explorer/api
agodnic 55d4b352ca
Remove unused fields from the origin transaction model (#528)
### Description

This pull request removes two unused fields from the `GlobalTransaction.OriginTx` JSON model:
* `timestamp`: this field is always set to the VAA's timestamp, making it redundant. Moreover, for EVM chains we need one extra RPC node request to get it. So better get rid of it.
* `chainId`: this field is always set to the VAA's emitter chain, making it redundant.
2023-07-12 16:47:33 -03:00
..
cacheable Fix intermittent failure in x-chain-activity endpoint (#420) 2023-06-20 10:34:20 -03:00
docs Remove unused fields from the origin transaction model (#528) 2023-07-12 16:47:33 -03:00
handlers Remove unused fields from the origin transaction model (#528) 2023-07-12 16:47:33 -03:00
internal Add environment to promethes metrics for api (#507) 2023-07-05 16:15: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 [API] Standard payload changes (#520) 2023-07-12 12:51:52 -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 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 Add environment to promethes metrics for api (#507) 2023-07-05 16:15:29 -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