diff --git a/docs/Developers/index.md b/docs/Developers/index.md
index bbe3c41..d4d33f6 100644
--- a/docs/Developers/index.md
+++ b/docs/Developers/index.md
@@ -8,6 +8,8 @@ description:
- [SDK](./sdk.md)
+- [Mainnet](./mainnet.md)
+
- [Holesky Testnet](./testnet.md)
## Auction Contracts v1.0
diff --git a/docs/Developers/interface.md b/docs/Developers/interface.md
index 97c5ea0..ea12398 100644
--- a/docs/Developers/interface.md
+++ b/docs/Developers/interface.md
@@ -3,279 +3,208 @@ title: Primary Market Interface
description: Primary Market Auction and Settlement contract interface
---
-## Interface
+# Summary Interfaces
+- [Auctioneer](#auctioneer-interface)
+- [Settlement](#settlementhouse-interface)
+- [Bidder](#bidder-interface)
-[_See the ERC6909 Interface reference for additional information_](../Reference/erc6909.md)
+# Auctioneer Interface
+[Git Source](https://github.com/manifoldfinance/open-bidder-contracts/blob/main/src/interfaces/IAuctioneer.sol)
-### Functions
+**Inherits:**
+ERC6909, Ownable2Step
-#### getBid
+*Implements an auction mechanism for selling block space.*
-_Get the bid from a bidder for a specific slot and round._
+## Structs
+### Auction
```solidity
-function getBid(uint256 slot) external view returns (uint256[] memory packedBids);
+struct Auction {
+ uint120 itemsForSale;
+ bool isOpen;
+ bool isSettled;
+ bool isPaidOut;
+ bool isRefunded;
+ mapping(address => BidderInfo) biddersInfo;
+}
```
-**Parameters**
-
-| Name | Type | Description |
-| ------ | --------- | ----------------- |
-| `slot` | `uint256` | The auction slot. |
+### BidderInfo
-**Returns**
+```solidity
+struct BidderInfo {
+ uint120 itemsBought;
+ uint128 amountOwed;
+}
+```
-| Name | Type | Description |
-| ------------ | ----------- | ------------------------------------------------------------------------------------------------- |
-| `packedBids` | `uint256[]` | Array of bids (in a packed format). uint256(uint128(bidPrice),uint120(itemsToBuy),uint8(biderId)) |
+## State Variables
+### maxBidder
-### newBidder
+```solidity
+uint8 public maxBidder;
+```
-_Add a new bidder to the auction._
+### WETH9
```solidity
-function newBidder(address additionalBidder) external onlyOwner returns (uint8 newId);
+WETH public immutable WETH9;
```
-**Parameters**
+### accountant
-| Name | Type | Description |
-| ------------------ | --------- | ------------------------------------- |
-| `additionalBidder` | `address` | The address of the additional bidder. |
+```solidity
+address public accountant;
+```
-### removeBidder
-_Remove a bidder from the auction._
+### maxBids
```solidity
-function removeBidder(uint8 bidderId) external onlyOwner;
+uint256 public maxBids = 50;
```
-**Parameters**
-
-| Name | Type | Description |
-| ---------- | ------- | -------------------------------------- |
-| `bidderId` | `uint8` | The index of the bidder to be removed. |
-### addOperator
-
-_Add a new operator to the auction._
+### minGasAmount
```solidity
-function addOperator(address newOperator) external onlyOwner;
+uint120 public minGasAmount = 20000;
```
-**Parameters**
-
-| Name | Type | Description |
-| ------------- | --------- | ------------------------------- |
-| `newOperator` | `address` | The address of the new operator |
-
-### removeOperator
-_Remove an operator from the auction._
+### operator
```solidity
-function removeOperator(address oldOperator) external onlyOwner;
+address public operator;
```
-**Parameters**
-
-| Name | Type | Description |
-| ------------- | --------- | ---------------------------------- |
-| `oldOperator` | `address` | Address of operator to be removed. |
-### openAuction
-
-_Open a new auction for a specific slot._
+### IdMap
```solidity
-function openAuction(uint256 slot, uint120 itemsForSale) external onlyOperator;
+mapping(address bidder => uint8 id) public IdMap;
```
-**Parameters**
-| Name | Type | Description |
-| -------------- | --------- | ------------------------------------------------------ |
-| `slot` | `uint256` | The auction slot. |
-| `itemsForSale` | `uint120` | The number of items available for sale in the auction. |
-
-### bid
-
-_Bid function for bidders to submit manual bids._
+### bidderMap
```solidity
-function bid(uint256 slot, uint256[] memory packedBids) external;
+mapping(uint8 id => address bidder) public bidderMap;
```
-**Parameters**
-| Name | Type | Description |
-| ------------ | ----------- | -------------------- |
-| `slot` | `uint256` | The auction slot. |
-| `packedBids` | `uint256[]` | Array of packed bids |
-
-### run
-
-_Execute the auction for a specific slot._
+### auctions
```solidity
-function run(uint256 slot) public onlyOperator;
+mapping(uint256 slot => Auction) public auctions;
```
-**Parameters**
-
-| Name | Type | Description |
-| ------ | --------- | ----------------- |
-| `slot` | `uint256` | The auction slot. |
-### settle
-
-_Settle the auction for a specific slot._
+### slotsCount
```solidity
-function settle(uint256 slot, address recipient) public onlyOperator;
+uint256 public slotsCount;
```
-**Parameters**
-
-| Name | Type | Description |
-| ----------- | --------- | -------------------------------------------------- |
-| `slot` | `uint256` | The auction slot. |
-| `recipient` | `address` | The address of the recipient of the settled funds. |
-### runAndSettle
+### slotsAuctioned
```solidity
-function runAndSettle(uint256 slot, address recipient) external onlyOperator;
+mapping(uint256 index => uint256 slot) public slotsAuctioned;
```
-### getBidderInfo
-_Retrieve information about a bidder after auction settlement._
+### bidCount
```solidity
-function getBidderInfo(uint256 slot, address bidder) external view returns (uint120 itemsBought, uint128 amountOwed);
+mapping(uint256 slot => uint256 count) public bidCount;
```
-**Parameters**
-
-| Name | Type | Description |
-| -------- | --------- | ------------------------------------------------------------ |
-| `slot` | `uint256` | The slot identifier of the auction. |
-| `bidder` | `address` | The address of the bidder for whom information is requested. |
+## Functions
-**Returns**
-
-| Name | Type | Description |
-| ------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `itemsBought` | `uint120` | The number of items bought by the bidder in the specified auction. |
-| `amountOwed` | `uint128` | The amount owed by the bidder for the items bought in the specified auction. Requirements: - The auction must have been settled. - The provided `bidder` address must be valid and have participated in the auction. |
+### bid
-### packBid
+*Bid function for bidders to submit manual bids.*
-_Packed Bid details into a uint256 for submission._
```solidity
-function packBid(uint256 bidPrice, uint256 itemsToBuy, uint256 bidderId) external pure returns (uint256 packedBid);
+function bid(uint256 slot, uint256[] memory packedBids) external;
```
-
**Parameters**
-| Name | Type | Description |
-| ------------ | --------- | ---------------------------- |
-| `bidPrice` | `uint256` | Price per item. |
-| `itemsToBuy` | `uint256` | Items to buy in the auction. |
-| `bidderId` | `uint256` | Id for bidder |
-
-**Returns**
+|Name|Type|Description|
+|----|----|-----------|
+|`slot`|`uint256`|The auction slot.|
+|`packedBids`|`uint256[]`|Array of packed bids|
-| Name | Type | Description |
-| ----------- | --------- | ---------------------- |
-| `packedBid` | `uint256` | for auction submission |
+### getBidderInfo
-### decodeBid
+*Retrieve information about a bidder after auction settlement.*
-_Decode the packed bid information._
```solidity
-function decodeBid(uint256 packedBid) internal pure returns (uint8 bidderId, uint120 itemsToBuy, uint128 bidPrice);
+function getBidderInfo(uint256 slot, address bidder) external view returns (uint120 itemsBought, uint128 amountOwed);
```
-
**Parameters**
-| Name | Type | Description |
-| ----------- | --------- | --------------------------- |
-| `packedBid` | `uint256` | The packed bid information. |
+|Name|Type|Description|
+|----|----|-----------|
+|`slot`|`uint256`|The slot identifier of the auction.|
+|`bidder`|`address`|The address of the bidder for whom information is requested.|
**Returns**
-| Name | Type | Description |
-| ------------ | --------- | -------------------------------------------- |
-| `bidderId` | `uint8` | The bidder's ID. |
-| `itemsToBuy` | `uint120` | The number of items the bidder wants to buy. |
-| `bidPrice` | `uint128` | The price per item in the bid. |
+|Name|Type|Description|
+|----|----|-----------|
+|`itemsBought`|`uint120`|The number of items bought by the bidder in the specified auction.|
+|`amountOwed`|`uint128`|The amount owed by the bidder for the items bought in the specified auction. Requirements: - The auction must have been settled. - The provided `bidder` address must be valid and have participated in the auction.|
+
+
+### packBid
-### checkAndStoreBid
+*Packed Bid details into a uint256 for submission.*
-_Check the validity of a bid._
```solidity
-function checkAndStoreBid(
- bool revertInvalid,
- address bidder,
- uint256 slot,
- uint256 itemsForSale,
- uint256[] memory packedBids
-) internal;
+function packBid(uint128 bidPrice, uint120 itemsToBuy, uint8 bidderId) external pure returns (uint256 packedBid);
```
-
**Parameters**
-| Name | Type | Description |
-| --------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `revertInvalid` | `bool` | true for manual bids causing reverts for invalid data |
-| `bidder` | `address` | Address of bidder. |
-| `slot` | `uint256` | The auction slot. |
-| `itemsForSale` | `uint256` | Total items for sale for the slot. |
-| `packedBids` | `uint256[]` | Array of packed bids Requirements: - The number of items in the bid must not exceed the available items for sale in the auction. - The bidder must have enough funds to cover the bid amount. |
+|Name|Type|Description|
+|----|----|-----------|
+|`bidPrice`|`uint128`|Price per item.|
+|`itemsToBuy`|`uint120`|Items to buy in the auction.|
+|`bidderId`|`uint8`|Id for bidder|
-## Structs
+**Returns**
-### Auction
+|Name|Type|Description|
+|----|----|-----------|
+|`packedBid`|`uint256`|for auction submission|
-```solidity
-struct Auction {
- uint120 itemsForSale;
- bool isOpen;
- bool isSettled;
- mapping(address => BidderInfo) biddersInfo;
-}
-```
+### calcAverageBid
+
+*Calculate average bid price for the last n auctions*
-### BidderInfo
```solidity
-struct BidderInfo {
- uint120 itemsBought;
- uint128 amountOwed;
-}
+function calcAverageBid(uint256 numAuctions) external view returns (uint128 avBidPrice);
```
+**Parameters**
-## Events
-
-### OperatorAdded
+|Name|Type|Description|
+|----|----|-----------|
+|`numAuctions`|`uint256`|Number of auctions to average for|
-```solidity
-event OperatorAdded(address newOperator);
-```
+**Returns**
-### OperatorRemoved
+|Name|Type|Description|
+|----|----|-----------|
+|`avBidPrice`|`uint128`|for last n auctions|
-```solidity
-event OperatorRemoved(address oldOperator);
-```
+## Events
### AuctionSettled
```solidity
@@ -285,13 +214,13 @@ event AuctionSettled(uint256 indexed slot);
### BidderAdded
```solidity
-event BidderAdded(address indexed bidder, uint8 bidderId);
+event BidderAdded(address indexed bidder, uint8 indexed bidderId);
```
### BidderRemoved
```solidity
-event BidderRemoved(address indexed bidder, uint8 bidderId);
+event BidderRemoved(address indexed bidder, uint8 indexed bidderId);
```
### AuctionOpened
@@ -300,8 +229,19 @@ event BidderRemoved(address indexed bidder, uint8 bidderId);
event AuctionOpened(uint256 indexed slot, uint120 itemsForSale);
```
-## Errors
+### AuctionPaidOut
+```solidity
+event AuctionPaidOut(uint256 indexed slot);
+```
+
+### AuctionRefund
+
+```solidity
+event AuctionRefund(uint256 indexed slot);
+```
+
+## Errors
### InvalidId
```solidity
@@ -361,3 +301,61 @@ error BidderNotRegistered(address bidder);
```solidity
error BidderAlreadyExists(address bidder);
```
+
+# SettlementHouse Interface
+[Git Source](https://github.com/manifoldfinance/open-bidder-contracts/blob/main/src/interfaces/ISettlement.sol)
+
+*A contract for managing bundles of transactions for a futures token.*
+
+
+## Structs
+### Bundle
+
+```solidity
+struct Bundle {
+ address submitter;
+ uint256 amountOfGas;
+ bytes32[] bundleHashes;
+}
+```
+
+## State Variables
+### futuresToken
+
+```solidity
+IERC6909 public immutable futuresToken;
+```
+
+## Functions
+
+### submitBundle
+
+
+```solidity
+function submitBundle(uint256 slot, uint256 amountOfGas, bytes32[] calldata bundleHashes) external;
+```
+
+
+# Bidder Interface
+[Git Source](https://github.com/manifoldfinance/open-bidder-contracts/blob/main/src/interfaces/IBidder.sol)
+
+## Functions
+### getBid
+
+*Get the bid from a bidder for a specific slot and round.*
+
+
+```solidity
+function getBid(uint256 slot) external view returns (uint256[] memory packedBids);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`slot`|`uint256`|The auction slot.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`packedBids`|`uint256[]`|Array of bids (in a packed format). uint256(uint128(bidPrice),uint120(itemsToBuy),uint8(bidderId))|
\ No newline at end of file
diff --git a/docs/Developers/mainnet.md b/docs/Developers/mainnet.md
new file mode 100644
index 0000000..4d1004c
--- /dev/null
+++ b/docs/Developers/mainnet.md
@@ -0,0 +1,61 @@
+---
+title: XGA L2 Mainnet
+description:
+ Mainnet information for node operators, validators, builders, and searchers.
+---
+
+- [Live auction dashboard](https://mainnet-auction-dashboard.securerpc.com/)
+- [L2 Blockchain explorer](https://mainnet-blockscout.securerpc.com/)
+
+## Node Operators
+
+Please coordinate with us to register your validator set with our registry
+service. We will provide you with the necessary information to get started.
+
+## Validators
+
+Connecting to the relay without being registered will result in your validator
+operating correctly so long as MEV Boost is also running.
+
+## Mainnet Information
+
+- **L2 RPC:**
+
+ - Description: L2 Node RPC
+ - URL:
+ [https://xga-api.securerpc.com/v1](https://xga-api.securerpc.com/v1)
+ - Methods: eth\_\*
+ - ChainId: 7890785
+ - Limits: 300 req per minute per IP
+
+- **Beta bundle RPC:**
+ - Description: Beta bundle submission RPC
+ - URL:
+ [https://mainnet-auction.securerpc.com/](https://mainnet-auction.securerpc.com/)
+ - Method: mev_sendBetaBundle
+ - Parameters:
+ - `txs`: List of txs as bundle e.g. [0x2323...,]
+ - `slot`: slot number e.g. "11282389"
+ - ChainId: 1
+
+## Builders and searchers
+
+Aquire some Holesky Testnet ETH through a faucet in the resources listed below.
+If you are unable to secure enough, please reach out to us.
+
+### Contracts
+
+L2 _Auctioneer_: `0x86Bc75A43704E38f0FD94BdA423C50071fE17c99`
+
+L2 _SettlementHouse_: `0x80C5FfF824d14c87C799D6F90b7D8e0a715bd33C`
+
+_L1StandardBridgeProxy_: `0x490B959870889D5FA0B329431683B8B3e850DD95`
+
+To monetize yourself on L2, send some ETH on L1 to
+`0x490B959870889D5FA0B329431683B8B3e850DD95`
+
+### Resources
+
+- Block Explorers
+ - [etherscan.io](https://etherscan.io/)
+ - [beaconcha.in](https://beaconcha.in/)
diff --git a/docs/Developers/sdk.md b/docs/Developers/sdk.md
index 4ccb57e..bd224a5 100644
--- a/docs/Developers/sdk.md
+++ b/docs/Developers/sdk.md
@@ -4,7 +4,30 @@ sidebar_position: 1
title: Auction SDK
---
-## RPC Endpoints
+XGA auction winners are granted future block space via a token, which is used with submission of transactions for inclusion in the beta block. Budding bidders can register themselves with the protocol to participate in beta block auctions. Thereupon custom implementations will be required to bid and submit transactions. Technical details are provided herein.
+
+Technical Overview:
+- [Bidding](#bidding):
+ - [Connect to L2 RPC](#l2-rpc)
+ - [Bridge eth to L2](#l1-bridge)
+ - [Understand auction contracts](#auction-contracts)
+ - [Deploy custom bidding strategy contract](#bidder-contracts)
+- [Submitting bundles](#submitting-bundles):
+ - [Beta Bundle RPC](#beta-bundle-rpc)
+ - [Bundle JSON Requests and Responses](#bundle-json-requests-and-responses)
+
+Full working examples are available for:
+- [Zero latency open bidder contract](https://github.com/manifoldfinance/open-bidder-contracts/)
+- [Bundle submissions](https://github.com/MEV-Protocol/beta-bundles-py)
+
+# Bidding
+## L2 RPC
+- **L2 RPC:**
+ - Description: L2 Node RPC
+ - URL:
+ [https://xga-api.securerpc.com/v1](https://xga-api.securerpc.com/v1)
+ - Methods: eth\_\*
+ - ChainId: 7890785
- **L2 RPC (TESTNET):**
@@ -13,56 +36,17 @@ title: Auction SDK
[https://holesky-api.securerpc.com/l2](https://holesky-api.securerpc.com/l2/)
- Methods: eth\_\*
- ChainId: 42169
+
+## L1 Bridge
-- **Beta bundle RPC (Testnet):**
- - Description: Beta bundle submission RPC
- - URL:
- [https://holesky-api.securerpc.com/v2](https://holesky-api.securerpc.com/v2)
- - Method: mev_sendBetaBundle
- - Parameters:
- - `txs`: List of txs as bundle e.g. [0x2323...,]
- - `slot`: slot number e.g. "11282389"
- - ChainId: 17000
-
-## Bundler Examples
-
-- [Python bundler](https://github.com/MEV-Protocol/beta-bundles-py) - employs
- a deployed bidder contract for continuous automated bidding, while listening
- for auction close event, then submits the bundle
-
-## Bundle JSON Requests and Responses
-
-### Example JSON request
-
-```jsonc
-{
- "jsonrpc": "2.0",
- "method": "mev_sendBetaBundle",
- "params": [
- {
- "txs": [0x... ],
- "slot": "1001"
- }
- ],
- "id": 8
-}
-```
+Fund L2 address by sending ETH to the L1 bridge address.
-### Example JSON response
+### Deployed Address
-```jsonc
-{
- "jsonrpc": "2.0",
- "id": 1,
- "method": "mev_sendBetaBundle",
- "result": "0x79e5cba7876f532218ac35a357209800be2362dd2e3f1e6dc5974698f0d7cee4",
-}
+```bash
+L1_BRIDGE="0x490B959870889D5FA0B329431683B8B3e850DD95"
```
-## L1 Bridge
-
-Fund L2 address by sending ETH to the bridge address.
-
### Deployed Address (Testnet)
```bash
@@ -71,7 +55,7 @@ L1_BRIDGE="0x3Ae5Ca0B05bE12d4FF9983Ed70D86de9C34e820C"
## WETH
-### Deployed Address (Testnet)
+### Deployed Address (Mainnet and Testnet)
```bash
WETH="0x4200000000000000000000000000000000000006"
@@ -79,6 +63,13 @@ WETH="0x4200000000000000000000000000000000000006"
## Auction Contracts
+### Deployed Addresses
+
+```bash
+AUCTIONEER="0x86Bc75A43704E38f0FD94BdA423C50071fE17c99"
+SETTLEMENT="0x80C5FfF824d14c87C799D6F90b7D8e0a715bd33C"
+```
+
### Deployed Addresses (Testnet)
```bash
@@ -142,7 +133,7 @@ After an auction is closed, bidders can query their bid results:
## Bidder Contracts
-A minimal viable bidder is provided below:
+A minimal viable bidder is provided below. [A more sophisticated fill or kill open bidder contract is provided](https://github.com/manifoldfinance/open-bidder-contracts/).
```solidity
/// SPDX-License-Identifier: UPL-1.0
@@ -183,3 +174,62 @@ contract MockBidder {
}
}
```
+
+# Submitting bundles
+
+## Beta Bundle RPC
+- **Beta bundle RPC:**
+ - Description: Beta bundle submission RPC
+ - URL:
+ [https://mainnet-auction.securerpc.com/](https://mainnet-auction.securerpc.com/)
+ - Method: mev_sendBetaBundle
+ - Parameters:
+ - `txs`: List of txs as bundle e.g. [0x2323...,]
+ - `slot`: slot number e.g. "11282389"
+ - ChainId: 1
+
+- **Beta bundle RPC (Testnet):**
+ - Description: Beta bundle submission RPC
+ - URL:
+ [https://holesky-api.securerpc.com/v2](https://holesky-api.securerpc.com/v2)
+ - Method: mev_sendBetaBundle
+ - Parameters:
+ - `txs`: List of txs as bundle e.g. [0x2323...,]
+ - `slot`: slot number e.g. "11282389"
+ - ChainId: 17000
+
+
+## Bundle JSON Requests and Responses
+
+### Example JSON request
+
+```jsonc
+{
+ "jsonrpc": "2.0",
+ "method": "mev_sendBetaBundle",
+ "params": [
+ {
+ "txs": [0x... ],
+ "slot": "1001"
+ }
+ ],
+ "id": 8
+}
+```
+
+### Example JSON response
+
+```jsonc
+{
+ "jsonrpc": "2.0",
+ "id": 1,
+ "method": "mev_sendBetaBundle",
+ "result": "0x79e5cba7876f532218ac35a357209800be2362dd2e3f1e6dc5974698f0d7cee4",
+}
+```
+
+## Bundler Examples
+
+- [Python bundler](https://github.com/MEV-Protocol/beta-bundles-py) - employs
+ a deployed bidder contract for continuous automated bidding, while listening
+ for auction close event, then submits the bundle
diff --git a/docs/Developers/testnet.md b/docs/Developers/testnet.md
index 672ba06..5bf2322 100644
--- a/docs/Developers/testnet.md
+++ b/docs/Developers/testnet.md
@@ -1,9 +1,12 @@
---
-title: MEV L2 Testnet
+title: XGA L2 Testnet
description:
Testing information for node operators, validators, builders, and searchers.
---
+- [Live auction dashboard](https://holesky-auction-dashboard.securerpc.com/)
+- [L2 Blockchain explorer](https://holesky-blockscout.securerpc.com/)
+
## Node Operators
Please coordinate with us to register your validator set with our registry
@@ -50,18 +53,6 @@ _L1StandardBridgeProxy_: `0x3Ae5Ca0B05bE12d4FF9983Ed70D86de9C34e820C`
To monetize yourself on L2, send some ETH on L1 (Holesky) to
`0x3Ae5Ca0B05bE12d4FF9983Ed70D86de9C34e820C`
-mevETH Reward Address: `0x583d8a136e5e4387234A50EB9fd790d9c513484C`
-
-- Holesky Network ID: `17000`
-- Holesky Chain ID: `17000`
-- L2 Chain ID: `42169`
-- L2 RPC Endpoint:
- [@holesky-l2.v2-stag.manifoldx.com](https://holesky-l2.v2-stag.manifoldx.com/)
-
-!!! warning
-
- The L2 RPC Endpoint requires a username and password, this is provided by us during the closed testing period
-
### Resources
- Block Explorers
diff --git a/docs/index.md b/docs/index.md
index 264e13d..651caf7 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,10 +1,10 @@
---
-title: MEV Auction Platform
-description: The Gang Designs the Ultimate MEV Auction
+title: XGA Auction Platform
+description: The Gang Designs the Ultimate XGA Auction
date: 2024-04-24
---
-# MEV Auction
+# eXtensible Gas Auction (XGA)
Multi-unit auctions, unlike their single-unit counterparts, present complex
allocation mechanisms. The MEV Auction platform implements several innovative