Skip to content

Commit

Permalink
Update generated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
byshape committed Jan 24, 2024
1 parent a003226 commit c71a3d3
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 19 deletions.
2 changes: 1 addition & 1 deletion documentation/src/contracts/Escrow.sol/contract.Escrow.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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,
Expand All @@ -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**
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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**

Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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;
Expand All @@ -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.*


Expand Down

0 comments on commit c71a3d3

Please sign in to comment.