@stellar/stellar-base 13.0.1 → 13.1.0

package/lib/address.js

@@ -155,10 +155,10 @@ var Address = exports.Address = /*#__PURE__*/function () {
   }, {
     key: "fromScAddress",
     value: function fromScAddress(scAddress) {
-      switch (scAddress["switch"]()) {
-        case _xdr["default"].ScAddressType.scAddressTypeAccount():
+      switch (scAddress["switch"]().value) {
+        case _xdr["default"].ScAddressType.scAddressTypeAccount().value:
           return Address.account(scAddress.accountId().ed25519());
-        case _xdr["default"].ScAddressType.scAddressTypeContract():
+        case _xdr["default"].ScAddressType.scAddressTypeContract().value:
           return Address.contract(scAddress.contractId());
         default:
           throw new Error('Unsupported address type');

package/lib/auth.js

@@ -26,11 +26,14 @@ function _asyncToGenerator(n) { return function () { var t = this, e = arguments
  *    whose hash you should sign, so that you can inspect the entire structure
  *    if necessary (rather than blindly signing a hash)
  *
- * @returns {Promise<Uint8Array>}   the signature of the raw payload (which is
- *    the sha256 hash of the preimage bytes, so `hash(preimage.toXDR())`) signed
+ * @returns {
+ *    Promise<Uint8Array> |
+ *    Promise<{signature: Uint8Array, publicKey: string}
+ * }  the signature of the raw payload (which is the sha256 hash of the preimage
+ *    bytes, so `hash(preimage.toXDR())`) either naked, implying it is signed
  *    by the key corresponding to the public key in the entry you pass to
  *    {@link authorizeEntry} (decipherable from its
- *    `credentials().address().address()`)
+ *    `credentials().address().address()`), or alongside an explicit `publicKey`.
  */
 /**
  * Actually authorizes an existing authorization entry using the given the
@@ -51,10 +54,17 @@ function _asyncToGenerator(n) { return function () { var t = this, e = arguments
  *
  * @param {xdr.SorobanAuthorizationEntry} entry   an unsigned authorization entr
  * @param {Keypair | SigningCallback} signer  either a {@link Keypair} instance
- *    or a function which takes a payload (a
- *    {@link xdr.HashIdPreimageSorobanAuthorization} instance) input and returns
- *    the signature of the hash of the raw payload bytes (where the signing key
- *    should correspond to the address in the `entry`)
+ *    or a function which takes a {@link xdr.HashIdPreimageSorobanAuthorization}
+ *    input payload and returns EITHER
+ *
+ *      (a) an object containing a `signature` of the hash of the raw payload bytes
+ *          as a Buffer-like and a `publicKey` string representing who just
+ *          created this signature, or
+ *      (b) just the naked signature of the hash of the raw payload bytes (where
+ *          the signing key is implied to be the address in the `entry`).
+ *
+ *    The latter option (b) is JUST for backwards compatibility and will be
+ *    removed in the future.
  * @param {number} validUntilLedgerSeq   the (exclusive) future ledger sequence
  *    number until which this authorization entry should be valid (if
  *    `currentLedgerSeq==validUntil`, this is expired))
@@ -66,8 +76,8 @@ function _asyncToGenerator(n) { return function () { var t = this, e = arguments
  *    {@link Operation.invokeHostFunction}
  *
  * @note If using the `SigningCallback` variation, the signer is assumed to be
- *    the entry's credential address. If you need a different key to sign the
- *    entry, you will need to use different method (e.g., fork this code).
+ *    the entry's credential address unless you use the variant that returns
+ *    the object.
  *
  * @see authorizeInvocation
  * @example
@@ -160,6 +170,7 @@ function _authorizeEntry() {
       payload,
       signature,
       publicKey,
+      sigResult,
       sigScVal,
       _args = arguments;
     return _regeneratorRuntime().wrap(function _callee$(_context) {
@@ -185,28 +196,33 @@ function _authorizeEntry() {
           }));
           payload = (0, _hashing.hash)(preimage.toXDR());
           if (!(typeof signer === 'function')) {
-            _context.next = 18;
+            _context.next = 16;
             break;
           }
-          _context.t0 = Buffer;
-          _context.next = 13;
+          _context.next = 12;
           return signer(preimage);
-        case 13:
-          _context.t1 = _context.sent;
-          signature = _context.t0.from.call(_context.t0, _context.t1);
-          publicKey = _address.Address.fromScAddress(addrAuth.address()).toString();
-          _context.next = 20;
+        case 12:
+          sigResult = _context.sent;
+          if (sigResult !== null && sigResult !== void 0 && sigResult.signature) {
+            signature = Buffer.from(sigResult.signature);
+            publicKey = sigResult.publicKey;
+          } else {
+            // if using the deprecated form, assume it's for the entry
+            signature = Buffer.from(sigResult);
+            publicKey = _address.Address.fromScAddress(addrAuth.address()).toString();
+          }
+          _context.next = 18;
           break;
-        case 18:
+        case 16:
           signature = Buffer.from(signer.sign(payload));
           publicKey = signer.publicKey();
-        case 20:
+        case 18:
           if (_keypair.Keypair.fromPublicKey(publicKey).verify(payload, signature)) {
-            _context.next = 22;
+            _context.next = 20;
             break;
           }
           throw new Error("signature doesn't match payload");
-        case 22:
+        case 20:
           // This structure is defined here:
           // https://soroban.stellar.org/docs/fundamentals-and-concepts/invoking-contracts-with-transactions#stellar-account-signatures
           //
@@ -223,7 +239,7 @@ function _authorizeEntry() {
           });
           addrAuth.signature(_xdr["default"].ScVal.scvVec([sigScVal]));
           return _context.abrupt("return", clone);
-        case 25:
+        case 23:
         case "end":
           return _context.stop();
       }

package/lib/scval.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.nativeToScVal = nativeToScVal;
 exports.scValToNative = scValToNative;
 var _xdr = _interopRequireDefault(require("./xdr"));
+var _keypair = require("./keypair");
 var _address = require("./address");
 var _contract = require("./contract");
 var _index = require("./numbers/index");
@@ -164,6 +165,11 @@ function nativeToScVal(val) {
         if (val instanceof _address.Address) {
           return val.toScVal();
         }
+        if (val instanceof _keypair.Keypair) {
+          return nativeToScVal(val.publicKey(), {
+            type: 'address'
+          });
+        }
         if (val instanceof _contract.Contract) {
           return val.address().toScVal();
         }
@@ -182,13 +188,6 @@ function nativeToScVal(val) {
           }
         }
         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);
           }));
@@ -389,4 +388,25 @@ function scValToNative(scv) {
     default:
       return scv.value();
   }
-}
+}
+
+/// Inject a sortable map builder into the xdr module.
+_xdr["default"].scvSortedMap = function (items) {
+  var sorted = Array.from(items).sort(function (a, b) {
+    // Both a and b are `ScMapEntry`s, so we need to sort by underlying key.
+    //
+    // We couldn't possibly handle every combination of keys since Soroban
+    // maps don't enforce consistent types, so we do a best-effort and try
+    // sorting by "number-like" or "string-like."
+    var nativeA = scValToNative(a.key());
+    var nativeB = scValToNative(b.key());
+    switch (_typeof(nativeA)) {
+      case 'number':
+      case 'bigint':
+        return nativeA < nativeB ? -1 : 1;
+      default:
+        return nativeA.toString().localeCompare(nativeB.toString());
+    }
+  });
+  return _xdr["default"].ScVal.scvMap(sorted);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stellar/stellar-base",
-  "version": "13.0.1",
+  "version": "13.1.0",
   "description": "Low-level support library for the Stellar network.",
   "main": "./lib/index.js",
   "browser": {
@@ -16,7 +16,7 @@
     "build:browser:prod": "cross-env NODE_ENV=production yarn build:browser",
     "build:prod": "cross-env NODE_ENV=production yarn build",
     "test": "yarn build && yarn test:node && yarn test:browser",
-    "test:node": "yarn _nyc mocha",
+    "test:node": "NODE_OPTIONS=$(test ! $(node -v | awk -F'.' '{printf substr($1,2)}') = '18' && echo '--no-experimental-detect-module') yarn _nyc mocha",
     "test:browser": "karma start ./config/karma.conf.js",
     "docs": "jsdoc -c ./config/.jsdoc.json --verbose",
     "lint": "eslint -c ./config/.eslintrc.js src/ && dtslint --localTs node_modules/typescript/lib types/",
@@ -26,6 +26,9 @@
     "clean": "rm -rf lib/ dist/ coverage/ .nyc_output/",
     "_nyc": "nyc --nycrc-path ./config/.nycrc"
   },
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "mocha": {
     "require": [
       "@babel/register",
@@ -70,11 +73,11 @@
   },
   "homepage": "https://github.com/stellar/js-stellar-base",
   "devDependencies": {
-    "@babel/cli": "^7.25.9",
-    "@babel/core": "^7.26.0",
-    "@babel/eslint-parser": "^7.25.9",
-    "@babel/eslint-plugin": "^7.25.9",
-    "@babel/preset-env": "^7.26.0",
+    "@babel/cli": "^7.27.0",
+    "@babel/core": "^7.26.10",
+    "@babel/eslint-parser": "^7.27.0",
+    "@babel/eslint-plugin": "^7.27.0",
+    "@babel/preset-env": "^7.26.9",
     "@babel/register": "^7.25.9",
     "@definitelytyped/dtslint": "^0.0.182",
     "@istanbuljs/nyc-config-babel": "3.0.0",
@@ -91,7 +94,7 @@
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prefer-import": "^0.0.1",
-    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-prettier": "^5.2.5",
     "eslint-webpack-plugin": "^4.2.0",
     "ghooks": "^2.0.4",
     "husky": "^8.0.3",
@@ -103,20 +106,20 @@
     "karma-mocha": "^2.0.0",
     "karma-sinon-chai": "^2.0.2",
     "karma-webpack": "^5.0.1",
-    "lint-staged": "^15.2.10",
+    "lint-staged": "^15.5.0",
     "minami": "^1.1.1",
     "mocha": "^10.8.2",
     "node-polyfill-webpack-plugin": "^3.0.0",
     "nyc": "^15.1.0",
-    "prettier": "^3.3.3",
+    "prettier": "^3.5.3",
     "randombytes": "^2.1.0",
     "sinon": "^16.1.0",
     "sinon-chai": "^3.7.0",
     "taffydb": "^2.7.3",
-    "terser-webpack-plugin": "^5.3.10",
+    "terser-webpack-plugin": "^5.3.14",
     "ts-node": "^10.9.2",
-    "typescript": "^5.6.3",
-    "webpack": "^5.96.1",
+    "typescript": "5.6.3",
+    "webpack": "^5.98.0",
     "webpack-cli": "^5.1.1"
   },
   "dependencies": {
@@ -128,6 +131,6 @@
     "tweetnacl": "^1.0.3"
   },
   "optionalDependencies": {
-    "sodium-native": "^4.3.0"
+    "sodium-native": "^4.3.3"
   }
 }

package/types/curr.d.ts

@@ -44,6 +44,16 @@ export namespace xdr {
 
   type Hash = Opaque[]; // workaround, cause unknown
 
+  /**
+   * Returns an {@link ScVal} with a map type and sorted entries.
+   *
+   * @param items the key-value pairs to sort.
+   *
+   * @warning This only performs "best-effort" sorting, working best when the
+   * keys are all either numeric or string-like.
+   */
+  function scvSortedMap(items: ScMapEntry[]): ScVal;
+
   interface SignedInt {
     readonly MAX_VALUE: 2147483647;
     readonly MIN_VALUE: -2147483648;

package/types/index.d.ts

@@ -1214,9 +1214,13 @@ export class SorobanDataBuilder {
   build(): xdr.SorobanTransactionData;
 }
 
+type BufferLike = Buffer | Uint8Array | ArrayBuffer;
 export type SigningCallback = (
   preimage: xdr.HashIdPreimage
-) => Promise<Buffer | Uint8Array | ArrayBuffer /* Buffer-like */>;
+) => Promise<
+  BufferLike |
+  { signature: BufferLike, publicKey: string }
+>;
 
 export function authorizeInvocation(
   signer: Keypair | SigningCallback,