Skip to content

Commit f2a7c86

Browse files
committed
feat: enhance ReceiverSignedMessage library with detailed documentation for SignedMessage structure
1 parent 8525f11 commit f2a7c86

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

src/library/ReceiverSignedMessage.sol

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,21 @@
11
// SPDX-License-Identifier: MIT
22
pragma solidity 0.8.26;
33

4+
/// @title ReceiverSignedMessage
5+
/// @author Luo Yingjie
6+
/// @notice This library defines the signed message structure for the receiver
7+
48
library ReceiverSignedMessage {
9+
/// @notice The signed message structure for the receiver
10+
/// @param chainSelector The target chain selector
11+
/// @param user The signer's address
12+
/// @param token The token on the destination chain to transfer
13+
/// @param amount The amount to transfer
14+
/// @param transferContract The contract address for transfer, first transfer to this contract, then router will transfer to the target chain => Receiver
15+
/// @param router The router address for approval => destination chain's router
16+
/// @param nonce The nonce for replay protection
17+
/// @param expiry The expiry timestamp
18+
519
struct SignedMessage {
620
uint64 chainSelector; // Include the target chain selector
721
address user; // Signer's address

0 commit comments

Comments
 (0)