Skip to content

Commit

Permalink
Merge pull request #235 from RafaDSan/develop
Browse files Browse the repository at this point in the history
fix: added missing tables in the docs
  • Loading branch information
RafaDSan authored Jun 25, 2024
2 parents 5c72530 + 154f227 commit 026d8cc
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/solidity-docgen/interfaces/ISwaplace.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,12 @@ Requirements:

Emits a {SwapCreated} event._

#### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| Swap | struct ISwap.Swap | is the Swap struct to be created. |

### acceptSwap

```solidity
Expand All @@ -65,6 +71,13 @@ Emits a {SwapAccepted} event.
NOTE: The expiry is set to 0, because if the Swap is expired it
will revert, preventing reentrancy attacks._

#### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| swapId | uint256 | is the ID of the Swap to be accepted. |
| receiver | address | is the address that will receive the trading assets. |

### cancelSwap

```solidity
Expand All @@ -83,6 +96,12 @@ Requirements:

Emits a {SwapCanceled} event._

#### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| swapId | uint256 | is the ID of the Swap to be canceled. |

### getSwap

```solidity
Expand All @@ -95,3 +114,9 @@ NOTE: If the Swaps doesn't exist, the values will be defaulted to 0.
You can check if a Swap exists by checking if the `owner` is the zero address.
If the `owner` is the zero address, then the Swap doesn't exist._

#### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| swapId | uint256 | is the ID of the Swap to be retrieved. |

0 comments on commit 026d8cc

Please sign in to comment.