@stellar/stellar-sdk 12.2.0 → 13.0.0-beta.1

package/lib/rpc/api.d.ts

@@ -1,5 +1,4 @@
 import { Contract, SorobanDataBuilder, xdr } from '@stellar/stellar-base';
-/** @namespace Api */
 export declare namespace Api {
     export interface Cost {
         cpuInsns: string;
@@ -31,18 +30,18 @@ export declare namespace Api {
         entries: LedgerEntryResult[];
         latestLedger: number;
     }
-    /** @see https://soroban.stellar.org/api/methods/getLedgerEntries */
+    /** @see https://developers.stellar.org/docs/data/rpc/api-reference/methods/getLedgerEntries */
     export interface RawGetLedgerEntriesResponse {
         entries?: RawLedgerEntryResult[];
         latestLedger: number;
     }
-    /** @see https://soroban.stellar.org/api/methods/getNetwork */
+    /** @see https://developers.stellar.org/docs/data/rpc/api-reference/methods/getNetwork */
     export interface GetNetworkResponse {
         friendbotUrl?: string;
         passphrase: string;
         protocolVersion: string;
     }
-    /** @see https://soroban.stellar.org/api/methods/getLatestLedger */
+    /** @see https://developers.stellar.org/docs/data/rpc/api-reference/methods/getLatestLedger */
     export interface GetLatestLedgerResponse {
         id: string;
         sequence: number;
@@ -53,7 +52,7 @@ export declare namespace Api {
         NOT_FOUND = "NOT_FOUND",
         FAILED = "FAILED"
     }
-    /** @see https://soroban.stellar.org/api/methods/getTransaction */
+    /** @see https://developers.stellar.org/docs/data/rpc/api-reference/methods/getTransaction */
     export type GetTransactionResponse = GetSuccessfulTransactionResponse | GetFailedTransactionResponse | GetMissingTransactionResponse;
     interface GetAnyTransactionResponse {
         status: GetTransactionStatus;
@@ -74,6 +73,7 @@ export declare namespace Api {
         envelopeXdr: xdr.TransactionEnvelope;
         resultXdr: xdr.TransactionResult;
         resultMetaXdr: xdr.TransactionMeta;
+        diagnosticEventsXdr?: xdr.DiagnosticEvent[];
     }
     export interface GetSuccessfulTransactionResponse extends GetAnyTransactionResponse {
         status: GetTransactionStatus.SUCCESS;
@@ -84,6 +84,7 @@ export declare namespace Api {
         envelopeXdr: xdr.TransactionEnvelope;
         resultXdr: xdr.TransactionResult;
         resultMetaXdr: xdr.TransactionMeta;
+        diagnosticEventsXdr?: xdr.DiagnosticEvent[];
         returnValue?: xdr.ScVal;
     }
     export interface RawGetTransactionResponse {
@@ -99,6 +100,51 @@ export declare namespace Api {
         resultMetaXdr?: string;
         ledger?: number;
         createdAt?: number;
+        diagnosticEventsXdr?: string[];
+    }
+    export interface GetTransactionsRequest {
+        startLedger: number;
+        cursor?: string;
+        limit?: number;
+    }
+    export interface RawTransactionInfo {
+        status: GetTransactionStatus;
+        ledger: number;
+        createdAt: number;
+        applicationOrder: number;
+        feeBump: boolean;
+        envelopeXdr?: string;
+        resultXdr?: string;
+        resultMetaXdr?: string;
+        diagnosticEventsXdr?: string[];
+    }
+    export interface TransactionInfo {
+        status: GetTransactionStatus;
+        ledger: number;
+        createdAt: number;
+        applicationOrder: number;
+        feeBump: boolean;
+        envelopeXdr: xdr.TransactionEnvelope;
+        resultXdr: xdr.TransactionResult;
+        resultMetaXdr: xdr.TransactionMeta;
+        returnValue?: xdr.ScVal;
+        diagnosticEventsXdr?: xdr.DiagnosticEvent[];
+    }
+    export interface GetTransactionsResponse {
+        transactions: TransactionInfo[];
+        latestLedger: number;
+        latestLedgerCloseTimestamp: number;
+        oldestLedger: number;
+        oldestLedgerCloseTimestamp: number;
+        cursor: string;
+    }
+    export interface RawGetTransactionsResponse {
+        transactions: RawTransactionInfo[];
+        latestLedger: number;
+        latestLedgerCloseTimestamp: number;
+        oldestLedger: number;
+        oldestLedgerCloseTimestamp: number;
+        cursor: string;
     }
     export type EventType = 'contract' | 'system' | 'diagnostic';
     export interface EventFilter {
@@ -188,7 +234,7 @@ export declare namespace Api {
      *     fields
      *   - for all other errors, this only includes error fields
      *
-     * @see https://soroban.stellar.org/api/methods/simulateTransaction#returns
+     * @see https://developers.stellar.org/docs/data/rpc/api-reference/methods/simulateTransaction
      */
     export type SimulateTransactionResponse = SimulateTransactionSuccessResponse | SimulateTransactionRestoreResponse | SimulateTransactionErrorResponse;
     export interface BaseSimulateTransactionResponse {
@@ -243,7 +289,7 @@ export declare namespace Api {
         auth?: string[];
         xdr: string;
     }
-    /** @see https://soroban.stellar.org/api/methods/simulateTransaction#returns */
+    /** @see https://developers.stellar.org/docs/data/rpc/api-reference/methods/simulateTransaction */
     export interface RawSimulateTransactionResponse {
         id: string;
         latestLedger: number;
@@ -264,9 +310,16 @@ export declare namespace Api {
             minResourceFee: string;
             transactionData: string;
         };
-        /** State Difference information */
+        /** State difference information */
         stateChanges?: RawLedgerEntryChange[];
     }
+    export interface GetVersionInfoResponse {
+        version: string;
+        commit_hash: string;
+        build_time_stamp: string;
+        captive_core_version: string;
+        protocol_version: number;
+    }
     export interface GetFeeStatsResponse {
         sorobanInclusionFee: FeeDistribution;
         inclusionFee: FeeDistribution;
@@ -290,5 +343,17 @@ export declare namespace Api {
         transactionCount: string;
         ledgerCount: number;
     }
+    export interface BalanceResponse {
+        latestLedger: number;
+        /** present only on success, otherwise request malformed or no balance */
+        balanceEntry?: {
+            /** a 64-bit integer */
+            amount: string;
+            authorized: boolean;
+            clawback: boolean;
+            lastModifiedLedgerSeq?: number;
+            liveUntilLedgerSeq?: number;
+        };
+    }
     export {};
 }

package/lib/rpc/axios.d.ts

@@ -1,3 +1,4 @@
-export declare const version: any;
-export declare const AxiosClient: import("axios").AxiosInstance;
+import { HttpClient } from "../http-client";
+export declare const version: string;
+export declare const AxiosClient: HttpClient;
 export default AxiosClient;

package/lib/rpc/axios.js

@@ -4,10 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.version = exports.default = exports.AxiosClient = void 0;
-var _axios = _interopRequireDefault(require("axios"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-var version = exports.version = require('../../package.json').version;
-var AxiosClient = exports.AxiosClient = _axios.default.create({
+var _httpClient = require("../http-client");
+var version = exports.version = "13.0.0-beta.1";
+var AxiosClient = exports.AxiosClient = (0, _httpClient.create)({
   headers: {
     'X-Client-Name': 'js-soroban-client',
     'X-Client-Version': version

package/lib/rpc/browser.d.ts

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

package/lib/rpc/browser.js

@@ -5,18 +5,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 var _exportNames = {
-  axios: true,
   StellarBase: true
 };
-exports.StellarBase = void 0;
-Object.defineProperty(exports, "axios", {
-  enumerable: true,
-  get: function get() {
-    return _axios.default;
-  }
-});
-exports.default = void 0;
-var _axios = _interopRequireDefault(require("axios"));
+exports.default = exports.StellarBase = void 0;
 var _index = require("./index");
 Object.keys(_index).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
@@ -33,5 +24,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/rpc/index.d.ts

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

package/lib/rpc/index.js

@@ -25,7 +25,7 @@ Object.defineProperty(exports, "Durability", {
 Object.defineProperty(exports, "Server", {
   enumerable: true,
   get: function get() {
-    return _server.Server;
+    return _server.RpcServer;
   }
 });
 exports.default = void 0;

package/lib/rpc/jsonrpc.d.ts

@@ -23,5 +23,13 @@ export interface Error<E = any> {
     message?: string;
     data?: E;
 }
-/** Sends the jsonrpc 'params' as a single 'param' object (no array support). */
+/**
+ * Sends the jsonrpc 'params' as a single 'param' object (no array support).
+ *
+ * @param {string} url URL to the RPC instance
+ * @param {string} method RPC method name that should be called
+ * @param {(any | null)} [param=null] params that should be supplied to the method
+ * @returns {Promise<T>}
+ * @private
+ */
 export declare function postObject<T>(url: string, method: string, param?: any): Promise<T>;

package/lib/rpc/parsers.d.ts

@@ -1,17 +1,39 @@
 import { Api } from './api';
-export declare function parseRawSendTransaction(r: Api.RawSendTransactionResponse): Api.SendTransactionResponse;
-export declare function parseRawEvents(r: Api.RawGetEventsResponse): Api.GetEventsResponse;
-export declare function parseRawLedgerEntries(raw: Api.RawGetLedgerEntriesResponse): Api.GetLedgerEntriesResponse;
 /**
- * Converts a raw response schema into one with parsed XDR fields and a
- * simplified interface.
- * Warning: This API is only exported for testing purposes and should not be
- *          relied on or considered "stable".
+ * Parse the response from invoking the `submitTransaction` method of a Soroban RPC server.
+ * @memberof module:rpc
+ * @private
  *
- * @param {Api.SimulateTransactionResponse|Api.RawSimulateTransactionResponse} sim the raw response schema (parsed ones are allowed, best-effort
- *    detected, and returned untouched)
+ * @param {Api.RawSendTransactionResponse} raw the raw `submitTransaction` response from the Soroban RPC server to parse
+ * @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 parseRawTransactions(r: Api.RawTransactionInfo): Api.TransactionInfo;
+/**
+ * Parse and return the retrieved events, if any, from a raw response from a Soroban RPC server.
+ * @memberof module:rpc
  *
- * @returns the original parameter (if already parsed), parsed otherwise
+ * @param {Api.RawGetEventsResponse} raw the raw `getEvents` response from the Soroban RPC server to parse
+ * @returns {Api.GetEventsResponse} events parsed from the Soroban RPC server's response
+ */
+export declare function parseRawEvents(raw: Api.RawGetEventsResponse): Api.GetEventsResponse;
+/**
+ * Parse and return the retrieved ledger entries, if any, from a raw response from a Soroban RPC server.
+ * @memberof module:rpc
+ * @private
  *
+ * @param {Api.RawGetLedgerEntriesResponse} raw he raw `getLedgerEntries` response from the Soroban RPC server to parse
+ * @returns {Api.GetLedgerEntriesResponse} ledger entries parsed from the Soroban RPC server's response
+ */
+export declare function parseRawLedgerEntries(raw: Api.RawGetLedgerEntriesResponse): Api.GetLedgerEntriesResponse;
+/**
+ * Converts a raw response schema into one with parsed XDR fields and a simplified interface.
+ * @warning This API is only exported for testing purposes and should not be relied on or considered "stable".
+ * @memberof module:rpc
+ *
+ * @param {Api.SimulateTransactionResponse | Api.RawSimulateTransactionResponse} sim the raw response schema (parsed ones are allowed, best-effort
+ *    detected, and returned untouched)
+ * @returns {Api.SimulateTransactionResponse} the original parameter (if already parsed), parsed otherwise
  */
 export declare function parseRawSimulation(sim: Api.SimulateTransactionResponse | Api.RawSimulateTransactionResponse): Api.SimulateTransactionResponse;

package/lib/rpc/parsers.js

@@ -7,6 +7,8 @@ exports.parseRawEvents = parseRawEvents;
 exports.parseRawLedgerEntries = parseRawLedgerEntries;
 exports.parseRawSendTransaction = parseRawSendTransaction;
 exports.parseRawSimulation = parseRawSimulation;
+exports.parseRawTransactions = parseRawTransactions;
+exports.parseTransactionInfo = parseTransactionInfo;
 var _stellarBase = require("@stellar/stellar-base");
 var _api = require("./api");
 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); }
@@ -15,13 +17,13 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
-function parseRawSendTransaction(r) {
-  var errorResultXdr = r.errorResultXdr,
-    diagnosticEventsXdr = r.diagnosticEventsXdr;
-  delete r.errorResultXdr;
-  delete r.diagnosticEventsXdr;
+function parseRawSendTransaction(raw) {
+  var errorResultXdr = raw.errorResultXdr,
+    diagnosticEventsXdr = raw.diagnosticEventsXdr;
+  delete raw.errorResultXdr;
+  delete raw.diagnosticEventsXdr;
   if (errorResultXdr) {
-    return _objectSpread(_objectSpread(_objectSpread({}, r), diagnosticEventsXdr !== undefined && diagnosticEventsXdr.length > 0 && {
+    return _objectSpread(_objectSpread(_objectSpread({}, raw), diagnosticEventsXdr !== undefined && diagnosticEventsXdr.length > 0 && {
       diagnosticEvents: diagnosticEventsXdr.map(function (evt) {
         return _stellarBase.xdr.DiagnosticEvent.fromXDR(evt, 'base64');
       })
@@ -29,13 +31,40 @@ function parseRawSendTransaction(r) {
       errorResult: _stellarBase.xdr.TransactionResult.fromXDR(errorResultXdr, 'base64')
     });
   }
-  return _objectSpread({}, r);
+  return _objectSpread({}, raw);
 }
-function parseRawEvents(r) {
-  var _r$events;
+function parseTransactionInfo(raw) {
+  var meta = _stellarBase.xdr.TransactionMeta.fromXDR(raw.resultMetaXdr, 'base64');
+  var info = {
+    ledger: raw.ledger,
+    createdAt: raw.createdAt,
+    applicationOrder: raw.applicationOrder,
+    feeBump: raw.feeBump,
+    envelopeXdr: _stellarBase.xdr.TransactionEnvelope.fromXDR(raw.envelopeXdr, 'base64'),
+    resultXdr: _stellarBase.xdr.TransactionResult.fromXDR(raw.resultXdr, 'base64'),
+    resultMetaXdr: meta
+  };
+  if (meta.switch() === 3 && meta.v3().sorobanMeta() !== null) {
+    var _meta$v3$sorobanMeta;
+    info.returnValue = (_meta$v3$sorobanMeta = meta.v3().sorobanMeta()) === null || _meta$v3$sorobanMeta === void 0 ? void 0 : _meta$v3$sorobanMeta.returnValue();
+  }
+  if ('diagnosticEventsXdr' in raw && raw.diagnosticEventsXdr) {
+    info.diagnosticEventsXdr = raw.diagnosticEventsXdr.map(function (diagnosticEvent) {
+      return _stellarBase.xdr.DiagnosticEvent.fromXDR(diagnosticEvent, 'base64');
+    });
+  }
+  return info;
+}
+function parseRawTransactions(r) {
+  return _objectSpread({
+    status: r.status
+  }, parseTransactionInfo(r));
+}
+function parseRawEvents(raw) {
+  var _raw$events;
   return {
-    latestLedger: r.latestLedger,
-    events: ((_r$events = r.events) !== null && _r$events !== void 0 ? _r$events : []).map(function (evt) {
+    latestLedger: raw.latestLedger,
+    events: ((_raw$events = raw.events) !== null && _raw$events !== void 0 ? _raw$events : []).map(function (evt) {
       var clone = _objectSpread({}, evt);
       delete clone.contractId;
       return _objectSpread(_objectSpread(_objectSpread({}, clone), evt.contractId !== '' && {