@stellar/stellar-sdk 13.0.0-beta.1 → 13.0.0-rc.2

package/lib/no-eventsource/stellartoml/index.d.ts

@@ -37,6 +37,7 @@ export declare namespace Api {
     interface StellarTomlResolveOptions {
         allowHttp?: boolean;
         timeout?: number;
+        allowedRedirects?: number;
     }
     type Url = string;
     type PublicKey = string;

package/lib/no-eventsource/stellartoml/index.js

@@ -27,6 +27,7 @@ var Resolver = exports.Resolver = function () {
     key: "resolve",
     value: (function () {
       var _resolve = _asyncToGenerator(_regeneratorRuntime().mark(function _callee(domain) {
+        var _opts$allowedRedirect;
         var opts,
           allowHttp,
           timeout,
@@ -40,6 +41,7 @@ var Resolver = exports.Resolver = function () {
               timeout = typeof opts.timeout === "undefined" ? _config.Config.getTimeout() : opts.timeout;
               protocol = allowHttp ? "http" : "https";
               return _context.abrupt("return", _httpClient.httpClient.get("".concat(protocol, "://").concat(domain, "/.well-known/stellar.toml"), {
+                maxRedirects: (_opts$allowedRedirect = opts.allowedRedirects) !== null && _opts$allowedRedirect !== void 0 ? _opts$allowedRedirect : 0,
                 maxContentLength: STELLAR_TOML_MAX_SIZE,
                 cancelToken: timeout ? new CancelToken(function (cancel) {
                   return setTimeout(function () {

package/lib/no-eventsource/utils.d.ts

@@ -16,4 +16,5 @@ export declare class Utils {
      * @static
      */
     static validateTimebounds(transaction: Transaction, gracePeriod?: number): boolean;
+    static sleep(ms: number): Promise<void>;
 }

package/lib/no-eventsource/utils.js

@@ -27,5 +27,12 @@ var Utils = exports.Utils = function () {
         maxTime = _transaction$timeBoun.maxTime;
       return now >= Number.parseInt(minTime, 10) - gracePeriod && now <= Number.parseInt(maxTime, 10) + gracePeriod;
     }
+  }, {
+    key: "sleep",
+    value: function sleep(ms) {
+      return new Promise(function (resolve) {
+        return setTimeout(resolve, ms);
+      });
+    }
   }]);
 }();

package/lib/rpc/api.d.ts

@@ -1,9 +1,5 @@
 import { Contract, SorobanDataBuilder, xdr } from '@stellar/stellar-base';
 export declare namespace Api {
-    export interface Cost {
-        cpuInsns: string;
-        memBytes: string;
-    }
     export interface GetHealthResponse {
         status: 'healthy';
     }
@@ -56,6 +52,7 @@ export declare namespace Api {
     export type GetTransactionResponse = GetSuccessfulTransactionResponse | GetFailedTransactionResponse | GetMissingTransactionResponse;
     interface GetAnyTransactionResponse {
         status: GetTransactionStatus;
+        txHash: string;
         latestLedger: number;
         latestLedgerCloseTime: number;
         oldestLedger: number;
@@ -93,13 +90,14 @@ export declare namespace Api {
         latestLedgerCloseTime: number;
         oldestLedger: number;
         oldestLedgerCloseTime: number;
+        txHash: string;
         applicationOrder?: number;
         feeBump?: boolean;
+        ledger?: number;
+        createdAt?: number;
         envelopeXdr?: string;
         resultXdr?: string;
         resultMetaXdr?: string;
-        ledger?: number;
-        createdAt?: number;
         diagnosticEventsXdr?: string[];
     }
     export interface GetTransactionsRequest {
@@ -113,6 +111,7 @@ export declare namespace Api {
         createdAt: number;
         applicationOrder: number;
         feeBump: boolean;
+        txHash: string;
         envelopeXdr?: string;
         resultXdr?: string;
         resultMetaXdr?: string;
@@ -124,6 +123,7 @@ export declare namespace Api {
         createdAt: number;
         applicationOrder: number;
         feeBump: boolean;
+        txHash: string;
         envelopeXdr: xdr.TransactionEnvelope;
         resultXdr: xdr.TransactionResult;
         resultMetaXdr: xdr.TransactionMeta;
@@ -170,6 +170,7 @@ export declare namespace Api {
         type: EventType;
         ledger: number;
         ledgerClosedAt: string;
+        cursor: string;
         pagingToken: string;
         inSuccessfulContractCall: boolean;
         txHash: string;
@@ -255,7 +256,6 @@ export declare namespace Api {
     export interface SimulateTransactionSuccessResponse extends BaseSimulateTransactionResponse {
         transactionData: SorobanDataBuilder;
         minResourceFee: string;
-        cost: Cost;
         /** present only for invocation simulation */
         result?: SimulateHostFunctionResult;
         /** State Difference information */
@@ -304,7 +304,6 @@ export declare namespace Api {
          * invokeHostFunctionOperation is supported per transaction.
          * */
         results?: RawSimulateHostFunctionResult[];
-        cost?: Cost;
         /** Present if succeeded but has expired ledger entries */
         restorePreamble?: {
             minResourceFee: string;
@@ -315,8 +314,12 @@ export declare namespace Api {
     }
     export interface GetVersionInfoResponse {
         version: string;
+        commitHash: string;
+        buildTimestamp: string;
+        captiveCoreVersion: string;
+        protocolVersion: number;
         commit_hash: string;
-        build_time_stamp: string;
+        build_timestamp: string;
         captive_core_version: string;
         protocol_version: number;
     }

package/lib/rpc/axios.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = exports.default = exports.AxiosClient = void 0;
 var _httpClient = require("../http-client");
-var version = exports.version = "13.0.0-beta.1";
+var version = exports.version = "13.0.0-rc.2";
 var AxiosClient = exports.AxiosClient = (0, _httpClient.create)({
   headers: {
     'X-Client-Name': 'js-soroban-client',

package/lib/rpc/index.d.ts

@@ -1,6 +1,6 @@
 /** @module rpc */
 export * from "./api";
-export { RpcServer as Server, Durability } from "./server";
+export { RpcServer as Server, BasicSleepStrategy, LinearSleepStrategy, Durability } from "./server";
 export { default as AxiosClient } from "./axios";
 export { parseRawSimulation, parseRawEvents } from "./parsers";
 export * from "./transaction";

package/lib/rpc/index.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 var _exportNames = {
   Server: true,
+  BasicSleepStrategy: true,
+  LinearSleepStrategy: true,
   Durability: true,
   AxiosClient: true,
   parseRawSimulation: true,
@@ -16,12 +18,24 @@ Object.defineProperty(exports, "AxiosClient", {
     return _axios.default;
   }
 });
+Object.defineProperty(exports, "BasicSleepStrategy", {
+  enumerable: true,
+  get: function get() {
+    return _server.BasicSleepStrategy;
+  }
+});
 Object.defineProperty(exports, "Durability", {
   enumerable: true,
   get: function get() {
     return _server.Durability;
   }
 });
+Object.defineProperty(exports, "LinearSleepStrategy", {
+  enumerable: true,
+  get: function get() {
+    return _server.LinearSleepStrategy;
+  }
+});
 Object.defineProperty(exports, "Server", {
   enumerable: true,
   get: function get() {

package/lib/rpc/parsers.d.ts

@@ -8,7 +8,7 @@ import { Api } from './api';
  * @returns {Api.SendTransactionResponse} transaction response parsed from the Soroban RPC server's response
  */
 export declare function parseRawSendTransaction(raw: Api.RawSendTransactionResponse): Api.SendTransactionResponse;
-export declare function parseTransactionInfo(raw: Api.RawTransactionInfo | Api.RawGetTransactionResponse): Omit<Api.TransactionInfo, 'status'>;
+export declare function parseTransactionInfo(raw: Api.RawTransactionInfo | Api.RawGetTransactionResponse): Omit<Api.TransactionInfo, 'status' | 'txHash'>;
 export declare function parseRawTransactions(r: Api.RawTransactionInfo): Api.TransactionInfo;
 /**
  * Parse and return the retrieved events, if any, from a raw response from a Soroban RPC server.

package/lib/rpc/parsers.js

@@ -57,7 +57,8 @@ function parseTransactionInfo(raw) {
 }
 function parseRawTransactions(r) {
   return _objectSpread({
-    status: r.status
+    status: r.status,
+    txHash: r.txHash
   }, parseTransactionInfo(r));
 }
 function parseRawEvents(raw) {
@@ -100,8 +101,7 @@ function parseSuccessful(sim, partial) {
   var _sim$results$length, _sim$results, _sim$stateChanges$len, _sim$stateChanges, _sim$stateChanges2;
   var success = _objectSpread(_objectSpread(_objectSpread({}, partial), {}, {
     transactionData: new _stellarBase.SorobanDataBuilder(sim.transactionData),
-    minResourceFee: sim.minResourceFee,
-    cost: sim.cost
+    minResourceFee: sim.minResourceFee
   }, ((_sim$results$length = (_sim$results = sim.results) === null || _sim$results === void 0 ? void 0 : _sim$results.length) !== null && _sim$results$length !== void 0 ? _sim$results$length : 0 > 0) && {
     result: sim.results.map(function (row) {
       var _row$auth;

package/lib/rpc/server.d.ts

@@ -48,6 +48,10 @@ export declare namespace RpcServer {
         cursor?: string;
         limit?: number;
     }
+    interface PollingOptions {
+        attempts?: number;
+        sleepStrategy?: SleepStrategy;
+    }
     interface ResourceLeeway {
         cpuInstructions: number;
     }
@@ -57,6 +61,13 @@ export declare namespace RpcServer {
         headers?: Record<string, string>;
     }
 }
+export declare const BasicSleepStrategy: SleepStrategy;
+export declare const LinearSleepStrategy: SleepStrategy;
+/**
+ * A function that returns the number of *milliseconds* to sleep
+ * on a given `iter`ation.
+ */
+export type SleepStrategy = (iter: number) => number;
 /**
  * Handles the network connection to a Soroban RPC instance, exposing an
  * interface for requests to that instance.
@@ -220,6 +231,32 @@ export declare class RpcServer {
      */
     getLedgerEntries(...keys: xdr.LedgerKey[]): Promise<Api.GetLedgerEntriesResponse>;
     _getLedgerEntries(...keys: xdr.LedgerKey[]): Promise<Api.RawGetLedgerEntriesResponse>;
+    /**
+     * Poll for a particular transaction with certain parameters.
+     *
+     * After submitting a transaction, clients can use this to poll for
+     * transaction completion and return a definitive state of success or failure.
+     *
+     * @param {string} hash   the transaction you're polling for
+     * @param {number} [opts.attempts] (optional) the number of attempts to make
+     *    before returning the last-seen status. By default or on invalid inputs,
+     *    try 5 times.
+     * @param {SleepStrategy} [opts.sleepStrategy] (optional) the amount of time
+     *    to wait for between each attempt. By default, sleep for 1 second between
+     *    each attempt.
+     *
+     * @return {Promise<Api.GetTransactionsResponse>} the response after a "found"
+     *    response (which may be success or failure) or the last response obtained
+     *    after polling the maximum number of specified attempts.
+     *
+     * @example
+     * const h = "c4515e3bdc0897f21cc5dbec8c82cf0a936d4741cb74a8e158eb51b9fb00411a";
+     * const txStatus = await server.pollTransaction(h, {
+     *    attempts: 100, // I'm a maniac
+     *    sleepStrategy: rpc.LinearSleepStrategy
+     * }); // this will take 5,050 seconds to complete
+     */
+    pollTransaction(hash: string, opts?: RpcServer.PollingOptions): Promise<Api.GetTransactionResponse>;
     /**
      * Fetch the details of a submitted transaction.
      *
@@ -227,10 +264,11 @@ export declare class RpcServer {
      * transaction has completed.
      *
      * @param {string} hash Hex-encoded hash of the transaction to check
-     * @returns {Promise<Api.GetTransactionResponse>} The status,
-     *    result, and other details about the transaction
+     * @returns {Promise<Api.GetTransactionResponse>} The status, result, and
+     *    other details about the transaction
      *
-     * @see {@link https://developers.stellar.org/docs/data/rpc/api-reference/methods/getTransaction | getTransaction docs}
+     * @see
+     * {@link https://developers.stellar.org/docs/data/rpc/api-reference/methods/getTransaction | getTransaction docs}
      *
      * @example
      * const transactionHash = "c4515e3bdc0897f21cc5dbec8c82cf0a936d4741cb74a8e158eb51b9fb00411a";