@tenderly/hardhat-integration

import "hardhat/types/config"; import "hardhat/types/runtime"; import { TenderlyContractUploadRequest, TenderlyForkContractUploadRequest, TenderlyVerifyContractsRequest } from "@tenderly/api-client/types"; import { ContractByName } from "./tenderly/types"; import { HardhatTenderlyConfig } from "./tenderly/types"; import { TenderlyNetwork } from "./TenderlyNetwork"; export interface TenderlyPlugin { /** * * @description * Verify contracts on tenderly platform. * There are three ways to verify contracts on tenderly: * <ul> * <li>Private verification - Set privateVerification flag in hardhat.config.ts as true and --network parameter must be anything but tenderly</li> * <li>Public verification - Set privateVerification flag in hardhat.config.ts as false and --network parameter must be anything but tenderly</li> * <li>Fork verification - The --network parameter must be set as tenderly</li> * </ul> * All of these verifications can happen implicitly without calling <code>tenderly.verify(...contracts)</code> method. This can be done by setting automaticVerifications flag to true in * <code>tdly.setup({ automaticVerifications: true })</code> * Note: Public and private verification can be multi compiler verifications. Unfortunately, at this point in time, there is no multi compiler version of fork verification. * @param contracts * Variadic list of all contracts to be verified in format <code>{ name: "ContractName", address: "0x1234...." }</code>. You do not have to put contract's dependencies here, we extract them from the /artifacts directory. * @example * tenderly.verify({ * name: "ContractName", * address: "0x1234567890abcdef1234567890abcdef12345678", * }, { * name: "AnotherContractName", * address: "0xabc4567890abcdef1234567890abcdef12345678", * }); */ verify: (...contracts: ContractByName[]) => Promise<void>; /** * * @description * Verify contracts on tenderly platform with a provided request. * This method only offers public and private verification. For verifying contracts on fork, look up verifyForkMultiCompilerAPI. * <ul> * <li>Private verification - Set privateVerification flag in hardhat.config.ts as true and --network parameter must be anything but tenderly</li> * <li>Public verification - Set privateVerification flag in hardhat.config.ts as false and --network parameter must be anything but tenderly</li> * <li>Fork verification - Not available</li> * </ul> * This method can be used for single or multi compiler verification. * Note: You are probably better off verifying via <code>tenderly.verify(...contracts)</code>. * If your contract has any dependencies, you must manually provide them their sources in the <code>sources</code> map inside a particular contract. * @param request * Request object that will be sent to the platform. * contractToVerify should have the name of the contract that you wish to verify. The name must belong to one of source names. * compiler complies with the structure of solidity compiler. * In order to provide a network id as a key in the networks you can import the NETWORK_NAME_CHAIN_ID_MAP map as: * <code>import { NETWORK_NAME_CHAIN_ID_MAP } from "@tenderly/api-client/common/constants";</code> * and then do * <code>NETWORK_NAME_CHAIN_ID_MAP["sepolia"]</code> * @example * tenderly.verifyMultiCompilerAPI({ * "contracts": [ * { * "contractToVerify": "contracts/interfaces/Token.sol:Token", * "sources": { * "path/to/contract": { * "name": "Token", * "code": "source code of the contract...", * }, * "path/to/another/contract": { * "name": "AnotherContract", * "code": "source code of the contract..." * } * }, * "compiler": { * "version": "0.8.17", * "settings": { * "optimizer": { * "enabled": true, * "runs": 200 * } * } * }, * "networks": { * 11155111: { * "address": "0x1234567890123456789012345678901234567890" * } * } * } * ] * }); */ verifyMultiCompilerAPI: (request: TenderlyVerifyContractsRequest) => Promise<void>; /** * * @description * Verify contracts on a tenderly fork with a provided request. * This method only offers fork verification. For verifying the contract privately or publicly, look up verifyMultiCompilerAPI. * <ul> * <li>Fork verification - Set privateVerification flag in hardhat.config.ts as false and --network parameter must be set to tenderly</li> * </ul> * This method can be used for single or multi compiler verification. * Note: You are probably better off verifying via <code>tenderly.verify(...contracts)</code>. * If your contract has any dependencies, you must manually provide them their sources in the <code>sources</code> map inside a particular contract. * @param request * Request object that will be sent to the platform. * contractToVerify should have the name of the contract that you wish to verify. The name must belong to one of source names. * compiler complies with the structure of solidity compiler. * In order to provide a network id as a key in the networks you can import the NETWORK_NAME_CHAIN_ID_MAP map as: * <code>import { NETWORK_NAME_CHAIN_ID_MAP } from "@tenderly/api-client/common/constants";</code> * and then do * <code>NETWORK_NAME_CHAIN_ID_MAP["sepolia"]</code> * @param tenderlyProject - Tenderly project name * @param username - Tenderly project username (or organization username) * @param forkID - Fork id on which verification is occurring * @example * tenderly.verifyForkMultiCompilerAPI({ * "contracts": [ * { * "contractToVerify": "contracts/interfaces/Token.sol:Token", * "sources": { * "path/to/contract": { * "name": "Token", * "code": "source code of the contract...", * }, * "path/to/another/contract": { * "name": "AnotherContract", * "code": "source code of the contract..." * } * }, * "compiler": { * "version": "0.8.17", * "settings": { * "optimizer": { * "enabled": true, * "runs": 200 * } * } * }, * "networks": { * 11155111: { * "address": "0x1234567890123456789012345678901234567890" * } * } * } * ] * }, * "your-project", "your-username", "your-fork-id" * ); */ verifyForkMultiCompilerAPI: (request: TenderlyVerifyContractsRequest, tenderlyProject: string, username: string, forkID: string) => Promise<void>; /** * * @description * Verify contracts on a tenderly devnet with a provided request. * This method only offers devnet verification. * <ul> * <li>Devnet verification - Set privateVerification flag in hardhat.config.ts as false and --network parameter must be set to tenderly</li> * </ul> * This method can be used for single or multi compiler verification. * Note: You are probably better off verifying via <code>tenderly.verify(...contracts)</code>. * If your contract has any dependencies, you must manually provide them their sources in the <code>sources</code> map inside a particular contract. * @param request * Request object that will be sent to the platform. * contractToVerify should have the name of the contract that you wish to verify. The name must belong to one of source names. * compiler complies with the structure of solidity compiler. * In order to provide a network id as a key in the networks you can import the NETWORK_NAME_CHAIN_ID_MAP map as: * <code>import { NETWORK_NAME_CHAIN_ID_MAP } from "@tenderly/api-client/common/constants";</code> * and then do * <code>NETWORK_NAME_CHAIN_ID_MAP["sepolia"]</code> * @param tenderlyProject - Tenderly project name * @param username - Tenderly project username (or organization username) * @param devnetID - Devnet id on which verification is occurring * @example * tenderly.verifyDevnetMultiCompilerAPI({ * "contracts": [ * { * "contractToVerify": "contracts/interfaces/Token.sol:Token", * "sources": { * "path/to/contract": { * "name": "Token", * "code": "source code of the contract...", * }, * "path/to/another/contract": { * "name": "AnotherContract", * "code": "source code of the contract..." * } * }, * "compiler": { * "version": "0.8.17", * "settings": { * "optimizer": { * "enabled": true, * "runs": 200 * } * } * }, * "networks": { * 11155111: { * "address": "0x1234567890123456789012345678901234567890" * } * } * } * ] * }, * "your-project", "your-username", "your-devnet-id" * ); */ verifyDevnetMultiCompilerAPI(request: TenderlyVerifyContractsRequest, tenderlyProject: string, username: string, devnetID: string): Promise<void>; /** * * @description * Verify contracts on tenderly platform with a provided request. * This method only offers public verification. For private and fork verification via API, see pushAPI and verifyForkAPI respectively. * Note: You are probably better off verifying via <code>tenderly.verify(...contracts)</code>. * If your contract has any dependencies, you must manually provide them as contracts in the <code>contracts</code> array. * Note: The networks object should be provided only to the contracts that you wish to verify. The rest of the contracts should only be there as dependencies needed for compilation. * Note: This method doesn't support multi compiler verification. You can check <code>tenderly.verifyMultiCompilerAPI(...)</code> for that. * @param request * Request object that will be sent to the platform. * In order to provide a network id as a key in the networks you can import the NETWORK_NAME_CHAIN_ID_MAP map as: * <code>import { NETWORK_NAME_CHAIN_ID_MAP } from "@tenderly/api-client/common/constants";</code> * and then do * <code>NETWORK_NAME_CHAIN_ID_MAP["sepolia"]</code> * @example * tenderly.verifyAPI({ * config: { * compiler_version: "0.8.17", * optimizations_used: true, * optimizations_count: 200, * evm_version: "default", * debug: { * revertStrings: "default" * } * }, * contracts: [ * { * contractName: "Token", * source: "source code of the Token contract that inherits Base...", * sourcePath: "contracts/Token.sol", * networks: { * 11155111: { * address: "0x5FbDB2315678afecb367f032d93F642f64180aa3", * } * } * }, { * contractName: "BaseToken", * source: "source code of the base token contract that Token inherits...", * sourcePath: "contracts/BaseToken.sol", * } * ] * }); */ verifyAPI: (request: TenderlyContractUploadRequest) => Promise<void>; /** * * @description * Verify deployed contracts on tenderly fork with a provided request. * This method only offers fork verification. For private and public verification via API, see pushAPI and verifyAPI respectively. * Note: You are probably better off verifying via <code>tenderly.verify(...contracts)</code>. * If your contract has any dependencies, you must manually provide them as contracts in the <code>contracts</code> array. * Note: The networks object should be provided only to the contracts that you wish to verify. The rest of the contracts should only be there as dependencies needed for compilation. * Note: Unfortunately, at this point in time, there is no multi compiler version of the fork verification. * @param request * Request object that will be sent to the platform. * In order to provide a network id as a key in the networks you can import the NETWORK_NAME_CHAIN_ID_MAP map as: * <code>import { NETWORK_NAME_CHAIN_ID_MAP } from "@tenderly/api-client/common/constants";</code> * and then do * <code>NETWORK_NAME_CHAIN_ID_MAP["sepolia"]</code> * Root parameter inside the request represents the transaction id from which the contract deployment will be searched. * This can be left undefined and the search will begin from the fork creation. * If you want to supply the root parameter, you can find the transaction id at the wanted simulation page as Transaction Id. * @param tenderlyProject - Tenderly project name * @param username - Tenderly project username (or organization username) * @param forkID - Fork id on which verification is occurring * @example * tenderly.verifyForkAPI({ * config: { * compiler_version: "0.8.17", * optimizations_used: true, * optimizations_count: 200, * evm_version: "default", * debug: { * revertStrings: "default" * } * }, * contracts: [ * { * contractName: "Token", * source: "source code of the contract...", * sourcePath: "contracts/Token.sol", * networks: { * 11155111: { * address: "0x5FbDB2315678afecb367f032d93F642f64180aa3", * } * } * }, { * contractName: "BaseToken", * source: "source code of the base token contract that Token inherits...", * sourcePath: "contracts/BaseToken.sol", * } * ], * root: "f57549dd-7eaf-4d8e-ac59-c3e0c0d18636", * }, "project", "tenderly", "cd70178b-6377-404a-879a-25dcb5d51684"); */ /** * * @description Verifying deployed contracts on fork via API. * @param request - raw contract verification request param */ verifyForkAPI: (request: TenderlyForkContractUploadRequest, tenderlyProject: string, username: string, forkID: string) => Promise<void>; /** * * @description Persisting contract deployment data needed for verification purposes using hre. * @param contracts - List of contract names and addresses.s */ persistArtifacts: (...contracts: ContractByName[]) => Promise<void>; /** * * @deprecated * @description * Verify contracts on tenderly platform with a provided request. * This method only offers private verification. For public and fork verification via API, see verifyAPI and verifyForkAPI respectively. * Note: You are probably better off verifying via <code>tenderly.verify(...contracts)</code>. * If your contract has any dependencies, you must manually provide them as contracts in the <code>contracts</code> array. * Note: The networks object should be provided only to the contracts that you wish to verify. The rest of the contracts should only be there as dependencies needed for compilation. * Note: This method doesn't support multi compiler verification. You can check <code>tenderly.verifyMultiCompilerAPI(...)</code> for that. * @param request * Request object that will be sent to the platform. * In order to provide a network id as a key in the networks you can import the network_name_to_id map as: * <code>import { NETWORK_NAME_CHAIN_ID_MAP } from "@tenderly/api-client/common/constants";</code> * and then do * <code>NETWORK_NAME_CHAIN_ID_MAP["rinkeby"]</code> * @param tenderlyProject - Tenderly project name * @param username - Tenderly project username (or organization username) * @example * tenderly.verifyAPI({ * config: { * compiler_version: "0.8.17", * optimizations_used: true, * optimizations_count: 200, * evm_version: "default", * debug: { * revertStrings: "default" * } * }, * contracts: [ * { * contractName: "Token", * source: "source code of the contract...", * sourcePath: "contracts/Token.sol", * networks: { * 5: { * address: "0x5FbDB2315678afecb367f032d93F642f64180aa3", * } * } * } * ] * }, "project", "tenderly"); */ pushAPI: (request: TenderlyContractUploadRequest, tenderlyProject: string, username: string) => Promise<void>; /** * * @deprecated * @description * Verify contracts on tenderly. This method relies on <code>tenderly.verify(...contracts)</code> in the background, so you can see that method. */ push: (...contracts: ContractByName[]) => Promise<void>; /** * * @deprecated */ network: () => TenderlyNetwork; /** * * @deprecated */ setNetwork: (network: TenderlyNetwork) => TenderlyNetwork; } declare module "hardhat/types/runtime" { interface HardhatRuntimeEnvironment { tenderly: TenderlyPlugin; tenderlyNetwork: { send: (request: { method: string; params?: any[]; }, callback: (error: any, response: any) => void) => void; verify: (...contracts: any[]) => Promise<void>; verifyAPI: (request: TenderlyForkContractUploadRequest, tenderlyProject: string, username: string, forkID: string) => Promise<void>; resetFork: () => string | undefined; getHead: () => string | undefined; setHead: (head: string | undefined) => void; getFork: () => Promise<string | undefined>; setFork: (fork: string | undefined) => void; initializeFork: () => Promise<void>; }; } } declare module "hardhat/types/config" { interface HardhatUserConfig { tenderly?: HardhatTenderlyConfig; } interface HardhatConfig { tenderly: HardhatTenderlyConfig; } } //# sourceMappingURL=type-extensions.d.ts.map