docs(strategy): align strategy authoring docs with engine#48
Open
NicolaBernini wants to merge 1 commit into
Open
docs(strategy): align strategy authoring docs with engine#48NicolaBernini wants to merge 1 commit into
NicolaBernini wants to merge 1 commit into
Conversation
Alignment pass against the superman-strategy engine surfaced drift in the strategy authoring pages: - quickstart: the withdrawal example used a nonexistent hook (ApproveAndWithdraw4626VaultHook) and asset-denominated sizing. The real withdrawal hook is Redeem4626VaultHook, which calls redeem(shares), so size_expr must be share-denominated. Switched to 0.5 * ys_<addr>_shares. - dsl: the variable tables listed identifiers the engine snapshot does not emit (ys_*_alloc, vault_pps_stale/_age_seconds, tick_age_seconds/ _block_number/_timestamp). Replaced with the canonical keys from internal/domain/eval_state_keys.go and listed the valid ys_ metric suffixes. - Documented that size_expr units differ by action (asset wei for DEPOSIT, share wei for WITHDRAWAL/redeem) across quickstart, dsl, and action-config, including why an assets->shares pps division fails validation. - action-config: added missing optional fields (max_duration_seconds, allow_order_splitting, venue lists, merkle descriptors). - Noted the validator does not check hook-registry existence or size_expr units (only shape/identifier/dry-run checks). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Alignment pass against the superman-strategy engine surfaced drift in the strategy authoring pages:
Following up on https://linear.app/superform/issue/SUP-19908/superform-institutional-check-doc-against-the-real-code and fixing according to https://linear.app/superform/issue/SUP-19909/fix-sup-19908