トークン変換のTypeScriptメソッド

ブロックチェーン・アプリケーション・ビルダーは、トークン・タクソノミ・フレームワーク標準を使用する代替可能トークンの変換に使用できるメソッドを自動的に生成します。

トークン変換メソッドには、交換プールの概念が含まれます。交換プール・アカウントは、他のトークン・アカウントによって資金供給されます。トークンをミントする場合、ミントしたトークンの一定割合を交換プール・アカウントに転送するように指定できます。

トークン変換プロセス

トークンの変換の一般的なフローは、次のステップに従います:
  1. initializeExchangePoolUserメソッドをコールして、交換プール・ユーザーを初期化します。
  2. createExchangePoolAccountsメソッドをコールして、交換プール・アカウントを作成します。変換元または変換先となる代替可能トークンのタイプごとに交換プール・アカウントを作成します。
  3. addConversionRateメソッドをコールして、変換するトークンの各ペアの換算レートを設定します。
  4. 次のいずれかの方法で、交換プール・トークン・アカウントに資金を供給します:
    • 標準の転送方法を使用して、トークンを交換プール・トークン・アカウントに転送します。
    • トークンをミントするときにmintWithFundingExchangePoolTokenメソッドをコールします。これにより、ミントしたトークンの一部を交換プール・アカウントに転送できます。
  5. tokenConversionメソッドをコールして、2つの代替可能トークン間で変換します。1人のユーザーがトークンを2つのトークン・アカウント間で変換することも、2人のユーザーが1つのアカウントから別のアカウントに直接トークンを変換することもできます。
  6. 交換プール・ユーザーは、交換プール・アカウントの残高およびアカウント・トランザクションを確認できます。
    • getAccountメソッドをコールして、各交換プール・トークン・アカウントの残高を表示します。
    • getAccountTransactionHistoryおよびgetAccountTransactionHistoryWithFiltersメソッドをコールして、各交換プール・トークン・アカウントのアカウント・トランザクションを表示します。

自動生成されたトークン変換メソッド

ブロックチェーン・アプリケーション・ビルダーは、様々なタイプの代替可能トークン間で変換するメソッドを自動的に生成します。コントローラ・メソッドを呼び出すには、@Validator(...params)デコレータが必要です。

initializeExchangePoolUser
このメソッドは、交換プール・ユーザーを初期化します。これは、1回かぎりのアクティビティです。このメソッドは、チェーンコードのToken Adminのみがコールできます。 
@Validator(yup.string(), yup.string())
public async initializeExchangePoolUser(org_id: string, user_id: string){
    await this.Ctx.Auth.checkAuthorization('TOKEN_CONVERSION.initializeExchangePoolUser', 'TOKEN');
    return await this.Ctx.TokenConvertor.initializeExchangePoolUser(org_id, user_id);
}
パラメータ:
  • org_id: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • user_id: string – ユーザーのユーザー名または電子メールID。
戻り値:
  • 成功の場合、交換プール・ユーザーの詳細を含むメッセージ。
戻り値の例:
{
    "assetType": "oconversion",
    "convertor_id": "bcb1f3b1442c625d3ce205660c5e717c5858a1fe1e12c325df799a851ceaa09b",
    "org_id": "Org1MSP",
    "user_id": "exchangepooluser"
}
createExchangePoolAccounts
このメソッドは、指定されたトークンIDの配列に対して交換プール・トークン・アカウントを作成します。このメソッドは、チェーンコードのToken Adminのみがコールできます。 
@Validator(yup.array().of(yup.string()))
public async createExchangePoolAccounts(token_ids: string[]){
    await this.Ctx.Auth.checkAuthorization('TOKEN_CONVERSION.initializeExchangePoolUser', 'TOKEN');
    return await this.Ctx.TokenConvertor.createExchangePoolAccounts(token_ids);
}
パラメータ:
  • token_ids: string []– トークンIDの配列。
戻り値:
  • 成功の場合、作成された交換プール・アカウントの詳細を含むオブジェクトのリスト。
戻り値の例:
[
  {
    "account_id": "oaccount~cc9d84f6d4a5976532493ef5200c9603e138adc35166ffd5fd1aad9c1647f034",
    "token_id": "USD",
    "status": "created"
  },
  {
    "account_id": "oaccount~3d4933111ec8bd6cc1ebb43f2b2c390deb929cfa534f9c6ada8e63bac04a13c0",
    "token_id": "INR",
    "status": "created"
  }
]
addConversionRate
このメソッドは、トークンのペアの換算レートを追加します。トークン換算レートは、小数点以下8桁まで指定できます。このメソッドは、チェーンコードのToken Adminのみがコールできます。 
@Validator(yup.string(), yup.string(), yup.number())
public async addConversionRate(from_token_id:string , to_token_id:string, token_conversion_rate: number) {
   await this.Ctx.Auth.checkAuthorization('TOKEN_CONVERSION.addConversionRate', 'TOKEN');
   return await this.Ctx.TokenConvertor.addConversionToken(from_token_id,to_token_id,token_conversion_rate);
}
パラメータ:
  • from_token_id: string – 変換元のトークンのID。
  • to_token_id: string – 変換先のトークンのID。
  • token_conversion_rate: number – from_token_idトークンをto_token_idトークンに変換するレート。
戻り値:
  • 成功の場合、換算レート・オブジェクトのJSON表現。
戻り値の例:
{
  "assetType": "oconversionRate",
  "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
  "from_token_id": "USD",
  "to_token_id": "INR",
  "conversion_rate": 10
}
getConversionRate
このメソッドは、トークンのペアの現在の換算レートを取得します。このメソッドは、チェーンコードのToken Admin、任意のOrg Adminおよび任意のトークン・アカウント所有者がコールできます。 
@Validator(yup.string(), yup.string())
public async getConversionRate(from_token_id:string , to_token_id:string) {
    await this.Ctx.Auth.checkAuthorization('TOKEN_CONVERSION.getConversionRate', 'TOKEN');
    const conversion_rate_id = await this.Ctx.TokenConversionRate.getConversionRateId(from_token_id, to_token_id);
    return await this.Ctx.TokenConversionRate.get(conversion_rate_id);
}
パラメータ:
  • from_token_id: string – 変換元のトークンのID。
  • to_token_id: string – 変換先のトークンのID。
戻り値:
  • 成功の場合、換算レート・オブジェクトのJSON表現。
戻り値の例:
{
  "assetType": "oconversionRate",
  "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
  "from_token_id": "USD",
  "to_token_id": "INR",
  "conversion_rate": 10
}
updateConversionRate
このメソッドは、トークンのペアの現在の換算レートを更新します。トークン換算レートは、小数点以下8桁まで指定できます。このメソッドは、チェーンコードのToken Adminのみがコールできます。 
@Validator(yup.string(), yup.string(), yup.number())
public async updateConversionRate(from_token_id:string , to_token_id:string, token_conversion_rate: number) {
    await this.Ctx.Auth.checkAuthorization('TOKEN_CONVERSION.updateConversionRate', 'TOKEN');
    return await this.Ctx.TokenConvertor.updateTokenConversionRate(from_token_id,to_token_id,token_conversion_rate);
}
パラメータ:
  • from_token_id: string – 変換元のトークンのID。
  • to_token_id: string – 変換先のトークンのID。
  • token_conversion_rate: number – from_token_idトークンをto_token_idトークンに変換するレート。
戻り値:
  • 成功の場合、更新された換算レート・オブジェクトのJSON表現。
戻り値の例:
{
  "assetType": "oconversionRate",
  "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
  "from_token_id": "USD",
  "to_token_id": "INR",
  "conversion_rate": 20
}
mintWithFundingExchangePool
このメソッドは、指定されたトークンIDおよび数量に基づいて、コール元のアカウントでトークンをミントします。その後、ミントした数量のうち一定の割合のトークンが交換プール・トークン・アカウントに転送されます。
@Validator(yup.string(), yup.number(), yup.number())
public async mintWithFundingExchangePool(token_id: string, token_quantity: number, percentage_token_to_exchange_pool: number) {
    return await this.Ctx.TokenConvertor.mintWithFundingExchangePool(token_id, token_quantity, percentage_token_to_exchange_pool);
}
パラメータ:
  • token_id: string – ミントするトークンのID。
  • token_quantity: number – ミントするトークンの合計数。
  • percentage_token_to_exchange_pool: number – 交換プール・トークン・アカウントに転送するミントしたトークンの割合。
戻り値:
  • 成功の場合、ミントと交換プールへの資金提供が成功したことを示すメッセージ。
戻り値の例:
{
    "msg": "Successfully minted 100 tokens to Account Id: oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb (Org-Id: Org1MSP, User-Id: admin) and Successfully transfered 20 tokens to exchange pool Account with Account Id: oaccount~cc9d84f6d4a5976532493ef5200c9603e138adc35166ffd5fd1aad9c1647f034 (Org-Id: Org1MSP, User-Id: exchangepooluser) "
}
tokenConversion
このメソッドは、コール元のアカウントから、to_token_id、to_org_idおよびto_user_idの値で指定されたアカウントにトークンを変換します。このメソッドは、チェーンコードのToken Adminおよび任意のトークン・アカウント所有者がコールできます。交換プール・ユーザーはこのメソッドをコールできません。 
@Validator(yup.string(),yup.string(),yup.string(),yup.string(),yup.number())
public async tokenConversion(from_token_id:string, to_token_id:string, to_org_id:string, to_user_id:string, token_quantity:number){
    await this.Ctx.Auth.checkAuthorization('TOKEN_CONVERSION.tokenConversion', 'TOKEN');
    return await this.Ctx.TokenConvertor.tokenConversion(from_token_id,to_token_id,to_org_id,to_user_id,token_quantity);
}
パラメータ:
  • from_token_id: string – 変換元のトークンのID。
  • to_token_id: string – 変換先のトークンのID。
  • to_org_id: string – トークンを受信する現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • to_user_id: string – トークンを受け取るユーザーのユーザー名または電子メールID。
  • token_quantity: number – 転送するトークンの合計数。
戻り値:
  • 成功の場合、トークンの変換が成功したことを示すメッセージ。
戻り値の例:
{
    "msg": "Succesfully converted 5 of tokens with tokenId: [USD] from AccountId: oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb (Org-Id: Org1MSP, User-Id: admin) to 100 of tokens with tokenId: [INR] to AccountId: oaccount~25e2e66718b6dbb59aea9c32acebec60e09d912b2578d4933d377ae5d0628f1e (Org-Id: Org1MSP, User-Id: user) as per the conversion rate of 20"
}
getConversionHistory
このメソッドは、指定されたトークン・アカウントのトークン変換履歴を返します。このメソッドは、チェーンコードのToken Admin、指定された組織のOrg Adminまたはトークン・アカウント所有者がコールできます。 
@Validator(yup.string(), yup.string(), yup.string())
  public async getConversionHistory(token_id: string, org_id: string, user_id: string) {
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getConversionHistory", "TOKEN", { account_id });
    return await this.Ctx.Account.getTokenConversionHistory(account_id, org_id, user_id);
  }
パラメータ:
  • token_id: string – トークンのID。
  • org_id: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • user_id: string – ユーザーのユーザー名または電子メールID。
戻り値:
  • 成功の場合、変換履歴の詳細を含むJSONオブジェクト。
戻り値の例:
[
  {
    "transaction_id": "otransaction~34edd19e03ec8bbbc77bc3372081410a824a5c10f9aa522b3a6390d7e8cb11cf",
    "from_account_id": "oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb",
    "to_account_id": "oaccount~25e2e66718b6dbb59aea9c32acebec60e09d912b2578d4933d377ae5d0628f1e",
    "transacted_amount": 5,
    "converted_amount": 100,
    "conversion_rate": "20",
    "from_token_id": "USD",
    "to_token_id": "INR",
    "balance": 75,
    "onhold_balance": 0,
    "timestamp": "2022-11-30T11:03:20.000Z",
    "transaction_type": "TOKEN_CONVERSION_DEBIT"
  }
]
getConversionRateHistory
このメソッドは、トークンのペアのトークン換算レート履歴を返します。このメソッドは、チェーンコードのToken Admin、任意のOrg Adminおよび任意のトークン・アカウント所有者がコールできます。 
@Validator(yup.string(), yup.string())
public async getConversionRateHistory(from_token_id:string , to_token_id:string) {
    const conversion_rate_id = await this.Ctx.TokenConversionRate.getConversionRateId(from_token_id,to_token_id);
    await this.Ctx.Auth.checkAuthorization('TOKEN_CONVERSION.getConversionRateHistory', 'TOKEN');  
    return await this.Ctx.TokenConversionRate.history(conversion_rate_id);
}
パラメータ:
  • from_token_id: string – 換算レートの計算を目的とした、変換元のトークンのID。
  • to_token_id: string – 換算レートの計算を目的とした、変換先のトークンのID。
戻り値:
  • 成功の場合、換算レート履歴の詳細を含むJSONオブジェクト。
戻り値の例:
 [
  {
    "trxId": "0b1ba7bc2620e1438b6580365e5c0ab852247ccfa5a3eb2157d3baca02c0e521",
    "timeStamp": "2022-11-30T10:23:38.000Z",
    "value": {
      "assetType": "oconversionRate",
      "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
      "from_token_id": "USD",
      "to_token_id": "INR",
      "conversion_rate": 20
    }
  },
  {
    "trxId": "36fc40ddb3d8308ee7e156af700da131d78d941fe390fc57985b7589e7035d5c",
    "timeStamp": "2022-11-30T10:13:18.000Z",
    "value": {
      "assetType": "oconversionRate",
      "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
      "from_token_id": "USD",
      "to_token_id": "INR",
      "conversion_rate": 10
    }
  }
]
getExchangePoolUser
このメソッドは、交換プール・ユーザーのorg_idおよびuser_id値を返します。このメソッドは、チェーンコードのToken Adminのみがコールできます。 
@Validator()
public async getExchangePoolUser() {
    await this.Ctx.Auth.checkAuthorization('TOKEN_CONVERSION.getExchangePoolUser', 'TOKEN');
    return await this.Ctx.TokenConvertor.getExchangePoolUser();
}
パラメータ:
  • なし
戻り値:
  • 成功の場合、交換プールのユーザーに関する情報を含むメッセージ。
戻り値の例:
{
   "assetType": "oconversion",
   "convertor_id": "bcb1f3b1442c625d3ce205660c5e717c5858a1fe1e12c325df799a851ceaa09b",
   "org_id": "Org1MSP",
   "user_id": "exchangepooluser"
}
initializeExchangePoolUser
このメソッドは、交換プール・ユーザーを初期化します。これは、1回かぎりのアクティビティです。このメソッドは、チェーンコードのToken Adminのみがコールできます。 
@Validator(yup.string(), yup.string())
public async initializeExchangePoolUser(org_id: string, user_id: string){
    await this.Ctx.Auth.checkAuthorization('TOKEN_CONVERSION.initializeExchangePoolUser', 'TOKEN');
    return await this.Ctx.TokenConvertor.initializeExchangePoolUser(org_id, user_id);
}
パラメータ:
  • org_id: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • user_id: string – ユーザーのユーザー名または電子メールID。
戻り値:
  • 成功の場合、交換プール・ユーザーの詳細を含むメッセージ。
戻り値の例:
{
    "assetType": "oconversion",
    "convertor_id": "bcb1f3b1442c625d3ce205660c5e717c5858a1fe1e12c325df799a851ceaa09b",
    "org_id": "Org1MSP",
    "user_id": "exchangepooluser"
}
createExchangePoolAccounts
このメソッドは、指定されたトークンIDの配列に対して交換プール・トークン・アカウントを作成します。このメソッドは、チェーンコードのToken Adminのみがコールできます。 
@Validator(yup.array().of(yup.string()))
public async createExchangePoolAccounts(token_ids: string[]){
    await this.Ctx.Auth.checkAuthorization('TOKEN_CONVERSION.initializeExchangePoolUser', 'TOKEN');
    return await this.Ctx.TokenConvertor.createExchangePoolAccounts(token_ids);
}
パラメータ:
  • token_ids: string []– トークンIDの配列。
戻り値:
  • 成功の場合、作成された交換プール・アカウントの詳細を含むオブジェクトのリスト。
戻り値の例:
[
  {
    "account_id": "oaccount~cc9d84f6d4a5976532493ef5200c9603e138adc35166ffd5fd1aad9c1647f034",
    "token_id": "USD",
    "status": "created"
  },
  {
    "account_id": "oaccount~3d4933111ec8bd6cc1ebb43f2b2c390deb929cfa534f9c6ada8e63bac04a13c0",
    "token_id": "INR",
    "status": "created"
  }
]
addConversionRate
このメソッドは、トークンのペアの換算レートを追加します。トークン換算レートは、小数点以下8桁まで指定できます。このメソッドは、チェーンコードのToken Adminのみがコールできます。 
@Validator(yup.string(), yup.string(), yup.number())
public async addConversionRate(from_token_id:string , to_token_id:string, token_conversion_rate: number) {
   await this.Ctx.Auth.checkAuthorization('TOKEN_CONVERSION.addConversionRate', 'TOKEN');
   return await this.Ctx.TokenConvertor.addConversionToken(from_token_id,to_token_id,token_conversion_rate);
}
パラメータ:
  • from_token_id: string – 変換元のトークンのID。
  • to_token_id: string – 変換先のトークンのID。
  • token_conversion_rate: number – from_token_idトークンをto_token_idトークンに変換するレート。
戻り値:
  • 成功の場合、換算レート・オブジェクトのJSON表現。
戻り値の例:
{
  "assetType": "oconversionRate",
  "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
  "from_token_id": "USD",
  "to_token_id": "INR",
  "conversion_rate": 10
}
getConversionRate
このメソッドは、トークンのペアの現在の換算レートを取得します。このメソッドは、指定された組織のOrg AdminまたはOrg Auditor、およびトークン・アカウント所有者がコールできます。Token AdminまたはToken Auditor 
@Validator(yup.string(), yup.string())
public async getConversionRate(from_token_id:string , to_token_id:string) {
    await this.Ctx.Auth.checkAuthorization('TOKEN_CONVERSION.getConversionRate', 'TOKEN');
    const conversion_rate_id = await this.Ctx.TokenConversionRate.getConversionRateId(from_token_id, to_token_id);
    return await this.Ctx.TokenConversionRate.get(conversion_rate_id);
}
パラメータ:
  • from_token_id: string – 変換元のトークンのID。
  • to_token_id: string – 変換先のトークンのID。
戻り値:
  • 成功の場合、換算レート・オブジェクトのJSON表現。
戻り値の例:
{
  "assetType": "oconversionRate",
  "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
  "from_token_id": "USD",
  "to_token_id": "INR",
  "conversion_rate": 10
}
updateConversionRate
このメソッドは、トークンのペアの現在の換算レートを更新します。トークン換算レートは、小数点以下8桁まで指定できます。このメソッドは、チェーンコードのToken Adminのみがコールできます。 
@Validator(yup.string(), yup.string(), yup.number())
public async updateConversionRate(from_token_id:string , to_token_id:string, token_conversion_rate: number) {
    await this.Ctx.Auth.checkAuthorization('TOKEN_CONVERSION.updateConversionRate', 'TOKEN');
    return await this.Ctx.TokenConvertor.updateTokenConversionRate(from_token_id,to_token_id,token_conversion_rate);
}
パラメータ:
  • from_token_id: string – 変換元のトークンのID。
  • to_token_id: string – 変換先のトークンのID。
  • token_conversion_rate: number – from_token_idトークンをto_token_idトークンに変換するレート。
戻り値:
  • 成功の場合、更新された換算レート・オブジェクトのJSON表現。
戻り値の例:
{
  "assetType": "oconversionRate",
  "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
  "from_token_id": "USD",
  "to_token_id": "INR",
  "conversion_rate": 20
}
mintWithFundingExchangePool
このメソッドは、指定されたトークンIDおよび数量に基づいて、コール元のアカウントでトークンをミントします。その後、ミントした数量のうち一定の割合のトークンが交換プール・トークン・アカウントに転送されます。
@Validator(yup.string(), yup.number(), yup.number())
public async mintWithFundingExchangePool(token_id: string, token_quantity: number, percentage_token_to_exchange_pool: number) {
    return await this.Ctx.TokenConvertor.mintWithFundingExchangePool(token_id, token_quantity, percentage_token_to_exchange_pool);
}
パラメータ:
  • token_id: string – ミントするトークンのID。
  • token_quantity: number – ミントするトークンの合計数。
  • percentage_token_to_exchange_pool: number – 交換プール・トークン・アカウントに転送するミントしたトークンの割合。
戻り値:
  • 成功の場合、ミントと交換プールへの資金提供が成功したことを示すメッセージ。
戻り値の例:
{
    "msg": "Successfully minted 100 tokens to Account Id: oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb (Org-Id: Org1MSP, User-Id: admin) and Successfully transfered 20 tokens to exchange pool Account with Account Id: oaccount~cc9d84f6d4a5976532493ef5200c9603e138adc35166ffd5fd1aad9c1647f034 (Org-Id: Org1MSP, User-Id: exchangepooluser) "
}
tokenConversion
このメソッドは、コール元のアカウントから、to_token_id、to_org_idおよびto_user_idの値で指定されたアカウントにトークンを変換します。このメソッドは、チェーンコードのToken Adminおよび任意のトークン・アカウント所有者がコールできます。交換プール・ユーザーはこのメソッドをコールできません。 
@Validator(yup.string(),yup.string(),yup.string(),yup.string(),yup.number())
public async tokenConversion(from_token_id:string, to_token_id:string, to_org_id:string, to_user_id:string, token_quantity:number){
    await this.Ctx.Auth.checkAuthorization('TOKEN_CONVERSION.tokenConversion', 'TOKEN');
    return await this.Ctx.TokenConvertor.tokenConversion(from_token_id,to_token_id,to_org_id,to_user_id,token_quantity);
}
パラメータ:
  • from_token_id: string – 変換元のトークンのID。
  • to_token_id: string – 変換先のトークンのID。
  • to_org_id: string – トークンを受信する現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • to_user_id: string – トークンを受け取るユーザーのユーザー名または電子メールID。
  • token_quantity: number – 転送するトークンの合計数。
戻り値:
  • 成功の場合、トークンの変換が成功したことを示すメッセージ。
戻り値の例:
{
    "msg": "Succesfully converted 5 of tokens with tokenId: [USD] from AccountId: oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb (Org-Id: Org1MSP, User-Id: admin) to 100 of tokens with tokenId: [INR] to AccountId: oaccount~25e2e66718b6dbb59aea9c32acebec60e09d912b2578d4933d377ae5d0628f1e (Org-Id: Org1MSP, User-Id: user) as per the conversion rate of 20"
}
getConversionHistory
このメソッドは、指定されたトークン・アカウントのトークン変換履歴を返します。このメソッドは、指定された組織のToken AdminまたはToken Auditor、Org AdminまたはOrg Auditorまたはトークン・アカウント所有者がコールできます。 
@Validator(yup.string(), yup.string(), yup.string())
  public async getConversionHistory(token_id: string, org_id: string, user_id: string) {
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getConversionHistory", "TOKEN", { account_id });
    return await this.Ctx.Account.getTokenConversionHistory(account_id, org_id, user_id);
  }
パラメータ:
  • token_id: string – トークンのID。
  • org_id: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • user_id: string – ユーザーのユーザー名または電子メールID。
戻り値:
  • 成功の場合、変換履歴の詳細を含むJSONオブジェクト。
戻り値の例:
[
  {
    "transaction_id": "otransaction~34edd19e03ec8bbbc77bc3372081410a824a5c10f9aa522b3a6390d7e8cb11cf",
    "from_account_id": "oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb",
    "to_account_id": "oaccount~25e2e66718b6dbb59aea9c32acebec60e09d912b2578d4933d377ae5d0628f1e",
    "transacted_amount": 5,
    "converted_amount": 100,
    "conversion_rate": "20",
    "from_token_id": "USD",
    "to_token_id": "INR",
    "balance": 75,
    "onhold_balance": 0,
    "timestamp": "2022-11-30T11:03:20.000Z",
    "transaction_type": "TOKEN_CONVERSION_DEBIT"
  }
]
getConversionRateHistory
このメソッドは、トークンのペアのトークン換算レート履歴を返します。このメソッドは、指定された組織のOrg AdminまたはOrg Auditor、およびトークン・アカウント所有者がコールできます。Token AdminまたはToken Auditor 
@Validator(yup.string(), yup.string())
public async getConversionRateHistory(from_token_id:string , to_token_id:string) {
    const conversion_rate_id = await this.Ctx.TokenConversionRate.getConversionRateId(from_token_id,to_token_id);
    await this.Ctx.Auth.checkAuthorization('TOKEN_CONVERSION.getConversionRateHistory', 'TOKEN');  
    return await this.Ctx.TokenConversionRate.history(conversion_rate_id);
}
パラメータ:
  • from_token_id: string – 換算レートの計算を目的とした、変換元のトークンのID。
  • to_token_id: string – 換算レートの計算を目的とした、変換先のトークンのID。
戻り値:
  • 成功の場合、換算レート履歴の詳細を含むJSONオブジェクト。
戻り値の例:
 [
  {
    "trxId": "0b1ba7bc2620e1438b6580365e5c0ab852247ccfa5a3eb2157d3baca02c0e521",
    "timeStamp": "2022-11-30T10:23:38.000Z",
    "value": {
      "assetType": "oconversionRate",
      "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
      "from_token_id": "USD",
      "to_token_id": "INR",
      "conversion_rate": 20
    }
  },
  {
    "trxId": "36fc40ddb3d8308ee7e156af700da131d78d941fe390fc57985b7589e7035d5c",
    "timeStamp": "2022-11-30T10:13:18.000Z",
    "value": {
      "assetType": "oconversionRate",
      "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
      "from_token_id": "USD",
      "to_token_id": "INR",
      "conversion_rate": 10
    }
  }
]
getExchangePoolUser
このメソッドは、交換プール・ユーザーのorg_idおよびuser_id値を返します。このメソッドは、チェーンコードのToken AdminまたはToken Auditorのみがコールできます。 
@Validator()
public async getExchangePoolUser() {
    await this.Ctx.Auth.checkAuthorization('TOKEN_CONVERSION.getExchangePoolUser', 'TOKEN');
    return await this.Ctx.TokenConvertor.getExchangePoolUser();
}
パラメータ:
  • なし
戻り値:
  • 成功の場合、交換プールのユーザーに関する情報を含むメッセージ。
戻り値の例:
{
   "assetType": "oconversion",
   "convertor_id": "bcb1f3b1442c625d3ce205660c5e717c5858a1fe1e12c325df799a851ceaa09b",
   "org_id": "Org1MSP",
   "user_id": "exchangepooluser"
}

トークン変換SDKメソッド

initializeExchangePoolUser
このメソッドは、交換プール・ユーザーを初期化します。これは、1回かぎりのアクティビティです。このメソッドは、チェーンコードのToken Adminのみがコールできます。 
Ctx.TokenConvertor.initializeExchangePoolUser(orgId: string, userId: string)
パラメータ:
  • orgId: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • userId: string – ユーザーのユーザー名または電子メールID。
戻り値:
  • 成功の場合、交換プール・ユーザーの詳細を含むメッセージ。
戻り値の例:
{
    "assetType": "oconversion",
    "convertor_id": "bcb1f3b1442c625d3ce205660c5e717c5858a1fe1e12c325df799a851ceaa09b",
    "org_id": "Org1MSP",
    "user_id": "exchangepooluser"
}
createExchangePoolAccounts
このメソッドは、指定されたトークンIDの配列に対して交換プール・トークン・アカウントを作成します。このメソッドは、チェーンコードのToken Adminのみがコールできます。 
Ctx.TokenConvertor.createExchangePoolAccounts(token_ids: string[])
パラメータ:
  • token_ids: string []– トークンIDの配列。
戻り値:
  • 成功の場合、作成された交換プール・アカウントの詳細を含むオブジェクトのリスト。
戻り値の例:
[
  {
    "account_id": "oaccount~cc9d84f6d4a5976532493ef5200c9603e138adc35166ffd5fd1aad9c1647f034",
    "token_id": "USD",
    "status": "created"
  },
  {
    "account_id": "oaccount~3d4933111ec8bd6cc1ebb43f2b2c390deb929cfa534f9c6ada8e63bac04a13c0",
    "token_id": "INR",
    "status": "created"
  }
]
addConversionToken
このメソッドは、指定されたトークンの新しい換算レートでトークンを追加します。トークン換算レートは、小数点以下8桁まで指定できます。このメソッドは、チェーンコードのToken Adminのみがコールできます。 
Ctx.TokenConvertor.addConversionToken(fromTokenId: string, toTokenId: string, tokenConversionRate: number)
パラメータ:
  • fromTokenId: string – 変換元のトークンのID。
  • toTokenId: string – 変換先のトークンのID。
  • tokenConversionRate: number – from_token_idトークンをto_token_idトークンに変換するレート。
戻り値:
  • 成功の場合、換算レート・オブジェクトのJSON表現。
戻り値の例:
{
  "assetType": "oconversionRate",
  "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
  "from_token_id": "USD",
  "to_token_id": "INR",
  "conversion_rate": 10
}
get
このメソッドは、トークンのペアの現在の換算レートを取得します。このメソッドは、チェーンコードのToken Adminおよび任意のトークン・アカウント所有者がコールできます。 
Ctx.TokenConversionRate.get(id: string)
パラメータ:
  • id: string – トークン変換レート・オブジェクトのID。
戻り値:
  • 成功の場合、換算レート・オブジェクトのJSON表現。
戻り値の例:
{
  "assetType": "oconversionRate",
  "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
  "from_token_id": "USD",
  "to_token_id": "INR",
  "conversion_rate": 10
}
updateTokenConversionRate
このメソッドは、トークンのペアの現在の換算レートを更新します。トークン換算レートは、小数点以下8桁まで指定できます。このメソッドは、チェーンコードのToken Adminのみがコールできます。 
Ctx.TokenConvertor.updateTokenConversionRate(fromTokenId: string, toTokenId: string, tokenConversionRate: number)
パラメータ:
  • from_token_id: string – 変換元のトークンのID。
  • to_token_id: string – 変換先のトークンのID。
  • token_conversion_rate: number – from_token_idトークンをto_token_idトークンに変換するレート。
戻り値:
  • 成功の場合、更新された換算レート・オブジェクトのJSON表現。
戻り値の例:
{
  "assetType": "oconversionRate",
  "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
  "from_token_id": "USD",
  "to_token_id": "INR",
  "conversion_rate": 20
}
mintWithFundingExchangePool
このメソッドは、指定されたトークンIDおよび数量に基づいて、コール元のアカウントでトークンをミントします。その後、ミントした数量のうち一定の割合のトークンが交換プール・トークン・アカウントに転送されます。
Ctx.TokenConvertor.mintWithFundingExchangePool(tokenId: string, tokenQuantity: number, percentageTokenToExchangePool: number)
パラメータ:
  • token_id: string – ミントするトークンのID。
  • token_quantity: number – ミントするトークンの合計数。
  • percentage_token_to_exchange_pool: number – 交換プール・トークン・アカウントに転送するミントしたトークンの割合。
戻り値:
  • 成功の場合、ミントと交換プールへの資金提供が成功したことを示すメッセージ。
戻り値の例:
{
    "msg": "Successfully minted 100 tokens to Account Id: oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb (Org-Id: Org1MSP, User-Id: admin) and Successfully transfered 20 tokens to exchange pool Account with Account Id: oaccount~cc9d84f6d4a5976532493ef5200c9603e138adc35166ffd5fd1aad9c1647f034 (Org-Id: Org1MSP, User-Id: exchangepooluser) "
}
tokenConversion
このメソッドは、コール元のアカウントから、to_token_id、to_org_idおよびto_user_idの値で指定されたアカウントにトークンを変換します。このメソッドは、チェーンコードのToken Adminおよび任意のトークン・アカウント所有者がコールできます。交換プール・ユーザーはこのメソッドをコールできません。 
Ctx.TokenConvertor.tokenConversion(fromTokenId: string, toTokenId: string, toOrgId: string, toUserId: string, tokenQuantity: number)
パラメータ:
  • from_token_id: string – 変換元のトークンのID。
  • to_token_id: string – 変換先のトークンのID。
  • to_org_id: string – トークンを受信する現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • to_user_id: string – トークンを受け取るユーザーのユーザー名または電子メールID。
戻り値:
  • 成功の場合、トークンの変換が成功したことを示すメッセージ。
戻り値の例:
{
    "msg": "Succesfully converted 5 of tokens with tokenId: [USD] from AccountId: oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb (Org-Id: Org1MSP, User-Id: admin) to 100 of tokens with tokenId: [INR] to AccountId: oaccount~25e2e66718b6dbb59aea9c32acebec60e09d912b2578d4933d377ae5d0628f1e (Org-Id: Org1MSP, User-Id: user) as per the conversion rate of 20"
}
getTokenConversionHistory
このメソッドは、指定されたトークン・アカウントのトークン変換履歴を返します。このメソッドは、チェーンコードのToken Admin、指定された組織のOrg Adminおよびトークン・アカウント所有者がコールできます。 
Ctx.Account.getTokenConversionHistory(account_id: string, org_id: string, user_id: string)
パラメータ:
  • account_id: string – 代替可能トークン・アカウントのID。
  • org_id: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • user_id: string – ユーザーのユーザー名または電子メールID。
戻り値:
  • 成功の場合、変換履歴の詳細を含むJSONオブジェクト。
戻り値の例:
[
  {
    "transaction_id": "otransaction~34edd19e03ec8bbbc77bc3372081410a824a5c10f9aa522b3a6390d7e8cb11cf",
    "from_account_id": "oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb",
    "to_account_id": "oaccount~25e2e66718b6dbb59aea9c32acebec60e09d912b2578d4933d377ae5d0628f1e",
    "transacted_amount": 5,
    "converted_amount": 100,
    "conversion_rate": "20",
    "from_token_id": "USD",
    "to_token_id": "INR",
    "balance": 75,
    "onhold_balance": 0,
    "timestamp": "2022-11-30T11:03:20.000Z",
    "transaction_type": "TOKEN_CONVERSION_DEBIT"
  }
]
history
このメソッドは、トークンのペアのトークン換算レート履歴を返します。このメソッドは、チェーンコードのToken Admin、任意のOrg Adminおよび任意のトークン・アカウント所有者がコールできます。 
Ctx.TokenConversionRate.history(conversion_rate_id: string)
パラメータ:
  • conversion_rate_id: string – 換算レート・オブジェクトのID。
戻り値:
  • 成功の場合、換算レート履歴の詳細を含むJSONオブジェクト。
戻り値の例:
 [
  {
    "trxId": "0b1ba7bc2620e1438b6580365e5c0ab852247ccfa5a3eb2157d3baca02c0e521",
    "timeStamp": "2022-11-30T10:23:38.000Z",
    "value": {
      "assetType": "oconversionRate",
      "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
      "from_token_id": "USD",
      "to_token_id": "INR",
      "conversion_rate": 20
    }
  },
  {
    "trxId": "36fc40ddb3d8308ee7e156af700da131d78d941fe390fc57985b7589e7035d5c",
    "timeStamp": "2022-11-30T10:13:18.000Z",
    "value": {
      "assetType": "oconversionRate",
      "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
      "from_token_id": "USD",
      "to_token_id": "INR",
      "conversion_rate": 10
    }
  }
]
getExchangePoolUser
このメソッドは、交換プール・ユーザーのOrgIdおよびUserId値を返します。このメソッドは、チェーンコードのToken Adminのみがコールできます。 
Ctx.TokenConvertor.getExchangePoolUser()
パラメータ:
  • なし
戻り値:
  • 成功の場合、交換プールのユーザーに関する情報を含むメッセージ。
戻り値の例:
{
   "assetType": "oconversion",
   "convertor_id": "bcb1f3b1442c625d3ce205660c5e717c5858a1fe1e12c325df799a851ceaa09b",
   "org_id": "Org1MSP",
   "user_id": "exchangepooluser"
}