ミント

ミントは、ゲームアイテムをNFTとして発行する機能です。これは、Hive コンソールの Blockchain > XPLA > NFT メニューのユーザー発行タブにある設定されたコンテンツに基づいてNFTを発行します。

ミント関数の実装フロー¶

以下は、Mint機能の実装プロセスです。Mint機能を実装するには、以下のフローチャート画像とガイドコンテンツに従って、ゲームクライアント (Hive SDK、ゲームクライアント) およびゲームサーバーエリアにコードを実装してください。以下の画像で青いアスタリスクでマークされた部分は、開発者が作業する必要がある領域です。主なタスクの詳細については、以下のガイドを参照してください。

hive SDKでのログインの実装¶

ゲームクライアントにコードを実装して、ユーザーがHive SDK認証機能を使用してIdPログインでログインできるようにします。Webログインもログイン方法としてサポートされています。

NFTミンティングボタンの実装¶

ゲームクライアントにユーザーがNFT発行ページを開くことができるUIを実装します。例えば、ユーザーがゲームにアクセスした後、キャラクターのインベントリからアイテムを選択すると、アイテムをNFTに変換ボタンが表示されるべきです。このボタンが押されると、以下の内容に従ってNFT発行ページが開かれるべきです。

アイテムをNFTに変換するリクエスト¶

ユーザーがゲームクライアントからゲームサーバーにゲームアイテムのNFT発行をリクエストするコードを実装します。これは、ユーザーがNFT発行ボタンを選択したときのアクションを実装するためです。ゲームサーバーがゲームクライアントからのリクエストを受け取ると、NFTとして発行されるゲームアイテムを確認し、次にNFT発行ページリンク作成APIを呼び出してアイテムをNFTとして発行します。

NFT発行ページリンク生成API呼び出し¶

NFT発行ページは、ユーザーが所有するアイテムをNFTに変換することを可能にするウェブページです。このウェブページは、Hive ブロックチェーンサーバーによって提供されています。ゲームサーバーはリンク生成APIを呼び出して、このウェブページのURL（webLinkUrl）を取得します。ユーザーがこのウェブページにアクセスすると、ゲーム内アイテムをブロックチェーン上でNFTとしてミントすることができます。

ノート¶

API呼び出しを行う際に開発者が取るべき予防策はこれです。

ゲームサーバーURL¶

gameServerUrl は、Hive ブロックチェーンサーバーがゲームサーバーに呼び出す API の リクエスト URL として使用されます (アイテム検証 API と 結果確認 API)。

ゲームサーバーURLとトークン¶

Hiveブロックチェーンサーバーがアイテム検証APIまたは結果確認APIを呼び出すとき、ゲームサーバーはAPI呼び出しのために認証トークン（ヘッダー パラメーター）をオプションで使用できます。これは開発者の裁量に任されています。API呼び出しに認証トークンを使用する場合、ゲームサーバーはNFT発行ページリンク生成APIを呼び出す際に、この認証トークンをtoken（クエリ パラメーター）としてgameServerUrlに事前に添付し、Hiveブロックチェーンサーバーに送信する必要があります。以下に例を示します。

"gameServerUrl": "https://api.com2us.com/hive?token=sInR5cCI6IkpXVC..."

属性¶

attributesは、Hiveブロックチェーンサーバーがゲームサーバーにitem validation APIおよびresult confirmation APIを呼び出す際にリクエストボディとして使用されます。

APIを呼び出す際にattributesにアイテムのユニークコードを指定すると、ユニークコードを結果確認APIのリクエストボディattributesに含めることもできます。この場合、対応するユニークコードでアイテムのステータスを更新できます。

NFT発行ページリンクの有効期間¶

一度作成されたページへのリンクは、最初にアクセスされたセッションに基づいて10分間のみ有効です。

リクエストURL¶

ヘッダーパラメータ¶

リクエストボディ¶

データオブジェクト¶

リクエストサンプル¶

curl -X 'POST' \
  'https://sandbox-bc-platform-api.withhive.com/web3/v1/web-link' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXlObyI6NiwiaWQiOiIvVWpXN....' \
  -H 'Content-Type: application/json' \
  -d '{
  "type": "MINT",
  "playerId": 1276814678,
  "characterId": "zeratu",
  "gameServerUrl": "https://api.com2us.com/hive" // When sending authentication token: "gameServerUrl": "https://api.com2us.com/hive?token=sInR5cCI6IkpXVC..."
  "data": {
    "itemId": "HIVE",
    "attributes": [
        {
          "traitType": "item_id",
          "value": "sward-3283272101239"
        },
        {
          "traitType": "strength",
          "value": "50"
        },
        {
          "traitType": "agility",
          "value": "10"
        }
      ]
  },
}'

応答¶

応答サンプル¶

{
  "code": 0,
  "message": "success",
  "data": {
    "webLinkid": "b6d2ca1b-b43a-4129-bf54-9a189e3aa664",
    "webLinkUrl": "https://sandbox-xpla-platform.withhive.com/api/v1/web-link/redirect?token=b256c85c-aee8-4837-b54d-9a03fe8a7435.f94140b71c9ebf058956547753131adde9968a0266f208d7e3059bbb6dd0c7bc",
    "expiration": "2024-08-05T08:33:15.448Z"
  }
}

hive SDKを使用したNFT発行ページの実装¶

NFT発行ページリンク作成APIは、Hive SDKを使用してゲーム内ブラウザで開くために受け取ったウェブページのURLをレスポンスとして公開します。

以下はNFT発行ページの例です。

発行されるNFTのアイテム情報

NFT発行ページを開くと、X-PLANETウォレットまたはXLPA Vaultのログインウィンドウが表示されます。ユーザーは、X-PLANETウォレットまたはXLPA Vaultにログインした後、MintまたはBurnを実行するために特定のウォレットアドレスを選択する必要があります。

X-PLANET	XPLA Vault	XPLA Games

NFTミンティング（ミントの実行）¶

NFT発行ページで、ユーザーはアイテムを選択し、その後ミントを実行します。

NFT発行前に手数料を確認してください

アイテム検証API呼び出し (ハイブブロックチェーンサーバー → ゲームサーバー)¶

ゲームアイテムをNFTに変換する前に、Hive ブロックチェーンサーバーはゲームサーバーからアイテムの確認を要求します。Hive ブロックチェーンサーバーは、ゲームサーバーから提供された応答のアイテム情報を確認した後、ブロックチェーン上でNFTを発行します。アイテムの確認が失敗した場合、Hive ブロックチェーンサーバーはNFTを発行しません。

ノート¶

APIエンドポイントを設定する際の開発者への考慮事項をいくつか紹介します。

ゲームサーバーURL¶

このAPIは、NFT発行ページリンク作成APIから要求されたgameServerUrlを使用してゲームサーバーに検証を要求します。

認証ヘッダー¶

NFT発行ページリンク作成APIから要求されたgameServerUrlにtokenクエリパラメータが存在する場合は、このtoken値をBearer形式で使用してください。

属性¶

NFT発行ページリンクを生成するためのAPIリクエストボディにattributesを含めます。

リクエストURL¶

ゲームサーバーで準備する必要があるAPIエンドポイント情報です。

ヘッダーパラメータ¶

リクエストボディ¶

リクエストサンプル¶

curl -X 'POST' \
  'https://api.com2us.com/hive/items/validate' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoieHBsYS13ZWJ2aWV3IiwiYXBwIjoiY29tLmdjcC5zdGVwYnlzdGVwLnBjd2ViLmJs...' \ // When using authentication token
  -H 'User-Agent: HiveBlockchain/1.0' \
  -d '{
    "type": "MINT",
    "itemId": "HIVE",
    "playerId": 2319123897,
    "characterId": "zeratu",
    "webLinkId": "b6d2ca1b-b43a-4129-bf54-9a189e3aa664",
    "attributes": [ // Attributes when generating NFT issuance page link
        {
          "traitType": "item_id",
          "value": "sward-3283272101239"
        },
        {
          "traitType": "strength",
          "value": "50"
        },
        {
          "traitType": "agility",
          "value": "10"
        }
      ]
  }'

レスポンス¶

HTTPステータスコードは次のとおりです。

• 成功
  • 200
• 失敗
  • 4xx: 不正なリクエストのエラーステータスコード
  • 5xx: サーバーエラーのエラーステータスコード

結果確認API呼び出し (ハイブブロックチェーン → ゲームサーバー)¶

Hiveブロックチェーンサーバーがリクエストボディ内でNFT発行結果をゲームサーバーに送信すると、ゲームサーバーはアイテムがゲームで使用できないように処理し、その後、結果をAPIを介してHiveブロックチェーンサーバーに返します。

ゲームサーバーが発行結果に基づいて実行するアクションは次のとおりです。

• NFT発行成功
  • ゲーム内アイテムの使用を防ぐために処理されました（例：ゲームユーザーのインベントリからアイテムを削除）
• NFT発行失敗
  • ゲーム内アイテムの使用を許可するために処理されました（例：ゲームユーザーのインベントリでアイテムを再利用できるように使用制限を解除）
  • ユーザーがNFT発行をキャンセルした場合や、時間制限が超過した場合にNFT発行失敗の結果を送信します

以下は、ゲームサーバーが成功したNFT発行で応答したときのNFT発行ページ画面の例です。

ノート¶

APIエンドポイントを設定する際の開発者への考慮事項は以下の通りです。

属性¶

attributesにユニークなアイテムコードを含めることで、NFT発行ページリンク作成APIを呼び出すことができ、リクエストボディattributesにもユニークコードを含めることができます。この場合、対応するユニークコードでアイテムのステータスを更新できます。

認証ヘッダー¶

NFT発行ページリンク作成APIから要求されたgameServerUrlにtokenクエリパラメータが存在する場合は、このtoken値をBearer形式で使用してください。

リクエストURL¶

ヘッダーパラメータ¶

リクエストボディ¶

リクエスト サンプル¶

curl -X 'POST' \
  'https://api.com2us.com/hive/items/callback' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoieHBsYS13ZWJ2aWV3IiwiYXBwIjoiY29tLmdjcC5zdGVwYnlzdGVwLnBjd2ViLmJs...' \  // When using authentication token
  -H 'User-Agent: HiveBlockchain/1.0' \
  -d '{
    "type": "MINT",
    "itemId": "HIVE",
    "playerId": 2319123897,
    "characterId": "zeratu",
    "webLinkId": "b6d2ca1b-b43a-4129-bf54-9a189e3aa664",
    "tokenId": "HIVE#348",
    "status": "success",
    "attributes": [ // Attributes when generating NFT issuance page link
        {
          "traitType": "item_id",
          "value": "sward-3283272101239"
        },
        {
          "traitType": "strength",
          "value": "50"
        },
        {
          "traitType": "agility",
          "value": "10"
        }
      ]
  }'

レスポンス¶

HTTPステータスコードは次のとおりです。

• 成功
  • 200
• 失敗
  • 4xx: 不正なリクエストのためのエラーステータスコード
  • 5xx: サーバーエラーのためのエラーステータスコード