Proyecto TypeScript andamiado para el marco de taxonomía de token

Blockchain App Builder toma la entrada de su archivo de especificación de token y genera un proyecto de código de cadena de andamios totalmente funcional.

El proyecto genera automáticamente clases y funciones de ciclo de vida de token, incluidos los métodos CRUD y no CRUD. La validación de argumentos, la canalización/anulación de canalización y la capacidad de persistencia transparente se admiten automáticamente.

Para obtener información sobre el proyecto andamiaje y los métodos que no están directamente relacionados con los tokens, consulte Scaffolded TypeScript Chaincode Project.

Referencia:

• Modelo
• Controlador
  • Métodos de token generados automáticamente
  • Métodos personalizados
• Métodos de SDK de token

Modelo

Cada clase de modelo con token amplía la clase Token, que a su vez amplía la clase OchainModel. La clase Token se importa desde ../lib/token. La capacidad de persistencia transparente, o ORM simplificado, se captura en la clase OchainModel.

import * as yup from 'yup';
import { Id, Mandatory, Validate, ReadOnly } from '../lib/decorators';
import { Token } from '../lib/token';
 
@Id('token_id')
export class Digicur extends Token<Digicur> {
 
    public readonly assetType = 'otoken';
 
    @Mandatory()
    @Validate(yup.string().required().matches(/^[A-Za-z0-9][A-Za-z0-9_-]*$/).max(16))
    public token_id: string;
 
    @ReadOnly('digicur')
    public token_name: string;
 
    @Validate(yup.string().trim().max(256))
    public token_desc: string;
 
    @ReadOnly('fungible')
    public token_type: string;
 
    @ReadOnly(["divisible","mintable","transferable","burnable","holdable","roles"])
    public behaviors: string[];
 
    @ReadOnly({minter_role_name: "minter", burner_role_name: "burner", notary_role_name: "notary"})
    public roles: object;
 
    @ReadOnly({max_mint_quantity: 20000})
    public mintable: object;
 
    @ReadOnly({decimal: 1})
    public divisible: object;
 
    @Validate(yup.number())
    public token_to_currency_ratio: number;
 
    @Validate(yup.string())
    public currency_representation: string;
 
}

Controlador

La clase de controlador principal amplía la clase OchainController. Solo hay un controlador principal.

export class DigiCurrCCController extends OchainController{

Puede crear cualquier número de clases, funciones o archivos, pero solo se pueden invocar los métodos definidos en la clase de controlador principal. Los otros métodos están ocultos.

Puede utilizar los métodos SDK de token para escribir métodos personalizados para la aplicación de negocio.

Métodos de token generados automáticamente

Blockchain App Builder genera automáticamente métodos para admitir tokens y ciclos de vida de tokens. Puede utilizar estos métodos para inicializar tokens, gestionar roles y cuentas, y completar otras tareas del ciclo de vida del token sin ninguna codificación adicional. Los métodos de controlador deben tener un decorador @Validator(...params) que se pueda invocar.

• Gestión del Control de Acceso
• Gestión de configuración de token
• Gestión de cuentas
• Gestión de Roles
• Gestión de historial de transacciones
• Gestión de comportamiento de token
  • Comportamiento mínimo
  • Comportamiento transferible
  • Comportamiento retenible
  • Comportamiento reproducible

Métodos de Gestión de Control de Acceso

• Base
• Activos digitales

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.

@Validator(yup.string(), yup.string())
public async addTokenAdmin(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization('ADMIN.addAdmin', 'TOKEN');
    return await this.Ctx.Admin.addAdmin(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 Admin (Org_Id: Org1MSP, User_Id: User1)"}

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.removeAdmin', 'TOKEN');
    return await this.Ctx.Admin.removeAdmin(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)"}

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 o Org Admin pueden 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.

@Validator(yup.string(), yup.string())
  public async isTokenAdmin(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.isUserTokenAdmin", "TOKEN");
    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.

getAllTokenAdmins

Este método devuelve una lista de todos los usuarios que son Token Admin del código de cadena. Este método solo puede ser llamado por Token Admin o cualquier Org Admin del código de cadena.

@Validator()
public async getAllTokenAdmins() {
    await this.Ctx.Auth.checkAuthorization('ADMIN.getAllAdmins', 'TOKEN');
    return await this.Ctx.Admin.getAllAdmins();
}

Parámetros:

• ninguno

Devuelve:

• Una vez realizada correctamente, una matriz admins en formato JSON que contiene objetos orgId y userId.

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. 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())
  public async addOrgAdmin(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.addOrgAdmin", "TOKEN", { org_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 });
    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)"
}

getOrgAdmins

Este método devuelve una lista de todos los usuarios que son Org Admin de una organización. Este método solo puede ser llamado por un Token Admin del código de cadena o por un Org Admin de cualquier organización.

  @Validator()
  public async getOrgAdmins() {
    await this.Ctx.Auth.checkAuthorization("ADMIN.getOrgAdmins", "TOKEN");
    return await this.Ctx.Admin.getAllOrgAdmins();
  }

Parámetros:

• ninguno

Devuelve:

• Si se realiza correctamente, una matriz en formato JSON que contiene objetos orgId y userId.

Ejemplo de valor devuelto:

{
    "admins": [
        {
            "org_id": "Org1MSP",
            "user_id": "orgadmin"
        },
        {
            "org_id": "Org1MSP",
            "user_id": "orgadmin1"
        },
        {
            "org_id": "Org1MSP",
            "user_id": "orgadmin2"
        }
    ]
}

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.

@Validator(yup.string(), yup.string())
public async addTokenAdmin(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization('ADMIN.addAdmin', 'TOKEN');
    return await this.Ctx.Admin.addAdmin(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 Admin (Org_Id: Org1MSP, User_Id: User1)"}

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.removeAdmin', 'TOKEN');
    return await this.Ctx.Admin.removeAdmin(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)"}

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.

@Validator(yup.string(), yup.string())
  public async isTokenAdmin(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.isUserTokenAdmin", "TOKEN");
    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.

getAllTokenAdmins

Este método devuelve una lista de todos los usuarios que son Token Admin del código de cadena. Este método solo puede ser llamado por Token Admin o Token Auditor del código de cadena.

@Validator()
public async getAllTokenAdmins() {
    await this.Ctx.Auth.checkAuthorization('ADMIN.getAllAdmins', 'TOKEN');
    return await this.Ctx.Admin.getAllAdmins();
}

Parámetros:

• ninguno

Devuelve:

• Una vez realizada correctamente, una matriz admins en formato JSON que contiene objetos orgId y userId.

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. 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())
  public async addOrgAdmin(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.addOrgAdmin", "TOKEN", { org_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 });
    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)"
}

getOrgAdmins

Este método devuelve una lista de todos los usuarios que son Org Admin de una organización. Este método solo puede ser llamado por Token Admin, Token Auditor, cualquier Org Admin o cualquier Org Auditor.

  @Validator()
  public async getOrgAdmins() {
    await this.Ctx.Auth.checkAuthorization("ADMIN.getOrgAdmins", "TOKEN");
    return await this.Ctx.Admin.getAllOrgAdmins();
  }

Parámetros:

• ninguno

Devuelve:

• Si se realiza correctamente, una matriz en formato JSON que contiene objetos orgId y userId.

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. Este método solo puede ser llamado por un Token Admin del código de cadena.

public async 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:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "cd81f6c4c9e7c18ece357dbf5c139ef66ef2d6566be3b14de5f6d0a3fd4bb2f0",
        "payload": {
            "msg": "Successfully added Token Auditor (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 196
    }
}

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.

public async 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.

Devuelve:

• En caso de éxito, un mensaje que incluye detalles del usuario que se ha eliminado como Token Auditor del código de cadena.

Ejemplo de valor devuelto:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "a886a6040fbc76374a3c78c89ab0ffc9f7b8391cc5239b169bf3b878cf40c67b",
        "payload": {
            "msg": "Successfully removed Token Auditor (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 219
    }
}

getTokenAuditors

Este método devuelve todos los Token Auditors del código de cadena. Este método solo puede ser llamado por un Token Admin o Token Auditor del código de cadena.

public async getTokenAuditors()

Ejemplo de valor devuelto:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "auditors": [
                {
                    "org_id": "CB",
                    "user_id": "auditor_user_cb"
                }
            ]
        },
        "encode": "JSON"
    }
}

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.

public async 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.

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:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "44bbad35a1478cb714e32f7cfd551897868a203520aab9cea5771d3aadc1cf03",
        "payload": {
            "msg": "Successfully added Org Auditor (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 198
    }
}

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.

public async 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.

Devuelve:

• En caso de éxito, un mensaje que incluye detalles del usuario que se ha eliminado como Org Auditor del código de cadena.

Ejemplo de valor devuelto:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "c3bc720461004a53b37c68d4bb264858b88d980bc093a0a3ebb62a32974fb306",
        "payload": {
            "msg": "Successfully removed Org Auditor (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 221
    }
}

getOrgAuditors

Este método devuelve todos los Org Auditors del código de cadena. Este método solo se puede llamar mediante Token Admin, Token Auditor, Org Admin o Org Auditor.

public async getOrgAuditors()

Ejemplo de valor devuelto:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "auditors": [
                {
                    "org_id": "FI1",
                    "user_id": "auditor_user_fi1"
                },
                {
                    "org_id": "FI2",
                    "user_id": "auditor_user_fi2"
                }
            ]
        },
        "encode": "JSON"
    }
}

Métodos para la Gestión de Configuración de Token

• Base
• Activos digitales

init

Este método se llama cuando se despliega o actualiza el código de cadena. Cada Token Admin se identifica mediante la información user_id y org_id en el parámetro adminList obligatorio. user_id es el nombre de usuario o el ID de correo electrónico del propietario de la instancia o del usuario conectado a la instancia. org_id es el ID del proveedor de servicios de afiliación (MSP) del usuario en la organización de red actual.

Cualquier usuario Token Admin puede agregar y eliminar otros usuarios Token Admin llamando a los métodos addAdmin y removeAdmin.

public async init(adminList: TokenAdminAsset[]) {
    await this.Ctx.Admin.initAdmin(adminList);
    return;
}

Parámetros:

• adminList array: matriz de información {user_id, org_id} que especifica la lista de administradores de tokens. La matriz adminList es un parámetro obligatorio.

Ejemplo de parámetro, macOS y CLI de Linux:

'[{"user_id":"userid", "org_id":"OrgMSPId"}]'

Ejemplo de parámetro, CLI de Microsoft Windows:

"[{\"user_id\":\"userid\", \"org_id\":\"OrgMSPId\"}]"

Ejemplo de parámetro, consola de Oracle Blockchain Platform:

["[{\"user_id\":\"userid\", \"org_id\":\"OrgMSPId\"}]"]

initialize<Token Name>Token

Este método crea un token e inicializa las propiedades del token. El activo y sus propiedades se guardan en la base de datos de estado. Este método solo puede ser llamado por un Token Admin del código de cadena.

@Validator(Digicur)
    public async initializeDigicurToken(token_asset: Digicur) {
        await this.Ctx.Auth.checkAuthorization('TOKEN.save', 'TOKEN');
        return await this.Ctx.Token.save(token_asset)
    }

Parámetros:

• asset <Token Class>: el activo de token se transfiere como parámetro a este método. Las propiedades del activo de token pueden variar y se describen en el archivo de especificación de token. No incluya parámetros que estén marcados como de solo lectura en el archivo de especificación.

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

  Visual Studio Code: utilice la GUI para transferir parámetros individuales que corresponden a los campos de clase de token.

  CLI/Postman: transfiera una cadena JSON serializada que incluya los campos de especificación de token, como se muestra en el siguiente ejemplo.

  "{\"token_id\":\"USD\",\"token_desc\":\"token_desc value\",\"Currency_Name\":\"Currency_Name value\"}"

Devuelve:

• En caso de éxito, una representación JSON del activo de token que se creó.

Ejemplo de valor devuelto:

{
    "assetType": "otoken",
    "token_id": "digiCurr101",
    "token_name": "digicur",
    "token_type": "fungible",
    "behaviors": [
        "divisible",
        "mintable",
        "transferable",
        "burnable",
        "roles"
    ],
    "roles": {
        "minter_role_name": "minter"
    },
    "mintable": {
        "max_mint_quantity": 1000
    },
    "divisible": {
        "decimal": 2
    },
    "currency_name": "DOLLAR",
    "token_to_currency_ratio": 1
}

update<Token Name>Token

Este método actualiza las propiedades del token. Después de crear un activo de token, solo se pueden actualizar la propiedad token_desc y las propiedades personalizadas. Este método solo puede ser llamado por un Token Admin del código de cadena.

@Validator(Digicur)
public async updateDigicurToken(token_asset: Digicur) {
    await this.Ctx.Auth.checkAuthorization('TOKEN.update', 'TOKEN');
    return await this.Ctx.Token.update(token_asset);
}

Parámetros:

• asset <Token Class>: el activo de token se transfiere como parámetro a este método. Las propiedades del activo de token pueden variar y se describen en el archivo de especificación de token. No incluya parámetros que estén marcados como de solo lectura en el archivo de especificación.

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

  Visual Studio Code: utilice la GUI para transferir parámetros individuales que corresponden a los campos de clase de token.

  CLI/Postman: transfiera una cadena JSON serializada que incluya los campos de especificación de token, como se muestra en el siguiente ejemplo.

  "{\"token_id\":\"USD\",\"token_desc\":\"token_desc value\",\"Currency_Name\":\"Currency_Name value\"}"

Devuelve:

• Cuando se realiza correctamente, se actualiza una representación JSON del activo de 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"
    },
    "mintable": {
        "max_mint_quantity": 1000
    },
    "divisible": {
        "decimal": 2
    },
    "currency_name": "DOLLAR",
    "token_to_currency_ratio": 1
}

getTokenDecimals

Este método devuelve el número de decimales que se han configurado para un token fraccionario. Si no se ha especificado el comportamiento divisible para el token, el valor por defecto es 0. Este método solo puede ser llamado por un Token Admin o Org Admin del código de cadena.

@Validator(yup.string())
public async getTokenDecimals(token_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    await this.Ctx.Auth.checkAuthorization('TOKEN.getDecimals', 'TOKEN');
    return {
        msg: `Token Id: ${token_id} has ${this.Ctx.Token.getDecimals(token_asset)} decimal places.`
    };
}

Parámetros:

• token_id: string: ID del token.

Devuelve:

• En caso de éxito, una cadena JSON que muestra el número de decimales de token.

Ejemplo de valor devuelto:

{"msg":"Token Id: digiCurr101 has 1 decimal places."}

getTokenById

Este método devuelve un objeto de token si está presente en la base de datos de estado. Este método solo se puede llamar mediante un Token Admin o un Org Admin del código de cadena.

@Validator(yup.string())
public async getTokenById(token_id: string) {
    await this.Ctx.Auth.checkAuthorization('TOKEN.get', 'TOKEN');
    const token = await this.getTokenObject(token_id);
    return token;
}

Parámetros:

• token_id: string: ID del token.

Devuelve:

• En caso de éxito, un objeto JSON que represente el activo de 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
}

getTokenHistory

Este método devuelve el historial de tokens para un ID de token especificado. Cualquier usuario puede llamar a este método.

  @Validator(yup.string())
  public async getTokenHistory(tokenId: string) {
    await this.Ctx.Auth.checkAuthorization("TOKEN.getTokenHistory", "TOKEN");
    return await this.Ctx.Token.history(tokenId);
  }

Parámetros:

• tokenId: string: ID del token.

Devuelve:

• En caso de éxito, un objeto JSON que represente el historial de tokens.

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
            }
        }
    }
]

getAllTokens

Este método devuelve todos los tokens que se almacenan en la base de datos de estado. Este método solo se puede llamar mediante un Token Admin o un Org Admin del código de cadena. 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.

@Validator()
public async getAllTokens() {
    await this.Ctx.Auth.checkAuthorization('TOKEN.getAllTokens', 'TOKEN');
    return await this.Ctx.Token.getAllTokens();
}

Parámetros:

• ninguno

Devuelve:

• En caso de éxito, un objeto JSON que represente todos los activos de token.

getTokensByName

Este método devuelve todos los objetos de token con un nombre especificado. Este método solo puede ser llamado por un Token Admin o Org Admin del código de cadena. 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.

@Validator(yup.string())
public async getTokensByName(token_name: string) {
    await this.Ctx.Auth.checkAuthorization('TOKEN.getTokensByName', 'TOKEN');
    return await this.Ctx.Token.getTokensByName(token_name);
}

Parámetros:

• token_name: string: nombre de los tokens que se van a recuperar. El nombre corresponde a la propiedad token_name en el archivo de especificación. El valor es el nombre de clase del token.

Devuelve:

• Si se realiza correctamente, un objeto JSON de todos los activos de token que coinciden con el nombre.

init

Este método se llama cuando se despliega o actualiza el código de cadena. Cada Token Admin se identifica mediante la información user_id y org_id en el parámetro adminList obligatorio. user_id es el nombre de usuario o el ID de correo electrónico del propietario de la instancia o del usuario conectado a la instancia. org_id es el ID del proveedor de servicios de afiliación (MSP) del usuario en la organización de red actual.

Cualquier usuario Token Admin puede agregar y eliminar otros usuarios Token Admin llamando a los métodos addAdmin y removeAdmin.

public async init(adminList: TokenAdminAsset[]) {
    await this.Ctx.Admin.initAdmin(adminList);
    return;
}

Parámetros:

• adminList array: matriz de información {user_id, org_id} que especifica la lista de administradores de tokens. La matriz adminList es un parámetro obligatorio.

Ejemplo de parámetro, macOS y CLI de Linux:

'[{"user_id":"userid", "org_id":"OrgMSPId"}]'

Ejemplo de parámetro, CLI de Microsoft Windows:

"[{\"user_id\":\"userid\", \"org_id\":\"OrgMSPId\"}]"

Ejemplo de parámetro, consola de Oracle Blockchain Platform:

["[{\"user_id\":\"userid\", \"org_id\":\"OrgMSPId\"}]"]

initialize<Token Name>Token

Este método crea un token e inicializa las propiedades del token. El activo y sus propiedades se guardan en la base de datos de estado. Este método solo puede ser llamado por un Token Admin del código de cadena.

@Validator(Digicur)
    public async initializeDigicurToken(token_asset: Digicur) {
        await this.Ctx.Auth.checkAuthorization('TOKEN.save', 'TOKEN');
        return await this.Ctx.Token.save(token_asset)
    }

Parámetros:

• asset <Token Class>: el activo de token se transfiere como parámetro a este método. Las propiedades del activo de token pueden variar y se describen en el archivo de especificación de token. No incluya parámetros que estén marcados como de solo lectura en el archivo de especificación.

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

  Visual Studio Code: utilice la GUI para transferir parámetros individuales que corresponden a los campos de clase de token.

  CLI/Postman: transfiera una cadena JSON serializada que incluya los campos de especificación de token, como se muestra en el siguiente ejemplo.

  "{\"token_id\":\"USD\",\"token_desc\":\"token_desc value\",\"Currency_Name\":\"Currency_Name value\"}"

Devuelve:

• En caso de éxito, una representación JSON del activo de token que se creó.

Ejemplo de valor devuelto:

{
    "assetType": "otoken",
    "token_id": "digiCurr101",
    "token_name": "digicur",
    "token_type": "fungible",
    "behaviors": [
        "divisible",
        "mintable",
        "transferable",
        "burnable",
        "roles"
    ],
    "roles": {
        "minter_role_name": "minter"
    },
    "mintable": {
        "max_mint_quantity": 1000
    },
    "divisible": {
        "decimal": 2
    },
    "currency_name": "DOLLAR",
    "token_to_currency_ratio": 1
}

update<Token Name>Token

Este método actualiza las propiedades del token. Después de crear un activo de token, solo se pueden actualizar la propiedad token_desc y las propiedades personalizadas. Este método solo puede ser llamado por un Token Admin del código de cadena.

@Validator(Digicur)
public async updateDigicurToken(token_asset: Digicur) {
    await this.Ctx.Auth.checkAuthorization('TOKEN.update', 'TOKEN');
    return await this.Ctx.Token.update(token_asset);
}

Parámetros:

• asset <Token Class>: el activo de token se transfiere como parámetro a este método. Las propiedades del activo de token pueden variar y se describen en el archivo de especificación de token. No incluya parámetros que estén marcados como de solo lectura en el archivo de especificación.

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

  Visual Studio Code: utilice la GUI para transferir parámetros individuales que corresponden a los campos de clase de token.

  CLI/Postman: transfiera una cadena JSON serializada que incluya los campos de especificación de token, como se muestra en el siguiente ejemplo.

  "{\"token_id\":\"USD\",\"token_desc\":\"token_desc value\",\"Currency_Name\":\"Currency_Name value\"}"

Devuelve:

• Cuando se realiza correctamente, se actualiza una representación JSON del activo de 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"
    },
    "mintable": {
        "max_mint_quantity": 1000
    },
    "divisible": {
        "decimal": 2
    },
    "currency_name": "DOLLAR",
    "token_to_currency_ratio": 1
}

getTokenDecimals

Este método devuelve el número de decimales que se han configurado para un token fraccionario. Si no se ha especificado el comportamiento divisible para el token, el valor por defecto es 0. Este método solo se puede llamar mediante Token Admin, Token Auditor, Org Admin o Org Auditor.

@Validator(yup.string())
public async getTokenDecimals(token_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    await this.Ctx.Auth.checkAuthorization('TOKEN.getDecimals', 'TOKEN');
    return {
        msg: `Token Id: ${token_id} has ${this.Ctx.Token.getDecimals(token_asset)} decimal places.`
    };
}

Parámetros:

• token_id: string: ID del token.

Devuelve:

• En caso de éxito, una cadena JSON que muestra el número de decimales de token.

Ejemplo de valor devuelto:

{"msg":"Token Id: digiCurr101 has 1 decimal places."}

getTokenById

Este método devuelve un objeto de token si está presente en la base de datos de estado. Este método solo se puede llamar mediante Token Admin, Token Auditor, Org Admin o Org Auditor.

@Validator(yup.string())
public async getTokenById(token_id: string) {
    await this.Ctx.Auth.checkAuthorization('TOKEN.get', 'TOKEN');
    const token = await this.getTokenObject(token_id);
    return token;
}

Parámetros:

• token_id: string: ID del token.

Devuelve:

• En caso de éxito, un objeto JSON que represente el activo de 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
}

getTokenHistory

Este método devuelve el historial de tokens para un ID de token especificado. Este método solo se puede llamar mediante Token Admin, Token Auditor, Org Admin o Org Auditor.

  @Validator(yup.string())
  public async getTokenHistory(tokenId: string) {
    await this.Ctx.Auth.checkAuthorization("TOKEN.getTokenHistory", "TOKEN");
    return await this.Ctx.Token.history(tokenId);
  }

Parámetros:

• tokenId: string: ID del token.

Devuelve:

• En caso de éxito, un objeto JSON que represente el historial de tokens.

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
            }
        }
    }
]

getAllTokens

Este método devuelve todos los tokens que se almacenan en la base de datos de estado. Este método solo se puede llamar mediante Token Admin, Token Auditor, Org Admin o Org 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.

@Validator()
public async getAllTokens() {
    await this.Ctx.Auth.checkAuthorization('TOKEN.getAllTokens', 'TOKEN');
    return await this.Ctx.Token.getAllTokens();
}

Parámetros:

• ninguno

Devuelve:

• En caso de éxito, un objeto JSON que represente todos los activos de token.

getTokensByName

Este método devuelve todos los objetos de token con un nombre especificado. Este método solo se puede llamar mediante Token Admin, Token Auditor, Org Admin o Org 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.

@Validator(yup.string())
public async getTokensByName(token_name: string) {
    await this.Ctx.Auth.checkAuthorization('TOKEN.getTokensByName', 'TOKEN');
    return await this.Ctx.Token.getTokensByName(token_name);
}

Parámetros:

• token_name: string: nombre de los tokens que se van a recuperar. El nombre corresponde a la propiedad token_name en el archivo de especificación. El valor es el nombre de clase del token.

Devuelve:

• Si se realiza correctamente, un objeto JSON de todos los activos de token que coinciden con el nombre.

Métodos para la gestión de cuentas

• Base
• Activos digitales

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 es un juego alfanumérico de caracteres, con el prefijo oaccount~<token asset name>~ y seguido de un hash del nombre de usuario o el ID de correo electrónico (user_id) del propietario de la instancia o del usuario que está conectado a la instancia, el ID de proveedor de servicios de afiliación (org_id) del usuario de la organización de red actual. 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(), yup.string())
  public async createAccount(org_id: string, user_id: string, token_type: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.createAccount", "TOKEN", { org_id });
    return await this.Ctx.Account.createAccount(org_id, user_id, token_type);
  }

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.
• token_type: string: tipo del token, que debe ser fungible.

Devuelve:

• En caso de éxito, un objeto JSON de la cuenta que se creó. El parámetro bapAccountVersion se define en el objeto de cuenta para uso interno.

Ejemplo de valor devuelto:

{
  "assetType": "oaccount",
  "account_id": "oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb",
  "bapAccountVersion": 0,
  "user_id": "admin",
  "org_id": "Org1MSP",
  "token_type": "fungible",
  "token_id": "",
  "token_name": "",
  "balance": 0,
  "onhold_balance": 0
}

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())
  public async associateTokenToAccount(account_id: string, token_id: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.associateToken", "TOKEN", { account_id });
    return await this.Ctx.Account.associateToken(account_id, token_id);
  }

Parámetros:

• account_id: string: ID de la cuenta.
• token_id: string: ID del token.

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:

{
    "assetType": "oaccount",
    "account_id": "oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb",
    "bapAccountVersion": 0,
    "user_id": "admin",
    "org_id": "Org1MSP",
    "token_type": "fungible",
    "token_id": "fungible",
    "token_name": "fiatmoneytok",
    "balance": 0,
    "onhold_balance": 0
}

getAccount

Este método devuelve los detalles de la cuenta para un usuario y token especificados. Este método solo puede ser llamado por un Token Admin del código de cadena, un Org Admin de la organización especificada o el AccountOwner de la cuenta.

@Validator(yup.string(), yup.string(), yup.string())
public async getAccount(token_id: string, org_id: string, user_id: string) {
  const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
  await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccount", "TOKEN", { account_id });
  return await this.Ctx.Account.getAccountWithStatus(account_id);
}

Parámetros:

• token_id: string: ID del token.
• 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 objeto de cuenta JSON que incluya las siguientes propiedades:
• account_id: ID de la cuenta de usuario.
• user_id: nombre de usuario o ID de correo electrónico del usuario.
• org_id: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
• token_id: ID del token.
• token_name: nombre del token.
• balance: saldo actual de la cuenta.
• onhold_balance: saldo actual retenido de la cuenta.
• bapAccountVersion: parámetro de objeto de cuenta para uso interno.
• status: estado actual de la cuenta.

Ejemplo de valor devuelto:

{
  "bapAccountVersion": 0,
  "assetType": "oaccount",
  "status": "active",
  "account_id": "oaccount~2de8db6b91964f8c9009136831126d3cfa94e1d00c4285c1ea3e6d1f36479ed4",
  "user_id": "idcqa",
  "org_id": "appdev",
  "token_type": "fungible",
  "token_id": "t1",
  "token_name": "obptok",
  "balance": 0,
  "onhold_balance": 0
}

getAccountHistory

Este método devuelve los detalles del historial de cuentas para un usuario y token especificados. Este método solo puede ser llamado por un Token Admin del código de cadena o el AccountOwner de la cuenta.

  @Validator(yup.string(), yup.string(), yup.string())
  public async getAccountHistory(token_id: string, org_id: string, user_id: string) {
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.history", "TOKEN", { account_id });
    return await this.Ctx.Account.history(account_id);
  }

Parámetros:

• token_id: string: ID del token.
• 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 de objetos de cuenta JSON que incluye las siguientes propiedades:
• trxId: ID de transacción de la transacción devuelta por el libro mayor.
• timeStamp: hora de la transacción.
• value: cadena JSON del objeto de cuenta.

Ejemplo de valor devuelto:

[
    {
      "trxId":"2gsdh17fff222467e5667be042e33ce18e804b3e065cca15de306f837e416d7c3e",
      "timeStamp":1629718288,
      "value":{
         "assetType":"oaccount",
         "account_id":"oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
         "user_id":"user1",
         "org_id":"Org1MSP",
         "token_id":"digiCurr101",
         "token_name":"digicur",
         "balance":100,
         "onhold_balance":0,
         "bapAccountVersion": 1
   },
   {
      "trxId":"9fd07fff222467e5667be042e33ce18e804b3e065cca15de306f837e416d7c3e",
      "timeStamp":1629718288,
      "value":{
         "assetType":"oaccount",
         "account_id":"oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
         "user_id":"user1",
         "org_id":"Org1MSP",
         "token_id":"digiCurr101",
         "token_name":"digicur",
         "balance":0,
         "onhold_balance":0,
         "bapAccountVersion": 0
      }
   }
]

getAccountOnHoldBalance

Este método devuelve el saldo actual retenido para una cuenta y un token especificados. Este método solo puede ser llamado por un Token Admin del código de cadena, un Org Admin de la organización especificada o el AccountOwner de la cuenta.

  @Validator(yup.string(), yup.string(), yup.string())
  public async getAccountOnHoldBalance(token_id: string, org_id: string, user_id: string) {
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountOnHoldBalance", "TOKEN", { account_id });
    return await this.Ctx.Account.getAccountOnHoldBalance(account_id);
  }

Parámetros:

• token_id: string: ID del token.
• 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 representación JSON del saldo retenido actual.

Ejemplo de valor devuelto:

{"msg":"Total Holding Balance is: 0","holding_balance":0}

getAllAccounts

Este método devuelve una lista de todas las cuentas. Este método solo puede ser llamado por un Token Admin del código de cadena. 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.

@Validator()
public async getAllAccounts() {
    await this.Ctx.Auth.checkAuthorization('ACCOUNT.getAllAccounts', 'TOKEN');
    return await this.Ctx.Account.getAllAccounts();
}

Parámetros:

• ninguno

Devuelve:

• En caso de éxito, una matriz JSON de todas las cuentas.

getUserByAccountId

Este método devuelve los detalles del usuario (org_id y user_id) para una cuenta especificada. Cualquier usuario del código de cadenas puede llamar a este método.

@Validator(yup.string())
public async getUserByAccountId(account_id: string) {
    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": "digiCurr101",
    "user_id": "user1",
    "org_id": "Org1MSP"
}

getAccountBalance

Este método devuelve el saldo actual de una cuenta y un token especificados. Este método solo puede ser llamado por un Token Admin del código de cadena, un Org Admin de la organización especificada o el AccountOwner de la cuenta.

  @Validator(yup.string(), yup.string(), yup.string())
  public async getAccountBalance(token_id: string, org_id: string, user_id: string) {
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountBalance", "TOKEN", { account_id });
    return await this.Ctx.Account.getAccountBalance(account_id);
  }

Parámetros:

• token_id: string: ID del token.
• 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 representación JSON del saldo de cuenta corriente.

Ejemplo de valor devuelto:

{"msg":"Current Balance is: 0","user_balance":0}

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 un Token Admin del código de cadena o por un Org Admin de la organización especificada.

  @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~2de8db6b91964f8c9009136831126d3cfa94e1d00c4285c1ea3e6d1f36479ed4",
        "valueJson": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~2de8db6b91964f8c9009136831126d3cfa94e1d00c4285c1ea3e6d1f36479ed4",
            "user_id": "idcqa",
            "org_id": "appdev",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "fiatmoneytok",
            "balance": 0,
            "onhold_balance": 0
        }
    },
    {
        "key": "oaccount~620fcf5deb5fd5a65c0b5b10fda129de0f629ccd232c5891c130e24a574df50a",
        "valueJson": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~620fcf5deb5fd5a65c0b5b10fda129de0f629ccd232c5891c130e24a574df50a",
            "user_id": "example_minter",
            "org_id": "appdev",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "fiatmoneytok",
            "balance": 0,
            "onhold_balance": 0
        }
    }
]

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 es un juego alfanumérico de caracteres, con el prefijo oaccount~<token asset name>~ y seguido de un hash del nombre de usuario o el ID de correo electrónico (user_id) del propietario de la instancia o del usuario que está conectado a la instancia, el ID de proveedor de servicios de afiliación (org_id) del usuario de la organización de red actual. 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(), yup.string(), yup.object().nullable())

public async createAccount(org_id: string, user_id: string, token_type: string, daily_limits: DailyLimits) {
await this.Ctx.Auth.checkAuthorization("ACCOUNT.createAccount", "TOKEN", { org_id });
return await this.Ctx.Account.createAccount(org_id, user_id, token_type, daily_limits);
}

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.
• token_type: string: tipo del token, que debe ser fungible.
• daily_limits: JSON: objeto que especifica la cantidad máxima de tokens que se pueden utilizar en transacciones diariamente (max_daily_amount) y el número máximo de transacciones que se pueden completar diariamente (max_daily_transactions).

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

  Código de Visual Studio: { "max_daily_amount": 1000, "max_daily_transactions": 100 }

  CLI/Postman: "{\"max_daily_amount\":1000,\"max_daily_transactions\":100}"

Devuelve:

• En caso de éxito, un objeto JSON de la cuenta que se creó. El parámetro bapAccountVersion se define en el objeto de cuenta para uso interno.

Ejemplo de valor devuelto:

{
  "assetType": "oaccount",
  "account_id": "oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb",
  "bapAccountVersion": 0,
  "user_id": "admin",
  "org_id": "Org1MSP",
  "token_type": "fungible",
  "token_id": "",
  "token_name": "",
  "balance": 0,
  "onhold_balance": 0,
  "onhold_burn_balance": 0,
  "max_daily_amount": 1000,
  "max_daily_transactions": 100
}

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())
  public async associateTokenToAccount(account_id: string, token_id: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.associateToken", "TOKEN", { account_id });
    return await this.Ctx.Account.associateToken(account_id, token_id);
  }

Parámetros:

• account_id: string: ID de la cuenta.
• token_id: string: ID del token.

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:

{
    "assetType": "oaccount",
    "account_id": "oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb",
    "bapAccountVersion": 0,
    "user_id": "admin",
    "org_id": "Org1MSP",
    "token_type": "fungible",
    "token_id": "fungible",
    "token_name": "fiatmoneytok",
    "balance": 0,
    "onhold_balance": 0
}

getAccount

Este método devuelve los detalles de la cuenta para un usuario y token especificados. 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.

@Validator(yup.string(), yup.string(), yup.string())
public async getAccount(token_id: string, org_id: string, user_id: string) {
  const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
  await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccount", "TOKEN", { account_id });
  return await this.Ctx.Account.getAccountWithStatus(account_id);
}

Parámetros:

• token_id: string: ID del token.
• 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 objeto de cuenta JSON que incluya las siguientes propiedades:
• account_id: ID de la cuenta de usuario.
• user_id: nombre de usuario o ID de correo electrónico del usuario.
• org_id: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
• token_id: ID del token.
• token_name: nombre del token.
• balance: saldo actual de la cuenta.
• onhold_balance: saldo actual retenido de la cuenta.
• bapAccountVersion: parámetro de objeto de cuenta para uso interno.
• status: estado actual de la cuenta.

Ejemplo de valor devuelto:

{
  "bapAccountVersion": 0,
  "assetType": "oaccount",
  "status": "active",
  "account_id": "oaccount~2de8db6b91964f8c9009136831126d3cfa94e1d00c4285c1ea3e6d1f36479ed4",
  "user_id": "idcqa",
  "org_id": "appdev",
  "token_type": "fungible",
  "token_id": "t1",
  "token_name": "obptok",
  "balance": 0,
  "onhold_balance": 0
}

getAccountHistory

Este método devuelve los detalles del historial de cuentas para un usuario y token especificados. Este método solo puede ser llamado por un Token Admin del código de cadena o el AccountOwner de la cuenta.

  @Validator(yup.string(), yup.string(), yup.string())
  public async getAccountHistory(token_id: string, org_id: string, user_id: string) {
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.history", "TOKEN", { account_id });
    return await this.Ctx.Account.history(account_id);
  }

Parámetros:

• token_id: string: ID del token.
• 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 de objetos de cuenta JSON que incluye las siguientes propiedades:
• trxId: ID de transacción de la transacción devuelta por el libro mayor.
• timeStamp: hora de la transacción.
• value: cadena JSON del objeto de cuenta.

Ejemplo de valor devuelto:

[
    {
      "trxId":"2gsdh17fff222467e5667be042e33ce18e804b3e065cca15de306f837e416d7c3e",
      "timeStamp":1629718288,
      "value":{
         "assetType":"oaccount",
         "account_id":"oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
         "user_id":"user1",
         "org_id":"Org1MSP",
         "token_id":"digiCurr101",
         "token_name":"digicur",
         "balance":100,
         "onhold_balance":0,
         "bapAccountVersion": 1
   },
   {
      "trxId":"9fd07fff222467e5667be042e33ce18e804b3e065cca15de306f837e416d7c3e",
      "timeStamp":1629718288,
      "value":{
         "assetType":"oaccount",
         "account_id":"oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
         "user_id":"user1",
         "org_id":"Org1MSP",
         "token_id":"digiCurr101",
         "token_name":"digicur",
         "balance":0,
         "onhold_balance":0,
         "bapAccountVersion": 0
      }
   }
]

getAccountOnHoldBalance

Este método devuelve el saldo actual retenido para una cuenta y un token especificados. 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.

  @Validator(yup.string(), yup.string(), yup.string())
  public async getAccountOnHoldBalance(token_id: string, org_id: string, user_id: string) {
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountOnHoldBalance", "TOKEN", { account_id });
    return await this.Ctx.Account.getAccountOnHoldBalance(account_id);
  }

Parámetros:

• token_id: string: ID del token.
• 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 representación JSON del saldo retenido actual.

Ejemplo de valor devuelto:

{"msg":"Total Holding Balance is: 0","holding_balance":0}

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.

@Validator()
public async getAllAccounts() {
    await this.Ctx.Auth.checkAuthorization('ACCOUNT.getAllAccounts', 'TOKEN');
    return await this.Ctx.Account.getAllAccounts();
}

Parámetros:

• ninguno

Devuelve:

• En caso de éxito, una matriz JSON de todas las cuentas.

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.

@Validator(yup.string())
public async getUserByAccountId(account_id: string) {
    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": "digiCurr101",
    "user_id": "user1",
    "org_id": "Org1MSP"
}

getAccountBalance

Este método devuelve el saldo actual de una cuenta y un token especificados. 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.

  @Validator(yup.string(), yup.string(), yup.string())
  public async getAccountBalance(token_id: string, org_id: string, user_id: string) {
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountBalance", "TOKEN", { account_id });
    return await this.Ctx.Account.getAccountBalance(account_id);
  }

Parámetros:

• token_id: string: ID del token.
• 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 representación JSON del saldo de cuenta corriente.

Ejemplo de valor devuelto:

{"msg":"Current Balance is: 0","user_balance":0}

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.

  @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~2de8db6b91964f8c9009136831126d3cfa94e1d00c4285c1ea3e6d1f36479ed4",
        "valueJson": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~2de8db6b91964f8c9009136831126d3cfa94e1d00c4285c1ea3e6d1f36479ed4",
            "user_id": "idcqa",
            "org_id": "appdev",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "fiatmoneytok",
            "balance": 0,
            "onhold_balance": 0
        }
    },
    {
        "key": "oaccount~620fcf5deb5fd5a65c0b5b10fda129de0f629ccd232c5891c130e24a574df50a",
        "valueJson": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~620fcf5deb5fd5a65c0b5b10fda129de0f629ccd232c5891c130e24a574df50a",
            "user_id": "example_minter",
            "org_id": "appdev",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "fiatmoneytok",
            "balance": 0,
            "onhold_balance": 0
        }
    }
]

Métodos para la gestión de roles

• Base
• Activos digitales

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(), yup.string(), yup.string())
  public async addRole(token_id: string, role: string, org_id: string, user_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("TOKEN.addRoleMember", "TOKEN", { token_id, org_id, role });
    return await this.Ctx.Token.addRoleMember(role, account_id, token_asset);
  }

Parámetros:

• token_id: string: ID del 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.
• 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, se mostrará un mensaje con los detalles de la cuenta.

Ejemplo de valor devuelto:

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

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(), yup.string(), yup.string())
  public async removeRole(token_id: string, role: string, org_id: string, user_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("TOKEN.removeRoleMember", "TOKEN", { token_id, org_id, role });
    return await this.Ctx.Token.removeRoleMember(role, account_id, token_asset);
  }

Parámetros:

• token_id: string: ID del 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.
• 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, se mostrará un mensaje con los detalles de la cuenta.

Ejemplo de valor devuelto:

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

getAccountsByRole

Este método devuelve una lista de todos los ID de cuenta para un rol y token especificados. Este método solo puede ser llamado por un Token Admin del código de cadena.

@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~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f"]}

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 lo puede llamar el Token Admin del código de cadena, el Org Admin de la organización especificada o el Account Owner especificado en los parámetros.

  @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:

{"accounts":["oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f"]}

getUsersByRole

Este método devuelve una lista de todos los usuarios para un rol y token especificados. Este método solo puede ser llamado por un Token Admin del código de cadena.

@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.

Devuelve:

• Si se realiza correctamente, una matriz JSON de los objetos de usuario (org_id, token_id y user_id).

Ejemplo de valor devuelto:

{"users":[{"token_id":"digiCurr101","user_id":"user1","org_id":"Org1MSP"}]}

isInRole

Este método devuelve un valor booleano para indicar si un usuario y un token tienen un rol especificado. Este método solo puede ser llamado por un Token Admin del código de cadena, el AccountOwner de la cuenta o un Org Admin de la organización especificada.

  @Validator(yup.string(), yup.string(), yup.string(), yup.string())
  public async isInRole(token_id: string, org_id: string, user_id: string, role: string) {
    const token_asset = await this.getTokenObject(token_id);
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_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:

• token_id: string: ID del token.
• 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.
• 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":"false"}

getOrgAccountsByRole

Este método devuelve información sobre todas las cuentas que tienen un rol especificado en una organización especificada. 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(), 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 comprobar.
• org_id: string: ID del proveedor de servicios de membresía (MSP) de la organización.

Devuelve:

• En caso de éxito, una lista de todas las cuentas con el rol especificado en la organización especificada.

Ejemplo de valor devuelto:

{
    "accounts": [
        "oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb",
        "oaccount~9c650574af9025a6106c8d12a801b079eda9ae2e3399fc2fbd5bd683d738a850"
    ]
}

getOrgUsersByRole

Este método devuelve información sobre todos los usuarios que tienen un rol especificado en una organización especificada. 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(), 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 comprobar.
• org_id: string: ID del proveedor de servicios de membresía (MSP) de la organización.

Devuelve:

• En caso de éxito, una lista de todos los usuarios con el rol especificado en la organización especificada.

Ejemplo de valor devuelto:

{
    "users": [
        {
            "token_id": "token",
            "user_id": "admin",
            "org_id": "Org1MSP"
        },
        {
            "token_id": "token",
            "user_id": "orgAdmin",
            "org_id": "Org1MSP"
        }
    ]
}

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(), yup.string(), yup.string())
  public async addRole(token_id: string, role: string, org_id: string, user_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("TOKEN.addRoleMember", "TOKEN", { token_id, org_id, role });
    return await this.Ctx.Token.addRoleMember(role, account_id, token_asset);
  }

Parámetros:

• token_id: string: ID del 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.
• 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, se mostrará un mensaje con los detalles de la cuenta.

Ejemplo de valor devuelto:

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

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(), yup.string(), yup.string())
  public async removeRole(token_id: string, role: string, org_id: string, user_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("TOKEN.removeRoleMember", "TOKEN", { token_id, org_id, role });
    return await this.Ctx.Token.removeRoleMember(role, account_id, token_asset);
  }

Parámetros:

• token_id: string: ID del 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.
• 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, se mostrará un mensaje con los detalles de la cuenta.

Ejemplo de valor devuelto:

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

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.

@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~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f"]}

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.

  @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:

{"accounts":["oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f"]}

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.

@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.

Devuelve:

• Si se realiza correctamente, una matriz JSON de los objetos de usuario (org_id, token_id y user_id).

Ejemplo de valor devuelto:

{"users":[{"token_id":"digiCurr101","user_id":"user1","org_id":"Org1MSP"}]}

isInRole

Este método devuelve un valor booleano para indicar si un usuario y un token tienen 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.

  @Validator(yup.string(), yup.string(), yup.string(), yup.string())
  public async isInRole(token_id: string, org_id: string, user_id: string, role: string) {
    const token_asset = await this.getTokenObject(token_id);
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_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:

• token_id: string: ID del token.
• 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.
• 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":"false"}

getOrgAccountsByRole

Este método devuelve información sobre todas las cuentas que tienen un rol especificado en una organización especificada. Este método solo se puede llamar mediante Token Admin, Token Auditor, Org Admin o Org Auditor.

   @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 comprobar.
• org_id: string: ID del proveedor de servicios de membresía (MSP) de la organización.

Devuelve:

• En caso de éxito, una lista de todas las cuentas con el rol especificado en la organización especificada.

Ejemplo de valor devuelto:

{
    "accounts": [
        "oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb",
        "oaccount~9c650574af9025a6106c8d12a801b079eda9ae2e3399fc2fbd5bd683d738a850"
    ]
}

getOrgUsersByRole

Este método devuelve información sobre todos los usuarios que tienen un rol especificado en una organización especificada. Este método solo puede ser llamado por Token Admin o Token Auditor, por un Org Admin o Org Auditor de la organización especificada.

  @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 comprobar.
• org_id: string: ID del proveedor de servicios de membresía (MSP) de la organización.

Devuelve:

• En caso de éxito, una lista de todos los usuarios con el rol especificado en la organización especificada.

Ejemplo de valor devuelto:

{
    "users": [
        {
            "token_id": "token",
            "user_id": "admin",
            "org_id": "Org1MSP"
        },
        {
            "token_id": "token",
            "user_id": "orgAdmin",
            "org_id": "Org1MSP"
        }
    ]
}

Métodos para la gestión del historial de transacciones

• Base
• Activos digitales

getAccountTransactionHistory

Este método devuelve una matriz de detalles de historial de transacciones de cuenta para un usuario y token especificados. Este método solo puede ser llamado por Token Admin del código de cadena, un Org Admin de la organización especificada o el AccountOwner de la cuenta.

 @Validator(yup.string(), yup.string(), yup.string())
  public async getAccountTransactionHistory(token_id: string, org_id: string, user_id: string) {
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountTransactionHistory", "TOKEN", { account_id });
    return await this.Ctx.Account.getAccountTransactionHistory(account_id, org_id, user_id.toLowerCase());
  }

Parámetros:

• token_id: string: ID del token.
• 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 de objetos de transacción de cuenta JSON que incluye las siguientes propiedades:
• transaction_id: ID de la transacción.
• transacted_account: cuenta con la que se realizó la transacción.
• transaction_type: tipo de transacción.
• transacted_amount: importe de la transacción.
• timestamp: hora de la transacción.
• balance: saldo de cuenta en el momento de la transacción.
• onhold_balance: saldo retenido en el momento de la transacción.
• token_id: ID del token.
• holding_id: identificador único devuelto por el método holdTokens.

Ejemplo de valor devuelto:

[
    {
        "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
        "transacted_amount": 20,
        "timestamp": "2021-08-17T06:04:24.000Z",
        "balance": 930,
        "onhold_balance": 0,
        "token_id": "digiCurr101",
        "transaction_type": "BULKTRANSFER",
        "sub_transactions": [
            {
                "transacted_account": "oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
                "transaction_type": "DEBIT",
                "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c4ca4238a0b923820dcc509a6f75849b",
                "transacted_amount": 10
            },
            {
                "transacted_account": "oaccount~digicur~38848e87296d67c8a90918f78cf55f9c9baab2cdc8c928535471aaa1210c706e",
                "transaction_type": "DEBIT",
                "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c81e728d9d4c2f636f067f89cc14862c",
                "transacted_amount": 10
            }
        ]
    },
    {
        "transaction_id": "otransaction~757864d5369bd0539d044caeb3bb4898db310fd7aa740f45a9938771903d43da",
        "transacted_amount": 50,
        "timestamp": "2021-08-17T06:02:44.000Z",
        "balance": 950,
        "onhold_balance": 0,
        "token_id": "digiCurr101",
        "transacted_account": "oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
        "transaction_type": "DEBIT"
    }
]

getAccountTransactionHistoryWithFilters

Este método devuelve una matriz de detalles de historial de transacciones de cuenta para un usuario y token especificados. Este método solo puede ser llamado por Token Admin del código de cadena, un Org Admin de la organización especificada o el AccountOwner de la cuenta. Este método solo se puede llamar cuando está conectado a la red remota de Oracle Blockchain Platform.

  @Validator(yup.string(), yup.string(), yup.string(), yup.object().nullable())
  public async getAccountTransactionHistoryWithFilters(token_id: string, org_id: string, user_id: string, filters?: Filters) {
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountTransactionHistoryWithFilters", "TOKEN", { account_id });
    return await this.Ctx.Account.getAccountTransactionHistoryWithFilters(account_id, org_id, user_id.toLowerCase(), filters);
  }

Parámetros:

• token_id: string: ID del token.
• 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.
• 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.

Por ejemplo:

ochain invoke GetAccountTransactionHistoryWithFilters 'token1' 'appbuilder12' 'user_minter' '{"PageSize":10,"Bookmark":"1","StartTime":"2022-01-25T17:41:42Z","EndTime":"2022-01-25T17:59:10Z"}'

[
  {
    "transaction_id": "otransaction~672897b5a4fa78b421c000e4d6d4f71f3d46529bfbb5b4be10bf5471dc35ce89",
    "transacted_amount": 5,
    "timestamp": "2022-04-20T15:46:04.000Z",
    "token_id": "tokenId",
    "transacted_account": "oaccount~16c38d804413ebabf416360d374f76c973d4e71c74adfde73cc40c7c274883b8",
    "transaction_type": "DEBIT",
    "balance": 90,
    "onhold_balance": 0
  },
  {
    "transaction_id": "otransaction~467bb67a33aaffca4487f33dcd46c9844efdb5421a2e7b6aa2d53152eb2c6d85",
    "transacted_amount": 5,
    "timestamp": "2022-04-20T15:45:47.000Z",
    "token_id": "tokenId",
    "transacted_account": "oaccount~fbf95683b21bbc91a22205819ac1e2e9c90355d536821ed3fe22b7d23915c248",
    "transaction_type": "DEBIT",
    "balance": 95,
    "onhold_balance": 0
  },
  {
    "transaction_id": "otransaction~c6d56ce54a9bbe24597d1d10448e39316dc6f16328bf3c5b0c8ef10e1dfeb397",
    "transacted_amount": 100,
    "timestamp": "2022-04-20T15:44:26.000Z",
    "token_id": "tokenId",
    "transacted_account": "oaccount~deb5fb0906c40506f6c2d00c573b774e01a53dd91499e651d92ac4778b6add6a",
    "transaction_type": "MINT",
    "balance": 100,
    "onhold_balance": 0
  }
]

getSubTransactionsById

Este método devuelve una matriz de detalles de historial de transacciones de cuenta para un usuario y token especificados. Este método solo puede ser llamado por Token Admin del código de cadena o AccountOwner de la cuenta.

  @Validator(yup.string())
  public async getSubTransactionsById(transaction_id: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getSubTransactionsById", "TOKEN", { transaction_id });
    return await this.Ctx.Account.getSubTransactionsById(transaction_id);
  }

Parámetros:

• transaction_id: string: ID de la transacción de transferencia masiva.

Devuelve:

• Matriz de objetos de subtransacción de cuenta en formato JSON para un ID de transacción de transferencia masiva especificado.

Por ejemplo:

ochain invoke GetAccountSubTransactionHistory 'otransaction~21972b4d206bd52ea77924efb259c67217edb23b4386580d1bee696f6f864b9b'

[
    {
        "transacted_account": "oaccount~16c38d804413ebabf416360d374f76c973d4e71c74adfde73cc40c7c274883b8",
        "transaction_type": "DEBIT",
        "transaction_id": "otransaction~6e0f8fe4a6430322170b9c619b04b6c9f1c8d257923f611b866bdf69d7fe6cb8~c81e728d9d4c2f636f067f89cc14862c",
        "transacted_amount": 5,
        "timestamp": "2022-04-20T15:52:21.000Z",
        "token_id": "token1",
        "balance": 80,
        "onhold_balance": 0
    },
    {
        "transacted_account": "oaccount~fbf95683b21bbc91a22205819ac1e2e9c90355d536821ed3fe22b7d23915c248",
        "transaction_type": "DEBIT",
        "transaction_id": "otransaction~6e0f8fe4a6430322170b9c619b04b6c9f1c8d257923f611b866bdf69d7fe6cb8~c4ca4238a0b923820dcc509a6f75849b",
        "transacted_amount": 5,
        "timestamp": "2022-04-20T15:52:21.000Z",
        "token_id": "token1",
        "balance": 85,
        "onhold_balance": 0
    }
]

getSubTransactionsByIdWithFilters

Este método devuelve una matriz de detalles de historial de subtransacciones de cuenta para una transacción especificada.

  @Validator(yup.string(), yup.object().nullable())
  public async getSubTransactionsByIdWithFilters(transaction_id: string, filters?: SubTransactionFilters) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getSubTransactionsByIdWithFilters", "TOKEN", { transaction_id });
    return await this.Ctx.Account.getSubTransactionsByIdWithFilters(transaction_id, filters);
  } 

Parámetros:

• transaction_id: string: ID de la transacció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.

Devuelve:

• Matriz de objetos de subtransacción de cuenta en formato JSON para un ID de transacción de transferencia masiva especificado.

Por ejemplo:

ochain invoke GetAccountSubTransactionHistoryWithFilters 'otransaction~21972b4d206bd52ea77924efb259c67217edb23b4386580d1bee696f6f864b9b' '{"PageSize":10,"Bookmark":"1"}'

[
  {
    "transaction_id": "otransaction~6e0f8fe4a6430322170b9c619b04b6c9f1c8d257923f611b866bdf69d7fe6cb8~c81e728d9d4c2f636f067f89cc14862c",
    "transacted_amount": 5,
    "timestamp": "2022-04-20T15:52:21.000Z",
    "token_id": "tokenId",
    "transacted_account": "oaccount~16c38d804413ebabf416360d374f76c973d4e71c74adfde73cc40c7c274883b8",
    "transaction_type": "DEBIT",
    "balance": 80,
    "onhold_balance": 0
  },
  {
    "transaction_id": "otransaction~6e0f8fe4a6430322170b9c619b04b6c9f1c8d257923f611b866bdf69d7fe6cb8~c4ca4238a0b923820dcc509a6f75849b",
    "transacted_amount": 5,
    "timestamp": "2022-04-20T15:52:21.000Z",
    "token_id": "tokenId",
    "transacted_account": "oaccount~fbf95683b21bbc91a22205819ac1e2e9c90355d536821ed3fe22b7d23915c248",
    "transaction_type": "DEBIT",
    "balance": 85,
    "onhold_balance": 0
  }
]

getTransactionById

Este método devuelve el historial de un activo Transaction.

@Validator(yup.string())
    public async getTransactionById(transaction_id: string) {
        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~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
    "history": [
        {
            "trxId": "68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
            "timeStamp": 1629180264,
            "value": {
                "assetType": "otransaction",
                "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
                "token_id": "digiCurr101",
                "from_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
                "to_account_id": "",
                "transaction_type": "BULKTRANSFER",
                "amount": 20,
                "timestamp": "2021-08-17T06:04:24.000Z",
                "number_of_sub_transactions": 2,
                "holding_id": ""
            }
        }
    ],
    "sub_transactions": [
        {
            "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c4ca4238a0b923820dcc509a6f75849b",
            "history": [
                {
                    "trxId": "68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
                    "timeStamp": 1629180264,
                    "value": {
                        "assetType": "otransaction",
                        "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c4ca4238a0b923820dcc509a6f75849b",
                        "token_id": "digiCurr101",
                        "from_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
                        "to_account_id": "oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
                        "transaction_type": "TRANSFER",
                        "amount": 10,
                        "timestamp": "2021-08-17T06:04:24.000Z",
                        "number_of_sub_transactions": 0,
                        "holding_id": ""
                    }
                }
            ]
        },
        {
            "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c81e728d9d4c2f636f067f89cc14862c",
            "history": [
                {
                    "trxId": "68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
                    "timeStamp": 1629180264,
                    "value": {
                        "assetType": "otransaction",
                        "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c81e728d9d4c2f636f067f89cc14862c",
                        "token_id": "digiCurr101",
                        "from_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
                        "to_account_id": "oaccount~digicur~38848e87296d67c8a90918f78cf55f9c9baab2cdc8c928535471aaa1210c706e",
                        "transaction_type": "TRANSFER",
                        "amount": 10,
                        "timestamp": "2021-08-17T06:04:24.000Z",
                        "number_of_sub_transactions": 0,
                        "holding_id": ""
                    }
                }
            ]
        }
    ]
}

deleteHistoricalTransactions

Este método suprime las transacciones más antiguas de la base de datos de estado.

@Validator(yup.date())
    public async deleteHistoricalTransactions(time_to_expiration: Date) {
        await this.Ctx.Auth.checkAuthorization('TRANSACTION.deleteTransactions', 'TOKEN');
        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:

"payload": {
    "msg": "Successfuly deleted transaction older than date: Thu Aug 19 2021 11:19:36 GMT+0000 (Coordinated Universal Time).",
    "transactions": [
        "otransaction~ec3366dd48b4ce2838f820f2f138648e6e55a07226713e59b411ff31b0d21058"
    ]
}

getAccountTransactionHistoryWithFiltersFromRichHistDB

Puede sincronizar los datos con la base de datos de historial enriquecida y, a continuación, recuperar los datos mediante llamadas a la API de código de cadenas. Este método recupera el historial de transacciones de la base de datos de historial enriquecido. Para poder utilizar este método, debe ejecutar Oracle Autonomous Database con Oracle REST Data Services (ORDS) y OAuth activados, como se describe en Oracle Database View Definitions for Wholesale CBDC en Oracle Blockchain Platform Digital Assets Edition.

@GetMethod()
@Validator(yup.string(), yup.string(), yup.string(), yup.string(), yup.string(), yup.object().nullable())
public async getAccountTransactionHistoryWithFiltersFromRichHistDB(token_id: string, org_id: string, user_id: string, custom_endpoint: string, bearer_token: string, filters?: Filters) {
const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountTransactionHistoryWithFilters", "TOKEN", { account_id });
return await this.Ctx.Account.getAccountTrxHistoryWithFiltersFromRichHistDB(account_id, org_id, user_id.toLowerCase(), custom_endpoint, bearer_token, filters);
}

Parámetros:

• token_id: string: ID del token que se debe acuñar.
• 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.
• 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.

getAccountTransactionHistory

Este método devuelve una matriz de detalles de historial de transacciones de 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.

@GetMethod()
@Validator(yup.string(), yup.string(), yup.string())
public async getAccountTransactionHistory(token_id: string, org_id: string, user_id: string) {
const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountTransactionHistory", "TOKEN", { account_id });
return await this.Ctx.Account.getAccountTransactionHistory(account_id, org_id, user_id.toLowerCase());
}

Parámetros:

• token_id: string: ID del token.
• 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:

[
            {
                "transaction_id": "otransaction~64c5a4830949eae1424600f3d4a438c6f603a7c3ea31a68e374b899803999e22",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:37:28.000Z",
                "balance": 550,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REJECT_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~a4537ef34a955b023b7c205b9abf06a6c79e4fdd761fb24f41b8eb34126b66c0",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:36:32.000Z",
                "balance": 550,
                "onhold_balance": 10,
                "token_id": "USD",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "APPROVE_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~6237a759422bd9fb112742e8cd7e6450df5a74a32236d9b1005571afed8904a4",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:36:18.000Z",
                "balance": 540,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REQUEST_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~06b35071415d74aa1a7c18449149c937d886cae76a832c44cf8d98e84586e76e",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:35:46.000Z",
                "balance": 540,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REQUEST_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            }
 ]

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.

@GetMethod()
@Validator(yup.string(), yup.string(), yup.string(), yup.object().nullable())
public async getAccountTransactionHistoryWithFilters(token_id: string, org_id: string, user_id: string, filters?: Filters) {
const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountTransactionHistoryWithFilters", "TOKEN", { account_id });
return await this.Ctx.Account.getAccountTransactionHistoryWithFilters(account_id, org_id, user_id.toLowerCase(), filters);
}

Parámetros:

• token_id: string: ID del token.
• 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.
• 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~64c5a4830949eae1424600f3d4a438c6f603a7c3ea31a68e374b899803999e22",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:37:28.000Z",
                "balance": 550,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REJECT_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~a4537ef34a955b023b7c205b9abf06a6c79e4fdd761fb24f41b8eb34126b66c0",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:36:32.000Z",
                "balance": 550,
                "onhold_balance": 10,
                "token_id": "USD",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "APPROVE_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~6237a759422bd9fb112742e8cd7e6450df5a74a32236d9b1005571afed8904a4",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:36:18.000Z",
                "balance": 540,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REQUEST_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~06b35071415d74aa1a7c18449149c937d886cae76a832c44cf8d98e84586e76e",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:35:46.000Z",
                "balance": 540,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REQUEST_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            }
 ]

getSubTransactionsById

Este método devuelve una matriz de detalles de historial de transacciones de cuenta para un usuario y token especificados. Este método solo lo pueden llamar los Token Admin, Token Auditor o los AccountOwner que han llamado a la transacción.

  @Validator(yup.string())
  public async getSubTransactionsById(transaction_id: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getSubTransactionsById", "TOKEN", { transaction_id });
    return await this.Ctx.Account.getSubTransactionsById(transaction_id);
  }

Parámetros:

• transaction_id: string: ID de la transacción de transferencia masiva.

Devuelve:

• Matriz de objetos de subtransacción de cuenta en formato JSON para un ID de transacción de transferencia masiva especificado.

Por ejemplo:

ochain invoke GetAccountSubTransactionHistory 'otransaction~21972b4d206bd52ea77924efb259c67217edb23b4386580d1bee696f6f864b9b'

[
    {
        "transacted_account": "oaccount~16c38d804413ebabf416360d374f76c973d4e71c74adfde73cc40c7c274883b8",
        "transaction_type": "DEBIT",
        "transaction_id": "otransaction~6e0f8fe4a6430322170b9c619b04b6c9f1c8d257923f611b866bdf69d7fe6cb8~c81e728d9d4c2f636f067f89cc14862c",
        "transacted_amount": 5,
        "timestamp": "2022-04-20T15:52:21.000Z",
        "token_id": "token1",
        "balance": 80,
        "onhold_balance": 0
    },
    {
        "transacted_account": "oaccount~fbf95683b21bbc91a22205819ac1e2e9c90355d536821ed3fe22b7d23915c248",
        "transaction_type": "DEBIT",
        "transaction_id": "otransaction~6e0f8fe4a6430322170b9c619b04b6c9f1c8d257923f611b866bdf69d7fe6cb8~c4ca4238a0b923820dcc509a6f75849b",
        "transacted_amount": 5,
        "timestamp": "2022-04-20T15:52:21.000Z",
        "token_id": "token1",
        "balance": 85,
        "onhold_balance": 0
    }
]

getSubTransactionsByIdWithFilters

Este método devuelve una matriz de detalles de historial de subtransacciones de cuenta para una transacción especificada.

  @Validator(yup.string(), yup.object().nullable())
  public async getSubTransactionsByIdWithFilters(transaction_id: string, filters?: SubTransactionFilters) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getSubTransactionsByIdWithFilters", "TOKEN", { transaction_id });
    return await this.Ctx.Account.getSubTransactionsByIdWithFilters(transaction_id, filters);
  } 

Parámetros:

• transaction_id: string: ID de la transacció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.

Devuelve:

• Matriz de objetos de subtransacción de cuenta en formato JSON para un ID de transacción de transferencia masiva especificado.

Por ejemplo:

ochain invoke GetAccountSubTransactionHistoryWithFilters 'otransaction~21972b4d206bd52ea77924efb259c67217edb23b4386580d1bee696f6f864b9b' '{"PageSize":10,"Bookmark":"1"}'

[
  {
    "transaction_id": "otransaction~6e0f8fe4a6430322170b9c619b04b6c9f1c8d257923f611b866bdf69d7fe6cb8~c81e728d9d4c2f636f067f89cc14862c",
    "transacted_amount": 5,
    "timestamp": "2022-04-20T15:52:21.000Z",
    "token_id": "tokenId",
    "transacted_account": "oaccount~16c38d804413ebabf416360d374f76c973d4e71c74adfde73cc40c7c274883b8",
    "transaction_type": "DEBIT",
    "balance": 80,
    "onhold_balance": 0
  },
  {
    "transaction_id": "otransaction~6e0f8fe4a6430322170b9c619b04b6c9f1c8d257923f611b866bdf69d7fe6cb8~c4ca4238a0b923820dcc509a6f75849b",
    "transacted_amount": 5,
    "timestamp": "2022-04-20T15:52:21.000Z",
    "token_id": "tokenId",
    "transacted_account": "oaccount~fbf95683b21bbc91a22205819ac1e2e9c90355d536821ed3fe22b7d23915c248",
    "transaction_type": "DEBIT",
    "balance": 85,
    "onhold_balance": 0
  }
]

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).

@Validator(yup.string())
    public async getTransactionById(transaction_id: string) {
        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~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
    "history": [
        {
            "trxId": "68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
            "timeStamp": 1629180264,
            "value": {
                "assetType": "otransaction",
                "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
                "token_id": "digiCurr101",
                "from_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
                "to_account_id": "",
                "transaction_type": "BULKTRANSFER",
                "amount": 20,
                "timestamp": "2021-08-17T06:04:24.000Z",
                "number_of_sub_transactions": 2,
                "holding_id": ""
            }
        }
    ],
    "sub_transactions": [
        {
            "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c4ca4238a0b923820dcc509a6f75849b",
            "history": [
                {
                    "trxId": "68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
                    "timeStamp": 1629180264,
                    "value": {
                        "assetType": "otransaction",
                        "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c4ca4238a0b923820dcc509a6f75849b",
                        "token_id": "digiCurr101",
                        "from_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
                        "to_account_id": "oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
                        "transaction_type": "TRANSFER",
                        "amount": 10,
                        "timestamp": "2021-08-17T06:04:24.000Z",
                        "number_of_sub_transactions": 0,
                        "holding_id": ""
                    }
                }
            ]
        },
        {
            "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c81e728d9d4c2f636f067f89cc14862c",
            "history": [
                {
                    "trxId": "68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
                    "timeStamp": 1629180264,
                    "value": {
                        "assetType": "otransaction",
                        "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c81e728d9d4c2f636f067f89cc14862c",
                        "token_id": "digiCurr101",
                        "from_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
                        "to_account_id": "oaccount~digicur~38848e87296d67c8a90918f78cf55f9c9baab2cdc8c928535471aaa1210c706e",
                        "transaction_type": "TRANSFER",
                        "amount": 10,
                        "timestamp": "2021-08-17T06:04:24.000Z",
                        "number_of_sub_transactions": 0,
                        "holding_id": ""
                    }
                }
            ]
        }
    ]
}

deleteHistoricalTransactions

Este método suprime las transacciones más antiguas de la base de datos de estado.

@Validator(yup.date())
    public async deleteHistoricalTransactions(time_to_expiration: Date) {
        await this.Ctx.Auth.checkAuthorization('TRANSACTION.deleteTransactions', 'TOKEN');
        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:

"payload": {
    "msg": "Successfuly deleted transaction older than date: Thu Aug 19 2021 11:19:36 GMT+0000 (Coordinated Universal Time).",
    "transactions": [
        "otransaction~ec3366dd48b4ce2838f820f2f138648e6e55a07226713e59b411ff31b0d21058"
    ]
}

Métodos para la gestión del comportamiento del token: comportamiento minable

• Base
• Activos digitales

issueTokens

Este método acuña tokens, que luego son propiedad del emisor de llamada del método. La persona que llama debe tener una cuenta y el rol de minter. El número de tokens que se pueden extraer está limitado por la propiedad max_mint_quantity del comportamiento mintable en el archivo de especificación. Si no se especifica la propiedad max_mint_quantity, se puede extraer un número ilimitado de tokens. La cantidad debe estar dentro de los valores decimales especificados por el parámetro decimal del comportamiento divisible en el archivo de especificación. Este método solo puede ser llamado por AccountOwner de la cuenta con el rol minter.

@Validator(yup.string(), yup.number().positive())
public async issueTokens(token_id: string, quantity: number) {
    const token_asset = await this.getTokenObject(token_id);
    return await this.Ctx.Token.mint(quantity, token_asset);
}

Parámetros:

• token_id: string: ID del token.
• quantity: el número de tokens que se deben acuñar.

Devuelve:

• En caso de éxito, se mostrará un mensaje con los detalles de la cuenta.

Ejemplo de valor devuelto:

{
    "msg": "Successfully minted 1000 tokens to Account Id: \
oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (Org-Id: Org1MSP, User-Id: user1)  ",
}

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 o cualquier Org Admin del código de cadena.

@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: digiCurr101 is 100 tokens.","quantity":100}

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 o cualquier Org Admin del código de cadena.

@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: digiCurr101 is 0 tokens.","quantity":0}

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.string(), yup.string(), yup.number().positive(), yup.date(), yup.object().nullable())
public async requestMint( token_id: string, operation_id: string, notary_org_id: string, notary_user_id: string, quantity: number, time_to_expiration: Date, info_details?: InfoDetails) {

const token_asset = await this.getTokenObject(token_id);
const notary_account_id = await this.Ctx.Account.generateAccountId(token_id, notary_org_id, notary_user_id);
return await this.Ctx.Token.hold(operation_id, null, notary_account_id, quantity, time_to_expiration, token_asset, HoldOperationType.MINT, info_details);

}

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.
• notary_org_id: string – El ID del proveedor de servicios de membresía (MSP) del notario menor que procesará la solicitud.
• notary_user_id: string: nombre de usuario o ID de correo electrónico del notario menor 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~95be539b4e1e4136dd86a806020c97a930909325340481b8fd88d339874fa699 (Org-Id: Org1MSP, User-Id: admin) has successfully submitted request to mint 100 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);
return await this.Ctx.Token.executeHold(operation_id, token_asset);
}

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 100 tokens to Account Id: oaccount~95be539b4e1e4136dd86a806020c97a930909325340481b8fd88d339874fa699 (Org-Id: Org1MSP, User-Id: admin)"
}

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);
return await this.Ctx.Token.releaseHold(operation_id, token_asset);
}

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 'operation1' to mint 100 tokens of token id token"
}

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);
return await 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 100 tokens to Account Id: oaccount~95be539b4e1e4136dd86a806020c97a930909325340481b8fd88d339874fa699 (Org-Id: Org1MSP, User-Id: admin)"
}

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.

@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: digiCurr101 is 100 tokens.","quantity":100}

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.

@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: digiCurr101 is 0 tokens.","quantity":0}

Métodos para la gestión del comportamiento del token - Comportamiento transferible

• Base
• Activos digitales

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. Este método solo puede ser llamado por AccountOwner de la cuenta.

@Validator(yup.string(), yup.string(), yup.string(), yup.number().positive())
public async transferTokens(token_id: string, to_org_id: string, to_user_id: string, quantity: number) {
   const token_asset = await this.getTokenObject(token_id);
   const to_account_id = await this.Ctx.Account.generateAccountId(token_id, to_org_id, to_user_id);
   return await this.Ctx.Token.transfer(to_account_id, quantity, token_asset);
}

Parámetros:

• token_id: string: ID del token.
• to_org_id: string: ID del proveedor de servicios de membresía (MSP) del receptor (beneficiario) de la organización actual.
• to_user_id: string: nombre de usuario o ID de correo electrónico del receptor.
• quantity: number: número de tokens que se van a transferir.

Devuelve:

• Una vez realizado correctamente, se muestra un mensaje con detalles de las cuentas de pagador y receptor de pago.

Ejemplo de valor devuelto:

{
    "msg": "Successfully transferred 400 tokens from account id: oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (Org-Id: Org1MSP, User-Id: user1) to account id: oaccount~digicur~682bb71de419602af74e3f226345ef308445ca51010737900c112435f676152df (Org-Id: Org1MSP, User-Id: user2) ",
}

bulkTransferTokens

Este método transfiere tokens de forma masiva desde la cuenta del emisor de llamada a las cuentas especificadas en el objeto flow. Las cantidades deben estar dentro de los valores decimales especificados por el parámetro decimal del comportamiento divisible en el emisor de llamada de especificación file.The de este método debe tener una cuenta ya creada. Este método solo puede ser llamado por AccountOwner de la cuenta.

@Validator(yup.string(), yup.array().of(yup.object()))
public async bulkTransferTokens(token_id: string, flow: object[]) {
     const token_asset = await this.getTokenObject(token_id);
     return await this.Ctx.Token.bulkTransfer(flow, token_asset);
}

Parámetros:

• token_id: string: ID del token.
• flow : object[]: matriz de objetos JSON que especifica receptores y cantidades.
  • to_orgId: string: ID del proveedor de servicios de membresía (MSP) del receptor en la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del receptor.
  • quantity: number: número de tokens que se van a transferir.
  Puede especificar el parámetro flow en un formato diferente si utiliza Visual Studio Code frente a la CLI o una recopilación Postman.
  Código de Visual Studio:

  [
    { "to_org_id": "Org1MSP", "to_user_id": "user1", "quantity": 10 },
    { "to_org_id": "Org1MSP", "to_user_id": "user2", "quantity": 10 }
  ]
  

  CLI / Postman:

  "[{ \"to_org_id\": \"Org1MSP\", \"to_user_id\": \"user1\", \"quantity\": 10 }, { \"to_org_id\": \"Org1MSP\", \"to_user_id\": \"user2\", \"quantity\": 10 }]"

Devuelve:

• Mensaje que indica que se ha realizado correctamente.

Ejemplo de valor devuelto:

{
    "msg": "Successfully transferred 20 tokens from Account Id           'oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df' (Org-Id: Org1MSP, User-Id: admin).",
    "from_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
    "sub_transactions": [
        {
            "to_account_id": "oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
            "amount": 10
        },
        {
            "to_account_id": "oaccount~digicur~38848e87296d67c8a90918f78cf55f9c9baab2cdc8c928535471aaa1210c706e",
            "amount": 10
        }
    ]
}

transferTokens

Este método transfiere tokens del emisor de llamada a una cuenta especificada.

@Validator(yup.string(), yup.string(), yup.string(), yup.number().positive(), yup.object().nullable())
public async transferTokens(token_id: string, to_org_id: string, to_user_id: string, quantity: number, info_details?: InfoDetails) {
const token_asset = await this.getTokenObject(token_id);
const to_account_id = await this.Ctx.Account.generateAccountId(token_id, to_org_id, to_user_id);
return await this.Ctx.Token.transfer(to_account_id, quantity, token_asset, info_details);
}

Parámetros:

• token_id: string: ID del token.
• to_org_id: string: ID del proveedor de servicios de membresía (MSP) del receptor (beneficiario) de la organización actual.
• to_user_id: string: nombre de usuario o ID de correo electrónico del receptor.
• 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 100 tokens from account id: oaccount~95be539b4e1e4136dd86a806020c97a930909325340481b8fd88d339874fa699 (Org-Id: Org1MSP, User-Id: admin) to account id: oaccount~7yuijg39b4e1e4136dd86a806020c97a930909325340481b8fdhjklliugbv699 (Org-Id: Org1MSP, User-Id: user)",
}

bulkTransferTokens

Este método transfiere tokens de forma masiva desde la cuenta del emisor de llamada a las cuentas especificadas en el objeto flow. Las cantidades deben estar dentro de los valores decimales especificados por el parámetro decimal del comportamiento divisible en el emisor de llamada de especificación file.The de este método debe tener una cuenta ya creada. Este método solo puede ser llamado por AccountOwner de la cuenta.

@Validator(yup.string(), yup.array().of(yup.object()))
public async bulkTransferTokens(token_id: string, flow: object[]) {
     const token_asset = await this.getTokenObject(token_id);
     return await this.Ctx.Token.bulkTransfer(flow, token_asset);
}

Parámetros:

• token_id: string: ID del token.
• flow : object[]: matriz de objetos JSON que especifica receptores y cantidades.
  • to_orgId: string: ID del proveedor de servicios de membresía (MSP) del receptor en la organización actual.
  • userId: string: nombre de usuario o ID de correo electrónico del receptor.
  • quantity: number: número de tokens que se van a transferir.
  Puede especificar el parámetro flow en un formato diferente si utiliza Visual Studio Code frente a la CLI o una recopilación Postman.
  Código de Visual Studio:

  [
    { "to_org_id": "Org1MSP", "to_user_id": "user1", "quantity": 10 },
    { "to_org_id": "Org1MSP", "to_user_id": "user2", "quantity": 10 }
  ]
  

  CLI / Postman:

  "[{ \"to_org_id\": \"Org1MSP\", \"to_user_id\": \"user1\", \"quantity\": 10 }, { \"to_org_id\": \"Org1MSP\", \"to_user_id\": \"user2\", \"quantity\": 10 }]"

Devuelve:

• Mensaje que indica que se ha realizado correctamente.

Ejemplo de valor devuelto:

{
    "msg": "Successfully transferred 20 tokens from Account Id           'oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df' (Org-Id: Org1MSP, User-Id: admin).",
    "from_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
    "sub_transactions": [
        {
            "to_account_id": "oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
            "amount": 10
        },
        {
            "to_account_id": "oaccount~digicur~38848e87296d67c8a90918f78cf55f9c9baab2cdc8c928535471aaa1210c706e",
            "amount": 10
        }
    ]
}

Métodos para la gestión del comportamiento del token - Comportamiento retenible

• Base
• Activos digitales

holdTokens

Este método crea una retención en nombre del propietario de los tokens con la cuenta to_account_id. Se especifica una cuenta de notario, que 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. El emisor de la llamada de este método debe tener una cuenta ya creada. Este método solo puede ser llamado por AccountOwner de la cuenta.

@Validator(yup.string(), yup.string(), yup.string(), yup.string(), yup.string(), yup.string(), yup.number().positive(), yup.date())
public async holdTokens(
    token_id: string,
    operation_id: string,
    to_org_id: string,
    to_user_id: string,
    notary_org_id: string,
    notary_user_id: string,
    quantity: number,
    time_to_expiration: Date
) {
    const token_asset = await this.getTokenObject(token_id);
    const to_account_id = await this.Ctx.Account.generateAccountId(token_id, to_org_id, to_user_id);
    const notary_account_id = await this.Ctx.Account.generateAccountId(token_id, notary_org_id, notary_user_id);
    return await this.Ctx.Token.hold(operation_id, to_account_id, notary_account_id, quantity, time_to_expiration, token_asset);
}

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.
• to_org_id: string: ID del proveedor de servicios de membresía (MSP) del receptor en la organización actual.
• to_user_id: string: nombre de usuario o ID de correo electrónico del receptor.
• notary_org_id: string: ID del proveedor de servicios de membresía (MSP) del notario en la organización actual.
• notary_user_id: string: nombre de usuario o ID de correo electró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.

Devuelve:

• En caso de éxito, un mensaje con la cuenta del emisor de la llamada y los detalles de retención.

Ejemplo de valor devuelto:

{
  "msg":"AccountId oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (Org-Id: Org1MSP , User-Id: admin) is   successfully holding 10 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);
    return await this.Ctx.Token.executeHold(operation_id, quantity, token_asset);
}

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~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (Org-Id: Org1MSP, User-Id: admin) is successfully executed '10' tokens from Operation Id 'opr_121'."
}

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);
    return await this.Ctx.Token.releaseHold(operation_id, token_asset);
}

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 '10' tokens from Operation Id 'opr_121' to Account Id: oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (Org-Id: Org1MSP, User-Id: user1)."
}

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 del código de cadena, un Org Admin de la organización especificada o el AccountOwner de la cuenta.

  @Validator(yup.string(), yup.string(), yup.string())
  public async getOnHoldIds(token_id: string, org_id: string, user_id: string) {
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getOnHoldIds", "TOKEN", { account_id });
    return await this.Ctx.Account.getOnHoldIds(account_id);
  }

Parámetros:

• token_id: string: ID del token.
• 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 lista JSON de ID de retención.

Ejemplo de valor devuelto:

{"msg":"Holding Ids are: ohold~digicur~digiCurr101~opr_121","holding_ids":["ohold~digicur~digiCurr101~opr_121"]}

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 cualquiera.

@Validator(yup.string(), yup.string())
public async getOnHoldDetailsWithOperationId(token_id: string, operation_id: string) {
    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.

Devuelve:

• En caso de éxito, un objeto de retención JSON que incluya las siguientes propiedades:
• holding_id: ID de tenencia de la transacción.
• operation_id: string: ID único para identificar la operación de retención. Normalmente, la aplicación cliente transfiere este ID.
• from_account_id: ID de cuenta del propietario actual de los tokens retenidos.
• to_account_id: ID de cuenta del receptor.
• notary_account_id: ID de cuenta del notario.
• token_id: string: ID del token guardado.
• quantity: cantidad de tokens que están retenidos para el ID de tenencia.
• time_to_expiration: la duración hasta que caduque la retención.

Ejemplo de valor devuelto:

{
    "assetType": "ohold",
    "holding_id": "ohold~digicur~digiCurr101~opr_121",
    "operation_id": "opr_121",
    "token_name": "digicur",
    "from_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
    "to_account_id": "oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
    "notary_account_id": "oaccount~digicur~38848e87296d67c8a90918f78cf55f9c9baab2cdc8c928535471aaa1210c706e",
    "token_id": "digiCurr101",
    "quantity": 10,
    "time_to_expiration": "2022-08-01T18:30:00.000Z"
}

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.

@Validator(yup.string(), yup.string())
public async getOnHoldBalanceWithOperationId(token_id: string, operation_id: string) {
    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 'opr_121' for token 'digiCurr101' is: 10",
	"holding_balance": 10
}

holdTokens

Este método crea una retención en nombre del propietario de los tokens con la cuenta to_account_id.

@Validator(yup.string(), yup.string(), yup.string(), yup.string(), yup.string(), yup.string(), yup.number().positive(), yup.date(), yup.object().nullable())
  public async holdTokens( token_id: string, operation_id: string, to_org_id: string, to_user_id: string, notary_org_id: string, notary_user_id: string, quantity: number, time_to_expiration: Date, info_details?: InfoDetails) {
    const token_asset = await this.getTokenObject(token_id);
    const to_account_id = await this.Ctx.Account.generateAccountId(token_id, to_org_id, to_user_id);
    const notary_account_id = await this.Ctx.Account.generateAccountId(token_id, notary_org_id, notary_user_id);
    return await this.Ctx.Token.hold(operation_id, to_account_id, notary_account_id, quantity, time_to_expiration, token_asset, HoldOperationType.TRANSFER, info_details);
  }

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.
• to_org_id: string: ID del proveedor de servicios de membresía (MSP) del receptor en la organización actual.
• to_user_id: string: nombre de usuario o ID de correo electrónico del receptor.
• notary_org_id: string: ID del proveedor de servicios de membresía (MSP) del notario en la organización actual.
• notary_user_id: string: nombre de usuario o ID de correo electró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~95be539b4e1e4136dd86a806020c97a930909325340481b8fd88d339874fa699 (Org-Id: Org1MSP, User-Id: admin) 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);
    return await this.Ctx.Token.executeHold(operation_id, quantity, token_asset);
}

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~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (Org-Id: Org1MSP, User-Id: admin) is successfully executed '10' tokens from Operation Id 'opr_121'."
}

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);
    return await this.Ctx.Token.releaseHold(operation_id, token_asset);
}

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 '10' tokens from Operation Id 'opr_121' to Account Id: oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (Org-Id: Org1MSP, User-Id: user1)."
}

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.

  @Validator(yup.string(), yup.string(), yup.string())
  public async getOnHoldIds(token_id: string, org_id: string, user_id: string) {
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getOnHoldIds", "TOKEN", { account_id });
    return await this.Ctx.Account.getOnHoldIds(account_id);
  }

Parámetros:

• token_id: string: ID del token.
• 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 lista JSON de ID de retención.

Ejemplo de valor devuelto:

{"msg":"Holding Ids are: ohold~digicur~digiCurr101~opr_121","holding_ids":["ohold~digicur~digiCurr101~opr_121"]}

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).

@Validator(yup.string(), yup.string())
public async getOnHoldDetailsWithOperationId(token_id: string, operation_id: string) {
    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.

Devuelve:

• En caso de éxito, un objeto de retención JSON que incluya las siguientes propiedades:
• holding_id: ID de tenencia de la transacción.
• operation_id: string: ID único para identificar la operación de retención. Normalmente, la aplicación cliente transfiere este ID.
• from_account_id: ID de cuenta del propietario actual de los tokens retenidos.
• to_account_id: ID de cuenta del receptor.
• notary_account_id: ID de cuenta del notario.
• token_id: string: ID del token guardado.
• quantity: cantidad de tokens que están retenidos para el ID de tenencia.
• time_to_expiration: la duración hasta que caduque la retención.

Ejemplo de valor devuelto:

{
    "assetType": "ohold",
    "holding_id": "ohold~digicur~digiCurr101~opr_121",
    "operation_id": "opr_121",
    "token_name": "digicur",
    "from_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
    "to_account_id": "oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
    "notary_account_id": "oaccount~digicur~38848e87296d67c8a90918f78cf55f9c9baab2cdc8c928535471aaa1210c706e",
    "token_id": "digiCurr101",
    "quantity": 10,
    "time_to_expiration": "2022-08-01T18:30:00.000Z"
}

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).

@Validator(yup.string(), yup.string())
public async getOnHoldBalanceWithOperationId(token_id: string, operation_id: string) {
    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 'opr_121' for token 'digiCurr101' is: 10",
	"holding_balance": 10
}

Métodos para la Gestión del Comportamiento del Token - Comportamiento Quemable

• Base
• Activos digitales

burnTokens

Este método desactiva o quema tokens de la cuenta del emisor de llamada de la transacción. La persona que llama a este método debe tener una cuenta y el rol de quemador. La cantidad debe estar dentro de los valores decimales especificados por el parámetro decimal del comportamiento divisible en el archivo de especificación. Este método puede ser llamado por el AccountOwner de la cuenta con el rol de quemador.

@Validator(yup.string(), yup.number().positive())
public async burnTokens(token_id: string, quantity: number) {
    const token_asset = await this.getTokenObject(token_id);
    return await this.Ctx.Token.burn(quantity, token_asset);
}

Parámetros:

• token_id: string: ID del token.
• quantity: número de tokens que se van a grabar.

Devuelve:

• En caso de éxito, un mensaje de éxito con la cantidad de tokens quemados y el ID de cuenta.

Ejemplo de valor devuelto:

{
    "msg": "Successfully burned 10 tokens from account id: oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (Org-Id: Org1MSP, User-Id: admin)"
}

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, que deben ser menores o iguales a su saldo disponible. Cuando se inicia una solicitud de consumo, el importe especificado se deduce inmediatamente del saldo disponible y se agrega al campo onhold_burn_balance. Si se aprueba la solicitud, los tokens se queman. Si se rechaza la solicitud, los tokens se devuelven del campo onhold_burn_balance al saldo disponible.

@Validator(yup.string(), yup.string(), yup.string(), yup.string(), yup.number().positive(), yup.date(), yup.object().nullable())

public async requestBurn( token_id: string, operation_id: string, notary_org_id: string, notary_user_id: string, quantity: number, time_to_expiration: Date, info_details?: InfoDetails ) {

const token_asset = await this.getTokenObject(token_id);
const notary_account_id = await this.Ctx.Account.generateAccountId(token_id, notary_org_id, notary_user_id);
return await this.Ctx.Token.hold(operation_id, null, notary_account_id, quantity, time_to_expiration, token_asset, HoldOperationType.BURN, null, description);
}

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.
• notary_org_id: string – El ID del proveedor de servicios de membresía (MSP) del notario del quemador que procesará la solicitud.
• notary_user_id: string: nombre de usuario o ID de correo electró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~95be539b4e1e4136dd86a806020c97a930909325340481b8fd88d339874fa699 (Org-Id: Org1MSP, User-Id: admin) has successfully submitted request to mint 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);
return await this.Ctx.Token.executeHold(operation_id, token_asset);
}

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 100 tokens from account id: oaccount~95be539b4e1e4136dd86a806020c97a930909325340481b8fd88d339874fa699 (Org-Id: Org1MSP, User-Id: admin)"
}

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);
return await this.Ctx.Token.releaseHold(operation_id, token_asset);
}

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 'operation1' to burn 100 tokens of token id token",
}

getAccountOnHoldBurnBalance

Este método devuelve el balance de consumo retenido para un usuario especificado. Este método solo lo pueden llamar los usuarios Token Admin, Token Auditor, Org Admin, Org Auditor o el propietario de la cuenta.

@GetMethod()
@Validator(yup.string(), yup.string(), yup.string())
public async getAccountOnHoldBurnBalance(token_id: string, org_id: string, user_id: string) {
  const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
  await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountOnHoldBurnBalance", "TOKEN", { account_id });
  return await this.Ctx.Account.getAccountOnHoldBurnBalance(account_id);
}

Parámetros:

• token_id: string: ID del token que se va a grabar.
• 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": "Total On Hold Burning Balance is: 10",
  "onhold_burn_balance": 10
}

burnTokens

Este método desactiva o quema tokens de la cuenta del emisor de llamada de la transacción.

@Validator(yup.string(), yup.number().positive(), yup.object().nullable())

public async burnTokens(token_id: string, quantity: number, info_details?: InfoDetails) {
const token_asset = await this.getTokenObject(token_id);
return await this.Ctx.Token.burn(quantity, token_asset, info_details);
}

Parámetros:

• token_id: string: ID del token.
• quantity: número de tokens que se van a grabar.
• 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 burned 100 tokens from account id: oaccount~95be539b4e1e4136dd86a806020c97a930909325340481b8fd88d339874fa699 (Org-Id: Org1MSP, User-Id: admin)"
}

Métodos personalizados

Puede utilizar los métodos SDK de token para escribir métodos personalizados para la aplicación de negocio.

Para evitar el doble gasto, no combine varias funciones asíncronas que funcionen en los mismos pares clave-valor en la base de datos de estado. En su lugar, utilice el método bulkTransferTokens para realizar varias transferencias en un solo método.

En el siguiente ejemplo se muestra cómo utilizar métodos de SDK de token en métodos personalizados. Cuando se llama al método buyTicket, transfiere 20 tokens de la cuenta del emisor de llamada a la cuenta del vendedor y devuelve el mensaje de transacción de la transferencia.

@Validator(yup.string(), yup.string(), yup.string(), yup.string(), yup.string())
public async buyTicket(token_id: string, seller_org_id: string, seller_user_id: string) {
	const token = await this.getTokenObject(token_id);

	/**
	* The following method this.Ctx.Account.generateAccountId(token_id, seller_org_id, seller_user_id) generates account id of the seller.
	*/
	const seller_account_id = await this.Ctx.Account.generateAccountId(token_id, seller_org_id, seller_user_id);

	/**
	* The following method this.Ctx.Token.transfer(seller_account_id, 20, token) transfers the quantity 20 from caller's
	* account & to seller's account.
	*/
	const transaction = await this.Ctx.Token.transfer(seller_account_id, 20, token);

	return transaction;
}

Si utiliza más de un método SDK de token en un método personalizado, no utilice métodos que afecten a los mismos pares clave-valor en la base de datos de estado. En el siguiente ejemplo, se muestra la forma incorrecta de realizar varias transferencias:

@Validator(yup.string(), yup.string(), yup.string(), yup.string(), yup.string())
public async sendTokens(token_id: string, user1_org_id: string, user1_user_id: string, user2_org_id: string, user2_user_id: string) {
    const token = await this.getTokenObject(token_id);
    const user1_account_id = await Account.generateAccountId(token_id, user1_org_id, user1_user_id);
    const user2_account_id = await Account.generateAccountId(token_id, user2_org_id, user2_user_id);
    await token.transfer(user1_account_id, 20);
    await token.transfer(user2_account_id, 30);
}

En su lugar, utilice el método bulkTransferTokens para transferir a varias cuentas desde la cuenta del emisor de la llamada, como se muestra en el siguiente fragmento de código.

bulkTransferTokens(token_id: string, flow: object[])

Note:

Si utiliza más de un método SDK de token en un método personalizado que puede afectar a los mismos pares clave-valor en la base de datos de estado, active la optimización de MVCC para los códigos de cadenas de token. Para obtener más información, consulte MVCC Optimization.

Métodos de SDK de token

• Gestión del Control de Acceso
• Gestión de configuración de token
• Gestión de cuentas
• Gestión de Roles
• Gestión de historial de transacciones
• Gestión de comportamiento de token
  • Comportamiento mínimo
  • Comportamiento transferible
  • Comportamiento retenible
  • Comportamiento reproducible

Métodos de Gestión de Control de Acceso

El SDK de token proporciona una función de control de acceso. Algunos métodos solo pueden ser llamados por Token Admin, Org Admin o AccountOwner del token. Puede utilizar esta función para asegurarse de que las operaciones sólo las realizan los usuarios previstos. Cualquier acceso no autorizado genera un error. Para utilizar la función de control de acceso, importe la clase Authorization desde el módulo ../lib/auth.

import { Authorization } from '../lib/auth';

• Base
• Activos digitales

addAdmin

Este método agrega un usuario como Token Admin del código de cadena de token.

Ctx.Admin.addAdmin(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.

Devuelve:

• En caso de éxito, un mensaje de promesa con un objeto JSON que muestra los detalles del usuario agregado como Token Admin del código de cadena de token. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
    "msg": "Successfully added Admin (Org_Id: Org1MSP, User_Id: user1)"
}

removeAdmin

Este método elimina un usuario como Token Admin del código de cadena de token.

Ctx.Admin.removeAdmin(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.

Devuelve:

• En caso de éxito, un mensaje de promesa con un objeto JSON que muestra los detalles del usuario que ya no es un Token Admin del código de cadena de token. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
    "msg": "Successfully removed Admin (Org_Id: Org1MSP, User_Id: user1)"
}

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()

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.

Devuelve:

• Respuesta booleana y mensaje de error si se encuentra un error.

getAllAdmins

Este método devuelve una lista de todos los usuarios que son Token Admin del código de cadena de token.

Ctx.Admin.getAllAdmins()

Parámetros:

• ninguno

Devuelve:

• En caso de éxito, una promesa con un objeto JSON que muestra los detalles de todos los usuarios que son un Token Admin del código de cadena de token. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
    "admins": [
        {
            "orgId": "Org1MSP",
            "userId": "admin"
        }
    ]
}

checkAuthorization

Utilice este método para agregar una comprobación de control de acceso a una operación. Algunos métodos de token solo pueden ser ejecutados por Token Admin o AccountOwner del token o por MultipleAccountOwner para usuarios con varias cuentas. La asignación de control de acceso se describe en el archivo ../lib/constant.ts. Puede modificar el control de acceso editando el archivo ../lib/constant.ts. Para usar su propio control de acceso o desactivar el control de acceso, elimine el código de control de acceso de los métodos de controlador y métodos personalizados generados automáticamente.

export const TOKENACCESS = {
  ADMIN: {
    isUserTokenAdmin: ["Admin", "OrgAdmin"],
    addTokenAdmin: ["Admin"],
    removeTokenAdmin: ["Admin"],
    getAllAdmins: ["Admin", "OrgAdmin"],
    addOrgAdmin: ["Admin", "OrgAdminForOrgId"],
    removeOrgAdmin: ["Admin", "OrgAdminForOrgId"],
    getOrgAdmins: ["Admin", "OrgAdmin"],
  },
  TOKEN: {
    save: ["Admin"],
    getAllTokens: ["Admin", "OrgAdmin"],
    get: ["Admin", "OrgAdmin"],
    update: ["Admin"],
    getDecimals: ["Admin", "OrgAdmin"],
    getTokensByName: ["Admin", "OrgAdmin"],
    addRoleMember: ["Admin", "OrgAdminRoleCheck"],
    removeRoleMember: ["Admin", "OrgAdminRoleCheck"],
    isInRole: ["Admin", "OrgAdminForAccountId", "AccountOwner"],
    getTotalMintedTokens: ["Admin", "OrgAdmin"],
    getNetTokens: ["Admin", "OrgAdmin"],
    getTokenHistory: ["Admin", "OrgAdmin"],
  },
  ROLE: {
    getAccountsByRole: ["Admin"],
    getOrgAccountsByRole: ["Admin", "OrgAdminForOrgId"],
    getUsersByRole: ["Admin"],
    getOrgUsersByRole: ["Admin", "OrgAdminForOrgId"],
  },
  TRANSACTION: {
    deleteTransactions: ["Admin"],
  },ACCOUNT: {
    createAccount: ["Admin", "OrgAdminForOrgId"],
    associateToken: ["Admin", "OrgAdminForAccountId"],
    getAllAccounts: ["Admin"],
    getAllOrgAccounts: ["Admin", "OrgAdminForOrgId"],
    getAccountsByUser: ["Admin", "OrgAdminForOrgId", "MultipleAccountOwner"],
    getAccount: ["Admin", "OrgAdminForAccountId", "AccountOwner"],
    history: ["Admin", "AccountOwner"],
    getAccountTransactionHistory: ["Admin", "OrgAdminForAccountId", "AccountOwner"],
    getAccountTransactionHistoryWithFilters: ["Admin", "OrgAdminForAccountId", "AccountOwner"],
    getSubTransactionsById: ["Admin", "TransactionInvoker"],
    getSubTransactionsByIdWithFilters: ["Admin", "TransactionInvoker"],
    getAccountBalance: ["Admin", "OrgAdminForAccountId", "AccountOwner"],
    getAccountOnHoldBalance: ["Admin", "OrgAdminForAccountId", "AccountOwner"],
    getOnHoldIds: ["Admin", "OrgAdminForAccountId", "AccountOwner"],
    getConversionHistory: ["Admin", "OrgAdminForAccountId", "AccountOwner"],
  },
  ACCOUNT_STATUS: {
    get: ["Admin", "OrgAdminForAccountId", "AccountOwner"],
    history: ["Admin", "OrgAdminForAccountId", "AccountOwner"],
    activateAccount: ["Admin", "OrgAdminForOrgId"],
    suspendAccount: ["Admin", "OrgAdminForOrgId"],
    deleteAccount: ["Admin", "OrgAdminForOrgId"],
  },
  TOKEN_CONVERSION: {
    initializeExchangePoolUser: ["Admin"],
    addConversionRate: ["Admin"],
    updateConversionRate: ["Admin"],
    getConversionRate: ["Admin", "OrgAdmin", "AnyAccountOwner"],
    getConversionRateHistory: ["Admin", "OrgAdmin", "AnyAccountOwner"],
    tokenConversion: ["Admin", "AnyAccountOwner"],
    getExchangePoolUser: ["Admin"],
  },
}

await this.Ctx.Auth.checkAuthorization(<parameters>);

Parámetros:

• classFuncName: string: valor de asignación entre la clase y los métodos, como se describe en el archivo ../lib/constant.ts.
• ...args: argumento de variable donde args[0] toma la constante 'TOKEN' y args[1] toma account_id para agregar una comprobación de control de acceso para un AccountOwner. Para agregar una comprobación de control de acceso para MultipleAccountOwner, args[1] toma org_id y args[2] toma user_id.

Devuelve:

• En caso de éxito, una promesa. En caso de error, rechazo con un mensaje de error.

addOrgAdmin

Este método agrega un usuario como Org Admin de la organización.

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.

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)"
}

getOrgAdmins

Este método devuelve una lista de todos los usuarios que son Org Admin de una organización.

Ctx.Admin.getAllOrgAdmins()

Parámetros:

• ninguno

Devuelve:

• Si se realiza correctamente, una matriz en formato JSON que contiene objetos orgId y userId.

Ejemplo de valor devuelto:

{
    "admins": [
        {
            "org_id": "Org1MSP",
            "user_id": "orgadmin"
        },
        {
            "org_id": "Org1MSP",
            "user_id": "orgadmin1"
        },
        {
            "org_id": "Org1MSP",
            "user_id": "orgadmin2"
        }
    ]
}

addAdmin

Este método agrega un usuario como Token Admin del código de cadena de token.

Ctx.Admin.addAdmin(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.

Devuelve:

• En caso de éxito, un mensaje de promesa con un objeto JSON que muestra los detalles del usuario agregado como Token Admin del código de cadena de token. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
    "msg": "Successfully added Admin (Org_Id: Org1MSP, User_Id: user1)"
}

removeAdmin

Este método elimina un usuario como Token Admin del código de cadena de token.

Ctx.Admin.removeAdmin(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.

Devuelve:

• En caso de éxito, un mensaje de promesa con un objeto JSON que muestra los detalles del usuario que ya no es un Token Admin del código de cadena de token. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
    "msg": "Successfully removed Admin (Org_Id: Org1MSP, User_Id: user1)"
}

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()

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.

Devuelve:

• Respuesta booleana y mensaje de error si se encuentra un error.

getAllAdmins

Este método devuelve una lista de todos los usuarios que son Token Admin del código de cadena de token.

Ctx.Admin.getAllAdmins()

Parámetros:

• ninguno

Devuelve:

• En caso de éxito, una promesa con un objeto JSON que muestra los detalles de todos los usuarios que son un Token Admin del código de cadena de token. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
    "admins": [
        {
            "orgId": "Org1MSP",
            "userId": "admin"
        }
    ]
}

checkAuthorization

Utilice este método para agregar una comprobación de control de acceso a una operación. Algunos métodos de token solo pueden ser ejecutados por Token Admin o AccountOwner del token o por MultipleAccountOwner para usuarios con varias cuentas. La asignación de control de acceso se describe en el archivo ../lib/constant.ts. Puede modificar el control de acceso editando el archivo ../lib/constant.ts. Para usar su propio control de acceso o desactivar el control de acceso, elimine el código de control de acceso de los métodos de controlador y métodos personalizados generados automáticamente.

export const TOKENACCESS = {
  ADMIN: {
    isUserTokenAdmin: ["Admin", "OrgAdmin"],
    addTokenAdmin: ["Admin"],
    removeTokenAdmin: ["Admin"],
    getAllAdmins: ["Admin", "OrgAdmin"],
    addOrgAdmin: ["Admin", "OrgAdminForOrgId"],
    removeOrgAdmin: ["Admin", "OrgAdminForOrgId"],
    getOrgAdmins: ["Admin", "OrgAdmin"],
  },
  TOKEN: {
    save: ["Admin"],
    getAllTokens: ["Admin", "OrgAdmin"],
    get: ["Admin", "OrgAdmin"],
    update: ["Admin"],
    getDecimals: ["Admin", "OrgAdmin"],
    getTokensByName: ["Admin", "OrgAdmin"],
    addRoleMember: ["Admin", "OrgAdminRoleCheck"],
    removeRoleMember: ["Admin", "OrgAdminRoleCheck"],
    isInRole: ["Admin", "OrgAdminForAccountId", "AccountOwner"],
    getTotalMintedTokens: ["Admin", "OrgAdmin"],
    getNetTokens: ["Admin", "OrgAdmin"],
    getTokenHistory: ["Admin", "OrgAdmin"],
  },
  ROLE: {
    getAccountsByRole: ["Admin"],
    getOrgAccountsByRole: ["Admin", "OrgAdminForOrgId"],
    getUsersByRole: ["Admin"],
    getOrgUsersByRole: ["Admin", "OrgAdminForOrgId"],
  },
  TRANSACTION: {
    deleteTransactions: ["Admin"],
  },ACCOUNT: {
    createAccount: ["Admin", "OrgAdminForOrgId"],
    associateToken: ["Admin", "OrgAdminForAccountId"],
    getAllAccounts: ["Admin"],
    getAllOrgAccounts: ["Admin", "OrgAdminForOrgId"],
    getAccountsByUser: ["Admin", "OrgAdminForOrgId", "MultipleAccountOwner"],
    getAccount: ["Admin", "OrgAdminForAccountId", "AccountOwner"],
    history: ["Admin", "AccountOwner"],
    getAccountTransactionHistory: ["Admin", "OrgAdminForAccountId", "AccountOwner"],
    getAccountTransactionHistoryWithFilters: ["Admin", "OrgAdminForAccountId", "AccountOwner"],
    getSubTransactionsById: ["Admin", "TransactionInvoker"],
    getSubTransactionsByIdWithFilters: ["Admin", "TransactionInvoker"],
    getAccountBalance: ["Admin", "OrgAdminForAccountId", "AccountOwner"],
    getAccountOnHoldBalance: ["Admin", "OrgAdminForAccountId", "AccountOwner"],
    getOnHoldIds: ["Admin", "OrgAdminForAccountId", "AccountOwner"],
    getConversionHistory: ["Admin", "OrgAdminForAccountId", "AccountOwner"],
  },
  ACCOUNT_STATUS: {
    get: ["Admin", "OrgAdminForAccountId", "AccountOwner"],
    history: ["Admin", "OrgAdminForAccountId", "AccountOwner"],
    activateAccount: ["Admin", "OrgAdminForOrgId"],
    suspendAccount: ["Admin", "OrgAdminForOrgId"],
    deleteAccount: ["Admin", "OrgAdminForOrgId"],
  },
  TOKEN_CONVERSION: {
    initializeExchangePoolUser: ["Admin"],
    addConversionRate: ["Admin"],
    updateConversionRate: ["Admin"],
    getConversionRate: ["Admin", "OrgAdmin", "AnyAccountOwner"],
    getConversionRateHistory: ["Admin", "OrgAdmin", "AnyAccountOwner"],
    tokenConversion: ["Admin", "AnyAccountOwner"],
    getExchangePoolUser: ["Admin"],
  },
}

await this.Ctx.Auth.checkAuthorization(<parameters>);

Parámetros:

• classFuncName: string: valor de asignación entre la clase y los métodos, como se describe en el archivo ../lib/constant.ts.
• ...args: argumento de variable donde args[0] toma la constante 'TOKEN' y args[1] toma account_id para agregar una comprobación de control de acceso para un AccountOwner. Para agregar una comprobación de control de acceso para MultipleAccountOwner, args[1] toma org_id y args[2] toma user_id.

Devuelve:

• En caso de éxito, una promesa. En caso de error, rechazo con un mensaje de error.

addOrgAdmin

Este método agrega un usuario como Org Admin de la organización.

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.

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)"
}

getOrgAdmins

Este método devuelve una lista de todos los usuarios que son Org Admin de una organización.

Ctx.Admin.getAllOrgAdmins()

Parámetros:

• ninguno

Devuelve:

• Si se realiza correctamente, una matriz en formato JSON que contiene objetos orgId y userId.

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.

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.

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:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "cd81f6c4c9e7c18ece357dbf5c139ef66ef2d6566be3b14de5f6d0a3fd4bb2f0",
        "payload": {
            "msg": "Successfully added Token Auditor (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 196
    }
}

removeTokenAuditor

Este método elimina un usuario como Token Auditor del código de cadena.

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.

Devuelve:

• En caso de éxito, un mensaje que incluye detalles del usuario que se ha eliminado como Token Auditor del código de cadena.

Ejemplo de valor devuelto:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "a886a6040fbc76374a3c78c89ab0ffc9f7b8391cc5239b169bf3b878cf40c67b",
        "payload": {
            "msg": "Successfully removed Token Auditor (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 219
    }
}

getTokenAuditors

Este método devuelve todos los Token Auditors del código de cadena.

this.Ctx.Admin.getAllTokenAuditors()

Ejemplo de valor devuelto:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "auditors": [
                {
                    "org_id": "CB",
                    "user_id": "auditor_user_cb"
                }
            ]
        },
        "encode": "JSON"
    }
}

addOrgAuditor

Este método agrega un usuario como Org Auditor del código de cadena.

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:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "44bbad35a1478cb714e32f7cfd551897868a203520aab9cea5771d3aadc1cf03",
        "payload": {
            "msg": "Successfully added Org Auditor (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 198
    }
}

removeOrgAuditor

Este método elimina un usuario como Org Auditor del código de cadena.

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.

Devuelve:

• En caso de éxito, un mensaje que incluye detalles del usuario que se ha eliminado como Org Auditor del código de cadena.

Ejemplo de valor devuelto:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "c3bc720461004a53b37c68d4bb264858b88d980bc093a0a3ebb62a32974fb306",
        "payload": {
            "msg": "Successfully removed Org Auditor (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 221
    }
}

getOrgAuditors

Este método devuelve todos los Org Auditors del código de cadena.

this.Ctx.Admin.getAllOrgAuditors()

Ejemplo de valor devuelto:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "auditors": [
                {
                    "org_id": "FI1",
                    "user_id": "auditor_user_fi1"
                },
                {
                    "org_id": "FI2",
                    "user_id": "auditor_user_fi2"
                }
            ]
        },
        "encode": "JSON"
    }
}

Métodos para la Gestión de Configuración de Token

save

Este método crea un token y guarda sus propiedades en la base de datos de estado.

Ctx.Token.save(token: <Instance of Token Class>,extraMetadata?:any)

Parámetros:

• token: <Instance of Token Class>: activo de token en el que se va a operar.

Devuelve:

• En caso de éxito, un mensaje de promesa con detalles de token. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
   "assetType":"otoken",
   "token_id":"digiCurr101",
   "token_name":"digicur",
   "token_type":"fungible",
   "behaviors":[
      "divisible",
      "mintable",
      "transferable",
      "burnable",
      "roles"
   ],
   "roles":{
      "minter_role_name":"minter"
   },
   "mintable":{
      "max_mint_quantity":1000
   },
   "divisible":{
      "decimal":2
   },
   "currency_name":"DOLLAR",
   "token_to_currency_ratio":1
}

update

Este método actualiza las propiedades del token. Después de crear un activo de token, solo actualiza el valor token_desc y sus propiedades personalizadas.

Ctx.Token.update(token: <Instance of Token Class>)

Parámetros:

• token: <Instance of Token Class>: activo de token en el que se va a operar.

Devuelve:

• En caso de éxito, un mensaje de promesa con detalles de token. En caso de error, rechazo con un mensaje de error.

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"
   },
   "mintable":{
      "max_mint_quantity":1000
   },
   "divisible":{
      "decimal":2
   },
   "currency_name":"DOLLAR",
   "token_to_currency_ratio":1
}

getTokenDecimals

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.

Ctx.Token.getTokenDecimals(token_id: string)

Parámetros:

• token_id: string: ID del token.

Devuelve:

• En caso de éxito, los decimales del token, en el tipo de dato numérico. En caso de error, se devuelve con un mensaje de error.

Ejemplo de valor devuelto:

1

get

Este método devuelve un objeto de token si está presente en la base de datos de estado.

Ctx.Token.get(token_id: string)

Parámetros:

• token_id: string: ID del token que se va a devolver.

Devuelve:

• En caso de éxito, una promesa con la representación JSON del token. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
    "assetType": "otoken",
    "token_id": "token1",
    "token_name": "account",
    "token_desc": "Token 1",
    "token_type": "fungible",
    "behaviors": [
        "divisible",
        "mintable",
        "transferable",
        "burnable",
        "holdable",
        "roles"
    ],
    "roles": {
        "minter_role_name": "minter",
        "burner_role_name": "burner",
        "notary_role_name": "notary"
    },
    "mintable": {
        "max_mint_quantity": 20000
    },
    "divisible": {
        "decimal": 1
    },
    "token_to_currency_ratio": 2,
    "currency_representation": "EURO"
}

history

Este método devuelve el historial para el token especificado.

Ctx.Token.history(tokenId)

Parámetros:

• tokenId: string: ID del token.

Devuelve:

• En caso de éxito, una promesa con una matriz de los detalles del historial de cuentas para el token especificado. En caso de error, rechazo con un mensaje de error.

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
            }
        }
    }
]

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.

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.

Ejemplo de valor devuelto:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "98e0a0a115803d25b843d630e6b23c435a192a03eb0a301fc9375f05da49a8b2",
        "payload": [
            {
                "key": "token1",
                "valueJson": {
                    "assetType": "otoken",
                    "token_id": "token1",
                    "token_name": "vtok",
                    "token_type": "fungible",
                    "behaviours": [
                        "divisible",
                        "mintable",
                        "transferable",
                        "burnable",
                        "holdable",
                        "roles"
                    ],
                    "roles": {
                        "burner_role_name": "burner",
                        "notary_role_name": "notary"
                    },
                    "mintable": {
                        "max_mint_quantity": 0
                    },
                    "divisible": {
                        "decimal": 1
                    }
                }
            }
        ],
        "encode": "JSON"
    }
}

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.

Devuelve:

• Devuelve una matriz de todos los activos de token del nombre especificado, en formato JSON.

Ejemplo de valor devuelto:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "98e0a0a115803d25b843d630e6b23c435a192a03eb0a301fc9375f05da49a8b2",
        "payload": [
            {
                "key": "token1",
                "valueJson": {
                    "assetType": "otoken",
                    "token_id": "token1",
                    "token_name": "vtok",
                    "token_type": "fungible",
                    "behaviours": [
                        "divisible",
                        "mintable",
                        "transferable",
                        "burnable",
                        "holdable",
                        "roles"
                    ],
                    "roles": {
                        "burner_role_name": "burner",
                        "notary_role_name": "notary"
                    },
                    "mintable": {
                        "max_mint_quantity": 0
                    },
                    "divisible": {
                        "decimal": 1
                    }
                }
            }
        ],
        "encode": "JSON"
    }
}

isTokenType

Este método indica si existe un activo de token con el ID especificado.

Ctx.Token.isTokenType(token_id: string)

Parámetros:

• token_id: string: ID del token que se va a comprobar.

Devuelve:

• En caso de éxito, una promesa con true si existe un activo de token con el ID especificado. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

true

getByRange

Este método llama al método getStateByRange del tejido internamente. Aunque cualquier activo con el ID determinado se devuelva desde la contabilidad, este método convierte el activo en el tipo de activo emisor de llamada.

<Token ClassCtx.Token.getByRange(start_token_id: string, end_token_id: string, token_class_reference?: <Instance of Token Class> )

Parámetros:

• startId: string: clave de inicio del rango. Esta clave está incluida en el rango.
• endId: string: clave final del rango. Esta clave se excluye del rango.
• token: <Instance of Token Class>: activo de token en el que se va a operar.

Devuelve:

• En caso de éxito, una promesa con una matriz de <Token Class>. En caso de error, rechazo con un mensaje de error.

Por ejemplo:

@validator(yup.string(), yup.string())
public async getDigiCurrGetByRange(start_token_id: string, end_token_id: string) {
   return await this.Ctx.Token.getByRange(start_token_id, end_token_id, DigiCurr);
}

Ejemplo de valor devuelto:

[
    {
        "assetType": "otoken",
        "token_id": "token1",
        "token_name": "digicur",
        "token_desc": "Token 1",
        "token_type": "fungible",
        "behaviors": [
            "divisible",
            "mintable",
            "transferable",
            "burnable",
            "holdable",
            "roles"
        ],
        "roles": {
            "minter_role_name": "minter",
            "burner_role_name": "burner",
            "notary_role_name": "notary"
        },
        "mintable": {
            "max_mint_quantity": 20000
        },
        "divisible": {
            "decimal": 0
        },
        "token_to_currency_ratio": 1.5,
        "currency_representation": "USD"
    },
    {
        "assetType": "otoken",
        "token_id": "token2",
        "token_name": "digicur",
        "token_desc": "Token2",
        "token_type": "fungible",
        "behaviors": [
            "divisible",
            "mintable",
            "transferable",
            "burnable",
            "holdable",
            "roles"
        ],
        "roles": {
            "minter_role_name": "minter",
            "burner_role_name": "burner",
            "notary_role_name": "notary"
        },
        "mintable": {
            "max_mint_quantity": 20000
        },
        "divisible": {
            "decimal": 0
        },
        "token_to_currency_ratio": 1,
        "currency_representation": "EURO"
    }
]

Métodos para la gestión de cuentas

getCallerAccountId

Este método devuelve el ID de cuenta del emisor de la llamada.

Ctx.Account.getCallerAccountId(token_id: string)

Parámetros:

• tokenId: string: ID del token.

Devuelve:

• En caso de éxito, una promesa con el ID de cuenta de emisor de llamada. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f

generateAccountId

Este método devuelve un ID de cuenta, que es un juego alfanumérico de caracteres, con el prefijo oaccount~<token asset name>~ y seguido de un hash del nombre de usuario o el ID de correo electrónico (user_id) del propietario de la instancia o del usuario que está conectado a la instancia, el ID de proveedor de servicios de afiliación (org_id) del usuario de la organización de red actual y el ID de token único (token_id).

Ctx.Account.generateAccountId(token_id: string, org_id: string, user_id: string)

Parámetros:

• tokenId: string: ID del token.
• orgId: string: ID del proveedor de servicios de afiliación (MSP) del usuario de la organización actual.
• userId: string: nombre de usuario o ID de correo electrónico del usuario.

Devuelve:

• En caso de éxito, un compromiso con el ID de cuenta generado. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f

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. Las cuentas realizan un seguimiento del saldo de un usuario, el saldo retenido y el historial de transacciones. Un ID de cuenta es un juego alfanumérico de caracteres, con el prefijo oaccount~<token asset name>~ y seguido de un hash del nombre de usuario o el ID de correo electrónico (user_id) del propietario de la instancia o del usuario que está conectado a la instancia, el ID de proveedor de servicios de afiliación (org_id) del usuario de la organización de red actual. Este método solo puede ser llamado por el Token Admin del código de cadena o por un Org Admin de la organización especificada.

this.Ctx.Account.createAccount(org_id: string, user_id: string, token_type: 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.
• token_type: string: tipo del token, que debe ser fungible.

Devuelve:

• En caso de éxito, el nuevo objeto de cuenta en formato JSON.

Ejemplo de valor devuelto:

{
  "assetType": "oaccount",
  "bapAccountVersion": 0,
  "account_id": "oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb",
  "user_id": "admin",
  "org_id": "Org1MSP",
  "token_type": "fungible",
  "token_id": "",
  "token_name": "",
  "balance": 0,
  "onhold_balance": 0
}

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.

async associateTokenToAccount(account_id: string, token_id: string)

Parámetros:

• account_id: string: ID de la cuenta.
• token_id: string: ID del token.

Devuelve:

• En caso de éxito, un objeto JSON de la cuenta actualizada.

Ejemplo de valor devuelto:

{
    "assetType": "oaccount",
    "bapAccountVersion": 0,
    "account_id": "oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb",
    "user_id": "admin",
    "org_id": "Org1MSP",
    "token_type": "fungible",
    "token_id": "fungible",
    "token_name": "fiatmoneytok",
    "balance": 0,
    "onhold_balance": 0
}

getAccountWithStatus

Este método devuelve los detalles de la cuenta para una cuenta especificada, incluido el estado de la cuenta.

Ctx.Account.getAccountWithStatus(account_id: string)

Parámetros:

• account_id: string: ID de la cuenta.

Devuelve:

• En caso de éxito, una promesa con los detalles de la cuenta. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
  "bapAccountVersion": 0,
  "assetType": "oaccount",
  "status": "active",
  "account_id": "oaccount~2de8db6b91964f8c9009136831126d3cfa94e1d00c4285c1ea3e6d1f36479ed4",
  "user_id": "idcqa",
  "org_id": "appdev",
  "token_type": "fungible",
  "token_id": "t1",
  "token_name": "obptok",
  "balance": 0,
  "onhold_balance": 0
}

getAccount

Este método devuelve los detalles de la cuenta para una cuenta especificada.

Ctx.Account.getAccount(account_id: string)

Parámetros:

• account_id: string: ID de la cuenta.

Devuelve:

• En caso de éxito, una promesa con los detalles de la cuenta. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
   "assetType":"oaccount",
   "bapAccountVersion": 0,
   "account_id":"oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
   "user_id":"user1",
   "org_id":"Org1MSP",
   "token_id":"digiCurr101",
   "token_name":"digicur",
   "balance":0,
   "onhold_balance":0
}

history

Este método devuelve una matriz de los detalles del historial de cuentas para una cuenta especificada.

Ctx.Account.history(account_id: string)

Parámetros:

• account_id: string: ID de la cuenta.

Devuelve:

• En caso de éxito, una promesa con la matriz de detalles del historial de cuentas. En caso de error, rechazo con un mensaje de error. El valor devuelto es el mismo que el método getAccountHistory.

Ejemplo de valor devuelto:

[
    {
      "trxId":"2gsdh17fff222467e5667be042e33ce18e804b3e065cca15de306f837e416d7c3e",
      "timeStamp":1629718288,
      "value":{
         "assetType":"oaccount",
         "account_id":"oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
         "user_id":"user1",
         "org_id":"Org1MSP",
         "token_id":"digiCurr101",
         "token_name":"digicur",
         "balance":100,
         "onhold_balance":0,
         "bapAccountVersion": 1
   },
   {
      "trxId":"9fd07fff222467e5667be042e33ce18e804b3e065cca15de306f837e416d7c3e",
      "timeStamp":1629718288,
      "value":{
         "assetType":"oaccount",
         "account_id":"oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
         "user_id":"user1",
         "org_id":"Org1MSP",
         "token_id":"digiCurr101",
         "token_name":"digicur",
         "balance":0,
         "onhold_balance":0,
         "bapAccountVersion": 0
      }
   }
]

getAccountOnHoldBalance

Este método devuelve el saldo retenido de una cuenta especificada.

Ctx.Account.getAccountOnHoldBalance(account_id: string)

Parámetros:

• account_id: string: ID de la cuenta.

Devuelve:

• En caso de éxito, una promesa con un objeto JSON que muestra el saldo retenido para la cuenta especificada. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
   "holding_balance":0,
   "msg":"Total Holding Balance of Account Id oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f (org_id: Org1MSP, user_id: user1) is 0"
}

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.

Ctx.Account.getAllAccounts()

Parámetros:

• ninguno

Devuelve:

• En caso de éxito, una promesa con un objeto JSON que muestre todas las cuentas. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

[
           {
               "key": "oaccount~digicur~2e2ef3375ae347cbd7b4d3d7be5cece803f9c36a184aaf2b8d332c5d2dcead52",
               "valueJson": {
                   "assetType": "oaccount",
                   "account_id": "oaccount~digicur~2e2ef3375ae347cbd7b4d3d7be5cece803f9c36a184aaf2b8d332c5d2dcead52",
                   "user_id": "admin",
                   "org_id": "Org1MSP",
                   "token_id": "digiCurr101",
                   "token_name": "digicur",
                   "bapAccountVersion": 0,
                   "balance": 0,
                   "onhold_balance": 0
               }
           },
           {
               "key": "oaccount~digicur~30080c7e5ba94035af57fbbccbbb495e92515e4b2b3dbcd476eb1c0343e4da65",
               "valueJson": {
                   "assetType": "oaccount",
                   "account_id": "oaccount~digicur~30080c7e5ba94035af57fbbccbbb495e92515e4b2b3dbcd476eb1c0343e4da65",
                   "bapAccountVersion": 0,
                   "user_id": "user1",
                   "org_id": "Org1MSP",
                   "token_id": "digiCurr101",
                   "token_name": "digicur",
                   "balance": 0,
                   "onhold_balance": 0
               }
           },
           {
               "key": "oaccount~digicur~cbde438258cb01a82f71a9a9f8029243c40c6d836a505432120529c2b3c2ff0c",
               "valueJson": {
                   "assetType": "oaccount",
                   "account_id": "oaccount~digicur~cbde438258cb01a82f71a9a9f8029243c40c6d836a505432120529c2b3c2ff0c",
                   "bapAccountVersion": 0,
                   "user_id": "user2",
                   "org_id": "Org1MSP",
                   "token_id": "digiCurr101",
                   "token_name": "digicur",
                   "balance": 0,
                   "onhold_balance": 0
               }
           },
           {
               "key": "oaccount~digicur~ecbc3aefcc562d3049c988717940195b30297e95012b7824bbd33a57ca50a626",
               "valueJson": {
                   "assetType": "oaccount",
                   "account_id": "oaccount~digicur~ecbc3aefcc562d3049c988717940195b30297e95012b7824bbd33a57ca50a626",
                   "bapAccountVersion": 0,
                   "user_id": "user3",
                   "org_id": "Org1MSP",
                   "token_id": "digiCurr101",
                   "token_name": "digicur",
                   "balance": 500,
                   "onhold_balance": 0
               }
           }
       ]

getUserByAccountId

Este método devuelve los detalles de usuario de una cuenta especificada.

Ctx.Account.getUserByAccountId(account_id: string)

Parámetros:

• account_id: string: ID de la cuenta.

Devuelve:

• En caso de éxito, una promesa con un objeto JSON que incluya tres propiedades:
  • 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.
  • token_id: ID del token.
• En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
   "token_id": "digiCurr101",
   "user_id": "user1",
   "org_id": "Org1MSP"
}

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 de la cuenta.

Devuelve:

• En caso de éxito, un mensaje de promesa con un objeto JSON que incluye dos propiedades:
  • msg: mensaje que muestra el saldo actual.
  • user_balance: valor numérico del saldo actual.
• En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
    "msg": "Current Balance is: 200",
    "user_balance": 200
}

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.

Devuelve:

• Si se realiza correctamente, se muestra una lista de todas las cuentas de la organización especificada.

Ejemplo de valor devuelto:

[
    {
        "key": "oaccount~2de8db6b91964f8c9009136831126d3cfa94e1d00c4285c1ea3e6d1f36479ed4",
        "valueJson": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~2de8db6b91964f8c9009136831126d3cfa94e1d00c4285c1ea3e6d1f36479ed4",
            "user_id": "idcqa",
            "org_id": "appdev",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "fiatmoneytok",
            "balance": 0,
            "onhold_balance": 0
        }
    },
    {
        "key": "oaccount~620fcf5deb5fd5a65c0b5b10fda129de0f629ccd232c5891c130e24a574df50a",
        "valueJson": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~620fcf5deb5fd5a65c0b5b10fda129de0f629ccd232c5891c130e24a574df50a",
            "user_id": "example_minter",
            "org_id": "appdev",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "fiatmoneytok",
            "balance": 0,
            "onhold_balance": 0
        }
    }
]

Métodos para la gestión de roles

addRoleMember

Este método agrega un rol a un usuario y token especificados.

Ctx.Token.addRoleMember(role: string, account_id: string, token: <Instance of Token Class>)

Parámetros:

• 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.
• account_id: number: ID de cuenta al que agregar el rol.
• token: <Instance of Token Class>: activo de token en el que se va a operar.

Devuelve:

• En caso de éxito, una promesa con un mensaje de éxito. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
    "msg":"Successfully added role minter to oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f (org_id :          Org1MSP, user_id : user1)"
}

removeRoleMember

Este método elimina un rol de un usuario y token especificados.

Ctx.Token.removeRoleMember(role: string, account_id: string, token: <Instance of Token Class>)

Parámetros:

• role: string: nombre del rol que se va a eliminar para el 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.
• account_id: number: ID de cuenta del que eliminar el rol.
• token: <Instance of Token Class>: activo de token en el que se va a operar.

Devuelve:

• En caso de éxito, una promesa con un mensaje de éxito. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
  "msg":"successfully removed member_id oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f (org_id : Org1MSP, user_id : user1) from role minter"
}

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.

Devuelve:

• En caso de éxito, una promesa con un objeto JSON que muestra todas las cuentas para el token y el rol especificados. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
    "accounts": [
        "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
        "oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f"
    ]
}

getAccountsByUser

Este método devuelve una lista de todos los ID de cuenta de un usuario especificado.

async getAccountsByUser(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:

• En caso de éxito, una matriz JSON de ID de cuenta.

Ejemplo de valor devuelto:

{"accounts":["oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f"]}

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.

Devuelve:

• En caso de éxito, una promesa con un objeto JSON que muestra todos los usuarios para el token y el rol especificados. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
   "users":[
      {
         "token_id":"digiCurr101",
         "user_id":"user1",
         "org_id":"Org1MSP"
      }
   ]
}

isInRole

Este método indica si un usuario y un token tienen un rol especificado.

Ctx.Token.isInRole(role: string, account_id: string, token: <Instance of Token Class>)

Parámetros:

• role: string: nombre del rol que se va a comprobar.
• account_id: number: ID de cuenta que se debe comprobar.
• token: <Instance of Token Class>: activo de token en el que se va a operar.

Devuelve:

• En caso de éxito, una promesa con true si el usuario tiene el rol y false si el usuario no tiene el rol. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{"result":"true"}

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.

Devuelve:

• En caso de éxito, una lista de todas las cuentas con el rol especificado en la organización especificada.

Ejemplo de valor devuelto:

{
    "accounts": [
        "oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb",
        "oaccount~9c650574af9025a6106c8d12a801b079eda9ae2e3399fc2fbd5bd683d738a850"
    ]
}

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.

Devuelve:

• En caso de éxito, una lista de todos los usuarios con el rol especificado en la organización especificada.

Ejemplo de valor devuelto:

{
    "users": [
        {
            "token_id": "token",
            "user_id": "admin",
            "org_id": "Org1MSP"
        },
        {
            "token_id": "token",
            "user_id": "orgAdmin",
            "org_id": "Org1MSP"
        }
    ]
}

roleCheck

Este método comprueba si el ID de cuenta proporcionado es miembro de cualquier rol.

Ctx.Token.roleCheck(account_id: string, token: <Instance of Token Class>)

Parámetros:

• account_id: string: ID de cuenta que se debe comprobar.
• token: <Instance of Token Class>: activo de token en el que se va a operar.

Devuelve:

• Si el ID de cuenta forma parte de cualquier rol, devuelve true. De lo contrario, devuelve false.

Ejemplo de valor devuelto:

{ result: true }

Métodos para la gestión del historial de transacciones

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 de la cuenta.

Devuelve:

• El valor devuelto es el mismo que el método getAccountTransactionHistory.
• En caso de éxito, una promesa con la matriz de objetos de transacción de cuenta:
  • transaction_id: ID de la transacción.
  • transacted_account: cuenta con la que se realizó la transacción.
  • transaction_type: tipo de transacción.
  • transacted_amount: importe de la transacción.
  • timestamp: hora de la transacción.
  • balance: saldo de cuenta en el momento de la transacción.
  • onhold_balance: saldo retenido en el momento de la transacción.
  • sub_transactions: solo para transferencias masivas, una lista de transacciones que forman parte de una transferencia masiva.
  • holding_id: identificador único devuelto por el método holdTokens.
  • token_id: ID del token.
• En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

[
   {
      "transaction_id":"otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
      "transacted_amount":20,
      "timestamp":"2021-08-17T06:04:24.000Z",
      "balance":60,
      "onhold_balance":0,
      "token_id":"digiCurr101",
      "transaction_type":"BULKTRANSFER",
      "sub_transactions":[
         {
            "transacted_account":"oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
            "transaction_type":"CREDIT",
            "transaction_id":"otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c4ca4238a0b923820dcc509a6f75849b",
            "transacted_amount":10
         }
      ]
   },
   {
      "transaction_id":"otransaction~757864d5369bd0539d044caeb3bb4898db310fd7aa740f45a9938771903d43da",
      "transacted_amount":50,
      "timestamp":"2021-08-17T06:02:44.000Z",
      "balance":50,
      "onhold_balance":0,
      "token_id":"digiCurr101",
      "transacted_account":"oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
      "transaction_type":"CREDIT"
   }
]

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.

await this.Ctx.Account.getAccountTransactionHistoryWithFilters(account_id: string, filters?: Filters)

Parámetros:

• account_id: string: ID 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.

Por ejemplo:

ochain invoke getAccountTransactionHistoryWithFilters 'token1' 'appbuilder12' 'user_minter' '{"PageSize":10,"Bookmark":"1","StartTime":"2022-01-25T17:41:42Z","EndTime":"2022-01-25T17:59:10Z"}'

[
    {
        "transaction_id": "otransaction~672897b5a4fa78b421c000e4d6d4f71f3d46529bfbb5b4be10bf5471dc35ce89",
        "transacted_amount": 5,
        "timestamp": "2022-04-20T15:46:04.000Z",
        "token_id": "token1",
        "transacted_account": "oaccount~16c38d804413ebabf416360d374f76c973d4e71c74adfde73cc40c7c274883b8",
        "transaction_type": "DEBIT",
        "balance": 90,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~467bb67a33aaffca4487f33dcd46c9844efdb5421a2e7b6aa2d53152eb2c6d85",
        "transacted_amount": 5,
        "timestamp": "2022-04-20T15:45:47.000Z",
        "token_id": "token1",
        "transacted_account": "oaccount~fbf95683b21bbc91a22205819ac1e2e9c90355d536821ed3fe22b7d23915c248",
        "transaction_type": "DEBIT",
        "balance": 95,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~c6d56ce54a9bbe24597d1d10448e39316dc6f16328bf3c5b0c8ef10e1dfeb397",
        "transacted_amount": 100,
        "timestamp": "2022-04-20T15:44:26.000Z",
        "token_id": "token1",
        "transacted_account": "oaccount~deb5fb0906c40506f6c2d00c573b774e01a53dd91499e651d92ac4778b6add6a",
        "transaction_type": "MINT",
        "balance": 100,
        "onhold_balance": 0
    }
]

getSubTransactionHistory

Este método devuelve una matriz de los detalles del historial de transacciones de una transacción especificada.

await this.Ctx.Account.getSubTransactionHistory(transaction_id)

Parámetros:

• transaction_id: string: ID de la transacción de transferencia masiva.

Por ejemplo:

ochain invoke GetAccountSubTransactionHistory 'otransaction~21972b4d206bd52ea77924efb259c67217edb23b4386580d1bee696f6f864b9b'

[
    {
        "transacted_account": "oaccount~16c38d804413ebabf416360d374f76c973d4e71c74adfde73cc40c7c274883b8",
        "transaction_type": "DEBIT",
        "transaction_id": "otransaction~6e0f8fe4a6430322170b9c619b04b6c9f1c8d257923f611b866bdf69d7fe6cb8~c81e728d9d4c2f636f067f89cc14862c",
        "transacted_amount": 5,
        "timestamp": "2022-04-20T15:52:21.000Z",
        "token_id": "token1",
        "balance": 80,
        "onhold_balance": 0
    },
    {
        "transacted_account": "oaccount~fbf95683b21bbc91a22205819ac1e2e9c90355d536821ed3fe22b7d23915c248",
        "transaction_type": "DEBIT",
        "transaction_id": "otransaction~6e0f8fe4a6430322170b9c619b04b6c9f1c8d257923f611b866bdf69d7fe6cb8~c4ca4238a0b923820dcc509a6f75849b",
        "transacted_amount": 5,
        "timestamp": "2022-04-20T15:52:21.000Z",
        "token_id": "token1",
        "balance": 85,
        "onhold_balance": 0
    }
]

getSubTransactionHistoryWithFilters

Este método devuelve una matriz de los detalles del historial de subtransacciones para una transacción especificada.

await this.Ctx.Account.getSubTransactionHistoryWithFilters(transaction_id: string, filters?: SubTransactionFilters)

Parámetros:

• transaction_id: string: ID de la transacción de transferencia masiva.
• 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.

Por ejemplo:

ochain invoke GetAccountSubTransactionHistoryWithFilters 'otransaction~21972b4d206bd52ea77924efb259c67217edb23b4386580d1bee696f6f864b9b' '{"PageSize":10,"Bookmark":"1"}'

[
    {
        "transaction_id": "otransaction~6e0f8fe4a6430322170b9c619b04b6c9f1c8d257923f611b866bdf69d7fe6cb8~c81e728d9d4c2f636f067f89cc14862c",
        "transacted_amount": 5,
        "timestamp": "2022-04-20T15:52:21.000Z",
        "token_id": "token1",
        "transacted_account": "oaccount~16c38d804413ebabf416360d374f76c973d4e71c74adfde73cc40c7c274883b8",
        "transaction_type": "DEBIT",
        "balance": 80,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~6e0f8fe4a6430322170b9c619b04b6c9f1c8d257923f611b866bdf69d7fe6cb8~c4ca4238a0b923820dcc509a6f75849b",
        "transacted_amount": 5,
        "timestamp": "2022-04-20T15:52:21.000Z",
        "token_id": "token1",
        "transacted_account": "oaccount~fbf95683b21bbc91a22205819ac1e2e9c90355d536821ed3fe22b7d23915c248",
        "transaction_type": "DEBIT",
        "balance": 85,
        "onhold_balance": 0
    }
]

getTransactionById

Este método devuelve el historial de un activo Transaction.

async getTransactionById(transaction_id: string)

Parámetros:

• transaction_id: string: ID del activo de transacción.

Devuelve:

• En caso de éxito, el historial de activos de transacción.

Ejemplo de valor devuelto:

{
    "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
    "history": [
        {
            "trxId": "68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
            "timeStamp": 1629180264,
            "value": {
                "assetType": "otransaction",
                "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
                "token_id": "digiCurr101",
                "from_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
                "to_account_id": "",
                "transaction_type": "BULKTRANSFER",
                "amount": 20,
                "timestamp": "2021-08-17T06:04:24.000Z",
                "number_of_sub_transactions": 2,
                "holding_id": ""
            }
        }
    ],
    "sub_transactions": [
        {
            "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c4ca4238a0b923820dcc509a6f75849b",
            "history": [
                {
                    "trxId": "68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
                    "timeStamp": 1629180264,
                    "value": {
                        "assetType": "otransaction",
                        "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c4ca4238a0b923820dcc509a6f75849b",
                        "token_id": "digiCurr101",
                        "from_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
                        "to_account_id": "oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
                        "transaction_type": "TRANSFER",
                        "amount": 10,
                        "timestamp": "2021-08-17T06:04:24.000Z",
                        "number_of_sub_transactions": 0,
                        "holding_id": ""
                    }
                }
            ]
        },
        {
            "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c81e728d9d4c2f636f067f89cc14862c",
            "history": [
                {
                    "trxId": "68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
                    "timeStamp": 1629180264,
                    "value": {
                        "assetType": "otransaction",
                        "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c81e728d9d4c2f636f067f89cc14862c",
                        "token_id": "digiCurr101",
                        "from_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
                        "to_account_id": "oaccount~digicur~38848e87296d67c8a90918f78cf55f9c9baab2cdc8c928535471aaa1210c706e",
                        "transaction_type": "TRANSFER",
                        "amount": 10,
                        "timestamp": "2021-08-17T06:04:24.000Z",
                        "number_of_sub_transactions": 0,
                        "holding_id": ""
                    }
                }
            ]
        }
    ]
}

deleteHistoricalTransactions

Este método devuelve una matriz de los detalles del historial de transacciones de una cuenta especificada.

async deleteHistoricalTransactions(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.

Devuelve:

• El valor devuelto es el mismo que el método getAccountTransactionHistory.
• En caso de éxito, una promesa con la matriz de objetos de transacción de cuenta:
  • transaction_id: ID de la transacción.
  • transacted_account: cuenta con la que se realizó la transacción.
  • transaction_type: tipo de transacción.
  • transacted_amount: importe de la transacción.
  • timestamp: hora de la transacción.
  • balance: saldo de cuenta en el momento de la transacción.
  • onhold_balance: saldo retenido en el momento de la transacción.
  • sub_transactions: solo para transferencias masivas, una lista de transacciones que forman parte de una transferencia masiva.
  • holding_id: identificador único devuelto por el método holdTokens.
  • token_id: ID del token.
• En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

"payload": {
            "msg": "Successfuly deleted transaction older than date: Thu Aug 19 2021 11:19:36 GMT+0000 (Coordinated Universal Time).",
            "transactions": [
                "otransaction~ec3366dd48b4ce2838f820f2f138648e6e55a07226713e59b411ff31b0d21058"
            ]
        }

Gestión de comportamiento de token

Los métodos de gestión del ciclo de vida del token se basan en los estándares del marco de taxonomía del token. Para utilizar los métodos de ciclo de vida del token, importe la clase Token del módulo ../lib/token.

import { Token } from '../lib/token';

Métodos para la gestión del comportamiento del token: comportamiento minable

mint

Este método acuña una cantidad de tokens, que luego son propiedad del emisor de llamada del método. La persona que llama debe tener una cuenta y el rol de minter. La cantidad debe estar dentro de los valores decimales especificados por el parámetro decimal del comportamiento divisible en el archivo de especificación.

Ctx.Token.mint(quantity: number, token: <Instance of Token Class>)

Parámetros:

• quantity: number: número total de tokens que se deben acuñar.
• token: <Instance of Token Class>: el activo de token que se debe acuñar.

Devuelve:

• En caso de éxito, una promesa con un mensaje de éxito y detalles de toAccount. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
  "msg":"Successfully minted 1000 tokens to Account Id: oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (Org-Id: Org1MSP, User-Id: admin)"
}

getTotalMintedTokens

Este método devuelve el número total de tokens acuñados.

Ctx.Token.getTotalMintedTokens(token: <Instance of Token Class>)

Parámetros:

• token: <Instance of Token Class>: activo de token en el que se va a operar.

Devuelve:

• En caso de éxito, la cantidad de tokens acuñados, en el tipo de datos de número. En caso de error, se devuelve con un mensaje de error.

Ejemplo de valor devuelto:

4000

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: <Instance of Token Class>)

Parámetros:

• token: <Instance of Token Class>: activo de token en el que se va a operar.

Devuelve:

• En caso de éxito, la cantidad de tokens netos, en el tipo de datos de número. En caso de error, se devuelve con un mensaje de error.

Ejemplo de valor devuelto:

2000

getMaxMintQuantity

Este método devuelve la cantidad mínima máxima para un token. Si no se especifica el comportamiento max_mint_quantity, el valor por defecto es 0, que permite la extracción de cualquier número de tokens.

Ctx.Token.getMaxMintQuantity(token: <Instance of Token Class>)

Parámetros:

• token: <Instance of Token Class>: activo de token en el que se va a operar.

Devuelve:

• En caso de éxito, la cantidad mínima máxima del token, en el tipo de dato numérico. En caso de error, se devuelve con un mensaje de error.

Ejemplo de valor devuelto:

20000

Métodos para la gestión del comportamiento del token - Comportamiento transferible

transfer

Este método transfiere tokens del emisor de llamada de transacción a la cuenta to_account_id. El emisor de llamada de este método debe tener una cuenta y la cantidad debe estar dentro de los valores decimales especificados por el parámetro decimal del comportamiento divisible en el archivo de especificación.

Ctx.Token.transfer(to_account_id: string, quantity: number, token: <Instance of Token Class>)

Parámetros:

• to_account_id: string: ID de cuenta para recibir los tokens.
• quantity: number: número total de tokens que se van a transferir.

Devuelve:

• En caso de éxito, una promesa con un mensaje de éxito. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
 "msg":"Successfully transferred 50 tokens from account id: oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (Org-Id: Org1MSP, User-Id: admin) to account id: oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f (Org-Id: Org1MSP, User-Id: user1)"
}

bulkTransfer

Este método transfiere tokens de forma masiva desde la cuenta del emisor de llamada a las cuentas especificadas en el objeto flow. El emisor de la llamada de este método debe tener una cuenta ya creada.

Ctx.Token.bulkTransfer(flow: object[], token: <Instance of Token Class>)

Parámetros:

• flow: object[]: matriz de objetos JSON que especifica los detalles y la cantidad del receptor. La cantidad de transferencia debe estar dentro de los valores decimales especificados por el parámetro decimal del comportamiento divisible en el archivo de especificación. Por ejemplo:

  [{
  	"to_org_id": "Org1MSP",
  	"to_user_id": "user1",
  	"quantity": 10
  }, {
  	"to_org_id": "Org1MSP",
  	"to_user_id": "user2",
  	"quantity": 10
  }]

• token: <Instance of Token Class>: activo de token en el que se va a operar.

Devuelve:

• En caso de éxito, una promesa con un mensaje de éxito e información de cuenta. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
    "from_account_id": "oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
    "msg": "Successfully transferred 2 tokens from Account Id oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f (Org-Id: Org1MSP, User-Id: user1)",
    "sub_transactions": [
        {
            "amount": 1,
            "to_account_id": "oaccount~digicur~38848e87296d67c8a90918f78cf55f9c9baab2cdc8c928535471aaa1210c706e"
        },
        {
            "amount": 1,
            "to_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df"
        }
    ]
}

Métodos para la gestión del comportamiento del token - Comportamiento retenible

hold

Este método crea una retención en nombre del propietario de los tokens con la cuenta to_account_id. Se especifica una cuenta de notario, que 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. El emisor de la llamada de este método debe tener una cuenta ya creada.

Ctx.Token.hold(operation_id: string, to_account_id: string, notary_account_id: string, quantity: number, time_to_expiration: Date, token: <Instance of Token Class>)

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 para recibir los tokens.
• 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: <Instance of Token Class>: el activo de token que se va a retener.

Devuelve:

• En caso de éxito, una promesa con un mensaje de éxito. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
 "msg": "account id: oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (org_id : Org1MSP, user_id : user1) is successfully holding 10 tokens",
}

executeHold

Este método completa una retención de tokens, transfiriendo la cantidad especificada de tokens previamente retenidos al 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.

Ctx.Token.executeHold(operation_id: string, quantity: number, token: <Instance of Token Class>)

Parámetros:

• 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 total de tokens para completar una retención.
• token: <Instance of Token Class>: activo de token para completar una retención.

Devuelve:

• En caso de éxito, una promesa con un mensaje de éxito. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
 "msg": "user with accountId: oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (org_id : Org1MSP, user_id : user1) has successfully executed 5  tokens(digiCurr101) from the hold with Operation Id opr_121",
}

releaseHold

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.

Ctx.Token.releaseHold(operation_id: string, token: <Instance of Token Class>)

Parámetros:

• operation_id: string: ID único para identificar la operación de retención. Normalmente, la aplicación cliente transfiere este ID.
• token: <Instance of Token Class>: el activo de token en el que se libera una retención.

Devuelve:

• En caso de éxito, una promesa con un mensaje de éxito. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
  "msg": "Successfully released 5 tokens from Operation Id opr_121 to Account Id: oaccount~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (org_id : Org1MSP, user_id : user1)",
}

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 de la cuenta.

Devuelve:

• En caso de éxito, una promesa con un objeto JSON que muestra todos los ID de retención de la cuenta especificada. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
   "msg":"Holding Ids are: ohold~digicur~digiCurr101~opr_121",
   "holding_ids":[
      "ohold~digicur~digiCurr101~opr_121"
   ]
}

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 para identificar la operación de retención. Normalmente, la aplicación cliente transfiere este ID.

Devuelve:

• En caso de éxito, un objeto retenido que incluya las siguientes propiedades:
  • holding_id: ID de tenencia de la transacción.
  • operation_id: string: ID único para identificar la operación de retención. Normalmente, la aplicación cliente transfiere este ID.
  • from_account_id: ID de cuenta del propietario actual de los tokens retenidos.
  • to_account_id: ID de cuenta del receptor.
  • notary_account_id: ID de cuenta del notario.
  • token_id: string: ID del token guardado.
  • quantity: cantidad de tokens que están retenidos para el ID de tenencia.
  • time_to_expiration: la duración hasta que caduque la retención.
• En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
    "assetType": "ohold",
    "holding_id": "ohold~digicur~digiCurr101~opr_121",
    "operation_id": "opr_121",
    "token_name": "digicur",
    "from_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
    "to_account_id": "oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
    "notary_account_id": "oaccount~digicur~38848e87296d67c8a90918f78cf55f9c9baab2cdc8c928535471aaa1210c706e",
    "token_id": "digiCurr101",
    "quantity": 10,
    "time_to_expiration": "2022-08-01T18:30:00.000Z"
}

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 para identificar la operación de retención. Normalmente, la aplicación cliente transfiere este ID.

Devuelve:

• En caso de éxito, un objeto de promesa con el saldo retenido para el token e ID de operación especificados. En caso de error, rechazo con un mensaje de error

Ejemplo de valor devuelto:

{
    "msg": "Current Holding Balance of Operation 'op1' for token 'token1' is: 10",
    "holding_balance": 10
}

Métodos para la Gestión del Comportamiento del Token - Comportamiento Quemable

burn

Este método desactiva o quema tokens de la cuenta del emisor de llamada de la transacción. La persona que llama a este método debe tener una cuenta y el rol de quemador. La cantidad debe estar dentro de los valores decimales especificados por el parámetro decimal del comportamiento divisible en el archivo de especificación.

Ctx.Token.burn(quantity: number, token: <Instance of Token Class>)

Parámetros:

• quantity: number: número total de tokens que se van a quemar.
• token: <Instance of Token Class>: el activo de token que se quemará.

Devuelve:

• En caso de éxito, una promesa con un mensaje de éxito. En caso de error, rechazo con un mensaje de error.

Ejemplo de valor devuelto:

{
 "msg":"Successfully burned 10 tokens from account id: oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (Org-Id: Org1MSP, User-Id: admin)"
}