solidity-registry

목적

재사용 가능한 Solidity 컨트랙트 모듈(contracts/standard/** 등)과, 이를 기반으로 한 구현체/프리셋, 테스트를 한 저장소에서 관리합니다.

디렉토리

• contracts/standard/: 라이브러리(베이스/믹스인/민터/공용 에러)
• contracts/implementations/: standard 모듈을 조합한 배포 가능한 구현체/프리셋
  • contracts/implementations/standard/StandardPresetMinimal.sol: 최소 프리셋
  • contracts/implementations/standard/StandardPresetFull.sol: 풀 프리셋(여러 믹스인 조합)
  • contracts/implementations/chainlink/ChainlinkPresetMinimal.sol: RevealMinter 호환 최소 프리셋
• contracts/mocks/: Hardhat 테스트용 목업
• test/: Hardhat 테스트

개발/테스트

의존성 설치:

npm install

테스트:

npm test

배포용 lib (implementations)

contracts/implementations/** 프리셋을 직접 배포할 수 있도록, 컨트랙트 bytecode + constructor args를 합쳐 txData를 만들고, 서명 가능한 EIP-1559 Deploy 트랜잭션을 구성하는 헬퍼를 제공합니다.

• src/lib/deploy/implementations.ts: 프리셋 deploy 트랜잭션 생성
• src/lib/transaction/transaction.ts: makeTx, makeDeployTx

예시(외부 RPC에서 deploy tx 만들기):

import { Wallet, ethers } from 'ethers';
import { makeImplementationDeployTx } from '@modernlion/solidity-registry';

const rpcUrl = process.env.RPC_URL!;
const pk = process.env.PRIVATE_KEY!;

const provider = new ethers.providers.JsonRpcProvider(rpcUrl);
const signer = new Wallet(pk, provider);

const tx = await makeImplementationDeployTx(
  'StandardPresetMinimal',
  ['MyNFT', 'MNFT', 1000, 'https://example.com/metadata/'],
  provider,
  await signer.getAddress(),
);

const signed = await signer.signTransaction(tx);
const receipt = await (await provider.sendTransaction(signed)).wait();
console.log('deployed at', receipt.contractAddress);

배포 (npm) — GitHub Actions

npm 배포는 수동 publish 대신 GitHub Actions로만 수행하는 것을 권장합니다.

1. Secrets 설정
   Repository → Settings → Secrets and variables → Actions 에서 NPM_TOKEN 추가

   • npm.com 로그인 → 프로필 클릭 → Access Tokens → Generate New Token → Granular Access token 선택
   • 권한: Read and write (패키지 배포용), 적용할 패키지(또는 전체) 지정
   • Bypass 2FA for publish (또는 "2FA 우회") 옵션을 켜기 — CI에서는 OTP를 입력할 수 없으므로, 이 옵션이 없으면 publish 시 EOTP 에러가 납니다.
   • 생성된 토큰(npm_...)을 복사해 GitHub Secret에 붙여넣기

2. 배포 절차

   • 배포할 버전으로 태그를 푸시하면 자동으로 npm publish 됨. (테스트는 CI에서만 수행, publish 워크플로에서는 중복 제거)
   • 예: git tag v1.0.1 && git push origin v1.0.1
   • 제약: 태그는 main 또는 master 브랜치에 있는 커밋에만 붙여야 함. 그렇지 않으면 배포 단계에서 실패함. (main에 푸시 → CI 통과 후 태그 푸시 권장)
   • 워크플로: .github/workflows/publish.yml (태그 v* 푸시 시 실행)

3. CI

   • main/master 푸시 및 PR 시 설치·컴파일·테스트만 실행: .github/workflows/ci.yml

참고(Chainlink + OZ import)

@chainlink/contracts가 @openzeppelin/[email protected]/... 형태로 import하는 파일이 있어, npm install 시 scripts/postinstall.cjs가 node_modules/@openzeppelin/[email protected] 별칭을 자동 생성합니다.