From c71a3d3bb4f1ce5e9b5cf16b404fb28069eae0f9 Mon Sep 17 00:00:00 2001 From: byshape Date: Wed, 24 Jan 2024 13:43:26 +0000 Subject: [PATCH] Update generated docs --- .../src/contracts/Escrow.sol/contract.Escrow.md | 2 +- .../EscrowFactory.sol/contract.EscrowFactory.md | 11 +++++------ .../interfaces/IEscrow.sol/interface.IEscrow.md | 4 ++-- .../IEscrowFactory.sol/interface.IEscrowFactory.md | 6 +++--- .../TimelocksLib.sol/library.TimelocksLib.md | 2 +- .../libraries/TimelocksLib.sol/type.Timelocks.md | 12 ++++++------ 6 files changed, 18 insertions(+), 19 deletions(-) diff --git a/documentation/src/contracts/Escrow.sol/contract.Escrow.md b/documentation/src/contracts/Escrow.sol/contract.Escrow.md index 16ff0d0..fae3983 100644 --- a/documentation/src/contracts/Escrow.sol/contract.Escrow.md +++ b/documentation/src/contracts/Escrow.sol/contract.Escrow.md @@ -1,5 +1,5 @@ # Escrow -[Git Source](https://github.com/1inch/cross-chain-swap/blob/40ee0298e9d149b252571265df4978f25f912e2a/contracts/Escrow.sol) +[Git Source](https://github.com/1inch/cross-chain-swap/blob/a0032266a4f4e0c7ae999b45292f7c9116abe373/contracts/Escrow.sol) **Inherits:** Clone, [IEscrow](/contracts/interfaces/IEscrow.sol/interface.IEscrow.md) diff --git a/documentation/src/contracts/EscrowFactory.sol/contract.EscrowFactory.md b/documentation/src/contracts/EscrowFactory.sol/contract.EscrowFactory.md index 4034a79..62a679b 100644 --- a/documentation/src/contracts/EscrowFactory.sol/contract.EscrowFactory.md +++ b/documentation/src/contracts/EscrowFactory.sol/contract.EscrowFactory.md @@ -1,5 +1,5 @@ # EscrowFactory -[Git Source](https://github.com/1inch/cross-chain-swap/blob/40ee0298e9d149b252571265df4978f25f912e2a/contracts/EscrowFactory.sol) +[Git Source](https://github.com/1inch/cross-chain-swap/blob/a0032266a4f4e0c7ae999b45292f7c9116abe373/contracts/EscrowFactory.sol) **Inherits:** [IEscrowFactory](/contracts/interfaces/IEscrowFactory.sol/interface.IEscrowFactory.md), SimpleSettlementExtension @@ -38,7 +38,7 @@ after all funds have been transferred. See [IPostInteraction-postInteraction](/l function _postInteraction( IOrderMixin.Order calldata order, bytes calldata, - bytes32 orderHash, + bytes32, address taker, uint256 makingAmount, uint256 takingAmount, @@ -62,25 +62,24 @@ See [IEscrowFactory-addressOfEscrow](/contracts/interfaces/IEscrowFactory.sol/in ```solidity -function addressOfEscrow(bytes32 salt) public view returns (address); +function addressOfEscrow(bytes memory data) public view returns (address); ``` ### _createEscrow Creates a new escrow contract with immutable arguments. -*The escrow contract is a proxy clone created using the create3 pattern.* +*The escrow contract is a proxy clone created using the create2 pattern.* ```solidity -function _createEscrow(bytes memory data, bytes32 salt, uint256 value) private returns (address clone); +function _createEscrow(bytes memory data, uint256 value) private returns (address clone); ``` **Parameters** |Name|Type|Description| |----|----|-----------| |`data`|`bytes`|Encoded immutable args.| -|`salt`|`bytes32`|The salt that influences the contract address in deterministic deployment.| |`value`|`uint256`|| **Returns** diff --git a/documentation/src/contracts/interfaces/IEscrow.sol/interface.IEscrow.md b/documentation/src/contracts/interfaces/IEscrow.sol/interface.IEscrow.md index da78f4c..8693534 100644 --- a/documentation/src/contracts/interfaces/IEscrow.sol/interface.IEscrow.md +++ b/documentation/src/contracts/interfaces/IEscrow.sol/interface.IEscrow.md @@ -1,5 +1,5 @@ # IEscrow -[Git Source](https://github.com/1inch/cross-chain-swap/blob/40ee0298e9d149b252571265df4978f25f912e2a/contracts/interfaces/IEscrow.sol) +[Git Source](https://github.com/1inch/cross-chain-swap/blob/a0032266a4f4e0c7ae999b45292f7c9116abe373/contracts/interfaces/IEscrow.sol) ## Functions @@ -178,10 +178,10 @@ chainId, token, amount and safetyDeposit relate to the destination chain. ```solidity struct DstEscrowImmutables { uint256 deployedAt; + uint256 chainId; bytes32 hashlock; address maker; address taker; - uint256 chainId; address token; uint256 amount; uint256 safetyDeposit; diff --git a/documentation/src/contracts/interfaces/IEscrowFactory.sol/interface.IEscrowFactory.md b/documentation/src/contracts/interfaces/IEscrowFactory.sol/interface.IEscrowFactory.md index a7cdf56..8a76fc1 100644 --- a/documentation/src/contracts/interfaces/IEscrowFactory.sol/interface.IEscrowFactory.md +++ b/documentation/src/contracts/interfaces/IEscrowFactory.sol/interface.IEscrowFactory.md @@ -1,5 +1,5 @@ # IEscrowFactory -[Git Source](https://github.com/1inch/cross-chain-swap/blob/40ee0298e9d149b252571265df4978f25f912e2a/contracts/interfaces/IEscrowFactory.sol) +[Git Source](https://github.com/1inch/cross-chain-swap/blob/a0032266a4f4e0c7ae999b45292f7c9116abe373/contracts/interfaces/IEscrowFactory.sol) ## Functions @@ -27,13 +27,13 @@ Returns the deterministic address of the escrow based on the salt. ```solidity -function addressOfEscrow(bytes32 salt) external view returns (address); +function addressOfEscrow(bytes memory data) external view returns (address); ``` **Parameters** |Name|Type|Description| |----|----|-----------| -|`salt`|`bytes32`|The salt used to deploy escrow.| +|`data`|`bytes`|The immutable arguments used to deploy escrow.| **Returns** diff --git a/documentation/src/contracts/libraries/TimelocksLib.sol/library.TimelocksLib.md b/documentation/src/contracts/libraries/TimelocksLib.sol/library.TimelocksLib.md index 73cbc82..078a328 100644 --- a/documentation/src/contracts/libraries/TimelocksLib.sol/library.TimelocksLib.md +++ b/documentation/src/contracts/libraries/TimelocksLib.sol/library.TimelocksLib.md @@ -1,5 +1,5 @@ # TimelocksLib -[Git Source](https://github.com/1inch/cross-chain-swap/blob/40ee0298e9d149b252571265df4978f25f912e2a/contracts/libraries/TimelocksLib.sol) +[Git Source](https://github.com/1inch/cross-chain-swap/blob/a0032266a4f4e0c7ae999b45292f7c9116abe373/contracts/libraries/TimelocksLib.sol) ## State Variables diff --git a/documentation/src/contracts/libraries/TimelocksLib.sol/type.Timelocks.md b/documentation/src/contracts/libraries/TimelocksLib.sol/type.Timelocks.md index f90d351..4364e90 100644 --- a/documentation/src/contracts/libraries/TimelocksLib.sol/type.Timelocks.md +++ b/documentation/src/contracts/libraries/TimelocksLib.sol/type.Timelocks.md @@ -1,8 +1,8 @@ # Timelocks -[Git Source](https://github.com/1inch/cross-chain-swap/blob/40ee0298e9d149b252571265df4978f25f912e2a/contracts/libraries/TimelocksLib.sol) +[Git Source](https://github.com/1inch/cross-chain-swap/blob/a0032266a4f4e0c7ae999b45292f7c9116abe373/contracts/libraries/TimelocksLib.sol) *Timelocks for the source and the destination chains. -For illustrative purposes, it is possible to describe theimlocks by two structures: +For illustrative purposes, it is possible to describe timelocks by two structures: struct SrcTimelocks { uint256 finality; uint256 withdrawal; @@ -14,10 +14,10 @@ uint256 withdrawal; uint256 publicWithdrawal; } finality: The duration of the chain finality period. -withdrawal: The duration of the period when only the taker with a secret can withdraw tokens for taker (source chain) or -maker (destination chain). -publicWithdrawal: The duration of the period when anyone with a secret can withdraw tokens for taker (source chain) or -maker (destination chain). +withdrawal: The duration of the period when only the taker with a secret can withdraw tokens for taker (source chain) +or maker (destination chain). +publicWithdrawal: The duration of the period when anyone with a secret can withdraw tokens for taker (source chain) +or maker (destination chain). cancel: The duration of the period when escrow can only be cancelled by the taker.*