chore: add failed reason to sdks (#554)

* add failed reason to sdks

* add failed reason to sdks

Author: guibescos

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to the searcher sdks will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
+## [Rust: 0.13.0, Python 0.28.0, Javascript 0.29.0, api-types 0.12.0] - 2025-05-14
+
+- Failed bids for swap quotes now have a reason status that exposes why the transaction failed on-chain. [554](https://github.com/pyth-network/per/pull/554)
+
 ## [Rust: 0.12.0, Python 0.27.0, Javascript 0.28.0, api-types 0.11.0] - 2025-05-09
 
 - Add a profile ID field to the opportunity api type. [538](https://github.com/pyth-network/per/pull/538)

Cargo.lock

@@ -1,6 +1,6 @@
 {
   "name": "@pythnetwork/express-relay-js",
-  "version": "0.28.0",
+  "version": "0.29.0",
   "description": "Utilities for interacting with the express relay protocol",
   "homepage": "https://github.com/pyth-network/per/tree/main/sdk/js",
   "author": "Douro Labs",

sdk/js/package.json

@@ -262,6 +262,13 @@ export interface components {
     };
     /** @enum {string} */
     BidCreateSwapSvmTag: "swap";
+    /** @enum {string} */
+    BidFailedReason:
+      | "insufficient_user_funds"
+      | "insufficient_searcher_funds"
+      | "insufficient_funds_sol_transfer"
+      | "deadline_passed"
+      | "other";
     BidResult: {
       /**
        * @description The unique id created to identify the bid. This id can be used to query the status of the bid.
@@ -311,6 +318,7 @@ export interface components {
           type: "won";
         }
       | {
+          reason?: null | components["schemas"]["BidFailedReason"];
           /** @example Jb2urXPyEh4xiBgzYvwEFe4q1iMxG1DNxWGGQg94AmKgqFTwLAiTiHrYiYxwHUB4DV8u5ahNEVtMMDm3sNSRdTg */
           result: string;
           /** @enum {string} */
@@ -670,7 +678,7 @@ export interface components {
       /**
        * @description Whether the quote is cancellable by the searcher between the time the quote is requested and the time the quote is signed and submitted back.
        *     For cancellable quotes, the quote needs to be signed and submitted back to the API. If the quote is not cancellable, the user may broadcast the transaction to the blockchain on their own instead of submitting it back to the API.
-       *     Therefore cancellable quotes allow the integrator to reduce the number of API calls to one, but at the cost of potentially worse prices. Price-optimizing integrators should use the default value of false.
+       *     Therefore, non-cancellable quotes allow the integrator to reduce the number of API calls to one, but at the cost of potentially worse prices. Price-optimizing integrators should use the default value of true.
        * @example true
        */
       cancellable?: boolean;

sdk/js/src/serverTypes.d.ts

@@ -36,5 +36,13 @@ class BidSubmissionFailedReasonVariantsSvm(Enum):
     DEADLINE_PASSED = "deadline_passed"
 
 
+class BidFailedReasonVariantsSvm(Enum):
+    INSUFFICIENT_USER_FUNDS = "insufficient_user_funds"
+    INSUFFICIENT_SEARCHER_FUNDS = "insufficient_searcher_funds"
+    INSUFFICIENT_FUNDS_SOL_TRANSFER = "insufficient_funds_sol_transfer"
+    DEADLINE_PASSED = "deadline_passed"
+    OTHER = "other"
+
+
 IntString = Annotated[int, PlainSerializer(lambda x: str(x), return_type=str)]
 UUIDString = Annotated[UUID, PlainSerializer(lambda x: str(x), return_type=str)]

sdk/python/express_relay/models/base.py

@@ -4,6 +4,7 @@
 from typing import Annotated, Any, ClassVar, Literal
 
 from express_relay.models.base import (
+    BidFailedReasonVariantsSvm,
     BidStatusVariantsSvm,
     BidSubmissionFailedReasonVariantsSvm,
     IntString,
@@ -382,12 +383,14 @@ class BidStatusSvm(BaseModel):
         type: The current status of the bid.
         result: The result of the bid: a transaction hash if the status is not PENDING.
                 The LOST status may have a result.
-        reason: The reason for the bid submission failure. This is only set when the status is SUBMISSION_FAILED.
+        reason: The reason for the bid submission failure. This is only set when the status is SUBMISSION_FAILED or FAILED.
     """
 
     type: BidStatusVariantsSvm
     result: SvmSignature | None = Field(default=None)
-    reason: BidSubmissionFailedReasonVariantsSvm | None = Field(default=None)
+    reason: BidSubmissionFailedReasonVariantsSvm | BidFailedReasonVariantsSvm | None = (
+        Field(default=None)
+    )
 
     @field_validator("type", mode="before")
     @classmethod
@@ -407,10 +410,13 @@ def check_result(self):
 
     @model_validator(mode="after")
     def check_failed_reason(self):
-        if self.type == BidStatusVariantsSvm.SUBMISSION_FAILED:
+        if (
+            self.type == BidStatusVariantsSvm.SUBMISSION_FAILED
+            or self.type == BidStatusVariantsSvm.FAILED
+        ):
             assert (
                 self.reason is not None
-            ), "bid reason should not be empty when status is submission failed"
+            ), "bid reason should not be empty when status is submission failed or failed"
         return self
 
 

sdk/python/express_relay/models/svm.py

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "express-relay"
-version = "0.27.0"
+version = "0.28.0"
 description = "Utilities for searchers and protocols to interact with the Express Relay protocol."
 authors = ["dourolabs"]
 license = "Apache-2.0"

sdk/python/pyproject.toml

@@ -1,6 +1,6 @@
 [package]
 name = "express-relay-client"
-version = "0.12.0"
+version = "0.13.0"
 edition = "2021"
 description = "Pyth Express Relay client"
 repository = "https://github.com/pyth-network/per"