スキャフォールド済TypeScriptチェーンコード・プロジェクト
ブロックチェーン・アプリケーション・ビルダーは、仕様ファイルから入力を受け取り、完全に機能するスキャフォールド済チェーンコード・プロジェクトを生成します。
チェーンコード・プロジェクトでTypeScript言語を使用する場合、スキャフォールド済プロジェクトには次の3つのメイン・ファイルが含まれます:
main.ts<chaincodeName>.model.ts<chaincodeName>.controller.ts
tsconfig.jsonファイルには、TypeScriptプロジェクトのコンパイルおよびビルドに必要な構成が含まれています。
<chaincodeName>.model.tsには複数のアセット定義が含まれ、<chaincodeName>.controller.tsにはアセットの動作とCRUDメソッドが含まれます。
model.tsおよびcontroller.tsの各種デコレータは、引数の自動検証、引数の整列化/非整列化、透過的永続性機能(ORM)およびリッチ問合せのコールなどの機能をサポートしています。
アセット
デフォルトでは、
OchainModelを拡張するすべてのクラスには、assetTypeという追加の読取り専用プロパティがあります。このプロパティは、このタイプのアセットのフェッチにのみ使用できます。このプロパティへの変更は、アセットの作成および更新時に無視されます。デフォルトのプロパティ値は<chaincodeName>.<assetName>です。@Id('supplierId')
export class Supplier extends OchainModel<Supplier> {
public readonly assetType = 'tsdeml36.supplier';
@Mandatory()
@Validate(yup.string())
public supplierId: string;
デコレータ
モデル
すべてのモデル・クラスはOchainModelを拡張します。透過的永続性機能または簡略化されたORMは、OchainModelクラスで取得されます。モデルで次のORMメソッドのいずれかをコールする必要がある場合は、OchainModelクラスを拡張する必要があります。
OchainModelを介して公開されるORMメソッド:
save- これはHyperledger FabricのputStateメソッドをコールしますget– これはHyperledger FabricのgetStateメソッドをコールしますupdate- これはHyperledger FabricのputStateメソッドをコールしますdelete– これはHyperledger FabricのdeleteStateメソッドをコールしますhistory– これはHyperledger FabricのgetHistoryForKeyメソッドをコールしますgetByRange– これはHyperledger FabricのgetStateByRangeメソッドをコールします
コントローラ
メイン・コントローラ・クラスは、OchainControllerを拡張します。メインコントローラは1つのみです。
export class TSProjectController extends OchainController{任意の数のクラス、関数またはファイルを作成できますが、メイン・コントローラ・クラス内で定義されているメソッドのみが外部から呼出し可能で、残りのメソッドは非表示になります。
CRUDメソッド
「入力仕様ファイル」で説明されているように、生成するCRUDメソッドを仕様ファイルで指定できます。たとえば、すべてのメソッドの生成を選択した場合、結果は次のようになります:
@Validator(Supplier)
public asynch createSupplier(asset: Supplier){
return await asset.save();
}
public asynch getSupplierById(id: string){
const asset = await Supplier.get(id);
return asset;
}
@Validator(Supplier)
public asynch updateSupplier(asset: Supplier){
return await asset.update();
}
public asynch deleteSupplier(id: string){
const result = await Supplier.delete(id);
return result;
}
public asynch getSupplierHistoryById(id: string){
const result = await Supplier.history(id);
return result;
}
@Validator(yup.string(), yup.string())
public asynch getSupplierByRange(startId: string, endId: string){
const result = await Supplier.getByRange(startId, endId);
return result;
}モデル・メソッド
-
save saveメソッドは、コール元のasset詳細を台帳に追加します。-
get getメソッドは、{chaincodeName}.model.tsの具象モデル・クラスによって継承されるOchainModelクラスの静的メソッドです。-
update updateメソッドは、台帳のコール元assetの詳細を更新します。このメソッドは、promiseを返します。-
delete - これにより、
idで指定された台帳からアセットが削除されます(存在する場合)。このメソッドは、Hyperledger FabricのdeleteStateメソッドを内部的にコールします。 -
history - 履歴メソッドは、
{chaincodeName}.model.tsの具象Modelクラスによって継承されるOchainModelクラスの静的メソッドです。これは、台帳からidによって指定されたアセット履歴を返します(存在する場合)。 -
getByRange getByRangeメソッドは、{chaincodeName}.model.tsの具象Modelクラスによって継承されるOchainModelクラスの静的メソッドです。-
getId - アセットに
Idとして導出キーがある場合、このメソッドを使用して導出IDを取得できます。導出キーに%t(タイムスタンプ)が含まれている場合、このメソッドはエラーを返します。
コントローラ・メソッドの詳細
前述のモデルのCRUDメソッドおよびCRUD以外のメソッドとは別に、ブロックチェーン・アプリケーション・ビルダーでは、コントローラの他のHyperledger Fabricメソッドに即時対応可能なサポートを提供しています。これらのメソッドを次に示します:
getAssetByIdgetAssetsByRangegetAssetHistoryByIdquerygenerateCompositeKeygetByCompositeKeygetTransactionIdgetTransactionTimestampgetTransactionInvokergetChannelIDgetCreatorgetSignedProposalgetArgsgetStringArgsgetMspIDgetNetworkStub
これらのメソッドは、
Controllerクラスのthisコンテキスト自体で使用できます。例:public async getModelById(id: string) {
const asset = await this.getAssetById(id);
return asset;
}
@Validator(yup.string(), yup.string())
public async getModelsByRange(startId: string, endId: string) {
const asset = await this.getAssetsByRange(startId, endId);
return asset;
}
public async getModelHistoryById(id: string) {
const result = await this.getAssetHistoryById(id);
return result;
}-
getAssetById getAssetByIdメソッドは、指定されたidに基づいてアセットを返します。これは汎用メソッドで、任意のタイプのアセットを取得するために使用されます。-
getAssetsByRange getAssetsByRangeメソッドは、アセット・タイプに関係なく、startId(これを含む)からendId(これを含まない)までのすべてのアセットを返します。これは汎用メソッドであり、任意のタイプのアセットを取得するために使用できます。-
getAssetHistoryById getAssetHistoryByIdメソッドは、指定されたidのアセットの履歴イテレータを返します。-
query queryメソッドは、台帳に対してリッチSQL/Couch DB問合せを実行します。このメソッドは、Oracle Blockchain Platformでのリモート・デプロイメントでのみサポートされます。これは、台帳でSQL問合せを実行するための一般的な方法です。-
generateCompositeKey - このメソッドは、
indexNameおよび引数で指定された属性に基づいてコンポジット・キーを生成し、返します。 -
getByCompositeKey - このメソッドは、コンポジット・キーの作成中に属性パラメータに指定されたキーおよび列に一致するアセットを返します。
indexOfIdパラメータは、スタブ・メソッドSplitCompositeKeyの配列で返されるキーの索引を指定します。内部的には、このメソッドはHyperledger FabricのgetStateByPartialCompositeKey、splitCompositeKeyおよびgetStateをコールします。 -
getTransactionId - 現在のチェーンコード呼出しリクエストのトランザクションIDを返します。トランザクションIDは、チャネルのスコープ内でトランザクションを一意に識別します。
-
getTransactionTimestamp - トランザクションが作成されたときのタイムスタンプを返します。これはトランザクション
ChannelHeaderから取得されるため、クライアントのタイムスタンプを示し、すべてのエンドーサで同じ値になります。 -
getTransactionInvoker - 一時マップ・プロパティ
bcsRestClientIdからトランザクションのコール元を返します。 -
getChannelID - チェーンコードが処理する提案のチャネルIDを返します。
-
getCreator - チェーンコード呼出しの発行者のアイデンティティ・オブジェクトを返します。
-
getSignedProposal - 署名済トランザクション提案の完全にデコードされたオブジェクトを返します。
-
getArgs - チェーンコード呼出しリクエストから引数を文字列の配列として返します。
-
getStringArgs - チェーンコード呼出しリクエストから引数を文字列の配列として返します。
-
getMspID - 呼出し側アイデンティティのMSP IDを返します。
-
getNetworkStub - ユーザーは、
getNetworkStubメソッドをコールすることでshimスタブにアクセスできます。これは、ユーザーがアセットを直接操作する独自の実装を記述するのに役立ちます。
カスタム・メソッド
このサンプル仕様ファイルから、次のカスタム・メソッドが生成されました。
executeQueryは、SQLリッチ問合せのコール方法を示しています。引数に対するバリデータは、仕様ファイルで指定された引数のタイプに基づいてブロックチェーン・アプリケーション・ビルダーによって自動的に追加されます。
/**
*
* BDB sql rich queries can be executed in OBP CS/EE.
* This method can be invoked only when connected to remote OBP CS/EE network.
*
*/
@Validator(yup.string()}
public async executeQuery(query: string) {
const result = await OchainController.query(query);
return result;
}
@Validator(yup.string(), yup.number()}
public async fetchRawMaterial(supplierId: string, rawMaterialSupply: number) {
}
@Validator(yup.string(), yup.string(), yup.number())
public async getRawMaterialFromSupplier(manufacturerId: string, supplierId: string, rawMaterialSupply: number) {
}
@Validator(yup.string(), yup.number(), yup.number())
public async createProducts(manufacturerId: string, rawMaterialConsumed: number, productsCreated: number) {
}
public async sendProductsToDistribution() {
}
初期化メソッド
コントローラには、空の定義を持つinitメソッドが用意されています。このメソッドは、チェーンコードを初めてインスタンス化またはアップグレードするときにHyperledger FabricのInitメソッドによってコールされます。
export class TestTsProjectController extends OchainController {
public async init(params: any) {
return;
}この時点でアプリケーションの状態を初期化する場合は、このメソッドを使用して初期化できます。