TypeScript Méthodes de verrouillage ERC-1155 NFT

Blockchain App Builder génère automatiquement des méthodes que vous pouvez utiliser pour verrouiller les jetons non fongibles qui utilisent la norme ERC-1155 étendue.

Un jeton verrouillé ne peut pas être gravé ou transféré à d'autres utilisateurs. Toutes les autres propriétés, telles que l'état, le propriétaire et l'historique du jeton, sont conservées. Vous pouvez utiliser la fonctionnalité de verrouillage NFT lors du transfert d'un jeton vers un autre réseau blockchain, tel qu'Ethereum ou Polygon.

Avant de verrouiller les fichiers NFT, vous devez affecter le rôle de gestionnaire de chambre forte à un utilisateur. Le gestionnaire de chambre forte est un type de rôle spécial, un rôle TokenSys. Les rôles TokenSys sont différents des rôles basés sur les ressources, tels que le brûleur, le minter et le notaire, et des rôles d'administration, tels que Token Admin et Org Admin. Actuellement, Blockchain App Builder prend en charge le rôle vault TokenSys. L'utilisateur unique qui a le rôle vault pour un code de chaîne est le gestionnaire de chambre forte du code de chaîne et peut gérer les transactions NFT verrouillées.

Le flux typique pour l'utilisation de la fonctionnalité de verrouillage NFT suit ces étapes.

• Créez un jeton non fongible ayant le comportement verrouillable.
• Utilisez la méthode addTokenSysRole pour accorder le rôle vault à un utilisateur, le gestionnaire de chambres fortes.
• Appelez la méthode lockNFT pour verrouiller un jeton non fongible, spécifié par l'ID jeton.

TokenSys Méthodes de gestion des rôles

addTokenSysRole

Cette méthode ajoute un rôle TokenSys à un utilisateur spécifié. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.

@Validator(yup.string(), yup.string(), yup.string())
public async addTokenSysRole(orgId: string, userId: string, role: string) {
  await this.Ctx.ERC1155Auth.checkAuthorization("ERC1155TOKEN.addTokenSysRoleMember", "TOKEN");
  const userAccountId = this.Ctx.ERC1155Account.generateAccountId(orgId, userId);
  return await this.Ctx.ERC1155Token.addTokenSysRoleMember(role, userAccountId);
}

Paramètres :

• orgId: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
• userId: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
• role: string - Nom du rôle TokenSys à donner à l'utilisateur.

Retours :

• En cas de succès, un message contenant les détails pertinents de l'opération.

Exemple de valeur renvoyée :

{
    "msg": "Successfully added role 'vault' to Account Id: oaccount~bf07f584a94be44781e49d9101bfaf58c6fbbe77a4dfebdb83c874c2caf03eba (Org-Id: Org1MSP, User-Id: user1)"
}

isInTokenSysRole

Cette méthode retourne une valeur booléenne pour indiquer si un utilisateur a un rôle TokenSys spécifié. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.

@Validator(yup.string(), yup.string(), yup.string())
public async isInTokenSysRole(orgId: string, userId: string, role: string) {
  await this.Ctx.ERC1155Auth.checkAuthorization("ERC1155TOKEN.isInTokenSysRole", "TOKEN", {orgId: orgId, userId: userId });
  const userAccountId = this.Ctx.ERC1155Account.generateAccountId(orgId, userId);
  return await this.Ctx.ERC1155Token.isInTokenSysRole(role, userAccountId);
}

Paramètres :

• orgId: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
• userId: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
• role: string - Nom du rôle TokenSys à vérifier.

Retours :

• En cas de succès, un message contenant les détails pertinents de l'opération.

Exemple de valeur renvoyée :

{
    "result": true,
    "msg": "Account Id oaccount~bf07f584a94be44781e49d9101bfaf58c6fbbe77a4dfebdb83c874c2caf03eba (Org-Id: Org1MSP, User-Id: user1) has vault role"
}

removeTokenSysRole

Cette méthode supprime un rôle TokenSys d'un utilisateur spécifié. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.

@Validator(yup.string(), yup.string(), yup.string())
public async removeTokenSysRole(orgId: string, userId: string, role: string) {
  await this.Ctx.ERC1155Auth.checkAuthorization("ERC1155TOKEN.removeTokenSysRoleMember", "TOKEN");
  const userAccountId = this.Ctx.ERC1155Account.generateAccountId(orgId, userId);
  return await this.Ctx.ERC1155Token.removeTokenSysRoleMember(role, userAccountId);
}

Paramètres :

• orgId: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
• userId: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
• role: string - Nom du rôle TokenSys à supprimer.

Retours :

• En cas de succès, un message contenant les détails pertinents de l'opération.

Exemple de valeur renvoyée :

{
    "msg": "Successfully removed role 'vault' from Account Id: oaccount~bf07f584a94be44781e49d9101bfaf58c6fbbe77a4dfebdb83c874c2caf03eba (Org-Id: Org1MSP, User-Id: user1)"
}

transferTokenSysRole

Cette méthode transfère un rôle TokenSys d'un utilisateur à un autre utilisateur. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.

@Validator(yup.string(), yup.string(), yup.string(), yup.string(), yup.string())
public async transferTokenSysRole(fromOrgId: string, fromUserId: string, toOrgId: string, toUserId: string, role: string) {
    await this.Ctx.ERC1155Auth.checkAuthorization("ERC1155TOKEN.transferTokenSysRole", "TOKEN");
    const fromUserAccountId = await this.Ctx.ERC1155Account.generateAccountId(fromOrgId, fromUserId);
    const toUserAccountId = await this.Ctx.ERC1155Account.generateAccountId(toOrgId, toUserId);
    return await this.Ctx.ERC1155Token.transferTokenSysRole(role, fromUserAccountId, toUserAccountId);
}

Paramètres :

• fromOrgId: string - ID fournisseur de services d'adhésion de l'utilisateur à partir duquel transférer le rôle TokenSys.
• fromUserId: string - Nom d'utilisateur ou ID courriel de l'utilisateur à partir duquel transférer le rôle TokenSys.
• toOrgId: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur vers lequel transférer le rôle TokenSys.
• toUserId: string - Nom d'utilisateur ou ID courriel de l'utilisateur vers lequel transférer le rôle TokenSys.
• role: string - Nom du rôle TokenSys à transférer.

Retours :

• En cas de succès, un message contenant les détails pertinents de l'opération.

Exemple de valeur renvoyée :

{
    "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

Cette méthode retourne une liste de tous les ID compte pour un rôle TokenSys spécifié. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.

@Validator(yup.string())
public async getAccountsByTokenSysRole(role: string) {
  await this.Ctx.ERC1155Auth.checkAuthorization("ERC1155TOKEN.getAccountsByTokenSysRole", "TOKEN");
  return await this.Ctx.ERC1155Token.getAccountsByTokenSysRole(role);
}

Paramètres :

• role: string - Nom du rôle TokenSys.

Retours :

• En cas de succès, un message contenant les détails pertinents de l'opération.

Exemple de valeur renvoyée :

{
    "accountIds": [
        "oaccount~bf07f584a94be44781e49d9101bfaf58c6fbbe77a4dfebdb83c874c2caf03eba"
    ]
}

getUsersByTokenSysRole

Cette méthode retourne des informations sur l'utilisateur pour tous les utilisateurs ayant un rôle TokenSys spécifié. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.

@Validator(yup.string())
public async getUsersByTokenSysRole(role: string) {
  await this.Ctx.ERC1155Auth.checkAuthorization("ERC1155TOKEN.getUsersByTokenSysRole", "TOKEN");
  return await this.Ctx.ERC1155Token.getUsersByTokenSysRole(role);
}

Paramètres :

• role: string - Nom du rôle TokenSys.

Retours :

• En cas de succès, un message contenant les détails pertinents de l'opération.

Exemple de valeur renvoyée :

{
   "users":[
      {
         "accountId":"oaccount~bf07f584a94be44781e49d9101bfaf58c6fbbe77a4dfebdb83c874c2caf03eba",
         "orgId":"Org1MSP",
         "userId":"user1"
      }
   ]
}

Méthodes de verrouillage NFT

lockNFT

Cette méthode verrouille un jeton non fongible spécifié. Pour verrouiller un jeton, un utilisateur doté du rôle TokenSys vault doit agir en tant que gestionnaire de chambres fortes. Cette méthode ne peut être appelée que par le propriétaire du jeton.

@Validator(yup.string())
public async lockNFT(orgId: string, userId: string, tokenId: string) {
  return await this.Ctx.ERC1155Token.lockNFT(orgId, userId, tokenId);
}

Paramètres :

• orgId: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
• userId: string - Nom d'utilisateur ou ID courriel de l'utilisateur (facultatif).
• tokenID: string - ID du jeton à verrouiller.

Retours :

• En cas de succès, une représentation JSON de l'objet de jeton.

Exemple de valeur renvoyée :

{
   "assetType":"otoken",
   "tokenId":"token1",
   "tokenName":"artcollection",
   "tokenStandard":"erc1155+",
   "tokenType":"nonfungible",
   "tokenUnit":"whole",
   "behaviors":[
      "indivisible",
      "mintable",
      "transferable",
      "burnable",
      "lockable",
      "roles"
   ],
   "roles":{
      "minter_role_name":"minter"
   },
   "mintable":{
      "max_mint_quantity":20000
   },
   "quantity":1,
   "createdBy":"oaccount~208e3345ac84b4849f0d2648b2f2f018019886a1230f99304ebff1b6a7733463",
   "creationDate":"2023-10-20T09:16:29.000Z",
   "owner":"oaccount~208e3345ac84b4849f0d2648b2f2f018019886a1230f99304ebff1b6a7733463",
   "isBurned":false,
   "isLocked":true,
   "tokenUri":"token1.example.com",
   "price":120,
   "on_sale_flag":false
}

isNFTLocked

Cette méthode retourne une valeur booléenne pour indiquer si un jeton spécifié est verrouillé. Cette méthode ne peut être appelée que par le responsable du jeton, le gestionnaire de chambres fortes (utilisateur doté du rôle TokenSys vault) ou une chaîne Token Admin du code de chaîne.

@GetMethod()
@Validator(yup.string())
public async isNFTLocked(tokenId: string) {
  try {
    await this.Ctx.ERC1155Auth.checkAuthorization("ERC1155TOKEN.isNFTLocked", "TOKEN", { tokenId });
  } catch(err) {
    const isCallerTokenSysRoleHolder = await this.Ctx.ERC1155Token.isCallerTokenSysRoleHolder(TOKEN_SYS_ROLE_TYPE.VAULT);
    if(!isCallerTokenSysRoleHolder)
      throw err;
  }
  const isNFTLocked = await this.Ctx.ERC1155Token.isNFTLocked(tokenId);
  return {isNFTLocked};
}

Paramètres :

• tokenID: string - ID du jeton.

Retours :

• En cas de succès, un message contenant les détails pertinents de l'opération.

Exemple de valeur renvoyée :

{
   "isNFTLocked":true
}

getAllLockedNFTs

Cette méthode retourne une liste de tous les jetons non fongibles verrouillés. Cette méthode ne peut être appelée que par le gestionnaire de chambres fortes (utilisateur doté du rôle TokenSys vault) ou par un code de chaîne Token Admin.

@GetMethod()
@Validator()
public async getAllLockedNFTs() {
  try {
    await this.Ctx.ERC1155Auth.checkAuthorization("ERC1155TOKEN.getAllLockedNFTs", "TOKEN");
  } catch(err) {
    const isCallerTokenSysRoleHolder = await this.Ctx.ERC1155Token.isCallerTokenSysRoleHolder(TOKEN_SYS_ROLE_TYPE.VAULT);
    if(!isCallerTokenSysRoleHolder)
      throw err;
  }
  return this.Ctx.ERC1155Token.getAllLockedNFTs();
}

Paramètres :

• Aucune

Retours :

• En cas de succès, un tableau des objets de jeton verrouillés non fongibles.

Exemple de valeur renvoyée :

[
   {
      "key":"token1",
      "valueJson":{
         "assetType":"otoken",
         "tokenId":"token1",
         "tokenName":"artcollection",
         "tokenStandard":"erc1155+",
         "tokenType":"nonfungible",
         "tokenUnit":"whole",
         "behaviors":[
            "indivisible",
            "mintable",
            "transferable",
            "burnable",
            "lockable",
            "roles"
         ],
         "roles":{
            "minter_role_name":"minter"
         },
         "mintable":{
            "max_mint_quantity":20000
         },
         "quantity":1,
         "createdBy":"oaccount~208e3345ac84b4849f0d2648b2f2f018019886a1230f99304ebff1b6a7733463",
         "creationDate":"2023-10-20T09:16:29.000Z",
         "owner":"oaccount~208e3345ac84b4849f0d2648b2f2f018019886a1230f99304ebff1b6a7733463",
         "isBurned":false,
         "isLocked":true,
         "tokenUri":"token1.example.com",
         "price":120,
         "on_sale_flag":false
      }
   }
]

getAllLockedNFTsByOrg

Cette méthode retourne une liste de tous les jetons non fongibles verrouillés pour une organisation spécifiée et facultativement un utilisateur spécifié. Cette méthode ne peut être appelée que par le gestionnaire de chambres fortes (utilisateur doté du rôle TokenSys vault) ou par un code de chaîne Token Admin.

@GetMethod()
@Validator(yup.string(), yup.string())
public async getLockedNFTsByOrg(orgId: string, userId?: string) {
  try {
    await this.Ctx.ERC1155Auth.checkAuthorization("ERC1155TOKEN.getLockedNFTsByOrg", "TOKEN");
  } catch(err) {
    const isCallerTokenSysRoleHolder = await this.Ctx.ERC1155Token.isCallerTokenSysRoleHolder(TOKEN_SYS_ROLE_TYPE.VAULT);
    if(!isCallerTokenSysRoleHolder)
      throw err;
  }
  return await this.Ctx.ERC1155Token.getLockedNFTsByOrg(orgId, userId);
}

Paramètres :

• orgId: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
• userId: string - Nom d'utilisateur ou ID courriel de l'utilisateur (facultatif).

Retours :

• En cas de succès, un tableau des objets de jeton verrouillés non fongibles.

Exemple de valeur renvoyée :

[
   {
      "key":"token1",
      "valueJson":{
         "assetType":"otoken",
         "tokenId":"token1",
         "tokenName":"artcollection",
         "tokenStandard":"erc1155+",
         "tokenType":"nonfungible",
         "tokenUnit":"whole",
         "behaviors":[
            "indivisible",
            "mintable",
            "transferable",
            "burnable",
            "lockable",
            "roles"
         ],
         "roles":{
            "minter_role_name":"minter"
         },
         "mintable":{
            "max_mint_quantity":20000
         },
         "quantity":1,
         "createdBy":"oaccount~208e3345ac84b4849f0d2648b2f2f018019886a1230f99304ebff1b6a7733463",
         "creationDate":"2023-10-20T09:16:29.000Z",
         "owner":"oaccount~208e3345ac84b4849f0d2648b2f2f018019886a1230f99304ebff1b6a7733463",
         "isBurned":false,
         "isLocked":true,
         "tokenUri":"token1.example.com",
         "price":120,
         "on_sale_flag":false
      }
   }
]