ブロックチェーン・アプリケーション・ビルダーのVisual Studio Code拡張機能を使用したチェーンコード·プロジェクトの作成

ブロックチェーンのアプリケーション・ビルダーを使用してチェーンコード・プロジェクトを作成するには、チェーンコード・プロジェクトの詳細仕様ファイルからスキャフォールドします。これにより、すべての必要なファイルを含むプロジェクトが生成されます。

バックグラウンド

ブロックチェーン・アプリケーション・ビルダーの初期化およびスキャフォールドは、すぐに使用できるチェーンコード・プロジェクトです。新規チェーンコードの作成コマンドでは、単純な入力に基づいて、次のような機能を持つ複雑なチェーンコード・プロジェクトを生成できます:
  • 複数のアセット(モデル)とその動作(コントローラ)
  • CRUD (作成/読取り/更新/削除)およびCRUD以外のメソッドの自動生成
  • 引数の自動検証
  • 引数の整列化/非整列化
  • 透過的永続性機能(ORM)
  • 豊富なクエリ・サポート
  • 一時データおよびプライベート・データのサポート
  • ID管理

生成されたプロジェクトは、モデル/コントローラおよびデコレータのパターンに従います。これにより、レジャーで保持されるアセットのプロパティを型付きフィールドとして指定し、「特定の動作」および検証ルールで拡張することができます。これにより、読みやすさとスケーラビリティに役立つコード行数が削減されます。

仕様ファイルの作成

最初に入力仕様ファイルを作成する必要があります。ブロックチェーン・アプリケーション・ビルダーの一部としてインストールされたサンプル仕様ファイルは変更できませんが、複製したり、独自の仕様ファイルの参照ファイルとして使用することはできます。

  1. 「仕様」ペインで、新規仕様ファイルの作成を選択します。
  2. 「仕様の詳細」ペインで、次のステップを実行します。
    • 仕様ファイルの名前を入力します。
    • ファイル・タイプを選択します。YAMLおよびJSON形式がサポートされています。
    • 必要に応じて、ファイルの説明を入力します。
    • テンプレートとして使用したいファイルがある場合は、「参照ファイル」ドロップダウン・リストを使用して、ワークスペースのファイルから仕様ファイルを生成します。何も選択されていない場合、作成されるファイルは空になり、仕様を最初から入力できます。
    • 仕様ファイルを格納するシステム上の場所を入力します。
    「保存」をクリックします。
仕様ファイルが作成され、「仕様」ペインに表示されます。クリックすると、エディタで開きます。

仕様ファイルのインポート

すでに存在する仕様ファイルがある場合は、それをインポートできます。
  1. 「仕様」ペインで、「その他のアクション」をクリックし、仕様のインポートを選択します。
  2. ファイルを参照して、仕様のインポートをクリックします。
仕様ファイルがインポートされ、「仕様」ペインに表示されます。クリックすると、エディタで開きます。

仕様ファイルの複製

右クリックして「複製」を選択することで、すでに「仕様」ペインにある仕様ファイルを複製することもできます。ファイルを右クリックし、「名前変更」を選択して名前を更新します。

仕様ファイルの内容の詳細は、「入力仕様ファイル」を参照してください。この情報とサンプル仕様テンプレートを使用して、仕様コンテンツを作成します。

仕様ファイルの検証

YAML言語サポート拡張機能をインストールした場合、入力時に仕様ファイルが自動的に検証されます。次の検証機能が自動的にサポートされています:
  • コマンド完了
  • スキーマ・デフォルトへのスカラー・ノードの補完
  • プロパティまたはメソッドの上にカーソルを置いたときの状況依存ヘルプ
  • 入力時の配列項目のインデント
  • 構文エラー検出

チェーンコード・プロジェクトのスキャフォールド

仕様ファイルを作成した後、チェーンコード・プロジェクトを生成できます。
  1. チェーンコード・ペインで、新規チェーンコードの作成を選択します。
  2. 「チェーンコードの詳細」ペインで、次のステップを実行します。
    • チェーンコード・プロジェクトの名前を入力します
    • 言語(TypeScriptまたはGo)を選択します
    • チェーンコードの作成に使用する仕様ファイルを選択します。
    • ローカル開発環境内でプロジェクトを作成する場所またはGoドメインを入力します。
    「Create」をクリックします。

ノート:

  • チェーンコード・ペインでは、チェーンコード・プロジェクト内でコンテンツを開いて操作できますが、プロジェクト内でファイルを追加、削除または名前変更することはできません。そのためには、プロジェクトを右クリックしてエクスプローラで開くを選択します。これにより、Visual Studio Codeエクスプローラ・ビューでプロジェクトが開きます。
  • チェーンコード・プロジェクト内のファイルを削除または名前変更すると、プロジェクト・ファイルとそれを作成するために使用した仕様ファイル間のリンクが壊れる可能性があります。両者の間でコードを同期する場合は、ファイル名を変更しないでください。

既存チェーンコード・プロジェクトのインポート

CLIを使用してチェーンコード・プロジェクトを作成した場合、またはVisual Studio Codeのブロックチェーン・コンテンツを消去してローカルに保存したプロジェクトをインポートする場合は、チェーンコード・ペインで「その他のアクション...」アイコンをクリックし、チェーンコードのインポートを選択します。プロジェクトを参照し、チェーンコードのインポートをクリックします。