Cómo implementar funciones en Solidity

Clase 9 de 21 • Curso de Introducción a Solidity

Ernesto García

teacher•

Funciones

Son piezas de código definidas por un nombre, parámetros y modificadores.

function <name>(<type> <parameter>..., [..., ]>) 
  <access modifiers>
  <mutability modifiers>
  <user defined modifiers> 
  <returns>(<type>) {
    <content>
}

name: Nombre de la función
type: Tipo de dato
parameter: Nombre del parámetro
access modifier: public, private, internal, external
mutability modifier: view, pure. Ambas hacen que la función no cobre gas, y si se omite, se asume que es una función que escribe en el storage de la EVM
user defined modifiers: Son modificadores definidos por el usuario, son opcionales y se presentan en la siguiente clase
returns: Indica que la función retornará uno o más datos

Pepe Sosa

student•

Algunos puntos a pulir:

Las funciones pure. No leen ni modifican variables de estado y tampoco usan ninguna variable global.
Existen funciones payable. Estas se usan cuando la función envía ether a alguna dirección en la blockchain. Solo las funciones con tipo de retorno “payable” están habilitadas para enviar ether.

Convenciones no obligatorias

En el desarrollo Solidity existe una convención no obligatoria y es que todos los parámetros de una función empiecen con guión bajo.

 function Suma( uint _numero1, uint _numero2 ) public pure returns (uint) {
         return sumaInterna(_numero2, _numero2);
     }

Como digo, es solo una convención no obligatoria pero si pretendemos entrar a este mundo hay que seguir las convenciones.

Rafael Carpio

student•

siempre estas comentando cosas buenas, eres un programador profesional?

Jimmy Buriticá Londoño

student•

Tipos de función

public: son accesibles desde todo ámbito posible.
private: solo son accesibles desde el mismo contrato.
internal: solo son accesibles desde el mismo contrato y sus contratos derivados.
external: solo accesibles desde fuera del contrato.

Pepe Sosa

student•

Declaración completa de la función:

// palabra clave o declaración - function
// nombre - Suma
// parámetros - ( uint numero1, uint numero2 )
// Modificador de acceso - public
// Tipo de función - pure
// Tipo de retorno - returns (uint)
function Suma( uint numero1, uint numero2 ) public pure returns (uint) {
     return numero1 + numero2;
 }

Iván Jijón

student•

Un método no es lo mismo que un procedimiento...

Método es un término de la programación orientada a objetos, hace referencia a una función que pertenece a una clase.
Una función devuelve un valor.
Un procedimiento ejecuta una serie de acciones (típicamente hace mutar las variablesque definen el estado) y no devuelve nada.

Adolfo Sebastián Jara Gavilanes

student•

Muchas gracias por la aclaración

Agostina Yakoby Moris

student•

Propongo una variante utilizando un evento para emitir el resultado de la suma y utilizar la función ObtenerResultado.

// SPDX-License-Identifier: GPL-3.0

pragma solidity >= 0.7.0 < 0.9.0;

contract Functions {

    uint private result;

    function Add(uint number1, uint number2) public pure returns(uint) {
        return InternAdd(number1, number2);
    }

    function InternAdd(uint number1, uint number2) private pure returns(uint) {
        return number1 + number2;
    }

    function GetResult() public view returns(uint) {
        return result;
    }

    event ShowResult(uint result);

    constructor(uint number1, uint number2) {
        result = Add(number1, number2);

        emit ShowResult(GetResult());
    }
}

Entiendo que el código se puede reducir aun más dejando únicamente la función suma y emitiendo la llamada de esta función. Las alternativas son muchas

Iván Jijón

student•

En Solidity también existe la convención de primero declarar las variables y después las funciones? El orden en el que se declaran las funciones debe seguir algún orden? (según los modificadores por ejemplo?)

Sebastian Perez

teacher•

Hola Ivan, es correcto existe esa convención. El orden debería ser el siguiente:

constructor receive fallback external public internal private

Esto claramente es opcional, puedes seguir tu propio orden. Puedes consultar más estilos aquí: https://docs.soliditylang.org/en/latest/style-guide.html

Erick Vidal Serrano Salazar

student•

siento que el profe habla y habla y no entiendo nada.

Rafael Carpio

student•

creo que es mejor ir a las bases de programacion, como javascript o varios cursos gratis que hay en platzi

Luis Alejandro Vera Hernandez

student•

¿Qué son las funciones en Solidity?

Las funciones son secciones de un programa que se encargar de ejecutar instrucciones de forma independiente. Estas pueden recibir parametros para usarlos dentro del código y pueden retornar una o más varibales. (Conocido como input y output)

Tienen visibilidad al igual que las variables de estado, pueden ser.

Public: Totalmente accesible, sea cual sea el origen.
Private: Accesible únicamente a través de una función incluida en el mismo contrato.
Internal: Accesible únicamente a través de otra función incluida en el mismo contrato, o desde una función de un contrato que deriva del mismo. NO es accesible desde un mensaje de un contrato externo o una transacción externa.
External: Accesible desde una cuenta de propiedad externa y a través de un mensaje (llamada desde otro contrato). No es accesible desde una función del mismo contrato o uno derivado del mismo.

Pepe Sosa

student•

En la clase no utilizamos la función "ObtenerResultado" que es de tipo view, para esto podríamos modificar la función "Suma" y asignar el resultado a la variable privada "resultado", luego devolver esa variable. Será necesaroi que la función Suma no sea pure.

contract Funciones{

     uint private resultado;

     function Suma( uint _numero1, uint _numero2 ) public returns (uint) {
         resultado = sumaInterna(_numero1, _numero2);
         return resultado;
     }

     function sumaInterna( uint _num1, uint _num2) private pure returns (uint){
         return _num1 + _num2;
     }

     function ObtenerResultado() public view returns (uint){
         return resultado;
     }

 }

Ahora al ejecutar la función "ObtenerResultado" en el deploy, podemos ver lo que tiene la variable privada (accedemos a ella desde una función pública).

Patricia Calisto Gutierrez

student•

Que diferencia hay entre funciones prívate y internal?

Luis Alejandro Vera Hernandez

student•

Private: Accesible únicamente a través de una función incluida en el mismo contrato.
Internal: Accesible únicamente a través de otra función incluida en el mismo contrato, o desde una función de un contrato que deriva del mismo. NO es accesible desde un mensaje de un contrato externo o una transacción externa.

Documentacion

Sebastian Perez

teacher•

Es como dice Luis ! Internal funciona como el privado, pero tiene sentido cuando se aplica la herencia.

jonathan vasquez

student•

¿Que sentido tuve el poner la variable resultado, si realmente no se utilizo? Entiendo que fue con el objetivo de explicar otro concepto, no se si estoy en lo cierto

Sebastian Perez

teacher•

Hola Jonathan, en el ejemplo se utilizó para mostrar que una variable privada no tiene una función de acceso externa y para poder accederla debemos definir una función (en este caso ObtenerResultado)

Jonas Ivan Tsuchida

student•

Profe, no se si toqué algo pero de repente me empezó a marcar todo el tiempo esta advertencia en rojo. (Antes lo venía usando sin problemas sin que me marque nada, esto me empezó a pasar después de tocar alguna opción en el menú de "Home" de Remix creo).

Jesus M Cocaño Diaz

student•

muevete a la parte del compilador y selecciona uno que este entre la 0.7.0 y la 0.9.0, despues guarda y se resuelve

Sebastian Perez

teacher•

Excelente respuesta, AkiraT comentanos si lo has podido resolver con este paso

Abidan Triguero Calle

student•

RESUMEN CLASE 9: FUNCIONES

I.- FUNCIONES

Son piezas de código que se identifican con un nombre y que pueden ser invocadas desde otras partes del contrato o fuera del mismo para realizar una acción.
El ingreso de parámetros es opcional al igual que el retorno de un valor. Es decir, puede que una función no retorne valores y solo ejecute una acción.

II.- TIPOS DE FUNCIONES

public: son accesibles desde todo ámbito posible.
private: solo son accesibles desde el mismo contrato.
internal: solo son accesibles desde el mismo contrato y sus contratos derivados.
external: solo accesibles desde fuera del contrato.
view: indica que la función es de sólo lectura y no modifica el estado del contrato.
pure: indica que no se accede a ningún valor del estado del contrato (o sea sus variables).

REMIX:

Funciones.sol

// SPDX-License-Identifier: GLP-3.0

pragma solidity >=0.7.0 <0.9.0;

contract Funciones {

    function Suma(uint numero1, uint numero2) public pure returns (uint) {
        return sumaInterna(numero1, numero2);
    }

    function sumaInterna(uint numero1, uint numero2) private pure returns(uint) {
        return numero1 + numero2;
    }

    uint private resultado;

    function ObtenerResultado() public view returns (uint) {
        return resultado;
    }
}

MIGUEL ANGEL DELGADO ARPITA

student•

Asigne un numero a variable privada " resultado" para verlo despues del deploy, si no lo asignan veran el cero que se le da automaticamente.

Guillermo Garcia

student•

Structs y arrays Los structs son tipos de datos complejos que nos permiten almacenar información de distintos tipos en un solo esquema

Po ejemplo podríamos crear la estructura alumno y que este tenga el nombre y apellido con numero de documentación, sus nota o asistencias y todos estos pertenecen a diferentes tipos de datos almacenados en la misma estructura

En el caso de necesitar una cadena de datos del mismo tipo de dato vamos a tener los arrays que se almacena de forma consecutiva y se puede acceder a sus elementos según su posición

Se dividen en:

Arrays estáticos: son aquellas que sabemos su tamaño

Arrays dinámicos: son aquellas que no sabemos su tamaño final

Miguel Angel Escurra

student•

Pure

Como ninguna función está modificando el estado de las variables del contrato, simplemente estamos haciendo una suma de los parámetros. Y como ninguna función está cambiando el estado del contrato o de variables (tampoco las está consultando). Se puede decir que está en estado puro o "pure".

Guillermo Leonardo Rossi

student•

consumen gas las funciones puras? supongo q si

Jesus M Cocaño Diaz

student•

Me queda claro la parte de las funciones publicas y privadas, pero las internas y las externas me generan dudas ¿Alguna buena persona que me pueda dar algunos ejemplos? muchas gracias

Nilson Diaz

student•

Hey ! tienen algunas ligeras diferencias

Publicas : Pueden accederse desde otros contratos ya sea por herencia, y tambien estan disponibles para llarmase fuera del contrato
Privadas : Solo pueden ser llamadas dentro del contrato donde se declararon , no podran ser llamdas ni desde fuera ni por herencia
External: Solo pueden ser llamdas unicamente desde fuera del contrato por una aplicacion o por otros contratos
Internal : Como privada pero esta si puede llamarse atraves de herencia , de igual forma no estan disponibles afuera del contrato.

Puedes verlo en la Documentacion de solidity, Documentacion internal y external

y tambien si quieres puedes probarlo en remixIDE y jugar un poco con la visibilidad de las funciones

Espero te ayude!

Sebastian Perez

teacher•

Excelente aporte de Nilson ! Recuerda que un buen uso de las externas son por ejemplo las funciones de receive y fallback.