Merge remote-tracking branch 'origin/master' into no-beneficiary-withdraw

Author: nkuba

pkg/chain/gen/Makefile

@@ -42,7 +42,7 @@ abi/%.abi: ${solidity_dir}/contracts/%.sol
 
 
 abi/%.go: abi/%.abi
-	abigen --abi $< --pkg abi --type $* --out $@
+	go run github.com/ethereum/go-ethereum/cmd/abigen --abi $< --pkg abi --type $* --out $@
 
 contract/%.go cmd/%.go: abi/%ImplV1.abi abi/%ImplV1.go abi/%.go *.go
 	go run github.com/keep-network/keep-common/tools/generators/ethereum $< contract/$*.go cmd/$*.go

solidity/contracts/KeepBonding.sol

@@ -16,6 +16,8 @@ pragma solidity 0.5.17;
 
 import "@keep-network/keep-core/contracts/KeepRegistry.sol";
 import "@keep-network/keep-core/contracts/TokenStaking.sol";
+import "@keep-network/keep-core/contracts/TokenGrant.sol";
+import "@keep-network/keep-core/contracts/libraries/RolesLookup.sol";
 
 import "openzeppelin-solidity/contracts/math/SafeMath.sol";
 
@@ -24,13 +26,17 @@ import "openzeppelin-solidity/contracts/math/SafeMath.sol";
 /// @notice Contract holding deposits from keeps' operators.
 contract KeepBonding {
     using SafeMath for uint256;
+    using RolesLookup for address payable;
 
     // Registry contract with a list of approved factories (operator contracts).
     KeepRegistry internal registry;
 
     // KEEP token staking contract.
     TokenStaking internal tokenStaking;
 
+    // KEEP token grant contract.
+    TokenGrant internal tokenGrant;
+
     // Unassigned value in wei deposited by operators.
     mapping(address => uint256) public unbondedValue;
 
@@ -71,10 +77,16 @@ contract KeepBonding {
 
     /// @notice Initializes Keep Bonding contract.
     /// @param registryAddress Keep registry contract address.
-    /// @param tokenStakingAddress KEEP Token staking contract address.
-    constructor(address registryAddress, address tokenStakingAddress) public {
+    /// @param tokenStakingAddress KEEP token staking contract address.
+    /// @param tokenGrantAddress KEEP token grant contract address.
+    constructor(
+        address registryAddress,
+        address tokenStakingAddress,
+        address tokenGrantAddress
+    ) public {
         registry = KeepRegistry(registryAddress);
         tokenStaking = TokenStaking(tokenStakingAddress);
+        tokenGrant = TokenGrant(tokenGrantAddress);
     }
 
     /// @notice Add the provided value to operator's pool available for bonding.
@@ -113,34 +125,47 @@ contract KeepBonding {
     }
 
     /// @notice Withdraws amount from operator's value available for bonding.
-    /// Can be called only by the operator or by the stake owner. The value is
-    /// transferred to the beneficiary associated with the operator.
+    /// Should not be used by grantee of managed grants. For this case,
+    /// please use `withdrawAsManagedGrantee`.
+    ///
+    /// This function can be called only by:
+    /// - operator,
+    /// - liquid, staked tokens owner (not a grant),
+    /// - direct staked tokens grantee (not a managed grant).
+    ///
     /// @param amount Value to withdraw in wei.
     /// @param operator Address of the operator.
     function withdraw(uint256 amount, address operator) public {
         require(
             msg.sender == operator ||
-                msg.sender == tokenStaking.ownerOf(operator),
+                msg.sender.isTokenOwnerForOperator(operator, tokenStaking) ||
+                msg.sender.isGranteeForOperator(operator, tokenGrant),
             "Only operator or the owner is allowed to withdraw bond"
         );
 
-        require(
-            unbondedValue[operator] >= amount,
-            "Insufficient unbonded value"
-        );
-
-        unbondedValue[operator] = unbondedValue[operator].sub(amount);
+        withdrawBond(amount, operator);
+    }
 
-        address beneficiary = tokenStaking.beneficiaryOf(operator);
+    /// @notice Withdraws amount from operator's value available for bonding.
+    /// Can be called only by staked tokens managed grantee.
+    /// @param amount Value to withdraw in wei.
+    /// @param operator Address of the operator.
+    /// @param managedGrant Address of the managed grant contract.
+    function withdrawAsManagedGrantee(
+        uint256 amount,
+        address operator,
+        address managedGrant
+    ) public {
         require(
-            beneficiary != address(0),
-            "Beneficiary not defined for the operator"
+            msg.sender.isManagedGranteeForOperator(
+                operator,
+                managedGrant,
+                tokenGrant
+            ),
+            "Only grantee is allowed to withdraw bond"
         );
 
-        (bool success, ) = beneficiary.call.value(amount)("");
-        require(success, "Transfer failed");
-
-        emit UnbondedValueWithdrawn(operator, beneficiary, amount);
+        withdrawBond(amount, operator);
     }
 
     /// @notice Create bond for the given operator, holder, reference and amount.
@@ -338,4 +363,27 @@ contract KeepBonding {
     {
         return authorizedPools[_operator][_poolAddress];
     }
+
+    /// @notice Withdraws the provided amount from unbonded value of the
+    /// provided operator to operator's beneficiary. If there is no enough
+    /// unbonded value or the transfer failed, function fails.
+    function withdrawBond(uint256 amount, address operator) internal {
+        require(
+            unbondedValue[operator] >= amount,
+            "Insufficient unbonded value"
+        );
+
+        unbondedValue[operator] = unbondedValue[operator].sub(amount);
+
+        address beneficiary = tokenStaking.beneficiaryOf(operator);
+        require(
+            beneficiary != address(0),
+            "Beneficiary not defined for the operator"
+        );
+
+        (bool success, ) = beneficiary.call.value(amount)("");
+        require(success, "Transfer failed");
+
+        emit UnbondedValueWithdrawn(operator, beneficiary, amount);
+    }
 }

solidity/migrations/2_deploy_contracts.js

@@ -17,6 +17,7 @@ const BondedSortitionPoolFactory = artifacts.require(
 let {
   RandomBeaconAddress,
   TokenStakingAddress,
+  TokenGrantAddress,
   RegistryAddress,
 } = require("./external-contracts")
 
@@ -27,13 +28,21 @@ module.exports = async function (deployer) {
     TokenStakingStub = artifacts.require("TokenStakingStub")
     TokenStakingAddress = (await TokenStakingStub.new()).address
 
+    TokenGrantStub = artifacts.require("TokenGrantStub")
+    TokenGrantAddress = (await TokenGrantStub.new()).address
+
     RandomBeaconStub = artifacts.require("RandomBeaconStub")
     RandomBeaconAddress = (await RandomBeaconStub.new()).address
 
     RegistryAddress = (await deployer.deploy(KeepRegistry)).address
   }
 
-  await deployer.deploy(KeepBonding, RegistryAddress, TokenStakingAddress)
+  await deployer.deploy(
+    KeepBonding,
+    RegistryAddress,
+    TokenStakingAddress,
+    TokenGrantAddress
+  )
 
   await deployer.deploy(BondedECDSAKeep)
 

solidity/migrations/external-contracts.js

@@ -1,12 +1,14 @@
 // Addresses of externally deployed smart contracts
 const RegistryAddress = "0xAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
 const TokenStakingAddress = "0xBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB"
-const RandomBeaconAddress = "0xCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC"
-const TBTCSystemAddress = "0xDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD"
+const TokenGrantAddress = "0xCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC"
+const RandomBeaconAddress = "0xDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD"
+const TBTCSystemAddress = "0xEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEE"
 
 module.exports = {
   RegistryAddress,
   TokenStakingAddress,
+  TokenGrantAddress,
   RandomBeaconAddress,
   TBTCSystemAddress,
 }

solidity/package-lock.json

@@ -32,7 +32,7 @@
   },
   "homepage": "https://github.com/keep-network/keep-ecdsa",
   "dependencies": {
-    "@keep-network/keep-core": "1.1.2",
+    "@keep-network/keep-core": "1.2.3-pre.0",
     "@keep-network/sortition-pools": "1.0.0",
     "@openzeppelin/upgrades": "^2.7.2",
     "openzeppelin-solidity": "2.3.0",

solidity/package.json

@@ -18,6 +18,9 @@ REGISTRY_PROPERTY="RegistryAddress"
 TOKEN_STAKING_CONTRACT_DATA="TokenStaking.json"
 TOKEN_STAKING_PROPERTY="TokenStakingAddress"
 
+TOKEN_GRANT_CONTRACT_DATA="TokenGrant.json"
+TOKEN_GRANT_PROPERTY="TokenGrantAddress"
+
 RANDOM_BEACON_CONTRACT_DATA="KeepRandomBeaconService.json"
 RANDOM_BEACON_PROPERTY="RandomBeaconAddress"
 
@@ -61,6 +64,21 @@ function fetch_token_staking_contract_address() {
   fi
 }
 
+function fetch_token_grant_contract_address() {
+  echo "Fetching value for ${TOKEN_GRANT_PROPERTY}..."
+
+  local contractDataPath=$(realpath $KEEP_CORE_SOL_ARTIFACTS_PATH/$TOKEN_GRANT_CONTRACT_DATA)
+  local ADDRESS=$(cat ${contractDataPath} | jq "${JSON_QUERY}" | tr -d '"')
+
+  if [[ !($ADDRESS =~ $ADDRESS_REGEXP) ]]; then
+    echo "Invalid address: ${ADDRESS}"
+    FAILED=true
+  else 
+    echo "Found value for ${TOKEN_GRANT_PROPERTY} = ${ADDRESS}"
+    sed -i -e "/${TOKEN_GRANT_PROPERTY}/s/${SED_SUBSTITUTION_REGEXP}/\"${ADDRESS}\"/" $DESTINATION_FILE
+  fi
+}
+
 function fetch_random_beacon_contract_address() {
   echo "Fetching value for ${RANDOM_BEACON_PROPERTY}..."
 
@@ -78,6 +96,7 @@ function fetch_random_beacon_contract_address() {
 
 fetch_registry_contract_address
 fetch_token_staking_contract_address
+fetch_token_grant_contract_address
 fetch_random_beacon_contract_address
 
 if $FAILED; then

solidity/scripts/lcl-provision-external-contracts.sh

@@ -12,6 +12,7 @@ const BondedECDSAKeepFactoryStub = artifacts.require(
 )
 const KeepBonding = artifacts.require("KeepBonding")
 const TokenStakingStub = artifacts.require("TokenStakingStub")
+const TokenGrantStub = artifacts.require("TokenGrantStub")
 const BondedSortitionPool = artifacts.require("BondedSortitionPool")
 const BondedSortitionPoolFactory = artifacts.require(
   "BondedSortitionPoolFactory"
@@ -28,6 +29,7 @@ const expect = chai.expect
 contract("BondedECDSAKeepFactory", async (accounts) => {
   let registry
   let tokenStaking
+  let tokenGrant
   let keepFactory
   let bondedSortitionPoolFactory
   let keepBonding
@@ -1178,9 +1180,11 @@ contract("BondedECDSAKeepFactory", async (accounts) => {
       registry = await KeepRegistry.new()
       bondedSortitionPoolFactory = await BondedSortitionPoolFactory.new()
       tokenStaking = await TokenStakingStub.new()
+      tokenGrant = await TokenGrantStub.new()
       keepBonding = await KeepBonding.new(
         registry.address,
-        tokenStaking.address
+        tokenStaking.address,
+        tokenGrant.address
       )
       randomBeacon = accounts[1]
       const bondedECDSAKeepMasterContract = await BondedECDSAKeep.new()
@@ -1477,7 +1481,12 @@ contract("BondedECDSAKeepFactory", async (accounts) => {
     registry = await KeepRegistry.new()
     bondedSortitionPoolFactory = await BondedSortitionPoolFactory.new()
     tokenStaking = await TokenStakingStub.new()
-    keepBonding = await KeepBonding.new(registry.address, tokenStaking.address)
+    tokenGrant = await TokenGrantStub.new()
+    keepBonding = await KeepBonding.new(
+      registry.address,
+      tokenStaking.address,
+      tokenGrant.address
+    )
     randomBeacon = await RandomBeaconStub.new()
     const bondedECDSAKeepMasterContract = await BondedECDSAKeep.new()
     keepFactory = await BondedECDSAKeepFactoryStub.new(

solidity/test/BondedECDSAKeepFactoryTest.js

@@ -11,6 +11,7 @@ const BondedECDSAKeepFactoryStub = artifacts.require(
 )
 const KeepBonding = artifacts.require("KeepBonding")
 const TokenStaking = artifacts.require("TokenStaking")
+const TokenGrant = artifacts.require("TokenGrant")
 const BondedSortitionPool = artifacts.require("BondedSortitionPool")
 const BondedSortitionPoolFactory = artifacts.require(
   "BondedSortitionPoolFactory"
@@ -27,6 +28,7 @@ const expect = chai.expect
 contract("BondedECDSAKeepFactory", async (accounts) => {
   let keepToken
   let tokenStaking
+  let tokenGrant
   let keepFactory
   let bondedSortitionPoolFactory
   let keepBonding
@@ -245,8 +247,13 @@ contract("BondedECDSAKeepFactory", async (accounts) => {
       initializationPeriod,
       undelegationPeriod
     )
+    tokenGrant = await TokenGrant.new(keepToken.address)
 
-    keepBonding = await KeepBonding.new(registry.address, tokenStaking.address)
+    keepBonding = await KeepBonding.new(
+      registry.address,
+      tokenStaking.address,
+      tokenGrant.address
+    )
     randomBeacon = await RandomBeaconStub.new()
     const bondedECDSAKeepMasterContract = await BondedECDSAKeep.new()
     keepFactory = await BondedECDSAKeepFactoryStub.new(

solidity/test/BondedECDSAKeepIntegrationTest.js

@@ -16,6 +16,7 @@ const TestToken = artifacts.require("TestToken")
 const KeepBonding = artifacts.require("KeepBonding")
 const TestEtherReceiver = artifacts.require("TestEtherReceiver")
 const TokenStakingStub = artifacts.require("TokenStakingStub")
+const TokenGrantStub = artifacts.require("TokenGrantStub")
 const BondedECDSAKeepCloneFactory = artifacts.require(
   "BondedECDSAKeepCloneFactory"
 )
@@ -42,6 +43,7 @@ contract("BondedECDSAKeep", (accounts) => {
   let registry
   let keepBonding
   let tokenStaking
+  let tokenGrant
   let bondedECDSAKeepStubMaster
   let keep
   let factoryStub
@@ -87,7 +89,12 @@ contract("BondedECDSAKeep", (accounts) => {
   before(async () => {
     registry = await KeepRegistry.new()
     tokenStaking = await TokenStakingStub.new()
-    keepBonding = await KeepBonding.new(registry.address, tokenStaking.address)
+    tokenGrant = await TokenGrantStub.new()
+    keepBonding = await KeepBonding.new(
+      registry.address,
+      tokenStaking.address,
+      tokenGrant.address
+    )
     bondedECDSAKeepStubMaster = await BondedECDSAKeepStub.new()
     factoryStub = await BondedECDSAKeepCloneFactory.new(
       bondedECDSAKeepStubMaster.address