TypeScript ERC-721 NFTロックのメソッド

ブロックチェーン・アプリケーション・ビルダーは、拡張ERC-721標準を使用する非代替トークンをロックするために使用できるメソッドを自動的に生成します。

ロックされたトークンは、他のユーザーに書き込むことも、転送することもできません。トークンの状態、所有者、履歴など、その他のすべてのプロパティが保持されます。トークンをEthereumやPolygonなどの別のブロックチェーン・ネットワークに転送する場合は、NFTロック機能を使用できます。

NFTをロックする前に、ボールト・マネージャ・ロールをユーザーに割り当てる必要があります。ボールト・マネージャは、特別なタイプのロール(TokenSysロール)です。TokenSysロールは、バーナー、ミナー、公証人などのアセット・ベースのロールや、Token AdminやOrg Adminなどの管理ロールとは異なります。現在、ブロックチェーン・アプリケーション・ビルダーはvault TokenSysロールをサポートしています。チェーンコードのvaultロールを持つ単一ユーザーは、チェーンコードのボールト・マネージャであり、ロックされたNFTを管理できます。

NFTロック機能を使用する一般的なフローは、次のステップに従います。
  • ロック可能な動作を持つ非代替トークンを作成します。
  • addTokenSysRoleメソッドを使用して、vaultロールをユーザー(ボールト・マネージャ)に付与します。
  • lockNFTメソッドをコールして、トークンIDで指定された非代替トークンをロックします。

TokenSysロール管理メソッド

addTokenSysRole
このメソッドは、指定されたユーザーにTokenSysロールを追加します。このメソッドをコールできるのは、チェーンコードのToken Adminのみです。 
@Validator(yup.string(), yup.string(), yup.string())
public async addTokenSysRole(role: string, orgId: string, userId: string) {
    await this.Ctx.ERC721Auth.checkAuthorization("ERC721TOKEN.addTokenSysRoleMember", "TOKEN");
    await this.Ctx.ERC721Auth.checkAuthorization('ERC721TOKEN.addRoleMember', 'TOKEN');
    const accountId = await this.Ctx.ERC721Account.generateAccountId(orgId, userId);
    return await this.Ctx.ERC721Token.addTokenSysRoleMember(role, accountId);
}
パラメータ:
  • role: string– ユーザーに付与するTokenSysロールの名前。
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID。
戻り値:
  • 成功時に、操作の関連詳細を含むメッセージ。
戻り値の例:
{
    "msg": "Successfully added role 'vault' to Account Id: oaccount~bf07f584a94be44781e49d9101bfaf58c6fbbe77a4dfebdb83c874c2caf03eba (Org-Id: Org1MSP, User-Id: user1)"
}
isInTokenSysRole
このメソッドは、ユーザーに指定されたTokenSysロールがあるかどうかを示すブール値を返します。このメソッドをコールできるのは、チェーンコードのToken Adminのみです。 
@GetMethod()
@Validator(yup.string(), yup.string(), yup.string())
public async isInTokenSysRole(orgId: string, userId: string, role: string) {
    await this.Ctx.ERC721Auth.checkAuthorization("ERC721TOKEN.isInTokenSysRole", "TOKEN", {orgId: orgId, userId: userId });
    const accountId = await this.Ctx.ERC721Account.generateAccountId(orgId, userId);
    return await this.Ctx.ERC721Token.isInTokenSysRole(role, accountId);
}
パラメータ:
  • role: string– チェックするTokenSysロールの名前。
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID。
戻り値:
  • 成功時に、操作の関連詳細を含むメッセージ。
戻り値の例:
{
    "result": true,
    "msg": "Account Id oaccount~bf07f584a94be44781e49d9101bfaf58c6fbbe77a4dfebdb83c874c2caf03eba (Org-Id: Org1MSP, User-Id: user1) has vault role"
}
removeTokenSysRole
このメソッドは、指定されたユーザーからTokenSysロールを削除します。このメソッドをコールできるのは、チェーンコードのToken Adminのみです。 
@Validator(yup.string(), yup.string(), yup.string())
public async removeTokenSysRole(role: string, orgId: string, userId: string) {
    await this.Ctx.ERC721Auth.checkAuthorization("ERC721TOKEN.removeTokenSysRoleMember", "TOKEN");
    const accountId = await this.Ctx.ERC721Account.generateAccountId(orgId, userId);
    return await this.Ctx.ERC721Token.removeTokenSysRoleMember(role, accountId);
}
パラメータ:
  • role: string– 削除するTokenSysロールの名前。
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID。
戻り値:
  • 成功時に、操作の関連詳細を含むメッセージ。
戻り値の例:
{
    "msg": "Successfully removed role 'vault' from Account Id: oaccount~bf07f584a94be44781e49d9101bfaf58c6fbbe77a4dfebdb83c874c2caf03eba (Org-Id: Org1MSP, User-Id: user1)"
}
transferTokenSysRole
このメソッドは、TokenSysロールをユーザーから別のユーザーに転送します。このメソッドをコールできるのは、チェーンコードのToken Adminのみです。 
@Validator(yup.string(), yup.string(), yup.string(), yup.string(), yup.string())
public async transferTokenSysRole(role: string, fromOrgId: string, fromUserId: string, toOrgId: string, toUserId: string) {
    await this.Ctx.ERC721Auth.checkAuthorization("ERC721TOKEN.transferTokenSysRole", "TOKEN");
    const fromAccountId = await this.Ctx.ERC721Account.generateAccountId(fromOrgId, fromUserId);
    const toAccountId = await this.Ctx.ERC721Account.generateAccountId(toOrgId, toUserId);
    return await this.Ctx.ERC721Token.transferTokenSysRole(role, fromAccountId, toAccountId);
}
パラメータ:
  • role: string– 転送するTokenSysロールの名前。
  • fromOrgId: string– TokenSysロールの転送元のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • fromUserId: string– TokenSysロールの転送元のユーザーのユーザー名または電子メールID。
  • toOrgId: string– TokenSysロールの転送先のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • toUserId: string– TokenSysロールの転送先のユーザーのユーザー名または電子メールID。
戻り値:
  • 成功時に、操作の関連詳細を含むメッセージ。
戻り値の例:
{
    "msg": "Successfully transfered role 'vault' from Account Id: ouaccount~f4e311528f03fffa7810753d643f66289ff6c9080fcf839902f28a1d3aff1789 (Org-Id: Org1MSP, User-Id: user1) to Account Id: ouaccount~ae5be2ae8f98d6d32f5d02b43877d987114e7937c7bacbc30390dcce09996a19 (Org-Id: Org1MSP, User-Id: user2)"
}
getAccountsByTokenSysRole
このメソッドは、指定されたTokenSysロールのすべてのアカウントIDのリストを返します。このメソッドをコールできるのは、チェーンコードのToken Adminのみです。 
@GetMethod()
@Validator(yup.string())
public async getAccountsByTokenSysRole(role: string) {
    await this.Ctx.ERC721Auth.checkAuthorization("ERC721TOKEN.getAccountsByTokenSysRole", "TOKEN");
    return await this.Ctx.ERC721Token.getAccountsByTokenSysRole(role);
}
パラメータ:
  • role: string– TokenSysロールの名前。
戻り値:
  • 成功時に、操作の関連詳細を含むメッセージ。
戻り値の例:
{
    "accountIds": [
        "oaccount~bf07f584a94be44781e49d9101bfaf58c6fbbe77a4dfebdb83c874c2caf03eba"
    ]
}
getUsersByTokenSysRole
このメソッドは、指定されたTokenSysロールを持つすべてのユーザーのユーザー情報を返します。このメソッドをコールできるのは、チェーンコードのToken Adminのみです。 
@GetMethod()
@Validator(yup.string())
public async getUsersByTokenSysRole(role: string) {
    await this.Ctx.ERC721Auth.checkAuthorization("ERC721TOKEN.getUsersByTokenSysRole", "TOKEN");
    return await this.Ctx.ERC721Token.getUsersByTokenSysRole(role);
}
パラメータ:
  • role: string– TokenSysロールの名前。
戻り値:
  • 成功時に、操作の関連詳細を含むメッセージ。
戻り値の例:
 "users":[
      {
         "accountId":"oaccount~bf07f584a94be44781e49d9101bfaf58c6fbbe77a4dfebdb83c874c2caf03eba",
         "orgId":"Org1MSP",
         "userId":"user1"
      }
   ]
}

NFTロック方法

lockNFT
このメソッドは、指定された非代替トークンをロックします。トークンをロックするには、ボールト・マネージャとして機能するTokenSys vaultロールを持つユーザーが存在する必要があります。このメソッドは、トークンの所有者のみがコールできます。 
@Validator(yup.string())
public async lockNFT(tokenId: string) {
    return await this.Ctx.ERC721Token.lockNFT(tokenId);
}
パラメータ:
  • tokenID: string– ロックするトークンのID。
戻り値:
  • 成功すると、トークン・オブジェクトのJSON表現。
戻り値の例:
{
   "assetType":"otoken",
   "tokenId":"token1",
   "tokenName":"artcollection",
   "symbol":"ART",
   "tokenStandard":"erc721+",
   "tokenType":"nonfungible",
   "tokenUnit":"whole",
   "behaviors":[
      "indivisible",
      "singleton",
      "mintable",
      "transferable",
      "lockable",
      "burnable",
      "roles"
   ],
   "roles":{
      "minter_role_name":"minter"
   },
   "mintable":{
      "max_mint_quantity":20000
   },
   "createdBy":"oaccount~208e3345ac84b4849f0d2648b2f2f018019886a1230f99304ebff1b6a7733463",
   "creationDate":"2023-10-20T10:26:29.000Z",
   "owner":"oaccount~208e3345ac84b4849f0d2648b2f2f018019886a1230f99304ebff1b6a7733463",
   "isBurned":false,
   "isLocked":true,
   "tokenUri":"token1.example.com",
   "price":120,
   "on_sale_flag":false
}
isNFTLocked
このメソッドは、指定されたトークンがロックされているかどうかを示すブール値を返します。このメソッドは、トークン所有者、ボールト・マネージャ(TokenSys vaultロールを持つユーザー)、またはチェーンコードのToken Adminによってのみコールできます。 
@GetMethod()
@Validator(yup.string())
public async isNFTLocked(tokenId: string) {
  try {
    await this.Ctx.ERC721Auth.checkAuthorization("ERC721TOKEN.isNFTLocked", "TOKEN", { tokenId });
  } catch(err) {
    const isCallerTokenSysRoleHolder = await this.Ctx.ERC721Token.isCallerTokenSysRoleHolder(TOKEN_SYS_ROLE_TYPE.VAULT);
    if(!isCallerTokenSysRoleHolder)
      throw err;
  }
  const isLocked = await this.Ctx.ERC721Token.isNFTLocked(tokenId);
  return {isLocked: isLocked}
}
パラメータ:
  • tokenID: string– トークンのID。
戻り値:
  • 成功時に、操作の関連詳細を含むメッセージ。
戻り値の例:
{
   "isNFTLocked":true
}
getAllLockedNFTs
このメソッドは、ロックされているすべての非代替トークンのリストを返します。このメソッドは、ボールト・マネージャ(TokenSys vaultロールを持つユーザー)またはチェーンコードのToken Adminによってのみコールできます。 
@GetMethod()
@Validator()
public async getAllLockedNFTs() {
  try {
    await this.Ctx.ERC721Auth.checkAuthorization("ERC721TOKEN.getAllLockedNFTs", "TOKEN");
  } catch(err) {
    const isCallerTokenSysRoleHolder = await this.Ctx.ERC721Token.isCallerTokenSysRoleHolder(TOKEN_SYS_ROLE_TYPE.VAULT);
    if(!isCallerTokenSysRoleHolder)
      throw err;
  }
 return this.Ctx.ERC721Token.getAllLockedNFTs();
}
パラメータ:
  • なし
戻り値:
  • 成功すると、ロックされた非代替トークンオブジェクトの配列。
戻り値の例:
[
   {
      "key":"token1",
      "valueJson":{
         "assetType":"otoken",
         "tokenId":"token1",
         "tokenName":"artcollection",
         "symbol":"ART",
         "tokenStandard":"erc721+",
         "tokenType":"nonfungible",
         "tokenUnit":"whole",
         "behaviors":[
            "indivisible",
            "singleton",
            "mintable",
            "transferable",
            "lockable",
            "burnable",
            "roles"
         ],
         "roles":{
            "minter_role_name":"minter"
         },
         "mintable":{
            "max_mint_quantity":20000
         },
         "createdBy":"oaccount~208e3345ac84b4849f0d2648b2f2f018019886a1230f99304ebff1b6a7733463",
         "creationDate":"2023-10-20T10:26:29.000Z",
         "owner":"oaccount~208e3345ac84b4849f0d2648b2f2f018019886a1230f99304ebff1b6a7733463",
         "isBurned":false,
         "isLocked":true,
         "tokenUri":"token1.example.com",
         "price":120,
         "on_sale_flag":false
      }
   }
]
getAllLockedNFTsByOrg
このメソッドは、指定された組織およびオプションで指定されたユーザーについて、ロックされているすべての非代替トークンのリストを返します。このメソッドは、ボールト・マネージャ(TokenSys vaultロールを持つユーザー)またはチェーンコードのToken Adminによってのみコールできます。 
@GetMethod()
@Validator(yup.string(), yup.string())
public async getLockedNFTsByOrg(orgId: string, userId?: string) {
  try {
    await this.Ctx.ERC721Auth.checkAuthorization("ERC721TOKEN.getLockedNFTsByOrg", "TOKEN");
  } catch(err) {
    const isCallerTokenSysRoleHolder = await this.Ctx.ERC721Token.isCallerTokenSysRoleHolder(TOKEN_SYS_ROLE_TYPE.VAULT);
    if(!isCallerTokenSysRoleHolder)
      throw err;
  }
  return await this.Ctx.ERC721Token.getLockedNFTsByOrg(orgId, userId);
}
パラメータ:
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID(オプション)。
戻り値:
  • 成功すると、ロックされた非代替トークンオブジェクトの配列。
戻り値の例:
[
   {
      "key":"token1",
      "valueJson":{
         "assetType":"otoken",
         "tokenId":"token1",
         "tokenName":"artcollection",
         "symbol":"ART",
         "tokenStandard":"erc721+",
         "tokenType":"nonfungible",
         "tokenUnit":"whole",
         "behaviors":[
            "indivisible",
            "singleton",
            "mintable",
            "transferable",
            "lockable",
            "burnable",
            "roles"
         ],
         "roles":{
            "minter_role_name":"minter"
         },
         "mintable":{
            "max_mint_quantity":20000
         },
         "createdBy":"oaccount~208e3345ac84b4849f0d2648b2f2f018019886a1230f99304ebff1b6a7733463",
         "creationDate":"2023-10-20T10:26:29.000Z",
         "owner":"oaccount~208e3345ac84b4849f0d2648b2f2f018019886a1230f99304ebff1b6a7733463",
         "isBurned":false,
         "isLocked":true,
         "tokenUri":"token1.examplecom",
         "price":120,
         "on_sale_flag":false
      }
   }
]