Client

CLI

A user can query the supply module using the CLI.

Query

The query commands allow users to query the supply state.

desmos query supply --help

About the divider exponent

Both the total and the circulating queries allow to specify an optional divider exponent. If provided, such exponent will be used to divide the resulting amount by 10^(divider exponent).

Example:

supply = 1.000.000
divider_exponent = 3
result = 1.000.000 / 10^3 = 1.000

total

The total command allows users to query the total supply of a token given a denomination and an optional divider exponent. If a divider exponent is provided, the resulting supply amount will be divided by 10^(divider_exponent).

desmos query supply total [denom] [[divider_exponent]] [flags]

Example:

desmos query supply total udsm 2

Example Output:

total_supply: "100003895600953035670"

circulating

The circulating command allows users to query the circulating supply of a token given a denomination.

desmos query supply circulating [denom] [[divider_exponent]] [flags]

Example:

desmos query supply circulating udsm 2

Example Output:

circulating_supply: "100003882303991703831"

gRPC

A user can query the supply module gRPC endpoints.

Total

The Total endpoint allows users to query for the total supply of a token given a denomination.

desmos.supply.v1.Query/Total

Example:

grpcurl -plaintext \
  -d '{"denom": "stake", "divider_exponent": "2"}' localhost:9090 desmos.supply.v1.Query/Total

Example Output:

{
  "totalSupply": "1000040727987145688"
}

Circulating

The Circulating endpoint allows users to query for the circulating supply of a token given a denomination.

desmos.supply.v1.Query/Circulating

Example:

grpcurl -plaintext \
  -d '{"denom": "stake", "divider_exponent": "2"}' localhost:9090 desmos.supply.v1.Query/Circulating

Example Output:

{
  "circulatingSupply": "1000040236507203206"
}

REST

A user can query the supply module using REST endpoints.

Total

The /total endpoint allows users to query for the total supply of a token given a denomination.

/desmos/supply/v1/total/{denom}

Example:

curl localhost:9090/desmos/supply/v1/total/stake?divider-exponent=2

Example Output:

{
  "total_supply": "589360298910067"
}

Circulating

The /circulating endpoint allows users to query for the circulating supply of a token given a denomination.

/desmos/supply/v1/circulating/{denom}

Example:

curl localhost:9090/desmos/supply/v1/circulating/stake?divider-exponent=2

Example Output:

{
  "circulating_supply": "577243154399894"
}