@stellar/stellar-base 12.0.0 → 12.1.0

package/lib/address.js

@@ -36,7 +36,7 @@ var Address = exports.Address = /*#__PURE__*/function () {
       this._type = 'contract';
       this._key = _strkey.StrKey.decodeContract(address);
     } else {
-      throw new Error('Unsupported address type');
+      throw new Error("Unsupported address type: ".concat(address));
     }
   }
 

package/lib/asset.js

@@ -176,12 +176,12 @@ var Asset = exports.Asset = /*#__PURE__*/function () {
   }, {
     key: "getAssetType",
     value: function getAssetType() {
-      switch (this.getRawAssetType()) {
-        case _xdr["default"].AssetType.assetTypeNative():
+      switch (this.getRawAssetType().value) {
+        case _xdr["default"].AssetType.assetTypeNative().value:
           return 'native';
-        case _xdr["default"].AssetType.assetTypeCreditAlphanum4():
+        case _xdr["default"].AssetType.assetTypeCreditAlphanum4().value:
           return 'credit_alphanum4';
-        case _xdr["default"].AssetType.assetTypeCreditAlphanum12():
+        case _xdr["default"].AssetType.assetTypeCreditAlphanum12().value:
           return 'credit_alphanum12';
         default:
           return 'unknown';

package/lib/events.js

@@ -4,10 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.humanizeEvents = humanizeEvents;
-var _xdr = _interopRequireDefault(require("./xdr"));
 var _strkey = require("./strkey");
 var _scval = require("./scval");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
 function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
@@ -30,14 +28,16 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
  */
 function humanizeEvents(events) {
   return events.map(function (e) {
-    if (e instanceof _xdr["default"].DiagnosticEvent) {
+    // A pseudo-instanceof check for xdr.DiagnosticEvent more reliable
+    // in mixed SDK environments:
+    if (e.inSuccessfulContractCall) {
       return extractEvent(e.event());
     }
     return extractEvent(e);
   });
 }
 function extractEvent(event) {
-  return _objectSpread(_objectSpread({}, event.contractId() != null && {
+  return _objectSpread(_objectSpread({}, typeof event.contractId === 'function' && event.contractId() != null && {
     contractId: _strkey.StrKey.encodeContract(event.contractId())
   }), {}, {
     type: event.type().name,

package/lib/operations/extend_footprint_ttl.js

@@ -7,21 +7,30 @@ exports.extendFootprintTtl = extendFootprintTtl;
 var _xdr = _interopRequireDefault(require("../xdr"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
 /**
- * Builds an operation to bump the time-to-live of a footprint (read and written
- * ledger keys). Its only parameter is the new, absolute ledger sequence number
- * at which the entry will expire.
+ * Builds an operation to bump the time-to-live (TTL) of the ledger keys. The
+ * keys for extension have to be provided in the read-only footprint of
+ * the transaction.
  *
- * The footprint itself is derived from the transaction (see
+ * The only parameter of the operation itself is the new minimum TTL for
+ * all the provided entries. If an entry already has a higher TTL, then it
+ * will just be skipped.
+ *
+ * TTL is the number of ledgers from the current ledger (exclusive) until
+ * the last ledger the entry is still considered alive (inclusive). Thus
+ * the exact ledger until the entries will live will only be determined
+ * when transaction has been applied.
+ *
+ * The footprint has to be specified in the transaction. See
  * {@link TransactionBuilder}'s `opts.sorobanData` parameter, which is a
  * {@link xdr.SorobanTransactionData} instance that contains fee data & resource
- * usage as part of {@link xdr.SorobanResources}).
+ * usage as part of {@link xdr.SorobanResources}.
  *
  * @function
  * @alias Operation.extendFootprintTtl
  *
  * @param {object} opts - object holding operation parameters
- * @param {number} opts.extendTo - the absolute ledger sequence number at which
- *     the transaction's ledger keys will now expire
+ * @param {number} opts.extendTo - the minimum TTL that all the entries in
+ *    the read-only footprint will have
  * @param {string} [opts.source] - an optional source account
  *
  * @returns {xdr.Operation} an Extend Footprint TTL operation
@@ -30,7 +39,7 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default":
 function extendFootprintTtl(opts) {
   var _opts$extendTo;
   if (((_opts$extendTo = opts.extendTo) !== null && _opts$extendTo !== void 0 ? _opts$extendTo : -1) <= 0) {
-    throw new RangeError("extendTo isn't a ledger quantity (uint32)");
+    throw new RangeError('extendTo has to be positive');
   }
   var extendFootprintOp = new _xdr["default"].ExtendFootprintTtlOp({
     ext: new _xdr["default"].ExtensionPoint(0),

package/lib/operations/restore_footprint.js

@@ -7,14 +7,18 @@ exports.restoreFootprint = restoreFootprint;
 var _xdr = _interopRequireDefault(require("../xdr"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
 /**
- * Builds a footprint restoration operation.
+ * Builds an operation to restore the archived ledger entries specified
+ * by the ledger keys.
+ *
+ * The ledger keys to restore are specified separately from the operation
+ * in read-write footprint of the transaction.
  *
  * It takes no parameters because the relevant footprint is derived from the
- * transaction itself (see {@link TransactionBuilder}'s `opts.sorobanData`
+ * transaction itself. See {@link TransactionBuilder}'s `opts.sorobanData`
  * parameter (or {@link TransactionBuilder.setSorobanData} /
  * {@link TransactionBuilder.setLedgerKeys}), which is a
  * {@link xdr.SorobanTransactionData} instance that contains fee data & resource
- * usage as part of {@link xdr.SorobanTransactionData}).
+ * usage as part of {@link xdr.SorobanTransactionData}.
  *
  * @function
  * @alias Operation.restoreFootprint

package/lib/scval.js

@@ -150,75 +150,87 @@ function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" ==
  * scValToNative(scv) == gigaMap;       // true
  */
 function nativeToScVal(val) {
-  var _val$constructor$name, _val$constructor;
   var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   switch (_typeof(val)) {
     case 'object':
-      if (val === null) {
-        return _xdr["default"].ScVal.scvVoid();
-      }
-      if (val instanceof _xdr["default"].ScVal) {
-        return val; // should we copy?
-      }
-      if (val instanceof _address.Address) {
-        return val.toScVal();
-      }
-      if (val instanceof _contract.Contract) {
-        return val.address().toScVal();
-      }
-      if (val instanceof Uint8Array || Buffer.isBuffer(val)) {
-        var _opts$type;
-        var copy = Uint8Array.from(val);
-        switch ((_opts$type = opts === null || opts === void 0 ? void 0 : opts.type) !== null && _opts$type !== void 0 ? _opts$type : 'bytes') {
-          case 'bytes':
-            return _xdr["default"].ScVal.scvBytes(copy);
-          case 'symbol':
-            return _xdr["default"].ScVal.scvSymbol(copy);
-          case 'string':
-            return _xdr["default"].ScVal.scvString(copy);
-          default:
-            throw new TypeError("invalid type (".concat(opts.type, ") specified for bytes-like value"));
+      {
+        var _val$constructor$name, _val$constructor;
+        if (val === null) {
+          return _xdr["default"].ScVal.scvVoid();
         }
-      }
-      if (Array.isArray(val)) {
-        if (val.length > 0 && val.some(function (v) {
-          return _typeof(v) !== _typeof(val[0]);
-        })) {
-          throw new TypeError("array values (".concat(val, ") must have the same type (types: ").concat(val.map(function (v) {
-            return _typeof(v);
-          }).join(','), ")"));
+        if (val instanceof _xdr["default"].ScVal) {
+          return val; // should we copy?
+        }
+        if (val instanceof _address.Address) {
+          return val.toScVal();
         }
-        return _xdr["default"].ScVal.scvVec(val.map(function (v) {
-          return nativeToScVal(v, opts);
+        if (val instanceof _contract.Contract) {
+          return val.address().toScVal();
+        }
+        if (val instanceof Uint8Array || Buffer.isBuffer(val)) {
+          var _opts$type;
+          var copy = Uint8Array.from(val);
+          switch ((_opts$type = opts === null || opts === void 0 ? void 0 : opts.type) !== null && _opts$type !== void 0 ? _opts$type : 'bytes') {
+            case 'bytes':
+              return _xdr["default"].ScVal.scvBytes(copy);
+            case 'symbol':
+              return _xdr["default"].ScVal.scvSymbol(copy);
+            case 'string':
+              return _xdr["default"].ScVal.scvString(copy);
+            default:
+              throw new TypeError("invalid type (".concat(opts.type, ") specified for bytes-like value"));
+          }
+        }
+        if (Array.isArray(val)) {
+          if (val.length > 0 && val.some(function (v) {
+            return _typeof(v) !== _typeof(val[0]);
+          })) {
+            throw new TypeError("array values (".concat(val, ") must have the same type (types: ").concat(val.map(function (v) {
+              return _typeof(v);
+            }).join(','), ")"));
+          }
+          return _xdr["default"].ScVal.scvVec(val.map(function (v) {
+            return nativeToScVal(v, opts);
+          }));
+        }
+        if (((_val$constructor$name = (_val$constructor = val.constructor) === null || _val$constructor === void 0 ? void 0 : _val$constructor.name) !== null && _val$constructor$name !== void 0 ? _val$constructor$name : '') !== 'Object') {
+          var _val$constructor2;
+          throw new TypeError("cannot interpret ".concat((_val$constructor2 = val.constructor) === null || _val$constructor2 === void 0 ? void 0 : _val$constructor2.name, " value as ScVal (").concat(JSON.stringify(val), ")"));
+        }
+        return _xdr["default"].ScVal.scvMap(Object.entries(val)
+        // The Soroban runtime expects maps to have their keys in sorted
+        // order, so let's do that here as part of the conversion to prevent
+        // confusing error messages on execution.
+        .sort(function (_ref, _ref2) {
+          var _ref3 = _slicedToArray(_ref, 1),
+            key1 = _ref3[0];
+          var _ref4 = _slicedToArray(_ref2, 1),
+            key2 = _ref4[0];
+          return key1.localeCompare(key2);
+        }).map(function (_ref5) {
+          var _k, _opts$type2;
+          var _ref6 = _slicedToArray(_ref5, 2),
+            k = _ref6[0],
+            v = _ref6[1];
+          // the type can be specified with an entry for the key and the value,
+          // e.g. val = { 'hello': 1 } and opts.type = { hello: [ 'symbol',
+          // 'u128' ]} or you can use `null` for the default interpretation
+          var _ref7 = (_k = ((_opts$type2 = opts === null || opts === void 0 ? void 0 : opts.type) !== null && _opts$type2 !== void 0 ? _opts$type2 : {})[k]) !== null && _k !== void 0 ? _k : [null, null],
+            _ref8 = _slicedToArray(_ref7, 2),
+            keyType = _ref8[0],
+            valType = _ref8[1];
+          var keyOpts = keyType ? {
+            type: keyType
+          } : {};
+          var valOpts = valType ? {
+            type: valType
+          } : {};
+          return new _xdr["default"].ScMapEntry({
+            key: nativeToScVal(k, keyOpts),
+            val: nativeToScVal(v, valOpts)
+          });
         }));
       }
-      if (((_val$constructor$name = (_val$constructor = val.constructor) === null || _val$constructor === void 0 ? void 0 : _val$constructor.name) !== null && _val$constructor$name !== void 0 ? _val$constructor$name : '') !== 'Object') {
-        var _val$constructor2;
-        throw new TypeError("cannot interpret ".concat((_val$constructor2 = val.constructor) === null || _val$constructor2 === void 0 ? void 0 : _val$constructor2.name, " value as ScVal (").concat(JSON.stringify(val), ")"));
-      }
-      return _xdr["default"].ScVal.scvMap(Object.entries(val).map(function (_ref) {
-        var _k, _opts$type2;
-        var _ref2 = _slicedToArray(_ref, 2),
-          k = _ref2[0],
-          v = _ref2[1];
-        // the type can be specified with an entry for the key and the value,
-        // e.g. val = { 'hello': 1 } and opts.type = { hello: [ 'symbol',
-        // 'u128' ]} or you can use `null` for the default interpretation
-        var _ref3 = (_k = ((_opts$type2 = opts === null || opts === void 0 ? void 0 : opts.type) !== null && _opts$type2 !== void 0 ? _opts$type2 : {})[k]) !== null && _k !== void 0 ? _k : [null, null],
-          _ref4 = _slicedToArray(_ref3, 2),
-          keyType = _ref4[0],
-          valType = _ref4[1];
-        var keyOpts = keyType ? {
-          type: keyType
-        } : {};
-        var valOpts = valType ? {
-          type: valType
-        } : {};
-        return new _xdr["default"].ScMapEntry({
-          key: nativeToScVal(k, keyOpts),
-          val: nativeToScVal(v, valOpts)
-        });
-      }));
     case 'number':
     case 'bigint':
       switch (opts === null || opts === void 0 ? void 0 : opts.type) {
@@ -243,6 +255,10 @@ function nativeToScVal(val) {
             return _xdr["default"].ScVal.scvSymbol(val);
           case 'address':
             return new _address.Address(val).toScVal();
+          case 'u32':
+            return _xdr["default"].ScVal.scvU32(parseInt(val, 10));
+          case 'i32':
+            return _xdr["default"].ScVal.scvI32(parseInt(val, 10));
           default:
             if (_index.XdrLargeInt.isType(optType)) {
               return new _index.XdrLargeInt(optType, val).toScVal();
@@ -350,21 +366,23 @@ function scValToNative(scv) {
     case _xdr["default"].ScValType.scvTimepoint().value:
     case _xdr["default"].ScValType.scvDuration().value:
       return new _xdr["default"].Uint64(scv.value()).toBigInt();
-    case _xdr["default"].ScValType.scvStatus().value:
-      // TODO: Convert each status type into a human-readable error string?
-      switch (scv.value()["switch"]()) {
-        case _xdr["default"].ScStatusType.sstOk().value:
-        case _xdr["default"].ScStatusType.sstUnknownError().value:
-        case _xdr["default"].ScStatusType.sstHostValueError().value:
-        case _xdr["default"].ScStatusType.sstHostObjectError().value:
-        case _xdr["default"].ScStatusType.sstHostFunctionError().value:
-        case _xdr["default"].ScStatusType.sstHostStorageError().value:
-        case _xdr["default"].ScStatusType.sstHostContextError().value:
-        case _xdr["default"].ScStatusType.sstVmError().value:
-        case _xdr["default"].ScStatusType.sstContractError().value:
-        case _xdr["default"].ScStatusType.sstHostAuthError().value:
+    case _xdr["default"].ScValType.scvError().value:
+      switch (scv.error()["switch"]().value) {
+        // Distinguish errors from the user contract.
+        case _xdr["default"].ScErrorType.sceContract().value:
+          return {
+            type: 'contract',
+            code: scv.error().contractCode()
+          };
         default:
-          break;
+          {
+            var err = scv.error();
+            return {
+              type: 'system',
+              code: err.code().value,
+              value: err.code().name
+            };
+          }
       }
 
     // in the fallthrough case, just return the underlying value directly

package/lib/transaction_builder.js

@@ -206,6 +206,21 @@ var TransactionBuilder = exports.TransactionBuilder = /*#__PURE__*/function () {
       return this;
     }
 
+    /**
+     * Adds an operation to the transaction at a specific index.
+     *
+     * @param {xdr.Operation} operation - The xdr operation object to add, use {@link Operation} static methods.
+     * @param {number} index - The index at which to insert the operation.
+     *
+     * @returns {TransactionBuilder} - The TransactionBuilder instance for method chaining.
+     */
+  }, {
+    key: "addOperationAt",
+    value: function addOperationAt(operation, index) {
+      this.operations.splice(index, 0, operation);
+      return this;
+    }
+
     /**
      * Removes the operations from the builder (useful when cloning).
      * @returns {TransactionBuilder} this builder instance
@@ -217,6 +232,20 @@ var TransactionBuilder = exports.TransactionBuilder = /*#__PURE__*/function () {
       return this;
     }
 
+    /**
+     * Removes the operation at the specified index from the transaction.
+     *
+     * @param {number} index - The index of the operation to remove.
+     *
+     * @returns {TransactionBuilder} The TransactionBuilder instance for method chaining.
+     */
+  }, {
+    key: "clearOperationAt",
+    value: function clearOperationAt(index) {
+      this.operations.splice(index, 1);
+      return this;
+    }
+
     /**
      * Adds a memo to the transaction.
      * @param {Memo} memo {@link Memo} object

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stellar/stellar-base",
-  "version": "12.0.0",
+  "version": "12.1.0",
   "description": "Low-level support library for the Stellar network.",
   "main": "./lib/index.js",
   "browser": {
@@ -70,15 +70,15 @@
   },
   "homepage": "https://github.com/stellar/js-stellar-base",
   "devDependencies": {
-    "@babel/cli": "^7.24.6",
-    "@babel/core": "^7.24.6",
-    "@babel/eslint-parser": "^7.24.6",
-    "@babel/eslint-plugin": "^7.24.6",
-    "@babel/preset-env": "^7.24.6",
+    "@babel/cli": "^7.24.8",
+    "@babel/core": "^7.24.9",
+    "@babel/eslint-parser": "^7.24.8",
+    "@babel/eslint-plugin": "^7.24.7",
+    "@babel/preset-env": "^7.24.8",
     "@babel/register": "^7.24.6",
     "@definitelytyped/dtslint": "^0.0.182",
     "@istanbuljs/nyc-config-babel": "3.0.0",
-    "@types/node": "^20.12.13",
+    "@types/node": "^20.14.11",
     "@typescript-eslint/parser": "^6.20.0",
     "babel-loader": "^9.1.3",
     "babel-plugin-istanbul": "^6.1.1",
@@ -91,7 +91,7 @@
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prefer-import": "^0.0.1",
-    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-prettier": "^5.2.1",
     "eslint-webpack-plugin": "^4.2.0",
     "ghooks": "^2.0.4",
     "husky": "^8.0.3",
@@ -103,24 +103,24 @@
     "karma-mocha": "^2.0.0",
     "karma-sinon-chai": "^2.0.2",
     "karma-webpack": "^5.0.1",
-    "lint-staged": "^15.2.5",
+    "lint-staged": "^15.2.7",
     "minami": "^1.1.1",
-    "mocha": "^10.4.0",
+    "mocha": "^10.6.0",
     "node-polyfill-webpack-plugin": "^3.0.0",
     "nyc": "^15.1.0",
-    "prettier": "^3.2.5",
+    "prettier": "^3.3.3",
     "randombytes": "^2.1.0",
     "sinon": "^16.1.0",
     "sinon-chai": "^3.7.0",
     "taffydb": "^2.7.3",
     "terser-webpack-plugin": "^5.3.10",
     "ts-node": "^10.9.2",
-    "typescript": "^5.4.5",
-    "webpack": "^5.90.3",
+    "typescript": "^5.5.3",
+    "webpack": "^5.93.0",
     "webpack-cli": "^5.1.1"
   },
   "dependencies": {
-    "@stellar/js-xdr": "^3.1.1",
+    "@stellar/js-xdr": "^3.1.2",
     "base32.js": "^0.1.0",
     "bignumber.js": "^9.1.2",
     "buffer": "^6.0.3",

package/types/index.d.ts

@@ -988,6 +988,7 @@ export namespace StrKey {
 
   function encodeContract(data: Buffer): string;
   function decodeContract(address: string): Buffer;
+  function isValidContract(address: string): boolean;
 }
 
 export namespace SignerKey {