Skip to content

[RFC] Update API docs and specs #69

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
Keithagy merged 1 commit into from
Jul 28, 2025
Merged

[RFC] Update API docs and specs #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions artifacts/apidocs/schemas/api_vault_investor_summary_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
|total_equity<br>`te` |string|True|The current valuation (in USD) of all held vault LP tokens.|
|all_time_realized_pnl<br>`at` |string|True|The all-time realized PnL (in USD) that the investor has received from the vault.|
|pending_redemption<br>`pr` |VaultRedemption|False<br>`None`|The singleton pending redemption (omitted if none).|
|can_burn<br>`cb` |boolean|False<br>`true`|True if the requesting account is authorized to burn tokens on this vault, omitted otherwise.|
??? info "[VaultRedemption](/../../schemas/vault_redemption)"
Vault redemption information.<br><br>This struct contains information about a pending redemption from a vault.<br>

Expand Down
1 change: 1 addition & 0 deletions artifacts/apidocs/schemas/vault_investor_summary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
|total_equity<br>`te` |string|True|The current valuation (in USD) of all held vault LP tokens.|
|all_time_realized_pnl<br>`at` |string|True|The all-time realized PnL (in USD) that the investor has received from the vault.|
|pending_redemption<br>`pr` |VaultRedemption|False<br>`None`|The singleton pending redemption (omitted if none).|
|can_burn<br>`cb` |boolean|False<br>`true`|True if the requesting account is authorized to burn tokens on this vault, omitted otherwise.|
??? info "[VaultRedemption](/../../schemas/vault_redemption)"
Vault redemption information.<br><br>This struct contains information about a pending redemption from a vault.<br>

Expand Down
26 changes: 14 additions & 12 deletions artifacts/apidocs/trading_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10875,7 +10875,8 @@ LITE ENDPOINT: lite/v1/vault_investor_summary
"request_valuation": 1000000,
"request_time": "1697788800000000000",
"max_redemption_period_timestamp": 1727788800000000000
}
},
"can_burn": null
}]
}
```
Expand All @@ -10894,7 +10895,8 @@ LITE ENDPOINT: lite/v1/vault_investor_summary
"rv": 1000000,
"rt": "1697788800000000000",
"mr": 1727788800000000000
}
},
"cb": null
}]
}
```
Expand Down Expand Up @@ -12366,11 +12368,11 @@ LITE ENDPOINT: lite/v1/vault_manager_investor_history
"event_time": "1697788800000000000",
"off_chain_account_id": "ACC:123456",
"vault_id": "2312134",
"type": "vaultInvest",
"price": 1000000,
"size": 1000000,
"realized_pnl": 1000000,
"performance_fee": 1000000
"type": "VAULT_INVEST",
"price": "1000000",
"size": "1000000",
"realized_pnl": "1000000",
"performance_fee": "1000000"
}]
}
```
Expand All @@ -12381,11 +12383,11 @@ LITE ENDPOINT: lite/v1/vault_manager_investor_history
"et": "1697788800000000000",
"oc": "ACC:123456",
"vi": "2312134",
"t": "vaultInvest",
"p": 1000000,
"s": 1000000,
"rp": 1000000,
"pf": 1000000
"t": "VAULT_INVEST",
"p": "1000000",
"s": "1000000",
"rp": "1000000",
"pf": "1000000"
}]
}
```
Expand Down
2 changes: 2 additions & 0 deletions artifacts/pysdk/grvt_raw_types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2673,6 +2673,8 @@ class VaultInvestorSummary:
all_time_realized_pnl: str
# The singleton pending redemption (omitted if none).
pending_redemption: VaultRedemption | None = None
# True if the requesting account is authorized to burn tokens on this vault, omitted otherwise.
can_burn: bool | None = None


@dataclass
Expand Down
23 changes: 18 additions & 5 deletions src/codegen/apispec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8133,7 +8133,7 @@
"index": 3,
"array_depth": 0,
"optional": false,
"example": "'vaultInvest'",
"example": "'VAULT_INVEST'",
"comment": [
"The type of transaction that occurred. List of types: vaultInvest, vaultBurnLpToken, vaultRedeem"
]
Expand All @@ -8146,7 +8146,7 @@
"index": 4,
"array_depth": 0,
"optional": false,
"example": "1000000",
"example": "'1000000'",
"comment": [
"The price of the vault LP tokens at the time of the event."
]
Expand All @@ -8159,7 +8159,7 @@
"index": 5,
"array_depth": 0,
"optional": false,
"example": "1000000",
"example": "'1000000'",
"comment": [
"The amount of Vault LP tokens invested or redeemed."
]
Expand All @@ -8172,7 +8172,7 @@
"index": 6,
"array_depth": 0,
"optional": false,
"example": "1000000",
"example": "'1000000'",
"comment": [
"The realized PnL of the vault."
]
Expand All @@ -8185,7 +8185,7 @@
"index": 7,
"array_depth": 0,
"optional": false,
"example": "1000000",
"example": "'1000000'",
"comment": [
"The performance fee of the vault."
]
Expand Down Expand Up @@ -12017,6 +12017,19 @@
"comment": [
"The singleton pending redemption (omitted if none)."
]
},
{
"name": "can_burn",
"lite_name": "cb",
"semantic_type": "bool",
"json_type": "boolean",
"index": 7,
"array_depth": 0,
"optional": true,
"default": "true",
"comment": [
"True if the requesting account is authorized to burn tokens on this vault, omitted otherwise."
]
}
],
"comment": [
Expand Down