Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update docs to match code updates #48

Merged
merged 1 commit into from
Aug 17, 2023
Merged

docs: update docs to match code updates #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/AllocationIDTracker.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ contract AllocationIDTracker {
* @dev Marks an allocation ID as used.
* @param sender The sender of the token to receiver.
* @param allocationID The allocation ID to mark as used.
* @param proof ECDSA Proof signed by the receiver's allocationID consisting of packed (sender address, allocationID, collateral contract address).
* @param proof ECDSA Proof signed by the receiver's allocationID consisting of packed (sender address, allocationID, escrow contract address).
* @notice REVERT with error:
* - AllocationIDPreviouslyClaimed: If the (sender, allocationID) pair was previously claimed
* - InvalidProof: If the proof is not valid
Expand All @@ -68,7 +68,7 @@ contract AllocationIDTracker {

/**
* @dev Verifies a proof.
* @param proof ECDSA Proof signed by the receiver's allocationID consisting of packed (sender address, allocationID, collateral contract address).
* @param proof ECDSA Proof signed by the receiver's allocationID consisting of packed (sender address, allocationID, escrow contract address).
* @param sender The sender of the token to receiver.
* @param allocationID The allocation ID to verify.
* @notice REVERT with error:
Expand Down
4 changes: 2 additions & 2 deletions src/Escrow.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ contract Escrow {
struct EscrowAccount {
uint256 balance; // Total escrow balance for a sender-receiver pair
uint256 amountThawing; // Amount of escrow currently being thawed
uint256 thawEndTimestamp; // Block number at which thawing period ends (zero if not thawing)
uint256 thawEndTimestamp; // Timestamp at which thawing period ends (zero if not thawing)
}

struct SenderAuthorization {
address sender; // Sender the signer is authorized to sign for
uint256 thawEndTimestamp; // Block number at which thawing period ends (zero if not thawing)
uint256 thawEndTimestamp; // Timestamp at which thawing period ends (zero if not thawing)
}

// Stores how much escrow each sender has deposited for each receiver, as well as thawing information
Expand Down