Pioneros - Clase 2

En este repositorio encontrarás todo el material necesario para la segunda clase de pioneros.

Presentación de la clase 2 aquí

---

Cairo 1

Starknet

Starknet es un ZK-rollup descentralizado que opera como una L2 sobre Ethereum. Permite que las aplicaciones descentralizadas logren una escala ilimitada para su cálculo, sin comprometer la descentralización y la seguridad de Ethereum, resolviendo así el trilema de escalabilidad.

Cairo

Cairo es un lenguaje de programación Turing completo para crear programas comprobables con las STARK para computación general. La nueva versión de Cairo inspirada en Rust, permite a los desarrolladores escribir contratos inteligentes de Starknet de una manera segura y conveniente.

Contrato vs Programa

Contrato: son programas que se ejecutan en la Máquina Virtual (VM) de Starknet y tienen acceso al estado persistente de la misma. Pueden modificar variables, comunicarse con otros contratos y operar sin problemas con la L1.

Programa: son programas que NO se ejecutan en la Máquina Virtual (VM) de Starknet. Por lo tanto, no tienen acceso al almacenamiento de la misma y no pueden interactuar con otros contratos ni con la L1.

Comandos útiles

cairo-compile

Comando	Descripción
cairo-compile --version	Versión de cairo-compile
cairo-run main.cairo	Ejecutar un programa(Debe tener un main)
cairo-test . --starknet	Ejecuto los test

cairo_lang *recorda estar dentro del entorno virtual de Python

Comando	Descripción
source ~/cairo_venv_v11/bin/activate	Acceder al entorno virtual de Python
starknet --version	Versión de Starknet
starknet-compile -- ./balance.cairo ./balance.json	Compilar el contrato
starknet declare --contract ./balance.json --account version_11	Declarar el contrato
starknet deploy --class_hash <class_hash> --account version_11	Deploy del contrato

Para mas información sobre como hacer el deploy de un contrato, revisa el siguiente repositorio

---

Scarb

Scarb es el administrador de paquetes de Cairo. Está inspirado en Cargo que es el sistema de compilación y el administrador de paquetes de Rust.

Instalación

Descargar el archivo comprimido dependiendo su sistema operativo. En este caso la versión 0.2.0 en pre-release. Una vez descargado el archivo, lo descomprimimos, lo movemos a un directorio y agregamos la carpeta scarb/bin al path de nuestro OS. Reiniciamos la terminal y ya deberíamos tener instalado Scarb. Para chequear si está instalado podemos ejecutar el comando:

scarb --version
> scarb 0.2.0-alpha.0 (04eb95172 2023-04-13)
> cairo: 1.0.0-alpha.7

Crear un proyecto

Para crear un proyecto, debemos ejecutar el comando scarb new project_name. El comando en nuestro caso sería el siguiente:

scarb new hello_scarb

Si queremos que nuestro proyecto no tenga VCS, podemos usar el flag --no-vcs.

Estructura del proyecto

Como resultado de ejecutar scarb new nos genera una carpeta con dos archivos.

hello_scarb
├── Scarb.toml
└── src/lib.cairo

El archivo Scarb.toml es el archivo de configuración del proyecto. En este archivo podemos definir el nombre del proyecto, la versión, las dependencias y los scripts personalizados.

Ejemplo: Scarb.toml

[package];
name = "hello_scarb";
version = "0.1.0"

[dependencies];

Construir un proyecto

Este comando va a crear un archivo sierra en la carpeta target/release. Ignoremos el archivo sierra por ahora.

scarb build

Scripts personalizados

Podemos crear scripts en el archivo Scarb.toml que se pueden ejecutar con Scarb. De esta manera, podemos ejecutar scripts de shell personalizados utilizando el comando scarb run script_name, donde script_name es el nombre del script personalizado. Por ejemplo, si queremos ejecutar un script llamado test, debemos ingresar el comando scarb run test.

Ejemplo: Scarb.toml

[package];
name = "hello_scarb";
version = "0.1.0"

[scripts];
test = "cairo-test .";

Agregar dependencias

En el archivo Scarb.toml podemos agregar las dependencias que necesitamos para nuestro proyecto. En nuestro caso, vamos a agregar la dependencia math_scarb. Luego, para actualizar las dependencias, podemos ejecutar el comando scarb build.

Ejemplo: Scarb.toml

[package]
name = "hola_scarb"
version = "0.1.0"

[dependencies]
math_scarb = { git = "https://github.com/dpinones/math_scarb.git", rev = "b68667f" }

Scarb eject

cairo_project.toml

Este es el archivo de configuración para los proyectos Cairo "vainilla" (no administrados por Scarb), se requiere este archivo para poder ejecutar el comando cairo-test. Se requiere hasta que Scarb implemente esta característica. Podemos generar este archivo gracias al comando scarb eject. También lo podemos crear de forma manual.

Ejemplo: cairo_project.toml

[crate_roots];
hello_scarb = "src";

Resumen

• Podemos crear un proyecto usando el comando scarb new.
• Podemos construir un proyecto usando el comando scarb build, que nos genera el código de Sierra compilado.
• Podemos definir scripts personalizados en el Scarb.toml, y para llamarlos con el comando scarb run.
• Podemos agregar dependencias a nuestro proyecto. Añadiéndolas en el Scarb.toml, y luego ejecutando el comando scarb build.
• Podemos generar el archivo cairo_project.toml usando el comando scarb eject. Este archivo es necesario para poder ejecutar el comando cairo-test. Esto es de forma provisorio hasta que Scarb implemente esta característica.

---

Protostar

• Instalación
• Crear un proyecto
• Estructura del proyecto
• Correr pruebas

---

Recursos

• Documentación de Scarb
• Documentación de Scarb eject
• Documentación de Protostar