@bgd-labs/governance-v3-js-utils

Governance v3 js utils

This repository contains helper functions to interact with governance v3 contracts.

Installation

npm

npm i @bgd-labs/governance-v3-js-utils

yarn

yarn add @bgd-labs/governance-v3-js-utils

Usage examples

Voting balances proofs example

    import { baseSlots, AssetsBalanceSlots, Asset } from '@bgd-labs/governance-v3-ethers-utils/dist/utils';
    import { getVotingProofs } from '@bgd-labs/governance-v3-js-utils/dist/viem';
    import { eGetVotingProofs } from '@bgd-labs/governance-v3-js-utils/dist/ether';
    import { AaveV3Ethereum, AaveSafetyModule, GovernanceV3Ethereum } from '@bgd-labs/aave-address-book';

    const assets = {
        aaveAddress: AaveV3Ethereum.ASSETS.AAVE.UNDERLYING,
        aAaveAddress: AaveV3Ethereum.ASSETS.AAVE.A_TOKEN,
        stkAAVEAddress: AaveSafetyModule.STK_AAVE,
        contractAddress: GovernanceV3Ethereum.GOVERNANCE,
    }

    const assetsBalanceSlots: AssetsBalanceSlots = {
        [assets.stkAAVEAddress.toLowerCase()]: {
            ...baseSlots[Asset.STKAAVE],
        },
        [assets.aAaveAddress.toLowerCase()]: {
            ...baseSlots[Asset.AAAVE],
        },
        [assets.aaveAddress.toLowerCase()]: {
            ...baseSlots[Asset.AAVE],
        },
        [assets.contractAddress.toLowerCase()]: {
            ...baseSlots[Asset.GOVCORE],
        },
    };

    const formattedBalances = [{
        underlyingAsset: assets.aaveAddress, // address of voting asset
        value: "100", // total balance (user balance + delegated voting power) on voting block
        userBalance: "100", // should be real user balance on voting block (not current))
        isWithDelegatedPower: false, // value !== userBalance (on voting block)
    }]

    // getting balance proofs for voting viem
    const proofs = await getVotingProofs({
        client: govCoreViemClient, // viem client
        blockHash: proposal.snapshotBlockHash, // from proposal data
        balances: formattedBalances,
        address: voterAddress, // voter asset (signer or representation address)
        aAaveAddress: assets.aAaveAddress,
        slots: assetsBalanceSlots,
    });
    
    // getting balance proofs for voting ether js v5
    const proofsEtherJs = await eGetVotingProofs({
        provider: govCoreRPCProvider, // ether js v5 provider
        blockHash: proposal.snapshotBlockHash, // from proposal data
        balances: formattedBalances,
        address: voterAddress, // voter asset (signer or representation address)
        aAaveAddress: assets.aAaveAddress,
        slots: assetsBalanceSlots,
    });

License

Copyright © 2024, BGD Labs. Released under the MIT License.