solidity-intro

Versión en Español

solidity-intro

Este repositorio está enfocado en la mayoría de conceptos básicos de Solidity, esta es una buena guía para estudiar si estás iniciando en este mundo, parte de los códigos vistos aquí están basados en https://github.com/solangegueiros/register-learn-solidity.

Antes de iniciar con la programación de Contratos inteligentes es muy importante tener claro algunos conceptos clave, como lo son:

• Licencia: Se suele usar este encabezado (// SPDX-License-Identifier: MIT) en todos los contratos inteligentes, esto es usado para declarar la licencia y recibir permiso de uso, edición, distribución, y todo lo que requerimos para crear código y ser los dueños de productos con esta base tecnológica.

• Versión del compilador: Lo segundo que tiene un encabezado es la versión del compilador pragma solidity 0.8.20;, esta versión es muy importante ya que es la encargada de compilar nuestro código y enviarlo a lenguaje que la máquina virtual de Ethereum pueda entender, en estas versiones van corrigiendo problemas que han causado hackeos o problemas de memoria, a continuación un ejemplo de desbordamiento de memoria en una versión antigua del compilador:

• Declaración del contrato: Para crear un contrato además de todo lo anterior mencionado es necesario usar la palabra reservada contract seguida del nombre del contrato con la primera letra en mayúscula como en el ejemplo de OverflowExample quedando algo así contract OverflowExample { ... } donde los ... representan nuestro código dentro del contrato.

• Tipos de variable: En solidity existen tres tipos de variables, las cuales son:

  1. Locales: Se declaran dentro de una función y no se guardan en la blockchain.
  2. Estado: Se declaran fuera de las funciones, dentro del contrato y se guardan en la blockchain.
  3. Globales: Son las variables que nos proveen de información general de la blockchain, como la estampa actual de tiempo, el número del bloque, o información de quien está interactuando con el contrato o cuántos activos está enviando al contrato y demás.

• Visibilidad: A lo largo del contrato veremos algunas palabras en las funciones, como external, public, internal o private, los cuales nos sirven para definir una visibilidad tanto para funciones como para variables de estado, a continuación, entenderemos para que sirve cada una:

  1. external: Este tipo de visibilidad indica que las funciones nombradas de esta manera pueden ser usadas al interactuar con el contrato, o desde otro contrato, si heredamos de este, pero no desde el mismo contrato, es decir, si tenemos una función que calcule algo pero nadie más en nuestro contrato la necesita, se puede definir external, si se tiene f(), no se puede llamar f() dentro de otra función, pero si se puede llamar this.f().
  2. public: Este tipo de visibilidad es muy parecida a la external, salvo que las funciones definidas como public pueden ser consultadas también por otras funciones del contrato y pueden ser asignadas a variables de estado, para indicarle al compilador que cree de manera automática funciones de lectura que permitirán obtener el valor de dichas variables de estado.
  3. internal: Este tipo de visibilidad permite acceder a las variables o funciones solo internamente, es decir, solo desde el mismo contrato mediante una función o mediante una función de otro contrato.
  4. private: Este tipo de visibilidad permite acceder a las variables o funciones solo dentro del contrato en el que se definieron, no se pueden acceder desde otros contratos.

• memory vs calldata vs storage: Cuando tengamos una función con parámetros de entrada de tipo string, array, struct o mapping, o queramos usar una variable local con estas características, debemos definir el alcande la memoria utilizada para almacenar estas variables, en estos casos solemos tener 3 opciones , o .

0_read_write.sol

En el contrato ReadWrite tienes la variable de estado myText, puedes actualizar este valor con la función setText, o puedes retornar el valor de la variable con la función getText.

1_read_write_v2.sol

En el contrato ReadWrite puedes hacer lo mismo que en el ejemplo anterior, adicional puedes medir el número de cambios hechos a lo largo de la historia.

2_read_write_constructor.sol

En el contrato ReadWriteConstructor puedes hacer lo mismo que en el ejemplo anterior, adicional puedes observar un nuevo concepto, un constructor es una "función" que es llamada por el contrato inteligente al momento de su creación, por lo que puedes guardar información como la billetera de quien lo desplegó, la estampa de tiempo y más.

3_read_write_owner.sol

En el contrato de ReadWriteOwner puedes ver un nuevo concepto, el "owner", este es asignado cuando se crea el contrato inteligente en la función del constructor, usando el valor msg.sender, la cual es una variable global con la dirección pública de quien desplegó el contrato inteligente. Este concepto es usado para restringir el acceso en algunas funciones, es muy común en contratos inteligentes más complejos.

4_read_write_require.sol

En el contrato de ReadWriteRequire puedes ver un nuevo concepto, el "require", este es similar al "if", porque tienes una condición que debe ser cumplida, si esto no pasa, el código no continúa ejecutándose, pero comparado con el "if" nos da un nuevo concepto, el "callback", este retorna el estado de cada "variable de estado" al estado inicial antes de llamar la función, adicional este muestra un mensaje de error en caso de tener uno.

5_global_info.sol

En el contrato global_info puedes encontrar seis funciones que retornan algunas variables globales.

• block.timestamp: Esta variable retorna la fecha en el formato unix (estándar de fechas. REF: https://www.unixtimestamp.com).
• block.number: Esta variable retorna el número del bloque que está procesando la transacción.
• block.chainid: Esta variable muestra el id de la cadena de la blockchain que se está usando.
• msg.value: Esta variable retorna el valor de crypto enviado por el usuario quien interactúa con el contrato inteligente.
• msg.sender: Esta variable retorna la dirección del usuario quien está interactuando con el contrato inteligente.
• tx.origin: Esta variable retorna la dirección de quien inició la transacción.

6_challenge

Tienes que crear un contrato inteligente que reciba dinero de cualquier persona, este tiene que ser capaz de reconocer al usuario y bloquear los fondos recibidos por cada uno de ellos por un año después de la transacción. Ejemplo: Juan ahorra 1000 wei en un contrato, el día 06/08/2023, Juan puedes retirar el dinero solamente después de 06/08/2024, considerando la hora, minutos y segundos.

Te invito a crear un PR con tu solución y etiquetarme en las redes sociales: @alejandro99so en instagram y X (Twitter).

7_modifier.sol

En el contrato MyModifier se introduce un nuevo concepto, el modifier, es una palabra reservada y la definición parece una función, pero con la particularidad de que esta "función" es usada en el encabezado de otras funciones, con el objetivo de modificar el comportamiento de esta función, el equivalente a un middleware, o interceptor, ya que se suele ejecutar antes del cuerpo de la función. Para saber si se ejecuta antes o después se usa underscore placeholder que se ve así: _;, y este representa la ejecución del código de la función.

• Caso 1: Si se tiene código antes del underscore placeholder este código del modifier se ejecutará antes del de la función.
• Caso 2: Si se tiene código después del underscore placeholder este código del modifier se ejecutará después de ejecutada la función.

Es más común el caso 1.

8_event.sol

En el contrato MyEvent se introduce nuevamente un concepto nuevo, el event, este también usa una palabra reservada, esta seguida de algo similar al encabezado de una función, ya que recibe el nombre y los parámetros de entrada con su respectivo tipo.

Estos eventos son muy útiles para conocer el estado de un contrato, ya que podemos reportar eventos importantes que requiera monitoreo y hacer que estos eventos ejecuten un endpoint, muestren algo en un front en tiempo real, nos notifique a un canal y mucho más, solo se requiere emitirlo en la función que requiramos y pasarle los valores de las variables que requerimos.

9_modifier_event.sol

En el contrato MyModifierEvent se combinan modificadores y eventos, se ve como el modificador onlyOwner, valida que quien llama la función sea quien creo el contrato y una vez lo valida emite un evento informando la modificación de la variable de tipo texto.

10_array.sol

En el contrato MyArray se define por primera vez en esta guía los arreglos, en este se observa string[] private myTexts;, lo cual muestra una variable llamada myTexts, con una visibilidad privada, la definición de string[] nos dice que será un arreglo de string, con esto en mente ya podremos usar las operaciones de los arreglos. Algunas de ellas son:

1. push: permite agregar un elemento al final del arreglo, es decir, si tengo dos elementos, puedo agregar un tercero.
2. length: permite saber la longitud del arreglo, recordemos que los índices o posiciones empiezan en 0, por lo tanto, si un arreglo tiene dos elementos, el índice del último elemento será 2 - 1, es decir 1, por lo que se obtiene restando uno a la longitud del arreglo.
3. [index]: permite asignar una variable a una posición particular del arreglo, debemos asegurar que dicha posición exista para no tener errores dentro del código, si tenemos un arreglo de diez posiciones, podremos asignar desde myTexts[0] hasta myTexts[9] ya que el último indice será 10 - 1 = 9.

11_array_conditional.sol

En el contrato MyArrayConditional se vuelve a observar un arreglo, y adicional se observa una implementa un condicional, un ciclo y un arreglo de strings definido de manera local, por lo que se usa memory para especificarle al compilador que guarde la variable en una memoria temporal, también se observa algo nuevo, la expresión new string[](totalNewArray), después de la definición conocida de string[] entre paréntesis se define el tamaño del arreglo, limitando el espacio de memoria que queremos reservar para el arreglo de string. También se observa que el ciclo es muy similar a los que se observan en otros lenguajes como javascript, for (uint i = start; i <= end; i++){}, donde primero se especifica la variable que se incrementara (i), luego el límite de i, y por último la manera en la que incrementara la variable i, seguido por {} do