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

package/lib/browser.d.ts

@@ -1,6 +1,6 @@
-import axios from "axios";
+import { httpClient } from "./http-client";
 export * from "./index";
 export * as StellarBase from "@stellar/stellar-base";
-export { axios };
+export { httpClient };
 declare const _default: any;
 export default _default;

package/lib/browser.js

@@ -5,18 +5,17 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 var _exportNames = {
-  axios: true,
+  httpClient: true,
   StellarBase: true
 };
-exports.StellarBase = void 0;
-Object.defineProperty(exports, "axios", {
+exports.default = exports.StellarBase = void 0;
+Object.defineProperty(exports, "httpClient", {
   enumerable: true,
   get: function get() {
-    return _axios.default;
+    return _httpClient.httpClient;
   }
 });
-exports.default = void 0;
-var _axios = _interopRequireDefault(require("axios"));
+var _httpClient = require("./http-client");
 var _index = require("./index");
 Object.keys(_index).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
@@ -33,5 +32,4 @@ var _StellarBase = _interopRequireWildcard(require("@stellar/stellar-base"));
 exports.StellarBase = _StellarBase;
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 var _default = exports.default = module.exports;

package/lib/config.d.ts

@@ -1,51 +1,63 @@
+/**
+ * Global config parameters.
+ */
+export interface Configuration {
+    /**
+     * Allow connecting to http servers. This must be set to false in production deployments!
+     * @default false
+     */
+    allowHttp: boolean;
+    /**
+     * Allow a timeout. Allows user to avoid nasty lag due network issues.
+     * @default 0
+     */
+    timeout: number;
+}
 /**
  * Global config class.
  *
- * Usage node:
- * ```
- * import {Config} from 'stellar-sdk';
+ * @hideconstructor
+ *
+ * @example <caption>Usage in node</caption>
+ * import { Config } from '@stellar/stellar-sdk';
  * Config.setAllowHttp(true);
  * Config.setTimeout(5000);
- * ```
  *
- * Usage browser:
- * ```
+ * @example <caption>Usage in the browser</caption>
  * StellarSdk.Config.setAllowHttp(true);
  * StellarSdk.Config.setTimeout(5000);
- * ```
- * @static
  */
 declare class Config {
     /**
-     * Sets `allowHttp` flag globally. When set to `true`, connections to insecure http protocol servers will be allowed.
-     * Must be set to `false` in production. Default: `false`.
-     * @param {boolean} value new allowHttp value
-     * @returns {void}
+     * Sets `allowHttp` flag globally. When set to `true`, connections to insecure
+     * http protocol servers will be allowed. Must be set to `false` in
+     * production.
+     * @default false
      * @static
      */
     static setAllowHttp(value: boolean): void;
     /**
-     * Sets `timeout` flag globally. When set to anything besides 0, the request will timeout after specified time (ms).
-     * Default: 0.
-     * @param {number} value new timeout value
-     * @returns {void}
+     * Sets `timeout` flag globally. When set to anything besides 0, the request
+     * will timeout after specified time (ms).
+     * @default 0
      * @static
      */
     static setTimeout(value: number): void;
     /**
+     * Returns the configured `allowHttp` flag.
      * @static
-     * @returns {boolean} allowHttp flag
+     * @returns {boolean}
      */
     static isAllowHttp(): boolean;
     /**
+     * Returns the configured `timeout` flag.
      * @static
-     * @returns {number} timeout flag
+     * @returns {number}
      */
     static getTimeout(): number;
     /**
      * Sets all global config flags to default values.
      * @static
-     * @returns {void}
      */
     static setDefault(): void;
 }

package/lib/contract/assembled_transaction.d.ts

@@ -1,8 +1,9 @@
-import { Account, SorobanDataBuilder, TransactionBuilder, xdr } from "@stellar/stellar-base";
+import { Account, SorobanDataBuilder, TransactionBuilder, authorizeEntry as stellarBaseAuthorizeEntry, xdr } from "@stellar/stellar-base";
 import type { AssembledTransactionOptions, ClientOptions, Tx, XDR_BASE64 } from "./types";
 import { Api } from "../rpc/api";
 import { SentTransaction } from "./sent_transaction";
 import { Spec } from "./spec";
+/** @module contract */
 /**
  * The main workhorse of {@link Client}. This class is used to wrap a
  * transaction-under-construction and provide high-level interfaces to the most
@@ -18,7 +19,7 @@ import { Spec } from "./spec";
  * Let's look at examples of how to use `AssembledTransaction` for a variety of
  * use-cases:
  *
- * # 1. Simple read call
+ * #### 1. Simple read call
  *
  * Since these only require simulation, you can get the `result` of the call
  * right after constructing your `AssembledTransaction`:
@@ -51,7 +52,7 @@ import { Spec } from "./spec";
  * })
  * ```
  *
- * # 2. Simple write call
+ * #### 2. Simple write call
  *
  * For write calls that will be simulated and then sent to the network without
  * further manipulation, only one more step is needed:
@@ -85,7 +86,7 @@ import { Spec } from "./spec";
  * const { result } = await tx.signAndSend()
  * ```
  *
- * # 3. More fine-grained control over transaction construction
+ * #### 3. More fine-grained control over transaction construction
  *
  * If you need more control over the transaction before simulating it, you can
  * set various {@link MethodOptions} when constructing your
@@ -118,7 +119,7 @@ import { Spec } from "./spec";
  * If you need to inspect the simulation later, you can access it with
  * `tx.simulation`.
  *
- * # 4. Multi-auth workflows
+ * #### 4. Multi-auth workflows
  *
  * Soroban, and Stellar in general, allows multiple parties to sign a
  * transaction.
@@ -205,6 +206,8 @@ import { Spec } from "./spec";
  * To see an even more complicated example, where Alice swaps with Bob but the
  * transaction is invoked by yet another party, check out
  * [test-swap.js](../../test/e2e/src/test-swap.js).
+ *
+ * @memberof module:contract
  */
 export declare class AssembledTransaction<T> {
     options: AssembledTransactionOptions<T>;
@@ -394,10 +397,11 @@ export declare class AssembledTransaction<T> {
      * If you don't want to simulate the transaction, you can set `simulate` to
      * `false` in the options.
      *
-     *     const tx = await AssembledTransaction.build({
-     *       ...,
-     *       simulate: false,
-     *     })
+     * @example
+     * const tx = await AssembledTransaction.build({
+     *   ...,
+     *   simulate: false,
+     * })
      */
     static build<T>(options: AssembledTransactionOptions<T>): Promise<AssembledTransaction<T>>;
     private static buildFootprintRestoreTransaction;
@@ -487,7 +491,7 @@ export declare class AssembledTransaction<T> {
      * Sending to all `needsNonInvokerSigningBy` owners in parallel is not
      * currently supported!
      */
-    signAuthEntries: ({ expiration, signAuthEntry, publicKey, }?: {
+    signAuthEntries: ({ expiration, signAuthEntry, address, authorizeEntry, }?: {
         /**
          * When to set each auth entry to expire. Could be any number of blocks in
          * the future. Can be supplied as a promise or a raw number. Default:
@@ -498,13 +502,17 @@ export declare class AssembledTransaction<T> {
          * Sign all auth entries for this account. Default: the account that
          * constructed the transaction
          */
-        publicKey?: string;
+        address?: string;
         /**
-         * You must provide this here if you did not provide one before. Default:
-         * the `signAuthEntry` function from the `Client` options. Must
-         * sign things as the given `publicKey`.
+         * You must provide this here if you did not provide one before and you are not passing `authorizeEntry`. Default: the `signAuthEntry` function from the `Client` options. Must sign things as the given `publicKey`.
          */
         signAuthEntry?: ClientOptions["signAuthEntry"];
+        /**
+         * If you have a pro use-case and need to override the default `authorizeEntry` function, rather than using the one in @stellar/stellar-base, you can do that! Your function needs to take at least the first argument, `entry: xdr.SorobanAuthorizationEntry`, and return a `Promise<xdr.SorobanAuthorizationEntry>`.
+         *
+         * Note that you if you pass this, then `signAuthEntry` will be ignored.
+        */
+        authorizeEntry?: typeof stellarBaseAuthorizeEntry;
     }) => Promise<void>;
     /**
      * Whether this transaction is a read call. This is determined by the