@agg-build/sdk 4.17.1 → 4.17.4

package/dist/index.d.mts

@@ -711,7 +711,15 @@ type PositionGroup = {
                 venueMarketOutcomeId: string;
             }[];
             totalSize: number;
+            /** Weighted over legs with a known entry price — see `costBasisUnknown`. */
             avgEntryPrice: number;
+            /**
+             * At least one leg was imported from an externally-acquired self-custody
+             * balance with no acquisition price we could reconcile. `totalValue`
+             * covers every leg; `avgEntryPrice` and `unrealizedPnl` cover only the
+             * legs with a known entry, and are 0 when none of them do.
+             */
+            costBasisUnknown?: boolean;
             currentPrice: number;
             totalValue: number;
             unrealizedPnlPercent: number;
@@ -2284,6 +2292,8 @@ interface SignatureRequest {
     /** Sign verbatim. */
     payload: unknown;
     expiresAt: string;
+    /** Why this signature is being asked for, when the server knows (e.g. `"fee"`, `"funding_and_fee"`). Display only. */
+    purpose?: string;
 }
 /**
  * Supplied by the partner. Receives a payload, returns a signature. The SDK
@@ -3089,6 +3099,14 @@ interface PlaceOrderParams {
     allowedSourceChainIds?: number[];
     /** USD budgets capped by refreshed wallet balances; omitted chains cannot fund. */
     chainBalances?: Record<string, number>;
+    /** Referral: EVM address that receives the referral fee. Needs an app API key. */
+    referrer?: string;
+    /** Referral fee in bips of routed notional (1..10000). Snag-free. */
+    referrerFeeBips?: number;
+    /** Who funds the referral: "user" (default) reserves it from maxSpend; "app" pays from `referralPayerAddress` after the fill. */
+    referralPayer?: "user" | "app";
+    /** Required with `referralPayer: "app"`: the wallet that signs the parked payout transaction. */
+    referralPayerAddress?: string;
     /**
      * Skip the smart-route solver and send one order straight to `venue` (predict,
      * hyperliquid, novig and prophetx only; others return 400). Requires a `read_write` `x-app-api-key`. No
@@ -3847,6 +3865,13 @@ interface VenueSoloQuote {
     estimatedPayout: number;
     estimatedProfit: number;
     returnPct: number;
+    /**
+     * `feeBreakdown.totalCost` plus this solo's own user-paid app fee and
+     * referral — same composition as the primary route's `totalCostIncFees`.
+     * `estimatedProfit`/`returnPct` stay router values, unaffected. Absent
+     * when the router sent no `feeBreakdown` for this solo.
+     */
+    totalCostIncFees?: number;
     status: string;
     /** Per-price-level fills, identical shape to primary fills. Empty for non-ok statuses. */
     fills: SmartRouteVenueFill[];
@@ -3913,6 +3938,14 @@ interface SmartRouteParams {
      * budget.
      */
     deepEstimate?: boolean;
+    /** Referral: EVM address that receives the referral fee. Needs an app API key. */
+    referrer?: string;
+    /** Referral fee in bips of routed notional (1..10000). Snag-free. */
+    referrerFeeBips?: number;
+    /** Who funds the referral: "user" (default) reserves it from maxSpend; "app" pays from `referralPayerAddress` after the fill. */
+    referralPayer?: "user" | "app";
+    /** Required with `referralPayer: "app"`: the wallet that signs the parked payout transaction. */
+    referralPayerAddress?: string;
 }
 /** One-time setup line item — populated only on deep-estimate quotes. */
 interface SmartRouteSetupCostLine {
@@ -3973,6 +4006,10 @@ interface SmartRouteFeeBreakdown {
     appFeeBips?: number;
     /** Category key the bips resolved against (e.g. "sports", or "all" for the fallback). */
     appFeeCategory?: string;
+    /** The `executionGas` line when it is actually collected with the app fee. Present iff > 0; already inside `totalCost`. */
+    gasReimbursement?: number;
+    /** Referral fee the USER pays, in USD. Present iff > 0 and `referralPayer` is "user"; already inside `totalCostIncFees`. An app-paid referral never appears here. */
+    referralFee?: number;
 }
 /** Response from GET /orderbook/:venueMarketOutcomeId/route. */
 interface SmartRouteSettlementLeg {
@@ -4081,6 +4118,14 @@ interface SmartRouteResponse {
         categoryKey: string;
         quotedAppFeeRaw: string;
     } | null;
+    /** Referral snapshot; null/absent when no referrer was accepted. */
+    referral?: {
+        referrer: string;
+        feeBips: number;
+        payer: "user" | "app";
+        payerAddress?: string;
+        quotedFeeUsd: number;
+    } | null;
     /** Populated only when status === "insufficient_position". */
     positionAvailability?: {
         totalSellableShares: number;

package/dist/index.d.ts

@@ -711,7 +711,15 @@ type PositionGroup = {
                 venueMarketOutcomeId: string;
             }[];
             totalSize: number;
+            /** Weighted over legs with a known entry price — see `costBasisUnknown`. */
             avgEntryPrice: number;
+            /**
+             * At least one leg was imported from an externally-acquired self-custody
+             * balance with no acquisition price we could reconcile. `totalValue`
+             * covers every leg; `avgEntryPrice` and `unrealizedPnl` cover only the
+             * legs with a known entry, and are 0 when none of them do.
+             */
+            costBasisUnknown?: boolean;
             currentPrice: number;
             totalValue: number;
             unrealizedPnlPercent: number;
@@ -2284,6 +2292,8 @@ interface SignatureRequest {
     /** Sign verbatim. */
     payload: unknown;
     expiresAt: string;
+    /** Why this signature is being asked for, when the server knows (e.g. `"fee"`, `"funding_and_fee"`). Display only. */
+    purpose?: string;
 }
 /**
  * Supplied by the partner. Receives a payload, returns a signature. The SDK
@@ -3089,6 +3099,14 @@ interface PlaceOrderParams {
     allowedSourceChainIds?: number[];
     /** USD budgets capped by refreshed wallet balances; omitted chains cannot fund. */
     chainBalances?: Record<string, number>;
+    /** Referral: EVM address that receives the referral fee. Needs an app API key. */
+    referrer?: string;
+    /** Referral fee in bips of routed notional (1..10000). Snag-free. */
+    referrerFeeBips?: number;
+    /** Who funds the referral: "user" (default) reserves it from maxSpend; "app" pays from `referralPayerAddress` after the fill. */
+    referralPayer?: "user" | "app";
+    /** Required with `referralPayer: "app"`: the wallet that signs the parked payout transaction. */
+    referralPayerAddress?: string;
     /**
      * Skip the smart-route solver and send one order straight to `venue` (predict,
      * hyperliquid, novig and prophetx only; others return 400). Requires a `read_write` `x-app-api-key`. No
@@ -3847,6 +3865,13 @@ interface VenueSoloQuote {
     estimatedPayout: number;
     estimatedProfit: number;
     returnPct: number;
+    /**
+     * `feeBreakdown.totalCost` plus this solo's own user-paid app fee and
+     * referral — same composition as the primary route's `totalCostIncFees`.
+     * `estimatedProfit`/`returnPct` stay router values, unaffected. Absent
+     * when the router sent no `feeBreakdown` for this solo.
+     */
+    totalCostIncFees?: number;
     status: string;
     /** Per-price-level fills, identical shape to primary fills. Empty for non-ok statuses. */
     fills: SmartRouteVenueFill[];
@@ -3913,6 +3938,14 @@ interface SmartRouteParams {
      * budget.
      */
     deepEstimate?: boolean;
+    /** Referral: EVM address that receives the referral fee. Needs an app API key. */
+    referrer?: string;
+    /** Referral fee in bips of routed notional (1..10000). Snag-free. */
+    referrerFeeBips?: number;
+    /** Who funds the referral: "user" (default) reserves it from maxSpend; "app" pays from `referralPayerAddress` after the fill. */
+    referralPayer?: "user" | "app";
+    /** Required with `referralPayer: "app"`: the wallet that signs the parked payout transaction. */
+    referralPayerAddress?: string;
 }
 /** One-time setup line item — populated only on deep-estimate quotes. */
 interface SmartRouteSetupCostLine {
@@ -3973,6 +4006,10 @@ interface SmartRouteFeeBreakdown {
     appFeeBips?: number;
     /** Category key the bips resolved against (e.g. "sports", or "all" for the fallback). */
     appFeeCategory?: string;
+    /** The `executionGas` line when it is actually collected with the app fee. Present iff > 0; already inside `totalCost`. */
+    gasReimbursement?: number;
+    /** Referral fee the USER pays, in USD. Present iff > 0 and `referralPayer` is "user"; already inside `totalCostIncFees`. An app-paid referral never appears here. */
+    referralFee?: number;
 }
 /** Response from GET /orderbook/:venueMarketOutcomeId/route. */
 interface SmartRouteSettlementLeg {
@@ -4081,6 +4118,14 @@ interface SmartRouteResponse {
         categoryKey: string;
         quotedAppFeeRaw: string;
     } | null;
+    /** Referral snapshot; null/absent when no referrer was accepted. */
+    referral?: {
+        referrer: string;
+        feeBips: number;
+        payer: "user" | "app";
+        payerAddress?: string;
+        quotedFeeUsd: number;
+    } | null;
     /** Populated only when status === "insufficient_position". */
     positionAvailability?: {
         totalSellableShares: number;

package/dist/index.js

@@ -3315,6 +3315,10 @@ Issued At: ${issuedAt}`;
       if (params.tradeSide) query.side = params.tradeSide;
       if (params.mode) query.mode = params.mode;
       if (params.deepEstimate) query.deepEstimate = "true";
+      if (params.referrer) query.referrer = params.referrer;
+      if (params.referrerFeeBips != null) query.referrerFeeBips = String(params.referrerFeeBips);
+      if (params.referralPayer) query.referralPayer = params.referralPayer;
+      if (params.referralPayerAddress) query.referralPayerAddress = params.referralPayerAddress;
       const response = yield this.request(
         `/orderbook/${encodeURIComponent(venueMarketOutcomeId)}/route`,
         { query, signal: options == null ? void 0 : options.signal }

package/dist/index.mjs

@@ -3183,6 +3183,10 @@ Issued At: ${issuedAt}`;
       if (params.tradeSide) query.side = params.tradeSide;
       if (params.mode) query.mode = params.mode;
       if (params.deepEstimate) query.deepEstimate = "true";
+      if (params.referrer) query.referrer = params.referrer;
+      if (params.referrerFeeBips != null) query.referrerFeeBips = String(params.referrerFeeBips);
+      if (params.referralPayer) query.referralPayer = params.referralPayer;
+      if (params.referralPayerAddress) query.referralPayerAddress = params.referralPayerAddress;
       const response = yield this.request(
         `/orderbook/${encodeURIComponent(venueMarketOutcomeId)}/route`,
         { query, signal: options == null ? void 0 : options.signal }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agg-build/sdk",
-  "version": "4.17.1",
+  "version": "4.17.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.",
   "sideEffects": false,
   "license": "MIT",