[RFC] Update API docs and specs

artifacts/apidocs/schemas/aggregated_account_summary.md

@@ -4,9 +4,18 @@
     |main_account_id<br>`ma` |string|True|The main account ID of the account to which the summary belongs|
     |total_equity<br>`te` |string|True|Total equity of the main (+ sub) account, denominated in USD|
     |spot_balances<br>`sb` |[SpotBalance]|True|The list of spot assets owned by this main (+ sub) account, and their balances|
+    |vault_investments<br>`vi` |[VaultInvestment]|True|The list of vault investments held by this main account|
     ??? info "[SpotBalance](/../../schemas/spot_balance)"
         |Name<br>`Lite`|Type|Required<br>`Default`| Description |
         |-|-|-|-|
         |currency<br>`c` |string|True|The currency you hold a spot balance in|
         |balance<br>`b` |string|True|This currency's balance in this trading account.|
         |index_price<br>`ip` |string|True|The index price of this currency. (reported in `USD`)|
+    ??? info "[VaultInvestment](/../../schemas/vault_investment)"
+        Summarizes a vault investment held by a funding account<br>
+
+        |Name<br>`Lite`|Type|Required<br>`Default`| Description |
+        |-|-|-|-|
+        |vault_id<br>`vi` |string|True|The trading account ID of the vault invested in.|
+        |num_lp_tokens<br>`nl` |string|True|The number of shares held by the investor.|
+        |share_price<br>`sp` |string|True|The current share price (in USD) of this vault investment.|

artifacts/apidocs/schemas/api_aggregated_account_summary_response.md

@@ -10,9 +10,18 @@
         |main_account_id<br>`ma` |string|True|The main account ID of the account to which the summary belongs|
         |total_equity<br>`te` |string|True|Total equity of the main (+ sub) account, denominated in USD|
         |spot_balances<br>`sb` |[SpotBalance]|True|The list of spot assets owned by this main (+ sub) account, and their balances|
+        |vault_investments<br>`vi` |[VaultInvestment]|True|The list of vault investments held by this main account|
         ??? info "[SpotBalance](/../../schemas/spot_balance)"
             |Name<br>`Lite`|Type|Required<br>`Default`| Description |
             |-|-|-|-|
             |currency<br>`c` |string|True|The currency you hold a spot balance in|
             |balance<br>`b` |string|True|This currency's balance in this trading account.|
             |index_price<br>`ip` |string|True|The index price of this currency. (reported in `USD`)|
+        ??? info "[VaultInvestment](/../../schemas/vault_investment)"
+            Summarizes a vault investment held by a funding account<br>
+
+            |Name<br>`Lite`|Type|Required<br>`Default`| Description |
+            |-|-|-|-|
+            |vault_id<br>`vi` |string|True|The trading account ID of the vault invested in.|
+            |num_lp_tokens<br>`nl` |string|True|The number of shares held by the investor.|
+            |share_price<br>`sp` |string|True|The current share price (in USD) of this vault investment.|

artifacts/apidocs/schemas/api_funding_account_summary_response.md

@@ -13,12 +13,21 @@
         |main_account_id<br>`ma` |string|True|The main account ID of the account to which the summary belongs|
         |total_equity<br>`te` |string|True|Total equity of the main account, denominated in USD|
         |spot_balances<br>`sb` |[SpotBalance]|True|The list of spot assets owned by this main account, and their balances|
+        |vault_investments<br>`vi` |[VaultInvestment]|True|The list of vault investments held by this main account|
         ??? info "[SpotBalance](/../../schemas/spot_balance)"
             |Name<br>`Lite`|Type|Required<br>`Default`| Description |
             |-|-|-|-|
             |currency<br>`c` |string|True|The currency you hold a spot balance in|
             |balance<br>`b` |string|True|This currency's balance in this trading account.|
             |index_price<br>`ip` |string|True|The index price of this currency. (reported in `USD`)|
+        ??? info "[VaultInvestment](/../../schemas/vault_investment)"
+            Summarizes a vault investment held by a funding account<br>
+
+            |Name<br>`Lite`|Type|Required<br>`Default`| Description |
+            |-|-|-|-|
+            |vault_id<br>`vi` |string|True|The trading account ID of the vault invested in.|
+            |num_lp_tokens<br>`nl` |string|True|The number of shares held by the investor.|
+            |share_price<br>`sp` |string|True|The current share price (in USD) of this vault investment.|
     ??? info "[ClientTier](/../../schemas/client_tier)"
         |Name<br>`Lite`|Type|Required<br>`Default`| Description |
         |-|-|-|-|

artifacts/apidocs/schemas/api_vault_burn_tokens_request.md

@@ -3,7 +3,6 @@
 
     |Name<br>`Lite`|Type|Required<br>`Default`| Description |
     |-|-|-|-|
-    |main_account_id<br>`ma` |string|True|The address of the main account initiating the burn.|
     |vault_id<br>`vi` |string|True|The unique identifier of the vault to burn tokens from.|
     |currency<br>`c` |string|True|The currency used for the burn. This should be the vault's quote currency.|
     |num_tokens<br>`nt` |string|True|The number of tokens to burn.|

artifacts/apidocs/schemas/api_vault_invest_request.md

@@ -3,7 +3,6 @@
 
     |Name<br>`Lite`|Type|Required<br>`Default`| Description |
     |-|-|-|-|
-    |main_account_id<br>`ma` |string|True|The address of the main account initiating the investment.|
     |vault_id<br>`vi` |string|True|The unique identifier of the vault to invest in.|
     |currency<br>`c` |string|True|The currency used for the investment. This should be the vault's quote currency.|
     |num_tokens<br>`nt` |string|True|The investment sum, in terms of the token currency specified (i.e., `numTokens` of '1000' with `tokenCurrency` of 'USDT' denotes investment of 1,000 USDT).|

artifacts/apidocs/schemas/api_vault_investor_summary_request.md

@@ -3,5 +3,4 @@
 
     |Name<br>`Lite`|Type|Required<br>`Default`| Description |
     |-|-|-|-|
-    |main_account_id<br>`ma` |string|True|The address of the main account initiating the request.|
     |vault_id<br>`vi` |string|True|The unique identifier of the vault to fetch the summary for.|

artifacts/apidocs/schemas/api_vault_redeem_cancel_request.md

@@ -3,5 +3,4 @@
 
     |Name<br>`Lite`|Type|Required<br>`Default`| Description |
     |-|-|-|-|
-    |main_account_id<br>`ma` |string|True|The address of the main account initiating the cancellation.|
     |vault_id<br>`vi` |string|True|The unique identifier of the vault to cancel the redemption from.|

artifacts/apidocs/schemas/api_vault_redeem_request.md

@@ -3,7 +3,6 @@
 
     |Name<br>`Lite`|Type|Required<br>`Default`| Description |
     |-|-|-|-|
-    |main_account_id<br>`ma` |string|True|The address of the main account initiating the redemption.|
     |vault_id<br>`vi` |string|True|The unique identifier of the vault to redeem from.|
     |currency<br>`c` |string|True|The currency used for the redemption. This should be the vault's quote currency.|
     |num_tokens<br>`nt` |string|True|The number of shares to redeem.|

artifacts/apidocs/schemas/api_vault_view_redemption_queue_request.md

@@ -3,5 +3,4 @@
 
     |Name<br>`Lite`|Type|Required<br>`Default`| Description |
     |-|-|-|-|
-    |main_account_id<br>`ma` |string|True|The address of the vault manager making the request.|
     |vault_id<br>`vi` |string|True|The unique identifier of the vault to fetch the redemption queue for.|

artifacts/apidocs/schemas/api_vault_view_redemption_queue_response.md

@@ -1,5 +1,5 @@
 !!! info "[ApiVaultViewRedemptionQueueResponse](/../../schemas/api_vault_view_redemption_queue_response)"
-    Response payload for a vault manager to view the redemption queue for their vault, ordered by descending priority.<br><br>Excludes requests that have not yet aged past the minmimum redemption period.<br><br>Also includes counters for total redemption sizes pending as well as urgent (refer to API integration guide for more detail on redemption request classifications).<br><br><br>
+    Response payload for a vault manager to view the redemption queue for their vault, ordered by descending priority.<br><br>Also includes counters for total redemption sizes pending as well as urgent (refer to API integration guide for more detail on redemption request classifications).<br><br><br>
 
     |Name<br>`Lite`|Type|Required<br>`Default`| Description |
     |-|-|-|-|
@@ -8,6 +8,7 @@
     |urgent_redemption_token_count<br>`ur` |string|True|Number of shares nearing the maximum redemption period (>= 90% of maximum redemption period).|
     |auto_redeemable_balance<br>`ar` |string|True|Amount available for automated redemption request servicing (in USD).|
     |share_price<br>`sp` |string|True|Current share price (in USD).|
+    |pre_min<br>`pm` |PreMinRedemptions|True|Dedicated section for requests yet to wait at least the minimum redemption period.|
     ??? info "[VaultRedemptionRequest](/../../schemas/vault_redemption_request)"
         Representation of a pending redemption request for a given vault.<br>
 
@@ -18,6 +19,7 @@
         |max_redemption_period_timestamp<br>`mr` |string|True|[Filled by GRVT Backend] Time in unix nanoseconds, beyond which the request will be force-redeemed.|
         |age_category<br>`ac` |VaultRedemptionReqAgeCategory|True|Age category of this redemption request.|
         |is_manager<br>`im` |boolean|False<br>`None`|`true` if this request belongs to the vault manager, omitted otherwise.|
+        |eligible_for_auto_redemption_timestamp<br>`ef` |string|True|[Filled by GRVT Backend] Time in unix nanoseconds, beyond which the request will be eligible for automated redemption.|
         ??? info "[VaultRedemptionReqAgeCategory](/../../schemas/vault_redemption_req_age_category)"
             Denotes the age category of a given redemption request.<br><br><br>
 
@@ -27,3 +29,30 @@
             |`URGENT` = 2|This request is nearing the maxmimum redemption period and will be factored into pre-order check margin requirements.|
             |`OVERDUE` = 3|This request has exceeded the maximum redemption period and will be considered for forced redemptions.|
             |`PRE_MIN` = 4|This request has yet to exceed the minimum redemption period, and is not yet eligible for automated redemption.|
+    ??? info "[PreMinRedemptions](/../../schemas/pre_min_redemptions)"
+        Vault redemption queue section hidden from main view. All requests here have yet to age past the vault's minimum redemption period.<br>
+
+        |Name<br>`Lite`|Type|Required<br>`Default`| Description |
+        |-|-|-|-|
+        |requests<br>`r` |[VaultRedemptionRequest]|True|Pre-minimum-age redemption requests, ordered by age (first element is the oldest request that is pre-minimum-age).|
+        |token_count<br>`tc` |string|True|Number of shares in the pre-minimum-age section of the vault's redemption queue.|
+        ??? info "[VaultRedemptionRequest](/../../schemas/vault_redemption_request)"
+            Representation of a pending redemption request for a given vault.<br>
+
+            |Name<br>`Lite`|Type|Required<br>`Default`| Description |
+            |-|-|-|-|
+            |request_time<br>`rt` |string|True|[Filled by GRVT Backend] Time at which the redemption request was received by GRVT in unix nanoseconds|
+            |num_lp_tokens<br>`nl` |string|True|The number of shares to redeem|
+            |max_redemption_period_timestamp<br>`mr` |string|True|[Filled by GRVT Backend] Time in unix nanoseconds, beyond which the request will be force-redeemed.|
+            |age_category<br>`ac` |VaultRedemptionReqAgeCategory|True|Age category of this redemption request.|
+            |is_manager<br>`im` |boolean|False<br>`None`|`true` if this request belongs to the vault manager, omitted otherwise.|
+            |eligible_for_auto_redemption_timestamp<br>`ef` |string|True|[Filled by GRVT Backend] Time in unix nanoseconds, beyond which the request will be eligible for automated redemption.|
+            ??? info "[VaultRedemptionReqAgeCategory](/../../schemas/vault_redemption_req_age_category)"
+                Denotes the age category of a given redemption request.<br><br><br>
+
+                |Value| Description |
+                |-|-|
+                |`NORMAL` = 1|This request is at least as old as the minimum redemption period, and is eligible for automated redemption.|
+                |`URGENT` = 2|This request is nearing the maxmimum redemption period and will be factored into pre-order check margin requirements.|
+                |`OVERDUE` = 3|This request has exceeded the maximum redemption period and will be considered for forced redemptions.|
+                |`PRE_MIN` = 4|This request has yet to exceed the minimum redemption period, and is not yet eligible for automated redemption.|

artifacts/apidocs/schemas/funding_account_summary.md

@@ -6,9 +6,18 @@
     |main_account_id<br>`ma` |string|True|The main account ID of the account to which the summary belongs|
     |total_equity<br>`te` |string|True|Total equity of the main account, denominated in USD|
     |spot_balances<br>`sb` |[SpotBalance]|True|The list of spot assets owned by this main account, and their balances|
+    |vault_investments<br>`vi` |[VaultInvestment]|True|The list of vault investments held by this main account|
     ??? info "[SpotBalance](/../../schemas/spot_balance)"
         |Name<br>`Lite`|Type|Required<br>`Default`| Description |
         |-|-|-|-|
         |currency<br>`c` |string|True|The currency you hold a spot balance in|
         |balance<br>`b` |string|True|This currency's balance in this trading account.|
         |index_price<br>`ip` |string|True|The index price of this currency. (reported in `USD`)|
+    ??? info "[VaultInvestment](/../../schemas/vault_investment)"
+        Summarizes a vault investment held by a funding account<br>
+
+        |Name<br>`Lite`|Type|Required<br>`Default`| Description |
+        |-|-|-|-|
+        |vault_id<br>`vi` |string|True|The trading account ID of the vault invested in.|
+        |num_lp_tokens<br>`nl` |string|True|The number of shares held by the investor.|
+        |share_price<br>`sp` |string|True|The current share price (in USD) of this vault investment.|

artifacts/apidocs/schemas/pre_min_redemptions.md

@@ -0,0 +1,27 @@
+!!! info "[PreMinRedemptions](/../../schemas/pre_min_redemptions)"
+    Vault redemption queue section hidden from main view. All requests here have yet to age past the vault's minimum redemption period.<br>
+
+    |Name<br>`Lite`|Type|Required<br>`Default`| Description |
+    |-|-|-|-|
+    |requests<br>`r` |[VaultRedemptionRequest]|True|Pre-minimum-age redemption requests, ordered by age (first element is the oldest request that is pre-minimum-age).|
+    |token_count<br>`tc` |string|True|Number of shares in the pre-minimum-age section of the vault's redemption queue.|
+    ??? info "[VaultRedemptionRequest](/../../schemas/vault_redemption_request)"
+        Representation of a pending redemption request for a given vault.<br>
+
+        |Name<br>`Lite`|Type|Required<br>`Default`| Description |
+        |-|-|-|-|
+        |request_time<br>`rt` |string|True|[Filled by GRVT Backend] Time at which the redemption request was received by GRVT in unix nanoseconds|
+        |num_lp_tokens<br>`nl` |string|True|The number of shares to redeem|
+        |max_redemption_period_timestamp<br>`mr` |string|True|[Filled by GRVT Backend] Time in unix nanoseconds, beyond which the request will be force-redeemed.|
+        |age_category<br>`ac` |VaultRedemptionReqAgeCategory|True|Age category of this redemption request.|
+        |is_manager<br>`im` |boolean|False<br>`None`|`true` if this request belongs to the vault manager, omitted otherwise.|
+        |eligible_for_auto_redemption_timestamp<br>`ef` |string|True|[Filled by GRVT Backend] Time in unix nanoseconds, beyond which the request will be eligible for automated redemption.|
+        ??? info "[VaultRedemptionReqAgeCategory](/../../schemas/vault_redemption_req_age_category)"
+            Denotes the age category of a given redemption request.<br><br><br>
+
+            |Value| Description |
+            |-|-|
+            |`NORMAL` = 1|This request is at least as old as the minimum redemption period, and is eligible for automated redemption.|
+            |`URGENT` = 2|This request is nearing the maxmimum redemption period and will be factored into pre-order check margin requirements.|
+            |`OVERDUE` = 3|This request has exceeded the maximum redemption period and will be considered for forced redemptions.|
+            |`PRE_MIN` = 4|This request has yet to exceed the minimum redemption period, and is not yet eligible for automated redemption.|

artifacts/apidocs/schemas/vault_investment.md

@@ -0,0 +1,8 @@
+!!! info "[VaultInvestment](/../../schemas/vault_investment)"
+    Summarizes a vault investment held by a funding account<br>
+
+    |Name<br>`Lite`|Type|Required<br>`Default`| Description |
+    |-|-|-|-|
+    |vault_id<br>`vi` |string|True|The trading account ID of the vault invested in.|
+    |num_lp_tokens<br>`nl` |string|True|The number of shares held by the investor.|
+    |share_price<br>`sp` |string|True|The current share price (in USD) of this vault investment.|

artifacts/apidocs/schemas/vault_redemption_request.md

@@ -8,6 +8,7 @@
     |max_redemption_period_timestamp<br>`mr` |string|True|[Filled by GRVT Backend] Time in unix nanoseconds, beyond which the request will be force-redeemed.|
     |age_category<br>`ac` |VaultRedemptionReqAgeCategory|True|Age category of this redemption request.|
     |is_manager<br>`im` |boolean|False<br>`None`|`true` if this request belongs to the vault manager, omitted otherwise.|
+    |eligible_for_auto_redemption_timestamp<br>`ef` |string|True|[Filled by GRVT Backend] Time in unix nanoseconds, beyond which the request will be eligible for automated redemption.|
     ??? info "[VaultRedemptionReqAgeCategory](/../../schemas/vault_redemption_req_age_category)"
         Denotes the age category of a given redemption request.<br><br><br>