Skip to content

Commit

Permalink
remove optional label for dex / lending (#50)
Browse files Browse the repository at this point in the history 
remove optional label
  • Loading branch information
@0xroll
0xroll authored Jan 8, 2025
1 parent 67efc67 commit 08771f1
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 50 deletions.
22 changes: 11 additions & 11 deletions schemas/dex/SCHEMA.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Snapshot of LP positions.
| token_address | The contract address of the token provided as liquidity. | string |
| token_symbol | The symbol of the token. | string |
| token_amount | The amount of the underlying liquidity position in the pool, decimal normalized (ie, the amount of USDC provided by the LPer in a USDC/WETH pool). | number |
| token_amount_usd | (Optional) The amount of the token in USD. | number |
| token_amount_usd | The amount of the token in USD. | number |

### Pool Snapshot

Expand All @@ -54,13 +54,13 @@ Snapshot of pool states.
| token_address | The contract address of the token in the pool. | string |
| token_symbol | The symbol of the token. | string |
| token_amount | The amount of the token in this pool at the snapshot. | number |
| token_amount_usd | (Optional) The amount of the token in USD. | number |
| token_amount_usd | The amount of the token in USD. | number |
| volume_amount | The volume of the token transacted in this pool during the given snapshot, decimal normalized. | number |
| volume_usd | (Optional) The volume transacted in the given snapshot, in USD. | number |
| volume_usd | The volume transacted in the given snapshot, in USD. | number |
| fee_rate | The fee rate of the pool, as a percentage (ie, 2.3% as 0.023). | number |
| total_fees_usd | (Optional) The total amount of revenue and fees paid in this pool in the given snapshot, in USD. | number |
| user_fees_usd | (Optional) The amount of total fees accrued to liquidity providers of the protocol, in USD. | number |
| protocol_fees_usd | (Optional) The amount of total fees accrued to the protocol, in USD. | number |
| total_fees_usd | The total amount of revenue and fees paid in this pool in the given snapshot, in USD. | number |
| user_fees_usd | The amount of total fees accrued to liquidity providers of the protocol, in USD. | number |
| protocol_fees_usd | The amount of total fees accrued to the protocol, in USD. | number |

### Trades (All DEX Types)

Expand All @@ -85,8 +85,8 @@ All trades across different types of DEXs.
| output_token_symbol | The symbol of the output token. | string |
| output_token_amount | The amount of the output token, decimal normalized. | number |
| spot_price_after_swap | The spot price in the pool after the swap is complete. This is the price ratio a user would get if they made an infinitesimal swap immediately after this one. | number |
| swap_amount_usd | (Optional) The amount of the swap in USD. | number |
| fees_usd | (Optional) The fees paid by the user. | number |
| swap_amount_usd | The amount of the swap in USD. | number |
| fees_usd | The fees paid by the user. | number |

### User Score Snapshot

Expand Down Expand Up @@ -123,7 +123,7 @@ Mint events for V2.
| token1_address | The contract address of token1. | string |
| token1_amount | The amount of token1. | number |
| mint_amount | The amount of LP token minted by the trader, decimal normalized. | number |
| mint_amount_usd | (Optional) The amount of the mint in USD. | number |
| mint_amount_usd | The amount of the mint in USD. | number |

### V2 Burns

Expand All @@ -145,7 +145,7 @@ Burn events for V2.
| token1_address | The contract address of token1. | string |
| token1_amount | The amount of token1. | number |
| burn_amount | The amount of LP tokens burned, decimal normalized. | number |
| burn_amount_usd | (Optional) The amount of the burn in USD. | number |
| burn_amount_usd | The amount of the burn in USD. | number |

### V2 Syncs

Expand Down Expand Up @@ -239,6 +239,6 @@ Transactional data on user level incentives claimed data.
| claimed_token_address | The smart contract address of the claimed token. | string |
| amount | The amount of the token claimed, decimal normalized. | number |
| amount_usd | The amount of claimed tokens in USD. | number |
| other_incentive_usd | (Optional) Any incentives outside of the claimed token, in this transaction, summed up in USD terms. | number |
| other_incentive_usd | Any incentives outside of the claimed token, in this transaction, summed up in USD terms. | number |

> Note: This markdown file is auto-generated.
22 changes: 11 additions & 11 deletions schemas/dex/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@
"type": "number"
},
"token_amount_usd": {
"description": "(Optional) The amount of the token in USD.",
"description": "The amount of the token in USD.",
"type": "number"
}
}
Expand Down Expand Up @@ -150,31 +150,31 @@
"type": "number"
},
"token_amount_usd": {
"description": "(Optional) The amount of the token in USD.",
"description": "The amount of the token in USD.",
"type": "number"
},
"volume_amount": {
"description": "The volume of the token transacted in this pool during the given snapshot, decimal normalized.",
"type": "number"
},
"volume_usd": {
"description": "(Optional) The volume transacted in the given snapshot, in USD.",
"description": "The volume transacted in the given snapshot, in USD.",
"type": "number"
},
"fee_rate": {
"description": "The fee rate of the pool, as a percentage (ie, 2.3% as 0.023).",
"type": "number"
},
"total_fees_usd": {
"description": "(Optional) The total amount of revenue and fees paid in this pool in the given snapshot, in USD.",
"description": "The total amount of revenue and fees paid in this pool in the given snapshot, in USD.",
"type": "number"
},
"user_fees_usd": {
"description": "(Optional) The amount of total fees accrued to liquidity providers of the protocol, in USD.",
"description": "The amount of total fees accrued to liquidity providers of the protocol, in USD.",
"type": "number"
},
"protocol_fees_usd": {
"description": "(Optional) The amount of total fees accrued to the protocol, in USD.",
"description": "The amount of total fees accrued to the protocol, in USD.",
"type": "number"
}
}
Expand Down Expand Up @@ -255,11 +255,11 @@
"type": "number"
},
"swap_amount_usd": {
"description": "(Optional) The amount of the swap in USD.",
"description": "The amount of the swap in USD.",
"type": "number"
},
"fees_usd": {
"description": "(Optional) The fees paid by the user.",
"description": "The fees paid by the user.",
"type": "number"
}
}
Expand Down Expand Up @@ -369,7 +369,7 @@
"type": "number"
},
"mint_amount_usd": {
"description": "(Optional) The amount of the mint in USD.",
"description": "The amount of the mint in USD.",
"type": "number"
}
}
Expand Down Expand Up @@ -438,7 +438,7 @@
"type": "number"
},
"burn_amount_usd": {
"description": "(Optional) The amount of the burn in USD.",
"description": "The amount of the burn in USD.",
"type": "number"
}
}
Expand Down Expand Up @@ -719,7 +719,7 @@
"type": "number"
},
"other_incentive_usd": {
"description": "(Optional) Any incentives outside of the claimed token, in this transaction, summed up in USD terms.",
"description": "Any incentives outside of the claimed token, in this transaction, summed up in USD terms.",
"type": "number"
}
}
Expand Down
28 changes: 14 additions & 14 deletions schemas/lending/SCHEMA.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ Snapshot of user positions in the lending protocol.
| underlying_token_symbol | The symbol of the underlying token. | string |
| user_address | The address of the user who has the position. | string |
| supplied_amount | The amount supplied by the user in the underlying token, decimal normalized. | number |
| supplied_amount_usd | (Optional) The supplied amount in USD. | number |
| supplied_amount_usd | The supplied amount in USD. | number |
| borrowed_amount | The amount borrowed by the user in the underlying token, decimal normalized. | number |
| borrowed_amount_usd | (Optional) The borrowed amount in USD. | number |
| collateral_amount | (Optional) The amount of collateral-only tokens of this asset, decimal normalized. | number |
| collateral_amount_usd | (Optional) The amount of collateral-only tokens in USD. | number |
| borrowed_amount_usd | The borrowed amount in USD. | number |
| collateral_amount | The amount of collateral-only tokens of this asset, decimal normalized. | number |
| collateral_amount_usd | The amount of collateral-only tokens in USD. | number |

### Pool Snapshot

Expand All @@ -52,23 +52,23 @@ Snapshot of the pool's state in the lending protocol.
| pool_address | The contract address of the pool. | string |
| underlying_token_address | The contract address of the underlying token. | string |
| underlying_token_symbol | The symbol of the underlying token. | string |
| underlying_token_price_usd | (Optional) The token price of the underlying asset in USD. | number |
| underlying_token_price_usd | The token price of the underlying asset in USD. | number |
| available_amount | The amount of token's available to borrow (liquidity or net supply or supply - borrow). | number |
| available_amount_usd | (Optional) The available amount of token's in this pool in USD. | number |
| available_amount_usd | The available amount of token's in this pool in USD. | number |
| supplied_amount | The total amount of the underlying token supplied in this pool, decimal normalized. | number |
| supplied_amount_usd | (Optional) The supplied amount in USD. | number |
| collateral_amount | (Optional) The amount of collateral only tokens in this pool. | number |
| collateral_amount_usd | (Optional) The amount of collateral only tokens in the pool. | number |
| supplied_amount_usd | The supplied amount in USD. | number |
| collateral_amount | The amount of collateral only tokens in this pool. | number |
| collateral_amount_usd | The amount of collateral only tokens in the pool. | number |
| collateral_factor | The collateral factor of the pool (defined as a decimal percentage, between 0-100). | number |
| supply_index | The supply index of the pool. | number |
| supply_apr | The current annual percentage rate for supplied amount, as a decimal percentage. | number |
| borrowed_amount | The amount of underlying tokens borrowed from this pool in the underlying token, decimal normalized. | number |
| borrowed_amount_usd | (Optional) The borrowed amount in USD. | number |
| borrowed_amount_usd | The borrowed amount in USD. | number |
| borrow_index | The borrow index of the pool. | number |
| borrow_apr | The current annual percentage rate for borrow, as a decimal percentage. | number |
| total_fees_usd | (Optional) The total revenue or fees accrued in this pool during the given snapshot period (ie, user_fees_usd + protocol_fees_usd = total_fees_usd). | number |
| user_fees_usd | (Optional) The portion of total revenue or fees accrued to users of the protocol during the given snapshot period. | number |
| protocol_fees_usd | (Optional) The portion of total revenue or fees accrued to protocol during the given snapshot period. | number |
| total_fees_usd | The total revenue or fees accrued in this pool during the given snapshot period (ie, user_fees_usd + protocol_fees_usd = total_fees_usd). | number |
| user_fees_usd | The portion of total revenue or fees accrued to users of the protocol during the given snapshot period. | number |
| protocol_fees_usd | The portion of total revenue or fees accrued to protocol during the given snapshot period. | number |

### Events

Expand Down Expand Up @@ -123,6 +123,6 @@ Transactional data on user level incentives claimed data.
| claimed_token_address | The smart contract address of the claimed token. | string |
| amount | The amount of the token claimed, decimal normalized. | number |
| amount_usd | The amount of claimed tokens in USD. | number |
| other_incentive_usd | (Optional) Any incentives outside of the claimed token, in this transaction, summed up in USD terms. | number |
| other_incentive_usd | Any incentives outside of the claimed token, in this transaction, summed up in USD terms. | number |

> Note: This markdown file is auto-generated.
28 changes: 14 additions & 14 deletions schemas/lending/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,23 +89,23 @@
"type": "number"
},
"supplied_amount_usd": {
"description": "(Optional) The supplied amount in USD.",
"description": "The supplied amount in USD.",
"type": "number"
},
"borrowed_amount": {
"description": "The amount borrowed by the user in the underlying token, decimal normalized.",
"type": "number"
},
"borrowed_amount_usd": {
"description": "(Optional) The borrowed amount in USD.",
"description": "The borrowed amount in USD.",
"type": "number"
},
"collateral_amount": {
"description": "(Optional) The amount of collateral-only tokens of this asset, decimal normalized.",
"description": "The amount of collateral-only tokens of this asset, decimal normalized.",
"type": "number"
},
"collateral_amount_usd": {
"description": "(Optional) The amount of collateral-only tokens in USD.",
"description": "The amount of collateral-only tokens in USD.",
"type": "number"
}
}
Expand Down Expand Up @@ -142,31 +142,31 @@
"type": "string"
},
"underlying_token_price_usd": {
"description": "(Optional) The token price of the underlying asset in USD.",
"description": "The token price of the underlying asset in USD.",
"type": "number"
},
"available_amount": {
"description": "The amount of token's available to borrow (liquidity or net supply or supply - borrow).",
"type": "number"
},
"available_amount_usd": {
"description": "(Optional) The available amount of token's in this pool in USD.",
"description": "The available amount of token's in this pool in USD.",
"type": "number"
},
"supplied_amount": {
"description": "The total amount of the underlying token supplied in this pool, decimal normalized.",
"type": "number"
},
"supplied_amount_usd": {
"description": "(Optional) The supplied amount in USD.",
"description": "The supplied amount in USD.",
"type": "number"
},
"collateral_amount": {
"description": "(Optional) The amount of collateral only tokens in this pool.",
"description": "The amount of collateral only tokens in this pool.",
"type": "number"
},
"collateral_amount_usd": {
"description": "(Optional) The amount of collateral only tokens in the pool.",
"description": "The amount of collateral only tokens in the pool.",
"type": "number"
},
"collateral_factor": {
Expand All @@ -186,7 +186,7 @@
"type": "number"
},
"borrowed_amount_usd": {
"description": "(Optional) The borrowed amount in USD.",
"description": "The borrowed amount in USD.",
"type": "number"
},
"borrow_index": {
Expand All @@ -198,15 +198,15 @@
"type": "number"
},
"total_fees_usd": {
"description": "(Optional) The total revenue or fees accrued in this pool during the given snapshot period (ie, user_fees_usd + protocol_fees_usd = total_fees_usd).",
"description": "The total revenue or fees accrued in this pool during the given snapshot period (ie, user_fees_usd + protocol_fees_usd = total_fees_usd).",
"type": "number"
},
"user_fees_usd": {
"description": "(Optional) The portion of total revenue or fees accrued to users of the protocol during the given snapshot period.",
"description": "The portion of total revenue or fees accrued to users of the protocol during the given snapshot period.",
"type": "number"
},
"protocol_fees_usd": {
"description": "(Optional) The portion of total revenue or fees accrued to protocol during the given snapshot period.",
"description": "The portion of total revenue or fees accrued to protocol during the given snapshot period.",
"type": "number"
}
}
Expand Down Expand Up @@ -369,7 +369,7 @@
"type": "number"
},
"other_incentive_usd": {
"description": "(Optional) Any incentives outside of the claimed token, in this transaction, summed up in USD terms.",
"description": "Any incentives outside of the claimed token, in this transaction, summed up in USD terms.",
"type": "number"
}
}
Expand Down

0 comments on commit 08771f1

Please sign in to comment.