Skip to content

Commit

Permalink
Update hardhat-setup README
Browse files Browse the repository at this point in the history
  • Loading branch information
zZoMROT committed Dec 9, 2024
1 parent 2d0a4a8 commit f9426ba
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion hardhat-setup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This class is your go-to assistant for setting up various blockchain networks fo

## Methods:

1. **`constructor(useHardhat: boolean, forkingNetworkName?: string, saveHardhatDeployments: boolean)`**: Initializes the class. It can set up a Hardhat network, including Hardhad forking, and determines whether to save deployments files.
1. **`constructor(useHardhat: boolean, forkingNetworkName?: string, saveHardhatDeployments: boolean, forkingAccounts?: HardhatNetworkAccountsUserConfig)`**: Initializes the class. It can set up a Hardhat network, including Hardhad forking, and determines whether to save deployments files.

**Constructor Parameters**

Expand All @@ -24,6 +24,10 @@ This class is your go-to assistant for setting up various blockchain networks fo

Decides whether to save deployment files in the Hardhat environment. If `true`, saves deployment details such as contract addresses in json file, useful for tracking and referencing in subsequent testing or deployments.

- **`forkingAccounts`** (optional):

Specifies the configuration for accounts used during Hardhat network forking. If provided, it allows customization of private keys, balances, and other account properties for the forked network simulation. If omitted, default accounts will be used.

2. **`register(...)`**: Registers a new network with specified parameters, such as the RPC URL, private key, and Etherscan keys.

3. **`registerCustom(...)`**: Allows registering custom networks with custom parameters for Etherscan contract verifications.
Expand Down

0 comments on commit f9426ba

Please sign in to comment.