Skip to content

[CLI] Dividend fixes #613

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pabloruiz55 merged 12 commits into from
Mar 21, 2019
Merged

[CLI] Dividend fixes #613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
9872bf9
Fix decimals in dividends modules
VictorVicente Mar 20, 2019
7095b38
STOs are listed with its version
VictorVicente Mar 20, 2019
daf208b
Reclaim ETH and ERC20 tokens from STO and Dividends modules
VictorVicente Mar 20, 2019
a6f289b
Pause/Unpase dividend modules
VictorVicente Mar 20, 2019
b0b71d3
Minor fix
VictorVicente Mar 20, 2019
715d3f6
Merge branch 'dev-2.1.0' into cli-dividend-fixes
VictorVicente Mar 20, 2019
fc88f2d
BigNumber library for dividends
VictorVicente Mar 20, 2019
ea1cbc8
STO selection fix
VictorVicente Mar 20, 2019
2c20b2f
Fix for pause/unpause STOs
VictorVicente Mar 21, 2019
a19b2a7
Show sto version when selecting
VictorVicente Mar 21, 2019
bb59d5d
Merge branch 'dev-2.1.0' into cli-dividend-fixes
pabloruiz55 Mar 21, 2019
a5b6c32
Version info for all modules
VictorVicente Mar 21, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 81 additions & 36 deletions CLI/commands/dividends_manager.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ const gbl = require('./common/global');
const contracts = require('./helpers/contract_addresses');
const abis = require('./helpers/contract_abis');
const csvParse = require('./helpers/csv');
const BigNumber = require('bignumber.js');
const { table } = require('table')

const EXCLUSIONS_DATA_CSV = `${__dirname}/../data/Checkpoint/exclusions_data.csv`;
Expand Down Expand Up @@ -146,7 +147,7 @@ async function dividendsManager() {
if (currentDividends.length > 0) {
options.push('Manage existing dividends');
}
options.push('Create new dividends');
options.push('Create new dividends', 'Reclaim ETH or ERC20 tokens from contract');

let index = readlineSync.keyInSelect(options, 'What do you want to do?', { cancel: 'RETURN' });
let selected = index != -1 ? options[index] : 'RETURN';
Expand Down Expand Up @@ -178,6 +179,9 @@ async function dividendsManager() {
case 'Create new dividends':
await createDividends();
break;
case 'Reclaim ETH or ERC20 tokens from contract':
await reclaimFromContract();
break;
case 'RETURN':
return;
}
Expand Down Expand Up @@ -238,9 +242,12 @@ async function manageExistingDividend(dividendIndex) {
let dividend = await currentDividendsModule.methods.dividends(dividendIndex).call();
let dividendTokenAddress = gbl.constants.ADDRESS_ZERO;
let dividendTokenSymbol = 'ETH';
let dividendTokenDecimals = 18;
if (dividendsType === 'ERC20') {
dividendTokenAddress = await currentDividendsModule.methods.dividendTokens(dividendIndex).call();
dividendTokenSymbol = await getERC20TokenSymbol(dividendTokenAddress);
let erc20token = new web3.eth.Contract(abis.erc20(), dividendTokenAddress);
dividendTokenDecimals = await erc20token.methods.decimals().call();
}
let progress = await currentDividendsModule.methods.getDividendProgress(dividendIndex).call();
let investorArray = progress[0];
Expand All @@ -266,12 +273,12 @@ async function manageExistingDividend(dividendIndex) {
console.log(`- Maturity: ${moment.unix(dividend.maturity).format('MMMM Do YYYY, HH:mm:ss')}`);
console.log(`- Expiry: ${moment.unix(dividend.expiry).format('MMMM Do YYYY, HH:mm:ss')}`);
console.log(`- At checkpoint: ${dividend.checkpointId}`);
console.log(`- Amount: ${web3.utils.fromWei(dividend.amount)} ${dividendTokenSymbol}`);
console.log(`- Claimed amount: ${web3.utils.fromWei(dividend.claimedAmount)} ${dividendTokenSymbol}`);
console.log(`- Amount: ${dividend.amount / Math.pow(10, dividendTokenDecimals)} ${dividendTokenSymbol}`);
console.log(`- Claimed amount: ${dividend.claimedAmount / Math.pow(10, dividendTokenDecimals)} ${dividendTokenSymbol}`);
console.log(`- Taxes:`);
console.log(` To withhold: ${web3.utils.fromWei(taxesToWithHeld)} ${dividendTokenSymbol}`);
console.log(` Withheld to-date: ${web3.utils.fromWei(dividend.totalWithheld)} ${dividendTokenSymbol}`);
console.log(` Withdrawn to-date: ${web3.utils.fromWei(dividend.totalWithheldWithdrawn)} ${dividendTokenSymbol}`);
console.log(` To withhold: ${taxesToWithHeld / Math.pow(10, dividendTokenDecimals)} ${dividendTokenSymbol}`);
console.log(` Withheld to-date: ${dividend.totalWithheld / Math.pow(10, dividendTokenDecimals)} ${dividendTokenSymbol}`);
console.log(` Withdrawn to-date: ${dividend.totalWithheldWithdrawn / Math.pow(10, dividendTokenDecimals)} ${dividendTokenSymbol}`);
console.log(`- Total investors: ${investorArray.length}`);
console.log(` Have already claimed: ${claimedInvestors} (${investorArray.length - excludedInvestors !== 0 ? claimedInvestors / (investorArray.length - excludedInvestors) * 100 : 0}%)`);
console.log(` Excluded: ${excludedInvestors} `);
Expand Down Expand Up @@ -300,6 +307,7 @@ async function manageExistingDividend(dividendIndex) {
showReport(
web3.utils.hexToUtf8(dividend.name),
dividendTokenSymbol,
dividendTokenDecimals,
dividend.amount, // Total amount of dividends sent
dividend.totalWithheld, // Total amount of taxes withheld
dividend.claimedAmount, // Total amount of dividends distributed
Expand All @@ -314,14 +322,17 @@ async function manageExistingDividend(dividendIndex) {
await pushDividends(dividendIndex, dividend.checkpointId);
break;
case 'Explore account':
await exploreAccount(dividendIndex, dividendTokenAddress, dividendTokenSymbol);
await exploreAccount(dividendIndex, dividendTokenAddress, dividendTokenSymbol, dividendTokenDecimals);
break;
case 'Withdraw withholding':
await withdrawWithholding(dividendIndex, dividendTokenSymbol);
await withdrawWithholding(dividendIndex, dividendTokenSymbol, dividendTokenDecimals);
break;
case 'Reclaim expired dividends':
await reclaimedDividend(dividendIndex, dividendTokenSymbol);
await reclaimedDividend(dividendIndex, dividendTokenSymbol, dividendTokenDecimals);
return;
case 'Reclaim ETH or ERC20 tokens from contract':
await reclaim
break;
case 'RETURN':
return;
}
Expand Down Expand Up @@ -376,6 +387,7 @@ async function createDividends() {
let dividendName = readlineSync.question(`Enter a name or title to indetify this dividend: `);
let dividendToken = gbl.constants.ADDRESS_ZERO;
let dividendSymbol = 'ETH';
let dividendTokenDecimals = 18;
let token;
if (dividendsType === 'ERC20') {
do {
Expand All @@ -390,17 +402,18 @@ async function createDividends() {
if (erc20Symbol != null) {
token = new web3.eth.Contract(abis.erc20(), dividendToken);
dividendSymbol = erc20Symbol;
dividendTokenDecimals = await token.methods.decimals().call();
} else {
console.log(chalk.red(`${dividendToken} is not a valid ERC20 token address!!`));
}
} while (dividendSymbol === 'ETH');
}
let dividendAmount = readlineSync.question(`How much ${dividendSymbol} would you like to distribute to token holders? `);

let dividendAmountBN = new web3.utils.BN(dividendAmount);
let issuerBalance = new web3.utils.BN(web3.utils.fromWei(await getBalance(Issuer.address, dividendToken)));
let dividendAmountBN = new BigNumber(dividendAmount).times(Math.pow(10, dividendTokenDecimals));
let issuerBalance = new BigNumber(await getBalance(Issuer.address, dividendToken));
if (issuerBalance.lt(dividendAmountBN)) {
console.log(chalk.red(`You have ${issuerBalance} ${dividendSymbol}.You need ${dividendAmountBN.sub(issuerBalance)} ${dividendSymbol} more!`));
console.log(chalk.red(`You have ${issuerBalance / Math.pow(10, dividendTokenDecimals)} ${dividendSymbol}. You need ${(dividendAmountBN - issuerBalance) / Math.pow(10, dividendTokenDecimals)} ${dividendSymbol} more!`));
} else {
let checkpointId = await selectCheckpoint(true); // If there are no checkpoints, it must create a new one
let now = Math.floor(Date.now() / 1000);
Expand All @@ -412,21 +425,21 @@ async function createDividends() {

let createDividendAction;
if (dividendsType == 'ERC20') {
let approveAction = token.methods.approve(currentDividendsModule._address, web3.utils.toWei(dividendAmountBN));
let approveAction = token.methods.approve(currentDividendsModule._address, dividendAmountBN);
await common.sendTransaction(approveAction);
if (checkpointId > 0) {
if (useDefaultExcluded) {
createDividendAction = currentDividendsModule.methods.createDividendWithCheckpoint(maturityTime, expiryTime, token.options.address, web3.utils.toWei(dividendAmountBN), checkpointId, web3.utils.toHex(dividendName));
createDividendAction = currentDividendsModule.methods.createDividendWithCheckpoint(maturityTime, expiryTime, token.options.address, dividendAmountBN, checkpointId, web3.utils.toHex(dividendName));
} else {
let excluded = getExcludedFromDataFile();
createDividendAction = currentDividendsModule.methods.createDividendWithCheckpointAndExclusions(maturityTime, expiryTime, token.options.address, web3.utils.toWei(dividendAmountBN), checkpointId, excluded[0], web3.utils.toHex(dividendName));
createDividendAction = currentDividendsModule.methods.createDividendWithCheckpointAndExclusions(maturityTime, expiryTime, token.options.address, dividendAmountBN, checkpointId, excluded[0], web3.utils.toHex(dividendName));
}
} else {
if (useDefaultExcluded) {
createDividendAction = currentDividendsModule.methods.createDividend(maturityTime, expiryTime, token.options.address, web3.utils.toWei(dividendAmountBN), web3.utils.toHex(dividendName));
createDividendAction = currentDividendsModule.methods.createDividend(maturityTime, expiryTime, token.options.address, dividendAmountBN, web3.utils.toHex(dividendName));
} else {
let excluded = getExcludedFromDataFile();
createDividendAction = currentDividendsModule.methods.createDividendWithExclusions(maturityTime, expiryTime, token.options.address, web3.utils.toWei(dividendAmountBN), excluded[0], web3.utils.toHex(dividendName));
createDividendAction = currentDividendsModule.methods.createDividendWithExclusions(maturityTime, expiryTime, token.options.address, dividendAmountBN, excluded[0], web3.utils.toHex(dividendName));
}
}
let receipt = await common.sendTransaction(createDividendAction);
Expand All @@ -448,7 +461,7 @@ async function createDividends() {
createDividendAction = currentDividendsModule.methods.createDividendWithExclusions(maturityTime, expiryTime, excluded, web3.utils.toHex(dividendName));
}
}
let receipt = await common.sendTransaction(createDividendAction, { value: web3.utils.toWei(dividendAmountBN) });
let receipt = await common.sendTransaction(createDividendAction, { value: dividendAmountBN });
let event = common.getEventFromLogs(currentDividendsModule._jsonInterface, receipt.logs, 'EtherDividendDeposited');
console.log(`
Dividend ${ event._dividendIndex} deposited`
Expand All @@ -457,6 +470,33 @@ Dividend ${ event._dividendIndex} deposited`
}
}

async function reclaimFromContract() {
let options = ['ETH', 'ERC20'];
let index = readlineSync.keyInSelect(options, 'What do you want to reclaim?', { cancel: 'RETURN' });
let selected = index != -1 ? options[index] : 'RETURN';
switch (selected) {
case 'ETH':
let ethBalance = await web3.eth.getBalance(currentDividendsModule.options.address);
console.log(chalk.yellow(`Current ETH balance: ${web3.utils.fromWei(ethBalance)} ETH`));
let reclaimETHAction = currentDividendsModule.methods.reclaimETH();
await common.sendTransaction(reclaimETHAction);
console.log(chalk.green('ETH has been reclaimed succesfully!'));
break;
case 'ERC20':
let erc20Address = readlineSync.question('Enter the ERC20 token address to reclaim (POLY = ' + polyToken.options.address + '): ', {
limit: function (input) {
return web3.utils.isAddress(input);
},
limitMessage: "Must be a valid address",
defaultInput: polyToken.options.address
});
let reclaimERC20Action = currentDividendsModule.methods.reclaimERC20(erc20Address);
await common.sendTransaction(reclaimERC20Action);
console.log(chalk.green('ERC20 has been reclaimed succesfully!'));
break
}
}

function showInvestors(investorsArray, claimedArray, excludedArray) {
let dataTable = [['Investor', 'Has claimed', 'Is excluded']];
for (let i = 0; i < investorsArray.length; i++) {
Expand All @@ -470,7 +510,7 @@ function showInvestors(investorsArray, claimedArray, excludedArray) {
console.log(table(dataTable));
}

function showReport(_name, _tokenSymbol, _amount, _witthheld, _claimed, _investorArray, _claimedArray, _excludedArray, _withheldArray, _amountArray) {
function showReport(_name, _tokenSymbol, _tokenDecimals, _amount, _witthheld, _claimed, _investorArray, _claimedArray, _excludedArray, _withheldArray, _amountArray) {
let title = `${_name.toUpperCase()} DIVIDEND REPORT`;
let dataTable =
[[
Expand All @@ -485,10 +525,10 @@ function showReport(_name, _tokenSymbol, _amount, _witthheld, _claimed, _investo
let investor = _investorArray[i];
let excluded = _excludedArray[i];
let withdrawn = _claimedArray[i] ? 'YES' : 'NO';
let amount = !excluded ? web3.utils.fromWei(web3.utils.toBN(_amountArray[i]).add(web3.utils.toBN(_withheldArray[i]))) : 0;
let withheld = !excluded ? web3.utils.fromWei(_withheldArray[i]) : 'NA';
let amount = !excluded ? new BigNumber(_amountArray[i]).plus(_withheldArray[i]).div((Math.pow(10, _tokenDecimals))) : 0;
let withheld = !excluded ? parseFloat(_withheldArray[i]) / Math.pow(10, _tokenDecimals) : 'NA';
let withheldPercentage = (!excluded) ? (withheld !== '0' ? parseFloat(withheld) / parseFloat(amount) * 100 : 0) : 'NA';
let received = !excluded ? web3.utils.fromWei(_amountArray[i]) : 0;
let received = !excluded ? parseFloat(_amountArray[i]) / Math.pow(10, _tokenDecimals) : 0;
dataTable.push([
investor,
amount,
Expand All @@ -501,9 +541,9 @@ function showReport(_name, _tokenSymbol, _amount, _witthheld, _claimed, _investo
console.log(chalk.yellow(`-----------------------------------------------------------------------------------------------------------------------------------------------------------`));
console.log(title.padStart((50 - title.length) / 2, '*').padEnd((50 - title.length) / 2, '*'));
console.log();
console.log(`- Total amount of dividends sent: ${web3.utils.fromWei(_amount)} ${_tokenSymbol} `);
console.log(`- Total amount of taxes withheld: ${web3.utils.fromWei(_witthheld)} ${_tokenSymbol} `);
console.log(`- Total amount of dividends distributed: ${web3.utils.fromWei(_claimed)} ${_tokenSymbol} `);
console.log(`- Total amount of dividends sent: ${parseFloat(_amount) / Math.pow(10, _tokenDecimals)} ${_tokenSymbol} `);
console.log(`- Total amount of taxes withheld: ${parseFloat(_witthheld) / Math.pow(10, _tokenDecimals)} ${_tokenSymbol} `);
console.log(`- Total amount of dividends distributed: ${parseFloat(_claimed) / Math.pow(10, _tokenDecimals)} ${_tokenSymbol} `);
console.log(`- Total amount of investors: ${_investorArray.length} `);
console.log();
console.log(table(dataTable));
Expand Down Expand Up @@ -536,7 +576,7 @@ async function pushDividends(dividendIndex, checkpointId) {
}
}

async function exploreAccount(dividendIndex, dividendTokenAddress, dividendTokenSymbol) {
async function exploreAccount(dividendIndex, dividendTokenAddress, dividendTokenSymbol, dividendTokenDecimals) {
let account = readlineSync.question('Enter address to explore: ', {
limit: function (input) {
return web3.utils.isAddress(input);
Expand All @@ -553,33 +593,33 @@ async function exploreAccount(dividendIndex, dividendTokenAddress, dividendToken

console.log();
console.log(`Security token balance: ${web3.utils.fromWei(securityTokenBalance)} ${tokenSymbol} `);
console.log(`Dividend token balance: ${web3.utils.fromWei(dividendTokenBalance)} ${dividendTokenSymbol} `);
console.log(`Dividend token balance: ${dividendTokenBalance / Math.pow(10, dividendTokenDecimals)} ${dividendTokenSymbol} `);
console.log(`Is excluded: ${isExcluded ? 'YES' : 'NO'} `);
if (!isExcluded) {
console.log(`Has claimed: ${hasClaimed ? 'YES' : 'NO'} `);
if (!hasClaimed) {
console.log(`Dividends available: ${web3.utils.fromWei(dividendBalance)} ${dividendTokenSymbol} `);
console.log(`Tax withheld: ${web3.utils.fromWei(dividendTax)} ${dividendTokenSymbol} `);
console.log(`Dividends available: ${dividendBalance / Math.pow(10, dividendTokenDecimals)} ${dividendTokenSymbol} `);
console.log(`Tax withheld: ${dividendTax / Math.pow(10, dividendTokenDecimals)} ${dividendTokenSymbol} `);
}
}
console.log();
}

async function withdrawWithholding(dividendIndex, dividendTokenSymbol) {
async function withdrawWithholding(dividendIndex, dividendTokenSymbol, dividendTokenDecimals) {
let action = currentDividendsModule.methods.withdrawWithholding(dividendIndex);
let receipt = await common.sendTransaction(action);
let eventName = dividendsType === 'ERC20' ? 'ERC20DividendWithholdingWithdrawn' : 'EtherDividendWithholdingWithdrawn';
let event = common.getEventFromLogs(currentDividendsModule._jsonInterface, receipt.logs, eventName);
console.log(chalk.green(`Successfully withdrew ${web3.utils.fromWei(event._withheldAmount)} ${dividendTokenSymbol} from dividend ${event._dividendIndex} tax withholding.`));
console.log(chalk.green(`Successfully withdrew ${event._withheldAmount / Math.pow(10, dividendTokenDecimals)} ${dividendTokenSymbol} from dividend ${event._dividendIndex} tax withholding.`));
}

async function reclaimedDividend(dividendIndex, dividendTokenSymbol) {
async function reclaimedDividend(dividendIndex, dividendTokenSymbol, dividendTokenDecimals) {
let action = currentDividendsModule.methods.reclaimDividend(dividendIndex);
let receipt = await common.sendTransaction(action);
let eventName = dividendsType === 'ERC20' ? 'ERC20DividendReclaimed' : 'EtherDividendReclaimed';
let event = common.getEventFromLogs(currentDividendsModule._jsonInterface, receipt.logs, eventName);
console.log(`
Reclaimed amount ${ web3.utils.fromWei(event._claimedAmount)} ${dividendTokenSymbol}
Reclaimed amount ${event._claimedAmount / Math.pow(10, dividendTokenDecimals)} ${dividendTokenSymbol}
to account ${ event._claimer} `
);
}
Expand Down Expand Up @@ -699,7 +739,7 @@ async function selectDividend(dividends) {
let result = null;
let options = dividends.map(function (d) {
return `${d.name}
Amount: ${web3.utils.fromWei(d.amount)} ${d.tokenSymbol}
Amount: ${parseFloat(d.amount) / Math.pow(10, d.tokenDecimals)} ${d.tokenSymbol}
Status: ${isExpiredDividend(d) ? 'Expired' : hasRemaining(d) ? 'In progress' : 'Completed'}
Token: ${d.tokenSymbol}
Created: ${moment.unix(d.created).format('MMMM Do YYYY, HH:mm:ss')}
Expand All @@ -715,7 +755,7 @@ async function selectDividend(dividends) {
}

async function getDividends() {
function DividendData(_index, _created, _maturity, _expiry, _amount, _claimedAmount, _name, _tokenSymbol) {
function DividendData(_index, _created, _maturity, _expiry, _amount, _claimedAmount, _name, _tokenSymbol, _tokenDecimals) {
this.index = _index;
this.created = _created;
this.maturity = _maturity;
Expand All @@ -724,6 +764,7 @@ async function getDividends() {
this.claimedAmount = _claimedAmount;
this.name = _name;
this.tokenSymbol = _tokenSymbol;
this.tokenDecimals = _tokenDecimals;
}

let dividends = [];
Expand All @@ -736,9 +777,12 @@ async function getDividends() {
let nameArray = dividendsData.names;
for (let i = 0; i < nameArray.length; i++) {
let tokenSymbol = 'ETH';
let dividendTokenDecimals = 18;
if (dividendsType === 'ERC20') {
let tokenAddress = await currentDividendsModule.methods.dividendTokens(i).call();
tokenSymbol = await getERC20TokenSymbol(tokenAddress);
let erc20token = new web3.eth.Contract(abis.erc20(), tokenAddress);
dividendTokenDecimals = await erc20token.methods.decimals().call();
}
dividends.push(
new DividendData(
Expand All @@ -749,7 +793,8 @@ async function getDividends() {
amountArray[i],
claimedAmountArray[i],
web3.utils.hexToUtf8(nameArray[i]),
tokenSymbol
tokenSymbol,
dividendTokenDecimals
)
);
}
Expand Down
Loading