Supply

This repo contains:

1. Utilities for calculating the circulating and total supply of utia on a given date.
2. An API with endpoints that return the current circulating and total supply.

Note

Note on methodology: due to complexity, this supply API does not adjust the circulating supply for tokens that were retroactively locked after TGE, for example due to CIP-31. As a result, the reported circulating supply may include a minor margin of error (likely no more than around 1%), decreasing to zero as lockups elapse.

Usage

1. Run the API server

   go run main.go

2. Verify the API server is running

   curl http://0.0.0.0:8080
   
   # Query the circulating supply
   curl http://0.0.0.0:8080/v0/circulating-supply
   
   # Query the total supply
   curl http://0.0.0.0:8080/v0/total-supply
   
   # Query the circulating supply on a particular date
   curl http://0.0.0.0:8080/v0/circulating-supply?date=2025-05-31
   
   # Query the total supply on a particular date
   curl http://0.0.0.0:8080/v0/total-supply?date=2025-05-31

Contributing

Helpful commands

# Get more info on available make commands.
make help

Note

Functions should ideally operate on utia values (of type int64) rather than TIA values (of type float64) to avoid loss of precsision. Utia values can be converted to TIA values (of type float64) prior to responding to API requests.

Deployment

The docker.yml workflow builds a Docker image and pushes it to GitHub Container Registry (GHCR). The supply server can be deployed using the Docker image from GHCR. CI will not automatically deploy the latest Docker image so you must do that manually if you want to deploy a new version of the supply server.