feat: gov v3 (#564)

* feat: type generation for new contreacts gov v3 * feat: gov data helpers * fix: export * fix: typings * fix: rename * fix: types * fix: types * feat: helper methods * fix: types * feat: voting machine data helper * fix: build * feat: gov core * fix: export * feat: update reps * feat: aave v3 token * fix: specify block number * feat: payloads data service * fix: export * feat: meta delegation * feat: token delegate * fix: export * feat: deleted export * feat: added getPowers * feat: added delegateedata * feat: get eip712 domain * fix: staked token v3 * fix: staking test * fix: staked token types * fix: abi * fix: domain * fix: domain * fix: domain * fix: message * fix: test * fix: sig * fix: sig * feat: Feat/gov v3 cleanup (#567) * fix: sig func * fix: sig func * feat: updates * feat: update types * feat: update types * feat: update gov delegation v3 * fix: gas limit --------- Co-authored-by: Mark Grothe <[email protected]> * fix: gas limits * fix: imports * fix: gas limits * fix: remove empty file --------- Co-authored-by: Joaquin Battilana <[email protected]> Co-authored-by: Mark Hinschberger <[email protected]>
aave · Jan 18, 2024 · 335588e · 335588e
1 parent 2285290
commit 335588e
Show file tree

Hide file tree

Showing 30 changed files with 14,136 additions and 2,512 deletions.
diff --git a/packages/contract-helpers/src/commons/types.ts b/packages/contract-helpers/src/commons/types.ts
@@ -143,6 +143,8 @@ export enum ProtocolAction {
   claimRewardsAndStake = 'claimRewardsAndStake',
   setUsageAsCollateral = 'setUsageAsCollateral',
   withdrawAndSwitch = 'withdrawAndSwitch',
+  batchMetaDelegate = 'batchMetaDelegate',
+  updateRepresentatives = 'updateRepresentatives',
 }
 
 export enum GovernanceVote {

diff --git a/packages/contract-helpers/src/commons/utils.ts b/packages/contract-helpers/src/commons/utils.ts
@@ -138,6 +138,14 @@ export const gasLimitRecommendations: GasRecommendationType = {
     limit: '1000000',
     recommended: '1000000',
   },
+  [ProtocolAction.batchMetaDelegate]: {
+    limit: '200000',
+    recommended: '200000',
+  },
+  [ProtocolAction.updateRepresentatives]: {
+    limit: '60000',
+    recommended: '60000',
+  },
 };
 
 export const mintAmountsPerToken: Record<string, string> = {

diff --git a/packages/contract-helpers/src/governance-v3/aave-token-v3/index.ts b/packages/contract-helpers/src/governance-v3/aave-token-v3/index.ts
@@ -0,0 +1,84 @@
+import { BigNumber, PopulatedTransaction, providers } from 'ethers';
+import { AaveTokenV3 } from '../typechain/AaveTokenV3';
+import { AaveTokenV3__factory } from '../typechain/factories/AaveTokenV3__factory';
+
+export enum GovernancePowerType {
+  VOTING,
+  PROPOSITION,
+  ALL,
+}
+
+interface Eip712Domain {
+  name: string;
+  version: string;
+  chainId: BigNumber;
+  verifyingContract: string;
+}
+
+export class AaveTokenV3Service {
+  readonly _contract: AaveTokenV3;
+  readonly _contractInterface = AaveTokenV3__factory.createInterface();
+
+  constructor(tokenAddress: string, provider: providers.Provider) {
+    this._contract = AaveTokenV3__factory.connect(tokenAddress, provider);
+  }
+
+  public async balanceOf(user: string) {
+    return this._contract.balanceOf(user);
+  }
+
+  public async getPowerAt(
+    blockNumber: number,
+    user: string,
+    delegationType: GovernancePowerType,
+  ) {
+    return this._contract.functions.getPowerCurrent(user, delegationType, {
+      blockTag: blockNumber,
+    });
+  }
+
+  public async getPowers(user: string) {
+    const powers = await this._contract.getPowersCurrent(user);
+    return {
+      votingPower: powers[0],
+      propositionPower: powers[1],
+    };
+  }
+
+  public async getDelegateeData(user: string) {
+    const data = await this._contract.getDelegates(user);
+    return {
+      votingDelegatee: data[0],
+      propositionDelegatee: data[1],
+    };
+  }
+
+  public getDelegateTxData(
+    user: string,
+    delegateTo: string,
+    type: GovernancePowerType,
+  ): PopulatedTransaction {
+    const tx: PopulatedTransaction = {};
+    if (type === GovernancePowerType.ALL) {
+      tx.data = this._contractInterface.encodeFunctionData('delegate', [
+        delegateTo,
+      ]);
+    } else {
+      tx.data = this._contractInterface.encodeFunctionData('delegateByType', [
+        delegateTo,
+        type,
+      ]);
+    }
+
+    return {
+      ...tx,
+      to: this._contract.address,
+      from: user,
+      gasLimit: BigNumber.from('100000'),
+    };
+  }
+
+  public async getEip712Domain(): Promise<Eip712Domain> {
+    return this._contract.functions.eip712Domain();
+  }
+}
diff --git a/packages/contract-helpers/src/governance-v3/delegate-helper/index.ts b/packages/contract-helpers/src/governance-v3/delegate-helper/index.ts
@@ -0,0 +1,150 @@
+import { BigNumber, PopulatedTransaction, providers } from 'ethers';
+import { tEthereumAddress, ENS, ProtocolAction } from '../../commons/types';
+import { gasLimitRecommendations } from '../../commons/utils';
+import { MetaDelegateHelper } from '../typechain/MetaDelegateHelper';
+import { MetaDelegateHelper__factory } from '../typechain/factories/MetaDelegateHelper__factory';
+export enum DelegationType {
+  VOTING,
+  PROPOSITION,
+  ALL,
+}
+
+export type MetaDelegateParams = {
+  delegator: string;
+  delegatee: string;
+  underlyingAsset: string;
+  deadline: string;
+  v: number;
+  r: string;
+  s: string;
+  delegationType: number;
+};
+
+export type DelegateMetaSigParams = {
+  underlyingAsset: tEthereumAddress;
+  delegatee: tEthereumAddress | ENS;
+  delegationType: DelegationType;
+  delegator: tEthereumAddress;
+  increaseNonce: boolean;
+  governanceTokenName: string;
+  nonce: string;
+  connectedChainId: number;
+  deadline: string;
+};
+
+export class MetaDelegateHelperService {
+  readonly _contract: MetaDelegateHelper;
+
+  readonly _contractInterface = MetaDelegateHelper__factory.createInterface();
+  private readonly metaDelegateHelperContractAddress: string;
+
+  constructor(
+    metaDelegateHelperContractAddress: string,
+    provider: providers.Provider,
+  ) {
+    this.metaDelegateHelperContractAddress = metaDelegateHelperContractAddress; // Assign the contract address
+
+    this._contract = MetaDelegateHelper__factory.connect(
+      metaDelegateHelperContractAddress,
+      provider,
+    );
+  }
+
+  public batchMetaDelegate(
+    user: string,
+    delegateParams: MetaDelegateParams[],
+  ): PopulatedTransaction {
+    const tx: PopulatedTransaction = {
+      data: this._contractInterface.encodeFunctionData('batchMetaDelegate', [
+        delegateParams,
+      ]),
+      to: this.metaDelegateHelperContractAddress,
+      from: user,
+      gasLimit: BigNumber.from(
+        gasLimitRecommendations[ProtocolAction.batchMetaDelegate].limit,
+      ),
+    };
+    return tx;
+  }
+
+  public async prepareV3DelegateByTypeSignature({
+    underlyingAsset,
+    delegatee,
+    delegationType,
+    delegator,
+    increaseNonce,
+    governanceTokenName,
+    nonce,
+    connectedChainId,
+    deadline,
+  }: DelegateMetaSigParams): Promise<string> {
+    const isAllDelegate = delegationType === DelegationType.ALL;
+
+    const sigBaseType = [
+      { name: 'nonce', type: 'uint256' },
+      { name: 'deadline', type: 'uint256' },
+    ];
+    const sigParametersType = [
+      { name: 'delegator', type: 'address' },
+      { name: 'delegatee', type: 'address' },
+    ];
+    const sigDelegationTypeType = [{ name: 'delegationType', type: 'uint8' }];
+
+    const typesData = {
+      delegator,
+      delegatee,
+      nonce: BigInt(increaseNonce ? Number(nonce) + 1 : nonce).toString(),
+      deadline,
+    };
+
+    const eIP712DomainType = {
+      EIP712Domain: [
+        {
+          name: 'name',
+          type: 'string',
+        },
+        {
+          name: 'version',
+          type: 'string',
+        },
+        {
+          name: 'chainId',
+          type: 'uint256',
+        },
+        {
+          name: 'verifyingContract',
+          type: 'address',
+        },
+      ],
+    };
+
+    const typeData = {
+      domain: {
+        name: governanceTokenName,
+        version: '2',
+        chainId: connectedChainId,
+        verifyingContract: underlyingAsset,
+      },
+      types: isAllDelegate
+        ? {
+            ...eIP712DomainType,
+            Delegate: [...sigParametersType, ...sigBaseType],
+          }
+        : {
+            ...eIP712DomainType,
+
+            DelegateByType: [
+              ...sigParametersType,
+              ...sigDelegationTypeType,
+              ...sigBaseType,
+            ],
+          },
+      primaryType: isAllDelegate ? 'Delegate' : 'DelegateByType',
+      message: isAllDelegate
+        ? { ...typesData }
+        : { ...typesData, delegationType },
+    };
+
+    return JSON.stringify(typeData);
+  }
+}
diff --git a/packages/contract-helpers/src/governance-v3/governance-core/index.ts b/packages/contract-helpers/src/governance-v3/governance-core/index.ts
@@ -0,0 +1,55 @@
+import { BigNumber, PopulatedTransaction, providers } from 'ethers';
+import { ChainId, ProtocolAction } from '../../commons/types';
+import { gasLimitRecommendations } from '../../commons/utils';
+import {
+  GovernanceCore,
+  GovernanceCoreInterface,
+} from '../typechain/GovernanceCore';
+import { GovernanceCore__factory } from '../typechain/factories/GovernanceCore__factory';
+
+export interface GovernanceCoreServiceInterface {
+  getProposalCount: () => Promise<number>;
+  updateRepresentativesForChain: (
+    user: string,
+    representatives: Array<{ representative: string; chainId: ChainId }>,
+  ) => PopulatedTransaction;
+}
+export class GovernanceCoreService implements GovernanceCoreServiceInterface {
+  private readonly _contractInterface: GovernanceCoreInterface;
+  private readonly _contractInstance: GovernanceCore;
+
+  constructor(
+    governanceCoreContractAddress: string,
+    provider: providers.Provider,
+  ) {
+    this._contractInterface = GovernanceCore__factory.createInterface();
+    this._contractInstance = GovernanceCore__factory.connect(
+      governanceCoreContractAddress,
+      provider,
+    );
+  }
+
+  public async getProposalCount(): Promise<number> {
+    const count = await this._contractInstance.getProposalsCount();
+    return count.toNumber();
+  }
+
+  public updateRepresentativesForChain(
+    user: string,
+    representatives: Array<{ representative: string; chainId: ChainId }>,
+  ): PopulatedTransaction {
+    const actionTx: PopulatedTransaction = {
+      data: this._contractInterface.encodeFunctionData(
+        'updateRepresentativesForChain',
+        [representatives],
+      ),
+      to: this._contractInstance.address,
+      from: user,
+      gasLimit: BigNumber.from(
+        gasLimitRecommendations[ProtocolAction.updateRepresentatives].limit,
+      ),
+    };
+
+    return actionTx;
+  }
+}