ミント

ミントは、ゲームアイテムをNFTとして発行する機能です。Hive コンソールでは、ブロックチェーン > 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（クエリパラメータ）としてHiveブロックチェーンサーバーに事前に送信する必要があります。以下に例を示します。

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

属性¶

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

attributesに含まれるアイテムのユニークコードを使ってAPIを呼び出すと、ユニークコードを結果確認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" //인증 토큰 전송 시: "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 レスポンスとして受け取ったウェブページのURLは、Hive SDKを使用して外部ブラウザに公開されます。

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

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

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

X-PLANET	XPLA Vault

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...' \ // 인증 토크 사용 시
  -H 'User-Agent: HiveBlockchain/1.0' \
  -d '{
    "type": "MINT",
    "itemId": "HIVE",
    "playerId": 2319123897,
    "characterId": "zeratu",
    "webLinkId": "b6d2ca1b-b43a-4129-bf54-9a189e3aa664",
    "attributes": [ // NFT 발행 페이지 링크 생성 시 attributes
        {
          "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...' \  // 인증 토크 사용 시
  -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": [ // NFT 발행 페이지 링크 생성 시 attributes
        {
          "traitType": "item_id",
          "value": "sward-3283272101239"
        },
        {
          "traitType": "strength",
          "value": "50"
        },
        {
          "traitType": "agility",
          "value": "10"
        }
      ]
  }'

応答¶

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

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