Add payroll app to all templates #124

theethernaut · 2019-07-29T19:51:11Z

🚧 WIP 🚧

Tasks

Add Payroll app functionality in base template
Add Payroll app in company template (review before applying to all others)
Company board template
Membership template
Reputation template

…parameters occur first

shared/helpers/abi.js

shared/scripts/test-ganache.sh

facuspagnuolo · 2019-07-30T18:40:39Z

Left a few comments, would you mind updating this branch with master?

…mpalte with payroll app in 1 tx

shared/contracts/BaseTemplate.sol

…olidity function overloading

…ertRevert util

facuspagnuolo

Looking good, we can work out some improvements for the tests later

sohkai

Just looked at the company template's changes, since the other template changes are quite similar.

A couple suggestions :)

shared/contracts/BaseTemplate.sol

shared/helpers/abi.js

sohkai · 2019-08-01T11:27:45Z

templates/trust/package.json

@@ -43,6 +43,7 @@
    "@aragon/apps-agent": "^1.0.0",
    "@aragon/apps-vault": "^4.1.0",
    "@aragon/apps-voting": "^2.1.0",
+    "@aragon/apps-payroll": "^1.0.0-rc.1",


Don't think we need this dependency here 😄

There's something weird going on, if that dependency isn't there, Trust doesn't compile. Or at least that was the case with the CI.

Hmm, I see, the contract resolution algorithm is a bit tricky with how npm works (and it's why we can't hoist contracts when using lerna).

Not sure if truffle@5 has made any inroads to fixing this, but for now I've moved the unused apps into the dev dependencies.

shared/helpers/assertRevert.js

templates/company/test/company.js

templates/company/contracts/CompanyTemplate.sol

sohkai · 2019-08-01T11:41:11Z

templates/company/contracts/CompanyTemplate.sol

+        address denominationToken = _toAddress(_payrollSettings[0]);
+        IFeed priceFeed = IFeed(_toAddress(_payrollSettings[1]));
+        uint64 rateExpiryTime = _payrollSettings[2].toUint64();
+        address employeeManager = _toAddress(_payrollSettings[3]);


One small thing is perhaps doing this coercion at the start of newInstance() instead, so the user doesn't waste gas creating an entire org before their input fails here.

see my summary comment bellow

facuspagnuolo · 2019-08-03T01:16:47Z

I've been wasting a lot of time dealing with stack too deep issues... we do have to start thinking on either using ABI encoder V2 or having less optimized templates (e.g. reading settings from storage, using more txs, or sth like that).

Note that the code looks completely awkward due to how we need to load from storage, pass by argument, and the rest of ticks and tricks that we needed to do to avoid compiling issues, it definitely won't look good for inexperienced users as an example of how to build a template :/

theethernaut · 2019-08-06T23:13:28Z

I've been wasting a lot of time dealing with stack too deep issues... we do have to start thinking on either using ABI encoder V2 or having less optimized templates (e.g. reading settings from storage, using more txs, or sth like that).

Note that the code looks completely awkward due to how we need to load from storage, pass by argument, and the rest of ticks and tricks that we needed to do to avoid compiling issues, it definitely won't look good for inexperienced users as an example of how to build a template :/

@facuspagnuolo
ABI encoder V2 sounds nice, but we would need to either enable experimental features on contracts (not even sure if 0.4.24 has the feature or how stable it is), or update all contracts to a newer version of Solidity like 0.5.x.

IDEA: What about implementing a very simple system in which any template can be initialized with 2 transactions, no matter how basic or complex it is.

tx 1) The user deploys a "configuration contract" that simply holds state in a bunch of public variables that can be read later by a template being initialized.

tx 2) The template's initialize function, instead of getting its settings from parameters in a function call, retrieves them from the configuration contract by reading state. The template could even selfdestruct the configuration contract, getting a bit of gas refunded.

The configuration contract could also contain booleans like "installPayrollApp", so that much of the modular functionality of installing a particular combination of apps could be abstracted to the BaseTemplate, making templates even simpler to read and understand.

sohkai · 2019-08-07T09:40:59Z

templates/company-board/test/company-board.js

+const ONE_DAY = 60 * 60 * 24
+const ONE_WEEK = ONE_DAY * 7
+const THIRTY_DAYS = ONE_DAY * 30
+const TWO_MONTHS = ONE_DAY * 31


This is a bit misleading; perhaps MORE_THAN_ONE_MONTH would be clearer?

Ohhh, it definitely should be ONE_MONTH

sohkai · 2019-08-07T09:54:19Z

templates/company-board/contracts/CompanyBoardTemplate.sol

+
+    function _setupPermissions(Voting _shareVoting, TokenManager _shareTokenManager, Vault _agentOrVault, Finance _finance, bool _useAgentAsVault) internal returns (Voting) {
+        Kernel dao = _fetchDaoCache();
+        ACL _acl = ACL(dao.acl());


Can we name this as just acl?

sohkai · 2019-08-07T10:07:37Z

templates/company-board/contracts/CompanyBoardTemplate.sol

-    {
-        Kernel dao = _popDaoCache(msg.sender);
-        _setupApps(dao, _boardMembers, _shareHolders, _shareStakes, _boardVotingSettings, _shareVotingSettings, _financePeriod, _useAgentAsVault);
+    function setupShare(string _id, address[] _holders, uint256[] _stakes, uint64[3] _votingSettings, uint64 _financePeriod, bool _useAgentAsVault) external {


If I understand it correctly now, the flow is:

prepareInstance()

setupBoard()

setupShare()

Is it not possible to combine prepareInstance() with setupBoard()?

It may be possible since they cost 5e6 and 1.3e6 respectively, which means they should fit in a single tx

sohkai · 2019-08-07T10:19:54Z

templates/trust/package.json

@@ -43,6 +43,7 @@
    "@aragon/apps-agent": "^1.0.0",
    "@aragon/apps-vault": "^4.1.0",
    "@aragon/apps-voting": "^2.1.0",
+    "@aragon/apps-payroll": "^1.0.0-rc.1",


Hmm, I see, the contract resolution algorithm is a bit tricky with how npm works (and it's why we can't hoist contracts when using lerna).

Not sure if truffle@5 has made any inroads to fixing this, but for now I've moved the unused apps into the dev dependencies.

sohkai · 2019-08-07T10:23:26Z

using ABI encoder V2

Would ABI encoder V2 help with the stack issues? There's probably not too much we can do on that regard since we only get 16 slots?

IDEA: What about implementing a very simple system in which any template can be initialized with 2 transactions, no matter how basic or complex it is.

I'm not sure if this would be cheaper than just passing along arguments; the main benefit I see with deploying a configuration contract (or writing to a global, shared one), would be ease of recovering if you only sent 1 / 3 transactions during onboarding or etc.

sohkai · 2019-08-07T12:11:34Z

@facuspagnuolo I've pushed a few commits that are mostly cosmetic / small fixes. Looking into changing the initialization structure of the company with board template (#124 (comment)) to see if I can come up with something more intuitive :).

theethernaut · 2019-08-07T13:39:27Z

I made a quick experiment in remix to see if a configuration contract would help with the stack too deep problem, and it looks like the technique produces the errors even sooner than when using plain old function parameters. If you want to have a look and play with it yourselves: https://remix.ethereum.org/#version=soljson-v0.5.1+commit.c8a2cb62.js&optimize=false&gist=17461f2c1dbd9edb598acba1a46ea412

sohkai · 2019-08-07T13:50:09Z

That is definitely not a good sign for the configuration contract... it's probably because doing a call involves quite a lot of stack variables.

facuspagnuolo and others added 7 commits July 27, 2019 09:43

company-board: optimize gas costs

eb37347

docs: update vote settings order

63a2f5b

Reordered parameters in newTokenAndInstance functions, so that token …

7e4435a

…parameters occur first

Removed trailing whitespace

4b8e3b8

Removed trailing semicolons

da59a23

Style fix in conditionals

b4af0a9

Progress in adding the Payroll app to the company template

ae8c413

theethernaut requested a review from facuspagnuolo July 29, 2019 19:51

luisivan mentioned this pull request Jul 29, 2019

Create new templates contracts aragonone/product#138

Closed

19 tasks

theethernaut added 3 commits July 29, 2019 17:04

Progress in adding the Payroll app to the company template

da86506

First working instance of Payroll app in the company template

652c4df

Company template with payroll working with overloading

77d5ce0

facuspagnuolo reviewed Jul 30, 2019

View reviewed changes

shared/helpers/abi.js Outdated Show resolved Hide resolved

shared/helpers/abi.js Outdated Show resolved Hide resolved

shared/scripts/test-ganache.sh Outdated Show resolved Hide resolved

theethernaut added 3 commits July 30, 2019 12:56

Style refactoring if the abi.js helper module

efe590d

Reduced gas limit back to 8000000 but removed option to initialize te…

62860fa

…mpalte with payroll app in 1 tx

Updated branch with master

e2fd6ce

sohkai reviewed Jul 31, 2019

View reviewed changes

shared/contracts/BaseTemplate.sol Outdated Show resolved Hide resolved

theethernaut added 3 commits July 31, 2019 08:02

Added Payroll app dependency to all the templates

39a0d28

Fixed an issue with assertRevertGanache and made it compatible with s…

969c130

…olidity function overloading

Updated company template readme, and minor improvements regarding ass…

225b4d9

…ertRevert util

facuspagnuolo reviewed Jul 31, 2019

View reviewed changes

theethernaut added 4 commits July 31, 2019 11:45

Added a parameter for fine tuning the Payroll app permissions

25f7382

Linter fix on CompanyTemplate

67d87db

Added Payroll app to the Reputation template

404d341

Added Payroll app to the Membership template

86dfe74

sohkai reviewed Aug 1, 2019

View reviewed changes

facuspagnuolo added 3 commits August 1, 2019 09:39

Merge branch 'master' of github.com:aragon/dao-kits into add_payroll_app

6b6d4ef

contracts: payroll enhancements

82e3017

docs: unify wording

b0d9a79

facuspagnuolo added 3 commits August 2, 2019 11:35

tests: use nested scenarios

4433704

company-board: support payroll

587eeb3

shared: improve assert revert

95b1fce

facuspagnuolo self-assigned this Aug 3, 2019

facuspagnuolo requested a review from sohkai August 3, 2019 01:19

facuspagnuolo changed the title ~~(WIP) Add payroll app to all templates~~ Add payroll app to all templates Aug 3, 2019

facuspagnuolo mentioned this pull request Aug 3, 2019

Template enhacements #127

Merged

sohkai reviewed Aug 7, 2019

View reviewed changes

sohkai added 4 commits August 7, 2019 13:15

Shared: bump web3 to stable v1

50e39d4

Templates: move unused apps in each template to its devDependencies

482ca9b

Templates: clarify comments and align code formatting

c6a179d

Templates: fix gas cost tests for more accurate amount

df06fc3

facuspagnuolo merged commit ce29559 into master Aug 7, 2019

delete-merged-branch bot deleted the add_payroll_app branch August 7, 2019 13:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add payroll app to all templates #124

Add payroll app to all templates #124

theethernaut commented Jul 29, 2019 •

edited by facuspagnuolo

facuspagnuolo commented Jul 30, 2019

facuspagnuolo left a comment

sohkai left a comment

sohkai Aug 1, 2019

theethernaut Aug 1, 2019

sohkai Aug 7, 2019

sohkai Aug 1, 2019

facuspagnuolo Aug 3, 2019

facuspagnuolo commented Aug 3, 2019 •

edited

theethernaut commented Aug 6, 2019 •

edited

sohkai Aug 7, 2019

facuspagnuolo Aug 7, 2019

sohkai Aug 7, 2019

facuspagnuolo Aug 7, 2019

sohkai Aug 7, 2019

facuspagnuolo Aug 7, 2019

sohkai Aug 7, 2019

sohkai commented Aug 7, 2019

sohkai commented Aug 7, 2019

theethernaut commented Aug 7, 2019 •

edited

sohkai commented Aug 7, 2019

Add payroll app to all templates #124

Add payroll app to all templates #124

Conversation

theethernaut commented Jul 29, 2019 • edited by facuspagnuolo

Tasks

facuspagnuolo commented Jul 30, 2019

facuspagnuolo left a comment

Choose a reason for hiding this comment

sohkai left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

facuspagnuolo commented Aug 3, 2019 • edited

theethernaut commented Aug 6, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sohkai commented Aug 7, 2019

sohkai commented Aug 7, 2019

theethernaut commented Aug 7, 2019 • edited

sohkai commented Aug 7, 2019

theethernaut commented Jul 29, 2019 •

edited by facuspagnuolo

facuspagnuolo commented Aug 3, 2019 •

edited

theethernaut commented Aug 6, 2019 •

edited

theethernaut commented Aug 7, 2019 •

edited