npm package: @pnetwork/staking-manager
Description: An Aragon app that allows to lock for a customizable amount of time, a quantity of ERC20 tokens in exchange organization's tokens
Author: allemanfredi@provable-things
Latest version: 3.0.0

# :crystal_ball: staking-manager

An Aragon app that allows to lock for a customizable amount of time, a quantity of ERC20 tokens in exchange for organization's tokens.

&nbsp;

***

&nbsp;

## :arrow_down: How to install

```
dao install <DAO address> staking-manager.open.aragonpm.eth --app-init-args <token manager> <vault> <erc20 token address> <min lock time> <max locks> --env aragon:rinkeby
```

&nbsp;

***

&nbsp;

## :clipboard: How to run locally

```
yarn install
```

```
yarn start
```

&nbsp;

***

&nbsp;

## :guardsman: Test

```
yarn test
```

### Result

```
    initialize(address _tokenManager, address _vault, address _depositToken, _uint256 _minLockTime _uint256 maxLocks) fails
      ✓ Should revert when passed non-contract address as token manager (48ms)
      ✓ Should revert when passed non-contract address as vault
      ✓ Should revert when passed non-contract address as deposit token
    initialize(address _tokenManager, address _vault, address address _depositToken, _uint256 _minLockTime, _uint256 maxLocks)
      ✓ Should set correct variables (40ms)
      ✓ Should set able to set maxLocks and minLockTime and vault (217ms)
      ✓ Should not be able to set maxLocks because of no permission (55ms)
      ✓ Should not be able to set maxLocks because of of value too high (86ms)
      ✓ Should not be able to set minLockTime because of no permission (65ms)
      ✓ Should not be able to set a new Vault because of no permission (56ms)
      stake(uint256 _amount, uint256 _lockTime, address _receiver)
        ✓ Should create wrapped tokens in exchange for DepositToken (112ms)
        ✓ Should not be able to stake without token approve (42ms)
        ✓ Should not be able to perform more stake than allowed (maxLocks) (1854ms)
        ✓ Should not be able to stake more than you have approved (49ms)
        ✓ Should not be able to stake with a lock time less than the minimun one (48ms)
        ✓ Should return a correct value when getting number of staked locks (1796ms)
        ✓ Should return a correct value when getting number of staked locks after having staked
      unstake(uint256 _amount)
        ✓ Should be able to both staking and unstaking (232ms)
        ✓ Should not be able to unstake more than you have (118ms)
        ✓ Should not be able to unstake because it needs to wait the correct time (128ms)
        ✓ Should be able to unstake (partial ok 1) (368ms)
        ✓ Should not be able to unstake because it needs to wait the correct time (partial fail 1) (256ms)
        ✓ Should be able to unstake (partial ok 2) (1062ms)
        ✓ Should not be able to unstake more than what you have wrapped (partial fail 2) (486ms)
        ✓ Should be able to unstake with different lock times (1016ms)
        ✓ Should be able to stake for a non sender address and unstake (254ms)
        ✓ Should not be able to stake for a non sender address and unstake to msg.sender (121ms)
        ✓ Should be able to insert in an empty slot (2603ms)
        ✓ Should be able to stake MAX_LOCKS times, unstake MAX_LOCKS * 2 times(unstake with amount / 2) and wrapping other MAX_LOCKS times (9768ms)
        ✓ Should be able to stake MAX_LOCKS times and unstake in two times (2408ms)
        ✓ Should not be able to stake zero tokens (45ms)
        ✓ Should return a correct value when getting number of staked locks after havin staked and unstake (4558ms)


  31 passing (53s)
```

&nbsp;

***

&nbsp;

## :rocket: How to publish

Create an __`.env`__ file with the following format

```
RINKEBY_PRIVATE_KEY=
MAINNET_PRIVATE_KEY=
INFURA_KEY=
```

Run the local IPFS node:

```
aragon ipfs start
```

and then publish.

```
npx buidler publish "version or patch/minor/major" --network "rinkeby or mainnet"
```

&nbsp;

***

&nbsp;

## :white_check_mark: How to verify

Add the following field to __`.env`__ file

```
ETHERSCAN_API_KEY=
```

and then verify.

```
npx buidler verify-contract --contract-name StakingManager --address 'deployed contract address' "constructor arguments"
```