Merge the Soroban RPC client into this library

.github/workflows/tests.yml

@@ -13,7 +13,7 @@ jobs:
       fail-fast: false
       max-parallel: 4
       matrix:
-        node-version: [16, 18, 20]
+        node-version: [16, 18]
 
     steps:
       - name: Checkout

CHANGELOG.md

@@ -103,7 +103,7 @@ This version is marked by a major version bump because of the significant upgrad
 
 ### Add
 
-- Add [SEP-1](https://stellar.org/protocol/sep-1) fields to `StellarTomlResolver` for type checks ([#794](https://github.com/stellar/js-stellar-sdk/pull/794)).
+- Add [SEP-1](https://stellar.org/protocol/sep-1) fields to `TomlResolver` for type checks ([#794](https://github.com/stellar/js-stellar-sdk/pull/794)).
 - Add support for passing `X-Auth-Token` as a custom header ([#795](https://github.com/stellar/js-stellar-sdk/pull/795)).
 
 ### Update
@@ -1142,7 +1142,7 @@ Many thanks to @Ffloriel and @Akuukis for their help with this release!
 
 ## 0.8.2
 
-- Added `timeout` option to `StellarTomlResolver` and `FederationServer` calls
+- Added `timeout` option to `TomlResolver` and `FederationServer` calls
   (https://github.com/stellar/js-stellar-sdk/issues/158).
 - Fixed adding random value to URLs multiple times
   (https://github.com/stellar/js-stellar-sdk/issues/169).
@@ -1210,7 +1210,7 @@ Many thanks to @Ffloriel and @Akuukis for their help with this release!
 - **Breaking change** Upgraded `stellar-base` to `0.6.0`. `ed25519` package is
   now an optional dependency. Check `StellarSdk.FastSigning` variable to check
   if `ed25519` package is available. More in README file.
-- New `StellarTomlResolver` class that allows getting `stellar.toml` file for a
+- New `TomlResolver` class that allows getting `stellar.toml` file for a
   domain.
 - New `Config` class to set global config values.
 

package.json

@@ -28,21 +28,22 @@
     "build:prod": "cross-env NODE_ENV=production yarn _build",
     "build:node": "yarn _babel && yarn build:ts",
     "build:ts": "tsc -p ./config/tsconfig.json",
+    "build:test": "tsc -p ./test/tsconfig.json",
     "build:browser": "webpack -c config/webpack.config.browser.js",
     "build:docs": "cross-env NODE_ENV=docs yarn _babel",
     "clean": "rm -rf lib/ dist/ coverage/ .nyc_output/ jsdoc/",
     "docs": "yarn build:docs && jsdoc -c ./config/.jsdoc.json --verbose",
-    "test": "yarn test:node && yarn test:integration && yarn test:browser",
+    "test": "yarn build:test && yarn test:node && yarn test:integration && yarn test:browser",
     "test:node": "yarn _nyc mocha --recursive 'test/unit/**/*.js'",
     "test:integration": "yarn _nyc mocha --recursive 'test/integration/**/*.js'",
     "test:browser": "karma start config/karma.conf.js",
     "fmt": "yarn eslint -c .eslintrc.js src/ --fix && yarn _prettier",
     "preversion": "yarn clean && yarn fmt && yarn build:prod && yarn test",
     "prepare": "yarn build:prod",
-    "_build": "yarn build:node && yarn build:browser",
+    "_build": "yarn build:node && yarn build:test && yarn build:browser",
     "_babel": "babel --extensions '.ts' --out-dir lib/ src/",
     "_nyc": "nyc --nycrc-path config/.nycrc",
-    "_prettier": "prettier --ignore-path config/.prettierignore --write './**/*.js'"
+    "_prettier": "prettier --ignore-path config/.prettierignore --write './test/**/*.js'"
   },
   "husky": {
     "hooks": {
@@ -51,8 +52,7 @@
   },
   "lint-staged": {
     "**/*.{js,json,ts}": [
-      "yarn fmt",
-      "yarn lint"
+      "yarn fmt"
     ]
   },
   "mocha": {
@@ -66,7 +66,7 @@
     ],
     "sort": true,
     "recursive": true,
-    "timeout": 60000
+    "timeout": 30000
   },
   "nyc": {
     "instrument": false,
@@ -86,11 +86,14 @@
     "@definitelytyped/dtslint": "^0.0.182",
     "@istanbuljs/nyc-config-babel": "3.0.0",
     "@stellar/tsconfig": "^1.0.2",
+    "@types/chai": "^4.3.6",
     "@types/detect-node": "^2.0.0",
     "@types/eventsource": "^1.1.12",
     "@types/lodash": "^4.14.199",
+    "@types/mocha": "^10.0.2",
     "@types/node": "^20.8.2",
     "@types/randombytes": "^2.0.1",
+    "@types/sinon": "^10.0.19",
     "@types/urijs": "^1.19.20",
     "@typescript-eslint/parser": "^6.7.4",
     "axios-mock-adapter": "^1.22.0",
@@ -143,7 +146,7 @@
     "bignumber.js": "^9.1.2",
     "eventsource": "^2.0.2",
     "randombytes": "^2.1.0",
-    "stellar-base": "10.0.0-beta.2",
+    "stellar-base": "10.0.0-beta.3",
     "toml": "^3.0.0",
     "urijs": "^1.19.1"
   }

src/errors.ts

@@ -1,11 +1,11 @@
-import { Horizon } from "./horizon_api";
+import { HorizonApi } from "./horizon/horizon_api";
 
 // For ES5 compatibility (https://stackoverflow.com/a/55066280).
 /* tslint:disable:variable-name max-classes-per-file */
 
 export class NetworkError extends Error {
   public response: {
-    data?: Horizon.ErrorResponseData;
+    data?: HorizonApi.ErrorResponseData;
     status?: number;
     statusText?: string;
     url?: string;

src/federation_server.ts → src/federation/federation_server.ts

@@ -2,9 +2,9 @@ import axios from "axios";
 import { StrKey } from "stellar-base";
 import URI from "urijs";
 
-import { Config } from "./config";
-import { BadResponseError } from "./errors";
-import { StellarTomlResolver } from "./stellar_toml_resolver";
+import { Config } from "../config";
+import { BadResponseError } from "../errors";
+import { TomlResolver } from "./stellar_toml_resolver";
 
 // FEDERATION_RESPONSE_MAX_SIZE is the maximum size of response from a federation server
 export const FEDERATION_RESPONSE_MAX_SIZE = 100 * 1024;
@@ -129,7 +129,7 @@ export class FederationServer {
     domain: string,
     opts: FederationServer.Options = {},
   ): Promise<FederationServer> {
-    const tomlObject = await StellarTomlResolver.resolve(domain, opts);
+    const tomlObject = await TomlResolver.resolve(domain, opts);
     if (!tomlObject.FEDERATION_SERVER) {
       return Promise.reject(
         new Error("stellar.toml does not contain FEDERATION_SERVER field"),

src/federation/index.ts

@@ -0,0 +1,9 @@
+export {
+  FederationServer as Server,
+  FEDERATION_RESPONSE_MAX_SIZE
+} from './federation_server';
+
+export {
+  TomlResolver,
+  STELLAR_TOML_MAX_SIZE
+} from './stellar_toml_resolver';

src/stellar_toml_resolver.ts → src/federation/stellar_toml_resolver.ts

@@ -1,23 +1,22 @@
 import axios from "axios";
-import { Networks } from "stellar-base";
 import toml from "toml";
-import { Config } from "./config";
+import { Networks } from "stellar-base";
+
+import { Config } from "../config";
 
-// STELLAR_TOML_MAX_SIZE is the maximum size of stellar.toml file
+/** the maximum size of stellar.toml file */
 export const STELLAR_TOML_MAX_SIZE = 100 * 1024;
 
 // axios timeout doesn't catch missing urls, e.g. those with no response
 // so we use the axios cancel token to ensure the timeout
 const CancelToken = axios.CancelToken;
 
-/**
- * StellarTomlResolver allows resolving `stellar.toml` files.
- */
-export class StellarTomlResolver {
+/** TomlResolver allows resolving `stellar.toml` files. */
+export class TomlResolver {
   /**
    * Returns a parsed `stellar.toml` file for a given domain.
    * ```js
-   * StellarSdk.StellarTomlResolver.resolve('acme.com')
+   * StellarSdk.TomlResolver.resolve('acme.com')
    *   .then(stellarToml => {
    *     // stellarToml in an object representing domain stellar.toml file.
    *   })
@@ -34,8 +33,8 @@ export class StellarTomlResolver {
    */
   public static async resolve(
     domain: string,
-    opts: StellarTomlResolver.StellarTomlResolveOptions = {},
-  ): Promise<StellarTomlResolver.StellarToml> {
+    opts: TomlResolver.StellarTomlResolveOptions = {},
+  ): Promise<TomlResolver.StellarToml> {
     const allowHttp =
       typeof opts.allowHttp === "undefined"
         ? Config.isAllowHttp()
@@ -84,7 +83,7 @@ export class StellarTomlResolver {
 }
 
 /* tslint:disable-next-line: no-namespace */
-export namespace StellarTomlResolver {
+export namespace TomlResolver {
   export interface StellarTomlResolveOptions {
     allowHttp?: boolean;
     timeout?: number;

src/friendbot/index.ts

@@ -0,0 +1,6 @@
+export namespace Api {
+  // Just the fields we are interested in
+  export interface Response {
+    result_meta_xdr: string;
+  }
+}

src/account_call_builder.ts → src/horizon/account_call_builder.ts

@@ -78,4 +78,4 @@ export class AccountCallBuilder extends CallBuilder<
     this.url.setQuery("liquidity_pool", id);
     return this;
   }
-}
+}

src/account_response.ts → src/horizon/account_response.ts

@@ -1,7 +1,7 @@
 /* tslint:disable:variable-name */
 
 import { Account as BaseAccount } from "stellar-base";
-import { Horizon } from "./horizon_api";
+import { HorizonApi } from "./horizon_api";
 import { ServerApi } from "./server_api";
 
 /**
@@ -27,9 +27,9 @@ export class AccountResponse {
   public readonly inflation_destination?: string;
   public readonly last_modified_ledger!: number;
   public readonly last_modified_time!: string;
-  public readonly thresholds!: Horizon.AccountThresholds;
-  public readonly flags!: Horizon.Flags;
-  public readonly balances!: Horizon.BalanceLine[];
+  public readonly thresholds!: HorizonApi.AccountThresholds;
+  public readonly flags!: HorizonApi.Flags;
+  public readonly balances!: HorizonApi.BalanceLine[];
   public readonly signers!: ServerApi.AccountRecordSigners[];
   public readonly data!: (options: {
     value: string;

src/call_builder.ts → src/horizon/call_builder.ts

@@ -1,13 +1,11 @@
 import URI from "urijs";
 import URITemplate from "urijs/src/URITemplate";
 
-import { BadRequestError, NetworkError, NotFoundError } from "./errors";
-import { Horizon } from "./horizon_api";
-import HorizonAxiosClient from "./horizon_axios_client";
-import { ServerApi } from "./server_api";
+import { BadRequestError, NetworkError, NotFoundError } from "../errors";
 
-/* tslint:disable-next-line:no-var-requires */
-const version = require("../package.json").version;
+import { HorizonApi } from "./horizon_api";
+import { AxiosClient, version } from "./horizon_axios_client";
+import { ServerApi } from "./server_api";
 
 // Resources which can be included in the Horizon response via the `join`
 // query-param.
@@ -35,9 +33,9 @@ let EventSource: Constructable<EventSource> = anyGlobal.EventSource ??
  */
 export class CallBuilder<
   T extends
-    | Horizon.FeeStatsResponse
-    | Horizon.BaseResponse
-    | ServerApi.CollectionPage<Horizon.BaseResponse>
+    | HorizonApi.FeeStatsResponse
+    | HorizonApi.BaseResponse
+    | ServerApi.CollectionPage<HorizonApi.BaseResponse>
 > {
   protected url: URI;
   public filter: string[][];
@@ -278,7 +276,7 @@ export class CallBuilder<
    * @param {bool} [link.templated] Whether the link is templated
    * @returns {function} A function that requests the link
    */
-  private _requestFnForLink(link: Horizon.ResponseLink): (opts?: any) => any {
+  private _requestFnForLink(link: HorizonApi.ResponseLink): (opts?: any) => any {
     return async (opts: any = {}) => {
       let uri;
 
@@ -327,7 +325,7 @@ export class CallBuilder<
         // are loading from the server or in-memory (via join).
         json[key] = async () => record;
       } else {
-        json[key] = this._requestFnForLink(n as Horizon.ResponseLink);
+        json[key] = this._requestFnForLink(n as HorizonApi.ResponseLink);
       }
     }
     return json;
@@ -344,7 +342,7 @@ export class CallBuilder<
       url = url.protocol(this.url.protocol());
     }
 
-    return HorizonAxiosClient.get(url.toString())
+    return AxiosClient.get(url.toString())
       .then((response) => response.data)
       .catch(this._handleNetworkError);
   }
@@ -404,4 +402,4 @@ export class CallBuilder<
       return Promise.reject(new Error(error.message));
     }
   }
-}
+}

src/horizon_api.ts → src/horizon/horizon_api.ts

@@ -1,7 +1,7 @@
 import { AssetType, MemoType } from "stellar-base";
 
 /* tslint:disable-next-line:no-namespace */
-export namespace Horizon {
+export namespace HorizonApi {
   export interface ResponseLink {
     href: string;
     templated?: boolean;

src/horizon_axios_client.ts → src/horizon/horizon_axios_client.ts

@@ -2,7 +2,7 @@ import axios, { AxiosResponse } from "axios";
 import URI from "urijs";
 
 /* tslint:disable-next-line:no-var-requires */
-const version = require("../package.json").version;
+export const version = require("../../package.json").version;
 
 export interface ServerTime {
   serverTime: number;
@@ -23,7 +23,7 @@ export interface ServerTime {
  */
 export const SERVER_TIME_MAP: Record<string, ServerTime> = {};
 
-const HorizonAxiosClient = axios.create({
+export const AxiosClient = axios.create({
   headers: {
     "X-Client-Name": "js-stellar-sdk",
     "X-Client-Version": version,
@@ -34,7 +34,7 @@ function _toSeconds(ms: number): number {
   return Math.floor(ms / 1000);
 }
 
-HorizonAxiosClient.interceptors.response.use(
+AxiosClient.interceptors.response.use(
   function interceptorHorizonResponse(response: AxiosResponse) {
     const hostname = URI(response.config.url!).hostname();
     const serverTime = _toSeconds(Date.parse(response.headers.date));
@@ -51,7 +51,7 @@ HorizonAxiosClient.interceptors.response.use(
   },
 );
 
-export default HorizonAxiosClient;
+export default AxiosClient;
 
 /**
  * Given a hostname, get the current time of that server (i.e., use the last-

src/horizon/index.ts

@@ -0,0 +1,15 @@
+// Expose all types
+export * from "./horizon_api";
+export * from "./server_api";
+
+// stellar-sdk classes to expose
+export * from "./account_response";
+
+export { Server } from "./server";
+export {
+  default as AxiosClient,
+  SERVER_TIME_MAP,
+  getCurrentServerTime
+} from "./horizon_axios_client";
+
+export default module.exports;