Tested the new staking functions, all work on subgraph now

Author: davekay100

scripts/cli/commands/protocol.ts

@@ -22,6 +22,12 @@ const gettersList = {
   'staking-thawing-period': { contract: 'Staking', name: 'thawingPeriod' },
   'staking-dispute-epochs': { contract: 'Staking', name: 'channelDisputeEpochs' },
   'staking-max-allocation-epochs': { contract: 'Staking', name: 'maxAllocationEpochs' },
+  'staking-delegation-capacity': { contract: 'Staking', name: 'delegationCapacity' },
+  'staking-delegation-parameters-cooldown': {
+    contract: 'Staking',
+    name: 'delegationParametersCooldown',
+  },
+  'staking-delegation-unbonding-period': { contract: 'Staking', name: 'delegationUnbondingPeriod' },
   'protocol-percentage': { contract: 'Staking', name: 'protocolPercentage' },
   'curation-governor': { contract: 'Curation', name: 'governor' },
   'curation-staking-contract': { contract: 'Curation', name: 'staking' },
@@ -51,6 +57,15 @@ const settersList = {
   'staking-dispute-epochs': { contract: 'Staking', name: 'setChannelDisputeEpochs' },
   'staking-max-allocation-epochs': { contract: 'Staking', name: 'setMaxAllocationEpochs' },
   'staking-protocol-percentage': { contract: 'Staking', name: 'setProtocolPercentage' },
+  'staking-delegation-capacity': { contract: 'Staking', name: 'setDelegationCapacity' },
+  'staking-delegation-parameters-cooldown': {
+    contract: 'Staking',
+    name: 'setDelegationParametersCooldown',
+  },
+  'staking-delegation-unbonding-period': {
+    contract: 'Staking',
+    name: 'setDelegationUnbondingPeriod',
+  },
   'curation-governor': { contract: 'Curation', name: 'setGovernor' },
   'curation-staking-contract': { contract: 'Curation', name: 'setStaking' },
   'curation-reserve-ratio': { contract: 'Curation', name: 'setDefaultReserveRatio' },

scripts/contracts/connectedContracts.ts

@@ -334,11 +334,11 @@ class ConnectedStaking extends ConnectedContract {
   }
 
   allocateWithDecimals = async (
-    amount: string,
-    price: string,
-    channelProxy: string,
     subgraphDeploymentID: string,
+    amount: string,
     channelPubKey: string,
+    channelProxy: string,
+    price: string,
   ): Promise<ContractTransaction> => {
     const amountParseDecimals = utils.parseUnits(amount as string, 18).toString()
     return this.contract.allocate(
@@ -347,6 +347,7 @@ class ConnectedStaking extends ConnectedContract {
       channelPubKey,
       channelProxy,
       price,
+      basicOverrides(),
     )
   }
 

scripts/contracts/helpers.ts

@@ -202,3 +202,56 @@ export const mockChannelPubKeys: Array<string> = [
   '0x0456708870bfd5d8fc956fe33285dcf59b075cd7a25a21ee00834e480d3754bcda180e670145a290bb4bebca8e105ea7776a7b39e16c4df7d4d1083260c6f05d58',
   '0x0456708870bfd5d8fc956fe33285dcf59b075cd7a25a21ee00834e480d3754bcda180e670145a290bb4bebca8e105ea7776a7b39e16c4df7d4d1083260c6f05d59',
 ]
+
+// User accounts used are always 0 to 10
+export const userAccounts = (mnemonic: string, provider: string): Array<Wallet> => {
+  return configureWallets(mnemonic, provider, 10)
+}
+
+/* Proxy accounts used are always 10 to 20.
+    Addresses below:
+    0x853d474EB22701b94910f275CdB57A62c4B2db7E
+    0x2A7f74f2F90d34eceE06E6196D3da7B8FcA02fa2
+    0x048CdeADbcb9E493D19b48eB7B693DC056Fd2036
+    0xD03a084A951B42bEb1a30232B8f738AB288256fa
+    0xEF99F3f68Dc194a3720b374c2e3AC56beF8d8D61
+    0x1A8f34607F6495f7E3bF6ee7553C12602B826D7A
+    0xEAaeC61E782992f85cCc096a16Fc9C74EfaA5355
+    0xf7c0e78323Fcb0532cEa23d99B63C729e178568A
+    0xF6cAdFc68B855e2944f27C5DF4a66c52B24d2d94
+    0x4cc6B907c7Bf1480426075e832Dc35bBC7264077
+*/
+export const proxyAccounts = (mnemonic: string, provider: string): Array<Wallet> => {
+  const wallets = configureWallets(mnemonic, provider, 20)
+  return wallets.slice(10, 20)
+}
+
+/* Channel accounts used are always 20 to 30.
+    Addresses below:
+    0x73f0bd80493BEA09BAFAFCdc6E71A9569eAcA0aB
+    0xeD12E3068Cdb1F9afD7A038c5a7B1a9b66C5986B
+    0x3796d3711070222d49EE6207Fe1cd4b2fcAD0663
+    0xfBD176446f56c0a52f44c5bfC24d339fF4B09470
+    0xbe45140e5783c8F5fA5123fDcC74D209f3c9155b
+    0x2084259748B13F800B6aE0b7A33c87e49546BfD8
+    0x81A90593786e6d0fC9cF29C9842Bca4Ab2f1bEb7
+    0xA3e182b8CaC70b43c84a437a4F1774447505EA40
+    0x082b1536F8C9b0Ca3198a911c4934e456C2f7c32
+    0xBA6D2612dEA713e61a7c22E691af4eaea46aCf75
+
+    Uncompressed public keys below:
+    0x04e8c44ab3118e5ca2e470ff20556bb6b470a5265ca0992e82e9a26cf332d87cf6e3add759bd4ed23277fadc46dd9b79fbcce33314cb4a48687830f6a524ebb998
+    0x04c10f828e7ee0cc03dfed95bb8497de9d5366c6b13d9524ef8bcabdd5b1f58f1a38de3332e16a124da62ac298ed1cbfc6d867576635a0151c55ac3d9c84778f1c
+    0x04d51dc84783a733fbe1ab91255d8fcd0195c8a03937dd6791426142de8e8da6eb5519cab9730648e3c3dac51bc0865347d80860b7c707944a051e0896cbc7b632
+    0x04dc700c3efcb80c151de25ae5ffa417f2556b5b3a0c9edba771febfdd9f8ea82943f62709942ea23185771b96c976cbb709e307130b4ea343b1888ef200166cce
+    0x04185736d5509a687f0b64dd5caf4497443650d67708138daff1ccf3aa900d936cd399a25a58951f3801dfb61f81d48b396e49296bcac67ca35aed5e65fd5e65ed
+    0x04f4fd3d15f633540db5fd5f69f3a83b5f9a43b258c0855e8f87dd586e9fd33fb06d72fbfad9fd90c1fd59eccf6589099403583cfb89604eb1b0eb472e61f5fefe
+    0x04a880416006af0996a76e1b5d6171c005009d55bd7af8ed78b2af6bfbfafdff755c68f0e32e49ca0627acceec1611d5521dde7b90076c4ba1894e3dfb53c01ffd
+    0x047da2b532a32e1f87b570a4675e71fa9a794c43cda4562d1e9c55975534b335f00c8ac1006b7b303d4e72189af7caa70112eff9b47bfe00e37b4d832fcc716b50
+    0x04cc3c74d466211b119217e97806f8ec5f09d865940c99effaae967dc67e282ff09aa1900fdb14865f8e3323cac75d6f193fa85b5c732b742163d1d83d699c04a3
+    0x04c9558bb809ed4c65cce849db4337c29b6c72bec97bb6a600a8af7fc72ded8486ae3a76916e424c9cef6e40721f9c8b265056862897afad7cc859b8e34d4dbc95
+*/
+export const channelAccounts = (mnemonic: string, provider: string): Array<Wallet> => {
+  const wallets = configureWallets(mnemonic, provider, 30)
+  return wallets.slice(20, 30)
+}

scripts/contracts/populateData.ts

@@ -17,7 +17,9 @@ import { AccountMetadata, SubgraphMetadata } from '../metadataHelpers'
 import * as AccountDatas from '../mockData/account-metadata/accountMetadatas'
 import * as SubgraphDatas from '../mockData/subgraph-metadata/subgraphMetadatas'
 import {
-  configureWallets,
+  userAccounts,
+  proxyAccounts,
+  channelAccounts,
   executeTransaction,
   checkGovernor,
   mockChannelPubKeys,
@@ -331,18 +333,18 @@ const populateStaking = async (network: string, signers: Array<Wallet>, proxies:
 }
 
 const populateAll = async (mnemonic: string, provider: string, network: string): Promise<void> => {
-  const signers = configureWallets(mnemonic, provider, 20)
-  const userAccounts = signers.slice(0, 10)
-  const proxyAccounts = signers.slice(10, 20)
+  const users = userAccounts(mnemonic, provider)
+  const proxies = proxyAccounts(mnemonic, provider)
+  const channels = channelAccounts(mnemonic, provider)
   const governor = signers[0]
   // await sendEth(network, governor, userAccounts, proxyAccounts, '0.25') // only use at the start. TODO - make this a cli option or something
-  await populateGraphToken(network, userAccounts, proxyAccounts, '100000') // only use at the start. TODO - make this a cli option or something
-  await populateEthereumDIDRegistry(network, userAccounts)
-  await populateENS(network, userAccounts)
-  await populateGNS(network, userAccounts)
-  await populateCuration(network, userAccounts)
-  await populateServiceRegistry(network, userAccounts)
-  await populateStaking(network, userAccounts, proxyAccounts)
+  await populateGraphToken(network, users, proxies, '100000') // only use at the start. TODO - make this a cli option or something
+  await populateEthereumDIDRegistry(network, users)
+  await populateENS(network, users)
+  await populateGNS(network, users)
+  await populateCuration(network, users)
+  await populateServiceRegistry(network, users)
+  await populateStaking(network, users, proxies)
 }
 
 export default populateAll

scripts/contracts/staking.ts

@@ -10,6 +10,7 @@ import {
   buildNetworkEndpoint,
 } from './helpers'
 import { ConnectedStaking, ConnectedGraphToken } from './connectedContracts'
+import { utils, BigNumber } from 'ethers'
 
 const {
   network,
@@ -19,6 +20,10 @@ const {
   channelPubKey,
   channelProxy,
   price,
+  channelID,
+  restake,
+  indexer,
+  newIndexer,
 } = minimist.default(process.argv.slice(2), {
   string: [
     'network',
@@ -28,6 +33,10 @@ const {
     'channelPubKey',
     'channelProxy',
     'price',
+    'channelID',
+    'restake',
+    'indexer',
+    'newIndexer',
   ],
 })
 
@@ -37,7 +46,8 @@ if (!network || !func) {
 Usage: ${path.basename(process.argv[1])}
   --network  <string> - options: ganache, kovan, rinkeby
 
-  --func <text> - options: stake, unstake, withdraw, allocate, settle
+  --func <text> - options: stake, unstake, withdraw, allocate, settle, collect, claim, delegate
+                           undelegate, withdrawDelegated
 
   Function arguments:
   stake
@@ -52,12 +62,33 @@ Usage: ${path.basename(process.argv[1])}
   allocate
     --subgraphDeploymentID <bytes32>  - The subgraph deployment ID being allocated on
     --amount <number>                 - Amount of tokens being allocated (script adds 10^18)
-    --channelPubKey <bytes>           - The subgraph deployment ID being allocated on
-    --channelProxy <address>          - The subgraph deployment ID being allocated on
+    --channelPubKey <bytes>           - The public key used by the indexer to setup the off-chain channel
+    --channelProxy <address>          - Address of the multisig proxy used to hold channel funds
     --price <number>                  - Price the indexer will charge for serving queries of the subgraphID
 
-  settle (Note - settle must be called by the channelProxy that created the allocation)
-    --amount <number>   - Amount of tokens being settled  (script adds 10^18)
+  settle (note - must pass at least one epoch)
+    --channelID <number> - Channel being settled
+
+  collect (Note - collect must be called by the channelProxy)
+    --channelID - ID of the channel we are collecting funds from
+    --from      - Multisig channel address that triggered the withdrawal
+    --amount    - Token amount to withdraw
+
+  claim (note - you must have settled the channel already)
+    --channelID - ID of the channel we are claiming funds from
+    --restake   - True if you are restaking the fees, rather than withdrawing
+
+  delegate
+    --indexer - Indexer being delegated to
+    --amount  - Amount of tokens being delegated (automatically adds 10^18)
+
+  undelegate
+    --indexer - Indexer being delegated to
+    --amount  - Amount of shares being undelegated
+
+  withdrawDelegated
+    --indexer     - Indexer being withdrawn from
+    --newIndexer  - Indexer being delegated to
     `,
   )
   process.exit(1)
@@ -79,7 +110,7 @@ const main = async () => {
 
   try {
     if (func == 'stake') {
-      checkFuncInputs([amount], ['amount'], 'stake')
+      checkFuncInputs([amount], ['amount'], func)
       console.log('  First calling approve() to ensure staking contract can call transferFrom()...')
       await executeTransaction(
         connectedGT.approveWithDecimals(staking.contract.address, amount),
@@ -88,30 +119,66 @@ const main = async () => {
       console.log(`Staking ${amount} tokens in the staking contract...`)
       await executeTransaction(staking.stakeWithDecimals(amount), network)
     } else if (func == 'unstake') {
-      checkFuncInputs([amount], ['amount'], 'unstake')
+      checkFuncInputs([amount], ['amount'], func)
       console.log(`Unstaking ${amount} tokens. Tokens will be locked...`)
       await executeTransaction(staking.unstakeWithDecimals(amount), network)
     } else if (func == 'withdraw') {
       console.log(`Unlock tokens and withdraw them from the staking contract...`)
       await executeTransaction(staking.contract.withdraw(), network)
     } else if (func == 'allocate') {
-      checkFuncInputs([amount, price], ['amount', 'price'], 'allocate')
+      checkFuncInputs([amount, price], ['amount', 'price'], func)
       console.log(`Allocating ${amount} tokens on state channel ${subgraphDeploymentID} ...`)
       await executeTransaction(
         staking.allocateWithDecimals(
-          amount,
-          price,
           subgraphDeploymentID,
+          amount,
           channelPubKey,
           channelProxy,
+          price,
         ),
         network,
       )
     } else if (func == 'settle') {
-      // Note - this function must be called by the channel proxy eth address
-      checkFuncInputs([amount], ['amount'], 'settle')
-      console.log(`Settling ${amount} tokens on state channel with proxy address TODO`)
-      await executeTransaction(staking.settleWithDecimals(amount), network)
+      checkFuncInputs([channelID], ['channelID'], func)
+      console.log(`Settling channel: ${channelID}...`)
+      await executeTransaction(staking.contract.settle(channelID), network)
+    } else if (func == 'collect') {
+      console.log('COLLECT NOT IMPLEMENTED. NORMALLY CALLED FROM PROXY ACCOUNT')
+      process.exit(1)
+    } else if (func == 'claim') {
+      checkFuncInputs([channelID, restake], ['channelID', 'restake'], func)
+      console.log(`Claiming channel: ${channelID}...`)
+      await executeTransaction(staking.contract.claim(channelID, restake), network)
+    } else if (func == 'delegate') {
+      checkFuncInputs([amount, indexer], ['amount', 'indexer'], func)
+      console.log('  First calling approve() to ensure staking contract can call transferFrom()...')
+      await executeTransaction(
+        connectedGT.approveWithDecimals(staking.contract.address, amount),
+        network,
+      )
+      console.log(`Delegating ${amount} tokens to indexer: ${indexer}...`)
+      const amountParseDecimals = utils.parseUnits(amount as string, 18)
+      await executeTransaction(staking.contract.delegate(indexer, amountParseDecimals), network)
+    } else if (func == 'undelegate') {
+      checkFuncInputs([amount, indexer], ['amount', 'indexer'], func)
+      console.log(`Undelegating ${amount} shares from indexer: ${indexer}...`)
+      const amountParseDecimals = utils.parseUnits(amount as string, 18)
+      await executeTransaction(staking.contract.undelegate(indexer, amountParseDecimals), network)
+    } else if (func == 'withdrawDelegated') {
+      checkFuncInputs([newIndexer, indexer], ['newIndexer', 'indexer'], func)
+      console.log(`Withdrawing from ${indexer}`)
+      if (newIndexer != '0x0000000000000000000000000000000000000000') {
+        console.log(`Depositing to : ${newIndexer}...`)
+      }
+      await executeTransaction(staking.contract.withdrawDelegated(indexer, newIndexer), network)
+    } else if (func == 'getDelegationShares') {
+      checkFuncInputs([indexer], ['indexer'], func)
+      console.log(`Getting delegation shares....`)
+      const shares = await staking.contract.getDelegationShares(
+        indexer,
+        staking.configuredWallet.address,
+      )
+      console.log(shares.div(BigNumber.from('1000000000000000000')).toString())
     } else {
       console.log(`Wrong func name provided`)
       process.exit(1)

scripts/teamAddresses.ts

@@ -9,6 +9,7 @@ type TeamAddresses = {
   ariel: string
   dave: string
   zac: string
+  martin: string
 }
 
 export const teamAddresses: TeamAddresses = {
@@ -22,4 +23,5 @@ export const teamAddresses: TeamAddresses = {
   ariel: '0xeF38F892E4722152fD8eDb50cD84a96344FD47Ce',
   dave: '0x93606b27cB5e4c780883eC4F6b7Bed5f6572d1dd',
   zac: '0xD31bC1e2a214066Bb2258dac5f43Ce75e5542Ab9',
+  martin: '0x055BCF2c2BC965Ac8EEAe3f95922D65EE45d3366',
 }