El pasado 17 de octubre comenzó la nueva temporada del MeetUp Blockchain Developers, realizando el séptimo encuentro en la sala de Telefónica Flagship Store, titulado “Monax & Hyperledger Burrow Workshop”. En el evento, Miguel Martínez (yo mismo), miembro del equipo de Blocknitive, realizó una presentación sobre la plataforma Hyperledger Burrow desde un punto de vista técnico. También contamos con la presencia de una de las empresas impulsoras del proyecto, Monax Industries. Chenxiao Hu Wu, Producer Experience Success, expuso la plataforma que lanzaron en abril de 2018, llamada Agreements Network. Para aquellos que no pudieron asistir, hemos subido el video a nuestro canal de Youtube.
Este post va dirigido a aquellos que quieran refrescar la segunda y última parte del workshop sobre Hyperledger Burrow. En esta parte nos pusimos manos a la obra y explicamos los primeros pasos a seguir para trabajar con esta plataforma. Estos mismos pasos se van a detallar a continuación, e incluyen las siguientes tareas:
- Descarga e instalación de la última versión de Burrow
- Permisionado de cuentas, configuración y lanzamiento del nodo Burrow
- Ejecución de una transacción entre cuentas
- Despliegue de un contrato inteligente escrito en Solidity
- Interacción con el contrato utilizando JavaScript
¡Comencemos!
Hyperledger Burrow aún está en estado de incubación, pero todo el código se encuentra disponible en su repositorio de GitHub por lo que podemos descargarle y empezar a probarle. Para instalar Burrow en nuestra máquina, tenemos dos opciones: descargar el repositorio completo y construir un binario a partir de éste utilizando un compilador Go, o descargarnos directamente el binario correspondiente a nuestra arquitectura.
Vamos a seguir la segunda opción. Para ello nos dirigimos a la opción de Releases del repositorio y descargamos el binario de su última versión (actualmente, la 0.22) para Linux x86_64. La arquitectura de mi equipo es de 64 bits, vosotros podréis comprobar la vuestra ejecutando el comando uname -a. Este workshop se ha realizado con el sistema operativo Ubuntu 16.04 LTS. A continuación podeis encontrar los requisitos que necesitáis, y un enlace para descargarlos.
Antes de nada, procedemos a descargar este repositorio.
cd $HOME
git clone https://github.com/blocknitive/workshop_hyperledger_burrow.git
cd $HOME/workshop_hyperledger_burrow
Nos movemos a una nueva carpeta, descargamos el binario 0.22 y descomprimimos el archivo:
mkdir $HOME/burrowchain && cd $HOME/burrowchain
wget https://github.com/hyperledger/burrow/releases/download/v0.22.0/burrow_0.22.0_Linux_x86_64.tar.gz
tar xvf burrow_0.22.0_Linux_x86_64.tar.gz
sudo cp burrow /bin/burrow
PATH=$PATH:/bin/burrow
Nota: Si quieres mantener esta instalación de forma indefinida debes introducir la última instrucción en archivos como ~/.profile o ~/.bash_profile.
Para comprobar que el cliente del nodo Burrow está instalado correctamente, ejecutamos:
burrow --version
De forma análoga a Ethereum, para especificar las cuentas existentes se debe construir un archivo de configuración. Para ello, nos servimos de una de las opciones que nos provee el comando.
burrow spec -f 1 -p 3 > genesis-spec.json
Con ese comando hemos creado una cuenta con todos los permisos (incluido el de validar bloques), y tres cuentas participantes. Vamos a redefinir los permisos que tiene asignados cada cuenta, tomando como referencia lo indicado en la siguiente tabla. Para ello, modificamos el fichero que se ha creado, genesis-spec.json.
| Nombre | Permisos |
|---|---|
| Full | [ all ] |
| Operator | [ send, call, createContract, name, hasRole ] |
| Writer | [ call, name, hasRole ] |
| RgReader | [ name, hasRole ] |
De esta manera, las cuentas creadas podrán realizar determinadas acciones de acuerdo con los permisos indicados:
- Full: cuenta con todos los permisos de la plataforma, incluido el permiso del que deben disponer las cuentas validadoras (bond). Como nuestra red solo tendrá 1 nodo, y éste debe ser validador, sólo podrá haber una cuenta validadora. Además, podrá realizar cualquier operación.
- Operator: dispone de los permisos necesarios para leer y ejecutar transacciones. Podrá desplegar smart contracts y llamar a sus funciones de lectura y escritura.
- Writer: podrá realizar las mismas acciones que la cuenta anterior, excepto la de desplegar contratos.
- RgReader: solo podrá tener acceso al registro de Burrow. No puede realizar transacciones ni llamar a código de smart contracts.
Una vez, realizada la especificación de las cuentas, pasamos a configurar el nodo Burrow. Utilizamos la opción burrow configure para crear el archivo de configuración .toml que después modificaremos a nuestro gusto.
burrow configure -s genesis-spec.json -n “BlockchainDevelopersChain” > burrow.toml
El archivo de configuración creado está dividido en varias partes:
- GenesisDoc: sobre las cuentas y sus permisos. Se listan en primer lugar todas las cuentas, y después por separado las cuentas validadoras. Las variables Perms y SetBit de GlobalPermisions.Base sirven para establecer los permisos que tendrán todas las cuentas por defecto. Establecemos dichas variables a 0 para que la configuración realizada anteriormente tenga efecto.
- Tendermint: sobre la red de nodos Burrow.
- RPC: sobre los puertos que expone en el nodo Burrow para interactuar con él. Se puede habilitar o deshabilitar cada uno de ellos. Habilitamos todos para poder probarles.
- Logging: sobre el histórico log que se crea durante la ejecución del cliente.
El aspecto de este archivo de configuración debe ser parecido a burrow.toml.old.
¡Está todo listo para lanzar nuestra blockchain Burrow y empezar a jugar con ella! Para arrancar el nodo debemos seleccionar que cuenta validadora usar. En este caso usaremos la primera cuenta (y la única) de la lista de cuentas validadoras.
burrow start -v 0 2>burrow.log &
Para comprobar que Burrow esta funcionando correctamente debemos verificar que se están agregando bloques a la cadena, y que por lo tanto, se va incrementando la altura.
tail -10 burrow.log | grep height
Asimismo, podemos acceder a dos de los endpoints que provee Burrow desde el navegador. Si no hemos cambiado las direcciones por defecto de la configuración de RPC, en la dirección localhost:26658 se puede ver información general de la cadena de bloques, y en localhost:9102\metrics métricas del nodo en tiempo real.
Vamos a enviar una transacción de 5 unidades desde la cuenta Full a Operator. De forma que la primera cuenta tendrá 5 unidades menos que antes y, la segunda, 5 unidades más. Primero, debemos saber las claves públicas de ambas cuentas. Ejecutamos el siguiente comando para saber las claves las cuáles dispone nuestro nodo.
burrow keys list
Nos vemos a la carpeta workspace1 y modificamos el fichero sendTransaction.yaml para cambiar la dirección destino por la clave pública de Operator. En ese archivo -yaml se pueden indicar los trabajos que queremos que se realicen. En este caso, el único trabajo que se ejecutará será el envío de la transacción.
Para ejecutarlo, debemos seleccionar el fichero que contiene los trabajos que se quieren lanzar y la address de la cuenta origen. La ejecución del trabajo produce un output que indica el hash de la transacción que se ha realizado.
burrow deploy --address 8410DE15FDB4171D7A357B2DBF28C65F709EF084 -f sendTransaction.yaml
Con nuestro navegador podemos dirigirnos a la dirección localhost:26658/accounts y comprobar el cambio de “Amount” en ambas cuentas. ¡Acabamos de realizar nuestra primera transacción con Hyperledger Burrow!
Hyperledger Burrow es capaz de ejecutar contratos inteligentes escritos en Solidity, pues cuenta con una EVM compatible con la de Ethereum. Además, es posible establecer diferentes permisos a las cuentas existentes, determinando así su comportamiento en la red. Vamos a centrarnos en estas dos funcionalidades, desplegando nuestro propio smart contract e interactuando con él.
A continuación, se presenta el smart contract que usaremos (UsuarioRegistro.sol). En Blocknitive tenemos pensado realizar un hackathon en un futuro y con este contrato pensamos mantener el registro de los usuarios que se apuntan a la competición. El contrato cuenta con dos funciones: una para leer el nombre del registro (no conlleva realizar una transacción, pues es constant) y otra para cambiarlo (conlleva la ejecución de una transacción).
pragma solidity ^0.4.18;
contract HackathonBlocknitive {
string nombreRegistro;
constructor() {
nombreRegistro = "Hackathon de Blocknitive";
}
function getNombreRegistro() constant public returns (string) {
return nombreRegistro;
}
function setNombreRegistro(string _nombre) public {
nombreRegistro = _nombre;
}
}Antes de desplegar el contrato, nos aseguramos de que nuestro nodo Burrow está funcionando. Para ello, nos movemos a nuestro directorio de trabajo, leemos el log y verificamos si se están añadiendo nuevos bloques a la cadena. Para ello, ejecutamos el siguiente comando:
cd $HOME/workshop_hyperledger_burrow
tail -5 burrow.log | grep height
Asimismo, podemos comprobar los puertos abiertos de escucha del nodo. Los puertos que mantiene abiertos depende de su configuración, pero tal y como lo indicamos en el segundo paso del tutorial deben ser: 6060, 26658, 10997, 9102 y 26656.
netstat -nepal | grep burrow
Si vuestro nodo Burrow no funciona correctamente y no detectáis el error, siempre podéis reiniciar el estado de la cadena de bloques borrando el directorio oculto .burrow, dónde se guarda toda la información.
Ahora, podemos desplegar el contrato escribiendo un sencillo .yaml dónde indicamos la acción. Ejecutamos el fichero deploy.yaml indicando el address de la cuenta que realizará la transacción. Para probar la capa de permisionado que proporciona la plataforma, vamos a utilizar la cuenta Writer (burrow keys list | grep Writer).
cd workspace2
burrow deploy -f deploy.yaml -a [Writer address]
Esta ejecución falla indicándonos que la cuenta seleccionada no tiene el permiso necesario para realizar esa acción, CreateContract. Si queremos desplegar el contrato, debemos seleccionar una cuenta con los permisos necesarios (en este caso, sólo las cuentas Operator y Full). Finalmente, utilizaremos la cuenta Operator para desplegar el contrato.
burrow deploy -f deploy.yaml -a [Operator address]
La ejecución crea un fichero de salida deploy.output.json en el que se detalla el hash de la transacción y la dirección del smart contract que acabamos de desplegar.
Burrow provee una capa de exposición que hace posible la interacción con el nodo desde fuera. Con la configuración que hemos establecido, Burrow muestra diferentes métricas en la ruta localhost:9102/metrics e información general sobre la cadena de bloques en localhost:26658, a las que se puede acceder mediante JSON-RPC. Además, se puede conectar vía GRPC al puerto 10997 para interactuar con el nodo (envío y recibo de transacciones).
La librería @monax/burrow, desarrollada por el equipo de Monax, es una API JavaScript que permite la comunicación con el nodo Burrow. Vamos a utilizar solo una pequeña parte de esta para probar nuestro smart contract recién desplegado. Si queréis profundizar en ella podéis consultar la documentación que se encuentra en el repositorio.
En el directorio workspace2 podéis encontrar el archivo program.js, que se muestra a continuación:
const monax = require('@monax/burrow');
var burrowURL = "localhost:10997";
var account = "[ set your account address]";
var options = {objectReturn: true};
var burrow = monax.createInstance(burrowURL, account, options);
var bytecode = "[bytecode]"
var abi = [abi]
var contractAddress = "[set your smart contract address]";
var contract = burrow.contracts.new(abi, bytecode, contractAddress);
// GetNombreRegistro()
contract.getNombreRegistro.at(contractAddress).then(respNombreRegistro => {
console.log(respNombreRegistro);
});
// SetNombreRegistro()
contract.setNombreRegistro.at(contractAddress, "Hackathon Blocknitive 2019").then(respNombreRegistro => {
console.log("Nombre modificado.");
// GetNombreRegistro()
contract.getNombreRegistro.at(contractAddress).then(respNombreRegistro2 => {
console.log(respNombreRegistro2);
});
});Este pequeño código javascript realiza las siguientes acciones:
- Inicializa el acceso al nodo Burrow y carga la instancia del contrato.
- Llama a una función para leer el nombre del registro.
- Modifica el nombre del registro.
- Vuelve a leer el nombre del registro para comprobar la modificación.
Antes de nada, debemos inicializar el proyecto e instalar la libreria:
npm init -y
npm install --save @monax/burrow
En el código se hacen dos lecturas y una escritura. Como podéis esperar no todas las cuentas podrán ejecutar este código por completo. Os invito a que probéis vosotros mismos lo que ocurre al ejecutar el código con diferentes cuentas. Podéis seleccionar el address de las cuentas ayudándoos de burrow keys list y ejecutarlo mediante node program.js. No os olvidéis de indicar el ABI, bytecode y dirección del smart contract recién desplegado.
Hasta aquí el workshop de Hyperledger Burrow. Esperamos que os haya parecido interesante este proyecto. En Blocknitive estamos muy atentos al desarrollo de la plataforma, porque, aunque se encuentre en estado de incubación, el código está disponible y como veis, se puede trabajar con él.
¡Nos vemos en la próxima!