Merge pull request #143 from 1inch/feature/fix-docgen-warnings

[SC-1121] Patch documents generation

README.md

@@ -19,7 +19,7 @@ This repository is a comprehensive toolkit designed to streamline and optimize t
 
 - **[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.
 
-- **[Solidity Contracts and Libraries](https://github.com/1inch/solidity-utils/blob/master/docs/contracts/SUMMARY.md)**: Frequently used smart contracts, libraries, and interfaces aimed at providing reusable code for common use cases, alongside optimizations to improve contract efficiency.
+- **[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.
 
 ## Contributing
 

docgen/templates.ts

@@ -7,4 +7,4 @@ import path from 'path';
  */
 export function oneInchTemplates(): string {
     return path.normalize(path.join(__dirname, '../../docgen/templates'));
-}
+}

docs/README.md

@@ -0,0 +1 @@
+# docs

docs/SUMMARY.md

@@ -0,0 +1,44 @@
+# Table of contents
+
+* [Main Readme](README.md)
+* [contracts](contracts/README.md)
+	* [interfaces](contracts/interfaces/README.md)
+		* [ICreate3Deployer](contracts/interfaces/ICreate3Deployer.md)
+		* [IDaiLikePermit](contracts/interfaces/IDaiLikePermit.md)
+		* [IERC20MetadataUppercase](contracts/interfaces/IERC20MetadataUppercase.md)
+		* [IERC7597Permit](contracts/interfaces/IERC7597Permit.md)
+		* [IPermit2](contracts/interfaces/IPermit2.md)
+		* [IWETH](contracts/interfaces/IWETH.md)
+	* [libraries](contracts/libraries/README.md)
+		* [AddressArray](contracts/libraries/AddressArray.md)
+		* [AddressLib](contracts/libraries/AddressLib.md)
+		* [AddressSet](contracts/libraries/AddressSet.md)
+		* [BySigTraits](contracts/libraries/BySigTraits.md)
+		* [BytesMemory](contracts/libraries/BytesMemory.md)
+		* [BytesStorage](contracts/libraries/BytesStorage.md)
+		* [ECDSA](contracts/libraries/ECDSA.md)
+		* [RevertReasonForwarder](contracts/libraries/RevertReasonForwarder.md)
+		* [RevertReasonParser](contracts/libraries/RevertReasonParser.md)
+		* [SafeERC20](contracts/libraries/SafeERC20.md)
+		* [StringUtil](contracts/libraries/StringUtil.md)
+		* [UniERC20](contracts/libraries/UniERC20.md)
+	* [mixins](contracts/mixins/README.md)
+		* [BySig](contracts/mixins/BySig.md)
+		* [EthReceiver](contracts/mixins/EthReceiver.md)
+		* [OnlyWethReceiver](contracts/mixins/OnlyWethReceiver.md)
+		* [PermitAndCall](contracts/mixins/PermitAndCall.md)
+		* [SelfdestructEthSender](contracts/mixins/SelfdestructEthSender.md)
+	* [mocks](contracts/mocks/README.md)
+		* [ERC20PermitMock](contracts/mocks/ERC20PermitMock.md)
+		* [SelfdestructEthSenderMock](contracts/mocks/SelfdestructEthSenderMock.md)
+		* [TokenCustomDecimalsMock](contracts/mocks/TokenCustomDecimalsMock.md)
+		* [TokenMock](contracts/mocks/TokenMock.md)
+* [js](js/README.md)
+	* [classes](js/classes/README.md)
+		* [hardhat_setup.Networks](js/classes/hardhat_setup.Networks.md)
+	* [interfaces](js/interfaces/README.md)
+		* [src.DeployContractOptions](js/interfaces/src.DeployContractOptions.md)
+	* [modules](js/modules/README.md)
+		* [hardhat_setup](js/modules/hardhat_setup.md)
+		* [src](js/modules/src.md)
+	* [modules](js/modules.md)

docs/contracts/mocks/README.md

@@ -0,0 +1 @@
+# mocks

docs/js/classes/hardhat_setup.Networks.md

@@ -47,17 +47,17 @@ See the [README](https://github.com/1inch/solidity-utils/tree/master/hardhat-set
 
 #### Defined in
 
-[hardhat-setup/networks.ts:67](https://github.com/1inch/solidity-utils/blob/5a4227e/hardhat-setup/networks.ts#L67)
+[hardhat-setup/networks.ts:75](https://github.com/1inch/solidity-utils/blob/cdb7d95/hardhat-setup/networks.ts#L75)
 
 ## Properties
 
 ### etherscan
 
-• **etherscan**: `Etherscan`
+• **etherscan**: [`Etherscan`](../modules/hardhat_setup.md#etherscan)
 
 #### Defined in
 
-[hardhat-setup/networks.ts:65](https://github.com/1inch/solidity-utils/blob/5a4227e/hardhat-setup/networks.ts#L65)
+[hardhat-setup/networks.ts:73](https://github.com/1inch/solidity-utils/blob/cdb7d95/hardhat-setup/networks.ts#L73)
 
 ___
 
@@ -67,7 +67,7 @@ ___
 
 #### Defined in
 
-[hardhat-setup/networks.ts:64](https://github.com/1inch/solidity-utils/blob/5a4227e/hardhat-setup/networks.ts#L64)
+[hardhat-setup/networks.ts:72](https://github.com/1inch/solidity-utils/blob/cdb7d95/hardhat-setup/networks.ts#L72)
 
 ## Methods
 
@@ -93,7 +93,7 @@ ___
 
 #### Defined in
 
-[hardhat-setup/networks.ts:88](https://github.com/1inch/solidity-utils/blob/5a4227e/hardhat-setup/networks.ts#L88)
+[hardhat-setup/networks.ts:96](https://github.com/1inch/solidity-utils/blob/cdb7d95/hardhat-setup/networks.ts#L96)
 
 ___
 
@@ -107,12 +107,12 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `etherscan` | `Etherscan` |
+| `etherscan` | [`Etherscan`](../modules/hardhat_setup.md#etherscan) |
 | `networks` | `NetworksUserConfig` |
 
 #### Defined in
 
-[hardhat-setup/networks.ts:131](https://github.com/1inch/solidity-utils/blob/5a4227e/hardhat-setup/networks.ts#L131)
+[hardhat-setup/networks.ts:139](https://github.com/1inch/solidity-utils/blob/cdb7d95/hardhat-setup/networks.ts#L139)
 
 ___
 
@@ -139,7 +139,7 @@ ___
 
 #### Defined in
 
-[hardhat-setup/networks.ts:105](https://github.com/1inch/solidity-utils/blob/5a4227e/hardhat-setup/networks.ts#L105)
+[hardhat-setup/networks.ts:113](https://github.com/1inch/solidity-utils/blob/cdb7d95/hardhat-setup/networks.ts#L113)
 
 ___
 
@@ -165,4 +165,4 @@ ___
 
 #### Defined in
 
-[hardhat-setup/networks.ts:112](https://github.com/1inch/solidity-utils/blob/5a4227e/hardhat-setup/networks.ts#L112)
+[hardhat-setup/networks.ts:120](https://github.com/1inch/solidity-utils/blob/cdb7d95/hardhat-setup/networks.ts#L120)

docs/js/interfaces/src.DeployContractOptions.md

@@ -0,0 +1,200 @@
+[@1inch/solidity-utils](../README.md) / [Modules](../modules.md) / [src](../modules/src.md) / DeployContractOptions
+
+# Interface: DeployContractOptions
+
+[src](../modules/src.md).DeployContractOptions
+
+**`Notice`**
+
+Options for deployment methods.
+
+**`Param`**
+
+Name of the contract to deploy.
+
+**`Param`**
+
+Arguments for the contract's constructor.
+
+**`Param`**
+
+Deployment facilitator object from Hardhat.
+
+**`Param`**
+
+Wallet deploying the contract.
+
+**`Param`**
+
+Optional custom name for deployment.
+
+**`Param`**
+
+Skips Etherscan verification if true.
+
+**`Param`**
+
+Avoids redeployment if contract already deployed.
+
+**`Param`**
+
+Gas strategy option.
+
+**`Param`**
+
+Gas strategy option.
+
+**`Param`**
+
+Gas strategy option.
+
+**`Param`**
+
+Toggles deployment logging.
+
+**`Param`**
+
+Number of confirmations to wait based on network. Ussually it's need for waiting before Etherscan verification.
+
+## Table of contents
+
+### Properties
+
+- [constructorArgs](src.DeployContractOptions.md#constructorargs)
+- [contractName](src.DeployContractOptions.md#contractname)
+- [deployer](src.DeployContractOptions.md#deployer)
+- [deploymentName](src.DeployContractOptions.md#deploymentname)
+- [deployments](src.DeployContractOptions.md#deployments)
+- [gasPrice](src.DeployContractOptions.md#gasprice)
+- [log](src.DeployContractOptions.md#log)
+- [maxFeePerGas](src.DeployContractOptions.md#maxfeepergas)
+- [maxPriorityFeePerGas](src.DeployContractOptions.md#maxpriorityfeepergas)
+- [skipIfAlreadyDeployed](src.DeployContractOptions.md#skipifalreadydeployed)
+- [skipVerify](src.DeployContractOptions.md#skipverify)
+- [waitConfirmations](src.DeployContractOptions.md#waitconfirmations)
+
+## Properties
+
+### constructorArgs
+
+• `Optional` **constructorArgs**: `any`[]
+
+#### Defined in
+
+[src/utils.ts:29](https://github.com/1inch/solidity-utils/blob/cdb7d95/src/utils.ts#L29)
+
+___
+
+### contractName
+
+• **contractName**: `string`
+
+#### Defined in
+
+[src/utils.ts:27](https://github.com/1inch/solidity-utils/blob/cdb7d95/src/utils.ts#L27)
+
+___
+
+### deployer
+
+• **deployer**: `string`
+
+#### Defined in
+
+[src/utils.ts:31](https://github.com/1inch/solidity-utils/blob/cdb7d95/src/utils.ts#L31)
+
+___
+
+### deploymentName
+
+• `Optional` **deploymentName**: `string`
+
+#### Defined in
+
+[src/utils.ts:32](https://github.com/1inch/solidity-utils/blob/cdb7d95/src/utils.ts#L32)
+
+___
+
+### deployments
+
+• **deployments**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `deploy` | (`name`: `string`, `options`: `DeployOptions`) => `Promise`\<`DeployResult`\> |
+
+#### Defined in
+
+[src/utils.ts:30](https://github.com/1inch/solidity-utils/blob/cdb7d95/src/utils.ts#L30)
+
+___
+
+### gasPrice
+
+• `Optional` **gasPrice**: `bigint`
+
+#### Defined in
+
+[src/utils.ts:35](https://github.com/1inch/solidity-utils/blob/cdb7d95/src/utils.ts#L35)
+
+___
+
+### log
+
+• `Optional` **log**: `boolean`
+
+#### Defined in
+
+[src/utils.ts:38](https://github.com/1inch/solidity-utils/blob/cdb7d95/src/utils.ts#L38)
+
+___
+
+### maxFeePerGas
+
+• `Optional` **maxFeePerGas**: `bigint`
+
+#### Defined in
+
+[src/utils.ts:37](https://github.com/1inch/solidity-utils/blob/cdb7d95/src/utils.ts#L37)
+
+___
+
+### maxPriorityFeePerGas
+
+• `Optional` **maxPriorityFeePerGas**: `bigint`
+
+#### Defined in
+
+[src/utils.ts:36](https://github.com/1inch/solidity-utils/blob/cdb7d95/src/utils.ts#L36)
+
+___
+
+### skipIfAlreadyDeployed
+
+• `Optional` **skipIfAlreadyDeployed**: `boolean`
+
+#### Defined in
+
+[src/utils.ts:34](https://github.com/1inch/solidity-utils/blob/cdb7d95/src/utils.ts#L34)
+
+___
+
+### skipVerify
+
+• `Optional` **skipVerify**: `boolean`
+
+#### Defined in
+
+[src/utils.ts:33](https://github.com/1inch/solidity-utils/blob/cdb7d95/src/utils.ts#L33)
+
+___
+
+### waitConfirmations
+
+• `Optional` **waitConfirmations**: `number`
+
+#### Defined in
+
+[src/utils.ts:39](https://github.com/1inch/solidity-utils/blob/cdb7d95/src/utils.ts#L39)