Skip to content

Commit 4c78547

Browse files
authored
[N-01]: Fix missing and misleading documentation (#973)
1 parent f6f8807 commit 4c78547

File tree

3 files changed

+5
-2
lines changed

3 files changed

+5
-2
lines changed

contracts/ZkSync_SpokePool.sol

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ contract ZkSync_SpokePool is SpokePool, CircleCCTPAdapter {
4646

4747
/**
4848
* @notice Constructor.
49+
* @notice Circle bridged & native USDC are optionally supported via configuration, but are mutually exclusive.
4950
* @param _wrappedNativeTokenAddress wrappedNativeToken address for this network to set.
5051
* @param _circleUSDC Circle USDC address on the SpokePool. Set to 0x0 to use the standard ERC20 bridge instead.
5152
* If not set to zero, then either the zkUSDCBridge or cctpTokenMessenger must be set and will be used to

contracts/chain-adapters/ZkStack_Adapter.sol

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ contract ZkStack_Adapter is AdapterInterface, CircleCCTPAdapter {
6666

6767
/**
6868
* @notice Constructs new Adapter.
69+
* @notice Circle bridged & native USDC are optionally supported via configuration, but are mutually exclusive.
6970
* @param _chainId The target ZkStack network's chain ID.
7071
* @param _bridgeHub The bridge hub contract address for the ZkStack network.
7172
* @param _circleUSDC Circle USDC address on L1. If not set to address(0), then either the USDCSharedBridge
@@ -200,7 +201,7 @@ contract ZkStack_Adapter is AdapterInterface, CircleCCTPAdapter {
200201
);
201202
}
202203
} else {
203-
// An ERC20 that is not WETH.
204+
// An standard bridged ERC20, separate from WETH and Circle Bridged/Native USDC.
204205
address sharedBridge = BRIDGE_HUB.sharedBridge();
205206
IERC20(l1Token).forceApprove(sharedBridge, amount);
206207
txHash = BRIDGE_HUB.requestL2TransactionTwoBridges{ value: txBaseCost }(

contracts/chain-adapters/ZkStack_CustomGasToken_Adapter.sol

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ contract ZkStack_CustomGasToken_Adapter is AdapterInterface, CircleCCTPAdapter {
8686

8787
/**
8888
* @notice Constructs new Adapter.
89+
* @notice Circle bridged & native USDC are optionally supported via configuration, but are mutually exclusive.
8990
* @param _chainId The target ZkStack network's chain ID.
9091
* @param _bridgeHub The bridge hub contract address for the ZkStack network.
9192
* @param _circleUSDC Circle USDC address on L1. If not set to address(0), then either the USDCSharedBridge
@@ -244,7 +245,7 @@ contract ZkStack_CustomGasToken_Adapter is AdapterInterface, CircleCCTPAdapter {
244245
);
245246
}
246247
} else {
247-
// An ERC20 that is not WETH and not the custom gas token.
248+
// An standard bridged ERC20, separate from WETH and Circle Bridged/Native USDC.
248249
IERC20(CUSTOM_GAS_TOKEN).forceApprove(sharedBridge, txBaseCost);
249250
IERC20(l1Token).forceApprove(sharedBridge, amount);
250251
txHash = BRIDGE_HUB.requestL2TransactionTwoBridges(

0 commit comments

Comments
 (0)