diff --git a/docs/Reference/Contracts/Auctioneer.md b/docs/Reference/Contracts/Auctioneer.md index 3c45e4d..a99967a 100644 --- a/docs/Reference/Contracts/Auctioneer.md +++ b/docs/Reference/Contracts/Auctioneer.md @@ -3,1204 +3,877 @@ description: Auctioneer Contract --- # Auctioneer.sol -> [Read code on GitHub](https://github.com/manifoldfinance/xga-auctioneer-v1/blob/maaster/src/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. - + Implements an auction mechanism for selling block space. ## Methods ### IdMap - - ```solidity title="Solidity" function IdMap(address bidder) external view returns (uint8 id) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| bidder | address | undefined | +| Name | Type | Description | +| ------ | ------- | ----------- | +| bidder | address | undefined | #### Returns -| Name | Type | Description | -|---|---|---| -| id | uint8 | undefined | +| Name | Type | Description | +| ---- | ----- | ----------- | +| id | uint8 | undefined | ### WETH9 - - ```solidity title="Solidity" function WETH9() external view returns (contract WETH) ``` - - - - #### Returns -| Name | Type | Description | -|---|---|---| -| _0 | contract WETH | undefined | +| Name | Type | Description | +| ---- | ------------- | ----------- | +| \_0 | contract WETH | undefined | ### acceptOwnership - - ```solidity title="Solidity" function acceptOwnership() external nonpayable ``` - -!!! info - - The new owner accepts the ownership transfer. - - +!!! info The new owner accepts the ownership transfer. ### accountant - - ```solidity title="Solidity" function accountant() external view returns (address) ``` - - - - #### Returns -| Name | Type | Description | -|---|---|---| -| _0 | address | undefined | +| Name | Type | Description | +| ---- | ------- | ----------- | +| \_0 | address | undefined | ### allowance - - ```solidity title="Solidity" function allowance(address, address, uint256) external view returns (uint256) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| _0 | address | undefined | -| _1 | address | undefined | -| _2 | uint256 | undefined | +| Name | Type | Description | +| ---- | ------- | ----------- | +| \_0 | address | undefined | +| \_1 | address | undefined | +| \_2 | uint256 | undefined | #### Returns -| Name | Type | Description | -|---|---|---| -| _0 | uint256 | undefined | +| Name | Type | Description | +| ---- | ------- | ----------- | +| \_0 | uint256 | undefined | ### approve - - ```solidity title="Solidity" function approve(address spender, uint256 id, uint256 amount) external nonpayable returns (bool) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| spender | address | undefined | -| id | uint256 | undefined | -| amount | uint256 | undefined | +| Name | Type | Description | +| ------- | ------- | ----------- | +| spender | address | undefined | +| id | uint256 | undefined | +| amount | uint256 | undefined | #### Returns | Name | Type | Description | -|---|---|---| -| _0 | bool | undefined | +| ---- | ---- | ----------- | +| \_0 | bool | undefined | ### auctions - - ```solidity title="Solidity" function auctions(uint256 slot) external view returns (uint120 itemsForSale, bool isOpen, bool isSettled, bool isPaidOut, bool isRefunded) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| slot | uint256 | undefined | +| Name | Type | Description | +| ---- | ------- | ----------- | +| slot | uint256 | undefined | #### Returns -| Name | Type | Description | -|---|---|---| -| itemsForSale | uint120 | undefined | -| isOpen | bool | undefined | -| isSettled | bool | undefined | -| isPaidOut | bool | undefined | -| isRefunded | bool | undefined | +| Name | Type | Description | +| ------------ | ------- | ----------- | +| itemsForSale | uint120 | undefined | +| isOpen | bool | undefined | +| isSettled | bool | undefined | +| isPaidOut | bool | undefined | +| isRefunded | bool | undefined | ### balanceOf - - ```solidity title="Solidity" function balanceOf(address, uint256) external view returns (uint256) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| _0 | address | undefined | -| _1 | uint256 | undefined | +| Name | Type | Description | +| ---- | ------- | ----------- | +| \_0 | address | undefined | +| \_1 | uint256 | undefined | #### Returns -| Name | Type | Description | -|---|---|---| -| _0 | uint256 | undefined | +| Name | Type | Description | +| ---- | ------- | ----------- | +| \_0 | uint256 | undefined | ### bid - - ```solidity title="Solidity" function bid(uint256 slot, uint256[] packedBids) external nonpayable ``` - -!!! info - - Bid function for bidders to submit manual bids. - +!!! info Bid function for bidders to submit manual bids. #### Parameters -| Name | Type | Description | -|---|---|---| -| slot | uint256 | The auction slot. | +| Name | Type | Description | +| ---------- | --------- | -------------------- | +| slot | uint256 | The auction slot. | | packedBids | uint256[] | Array of packed bids | ### bidCount - - ```solidity title="Solidity" function bidCount(uint256 slot) external view returns (uint256 count) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| slot | uint256 | undefined | +| Name | Type | Description | +| ---- | ------- | ----------- | +| slot | uint256 | undefined | #### Returns -| Name | Type | Description | -|---|---|---| -| count | uint256 | undefined | +| Name | Type | Description | +| ----- | ------- | ----------- | +| count | uint256 | undefined | ### bidderMap - - ```solidity title="Solidity" function bidderMap(uint8 id) external view returns (address bidder) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| id | uint8 | undefined | +| Name | Type | Description | +| ---- | ----- | ----------- | +| id | uint8 | undefined | #### Returns -| Name | Type | Description | -|---|---|---| -| bidder | address | undefined | +| Name | Type | Description | +| ------ | ------- | ----------- | +| bidder | address | undefined | ### calcAverageBid - - ```solidity title="Solidity" function calcAverageBid(uint256 numAuctions) external view returns (uint128 avBidPrice) ``` - -!!! info - - Calculate average bid price for the last n auctions - +!!! info Calculate average bid price for the last n auctions #### Parameters -| Name | Type | Description | -|---|---|---| +| Name | Type | Description | +| ----------- | ------- | --------------------------------- | | numAuctions | uint256 | Number of auctions to average for | #### Returns -| Name | Type | Description | -|---|---|---| +| Name | Type | Description | +| ---------- | ------- | ------------------- | | avBidPrice | uint128 | for last n auctions | ### changeOperator - - ```solidity title="Solidity" function changeOperator(address newOperator) external nonpayable ``` - -!!! info - - Change operator of the auction. - +!!! info Change operator of the auction. #### Parameters -| Name | Type | Description | -|---|---|---| +| Name | Type | Description | +| ----------- | ------- | ------------------------------- | | newOperator | address | The address of the new operator | ### getBidderInfo - - ```solidity title="Solidity" function getBidderInfo(uint256 slot, address bidder) external view returns (uint120 itemsBought, uint128 amountOwed) ``` - -!!! info - - Retrieve information about a bidder after auction settlement. - +!!! info Retrieve information about a bidder after auction settlement. #### Parameters -| Name | Type | Description | -|---|---|---| -| slot | uint256 | The slot identifier of the auction. | +| 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 | -|---|---|---| -| 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. | +| 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. | ### isOperator - - ```solidity title="Solidity" function isOperator(address, address) external view returns (bool) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| _0 | address | undefined | -| _1 | address | undefined | +| Name | Type | Description | +| ---- | ------- | ----------- | +| \_0 | address | undefined | +| \_1 | address | undefined | #### Returns | Name | Type | Description | -|---|---|---| -| _0 | bool | undefined | +| ---- | ---- | ----------- | +| \_0 | bool | undefined | ### maxBidder - - ```solidity title="Solidity" function maxBidder() external view returns (uint8) ``` - - - - #### Returns -| Name | Type | Description | -|---|---|---| -| _0 | uint8 | undefined | +| Name | Type | Description | +| ---- | ----- | ----------- | +| \_0 | uint8 | undefined | ### maxBids - - ```solidity title="Solidity" function maxBids() external view returns (uint256) ``` - - - - #### Returns -| Name | Type | Description | -|---|---|---| -| _0 | uint256 | undefined | +| Name | Type | Description | +| ---- | ------- | ----------- | +| \_0 | uint256 | undefined | ### minGasAmount - - ```solidity title="Solidity" function minGasAmount() external view returns (uint120) ``` - - - - #### Returns -| Name | Type | Description | -|---|---|---| -| _0 | uint120 | undefined | +| Name | Type | Description | +| ---- | ------- | ----------- | +| \_0 | uint120 | undefined | ### newBidder - - ```solidity title="Solidity" function newBidder(address additionalBidder) external nonpayable returns (uint8 newId) ``` - -!!! info - - Add a new bidder to the auction. - +!!! info Add a new bidder to the auction. #### Parameters -| Name | Type | Description | -|---|---|---| +| Name | Type | Description | +| ---------------- | ------- | ------------------------------------- | | additionalBidder | address | The address of the additional bidder. | #### Returns -| Name | Type | Description | -|---|---|---| -| newId | uint8 | undefined | +| Name | Type | Description | +| ----- | ----- | ----------- | +| newId | uint8 | undefined | ### openAuction - - ```solidity title="Solidity" function openAuction(uint256 slot, uint120 itemsForSale) external nonpayable ``` - -!!! info - - Open a new auction for a specific slot. - +!!! info Open a new auction for a specific slot. #### Parameters -| Name | Type | Description | -|---|---|---| -| slot | uint256 | The auction slot. | +| Name | Type | Description | +| ------------ | ------- | ------------------------------------------------------ | +| slot | uint256 | The auction slot. | | itemsForSale | uint120 | The number of items available for sale in the auction. | ### operator - - ```solidity title="Solidity" function operator() external view returns (address) ``` - - - - #### Returns -| Name | Type | Description | -|---|---|---| -| _0 | address | undefined | +| Name | Type | Description | +| ---- | ------- | ----------- | +| \_0 | address | undefined | ### owner - - ```solidity title="Solidity" function owner() external view returns (address) ``` - - - - #### Returns -| Name | Type | Description | -|---|---|---| -| _0 | address | undefined | +| Name | Type | Description | +| ---- | ------- | ----------- | +| \_0 | address | undefined | ### packBid - - ```solidity title="Solidity" function packBid(uint128 bidPrice, uint120 itemsToBuy, uint8 bidderId) external pure returns (uint256 packedBid) ``` - -!!! info - - Packed Bid details into a uint256 for submission. - +!!! info Packed Bid details into a uint256 for submission. #### Parameters -| Name | Type | Description | -|---|---|---| -| bidPrice | uint128 | Price per item. | +| Name | Type | Description | +| ---------- | ------- | ---------------------------- | +| bidPrice | uint128 | Price per item. | | itemsToBuy | uint120 | Items to buy in the auction. | -| bidderId | uint8 | Id for bidder | +| bidderId | uint8 | Id for bidder | #### Returns -| Name | Type | Description | -|---|---|---| +| Name | Type | Description | +| --------- | ------- | ---------------------- | | packedBid | uint256 | for auction submission | ### payout - - ```solidity title="Solidity" function payout(uint256 slot) external nonpayable ``` - -!!! info - - Payout revenue from auction to validators - +!!! info Payout revenue from auction to validators #### Parameters -| Name | Type | Description | -|---|---|---| +| Name | Type | Description | +| ---- | ------- | ----------------- | | slot | uint256 | The auction slot. | ### pendingOwner - - ```solidity title="Solidity" function pendingOwner() external view returns (address) ``` - - - - #### Returns -| Name | Type | Description | -|---|---|---| -| _0 | address | undefined | +| Name | Type | Description | +| ---- | ------- | ----------- | +| \_0 | address | undefined | ### refund - - ```solidity title="Solidity" function refund(uint256 slot) external nonpayable ``` - -!!! info - - Refund revenue from auction to bidders - +!!! info Refund revenue from auction to bidders #### Parameters -| Name | Type | Description | -|---|---|---| +| Name | Type | Description | +| ---- | ------- | ----------------- | | slot | uint256 | The auction slot. | ### removeBidder - - ```solidity title="Solidity" function removeBidder(uint8 bidderId) external nonpayable ``` - -!!! info - - Remove a bidder from the auction. - +!!! info Remove a bidder from the auction. #### Parameters -| Name | Type | Description | -|---|---|---| +| Name | Type | Description | +| -------- | ----- | -------------------------------------- | | bidderId | uint8 | The index of the bidder to be removed. | ### runAndSettle - - ```solidity title="Solidity" function runAndSettle(uint256 slot) external nonpayable ``` - -!!! info - - Execute the auction for a specific slot. - +!!! info Execute the auction for a specific slot. #### Parameters -| Name | Type | Description | -|---|---|---| +| Name | Type | Description | +| ---- | ------- | ----------------- | | slot | uint256 | The auction slot. | ### setOperator - - ```solidity title="Solidity" function setOperator(address operator, bool approved) external nonpayable returns (bool) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| operator | address | undefined | -| approved | bool | undefined | +| Name | Type | Description | +| -------- | ------- | ----------- | +| operator | address | undefined | +| approved | bool | undefined | #### Returns | Name | Type | Description | -|---|---|---| -| _0 | bool | undefined | +| ---- | ---- | ----------- | +| \_0 | bool | undefined | ### slotsAuctioned - - ```solidity title="Solidity" function slotsAuctioned(uint256 index) external view returns (uint256 slot) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| index | uint256 | undefined | +| Name | Type | Description | +| ----- | ------- | ----------- | +| index | uint256 | undefined | #### Returns -| Name | Type | Description | -|---|---|---| -| slot | uint256 | undefined | +| Name | Type | Description | +| ---- | ------- | ----------- | +| slot | uint256 | undefined | ### slotsCount - - ```solidity title="Solidity" function slotsCount() external view returns (uint256) ``` - - - - #### Returns -| Name | Type | Description | -|---|---|---| -| _0 | uint256 | undefined | +| Name | Type | Description | +| ---- | ------- | ----------- | +| \_0 | uint256 | undefined | ### supportsInterface - - ```solidity title="Solidity" function supportsInterface(bytes4 interfaceId) external view returns (bool) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| interfaceId | bytes4 | undefined | +| Name | Type | Description | +| ----------- | ------ | ----------- | +| interfaceId | bytes4 | undefined | #### Returns | Name | Type | Description | -|---|---|---| -| _0 | bool | undefined | +| ---- | ---- | ----------- | +| \_0 | bool | undefined | ### transfer - - ```solidity title="Solidity" function transfer(address receiver, uint256 id, uint256 amount) external nonpayable returns (bool) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| receiver | address | undefined | -| id | uint256 | undefined | -| amount | uint256 | undefined | +| Name | Type | Description | +| -------- | ------- | ----------- | +| receiver | address | undefined | +| id | uint256 | undefined | +| amount | uint256 | undefined | #### Returns | Name | Type | Description | -|---|---|---| -| _0 | bool | undefined | +| ---- | ---- | ----------- | +| \_0 | bool | undefined | ### transferFrom - - ```solidity title="Solidity" function transferFrom(address sender, address receiver, uint256 id, uint256 amount) external nonpayable returns (bool) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| sender | address | undefined | -| receiver | address | undefined | -| id | uint256 | undefined | -| amount | uint256 | undefined | +| Name | Type | Description | +| -------- | ------- | ----------- | +| sender | address | undefined | +| receiver | address | undefined | +| id | uint256 | undefined | +| amount | uint256 | undefined | #### Returns | Name | Type | Description | -|---|---|---| -| _0 | bool | undefined | +| ---- | ---- | ----------- | +| \_0 | bool | undefined | ### transferOwnership - - ```solidity title="Solidity" function transferOwnership(address newOwner) external nonpayable ``` - -!!! info - - Starts the ownership transfer of the contract to a new account. Replaces the pending transfer if there is one. Can only be called by the current owner. - +!!! info Starts the ownership transfer of the contract to a new account. Replaces the pending transfer if there is one. +Can only be called by the current owner. #### Parameters -| Name | Type | Description | -|---|---|---| -| newOwner | address | undefined | +| Name | Type | Description | +| -------- | ------- | ----------- | +| newOwner | address | undefined | ### updateAccountant - - ```solidity title="Solidity" function updateAccountant(address newAccountant) external nonpayable ``` - -!!! info - - update accountant address - +!!! info update accountant address #### Parameters -| Name | Type | Description | -|---|---|---| -| newAccountant | address | undefined | +| Name | Type | Description | +| ------------- | ------- | ----------- | +| newAccountant | address | undefined | ### updateMaxBids - - ```solidity title="Solidity" function updateMaxBids(uint256 newMaxBids) external nonpayable ``` - -!!! info - - update max num of bids per bidder - +!!! info update max num of bids per bidder #### Parameters -| Name | Type | Description | -|---|---|---| -| newMaxBids | uint256 | undefined | +| Name | Type | Description | +| ---------- | ------- | ----------- | +| newMaxBids | uint256 | undefined | ### updateMinGasAmount - - ```solidity title="Solidity" function updateMinGasAmount(uint120 newAmount) external nonpayable ``` - -!!! info - - update minGasAmount - +!!! info update minGasAmount #### Parameters -| Name | Type | Description | -|---|---|---| -| newAmount | uint120 | undefined | - - +| Name | Type | Description | +| --------- | ------- | ----------- | +| newAmount | uint120 | undefined | ## Events ### Approval - - ```solidity title="Solidity" event Approval(address indexed owner, address indexed spender, uint256 indexed id, uint256 amount) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| owner `indexed` | address | undefined | -| spender `indexed` | address | undefined | -| id `indexed` | uint256 | undefined | -| amount | uint256 | undefined | +| Name | Type | Description | +| ----------------- | ------- | ----------- | +| owner `indexed` | address | undefined | +| spender `indexed` | address | undefined | +| id `indexed` | uint256 | undefined | +| amount | uint256 | undefined | ### AuctionOpened - - ```solidity title="Solidity" event AuctionOpened(uint256 indexed slot, uint120 itemsForSale) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| slot `indexed` | uint256 | undefined | -| itemsForSale | uint120 | undefined | +| Name | Type | Description | +| -------------- | ------- | ----------- | +| slot `indexed` | uint256 | undefined | +| itemsForSale | uint120 | undefined | ### AuctionPaidOut - - ```solidity title="Solidity" event AuctionPaidOut(uint256 indexed slot) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| slot `indexed` | uint256 | undefined | +| Name | Type | Description | +| -------------- | ------- | ----------- | +| slot `indexed` | uint256 | undefined | ### AuctionRefund - - ```solidity title="Solidity" event AuctionRefund(uint256 indexed slot) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| slot `indexed` | uint256 | undefined | +| Name | Type | Description | +| -------------- | ------- | ----------- | +| slot `indexed` | uint256 | undefined | ### AuctionSettled - - ```solidity title="Solidity" event AuctionSettled(uint256 indexed slot) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| slot `indexed` | uint256 | undefined | +| Name | Type | Description | +| -------------- | ------- | ----------- | +| slot `indexed` | uint256 | undefined | ### BidderAdded - - ```solidity title="Solidity" event BidderAdded(address indexed bidder, uint8 indexed bidderId) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| bidder `indexed` | address | undefined | -| bidderId `indexed` | uint8 | undefined | +| Name | Type | Description | +| ------------------ | ------- | ----------- | +| bidder `indexed` | address | undefined | +| bidderId `indexed` | uint8 | undefined | ### BidderRemoved - - ```solidity title="Solidity" event BidderRemoved(address indexed bidder, uint8 indexed bidderId) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| bidder `indexed` | address | undefined | -| bidderId `indexed` | uint8 | undefined | +| Name | Type | Description | +| ------------------ | ------- | ----------- | +| bidder `indexed` | address | undefined | +| bidderId `indexed` | uint8 | undefined | ### OperatorSet - - ```solidity title="Solidity" event OperatorSet(address indexed owner, address indexed operator, bool approved) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| owner `indexed` | address | undefined | -| operator `indexed` | address | undefined | -| approved | bool | undefined | +| Name | Type | Description | +| ------------------ | ------- | ----------- | +| owner `indexed` | address | undefined | +| operator `indexed` | address | undefined | +| approved | bool | undefined | ### OperatorUpdated - - ```solidity title="Solidity" event OperatorUpdated(address indexed oldOperator, address indexed newOperator) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| oldOperator `indexed` | address | undefined | -| newOperator `indexed` | address | undefined | +| Name | Type | Description | +| --------------------- | ------- | ----------- | +| oldOperator `indexed` | address | undefined | +| newOperator `indexed` | address | undefined | ### OwnershipTransferStarted - - ```solidity title="Solidity" event OwnershipTransferStarted(address indexed previousOwner, address indexed newOwner) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| previousOwner `indexed` | address | undefined | -| newOwner `indexed` | address | undefined | +| Name | Type | Description | +| ----------------------- | ------- | ----------- | +| previousOwner `indexed` | address | undefined | +| newOwner `indexed` | address | undefined | ### OwnershipTransferred - - ```solidity title="Solidity" event OwnershipTransferred(address indexed user, address indexed newOwner) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| user `indexed` | address | undefined | -| newOwner `indexed` | address | undefined | +| Name | Type | Description | +| ------------------ | ------- | ----------- | +| user `indexed` | address | undefined | +| newOwner `indexed` | address | undefined | ### Transfer - - ```solidity title="Solidity" event Transfer(address caller, address indexed from, address indexed to, uint256 indexed id, uint256 amount) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| caller | address | undefined | -| from `indexed` | address | undefined | -| to `indexed` | address | undefined | -| id `indexed` | uint256 | undefined | -| amount | uint256 | undefined | - - +| Name | Type | Description | +| -------------- | ------- | ----------- | +| caller | address | undefined | +| from `indexed` | address | undefined | +| to `indexed` | address | undefined | +| id `indexed` | uint256 | undefined | +| amount | uint256 | undefined | ## Errors ### AuctionAlreadyOpen - - ```solidity title="Solidity" error AuctionAlreadyOpen(uint256 slot) ``` - - #### Parameters -| Name | Type | Description | -|---|---|---| -| slot | uint256 | undefined | +| Name | Type | Description | +| ---- | ------- | ----------- | +| slot | uint256 | undefined | ### AuctionAlreadySettled - - ```solidity title="Solidity" error AuctionAlreadySettled(uint256 slot) ``` - - #### Parameters -| Name | Type | Description | -|---|---|---| -| slot | uint256 | undefined | +| Name | Type | Description | +| ---- | ------- | ----------- | +| slot | uint256 | undefined | ### AuctionNotClosed - - ```solidity title="Solidity" error AuctionNotClosed(uint256 slot) ``` - - #### Parameters -| Name | Type | Description | -|---|---|---| -| slot | uint256 | undefined | +| Name | Type | Description | +| ---- | ------- | ----------- | +| slot | uint256 | undefined | ### AuctionNotOpen - - ```solidity title="Solidity" error AuctionNotOpen(uint256 slot) ``` - - #### Parameters -| Name | Type | Description | -|---|---|---| -| slot | uint256 | undefined | +| Name | Type | Description | +| ---- | ------- | ----------- | +| slot | uint256 | undefined | ### BidderAlreadyExists - - ```solidity title="Solidity" error BidderAlreadyExists(address bidder) ``` - - #### Parameters -| Name | Type | Description | -|---|---|---| -| bidder | address | undefined | +| Name | Type | Description | +| ------ | ------- | ----------- | +| bidder | address | undefined | ### BidderNotRegistered - - ```solidity title="Solidity" error BidderNotRegistered(address bidder) ``` - - #### Parameters -| Name | Type | Description | -|---|---|---| -| bidder | address | undefined | +| Name | Type | Description | +| ------ | ------- | ----------- | +| bidder | address | undefined | ### InsufficientFunds - - ```solidity title="Solidity" error InsufficientFunds() ``` - - - ### InvalidBidItems - - ```solidity title="Solidity" error InvalidBidItems() ``` - - - ### InvalidId - - ```solidity title="Solidity" error InvalidId() ``` - - - ### Unauthorized - - ```solidity title="Solidity" error Unauthorized() ``` - - - - - diff --git a/docs/Reference/Contracts/Bidder.md b/docs/Reference/Contracts/Bidder.md index 1818371..29a1480 100644 --- a/docs/Reference/Contracts/Bidder.md +++ b/docs/Reference/Contracts/Bidder.md @@ -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)) | - - - - diff --git a/docs/Reference/Contracts/IAccountant.md b/docs/Reference/Contracts/IAccountant.md index 897dccd..93fe752 100644 --- a/docs/Reference/Contracts/IAccountant.md +++ b/docs/Reference/Contracts/IAccountant.md @@ -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 ``` - - - - - - - - diff --git a/docs/Reference/Contracts/IERC6909.md b/docs/Reference/Contracts/IERC6909.md index dc07de9..3b04b51 100644 --- a/docs/Reference/Contracts/IERC6909.md +++ b/docs/Reference/Contracts/IERC6909.md @@ -1,13 +1,10 @@ --- -description: ERC6909 Core Interface +title: ERC6909 Core Interface --- # IERC6909.sol -> [Read code on GitHub](https://github.com/manifoldfinance/xga-auctioneer-v1/blob/maaster/src/IERC6909.sol) - - - +> [Read code on GitHub](https://github.com/manifoldfinance/xga-auctioneer-v1/blob/master/src/IERC6909.sol) ## Methods @@ -19,21 +16,18 @@ Spender allowance of an id. function allowance(address owner, address spender, uint256 id) external view returns (uint256 amount) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| owner | address | The address of the owner. | +| Name | Type | Description | +| ------- | ------- | --------------------------- | +| owner | address | The address of the owner. | | spender | address | The address of the spender. | -| id | uint256 | The id of the token. | +| id | uint256 | The id of the token. | #### Returns -| Name | Type | Description | -|---|---|---| +| Name | Type | Description | +| ------ | ------- | --------------------------- | | amount | uint256 | The allowance of the token. | ### approve @@ -44,22 +38,19 @@ Approves an amount of an id to a spender. function approve(address spender, uint256 id, uint256 amount) external nonpayable returns (bool) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| +| Name | Type | Description | +| ------- | ------- | --------------------------- | | spender | address | The address of the spender. | -| id | uint256 | The id of the token. | -| amount | uint256 | The amount of the token. | +| id | uint256 | The id of the token. | +| amount | uint256 | The amount of the token. | #### Returns | Name | Type | Description | -|---|---|---| -| _0 | bool | undefined | +| ---- | ---- | ----------- | +| \_0 | bool | undefined | ### balanceOf @@ -69,20 +60,17 @@ Owner balance of an id. function balanceOf(address owner, uint256 id) external view returns (uint256 amount) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| +| Name | Type | Description | +| ----- | ------- | ------------------------- | | owner | address | The address of the owner. | -| id | uint256 | The id of the token. | +| id | uint256 | The id of the token. | #### Returns -| Name | Type | Description | -|---|---|---| +| Name | Type | Description | +| ------ | ------- | ------------------------- | | amount | uint256 | The balance of the token. | ### isOperator @@ -93,20 +81,17 @@ Checks if a spender is approved by an owner as an operator function isOperator(address owner, address spender) external view returns (bool approved) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| owner | address | The address of the owner. | +| Name | Type | Description | +| ------- | ------- | --------------------------- | +| owner | address | The address of the owner. | | spender | address | The address of the spender. | #### Returns -| Name | Type | Description | -|---|---|---| +| Name | Type | Description | +| -------- | ---- | -------------------- | | approved | bool | The approval status. | ### setOperator @@ -117,21 +102,18 @@ Sets or removes a spender as an operator for the caller. function setOperator(address spender, bool approved) external nonpayable returns (bool) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| spender | address | The address of the spender. | -| approved | bool | The approval status. | +| Name | Type | Description | +| -------- | ------- | --------------------------- | +| spender | address | The address of the spender. | +| approved | bool | The approval status. | #### Returns | Name | Type | Description | -|---|---|---| -| _0 | bool | undefined | +| ---- | ---- | ----------- | +| \_0 | bool | undefined | ### transfer @@ -141,22 +123,19 @@ Transfers an amount of an id from the caller to a receiver. function transfer(address receiver, uint256 id, uint256 amount) external nonpayable returns (bool) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| +| Name | Type | Description | +| -------- | ------- | ---------------------------- | | receiver | address | The address of the receiver. | -| id | uint256 | The id of the token. | -| amount | uint256 | The amount of the token. | +| id | uint256 | The id of the token. | +| amount | uint256 | The amount of the token. | #### Returns | Name | Type | Description | -|---|---|---| -| _0 | bool | undefined | +| ---- | ---- | ----------- | +| \_0 | bool | undefined | ### transferFrom @@ -166,25 +145,20 @@ Transfers an amount of an id from a sender to a receiver. function transferFrom(address sender, address receiver, uint256 id, uint256 amount) external nonpayable returns (bool) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| sender | address | The address of the sender. | +| Name | Type | Description | +| -------- | ------- | ---------------------------- | +| sender | address | The address of the sender. | | receiver | address | The address of the receiver. | -| id | uint256 | The id of the token. | -| amount | uint256 | The amount of the token. | +| id | uint256 | The id of the token. | +| amount | uint256 | The amount of the token. | #### Returns | Name | Type | Description | -|---|---|---| -| _0 | bool | undefined | - - +| ---- | ---- | ----------- | +| \_0 | bool | undefined | ## Events @@ -196,17 +170,14 @@ The event emitted when an approval occurs. event Approval(address indexed owner, address indexed spender, uint256 indexed id, uint256 amount) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| owner `indexed` | address | The address of the owner. | +| Name | Type | Description | +| ----------------- | ------- | --------------------------- | +| owner `indexed` | address | The address of the owner. | | spender `indexed` | address | The address of the spender. | -| id `indexed` | uint256 | The id of the token. | -| amount | uint256 | The amount of the token. | +| id `indexed` | uint256 | The id of the token. | +| amount | uint256 | The amount of the token. | ### OperatorSet @@ -216,16 +187,13 @@ The event emitted when an operator is set. event OperatorSet(address indexed owner, address indexed spender, bool approved) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| owner `indexed` | address | The address of the owner. | +| Name | Type | Description | +| ----------------- | ------- | --------------------------- | +| owner `indexed` | address | The address of the owner. | | spender `indexed` | address | The address of the spender. | -| approved | bool | The approval status. | +| approved | bool | The approval status. | ### Transfer @@ -235,18 +203,12 @@ The event emitted when a transfer occurs. event Transfer(address caller, address indexed sender, address indexed receiver, uint256 indexed id, uint256 amount) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| caller | address | The caller of the transfer. | -| sender `indexed` | address | The address of the sender. | +| Name | Type | Description | +| ------------------ | ------- | ---------------------------- | +| caller | address | The caller of the transfer. | +| sender `indexed` | address | The address of the sender. | | receiver `indexed` | address | The address of the receiver. | -| id `indexed` | uint256 | The id of the token. | -| amount | uint256 | The amount of the token. | - - - +| id `indexed` | uint256 | The id of the token. | +| amount | uint256 | The amount of the token. | diff --git a/docs/Reference/Contracts/SettlementHouse.md b/docs/Reference/Contracts/SettlementHouse.md index 7f87914..7bf1c9a 100644 --- a/docs/Reference/Contracts/SettlementHouse.md +++ b/docs/Reference/Contracts/SettlementHouse.md @@ -3,114 +3,80 @@ description: SettlementHouse --- # SettlementHouse.sol -> [Read code on GitHub](https://github.com/manifoldfinance/xga-auctioneer-v1/blob/maaster/src/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. - + A contract for managing bundles of transactions for a futures token. ## Methods ### futuresToken - - ```solidity title="Solidity" function futuresToken() external view returns (contract IERC6909) ``` - - - - #### Returns -| Name | Type | Description | -|---|---|---| -| _0 | contract IERC6909 | undefined | +| Name | Type | Description | +| ---- | ----------------- | ----------- | +| \_0 | contract IERC6909 | undefined | ### queryBundles - - ```solidity title="Solidity" function queryBundles(uint256 slot) external view returns (struct SettlementHouse.Bundle[] slotBundles) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| slot | uint256 | undefined | +| Name | Type | Description | +| ---- | ------- | ----------- | +| slot | uint256 | undefined | #### Returns -| Name | Type | Description | -|---|---|---| -| slotBundles | SettlementHouse.Bundle[] | undefined | +| Name | Type | Description | +| ----------- | ------------------------ | ----------- | +| slotBundles | SettlementHouse.Bundle[] | undefined | ### submitBundle - - ```solidity title="Solidity" function submitBundle(uint256 slot, uint256 amountOfGas, bytes32[] bundleHashes) external nonpayable ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| slot | uint256 | undefined | -| amountOfGas | uint256 | undefined | -| bundleHashes | bytes32[] | undefined | - - +| Name | Type | Description | +| ------------ | --------- | ----------- | +| slot | uint256 | undefined | +| amountOfGas | uint256 | undefined | +| bundleHashes | bytes32[] | undefined | ## Events ### BundleSubmitted - - ```solidity title="Solidity" event BundleSubmitted(address indexed sender, uint256 indexed slot, uint256 indexed index, uint256 amountOfGas) ``` - - - #### Parameters -| Name | Type | Description | -|---|---|---| -| sender `indexed` | address | undefined | -| slot `indexed` | uint256 | undefined | -| index `indexed` | uint256 | undefined | -| amountOfGas | uint256 | undefined | - - +| Name | Type | Description | +| ---------------- | ------- | ----------- | +| sender `indexed` | address | undefined | +| slot `indexed` | uint256 | undefined | +| index `indexed` | uint256 | undefined | +| amountOfGas | uint256 | undefined | ## Errors ### Unauthorized - - ```solidity title="Solidity" error Unauthorized() ``` - - - - - diff --git a/package.json b/package.json index 0792bdd..47a645c 100644 --- a/package.json +++ b/package.json @@ -1,13 +1,13 @@ { "name": "docs-xga", - "version": "0.0.1", + "version": "0.0.2", "description": "mkdocs website for XGA", "scripts": { "build": "mkdocs build -d public", "make": "bash build.sh", "vercel": "npx vercel deploy", "fmt": "npx prettier --config .prettierrc.js --write .", - "local-sitemap": "static-sitemap-cli --base http://localhost:8000 --no-clean --root public", + "local": "npx static-sitemap-cli --base http://127.0.0.1:8000/ --no-clean --root site", "sitemap": "npx static-sitemap-cli --base https://docs.xga.com --no-clean --root public" }, "keywords": [ diff --git a/sitemap.txt b/sitemap.txt index 0fee089..f5119c6 100644 --- a/sitemap.txt +++ b/sitemap.txt @@ -1,52 +1,59 @@ -http://docs.xga.com/ -http://docs.xga.com/Clients -http://docs.xga.com/Developers -http://docs.xga.com/Legal -http://docs.xga.com/Relay -http://docs.xga.com/api -http://docs.xga.com/blog -http://docs.xga.com/tmp -http://docs.xga.com/Clients/accounting -http://docs.xga.com/Clients/clients -http://docs.xga.com/Clients/configuration -http://docs.xga.com/Clients/relay -http://docs.xga.com/Clients/requirements -http://docs.xga.com/Clients/validators -http://docs.xga.com/Developers/builders -http://docs.xga.com/Developers/interface -http://docs.xga.com/Developers/mainnet -http://docs.xga.com/Developers/payment-methods -http://docs.xga.com/Developers/sdk -http://docs.xga.com/Developers/testnet -http://docs.xga.com/Learning/Forward-Contracts -http://docs.xga.com/Learning/aup_auction -http://docs.xga.com/Learning/flashbots-comparison -http://docs.xga.com/Learning/primary-market -http://docs.xga.com/Learning/secondary-market -http://docs.xga.com/Legal/CDD -http://docs.xga.com/Legal/Content-Disclaimer -http://docs.xga.com/Legal/Disclosure-Statement -http://docs.xga.com/Reference/constants -http://docs.xga.com/Reference/contract_design -http://docs.xga.com/Reference/contract_summary -http://docs.xga.com/Reference/erc6909 -http://docs.xga.com/Reference/glossary -http://docs.xga.com/Reference/rpc-payload -http://docs.xga.com/Relay/captive-insurance -http://docs.xga.com/Rulebook/bylaws -http://docs.xga.com/Rulebook/definitions -http://docs.xga.com/Rulebook/delivery-and-settlement -http://docs.xga.com/Rulebook/general -http://docs.xga.com/Rulebook/governance -http://docs.xga.com/Rulebook/network-clearing-participants -http://docs.xga.com/Rulebook/obligations -http://docs.xga.com/Rulebook/suspension -http://docs.xga.com/api/beta-auction -http://docs.xga.com/api/bundle -http://docs.xga.com/api/relay -http://docs.xga.com/api/signature-scheme -http://docs.xga.com/newsletter/0_newsletter_index -http://docs.xga.com/newsletter/2024_05_24 -http://docs.xga.com/newsletter/2024_05_25 -http://docs.xga.com/release/stable -http://docs.xga.com/blog/posts/v0-roadmap +https://docs.xga.com/index.html +https://docs.xga.com/Clients/index.html +https://docs.xga.com/Developers/index.html +https://docs.xga.com/Legal/index.html +https://docs.xga.com/Relay/index.html +https://docs.xga.com/api/index.html +https://docs.xga.com/blog/index.html +https://docs.xga.com/tmp/index.html +https://docs.xga.com/Clients/accounting/index.html +https://docs.xga.com/Clients/clients/index.html +https://docs.xga.com/Clients/configuration/index.html +https://docs.xga.com/Clients/relay/index.html +https://docs.xga.com/Clients/requirements/index.html +https://docs.xga.com/Clients/validators/index.html +https://docs.xga.com/Developers/builders/index.html +https://docs.xga.com/Developers/interface/index.html +https://docs.xga.com/Developers/mainnet/index.html +https://docs.xga.com/Developers/payment-methods/index.html +https://docs.xga.com/Developers/sdk/index.html +https://docs.xga.com/Developers/testnet/index.html +https://docs.xga.com/Developers/walkthrough/index.html +https://docs.xga.com/Learning/Forward-Contracts/index.html +https://docs.xga.com/Learning/aup_auction/index.html +https://docs.xga.com/Learning/flashbots-comparison/index.html +https://docs.xga.com/Learning/preconfirmations/index.html +https://docs.xga.com/Learning/primary-market/index.html +https://docs.xga.com/Learning/secondary-market/index.html +https://docs.xga.com/Legal/CDD/index.html +https://docs.xga.com/Legal/Content-Disclaimer/index.html +https://docs.xga.com/Legal/Disclosure-Statement/index.html +https://docs.xga.com/Reference/constants/index.html +https://docs.xga.com/Reference/contract_design/index.html +https://docs.xga.com/Reference/contract_summary/index.html +https://docs.xga.com/Reference/erc6909/index.html +https://docs.xga.com/Reference/glossary/index.html +https://docs.xga.com/Reference/rpc-payload/index.html +https://docs.xga.com/Relay/captive-insurance/index.html +https://docs.xga.com/Rulebook/bylaws/index.html +https://docs.xga.com/Rulebook/definitions/index.html +https://docs.xga.com/Rulebook/delivery-and-settlement/index.html +https://docs.xga.com/Rulebook/general/index.html +https://docs.xga.com/Rulebook/governance/index.html +https://docs.xga.com/Rulebook/network-clearing-participants/index.html +https://docs.xga.com/Rulebook/obligations/index.html +https://docs.xga.com/Rulebook/suspension/index.html +https://docs.xga.com/api/beta-auction/index.html +https://docs.xga.com/api/bundle/index.html +https://docs.xga.com/api/relay/index.html +https://docs.xga.com/api/signature-scheme/index.html +https://docs.xga.com/newsletter/0_newsletter_index/index.html +https://docs.xga.com/newsletter/2024_05_24/index.html +https://docs.xga.com/newsletter/2024_05_25/index.html +https://docs.xga.com/release/stable/index.html +https://docs.xga.com/Reference/Contracts/Auctioneer/index.html +https://docs.xga.com/Reference/Contracts/Bidder/index.html +https://docs.xga.com/Reference/Contracts/IAccountant/index.html +https://docs.xga.com/Reference/Contracts/IERC6909/index.html +https://docs.xga.com/Reference/Contracts/SettlementHouse/index.html +https://docs.xga.com/blog/posts/v0-roadmap/index.html diff --git a/sitemap.xml b/sitemap.xml index 4874ff2..796adf4 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -1,211 +1,239 @@ - http://docs.xga.com/ - 2024-06-09T08:34:08.067Z + https://docs.xga.com/index.html + 2024-06-30T10:03:45.137Z - http://docs.xga.com/Clients - 2024-06-09T08:34:08.077Z + https://docs.xga.com/Clients/index.html + 2024-06-30T10:03:45.146Z - http://docs.xga.com/Developers - 2024-06-09T08:34:08.102Z + https://docs.xga.com/Developers/index.html + 2024-06-30T10:03:45.170Z - http://docs.xga.com/Legal - 2024-06-09T08:34:08.151Z + https://docs.xga.com/Legal/index.html + 2024-06-30T10:03:45.238Z - http://docs.xga.com/Relay - 2024-06-09T08:34:08.183Z + https://docs.xga.com/Relay/index.html + 2024-06-30T10:03:45.315Z - http://docs.xga.com/api - 2024-06-09T08:34:08.207Z + https://docs.xga.com/api/index.html + 2024-06-30T10:03:45.338Z - http://docs.xga.com/blog - 2024-06-09T08:34:08.348Z + https://docs.xga.com/blog/index.html + 2024-06-30T10:03:45.474Z - http://docs.xga.com/tmp - 2024-06-09T08:34:08.073Z + https://docs.xga.com/tmp/index.html + 2024-06-30T10:03:45.142Z - http://docs.xga.com/Clients/accounting - 2024-06-09T08:34:08.080Z + https://docs.xga.com/Clients/accounting/index.html + 2024-06-30T10:03:45.149Z - http://docs.xga.com/Clients/clients - 2024-06-09T08:34:08.083Z + https://docs.xga.com/Clients/clients/index.html + 2024-06-30T10:03:45.152Z - http://docs.xga.com/Clients/configuration - 2024-06-09T08:34:08.088Z + https://docs.xga.com/Clients/configuration/index.html + 2024-06-30T10:03:45.157Z - http://docs.xga.com/Clients/relay - 2024-06-09T08:34:08.091Z + https://docs.xga.com/Clients/relay/index.html + 2024-06-30T10:03:45.159Z - http://docs.xga.com/Clients/requirements - 2024-06-09T08:34:08.096Z + https://docs.xga.com/Clients/requirements/index.html + 2024-06-30T10:03:45.164Z - http://docs.xga.com/Clients/validators - 2024-06-09T08:34:08.099Z + https://docs.xga.com/Clients/validators/index.html + 2024-06-30T10:03:45.167Z - http://docs.xga.com/Developers/builders - 2024-06-09T08:34:08.106Z + https://docs.xga.com/Developers/builders/index.html + 2024-06-30T10:03:45.175Z - http://docs.xga.com/Developers/interface - 2024-06-09T08:34:08.118Z + https://docs.xga.com/Developers/interface/index.html + 2024-06-30T10:03:45.186Z - http://docs.xga.com/Developers/mainnet - 2024-06-09T08:34:08.121Z + https://docs.xga.com/Developers/mainnet/index.html + 2024-06-30T10:03:45.189Z - http://docs.xga.com/Developers/payment-methods - 2024-06-09T08:34:08.123Z + https://docs.xga.com/Developers/payment-methods/index.html + 2024-06-30T10:03:45.191Z - http://docs.xga.com/Developers/sdk - 2024-06-09T08:34:08.132Z + https://docs.xga.com/Developers/sdk/index.html + 2024-06-30T10:03:45.200Z - http://docs.xga.com/Developers/testnet - 2024-06-09T08:34:08.135Z + https://docs.xga.com/Developers/testnet/index.html + 2024-06-30T10:03:45.203Z - http://docs.xga.com/Learning/Forward-Contracts - 2024-06-09T08:34:08.138Z + https://docs.xga.com/Developers/walkthrough/index.html + 2024-06-30T10:03:45.220Z - http://docs.xga.com/Learning/aup_auction - 2024-06-09T08:34:08.141Z + https://docs.xga.com/Learning/Forward-Contracts/index.html + 2024-06-30T10:03:45.222Z - http://docs.xga.com/Learning/flashbots-comparison - 2024-06-09T08:34:08.144Z + https://docs.xga.com/Learning/aup_auction/index.html + 2024-06-30T10:03:45.225Z - http://docs.xga.com/Learning/primary-market - 2024-06-09T08:34:08.146Z + https://docs.xga.com/Learning/flashbots-comparison/index.html + 2024-06-30T10:03:45.228Z - http://docs.xga.com/Learning/secondary-market - 2024-06-09T08:34:08.148Z + https://docs.xga.com/Learning/preconfirmations/index.html + 2024-06-30T10:03:45.231Z - http://docs.xga.com/Legal/CDD - 2024-06-09T08:34:08.153Z + https://docs.xga.com/Learning/primary-market/index.html + 2024-06-30T10:03:45.234Z - http://docs.xga.com/Legal/Content-Disclaimer - 2024-06-09T08:34:08.155Z + https://docs.xga.com/Learning/secondary-market/index.html + 2024-06-30T10:03:45.236Z - http://docs.xga.com/Legal/Disclosure-Statement - 2024-06-09T08:34:08.157Z + https://docs.xga.com/Legal/CDD/index.html + 2024-06-30T10:03:45.240Z - http://docs.xga.com/Reference/constants - 2024-06-09T08:34:08.162Z + https://docs.xga.com/Legal/Content-Disclaimer/index.html + 2024-06-30T10:03:45.242Z - http://docs.xga.com/Reference/contract_design - 2024-06-09T08:34:08.164Z + https://docs.xga.com/Legal/Disclosure-Statement/index.html + 2024-06-30T10:03:45.244Z - http://docs.xga.com/Reference/contract_summary - 2024-06-09T08:34:08.167Z + https://docs.xga.com/Reference/constants/index.html + 2024-06-30T10:03:45.249Z - http://docs.xga.com/Reference/erc6909 - 2024-06-09T08:34:08.175Z + https://docs.xga.com/Reference/contract_design/index.html + 2024-06-30T10:03:45.251Z - http://docs.xga.com/Reference/glossary - 2024-06-09T08:34:08.178Z + https://docs.xga.com/Reference/contract_summary/index.html + 2024-06-30T10:03:45.254Z - http://docs.xga.com/Reference/rpc-payload - 2024-06-09T08:34:08.180Z + https://docs.xga.com/Reference/erc6909/index.html + 2024-06-30T10:03:45.262Z - http://docs.xga.com/Relay/captive-insurance - 2024-06-09T08:34:08.188Z + https://docs.xga.com/Reference/glossary/index.html + 2024-06-30T10:03:45.265Z - http://docs.xga.com/Rulebook/bylaws - 2024-06-09T08:34:08.190Z + https://docs.xga.com/Reference/rpc-payload/index.html + 2024-06-30T10:03:45.267Z - http://docs.xga.com/Rulebook/definitions - 2024-06-09T08:34:08.192Z + https://docs.xga.com/Relay/captive-insurance/index.html + 2024-06-30T10:03:45.319Z - http://docs.xga.com/Rulebook/delivery-and-settlement - 2024-06-09T08:34:08.194Z + https://docs.xga.com/Rulebook/bylaws/index.html + 2024-06-30T10:03:45.321Z - http://docs.xga.com/Rulebook/general - 2024-06-09T08:34:08.196Z + https://docs.xga.com/Rulebook/definitions/index.html + 2024-06-30T10:03:45.323Z - http://docs.xga.com/Rulebook/governance - 2024-06-09T08:34:08.197Z + https://docs.xga.com/Rulebook/delivery-and-settlement/index.html + 2024-06-30T10:03:45.325Z - http://docs.xga.com/Rulebook/network-clearing-participants - 2024-06-09T08:34:08.200Z + https://docs.xga.com/Rulebook/general/index.html + 2024-06-30T10:03:45.327Z - http://docs.xga.com/Rulebook/obligations - 2024-06-09T08:34:08.202Z + https://docs.xga.com/Rulebook/governance/index.html + 2024-06-30T10:03:45.329Z - http://docs.xga.com/Rulebook/suspension - 2024-06-09T08:34:08.204Z + https://docs.xga.com/Rulebook/network-clearing-participants/index.html + 2024-06-30T10:03:45.331Z - http://docs.xga.com/api/beta-auction - 2024-06-09T08:34:08.219Z + https://docs.xga.com/Rulebook/obligations/index.html + 2024-06-30T10:03:45.333Z - http://docs.xga.com/api/bundle - 2024-06-09T08:34:08.236Z + https://docs.xga.com/Rulebook/suspension/index.html + 2024-06-30T10:03:45.334Z - http://docs.xga.com/api/relay - 2024-06-09T08:34:08.343Z + https://docs.xga.com/api/beta-auction/index.html + 2024-06-30T10:03:45.349Z - http://docs.xga.com/api/signature-scheme - 2024-06-09T08:34:08.346Z + https://docs.xga.com/api/bundle/index.html + 2024-06-30T10:03:45.365Z - http://docs.xga.com/newsletter/0_newsletter_index - 2024-06-09T08:34:08.353Z + https://docs.xga.com/api/relay/index.html + 2024-06-30T10:03:45.468Z - http://docs.xga.com/newsletter/2024_05_24 - 2024-06-09T08:34:08.355Z + https://docs.xga.com/api/signature-scheme/index.html + 2024-06-30T10:03:45.473Z - http://docs.xga.com/newsletter/2024_05_25 - 2024-06-09T08:34:08.357Z + https://docs.xga.com/newsletter/0_newsletter_index/index.html + 2024-06-30T10:03:45.479Z - http://docs.xga.com/release/stable - 2024-06-09T08:34:08.359Z + https://docs.xga.com/newsletter/2024_05_24/index.html + 2024-06-30T10:03:45.481Z - http://docs.xga.com/blog/posts/v0-roadmap - 2024-06-09T08:34:08.351Z + https://docs.xga.com/newsletter/2024_05_25/index.html + 2024-06-30T10:03:45.483Z + + + https://docs.xga.com/release/stable/index.html + 2024-06-30T10:03:45.484Z + + + https://docs.xga.com/Reference/Contracts/Auctioneer/index.html + 2024-06-30T10:03:45.294Z + + + https://docs.xga.com/Reference/Contracts/Bidder/index.html + 2024-06-30T10:03:45.297Z + + + https://docs.xga.com/Reference/Contracts/IAccountant/index.html + 2024-06-30T10:03:45.300Z + + + https://docs.xga.com/Reference/Contracts/IERC6909/index.html + 2024-06-30T10:03:45.308Z + + + https://docs.xga.com/Reference/Contracts/SettlementHouse/index.html + 2024-06-30T10:03:45.312Z + + + https://docs.xga.com/blog/posts/v0-roadmap/index.html + 2024-06-30T10:03:45.477Z diff --git a/sitemap.xml.gz b/sitemap.xml.gz index 0e2e38d..34ca6c5 100644 Binary files a/sitemap.xml.gz and b/sitemap.xml.gz differ