🔐XaiLocker

Overview

This contract implements basic interactions with XAI infrastructure with some additional integrity checks.

All functions are intended to be called only from the service contract.

This contract uses EIP-7201 to ensure storage integrity using a transparent proxy pattern

Structs

Misc

enum RequestStatus {
    Empty,
    Created,
    Completed,
    Cancelled
}

UnstakeRequest

struct UnstakeRequest {
    address pool;
    uint64 unstakeAfter;
    uint256 poolUnstakeIndex;
    uint128 amount;
    RequestStatus status;
}

RedemptionRequest

struct RedemptionRequest {
    uint256 esXaiIndex;
    uint128 amount;
    uint64 redeemableAfter;
    RequestStatus status;
}

LockerInfo

struct LockerInfo {
    address service;
    uint256 balance;
    UnstakeRequest[] unstakeRequests;
}

UserInfo

struct UserInfo {
    mapping(address => RedemptionRequest[]) requests;
}

Views

service

function service() view returns(address)

balance

function balance() view returns(uint256)

This value is used to check the solvency of the contract to perform basic actions.

getUnstakeRequest

function getUnstakeRequestCount()  view returns (uint256)
function getUnstakeRequest(uint256 index) view returns (UnstakeRequest memory)

getRedemptionRequest

This view returns data from esXAI contract.

function getRedemptionRequestCount() view returns (uint256)
function getRedemptionRequest(uint256 index) view 
    returns (IesXai.RedemptionRequest memory)

getUserRedemptionRequest

This view returns data from locker storage.

function getUserRedemptionRequestCount(address account) view returns (uint256)
function getUserRedemptionRequest(address account, uint256 index) view 
    returns (RedemptionRequest memory) 

Functions

Locking

Lock functions work only with the service contract and assume that when calling the function, the required amount of tokens will be sent in advance. Function signatures contain an unused address value for possible backward compatibility.

function lockXaiFor(address, uint256 amount)
function lockEsXaiFor(address, uint256 amount)

lockXaiFor

Solvency check performed inside the XAI infrastructure.

lockEsXaiFor

The function checks that enough tokens have been received by the contract by comparing with the stored internal balance.

Redeeming

Start redemption

function startRedemption(address user, uint256 amount, uint256 duration) 
    returns (uint256 redemptionIndex)

This function send esXAI to factory contract and starts redemption process for specified duration.

Cancel redemption

function cancelRedemption(address user, uint256 index) 
    returns (uint256 requestAmount)

This function cancel specified request and returns esXAI to locker.

Complete redemption

function completeRedemption(address user, uint256 index) 
    returns (uint256 requestAmount)

This function completes redemption process with transfer output XAI to specified user.

Staking

Stake

function stakeToPool(address pool, uint256 amount) returns (bool)

Start unstake

function createUnstakeRequest(address pool, uint256 amount) 
    returns (uint256 createdRequestIndex)

Complete unstake

function unstakeFromPool(uint256 requestIndex) 
    returns (uint256 unstakedAmount)

Claim rewards

function claimFromPool(address pool) 
    returns (uint256 claimed)

Governance

function setService(address service)