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

docs(contracts): regenerate #12

Merged
merged 7 commits into from
Jul 1, 2024
Merged

docs(contracts): regenerate #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a136a56
Merge branch 'master' of https://github.com/manifoldfinance/docs-xga
sambacha Jun 25, 2024
0ff07bc
Merge branch 'master' of https://github.com/manifoldfinance/docs-xga
sambacha Jun 25, 2024
315fd41
docs(contracts): improve markdown output for contracts
sambacha Jun 30, 2024
76f029c
fix(docs): correct admonitions
sambacha Jun 30, 2024
cf96d42
chore(lint): fmt
sambacha Jul 1, 2024
7e4524e
chore(update): sitemap
sambacha Jul 1, 2024
f43d8c7
Merge branch 'master' into contracts-generate
sambacha Jul 1, 2024
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
835 changes: 254 additions & 581 deletions docs/Reference/Contracts/Auctioneer.md
View file
Open in desktop

Large diffs are not rendered by default.

27 changes: 8 additions & 19 deletions docs/Reference/Contracts/Bidder.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,42 +1,31 @@
---
description: Bidder
title: Bidder
---

# Bidder.sol
> [Read code on GitHub](https://github.com/manifoldfinance/xga-auctioneer-v1/blob/maaster/src/Bidder.sol)




> [Read code on GitHub](https://github.com/manifoldfinance/xga-auctioneer-v1/blob/master/src/Bidder.sol)

## Methods

### getBid



```solidity title="Solidity"
function getBid(uint256 slot) external view returns (uint256[] packedBids)
```

!!! info

!!! info

Get the bid from a bidder for a specific slot and round.

Get the bid from a bidder for a specific slot and round.

#### Parameters

| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
| ---- | ------- | ----------------- |
| slot | uint256 | The auction slot. |

#### Returns

| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
| ---------- | --------- | -------------------------------------------------------------------------------------------------- |
| packedBids | uint256[] | Array of bids (in a packed format). uint256(uint128(bidPrice),uint120(itemsToBuy),uint8(bidderId)) |




41 changes: 8 additions & 33 deletions docs/Reference/Contracts/IAccountant.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,64 +1,39 @@
---
description: IAccountant
title: Interface Accountant
---

# IAccountant.sol
> [Read code on GitHub](https://github.com/manifoldfinance/xga-auctioneer-v1/blob/maaster/src/IAccountant.sol)




> [Read code on GitHub](https://github.com/manifoldfinance/xga-auctioneer-v1/blob/master/src/IAccountant.sol)

## Methods

### getPayoutBalance



```solidity title="Solidity"
function getPayoutBalance() external view returns (uint256 payoutBalance)
```





#### Returns

| Name | Type | Description |
|---|---|---|
| payoutBalance | uint256 | undefined |
| Name | Type | Description |
| ------------- | ------- | ----------- |
| payoutBalance | uint256 | undefined |

### minPayout



```solidity title="Solidity"
function minPayout() external view returns (uint256 amount)
```





#### Returns

| Name | Type | Description |
|---|---|---|
| amount | uint256 | undefined |
| Name | Type | Description |
| ------ | ------- | ----------- |
| amount | uint256 | undefined |

### payout



```solidity title="Solidity"
function payout() external nonpayable
```








Loading