@stellar/stellar-sdk 12.3.0 → 13.0.0-rc.1

package/lib/contract/assembled_transaction.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.AssembledTransaction = void 0;
 var _stellarBase = require("@stellar/stellar-base");
-var _server = require("../rpc/server");
+var _rpc = require("../rpc");
 var _api = require("../rpc/api");
 var _transaction = require("../rpc/transaction");
 var _rust_result = require("./rust_result");
@@ -130,6 +130,7 @@ var AssembledTransaction = exports.AssembledTransaction = function () {
         force,
         _ref4$signTransaction,
         signTransaction,
+        sigsNeeded,
         timeoutInSeconds,
         signature,
         _args2 = arguments;
@@ -155,26 +156,29 @@ var AssembledTransaction = exports.AssembledTransaction = function () {
             }
             throw new AssembledTransaction.Errors.NoSigner("You must provide a signTransaction function, either when calling " + "`signAndSend` or when initializing your Client");
           case 7:
-            if (!_this.needsNonInvokerSigningBy().length) {
-              _context2.next = 9;
+            sigsNeeded = _this.needsNonInvokerSigningBy().filter(function (id) {
+              return !id.startsWith('C');
+            });
+            if (!sigsNeeded.length) {
+              _context2.next = 10;
               break;
             }
-            throw new AssembledTransaction.Errors.NeedsMoreSignatures("Transaction requires more signatures. " + "See `needsNonInvokerSigningBy` for details.");
-          case 9:
+            throw new AssembledTransaction.Errors.NeedsMoreSignatures("Transaction requires signatures from ".concat(sigsNeeded, ". ") + "See `needsNonInvokerSigningBy` for details.");
+          case 10:
             timeoutInSeconds = (_this$options$timeout2 = _this.options.timeoutInSeconds) !== null && _this$options$timeout2 !== void 0 ? _this$options$timeout2 : _types.DEFAULT_TIMEOUT;
             _this.built = _stellarBase.TransactionBuilder.cloneFrom(_this.built, {
               fee: _this.built.fee,
               timebounds: undefined,
               sorobanData: _this.simulationData.transactionData
             }).setTimeout(timeoutInSeconds).build();
-            _context2.next = 13;
+            _context2.next = 14;
             return signTransaction(_this.built.toXDR(), {
               networkPassphrase: _this.options.networkPassphrase
             });
-          case 13:
+          case 14:
             signature = _context2.sent;
             _this.signed = _stellarBase.TransactionBuilder.fromXDR(signature, _this.options.networkPassphrase);
-          case 15:
+          case 16:
           case "end":
             return _context2.stop();
         }
@@ -223,7 +227,7 @@ var AssembledTransaction = exports.AssembledTransaction = function () {
       return _toConsumableArray(new Set(((_rawInvokeHostFunctio = rawInvokeHostFunctionOp.auth) !== null && _rawInvokeHostFunctio !== void 0 ? _rawInvokeHostFunctio : []).filter(function (entry) {
         return entry.credentials().switch() === _stellarBase.xdr.SorobanCredentialsType.sorobanCredentialsAddress() && (includeAlreadySigned || entry.credentials().address().signature().switch().name === "scvVoid");
       }).map(function (entry) {
-        return _stellarBase.StrKey.encodeEd25519PublicKey(entry.credentials().address().address().accountId().ed25519());
+        return _stellarBase.Address.fromScAddress(entry.credentials().address().address()).toString();
       })));
     });
     _defineProperty(this, "signAuthEntries", _asyncToGenerator(_regeneratorRuntime().mark(function _callee6() {
@@ -233,22 +237,22 @@ var AssembledTransaction = exports.AssembledTransaction = function () {
         expiration,
         _ref9$signAuthEntry,
         signAuthEntry,
-        _ref9$publicKey,
-        publicKey,
+        _ref9$address,
+        address,
+        _ref9$authorizeEntry,
+        authorizeEntry,
         needsNonInvokerSigningBy,
         rawInvokeHostFunctionOp,
         authEntries,
         _iterator,
         _step,
-        _step$value,
-        i,
-        entry,
-        pk,
-        _args6 = arguments;
-      return _regeneratorRuntime().wrap(function _callee6$(_context6) {
-        while (1) switch (_context6.prev = _context6.next) {
+        _loop,
+        _ret,
+        _args7 = arguments;
+      return _regeneratorRuntime().wrap(function _callee6$(_context7) {
+        while (1) switch (_context7.prev = _context7.next) {
           case 0:
-            _ref9 = _args6.length > 0 && _args6[0] !== undefined ? _args6[0] : {}, _ref9$expiration = _ref9.expiration, expiration = _ref9$expiration === void 0 ? _asyncToGenerator(_regeneratorRuntime().mark(function _callee4() {
+            _ref9 = _args7.length > 0 && _args7[0] !== undefined ? _args7[0] : {}, _ref9$expiration = _ref9.expiration, expiration = _ref9$expiration === void 0 ? _asyncToGenerator(_regeneratorRuntime().mark(function _callee4() {
               return _regeneratorRuntime().wrap(function _callee4$(_context4) {
                 while (1) switch (_context4.prev = _context4.next) {
                   case 0:
@@ -262,111 +266,138 @@ var AssembledTransaction = exports.AssembledTransaction = function () {
                     return _context4.stop();
                 }
               }, _callee4);
-            }))() : _ref9$expiration, _ref9$signAuthEntry = _ref9.signAuthEntry, signAuthEntry = _ref9$signAuthEntry === void 0 ? _this.options.signAuthEntry : _ref9$signAuthEntry, _ref9$publicKey = _ref9.publicKey, publicKey = _ref9$publicKey === void 0 ? _this.options.publicKey : _ref9$publicKey;
+            }))() : _ref9$expiration, _ref9$signAuthEntry = _ref9.signAuthEntry, signAuthEntry = _ref9$signAuthEntry === void 0 ? _this.options.signAuthEntry : _ref9$signAuthEntry, _ref9$address = _ref9.address, address = _ref9$address === void 0 ? _this.options.publicKey : _ref9$address, _ref9$authorizeEntry = _ref9.authorizeEntry, authorizeEntry = _ref9$authorizeEntry === void 0 ? _stellarBase.authorizeEntry : _ref9$authorizeEntry;
             if (_this.built) {
-              _context6.next = 3;
+              _context7.next = 3;
               break;
             }
             throw new Error("Transaction has not yet been assembled or simulated");
           case 3:
+            if (!(authorizeEntry === _stellarBase.authorizeEntry)) {
+              _context7.next = 11;
+              break;
+            }
             needsNonInvokerSigningBy = _this.needsNonInvokerSigningBy();
-            if (needsNonInvokerSigningBy) {
-              _context6.next = 6;
+            if (!(needsNonInvokerSigningBy.length === 0)) {
+              _context7.next = 7;
               break;
             }
             throw new AssembledTransaction.Errors.NoUnsignedNonInvokerAuthEntries("No unsigned non-invoker auth entries; maybe you already signed?");
-          case 6:
-            if (!(needsNonInvokerSigningBy.indexOf(publicKey !== null && publicKey !== void 0 ? publicKey : "") === -1)) {
-              _context6.next = 8;
+          case 7:
+            if (!(needsNonInvokerSigningBy.indexOf(address !== null && address !== void 0 ? address : "") === -1)) {
+              _context7.next = 9;
               break;
             }
-            throw new AssembledTransaction.Errors.NoSignatureNeeded("No auth entries for public key \"".concat(publicKey, "\""));
-          case 8:
+            throw new AssembledTransaction.Errors.NoSignatureNeeded("No auth entries for public key \"".concat(address, "\""));
+          case 9:
             if (signAuthEntry) {
-              _context6.next = 10;
+              _context7.next = 11;
               break;
             }
-            throw new AssembledTransaction.Errors.NoSigner("You must provide `signAuthEntry` when calling `signAuthEntries`, " + "or when constructing the `Client` or `AssembledTransaction`");
-          case 10:
+            throw new AssembledTransaction.Errors.NoSigner("You must provide `signAuthEntry` or a custom `authorizeEntry`");
+          case 11:
             rawInvokeHostFunctionOp = _this.built.operations[0];
             authEntries = (_rawInvokeHostFunctio2 = rawInvokeHostFunctionOp.auth) !== null && _rawInvokeHostFunctio2 !== void 0 ? _rawInvokeHostFunctio2 : [];
             _iterator = _createForOfIteratorHelper(authEntries.entries());
-            _context6.prev = 13;
+            _context7.prev = 14;
+            _loop = _regeneratorRuntime().mark(function _loop() {
+              var _step$value, i, entry, credentials, authEntryAddress, sign;
+              return _regeneratorRuntime().wrap(function _loop$(_context6) {
+                while (1) switch (_context6.prev = _context6.next) {
+                  case 0:
+                    _step$value = _slicedToArray(_step.value, 2), i = _step$value[0], entry = _step$value[1];
+                    credentials = _stellarBase.xdr.SorobanCredentials.fromXDR(entry.credentials().toXDR());
+                    if (!(credentials.switch() !== _stellarBase.xdr.SorobanCredentialsType.sorobanCredentialsAddress())) {
+                      _context6.next = 4;
+                      break;
+                    }
+                    return _context6.abrupt("return", 0);
+                  case 4:
+                    authEntryAddress = _stellarBase.Address.fromScAddress(credentials.address().address()).toString();
+                    if (!(authEntryAddress !== address)) {
+                      _context6.next = 7;
+                      break;
+                    }
+                    return _context6.abrupt("return", 0);
+                  case 7:
+                    sign = signAuthEntry !== null && signAuthEntry !== void 0 ? signAuthEntry : Promise.resolve;
+                    _context6.t0 = authorizeEntry;
+                    _context6.t1 = entry;
+                    _context6.t2 = function () {
+                      var _ref11 = _asyncToGenerator(_regeneratorRuntime().mark(function _callee5(preimage) {
+                        return _regeneratorRuntime().wrap(function _callee5$(_context5) {
+                          while (1) switch (_context5.prev = _context5.next) {
+                            case 0:
+                              _context5.t0 = Buffer;
+                              _context5.next = 3;
+                              return sign(preimage.toXDR("base64"), {
+                                accountToSign: address
+                              });
+                            case 3:
+                              _context5.t1 = _context5.sent;
+                              return _context5.abrupt("return", _context5.t0.from.call(_context5.t0, _context5.t1, "base64"));
+                            case 5:
+                            case "end":
+                              return _context5.stop();
+                          }
+                        }, _callee5);
+                      }));
+                      return function (_x) {
+                        return _ref11.apply(this, arguments);
+                      };
+                    }();
+                    _context6.next = 13;
+                    return expiration;
+                  case 13:
+                    _context6.t3 = _context6.sent;
+                    _context6.t4 = _this.options.networkPassphrase;
+                    _context6.next = 17;
+                    return (0, _context6.t0)(_context6.t1, _context6.t2, _context6.t3, _context6.t4);
+                  case 17:
+                    authEntries[i] = _context6.sent;
+                  case 18:
+                  case "end":
+                    return _context6.stop();
+                }
+              }, _loop);
+            });
             _iterator.s();
-          case 15:
+          case 17:
             if ((_step = _iterator.n()).done) {
-              _context6.next = 34;
-              break;
-            }
-            _step$value = _slicedToArray(_step.value, 2), i = _step$value[0], entry = _step$value[1];
-            if (!(entry.credentials().switch() !== _stellarBase.xdr.SorobanCredentialsType.sorobanCredentialsAddress())) {
-              _context6.next = 19;
+              _context7.next = 24;
               break;
             }
-            return _context6.abrupt("continue", 32);
+            return _context7.delegateYield(_loop(), "t0", 19);
           case 19:
-            pk = _stellarBase.StrKey.encodeEd25519PublicKey(entry.credentials().address().address().accountId().ed25519());
-            if (!(pk !== publicKey)) {
-              _context6.next = 22;
+            _ret = _context7.t0;
+            if (!(_ret === 0)) {
+              _context7.next = 22;
               break;
             }
-            return _context6.abrupt("continue", 32);
+            return _context7.abrupt("continue", 22);
           case 22:
-            _context6.t0 = _stellarBase.authorizeEntry;
-            _context6.t1 = entry;
-            _context6.t2 = function () {
-              var _ref11 = _asyncToGenerator(_regeneratorRuntime().mark(function _callee5(preimage) {
-                return _regeneratorRuntime().wrap(function _callee5$(_context5) {
-                  while (1) switch (_context5.prev = _context5.next) {
-                    case 0:
-                      _context5.t0 = Buffer;
-                      _context5.next = 3;
-                      return signAuthEntry(preimage.toXDR("base64"));
-                    case 3:
-                      _context5.t1 = _context5.sent;
-                      return _context5.abrupt("return", _context5.t0.from.call(_context5.t0, _context5.t1, "base64"));
-                    case 5:
-                    case "end":
-                      return _context5.stop();
-                  }
-                }, _callee5);
-              }));
-              return function (_x) {
-                return _ref11.apply(this, arguments);
-              };
-            }();
-            _context6.next = 27;
-            return expiration;
-          case 27:
-            _context6.t3 = _context6.sent;
-            _context6.t4 = _this.options.networkPassphrase;
-            _context6.next = 31;
-            return (0, _context6.t0)(_context6.t1, _context6.t2, _context6.t3, _context6.t4);
-          case 31:
-            authEntries[i] = _context6.sent;
-          case 32:
-            _context6.next = 15;
+            _context7.next = 17;
             break;
-          case 34:
-            _context6.next = 39;
+          case 24:
+            _context7.next = 29;
             break;
-          case 36:
-            _context6.prev = 36;
-            _context6.t5 = _context6["catch"](13);
-            _iterator.e(_context6.t5);
-          case 39:
-            _context6.prev = 39;
+          case 26:
+            _context7.prev = 26;
+            _context7.t1 = _context7["catch"](14);
+            _iterator.e(_context7.t1);
+          case 29:
+            _context7.prev = 29;
             _iterator.f();
-            return _context6.finish(39);
-          case 42:
+            return _context7.finish(29);
+          case 32:
           case "end":
-            return _context6.stop();
+            return _context7.stop();
         }
-      }, _callee6, null, [[13, 36, 39, 42]]);
+      }, _callee6, null, [[14, 26, 29, 32]]);
     })));
     this.options = options;
     this.options.simulate = (_this$options$simulat = this.options.simulate) !== null && _this$options$simulat !== void 0 ? _this$options$simulat : true;
-    this.server = new _server.Server(this.options.rpcUrl, {
+    this.server = new _rpc.Server(this.options.rpcUrl, {
       allowHttp: (_this$options$allowHt = this.options.allowHttp) !== null && _this$options$allowHt !== void 0 ? _this$options$allowHt : false
     });
   }
@@ -454,23 +485,23 @@ var AssembledTransaction = exports.AssembledTransaction = function () {
     value: (function () {
       var _send = _asyncToGenerator(_regeneratorRuntime().mark(function _callee7() {
         var sent;
-        return _regeneratorRuntime().wrap(function _callee7$(_context7) {
-          while (1) switch (_context7.prev = _context7.next) {
+        return _regeneratorRuntime().wrap(function _callee7$(_context8) {
+          while (1) switch (_context8.prev = _context8.next) {
             case 0:
               if (this.signed) {
-                _context7.next = 2;
+                _context8.next = 2;
                 break;
               }
               throw new Error("The transaction has not yet been signed. Run `sign` first, or use `signAndSend` instead.");
             case 2:
-              _context7.next = 4;
-              return _sent_transaction.SentTransaction.init(undefined, this);
+              _context8.next = 4;
+              return _sent_transaction.SentTransaction.init(this);
             case 4:
-              sent = _context7.sent;
-              return _context7.abrupt("return", sent);
+              sent = _context8.sent;
+              return _context8.abrupt("return", sent);
             case 6:
             case "end":
-              return _context7.stop();
+              return _context8.stop();
           }
         }, _callee7, this);
       }));
@@ -492,47 +523,47 @@ var AssembledTransaction = exports.AssembledTransaction = function () {
       var _restoreFootprint = _asyncToGenerator(_regeneratorRuntime().mark(function _callee8(restorePreamble, account) {
         var _account;
         var restoreTx, sentTransaction;
-        return _regeneratorRuntime().wrap(function _callee8$(_context8) {
-          while (1) switch (_context8.prev = _context8.next) {
+        return _regeneratorRuntime().wrap(function _callee8$(_context9) {
+          while (1) switch (_context9.prev = _context9.next) {
             case 0:
               if (this.options.signTransaction) {
-                _context8.next = 2;
+                _context9.next = 2;
                 break;
               }
               throw new Error("For automatic restore to work you must provide a signTransaction function when initializing your Client");
             case 2:
               if (!((_account = account) !== null && _account !== void 0)) {
-                _context8.next = 6;
+                _context9.next = 6;
                 break;
               }
-              _context8.t0 = _account;
-              _context8.next = 9;
+              _context9.t0 = _account;
+              _context9.next = 9;
               break;
             case 6:
-              _context8.next = 8;
+              _context9.next = 8;
               return (0, _utils.getAccount)(this.options, this.server);
             case 8:
-              _context8.t0 = _context8.sent;
+              _context9.t0 = _context9.sent;
             case 9:
-              account = _context8.t0;
-              _context8.next = 12;
+              account = _context9.t0;
+              _context9.next = 12;
               return AssembledTransaction.buildFootprintRestoreTransaction(_objectSpread({}, this.options), restorePreamble.transactionData, account, restorePreamble.minResourceFee);
             case 12:
-              restoreTx = _context8.sent;
-              _context8.next = 15;
+              restoreTx = _context9.sent;
+              _context9.next = 15;
               return restoreTx.signAndSend();
             case 15:
-              sentTransaction = _context8.sent;
+              sentTransaction = _context9.sent;
               if (sentTransaction.getTransactionResponse) {
-                _context8.next = 18;
+                _context9.next = 18;
                 break;
               }
               throw new AssembledTransaction.Errors.RestorationFailure("The attempt at automatic restore failed. \n".concat(JSON.stringify(sentTransaction)));
             case 18:
-              return _context8.abrupt("return", sentTransaction.getTransactionResponse);
+              return _context9.abrupt("return", sentTransaction.getTransactionResponse);
             case 19:
             case "end":
-              return _context8.stop();
+              return _context9.stop();
           }
         }, _callee8, this);
       }));
@@ -588,30 +619,30 @@ var AssembledTransaction = exports.AssembledTransaction = function () {
       var _build = _asyncToGenerator(_regeneratorRuntime().mark(function _callee9(options) {
         var _options$fee, _options$args, _options$timeoutInSec;
         var tx, contract, account;
-        return _regeneratorRuntime().wrap(function _callee9$(_context9) {
-          while (1) switch (_context9.prev = _context9.next) {
+        return _regeneratorRuntime().wrap(function _callee9$(_context10) {
+          while (1) switch (_context10.prev = _context10.next) {
             case 0:
               tx = new AssembledTransaction(options);
               contract = new _stellarBase.Contract(options.contractId);
-              _context9.next = 4;
+              _context10.next = 4;
               return (0, _utils.getAccount)(options, tx.server);
             case 4:
-              account = _context9.sent;
+              account = _context10.sent;
               tx.raw = new _stellarBase.TransactionBuilder(account, {
                 fee: (_options$fee = options.fee) !== null && _options$fee !== void 0 ? _options$fee : _stellarBase.BASE_FEE,
                 networkPassphrase: options.networkPassphrase
               }).addOperation(contract.call.apply(contract, [options.method].concat(_toConsumableArray((_options$args = options.args) !== null && _options$args !== void 0 ? _options$args : [])))).setTimeout((_options$timeoutInSec = options.timeoutInSeconds) !== null && _options$timeoutInSec !== void 0 ? _options$timeoutInSec : _types.DEFAULT_TIMEOUT);
               if (!options.simulate) {
-                _context9.next = 9;
+                _context10.next = 9;
                 break;
               }
-              _context9.next = 9;
+              _context10.next = 9;
               return tx.simulate();
             case 9:
-              return _context9.abrupt("return", tx);
+              return _context10.abrupt("return", tx);
             case 10:
             case "end":
-              return _context9.stop();
+              return _context10.stop();
           }
         }, _callee9);
       }));
@@ -626,23 +657,23 @@ var AssembledTransaction = exports.AssembledTransaction = function () {
       var _buildFootprintRestoreTransaction = _asyncToGenerator(_regeneratorRuntime().mark(function _callee10(options, sorobanData, account, fee) {
         var _options$timeoutInSec2;
         var tx;
-        return _regeneratorRuntime().wrap(function _callee10$(_context10) {
-          while (1) switch (_context10.prev = _context10.next) {
+        return _regeneratorRuntime().wrap(function _callee10$(_context11) {
+          while (1) switch (_context11.prev = _context11.next) {
             case 0:
               tx = new AssembledTransaction(options);
               tx.raw = new _stellarBase.TransactionBuilder(account, {
                 fee: fee,
                 networkPassphrase: options.networkPassphrase
               }).setSorobanData(sorobanData instanceof _stellarBase.SorobanDataBuilder ? sorobanData.build() : sorobanData).addOperation(_stellarBase.Operation.restoreFootprint({})).setTimeout((_options$timeoutInSec2 = options.timeoutInSeconds) !== null && _options$timeoutInSec2 !== void 0 ? _options$timeoutInSec2 : _types.DEFAULT_TIMEOUT);
-              _context10.next = 4;
+              _context11.next = 4;
               return tx.simulate({
                 restore: false
               });
             case 4:
-              return _context10.abrupt("return", tx);
+              return _context11.abrupt("return", tx);
             case 5:
             case "end":
-              return _context10.stop();
+              return _context11.stop();
           }
         }, _callee10);
       }));

package/lib/contract/basic_node_signer.d.ts

@@ -1,10 +1,15 @@
 import { Keypair } from "@stellar/stellar-base";
 /**
- * For use with {@link Client} and {@link AssembledTransaction}.
+ * For use with {@link Client} and {@link module:contract.AssembledTransaction}.
  * Implements `signTransaction` and `signAuthEntry` with signatures expected by
  * those classes. This is useful for testing and maybe some simple Node
  * applications. Feel free to use this as a starting point for your own
  * Wallet/TransactionSigner implementation.
+ *
+ * @memberof module:contract
+ *
+ * @param {Keypair} keypair {@link Keypair} to use to sign the transaction or auth entry
+ * @param {string} networkPassphrase passphrase of network to sign for
  */
 export declare const basicNodeSigner: (keypair: Keypair, networkPassphrase: string) => {
     signTransaction: (tx: string) => Promise<string>;

package/lib/contract/client.d.ts

@@ -1,49 +1,49 @@
 import { Spec } from "./spec";
 import { AssembledTransaction } from "./assembled_transaction";
 import type { ClientOptions } from "./types";
+/**
+ * Generate a class from the contract spec that where each contract method
+ * gets included with an identical name.
+ *
+ * Each method returns an {@link module:contract.AssembledTransaction | AssembledTransaction} that can
+ * be used to modify, simulate, decode results, and possibly sign, & submit the
+ * transaction.
+ *
+ * @memberof module:contract
+ *
+ * @class
+ * @param {module:contract.Spec} spec {@link Spec} to construct a Client for
+ * @param {ClientOptions} options see {@link ClientOptions}
+ */
 export declare class Client {
-    /** {@link Spec} to construct a Client for */
     readonly spec: Spec;
-    /** see {@link ClientOptions} */
     readonly options: ClientOptions;
-    /**
-     * Generate a class from the contract spec that where each contract method
-     * gets included with an identical name.
-     *
-     * Each method returns an {@link AssembledTransaction} that can be used to
-     * modify, simulate, decode results, and possibly sign, & submit the
-     * transaction.
-     */
-    constructor(
-    /** {@link Spec} to construct a Client for */
-    spec: Spec, 
-    /** see {@link ClientOptions} */
-    options: ClientOptions);
+    constructor(spec: Spec, options: ClientOptions);
     /**
      * Generates a Client instance from the provided ClientOptions and the contract's wasm hash.
      * The wasmHash can be provided in either hex or base64 format.
      *
-     * @param wasmHash The hash of the contract's wasm binary, in either hex or base64 format.
-     * @param options The ClientOptions object containing the necessary configuration, including the rpcUrl.
-     * @param format The format of the provided wasmHash, either "hex" or "base64". Defaults to "hex".
-     * @returns A Promise that resolves to a Client instance.
+     * @param {Buffer | string} wasmHash The hash of the contract's wasm binary, in either hex or base64 format.
+     * @param {ClientOptions} options The ClientOptions object containing the necessary configuration, including the rpcUrl.
+     * @param {('hex' | 'base64')} [format='hex'] The format of the provided wasmHash, either "hex" or "base64". Defaults to "hex".
+     * @returns {Promise<module:contract.Client>} A Promise that resolves to a Client instance.
      * @throws {TypeError} If the provided options object does not contain an rpcUrl.
      */
     static fromWasmHash(wasmHash: Buffer | string, options: ClientOptions, format?: "hex" | "base64"): Promise<Client>;
     /**
      * Generates a Client instance from the provided ClientOptions and the contract's wasm binary.
      *
-     * @param wasm The contract's wasm binary as a Buffer.
-     * @param options The ClientOptions object containing the necessary configuration.
-     * @returns A Promise that resolves to a Client instance.
+     * @param {Buffer} wasm The contract's wasm binary as a Buffer.
+     * @param {ClientOptions} options The ClientOptions object containing the necessary configuration.
+     * @returns {Promise<module:contract.Client>} A Promise that resolves to a Client instance.
      * @throws {Error} If the contract spec cannot be obtained from the provided wasm binary.
      */
     static fromWasm(wasm: Buffer, options: ClientOptions): Promise<Client>;
     /**
      * Generates a Client instance from the provided ClientOptions, which must include the contractId and rpcUrl.
      *
-     * @param options The ClientOptions object containing the necessary configuration, including the contractId and rpcUrl.
-     * @returns A Promise that resolves to a Client instance.
+     * @param {ClientOptions} options The ClientOptions object containing the necessary configuration, including the contractId and rpcUrl.
+     * @returns {Promise<module:contract.Client>} A Promise that resolves to a Client instance.
      * @throws {TypeError} If the provided options object does not contain both rpcUrl and contractId.
      */
     static from(options: ClientOptions): Promise<Client>;

package/lib/contract/rust_result.d.ts

@@ -3,10 +3,11 @@
  * methods that return Results, to maintain their distinction from methods
  * that simply either return a value or throw.
  *
- * **Why is this needed?**
+ * #### Why is this needed?
  *
- * This is used by `ContractSpec` and `AssembledTransaction` when parsing
- * values return by contracts.
+ * This is used by {@link module:contract.Spec | `ContractSpec`} and
+ * {@link module:contract.AssembledTransaction | `AssembledTransaction`} when
+ * parsing values return by contracts.
  *
  * Contract methods can be implemented to return simple values, in which case
  * they can also throw errors. This matches JavaScript's most idiomatic
@@ -27,6 +28,8 @@
  * In the future, if this feels too un-idiomatic for JavaScript, we can always
  * remove this and flatten all JS calls to `try...catch`. Easier to remove this
  * logic later than it would be to add it.
+ *
+ * @memberof module:contract
  */
 export interface Result<T, E extends ErrorMessage = ErrorMessage> {
     unwrap(): T;
@@ -36,17 +39,22 @@ export interface Result<T, E extends ErrorMessage = ErrorMessage> {
 }
 /**
  * Error interface containing the error message. Matches Rust's implementation.
- * Part of implementing {@link Result}, a minimal implementation of Rust's
- * `Result` type. Used for contract methods that return Results, to maintain
- * their distinction from methods that simply either return a value or throw.
+ * Part of implementing {@link module:contract.Result | Result}, a minimal
+ * implementation of Rust's `Result` type. Used for contract methods that return
+ * Results, to maintain their distinction from methods that simply either return
+ * a value or throw.
+ *
+ * @memberof module:contract
  */
 export interface ErrorMessage {
     message: string;
 }
 /**
- * Part of implementing {@link Result}, a minimal implementation of Rust's
- * `Result` type. Used for contract methods that return Results, to maintain
- * their distinction from methods that simply either return a value or throw.
+ * Part of implementing {@link module:contract.Result | Result}, a minimal
+ * implementation of Rust's `Result` type. Used for contract methods that return
+ * Results, to maintain their distinction from methods that simply either return
+ * a value or throw.
+ * @private
  */
 export declare class Ok<T> implements Result<T, never> {
     readonly value: T;
@@ -57,9 +65,11 @@ export declare class Ok<T> implements Result<T, never> {
     isErr(): boolean;
 }
 /**
- * Part of implementing {@link Result}, a minimal implementation of Rust's
- * `Result` type. Used for contract methods that return Results, to maintain
- * their distinction from methods that simply either return a value or throw.
+ * Part of implementing {@link module:contract.Result | Result}, a minimal
+ * implementation of Rust's `Result` type. Used for contract methods that return
+ * Results, to maintain their distinction from methods that simply either return
+ * a value or throw.
+ * @private
  */
 export declare class Err<E extends ErrorMessage> implements Result<never, E> {
     readonly error: E;