@agg-build/sdk 4.11.0 → 4.11.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -3661,6 +3661,12 @@ interface SmartRouteVenueFill {
3661
3661
  * older engine build that does not emit it still validates.
3662
3662
  */
3663
3663
  builderFee?: number;
3664
+ /**
3665
+ * What the venue takes from this leg's payout if the outcome wins (USD):
3666
+ * Hyperliquid HIP-4's close fee on the $1 settlement, 0 elsewhere. Not a
3667
+ * cost at fill; already netted out of `estimatedPayout`.
3668
+ */
3669
+ settlementFee?: number;
3664
3670
  /** Inclusive fee/reserve funding budget. For fee display, use the route's
3665
3671
  * feeBreakdown.venueFees and executionReserve instead. */
3666
3672
  venueFee?: number;
@@ -3677,7 +3683,16 @@ interface SmartRouteAllocation {
3677
3683
  interface SmartRouteBridgeStep {
3678
3684
  sourceChainId: string;
3679
3685
  destChainId: string;
3686
+ /** Source-side amount sent into the bridge, in USD: the allocations this lane funds plus `cost`. */
3680
3687
  amount: number;
3688
+ /**
3689
+ * Delivery margin, in USD, sent on top of the allocations so the destination
3690
+ * still receives them in full after the bridge takes its fee. A planning
3691
+ * reserve, not the expected fee: excluded from `feeBreakdown.bridgeFees` and
3692
+ * `totalCost`, and whatever the bridge does not charge arrives at the
3693
+ * destination as the user's balance. Read `feeBreakdown.bridgeFees` for the
3694
+ * expected bridge fee.
3695
+ */
3681
3696
  cost: number;
3682
3697
  sourceTokenAddress?: string;
3683
3698
  destTokenAddress?: string;
@@ -3913,7 +3928,8 @@ interface SmartRouteResponse {
3913
3928
  * `slippage.slippageBps` to flag thin liquidity.
3914
3929
  */
3915
3930
  slippage?: SmartRouteSlippage;
3916
- /** Estimated payout if the outcome wins (= totalFilled shares × $1). */
3931
+ /** Estimated payout if the outcome wins (= totalFilled shares × $1, less
3932
+ * settlement fees — see `fills[].settlementFee`). */
3917
3933
  estimatedPayout?: number;
3918
3934
  /** Total cost including all fees (rawExecCost + venueFees + bridgeFees +
3919
3935
  * executionGas). For deep-estimate quotes, `setupCostsTotal` is folded
package/dist/index.d.ts CHANGED
@@ -3661,6 +3661,12 @@ interface SmartRouteVenueFill {
3661
3661
  * older engine build that does not emit it still validates.
3662
3662
  */
3663
3663
  builderFee?: number;
3664
+ /**
3665
+ * What the venue takes from this leg's payout if the outcome wins (USD):
3666
+ * Hyperliquid HIP-4's close fee on the $1 settlement, 0 elsewhere. Not a
3667
+ * cost at fill; already netted out of `estimatedPayout`.
3668
+ */
3669
+ settlementFee?: number;
3664
3670
  /** Inclusive fee/reserve funding budget. For fee display, use the route's
3665
3671
  * feeBreakdown.venueFees and executionReserve instead. */
3666
3672
  venueFee?: number;
@@ -3677,7 +3683,16 @@ interface SmartRouteAllocation {
3677
3683
  interface SmartRouteBridgeStep {
3678
3684
  sourceChainId: string;
3679
3685
  destChainId: string;
3686
+ /** Source-side amount sent into the bridge, in USD: the allocations this lane funds plus `cost`. */
3680
3687
  amount: number;
3688
+ /**
3689
+ * Delivery margin, in USD, sent on top of the allocations so the destination
3690
+ * still receives them in full after the bridge takes its fee. A planning
3691
+ * reserve, not the expected fee: excluded from `feeBreakdown.bridgeFees` and
3692
+ * `totalCost`, and whatever the bridge does not charge arrives at the
3693
+ * destination as the user's balance. Read `feeBreakdown.bridgeFees` for the
3694
+ * expected bridge fee.
3695
+ */
3681
3696
  cost: number;
3682
3697
  sourceTokenAddress?: string;
3683
3698
  destTokenAddress?: string;
@@ -3913,7 +3928,8 @@ interface SmartRouteResponse {
3913
3928
  * `slippage.slippageBps` to flag thin liquidity.
3914
3929
  */
3915
3930
  slippage?: SmartRouteSlippage;
3916
- /** Estimated payout if the outcome wins (= totalFilled shares × $1). */
3931
+ /** Estimated payout if the outcome wins (= totalFilled shares × $1, less
3932
+ * settlement fees — see `fills[].settlementFee`). */
3917
3933
  estimatedPayout?: number;
3918
3934
  /** Total cost including all fees (rawExecCost + venueFees + bridgeFees +
3919
3935
  * executionGas). For deep-estimate quotes, `setupCostsTotal` is folded
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@agg-build/sdk",
3
- "version": "4.11.0",
3
+ "version": "4.11.3",
4
4
  "description": "Vanilla TypeScript client for the AGG prediction market aggregator (auth, markets, orderbooks, charts, trading, managed execution, WebSockets). Works in browsers, Node.js, and React Native.",
5
5
  "sideEffects": false,
6
6
  "license": "MIT",