BathToken Subgraph
An overview the BahToken subgraph's key entities, contract event handlers, and example queries for a variety of use cases.
BathToken Key Entities
The BathToken subgraph contains a collection of entities that collect and store data related to liquidity provider activity and pool utilization for market-making on the protocol's order books. Below are key entities that we believe users will find most relevant to their data needs.
LiquidityProvider Entity (ID: Wallet Address)
1
type LiquidityProvider @entity {
2
" <user adddress> "
3
id: ID!
4
" derived fields"
5
positions: [PoolPosition!]! @derivedFrom(field: "liquidityProvider")
6
deposits: [Deposit!]! @derivedFrom(field: "liquidityProvider")
7
withdraws: [Withdraw!]! @derivedFrom(field: "liquidityProvider")
8
}
Copied!
The LiquidityProvider entity acts as a single point of reference to collect all activity with Rubicon liquidity pools from a wallet's address. From within a LiquidityProvider entity, you can access the PoolPosition, Deposit, and Withdraw entities. The contract events that update these events are as follows:
Variable Updated
Function
Event Emit
Contract
LiquidityProvider.positions
LiquidityProvider.deposits
function deposit(
uint256 _amount
)
external returns (
uint256 shares
)
{
uint256 _pool = underlyingBalance();
uint256 _before = underlyingToken.balanceOf(address(this));
event LogDeposit(
uint256 depositedAmt,
IERC20 asset,
uint256 sharesReceived,
address depositor,
uint256 underlyingBalance,
uint256 outstandingAmount,
uint256 totalSupply
);
BathToken.sol
LiquidityProvider.positions
LiquidityProvider.withdraws
function withdraw(
uint256 _shares
)
external returns (
uint256 amountWithdrawn
);
event LogWithdraw(
uint256 amountWithdrawn,
IERC20 asset,
uint256 sharesWithdrawn,
address withdrawer,
uint256 fee,
address feeTo,
uint256 underlyingBalance,
uint256 outstandingAmount,
uint256 totalSupply
);
BathToken.sol
PoolPosition Entity (ID: <user address>#<pool underlying asset address>)
1
type PoolPosition @entity {
2
" <user address>#<pool underlying asset address> "
3
id: ID!
4
" the liquidity provider is "
5
liquidityProvider: LiquidityProvider!
6
" the pool is "
7
pool: Pool!
8
" current bathToken balance "
9
bathTokenAmount: BigInt!
10
" total value of pool deposits "
11
totalDeposited: BigInt!
12
" total value of pool withdraws "
13
totalWithdrawn: BigInt!
14
}
Copied!
The PoolPosition entity represents the active state of a user's holdings in a Rubicon liquidity pool. To access the current state of the pool, including the total volume, outstanding amount, and bathToken price, the Pool entity can be accessed. All values are denominated in the integer value of the underlying ERC20 token that they represent. The contract events that update these entities are as follows:
Variable Updated
Function
Event Emit
Contract
PoolPosition.bathTokenAmount
PoolPosition.totalDeposited
function deposit(
uint256 _amount
)
external returns(
uint256 shares
)
{
uint256 _pool = underlyingBalance();
uint256 _before = underlyingToken.balanceOf(address(this));
event LogDeposit( uint256 depositedAmt, IERC20 asset, uint256 sharesReceived, address depositor, uint256 underlyingBalance, uint256 outstandingAmount, uint256 totalSupply );
BathToken.sol
PoolPosition.bathTokenAmount
PoolPosition.totalWithdrawn
function withdraw(uint256 _shares) external returns (uint256 amountWithdrawn)
event LogWithdraw( uint256 amountWithdrawn, IERC20 asset, uint256 sharesWithdrawn, address withdrawer, uint256 fee, address feeTo, uint256 underlyingBalance, uint256 outstandingAmount, uint256 totalSupply );
BathToken.sol
Pool Entity (ID: <pool underlying asset address>)
1
type Pool @entity {
2
" <pool underlying asset address> "
3
id: ID!
4
" derived from "
5
bathHouse: BathHouse!
6
" pool name "
7
name: String!
8
" pool asset address "
9
underlyingToken: String!
10
" creation time "
11
createdAtTimestamp: BigInt!
12
" block pool was created at "
13
createdAtBlockNumber: BigInt!
14
" address of bath token creator "
15
bathTokenCreator: String!
16
" pool underlying balance (amount in pool and on books) "
17
underlyingBalance: BigInt!
18
" amount of pool assets outstanding on the orderbook "
19
outstandingAmount: BigInt!
20
" shares outstanding (BathTokens) "
21
tokenSupply: BigInt!
22
" total value of pool deposits "
23
totalDeposited: BigInt!
24
" total value of pool withdraws "
25
totalWithdrawn: BigInt!
26
" BathToken Price: total suppply / underlying balance "
27
price: BigDecimal!
28
" total earned from market making activity "
29
totalEarned: BigInt!
30
" daily snapshots of pool data "
31
poolDayData: [PoolDayData!]! @derivedFrom(field: "pool")
32
" hourly snapshots of pool data "
33
poolHourData: [PoolHourData!]! @derivedFrom(field: "pool")
34
" derived fields "
35
deposits: [Deposit!]! @derivedFrom(field: "pool")
36
withdraws: [Withdraw!]! @derivedFrom(field: "pool")
37
PoolBuffers: [PoolBuffer!]! @derivedFrom(field: "pool")
38
}
Copied!
The Pool entity contains all relevant information regarding the current, and historical state, or a liquidity pool. The Pool entity maps to multiple other entities that is is associated with. The most relevant entities it maps are the PoolDayData, PoolHourData, and PoolBuffer entities. The totalEarned variable of the Pool entity is calculated as follows
Every Pool entity also has two associated entities that tracks pool statistics over a set period of time: PoolDayData & PoolHourData. The IDs for these pair are as follows:
- PoolDayData(ID: <pool underlying asset address>#<timestamp rounded to current day by dividing by 86400>)
- PoolHourData(ID: <pool underlying asset address>#<timestamp rounded to current hour by dividing by 3600>)
All values are denominated in the integer value of the underlying ERC-20 token that they represent. The contract events that update these entities are as follows:
Variable Updated
Function
Event Emit
Contract
Pool.underlyingBalance
Pool.tokenSupply
Pool.tokensMinted
Pool.totalDeposited
Pool.price
Pool.Deposits
function deposit(uint256 _amount) external returns (uint256 shares) { uint256 _pool = underlyingBalance(); uint256 _before = underlyingToken.balanceOf(address(this));
event LogDeposit( uint256 depositedAmt, IERC20 asset, uint256 sharesReceived, address depositor, uint256 underlyingBalance, uint256 outstandingAmount, uint256 totalSupply );
BathToken.sol
Pool.underlyingBalance
Pool.tokenSupply
Pool.tokensBurned
Pool.totalWithdrawn
Pool.price
Pool.Withdraws
function withdraw(uint256 _shares) external returns (uint256 amountWithdrawn)
event LogWithdraw( uint256 amountWithdrawn, IERC20 asset, uint256 sharesWithdrawn, address withdrawer, uint256 fee, address feeTo, uint256 underlyingBalance, uint256 outstandingAmount, uint256 totalSupply );
BathToken.sol
Pool.underlyingBalance
Pool.outstandingAmount
Pool.totalEarned
Pool.PoolBuffers
function rebalance( address destination, address filledAssetToRebalance, /* sister or fill asset */ uint256 stratProportion, uint256 rebalAmt )
event LogRebalance( IERC20 pool_asset, address destination, IERC20 transferAsset, uint256 rebalAmt, uint256 stratReward, uint256 underlyingBalance, uint256 outstandingAmount, uint256 totalSupply );
BathToken.sol
Pool.underlyingBalance
Pool.outstandingAmount
Pool.totalEarned
Pool.PoolBuffers
function placeOffer( uint256 pay_amt, ERC20 pay_gem, uint256 buy_amt, ERC20 buy_gem )
event LogPoolOffer( uint256 id, IERC20 pool_asset, uint256 underlyingBalance, uint256 outstandingAmount, uint256 totalSupply );
BathToken.sol
Pool.underlyingBalance
Pool.outstandingAmount
Pool.totalEarned
Pool.PoolBuffers
function buy(uint256 id, uint256 quantity) public virtual can_buy(id) synchronized returns (bool)
event LogTake( bytes32 indexed id, bytes32 indexed pair, address maker, ERC20 pay_gem, ERC20 buy_gem, address indexed taker, uint128 take_amt, uint128 give_amt, uint64 timestamp );
RubiconMarket.sol
PoolBuffer Entity (ID: <pool underlying asset address>#<buffer asset address>)
1
type PoolBuffer @entity {
2
" <pool underlying asset address>#<buffer asset address> "
3
id: ID!
4
" the pool is"
5
pool: Pool!
6
" token address of asset in buffer "
7
token: String!
8
" name of asset in buffer "
9
name: String!
10
" amount of token in buffer "
11
bufferAmount: BigInt!
12
}
Copied!
The PoolBuffer entity corresponds to the amount of a sister pairs asset that is sitting on the liquidity pool waiting to be rebalanced. The visual below will help to explain this process and what the Pool Buffer amount corresponds to.
TODO: *insert visualization from above*
Every PoolBuffer entity also has two associated entities that tracks PoolBuffer statistics over a set period of time: PoolDayData & PoolHourData. The IDs for these pair are as follows:
- PoolBufferDay(ID: <pool underlying asset address>#<buffer asset address>#<timestamp rounded to current day by dividing by 86400>)
- PoolBufferHour(ID: <pool underlying asset address>#<buffer asset address>#<timestamp rounded to current hour by dividing by 3600>)
All values are denominated in the integer value of the underlying ERC-20 token that they represent. The contract events that update these entities are as follows:
Variable Updated
Function
Event Emit
Contract
PoolBuffer.bufferAmount
function rebalance( address destination, address filledAssetToRebalance, /* sister or fill asset */ uint256 stratProportion, uint256 rebalAmt )
event LogRebalance( IERC20 pool_asset, address destination, IERC20 transferAsset, uint256 rebalAmt, uint256 stratReward, uint256 underlyingBalance, uint256 outstandingAmount, uint256 totalSupply );
BathToken.sol
PoolBuffer.bufferAmount
function buy(uint256 id, uint256 quantity) public virtual can_buy(id) synchronized returns (bool)
event LogTake( bytes32 indexed id, bytes32 indexed pair, address maker, ERC20 pay_gem, ERC20 buy_gem, address indexed taker, uint128 take_amt, uint128 give_amt, uint64 timestamp );
RubiconMarket.sol
Deposit Entity (ID: <transaction hash>#<user address>)
1
type Deposit @entity {
2
" <transaction hash>#<user address> "
3
id: ID!
4
" time of txn "
5
timestamp: BigInt!
6
" transaction details "
7
transaction: Transaction!
8
" pool to deposit in "
9
pool: Pool!
10
" amount deposited into pool "
11
depositAmount: BigInt!
12
" Bath Tokens received "
13
bathTokenAmount: BigInt!
14
" BathToken Price: total suppply / underlying balance "
15
price: BigDecimal!
16
" liquidity provider "
17
liquidityProvider: LiquidityProvider!
18
" map to PoolDayData entity "
19
poolDayData: PoolDayData!
20
" map to PoolHourData entity "
21
poolHourData: PoolHourData!
22
}
Copied!
The Deposit entity corresponds to any deposit placed by a liquidity provider into the Rubicon pools. The Deposit entity contains all relevant data regarding the deposit, such as deposit amount and shares received, along with mapping to other relevant entities. All values are denominated in the integer value of the underlying ERC20 token that they represent. The contract events that update these entities are as follows:
Variable Updated
Function
Event Emit
Contract
Deposit.timestamp
Deposit.transaction
Deposit.pool
Deposit.depositAmount
Deposit.bathTokenAmount
Deposit.price
function deposit(uint256 _amount) external returns (uint256 shares) { uint256 _pool = underlyingBalance(); uint256 _before = underlyingToken.balanceOf(address(this));
event LogDeposit( uint256 depositedAmt, IERC20 asset, uint256 sharesReceived, address depositor, uint256 underlyingBalance, uint256 outstandingAmount, uint256 totalSupply );
BathToken.sol
Withdraw Entity (ID: <transaction hash>#<user address>)
1
type Withdraw @entity {
2
" <transaction hash>#<user address> "
3
id: ID!
4
" time of txn "
5
timestamp: BigInt!
6
" transaction details "
7
transaction: Transaction!
8
" pool to withdraw from "
9
pool: Pool!
10
" amount withdrawn from the pool "
11
withdrawAmount: BigInt!
12
" Bath Tokens burned "
13
bathTokenBurned: BigInt!
14
" BathToken Price: total suppply / underlying balance "
15
price: BigDecimal!
16
" liquidity provider "
17
liquidityProvider: LiquidityProvider!
18
" map to PoolDayData entity "
19
poolDayData: PoolDayData!
20
" map to PoolHourData entity "
21
poolHourData: PoolHourData!
22
}
Copied!
The Withdraw entity corresponds to any deposit placed by a liquidity provider into the Rubicon pools. The Withdraw entity contains all relevant data regarding the deposit, such as withdraw amount and shares received, along with mapping to other relevant entities. All values are denominated in the integer value of the underlying ERC20 token that they represent. The contract events that update these entities are as follows:
Variable Updated
Function
Event Emit
Contract
Withdraw.timestamp
Withdraw.transaction
Withdraw.pool
Withdraw.withdrawAmount
Withdraw.bathTokenBurned
Withdraw.price
function withdraw(uint256 _shares) external returns (uint256 amountWithdrawn)
event LogWithdraw( uint256 amountWithdrawn, IERC20 asset, uint256 sharesWithdrawn, address withdrawer, uint256 fee, address feeTo, uint256 underlyingBalance, uint256 outstandingAmount, uint256 totalSupply );
BathToken.sol
Example Queries
The following queries are some common use case scenarios for potential data needs relating to the BathToken subgraph.
Use Case
Subgraph Studio Example
Access a User's liquidity pool positions
Check on the current statistics of the liquidity pools
Load in the historical pools data
Last modified 3mo ago
Copy link
Contents
BathToken Key Entities
LiquidityProvider Entity (ID: Wallet Address)
PoolPosition Entity (ID: <user address>#<pool underlying asset address>)
Pool Entity (ID: <pool underlying asset address>)
PoolBuffer Entity (ID: <pool underlying asset address>#<buffer asset address>)
Deposit Entity (ID: <transaction hash>#<user address>)
Withdraw Entity (ID: <transaction hash>#<user address>)
Example Queries