Skip to content

Commit b0c7c19

Browse files
authored
Merge pull request 1inch#165 from 1inch/feature/update-docs
[SC-1339] Update docs
2 parents 12a1fee + c5e20d6 commit b0c7c19

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+2507
-1795
lines changed

docs/js/README.md

Lines changed: 6 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,10 @@
1-
@1inch/solidity-utils / [Modules](modules.md)
1+
**@1inch/solidity-utils****Docs**
22

3-
<div align="center">
4-
<img src="https://github.com/1inch/solidity-utils/blob/master/.github/1inch_github_w.svg#gh-light-mode-only">
5-
<img src="https://github.com/1inch/solidity-utils/blob/master/.github/1inch_github_b.svg#gh-dark-mode-only">
6-
</div>
3+
***
74

8-
# Utility Library for Smart Contracts and Testing
5+
# @1inch/solidity-utils
96

10-
[![Build Status](https://github.com/1inch/solidity-utils/workflows/CI/badge.svg)](https://github.com/1inch/solidity-utils/actions)
11-
[![Coverage Status](https://codecov.io/gh/1inch/solidity-utils/branch/master/graph/badge.svg?token=HJWBIVXQQA)](https://codecov.io/gh/1inch/solidity-utils)
12-
[![NPM Package](https://img.shields.io/npm/v/@1inch/solidity-utils.svg)](https://www.npmjs.org/package/@1inch/solidity-utils)
7+
## Modules
138

14-
This repository is a comprehensive toolkit designed to streamline and optimize the development, tests and management of smart contracts. This repository serves as a one-stop resource for developers working on Ethereum and EVM-compatible blockchain projects, offering a blend of Solidity contracts with various utilities and optimizations, alongside JavaScript tools for testing, documentation, and project management.
15-
16-
## Features
17-
18-
- **[Development and Testing](https://github.com/1inch/solidity-utils/blob/master/docs/js/modules/src.md)**: The tools and utilities provided in this section are designed to aid in the development and testing of smart contracts. They help avoid the duplication of helper methods across different repositories by centralizing commonly used functions and scripts. This not only streamlines the development process but also ensures that the latest versions of these helpers are readily available and consistently used throughout your projects. Leveraging these utilities can significantly enhance efficiency and maintainability of your smart contract code.
19-
20-
- **[Documentation and Utilities](https://github.com/1inch/solidity-utils/blob/master/utils/README.md)**: A suite of functionalities for generating documentation and additional utilities to enhance development workflow.
21-
22-
- **[Configuration and Management](https://github.com/1inch/solidity-utils/blob/master/docs/js/modules/hardhat_setup.md)**: Tools for setting up Hardhat network configurations and managing project settings efficiently.
23-
24-
- **[Solidity Contracts and Libraries](https://github.com/1inch/solidity-utils/blob/master/docs/SUMMARY.md)**: Frequently used smart contracts, libraries, and interfaces aimed at providing reusable code for common use cases, alongside optimizations to improve contract efficiency.
25-
26-
## Contributing
27-
28-
Contributions are welcome! If you have a suggestion that would make this repository better, or if you have any questions, please feel free to fork the repo and create a pull request. You can also simply open an issue with your suggestion or question.
9+
- [hardhat-setup](hardhat-setup/README.md)
10+
- [src](src/README.md)

docs/js/classes/hardhat_setup.Networks.md

Lines changed: 0 additions & 168 deletions
This file was deleted.

docs/js/enums/src.NonceType.md

Lines changed: 0 additions & 45 deletions
This file was deleted.

docs/js/hardhat-setup/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
[**@1inch/solidity-utils**](../README.md)**Docs**
2+
3+
***
4+
5+
[@1inch/solidity-utils](../README.md) / hardhat-setup
6+
7+
# hardhat-setup
8+
9+
## Index
10+
11+
### Hardhat-Setup
12+
A helper method to get the network name from the command line arguments.
13+
14+
- [getNetwork](functions/getNetwork.md)
15+
16+
### Hardhat-Setup
17+
A helper method to parse RPC configuration strings. Checks that the string is in the expected format.
18+
19+
- [parseRpcEnv](functions/parseRpcEnv.md)
20+
21+
### Hardhat-Setup
22+
A helper method to reset the Hardhat network to the local network or to a fork.
23+
24+
- [resetHardhatNetworkFork](functions/resetHardhatNetworkFork.md)
25+
26+
### Hardhat-Setup
27+
Configuration type for managing Etherscan integration in Hardhat setups.
28+
29+
- [Etherscan](type-aliases/Etherscan.md)
30+
31+
### Hardhat-Setup
32+
The Network class is a helper class to register networks and Etherscan API keys.
33+
See the [README](https://github.com/1inch/solidity-utils/tree/master/hardhat-setup/README.md) for usage.
34+
35+
- [Networks](classes/Networks.md)

0 commit comments

Comments
 (0)