From d2657220a6be22a7c93afe628c05bb96bb79d4ce Mon Sep 17 00:00:00 2001 From: Matt Yang Date: Mon, 23 Oct 2023 12:02:59 -0400 Subject: [PATCH] update comments --- contracts/src/v0.8/ccip/ARM.sol | 2 +- contracts/src/v0.8/ccip/CommitStore.sol | 10 +++++----- contracts/src/v0.8/ccip/libraries/Client.sol | 2 +- contracts/src/v0.8/ccip/libraries/Internal.sol | 14 +++++++------- contracts/src/v0.8/ccip/offRamp/EVM2EVMOffRamp.sol | 6 +++--- contracts/src/v0.8/ccip/onRamp/EVM2EVMOnRamp.sol | 6 +++--- 6 files changed, 20 insertions(+), 20 deletions(-) diff --git a/contracts/src/v0.8/ccip/ARM.sol b/contracts/src/v0.8/ccip/ARM.sol index ecdb72781d..3d1964cc8d 100644 --- a/contracts/src/v0.8/ccip/ARM.sol +++ b/contracts/src/v0.8/ccip/ARM.sol @@ -6,7 +6,7 @@ import {IARM} from "./interfaces/IARM.sol"; import {OwnerIsCreator} from "./../shared/access/OwnerIsCreator.sol"; -/// @dev This contract is owned by RMN, if changing, please notify RMN. +/// @dev This contract is owned by RMN, if changing, please notify the RMN maintainers. contract ARM is IARM, OwnerIsCreator, ITypeAndVersion { // STATIC CONFIG // solhint-disable-next-line chainlink-solidity/all-caps-constant-storage-variables diff --git a/contracts/src/v0.8/ccip/CommitStore.sol b/contracts/src/v0.8/ccip/CommitStore.sol index 70106caa13..df546ceaa8 100644 --- a/contracts/src/v0.8/ccip/CommitStore.sol +++ b/contracts/src/v0.8/ccip/CommitStore.sol @@ -21,13 +21,13 @@ contract CommitStore is ICommitStore, ITypeAndVersion, OCR2Base { event Paused(address account); event Unpaused(address account); - /// @dev RMN depends on this event, if changing, please notify RMN. + /// @dev RMN depends on this event, if changing, please notify the RMN maintainers. event ReportAccepted(CommitReport report); event ConfigSet(StaticConfig staticConfig, DynamicConfig dynamicConfig); event RootRemoved(bytes32 root); /// @notice Static commit store config - /// @dev RMN depends on this struct, if changing, please notify RMN. + /// @dev RMN depends on this struct, if changing, please notify the RMN maintainers. struct StaticConfig { uint64 chainSelector; // ───────╮ Destination chainSelector uint64 sourceChainSelector; // ─╯ Source chainSelector @@ -41,14 +41,14 @@ contract CommitStore is ICommitStore, ITypeAndVersion, OCR2Base { } /// @notice a sequenceNumber interval - /// @dev RMN depends on this struct, if changing, please notify RMN. + /// @dev RMN depends on this struct, if changing, please notify the RMN maintainers. struct Interval { uint64 min; // ───╮ Minimum sequence number, inclusive uint64 max; // ───╯ Maximum sequence number, inclusive } /// @notice Report that is committed by the observing DON at the committing phase - /// @dev RMN depends on this struct, if changing, please notify RMN. + /// @dev RMN depends on this struct, if changing, please notify the RMN maintainers. struct CommitReport { Internal.PriceUpdates priceUpdates; Interval interval; @@ -226,7 +226,7 @@ contract CommitStore is ICommitStore, ITypeAndVersion, OCR2Base { // ================================================================ /// @notice Returns the static commit store config. - /// @dev RMN depends on this function, if changing, please notify RMN. + /// @dev RMN depends on this function, if changing, please notify the RMN maintainers. /// @return the configuration. function getStaticConfig() external view returns (StaticConfig memory) { return diff --git a/contracts/src/v0.8/ccip/libraries/Client.sol b/contracts/src/v0.8/ccip/libraries/Client.sol index c52f17b1ff..51bcbda56c 100644 --- a/contracts/src/v0.8/ccip/libraries/Client.sol +++ b/contracts/src/v0.8/ccip/libraries/Client.sol @@ -3,7 +3,7 @@ pragma solidity ^0.8.0; // End consumer library. library Client { - /// @dev RMN depends on this struct, if changing, please notify RMN. + /// @dev RMN depends on this struct, if changing, please notify the RMN maintainers. struct EVMTokenAmount { address token; // token address on the local chain. uint256 amount; // Amount of tokens. diff --git a/contracts/src/v0.8/ccip/libraries/Internal.sol b/contracts/src/v0.8/ccip/libraries/Internal.sol index 0148702d17..968fddbe34 100644 --- a/contracts/src/v0.8/ccip/libraries/Internal.sol +++ b/contracts/src/v0.8/ccip/libraries/Internal.sol @@ -16,21 +16,21 @@ library Internal { uint16 internal constant MAX_RET_BYTES = 4 + 4 * 32; /// @notice A collection of token price and gas price updates. - /// @dev RMN depends on this struct, if changing, please notify RMN. + /// @dev RMN depends on this struct, if changing, please notify the RMN maintainers. struct PriceUpdates { TokenPriceUpdate[] tokenPriceUpdates; GasPriceUpdate[] gasPriceUpdates; } /// @notice Token price in USD. - /// @dev RMN depends on this struct, if changing, please notify RMN. + /// @dev RMN depends on this struct, if changing, please notify the RMN maintainers. struct TokenPriceUpdate { address sourceToken; // Source token uint224 usdPerToken; // 1e18 USD per smallest unit of token } /// @notice Gas price for a given chain in USD, its value may contain tightly packed fields. - /// @dev RMN depends on this struct, if changing, please notify RMN. + /// @dev RMN depends on this struct, if changing, please notify the RMN maintainers. struct GasPriceUpdate { uint64 destChainSelector; // Destination chain selector uint224 usdPerUnitGas; // 1e18 USD per smallest unit (e.g. wei) of destination chain gas @@ -53,7 +53,7 @@ library Internal { } /// @notice Report that is submitted by the execution DON at the execution phase. - /// @dev RMN depends on this struct, if changing, please notify RMN. + /// @dev RMN depends on this struct, if changing, please notify the RMN maintainers. struct ExecutionReport { EVM2EVMMessage[] messages; // Contains a bytes array for each message, each inner bytes array contains bytes per transferred token @@ -63,7 +63,7 @@ library Internal { } /// @notice The cross chain message that gets committed to EVM chains. - /// @dev RMN depends on this struct, if changing, please notify RMN. + /// @dev RMN depends on this struct, if changing, please notify the RMN maintainers. struct EVM2EVMMessage { uint64 sourceChainSelector; // ─────────╮ the chain selector of the source chain, note: not chainId address sender; // ─────────────────────╯ sender address on the source chain @@ -108,7 +108,7 @@ library Internal { function _hash(EVM2EVMMessage memory original, bytes32 metadataHash) internal pure returns (bytes32) { // Fixed-size message fields are included in nested hash to reduce stack pressure. - // This hashing scheme is also used by RMN. If changing it, please notify RMN. + // This hashing scheme is also used by RMN. If changing it, please notify the RMN maintainers. return keccak256( abi.encode( @@ -139,7 +139,7 @@ library Internal { /// IN_PROGRESS currently being executed, used a replay protection /// SUCCESS successfully executed. End state /// FAILURE unsuccessfully executed, manual execution is now enabled. - /// @dev RMN depends on this enum, if changing, please notify RMN. + /// @dev RMN depends on this enum, if changing, please notify the RMN maintainers. enum MessageExecutionState { UNTOUCHED, IN_PROGRESS, diff --git a/contracts/src/v0.8/ccip/offRamp/EVM2EVMOffRamp.sol b/contracts/src/v0.8/ccip/offRamp/EVM2EVMOffRamp.sol index d4d4f8af2f..753d7a560d 100644 --- a/contracts/src/v0.8/ccip/offRamp/EVM2EVMOffRamp.sol +++ b/contracts/src/v0.8/ccip/offRamp/EVM2EVMOffRamp.sol @@ -67,7 +67,7 @@ contract EVM2EVMOffRamp is IAny2EVMOffRamp, AggregateRateLimiter, ITypeAndVersio event ConfigSet(StaticConfig staticConfig, DynamicConfig dynamicConfig); event SkippedIncorrectNonce(uint64 indexed nonce, address indexed sender); event SkippedSenderWithPreviousRampMessageInflight(uint64 indexed nonce, address indexed sender); - /// @dev RMN depends on this event, if changing, please notify RMN. + /// @dev RMN depends on this event, if changing, please notify the RMN maintainers. event ExecutionStateChanged( uint64 indexed sequenceNumber, bytes32 indexed messageId, @@ -76,7 +76,7 @@ contract EVM2EVMOffRamp is IAny2EVMOffRamp, AggregateRateLimiter, ITypeAndVersio ); /// @notice Static offRamp config - /// @dev RMN depends on this struct, if changing, please notify RMN. + /// @dev RMN depends on this struct, if changing, please notify the RMN maintainers. struct StaticConfig { address commitStore; // ────────╮ CommitStore address on the destination chain uint64 chainSelector; // ───────╯ Destination chainSelector @@ -451,7 +451,7 @@ contract EVM2EVMOffRamp is IAny2EVMOffRamp, AggregateRateLimiter, ITypeAndVersio /// @notice Returns the static config. /// @dev This function will always return the same struct as the contents is static and can never change. - /// RMN depends on this function, if changing, please notify RMN. + /// RMN depends on this function, if changing, please notify the RMN maintainers. function getStaticConfig() external view returns (StaticConfig memory) { return StaticConfig({ diff --git a/contracts/src/v0.8/ccip/onRamp/EVM2EVMOnRamp.sol b/contracts/src/v0.8/ccip/onRamp/EVM2EVMOnRamp.sol index 3370094ec7..a1f7862181 100644 --- a/contracts/src/v0.8/ccip/onRamp/EVM2EVMOnRamp.sol +++ b/contracts/src/v0.8/ccip/onRamp/EVM2EVMOnRamp.sol @@ -61,14 +61,14 @@ contract EVM2EVMOnRamp is IEVM2AnyOnRamp, ILinkAvailable, AggregateRateLimiter, event NopPaid(address indexed nop, uint256 amount); event FeeConfigSet(FeeTokenConfigArgs[] feeConfig); event TokenTransferFeeConfigSet(TokenTransferFeeConfigArgs[] transferFeeConfig); - /// RMN depends on this event, if changing, please notify RMN. + /// RMN depends on this event, if changing, please notify the RMN maintainers. event CCIPSendRequested(Internal.EVM2EVMMessage message); event NopsSet(uint256 nopWeightsTotal, NopAndWeight[] nopsAndWeights); event PoolAdded(address token, address pool); event PoolRemoved(address token, address pool); /// @dev Struct that contains the static configuration - /// RMN depends on this struct, if changing, please notify RMN. + /// RMN depends on this struct, if changing, please notify the RMN maintainers. struct StaticConfig { address linkToken; // ────────╮ Link token address uint64 chainSelector; // ─────╯ Source chainSelector @@ -384,7 +384,7 @@ contract EVM2EVMOnRamp is IEVM2AnyOnRamp, ILinkAvailable, AggregateRateLimiter, // ================================================================ /// @notice Returns the static onRamp config. - /// @dev RMN depends on this function, if changing, please notify RMN. + /// @dev RMN depends on this function, if changing, please notify the RMN maintainers. /// @return the configuration. function getStaticConfig() external view returns (StaticConfig memory) { return