Solidity best practices

HashLips Academy

솔리디티 패턴 소개 및 시리즈 개요

이 시리즈에서는 코드의 견고성과 안정성을 개선하기 위한 솔리디티 패턴을 다룹니다.

이 시리즈에서는 Frevol의 기사를 참조하여 각 섹션을 설명과 코드 예제와 함께 살펴봅니다.

발표자인 Daniel(해시리프트)을 소개하고, 도움을 받기 위해 Discord 또는 텔레그램 채널에 가입하도록 초대합니다.

remix.ethereum.org에서 코드 예제를 따라 연습해 보실 것을 권장합니다.

사람이 읽을 수 있는 코드를 바이트코드로 컴파일하기 위한 온라인 솔리디티 컴파일러인 Remix에 대한 설명입니다.

솔리디티 패턴은 원래 0.4.2 버전에서 코딩되었지만 예제에서는 0.8.0을 사용합니다.

가드 검사, 상태 머신, 오라클, 무작위성과 같은 개념에 집중하여 현재 솔리디티 버전에 맞게 구현을 조정합니다.

가드 검사는 예상되는 기능 실행을 보장하고 스마트 컨트랙트에서 예측할 수 없는 동작을 방지합니다.

가드 체크가 없다면 블록체인의 불변성은 재앙적인 결과를 초래할 수 있습니다.

솔리디티 기초에 익숙하지 않은 분들을 위해 '솔리디티 기초 배우기' 강좌를 참고하세요.

코딩 예시: 버거 가게 스마트 컨트랙트

Remix에 '솔리디티 패턴'이라는 새 작업 공간을 생성합니다.

새 파일 'GuardCheck.sol'을 생성하고 'Ballot' 계약에서 프래그마 및 라이선스를 복사합니다.

바이버거와 환불 기능이 있는 햄버거 가게 스마트 컨트랙트의 가상의 예시입니다.

햄버거 비용(0.2 에테르)에 대한 변수를 사용하여 'burgerShop' 컨트랙트를 정의합니다.

초기 햄버거 가게 계약을 테스트한 결과 구매버거 및 환불 기능의 취약점이 발견되었습니다.

가드는 사용자 입력 및 계약 동작의 유효성을 검사하여 실패 시 상태 변경을 되돌립니다.

require` 문, `assert`, `revert`를 사용한 가드 검사 구현.

'구매 버거' 함수에 'require' 문을 사용하여 충분한 결제가 이루어지도록 합니다.

가드 검사를 위해 재사용 가능한 로직을 추상화하는 수정자를 생성하고 사용합니다.

상태 머신에 대한 설명과 상태 업데이트를 위한 스마트 컨트랙트에서의 적용에 대해 설명합니다.

햄버거 가게 예제에서 열거형을 사용하여 다양한 단계(준비, 만들기, 배달)를 정의합니다.

현재 스테이지에 따라 함수 실행을 제어하는 수정자 `isAtStage`를 생성합니다.

스테이지 간 전환을 위한 `updateStage` 함수 만들기.

스테이지 전환을 관찰하면서 Remix에서 스테이트 머신 구현을 테스트합니다.

오라클 패턴은 오프체인 데이터 액세스를 다루며 신뢰할 수 있는 소스의 중요성을 강조합니다.

오라클 패턴의 세 가지 주요 부분: 기본 계약, 오라클 계약, 외부 데이터 소스.

예시: 예: API를 사용하여 햄버거 가게에서 행운의 패킷에 대한 활동 가져오기.

외부 세계와의 상호작용을 위해 증명 가능한 API를 사용합니다.

오라클 컨트랙트에서 `getActivity` 및 `콜백` 함수 구현하기.

예측 가능성과 채굴자의 영향력으로 인해 블록체인에서 진정한 무작위성을 달성하는 데 어려움이 있습니다.

초기 접근 방식은 `keccak256` 해시 및 모듈러스 연산자를 사용하여 채굴자 조작에 대한 취약성을 보여주었습니다.

신뢰할 수 있는 당사자, 봉인된 시드 및 블록 번호 확인을 통한 단계적 방법을 사용하여 더욱 안전한 접근 방식입니다.

단계적 접근 방식에 대한 설명: 베팅 배치, 신뢰할 수 있는 당사자에 의한 시드 설정, 결과 공개.

무작위성을 검증하는 데 있어 신뢰할 수 있는 당사자의 역할이 중요하다는 점을 강조합니다.

역할 또는 시간에 따라 함수 호출을 제한하는 액세스 제어를 구현합니다.

생성자 함수를 사용하여 계약에 소유자 할당하기.

소유자로 함수 호출을 제한하는 `onlyOwner` 수정자를 만듭니다.

시작 날짜` 변수와 `shopOpened` 수정자를 사용하여 시간 기반 액세스 제어를 구현합니다.

직원 역할을 포함하도록 액세스 제어를 확장하는 것에 대해 논의합니다.

검사-효과-상호 작용 패턴: 보안 패턴

재침입 취약점을 방지하기 위한 점검-효과-상호 작용 패턴에 대한 설명입니다.

주문 확인, 상태 업데이트(효과) 및 외부 상호작용의 중요성을 보여주는 예시입니다.

부적절한 주문은 재입력 공격으로 이어질 수 있습니다.

올바른 순서: 확인, 효과, 상호작용 순으로 진행하세요.

안전한 이더리움 전송: 보안 패턴

이더를 전송하는 '전송', '보내기', '호출' 방법을 비교하여 가스를 유연하게 처리할 수 있는 '호출'을 추천합니다.

'이전' 기능은 실패 및 계약이 되돌릴 가능성이 있으므로 더 이상 권장되지 않습니다.

'호출' 방식은 사용 가능한 모든 가스를 전달하므로 유연성을 높이고 잠재적인 가스 증가에 대처할 수 있습니다.

풀 오버 푸시 패턴은 이더 전송의 책임을 컨트랙트에서 사용자로 전환합니다.

사용자에게 지급해야 할 환불을 추적하기 위해 `userRefunds` 매핑을 구현합니다.

사용자가 환불을 철회할 수 있는 'claimRefund' 기능을 생성합니다.

환불` 함수를 `사용자 환불` 매핑을 사용하도록 리팩터링하고 청구 후 항목을 지웁니다.

오류 발생 시 계약 기능을 일시 중지하는 비상 정지 메커니즘을 구현합니다.

부울 변수 `paused`를 사용하여 일시 중지 메커니즘을 제어합니다.

소유자가 호출할 수 있는 '일시 중지' 함수를 만들어 '일시 중지' 상태를 전환합니다.

일시 중지 시 함수 실행을 방지하기 위해 `notPaused` 수정자를 생성합니다.

Remix에서 비상 정지 메커니즘을 테스트합니다.

구매 버거` 및 `구매 디럭스 버거` 함수를 `가격` 매개 변수가 있는 단일 함수로 병합합니다.

'shouldPay` 수정자를 수정하여 `normalCost` 또는 `deluxeCost`에 대해 확인합니다.

코드의 명확성과 수정자의 재사용성을 개선하기 위한 추가 리팩토링.

프록시 델리게이트 패턴: 업그레이드 가능성 패턴

메인 컨트랙트의 저장소를 업데이트하는 동안 다른 컨트랙트에 함수 실행을 위임하는 프록시 위임 패턴에 대한 설명입니다.

별도의 컨트랙트에서 함수를 실행하기 위해 `delegatecall`을 사용하는 예시입니다.

업그레이드 및 스토리지 일관성 유지를 위해 델리게이트 패턴을 사용할 때의 이점.

위임자 주소를 업데이트하여 계약을 업그레이드하는 방법을 보여주는 예시입니다.

영구 저장 패턴: 업그레이드 가능성 패턴

영구 저장 패턴은 스마트 컨트랙트 업그레이드 전반에 걸쳐 데이터를 보존하는 문제를 해결합니다.

영구 데이터 저장을 위한 별도의 영구 저장소 계약의 예입니다.

영구 저장소 계약에서 데이터를 관리하기 위한 게터 및 세터 메서드입니다.

계약 업그레이드 전반에 걸쳐 데이터를 유지하기 위해 영구 저장소를 사용할 때의 이점.

문자열 동일성 비교: 해싱 전에 문자열 길이를 확인하여 가스 사용량을 최적화합니다.

긴밀한 변수 패킹: 데이터 유형별로 변수를 정리하여 컴파일러 효율성을 개선합니다.

메모리 배열 구축: 게터 함수를 사용하여 데이터를 집계하여 컨트랙트에서 데이터를 검색할 때 가스 비용을 절감합니다.