https://github.com/syscoin/syscoin-info-api
Syscoin Supply API between NEVM and UTXO chains
https://github.com/syscoin/syscoin-info-api
Last synced: 3 months ago
JSON representation
Syscoin Supply API between NEVM and UTXO chains
- Host: GitHub
- URL: https://github.com/syscoin/syscoin-info-api
- Owner: syscoin
- Created: 2022-12-08T22:01:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-25T23:55:35.000Z (about 1 year ago)
- Last Synced: 2025-04-26T00:26:20.264Z (about 1 year ago)
- Language: JavaScript
- Size: 51.8 KB
- Stars: 0
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Syscoin Info API
## Description
This is a simple NodsJS Express server to fetch information on Syscoin.
## Endpoints
Host: https://info.syscoin.org/
### `GET /totalsupply`
- This returns total supply calculated on both UTXO and NEVM blockchain in plaintext.
### `GET /triggerRecordSupply`
- Normally total supply is calculated and recorded when new block hash is detected.
- This endpoints acts as manual trigger in calculation.
### `GET /health`
- This is a health check endpoint. Useful for monitoring if API is running.
## Syscoin Core (`/syscoin-core`)
- Dockerized version of the Syscoin Daemon
- JSON RPC is used by the API in retrieving UTXO supply
## API Environment Variables (Required\*)
- `SYSCOIN_CORE_RPC_HOST` ex. `localhost`
- `SYSCOIN_CORE_RPC_PORT` ex. `8370`
- `SYSCOIN_CORE_RPC_PASSWORD` - password for auth to RPC
- `SYSCOIN_CORE_RPC_USERNAME` - username for auth to RPC
An `.env.example` is provided for convenience.
You can generate password and username:
```bash
curl -sSL https://raw.githubusercontent.com/syscoin/syscoin/master/share/rpcauth/rpcauth.py | python -
```
For more information you can check it here: https://github.com/syscoin/docker-syscoin-core#usage
## Syscoin Vault Manager
Please refer to `config.js` for the current official address of SyscoinVaultManager contract.