Skip to content

Commit eba08e7

Browse files
committed
Clean up subgraphs section based on Sam's feedback
1 parent 8679c16 commit eba08e7

File tree

3 files changed

+23
-14
lines changed

3 files changed

+23
-14
lines changed

docs/subgraphs.mdx docs/fnd-subgraph.mdx

+18-9
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
id: subgraphs
3-
title: Subgraphs
4-
sidebar_label: Subgraphs
5-
slug: /subgraphs
2+
id: fnd-subgraph
3+
title: FND Subgraph
4+
sidebar_label: FND Subgraph
5+
slug: /fnd-subgraph
66
---
77

88
import Tabs from '@theme/Tabs';
@@ -12,6 +12,10 @@ All of the data from the Foundation protocol is public and free to use.
1212

1313
You can build your own UI with whatever features you would like using the same data.
1414

15+
There are "subgraphs" for Foundation data on the Ethereum mainnet and the Goerli testnet.
16+
17+
These were built using [The Graph](https://thegraph.com/). The Graph uses [GraphQL](https://graphql.org/), a query language for data.
18+
1519
### 🌐 [mainnet subgraph](https://thegraph.com/explorer/subgraph/f8n/fnd) 🌐
1620

1721
Our mainnet subgraph contains all the info you can find on [foundation.app](https://foundation.app). (We use it too!)
@@ -37,10 +41,8 @@ import ExampleResult from './queries/example/result.mdx';
3741
<TabItem value="result"><ExampleResult/></TabItem>
3842
</Tabs>
3943

40-
## Note
41-
42-
:::note
43-
If you learn best by checking out examples, we recommend jumping ahead to the [examples](subgraphs-examples) section. If you learn better by starting with the fundamentals and building from there, please read on below.
44+
:::tip
45+
If you learn best by checking out examples, we recommend jumping ahead to the [examples](subgraph-examples) section. If you learn better by starting with the fundamentals and building from there, please read on below.
4446
:::
4547

4648
## Table structure
@@ -119,12 +121,19 @@ All individual bids placed on Foundation.
119121

120122
Currently the only auction model we support is Reserve Auctions. More will be added in the future.
121123

122-
When an NFT is initially listed, it's state in the Foundation subgraph will be `nftMarketAuction.status=Open` with `nftMarketAuction.highestBid=null`.
124+
### Initially listed
123125

126+
When an NFT is initially listed, its state in the Foundation subgraph will be `nftMarketAuction.status=Open` with `nftMarketAuction.highestBid=null`.
127+
128+
### Reserve price met
124129
Once the reserve price is met, `nftMarketAuction.highestBid!=null`.
125130

131+
### End time
126132
Anyone can place bids on auctions until the end time has passed. So `nftMarketAuction.status=Open and nftMarketAuction.dateEnding<=nowInSeconds` means an auction is accepting bids and `nftMarketAuction.status=Open and nftMarketAuction.dateEnding>nowInSeconds` indicates that the auction countdown has completed and bids are no longer being accepted.
127133

134+
Note that the end time for an auction may change, because placing a bit in the last 15 minutes resets the remaining time to 15 minutes to prevent sniping.
135+
136+
### NFT claimed
128137
Since Ethereum requires a user-initiated transaction in order to react to the changing of time, users must claim their NFT after an auction has closed. Technically anyone can do this, but through the foundation.app UI we encourage the bidder to do so (and the foundation.app UI will allow sellers to complete the process as well). But it's on Ethereum, so anyone is free to do it if they please.
129138

130139
Once the NFT has been claimed, the auction status changes to `nftMarketAuction.status=Finalized`. `Finalized` indicates that the NFT has been transferred to the auction winner and the seller has received funds from the sale.

docs/subgraphs-examples.mdx docs/subgraph-examples.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
id: subgraphs-examples
3-
title: Subgraphs Examples
4-
sidebar_label: Subgraphs Examples
5-
slug: /subgraphs-examples
2+
id: subgraph-examples
3+
title: Subgraph Examples
4+
sidebar_label: Subgraph Examples
5+
slug: /subgraph-examples
66
---
77

88
import Tabs from '@theme/Tabs';

sidebars.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
module.exports = {
22
someSidebar: {
3-
Foundation: ['intro', 'subgraphs', 'subgraphs-examples', 'contracts', 'fnd.js', 'nfte', 'community-proposals'],
3+
Foundation: ['intro', 'fnd-subgraph', 'subgraph-examples', 'contracts', 'fnd.js', 'nfte', 'community-proposals'],
44
},
55
};

0 commit comments

Comments
 (0)