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

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

バックグラウンド

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

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

仕様ファイルの作成

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

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

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

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

仕様ファイルの複製

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

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

仕様ファイルの検証

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

チェーンコード・プロジェクト

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

ノート:

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

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

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