diff --git a/resources/subgraphs/mainnet-voting-entities.md b/resources/subgraphs/mainnet-voting-entities.md index debc866..9493d15 100644 --- a/resources/subgraphs/mainnet-voting-entities.md +++ b/resources/subgraphs/mainnet-voting-entities.md @@ -22,10 +22,10 @@ Description: | Field | Type | Description | | --------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| id | ID! | Utility entity that links data from a single ethereum address. Id of the entity is the ethereum address itself | +| id | ID! | Utility entity that links data from a single Ethereum address. Id of the entity is the Ethereum address itself | | address | Bytes! | | | countReveals | BigInt | Number of price requests that this user has revealed a vote for, and therefore participated in as a voter | -| countRetrievals | BigInt | Provides a lower-bound on # of votes that user has correctly voted for. User may not have retrieved rewards for all of their correct votes | +| countRetrievals | BigInt | Provides a lower bound on # of votes that user has correctly voted for. User may not have retrieved rewards for all of their correct votes | | votesCommited | Int! | | ## Collateral @@ -59,7 +59,7 @@ Description: | --------------------- | ------------------------------------------ | ------------------------------------------------------------------ | | id | ID! | ID is the PriceIdentifier ID + the timestamp | | isResolved | Boolean! | Depicts whether the request has been resolved | -| Price | BigInt | Price resolved for this request | +| price | BigInt | Price resolved for this request | | latestRound | PriceRequestRound | PriceRequestRound entity corresponding to the last round of voting | | time | BigInt! | | | identifier | PriceIdentifier! | PriceIdentifier for the request | @@ -84,26 +84,26 @@ Description: | ancillaryData | String | | | time | BigInt! | | | snapshotId | BigInt | | -| votorsAmount | BigDecimal! | Total amount of users who voted on this round | +| votersAmount | BigDecimal! | Total amount of users who voted on this round | | votersClaimedAmount | BigDecimal! | Total amount of users who claimed rewards on this round | | totalVotesRevealed | BigDecimal! | | | totaRewardsClaimed | BigDecimal! | | | totalSupplyAtSnapshot | BigDecimal | | | tokenVoteParticipationRatio | BigDecimal | Ratio of the total supply of tokens that were weighted on this vote | | tokenVoteParticipationPercentage | BigDecimal | Ratio of correct voters over total voters on this price request | -| votorsEligibleForRewardRatio | BigDecimal | Ratio of correct voters over total voters on this price request | +| votersEligibleForRewardRatio | BigDecimal | Ratio of correct voters over total voters on this price request | | votersEligibleForRewardsPercentage | BigDecimal | Percentage of correct voters over total voters on this price request | | votersClaimRatio | BigDecimal | Ratio of correct voters who claimed their rewards | | votersClaimedPercentage | BigDecimal | Percentage of correct voters who claimed their rewards | | tokensClaimedRatio | BigDecimal | Ratio of rewards claimed over total supply of voting token | | tokensClaimedPercentage | BigDecimal | Percentage of rewards claimed over total supply of voting token | -| getPercentageRaw | BigDecimal | gatPercentage expressed exactly as in the contract. 1 = 100% | -| getPercentage | BigDecimal | gatPercentage expressed as a percentage value | +| getPercentageRaw | BigDecimal | getPercentage expressed exactly as in the contract. 1 = 100% | +| getPercentage | BigDecimal | getPercentage expressed as a percentage value | | inflationRateRaw | BigDecimal | inflationRate expressed exactly as in the contract. 1 = 100% | | inflationRate | BigDecimal | inflationRate expressed as a percentage value | | winnerGroup | VoterGroup | | | committedVotes | [`CommittedVote!`](#committedvote) | | -| revealVotes | [`RevealedVote!`](#revealedvote) | | +| revealedVotes | [`RevealedVote!`](#revealedvote) | | | groups | [`VoterGroup!`](#votergroup) | | | rewardsClaimed | [`RewardsClaimed!`](#rewardsclaimed) | | @@ -128,7 +128,7 @@ Description: | Field | Type | Description | | ------------- | ------------------ | ---------------------------------------------------------------------------------------- | -| id | ID! | Commited votes won't show the price until a reveal happens and a RevealedVote is created | +| id | ID! | Committed votes won't show the price until a reveal happens and a RevealedVote is created | | identifier | PriceIdentifier! | | | ancillaryData | String | | | request | PriceRequest! | | diff --git a/resources/subgraphs/queries.md b/resources/subgraphs/queries.md index ab02e90..59d4422 100644 --- a/resources/subgraphs/queries.md +++ b/resources/subgraphs/queries.md @@ -5,7 +5,7 @@ title: Sample Queries ## Sample Queries -Below are some sample queries you can use to gather information from the Uma contracts. +Below are some sample queries you can use to gather information from UMA contracts. You can build your own queries using a [GraphQL Explorer](https://graphiql-online.com/graphiql) and enter your endpoint to limit the data to exactly what you need. diff --git a/resources/subgraphs/subgraph-data.md b/resources/subgraphs/subgraph-data.md index 7c9e2af..8e17661 100644 --- a/resources/subgraphs/subgraph-data.md +++ b/resources/subgraphs/subgraph-data.md @@ -3,11 +3,11 @@ sidebar_position: 1 title: Subgraph Data Introduction --- -# Uma Subgraph Introduction +# UMA Subgraph Introduction -This section explains the UMA Subgraph and how to interact with it. The UMA subgraph indexes data from the UMA contracts over time. It organizes data about tokenholders, contracts, DVM requests, and more. The subgraph updates any time a transaction is made on UMA. The subgraph runs on [The Graph](https://thegraph.com/) protocol’s hosted service and can be openly queried. +This section explains the UMA subgraph and how to interact with it. The UMA subgraph indexes data from UMA contracts over time. It organizes data about tokenholders, contracts, DVM requests, voting, and more. The subgraph updates any time a transaction is made on UMA. The subgraph runs on [The Graph](https://thegraph.com/) protocol’s hosted service and can be openly queried. -Uma has a GraphQL API Endpoint hosted by [The Graph](https://thegraph.com/docs/about/introduction#what-the-graph-is) called a subgraph for indexing and organizing data from the Snapshot smart contracts. The schema of GraphQL elements available is defined in [`/schema.graphql` ](https://github.com/balancer-labs/balancer-subgraph-v2/blob/master/schema.graphql) +UMA has a GraphQL API Endpoint hosted by [The Graph](https://thegraph.com/docs/about/introduction#what-the-graph-is) called a subgraph for indexing and organizing data from the smart contracts. The schema of GraphQL elements available is defined in [`the subgraphs repo` ](https://github.com/UMAprotocol/subgraphs/). ## Ethereum Mainnet