Skip to content

Latest commit

 

History

History
386 lines (325 loc) · 12.1 KB

ILockedSOV.md

File metadata and controls

386 lines (325 loc) · 12.1 KB
Raw

The Locked SOV Interface. (ILockedSOV.sol)

View Source: contracts/locked/ILockedSOV.sol

↘ Derived Contracts: LockedSOV

ILockedSOV contract

This interface is an incomplete yet useful for future migration of LockedSOV Contract.

Functions

deposit

⤿ Overridden Implementation(s): LockedSOV.deposit

Adds SOV to the user balance (Locked and Unlocked Balance based on _basisPoint).

function deposit(address _userAddress, uint256 _sovAmount, uint256 _basisPoint) external nonpayable

Arguments

Name Type Description
_userAddress address The user whose locked balance has to be updated with _sovAmount.
_sovAmount uint256 The amount of SOV to be added to the locked and/or unlocked balance.
_basisPoint uint256 The % (in Basis Point)which determines how much will be unlocked immediately.
Source Code 
function deposit(
        address _userAddress,
        uint256 _sovAmount,
        uint256 _basisPoint
    ) external;

depositSOV

⤿ Overridden Implementation(s): LockedSOV.depositSOV

Adds SOV to the locked balance of a user.

function depositSOV(address _userAddress, uint256 _sovAmount) external nonpayable

Arguments

Name Type Description
_userAddress address The user whose locked balance has to be updated with _sovAmount.
_sovAmount uint256 The amount of SOV to be added to the locked balance.
Source Code 
function depositSOV(address _userAddress, uint256 _sovAmount) external;

withdrawAndStakeTokensFrom

⤿ Overridden Implementation(s): LockedSOV.withdrawAndStakeTokensFrom

Withdraws unlocked tokens and Stakes Locked tokens for a user who already have a vesting created.

function withdrawAndStakeTokensFrom(address _userAddress) external nonpayable

Arguments

Name Type Description
_userAddress address The address of user tokens will be withdrawn.
Source Code 
function withdrawAndStakeTokensFrom(address _userAddress) external;

cliff

function cliff() external view
returns(uint256)
Source Code 
function cliff() external view returns (uint256);

duration

function duration() external view
returns(uint256)
Source Code 
function duration() external view returns (uint256);

getLockedBalance

⤿ Overridden Implementation(s): LockedSOV.getLockedBalance

function getLockedBalance(address _addr) external view
returns(_balance uint256)

Arguments

Name Type Description
_addr address
Source Code 
function getLockedBalance(address _addr) external view returns (uint256 _balance);

getUnlockedBalance

⤿ Overridden Implementation(s): LockedSOV.getUnlockedBalance

function getUnlockedBalance(address _addr) external view
returns(_balance uint256)

Arguments

Name Type Description
_addr address
Source Code 
function getUnlockedBalance(address _addr) external view returns (uint256 _balance);

Contracts