wormhole-explorer/api
Mariano 220dd01982
[WORMSCAN-API-1335] Support querying with multiple sourceChains and targetChains (#1364)
* refactor to accept multiple sourceChains,targetChains and appIds

* support multiple appIds

* adjust x-chain-activity/tops to also support multiple sourceChains and targetChains

* readapt to multiple sourceChains and targetChains

* add unit-tests

* fix unit-test case names

* add unit-test to validate query construction

* fix docs

* fix length of targetChains
2024-04-30 16:56:19 -03:00
..
cacheable Fallback metrics endpoint (#921) 2023-12-19 12:24:58 -03:00
docs [WORMSCAN-API-1335] Support querying with multiple sourceChains and targetChains (#1364) 2024-04-30 16:56:19 -03:00
handlers [WORMSCAN-API-1335] Support querying with multiple sourceChains and targetChains (#1364) 2024-04-30 16:56:19 -03:00
internal [ISSUE-1213] Refactor of top-contributors stats and activity job (#1215) 2024-03-18 10:21:42 -03:00
middleware [WORMSCAN-API-1335] Support querying with multiple sourceChains and targetChains (#1364) 2024-04-30 16:56:19 -03:00
response Create an api endpoint to call vaa payload parser component (#596) 2023-08-10 11:02:14 -03:00
routes [WORMSCAN-API-1335] Support querying with multiple sourceChains and targetChains (#1364) 2024-04-30 16:56:19 -03:00
rpc Store duplicate vaas on a secondary collection (#1308) 2024-04-22 14:26:07 -03:00
.gitignore [API/FLY/SPY] Update .gitignore (#87) 2023-01-24 12:02:41 -03:00
Dockerfile Store duplicate vaas on a secondary collection (#1308) 2024-04-22 14:26:07 -03:00
Makefile add make to docker 2023-02-05 09:52:56 -03:00
README.md Relays api endpoint (#689) 2023-09-13 10:23:10 -03:00
go.mod Fix go dependencies in api and pipeline (#1344) 2024-04-23 11:41:06 -03:00
go.sum Fix go dependencies in api and pipeline (#1344) 2024-04-23 11:41:06 -03:00
main.go Add cache to governor endpoints (#1271) 2024-04-03 14:58:04 -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_DB_NAME=wormhole WORMSCAN_PORT=5555 WORMSCAN_RUNMODE=DEVELOPMENT ./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