TypeScript Métodos para Status da Conta de Token ERC-721

O Blockchain App Builder gera automaticamente métodos que você pode usar para gerenciar o status da conta para tokens que usam o padrão ERC-721 estendido.

Você pode usar os métodos a seguir para colocar as contas de usuário de token nos estados ativo, suspenso ou excluído.

Quando uma conta é suspensa, o usuário da conta não pode concluir nenhuma operação de gravação, que inclui cunhagem, gravação e transferência de tokens. Além disso, outros usuários não podem transferir tokens para uma conta suspensa. Uma conta suspensa ainda pode concluir operações de leitura.

Uma conta com um saldo de token diferente de zero não pode ser excluída. Você deve transferir ou gravar todos os tokens em uma conta para poder excluir a conta. Depois que uma conta estiver no estado excluído, não será possível alterá-lo de volta para ativo ou suspenso.

• Métodos de Status da Conta Gerados Automaticamente
• Métodos SDK do Status da Conta

Métodos de Status da Conta Gerados Automaticamente

getAccountStatus

Este método obtém o status atual da conta de token. Esse método pode ser chamado pelo Token Admin do chaincode ou pelo proprietário da conta do token.

@Validator(yup.string(), yup.string())
     public async getAccountStatus(orgId: string, userId: string) {
       const accountId = await this.Ctx.ERC721Account.generateAccountId(orgId, userId);
       await this.Ctx.ERC721Auth.checkAuthorization("ERC721ACCOUNT_STATUS.get", "TOKEN", { accountId });
       try {
         return await this.Ctx.ERC721AccountStatus.getAccountStatus(accountId);
       } catch (err) {
        return await this.Ctx.ERC721AccountStatus.getDefaultAccountStatus(accountId);
       }
     }

Parâmetros:

• orgId: string - O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
• userId: string - O nome de usuário ou o ID de e-mail do usuário.

Retorna:

• Em caso de sucesso, uma representação JSON do status da conta de token. Se nenhum status for encontrado no razão da conta porque a conta foi criada antes da funcionalidade de status da conta estar disponível, o status será listado como active na resposta.

Exemplo de Valor de Retorno:

{
    "assetType": "oaccountStatus",
    "statusId": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
    "accountId": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
    "status": "active"
}

getAccountStatusHistory

Este método obtém o histórico do status da conta. Esse método pode ser chamado pelo Token Admin do chaincode ou pelo proprietário da conta do token.

public async getAccountStatusHistory(orgId: string, userId: string) {
       const accountId = await this.Ctx.ERC721Account.generateAccountId(orgId, userId);
       await this.Ctx.ERC721Account.getAccount(accountId);
       await this.Ctx.ERC721Auth.checkAuthorization("ERC721ACCOUNT_STATUS.history", "TOKEN", { accountId });
       const status_id = await this.Ctx.ERC721AccountStatus.generateAccountStatusId(accountId);
       let accountStatusHistory: any;
       try {
         accountStatusHistory = await this.Ctx.ERC721AccountStatus.history(status_id);
       } catch (err) {
         return [];
       }
       return accountStatusHistory;
     }

Parâmetros:

• orgId: string - O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
• userId: string - O nome de usuário ou o ID de e-mail do usuário.

Retorna:

• Em caso de sucesso, o histórico de status da conta no formato JSON.

Exemplo de Valor de Retorno:

[
  {
    "trxId": "d5c6d6f601257ba9b6edaf5b7660f00adc13c37d5321b8f7d3a35afab2e93e63",
    "timeStamp": "2022-12-02T10:39:14.000Z",
    "value": {
      "assetType": "oaccountStatus",
      "statusId": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
      "accountId": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
      "status": "suspended"
    }
  },
  {
    "trxId": "e6c850cfa084dc20ad95fb2bb8165eef3a3bd62a0ac867cccee57c2003125183",
    "timeStamp": "2022-12-02T10:37:50.000Z",
    "value": {
      "assetType": "oaccountStatus",
      "statusId": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
      "accountId": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
      "status": "active"
    }
  }
]

activateAccount

Este método ativa uma conta de token. Este método só pode ser chamado por um Token Admin do chaincode. Contas excluídas não podem ser ativadas. Para todas as contas criadas antes de a funcionalidade de status da conta estar disponível, você deve chamar esse método para definir o status da conta como active.

@Validator(yup.string(), yup.string())
 public async activateAccount(orgId: string, userId: string) {
   await this.Ctx.ERC721Auth.checkAuthorization("ERC721ACCOUNT_STATUS.activateAccount", "TOKEN");
   const accountId = await this.Ctx.ERC721Account.generateAccountId(orgId, userId);
   return await this.Ctx.ERC721Account.activateAccount(accountId);
 }

Parâmetros:

• orgId: string - O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
• userId: string - O nome de usuário ou o ID de e-mail do usuário.

Retorna:

• Em caso de sucesso, uma representação JSON do status da conta de token.

Exemplo de Valor de Retorno:

{
  "assetType": "oaccountStatus",
  "statusId": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
  "accountId": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
  "status": "active"
}

suspendAccount

Este método suspende uma conta de token. Este método só pode ser chamado por um Token Admin do chaincode. Depois que uma conta é suspensa, você não pode concluir nenhuma operação que atualize a conta. Uma conta excluída não pode ser suspensa.

@Validator(yup.string(), yup.string())
 public async suspendAccount(orgId: string, userId: string) {
   await this.Ctx.ERC721Auth.checkAuthorization("ERC721ACCOUNT_STATUS.suspendAccount", "TOKEN");
   const accountId = await this.Ctx.ERC721Account.generateAccountId(orgId, userId);
   return await this.Ctx.ERC721Account.suspendAccount(accountId);
 }

Parâmetros:

• orgId: string - O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
• userId: string - O nome de usuário ou o ID de e-mail do usuário.

Retorna:

• Em caso de sucesso, uma representação JSON do status da conta de token.

Exemplo de Valor de Retorno:

{
    "assetType": "oaccountStatus",
    "statusId": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
    "accountId": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
    "status": "suspended"
}

deleteAccount

Este método exclui uma conta de token. Este método só pode ser chamado por um Token Admin do chaincode. Depois que uma conta é excluída, não é possível concluir nenhuma operação que atualize a conta. A conta excluída está em um estado final e não pode ser alterada para nenhum outro estado. Para excluir uma conta, o saldo da conta deve ser zero.

@Validator(yup.string(), yup.string())
 public async deleteAccount(orgId: string, userId: string) {
   await this.Ctx.ERC721Auth.checkAuthorization("ERC721ACCOUNT_STATUS.deleteAccount", "TOKEN");
   const accountId = await this.Ctx.ERC721Account.generateAccountId(orgId, userId);
   return await this.Ctx.ERC721Account.deleteAccount(accountId);
 }

Parâmetros:

• orgId: string - O ID do provedor de serviços de associação (MSP) do usuário na organização atual.
• userId: string - O nome de usuário ou o ID de e-mail do usuário.

Retorna:

• Em caso de sucesso, uma representação JSON do status da conta de token.

Exemplo de Valor de Retorno:

{
  "assetType": "oaccountStatus",
  "statusId": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
  "accountId": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
  "status": "deleted"
}

Métodos SDK do Status da Conta

getAccountStatus

Este método obtém o status atual da conta de token.

Ctx.ERC721AccountStatus.getAccountStatus(accountId: string)

Parâmetros:

• accountId: string - O ID da conta de token.

Retorna:

• Em caso de sucesso, uma representação JSON do status da conta de token. Se nenhum status for encontrado no razão da conta porque a conta foi criada antes da funcionalidade de status da conta estar disponível, o status será listado como active na resposta.

Exemplo de Valor de Retorno:

{
    "assetType": "oaccountStatus",
    "statusId": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
    "accountId": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
    "status": "active"
}

getAccountStatusHistory

Este método obtém o histórico do status da conta.

Ctx.ERC721AccountStatus.history(statusId: string)

Parâmetros:

• statusId: string - O ID do objeto de status da conta.

Retorna:

• Em caso de sucesso, uma representação JSON do histórico de status da conta.

Exemplo de Valor de Retorno:

[
  {
    "trxId": "d5c6d6f601257ba9b6edaf5b7660f00adc13c37d5321b8f7d3a35afab2e93e63",
    "timeStamp": "2022-12-02T10:39:14.000Z",
    "value": {
      "assetType": "oaccountStatus",
      "statusId": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
      "accountId": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
      "status": "suspended"
    }
  },
  {
    "trxId": "e6c850cfa084dc20ad95fb2bb8165eef3a3bd62a0ac867cccee57c2003125183",
    "timeStamp": "2022-12-02T10:37:50.000Z",
    "value": {
      "assetType": "oaccountStatus",
      "statusId": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
      "accountId": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
      "status": "active"
    }
  }
]

activateAccount

Este método ativa uma conta de token. Para todas as contas criadas antes de a funcionalidade de status da conta estar disponível, você deve chamar esse método para definir o status da conta como active.

Ctx.ERC721Account.activateAccount(accountId: string)

Parâmetros:

• accountId: string - O ID da conta de token.

Retorna:

• Em caso de sucesso, uma representação JSON do objeto de status da conta para a conta de token especificada.

Exemplo de Valor de Retorno:

{
  "assetType": "oaccountStatus",
  "statusId": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
  "accountId": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
  "status": "active"
}

suspendAccount

Este método suspende uma conta de token.

Ctx.ERC721AccountStatus.suspendAccount(accountId: string)

Parâmetros:

• accountId: string - O ID da conta de token.

Retorna:

• Em caso de sucesso, uma representação JSON do objeto de status da conta para a conta de token especificada.

Exemplo de Valor de Retorno:

{
    "assetType": "oaccountStatus",
    "statusId": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
    "accountId": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
    "status": "suspended"
}

deleteAccount

Este método exclui uma conta de token.

Ctx.ERC721Account.deleteAccount(accountId: string)

Parâmetros:

• accountId: string - O ID da conta de token.

Retorna:

• Em caso de sucesso, uma representação JSON do objeto de status da conta para a conta de token especificada.

Exemplo de Valor de Retorno:

{
  "assetType": "oaccountStatus",
  "statusId": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
  "accountId": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
  "status": "deleted"
}