From ea21b2adb295feb096b7b287c0786e6062d8781c Mon Sep 17 00:00:00 2001 From: dave | d1onys1us <13951458+d1onys1us@users.noreply.github.com> Date: Tue, 3 Jan 2023 09:51:01 -0500 Subject: [PATCH] chore(docs): remove private vars from handlebars template --- packages/protocol/package.json | 2 +- .../solidity-docgen/templates/common.hbs | 5 ++-- .../docs/smart-contracts/L1/TaikoL1.md | 6 ---- .../docs/smart-contracts/L1/TkoToken.md | 6 ---- .../docs/smart-contracts/L2/TaikoL2.md | 30 ------------------- .../docs/smart-contracts/bridge/Bridge.md | 12 -------- .../smart-contracts/bridge/BridgedERC20.md | 6 ---- .../docs/smart-contracts/bridge/EtherVault.md | 12 -------- .../docs/smart-contracts/bridge/TokenVault.md | 18 ----------- .../smart-contracts/common/AddressResolver.md | 12 -------- .../smart-contracts/common/ConfigManager.md | 6 ---- pnpm-lock.yaml | 8 ++--- 12 files changed, 8 insertions(+), 115 deletions(-) diff --git a/packages/protocol/package.json b/packages/protocol/package.json index b9cb3133c5..37f4062471 100644 --- a/packages/protocol/package.json +++ b/packages/protocol/package.json @@ -71,7 +71,7 @@ "rlp": "^3.0.0", "solhint": "^3.3.7", "solidity-coverage": "^0.8.2", - "solidity-docgen": "^0.6.0-beta.29", + "solidity-docgen": "^0.6.0-beta.34", "ts-node": "^10.5.0", "typechain": "^5.2.0", "typescript": "^4.5.5" diff --git a/packages/protocol/solidity-docgen/templates/common.hbs b/packages/protocol/solidity-docgen/templates/common.hbs index b2a3b2a5a2..2a723215fe 100644 --- a/packages/protocol/solidity-docgen/templates/common.hbs +++ b/packages/protocol/solidity-docgen/templates/common.hbs @@ -9,7 +9,9 @@ {{{natspec.notice}}} {{#if natspec.dev}} +{{#unless (eq visibility "internal")}} _{{{natspec.dev}}}_ +{{/unless}} {{/if}} {{#if natspec.params}} @@ -30,5 +32,4 @@ _{{{natspec.dev}}}_ {{#each returns}} | {{#if name}}{{name}}{{else}}[{{@index}}]{{/if}} | {{type}} | {{{joinLines natspec}}} | {{/each}} -{{/if}} - +{{/if}} \ No newline at end of file diff --git a/packages/website/docs/smart-contracts/L1/TaikoL1.md b/packages/website/docs/smart-contracts/L1/TaikoL1.md index 34624912bb..a351c69e3f 100644 --- a/packages/website/docs/smart-contracts/L1/TaikoL1.md +++ b/packages/website/docs/smart-contracts/L1/TaikoL1.md @@ -12,12 +12,6 @@ struct LibData.State state struct LibData.TentativeState tentative ``` -### \_\_gap - -```solidity -uint256[50] __gap -``` - ### init ```solidity diff --git a/packages/website/docs/smart-contracts/L1/TkoToken.md b/packages/website/docs/smart-contracts/L1/TkoToken.md index d71fc1fb00..7909d2887f 100644 --- a/packages/website/docs/smart-contracts/L1/TkoToken.md +++ b/packages/website/docs/smart-contracts/L1/TkoToken.md @@ -2,12 +2,6 @@ _This is Taiko's governance and fee token._ -### \_\_gap - -```solidity -uint256[50] __gap -``` - ### Mint ```solidity diff --git a/packages/website/docs/smart-contracts/L2/TaikoL2.md b/packages/website/docs/smart-contracts/L2/TaikoL2.md index bf7ed0351e..a25186c80b 100644 --- a/packages/website/docs/smart-contracts/L2/TaikoL2.md +++ b/packages/website/docs/smart-contracts/L2/TaikoL2.md @@ -1,17 +1,5 @@ ## TaikoL2 -### l2Hashes - -```solidity -mapping(uint256 => bytes32) l2Hashes -``` - -### l1Hashes - -```solidity -mapping(uint256 => bytes32) l1Hashes -``` - ### publicInputHash ```solidity @@ -24,12 +12,6 @@ bytes32 publicInputHash bytes32 latestSyncedHeader ``` -### \_\_gap - -```solidity -uint256[46] __gap -``` - ### BlockInvalidated ```solidity @@ -101,15 +83,3 @@ function getBlockHash(uint256 number) public view returns (bytes32) ```solidity function getConstants() public pure returns (uint256, uint256, uint256, uint256, uint256, uint256, uint256, uint256, uint256, uint256, uint256) ``` - -### \_checkPublicInputs - -```solidity -function _checkPublicInputs() private -``` - -### \_hashPublicInputs - -```solidity -function _hashPublicInputs(uint256 chainId, uint256 number, uint256 baseFee, bytes32[255] ancestors) private pure returns (bytes32) -``` diff --git a/packages/website/docs/smart-contracts/bridge/Bridge.md b/packages/website/docs/smart-contracts/bridge/Bridge.md index e463d1da05..448f41941f 100644 --- a/packages/website/docs/smart-contracts/bridge/Bridge.md +++ b/packages/website/docs/smart-contracts/bridge/Bridge.md @@ -5,18 +5,6 @@ which calls the library implementations. See {IBridge} for more details. _The code hash for the same address on L1 and L2 may be different._ -### state - -```solidity -struct LibBridgeData.State state -``` - -### \_\_gap - -```solidity -uint256[50] __gap -``` - ### MessageStatusChanged ```solidity diff --git a/packages/website/docs/smart-contracts/bridge/BridgedERC20.md b/packages/website/docs/smart-contracts/bridge/BridgedERC20.md index c5d8c9767d..9c16648f21 100644 --- a/packages/website/docs/smart-contracts/bridge/BridgedERC20.md +++ b/packages/website/docs/smart-contracts/bridge/BridgedERC20.md @@ -12,12 +12,6 @@ address srcToken uint256 srcChainId ``` -### \_\_gap - -```solidity -uint256[48] __gap -``` - ### BridgeMint ```solidity diff --git a/packages/website/docs/smart-contracts/bridge/EtherVault.md b/packages/website/docs/smart-contracts/bridge/EtherVault.md index b6696ec779..d362415710 100644 --- a/packages/website/docs/smart-contracts/bridge/EtherVault.md +++ b/packages/website/docs/smart-contracts/bridge/EtherVault.md @@ -2,18 +2,6 @@ Vault that holds Ether. -### authorizedAddrs - -```solidity -mapping(address => bool) authorizedAddrs -``` - -### \_\_gap - -```solidity -uint256[49] __gap -``` - ### Authorized ```solidity diff --git a/packages/website/docs/smart-contracts/bridge/TokenVault.md b/packages/website/docs/smart-contracts/bridge/TokenVault.md index 932372872c..0fd52b8772 100644 --- a/packages/website/docs/smart-contracts/bridge/TokenVault.md +++ b/packages/website/docs/smart-contracts/bridge/TokenVault.md @@ -34,12 +34,6 @@ mapping(address => struct TokenVault.CanonicalERC20) bridgedToCanonical mapping(uint256 => mapping(address => address)) canonicalToBridged ``` -### \_\_gap - -```solidity -uint256[47] __gap -``` - ### BridgedERC20Deployed ```solidity @@ -139,15 +133,3 @@ invoking a message call._ | from | address | The source address. | | to | address | The destination address. | | amount | uint256 | The amount of tokens to be sent. 0 is a valid value. | - -### \_getOrDeployBridgedToken - -```solidity -function _getOrDeployBridgedToken(struct TokenVault.CanonicalERC20 canonicalToken) private returns (address) -``` - -### \_deployBridgedToken - -```solidity -function _deployBridgedToken(struct TokenVault.CanonicalERC20 canonicalToken) private returns (address bridgedToken) -``` diff --git a/packages/website/docs/smart-contracts/common/AddressResolver.md b/packages/website/docs/smart-contracts/common/AddressResolver.md index 1d84900aa8..e6e81c7cc7 100644 --- a/packages/website/docs/smart-contracts/common/AddressResolver.md +++ b/packages/website/docs/smart-contracts/common/AddressResolver.md @@ -9,12 +9,6 @@ it uses an AddressManager to manage the name-to-address mapping. contract IAddressManager _addressManager ``` -### \_\_gap - -```solidity -uint256[49] __gap -``` - ### onlyFromNamed ```solidity @@ -91,9 +85,3 @@ Returns the AddressManager's address. ```solidity function _init(address addressManager_) internal virtual ``` - -### \_resolve - -```solidity -function _resolve(uint256 chainId, string name) private view returns (address payable) -``` diff --git a/packages/website/docs/smart-contracts/common/ConfigManager.md b/packages/website/docs/smart-contracts/common/ConfigManager.md index da0a49d19d..4c3d2ddb17 100644 --- a/packages/website/docs/smart-contracts/common/ConfigManager.md +++ b/packages/website/docs/smart-contracts/common/ConfigManager.md @@ -1,11 +1,5 @@ ## ConfigManager -### kv - -```solidity -mapping(bytes32 => bytes) kv -``` - ### Updated ```solidity diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index e56ae85a5f..a1044844ed 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -157,7 +157,7 @@ importers: rlp: ^3.0.0 solhint: ^3.3.7 solidity-coverage: ^0.8.2 - solidity-docgen: ^0.6.0-beta.29 + solidity-docgen: ^0.6.0-beta.34 ts-node: ^10.5.0 typechain: ^5.2.0 typescript: ^4.5.5 @@ -203,7 +203,7 @@ importers: rlp: 3.0.0 solhint: 3.3.7 solidity-coverage: 0.8.2_hardhat@2.12.2 - solidity-docgen: 0.6.0-beta.30_hardhat@2.12.2 + solidity-docgen: 0.6.0-beta.34_hardhat@2.12.2 ts-node: 10.9.1_vw4thnff6td543szquzqpxymti typechain: 5.2.0_typescript@4.9.3 typescript: 4.9.3 @@ -18185,8 +18185,8 @@ packages: - supports-color dev: true - /solidity-docgen/0.6.0-beta.30_hardhat@2.12.2: - resolution: {integrity: sha512-CfwhhM/hQIWm0LHyUIJse4Lz4kR+VahBfns5Z0l7l+2V3Emv8LNIG8a6aM1+r0k49iOVfO1xyFaJyXFS1UD8cA==} + /solidity-docgen/0.6.0-beta.34_hardhat@2.12.2: + resolution: {integrity: sha512-igdGrkg8gT1jn+B2NwzjEtSf+7NTrSi/jz88zO7MZWgETmcWbXaxgAsQP4BQeC4YFeH0Pie1NsLP7+9qDgvFtA==} peerDependencies: hardhat: ^2.8.0 dependencies: