Crie um Projeto Chaincode com a Extensão Blockchain App Builder VS Code

Para criar um Projeto Chaincode ao usar o Blockchain App Builder, você precisa montar um projeto de chaincode a partir de um arquivo de especificação detalhado. Isso gera um projeto com todos os arquivos necessários.

Segundo plano

O Blockchain App Builder inicializa e organiza um projeto de chaincode pronto para você. Com base em uma entrada simples, Criar Novo Chaincode pode gerar projetos de chaincode complexos com recursos como:
  • Vários ativos (modelos) e seus comportamentos (controladores)
  • Gerar automaticamente métodos CRUD (Criar/Ler/Atualizar/Excluir) e não CRUD
  • Validação automática de argumentos
  • Marshalling/unmarshalling de argumentos
  • Capacidade de persistência transparente (ORM)
  • Chamando consultas avançadas
  • Suporte a dados transitórios e privados
  • Gerenciamento de identidades

O projeto gerado segue o padrão de modelo/controlador e decorador, que permite que as propriedades de um ativo mantidas no razão sejam especificadas como campos digitados e estendidas com comportamentos e regras de validação específicos. Isso reduz o número de linhas de código, o que ajuda na legibilidade e na escalabilidade.

Criar um Arquivo de Especificação

Antes de começar, você precisa criar um arquivo de especificação de entrada. Observe que você não pode alterar os arquivos de especificação de amostra que foram instalados como parte do Blockchain App Builder, mas pode duplicá-los ou usá-los como um arquivo de referência para seus próprios arquivos de especificação.

  1. No painel Especificações, selecione Criar Novo Arquivo de Especificação.
  2. O painel Detalhes das Especificações é aberto:
    • Informe o nome do arquivo de especificação.
    • Selecione o tipo de arquivo - YAML e JSON são suportados.
    • Como alternativa, insira uma descrição para o arquivo.
    • O menu suspenso Arquivo de Referência permite gerar seu arquivo de especificação com base em um arquivo pré-existente em seu espaço de trabalho se você tiver um arquivo que gostaria de usar como modelo. Se nada for selecionado, o arquivo criado ficará vazio e você poderá inserir sua especificação do zero.
    • Insira o local onde deseja que o arquivo de especificação seja armazenado no sistema.
    Clique em Salvar.
O novo arquivo de especificação é criado e aparece no painel Especificações. Clique nele para abri-lo no editor.

Importar um Arquivo de Especificação

Se você tiver um arquivo de especificação pré-existente, poderá importá-lo:
  1. No painel Especificações, clique em Mais Ações e selecione Importar Especificação.
  2. Navegue até o arquivo e clique em Importar Especificação.
O arquivo de especificação é importado e aparece no painel Especificações. Clique nele para abri-lo no editor.

Duplicar um Arquivo de Especificação

Você também pode duplicar um arquivo de especificação que já está no painel Especificações clicando com o botão direito do mouse nele e selecionando Duplicar. Clique com o botão direito do mouse no arquivo e selecione Nomear para atualizar o nome.

Os detalhes sobre o conteúdo dos arquivos de especificações são descritos aqui: Arquivo de Especificação de Entrada. Use essas informações e os modelos de especificação de amostra para criar seu conteúdo de especificação.

Validar um Arquivo de Especificação

Se você instalou a extensão YAML Language Support, o arquivo de especificação é validado automaticamente à medida que você digita. Os seguintes recursos de validação são suportados automaticamente:
  • Conclusão do comando
  • Conclusão de nós escalares para padrões de esquema
  • Ajuda contextual quando você passa o mouse sobre uma propriedade ou um método
  • Recuos para itens de matriz à medida que você digita
  • Detecção de erro de sintaxe

Andaime do Projeto Chaincode

Quando você tiver um arquivo de especificação que atenda às suas necessidades, gere seu projeto de chaincode.
  1. No painel Chaincodes, selecione Criar Novo Chaincode.
  2. O painel Detalhes do Codigo é aberto:
    • Informe o nome do seu projeto de chaincode.
    • Selecione o idioma: TypeScript ou Go.
    • Selecione o arquivo de especificação que você está usando para criar o chaincode.
    • Informe o local ou o domínio Go no qual você deseja que o projeto seja criado em seu ambiente de desenvolvimento local.
    Clique em Criar.
Quando seu projeto for criado, ele será mostrado no painel Chaincodes. Todos os arquivos exigidos pelo chaincode estarão no projeto. Para obter uma visão geral detalhada dos arquivos criados, consulte: Para obter uma visão geral detalhada de um projeto baseado em token, consulte também:

Observação:

  • O painel Chaincodes permite abrir e trabalhar com conteúdo dentro do projeto chaincode, mas não permite adicionar, excluir ou renomear arquivos dentro do projeto. Para fazer isso, clique com o botão direito do mouse em seu projeto e selecione Abrir no Explorer. Isso abre o projeto na visualização do VS Code Explorer.
  • Excluir ou renomear arquivos no projeto de chaincode pode potencialmente quebrar o link entre os arquivos do projeto e o arquivo de especificação usado para criá-lo. Se você planeja sincronizar seu código entre os dois, não altere os nomes dos arquivos.

Importar um Projeto Chaincode Existente

Se você criou um projeto de chaincode por meio da CLI ou limpou seu conteúdo de blockchain do VS Code e deseja importar um projeto salvo localmente, no painel Chaincodes, clique no ícone Mais Ações... e selecione Importar Chaincode. Navegue até o projeto e clique em Importar Chaincode.