Creación de un proyecto de código de cadena con la extensión de código VS de Blockchain App Builder

Para crear un proyecto de código de cadena al utilizar Blockchain App Builder, debe andamiar un proyecto de código de cadena desde un archivo de especificación detallado. Esto genera un proyecto con todos los archivos que necesita.

Antecedentes

Blockchain App Builder inicializa y andamiaja un proyecto de código de cadenas listo para usar. En función de una entrada simple, Crear nuevo código de cadena puede generar proyectos de código de cadena complejos con funciones como:
  • Varios activos (modelos) y sus comportamientos (controladores)
  • Generación automática de métodos CRUD (Crear/Leer/Actualizar/Suprimir) y no CRUD
  • Validación automática de argumentos
  • Marshalling/unmarshalling de argumentos
  • Capacidad de persistencia transparente (ORM)
  • Llamada a consultas enriquecidas
  • Soporte de datos transitorios y privados
  • Gestión de identidad

El proyecto generado sigue el patrón de modelo/controlador y decorador, que permite que las propiedades de un activo mantenidas en el libro mayor se especifiquen como campos con tipo y se amplíen con comportamientos específicos y reglas de validación. Esto reduce el número de líneas de código, lo que ayuda en la legibilidad y escalabilidad.

Creación de un Archivo de Especificación

Antes de empezar, debe crear un archivo de especificación de entrada. Tenga en cuenta que no puede modificar los archivos de especificación de ejemplo que se instalaron como parte de Blockchain App Builder, pero puede duplicarlos o utilizarlos como archivo de referencia para sus propios archivos de especificación.

  1. En el panel Especificaciones, seleccione Crear nuevo archivo de especificación.
  2. Se abre el panel Detalles de especificaciones:
    • Introduzca el nombre del archivo de especificación.
    • Seleccione el tipo de archivo: se admiten YAML y JSON.
    • También puede introducir una descripción para el archivo.
    • La lista desplegable Archivo de Referencia permite generar el archivo de especificación a partir de un archivo preexistente en el espacio de trabajo si tiene un archivo que desea utilizar como plantilla. Si no se selecciona nada, el archivo creado estará vacío y podrá introducir la especificación desde cero.
    • Introduzca la ubicación en la que desea que se almacene el archivo de especificación en el sistema.
    Haga clic en Guardar.
El nuevo archivo de especificación se crea y aparece en el panel Especificaciones. Haz clic en él para abrirlo en el editor.

Importación de un Archivo de Especificación

Si tiene un archivo de especificación preexistente, puede importarlo:
  1. En el panel Especificaciones, haga clic en Más acciones y seleccione Importar especificación.
  2. Busque el archivo y haga clic en Importar especificación.
El archivo de especificación se importa y aparece en el panel Especificaciones. Haz clic en él para abrirlo en el editor.

Duplicar un archivo de especificación

También puede duplicar un archivo de especificación que ya está en el panel Especificaciones haciendo clic con el botón derecho en él y seleccionando Duplicar. Haga clic con el botón derecho en el archivo y seleccione Cambiar nombre para actualizar el nombre.

Los detalles sobre el contenido de los archivos de especificaciones se describen aquí: Input Specification File. Utilice esta información y las plantillas de especificación de ejemplo para crear el contenido de especificación.

Validación de un Archivo de Especificación

Si instaló la extensión YAML Language Support, el archivo de especificación se validará automáticamente a medida que escribe. Las siguientes funciones de validación están soportadas automáticamente:
  • Finalización del comando
  • Finalización de nodos escalares en valores por defecto de esquema
  • Ayuda sensible al contexto al pasar el mouse sobre una propiedad o método
  • Sangra los elementos de la matriz a medida que escribe
  • Detección de errores sintéticos

Andamios del Proyecto Chaincode

Cuando tenga un archivo de especificación que satisfaga sus necesidades, genere su proyecto de código de cadenas.
  1. En el panel Códigos de cadena, seleccione Crear nuevo código de cadena.
  2. Se abre el panel Detalles de código de cadena:
    • Introduzca el nombre del proyecto de código de cadenas.
    • Seleccione el idioma: TypeScript o Go.
    • Seleccione el archivo de especificación que está utilizando para crear el código de cadenas.
    • Introduzca la ubicación o el dominio Go donde desea que se cree el proyecto en el entorno de desarrollo local.
    Haga clic en Create.
Cuando se crea el proyecto, se mostrará en el panel Códigos Caídos. Todos los archivos requeridos por el código de cadenas estarán en el proyecto. Para obtener una descripción general detallada de los archivos creados, consulte: Para obtener una visión general detallada de un proyecto basado en token, consulte también:

Note:

  • El panel Códigos de cadena permite abrir y trabajar con contenido dentro del proyecto de código de cadena, pero no le permitirá agregar, suprimir ni cambiar el nombre de los archivos dentro del proyecto. Para ello, haga clic con el botón derecho en el proyecto y seleccione Abrir en el explorador. Esto abre el proyecto en la vista Explorador de códigos VS.
  • La supresión o el cambio de nombre de archivos en el proyecto de código de cadenas puede romper el enlace entre los archivos de proyecto y el archivo de especificación utilizado para crearlo. Si planea sincronizar el código entre los dos, no cambie los nombres de archivo.

Importación de un proyecto de código de cadena existente

Si ha creado un proyecto de código de cadenas a través de la CLI o ha limpiado el contenido de cadena de bloques de VS Code y desea importar un proyecto guardado localmente, en el panel Códigos de cadenas, haga clic en el icono Más acciones... y seleccione Importar código de cadena. Vaya al proyecto y haga clic en Import Chaincode.