TypeScript Métodos para Estado de Cuenta de Token ERC-1155

Blockchain App Builder genera automáticamente métodos que puede utilizar para gestionar el estado de la cuenta de los tokens que utilizan el estándar ERC-1155 ampliado.

Puede utilizar los siguientes métodos para poner las cuentas de usuario de token en estado activo, suspendido o suprimido.

Cuando se suspende una cuenta, el usuario de la cuenta no puede completar ninguna operación de escritura, que incluye la extracción, la grabación y la transferencia de tokens. Además, otros usuarios no pueden transferir tokens a una cuenta suspendida. Una cuenta suspendida aún puede completar operaciones de lectura.

No se puede suprimir una cuenta con un saldo de token distinto de cero. Debe transferir o grabar todos los tokens en una cuenta antes de poder eliminar la cuenta. Una vez que una cuenta se encuentra en estado suprimido, el estado de la cuenta no se puede volver a cambiar a activo o suspendido.

Métodos de estado de cuenta generados automáticamente

getAccountStatus

Este método obtiene el estado actual de la cuenta de token. El Token Admin del código de cadenas o el propietario de la cuenta de token pueden llamar a este método.

@Validator(yup.string(), yup.string(), yup.string())
  public async getAccountStatus(orgId: string, userId: string, tokenId ?: string) {
    const userAccountId = this.Ctx.ERC1155Account.generateAccountId(orgId, userId, ACCOUNT_TYPE.USER_ACCOUNT);
    let tokenAccount = await this.Ctx.ERC1155Account.getAccount(userAccountId, tokenId);
    await this.Ctx.ERC1155Auth.checkAuthorization("ERC1155ACCOUNT_STATUS.get", "TOKEN", { accountId: tokenAccount.accountId });
    try {
      return await this.Ctx.ERC1155AccountStatus.getAccountStatus(tokenAccount.accountId);
    } catch (err) {
      return await this.Ctx.ERC1155AccountStatus.getDefaultAccountStatus(tokenAccount.accountId);
    }
  }

Parámetros:

orgId: string: ID del proveedor de servicios de miembros (MSP) del usuario en la organización actual.
userId: string: nombre de usuario o ID de correo electrónico del usuario.
tokenId ?: string: para una cuenta de token no fungible, una cadena vacía. Para una cuenta de token fungible, el ID de token.

Devuelve:

Una vez realizada correctamente, una representación JSON del estado de la cuenta de token. Si no se encuentra ningún estado en el libro mayor de la cuenta porque la cuenta se creó antes de que la funcionalidad de estado de cuenta estuviera disponible, el estado se muestra como active en la respuesta.

Ejemplo de valor de retorno:

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

getAccountStatusHistory

Este método obtiene el historial del estado de la cuenta. El Token Admin del código de cadenas o el propietario de la cuenta de token pueden llamar a este método.

public async getAccountStatusHistory(orgId: string, userId: string, tokenId ?: string) {
    const userAccountId = this.Ctx.ERC1155Account.generateAccountId(orgId, userId, ACCOUNT_TYPE.USER_ACCOUNT);
    let tokenAccount = await this.Ctx.ERC1155Account.getAccount(userAccountId, tokenId);
    await this.Ctx.ERC1155Auth.checkAuthorization("ERC1155ACCOUNT_STATUS.history", "TOKEN", { accountId: tokenAccount.accountId });
    const status_id = await this.Ctx.ERC1155AccountStatus.generateAccountStatusId(tokenAccount.accountId);
    let accountStatusHistory: any;
    try {
      accountStatusHistory = await this.Ctx.ERC1155AccountStatus.history(status_id);
    } catch (err) {
      return [];
    }
    return accountStatusHistory;
  }

Parámetros:

orgId: string: ID del proveedor de servicios de miembros (MSP) del usuario en la organización actual.
userId: string: nombre de usuario o ID de correo electrónico del usuario.
tokenId ?: string: para una cuenta de token no fungible, una cadena vacía. Para una cuenta de token fungible, el ID de token.

Devuelve:

En caso de éxito, el historial de estado de la cuenta en formato JSON.

Ejemplo 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 activa una cuenta de token. Este método solo puede ser llamado por un Token Admin del código de cadena. Las cuentas eliminadas no se pueden activar. Para cualquier cuenta creada antes de que la funcionalidad de estado de cuenta esté disponible, debe llamar a este método para definir el estado de cuenta como active.

@Validator(yup.string(), yup.string(), yup.string())
public async activateAccount(orgId: string, userId: string, tokenId ?: string) {
  await this.Ctx.ERC1155Auth.checkAuthorization("ERC1155ACCOUNT_STATUS.activateAccount", "TOKEN");
  const userAccountId = this.Ctx.ERC1155Account.generateAccountId(orgId, userId, ACCOUNT_TYPE.USER_ACCOUNT);
  let tokenAccount = await this.Ctx.ERC1155Account.getAccount(userAccountId, tokenId);
  return await this.Ctx.ERC1155Account.activateAccount(tokenAccount.accountId);
}

Parámetros:

orgId: string: ID del proveedor de servicios de miembros (MSP) del usuario en la organización actual.
userId: string: nombre de usuario o ID de correo electrónico del usuario.
tokenId ?: string: para una cuenta de token no fungible, una cadena vacía. Para una cuenta de token fungible, el ID de token.

Devuelve:

Una vez realizada correctamente, una representación JSON del estado de la cuenta de token.

Ejemplo de valor de retorno:

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

suspendAccount

Este método suspende una cuenta de token. Este método solo puede ser llamado por un Token Admin del código de cadena. Después de suspender una cuenta, no puede completar ninguna operación que actualice la cuenta. Una cuenta eliminada no se puede suspender.

@Validator(yup.string(), yup.string(), yup.string())
public async suspendAccount(orgId: string, userId: string, tokenId ?: string) {
  await this.Ctx.ERC1155Auth.checkAuthorization("ERC1155ACCOUNT_STATUS.suspendAccount", "TOKEN");
  const userAccountId = this.Ctx.ERC1155Account.generateAccountId(orgId, userId, ACCOUNT_TYPE.USER_ACCOUNT);
  let tokenAccount = await this.Ctx.ERC1155Account.getAccount(userAccountId, tokenId);
  return await this.Ctx.ERC1155Account.suspendAccount(tokenAccount.accountId);
}

Parámetros:

orgId: string: ID del proveedor de servicios de miembros (MSP) del usuario en la organización actual.
userId: string: nombre de usuario o ID de correo electrónico del usuario.
tokenId ?: string: para una cuenta de token no fungible, una cadena vacía. Para una cuenta de token fungible, el ID de token.

Devuelve:

Una vez realizada correctamente, una representación JSON del estado de la cuenta de token.

Ejemplo de valor de retorno:

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

deleteAccount

Este método suprime una cuenta de token. Este método solo puede ser llamado por un Token Admin del código de cadena. Después de eliminar una cuenta, no puede completar ninguna operación que actualice la cuenta. La cuenta eliminada tiene un estado final y no se puede cambiar a ningún otro estado. Para suprimir una cuenta, el saldo de cuenta debe ser cero.

@Validator(yup.string(), yup.string(), yup.string())
public async deleteAccount(orgId: string, userId: string, tokenId ?: string) {
  await this.Ctx.ERC1155Auth.checkAuthorization("ERC1155ACCOUNT_STATUS.deleteAccount", "TOKEN");
  const userAccountId = this.Ctx.ERC1155Account.generateAccountId(orgId, userId, ACCOUNT_TYPE.USER_ACCOUNT);
  let tokenAccount = await this.Ctx.ERC1155Account.getAccount(userAccountId, tokenId);
  return await this.Ctx.ERC1155Account.deleteAccount(tokenAccount.accountId);
}

Parámetros:

orgId: string: ID del proveedor de servicios de miembros (MSP) del usuario en la organización actual.
userId: string: nombre de usuario o ID de correo electrónico del usuario.
tokenId ?: string: para una cuenta de token no fungible, una cadena vacía. Para una cuenta de token fungible, el ID de token.

Devuelve:

Una vez realizada correctamente, una representación JSON del estado de la cuenta de token.

Ejemplo de valor de retorno:

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

Métodos SDK de estado de cuenta

getAccountStatus

Este método obtiene el estado actual de la cuenta de token.

Ctx.ERC1155AccountStatus.getAccountStatus(accountId: string)

Parámetros:

accountId: string: ID de la cuenta de token.

Devuelve:

Una vez realizada correctamente, una representación JSON del estado de la cuenta de token. Si no se encuentra ningún estado en el libro mayor de la cuenta porque la cuenta se creó antes de que la funcionalidad de estado de cuenta estuviera disponible, el estado se muestra como active en la respuesta.

Ejemplo de valor de retorno:

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

getAccountStatusHistory

Este método obtiene el historial del estado de la cuenta.

Ctx.ERC1155AccountStatus.history(statusId: string)

Parámetros:

statusId: string: ID del objeto de estado de cuenta.

Devuelve:

Una vez realizada correctamente, una representación JSON del historial de estado de la cuenta.

Ejemplo 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 activa una cuenta de token. Para cualquier cuenta creada antes de que la funcionalidad de estado de cuenta esté disponible, debe llamar a este método para definir el estado de cuenta como active.

Ctx.ERC1155Account.activateAccount(tokenAccountId: string)

Parámetros:

tokenAccountId: string: ID de la cuenta de token.

Devuelve:

Una vez realizada correctamente, una representación JSON del objeto de estado de cuenta para la cuenta de token especificada.

Ejemplo de valor de retorno:

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

suspendAccount

Este método suspende una cuenta de token.

Ctx.ERC1155Account.suspendAccount(tokenAccountId: string)

Parámetros:

tokenAccountId: string: ID de la cuenta de token.

Devuelve:

Una vez realizada correctamente, una representación JSON del objeto de estado de cuenta para la cuenta de token especificada.

Ejemplo de valor de retorno:

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

deleteAccount

Este método suprime una cuenta de token.

Ctx.ERC1155Account.deleteAccount(tokenAccountId: string)

Parámetros:

tokenAccountId: string: ID de la cuenta de token.

Devuelve:

Una vez realizada correctamente, una representación JSON del objeto de estado de cuenta para la cuenta de token especificada.

Ejemplo de valor de retorno:

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