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.

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(auction): update links #13

Merged
merged 11 commits into from
Jul 11, 2024
15 changes: 15 additions & 0 deletions docs/Developers/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Developer overview
description: Developer related information for builders, searchers and intergrators.

Check warning on line 3 in docs/Developers/index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (intergrators)
---

!!! important
Expand All @@ -25,6 +25,21 @@

[Payment Methods](./payment-methods.md)

## API Endpoints and Analytics

| URL | Description |
| ---------------------------------------------------------------- | ------------------------------- |
| [eth.xga.com](https://eth.xga.com) | auction mev-boost-relay |
| [dashboard-auth.xga.com](https://dashboard-auth.xga.com) | auction dashboard, auth |
| [blockscout.xga.com](https://blockscout.xga.com) | blockscout |

Check warning on line 34 in docs/Developers/index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (blockscout)

Check warning on line 34 in docs/Developers/index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (blockscout)
| [rpc.xga.com](https://rpc.xga.com) | mainnet RPC |
| [op.xga.com](https://op.xga.com) | mainnet XGA RPC |
| [holesky-dashboard.xga.com](https://holesky-dashboard.xga.com) | holesky auction stash board |
| [holesky-blockscout.xga.com](https://holesky-blockscout.xga.com) | holesky blockscout |

Check warning on line 38 in docs/Developers/index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (blockscout)

Check warning on line 38 in docs/Developers/index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (blockscout)
| [holesky-op.xga.com](https://holesky-op.xga.com) | holesky XGA RPC |
| [holesky-eth.xga.com](https://holesky-eth.xga.com) | holesky auction mev-boost-relay |
| [holesky-rpc.xga.com](https://holesky-rpc.xga.com) | holesky RPC |

## RPC Endpoints

Holesky: https://holesky-eth.xga.com/ - Relay
Expand Down
4 changes: 2 additions & 2 deletions docs/Reference/Contracts/Auctioneer.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
description: Auctioneer Contract
title: Auctioneer Contract
---

# Auctioneer.sol

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

Implements an auction mechanism for selling block space.

Expand Down
2 changes: 1 addition & 1 deletion docs/Reference/Contracts/Bidder.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ title: Bidder
function getBid(uint256 slot) external view returns (uint256[] packedBids)
```

!!! info
!!! info

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

Expand Down
6 changes: 3 additions & 3 deletions docs/Reference/Contracts/SettlementHouse.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
description: SettlementHouse
title: SettlementHouse
---

# SettlementHouse.sol
## SettlementHouse.sol

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

!!! note
!!! note

A contract for managing bundles of transactions for a futures token.

Expand All @@ -15,19 +15,19 @@
### futuresToken

```solidity title="Solidity"
function futuresToken() external view returns (contract IERC6909)

Check warning on line 18 in docs/Reference/Contracts/SettlementHouse.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (IERC)

Check warning on line 18 in docs/Reference/Contracts/SettlementHouse.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (IERC)
```

#### Returns

| Name | Type | Description |
| ---- | ----------------- | ----------- |
| \_0 | contract IERC6909 | undefined |

Check warning on line 25 in docs/Reference/Contracts/SettlementHouse.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (IERC)

Check warning on line 25 in docs/Reference/Contracts/SettlementHouse.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (IERC)

### queryBundles

```solidity title="Solidity"
function queryBundles(uint256 slot) external view returns (struct SettlementHouse.Bundle[] slotBundles)

Check warning on line 30 in docs/Reference/Contracts/SettlementHouse.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (struct)

Check warning on line 30 in docs/Reference/Contracts/SettlementHouse.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (struct)
```

#### Parameters
Expand Down
13 changes: 13 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
XGA is a platform that is comprised of an Optimism based Rollup, a smart contract protocol, an Ethereum consensus layer
sidecar and a domain-specific engine called Open Games for proving/developing (game-specific) mechanisms.

- Preconfirmations without CL or EL changes

Check warning on line 14 in docs/index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (Preconfirmations)
- Searchers no longer need to vertically integrate with Builders, leading to a more competitive MEV market for the
benefit of Validator returns.
- Unambiguously earns more for Validators than running MEV Boost alone.
Expand All @@ -28,7 +28,7 @@
3. Elastic Supply Scheduling
4. Option to use Contract based bidding. (RPC Supported as well).
5. Backwards compatible with MEV-Boost
6. No need for Restaking or Depositing of Staked Ether for Validators to participate

Check warning on line 31 in docs/index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (Restaking)

### **Block Structure**

Expand Down Expand Up @@ -112,6 +112,19 @@

## Suggested Links

| URL | Description |
| ---------------------------------------------------------------- | ------------------------------- |
| [eth.xga.com](https://eth.xga.com) | auction mev-boost-relay |
| [dashboard-auth.xga.com](https://dashboard-auth.xga.com) | mainnet dashboard |
| [blockscout.xga.com](https://blockscout.xga.com) | blockscout |
| [rpc.xga.com](https://rpc.xga.com) | mainnet RPC |
| [op.xga.com](https://op.xga.com) | mainnet XGA RPC |
| [holesky-dashboard.xga.com](https://holesky-dashboard.xga.com) | holesky auction stash board |
| [holesky-blockscout.xga.com](https://holesky-blockscout.xga.com) | holesky blockscout |
| [holesky-op.xga.com](https://holesky-op.xga.com) | holesky XGA RPC |
| [holesky-eth.xga.com](https://holesky-eth.xga.com) | holesky auction mev-boost-relay |
| [holesky-rpc.xga.com](https://holesky-rpc.xga.com) | holesky RPC |

## Footnotes

[^1]: Previously this was called 'above'
Expand Down
7 changes: 4 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
# yamllint disable rule:line-length
# yamllint disable rule:comments-indentation
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json

repo_name: manifoldfinance/docs-xga
repo_url: https://github.com/manifoldfinance/docs-xga
site_author: XGA Systems
Expand Down Expand Up @@ -106,8 +105,10 @@ extra:
name: Google Analytics
checked: false
social:
- icon: fontawesome/solid/rss
link: https://your.site/newsletter/0_newsletter_index/
# - icon: fontawesome/solid/rss
# link: https://your.site/newsletter/0_newsletter_index/
- icon: fontawesome/solid/envelope
link: https://noteforms.com/forms/xga-intake-847b2j

plugins:
- search:
Expand Down