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

fix: added missing tables in the docs #235

Merged
merged 1 commit into from
Jun 25, 2024
Merged

fix: added missing tables in the docs #235

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/solidity-docgen/interfaces/ISwaplace.md
View file
Open in desktop
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. |

Loading