🌱BEB 09 Final Project 회고

프로젝트 소개

개요

이번 프로젝트는 저번 프로젝트2의 주제와 동일하게 플로깅 및 기타 환경 운동 관련 커뮤니티를 블록체인 기반 인센티브 형식으로 구현했습니다. 주제가 비슷한 대신 기능을 늘렸고 ERC-1155를 통해 동일한 NFT를 배지 형식으로 참가자에게 행사 참여 보상으로 지급하고 ERC-721로 DNFT를 구현했다.

프로젝트2와 동일한 팀원 분들에 한분 더 모셔서 진행했다. 다들 너무 잘하시는 분들이라 갈등 한번 없이 프로젝트를 잘 마무리 했다.

나는 그동안의 프로젝트와 동일하게 smart contract 부분을 담당했다. 이번에는 컨트랙트 및 서버의 테스트 코드도 작성해보고 mongoDB도 새로 사용해 보았다. 처음에는 사용하기 어려웠지만 금방 잘 적응해서 맡은 부분을 잘 구현해 나아갔다. 클라이언트와 관리자 페이지를 따로 구현해 여러 행사 및 사용자 관리를 더욱 용이하게 구성했다.

github

clean-mile github

배포링크

client : https://www.clean-mile.co/
admin : https://admin.clean-mile.co/auth/login

서비스 아키텍쳐

역할 및 기술 스택

역할

• Smart Contract : DNFT, Badge, Token Contract, Test Code, Contract Deploy,Verify
• Server: contract controller, Unit Test

기술 스택

ERC-1155

ERC1155는 이더리움 개발자가 동일한 표준을 사용하여 쉽게 대체 가능, 부분 대체 가능, 대체 불가능 토큰을 생성하도록 해 주는 표준이다
우리 플랫폼에서 가장 중요한 부분 중 하나인 활동 후 인증을 하면 행사와 관련한 배지를 지급하는 부분을 구현하기 위해 필요했다. 배지는 ERC-721로도 충분히 구현 가능하지만 행사에 참여한 여러 사용자에게 동일한 배지를 주기 위해선 세상에 오직 딱 하나 존재하는 토큰이 아닌 참가자 수 만큼 동일한 토큰이 존재해야 했다. 따라서 ERC-1155를 통해 구현했다.

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.19;

interface ICleanMileBadge {
    // 각 뱃지의 ID를 정의합니다. 0은 브론즈, 1은 실버, 2는 골드 뱃지입니다.
    enum BadgeType {
        Bronze,
        Silver,
        Gold
    }

    // 토큰 ID에 대한 뱃지 유형을 조회하는 함수
    function badgeType(uint256 tokenId) external view returns (BadgeType);

    // 유저의 뱃지 점수를 조회하는 함수
    function userBadgeScore(
        address userAddress
    ) external view returns (uint256);

    // 특정 토큰의 뱃지 수량을 조회하는 함수
    function badgeBalance(
        address account,
        uint256 tokenId
    ) external view returns (uint256);

    // 뱃지를 발급하는 함수
    function mintBadge(
        address account,
        BadgeType badgeType,
        uint256 amount,
        string memory uri
    ) external returns (uint256);

    // 뱃지를 전송하는 함수 (한명에게 한개씩)
    function transferBadge(
        address from,
        address to,
        uint256 tokenId,
        uint256 amount
    ) external;

    // 뱃지를 여러 사용자에게 전송하는 함수 (한가지 종류의 토큰을 여러 사람에게)
    function transferBadges(
        address from,
        address[] calldata recipients,
        uint256 tokenId,
        uint256 amount
    ) external;

    event MintBadge(
        address indexed sender,
        address account,
        BadgeType badgeType,
        uint256 amount,
        string _uri
    );

    event TransferMultiple(
        address indexed sender,
        address[] recipients,
        uint256 tokenId,
        uint256 amount
    );

    // 특정 토큰에 대한 권한 부여 이벤트입니다.
    event ApprovalForToken(
        address indexed account,
        uint256 indexed tokenId,
        bool approve
    );

1.관리자는 mintBadge 함수로 행사와 관련한 뱃지를 원한는 수량만큼 민팅할 수 있습니다.
2.이후 transferBadge 함수를 통해 사용자가 qr인증을 하면 해당 행사에 대한 뱃지를 전송한다.
3.만약 참여자가 너무 많을 경우 일일이 배지를 전송하는 것은 가스비가 너무 많이 소요된다. 따라서 transferBadges로 인증 완료한 참여자들에게 일관 전송한다.
4. 배지는 gold, silver, bronze 타입을 가지고 있다. 사용자는 배지를 받는 순간 같이 배지 점수도 받게 되며 추후에 DNFT 업그레이드에 사용된다. (골드 : 10점, 실버 : 5점, 브론즈 : 1점)
5.userBadgeScore 함수를 이용해 사용자의 배지 점수를 확인 가능하다.

만약 참가자가 qr인증을 하게 된다면 이런 식으로 배지를 지급 받게 된다.

이후 마이페이지에서 수령한 배지 및 참가한 활동에 대한 기록을 확인할 수 있다.
배지 점수 또한 같이 올라가게 된다.

배지 민팅이나 전송 같이 중요한 함수들은 따로 이벤트를 정의해 로그 생성 및 데몬이 추적 가능하도록 구현했다.

DNFT(ERC-721)

NFT의 속성이 동적으로 변동가능한 것이 DNFT이다. 우리는 이 DNFT를 사용자에게 회원가입 시 지급하고 활동에 따른 배지 점수에 따라서 업그레이드를 가능하도록 했다. 사용자들은 활동에 따라 DNFT를 업그레이드하고 아이콘이 변경되며 자신의 활동 기록이 DNFT description에 계속해서 기록되며 어느 정도 활동에 대한 인증도 가능하다.

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.19;

interface ICleanMileDNFT {
    //level 1~5는 일반 사용자 level_6은 관리자
    enum DNFTLevel {
        level_1,
        level_2,
        level_3,
        level_4,
        level_5,
        level_6
    }

    enum UserType {
        User,
        Admin
    }

    struct DNFTData {
        uint256 token_id;
        string name;
        string description;
        DNFTLevel level;
    }

    event UpgradeDNFT(address indexed sender, uint256 tokenId);

    event MintDNFT(
        address _to,
        string _name,
        string _description,
        UserType userType
    );

    function dnftName(uint256 _tokenId) external view returns (string memory);

    function dnftDescription(
        uint256 _tokenId
    ) external view returns (string memory);

    function dnftLevel(uint256 _tokenId) external view returns (DNFTLevel);

    function dnftData(uint256 _tokenId) external view returns (DNFTData memory);

    function mintDNFT(
        address _to,
        string calldata _name,
        string calldata _description,
        UserType userType
    ) external returns (uint256);

    function updateName(uint256 _tokenId, string calldata _name) external;

    function updateDescription(
        uint256 _tokenId,
        string calldata _description
    ) external;

    function setBadge(address badgeAddress) external returns (bool);

    function upgradeDNFT(uint256 _tokenId) external returns (bool);

    function upgradeCheck(uint256 _tokenId) external returns (DNFTLevel);
}

DNFT 컨트랙트의 인터페이스이다.
1.DNFT는 1~6레벨까지 존재한다. 6레벨은 관리자이다.
2.사용자는 회원가입시 mintDNFT 함수를 통해 자신의 지갑에 DNFT를 수령한다.
3.이후 활동을 하며 배지 점수를 획득하고 정해진 기준에 따라 업그레이드가 가능하다.
[기준]
1단계(씨앗) : 0점(회원가입 상태)~ 14점 (간격: 15점)
2단계(새싹) : 15점 ~ 39점 (간격25점)
3단계(잎새) : 41점 ~ 74점 (간격35점)
4단계(가지) : 75점 ~ 119점 (간격45점)
5단계(열매) : 120점 ~
이 기준은 현실적인 행사들의 주최 주기를 기준으로 정했습니다.
4.이 기준을 충족한다면 다음 레벨로 업그레이드 할 수 있습니다.

업그레이드 전

업그레이드 후

컨트랙트를 구성하는 과정에서 가스비를 줄이기 위해 최대한 온체인 상 데이터를 줄이고 트랜잭션 횟수를 줄이는 방법에 대해서 많이 고민해 보았다.

컨트랙트 후기

프로젝트 1은 foundry, 프로젝트 2는 truffle, 이번 프로젝트 3는 hardhat을 사용했다. 3번 모두 다른 환경을 이용해 컨트랙트를 개발, 배포, 검증까지 했다.

그리고 이번 프로젝트에서 또 하나 새로 시도한 것은 mocha를 이용한 컨트랙트 테스트 코드 작성이다. 각 컨트랙트 마다 positive, negative case를 두어 가능한 모든 상황을 테스트 해보려 했다. 사실 이 부분이 굳이 필요한가 싶었지만 테스트 코드를 작성하며 컨트랙트에 빈 곳이 있다는 사실을 알게 되었고 수정할 수 있었다. 개발에 있어서 반드시 필요한 작업이라는 사실을 알게 되었다.

그리고 여러 에러 정의 및 이벤트 정의와 관련된 부분에 대한 공부를 많이 할 수 있었다.

서버

서버 부분에서는 컨트랙와 관련된 기능에 대한 controller를 구현했다. 그리고 서버 담당하신 팀원 분이 작성해 놓은 api에서 필요한 부분에 갖다 붙였다.
그리고 서버 유닛 테스트 코드를 작성했다. 사실 서버 기능과 관련된 함수가 너무 많아서 조금 힘들었다. 방식은 테스트를 진행하면서 기존 DB를 건드리면 안되기 때문에 mongo-memory-server를 띄운다음 테스트가 종료 되면 같이 종료하는 식으로 구성했다. 컨트랙트와 마친가지로 mocha, chai를 사용했다!

사실 서버와 관련해서 내가 기여한 부분은 이 정도이다. 하지만 팀원분들의 코드를 보면서 매일 공부하다 보니 좀 더 전체적인 구조가 이해가 잘 되었다. 아마 다른 프로젝트를 진행하면서 많이 참고할 거 같다. 서버 담당하신 팀원 분께서 postman으로 api를 정리하셨다. 한 눈에 보기 상당히 편하고 깔끔했다. 내가 주로 맡은 파트가 아니다 보니 남의 코드를 보면서 내 것을 중간에 삽입했기 때문에 구현에 대한 부분 보다는 남의 것을 내 것으로 만드는데 많은 시간을 쏟았던거 같다.프로젝트를 진행하며 제일 많이 배울 수 있는 부분은 남이 하는 것을 내 것으로 만드는 부분에서 오는 것 같다고 느꼈다.

프로젝트 후기

마지막 프로젝트까지 마무리 되었다.

아무것도 모르고 시작했지만 좋은 사람들로부터 많은 정보와 도움을 받아 이렇게 끝날 때 쯤에는 어느 정도 내가 맡은 역할을 다 할 수 있는 사람이 된거 같아 뿌듯하다. 그리고 앞으로 나는 어떻게 공부를 할 것인가에 대한 방향을 잡을 수 있어 좋았다. 사용 가능한 언어의 폭을 늘리고 컨트랙트 관련 부분 해서는 이론에 대한 부분을 많이 까먹었기 때문에 앞으로 다시 복습하면서 보강해 나가야 할 거 같다.

욕심부리지 않고 천천히 앞으로 나아가야겠다.