Modelo de transacciones confidenciales

La versión mejorada de Blockchain App Builder incluye un atributo de modelo que genera métodos adicionales para el modo confidencial.

Si incluye el parámetro confidential: true en el archivo de especificación para tokens que utilizan el estándar extendido Token Taxonomy Framework, Blockchain App Builder genera un código de cadena para su uso en modo confidencial, incluidas las siguientes versiones modificadas del estándar generado automáticamente y los métodos SDK (solo TypeScript).

Para obtener más información sobre las transacciones confidenciales y el escenario confidencial de la moneda digital del banco central mayorista (CBDC), consulte Moneda digital del banco central mayorista con transacciones confidenciales.

En la siguiente tabla se resumen los métodos que se generan al andamiar un proyecto de Marco de taxonomía de token en modo confidencial.

Categoría de método Método generado automáticamente Método SDK Descripción
Gestión del Control de Acceso isTokenAdmin isUserTokenAdmin Devuelve true si el emisor de llamada es un administrador
addTokenAdmin addTokenAdmin Agrega un administrador
removeTokenAdmin removeTokenAdmin Elimina un administrador
getAllTokenAdmins Devuelve todos los administradores
addOrgAdmin addOrgAdmin Agrega una administración de organización
removeOrgAdmin removeOrgAdmin Elimina un administrador de organización
getAllOrgAdmins Devuelve todos los administradores de organización
addTokenAuditor addTokenAuditor Agrega un auditor
removeTokenAuditor removeTokenAuditor Elimina un auditor
getAllTokenAuditors Devuelve todos los auditores
addOrgAuditor addOrgAuditor Agrega un auditor de organización
removeOrgAuditor removeOrgAuditor Elimina un auditor de organización
getAllOrgAuditors Devuelve todos los auditores de organización
Gestión de tokens getAllTokens Devuelve todos los activos de token
getDecimals Devuelve el número de posiciones decimales para un token especificado.
history Devuelve el historial de un token
getTokensByName Devuelve todos los activos de token para un nombre de token especificado
Gestión de cuentas createAccount createAccount Crea una cuenta de usuario
associateTokenToAccount associateToken Asocia una cuenta con un token
getAllAccounts getAllAccounts Devuelve detalles de todas las cuentas de usuario
getAllOrgAccounts getAllOrgAccounts Devuelve detalles de todas las cuentas de usuario de una organización
getAccountsByUser getAccountsByUser Devuelve todos los ID de cuenta de un usuario
getUserByAccountId getUserByAccountId Devuelve los detalles de usuario para un ID de cuenta
getAccount getAccountWithStatus Devuelve detalles de una cuenta de token
getAccountDetailsByCustomAccountId getAccountDetailsByCustomAccountId Devuelve los detalles de la cuenta para un ID de cuenta personalizado
getAccountBalance getAccountBalance Devuelve el saldo actual de una cuenta
getAccountStatus getAccountStatus Devuelve el estado de una cuenta.
getAccountStatusHistory history Devuelve el historial de una cuenta de token
activateAccount activateAccount Activa una cuenta de token
suspendAccount suspendAccount Suspende una cuenta de token
deleteAccount deleteAccount Suprime una cuenta de token
setMaxDailyAmount setMaxDailyAmount Define la cantidad máxima de tokens que un usuario puede transferir diariamente
setMaxDailyTransactionCount setMaxDailyTransactionCount Define el número máximo de transacciones que un usuario puede completar diariamente
getMaxDailyAmount getMaxDailyAmount Devuelve la cantidad máxima de tokens que un usuario puede transferir diariamente
getMaxDailyTransactionCount getMaxDailyTransactionCount Devuelve el número máximo de transacciones que un usuario puede completar diariamente
getAccountOnHoldBalance getAccountOnHoldBalance Devuelve el saldo actual retenido de una cuenta
Gestión de Roles addRole addRoleMember Agrega un rol a un usuario
removeRole removeRoleMember Elimina un rol de un usuario
getAccountsByRole getAccountsByRole Devuelve ID de cuenta para un rol especificado
getOrgAccountsByRole getOrgAccountsByRole Devuelve ID de cuenta para un rol especificado en una organización
getUsersByRole getUsersByRole Devuelve una lista de usuarios para un rol especificado
getOrgUsersByRole getOrgUsersByRole Devuelve una lista de usuarios para un rol especificado en una organización
isInRole isInRole Devuelve si un usuario tiene un rol especificado
Gestión de Transacciones getAccountTransactionHistory getAccountTransactionHistory Devuelve el historial de transacciones de una cuenta
getAccountTransactionHistoryWithFilters getAccountTransactionHistoryWithFilters Devuelve el historial de transacciones filtradas de una cuenta
getAccountTransactionHistoryWithFiltersFromRichHistDB getAccountTrxHistoryWithFiltersFromRichHistDB Devuelve el historial de transacciones filtrado de la base de datos de historial enriquecido para una cuenta
getOrgAccountsTransactionHistoryWithFiltersFromRichHistDB getOrgAccountsTrxHistoryWithFiltersFromRichHistDB Devuelve el historial de transacciones filtrado de la base de datos de historial enriquecido para una organización
getAllAccountsTransactionHistoryWithFiltersFromRichHistDB getAllAccountsTrxHistoryWithFiltersFromRichHistDB Devuelve el historial de transacciones filtrado de la base de datos de historial enriquecido para todas las cuentas
consolidateRunningBalanceInTransactions consolidateRunningBalanceInTransactions Actualiza los saldos de cuenta en ejecución para las transacciones pendientes
processSendersAndReceivers processSendersAndReceivers Actualiza los saldos de cuenta durante las transferencias entre organizaciones
deleteHistoricalTransactions deleteTransactions Suprime las transacciones más antiguas
getTransactionById getTransactionById Devuelve el historial de un activo de transacción
Comportamiento mínimo requestMint Solicitudes que se emiten tokens
approveMint Aprueba una solicitud de menta
rejectMint Rechaza una solicitud de menta
issueTokens issueTokens Tokens de menta
getTotalMintedTokens getTotalMintedTokens Devuelve el número total de tokens acuñados
getNetTokens getNetTokens Devuelve la cantidad neta de tokens disponibles
Comportamiento transferible transferTokens transferTokens Transferencias de tokens
Comportamiento retenible holdTokens hold Pone un saldo de token en espera
executeHoldTokens executeHold Completa una retención de token
releaseHoldTokens releaseHold Libera una retención de token
getOnHoldIds getOnHoldIds Devuelve todos los ID de retención de una cuenta
getOnHoldDetailsWithOperationId getOnHoldDetailsWithOperationId Devuelve los detalles de la transacción retenida para un ID de operación
getOnHoldBalanceWithOperationId getOnHoldBalanceWithOperationId Devuelve el saldo retenido de un ID de operación
Comportamiento reproducible requestBurn Solicitudes que destruyen tokens
approveBurn Aprueba una solicitud de grabación
rejectBurn Rechaza una solicitud de grabación
Traslados entre organizaciones executeHoldTokensSender executeHoldTokensSender Deduce tokens de la cuenta de un remitente
executeHoldTokensReceiver executeHoldTokensReceiver Acreditación de tokens en la cuenta de un receptor

Métodos TypeScript modificados para código de cadena confidencial

Si incluye el parámetro confidential: true en el archivo de especificación para los tokens que utilizan el estándar extendido Token Taxonomy Framework, Blockchain App Builder genera versiones modificadas de los métodos estándar generados automáticamente, así como métodos adicionales.

isTokenAdmin
Este método devuelve el valor booleano true si el emisor de llamada de la función es Token Admin; de lo contrario, devuelve false. Un Token Admin, Token Auditor, cualquier Org Admin o cualquier Org Auditor puede llamar a esta función en cualquier otro usuario de la red blockchain. Otros usuarios pueden llamar a este método solo en sus propias cuentas. 
@GetMethod()
 @Validator(yup.string(), yup.string())
 public async isTokenAdmin(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.isUserTokenAdmin", "TOKEN", { org_id });
    return await this.Ctx.Auth.isUserTokenAdmin(org_id, user_id);
 }
Parámetros:
  • org_id: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • user_id: string: nombre de usuario o ID de correo electrónico del usuario.
Devuelve:
  • El método devuelve true si el emisor de llamada es Token Admin; de lo contrario, devuelve false.
addTokenAdmin
Este método agrega un usuario como Token Admin del código de cadena. Este método solo puede ser llamado por un Token Admin del código de cadena. Puesto que el valor user_id se almacena en el libro mayor público, no utilice ninguna información de identificación personal (PII) para el valor user_id. 
@Validator(yup.string(), yup.string())
  public async addTokenAdmin(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.addTokenAdmin", "TOKEN");
    await this.Ctx.Model.createEvent(EVENT_NAME.ADD_TOKEN_ADMIN, { org_id, user_id });
    return await this.Ctx.Admin.addTokenAdmin(org_id, user_id);
  }
Parámetros:
  • org_id: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • user_id: string: nombre de usuario o ID de correo electrónico del usuario.
Devuelve:
  • Si se ha realizado correctamente, un mensaje que incluye detalles del usuario que se ha agregado como Token Admin del código de cadena.
Ejemplo de valor devuelto:
{
  "msg": "Successfully added Token Admin (Org_Id: CentralBank, User_Id: cb1)"
}
removeTokenAdmin
Este método elimina un usuario como Token Admin del código de cadena. Este método solo puede ser llamado por un Token Admin del código de cadena. 
@Validator(yup.string(), yup.string())
  public async removeTokenAdmin(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.removeTokenAdmin", "TOKEN");
    await this.Ctx.Model.createEvent(EVENT_NAME.REMOVE_TOKEN_ADMIN, { org_id, user_id });
    return await this.Ctx.Admin.removeTokenAdmin(org_id, user_id);
  }
Parámetros:
  • org_id: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • user_id: string: nombre de usuario o ID de correo electrónico del usuario.
Devuelve:
  • En caso de éxito, un mensaje que incluye detalles del usuario que se ha eliminado como Token Admin del código de cadena.
Ejemplo de valor devuelto:
{"msg": "Successfully removed Admin (Org_Id: Org1MSP, User_Id: User1)"}
addOrgAdmin
Este método agrega un usuario como Org Admin de la organización. Este método solo puede ser llamado por un Token Admin del código de cadena o un Org Admin de la organización especificada. Puesto que el valor user_id se almacena en el libro mayor público, no utilice ninguna información de identificación personal (PII) para el valor user_id. 
@Validator(yup.string(), yup.string())
  public async addOrgAdmin(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.addOrgAdmin", "TOKEN", { org_id });
    await this.Ctx.Model.createEvent(EVENT_NAME.ADD_ORG_ADMIN, { org_id, user_id });
    return await this.Ctx.Admin.addOrgAdmin(org_id, user_id);
  }
Parámetros:
  • org_id: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • user_id: string: nombre de usuario o ID de correo electrónico del usuario.
Devuelve:
  • En caso de éxito, un mensaje que incluye detalles del usuario que se agregó como Org Admin de la organización.
Ejemplo de valor devuelto:
{
    "msg": "Successfully added Org Admin (Org_Id: Org1MSP, User_Id: orgAdmin)"
}
removeOrgAdmin
Este método elimina un usuario como Org Admin de la organización. Este método solo puede ser llamado por un Token Admin del código de cadena o por un Org Admin de la organización especificada. 
@Validator(yup.string(), yup.string())
  public async removeOrgAdmin(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.removeOrgAdmin", "TOKEN", { org_id });
    await this.Ctx.Model.createEvent(EVENT_NAME.REMOVE_ORG_ADMIN, { org_id, user_id });
    return await this.Ctx.Admin.removeOrgAdmin(org_id, user_id);
  }
Parámetros:
  • org_id: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • user_id: string: nombre de usuario o ID de correo electrónico del usuario.
Devuelve:
  • Si se ha realizado correctamente, un mensaje que incluye detalles del usuario que se ha eliminado como Org Admin de la organización.
Ejemplo de valor devuelto:
{
  "msg": "Successfully removed Org Admin (Org_Id Org1MSP User_Id orgAdmin)"
}
addTokenAuditor
Este método agrega un usuario como Token Auditor del código de cadena. Este método solo puede ser llamado por un Token Admin del código de cadena. Puesto que el valor user_id se almacena en el libro mayor público, no utilice ninguna información de identificación personal (PII) para el valor user_id. 
@Validator(yup.string(), yup.string())
  public async addTokenAuditor(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.addTokenAuditor", "TOKEN");
    await this.Ctx.Model.createEvent(EVENT_NAME.ADD_TOKEN_AUDITOR, { org_id, user_id });
    return await this.Ctx.Admin.addTokenAuditor(org_id, user_id);
  }
Parámetros:
  • org_id: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • user_id: string: nombre de usuario o ID de correo electrónico del usuario.
Ejemplo de valor devuelto:
{
  "msg": "Successfully added Token Auditor (Org_Id: CentralBank, User_Id: cb_admin_demo)"
}
removeTokenAuditor
Este método elimina un usuario como Token Auditor del código de cadena. Este método solo puede ser llamado por un Token Admin del código de cadena. 
@Validator(yup.string(), yup.string())
  public async removeTokenAuditor(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.removeTokenAuditor", "TOKEN");
    await this.Ctx.Model.createEvent(EVENT_NAME.REMOVE_TOKEN_AUDITOR, { org_id, user_id });
    return await this.Ctx.Admin.removeTokenAuditor(org_id, user_id);
  }
Parámetros:
  • org_id: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • user_id: string: nombre de usuario o ID de correo electrónico del usuario.
Ejemplo de valor devuelto:
{
           "msg": "Successfully removed Token Auditor (Org_Id: CB, User_Id: cb)"
       }
addOrgAuditor
Este método agrega un usuario como Org Auditor del código de cadena. Este método solo puede ser llamado por un Token Admin o Org Admin del código de cadena. Puesto que el valor user_id se almacena en el libro mayor público, no utilice ninguna información de identificación personal (PII) para el valor user_id. 
@Validator(yup.string(), yup.string())
  public async addOrgAuditor(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.addOrgAuditor", "TOKEN", { org_id });
    await this.Ctx.Model.createEvent(EVENT_NAME.ADD_ORG_AUDITOR, { org_id, user_id });
    return await this.Ctx.Admin.addOrgAuditor(org_id, user_id);
  }
Parámetros:
  • org_id: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • user_id: string: nombre de usuario o ID de correo electrónico del usuario.
Devuelve:
  • Si se ha realizado correctamente, un mensaje que incluye detalles del usuario que se ha agregado como Org Auditor del código de cadena.
Ejemplo de valor devuelto:
{
           "msg": "Successfully added Org Auditor (Org_Id: CentralBank, User_Id: cb_admin_demo)"
       }
removeOrgAuditor
Este método elimina un usuario como Org Auditor del código de cadena. Este método solo puede ser llamado por un Token Admin o Org Admin del código de cadena. 
@Validator(yup.string(), yup.string())
  public async removeOrgAuditor(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.removeOrgAuditor", "TOKEN", { org_id });
    await this.Ctx.Model.createEvent(EVENT_NAME.REMOVE_ORG_AUDITOR, { org_id, user_id });
    return await this.Ctx.Admin.removeOrgAuditor(org_id, user_id);
  }
Parámetros:
  • org_id: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • user_id: string: nombre de usuario o ID de correo electrónico del usuario.
Ejemplo de valor devuelto:
{
           "msg": "Successfully removed Org Auditor (Org_Id: CB, User_Id: cb)"
       }
createAccount
Este método crea una cuenta para un usuario y token especificados. Se debe crear una cuenta para cualquier usuario que tenga tokens en cualquier momento. Las cuentas realizan un seguimiento de los saldos, los saldos retenidos y el historial de transacciones. Un ID de cuenta se forma concatenando el tipo de activo y el ID de token y, a continuación, creando un hash SHA-256 en una concatenación del ID de organización y el ID de usuario. Este método solo lo puede llamar un Token Admin o un Org Admin de la organización especificada. 
@Validator(yup.string(),yup.string(), yup.string(), yup.object().nullable())
  public async createAccount(org_id: string, user_id: string, token_type: string, dailyLimits?: DailyLimits) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.createAccount", "TOKEN", { org_id });
    await this.Ctx.Model.createEvent(EVENT_NAME.CREATE_ACCOUNT, { org_id, user_id, token_type, dailyLimits });
    return await this.Ctx.Account.createAccount(org_id, user_id, token_type, dailyLimits);
  }
Parámetros:
  • org_id: ID del proveedor de servicios de afiliación (MSP) del usuario para el que se creará la cuenta. El ID debe empezar por un carácter alfanumérico y puede incluir letras, números y caracteres especiales, como guiones bajos (_), puntos (.), signos at (@) y guiones (-).
  • user_id: nombre de usuario o ID de correo electrónico del usuario. El ID debe empezar por un carácter alfanumérico y puede incluir letras, números y caracteres especiales, como guiones bajos (_), puntos (.), signos at (@) y guiones (-).
  • token_type: string: tipo de token, que debe ser fungible.
  • daily_limits: DailyLimits: objeto JSON del siguiente tipo.
    {
     "max_daily_amount": 100000
     "max_daily_transactions": 10000
 }
    En el ejemplo, el valor max_daily_amount es la cantidad máxima de tokens que se pueden realizar diariamente y el valor max_daily_transactions es el número máximo de transacciones que se pueden completar diariamente.
Ejemplo de valor devuelto:
{
    "bapAccountVersion": 0,
    "assetType": "oaccount",
    "account_id": "oaccount~b53cb2c19c92d1d5c8cb9f6e988e7761c34e03e014e6c4b889565fc0abf46c8a",
    "org_id": "CentralBank",
    "token_type": "fungible",
    "token_id": "",
    "token_name": "",
    "balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6",
    "onhold_balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6",
    "onhold_burn_balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6",
}
associateTokenToAccount
Este método asocia un token fungible a una cuenta. Este método solo puede ser llamado por un Token Admin del código de cadena o por un Org Admin de la organización relevante. 
@Validator(yup.string(), yup.string(), yup.string().optional())
  public async associateTokenToAccount(account_id: string, token_id: string, custom_account_id?: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.associateToken", "TOKEN", { account_id });
    const token_asset = await this.getTokenObject(token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.ASSOCIATE_TOKEN_TO_ACCOUNT, { account_id, token_asset }, token_asset);
    return await this.Ctx.Account.associateToken(account_id, token_id, custom_account_id);
  }
Parámetros:
  • account_id: string: ID de la cuenta.
  • token_id: string: ID del token.
  • custom_account_id: string: para el modo confidencial, el ID de cuenta bancaria de la cuenta, un identificador alfanumérico aleatorio único. De forma predeterminada, tiene 14 caracteres.
Devuelve:
  • En caso de éxito, un objeto JSON de la cuenta actualizada. El parámetro bapAccountVersion se define en el objeto de cuenta para uso interno.
Ejemplo de valor devuelto:
{
    "bapAccountVersion": 0,
    "assetType": "oaccount",
    "account_id": "oaccount~b53cb2c19c92d1d5c8cb9f6e988e7761c34e03e014e6c4b889565fc0abf46c8a",
    "org_id": "CentralBank",
    "token_type": "fungible",
    "token_id": "USD",
    "token_name": "cbdc",
    "balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6",
    "onhold_balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6",
    "onhold_burn_balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6",
    "application_groups": [
        "CENTRAL_BANK_USERS"
    ]
}
getAllAccounts
Este método devuelve una lista de todas las cuentas. Este método solo se puede llamar mediante Token Admin o Token Auditor. Este método utiliza consultas enriquecidas de Berkeley DB SQL y solo se puede llamar cuando se conecta a la red remota de Oracle Blockchain Platform. 
@GetMethod()
  @Validator()
  public async getAllAccounts() {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAllAccounts", "TOKEN");
    return await this.Ctx.Account.getAllAccounts();
  }
Parámetros:
  • ninguno
Ejemplo de valor devuelto:
[
    {
        "key": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
        "valueJson": {
            "bapAccountVersion": 3,
            "assetType": "oaccount",
            "account_id": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
            "org_id": "CentralBank",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "cbdc",
            "balance": "028a27c752e9b518d156e61da6589e723b179b6d7351dc34ec92bbb27b783ed1dc",
            "onhold_balance": "02d53a7eda9484bda7252212714f647b70d32663cfa416f93f488ef6b6bc8fb2eb",
            "onhold_burn_balance": "02d53a7eda9484bda7252212714f647b70d32663cfa416f93f488ef6b6bc8fb2eb",
            "application_groups": [
                "application_groups value"
            ]
        }
    },
    {
        "key": "oaccount~1da238c1491c919b151f777a615fb5779032c34b3ef3adeca6afe591bac10aaf",
        "valueJson": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~1da238c1491c919b151f777a615fb5779032c34b3ef3adeca6afe591bac10aaf",
            "org_id": "CentralBank",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "cbdc",
            "balance": "020da01cd57249c6470b6dd03c2ee4c49de58c71ccc64f2de1203e835967a0846d",
            "onhold_balance": "020da01cd57249c6470b6dd03c2ee4c49de58c71ccc64f2de1203e835967a0846d",
            "onhold_burn_balance": "020da01cd57249c6470b6dd03c2ee4c49de58c71ccc64f2de1203e835967a0846d",
            "application_groups": [
                "application_groups value"
            ]
        }
    }
]
getAllOrgAccounts
Este método devuelve una lista de todas las cuentas de token que pertenecen a una organización especificada. Este método solo puede ser llamado por Token Admin o Token Auditor, o por un Org Admin o Org Auditor de la organización especificada. 
@GetMethod()
  @Validator(yup.string())
  public async getAllOrgAccounts(org_id: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAllOrgAccounts", "TOKEN", { org_id });
    return await this.Ctx.Account.getAllOrgAccounts(org_id);
  }
Parámetros:
  • org_id: string: ID del proveedor de servicios de membresía (MSP) de la organización.
Devuelve:
  • Si se realiza correctamente, se muestra una lista de todas las cuentas de la organización especificada.
Ejemplo de valor devuelto:
[
    {
        "key": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
        "valueJson": {
            "bapAccountVersion": 2,
            "assetType": "oaccount",
            "account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
            "org_id": "CentralBank",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "cbdc",
            "balance": "18",
            "onhold_balance": "0",
            "onhold_burn_balance": "0",
            "application_groups": [
                "application_groups value"
            ],
            "user_id": "cb",
            "custom_account_id": "1234567jh"
        }
    },
    {
        "key": "oaccount~5e3b5a3306d7ca3f3e3fe7cc27b6ae547e94dba1c5af58a69a771d7a619b6a66",
        "valueJson": {
            "bapAccountVersion": 1,
            "assetType": "oaccount",
            "account_id": "oaccount~5e3b5a3306d7ca3f3e3fe7cc27b6ae547e94dba1c5af58a69a771d7a619b6a66",
            "org_id": "CentralBank",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "cbdc",
            "balance": "22",
            "onhold_balance": "0",
            "onhold_burn_balance": "0",
            "application_groups": [
                "application_groups value"
            ],
            "user_id": "cb1",
            "custom_account_id": "1234567jh"
        }
    }
]
getAccountsByUser
Este método devuelve una lista de todos los IDs de cuenta para un ID de organización y un ID de usuario especificados. Este método solo puede ser llamado por Token Admin o Token Auditor, por Org Admin o Org Auditor de la organización especificada, o por Account Owner especificado en los parámetros. 
@GetMethod()
  @Validator(yup.string(), yup.string())
  public async getAccountsByUser(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountsByUser", "TOKEN", { org_id, user_id });
    return await this.Ctx.Account.getAccountsByUser(org_id, user_id);
  }
Parámetros:
  • org_id string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • user_id string: nombre de usuario o ID de correo electrónico del usuario.
Devuelve:
  • En caso de éxito, una matriz JSON de ID de cuenta.
Ejemplo de valor devuelto:
[
    {
        "bapAccountVersion": 2,
        "assetType": "oaccount",
        "user_id": "cb",
        "custom_account_id": "1234567jh",
        "account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
        "org_id": "CentralBank",
        "token_type": "fungible",
        "token_id": "token",
        "token_name": "cbdc",
        "balance": "18",
        "onhold_balance": "0",
        "onhold_burn_balance": "0",
        "application_groups": [
            "application_groups value"
        ]
    }
]
getUserByAccountId
Este método devuelve los detalles del usuario (org_id y user_id) para una cuenta especificada. Este método puede ser llamado por Token Admin o Token Auditor, o por un Org Admin o Org Auditor de la organización especificada. 
@GetMethod()
  @Validator(yup.string())
  public async getUserByAccountId(account_id: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getUserByAccountId", "TOKEN", { account_id });
    return await this.Ctx.Account.getUserByAccountId(account_id);
  }
Parámetros:
  • account_id: string: ID de la cuenta.
Devuelve:
  • Cuando se realiza correctamente, un objeto JSON de los detalles del usuario (org_id, token_id y user_id).
Ejemplo de valor devuelto:
{
    "token_id": "USD",
    "org_id": "CentralBank",
    "user_id": "cb_admin_demo",
    "custom_account_id": "10101234000123"
}
getAccount
Este método devuelve los detalles de una cuenta especificada. Este método solo se puede llamar mediante Token Admin o Token Auditor, un Org Admin o Org Auditor de la organización especificada o el AccountOwner de la cuenta. 
@GetMethod()
  @Validator(yup.string())
  public async getAccount(account_id: string) {
    await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccount", "TOKEN", { account_id });
    return await this.Ctx.Account.getAccountWithStatus(account_id);
  }
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Ejemplo de valor devuelto:
{
    "bapAccountVersion": 2,
    "assetType": "oaccount",
    "user_id": "cb",
    "custom_account_id": "1234567jh",
    "status": "active",
    "account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
    "org_id": "CentralBank",
    "token_type": "fungible",
    "token_id": "token",
    "token_name": "cbdc",
    "balance": "18",
    "onhold_balance": "0",
    "onhold_burn_balance": "0",
    "application_groups": [
        "application_groups value"
    ]
}
getAccountDetailsByCustomAccountId
Este método devuelve los detalles de un ID de cuenta personalizado especificado. Este método solo puede ser llamado por Token Admin o Token Auditor, o por Org Admin o Org Auditor de la organización especificada. 
@GetMethod()
  @Validator(yup.string(), yup.string())
  public async getAccountDetailsByCustomAccountId(custom_account_id: string, org_id: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountDetailsByCustomAccountId", "TOKEN", { org_id });
    return await this.Ctx.Account.getAccountDetailsByCustomAccountId(custom_account_id, org_id);
  }
Parámetros:
  • custom_account_id: string: ID de cuenta bancaria de la cuenta, un identificador alfanumérico aleatorio único.
  • org_id: string: ID del proveedor de servicios de membresía (MSP) de la organización.
Ejemplo de valor devuelto:
[
    {
        "bapAccountVersion": 0,
        "assetType": "oaccount",
        "account_id": "oaccount~c44ffac4c46718e9744cb0aae2016d26a87a5bef5e2d1c0d1abc7d8782f0ba61",
        "org_id": "CentralBank",
        "token_type": "fungible",
        "token_id": "USD",
        "token_name": "cbdc",
        "balance": "0",
        "onhold_balance": "0",
        "onhold_burn_balance": "0",
        "application_groups": [
            "SYSTEM_ADMINS"
        ],
        "user_id": "cb_admin_demo",
        "custom_account_id": "10101234000123"
    }
]
getAccountBalance
Este método devuelve el saldo actual de una cuenta especificada. Este método solo se puede llamar mediante Token Admin o Token Auditor, un Org Admin o Org Auditor de la organización especificada o el AccountOwner de la cuenta. 
@GetMethod()
  @Validator(yup.string())
  public async getAccountBalance(account_id: string) {
    await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountBalance", "TOKEN", { account_id });
    return await this.Ctx.Account.getAccountBalance(account_id);
  }
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Devuelve:
  • En caso de éxito, una representación JSON del saldo de cuenta corriente.
Ejemplo de valor devuelto:
{
    "msg": "Current Balance is: 100",
    "user_balance": 100
}
getAccountStatus
Este método obtiene el estado actual de la cuenta de token. Este método puede ser llamado por el Token Admin del código de cadena, un Org Admin de la organización especificada o por el propietario de la cuenta de token. 
@GetMethod()
  @Validator(yup.string())
  public async getAccountStatus(account_id: string) {
    await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT_STATUS.get", "TOKEN", { account_id });
    try {
      return await this.Ctx.AccountStatus.getAccountStatus(account_id);
    } catch (err) {
      return await this.Ctx.AccountStatus.getDefaultAccountStatus(account_id);
    }
  }
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Devuelve:
  • En caso de éxito, un mensaje que incluye detalles del estado de la cuenta de token.
Ejemplo de valor devuelto:
{
    "assetType": "oaccountStatus",
    "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
    "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
    "status": "active"
}
getAccountStatusHistory
Este método obtiene el historial del estado de la cuenta. Este método puede ser llamado por el Token Admin del código de cadena, un Org Admin de la organización especificada o por el propietario de la cuenta de token. 
@GetMethod()
  @Validator(yup.string())
  public async getAccountStatusHistory(account_id: string) {
    await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT_STATUS.history", "TOKEN", { account_id });
    const status_id = await this.Ctx.AccountStatus.generateAccountStatusId(account_id);
    let account_status_history: any;
    try {
      account_status_history = await this.Ctx.AccountStatus.history(status_id);
    } catch (err) {
      return [];
    }
    return account_status_history;
  }
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Devuelve:
  • En caso de éxito, un mensaje que incluye detalles del historial de estado de la cuenta.
Ejemplo de valor devuelto:
[
  {
    "trxId": "d5c6d6f601257ba9b6edaf5b7660f00adc13c37d5321b8f7d3a35afab2e93e63",
    "timeStamp": "2025-12-02T10:39:14.000Z",
    "value": {
      "assetType": "oaccountStatus",
      "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
      "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
      "status": "suspended"
    }
  },
  {
    "trxId": "e6c850cfa084dc20ad95fb2bb8165eef3a3bd62a0ac867cccee57c2003125183",
    "timeStamp": "2025-12-02T10:37:50.000Z",
    "value": {
      "assetType": "oaccountStatus",
      "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
      "account_id": "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 o un Org Admin de la organización especificada. Las cuentas eliminadas no se pueden activar. 
@Validator(yup.string())
  public async activateAccount(account_id: string) {
    const account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT_STATUS.activateAccount", "TOKEN", { org_id: account.org_id });
    const token_asset = await this.getTokenObject(account.token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.ACTIVATE_ACCOUNT, { account_id }, token_asset);
    return await this.Ctx.Account.activateAccount(account_id);
  }
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Devuelve:
  • Una vez realizado correctamente, una representación JSON del objeto de estado de cuenta para la cuenta de token especificada.
Ejemplo de valor devuelto:
{
  "assetType": "oaccountStatus",
  "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
  "account_id": "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 o un Org Admin de la organización especificada. Después de suspender una cuenta, no puede completar ninguna operación que actualice la cuenta. No se puede suspender una cuenta eliminada. 
@Validator(yup.string())
  public async suspendAccount(account_id: string) {
    const account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT_STATUS.suspendAccount", "TOKEN", { org_id: account.org_id });
    const token_asset = await this.getTokenObject(account.token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.SUSPEND_ACCOUNT, { account }, token_asset);
    return await this.Ctx.Account.suspendAccount(account_id);
  }
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Devuelve:
  • Una vez realizado correctamente, una representación JSON del objeto de estado de cuenta para la cuenta de token especificada.
Ejemplo de valor devuelto:
{
    "assetType": "oaccountStatus",
    "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
    "account_id": "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 o un Org Admin de la organización especificada. 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 eliminar una cuenta, el saldo de cuenta y el saldo retenido deben ser cero. 
@Validator(yup.string())
  public async deleteAccount(account_id: string) {
    const account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT_STATUS.deleteAccount", "TOKEN", { org_id: account.org_id });
    const token_asset = await this.getTokenObject(account.token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.DELETE_ACCOUNT, { account_id }, token_asset);
    return await this.Ctx.Account.deleteAccount(account_id);
  }
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Devuelve:
  • Una vez realizado correctamente, una representación JSON del objeto de estado de cuenta para la cuenta de token especificada.
Ejemplo de valor devuelto:
{
  "assetType": "oaccountStatus",
  "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
  "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
  "status": "deleted"
}
setMaxDailyAmount
Este método define el valor max_daily_amount para una cuenta especificada. Este método solo puede ser llamado por un Token Admin del código de cadena o un Org Admin de la organización especificada. 
@Validator(yup.string(), yup.string().optional())
  public async setMaxDailyAmount (account_id: string, max_daily_amount?: string) {
    const account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization('ACCOUNT.setMaxDailyAmount', 'TOKEN', { org_id: account.org_id });
    const token_asset = await this.getTokenObject(account.token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.SET_MAX_DAILY_AMOUNT, { account_id, max_daily_amount }, token_asset);
    return this.Ctx.Account.setMaxDailyAmount (account_id, max_daily_amount);
  }
Parámetros:
  • account_id: string: ID único de la cuenta de token.
  • max_daily_amount?: string: (opcional) cantidad máxima de tokens que el usuario puede transferir diariamente. Si no se especifica, el usuario puede transferir cualquier cantidad de tokens diariamente.
Ejemplo de valor devuelto:
{
           "msg": "Successfully set max daily amount for account id oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a to 1000000"
       }
setMaxDailyTransactionCount
Este método define el valor max_daily_transactions para una cuenta especificada. Este método solo puede ser llamado por un Token Admin del código de cadena o un Org Admin de la organización especificada. 
@Validator(yup.string(), yup.string().optional())
  public async setMaxDailyTransactionCount (account_id: string, max_daily_transactions?: string) {
    const account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization('ACCOUNT.setMaxDailyTransactionCount', 'TOKEN', { org_id: account.org_id });
    const token_asset = await this.getTokenObject(account.token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.SET_MAX_DAILY_TRANSACTION_COUNT, { account_id, max_daily_transactions}, token_asset);
    return this.Ctx.Account.setMaxDailyTransactionCount (account_id, max_daily_transactions);
  }
Parámetros:
  • account_id: string: ID único de la cuenta de token.
  • max_daily_transactions?: string: (opcional) número máximo de transacciones que el usuario puede completar diariamente. Si no se especifica, el usuario puede completar cualquier número de transacciones diarias.
Ejemplo de valor devuelto:
{
            "msg": "Successfully set max daily transactions for account id oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a to 100000"
        }
getMaxDailyAmount
Este método obtiene el valor max_daily_amount para una cuenta especificada. Este método solo puede ser llamado por un Token Admin o Token Auditor del código de cadena o un Org Admin o Org Auditor de la organización especificada. 
@GetMethod()
  @Validator(yup.string())
  public async getMaxDailyAmount (account_id: string) {
    await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization('ACCOUNT.getMaxDailyAmount', 'TOKEN', { account_id });
    return this.Ctx.Account.getMaxDailyAmount (account_id);
  }
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Ejemplo de valor devuelto:
{
           "max_daily_amount": "10000"
       }
getMaxDailyTransactionCount
Este método obtiene el valor max_daily_transactions para una cuenta especificada. Este método solo puede ser llamado por un Token Admin o Token Auditor del código de cadena o un Org Admin o Org Auditor de la organización especificada. 
@GetMethod()
  @Validator(yup.string())
  public async getMaxDailyTransactionCount (account_id: string) {
    await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization('ACCOUNT.getMaxDailyTransactionCount', 'TOKEN', { account_id });
    return this.Ctx.Account.getMaxDailyTransactionCount (account_id);
  }
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Ejemplo de valor devuelto:
{
           "max_daily_transactions": "100"
       }
getAccountOnHoldBalance
Este método devuelve el saldo actual retenido para una cuenta especificada. Este método solo se puede llamar mediante Token Admin o Token Auditor, un Org Admin o Org Auditor de la organización especificada o el AccountOwner de la cuenta. 
@GetMethod()
  @Validator(yup.string())
  public async getAccountOnHoldBalance(account_id: string) {
    await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountOnHoldBalance", "TOKEN", { account_id });
    return await this.Ctx.Account.getAccountOnHoldBalance(account_id);
  }
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Devuelve:
  • En caso de éxito, una representación JSON del saldo retenido actual.
Ejemplo de valor devuelto:
{
           "msg": "Total Holding Balance is: 0",
           "holding_balance": 0
       }
addRole
Este método agrega un rol a un usuario y token especificados. Este método solo puede ser llamado por un Token Admin del código de cadena o por un Org Admin de la organización especificada que también tenga el rol especificado. 
@Validator(yup.string(), yup.string())
  public async addRole(account_id: string, role: string) {
    const account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    const token_asset = await this.getTokenObject(account.token_id);
    await this.Ctx.Auth.checkAuthorization("TOKEN.addRoleMember", "TOKEN", { token_id: account.token_id, org_id: account.org_id, role });
    await this.Ctx.Model.createEvent(EVENT_NAME.ADD_ROLE, { role, account_id }, token_asset);
    return await this.Ctx.Token.addRoleMember(role, account_id, token_asset);
  }
Parámetros:
  • account_id: string: ID único de la cuenta de token.
  • role: string: nombre del rol que se va a agregar al usuario especificado. Los comportamientos mintable y burnable corresponden a las propiedades minter_role_name y burner_role_name del archivo de especificación. Del mismo modo, el rol notary corresponde a la propiedad notary_role_name del archivo de especificación.
Devuelve:
  • En caso de éxito, se mostrará un mensaje con los detalles de la cuenta.
Ejemplo de valor devuelto:
{
     "msg": "Successfully added role 'notary' to Account Id: oaccount~2eb5f8a9bc561f8f41a4ea3be9511958cc6684ef14f2337ca396efc301b627d8"
}
removeRole
Este método elimina un rol de un usuario y token especificados. Este método solo puede ser llamado por un Token Admin del código de cadena o por un Org Admin de la organización especificada que también tenga el rol especificado. 
@Validator(yup.string(), yup.string())
  public async removeRole(account_id: string, role: string) {
    const account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    const token_asset = await this.getTokenObject(account.token_id);
    await this.Ctx.Auth.checkAuthorization("TOKEN.removeRoleMember", "TOKEN", { token_id: account.token_id, org_id: account.org_id, role });
    await this.Ctx.Model.createEvent(EVENT_NAME.REMOVE_ROLE, { role, account_id }, token_asset);
    return await this.Ctx.Token.removeRoleMember(role, account_id, token_asset);
  }
Parámetros:
  • account_id: string: ID único de la cuenta de token.
  • role: string: nombre del rol que se va a eliminar del usuario especificado. Los comportamientos mintable y burnable corresponden a las propiedades minter_role_name y burner_role_name del archivo de especificación. Del mismo modo, el rol notary corresponde a la propiedad notary_role_name del archivo de especificación.
Devuelve:
  • En caso de éxito, se mostrará un mensaje con los detalles de la cuenta.
Ejemplo de valor devuelto:
{
   "msg": "Successfully removed role 'notary' from Account Id: oaccount~2eb5f8a9bc561f8f41a4ea3be9511958cc6684ef14f2337ca396efc301b627d8"
}
getAccountsByRole
Este método devuelve una lista de todos los ID de cuenta para un rol y token especificados. Este método solo se puede llamar mediante Token Admin o Token Auditor. 
@GetMethod()
  @Validator(yup.string(), yup.string())
  public async getAccountsByRole(token_id: string, role: string) {
    await this.Ctx.Auth.checkAuthorization("ROLE.getAccountsByRole", "TOKEN");
    return await this.Ctx.Role.getAccountsByRole(token_id, role);
  }
Parámetros:
  • token_id: string: ID del token.
  • role: string: nombre del rol que se va a buscar.
Devuelve:
  • En caso de éxito, una matriz JSON de ID de cuenta.
Ejemplo de valor devuelto:
{
           "accounts": [
               "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75"
           ]
       }
getOrgAccountsByRole
Este método devuelve una lista de todos los ID de cuenta para un rol, token y organización especificados. Este método solo puede ser llamado por Token Admin o Token Auditor, o por un Org Admin o Org Auditor de la organización especificada. 
@GetMethod()
  @Validator(yup.string(), yup.string(), yup.string())
  public async getOrgAccountsByRole(token_id: string, role: string, org_id: string) {
    await this.Ctx.Auth.checkAuthorization("ROLE.getOrgAccountsByRole", "TOKEN", { org_id });
    return await this.Ctx.Role.getOrgAccountsByRole(token_id, role, org_id);
  }
Parámetros:
  • token_id: string: ID del token.
  • role: string: nombre del rol que se va a buscar.
  • org_id: string: ID del proveedor de servicios de membresía (MSP) de la organización.
Devuelve:
  • En caso de éxito, una matriz JSON de ID de cuenta.
Ejemplo de valor devuelto:
{
           "accounts": [
               "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75"
           ]
       }
getUsersByRole
Este método devuelve una lista de todos los usuarios para un rol y token especificados. Este método solo se puede llamar mediante Token Admin o Token Auditor. 
@GetMethod()
  @Validator(yup.string(), yup.string())
  public async getUsersByRole(token_id: string, role: string) {
    await this.Ctx.Auth.checkAuthorization("ROLE.getUsersByRole", "TOKEN");
    return await this.Ctx.Role.getUsersByRole(token_id, role);
  }
Parámetros:
  • token_id: string: ID del token.
  • role: string: nombre del rol que se va a buscar.
Ejemplo de valor devuelto:
{
          "users": [
              {
                  "token_id": "token",
                  "org_id": "CentralBank"
              }
          ]
      }
getOrgUsersByRole
Este método devuelve una lista de todos los usuarios para un rol, token y organización especificados. Este método solo puede ser llamado por Token Admin o Token Auditor, o por un Org Admin o Org Auditor de la organización especificada. 
@GetMethod()
  @Validator(yup.string(), yup.string(), yup.string())
  public async getOrgUsersByRole(token_id: string, role: string, org_id: string) {
    await this.Ctx.Auth.checkAuthorization("ROLE.getOrgUsersByRole", "TOKEN", { org_id });
    return await this.Ctx.Role.getOrgUsersByRole(token_id, role, org_id);
  }
Parámetros:
  • token_id: string: ID del token.
  • role: string: nombre del rol que se va a buscar.
  • org_id: string: ID del proveedor de servicios de membresía (MSP) de la organización.
Ejemplo de valor devuelto:
{
           "users": [
               {
                   "token_id": "token",
                   "org_id": "CentralBank",
                   "user_id": "cb1",
                   "custom_account_id": "1234567jh"
               }
           ]
       }
isInRole
Este método devuelve un valor booleano para indicar si un usuario tiene un rol especificado. Este método solo se puede llamar mediante Token Admin o Token Auditor, AccountOwner de la cuenta o un Org Admin o Org Auditor de la organización especificada. 
@GetMethod()
  @Validator(yup.string(), yup.string())
  public async isInRole(account_id: string, role: string) {
    const account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    const token_asset = await this.getTokenObject(account.token_id);
    await this.Ctx.Auth.checkAuthorization("TOKEN.isInRole", "TOKEN", { account_id });
    return { result: await this.Ctx.Token.isInRole(role, account_id, token_asset) };
  }
Parámetros:
  • account_id: string: ID único de la cuenta de token.
  • role: string: nombre del rol que se va a buscar.
Devuelve:
  • En caso de éxito, una cadena JSON del resultado booleano.
Ejemplo de valor devuelto:
{
           "result": "true"
       }
getAccountTransactionHistory
Este método devuelve una matriz de detalles del historial de transacciones de la cuenta para una cuenta especificada. Este método solo puede ser llamado por Token Admin o Token Auditor, un Org Admin o Org Auditor de la organización especificada o el AccountOwner de la cuenta. 
@GetMethod()
  @Validator(yup.string())
  public async getAccountTransactionHistory(account_id: string) {
    const account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountTransactionHistory", "TOKEN", { account_id });
    return await this.Ctx.Account.getAccountTransactionHistory(account_id, account.org_id);
  }
Parámetros:
  • account_id: string: ID único de la cuenta.
Ejemplo de valor devuelto:
[
    {
        "transaction_id": "otransaction~4514aa229ebcc4d2fedcaa47c4301615e30c4a9bae45cf0256a5b80d75b3697a",
        "transacted_amount": 1000,
        "timestamp": "2025-08-25T13:20:50.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "APPROVE_MINT",
        "balance": 21000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~1982f73495060e0eef4d78282a91c41e27e8c95572739b0677a1e404a0d20aa9",
        "transacted_amount": 200,
        "timestamp": "2025-08-25T13:12:43.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "REQUEST_MINT",
        "balance": 20000,
        "onhold_balance": 0
    },
    .
    .
    .  
    .
    {
        "transaction_id": "otransaction~396e6ca5a11a9609632d0864026409d46a708fb95e3e21b39fa5f3fb78f90872",
        "transacted_amount": 0,
        "timestamp": "2025-08-12T20:43:20.000Z",
        "token_id": "",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "CREATE_ACCOUNT",
        "balance": 0,
        "onhold_balance": 0
    }
]
getAccountTransactionHistoryWithFilters
Este método devuelve una matriz filtrada de detalles del historial de transacciones de la cuenta para un usuario y token especificados. Este método solo puede ser llamado por Token Admin o Token Auditor, un Org Admin o Org Auditor de la organización especificada o el AccountOwner de la cuenta. Este método solo se puede llamar cuando está conectado a una red remota de Oracle Blockchain Platform. 
@GetMethod()
  @Validator(yup.string(), yup.object().nullable())
  public async getAccountTransactionHistoryWithFilters(account_id: string, filters?: Filters) {
    const account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountTransactionHistoryWithFilters", "TOKEN", { account_id });
    return await this.Ctx.Account.getAccountTransactionHistoryWithFilters(account_id, account.org_id, filters);
  }
Parámetros:
  • account_id: string: ID único de la cuenta.
  • filters: string: parámetro opcional. Si está vacío, se devuelven todos los registros. La propiedad PageSize determina el número de registros que se devolverán. Si PageSize es 0, el tamaño de página por defecto es 20. La propiedad Bookmark determina el índice inicial de los registros que se van a devolver. Para obtener más información, consulte la documentación de Hyperledger Fabric. Las propiedades StartTime y EndTime se deben especificar en formato RFC-3339, como se muestra en el siguiente ejemplo.
    {
     "pageSize": 20,
     "bookmark": "",
     "startTime": "1900-01-01T00:00:00+00:00",
     "endTime": "2100-01-01T00:00:00+00:00"
 }
Ejemplo de cuerpo de solicitud Postman:
curl --location 'https://centralbank-oabcs1-bom.blockchain.ocp.oraclecloud.com:7443/restproxy/api/v2/channels/default/chaincode-queries' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Y2I6MTIzNDVAQXBwQnVpbGRlcg==' \
--data '{
    "chaincode": "confDev",
    "args": [
        "getAccountTransactionHistoryWithFilters"
    ],
    "timeout": 12000,
    "sync": true,
    "peer": "centralbank-oabcs1-bom.blockchain.ocp.oraclecloud.com:20010",
    "transientMap": {
        "args": "[\"oaccount~3a1b1c307883c0f74473fedfa62894d510b68959c4a21c7abb9d0224151aa573\",\"{\\\"pageSize\\\":20,\\\"bookmark\\\":\\\"\\\",\\\"startTime\\\":\\\"1900-01-01T00:00:00+00:00\\\",\\\"endTime\\\":\\\"2100-01-01T00:00:00+00:00\\\"}\"]"
    }
}'
Ejemplo de valor devuelto:
[
            {
                "transaction_id": "otransaction~ccc2c2e89ab7887af4fdad3dc9918ea057a8aa834a0ed8d0f23271049f084952",
                "transacted_amount": 8,
                "timestamp": "2025-08-20T23:22:53.000Z",
                "token_id": "token",
                "category": "category value",
                "description": "description value",
                "holding_id": "ohold~cbdc~token~hold1",
                "to_account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
                "to_org_id": "Org1",
                "to_user_id": "cb",
                "to_custom_account_id": "1234567jh",
                "from_account_id": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
                "from_org_id": "CentralBank",
                "from_user_id": "Not Available",
                "from_custom_account_id": "Not Available",
                "transacted_account": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
                "transaction_type": "CREDIT",
                "balance": 18,
                "onhold_balance": 0,
                "transacted_org_id": "CentralBank",
                "transacted_user_id": "Not Available",
                "transacted_custom_account_id": "Not Available"
            },
            {
                "transaction_id": "otransaction~6c0452a58f13db93f1c308d60eab1fde6c911921b350c0bbbe0ce7dab394721d",
                "transacted_amount": 10,
                "timestamp": "2025-08-20T23:04:53.000Z",
                "token_id": "token",
                "category": "category value",
                "description": "description value",
                "holding_id": "ohold~cbdc~token~hold1",
                "to_account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
                "to_org_id": "Org1",
                "to_user_id": "cb",
                "to_custom_account_id": "1234567jh",
                "from_account_id": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
                "from_org_id": "CentralBank",
                "from_user_id": "Not Available",
                "from_custom_account_id": "Not Available",
                "transacted_account": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
                "transaction_type": "CREDIT",
                "balance": 10,
                "onhold_balance": 0,
                "transacted_org_id": "CentralBank",
                "transacted_user_id": "Not Available",
                "transacted_custom_account_id": "Not Available"
            },
            .
            .
            .
            .
            {
                "transaction_id": "otransaction~df98e24a3b90661b54b54289b600b13a1051c922db0a4d20e3705a9820ae9c20",
                "transacted_amount": 0,
                "timestamp": "2025-08-20T22:55:09.000Z",
                "category": "",
                "description": "",
                "from_account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
                "from_org_id": "Org1",
                "from_user_id": "cb",
                "from_custom_account_id": "1234567jh",
                "transacted_account": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
                "transaction_type": "CREATE_ACCOUNT",
                "balance": 0,
                "onhold_balance": 0,
                "transacted_org_id": "Org1",
                "transacted_user_id": "cb",
                "transacted_custom_account_id": "1234567jh"
            }
        ]
getAccountTransactionHistoryWithFiltersFromRichHistDB
Este método recupera el historial de transacciones de la base de datos de historial enriquecido. Este método solo puede ser llamado por Token Admin o Token Auditor, un Org Admin o Org Auditor de la organización especificada o el AccountOwner de la cuenta. 
@GetMethod()
  @Validator(yup.string(), yup.string(), yup.string(), yup.object().nullable())
  public async getAccountTransactionHistoryWithFiltersFromRichHistDB(account_id: string, custom_endpoint: string, bearer_token: string, filters?: Filters) {
    const account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountTransactionHistoryWithFiltersFromRichHistDB", "TOKEN", { account_id });
    return await this.Ctx.Account.getAccountTrxHistoryWithFiltersFromRichHistDB(account_id, account.org_id, custom_endpoint, bearer_token, filters);
  }
Parámetros:
  • account_id: string: ID único de la cuenta.
  • custom_endpoint: punto final de servicio RESTful de la base de datos de historial enriquecida.
  • bearer_token: token de autorización de acceso para el punto final de servicio RESTful.
  • filters: string: parámetro opcional. Si está vacío, se devuelven todos los registros. La propiedad PageSize determina el número de registros que se devolverán. Si PageSize es 0, el tamaño de página por defecto es 20. La propiedad Bookmark determina el índice inicial de los registros que se van a devolver. Para obtener más información, consulte la documentación de Hyperledger Fabric. Las propiedades StartTime y EndTime se deben especificar en formato RFC-3339, como se muestra en el siguiente ejemplo.
    {
     "pageSize": 20,
     "bookmark": "",
     "startTime": "1900-01-01T00:00:00+00:00",
     "endTime": "2100-01-01T00:00:00+00:00"
 }
Ejemplo de cuerpo de solicitud Postman:
curl --location 'https://centralbank-oabcs1-bom.blockchain.ocp.oraclecloud.com:7443/restproxy/api/v2/channels/default/chaincode-queries' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Y2I6MTIzNDVAQXBwQnVpbGRlcg==' \
--data '{
    "chaincode": "confDev",
    "args": [
        "getAccountTransactionHistoryWithFiltersFromRichHistDB"
    ],
    "timeout": 12000,
    "sync": true,
    "peer": "centralbank-oabcs1-bom.blockchain.ocp.oraclecloud.com:20010",
    "transientMap": {
        "args": "[\"oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc\",\"https://g5363dsasdade33f4-sampledb.adb.ap-sydney-1.oraclecloudapps.com/ords/obp2/conf_cc2/conf_cc2\",\"Dtbw-ehx7QjXfw2VbZsMzQ\",\"{\\\"pageSize\\\":20,\\\"bookmark\\\":\\\"\\\",\\\"startTime\\\":\\\"1900-01-01T00:00:00+00:00\\\",\\\"endTime\\\":\\\"2100-01-01T00:00:00+00:00\\\"}\"]"
    }
}'
Ejemplo de valor devuelto:
[
    {
        "transaction_id": "otransaction~3140569a4ecb3c3f141cc2468fe21276640b7fd79013d951d9104b79072d8f9c",
        "transacted_amount": 200,
        "timestamp": "2025-08-25T13:16:55.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_officer_demo",
        "transacted_custom_account_id": "20200222221111",
        "to_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "to_org_id": "Org1",
        "to_user_id": "fi1_org_officer_demo",
        "to_custom_account_id": "20200222221111",
        "from_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "from_org_id": "CentralBank",
        "from_user_id": "cb_issuer_demo",
        "from_custom_account_id": "10109999001234",
        "transaction_type": "EXECUTEHOLD",
        "category": "transfer",
        "balance": 26800,
        "onhold_balance": 300
    },
    {
        "transaction_id": "otransaction~5112f576c94c2d23c342479bfa37e34612414b3258a64b43cf51b920f4ff5868",
        "transacted_amount": 5000,
        "timestamp": "2025-08-12T21:05:02.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98",
        "transacted_org_id": "CentralBank",
        "transacted_user_id": "cb_retirer_demo",
        "transacted_custom_account_id": "10109999006543",
        "to_account": "oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98",
        "to_org_id": "CentralBank",
        "to_user_id": "cb_retirer_demo",
        "to_custom_account_id": "10109999006543",
        "from_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "from_org_id": "CentralBank",
        "from_user_id": "cb_issuer_demo",
        "from_custom_account_id": "10109999001234",
        "transaction_type": "DEBIT",
        "category": "burn",
        "balance": 45000,
        "onhold_balance": 0
    },
    .  
    .
    .
    .
    {
        "transaction_id": "otransaction~862aa9d9e877d3ea209b87299ab5b12c13ed5ce43d1cf1b934043c1dd02f58f6",
        "transacted_amount": 50000,
        "timestamp": "2025-08-12T21:04:22.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transacted_org_id": "CentralBank",
        "transacted_user_id": "cb__creator_demo",
        "transacted_custom_account_id": "10105678004567",
        "to_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "to_org_id": "CentralBank",
        "to_user_id": "cb_issuer_demo",
        "to_custom_account_id": "10109999001234",
        "from_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "from_org_id": "CentralBank",
        "from_user_id": "cb__creator_demo",
        "from_custom_account_id": "10105678004567",
        "transaction_type": "CREDIT",
        "category": "transfer",
        "balance": 50000,
        "onhold_balance": 0
    }
]
getOrgAccountsTransactionHistoryWithFiltersFromRichHistDB
Este método recupera el historial de transacciones de la base de datos de historial enriquecido para la organización especificada. Este método solo puede ser llamado por Token Admin o Token Auditor, un Org Admin o Org Auditor de la organización especificada o el AccountOwner de la cuenta. 
@GetMethod()
  @Validator(yup.string(), yup.string(), yup.string(), yup.object().nullable())
  public async getOrgAccountsTransactionHistoryWithFiltersFromRichHistDB(org_id: string, custom_endpoint: string, bearer_token: string, filters?: Filters) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getOrgAccountsTransactionHistoryWithFiltersFromRichHistDB", "TOKEN", { org_id });
    return await this.Ctx.Account.getOrgAccountsTrxHistoryWithFiltersFromRichHistDB(org_id, custom_endpoint, bearer_token, filters);
  }
Parámetros:
  • org_id: string: ID del proveedor de servicios de membresía (MSP) de la organización.
  • custom_endpoint: punto final de servicio RESTful de la base de datos de historial enriquecida.
  • bearer_token: token de autorización de acceso para el punto final de servicio RESTful.
  • filters: string: parámetro opcional. Si está vacío, se devuelven todos los registros. La propiedad PageSize determina el número de registros que se devolverán. Si PageSize es 0, el tamaño de página por defecto es 20. La propiedad Bookmark determina el índice inicial de los registros que se van a devolver. Para obtener más información, consulte la documentación de Hyperledger Fabric. Las propiedades StartTime y EndTime se deben especificar en formato RFC-3339, como se muestra en el siguiente ejemplo.
    {
     "pageSize": 20,
     "bookmark": "",
     "startTime": "1900-01-01T00:00:00+00:00",
     "endTime": "2100-01-01T00:00:00+00:00"
 }
Ejemplo de cuerpo de solicitud Postman:
curl --location 'https://org1-oabcs1-bom.blockchain.ocp.oraclecloud.com:7443/restproxy/api/v2/channels/default/chaincode-queries' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Y2I6MTIzNDVAQXBwQnVpbGRlcg==' \
--data '{
    "chaincode": "confDev",
    "args": [
        "getOrgAccountsTransactionHistoryWithFiltersFromRichHistDB"
    ],
    "timeout": 12000,
    "sync": true,
    "peer": "org1-oabcs1-bom.blockchain.ocp.oraclecloud.com:20010",
    "transientMap": {
        "args": "[\"Org1\",\"https://g5363dsasdade33f4-sampledb.adb.ap-sydney-1.oraclecloudapps.com/ords/obp2/conf_cc2/conf_cc2AllOrgAccounts\",\"Dtbw-ehx7QjXfw2VbZsMzQ\",\"{\\\"pageSize\\\":20,\\\"bookmark\\\":\\\"\\\",\\\"startTime\\\":\\\"1900-01-01T00:00:00+00:00\\\",\\\"endTime\\\":\\\"2100-01-01T00:00:00+00:00\\\"}\"]"
    }
}'
Ejemplo de valor devuelto:
[
    {
        "transaction_id": "otransaction~4793f3907eefce2f9fca7ef107405b0f116efb3afbf83fa0e61fe763690c8235",
        "transacted_amount": 100,
        "timestamp": "2025-08-25T13:47:56.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_officer_demo",
        "transacted_custom_account_id": "20200222221111",
        "to_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "to_org_id": "CentralBank",
        "from_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "from_org_id": "Org1",
        "from_user_id": "fi1_org_officer_demo",
        "from_custom_account_id": "20200222221111",
        "transaction_type": "ONHOLD",
        "holding_id": "ohold~cbdc~USD~2ac01689",
        "category": "issuance"
    },
    {
        "transaction_id": "otransaction~5177f7560d32838242a26ac74f2a90c6ff9b47aae0d0988f28d9b4cf7e27c097",
        "transacted_amount": 10,
        "timestamp": "2025-08-25T13:22:23.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~1e31495a0c149b08cb9d02bdcac5e83d88c0f1557d954dda12bb807d7f6fc111",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_user1_demo",
        "transacted_custom_account_id": "20200198765432",
        "to_account": "oaccount~d08ff55a040d5e5dcf406009bab1b3398e06c374356efb1bddbf2f17fc37f949",
        "to_org_id": "Org1",
        "to_user_id": "fi1_org_user2_demo",
        "to_custom_account_id": "20200211112222",
        "from_account": "oaccount~1e31495a0c149b08cb9d02bdcac5e83d88c0f1557d954dda12bb807d7f6fc111",
        "from_org_id": "Org1",
        "from_user_id": "fi1_org_user1_demo",
        "from_custom_account_id": "20200198765432",
        "transaction_type": "CREDIT",
        "holding_id": "ohold~cbdc~USD~454f4bf6",
        "category": "transfer"
    },
    .
    .
    .
    .
    {
        "transaction_id": "otransaction~b7c97d737fb978651c9132276ab677c0bcf795b9db13d0d39cba5243615c7389",
        "transacted_amount": 10,
        "timestamp": "2025-08-21T08:46:09.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_officer_demo",
        "transacted_custom_account_id": "20200222221111",
        "to_account": "oaccount~1e31495a0c149b08cb9d02bdcac5e83d88c0f1557d954dda12bb807d7f6fc111",
        "to_org_id": "Org1",
        "to_user_id": "fi1_org_user1_demo",
        "to_custom_account_id": "20200198765432",
        "from_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "from_org_id": "Org1",
        "from_user_id": "fi1_org_officer_demo",
        "from_custom_account_id": "20200222221111",
        "transaction_type": "ONHOLD",
        "holding_id": "ohold~cbdc~USD~4fbbb846",
        "category": "transfer"
    }
]
getAllAccountsTransactionHistoryWithFiltersFromRichHistDB
Este método recupera el historial de transacciones de la base de datos de historial enriquecido para todas las organizaciones. Este método solo puede ser llamado por Token Admin o Token Auditor. 
@GetMethod()
  @Validator(yup.string(), yup.string(), yup.object().nullable())
  public async getAllAccountsTransactionHistoryWithFiltersFromRichHistDB(custom_endpoint: string, bearer_token: string, filters?: Filters) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAllAccountsTransactionHistoryWithFiltersFromRichHistDB", "TOKEN");
    return await this.Ctx.Account.getAllAccountsTrxHistoryWithFiltersFromRichHistDB(custom_endpoint, bearer_token, filters);
  }
Parámetros:
  • custom_endpoint: punto final de servicio RESTful de la base de datos de historial enriquecida.
  • bearer_token: token de autorización de acceso para el punto final de servicio RESTful.
  • filters: string: parámetro opcional. Si está vacío, se devuelven todos los registros. La propiedad PageSize determina el número de registros que se devolverán. Si PageSize es 0, el tamaño de página por defecto es 20. La propiedad Bookmark determina el índice inicial de los registros que se van a devolver. Para obtener más información, consulte la documentación de Hyperledger Fabric. Las propiedades StartTime y EndTime se deben especificar en formato RFC-3339, como se muestra en el siguiente ejemplo.
    {
     "pageSize": 20,
     "bookmark": "",
     "startTime": "1900-01-01T00:00:00+00:00",
     "endTime": "2100-01-01T00:00:00+00:00"
 }
Ejemplo de cuerpo de solicitud Postman:
curl --location 'https://centralbank-oabcs1-bom.blockchain.ocp.oraclecloud.com:7443/restproxy/api/v2/channels/default/chaincode-queries' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Y2I6MTIzNDVAQXBwQnVpbGRlcg==' \
--data '{
    "chaincode": "confDev",
    "args": [
        "getAllAccountsTransactionHistoryWithFiltersFromRichHistDB"
    ],
    "timeout": 12000,
    "sync": true,
    "peer": "centralbank-oabcs1-bom.blockchain.ocp.oraclecloud.com:20010",
    "transientMap": {
        "args": "[\"https://g5363dsasdade33f4-sampledb.adb.ap-sydney-1.oraclecloudapps.com/ords/obp2/conf_cc2/conf_cc2AllAccounts\",\"Dtbw-ehx7QjXfw2VbZsMzQ\",\"{\\\"pageSize\\\":20,\\\"bookmark\\\":\\\"\\\",\\\"startTime\\\":\\\"1900-01-01T00:00:00+00:00\\\",\\\"endTime\\\":\\\"2100-01-01T00:00:00+00:00\\\"}\"]"
    }
}'
Ejemplo de valor devuelto:
[
    {
        "transaction_id": "otransaction~62eb436be7c29fc2ed9cae221e874d9a31b163fa10374e7da09bf5e09a96c3ff",
        "transacted_amount": 10000,
        "timestamp": "2025-08-25T13:57:58.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "transacted_org_id": "CentralBank",
        "transacted_user_id": "cb_issuer_demo",
        "transacted_custom_account_id": "10109999001234",
        "to_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "to_org_id": "CentralBank",
        "to_user_id": "cb_issuer_demo",
        "to_custom_account_id": "10109999001234",
        "from_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "from_org_id": "CentralBank",
        "from_user_id": "cb__creator_demo",
        "from_custom_account_id": "10105678004567",
        "transaction_type": "DEBIT",
        "category": "issuance"
    },
    {
        "transaction_id": "otransaction~4793f3907eefce2f9fca7ef107405b0f116efb3afbf83fa0e61fe763690c8235",
        "transacted_amount": 100,
        "timestamp": "2025-08-25T13:47:56.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_officer_demo",
        "transacted_custom_account_id": "20200222221111",
        "to_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "to_org_id": "CentralBank",
        "to_user_id": "cb_issuer_demo",
        "to_custom_account_id": "10109999001234",
        "from_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "from_org_id": "Org1",
        "from_user_id": "fi1_org_officer_demo",
        "from_custom_account_id": "20200222221111",
        "transaction_type": "ONHOLD",
        "holding_id": "ohold~cbdc~USD~2ac01689",
        "category": "issuance"
    },
    .
    .
    .
    .
    {
        "transaction_id": "otransaction~5177f7560d32838242a26ac74f2a90c6ff9b47aae0d0988f28d9b4cf7e27c097",
        "transacted_amount": 10,
        "timestamp": "2025-08-25T13:22:23.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~d08ff55a040d5e5dcf406009bab1b3398e06c374356efb1bddbf2f17fc37f949",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_user2_demo",
        "transacted_custom_account_id": "20200211112222",
        "to_account": "oaccount~d08ff55a040d5e5dcf406009bab1b3398e06c374356efb1bddbf2f17fc37f949",
        "to_org_id": "Org1",
        "to_user_id": "fi1_org_user2_demo",
        "to_custom_account_id": "20200211112222",
        "from_account": "oaccount~1e31495a0c149b08cb9d02bdcac5e83d88c0f1557d954dda12bb807d7f6fc111",
        "from_org_id": "Org1",
        "from_user_id": "fi1_org_user1_demo",
        "from_custom_account_id": "20200198765432",
        "transaction_type": "EXECUTEHOLD",
        "holding_id": "ohold~cbdc~USD~454f4bf6",
        "category": "transfer"
    }
]
deleteHistoricalTransactions
Este método suprime las transacciones más antiguas de la base de datos de estado. Este método solo se puede llamar mediante Token Admin. 
@Validator(yup.date())
  public async deleteHistoricalTransactions(time_to_expiration: Date) {
    await this.Ctx.Auth.checkAuthorization("TRANSACTION.deleteTransactions", "TOKEN");
    await this.Ctx.Model.createEvent(EVENT_NAME.DELETE_HISTORICAL_TRANSACTIONS, { time_to_expiration });
    return await this.Ctx.Transaction.deleteTransactions(time_to_expiration);
  }
Parámetros:
  • time_to_expiration Date: registro de hora que indica cuándo se deben suprimir las transacciones. Se suprimirán los activos de transacción que sean anteriores a la hora especificada.
Ejemplo de valor devuelto:
{
    "msg": "Successfully deleted transaction older than date: Thu Aug 19 2025 11:19:36 GMT+0000 (Coordinated Universal Time).",
    "transactions": [
           "otransaction~ec3366dd48b4ce2838f820f2f138648e6e55a07226713e59b411ff31b0d21058"
     ]
}
getTransactionById
Este método devuelve el historial de un activo Transaction. Este método solo puede ser llamado por un Token Admin o Token Auditor, por un Org Admin o Org Auditor de la organización especificada, o por un participante de la transacción (emisor, destinatario o notario). 
@GetMethod()
  @Validator(yup.string())
  public async getTransactionById(transaction_id: string) {
    await this.Ctx.Auth.checkAuthorization("TRANSACTION.getTransactionById", "TOKEN", { transaction_id });
    return await this.Ctx.Transaction.getTransactionById(transaction_id);
  }
Parámetros:
  • transaction_id string: ID del activo de transacción.
Devuelve:
  • En caso de éxito, una matriz JSON del historial de la transacción.
Ejemplo de valor devuelto:
{
    "transaction_id": "otransaction~6523597253e45b3c976aecdc54e2c6316d0a4f88ad5d7f3fff48c69213e4375a",
    "history": [
        {
            "trxId": "6523597253e45b3c976aecdc54e2c6316d0a4f88ad5d7f3fff48c69213e4375a",
            "timeStamp": "2025-08-20T23:21:45.000Z",
            "value": {
                "assetType": "otransaction",
                "transaction_id": "otransaction~6523597253e45b3c976aecdc54e2c6316d0a4f88ad5d7f3fff48c69213e4375a",
                "token_id": "token",
                "from_account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
                "to_account_id": "oaccount~5e3b5a3306d7ca3f3e3fe7cc27b6ae547e94dba1c5af58a69a771d7a619b6a66",
                "transaction_type": "TRANSFER",
                "amount": 22,
                "timestamp": "2025-08-20T23:21:45.000Z",
                "number_of_sub_transactions": 0,
                "holding_id": "",
                "sub_transaction": "false",
                "category": "category value",
                "description": "description value"
            }
        }
    ],
    "sub_transactions": []
}
consolidateRunningBalanceInTransactions
Este método calcula los saldos de cuenta en ejecución y guarda los valores actualizados en los pares de clave/valor de transacción. Normalmente, los administradores del sistema llaman a este método mediante un programador de proxy REST. Este método solo se puede llamar mediante Token Admin o Org Admin. 
@Validator(yup.string())
  public async consolidateRunningBalanceInTransactions() {
    await this.Ctx.Auth.checkAuthorization("TRANSACTION.consolidateRunningBalanceInTransactions", "TOKEN");
    return this.Ctx.Transaction.consolidateRunningBalanceInTransactions(true);
  }
Ejemplo de valor devuelto:
{ msg: "Successfully updated account running balance for pending transactions."}
processSendersAndReceivers
Este método calcula y actualiza los saldos de cuenta de token que se distribuyen en los pares de clave/valor de remitente y receptor que se crearon durante las transferencias entre organizaciones y, a continuación, suprime los pares de clave/valor de remitente y receptor, que ya no se utilizan. Normalmente, los administradores del sistema llaman a este método mediante un programador de proxy REST. Este método solo se puede llamar mediante Token Admin o Org Admin. 
@Validator(yup.string())
  public async processSendersAndReceivers() {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.processSendersAndReceivers", "TOKEN");
    return this.Ctx.Account.processSendersAndReceivers(true);
  }
Ejemplo de valor devuelto:
{ msg: "Successfully updated balance for accounts from pending receivers."}
requestMint
Este método puede ser llamado por un minter para enviar una solicitud al notario minter para crear una cantidad especificada de tokens. 
@Validator(
    yup.string(),
    yup.string(),
    yup.number().positive(),
    yup.date(),
    yup.object().nullable()
  )
  public async requestMint(
      operation_id: string,
      notary_account_id: string,
      quantity:number,
      time_to_expiration: Date,
      info_details ?: InfoDetails
  ) {
    const notary_account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(notary_account_id);
    const token_asset = await this.getTokenObject(notary_account.token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.REQUEST_MINT, { operation_id, notary_account_id, quantity, time_to_expiration, info_details }, token_asset);
    return await this.Ctx.Hold.hold(operation_id, null, notary_account_id, quantity, time_to_expiration, token_asset, HoldOperationType.MINT, info_details);
  }
Parámetros:
  • operation_id: string: ID de operación único que representa la solicitud de moneda.
  • notary_account_id: string: ID de cuenta único del notario secundario que procesará la solicitud.
  • quantity: number: cantidad de tokens que se deben acuñar.
  • time_to_expiration: el tiempo después del cual caduca la solicitud de extracción y ya no es válida.
  • info_details: JSON: objeto que especifica la categoría (category) y la descripción (description) de la solicitud.

    Puede especificar el parámetro info_details en un formato diferente si utiliza Visual Studio Code frente a la CLI o una recopilación Postman.

    Código de Visual Studio: { "category": "category value", "description": "description value" }

    CLI/Postman: "{\"category\":\"category value\",\"description\":\"description value\"}"

Ejemplo de valor devuelto:
{
           "msg": "AccountId oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41 has successfully submitted request to mint 200 tokens"
       }
approveMint
Este método puede ser llamado por un notario de minter para aprobar una solicitud de acuñación. 
@Validator(yup.string(), yup.string())
  public async approveMint(token_id: string, operation_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.APPROVE_MINT, { token_asset, operation_id }, token_asset);
    return await this.Ctx.Hold.executeHold(operation_id, token_asset, HoldOperationType.MINT);
  }
Parámetros:
  • token_id: string: ID del token que se debe acuñar.
  • operation_id: string: ID de operación único que representa la solicitud de moneda.
Ejemplo de valor devuelto:
{
           "msg": "Successfully minted 1000 tokens to Account Id: oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41"
       }
rejectMint
Este método puede ser llamado por un notario de minter para rechazar una solicitud de acuñación. 
@Validator(yup.string(), yup.string())
  public async rejectMint(token_id: string, operation_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.REJECT_MINT, { token_asset, operation_id }, token_asset);
    return await this.Ctx.Hold.releaseHold(operation_id, token_asset, HoldOperationType.MINT);
  }
Parámetros:
  • token_id: string: ID del token que se debe acuñar.
  • operation_id: string: ID de operación único que representa la solicitud de moneda.
Ejemplo de valor devuelto:
{
           "msg": "Successfully rejected mint request with Operation Id '89ce' to mint 2000 tokens of token id USD"
       }
issueTokens
Este método acuña tokens, que luego son propiedad del emisor de llamada del método.
@Validator(yup.string(), yup.number().positive(), yup.object().nullable())
  public async issueTokens(token_id: string, quantity: number, info_details?: InfoDetails) {
    const token_asset = await this.getTokenObject(token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.ISSUE_TOKENS, { quantity, token_asset, info_details }, token_asset);
    return await this.Ctx.Token.mint(quantity, token_asset, info_details);
  }
Parámetros:
  • token_id: string: ID del token.
  • quantity: número de tokens que se deben acuñar.
  • info_details: JSON: objeto que especifica la categoría (category) y la descripción (description) de la solicitud.

    Puede especificar el parámetro info_details en un formato diferente si utiliza Visual Studio Code frente a la CLI o una recopilación Postman.

    Código de Visual Studio: { "category": "category value", "description": "description value" }

    CLI/Postman: "{\"category\":\"category value\",\"description\":\"description value\"}"

Ejemplo de valor devuelto:
{
          "msg": "Successfully minted 1000 tokens to Account Id: oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41"
      }
getTotalMintedTokens
Este método devuelve el número total de tokens acuñados para un token especificado. Este método solo se puede llamar mediante Token Admin, Token Auditor, Org Admin o Org Auditor. 
@GetMethod()
  @Validator(yup.string())
  public async getTotalMintedTokens(token_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    await this.Ctx.Auth.checkAuthorization("TOKEN.getTotalMintedTokens", "TOKEN");
    const totalMintedTokens = await this.Ctx.Token.getTotalMintedTokens(token_asset);
    return {
      msg: `Total minted token for Token Id: ${token_id} is ${totalMintedTokens} tokens.`,
      quantity: totalMintedTokens,
    };
  }
Parámetros:
  • token_id: string: ID del token.
Devuelve:
  • En caso de éxito, una cadena JSON que indique el número total de tokens.
Ejemplo de valor devuelto:
{
    "msg": "Total minted token for Token Id: USD is 910 tokens.",
    "quantity": 910
}
getNetTokens
Este método devuelve el número neto total de tokens disponibles en el sistema para un token especificado. El total neto de tokens es la cantidad de tokens que quedan después de que los tokens se queman. En forma de ecuación: tokens netos = tokens totales acuñados - tokens totales quemados. Si no se queman tokens, el número de tokens netos es igual al total de tokens acuñados. Este método solo se puede llamar mediante Token Admin, Token Auditor, Org Admin o Org Auditor. 
@GetMethod()
  @Validator(yup.string())
  public async getNetTokens(token_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    await this.Ctx.Auth.checkAuthorization("TOKEN.getNetTokens", "TOKEN");
    const netTokens = await this.Ctx.Token.getNetTokens(token_asset);
    return {
      msg: `Net supply of token for Token Id: ${token_id} is ${netTokens} tokens.`,
      quantity: netTokens,
    };
  }
Parámetros:
  • token_id: string: ID del token.
Devuelve:
  • En caso de éxito, una cadena JSON que indique el número neto de tokens.
Ejemplo de valor devuelto:
{
    "msg": "Net supply of token for Token Id: USD is 878 tokens.",
    "quantity": 878
}
transferTokens
Este método transfiere tokens del emisor de llamada a una cuenta especificada.
@Validator(yup.string(), yup.number(), yup.object().nullable())
  public async transferTokens(to_account_id: string, quantity: number, info_details ?: InfoDetails) {
    if (quantity <= 0) {
      throw new Error("The quantity should be a positive number.")
    }
    const to_account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(to_account_id);
    const token_asset = await this.getTokenObject(to_account.token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.TRANSFER_TOKENS, { to_account_id, quantity, info_details }, token_asset);
    let isNotary = await this.Ctx.Token.checkNotary(to_account_id, token_asset);
    if(isNotary) {
      throw new Error(`To Account Id '${to_account_id}' can not have a notary role!`);
    }
    return await this.Ctx.Token.transfer(to_account_id, quantity, token_asset, info_details);
  }
Parámetros:
  • to_account_id: string: ID de cuenta único del receptor (beneficiario).
  • quantity: number: número de tokens que se van a transferir.
  • info_details: JSON: objeto que especifica la categoría (category) y la descripción (description) de la solicitud.

    Puede especificar el parámetro info_details en un formato diferente si utiliza Visual Studio Code frente a la CLI o una recopilación Postman.

    Código de Visual Studio: { "category": "category value", "description": "description value" }

    CLI/Postman: "{\"category\":\"category value\",\"description\":\"description value\"}"

Ejemplo de valor devuelto:
{
          "msg": "Successfully transferred 10000 tokens from account id: oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41  to account id: oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a."
      }
holdTokens
Este método crea una retención en nombre del emisor de llamada (el propietario de los tokens) con la cuenta to_account_id. La cuenta notarial especificada es responsable de completar o liberar la retención. Cuando se crea la retención, el saldo de token especificado del pagador se retiene. Un saldo retenido no se puede transferir hasta que la retención se haya completado o liberado. 
@Validator(
    yup.string(),
    yup.string(),
    yup.string(),
    yup.number().positive(),
    yup.date(),
    yup.object().nullable()
  )
  public async holdTokens(
    operation_id: string,
    to_account_id: string,
    notary_account_id: string,
    quantity: number,
    time_to_expiration: Date,
    info_details ?: InfoDetails,
  ) {
    const to_account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(to_account_id);
    await this.Ctx.Account.getAccountWithTokenIdValidation(notary_account_id);
    const token_asset = await this.getTokenObject(to_account.token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.HOLD_TOKENS, {
      operation_id,
      to_account_id,
      notary_account_id,
      quantity,
      time_to_expiration,
      info_details
    }, token_asset);
    return await this.Ctx.Hold.hold(operation_id, to_account_id, notary_account_id, quantity, time_to_expiration, token_asset, HoldOperationType.TRANSFER, info_details);
  }
Parámetros:
  • operation_id: string: ID único para identificar la operación de retención. Normalmente, la aplicación cliente transfiere este ID.
  • to_account_id: string: el ID de cuenta único del receptor.
  • notary_account_id: string: ID de cuenta único del notario.
  • quantity: number: número de tokens que se deben retener.
  • time_to_expiration: hora a la que caduca la retención. Especifique 0 para una retención permanente. De lo contrario, utilice el formato RFC-3339. Por ejemplo, 2021-06-02T12:46:06Z.
  • info_details: JSON: objeto que especifica la categoría (category) y la descripción (description) de la solicitud.

    Puede especificar el parámetro info_details en un formato diferente si utiliza Visual Studio Code frente a la CLI o una recopilación Postman.

    Código de Visual Studio: { "category": "category value", "description": "description value" }

    CLI/Postman: "{\"category\":\"category value\",\"description\":\"description value\"}"

Ejemplo de valor devuelto:
{
           "msg": "AccountId oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3 is successfully holding 100 tokens"
       }
executeHoldTokens
Este método completa una retención de un token. Una cantidad de tokens previamente retenidos por un propietario de token se transfiere a un receptor. Si el valor quantity es menor que el valor de retención real, el importe restante vuelve a estar disponible para el propietario original de los tokens. Este método solo puede ser llamado por el ID AccountOwner con el rol notary para el ID de operación especificado. La retención solo la puede completar el notario. 
@Validator(yup.string(), yup.string(), yup.number().positive())
  public async executeHoldTokens(token_id: string, operation_id: string, quantity: number) {
    const token_asset = await this.getTokenObject(token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.EXECUTE_HOLD_TOKENS, { token_asset, operation_id, quantity }, token_asset);
    return await this.Ctx.Hold.executeHold(operation_id, token_asset, HoldOperationType.TRANSFER, quantity);
  }
Parámetros:
  • token_id: string: ID del token.
  • operation_id: string: ID único para identificar la operación de retención. Normalmente, la aplicación cliente transfiere este ID.
  • quantity: number: número de tokens retenidos que se van a transferir.
Devuelve:
  • En caso de éxito, un mensaje con el ID de cuenta del emisor de la llamada y la cantidad de la transacción.
Ejemplo de valor devuelto:
{
           "msg": "Account Id: oaccount~1e31495a0c149b08cb9d02bdcac5e83d88c0f1557d954dda12bb807d7f6fc111 is successfully executed '10' tokens from Operation Id '454f4bf6'."
       }
releaseHoldTokens
Este método libera una retención de tokens. La transferencia no se ha completado y todos los tokens retenidos están disponibles de nuevo para el propietario original. Este método puede ser llamado por el ID AccountOwner con el rol notary dentro del límite de tiempo especificado o por el pagador, el beneficiario o el notario después del límite de tiempo especificado. 
@Validator(yup.string(), yup.string())
  public async releaseHoldTokens(token_id: string, operation_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.RELEASE_HOLD_TOKENS, { token_asset, operation_id }, token_asset);
    return await this.Ctx.Hold.releaseHold(operation_id, token_asset, HoldOperationType.TRANSFER);
  }
Parámetros:
  • token_id: string: ID del token.
  • operation_id: string: ID único para identificar la operación de retención. Normalmente, la aplicación cliente transfiere este ID.
Devuelve:
  • Si se realiza correctamente, se muestra un mensaje que indica que la retención se ha liberado.
Ejemplo de valor devuelto:
{
           "msg": "Successfully released '200' tokens from Operation Id '77b75873' to Account Id: oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a."
       }
getOnHoldIds
Este método devuelve una lista de todos los IDs de retención de una cuenta especificada. Este método se puede llamar mediante un Token Admin o Token Auditor del código de cadena, un Org Admin o Org Auditor de la organización especificada o el AccountOwner de la cuenta. 
@GetMethod()
  @Validator(yup.string())
  public async getOnHoldIds(account_id: string) {
    await this.Ctx.Account.getAccountWithTokenIdValidation(account_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getOnHoldIds", "TOKEN", { account_id });
    return await this.Ctx.Account.getOnHoldIds(account_id);
  }
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Devuelve:
  • En caso de éxito, una lista JSON de ID de retención.
Ejemplo de valor devuelto:
{
           "msg": "Holding Ids are: ",
           "holding_ids": ["ohold~cbdc~token~hold1"]
       }
getOnHoldDetailsWithOperationId
Este método devuelve los detalles de la transacción retenida para un token e ID de operación especificados. Este método puede ser llamado por un Token Admin o Token Auditor del código de cadena, o por un participante de transacción (emisor, destinatario, notario). 
@GetMethod()
  @Validator(yup.string(), yup.string())
  public async getOnHoldDetailsWithOperationId(token_id: string, operation_id: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getOnHoldDetailsWithOperationId", "TOKEN", { token_id, operation_id });
    return await this.Ctx.Hold.getOnHoldDetailsWithOperationId(token_id, operation_id);
  }
Parámetros:
  • token_id: string: ID del token.
  • operation_id: string: ID único para identificar la operación de retención. Normalmente, la aplicación cliente transfiere este ID.
Ejemplo de valor devuelto:
{
          "assetType": "ohold",
          "holding_id": "ohold~cbdc~token~hold1",
          "operation_id": "hold1",
          "token_name": "cbdc",
          "from_org_id": "CentralBank",
          "operation_type": "transfer",
          "status": "approved",
          "from_account_id": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
          "to_account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
          "notary_account_id": "oaccount~1da238c1491c919b151f777a615fb5779032c34b3ef3adeca6afe591bac10aaf",
          "token_id": "token",
          "quantity": "0",
          "time_to_expiration": "2029-01-04T00:00:00.000Z",
          "category": "category value",
          "description": "description value"
      }
getOnHoldBalanceWithOperationId
Este método devuelve el saldo retenido para un token e ID de operación especificados. Este método puede ser llamado por un Token Admin o Token Auditor del código de cadena, o por un participante de transacción (emisor, destinatario, notario). 
@GetMethod()
  @Validator(yup.string(), yup.string())
  public async getOnHoldBalanceWithOperationId(token_id: string, operation_id: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getOnHoldBalanceWithOperationId", "TOKEN", { token_id, operation_id });
    return await this.Ctx.Hold.getOnHoldBalanceWithOperationId(token_id, operation_id);
  }
Parámetros:
  • token_id: string: ID del token.
  • operation_id: string: ID único para identificar la operación de retención. Normalmente, la aplicación cliente transfiere este ID.
Devuelve:
  • En caso de éxito, una cadena JSON que indique el saldo de retención.
Ejemplo de valor devuelto:
{
           "msg": "Current Holding Balance of Operation 'hold1' for token 'token' is: 0",
           "holding_balance": 0
       }
requestBurn
Este método puede ser llamado por un quemador para enviar una solicitud al notario del quemador para destruir una cantidad especificada de tokens.
@Validator(
    yup.string(),
    yup.string(),
    yup.number().positive(),
    yup.date(),
    yup.object().nullable()
  )
  public async requestBurn(
      operation_id: string,
      notary_account_id: string,
      quantity:number,
      time_to_expiration: Date,
      info_details ?: InfoDetails,
  ) {
    const notary_account: FungibleAccount = await this.Ctx.Account.getAccountWithTokenIdValidation(notary_account_id);
    const token_asset = await this.getTokenObject(notary_account.token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.REQUEST_BURN, { operation_id, notary_account_id, quantity, time_to_expiration, info_details }, token_asset);
    return await this.Ctx.Hold.hold(operation_id, null, notary_account_id, quantity, time_to_expiration, token_asset, HoldOperationType.BURN, info_details);
  }
Parámetros:
  • operation_id: string: el ID de operación único que representa la solicitud de grabación.
  • notary_account_id: string: ID de cuenta único del notario del quemador que procesará la solicitud.
  • quantity: number: cantidad de tokens que se queman.
  • time_to_expiration: el tiempo después del cual caduca la solicitud de grabación y ya no es válida.
  • info_details: JSON: objeto que especifica la categoría (category) y la descripción (description) de la solicitud.

    Puede especificar el parámetro info_details en un formato diferente si utiliza Visual Studio Code frente a la CLI o una recopilación Postman.

    Código de Visual Studio: { "category": "category value", "description": "description value" }

    CLI/Postman: "{\"category\":\"category value\",\"description\":\"description value\"}"

Ejemplo de valor devuelto:
{
           "msg": "AccountId oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98 has successfully submitted request to burn 100 tokens"
       }
approveBurn
Este método puede ser llamado por un notario del quemador para aprobar una solicitud de grabación. 
@Validator(yup.string(), yup.string())
  public async approveBurn(token_id: string, operation_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.APPROVE_BURN, { token_asset, operation_id }, token_asset);
    return await this.Ctx.Hold.executeHold(operation_id, token_asset, HoldOperationType.BURN);
  }
Parámetros:
  • token_id: string: ID del token que se va a grabar.
  • operation_id: string: el ID de operación único que representa la solicitud de grabación.
Ejemplo de valor devuelto:
{
           "msg": "Successfully burned 200 tokens from account id: oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98"
       }
rejectBurn
Este método puede ser llamado por un notario de quemadores para rechazar una solicitud de quemado. 
@Validator(yup.string(), yup.string())
  public async rejectBurn(token_id: string, operation_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    await this.Ctx.Model.createEvent(EVENT_NAME.REJECT_BURN, { token_asset, operation_id }, token_asset);
    return await this.Ctx.Hold.releaseHold(operation_id, token_asset, HoldOperationType.BURN);
  }
Parámetros:
  • token_id: string: ID del token que se va a grabar.
  • operation_id: string: el ID de operación único que representa la solicitud de grabación.
Ejemplo de valor devuelto:
{
           "msg": "Successfully rejected burn request with Operation Id '8d34' to burn 100 tokens of token id USD"
       }

TypeScript Métodos para transferencias entre organizaciones

Las transferencias entre organizaciones tienen dos partes: en primer lugar, el importe se carga del remitente y, a continuación, el importe se abona al receptor. Las dos API siguientes se llaman juntas como una transacción atómica mediante la API de confirmación en dos fases del proxy de REST de Oracle Blockchain Platform. Las transferencias confidenciales se realizan de esta manera porque las recopilaciones de datos privados de las dos organizaciones son distintas y no se puede acceder a ellas en una sola transacción.

Ambas transacciones se envían mediante la API de confirmación en dos fases del proxy de REST. Para obtener más información, consulte Llamada a transacción atómica.

Puede crear una solicitud POST en la recopilación Postman en la que la URL sea similar a: https://test-xyz-abc.blockchain.ocp.oraclecloud.com:7443/restproxy/api/v2/atomicTransactions. Debe enviar todas las cabeceras esenciales, incluidas las siguientes.
- Content-Type: application/json
- Confidential-Transaction: true
En el cuerpo de la solicitud, incluya los métodos executeHoldTokensSendery executeHoldTokensReceiver como se muestra en la siguiente solicitud.
{
 "transactions": [
   {
        "chaincode": "<chaincode>",
        "args": [
            "executeHoldTokensSender"
        ],
        "timeout": 6000,
        "sync": true,
        "transientMap": {
            "args": "[ \"bc-token-id value\",\"operation_id value\",\"quantity value\"]"
        },
        "endorsers" : <Sender's endorsers List>,
        "channel":"<channel name>"
   },
   {
        "chaincode": "<chaincode name>",
        "args": [
            "executeHoldTokensReceiver"
        ],
        "timeout": 6000,
        "sync": true,
        "transientMap": {
            "args": "[ \"bc-token-id value\",\"operation_id value\",\"quantity value\"]"
        },
        "endorsers" : <Recipient endorsers List>,
        "channel":"<channelName>"
    }
 ],
 "isolationLevel": "readCommitted",
 "prepareTimeout": 10000,
 "copyInputsToTransientMap": true,
 "sync": true,
 "parallelPrepare": true
}
En el siguiente ejemplo, se muestra un cuerpo de solicitud.
{
 "transactions": [
   {
        "chaincode": "WholesaleCBDCConfidential",
        "args": [
            "executeHoldTokensSender"
        ],
        "timeout": 6000,
        "sync": true,
        "transientMap": {
            "args": "[ \"bc-token-id value\",\"operation_id value\",\"quantity value\"]"
        },
        "endorsers" : ["org1-xyz-abc.blockchain.ocp.oraclecloud.com:20009", "org1-xyz-abc.blockchain.ocp.oraclecloud.com:20009"],
        "channel":"default"
   },
   {
        "chaincode": "WholesaleCBDCConfidential",
        "args": [
            "executeHoldTokensReceiver"
        ],
        "timeout": 6000,
        "sync": true,
        "transientMap": {
            "args": "[ \"bc-token-id value\",\"operation_id value\",\"quantity value\"]"
        },
        "endorsers" : ["org2-xyz-abc.blockchain.ocp.oraclecloud.com:20009", "org2-xyz-abc.blockchain.ocp.oraclecloud.com:20009"],
        "channel":"default"
    }
 ],
 "isolationLevel": "readCommitted",
 "prepareTimeout": 10000,
 "copyInputsToTransientMap": true,
 "sync": true,
 "parallelPrepare": true
}
executeHoldTokensSender
Este método solo puede ser llamado por el usuario con el rol de notario para el ID de operación especificado. Este método es la primera parte de la aprobación de un traslado entre organizaciones. El importe especificado se deduce de la cuenta del remitente.
@ExcludeFromPostmanCollection()
  @Validator(yup.string(), yup.string(), yup.number().positive(), yup.string(), yup.string())
  public async executeHoldTokensSender(token_id: string, operation_id: string, quantity: number,  isolationLevel: string, globalIdInput:string) {
    if (!this.Ctx.Utils.isValidInterOrgTransferRequest()) {
      throw new Error("The request for the inter-org transfer is invalid.")
    }
    const globalTxId =  this.Ctx.Utils.extractGlobalTransactionId(globalIdInput);
    const token_asset = await this.getTokenObject(token_id);
    return await this.Ctx.Hold.executeHoldSender(operation_id, quantity, globalTxId, token_asset);
  }
Parámetros:
  • token_id: string: ID del token que se va a grabar.
  • operation_id: string: ID de operación único que representa la solicitud de retención que se debe aprobar.
  • quantity: number: cantidad de tokens retenidos para transferir.
  • isolationLevel: string: nivel de aislamiento de la transacción atómica, ya sea serializable o readCommitted.
  • globalIdInput: string
Ejemplo de valor devuelto:
{
      "msg":
        "Account Id: oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a is successfully executed '10' tokens from Operation Id 'hold1'."
    }
executeHoldTokensReceiver
Este método solo puede ser llamado por el usuario con el rol de notario para el ID de operación especificado. Este método es la segunda parte de la aprobación de un traslado entre organizaciones. El importe especificado se acredita en la cuenta del receptor.
@ExcludeFromPostmanCollection()
  @Validator(yup.string(), yup.string(), yup.number().positive(), yup.string(), yup.string())
  public async executeHoldTokensReceiver(token_id: string, operation_id: string, quantity: number,  isolationLevel: string, globalIdInput:string) {
    if (!this.Ctx.Utils.isValidInterOrgTransferRequest()) {
      throw new Error("The request for the inter-org transfer is invalid.")
    }
    const globalTxId =  this.Ctx.Utils.extractGlobalTransactionId(globalIdInput);
    const token_asset = await this.getTokenObject(token_id);
    return await this.Ctx.Hold.executeHoldReceiver(operation_id, quantity, globalTxId, token_asset);
  }
Parámetros:
  • token_id: string: ID del token que se va a grabar.
  • operation_id: string: ID de operación único que representa la solicitud de retención que se debe aprobar.
  • quantity: number: cantidad de tokens retenidos para transferir.
  • isolationLevel: string: nivel de aislamiento de la transacción atómica, ya sea serializable o readCommitted.
  • globalIdInput: string
Ejemplo de valor devuelto:
{
      "msg":
        "Account Id: oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a is successfully executed '10' tokens from Operation Id 'hold1, receiverId oreceiver~72d9bfcf-2c68-4c33-b8c3-fe3374983bf2'."
    }

Métodos de SDK de TypeScript modificados para código de cadena confidencial

Si incluye el parámetro confidential: true en el archivo de especificación para tokens que utilizan el estándar extendido Token Taxonomy Framework, Blockchain App Builder genera versiones modificadas de los métodos estándar de SDK, así como métodos adicionales.

isUserTokenAdmin
Este método devuelve el valor booleano true si el emisor de llamada de la función es un Token Admin. De lo contrario, el método devuelve false. 
Ctx.Auth.isUserTokenAdmin(org_id: string, user_id: string);
Parámetros:
  • org_id: ID del proveedor de servicios de membresía (MSP) del usuario en la organización de red actual.
  • user_id: nombre de usuario o ID de correo electrónico del usuario.
Ejemplo de valor devuelto:
{
    "result": true
}
addTokenAdmin
Este método agrega un usuario como Token Admin del código de cadena de token. Puesto que el valor user_id se almacena en el libro mayor público, no utilice ninguna información de identificación personal (PII) para el valor user_id. 
Ctx.Admin.addTokenAdmin(org_id: string, user_id: string);
Parámetros:
  • user_id: nombre de usuario o ID de correo electrónico del usuario.
  • org_id: ID del proveedor de servicios de membresía (MSP) del usuario en la organización de red actual.
Ejemplo de valor devuelto:
{
  "msg": "Successfully added Token Admin (Org_Id: CentralBank, User_Id: cb1)"
}
removeTokenAdmin
Este método elimina un usuario como Token Admin del código de cadena de token. 
Ctx.Admin.removeTokenAdmin(org_id: string, user_id: string);
Parámetros:
  • user_id: nombre de usuario o ID de correo electrónico del usuario.
  • org_id: ID del proveedor de servicios de membresía (MSP) del usuario en la organización de red actual.
Ejemplo de valor devuelto:
{"msg": "Successfully removed Admin (Org_Id: Org1MSP, User_Id: User1)"}
getAllTokenAdmins
Este método devuelve una lista de todos los usuarios que son Token Admin del código de cadena. 
Ctx.Admin.getAllTokenAdmins();
Parámetros:
  • ninguno
Ejemplo de valor devuelto:
{"admins":[{"org_id":"Org1MSP","user_id":"admin"}]}
addOrgAdmin
Este método agrega un usuario como Org Admin de la organización. Puesto que el valor user_id se almacena en el libro mayor público, no utilice ninguna información de identificación personal (PII) para el valor user_id. 
 Ctx.Admin.addOrgAdmin(org_id: string, user_id: string);
Parámetros:
  • org_id: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • user_id: string: nombre de usuario o ID de correo electrónico del usuario.
Ejemplo de valor devuelto:
{
    "msg": "Successfully added Org Admin (Org_Id: Org1MSP, User_Id: orgAdmin)"
}
removeOrgAdmin
Este método elimina un usuario como Org Admin de la organización. 
Ctx.Admin.removeOrgAdmin(org_id: string, user_id: string);
Parámetros:
  • org_id: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • user_id: string: nombre de usuario o ID de correo electrónico del usuario.
Ejemplo de valor devuelto:
{
  "msg": "Successfully removed Org Admin (Org_Id Org1MSP User_Id orgAdmin)"
}
getAllOrgAdmins
Este método devuelve una lista de todos los usuarios que son Org Admin de una organización. 
Ctx.Admin.getAllOrgAdmins();
Parámetros:
  • ninguno
Ejemplo de valor devuelto:
{
    "admins": [
        {
            "org_id": "Org1MSP",
            "user_id": "orgadmin"
        },
        {
            "org_id": "Org1MSP",
            "user_id": "orgadmin1"
        },
        {
            "org_id": "Org1MSP",
            "user_id": "orgadmin2"
        }
    ]
}
addTokenAuditor
Este método agrega un usuario como Token Auditor del código de cadena. Puesto que el valor user_id se almacena en el libro mayor público, no utilice ninguna información de identificación personal (PII) para el valor user_id. 
Ctx.Admin.addTokenAuditor(org_id: string, user_id: string);
Parámetros:
  • org_id: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • user_id: string: nombre de usuario o ID de correo electrónico del usuario.
Devuelve:
  • Si se ha realizado correctamente, un mensaje que incluye detalles del usuario que se ha agregado como Token Auditor del código de cadena.
Ejemplo de valor devuelto:
{
  "msg": "Successfully added Token Auditor (Org_Id: CentralBank, User_Id: cb_admin_demo)"
}
removeTokenAuditor
Este método elimina un usuario como Token Auditor del código de cadena. 
Ctx.Admin.removeTokenAuditor(org_id: string, user_id: string);
Parámetros:
  • org_id: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • user_id: string: nombre de usuario o ID de correo electrónico del usuario.
Ejemplo de valor devuelto:
{
           "msg": "Successfully removed Token Auditor (Org_Id: CB, User_Id: cb)"
       }
getAllTokenAuditors
Este método devuelve todos los Token Auditors del código de cadena. 
this.Ctx.Admin.getAllTokenAuditors();
addOrgAuditor
Este método agrega un usuario como Org Auditor del código de cadena. 
Ctx.Admin.addOrgAuditor(org_id: string, user_id: string);
Parámetros:
  • org_id: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • user_id: string: nombre de usuario o ID de correo electrónico del usuario.
Ejemplo de valor devuelto:
{
           "msg": "Successfully added Org Auditor (Org_Id: CentralBank, User_Id: cb_admin_demo)"
       }
removeOrgAuditor
Este método elimina un usuario como Org Auditor del código de cadena. 
this.Ctx.Admin.removeOrgAuditor(org_id: string, user_id: string);
Parámetros:
  • org_id: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
  • user_id: string: nombre de usuario o ID de correo electrónico del usuario.
Ejemplo de valor devuelto:
{
           "msg": "Successfully removed Org Auditor (Org_Id: CB, User_Id: cb)"
       }
getAllOrgAuditors
Este método devuelve todos los Org Auditors del código de cadena. 
this.Ctx.Admin.getAllOrgAuditors()
getAllTokens
Este método devuelve todos los activos de token guardados en la base de datos de estado. Este método utiliza consultas enriquecidas de Berkeley DB SQL y solo se puede llamar cuando se conecta a la red remota de Oracle Blockchain Platform.
this.Ctx.Token.getAllTokens();
Parámetros:
  • ninguno
Devuelve:
  • En el éxito, devuelve una promesa con todos los activos de token. En caso de error, devuelve un mensaje de error.
getDecimals
Este método devuelve el número de decimales disponibles para un token fraccionario. Si no se especifica el comportamiento divisible, el valor por defecto es 0. 
this.Ctx.Token.getDecimals(token_asset)
Parámetros:
  • token_id: string: ID del token.
Ejemplo de valor devuelto:
1
history
Este método devuelve el historial para el token especificado.
Ctx.Token.history(tokenId: string);
Parámetros:
  • token_id: string: ID del token.
Ejemplo de valor devuelto:
[
    {
        "trxId": "0d75f09446a60088afb948c6aca046e261fddcd43df416076201cdc5565f1a35",
        "timeStamp": "2023-09-01T16:48:41.000Z",
        "value": {
            "assetType": "otoken",
            "token_id": "token",
            "token_name": "fiatmoneytok",
            "token_desc": "updatedDesc",
            "token_standard": "ttf+",
            "token_type": "fungible",
            "token_unit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter"
            },
            "mintable": {
                "max_mint_quantity": 1000
            },
            "divisible": {
                "decimal": 2
            }
        }
    },
    {
        "trxId": "3666344878b043b65d5b821cc79c042ba52aec467618800df5cf14eac69f72fa",
        "timeStamp": "2023-08-31T20:24:55.000Z",
        "value": {
            "assetType": "otoken",
            "token_id": "token",
            "token_name": "fiatmoneytok",
            "token_standard": "ttf+",
            "token_type": "fungible",
            "token_unit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter"
            },
            "mintable": {
                "max_mint_quantity": 1000
            },
            "divisible": {
                "decimal": 2
            }
        }
    }
]
getTokensByName
Este método devuelve todos los activos de token con el nombre especificado. Este método utiliza consultas enriquecidas de Berkeley DB SQL y solo se puede llamar cuando se conecta a la red remota de Oracle Blockchain Platform.
Ctx.Token.getTokensByName(token_name: string);
Parámetros:
  • token_name: string: nombre del token, que corresponde a la propiedad Token_name del modelo. El valor es el nombre de clase del token.
Ejemplo de valor devuelto:
[
 {
    "assetType": "otoken",
    "token_id": "digiCurr101",
    "token_name": "digicur",
    "token_desc": "Digital Currency equiv of dollar",
    "token_type": "fungible",
    "behaviors": [
        "divisible",
        "mintable",
        "transferable",
        "burnable",
        "roles"
    ],
    "roles": {
        "minter_role_name": "minter"
        "burner_role_name": "burner",
        "notary_role_name": "notary"
    },
    "mintable": {
        "max_mint_quantity": 2000
    },
    "divisible": {
        "decimal": 1
    },
    "currency_name": "DOLLAR",
    "token_to_currency_ratio": 1
 }
]
createAccount
Este método crea una cuenta para un usuario y token especificados. Todos los usuarios que tengan tokens en cualquier momento deben tener una cuenta.
Ctx.Account.createAccount(org_id: string, user_id: string, token_type: string, dailyLimits);
Parámetros:
  • org_id: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual. El ID debe empezar por un carácter alfanumérico y puede incluir letras, números y caracteres especiales, como guiones bajos (_), puntos (.), signos at (@) y guiones (-).
  • user_id: string: nombre de usuario o ID de correo electrónico del usuario. El ID debe empezar por un carácter alfanumérico y puede incluir letras, números y caracteres especiales, como guiones bajos (_), puntos (.), signos at (@) y guiones (-).
  • token_type: string: tipo del token, que debe ser fungible.
  • daily_limits: DailyLimits: objeto JSON del siguiente tipo.
    {
     "max_daily_amount": 100000
     "max_daily_transactions": 10000
 }
    En el ejemplo, el valor max_daily_amount es la cantidad máxima de tokens que se pueden realizar diariamente y el valor max_daily_transactions es el número máximo de transacciones que se pueden completar diariamente.
Ejemplo de valor devuelto:
{
    "bapAccountVersion": 0,
    "assetType": "oaccount",
    "account_id": "oaccount~b53cb2c19c92d1d5c8cb9f6e988e7761c34e03e014e6c4b889565fc0abf46c8a",
    "org_id": "CentralBank",
    "token_type": "fungible",
    "token_id": "",
    "token_name": "",
    "balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6",
    "onhold_balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6",
    "onhold_burn_balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6"
}
associateToken
Este método asocia un token fungible a una cuenta. 
Ctx.Account.associateToken(account_id: string, token_id: string, custom_account_id?: string);
Parámetros:
  • account_id: string: ID de la cuenta.
  • token_id: string: ID del token.
  • custom_account_id: string: para el modo confidencial, el ID de cuenta bancaria de la cuenta, un identificador alfanumérico aleatorio único. De forma predeterminada, tiene 14 caracteres.
Ejemplo de valor devuelto:
{
    "bapAccountVersion": 0,
    "assetType": "oaccount",
    "account_id": "oaccount~b53cb2c19c92d1d5c8cb9f6e988e7761c34e03e014e6c4b889565fc0abf46c8a",
    "org_id": "CentralBank",
    "token_type": "fungible",
    "token_id": "USD",
    "token_name": "cbdc",
    "balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6",
    "onhold_balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6",
    "onhold_burn_balance": "028b72742c8aa9a0395c828fe4f0e46226a3e40d4e731d0b994c8028c8b7bd4df6",
    "application_groups": [
        "CENTRAL_BANK_USERS"
    ]
}
getAllAccounts
Este método devuelve una lista de todas las cuentas. Este método utiliza consultas enriquecidas de Berkeley DB SQL y solo se puede llamar cuando se conecta a la red remota de Oracle Blockchain Platform.
this.Ctx.Account.getAllAccounts();
Parámetros:
  • ninguno
Ejemplo de valor devuelto:
[
    {
        "key": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
        "valueJson": {
            "bapAccountVersion": 3,
            "assetType": "oaccount",
            "account_id": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
            "org_id": "CentralBank",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "cbdc",
            "balance": "028a27c752e9b518d156e61da6589e723b179b6d7351dc34ec92bbb27b783ed1dc",
            "onhold_balance": "02d53a7eda9484bda7252212714f647b70d32663cfa416f93f488ef6b6bc8fb2eb",
            "onhold_burn_balance": "02d53a7eda9484bda7252212714f647b70d32663cfa416f93f488ef6b6bc8fb2eb",
            "application_groups": [
                "application_groups value"
            ]
        }
    },
    {
        "key": "oaccount~1da238c1491c919b151f777a615fb5779032c34b3ef3adeca6afe591bac10aaf",
        "valueJson": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~1da238c1491c919b151f777a615fb5779032c34b3ef3adeca6afe591bac10aaf",
            "org_id": "CentralBank",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "cbdc",
            "balance": "020da01cd57249c6470b6dd03c2ee4c49de58c71ccc64f2de1203e835967a0846d",
            "onhold_balance": "020da01cd57249c6470b6dd03c2ee4c49de58c71ccc64f2de1203e835967a0846d",
            "onhold_burn_balance": "020da01cd57249c6470b6dd03c2ee4c49de58c71ccc64f2de1203e835967a0846d",
            "application_groups": [
                "application_groups value"
            ]
        }
    }
]
getAllOrgAccounts
Este método devuelve una lista de todas las cuentas de token que pertenecen a una organización especificada.
Ctx.Account.getAllOrgAccounts(org_id: string);
Parámetros:
  • org_id: string: ID del proveedor de servicios de membresía (MSP) de la organización.
Ejemplo de valor devuelto:
[
    {
        "key": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
        "valueJson": {
            "bapAccountVersion": 2,
            "assetType": "oaccount",
            "account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
            "org_id": "CentralBank",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "cbdc",
            "balance": "18",
            "onhold_balance": "0",
            "onhold_burn_balance": "0",
            "application_groups": [
                "application_groups value"
            ],
            "user_id": "cb",
            "custom_account_id": "1234567jh"
        }
    },
    {
        "key": "oaccount~5e3b5a3306d7ca3f3e3fe7cc27b6ae547e94dba1c5af58a69a771d7a619b6a66",
        "valueJson": {
            "bapAccountVersion": 1,
            "assetType": "oaccount",
            "account_id": "oaccount~5e3b5a3306d7ca3f3e3fe7cc27b6ae547e94dba1c5af58a69a771d7a619b6a66",
            "org_id": "CentralBank",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "cbdc",
            "balance": "22",
            "onhold_balance": "0",
            "onhold_burn_balance": "0",
            "application_groups": [
                "application_groups value"
            ],
            "user_id": "cb1",
            "custom_account_id": "1234567jh"
        }
    }
]
getAccountsByUser
Este método devuelve una lista de todos los ID de cuenta para un usuario y una organización especificados.
Ctx.Account.getAccountsByUser(org_id: string, user_id: string);
Parámetros:
  • org_id string: ID del proveedor de servicios de membresía (MSP) de la organización.
  • user_id string: nombre de usuario o ID de correo electrónico del usuario.
Ejemplo de valor devuelto:
[
    {
        "bapAccountVersion": 2,
        "assetType": "oaccount",
        "user_id": "cb",
        "custom_account_id": "1234567jh",
        "account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
        "org_id": "CentralBank",
        "token_type": "fungible",
        "token_id": "token",
        "token_name": "cbdc",
        "balance": "18",
        "onhold_balance": "0",
        "onhold_burn_balance": "0",
        "application_groups": [
            "application_groups value"
        ]
    }
]
getUserByAccountId
Este método devuelve los detalles de usuario de una cuenta especificada.
this.Ctx.Account.getUserByAccountId(account_id: string);
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Ejemplo de valor devuelto:
{
    "token_id": "USD",
    "org_id": "CentralBank",
    "user_id": "cb_admin_demo",
    "custom_account_id": "10101234000123"
}
getAccountWithStatus
Este método devuelve los detalles de la cuenta para un usuario y token especificados.
Ctx.Account.getAccountWithStatus(account_id: string);
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Ejemplo de valor devuelto:
{
    "bapAccountVersion": 2,
    "assetType": "oaccount",
    "user_id": "cb",
    "custom_account_id": "1234567jh",
    "status": "active",
    "account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
    "org_id": "CentralBank",
    "token_type": "fungible",
    "token_id": "token",
    "token_name": "cbdc",
    "balance": "18",
    "onhold_balance": "0",
    "onhold_burn_balance": "0",
    "application_groups": [
        "application_groups value"
    ]
}
getAccountDetailsByCustomAccountId
Este método devuelve todos los detalles de cuenta de token para una organización y un ID de cuenta especificados.
Ctx.Account.getAccountDetailsByCustomAccountId(custom_account_id: string, org_id: string)
Parámetros:
  • custom_account_id: string: ID de cuenta bancaria de la cuenta, un identificador alfanumérico aleatorio único.
  • org_id string: ID del proveedor de servicios de membresía (MSP) de la organización.
Ejemplo de valor devuelto:
[
    {
        "bapAccountVersion": 0,
        "assetType": "oaccount",
        "account_id": "oaccount~c44ffac4c46718e9744cb0aae2016d26a87a5bef5e2d1c0d1abc7d8782f0ba61",
        "org_id": "CentralBank",
        "token_type": "fungible",
        "token_id": "USD",
        "token_name": "cbdc",
        "balance": "0",
        "onhold_balance": "0",
        "onhold_burn_balance": "0",
        "application_groups": [
            "SYSTEM_ADMINS"
        ],
        "user_id": "cb_admin_demo",
        "custom_account_id": "10101234000123"
    }
]
getAccountBalance
Este método devuelve el saldo de la cuenta para una cuenta especificada.
Ctx.Account.getAccountBalance(account_id: string);
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Ejemplo de valor devuelto:
{
    "msg": "Current Balance is: 100",
    "user_balance": 100
}
getAccountStatus
Este método obtiene el estado actual de la cuenta de token.
Ctx.AccountStatus.getAccountStatus(account_id: string);
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Ejemplo de valor devuelto:
{
    "assetType": "oaccountStatus",
    "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
    "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
    "status": "active"
}
history (Account Status)
Este método obtiene el historial del estado de la cuenta.
Ctx.AccountStatus.history(status_id: string);
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Ejemplo de valor devuelto:
[
  {
    "trxId": "d5c6d6f601257ba9b6edaf5b7660f00adc13c37d5321b8f7d3a35afab2e93e63",
    "timeStamp": "2025-12-02T10:39:14.000Z",
    "value": {
      "assetType": "oaccountStatus",
      "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
      "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
      "status": "suspended"
    }
  },
  {
    "trxId": "e6c850cfa084dc20ad95fb2bb8165eef3a3bd62a0ac867cccee57c2003125183",
    "timeStamp": "2025-12-02T10:37:50.000Z",
    "value": {
      "assetType": "oaccountStatus",
      "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
      "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
      "status": "active"
    }
  }
]
activateAccount
Este método activa una cuenta de token. Las cuentas eliminadas no se pueden activar.
Ctx.Account.activateAccount(account_id: string);
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Ejemplo de valor devuelto:
{
  "assetType": "oaccountStatus",
  "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
  "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
  "status": "active"
}
suspendAccount
Este método suspende una cuenta de token. Después de suspender una cuenta, no puede completar ninguna operación que actualice la cuenta. No se puede suspender una cuenta eliminada.
Ctx.Account.suspendAccount(account_id: string);
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Ejemplo de valor devuelto:
{
    "assetType": "oaccountStatus",
    "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
    "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
    "status": "suspended"
}
deleteAccount
Este método suprime una cuenta de token. 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 eliminar una cuenta, el saldo de cuenta y el saldo retenido deben ser cero.
Ctx.Account.deleteAccount(account_id: string);
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Ejemplo de valor devuelto:
{
  "assetType": "oaccountStatus",
  "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
  "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
  "status": "deleted"
}
setMaxDailyAmount
Este método define el valor max_daily_amount para una cuenta especificada. 
Ctx.Account.setMaxDailyAmount(account_id: string, max_daily_amount?: string);
Parámetros:
  • account_id: string: ID único de la cuenta de token.
  • max_daily_amount?: string: (opcional) cantidad máxima de tokens que el usuario puede transferir diariamente. Si no se especifica, el usuario puede transferir cualquier cantidad de tokens diariamente.
Ejemplo de valor devuelto:
{
           "msg": "Successfully set max daily amount for account id oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a to 1000000"
       }
setMaxDailyTransactionCount
Este método define el valor max_daily_transactions para una cuenta especificada. 
Ctx.Account.setMaxDailyTransactionCount(account_id: string, max_daily_transactions?: string);
Parámetros:
  • account_id: string: ID único de la cuenta de token.
  • max_daily_transactions?: string: (opcional) número máximo de transacciones que el usuario puede completar diariamente. Si no se especifica, el usuario puede completar cualquier número de transacciones diarias.
Ejemplo de valor devuelto:
{
            "msg": "Successfully set max daily transactions for account id oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a to 100000"
        }
getMaxDailyAmount
Este método obtiene el valor max_daily_amount (el importe máximo que se puede transferir diariamente) para una cuenta especificada. 
Ctx.Account.getMaxDailyAmount(account_id: string);
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Ejemplo de valor devuelto:
{
           "max_daily_amount": "10000"
       }
getMaxDailyTransactionCount
Este método obtiene el valor max_daily_transactions (número máximo de transacciones permitidas por día) para una cuenta especificada. 
Ctx.Account.getMaxDailyTransactionCount(account_id: string);
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Ejemplo de valor devuelto:
{
           "max_daily_transactions": "100"
       }
getAccountOnHoldBalance
Este método devuelve el saldo retenido de una cuenta especificada.
Ctx.Account.getAccountOnHoldBalance(account_id: string);
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Ejemplo de valor devuelto:
{
           "msg": "Total Holding Balance is: 0",
           "holding_balance": 0
       }
addRoleMember
Este método agrega un rol a una cuenta especificada.
Ctx.Token.addRoleMember(role: string, account_id: string, token_asset);
Parámetros:
  • account_id: number: ID de cuenta al que agregar el rol.
  • role: string: nombre del rol que se va a agregar al usuario especificado.
  • token_asset: any: el activo de token, que se transfiere como parámetro. Las propiedades del activo de token se describen en el archivo de modelo.
Ejemplo de valor devuelto:
{
     "msg": "Successfully added role 'notary' to Account Id: oaccount~2eb5f8a9bc561f8f41a4ea3be9511958cc6684ef14f2337ca396efc301b627d8"
}
removeRoleMember
Este método elimina un rol de una cuenta especificada.
Ctx.Token.removeRoleMember(role: string, account_id: string, token_asset);
Parámetros:
  • account_id: number: ID de cuenta del que eliminar el rol.
  • role: string: nombre del rol que se va a eliminar para el usuario especificado.
  • token_asset: any: el activo de token, que se transfiere como parámetro. Las propiedades del activo de token se describen en el archivo de modelo.
Ejemplo de valor devuelto:
{
   "msg": "Successfully removed role 'notary' from Account Id: oaccount~2eb5f8a9bc561f8f41a4ea3be9511958cc6684ef14f2337ca396efc301b627d8"
}
getAccountsByRole
Este método devuelve una lista de todas las cuentas para un rol y token especificados.
Ctx.Role.getAccountsByRole(token_id: string, role: string);
Parámetros:
  • token_id: string: ID del token.
  • role: string: nombre del rol que se va a buscar.
Ejemplo de valor devuelto:
{
           "accounts": [
               "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75"
           ]
       }
getOrgAccountsByRole
Este método devuelve información sobre todas las cuentas que tienen un rol especificado en una organización especificada.
Ctx.Role.getOrgAccountsByRole(token_id: string, role: string, org_id: string);
Parámetros:
  • token_id: string: ID del token.
  • role: string: nombre del rol que se va a comprobar.
  • org_id: string: ID del proveedor de servicios de membresía (MSP) de la organización.
Ejemplo de valor devuelto:
{
           "accounts": [
               "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75"
           ]
       }
getUsersByRole
Este método devuelve una lista de todos los usuarios para un rol y token especificados.
Ctx.Role.getUsersByRole(token_id: string, role: string);
Parámetros:
  • token_id: string: ID del token.
  • role: string: nombre del rol que se va a buscar.
Ejemplo de valor devuelto:
{
          "users": [
              {
                  "token_id": "token",
                  "org_id": "CentralBank"
              }
          ]
      }
getOrgUsersByRole
Este método devuelve información sobre todos los usuarios que tienen un rol especificado en una organización especificada. 
 Ctx.Role.getOrgUsersByRole(token_id: string, role: string, org_id: string);
Parámetros:
  • token_id: string: ID del token.
  • role: string: nombre del rol que se va a comprobar.
  • org_id: string: ID del proveedor de servicios de membresía (MSP) de la organización.
Ejemplo de valor devuelto:
{
           "users": [
               {
                   "token_id": "token",
                   "org_id": "CentralBank",
                   "user_id": "cb1",
                   "custom_account_id": "1234567jh"
               }
           ]
       }
isInRole
Este método indica si un usuario tiene un rol especificado.
Ctx.Token.isInRole(role: string, account_id: string, token_asset)
Parámetros:
  • account_id: number: ID único de la cuenta de token.
  • role: string: nombre del rol que se va a comprobar.
  • token_asset: any: el activo de token, que se transfiere como parámetro. Las propiedades del activo de token se describen en el archivo de modelo.
Ejemplo de valor devuelto:
{
           "result": "true"
       }
getAccountTransactionHistory
Este método devuelve una matriz de los detalles del historial de transacciones de una cuenta especificada.
Ctx.Account.getAccountTransactionHistory(account_id: string)
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Ejemplo de valor devuelto:
[
    {
        "transaction_id": "otransaction~4514aa229ebcc4d2fedcaa47c4301615e30c4a9bae45cf0256a5b80d75b3697a",
        "transacted_amount": 1000,
        "timestamp": "2025-08-25T13:20:50.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "APPROVE_MINT",
        "balance": 21000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~1982f73495060e0eef4d78282a91c41e27e8c95572739b0677a1e404a0d20aa9",
        "transacted_amount": 200,
        "timestamp": "2025-08-25T13:12:43.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "REQUEST_MINT",
        "balance": 20000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~fedd714cf1509f7517819d7cd4c0921d0b2f5d1ff6a25dcb08ab411defd6b5f3",
        "transacted_amount": 2000,
        "timestamp": "2025-08-21T05:23:25.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "REQUEST_MINT",
        "balance": 20000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~f33b47234f3ee0b636962c8c31c01d06523b789ca16b3b342d5080b71268bcc3",
        "transacted_amount": 1000,
        "timestamp": "2025-08-21T05:23:07.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "REQUEST_MINT",
        "balance": 20000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~cf934527149bc24f62a8ddeeea7f74a19a0f84d8f161535a771be49d2520d5b3",
        "transacted_amount": 10000,
        "timestamp": "2025-08-13T06:12:41.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "APPROVE_MINT",
        "balance": 20000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~f5c0e11ca61d9adc843658929e6de2a738ad586304f9e020f75bf4aac5e42a2c",
        "transacted_amount": 10000,
        "timestamp": "2025-08-13T06:12:04.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "REQUEST_MINT",
        "balance": 10000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~862aa9d9e877d3ea209b87299ab5b12c13ed5ce43d1cf1b934043c1dd02f58f6",
        "transacted_amount": 50000,
        "timestamp": "2025-08-12T21:04:22.000Z",
        "token_id": "USD",
        "category": "transfer",
        "transacted_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "transaction_type": "DEBIT",
        "balance": 10000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~8a74c6d87ca74a613aab9db5d40386f8d5b534f9800503af8ca27e8946d7616d",
        "transacted_amount": 40000,
        "timestamp": "2025-08-12T21:01:27.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "REJECT_MINT",
        "balance": 60000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~28ac66ba33f7ad0648448964b2b74525c9e3f0c9908c7a0484690b9baa56c2db",
        "transacted_amount": 30000,
        "timestamp": "2025-08-12T21:01:16.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "APPROVE_MINT",
        "balance": 60000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~7e32ad8f365ff59814e112f27602f30ab599fb9c1638784496c66a61a6277c22",
        "transacted_amount": 20000,
        "timestamp": "2025-08-12T21:01:05.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "APPROVE_MINT",
        "balance": 30000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~1477050bb9e55f4f471872b31fce0d2097f5d5e57d89a842070df5e36d7ab0da",
        "transacted_amount": 10000,
        "timestamp": "2025-08-12T21:01:03.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "APPROVE_MINT",
        "balance": 10000,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~0e76c6931b7ee134e967e847d9730b867a0fd191d39697d83d36dd15745c02e3",
        "transacted_amount": 40000,
        "timestamp": "2025-08-12T21:00:20.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "REQUEST_MINT",
        "balance": 0,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~07bbf9c190694371626da59ded5d87434d26f612891e13bb15bdd28f6086e760",
        "transacted_amount": 30000,
        "timestamp": "2025-08-12T21:00:01.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "REQUEST_MINT",
        "balance": 0,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~8721175c6cbbce17b6c4bb6a444e475d07f52352dfd0d990679f342215153513",
        "transacted_amount": 20000,
        "timestamp": "2025-08-12T20:59:41.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "REQUEST_MINT",
        "balance": 0,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~dc24c24d43a6525e807a39edcf8c6a2b6ccb81f0d755958f509509687eacee84",
        "transacted_amount": 10000,
        "timestamp": "2025-08-12T20:59:13.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "REQUEST_MINT",
        "balance": 0,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~396e6ca5a11a9609632d0864026409d46a708fb95e3e21b39fa5f3fb78f90872",
        "transacted_amount": 0,
        "timestamp": "2025-08-12T20:43:20.000Z",
        "token_id": "",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transaction_type": "CREATE_ACCOUNT",
        "balance": 0,
        "onhold_balance": 0
    }
]
getAccountTransactionHistoryWithFilters
Este método devuelve una matriz de los detalles del historial de transacciones de una cuenta especificada. Este método solo se puede llamar cuando está conectado a la red remota de Oracle Blockchain Platform.
Ctx.Account.getAccountTransactionHistoryWithFilters(account_id: string, org_id: string, filters);
Parámetros:
  • account_id: string: ID de la cuenta.
  • org_id: string: ID del proveedor de servicios de membresía (MSP) de la organización.
  • filters: string: parámetro opcional. Si está vacío, se devuelven todos los registros. La propiedad PageSize determina el número de registros que se devolverán. Si PageSize es 0, el tamaño de página por defecto es 20. La propiedad Bookmark determina el índice inicial de los registros que se van a devolver. Para obtener más información, consulte la documentación de Hyperledger Fabric. Las propiedades StartTime y EndTime se deben especificar en formato RFC-3339.
Ejemplo de valor devuelto:
[
             {
                "transaction_id": "otransaction~ccc2c2e89ab7887af4fdad3dc9918ea057a8aa834a0ed8d0f23271049f084952",
                "transacted_amount": 8,
                "timestamp": "2025-08-20T23:22:53.000Z",
                "token_id": "token",
                "category": "category value",
                "description": "description value",
                "holding_id": "ohold~cbdc~token~hold1",
                "to_account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
                "to_org_id": "Org1",
                "to_user_id": "cb",
                "to_custom_account_id": "1234567jh",
                "from_account_id": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
                "from_org_id": "CentralBank",
                "from_user_id": "Not Available",
                "from_custom_account_id": "Not Available",
                "transacted_account": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
                "transaction_type": "CREDIT",
                "balance": 18,
                "onhold_balance": 0,
                "transacted_org_id": "CentralBank",
                "transacted_user_id": "Not Available",
                "transacted_custom_account_id": "Not Available"
            },
            {
                "transaction_id": "otransaction~6c0452a58f13db93f1c308d60eab1fde6c911921b350c0bbbe0ce7dab394721d",
                "transacted_amount": 10,
                "timestamp": "2025-08-20T23:04:53.000Z",
                "token_id": "token",
                "category": "category value",
                "description": "description value",
                "holding_id": "ohold~cbdc~token~hold1",
                "to_account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
                "to_org_id": "Org1",
                "to_user_id": "cb",
                "to_custom_account_id": "1234567jh",
                "from_account_id": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
                "from_org_id": "CentralBank",
                "from_user_id": "Not Available",
                "from_custom_account_id": "Not Available",
                "transacted_account": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
                "transaction_type": "CREDIT",
                "balance": 10,
                "onhold_balance": 0,
                "transacted_org_id": "CentralBank",
                "transacted_user_id": "Not Available",
                "transacted_custom_account_id": "Not Available"
            },
            .
            .
            .
            .
            {
                "transaction_id": "otransaction~df98e24a3b90661b54b54289b600b13a1051c922db0a4d20e3705a9820ae9c20",
                "transacted_amount": 0,
                "timestamp": "2025-08-20T22:55:09.000Z",
                "category": "",
                "description": "",
                "from_account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
                "from_org_id": "Org1",
                "from_user_id": "cb",
                "from_custom_account_id": "1234567jh",
                "transacted_account": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
                "transaction_type": "CREATE_ACCOUNT",
                "balance": 0,
                "onhold_balance": 0,
                "transacted_org_id": "Org1",
                "transacted_user_id": "cb",
                "transacted_custom_account_id": "1234567jh"
            }
 ]
getAccountTrxHistoryWithFiltersFromRichHistDB
Este método devuelve una matriz de los detalles del historial de transacciones de la base de datos de historial enriquecido.
Ctx.Account.getAccountTrxHistoryWithFiltersFromRichHistDB(account_id: string, org_id: string, custom_endpoint: string, bearer_token: string, filters);
Parámetros:
  • account_id: string: ID único de la cuenta de token.
  • org_id: string: ID del proveedor de servicios de membresía (MSP) de la organización.
  • custom_endpoint: punto final de servicio RESTful de la base de datos de historial enriquecida.
  • bearer_token: token de autorización de acceso para el punto final de servicio RESTful.
  • filters: string: parámetro opcional. Si está vacío, se devuelven todos los registros. La propiedad PageSize determina el número de registros que se devolverán. Si PageSize es 0, el tamaño de página por defecto es 20. La propiedad Bookmark determina el índice inicial de los registros que se van a devolver. Para obtener más información, consulte la documentación de Hyperledger Fabric. Las propiedades StartTime y EndTime se deben especificar en formato RFC-3339.
Ejemplo de valor devuelto:
[
    {
        "transaction_id": "otransaction~3140569a4ecb3c3f141cc2468fe21276640b7fd79013d951d9104b79072d8f9c",
        "transacted_amount": 200,
        "timestamp": "2025-08-25T13:16:55.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_officer_demo",
        "transacted_custom_account_id": "20200222221111",
        "to_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "to_org_id": "Org1",
        "to_user_id": "fi1_org_officer_demo",
        "to_custom_account_id": "20200222221111",
        "from_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "from_org_id": "CentralBank",
        "from_user_id": "cb_issuer_demo",
        "from_custom_account_id": "10109999001234",
        "transaction_type": "EXECUTEHOLD",
        "category": "transfer",
        "balance": 26800,
        "onhold_balance": 300
    },
    {
        "transaction_id": "otransaction~5112f576c94c2d23c342479bfa37e34612414b3258a64b43cf51b920f4ff5868",
        "transacted_amount": 5000,
        "timestamp": "2025-08-12T21:05:02.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98",
        "transacted_org_id": "CentralBank",
        "transacted_user_id": "cb_retirer_demo",
        "transacted_custom_account_id": "10109999006543",
        "to_account": "oaccount~cea6080858337b1575d6a76ed0bd07a0eacd8871e3f2f7f793729a0e4b0e8e98",
        "to_org_id": "CentralBank",
        "to_user_id": "cb_retirer_demo",
        "to_custom_account_id": "10109999006543",
        "from_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "from_org_id": "CentralBank",
        "from_user_id": "cb_issuer_demo",
        "from_custom_account_id": "10109999001234",
        "transaction_type": "DEBIT",
        "category": "burn",
        "balance": 45000,
        "onhold_balance": 0
    },
    .  
    .
    .
    .
    {
        "transaction_id": "otransaction~862aa9d9e877d3ea209b87299ab5b12c13ed5ce43d1cf1b934043c1dd02f58f6",
        "transacted_amount": 50000,
        "timestamp": "2025-08-12T21:04:22.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "transacted_org_id": "CentralBank",
        "transacted_user_id": "cb__creator_demo",
        "transacted_custom_account_id": "10105678004567",
        "to_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "to_org_id": "CentralBank",
        "to_user_id": "cb_issuer_demo",
        "to_custom_account_id": "10109999001234",
        "from_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "from_org_id": "CentralBank",
        "from_user_id": "cb__creator_demo",
        "from_custom_account_id": "10105678004567",
        "transaction_type": "CREDIT",
        "category": "transfer",
        "balance": 50000,
        "onhold_balance": 0
    }
]
getOrgAccountsTrxHistoryWithFiltersFromRichHistDB
Este método devuelve una matriz de los detalles del historial de transacciones de una organización especificada de la base de datos de historial enriquecido.
Ctx.Account.getOrgAccountsTrxHistoryWithFiltersFromRichHistDB(org_id: string, custom_endpoint: string, bearer_token: string, filters);
Parámetros:
  • org_id string: ID del proveedor de servicios de membresía (MSP) de la organización.
  • custom_endpoint: punto final de servicio RESTful de la base de datos de historial enriquecida.
  • bearer_token: token de autorización de acceso para el punto final de servicio RESTful.
  • filters: string: parámetro opcional. Si está vacío, se devuelven todos los registros. La propiedad PageSize determina el número de registros que se devolverán. Si PageSize es 0, el tamaño de página por defecto es 20. La propiedad Bookmark determina el índice inicial de los registros que se van a devolver. Para obtener más información, consulte la documentación de Hyperledger Fabric. Las propiedades StartTime y EndTime se deben especificar en formato RFC-3339.
Ejemplo de valor devuelto:
[
    {
        "transaction_id": "otransaction~4793f3907eefce2f9fca7ef107405b0f116efb3afbf83fa0e61fe763690c8235",
        "transacted_amount": 100,
        "timestamp": "2025-08-25T13:47:56.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_officer_demo",
        "transacted_custom_account_id": "20200222221111",
        "to_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "to_org_id": "CentralBank",
        "from_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "from_org_id": "Org1",
        "from_user_id": "fi1_org_officer_demo",
        "from_custom_account_id": "20200222221111",
        "transaction_type": "ONHOLD",
        "holding_id": "ohold~cbdc~USD~2ac01689",
        "category": "issuance"
    },
    {
        "transaction_id": "otransaction~5177f7560d32838242a26ac74f2a90c6ff9b47aae0d0988f28d9b4cf7e27c097",
        "transacted_amount": 10,
        "timestamp": "2025-08-25T13:22:23.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~1e31495a0c149b08cb9d02bdcac5e83d88c0f1557d954dda12bb807d7f6fc111",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_user1_demo",
        "transacted_custom_account_id": "20200198765432",
        "to_account": "oaccount~d08ff55a040d5e5dcf406009bab1b3398e06c374356efb1bddbf2f17fc37f949",
        "to_org_id": "Org1",
        "to_user_id": "fi1_org_user2_demo",
        "to_custom_account_id": "20200211112222",
        "from_account": "oaccount~1e31495a0c149b08cb9d02bdcac5e83d88c0f1557d954dda12bb807d7f6fc111",
        "from_org_id": "Org1",
        "from_user_id": "fi1_org_user1_demo",
        "from_custom_account_id": "20200198765432",
        "transaction_type": "CREDIT",
        "holding_id": "ohold~cbdc~USD~454f4bf6",
        "category": "transfer"
    },
    .
    .
    .
    .
    {
        "transaction_id": "otransaction~b7c97d737fb978651c9132276ab677c0bcf795b9db13d0d39cba5243615c7389",
        "transacted_amount": 10,
        "timestamp": "2025-08-21T08:46:09.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_officer_demo",
        "transacted_custom_account_id": "20200222221111",
        "to_account": "oaccount~1e31495a0c149b08cb9d02bdcac5e83d88c0f1557d954dda12bb807d7f6fc111",
        "to_org_id": "Org1",
        "to_user_id": "fi1_org_user1_demo",
        "to_custom_account_id": "20200198765432",
        "from_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "from_org_id": "Org1",
        "from_user_id": "fi1_org_officer_demo",
        "from_custom_account_id": "20200222221111",
        "transaction_type": "ONHOLD",
        "holding_id": "ohold~cbdc~USD~4fbbb846",
        "category": "transfer"
    }
]
getAllAccountsTrxHistoryWithFiltersFromRichHistDB
Este método devuelve una matriz de los detalles del historial de transacciones de todas las organizaciones de la base de datos de historial enriquecido.
Ctx.Account.getAllAccountsTrxHistoryWithFiltersFromRichHistDB(custom_endpoint: string, bearer_token: string, filters);
Parámetros:
  • org_id string: ID del proveedor de servicios de membresía (MSP) de la organización.
  • custom_endpoint: punto final de servicio RESTful de la base de datos de historial enriquecida.
  • bearer_token: token de autorización de acceso para el punto final de servicio RESTful.
  • filters: string: parámetro opcional. Si está vacío, se devuelven todos los registros. La propiedad PageSize determina el número de registros que se devolverán. Si PageSize es 0, el tamaño de página por defecto es 20. La propiedad Bookmark determina el índice inicial de los registros que se van a devolver. Para obtener más información, consulte la documentación de Hyperledger Fabric. Las propiedades StartTime y EndTime se deben especificar en formato RFC-3339.
Ejemplo de valor devuelto:
[
    {
        "transaction_id": "otransaction~62eb436be7c29fc2ed9cae221e874d9a31b163fa10374e7da09bf5e09a96c3ff",
        "transacted_amount": 10000,
        "timestamp": "2025-08-25T13:57:58.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "transacted_org_id": "CentralBank",
        "transacted_user_id": "cb_issuer_demo",
        "transacted_custom_account_id": "10109999001234",
        "to_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "to_org_id": "CentralBank",
        "to_user_id": "cb_issuer_demo",
        "to_custom_account_id": "10109999001234",
        "from_account": "oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41",
        "from_org_id": "CentralBank",
        "from_user_id": "cb__creator_demo",
        "from_custom_account_id": "10105678004567",
        "transaction_type": "DEBIT",
        "category": "issuance"
    },
    {
        "transaction_id": "otransaction~4793f3907eefce2f9fca7ef107405b0f116efb3afbf83fa0e61fe763690c8235",
        "transacted_amount": 100,
        "timestamp": "2025-08-25T13:47:56.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_officer_demo",
        "transacted_custom_account_id": "20200222221111",
        "to_account": "oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a",
        "to_org_id": "CentralBank",
        "to_user_id": "cb_issuer_demo",
        "to_custom_account_id": "10109999001234",
        "from_account": "oaccount~76687c724ddbc2d6e6664d9618b2bf1c2a9fe10f84887462447e4caba6aaaff3",
        "from_org_id": "Org1",
        "from_user_id": "fi1_org_officer_demo",
        "from_custom_account_id": "20200222221111",
        "transaction_type": "ONHOLD",
        "holding_id": "ohold~cbdc~USD~2ac01689",
        "category": "issuance"
    },
    .
    .
    .
    .
    {
        "transaction_id": "otransaction~5177f7560d32838242a26ac74f2a90c6ff9b47aae0d0988f28d9b4cf7e27c097",
        "transacted_amount": 10,
        "timestamp": "2025-08-25T13:22:23.000Z",
        "token_id": "USD",
        "transacted_account": "oaccount~d08ff55a040d5e5dcf406009bab1b3398e06c374356efb1bddbf2f17fc37f949",
        "transacted_org_id": "Org1",
        "transacted_user_id": "fi1_org_user2_demo",
        "transacted_custom_account_id": "20200211112222",
        "to_account": "oaccount~d08ff55a040d5e5dcf406009bab1b3398e06c374356efb1bddbf2f17fc37f949",
        "to_org_id": "Org1",
        "to_user_id": "fi1_org_user2_demo",
        "to_custom_account_id": "20200211112222",
        "from_account": "oaccount~1e31495a0c149b08cb9d02bdcac5e83d88c0f1557d954dda12bb807d7f6fc111",
        "from_org_id": "Org1",
        "from_user_id": "fi1_org_user1_demo",
        "from_custom_account_id": "20200198765432",
        "transaction_type": "EXECUTEHOLD",
        "holding_id": "ohold~cbdc~USD~454f4bf6",
        "category": "transfer"
    }
]
consolidateRunningBalanceInTransactions
Este método calcula los saldos de cuenta en ejecución y guarda los valores actualizados en los pares de clave/valor de transacción. Normalmente, los administradores del sistema llaman a este método mediante un programador de proxy REST.
Ctx.Transaction.consolidateRunningBalanceInTransactions(save: boolean);
Ejemplo de valor devuelto:
{ msg: "Successfully updated account running balance for pending transactions."}
processSendersAndReceivers
Este método calcula y actualiza los saldos de cuenta de token que se distribuyen en los pares de clave/valor de remitente y receptor que se crearon durante las transferencias entre organizaciones y, a continuación, suprime los pares de clave/valor de remitente y receptor, que ya no se utilizan. Normalmente, los administradores del sistema llaman a este método mediante un programador de proxy REST. 
Ctx.Account.processSendersAndReceivers(save: boolean);
Ejemplo de valor devuelto:
{ msg: "Successfully updated balance for accounts from pending receivers."}
deleteTransactions
Este método suprime las transacciones más antiguas de la base de datos de estado.
Ctx.Transaction.deleteTransactions(time_to_expiration: Date);
Parámetros:
  • time_to_expiration: Date: registro de hora que indica cuándo se deben suprimir las transacciones. Se suprimirán los activos de transacción que sean anteriores a la hora especificada.
Ejemplo de valor devuelto:
{
    "msg": "Successfully deleted transaction older than date: Thu Aug 19 2025 11:19:36 GMT+0000 (Coordinated Universal Time).",
    "transactions": [
           "otransaction~ec3366dd48b4ce2838f820f2f138648e6e55a07226713e59b411ff31b0d21058"
     ]
}
getTransactionById
Este método devuelve el historial de un activo Transaction. 
Ctx.Transaction.getTransactionById(transaction_id: string);
Parámetros:
  • transaction_id string: ID del activo de transacción.
Ejemplo de valor devuelto:
{
    "transaction_id": "otransaction~6523597253e45b3c976aecdc54e2c6316d0a4f88ad5d7f3fff48c69213e4375a",
    "history": [
        {
            "trxId": "6523597253e45b3c976aecdc54e2c6316d0a4f88ad5d7f3fff48c69213e4375a",
            "timeStamp": "2025-08-20T23:21:45.000Z",
            "value": {
                "assetType": "otransaction",
                "transaction_id": "otransaction~6523597253e45b3c976aecdc54e2c6316d0a4f88ad5d7f3fff48c69213e4375a",
                "token_id": "token",
                "from_account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
                "to_account_id": "oaccount~5e3b5a3306d7ca3f3e3fe7cc27b6ae547e94dba1c5af58a69a771d7a619b6a66",
                "transaction_type": "TRANSFER",
                "amount": 22,
                "timestamp": "2025-08-20T23:21:45.000Z",
                "number_of_sub_transactions": 0,
                "holding_id": "",
                "sub_transaction": "false",
                "category": "category value",
                "description": "description value"
            }
        }
    ],
    "sub_transactions": []
}
issueTokens
Minters puede llamar a este método para crear una cantidad específica de tokens.
this.Ctx.Token.mint(quantity, token_asset, info_details)
Parámetros:
  • token_id: string: ID del token.
  • quantity: el número de tokens que se deben acuñar.
  • info_details: JSON: objeto que especifica la categoría (category) y la descripción (description) de la solicitud.

    Puede especificar el parámetro info_details en un formato diferente si utiliza Visual Studio Code frente a la CLI o una recopilación Postman.

    Código de Visual Studio: { "category": "category value", "description": "description value" }

    CLI/Postman: "{\"category\":\"category value\",\"description\":\"description value\"}"

Ejemplo de valor devuelto:
{
          "msg": "Successfully minted 1000 tokens to Account Id: oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41"
      }
getTotalMintedTokens
Este método devuelve el número total de tokens acuñados.
Ctx.Token.getTotalMintedTokens(token_asset);
Parámetros:
  • token_asset: any: el activo de token, que se transfiere como parámetro. Las propiedades del activo de token se describen en el archivo de modelo.
Ejemplo de valor devuelto:
{
    "msg": "Total minted token for Token Id: USD is 910 tokens.",
    "quantity": 910
}
getNetTokens
Este método devuelve la cantidad neta de tokens que están disponibles en el sistema. Los tokens netos son la cantidad de tokens que quedan después de que los tokens se queman. En forma de ecuación: tokens netos = tokens totales acuñados - tokens totales quemados. Si no se queman tokens, el número de tokens netos es igual al total de tokens acuñados.
Ctx.Token.getNetTokens(token_asset);
Parámetros:
  • token_asset: any: el activo de token, que se transfiere como parámetro. Las propiedades del activo de token se describen en el archivo de modelo.
Ejemplo de valor devuelto:
{
    "msg": "Net supply of token for Token Id: USD is 878 tokens.",
    "quantity": 878
}
transferTokens
Este método transfiere tokens del emisor de llamada a una cuenta especificada. El emisor de llamada del método debe tener una cuenta. La cantidad debe estar dentro de los valores decimales especificados por el parámetro decimal del comportamiento divisible en el archivo de especificación. 
this.Ctx.Token.transfer(to_account_id: string, quantity, token_asset, info_details);
Parámetros:
  • to_account_id: string: ID de cuenta del receptor (beneficiario).
  • quantity: number: número de tokens que se van a transferir.
  • info_details: JSON: objeto que especifica la categoría (category) y la descripción (description) de la solicitud.

    Puede especificar el parámetro info_details en un formato diferente si utiliza Visual Studio Code frente a la CLI o una recopilación Postman.

    Código de Visual Studio: { "category": "category value", "description": "description value" }

    CLI/Postman: "{\"category\":\"category value\",\"description\":\"description value\"}"

Ejemplo de valor devuelto:
{
          "msg": "Successfully transferred 10000 tokens from account id: oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41  to account id: oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a."
      }
hold
Este método es utilizado por el minter para enviar una solicitud al notario minter para crear una cantidad especificada de tokens. La cuenta notarial especificada es responsable de completar o liberar la retención.
Ctx.Hold.hold(operation_id: string, to_account_id: string, notary_account_id: string, quantity: number, time_to_expiration: Date, token, type: HoldOperationType, info_details?: InfoDetails)
Parámetros:
  • operation_id: string: ID único para identificar la operación de retención. Normalmente, la aplicación cliente transfiere este ID.
  • to_account_id: string: ID de la cuenta del destinatario.
  • notary__account_id: string: ID de la cuenta de notario.
  • quantity: number: número total de tokens que se deben retener.
  • time_to_expiration: Date: la duración hasta que caduque la retención. Especifique 0 para una retención permanente. De lo contrario, utilice el formato RFC-3339. Por ejemplo, 2021-06-02T12.
  • token: any: el activo de token, que se transfiere como parámetro. Las propiedades del activo de token se describen en el archivo de modelo.
  • type: HoldOperationType: tipo de operación de retención que se debe solicitar. Debe ser uno de los tres valores posibles, MINT, BURN o TRANSFER.
  • info_details: JSON: objeto que especifica la categoría (category) y la descripción (description) de la solicitud.

    Puede especificar el parámetro info_details en un formato diferente si utiliza Visual Studio Code frente a la CLI o una recopilación Postman.

    Código de Visual Studio: { "category": "category value", "description": "description value" }

    CLI/Postman: "{\"category\":\"category value\",\"description\":\"description value\"}"

Ejemplo de valor devuelto:
{
           "msg": "AccountId oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41 has successfully submitted request to mint 200 tokens"
       }
executeHold
Los notarios pueden llamar a este método para aprobar una operación de retención, que puede ser uno de tres tipos: menta, quemadura o transferencia.
Ctx.Hold. executeHold(operation_id: string, token, operation_type: HoldOperationType, quantity? :number)
Parámetros:
  • operation_type: HoldOperationType: tipo de operación de retención que se debe aprobar. Debe ser uno de los tres valores posibles, MINT, BURN o TRANSFER.
  • quantity: number: (opcional) solo para operaciones de transferencia, el importe aprobado que se va a transferir al destinatario.
  • token: any: el activo de token, que se transfiere como parámetro. Las propiedades del activo de token se describen en el archivo de modelo.
  • operation_id: string: ID único de la solicitud.
Ejemplo de valor devuelto:
{
           "msg": "Successfully minted 1000 tokens to Account Id: oaccount~da6e14466a0ba9b48ebc18fa672addb92dffc371bf953c3229a95b2ff2d9cd41"
       }
releaseHold
Los notarios pueden llamar a este método para rechazar una operación de retención, que puede ser uno de tres tipos: menta, quemadura o transferencia.
Ctx.Hold.releaseHold(operation_id: string, token, operation_type: HoldOperationType)
Parámetros:
  • operation_type: HoldOperationType: tipo de operación de retención que se va a rechazar. Debe ser uno de los tres valores posibles, MINT, BURN o TRANSFER.
  • token: any: el activo de token, que se transfiere como parámetro. Las propiedades del activo de token se describen en el archivo de modelo.
  • operation_id: string: ID único de la solicitud.
Ejemplo de valor devuelto:
{
           "msg": "Successfully rejected mint request with Operation Id '89ce' to mint 2000 tokens of token id USD"
       }
getOnHoldIds
Este método devuelve una lista de todos los IDs de retención de una cuenta especificada.
Ctx.Account.getOnHoldIds(account_id: string);
Parámetros:
  • account_id: string: ID único de la cuenta de token.
Ejemplo de valor devuelto:
{
           "msg": "Holding Ids are: ",
           "holding_ids": ["ohold~cbdc~token~hold1"]
       }
getOnHoldDetailsWithOperationId
Este método devuelve los detalles de la transacción retenida para un token e ID de operación especificados.
Ctx.Hold.getOnHoldDetailsWithOperationId(token_id: string, operation_id: string);
Parámetros:
  • token_id: string: ID del token.
  • operation_id: string: ID único que identifica la operación de retención.
Ejemplo de valor devuelto:
{
          "assetType": "ohold",
          "holding_id": "ohold~cbdc~token~hold1",
          "operation_id": "hold1",
          "token_name": "cbdc",
          "from_org_id": "CentralBank",
          "operation_type": "transfer",
          "status": "approved",
          "from_account_id": "oaccount~5abb4155f4b245bb1732321e3174ac81999b03495b5c74f8e1f270bafbadef75",
          "to_account_id": "oaccount~22776ada3efff6aaf4c68c204c1f063b139adfa1bca79ed53199117c34036cfc",
          "notary_account_id": "oaccount~1da238c1491c919b151f777a615fb5779032c34b3ef3adeca6afe591bac10aaf",
          "token_id": "token",
          "quantity": "0",
          "time_to_expiration": "2029-01-04T00:00:00.000Z",
          "category": "category value",
          "description": "description value"
      }
getOnHoldBalanceWithOperationId
Este método devuelve el saldo retenido para un token e ID de operación especificados. Este método puede ser llamado por cualquiera.
Ctx.Hold.getOnHoldBalanceWithOperationId(token_id: string, operation_id: string);
Parámetros:
  • token_id: string: ID del token.
  • operation_id: string: ID único que identifica la operación de retención.
Ejemplo de valor devuelto:
{
           "msg": "Current Holding Balance of Operation 'hold1' for token 'token' is: 0",
           "holding_balance": 0
       }

TypeScript Métodos de SDK para transferencias entre organizaciones

Las transferencias entre organizaciones tienen dos partes: en primer lugar, el importe se carga del remitente y, a continuación, el importe se abona al receptor. Las dos API siguientes se llaman juntas como una transacción atómica mediante la API de confirmación en dos fases del proxy de REST de Oracle Blockchain Platform. Las transferencias confidenciales se realizan de esta manera porque las recopilaciones de datos privados de las dos organizaciones son distintas y no se puede acceder a ellas en una sola transacción.

executeHoldTokensSender
Este método solo puede ser llamado por el usuario con el rol de notario para el ID de operación especificado. Este método es la primera parte de la aprobación de un traslado entre organizaciones. El importe especificado se deduce de la cuenta del remitente.
Ctx.Hold.executeHoldSender(operation_id: string, quantity, globalTxId: string, token: any);
Parámetros:
  • token: any: el activo de token, que se transfiere como parámetro. Las propiedades del activo de token se describen en el archivo de modelo.
  • operation_id: string: ID de operación único que representa la solicitud de retención que se debe aprobar.
  • quantity: number: cantidad de tokens retenidos para transferir.
  • globalTxid: string: ID de transacción global generado por el proxy REST para una solicitud de confirmación en dos fases, que en este caso se utiliza como referencia común que enlaza las operaciones de débito y crédito en una transferencia entre organizaciones.
Ejemplo de valor devuelto:
{
      "msg":
        "Account Id: oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a is successfully executed '10' tokens from Operation Id 'hold1'."
    }
executeHoldTokensReceiver
Este método solo puede ser llamado por el usuario con el rol de notario para el ID de operación especificado. Este método es la segunda parte de la aprobación de un traslado entre organizaciones. El importe especificado se acredita en la cuenta del receptor.
Ctx.Hold.executeHoldReceiver(operation_id: string, quantity, globalTxId: string, token: any);
Parámetros:
  • token: any: el activo de token, que se transfiere como parámetro. Las propiedades del activo de token se describen en el archivo de modelo.
  • operation_id: string: ID de operación único que representa la solicitud de retención que se debe aprobar.
  • quantity: number: cantidad de tokens retenidos para transferir.
  • globalTxid: string: ID de transacción global generado por el proxy REST para una solicitud de confirmación en dos fases, que en este caso se utiliza como referencia común que enlaza las operaciones de débito y crédito en una transferencia entre organizaciones.
Ejemplo de valor devuelto:
{
      "msg":
        "Account Id: oaccount~68d67712f500e9dac8c314c19744003a993250271d960e9b0d25267bb18dfe9a is successfully executed '10' tokens from Operation Id 'hold1, receiverId oreceiver~72d9bfcf-2c68-4c33-b8c3-fe3374983bf2'."
    }