@stellar/typescript-wallet-sdk 3.0.0 → 3.0.1

package/CHANGELOG.MD

@@ -1,3 +1,10 @@
+# Release notes - Typescript Wallet SDK - 3.0.1
+
+### Fixed
+* SEP-10: verify the auth server returns the same challenge body after `client_domain` re-signing, instead of trusting a server-supplied transaction (#237)
+* `submitWithFeeIncrease`: forward `maxFee` across recursive retries so the cap is enforced on every retry, not just the first (#238)
+* `submitTransaction`: replace the unbounded recursive 504 retry with a bounded equal-jitter exponential backoff loop, avoiding stack overflow during sustained Horizon outages (#238)
+
 # Release notes - Typescript Wallet SDK - 3.0.0
 
 ### BREAKING CHANGES

package/lib/bundle.js

@@ -1857,9 +1857,9 @@ var Sep10 = /** @class */ (function () {
     Sep10.prototype.sign = function (_a) {
         var accountKp = _a.accountKp, challengeResponse = _a.challengeResponse, walletSigner = _a.walletSigner;
         return __awaiter(this, void 0, void 0, function () {
-            var networkPassphrase, webAuthDomain, transaction, _i, _b, op;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
+            var networkPassphrase, webAuthDomain, transaction, hasClientDomain, originalHash, returned;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
                         networkPassphrase = this.cfg.stellar.network;
                         if (challengeResponse.network_passphrase &&
@@ -1874,24 +1874,26 @@ var Sep10 = /** @class */ (function () {
                             throw new Exceptions_1.ChallengeValidationFailedError(e instanceof Error ? e : new Error(String(e)));
                         }
                         transaction = stellar_sdk_1.TransactionBuilder.fromXDR(challengeResponse.transaction, networkPassphrase);
-                        _i = 0, _b = transaction.operations;
-                        _c.label = 1;
-                    case 1:
-                        if (!(_i < _b.length)) return [3 /*break*/, 4];
-                        op = _b[_i];
-                        if (!(op.type === "manageData" && op.name === "client_domain")) return [3 /*break*/, 3];
+                        hasClientDomain = transaction.operations.some(function (op) { return op.type === "manageData" && op.name === "client_domain"; });
+                        if (!hasClientDomain) return [3 /*break*/, 2];
+                        originalHash = transaction.hash();
                         return [4 /*yield*/, walletSigner.signWithDomainAccount({
                                 transactionXDR: challengeResponse.transaction,
                                 networkPassphrase: networkPassphrase,
                                 accountKp: accountKp,
                             })];
+                    case 1:
+                        returned = _b.sent();
+                        // Transaction.hash() covers the envelope body but excludes signatures, so
+                        // a domain signer that only appends its signature preserves the hash. Any
+                        // change to the operations, source account, memo, or other body fields
+                        // changes the hash and is rejected here.
+                        if (!returned.hash().equals(originalHash)) {
+                            throw new Exceptions_1.DomainSigningModifiedError();
+                        }
+                        transaction = returned;
+                        _b.label = 2;
                     case 2:
-                        transaction = _c.sent();
-                        _c.label = 3;
-                    case 3:
-                        _i++;
-                        return [3 /*break*/, 1];
-                    case 4:
                         walletSigner.signWithClientAccount({ transaction: transaction, accountKp: accountKp });
                         return [2 /*return*/, transaction];
                 }
@@ -2232,7 +2234,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.Sep7UriTypeNotSupportedError = exports.Sep7LongMsgError = exports.Sep7InvalidUriError = exports.AuthHeaderClientDomainRequiredError = exports.AuthHeaderSigningKeypairRequiredError = exports.DefaultSignerDomainAccountError = exports.SigningKeypairMissingSecretError = exports.InvalidJsonError = exports.UnknownAnchorTransactionError = exports.AllowHttpOnNonTestnetError = exports.ChallengeTxnInvalidSignatureError = exports.ChallengeTxnIncorrectSequenceError = exports.NetworkPassphraseMismatchError = exports.ChallengeValidationFailedError = exports.MissingSigningKeyError = exports.Sep38PriceOnlyOneAmountError = exports.NoAccountAndNoSponsorError = exports.DeviceKeyEqualsMasterKeyError = exports.NoAccountSignersError = exports.UnableToDeduceKeyError = exports.NoDeviceKeyForAccountError = exports.LostSignerKeyNotFound = exports.NotAllSignaturesFetchedError = exports.RecoveryIdentityNotFoundError = exports.RecoveryServerNotFoundError = exports.KYCServerNotFoundError = exports.CustomerNotFoundError = exports.Sep9InfoRequiredError = exports.WithdrawalTxMemoError = exports.PathPayOnlyOneAmountError = exports.WithdrawalTxMissingMemoError = exports.WithdrawalTxMissingDestinationError = exports.WithdrawalTxNotPendingUserTransferStartError = exports.OperationsLimitExceededError = exports.SignerRequiredError = exports.TransactionSubmitWithFeeIncreaseFailedError = exports.ExpiredTokenError = exports.InvalidTokenError = exports.MissingTokenError = exports.InsufficientStartingBalanceError = exports.TransactionSubmitFailedError = exports.AccountDoesNotExistError = exports.InvalidTransactionsResponseError = exports.InvalidTransactionResponseError = exports.MissingTransactionIdError = exports.ClientDomainWithMemoError = exports.InvalidMemoError = exports.AssetNotSupportedError = exports.ServerRequestFailedError = void 0;
+exports.Sep7UriTypeNotSupportedError = exports.Sep7LongMsgError = exports.Sep7InvalidUriError = exports.AuthHeaderClientDomainRequiredError = exports.AuthHeaderSigningKeypairRequiredError = exports.DomainSigningModifiedError = exports.DefaultSignerDomainAccountError = exports.SigningKeypairMissingSecretError = exports.InvalidJsonError = exports.UnknownAnchorTransactionError = exports.AllowHttpOnNonTestnetError = exports.ChallengeTxnInvalidSignatureError = exports.ChallengeTxnIncorrectSequenceError = exports.NetworkPassphraseMismatchError = exports.ChallengeValidationFailedError = exports.MissingSigningKeyError = exports.Sep38PriceOnlyOneAmountError = exports.NoAccountAndNoSponsorError = exports.DeviceKeyEqualsMasterKeyError = exports.NoAccountSignersError = exports.UnableToDeduceKeyError = exports.NoDeviceKeyForAccountError = exports.LostSignerKeyNotFound = exports.NotAllSignaturesFetchedError = exports.RecoveryIdentityNotFoundError = exports.RecoveryServerNotFoundError = exports.KYCServerNotFoundError = exports.CustomerNotFoundError = exports.Sep9InfoRequiredError = exports.WithdrawalTxMemoError = exports.PathPayOnlyOneAmountError = exports.WithdrawalTxMissingMemoError = exports.WithdrawalTxMissingDestinationError = exports.WithdrawalTxNotPendingUserTransferStartError = exports.OperationsLimitExceededError = exports.SignerRequiredError = exports.TransactionSubmitWithFeeIncreaseFailedError = exports.ExpiredTokenError = exports.InvalidTokenError = exports.MissingTokenError = exports.InsufficientStartingBalanceError = exports.TransactionSubmitFailedError = exports.AccountDoesNotExistError = exports.InvalidTransactionsResponseError = exports.InvalidTransactionResponseError = exports.MissingTransactionIdError = exports.ClientDomainWithMemoError = exports.InvalidMemoError = exports.AssetNotSupportedError = exports.ServerRequestFailedError = void 0;
 var axios_1 = __importDefault(__webpack_require__(/*! axios */ "../../node_modules/axios/dist/node/axios.cjs"));
 var Utils_1 = __webpack_require__(/*! ../Utils */ "./src/walletSdk/Utils/index.ts");
 var ServerRequestFailedError = /** @class */ (function (_super) {
@@ -2686,6 +2688,16 @@ var DefaultSignerDomainAccountError = /** @class */ (function (_super) {
     return DefaultSignerDomainAccountError;
 }(Error));
 exports.DefaultSignerDomainAccountError = DefaultSignerDomainAccountError;
+var DomainSigningModifiedError = /** @class */ (function (_super) {
+    __extends(DomainSigningModifiedError, _super);
+    function DomainSigningModifiedError() {
+        var _this = _super.call(this, "Domain signer returned a transaction whose body differs from the original challenge. Only the client_domain signature should be added.") || this;
+        Object.setPrototypeOf(_this, DomainSigningModifiedError.prototype);
+        return _this;
+    }
+    return DomainSigningModifiedError;
+}(Error));
+exports.DomainSigningModifiedError = DomainSigningModifiedError;
 var AuthHeaderSigningKeypairRequiredError = /** @class */ (function (_super) {
     __extends(AuthHeaderSigningKeypairRequiredError, _super);
     function AuthHeaderSigningKeypairRequiredError() {
@@ -3013,6 +3025,12 @@ var TransactionBuilder_1 = __webpack_require__(/*! ./Transaction/TransactionBuil
 var Exceptions_1 = __webpack_require__(/*! ../Exceptions */ "./src/walletSdk/Exceptions/index.ts");
 var getResultCode_1 = __webpack_require__(/*! ../Utils/getResultCode */ "./src/walletSdk/Utils/getResultCode.ts");
 var Account_1 = __webpack_require__(/*! ./Account */ "./src/walletSdk/Horizon/Account.ts");
+var SUBMIT_504_MAX_RETRIES = 5;
+var SUBMIT_504_BASE_DELAY_MS = 1000;
+var SUBMIT_504_MAX_DELAY_MS = 30000;
+var sleep = function (ms) {
+    return new Promise(function (resolve) { return setTimeout(resolve, ms); });
+};
 /**
  * Interaction with the Stellar Network.
  * Do not create this object directly, use the Wallet class.
@@ -3089,37 +3107,63 @@ var Stellar = /** @class */ (function () {
         return stellar_sdk_1.TransactionBuilder.buildFeeBumpTransaction(feeAddress.keypair, (baseFee || this.cfg.stellar.baseFee).toString(), transaction, transaction.networkPassphrase);
     };
     /**
-     * Submits a signed transaction to the server. If the submission fails with status
-     * 504 indicating a timeout error, it will automatically retry.
+     * Submits a signed transaction to Horizon.
+     *
+     * On HTTP 504 (timeout), retries with exponential backoff up to
+     * {@link SUBMIT_504_MAX_RETRIES} times. Any non-504 error is rethrown
+     * immediately without retrying.
+     *
      * @param {Transaction|FeeBumpTransaction} signedTransaction - The signed transaction to submit.
-     * @returns {boolean} `true` if the transaction was successfully submitted.
-     * @throws {TransactionSubmitFailedError} If the transaction submission fails.
+     * @returns {boolean} `true` if Horizon confirmed the submission as successful.
+     * @throws {TransactionSubmitFailedError} If Horizon responded with a non-successful
+     *   submission result (the transaction reached Horizon but was rejected).
+     * @throws The underlying 504 error if every retry attempt timed out. In this
+     *   case the transaction's on-chain status is **indeterminate** — Horizon may
+     *   have ingested it on the final attempt without responding in time. Callers
+     *   should poll the transaction hash to determine the actual outcome rather
+     *   than resubmit blindly; resubmitting a signed transaction with the same
+     *   sequence number will fail with `tx_bad_seq` once the original lands.
      */
     Stellar.prototype.submitTransaction = function (signedTransaction) {
+        var _a;
         return __awaiter(this, void 0, void 0, function () {
-            var response, e_2;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var lastError, attempt, response, e_2, cappedDelay, half;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
-                        _a.trys.push([0, 2, , 5]);
-                        return [4 /*yield*/, this.server.submitTransaction(signedTransaction)];
+                        attempt = 0;
+                        _b.label = 1;
                     case 1:
-                        response = _a.sent();
+                        if (!(attempt <= SUBMIT_504_MAX_RETRIES)) return [3 /*break*/, 7];
+                        _b.label = 2;
+                    case 2:
+                        _b.trys.push([2, 4, , 6]);
+                        return [4 /*yield*/, this.server.submitTransaction(signedTransaction)];
+                    case 3:
+                        response = _b.sent();
                         if (!response.successful) {
                             throw new Exceptions_1.TransactionSubmitFailedError(response);
                         }
                         return [2 /*return*/, true];
-                    case 2:
-                        e_2 = _a.sent();
-                        if (!(e_2.response.status === 504)) return [3 /*break*/, 4];
-                        return [4 /*yield*/, this.submitTransaction(signedTransaction)];
-                    case 3: 
-                    // in case of 504, keep retrying this tx until submission succeeds or we get a different error
-                    // https://developers.stellar.org/api/errors/http-status-codes/horizon-specific/timeout
-                    // https://developers.stellar.org/docs/encyclopedia/error-handling#timeouts
-                    return [2 /*return*/, _a.sent()];
-                    case 4: throw e_2;
-                    case 5: return [2 /*return*/];
+                    case 4:
+                        e_2 = _b.sent();
+                        if (((_a = e_2 === null || e_2 === void 0 ? void 0 : e_2.response) === null || _a === void 0 ? void 0 : _a.status) !== 504) {
+                            throw e_2;
+                        }
+                        lastError = e_2;
+                        if (attempt === SUBMIT_504_MAX_RETRIES) {
+                            return [3 /*break*/, 7];
+                        }
+                        cappedDelay = Math.min(SUBMIT_504_BASE_DELAY_MS * Math.pow(2, attempt), SUBMIT_504_MAX_DELAY_MS);
+                        half = cappedDelay / 2;
+                        return [4 /*yield*/, sleep(half + Math.random() * half)];
+                    case 5:
+                        _b.sent();
+                        return [3 /*break*/, 6];
+                    case 6:
+                        attempt++;
+                        return [3 /*break*/, 1];
+                    case 7: throw lastError;
                 }
             });
         });
@@ -3191,6 +3235,7 @@ var Stellar = /** @class */ (function () {
                                     signerFunction: signerFunction,
                                     baseFee: newFee,
                                     memo: memo,
+                                    maxFee: maxFee,
                                 })];
                         }
                         throw e_3;
@@ -82427,7 +82472,7 @@ function decode(arr) {
 /***/ ((module) => {
 
 "use strict";
-module.exports = JSON.parse('{"name":"@stellar/typescript-wallet-sdk","version":"3.0.0","engines":{"node":">=20"},"browser":"./lib/bundle_browser.js","main":"./lib/bundle.js","types":"./lib/index.d.ts","license":"Apache-2.0","private":false,"devDependencies":{"@babel/preset-env":"^7.20.2","@babel/preset-typescript":"^7.23.3","@stellar/prettier-config":"^1.0.1","@stellar/tsconfig":"^1.0.2","@types/jest":"^29.4.0","@types/lodash":"^4.14.194","@types/sinon":"^10.0.15","@typescript-eslint/eslint-plugin":"^6.7.5","@typescript-eslint/parser":"^6.7.5","babel-jest":"^29.4.1","crypto-browserify":"^3.12.0","dotenv":"^16.3.1","eslint":"^8.51.0","eslint-config-prettier":"^9.0.0","eslint-plugin-jsdoc":"^46.8.2","express":"^4.19.2","husky":"^8.0.0","jest":"^29.4.1","lint-staged":"^14.0.1","npm-run-all":"^4.1.5","playwright":"^1.43.1","prettier":"^2.0.5","pretty-quick":"^2.0.1","process":"^0.11.10","sinon":"^15.1.0","stream-browserify":"^3.0.0","ts-jest":"^29.0.5","ts-loader":"^9.4.2","ts-node":"^10.9.1","tslib":"^2.5.0","typescript":"^5.0.4","webpack":"^5.83.1","webpack-cli":"^5.1.1"},"dependencies":{"@stablelib/base64":"^2.0.0","@stablelib/utf8":"^2.0.0","@stellar/stellar-sdk":"15.0.1","axios":"^1.4.0","base64url":"^3.0.1","https-browserify":"^1.0.0","jws":"^4.0.0","lodash":"^4.17.21","query-string":"^7.1.3","stream-http":"^3.2.0","tweetnacl":"^1.0.3","url":"^0.11.0","util":"^0.12.5","utility-types":"^3.10.0","vm-browserify":"^1.1.2"},"scripts":{"test":"jest --watchAll","test:ci":"jest --ci","test:e2e:ci":"jest --config jest.e2e.config.js --ci","test:recovery:ci":"jest --config jest.integration.config.js recovery.test.ts --ci","test:anchorplatform:ci":"yarn jest --config jest.integration.config.js anchorplatform.test.ts --ci","build:web":"webpack --config webpack.config.js","build:node":"webpack --env NODE=true --config webpack.config.js","build":"run-p build:web build:node","example:sep10Server":"ts-node examples/sep10/sep10Server.ts","example:sep10Wallet":"ts-node examples/sep10/sep10Wallet.ts","example:sep24":"ts-node examples/sep24/sep24.ts","example:sep12":"ts-node examples/sep12/sep12.ts"}}');
+module.exports = JSON.parse('{"name":"@stellar/typescript-wallet-sdk","version":"3.0.1","engines":{"node":">=20"},"browser":"./lib/bundle_browser.js","main":"./lib/bundle.js","types":"./lib/index.d.ts","license":"Apache-2.0","private":false,"devDependencies":{"@babel/preset-env":"^7.20.2","@babel/preset-typescript":"^7.23.3","@stellar/prettier-config":"^1.0.1","@stellar/tsconfig":"^1.0.2","@types/jest":"^29.4.0","@types/lodash":"^4.14.194","@types/sinon":"^10.0.15","@typescript-eslint/eslint-plugin":"^6.7.5","@typescript-eslint/parser":"^6.7.5","babel-jest":"^29.4.1","crypto-browserify":"^3.12.0","dotenv":"^16.3.1","eslint":"^8.51.0","eslint-config-prettier":"^9.0.0","eslint-plugin-jsdoc":"^46.8.2","express":"^4.19.2","husky":"^8.0.0","jest":"^29.4.1","lint-staged":"^14.0.1","npm-run-all":"^4.1.5","playwright":"^1.43.1","prettier":"^2.0.5","pretty-quick":"^2.0.1","process":"^0.11.10","sinon":"^15.1.0","stream-browserify":"^3.0.0","ts-jest":"^29.0.5","ts-loader":"^9.4.2","ts-node":"^10.9.1","tslib":"^2.5.0","typescript":"^5.0.4","webpack":"^5.83.1","webpack-cli":"^5.1.1"},"dependencies":{"@stablelib/base64":"^2.0.0","@stablelib/utf8":"^2.0.0","@stellar/stellar-sdk":"15.0.1","axios":"^1.4.0","base64url":"^3.0.1","https-browserify":"^1.0.0","jws":"^4.0.0","lodash":"^4.17.21","query-string":"^7.1.3","stream-http":"^3.2.0","tweetnacl":"^1.0.3","url":"^0.11.0","util":"^0.12.5","utility-types":"^3.10.0","vm-browserify":"^1.1.2"},"scripts":{"test":"jest --watchAll","test:ci":"jest --ci","test:e2e:ci":"jest --config jest.e2e.config.js --ci","test:recovery:ci":"jest --config jest.integration.config.js recovery.test.ts --ci","test:anchorplatform:ci":"yarn jest --config jest.integration.config.js anchorplatform.test.ts --ci","build:web":"webpack --config webpack.config.js","build:node":"webpack --env NODE=true --config webpack.config.js","build":"run-p build:web build:node","example:sep10Server":"ts-node examples/sep10/sep10Server.ts","example:sep10Wallet":"ts-node examples/sep10/sep10Wallet.ts","example:sep24":"ts-node examples/sep24/sep24.ts","example:sep12":"ts-node examples/sep12/sep12.ts"}}');
 
 /***/ }),