[Solidity 깨부수기] Function

01 정의

📌 기본 구조

function 이름 (받고싶은 타입  변수명) public { // public, private, internal, external 등 가능
      // 내용
    }​

(1) Parameter 와 Retrun 값이 없는 function 정의

위와 같이 코드를 작성했을 경우, changeA라는 함수가 작동할 때 변수 a의 값을 5로 변경시켜주는 기능을 한다.

 

컴파일 이후, 배포를 하여 결과를 확인해보면 a만 호출했을 경우 초기값인 3을 출력하고 있지만

 

changeA 를 호출한 이후 a를 호출하면 값이 5인 것을 확인할 수 있고, 이 과정에서도 가스가 소비된다.

즉, changeA 함수를 통해 5라는 값이 변수 a에 대입됐다고 할 수 있다.

 

(2) Parameter 는 있고, Retrun 값이 없는 function 정의

파라미터는 있고 리턴값이 없는 함수의 경우, 위 changeB 함수와 같이 작성해줄 수 있다. 파라미터가 있는 함수를 정의해줄 경우 type이 어떤 파라미터를 넣을 것인지를 작성해주어야 한다.

 

따라서 해당 함수는 changeB 함수를 실행할 때마다, _value의 파라미터 값을 넣어주어야 하며, 변수 a에 입력한 값이 들어가도록 할 수 있다.

 

배포 이후 결과를 확인해보자. 우선 변수 a만 호출했을 경우 초기값인 3을 출력하고 있다.

 

changeB 함수 부분에 10을 입력하고 함수를 호출하고

 

다시 변수 a를 호출해보니 변수의 값이 10으로 바뀐것을 확인할 수 있다.

 

(3) Parameter 와 Retrun 값이 있는 function 정의

파라미터와 리턴값이 모두 있는 함수는 changeC 함수와 같이 작성할 수 있다. 이때, public 뒤에 리턴해주어야 하는 값이 있으니 리턴 값을 명시해주어야 하며 반드시 "s"를 붙여 "returns"로 작성해야 한다. 또한, 어떤 값을 리턴할 것인지 타입을 작성해야 한다. 본 실습에서는 a 변수를 그대로 리턴할 것이기 때문에 uint256을 사용하였다.

 

배포 이후 결과를 확인해보자. 우선 a 변수의 값은 초기값 그대로 3이 나오고 있고

 

45를 리턴하고자 changeC에 값을 넣고 리턴한 후

 

a를 호출하면 45가 출력되는 것을 확인할 수 있다.

 

추가적으로 터미널에 리턴값이 생성된 것을 확인할 수 있었다.

즉, changeC 함수는 입력한 값을 받아서 변수 a에 대입하고 대입한 a를 리턴한 함수임을 알 수 있다.

 

 

02 public, private, internal, external

(1) public

: 완전히 오픈되어 모든 곳에서 접근이 가능하다.

 

(2) private

: 오직 private이 정의된 자기 컨트랙에서만 가능 (private이 정의된 컨트랙을 상속받은 자식도 불가능)

 

(3) internal

: private처럼 오직 internal이 정의된 자기 컨트랙에서만 가능하고, internal이 정의된 컨트랙을 상속받은 자

 

(4) external

: public처럼 모든 곳에서 접근 가능하나, external이 정의된 자기 자신 컨트랙 내에서 접근 불가능

 

▶ 실습 진행

위 개념들을 확인해보고자 간단한 실습을 진행하였다.

 

먼저 public과 private을 비교해보고자 아래와 같이 코드를 작성하였다.

 

이를 배포해서 그 결과를 확인해보자. 코드 배포를 통해 결과를 확인해보니 a2 변수는 private 즉, 접근이 제한되어 있으므로 public 접근 제한을 가지고 있는 변수 a만 출력되는 것을 확인할 수 있다.

 

다음으로 조금 더 발전된 예제 코드를 살펴보자.

📌 public 예제 코드

// SPDX-License-Identifier: GPL-3.0

pragma solidity >=0.7.0 <0.9.0;

contract Lec5 {
    // public
    uint256 public a = 5;

    // private
    uint256 private a2 = 5;
}

contract Public_example {
    uint256 public a = 3;
    
    function changeA(uint256 _value) public {
        a =_value;
    }
    function get_a() view public returns (uint256)  {
        return a;
    }
}

contract Public_example_2 {
    
    Public_example instance = new Public_example();

    function changeA_2(uint256 _value) public{
      instance.changeA(_value);
    }
    function use_public_example_a() view public returns (uint256)  {
        return instance.get_a();
    }
}​

 

위 예제에는 Public_example과 Public_example_2 라는 두개의 스마트 컨트랙이 있다. Public_example_2를 사용하여 Public_example 에 접근 할 것이다.

이때, Public_example_2에서 조금 더 눈에 띄는 Public_example instance = new Public_example(); 인스턴스가 있다. 이 인스턴스를 통해서 Public_example 컨트랙에 접근이 가능하다.
 
즉, 인스턴스는 Public_example의 분신이라고 간단하게 이해할 수 있다.

 

위 코드를 실행하기 위해 컴파일 후 배포를 진행해보자. 그 전에, 우리는 코드에 contract을 총 3번 생성해주었기 때문에 remix 환경에서도 총 3개의 컨트랙이 있는 것을 확인할 수 있다.

 

3개의 컨트랙 중 public_example_2를 배포하면 다음과 같은 화면을 볼 수 있다.

 

이제 이 A 값에 10을 넣고 리턴을 한 후 그 결과가 10과 일치하는지 확인해보자. A값에 10을 넣었을 때 최종적으로 동일하게 변경된 값이 출력되는 것을 확인할 수 있다.

 

만약 위 코드에서 changeA와 get_a 각각의 함수에 접근제한자를 public이 아닌 private으로 변경할 경우 오류가 발생하는 것을 확인할 수 있다.

 

다음으로 external과 관련된 예제 코드를 확인해보자.

📌 external 예제 코드

// SPDX-License-Identifier: GPL-3.0

pragma solidity >=0.7.0 <0.9.0;

contract Lec5 {
    // public
    uint256 public a = 5;

    // private
    uint256 private a2 = 5;
}

contract external_example {
    uint256 private a = 3;
    
    function get_a() view external returns (uint256)  {
        return a;
    }

}

contract external_example_2 {
    
    external_example instance = new external_example();

    function external_example_get_a() view public returns (uint256)  {
        return instance.get_a();
    }
}​

 

위 코드에서 external_examle의 get_a는 external 로 정의 되어 있기에, external_examle  내에서는 접근이 불가능하다. 하지만, external_examle _2는 전혀 별개의 스마트 컨트랙이기에 가능함을 알 수 있다.

 

해당 코드도 public이 작성되는 부분에 external을 작성하면 오류가 나는 것을 확인할 수 있다.

 

 

03 View와 Pure

(1) View

: function 밖의 변수들을 읽을 수 있으나 변경 불가능

 

 

(2) Pure

: function 밖의 변수들을 읽지 못하고, 변경도 불가능

 

▶ View와 Pure 모두 명시를 안할 경우, function 밖의 변수들을 읽어서 변경을 해야한다.

📌 관련 예제

// SPDX-License-Identifier: GPL-3.0

pragma solidity >=0.7.0 <0.9.0;

contract View_example{
     uint256 public a = 1;
    
    function read_a() public returns(uint256){
        a = 3;
        return a+2;
    } 
}

contract Pure_example{
    
    function read_a() pure public returns(uint256){
        uint256 a = 3;
        return a+2;
    } 
}​

 

 

04 String

✅ 솔리디티 저장 영역

1. storage : 대부분의 변수, 함수들이 저장되며, 영속적으로 저장이되어 가스 비용이 비쌈
 
2. memory: 함수의 파라미터, 리턴값, 레퍼런스 타입이 주로 저장이 됨. 그러나, storage 처럼 영속적이지 않고, 함수내에서만 유효하기에 storage보다 가스 비용이 쌈
 
3. Colldata : 주로 external function 의 파라메터에서 사용 됩니다.  예를 들어 함수를 실행할 때 파라메터의 값 자체를 calldata로 받을 수 있다. calldata로 받게 된다면, 값은 변경할 수 없고 읽기만 가능하다. 
 
4. stack:  EVM (Ethereum Virtual Machine) 에서 stack data를 관리할때 쓰는 영역인데 1024Mb 1024개의 data를 제한적으로 저장해 사용할 수 있다. 예를 들어, 함수를 실행할 때 로컬 변수와 같은것들을 잠시 기억할 때 EVM이 사용을 한다. 

 

✅ 예제

// SPDX-License-Identifier  GPL-30
pragma solidity >= 0.7.0 < 0.9.0;

contract lec7 {
    
    function get_string(string memory _str) public pure returns( string memory){
        return _str;
    }
}

 

위 예제에 보면 string 다음에 memory 키워드가 있다.  memory는 늘 string 다음에 붙여준다. 그리고, pure를 쓰는이유는, 파라미터 받은걸 바로 리턴하기해서, storage 에 저장된 변수들을 읽지 않았기 때문에 pure을 사용했다.

 

 

 

출처 : 인프런 솔리디티 깨부수기(https://inf.run/qNVC)