AVATAR (AVA) Whitepaper

12. Contract API Reference

12.1 AVAToken — Owner Functions (ByOwner)

setVestingContractByOwner

setVestingContractByOwner(address _vesting)

AVAVesting 프록시 주소를 등록합니다. 1회만 호출 가능하며, 설정 후 변경 불가합니다.

Role: DEFAULT_ADMIN_ROLE (Owner)  |  Revert: VestingContractAlreadySet, ZeroAddress

burnByAdmin

burnByAdmin(address from, uint256 amount, VestingGroup group)

그룹별 조건에 따라 토큰을 소각합니다. AVAVesting의 validateBurn → adjustForBurn 순서로 검증 후 실행됩니다.

Role: ADMIN_BURNER_ROLE  |  Event: TokensBurned(from, amount, group)

pauseByOwner / unpauseByOwner

pauseByOwner()
unpauseByOwner()

모든 토큰 전송을 일시 중지/재개합니다. 긴급 상황 시 사용합니다.

Role: OWNER_PAUSER_ROLE

12.2 AVAToken — Transfer Functions

transfer

transfer(address to, uint256 amount) → bool

ERC-20 표준 전송. 사용 가능한 잔액(Available Balance) 범위 내에서만 전송 가능합니다. 잠긴(Locked) 토큰은 전송할 수 없습니다.

Role: 없음 (누구나)  |  Revert: InsufficientAvailableBalance

transferFrom

transferFrom(address from, address to, uint256 amount) → bool

ERC-20 위임 전송. approve로 승인된 범위 내에서 제3자가 전송합니다. Available Balance 제한 동일 적용.

Role: 없음 (approve 필요)  |  Revert: InsufficientAvailableBalance

approve

approve(address spender, uint256 amount) → bool

ERC-20 표준 승인. 제3자(spender)가 지정 수량까지 transferFrom으로 전송할 수 있도록 허용합니다.

Role: 없음 (누구나)  |  Event: Approval(owner, spender, amount)

executeVestingTransfer

executeVestingTransfer(address from, address to, uint256 amount)

베스팅 전용 내부 전송. Available Balance 검사를 우회하여 잠긴 토큰을 이동합니다. AVAVesting 컨트랙트만 호출 가능합니다.

Role: AVAVesting 컨트랙트만 (내부 호출)  |  Revert: VestingTransferOnly

12.3 AVAToken — View Functions

# 사용 가능 잔액 조회
cast call $TOKEN_PROXY "getAvailableBalance(address)(uint256)" $WALLET --rpc-url $RPC_URL

# 버전 조회
cast call $TOKEN_PROXY "version()(string)" --rpc-url $RPC_URL

12.4 AVAVesting — Admin Functions (ByAdmin)

setGroupConfigByAdmin

setGroupConfigByAdmin(
    VestingGroup group,
    address groupWallet,
    uint256 totalAllocation,
    uint256 initialUnlock,
    uint256 cliffDuration,
    uint256 vestingDuration,
    StartTimeMode startTimeMode
)

그룹별 베스팅 설정을 등록합니다. 1회만 호출 가능하며, cliff/vesting은 일(day) 단위 정렬 필수 (max 3,650일).

Role: ADMIN_VESTING_MANAGER_ROLE  |  Event: GroupConfigSet(...)

setTGETimestampByAdmin

setTGETimestampByAdmin(uint256 timestamp)

TGE(Token Generation Event) 시점을 설정합니다. 1회만 호출 가능하며, 과거 90일 ~ 미래 365일 범위만 허용.

Role: ADMIN_VESTING_MANAGER_ROLE  |  Event: TGETimestampSet(timestamp)

distributeToGroupByAdmin

distributeToGroupByAdmin(VestingGroup group, address from, uint256 amount)

Deployer에서 그룹 지갑으로 토큰을 배분하고 초기 베스팅 스케줄을 생성합니다. 그룹당 1회만 호출 가능.

Role: ADMIN_VESTING_MANAGER_ROLE  |  Event: GroupDistributed(group, wallet, amount)

vestingTransferByAdmin

vestingTransferByAdmin(
    VestingGroup group,
    address from,
    address to,
    uint256 amount,
    uint256 scheduleIndex
)

잠긴 토큰을 베스팅 조건과 함께 다른 지갑으로 전송합니다. 수신자는 cliff/vesting 조건을 상속받으며, initialUnlock은 상속되지 않습니다.

Role: ADMIN_VESTING_MANAGER_ROLE  |  Event: VestingTransferExecuted(group, from, to, amount, startTime)

groupWalletTransferByAdmin

groupWalletTransferByAdmin(VestingGroup group, address to, uint256 amount)

그룹 지갑에서 외부 지갑으로 자유잔액(해제된 토큰)을 전송합니다. 그룹 지갑은 일반 transfer가 차단되어 이 함수를 통해서만 전송 가능합니다.

Role: ADMIN_VESTING_MANAGER_ROLE  |  Event: GroupWalletTransferExecuted(group, from, to, amount)

pauseByOwner / unpauseByOwner

pauseByOwner()
unpauseByOwner()

모든 베스팅 작업(distributeToGroupByAdmin, vestingTransferByAdmin, groupWalletTransferByAdmin)을 일시 중지/재개합니다.

Role: OWNER_PAUSER_ROLE

12.5 AVAVesting — View Functions

# 베스팅 스케줄 조회
cast call $VESTING_PROXY "getVestingSchedules(address)" $WALLET --rpc-url $RPC_URL

# 그룹 설정 조회 (0=Foundation, 1=Ecosystem, ...)
cast call $VESTING_PROXY "getGroupConfig(uint8)" 0 --rpc-url $RPC_URL

# TGE 타임스탬프 조회
cast call $VESTING_PROXY "getTGETimestamp()(uint256)" --rpc-url $RPC_URL

12.6 Access Control Functions

OpenZeppelin AccessControl 상속. 양쪽 컨트랙트에서 동일하게 사용 가능합니다.

12.7 Role Constants

12.8 Data Types

VestingGroup (enum)

StartTimeMode (enum)

GroupConfig (struct)

WalletVesting (struct)