通貨供給量の照会
初級⚓︎

取引所や市場データアグリゲーターは、時価総額やトークン指標を表示するために正確な供給量の数値を必要とします。

Symbolネットワークは、専用のRESTエンドポイントを通じて、ネイティブ通貨であるXYMの最大供給量、総供給量、および循環供給量を公開しています。

このチュートリアルでは、それぞれの値を照会し、それらから追加の指標を導き出す方法を説明します。

前提条件⚓︎

このチュートリアルでは、SDKを必要とせずにSymbol REST APIを使用します。 HTTPリクエストを行う方法さえあれば実行可能です。

完全なコード⚓︎

Python JavaScript

import os
import urllib.request

NODE_URL = os.getenv('NODE_URL', 'https://reference.symboltest.net:3001')
print(f'Using node {NODE_URL}')

SUPPLY_URL = f'{NODE_URL}/network/currency/supply'

try:
    with urllib.request.urlopen(f'{SUPPLY_URL}/max') as response:
        maximum_supply = float(response.read().decode().strip())
    print(f'Maximum supply: {maximum_supply:,.6f} XYM')

    with urllib.request.urlopen(f'{SUPPLY_URL}/total') as response:
        total_supply = float(response.read().decode().strip())
    print(f'Total supply: {total_supply:,.6f} XYM')

    with urllib.request.urlopen(f'{SUPPLY_URL}/circulating') as response:
        circulating_supply = float(response.read().decode().strip())
    print(f'Circulating supply: {circulating_supply:,.6f} XYM')

    non_circulating_supply = total_supply - circulating_supply
    print(f'Non-circulating supply: {non_circulating_supply:,.6f} XYM')

    unminted_supply = maximum_supply - total_supply
    print(f'Unminted supply: {unminted_supply:,.6f} XYM')

except Exception as error:
    print(error)

Download source

const NODE_URL = process.env.NODE_URL ||
    'https://reference.symboltest.net:3001';
console.log(`Using node ${NODE_URL}`);

const SUPPLY_PATH = '/network/currency/supply';

try {
    const fmt = v =>
        v.toLocaleString('en-US', { minimumFractionDigits: 6 });

    const maximumResponse = await fetch(`${NODE_URL}${SUPPLY_PATH}/max`);
    const maximumSupply = parseFloat((await maximumResponse.text()).trim());
    console.log(`Maximum supply: ${fmt(maximumSupply)} XYM`);

    const totalResponse = await fetch(`${NODE_URL}${SUPPLY_PATH}/total`);
    const totalSupply = parseFloat((await totalResponse.text()).trim());
    console.log(`Total supply: ${fmt(totalSupply)} XYM`);

    const circulatingResponse =
        await fetch(`${NODE_URL}${SUPPLY_PATH}/circulating`);
    const circulatingSupply =
        parseFloat((await circulatingResponse.text()).trim());
    console.log(`Circulating supply: ${fmt(circulatingSupply)} XYM`);

    const nonCirculatingSupply = totalSupply - circulatingSupply;
    console.log(`Non-circulating supply: ${fmt(nonCirculatingSupply)} XYM`);

    const unmintedSupply = maximumSupply - totalSupply;
    console.log(`Unminted supply: ${fmt(unmintedSupply)} XYM`);
} catch (error) {
    console.log(error);
}

Download source

このスニペットでは、 NODE_URL 環境変数を使用してSymbol APIノードを設定します。値が指定されない場合は、デフォルトのテストネットノードが使用されます。

デフォルトノードはテストネットです

デフォルトのノードはテストネットを指しています。本番環境の供給量データについては、 NODE_URL をメインネットノードに設定してください。利用可能なメインネットノードのリストについては、symbol.fyi/nodesを参照してください。

コード解説⚓︎

供給量の値の取得⚓︎

Python JavaScript

    with urllib.request.urlopen(f'{SUPPLY_URL}/max') as response:
        maximum_supply = float(response.read().decode().strip())
    print(f'Maximum supply: {maximum_supply:,.6f} XYM')

    with urllib.request.urlopen(f'{SUPPLY_URL}/total') as response:
        total_supply = float(response.read().decode().strip())
    print(f'Total supply: {total_supply:,.6f} XYM')

    with urllib.request.urlopen(f'{SUPPLY_URL}/circulating') as response:
        circulating_supply = float(response.read().decode().strip())
    print(f'Circulating supply: {circulating_supply:,.6f} XYM')

    const fmt = v =>
        v.toLocaleString('en-US', { minimumFractionDigits: 6 });

    const maximumResponse = await fetch(`${NODE_URL}${SUPPLY_PATH}/max`);
    const maximumSupply = parseFloat((await maximumResponse.text()).trim());
    console.log(`Maximum supply: ${fmt(maximumSupply)} XYM`);

    const totalResponse = await fetch(`${NODE_URL}${SUPPLY_PATH}/total`);
    const totalSupply = parseFloat((await totalResponse.text()).trim());
    console.log(`Total supply: ${fmt(totalSupply)} XYM`);

    const circulatingResponse =
        await fetch(`${NODE_URL}${SUPPLY_PATH}/circulating`);
    const circulatingSupply =
        parseFloat((await circulatingResponse.text()).trim());
    console.log(`Circulating supply: ${fmt(circulatingSupply)} XYM`);

各供給量の値は、専用のエンドポイントを通じて利用できます。

/network/currency/supply/max GET: ネットワークプロパティで設定されている、XYMのハードキャップ（最大発行上限）。
/network/currency/supply/total GET: 現在までに発行（ミント）されたXYMの総量。新しいXYMは、新しいブロックごとのインフレーション報酬を通じて徐々に発行されます。
/network/currency/supply/circulating GET: 総供給量から、ネメシスアカウント、トレジャリー（財務）アカウント、およびハーベスト、モザイクレンタル、ネームスペースレンタルの手数料を収集するシンクアカウントが保持する残高を差し引いた値。

これら3つのエンドポイントはすべて、（JSONではなく）プレーンテキストの数値を返します。これらは絶対単位ではなく、すでに小数点以下の桁数を含む全体単位（例： 8999999999.000000 ）で表されています。

注意: 循環供給量はノードに依存します

非循環アカウントのリストは各ノードオペレーターによって（ノードの rest.json ファイル内で）設定されるため、異なるノードが異なる循環供給量の値を報告する可能性があります。供給量データを統合する場合は、デフォルト設定を持つ信頼できるノードを照会するようにしてください。

追加の指標の導出⚓︎

Python JavaScript

    non_circulating_supply = total_supply - circulating_supply
    print(f'Non-circulating supply: {non_circulating_supply:,.6f} XYM')

    unminted_supply = maximum_supply - total_supply
    print(f'Unminted supply: {unminted_supply:,.6f} XYM')

    const nonCirculatingSupply = totalSupply - circulatingSupply;
    console.log(`Non-circulating supply: ${fmt(nonCirculatingSupply)} XYM`);

    const unmintedSupply = maximumSupply - totalSupply;
    console.log(`Unminted supply: ${fmt(unmintedSupply)} XYM`);

3つの値をすべて取得した後、コードは2つの追加の指標を導き出します。

Non-circulating (非循環): 総供給量と循環供給量の差。
Unminted (未発行): 最大供給量と総供給量の差。今後発行される予定の残りのXYMを表します。

出力⚓︎

以下の出力は、通貨供給量を照会する典型的な実行例を示しています。

Using node https://reference.symboltest.net:3001
Maximum supply: 8,999,999,999.000000 XYM
Total supply: 8,323,505,878.695894 XYM
Circulating supply: 8,323,495,854.693871 XYM
Non-circulating supply: 10,024.002024 XYM
Unminted supply: 676,494,120.304106 XYM

これらの値はテストネットノードからのものであり、メインネットの供給量の数値を反映していません。

出力は、XYMの供給量の完全な内訳を示しています。

最大供給量 (maximum supply) (2行目): XYMのハードキャップです。
総供給量 (total supply) (3行目): すべてのXYMがまだ発行されているわけではないため、最大供給量より少なくなります。
循環供給量 (circulating supply) (4行目): 一部の発行済みXYMは非循環アカウントによって保持されているため、さらに少なくなります。
非循環供給量 (non-circulating supply) (5行目): 総供給量と循環供給量の差を表します。
未発行供給量 (unminted supply) (6行目): インフレーション報酬を通じて徐々に発行される残りのXYMを示しています。

結論⚓︎

このチュートリアルでは、以下の方法を説明しました。

ステップ	関連ドキュメント
最大供給量の取得	`/network/currency/supply/max` `GET`
総供給量の取得	`/network/currency/supply/total` `GET`
循環供給量の取得	`/network/currency/supply/circulating` `GET`
追加の指標の導出	-

次のステップ⚓︎

特定のアカウントのXYM残高を確認するには、アカウント残高の照会チュートリアルを参照してください。

通貨供給量の照会初級⚓︎

前提条件⚓︎

完全なコード⚓︎

コード解説⚓︎

供給量の値の取得⚓︎

追加の指標の導出⚓︎

出力⚓︎

結論⚓︎

次のステップ⚓︎

通貨供給量の照会
初級⚓︎