Pular para o conteúdo
LabS Atlas
Digital Assets
Entrar

Survey Chain Client

Ir para notas que citam esta
atualizado há 25 diasEntre para perguntar ao Labinho sobre esta notaO Labinho é o assistente que responde com as notas e as sessões do LabS e mostra de onde tirou cada resposta.

Survey Chain Client é a biblioteca Java interna que encapsula o Web3j e entrega às aplicações operações de negócio prontas sobre o contrato de pesquisas publicado na blockchain.

Ela nasceu no SurveyChain, o protótipo de pesquisas pelo WhatsApp da bancada Digital Assets. Usar o Web3j diretamente obriga cada aplicação a lidar com detalhes de baixo nível: apontar para a rede, carregar credenciais, montar e assinar transações, tratar retornos pouco amigáveis. A biblioteca concentra essa complexidade num só lugar e aponta direto para o contrato de pesquisas, de modo que quem consome apenas chama operações como criar uma pesquisa ou listar as pesquisas existentes.

Por que encapsular em vez de repetir em cada serviço

O protótipo tinha dois serviços que se conectavam à mesma blockchain, do mesmo jeito, e chamavam os mesmos métodos do mesmo contrato, com a expectativa de ganhar outros consumidores. Um mesmo Contrato Inteligente publicado pode atender várias aplicações ao mesmo tempo; sem uma camada comum, cada uma reimplementaria conexão com a rede, autenticação, validações, contornos de falha e o mapeamento de cada método, e o código ficaria grande e duplicado.

A vantagem mais visível aparece quando um método do contrato muda. Alterar um contrato já publicado é mais delicado do que em tempo de desenvolvimento, e quando a mudança acontece o novo mapeamento e suas validações são ajustados uma única vez, na biblioteca, em vez de replicados em todos os serviços que usam aquele método. A analogia útil é a das bibliotecas de acesso a banco de dados, que escondem os detalhes do driver para que todas as aplicações falem com o banco da mesma forma simplificada.

O que a biblioteca expõe e como está organizada

Os arquivos centrais ficam numa pasta de contratos: a parte de conexão e comunicação com a rede, uma classe cliente com métodos auxiliares (buscar os dados e o recibo de uma transação, efetuar transações) e os métodos que mapeiam o contrato. Cada método segue a regra do Web3j de declarar nome da função, tipos das entradas e tipo do retorno. A criação de pesquisa recebe um valor bytes32 e um uint256 com o prazo, e devolve o endereço da transação; a listagem usa o contorno de consultar primeiro a quantidade de pesquisas e depois buscar cada uma por índice.

A biblioteca também implementa a criação de carteiras, considerada a parte mais difícil de todo o trabalho, mais até do que o mapeamento dos métodos do contrato.

Como uma API consome a biblioteca

A biblioteca é distribuída como um JAR no repositório interno de pacotes (Nexus Repository) e entra no projeto como qualquer outra dependência, ao lado do próprio Web3j. Na API de pesquisas, que cumpre o papel de Backend for Blockchain entre o bot e a rede, criar uma pesquisa leva cerca de três linhas:

  • indicar a credencial do usuário que fará a operação, o que também serve à autorização, já que o contrato pode restringir quem cria pesquisas;
  • gerar um hash único a partir de todos os dados da pesquisa, que permite detectar qualquer alteração posterior, e passá-lo ao método de criação;
  • receber o endereço da transação gerada.

A listagem segue o mesmo padrão: a API informa a credencial, mesmo que o contrato ainda não restrinja a leitura, e chama um único método que devolve todas as pesquisas.

Onde fica o custo

O esforço é concentrado na construção da biblioteca, especialmente na criação de transações e de carteiras. Feito isso, o código da biblioteca costuma ser mais simples do que o dos próprios consumidores, e quem escreve a API começa direto pela lógica de negócio.