index.ts

import { bn, fp } from '@helpers/numbers';
import { Task, TaskMode, TaskRunOptions } from '@src';
import { SiloLinearPoolDeployment } from './input';
import { ZERO_ADDRESS } from '@helpers/constants';
import * as expectEvent from '@helpers/expectEvent';
import { ethers } from 'hardhat';
import { getContractDeploymentTransactionHash, saveContractDeploymentTransactionHash } from '@src';
export default async (task: Task, { force, from }: TaskRunOptions = {}): Promise<void> => {
  const input = task.input() as SiloLinearPoolDeployment;
  const args = [
    input.Vault,
    input.ProtocolFeePercentagesProvider,
    input.BalancerQueries,
    input.FactoryVersion,
    input.PoolVersion,
    input.InitialPauseWindowDuration,
    input.BufferPeriodDuration,
  ];

  // Enums needed for Mock Silos interest data
  enum AssetStatus {
    Undefined,
    Active,
    Removed,
  }

  const factory = await task.deployAndVerify('SiloLinearPoolFactory', args, from, force);

  if (task.mode === TaskMode.LIVE) {
    // We also create a Pool using the factory and verify it, to let us compute their action IDs and so that future
    // Pools are automatically verified. We however don't run any of this code in CHECK mode, since we don't care about
    // the contracts deployed here. The action IDs will be checked to be correct via a different mechanism.

    // A Silo requires a Silo Repository
    const mockSiloRepoArgs = [0, 0];
    const mockSiloRepo = await task.deployAndVerify('MockSiloRepository', mockSiloRepoArgs, from, force);

    // shareTokens require a Silo liquidity pool
    const mockSiloArgs = [mockSiloRepo.address, input.WETH];
    const mockSilo = await task.deployAndVerify('MockSilo', mockSiloArgs, from, force);

    // SiloLinearPools require an Silo Token
    const mockShareTokenArgs = ['DO NOT USE - Mock Share Token', 'TEST', mockSilo.address, input.WETH, 18];
    const mockShareToken = await task.deployAndVerify('MockShareToken', mockShareTokenArgs, from, force);

    // It is necessary to set a total supply for the shareToken, as well as initialize assetStorage and interestData within the mockSilo.
    // This is done in order to avoid divide by 0 errors when creating a MockSiloLinearPool from the Factory.
    await mockShareToken.setTotalSupply(fp(1));
    await mockSilo.setAssetStorage(
      input.WETH,
      mockShareToken.address,
      mockShareToken.address,
      mockShareToken.address,
      fp(1),
      fp(1),
      fp(1)
    );

    await mockSilo.setInterestData(
      input.WETH, // interestBearingAsset
      0, // harvestedProtocolFees
      0, // protocolFees
      0, // interestRateTimestamp
      AssetStatus.Active // status
    );

    // The assetManager, pauseWindowDuration and bufferPeriodDuration will be filled in later, but we need to declare
    // them here to appease the type system. Those are constructor arguments, but automatically provided by the factory.
    const mockPoolArgs = {
      vault: input.Vault,
      name: 'DO NOT USE - Mock Linear Pool',
      symbol: 'TEST',
      mainToken: input.WETH,
      wrappedToken: mockShareToken.address,
      assetManager: undefined,
      upperTarget: 0,
      pauseWindowDuration: undefined,
      bufferPeriodDuration: undefined,
      swapFeePercentage: bn(1e12),
      owner: ZERO_ADDRESS,
      version: input.PoolVersion,
    };

    // This mimics the logic inside task.deploy
    if (force || !task.output({ ensure: false })['MockSiloLinearPool']) {
      const PROTOCOL_ID = 0;

      const poolCreationReceipt = await (
        await factory.create(
          mockPoolArgs.name,
          mockPoolArgs.symbol,
          mockPoolArgs.mainToken,
          mockPoolArgs.wrappedToken,
          mockPoolArgs.upperTarget,
          mockPoolArgs.swapFeePercentage,
          mockPoolArgs.owner,
          PROTOCOL_ID
        )
      ).wait();

      const event = expectEvent.inReceipt(poolCreationReceipt, 'PoolCreated');
      const mockPoolAddress = event.args.pool;

      await saveContractDeploymentTransactionHash(mockPoolAddress, poolCreationReceipt.transactionHash, task.network);
      await task.save({ MockSiloLinearPool: mockPoolAddress });
    }

    const mockSiloLinearPool = await task.instanceAt('SiloLinearPool', task.output()['MockSiloLinearPool']);

    // In order to verify the Pool's code, we need to complete its constructor arguments by computing the factory
    // provided arguments (asset manager and pause durations).

    // The asset manager is found by querying the Vault
    const vaultTask = new Task('20210418-vault', TaskMode.READ_ONLY, task.network);
    const vault = await vaultTask.deployedInstance('Vault');

    const { assetManager: assetManagerAddress } = await vault.getPoolTokenInfo(
      await mockSiloLinearPool.getPoolId(),
      input.WETH
    );
    mockPoolArgs.assetManager = assetManagerAddress;

    // The durations require knowing when the Pool was created, so we look for the timestamp of its creation block.

    const txHash = await getContractDeploymentTransactionHash(mockSiloLinearPool.address, task.network);

    const tx = await ethers.provider.getTransactionReceipt(txHash);
    const poolCreationBlock = await ethers.provider.getBlock(tx.blockNumber);

    // With those and the period end times, we can compute the durations.

    const { pauseWindowEndTime, bufferPeriodEndTime } = await mockSiloLinearPool.getPausedState();

    mockPoolArgs.pauseWindowDuration = pauseWindowEndTime.sub(poolCreationBlock.timestamp);
    mockPoolArgs.bufferPeriodDuration = bufferPeriodEndTime
      .sub(poolCreationBlock.timestamp)
      .sub(mockPoolArgs.pauseWindowDuration);

    // We are now ready to verify the Pool
    await task.verify('SiloLinearPool', mockSiloLinearPool.address, [mockPoolArgs]);

    // We can also verify the Asset Manager
    await task.verify('SiloLinearPoolRebalancer', assetManagerAddress, [
      input.Vault,
      input.BalancerQueries,
      mockShareToken.address,
    ]);
  }
};