Merge pull request #824 from graphprotocol/tmigone/exponential-rebates-rebased

feat(rebates): change query fee rebates mechanism to use exponential formula [rebased]

Author: tmigone

.gitignore

@@ -25,6 +25,7 @@ addresses-local.json
 localNetwork.json
 arbitrum-addresses-local.json
 tx-*.log
+addresses-fork.json
 
 # Keys
 .keystore

cli/commands/contracts/staking.ts

@@ -56,15 +56,6 @@ export const closeAllocation = async (cli: CLIEnvironment, cliArgs: CLIArgs): Pr
   await sendTransaction(cli.wallet, staking, 'closeAllocation', [allocationID, poi])
 }
 
-export const claim = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<void> => {
-  const allocationID = cliArgs.allocationID
-  const restake = cliArgs.restake
-  const staking = cli.contracts.Staking
-
-  logger.info(`Claiming allocation ${allocationID} with restake = ${restake}...`)
-  await sendTransaction(cli.wallet, staking, 'claim', [allocationID, restake])
-}
-
 export const delegate = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<void> => {
   const indexer = cliArgs.indexer
   const amount = parseGRT(cliArgs.amount)
@@ -229,28 +220,6 @@ export const stakingCommand = {
           return closeAllocation(await loadEnv(argv), argv)
         },
       })
-      .command({
-        command: 'claim',
-        describe: 'Claim rebate',
-        builder: (yargs: Argv) => {
-          return yargs
-            .option('allocationID', {
-              description: 'The allocation claimed from the rebate pool',
-              type: 'string',
-              requiresArg: true,
-              demandOption: true,
-            })
-            .option('restake', {
-              description: 'True if you are restaking the fees, rather than withdrawing',
-              type: 'boolean',
-              requiresArg: true,
-              demandOption: true,
-            })
-        },
-        handler: async (argv: CLIArgs): Promise<void> => {
-          return claim(await loadEnv(argv), argv)
-        },
-      })
       .command({
         command: 'delegate',
         describe: 'Delegate GRT',

cli/commands/protocol/get.ts

@@ -11,7 +11,6 @@ export const gettersList = {
   // Staking
   'staking-slasher': { contract: 'Staking', name: 'slashers' },
   'staking-thawing-period': { contract: 'Staking', name: 'thawingPeriod' },
-  'staking-dispute-epochs': { contract: 'Staking', name: 'channelDisputeEpochs' },
   'staking-max-allocation-epochs': { contract: 'Staking', name: 'maxAllocationEpochs' },
   'staking-delegation-ratio': { contract: 'Staking', name: 'delegationRatio' },
   'staking-delegation-parameters-cooldown': {

cli/commands/protocol/set.ts

@@ -11,10 +11,9 @@ export const settersList = {
   // Staking
   'staking-slasher': { contract: 'Staking', name: 'setSlasher' },
   'staking-thawing-period': { contract: 'Staking', name: 'setThawingPeriod' },
-  'staking-dispute-epochs': { contract: 'Staking', name: 'setChannelDisputeEpochs' },
   'staking-max-allocation-epochs': { contract: 'Staking', name: 'setMaxAllocationEpochs' },
   'staking-protocol-percentage': { contract: 'Staking', name: 'setProtocolPercentage' },
-  'staking-delegation-ratio': { contract: 'Staking', name: 'setDelegationRatio' },
+  'staking-delegation-parameters': { contract: 'Staking', name: 'setDelegationParameters' },
   'staking-delegation-parameters-cooldown': {
     contract: 'Staking',
     name: 'setDelegationParametersCooldown',

cli/config.ts

@@ -77,9 +77,16 @@ export function getContractConfig(
     if (name.startsWith('init')) {
       const initList = Object.entries(contractConfig.init) as Array<Array<string>>
       for (const [initName, initValue] of initList) {
+        // This allows passing structs as constructor params
+        // We can't however inject CLI env variables into struct params
+        const value =
+          typeof initValue === 'object'
+            ? Object.values(initValue)
+            : parseConfigValue(initValue, addressBook, cli)
+
         contractParams.push({
           name: initName,
-          value: parseConfigValue(initValue, addressBook, cli),
+          value: value,
         } as {
           name: string
           value: string

cli/network.ts

@@ -38,7 +38,7 @@ export const getChainID = (): number => {
 
 export const hashHexString = (input: string): string => keccak256(`0x${input.replace(/^0x/, '')}`)
 
-type ContractParam = string | BigNumber | number
+type ContractParam = string | BigNumber | number | { [key: string]: any }
 type DeployResult = {
   contract: Contract
   creationCodeHash: string
@@ -68,7 +68,12 @@ export const isContractDeployed = async (
 
   if (checkCreationCode) {
     const savedCreationCodeHash = addressEntry.creationCodeHash
-    const creationCodeHash = hashHexString(artifact.bytecode)
+    let creationCodeHash: string
+    try {
+      creationCodeHash = hashHexString(artifact.bytecode)
+    } catch (error) {
+      // Noop - assume contract is not deployed
+    }
     if (!savedCreationCodeHash || savedCreationCodeHash !== creationCodeHash) {
       logger.warn(`creationCodeHash in our address book doesn't match ${name} artifacts`)
       logger.info(`${savedCreationCodeHash} !== ${creationCodeHash}`)
@@ -315,6 +320,34 @@ export const deployContractAndSave = async (
   return deployResult.contract
 }
 
+export const deployContractImplementationAndSave = async (
+  name: string,
+  args: Array<ContractParam>,
+  sender: Signer,
+  addressBook: AddressBook,
+): Promise<Contract> => {
+  // Deploy the contract
+  const deployResult = await deployContract(name, args, sender)
+
+  // Save address entry
+  const entry = addressBook.getEntry(name)
+  entry.implementation = {
+    address: deployResult.contract.address,
+    constructorArgs: args.length === 0 ? undefined : args.map((e) => e.toString()),
+    creationCodeHash: deployResult.creationCodeHash,
+    runtimeCodeHash: deployResult.runtimeCodeHash,
+    txHash: deployResult.txHash,
+    libraries:
+      deployResult.libraries && Object.keys(deployResult.libraries).length > 0
+        ? deployResult.libraries
+        : undefined,
+  }
+  addressBook.setEntry(name, entry)
+  logger.info('> Contract saved to address book')
+
+  return deployResult.contract
+}
+
 export const deployContractWithProxyAndSave = async (
   name: string,
   args: Array<ContractParam>,

config/graph.arbitrum-goerli.yml

@@ -108,12 +108,14 @@ contracts:
       thawingPeriod: 6646 # in blocks
       protocolPercentage: 10000 # in parts per million
       curationPercentage: 100000 # in parts per million
-      channelDisputeEpochs: 2 # in epochs
       maxAllocationEpochs: 4 # in epochs
       delegationUnbondingPeriod: 12 # in epochs
       delegationRatio: 16 # delegated stake to indexer stake multiplier
-      rebateAlphaNumerator: 77 # rebateAlphaNumerator / rebateAlphaDenominator
-      rebateAlphaDenominator: 100 # rebateAlphaNumerator / rebateAlphaDenominator
+      rebateParameters:
+        alphaNumerator: 100 # alphaNumerator / alphaDenominator
+        alphaDenominator: 100 # alphaNumerator / alphaDenominator
+        lambdaNumerator: 60 # lambdaNumerator / lambdaDenominator
+        lambdaDenominator: 100 # lambdaNumerator / lambdaDenominator
       extensionImpl: "${{StakingExtension.address}}"
     calls:
       - fn: "setDelegationTaxPercentage"

config/graph.arbitrum-localhost.yml

@@ -1,10 +1,10 @@
 general:
-  arbitrator: &arbitrator "0x4237154FE0510FdE3575656B60c68a01B9dCDdF8" # Arbitration Council
-  governor: &governor "0x1257227a2ECA34834940110f7B5e341A5143A2c4" # Graph Council
-  authority: &authority "0x12B8D08b116E1E3cc29eE9Cf42bB0AA8129C3215" # Authority that signs payment vouchers
-  availabilityOracle: &availabilityOracle "0x7694a48065f063a767a962610C6717c59F36b445" # Subgraph Availability Oracle
-  pauseGuardian: &pauseGuardian "0x601060e0DC5349AA55EC73df5A58cB0FC1cD2e3C" # Protocol pause guardian
-  allocationExchangeOwner: &allocationExchangeOwner "0xbD38F7b67a591A5cc7D642e1026E5095B819d952" # Allocation Exchange owner
+  arbitrator: &arbitrator "0xFFcf8FDEE72ac11b5c542428B35EEF5769C409f0" # Arbitration Council
+  governor: &governor "0x22d491Bde2303f2f43325b2108D26f1eAbA1e32b" # Graph Council
+  authority: &authority "0xE11BA2b4D45Eaed5996Cd0823791E0C93114882d" # Authority that signs payment vouchers
+  availabilityOracle: &availabilityOracle "0xd03ea8624C8C5987235048901fB614fDcA89b117" # Subgraph Availability Oracle
+  pauseGuardian: &pauseGuardian "0x95cED938F7991cd0dFcb48F0a06a40FA1aF46EBC" # Protocol pause guardian
+  allocationExchangeOwner: &allocationExchangeOwner "0x3E5e9111Ae8eB78Fe1CC3bb8915d5D461F3Ef9A9" # Allocation Exchange owner
 
 contracts:
   Controller:
@@ -108,12 +108,14 @@ contracts:
       thawingPeriod: 6646 # in blocks
       protocolPercentage: 10000 # in parts per million
       curationPercentage: 100000 # in parts per million
-      channelDisputeEpochs: 2 # in epochs
       maxAllocationEpochs: 4 # in epochs
       delegationUnbondingPeriod: 12 # in epochs
       delegationRatio: 16 # delegated stake to indexer stake multiplier
-      rebateAlphaNumerator: 77 # rebateAlphaNumerator / rebateAlphaDenominator
-      rebateAlphaDenominator: 100 # rebateAlphaNumerator / rebateAlphaDenominator
+      rebateParameters:
+        alphaNumerator: 100 # alphaNumerator / alphaDenominator
+        alphaDenominator: 100 # alphaNumerator / alphaDenominator
+        lambdaNumerator: 60 # lambdaNumerator / lambdaDenominator
+        lambdaDenominator: 100 # lambdaNumerator / lambdaDenominator
       extensionImpl: "${{StakingExtension.address}}"
     calls:
       - fn: "setDelegationTaxPercentage"

config/graph.arbitrum-one.yml

@@ -108,12 +108,14 @@ contracts:
       thawingPeriod: 186092 # in blocks
       protocolPercentage: 10000 # in parts per million
       curationPercentage: 100000 # in parts per million
-      channelDisputeEpochs: 7 # in epochs
       maxAllocationEpochs: 28 # in epochs
       delegationUnbondingPeriod: 28 # in epochs
       delegationRatio: 16 # delegated stake to indexer stake multiplier
-      rebateAlphaNumerator: 77 # rebateAlphaNumerator / rebateAlphaDenominator
-      rebateAlphaDenominator: 100 # rebateAlphaNumerator / rebateAlphaDenominator
+      rebateParameters:
+        alphaNumerator: 100 # alphaNumerator / alphaDenominator
+        alphaDenominator: 100 # alphaNumerator / alphaDenominator
+        lambdaNumerator: 60 # lambdaNumerator / lambdaDenominator
+        lambdaDenominator: 100 # lambdaNumerator / lambdaDenominator
       extensionImpl: "${{StakingExtension.address}}"
     calls:
       - fn: "setDelegationTaxPercentage"

config/graph.goerli.yml

@@ -111,12 +111,14 @@ contracts:
       thawingPeriod: 6646 # in blocks
       protocolPercentage: 10000 # in parts per million
       curationPercentage: 100000 # in parts per million
-      channelDisputeEpochs: 2 # in epochs
       maxAllocationEpochs: 4 # in epochs
       delegationUnbondingPeriod: 12 # in epochs
       delegationRatio: 16 # delegated stake to indexer stake multiplier
-      rebateAlphaNumerator: 77 # rebateAlphaNumerator / rebateAlphaDenominator
-      rebateAlphaDenominator: 100 # rebateAlphaNumerator / rebateAlphaDenominator
+      rebateParameters:
+        alphaNumerator: 100 # alphaNumerator / alphaDenominator
+        alphaDenominator: 100 # alphaNumerator / alphaDenominator
+        lambdaNumerator: 60 # lambdaNumerator / lambdaDenominator
+        lambdaDenominator: 100 # lambdaNumerator / lambdaDenominator
       extensionImpl: "${{StakingExtension.address}}"
     calls:
       - fn: "setDelegationTaxPercentage"