Skip to content

Commit

Permalink
update comments
Browse files Browse the repository at this point in the history
  • Loading branch information
matYang committed Oct 23, 2023
1 parent 34f74a2 commit d265722
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 20 deletions.
2 changes: 1 addition & 1 deletion contracts/src/v0.8/ccip/ARM.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions contracts/src/v0.8/ccip/CommitStore.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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;
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion contracts/src/v0.8/ccip/libraries/Client.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
14 changes: 7 additions & 7 deletions contracts/src/v0.8/ccip/libraries/Internal.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -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,
Expand Down
6 changes: 3 additions & 3 deletions contracts/src/v0.8/ccip/offRamp/EVM2EVMOffRamp.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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
Expand Down Expand Up @@ -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({
Expand Down
6 changes: 3 additions & 3 deletions contracts/src/v0.8/ccip/onRamp/EVM2EVMOnRamp.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit d265722

Please sign in to comment.