Skip to content

Latest commit

 

History

History
336 lines (287 loc) · 9.11 KB

IBondPool.md

File metadata and controls

336 lines (287 loc) · 9.11 KB
Raw

IBondPool.sol

View Source: contracts/interfaces/IBondPool.sol

↗ Extends: IMember ↘ Derived Contracts: BondPoolBase

IBondPool

Structs

BondPoolInfoType

struct BondPoolInfoType {
 address lpToken,
 uint256 marketPrice,
 uint256 discountRate,
 uint256 vestingTerm,
 uint256 maxBond,
 uint256 totalNpmAllocated,
 uint256 totalNpmDistributed,
 uint256 npmAvailable,
 uint256 bondContribution,
 uint256 claimable,
 uint256 unlockDate
}

SetupBondPoolArgs

struct SetupBondPoolArgs {
 address lpToken,
 address treasury,
 uint256 bondDiscountRate,
 uint256 maxBondAmount,
 uint256 vestingTerm,
 uint256 npmToTopUpNow
}

Events

event BondPoolSetup(struct IBondPool.SetupBondPoolArgs  args);
event BondCreated(address indexed account, uint256  lpTokens, uint256  npmToVest, uint256  unlockDate);
event BondClaimed(address indexed account, uint256  amount);

Functions

setup

function setup(struct IBondPool.SetupBondPoolArgs args) external nonpayable

Arguments

Name Type Description
args struct IBondPool.SetupBondPoolArgs
Source Code 
function setup(SetupBondPoolArgs calldata args) external;

createBond

function createBond(uint256 lpTokens, uint256 minNpmDesired) external nonpayable

Arguments

Name Type Description
lpTokens uint256
minNpmDesired uint256
Source Code 
function createBond(uint256 lpTokens, uint256 minNpmDesired) external;

claimBond

function claimBond() external nonpayable

Arguments

Name Type Description
Source Code 
function claimBond() external;

getNpmMarketPrice

function getNpmMarketPrice() external view
returns(uint256)

Arguments

Name Type Description
Source Code 
function getNpmMarketPrice() external view returns (uint256);

calculateTokensForLp

function calculateTokensForLp(uint256 lpTokens) external view
returns(uint256)

Arguments

Name Type Description
lpTokens uint256
Source Code 
function calculateTokensForLp(uint256 lpTokens) external view returns (uint256);

getInfo

function getInfo(address forAccount) external view
returns(info struct IBondPool.BondPoolInfoType)

Arguments

Name Type Description
forAccount address
Source Code 
function getInfo(address forAccount) external view returns (BondPoolInfoType memory info);

Contracts