hardhat.config.ts

import { HardhatUserConfig } from 'hardhat/config';
import { NetworkUserConfig } from 'hardhat/types';
import { config as dotenvConfig } from 'dotenv';
import { resolve } from 'path';

/**
 * this package includes:
 *  - @nomiclabs/hardhat-ethers
 *  - @nomicfoundation/hardhat-chai-matchers
 *  - @nomicfoundation/hardhat-network-helpers
 *  - @nomiclabs/hardhat-etherscan
 *  - @typechain/hardhat
 *  - solidity-coverage
 */
import '@nomicfoundation/hardhat-toolbox';

// additional hardhat plugins
import 'hardhat-packager';
import 'hardhat-contract-sizer';
import 'hardhat-deploy';

// custom built hardhat plugins for CI
import './scripts/ci/docs-generate';
import './scripts/ci/gas_benchmark';

// Typescript types for web3.js
import '@nomiclabs/hardhat-web3';

/**
 * @dev uncomment to generate contract docs in Markdown
 */
import '@b00ste/hardhat-dodoc';
import { dodocConfig } from './dodoc/config';

dotenvConfig({ path: resolve(__dirname, './.env') });

function getTestnetChainConfig(): NetworkUserConfig {
  const config: NetworkUserConfig = {
    live: true,
    url: 'https://rpc.testnet.lukso.network',
    chainId: 4201,
    saveDeployments: true,
  };

  if (process.env.CONTRACT_VERIFICATION_TESTNET_PK !== undefined) {
    config['accounts'] = [process.env.CONTRACT_VERIFICATION_TESTNET_PK];
  }

  return config;
}

const config: HardhatUserConfig = {
  defaultNetwork: 'hardhat',
  networks: {
    hardhat: {
      live: false,
      saveDeployments: true,
      allowBlocksWithSameTimestamp: true,
    },
    luksoTestnet: getTestnetChainConfig(),
  },
  namedAccounts: {
    owner: 0,
  },
  deterministicDeployment: {
    luksoTestnet: {
      // Nick Factory. See https://github.com/Arachnid/deterministic-deployment-proxy
      factory: '0x4e59b44847b379578588920ca78fbf26c0b4956c',
      deployer: '0x3fab184622dc19b6109349b94811493bf2a45362',
      funding: '0x0000000000000000000000000000000000000000000000000000000000000000',
      signedTx:
        '0xf8a58085174876e800830186a08080b853604580600e600039806000f350fe7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe03601600081602082378035828234f58015156039578182fd5b8082525050506014600cf31ba02222222222222222222222222222222222222222222222222222222222222222a02222222222222222222222222222222222222222222222222222222222222222',
    },
  },
  etherscan: {
    apiKey: 'no-api-key-needed',
    customChains: [
      {
        network: 'luksoTestnet',
        chainId: 4201,
        urls: {
          apiURL: 'https://api.explorer.execution.testnet.lukso.network/api',
          browserURL: 'https://explorer.execution.testnet.lukso.network/',
        },
      },
    ],
  },
  gasReporter: {
    enabled: true,
    currency: 'USD',
    gasPrice: 21,
    excludeContracts: ['Helpers/'],
    src: './contracts',
    showMethodSig: true,
  },
  solidity: {
    version: '0.8.17',
    settings: {
      optimizer: {
        enabled: true,
        /**
         * Optimize for how many times you intend to run the code.
         * Lower values will optimize more for initial deployment cost, higher
         * values will optimize more for high-frequency usage.
         * @see https://docs.soliditylang.org/en/v0.8.6/internals/optimizer.html#opcode-based-optimizer-module
         */
        runs: 1000,
      },
      outputSelection: {
        '*': {
          '*': ['storageLayout'],
        },
      },
    },
  },
  mocha: {
    timeout: 10000000,
  },
  packager: {
    // What contracts to keep the artifacts and the bindings for.
    contracts: [
      // Standard version
      // ------------------
      'UniversalProfile',
      'LSP0ERC725Account',
      'LSP1UniversalReceiverDelegateUP',
      'LSP1UniversalReceiverDelegateVault',
      'LSP4DigitalAssetMetadata',
      'LSP6KeyManager',
      'LSP7DigitalAsset',
      'LSP7CappedSupply',
      'LSP7Mintable',
      'LSP8IdentifiableDigitalAsset',
      'LSP8CappedSupply',
      'LSP8Mintable',
      'LSP9Vault',
      'LSP11BasicSocialRecovery',
      // Proxy version
      // ------------------
      'UniversalProfileInit',
      'LSP0ERC725AccountInit',
      'LSP4DigitalAssetMetadataInitAbstract',
      'LSP6KeyManagerInit',
      'LSP7DigitalAssetInitAbstract',
      'LSP7CappedSupplyInitAbstract',
      'LSP7MintableInit',
      'LSP8IdentifiableDigitalAssetInitAbstract',
      'LSP8CappedSupplyInitAbstract',
      'LSP8MintableInit',
      'LSP9VaultInit',
      'LSP11BasicSocialRecoveryInit',
      // ERC Compatible tokens
      // ------------------
      'LSP7CompatibleERC20',
      'LSP7CompatibleERC20InitAbstract',
      'LSP7CompatibleERC20Mintable',
      'LSP7CompatibleERC20MintableInit',
      'LSP8CompatibleERC721',
      'LSP8CompatibleERC721InitAbstract',
      'LSP8CompatibleERC721Mintable',
      'LSP8CompatibleERC721MintableInit',
      // Legacy L14
      // ------------------
      'UniversalReceiverAddressStore',
      // Tools
      // ------------------
      'Create2Factory',
      'LSP16UniversalFactory',
      'LSP23LinkedContractsFactory',
    ],
    // Whether to include the TypeChain factories or not.
    // If this is enabled, you need to run the TypeChain files through the TypeScript compiler before shipping to the registry.
    includeFactories: true,
  },
  paths: {
    artifacts: 'artifacts',
    tests: 'tests',
  },
  typechain: {
    outDir: 'types',
    target: 'ethers-v5',
  },
  dodoc: dodocConfig,
};

export default config;