Skip to content
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.

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

vault form tooltips #723

Merged
merged 3 commits into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions config/localization/en/app.json
Original file line number Diff line number Diff line change
Expand Up @@ -1678,6 +1678,8 @@
"ACKNOWLEDGE_HIGH_SLIPPAGE": "Acknowledge High Slippage",
"SLIPPAGE_WARNING": "This withdrawal would result in {AMOUNT} slippage. Slippage may be reduced if you withdraw at a later time. For more information, see {LINK}.",
"EST_SLIPPAGE": "Est. slippage",
"ESTIMATED_SLIPPAGE": "Estimated Slippage",
"ESTIMATED_AMOUNT_RECEIVED": "Estimated Amount Received",
"PROTOCOL_VAULT": "dYdX Protocol Vault",
"LOCKED_BALANCE": "Locked Balance",
"WITHDRAW_TOO_HIGH": "You cannot withdraw more than your vault balance.",
Expand Down
17 changes: 17 additions & 0 deletions config/localization/en/tooltips.json
Original file line number Diff line number Diff line change
Expand Up @@ -378,5 +378,22 @@
"TITLE": "Reference Price",
"BODY": "The Reference Price is the rolling 30 day average of the market's price and is used as an input to automatically calculate the market's parameters on dYdX Chain. The Reference Price should approximately be the same as the market's current price (i.e. round down to the same powers of 10)."
}
},
"VAULT": {
"ESTIMATED_AMOUNT_RECEIVED": {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

designs don't have titles and they feel kinda redundant so I left them out here

"BODY": "The estimated amount to receive when withdrawing, which is withdrawal amount minus estimated slippage amount. This amount is an estimation based on the current conditions. The actual amount may be different based on the actual conditions at the execution time."
},
"ESTIMATED_SLIPPAGE": {
"BODY": "The estimated amount of slippage when withdrawing. The slippage comes from the vault's need to update the current positions to free up margin in order to meet the withdrawal amount. This amount is an estimation based on the current conditions. The actual amount may be different based on the actual conditions at the execution time."
},
"AVAILABLE_TO_WITHDRAW": {
"BODY": "The amount you can withdraw, which is your vault balance minus any amount that's locked up for new market listings."
},
"YOUR_VAULT_BALANCE": {
"BODY": "The current value of your deposits. This is calculated based on the vault's current equity and positions."
},
"YOUR_ALL_TIME_PNL": {
"BODY": "The total PnL over time. This includes historical PnL of your vault deposits."
}
}
}
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@dydxprotocol/v4-localization",
"version": "1.1.208",
"version": "1.1.209",
"description": "v4 localization",
"main": "index.ts",
"scripts": {
Expand Down
2 changes: 2 additions & 0 deletions scripts/generated/app.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1848,6 +1848,8 @@ export const APP_STRING_KEYS = {
DEPOSIT_TOO_LOW: 'APP.VAULTS.DEPOSIT_TOO_LOW',
ENTER_AMOUNT_TO_DEPOSIT: 'APP.VAULTS.ENTER_AMOUNT_TO_DEPOSIT',
ENTER_AMOUNT_TO_WITHDRAW: 'APP.VAULTS.ENTER_AMOUNT_TO_WITHDRAW',
ESTIMATED_AMOUNT_RECEIVED: 'APP.VAULTS.ESTIMATED_AMOUNT_RECEIVED',
ESTIMATED_SLIPPAGE: 'APP.VAULTS.ESTIMATED_SLIPPAGE',
EST_SLIPPAGE: 'APP.VAULTS.EST_SLIPPAGE',
LOCKED_BALANCE: 'APP.VAULTS.LOCKED_BALANCE',
MEGAVAULT: 'APP.VAULTS.MEGAVAULT',
Expand Down
8 changes: 8 additions & 0 deletions scripts/generated/tooltips.ts
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,14 @@ export const TOOLTIP_STRING_KEYS = {
UNEQUAL_ORDER_SIZES_BODY: 'TOOLTIPS.TRIGGER_ORDERS.UNEQUAL_ORDER_SIZES.BODY',
UNEQUAL_ORDER_SIZES_TITLE: 'TOOLTIPS.TRIGGER_ORDERS.UNEQUAL_ORDER_SIZES.TITLE',

// VAULT

AVAILABLE_TO_WITHDRAW_BODY: 'TOOLTIPS.VAULT.AVAILABLE_TO_WITHDRAW.BODY',
ESTIMATED_AMOUNT_RECEIVED_BODY: 'TOOLTIPS.VAULT.ESTIMATED_AMOUNT_RECEIVED.BODY',
ESTIMATED_SLIPPAGE_BODY: 'TOOLTIPS.VAULT.ESTIMATED_SLIPPAGE.BODY',
YOUR_ALL_TIME_PNL_BODY: 'TOOLTIPS.VAULT.YOUR_ALL_TIME_PNL.BODY',
YOUR_VAULT_BALANCE_BODY: 'TOOLTIPS.VAULT.YOUR_VAULT_BALANCE.BODY',

// WITHDRAW

BRIDGE_FEES_BODY: 'TOOLTIPS.WITHDRAW.BRIDGE_FEES.BODY',
Expand Down
Loading