Skip to content

update data types #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 22, 2025
Merged

update data types #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fcb4732
update data types
melotik Jan 21, 2025
79f6059
Merge branch 'main' of github.com:delta-hq/schemas into dylan/update-…
melotik Jan 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 33 additions & 33 deletions schemas/automated-liquidity-management/SCHEMA.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ List of pools in the protocol.

| Property | Description | Type |
|-------------------------|-----------------------------------------------------------|--------|
| chain_id | The standard chain id. | number |
| timestamp | The timestamp this pool was created. | number |
| creation_block_number | The block number that this pool was created. | number |
| chain_id | The standard chain id. | int |
| timestamp | The timestamp this pool was created. | timestamp |
| creation_block_number | The block number that this pool was created. | bigint |
| strategy_vault_contract_address | The contract address of the strategy vault which manages the liquidity pool positions. | string |
| liquidity_pool_address | The contract address of the underlying liquidity pool where liquidity are deposited into | string |
| strategy_vault_receipt_token_address | The contract address of ERC20 token which represents the share of liquidity provided. | string |
| strategy_vault_receipt_token_decimals | The decimal amount of the ERC20 receipt token. | number |
| strategy_vault_receipt_token_decimals | The decimal amount of the ERC20 receipt token. | int |
| strategy_vault_receipt_token_symbol | The symbol of the receipt token. | string |

### Position Snapshot
Expand All @@ -25,50 +25,50 @@ Snapshot of the pool users.

| Property | Description | Type |
|-------------------------|-----------------------------------------------------------|--------|
| timestamp | The timestamp of the snapshot. | number |
| timestamp | The timestamp of the snapshot. | timestamp |
| block_date | The timestamp truncated (ie, YYYY-MM-DD format for daily snapshots and YYYY-MM-DD HH:00:00 for hourly snapshots). | date |
| chain_id | The standard chain id. | number |
| chain_id | The standard chain id. | int |
| strategy_vault_contract_address | The address of the strategy vault this user has a position in. | string |
| user_address | The address of the user who has a position in the strategy vault. | string |
| liquidity_pool_address | The address of the underlying liquidity pool where liquidity are deposited into | string |
| underlying_token_address | The address of the supplied underlying token. | string |
| underlying_token_index | The index of the underlying token in the smart contract, default 0. | number |
| underlying_token_amount | The amount based on the user's share of the total underlying token, decimal normalized. | number |
| underlying_token_amount_usd | The amount based on the user's share of the total underlying token, in USD. | number |
| total_fees_usd | The total amount of revenue and fees paid in this pool in the given snapshot, in USD. | number |
| underlying_token_index | The index of the underlying token in the smart contract, default 0. | bigint |
| underlying_token_amount | The amount based on the user's share of the total underlying token, decimal normalized. | double |
| underlying_token_amount_usd | The amount based on the user's share of the total underlying token, in USD. | double |
| total_fees_usd | The total amount of revenue and fees paid in this pool in the given snapshot, in USD. | double |

### Pool Snapshot

TVL, fees, and incentives data at the pool level.

| Property | Description | Type |
|-------------------------|-----------------------------------------------------------|--------|
| timestamp | The timestamp of the snapshot. | number |
| timestamp | The timestamp of the snapshot. | timestamp |
| block_date | The timestamp truncated (ie, YYYY-MM-DD format for daily snapshots and YYYY-MM-DD HH:00:00 for hourly snapshots). | date |
| chain_id | The standard chain id. | number |
| chain_id | The standard chain id. | int |
| strategy_vault_contract_address | The address of the strategy vault this user has a position in. | string |
| liquidity_pool_address | The address of the underlying liquidity pool where liquidity are deposited into | string |
| underlying_token_address | The address of the supplied underlying token. | string |
| underlying_token_index | The index of the underlying token in the smart contract, default 0. | number |
| underlying_token_amount | The amount of underlying token supplied in this pool, decimal normalized. | number |
| underlying_token_amount_usd | The amount of underlying tokens supplied in this pool, in USD. | number |
| total_fees_usd | The total amount of revenue and fees paid in this pool in the given snapshot, in USD. | number |
| underlying_token_index | The index of the underlying token in the smart contract, default 0. | bigint |
| underlying_token_amount | The amount of underlying token supplied in this pool, decimal normalized. | double |
| underlying_token_amount_usd | The amount of underlying tokens supplied in this pool, in USD. | double |
| total_fees_usd | The total amount of revenue and fees paid in this pool in the given snapshot, in USD. | double |

### ERC-20 LP Token Transfer Events

All LP Token transfer events

| Property | Description | Type |
|-------------------------|-----------------------------------------------------------|--------|
| timestamp | The timestamp of the transaction. | number |
| chain_id | The standard id of the chain. | number |
| block_number | The block number of the trade. | number |
| log_index | The event log. For transactions that don't emit event, create arbitrary index starting from 0. | number |
| timestamp | The timestamp of the transaction. | timestamp |
| chain_id | The standard id of the chain. | int |
| block_number | The block number of the trade. | bigint |
| log_index | The event log. For transactions that don't emit event, create arbitrary index starting from 0. | bigint |
| transaction_hash | The hash of the transaction. | string |
| from_address | The from address of the event (ie, the from field in a transfer). | string |
| to_address | The to address of the event (ie, the to field in a transfer). | string |
| pool_address | The contract address of the pool LP token. | string |
| amount | The amount of token transacted, decimal normalized. | number |
| amount | The amount of token transacted, decimal normalized. | double |
| event_type | The type of event, corresponds to the action taken by the user (ie, deposit, withdrawal). | string |

### Events
Expand All @@ -77,16 +77,16 @@ All user events (ie, Deposit, Withdrawal)

| Property | Description | Type |
|-------------------------|-----------------------------------------------------------|--------|
| timestamp | The timestamp of the transaction. | number |
| chain_id | The standard id of the chain. | number |
| block_number | The block number of the trade. | number |
| log_index | The event log. For transactions that don't emit event, create arbitrary index starting from 0. | number |
| timestamp | The timestamp of the transaction. | timestamp |
| chain_id | The standard id of the chain. | int |
| block_number | The block number of the trade. | bigint |
| log_index | The event log. For transactions that don't emit event, create arbitrary index starting from 0. | bigint |
| transaction_hash | The hash of the transaction. | string |
| user_address | The address that initiates the transaction (ie, the transaction signer). | string |
| pool_address | The smart contract address of the pool. | string |
| underlying_token_address | The contract address of the underlying token or deposited token. | string |
| amount | The amount of token transacted, decimal normalized. | number |
| amount_usd | The amount of token transacted, in USD. | number |
| amount | The amount of token transacted, decimal normalized. | double |
| amount_usd | The amount of token transacted, in USD. | double |
| event_type | The type of event, corresponds to the action taken by the user (ie, deposit, withdrawal). | string |

### Incentive Claim Data
Expand All @@ -95,15 +95,15 @@ Transactional data on user level incentives claimed data.

| Property | Description | Type |
|-------------------------|-----------------------------------------------------------|--------|
| timestamp | The timestamp of the claim. | number |
| chain_id | The standard chain id. | number |
| timestamp | The timestamp of the claim. | timestamp |
| chain_id | The standard chain id. | int |
| transaction_hash | The hash of the transaction. | string |
| log_index | The event log. For transactions that don't emit event, create arbitrary index starting from 0. | number |
| log_index | The event log. For transactions that don't emit event, create arbitrary index starting from 0. | bigint |
| transaction_signer | The address of the account that signed the transaction. | string |
| user_address | The address of the user who claimed the incentives (could be different from the transaction_signer). | string |
| 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 |
| amount | The amount of the token claimed, decimal normalized. | double |
| amount_usd | The amount of claimed tokens in USD. | double |
| other_incentive_usd | (Optional) Any incentives outside of the claimed token, in this transaction, summed up in USD terms. | double |

> Note: This markdown file is auto-generated.
68 changes: 34 additions & 34 deletions schemas/automated-liquidity-management/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@
"properties": {
"chain_id": {
"description": "The standard chain id.",
"type": "number"
"type": "int"
},
"timestamp": {
"description": "The timestamp this pool was created.",
"type": "number"
"type": "timestamp"
},
"creation_block_number": {
"description": "The block number that this pool was created.",
"type": "number"
"type": "bigint"
},
"strategy_vault_contract_address": {
"description": "The contract address of the strategy vault which manages the liquidity pool positions.",
Expand All @@ -37,7 +37,7 @@
},
"strategy_vault_receipt_token_decimals": {
"description": "The decimal amount of the ERC20 receipt token.",
"type": "number"
"type": "int"
},
"strategy_vault_receipt_token_symbol": {
"description": "The symbol of the receipt token.",
Expand All @@ -54,15 +54,15 @@
"properties": {
"timestamp": {
"description": "The timestamp of the snapshot.",
"type": "number"
"type": "timestamp"
},
"block_date": {
"description": "The timestamp truncated (ie, YYYY-MM-DD format for daily snapshots and YYYY-MM-DD HH:00:00 for hourly snapshots).",
"type": "date"
},
"chain_id": {
"description": "The standard chain id.",
"type": "number"
"type": "int"
},
"strategy_vault_contract_address": {
"description": "The address of the strategy vault this user has a position in.",
Expand All @@ -82,19 +82,19 @@
},
"underlying_token_index": {
"description": "The index of the underlying token in the smart contract, default 0.",
"type": "number"
"type": "bigint"
},
"underlying_token_amount": {
"description": "The amount based on the user's share of the total underlying token, decimal normalized.",
"type": "number"
"type": "double"
},
"underlying_token_amount_usd": {
"description": "The amount based on the user's share of the total underlying token, in USD.",
"type": "number"
"type": "double"
},
"total_fees_usd": {
"description": "The total amount of revenue and fees paid in this pool in the given snapshot, in USD.",
"type": "number"
"type": "double"
}
}
},
Expand All @@ -107,15 +107,15 @@
"properties": {
"timestamp": {
"description": "The timestamp of the snapshot.",
"type": "number"
"type": "timestamp"
},
"block_date": {
"description": "The timestamp truncated (ie, YYYY-MM-DD format for daily snapshots and YYYY-MM-DD HH:00:00 for hourly snapshots).",
"type": "date"
},
"chain_id": {
"description": "The standard chain id.",
"type": "number"
"type": "int"
},
"strategy_vault_contract_address": {
"description": "The address of the strategy vault this user has a position in.",
Expand All @@ -131,19 +131,19 @@
},
"underlying_token_index": {
"description": "The index of the underlying token in the smart contract, default 0.",
"type": "number"
"type": "bigint"
},
"underlying_token_amount": {
"description": "The amount of underlying token supplied in this pool, decimal normalized.",
"type": "number"
"type": "double"
},
"underlying_token_amount_usd": {
"description": "The amount of underlying tokens supplied in this pool, in USD.",
"type": "number"
"type": "double"
},
"total_fees_usd": {
"description": "The total amount of revenue and fees paid in this pool in the given snapshot, in USD.",
"type": "number"
"type": "double"
}
}
},
Expand All @@ -156,19 +156,19 @@
"properties": {
"timestamp": {
"description": "The timestamp of the transaction.",
"type": "number"
"type": "timestamp"
},
"chain_id": {
"description": "The standard id of the chain.",
"type": "number"
"type": "int"
},
"block_number": {
"description": "The block number of the trade.",
"type": "number"
"type": "bigint"
},
"log_index": {
"description": "The event log. For transactions that don't emit event, create arbitrary index starting from 0.",
"type": "number"
"type": "bigint"
},
"transaction_hash": {
"description": "The hash of the transaction.",
Expand All @@ -181,14 +181,14 @@
"to_address": {
"description": "The to address of the event (ie, the to field in a transfer).",
"type": "string"
},
},
"pool_address": {
"description": "The contract address of the pool LP token.",
"type": "string"
},
"amount": {
"description": "The amount of token transacted, decimal normalized.",
"type": "number"
"type": "double"
},
"event_type": {
"description": "The type of event, corresponds to the action taken by the user (ie, deposit, withdrawal).",
Expand All @@ -205,19 +205,19 @@
"properties": {
"timestamp": {
"description": "The timestamp of the transaction.",
"type": "number"
"type": "timestamp"
},
"chain_id": {
"description": "The standard id of the chain.",
"type": "number"
"type": "int"
},
"block_number": {
"description": "The block number of the trade.",
"type": "number"
"type": "bigint"
},
"log_index": {
"description": "The event log. For transactions that don't emit event, create arbitrary index starting from 0.",
"type": "number"
"type": "bigint"
},
"transaction_hash": {
"description": "The hash of the transaction.",
Expand All @@ -237,11 +237,11 @@
},
"amount": {
"description": "The amount of token transacted, decimal normalized.",
"type": "number"
"type": "double"
},
"amount_usd": {
"description": "The amount of token transacted, in USD.",
"type": "number"
"type": "double"
},
"event_type": {
"description": "The type of event, corresponds to the action taken by the user (ie, deposit, withdrawal).",
Expand All @@ -258,19 +258,19 @@
"properties": {
"timestamp": {
"description": "The timestamp of the claim.",
"type": "number"
"type": "timestamp"
},
"chain_id": {
"description": "The standard chain id.",
"type": "number"
"type": "int"
},
"transaction_hash": {
"description": "The hash of the transaction.",
"type": "string"
},
"log_index": {
"description": "The event log. For transactions that don't emit event, create arbitrary index starting from 0.",
"type": "number"
"type": "bigint"
},
"transaction_signer": {
"description": "The address of the account that signed the transaction.",
Expand All @@ -286,15 +286,15 @@
},
"amount": {
"description": "The amount of the token claimed, decimal normalized.",
"type": "number"
"type": "double"
},
"amount_usd": {
"description": "The amount of claimed tokens in USD.",
"type": "number"
"type": "double"
},
"other_incentive_usd": {
"description": "(Optional) Any incentives outside of the claimed token, in this transaction, summed up in USD terms.",
"type": "number"
"type": "double"
}
}
}
Expand Down
Loading
Loading