[Ethereum] All about Libraries

📚 Library

---

라이브러리는 코드의 재사용성을 높여주는 장치라고 할 수 있다. 라이브러리의 코드를 한 번 디플로이하면 다시 디플로이할 필요 없이 여러 컨트랙트에서 가져다 쓸 수 있다. 또한 중복되는 기능이나 함수를 따로 라이브러리에 모아두면 컨트랙트가 가벼워지고 가스 절약으로 이어진다. 이는 상속과는 다르다. 상속을 하게 되면 솔리디티는 코드를 복사하기 때문에 라이브러리와 비교했을 때 더 많은 가스를 소비하게 되어있다. 또한 scratch 부터 컨트랙트를 짜는 것이 아닌 검증된 라이브러리를 가져다 쓰면 보안 및 개발 측면에서도 많은 도움이 될 수 있다.

⚡️ 한계점

---

라이브러리는 stateless라서 다음과 같은 한계점이 있다.

• storage 없음.
• 이더를 받을 수 없음. (fallback 함수 없음 + payable 함수 사용 불가) -> ethereum.stackexchange에 따르면 다른 컨트랙트에서 selfdestruct()로 컨트랙트를 파괴하면서 보낼 수 있기는 하다..
• 상속 불가
• selfdestruct() 사용 불가

🧑‍🍳 라이브러리 만들어보기

---

pragma solidity 0.8.0;

library libraryName {
    // struct, enum or constant variable declaration
    // function definition with body
}

만든느 방법은 간단하다. contract 대신 library로 작성하면 된다. 이 때 storage가 없기 때문에 일반적인 변수를 작성할 수는 없다. 라이브러리에서 사용 가능한 것은

1. struct
2. enum,
3. constant로 정의된 변수이다.

constant는 컨트랙트의 bytecode에 저장되기 때문에 storage와 상관 없다.

pragma solidity 0.8.0;

library MathLib {
    
    struct MathConstant {
        uint Pi;             // π (Pi) ≈ 3.1415926535...
        uint Phi;            // Golden ratio ≈ 1.6180339887...
        uint Tau;            // Tau (2pi) ≈ 6.283185...
        uint Omega;          // Ω (Omega) ≈ 0.5671432904...
        uint ImaginaryUnit;  // i (Imaginary Unit) = √–1
        uint EulerNb;        // Euler number ≈ 2.7182818284590452...
        uint PythagoraConst; // Pythagora constant (√2) ≈ 1.41421... 
        uint TheodorusConst; // Theodorus constant (√3) ≈ 1.73205... 
    }
    
}

위와 같이 작성할 수 있다.

⛓ 라이브러리 사용하기

---

라이브러리를 사용할 때 두 가지 케이스로 나뉜다.

1. Embedded Library - internal function만 있을 경우, EVM에서 라이브러리를 컨트랙트로 가져오기 때문에(JUMP 사용) 따로 디플로이 할 필요가 없다.

2. Linked Library - public 또는 external function이 있을 경우, 따로 디플로이 해줘야 한다. 디플로이된 주소를 이용하면 된다.

import 해오기 + using

pragma solidity 0.8.0;

import MathLib from “./MathLib.sol”;

contract MyContract {
    using MathLib for uint;
    
  	uint a = 10;
	uint b= 10;
	uint c = a.subUint(b); //0
  
}

사용할 컨트랙트에서 간단히 import해서 사용할 수 있다. 이후 라이브러리를 적용할 타입을 지정할 수 있다. 라이브러리의 함수는 적용된 타입의 메소드처럼 사용 가능하다.

pragma solidity 0.8.0;

library MathLib {
    
    function multiply(uint a, uint b) public view returns (uint, address) {
        return (a * b, address(this));
    }
}

contract Example {
    
    using MathLib for uint;
    address owner = address(this);
    
    function multiplyExample(uint _a, uint _b) public view returns (uint, address) {
        return _a.multiply(_b);
    }
}

위 예제같은 경우, multiplyExample를 호출하면 Example 컨트랙트의 주소를 리턴한다. 라이브러리의 주소가 아닌 컨트랙트의 주소를 리턴한다는 것은 라이브러리의 함수를 호출할 때 DELEGATECALL을 사용한다는 뜻이다. 주소뿐만 아니라 msg.value와 msg.data도 마찬가지다.

라이브러리의 함수가 internal로 선언됐다면 컴파일 할 때 EVM에서 라이브러리의 함수를 컨트랙트로 가져온다. 이후 컨트랙트에서 함수를 호출할 때 원래 컨트랙트의 함수가 있었던 것 처럼 JUMP를 이용해 호출한다.(DELEGATECALL X)

Mapping

pragma solidity 0.8.0;

library Messenger {
    event LogFunctionWithMappingAsInput(
        address from, 
        address to,
        string message
    );
    function sendMessage(
        address to, 
        mapping (string => string) storage aMapping
    ) public {
        emit LogFunctionWithMappingAsInput(
            msg.sender, 
            to, 
            aMapping[“test1”]
        );
    }
}

라이브러리 안의 함수에서 mapping을 파라미터로 사용할 수 있다. 이 때 반드시 storage로 선언되어야 하며 사용하는 함수는 public, private, external, internal 모두 가능하다.

modifier

라이브러리 자체에서 modifier를 사용할 수 있지만 라이브러리 안에서만 사용 가능하다. 따라서 컨트랙트에서 modifier를 사용하려면 컨트랙트 자체에서 선언해야 한다.

출처 및 참고자료

---

1. Solidity Tutorial: all about Libraries