Entities
Reference UNCX V3 subgraph entities and fields for lockers, position managers, pool aggregates, reserves and liquidity positions.
Entities
Section titled “Entities ”Locker
Section titled “Locker ”Locker entity represents the UNCX liquidity locker.
| Field | Type | Description |
|---|---|---|
| id | ID! | Locker address |
Manager
Section titled “Manager ”Manager represents the Uniswap V3 NFT position manager. It is used to control the positions within the liquidity pools.
| Field | Type | Description |
|---|---|---|
| id | ID! | Position manager address |
Aggregate
Section titled “Aggregate ”Aggregate entity represents the aggregate of all pools added without the fee tier. It aggregates reserves and locks for a given combination of manager, token0, and token1.
| Field | Type | Description |
|---|---|---|
| id | ID! | Manager + token0 + token1 |
| token0 | Token! | Token0 address |
| token1 | Token! | Token1 address |
| manager | Manager! | Position manager address |
| pools | [Reserve!]! | All aggregated reserves |
| locks | [Lock!]! | All aggregated locks |
Reserve
Section titled “Reserve ”Reserve entity represents the locked liquidity reserve for a specific pool.
| Field | Type | Description |
|---|---|---|
| id | ID! | Pool address |
| liquidity | BigInt! | Locked liquidity reserve |
| mainToken | Token! | Main token |
| baseToken | Token! | Core tokens such as stablecoins, ETH, BNB etc. |
| pool | Pool! | Pool object |
| aggregate | Aggregate! | Pool aggregate |
| manager | Manager! | Position manager address |
| locks | [Lock!]! | All locks in a reserve |
| lockIds | [String!]! | Lock IDs for a reserve |
| locker | Locker! | Locker address |
Pool entity represents a liquidity pool with specific tokens and fee tier. It holds the state of a liquidity pool.
| Field | Type | Description |
|---|---|---|
| id | ID! | Pool address |
| feeTier | BigInt! | Pool fee tier |
| token0 | Token! | Token0 address |
| token1 | Token! | Token1 address |
| amount0 | BigInt! | Amount of token0 stored in the pool |
| amount1 | BigInt! | Amount of token1 stored in the pool |
| price0 | BigDecimal | Relative price of token0 |
| price1 | BigDecimal | Relative price of token1 |
| activeLiquidity | BigInt! | Total in-range liquidity |
| sqrtPriceX96 | BigInt! | sqrtPriceX96, used for calculations |
| currentTick | BigInt! | Current pool tick |
| positionIds | [String!]! | All positions IDs |
| positions | [Position!]! | All positions |
| reserve | Reserve! | Reserve |
| aggregate | Aggregate! | Aggregator |
| manager | Manager! | Position manager |
The Lock entity represents a specific lock in the liquidity pool, which is characterized by its unique ID. It contains all the necessary details about the lock such as the locked liquidity, the tokens involved, lock owner, fee collection addresses, and unlock date among other details.
| Field | Type | Description |
|---|---|---|
| id | ID! | Locker address + lock id |
| lockId | String! | Lock id |
| mainToken | Token! | Main token |
| baseToken | Token! | Core tokens such as stablecoins, ETH, BNB etc. |
| lockedLiquidity | BigInt! | Liquidity stored in a lock (non-withdrawable) |
| lockedAmount0 | BigInt! | Amount0 stored in a lock (non-withdrawable) |
| lockedAmount1 | BigInt! | Amount1 stored in a lock (non-withdrawable) |
| lockedCoreUSD | BigDecimal! | USD value of the core asset locked (non-withdrawable) |
| lockedPercent | BigDecimal! | Locked percent of the active liquidity (non-withdrawable) |
| owner | Wallet! | Lock owner address |
| collector | Wallet! | Fee collection address |
| additionalCollector | Wallet! | Additional fee collection address |
| unlockDate | BigInt! | Unlock date as a timestamp |
| position | Position! | NFT position (manager + NFT id) |
| reserve | Reserve! | Pool address |
| aggregate | Aggregate! | Aggregator |
| manager | Manager! | Position manager |
| locker | Locker! | Locker address |
| blockNumber | BigInt! | Last update block |
| timestamp | BigInt! | Last update timestamp |
| lockEvents | [LockEvent!]! | List all lock events for a lock |
| withdrawEvents | [WithdrawEvent!]! | List all withdraw events for a lock |
| increaseEvents | [IncreaseEvent!]! | List all increase liquidity events for a lock |
| relockEvents | [RelockEvent!]! | List all relock events for a lock |
| transferOwnershipEvents | [TransferOwnershipEvent!]! | List all transfer events for a lock |
| migrateEvents | [MigrateEvent!]! | List all migration events for a lock |
Position
Section titled “Position ”Position entity represents a specific NFT position in the liquidity pool. Each position is identified by a unique ID and has all the necessary details such as liquidity, tokens involved, ticks and associated lock.
| Field | Type | Description |
|---|---|---|
| id | ID! | Position Manager + NFT ID |
| nftId | String! | ID of the non-fungible position |
| token0 | Token! | Token0 address |
| token1 | Token! | Token1 address |
| lowerTick | BigInt! | Lower tick of the position |
| upperTick | BigInt! | Upper tick of the position |
| liquidity | BigInt! | Total position liquidity |
| amount0 | BigInt! | Amount of token0 stored in the position |
| amount1 | BigInt! | Amount of token1 stored in the position |
| coreTotalUSD | BigDecimal! | Core token USD TVL stored in the position |
| lock | Lock! | Lock nonce |
| pool | Pool! | Pool address |
| aggregate | Aggregate! | Aggregator |
| manager | Manager! | Position manager |
Token
Section titled “Token ”Token entity represents a specific token. It includes details such as the name, symbol, decimals and its use in reserves.
| Field | Type | Description |
|---|---|---|
| id | ID! | Smart contract address of the token |
| name | String! | Name of the token |
| symbol | String! | Symbol of the token |
| decimals | Int! | The number of decimal places this token uses |
| tvlUSD | BigDecimal! | Dollar value locked in this token across all pools |
| lockedUSD | BigDecimal! | Dollar value locked in this token across all pools (non-withdrawable) |
| mainTokenReserves | [Reserve!]! | All reserves where this token is the main token |
| baseTokenReserves | [Reserve!]! | All reserves where this token is the core token |
| baseTokens | [BaseToken!]! | Check if token is a base token |
| blockNumber | BigInt! | Last update block |
| timestamp | BigInt! | Last update timestamp |
BaseToken
Section titled “BaseToken ”BaseToken entity represents a specific token that is considered as a base asset. It includes the price and last updated timestamp.
| Field | Type | Description |
|---|---|---|
| id | ID! | Smart contract address of the token |
| token | Token! | Token data |
| basePrice | BigInt! | If asset is a core liquid asset, set its price |
| lastBaseUpdatedTimestamp | BigInt! | Timestamp for updating base price |
Wallet
Section titled “Wallet ”Wallet entity represents an account or a wallet on the blockchain. It includes information on locks and collectors.
| Field | Type | Description |
|---|---|---|
| id | ID! | Account address |
| locks | [Lock!]! | Associated locks |
| collectors | [Lock!]! | Associated fee collectors |
| additionalCollectors | [Lock!]! | Associated additional collectors |
Events
Section titled “Events ”EventCollection
Section titled “EventCollection ”This entity primarily acts as an aggregator for different types of events and contains locker address.
| Field | Type | Description |
|---|---|---|
| id | ID | Locker Address |
| lockEvents | [LockEvent!] | Collection of lock events |
| lockEventsNumber | BigInt | Total number of lock events |
| withdrawEvents | [WithdrawEvent!] | Collection of withdrawal events |
| withdrawEventsNumber | BigInt | Total number of withdrawal events |
| increaseEvents | [IncreaseEvent!] | Collection of increase events |
| increaseEventsNumber | BigInt | Total number of increase events |
| relockEvents | [RelockEvent!] | Collection of relock events |
| relockEventsNumber | BigInt | Total number of relock events |
| transferOwnershipEvents | [TransferOwnershipEvent!] | Collection of ownership transfer events |
| transferOwnershipEventsNumber | BigInt | Total number of ownership transfer events |
| migrateEvents | [MigrateEvent!] | Collection of migration events |
| migrateEventsNumber | BigInt | Total number of migration events |
| collectorEvents | [CollectorEvent!] | Collection of collector events |
| collectorEventsNumber | BigInt | Total number of collector events |
| additionalCollectorEvents | [AdditionalCollectorEvent!] | Collection of additional collector events |
| additionalCollectorEventsNumber | BigInt | Total number of additional collector events |
LockEvent
Section titled “LockEvent ”This entity records all the information related to the locking event at a time of a transaction.
| Field | Type | Description |
|---|---|---|
| id | ID | Locker address + event index |
| lockId | String | Lock ID |
| mainToken | Token | Main token (does not follow token0 / token1 contract order) |
| baseToken | Token | Core tokens such as stablecoins, ETH, BNB etc. (does not follow token0 / token1 contract order) |
| lockedLiquidity | BigInt | Liquidity stored in a lock (non withdrawable) |
| lockedAmount0 | BigInt | Amount0 stored in a lock (non withdrawable) |
| lockedAmount1 | BigInt | Amount1 stored in a lock (non withdrawable) |
| lockedCoreUSD | BigDecimal | USD value of the core asset locked (non withdrawable) |
| lockedPercent | BigDecimal | Locked percent of the active liquidity (non withdrawable) |
| owner | Wallet | Lock owner address |
| collector | Wallet | Fee collection address |
| additionalCollector | Wallet | Additional fee collection address |
| position | Position | NFT position (manager + NFT id) |
| lock | Lock | Lock ID |
| reserve | Reserve | Pool address |
| aggregate | Aggregate | Aggregator |
| manager | Manager | Position manager |
| locker | Locker | Locker address |
| unlockDate | BigInt | Unlock date as a timestamp |
| blockNumber | BigInt | Event block |
| timestamp | BigInt | Event timestamp |
| transaction | Bytes | Transaction hash |
| eventsCollection | EventCollection | Collection reference |
WithdrawEvent
Section titled “WithdrawEvent ”This entity represents the event of a withdrawal action of the lock’s liquidity. It has various attributes related to the withdrawal, such as the liquidity withdrawn and the address of the owner.
| Field | Type | Description |
|---|---|---|
| id | ID | Locker address + event index |
| lockId | String | Lock ID |
| mainToken | Token | Main token |
| baseToken | Token | Core tokens like stablecoins, ETH, BNB |
| withdrawnLiquidity | BigInt | Liquidity withdrawn from a lock |
| withdrawnAmount0 | BigInt | Amount0 withdrawn from a lock |
| withdrawnAmount1 | BigInt | Amount1 withdrawn from a lock |
| withdrawnCoreUSD | BigDecimal | USD value of the core asset withdrawn |
| withdrawnPercent | BigDecimal | Withdrawn percent of the active liquidity |
| owner | Wallet | Lock owner address |
| collector | Wallet | Fee collection address |
| additionalCollector | Wallet | Additional fee collection address |
| position | Position | NFT position |
| lock | Lock | Lock ID |
| reserve | Reserve | Pool address |
| aggregate | Aggregate | Aggregator |
| manager | Manager | Position manager |
| locker | Locker | Locker address |
| unlockDate | BigInt | Unlock date as a timestamp |
| blockNumber | BigInt | Event block |
| timestamp | BigInt | Event timestamp |
| transaction | Bytes | Transaction hash |
| eventsCollection | EventCollection | Collection reference |
IncreaseEvent
Section titled “IncreaseEvent ”The IncreaseEvent is an entity representing an event where the amount of liquidity locked in a specific lock is increased. This includes details about the locked funds before and after the increase, and the event details such as timestamp and transaction.
| Field | Type | Description |
|---|---|---|
| id | ID | Locker address + event index |
| lockId | String | Lock ID |
| mainToken | Token | Main token (does not follow token0 / token1 contract order) |
| baseToken | Token | Core tokens such as stablecoins, ETH, BNB etc. (does not follow token0 / token1 contract order) |
| lockedLiquidityBefore | BigInt | Liquidity stored before increase in a lock (non withdrawable) |
| lockedAmount0Before | BigInt | amount0 stored before increase in a lock (non withdrawable) |
| lockedAmount1Before | BigInt | amount1 stored before increase in a lock (non withdrawable) |
| lockedCoreUSDBefore | BigDecimal | USD value of the core asset locked before increase (non withdrawable) |
| lockedPercentBefore | BigDecimal | Locked percent of the active liquidity before increase (non withdrawable) |
| lockedLiquidityAfter | BigInt | Liquidity stored in a lock after increase (non withdrawable) |
| lockedAmount0After | BigInt | amount0 stored in a lock after increase (non withdrawable) |
| lockedAmount1After | BigInt | amount1 stored in a lock after increase (non withdrawable) |
| lockedCoreUSDAfter | BigDecimal | USD value of the core asset locked after increase (non withdrawable) |
| lockedPercentAfter | BigDecimal | Locked percent of the active liquidity after increase (non withdrawable) |
| owner | Wallet | Lock owner address |
| collector | Wallet | Fee collection address |
| additionalCollector | Wallet | Additional fee collection address |
| position | Position | NFT position (manager + NFT id) |
| lock | Lock | Lock ID |
| reserve | Reserve | Pool address |
| aggregate | Aggregate | Aggregator |
| manager | Manager | Position manager |
| locker | Locker | Locker address |
| unlockDate | BigInt | Unlock date as a timestamp |
| blockNumber | BigInt | Event block |
| timestamp | BigInt | Event timestamp |
| transaction | Bytes | Transaction hash |
| eventsCollection | EventCollection | Collection reference |
RelockEvent
Section titled “RelockEvent ”The RelockEvent entity represents an event where the unlock date is pushed further back. It provides information about the locked liquidity, the details of the tokens involved, and event specifics like timestamp and transaction.
| Field | Type | Description |
|---|---|---|
| id | ID | Locker address + event index |
| lockId | String | Lock ID |
| mainToken | Token | Main token (does not follow token0 / token1 contract order) |
| baseToken | Token | Core tokens such as stablecoins, ETH, BNB etc. (does not follow token0 / token1 contract order) |
| lockedLiquidity | BigInt | Liquidity stored in a lock (non withdrawable) |
| lockedAmount0 | BigInt | Amount0 stored in a lock (non withdrawable) |
| lockedAmount1 | BigInt | Amount1 stored in a lock (non withdrawable) |
| lockedCoreUSD | BigDecimal | USD value of the core asset locked (non withdrawable) |
| lockedPercent | BigDecimal | Locked percent of the active liquidity (non withdrawable) |
| owner | Wallet | Lock owner address transfer |
| collector | Wallet | Fee collection address |
| additionalCollector | Wallet | Additional fee collection address |
| position | Position | NFT position (manager + NFT id) |
| lock | Lock | Lock ID |
| reserve | Reserve | Pool address |
| aggregate | Aggregate | Aggregator |
| manager | Manager | Position manager |
| locker | Locker | Locker address |
| unlockDateBefore | BigInt | Old unlock date as a timestamp |
| unlockDateAfter | BigInt | New unlock date as a timestamp |
| blockNumber | BigInt | Event block |
| timestamp | BigInt | Event timestamp |
| transaction | Bytes | Transaction hash |
| eventsCollection | EventCollection | Collection reference |
TransferOwnershipEvent
Section titled “TransferOwnershipEvent ”The TransferOwnershipEvent entity represents an event where the ownership of a lock is transferred from one wallet to another. It provides details about the locked funds and the wallets involved in the transfer, along with event specifics such as timestamp and transaction.
| Field | Type | Description |
|---|---|---|
| id | ID | Locker address + event index |
| lockId | String | Lock ID |
| mainToken | Token | Main token (does not follow token0 / token1 contract order) |
| baseToken | Token | Core tokens such as stablecoins, ETH, BNB etc. (does not follow token0 / token1 contract order) |
| lockedLiquidity | BigInt | Liquidity stored in a lock (non withdrawable) |
| lockedAmount0 | BigInt | Amount0 stored in a lock (non withdrawable) |
| lockedAmount1 | BigInt | Amount1 stored in a lock (non withdrawable) |
| lockedCoreUSD | BigDecimal | USD value of the core asset locked (non withdrawable) |
| lockedPercent | BigDecimal | Locked percent of the active liquidity (non withdrawable) |
| ownerBefore | Wallet | Lock owner address before transfer |
| ownerAfter | Wallet | Lock owner address after transfer |
| collector | Wallet | Fee collection address |
| additionalCollector | Wallet | Additional fee collection address |
| position | Position | NFT position (manager + NFT id) |
| lock | Lock | Lock ID |
| reserve | Reserve | Pool address |
| aggregate | Aggregate | Aggregator |
| manager | Manager | Position manager |
| locker | Locker | Locker address |
| unlockDate | BigInt | Unlock date as a timestamp |
| blockNumber | BigInt | Event block |
| timestamp | BigInt | Event timestamp |
| transaction | Bytes | Transaction hash |
| eventsCollection | EventCollection | Collection reference |
MigrateEvent
Section titled “MigrateEvent ”MigrateEvent represents an event where a migration of a lock in the liquidity pool occurs. This involves moving funds from one lock to another.
| Field | Type | Description |
|---|---|---|
| id | ID! | locker address + event index |
| lockId | String! | lock id |
| mainToken | Token! | main token |
| baseToken | Token! | core tokens such as stablecoins, ETH, BNB etc. |
| lockedLiquidity | BigInt! | liquidity stored in a lock (non withdrawable) |
| lockedAmount0 | BigInt! | amount0 stored in a lock (non withdrawable) |
| lockedAmount1 | BigInt! | amount1 stored in a lock (non withdrawable) |
| lockedCoreUSD | BigDecimal! | USD value of the core asset locked (non withdrawable) |
| lockedPercent | BigDecimal! | locked percent of the active liquidity (non withdrawable) |
| owner | Wallet! | lock owner address |
| collector | Wallet! | fee collection address |
| additionalCollector | Wallet! | additional fee collection address |
| position | Position | nft position (manager + nft id) |
| lock | Lock | Lock ID |
| reserve | Reserve! | pool address |
| aggregate | Aggregate! | aggregator |
| manager | Manager! | position manager |
| locker | Locker! | locker address |
| unlockDate | BigInt! | unlock date as a timestamp |
| blockNumber | BigInt! | event block |
| timestamp | BigInt! | event timestamp |
| transaction | Bytes! | transaction hash |
| eventsCollection | EventCollection! | collection reference |
CollectorEvent
Section titled “CollectorEvent ”CollectorEvent represents an event where the fee collector of a lock changes. The fee collector is the account with the ability to initiate the fee collection process.
| Field | Type | Description |
|---|---|---|
| id | ID! | locker address + event index |
| lockId | String! | lock id |
| mainToken | Token! | main token |
| baseToken | Token! | core tokens such as stablecoins, ETH, BNB etc. |
| lockedLiquidity | BigInt! | liquidity stored in a lock (non withdrawable) |
| lockedAmount0 | BigInt! | amount0 stored in a lock (non withdrawable) |
| lockedAmount1 | BigInt! | amount1 stored in a lock (non withdrawable) |
| lockedCoreUSD | BigDecimal! | USD value of the core asset locked (non withdrawable) |
| lockedPercent | BigDecimal! | locked percent of the active liquidity (non withdrawable) |
| owner | Wallet! | lock owner address |
| collectorBefore | Wallet! | old fee collection address |
| collectorAfter | Wallet! | new fee collection address |
| additionalCollector | Wallet! | additional fee collection address |
| position | Position | nft position (manager + nft id) |
| lock | Lock | Lock ID |
| reserve | Reserve! | pool address |
| aggregate | Aggregate! | aggregator |
| manager | Manager! | position manager |
| locker | Locker! | locker address |
| unlockDate | BigInt! | unlock date as a timestamp |
| blockNumber | BigInt! | event block |
| timestamp | BigInt! | event timestamp |
| transaction | Bytes! | transaction hash |
| eventsCollection | EventCollection! | collection reference |
AdditionalCollectorEvent
Section titled “AdditionalCollectorEvent ”AdditionalCollectorEvent represents an event where the additional fee collector of a lock changes. The additional fee collector is an account granted permission to initiate the fee collection process.
| Field | Type | Description |
|---|---|---|
| lockedAmount1 | BigInt! | amount1 stored in a lock (non withdrawable) |
| lockedCoreUSD | BigDecimal! | USD value of the core asset locked (non withdrawable) |
| lockedPercent | BigDecimal! | locked percent of the active liquidity (non withdrawable) |
| owner | Wallet! | lock owner address |
| collector | Wallet! | fee collection address |
| additionalCollectorBefore | Wallet! | old additional fee collection address |
| additionalCollectorAfter | Wallet! | new additional fee collection address |
| position | Position | nft position (manager + nft id) |
| lock | Lock | Lock ID |
| reserve | Reserve! | pool address |
| aggregate | Aggregate! | aggregator |
| manager | Manager! | position manager |
| locker | Locker! | locker address |
| unlockDate | BigInt! | unlock date as a timestamp |
| blockNumber | BigInt! | event block |
| timestamp | BigInt! | event timestamp |
| transaction | Bytes! | transaction hash |
| eventsCollection | EventCollection! | collection reference |
Search
Section titled “Search ”tokenSearch
Section titled “tokenSearch ”The tokenSearch is a full-text search schema over the “Token” entity. It allows users to perform searches over the fields “symbol”, “name”, and “id”.
| name | entity | fields |
|---|---|---|
| tokenSearch | Token | symbol |
| tokenSearch | Token | name |
| tokenSearch | Token | id |
poolSearch
Section titled “poolSearch ”The poolSearch is a full-text search schema for the “Pool” entity. It allows users to find specific “Pool” entities by their unique identifiers.
| name | entity | fields |
|---|---|---|
| poolSearch | Pool | id |
lockSearch
Section titled “lockSearch ”The lockSearch is a full-text search schema over the “Lock” entity. It helps users find specific “Lock” entities by their unique “lockId”.
| name | entity | fields |
|---|---|---|
| lockSearch | Lock | lockId |
reserveSearch
Section titled “reserveSearch ”The reserveSearch is a full-text search schema designed for the “Reserve” entity. It allows users to search and find specific “Reserve” entities by their unique identifiers.
| name | entity | fields |
|---|---|---|
| reserveSearch | Reserve | id |
walletSearch
Section titled “walletSearch ”The walletSearch is a full-text search schema over the “Wallet” entity. It enables users to locate specific “Wallet” entities by their unique identifiers.
| name | entity | fields |
|---|---|---|
| walletSearch | Wallet | id |