@stellar/typescript-wallet-sdk 1.0.0-alpha.2 → 1.0.0-beta.0

package/lib/walletSdk/anchor/index.d.ts

@@ -1,16 +1,72 @@
+import { AxiosInstance } from "axios";
+import { Config } from "walletSdk";
 import { Auth } from "../Auth";
-import { Interactive } from "../interactive";
-import { TomlInfo } from "../toml";
+import { Interactive } from "../Interactive";
+import { AnchorServiceInfo, AnchorTransaction, GetTransactionParams, GetTransactionsParams, TomlInfo } from "../Types";
+import { Watcher } from "../Watcher";
+type AnchorParams = {
+    cfg: Config;
+    homeDomain: string;
+    httpClient: AxiosInstance;
+    language: string;
+};
 export declare class Anchor {
+    language: string;
+    private cfg;
     private homeDomain;
     private httpClient;
-    private cfg;
-    constructor(cfg: any, homeDomain: string, httpClient: any);
-    getInfo(): Promise<TomlInfo>;
+    private toml;
+    constructor(params: AnchorParams);
+    getInfo(shouldRefresh?: boolean): Promise<TomlInfo>;
     auth(): Promise<Auth>;
     interactive(): Interactive;
-    getServicesInfo(): Promise<any>;
-    getTransaction(): void;
-    getTransactionForAsset(): void;
-    getHistory(): void;
+    watcher(): Watcher;
+    getServicesInfo(lang?: string): Promise<AnchorServiceInfo>;
+    /**
+     * Get single transaction's current status and details. One of the [id], [stellarTransactionId],
+     * [externalTransactionId] must be provided.
+     *
+     * @param authToken auth token of the account authenticated with the anchor
+     * @param id transaction ID
+     * @param stellarTransactionId stellar transaction ID
+     * @param externalTransactionId external transaction ID
+     * @return transaction object
+     * @throws [MissingTransactionIdError] if none of the id params is provided
+     * @throws [InvalidTransactionResponseError] if Anchor returns an invalid transaction
+     * @throws [ServerRequestFailedError] if server request fails
+     */
+    getTransactionBy({ authToken, id, stellarTransactionId, externalTransactionId, lang, }: GetTransactionParams): Promise<AnchorTransaction>;
+    /**
+     * Get account's transactions specified by asset and other params.
+     *
+     * @param authToken auth token of the account authenticated with the anchor
+     * @param assetCode target asset to query for
+     * @param noOlderThan response should contain transactions starting on or after this date & time
+     * @param limit response should contain at most 'limit' transactions
+     * @param kind kind of transaction that is desired. E.g.: 'deposit', 'withdrawal'
+     * @param pagingId response should contain transactions starting prior to this ID (exclusive)
+     * @param lang desired language (localization), it can also accept locale in the format 'en-US'
+     * @return list of transactions as requested by the client, sorted in time-descending order
+     * @throws [InvalidTransactionsResponseError] if Anchor returns an invalid response
+     * @throws [ServerRequestFailedError] if server request fails
+     */
+    getTransactionsForAsset({ authToken, assetCode, noOlderThan, limit, kind, pagingId, lang, }: GetTransactionsParams): Promise<AnchorTransaction[]>;
+    /**
+     * Get all successfully finished (either completed or refunded) account transactions for specified
+     * asset. Optional field implementation depends on anchor.
+     *
+     * @param authToken auth token of the account authenticated with the anchor
+     * @param assetCode target asset to query for
+     * @param noOlderThan response should contain transactions starting on or after this date & time
+     * @param limit response should contain at most 'limit' transactions
+     * @param kind kind of transaction that is desired. E.g.: 'deposit', 'withdrawal'
+     * @param pagingId response should contain transactions starting prior to this ID (exclusive)
+     * @param lang desired language (localization), it can also accept locale in the format 'en-US'
+     * @return list of filtered transactions that achieved a final state (completed or refunded)
+     * @throws [AssetNotSupportedError] if asset is not supported by the anchor
+     * @throws [InvalidTransactionsResponseError] if Anchor returns an invalid response
+     * @throws [ServerRequestFailedError] if server request fails
+     */
+    getHistory({ authToken, assetCode, noOlderThan, limit, kind, pagingId, lang, }: GetTransactionsParams): Promise<AnchorTransaction[]>;
 }
+export {};

package/lib/walletSdk/auth/WalletSigner.d.ts

@@ -1,3 +1,7 @@
+import { Transaction } from "stellar-sdk";
+import { SignWithClientAccountParams, SignWithDomainAccountParams } from "../Types";
 export interface WalletSigner {
+    signWithClientAccount({ transaction, accountKp }: SignWithClientAccountParams): Transaction;
+    signWithDomainAccount({ transactionXDR, networkPassphrase, accountKp }: SignWithDomainAccountParams): Transaction;
 }
 export declare const DefaultSigner: WalletSigner;

package/lib/walletSdk/auth/index.d.ts

@@ -1,9 +1,21 @@
-import { Keypair } from "stellar-sdk";
+import { AxiosInstance } from "axios";
+import { Config } from "walletSdk";
+import { AuthenticateParams, AuthToken } from "../Types";
+export { WalletSigner, DefaultSigner } from "./WalletSigner";
+type AuthParams = {
+    cfg: Config;
+    webAuthEndpoint: string;
+    homeDomain: string;
+    httpClient: AxiosInstance;
+};
 export declare class Auth {
+    private cfg;
     private webAuthEndpoint;
-    constructor(webAuthEndpoint: any);
-    authenticate(accountKp: Keypair, memoId?: string, clientDomain?: string): Promise<any>;
-    challenge(accountKp: Keypair, memoId?: string, clientDomain?: string): Promise<any>;
-    sign(accountKp: Keypair, challengeTx: any, network: any): any;
-    getToken(signedTx: any): Promise<any>;
+    private homeDomain;
+    private httpClient;
+    constructor(params: AuthParams);
+    authenticate({ accountKp, walletSigner, memoId, clientDomain, }: AuthenticateParams): Promise<AuthToken>;
+    private challenge;
+    private sign;
+    private getToken;
 }

package/lib/walletSdk/exception/index.d.ts

@@ -10,3 +10,12 @@ export declare class InvalidMemoError extends Error {
 export declare class ClientDomainWithMemoError extends Error {
     constructor();
 }
+export declare class MissingTransactionIdError extends Error {
+    constructor();
+}
+export declare class InvalidTransactionResponseError extends Error {
+    constructor(transactionResponse: any);
+}
+export declare class InvalidTransactionsResponseError extends Error {
+    constructor(transactionsResponse: any);
+}

package/lib/walletSdk/horizon/Account.d.ts

@@ -0,0 +1,18 @@
+import { Keypair, Transaction, FeeBumpTransaction } from "stellar-sdk";
+declare class AccountKeypair {
+    keypair: Keypair;
+    constructor(keypair: Keypair);
+    get publicKey(): string;
+    toString(): string;
+}
+export declare class PublicKeypair extends AccountKeypair {
+    constructor(keypair: Keypair);
+    static fromPublicKey: (publicKey: string) => PublicKeypair;
+}
+export declare class SigningKeypair extends AccountKeypair {
+    constructor(keypair: Keypair);
+    static fromSecret: (secretKey: string) => SigningKeypair;
+    get secretKey(): string;
+    sign(transaction: Transaction | FeeBumpTransaction): Transaction | FeeBumpTransaction;
+}
+export {};

package/lib/walletSdk/horizon/AccountService.d.ts

@@ -0,0 +1,8 @@
+import { Config } from "walletSdk";
+import { SigningKeypair } from "./Account";
+export declare class AccountService {
+    private server;
+    private network;
+    constructor(cfg: Config);
+    createKeypair(): SigningKeypair;
+}

package/lib/walletSdk/horizon/Stellar.d.ts

@@ -1,3 +1,7 @@
+import { Config } from "walletSdk";
+import { AccountService } from "./AccountService";
 export declare class Stellar {
-    constructor(cfg: any);
+    private cfg;
+    constructor(cfg: Config);
+    account(): AccountService;
 }

package/lib/walletSdk/horizon/index.d.ts

@@ -0,0 +1,3 @@
+export { PublicKeypair, SigningKeypair } from "./Account";
+export { AccountService } from "./AccountService";
+export { Stellar } from "./Stellar";

package/lib/walletSdk/index.d.ts

@@ -1,24 +1,25 @@
+import { AxiosInstance, AxiosRequestConfig } from "axios";
 import { Networks, Server } from "stellar-sdk";
 import { Anchor } from "./Anchor";
-import { WalletSigner } from "./Auth/WalletSigner";
-import { Stellar } from "./horizon/Stellar";
-import { Recovery } from "./recovery/Recovery";
-interface ClientConfigFn {
-}
-interface ClientConfig {
-}
-declare class HttpClient {
-}
+import { WalletSigner } from "./Auth";
+import { Stellar } from "./Horizon";
+import { Recovery } from "./Recovery";
+import { ConfigParams, StellarConfigurationParams, WalletAnchor, WalletParams, WalletRecovery } from "./Types";
 export declare class Wallet {
     private cfg;
-    private clients;
+    private language;
     static TestNet: () => Wallet;
     static MainNet: () => Wallet;
-    constructor(stellarConfiguration: StellarConfiguration, applicationConfiguration?: ApplicationConfiguration);
-    anchor(homeDomain: string, httpClientConfig?: ClientConfigFn): Anchor;
+    constructor({ stellarConfiguration, applicationConfiguration, language }: WalletParams);
+    anchor({ homeDomain, httpClientConfig, language }: WalletAnchor): Anchor;
     stellar(): Stellar;
-    recover(servers: any, httpClientConfig: any): Recovery;
-    getClient(httpClientConfig?: any): any;
+    recovery({ servers, httpClientConfig }: WalletRecovery): Recovery;
+    getClient(httpClientConfig?: AxiosRequestConfig): AxiosInstance;
+}
+export declare class Config {
+    stellar: StellarConfiguration;
+    app: ApplicationConfiguration;
+    constructor({ stellarConfiguration, applicationConfiguration }: ConfigParams);
 }
 export declare class StellarConfiguration {
     server: Server;
@@ -27,11 +28,10 @@ export declare class StellarConfiguration {
     baseFee: number;
     static TestNet: () => StellarConfiguration;
     static MainNet: () => StellarConfiguration;
-    constructor(network: any, horizonUrl: any, baseFee?: number);
+    constructor({ network, horizonUrl, baseFee }: StellarConfigurationParams);
 }
 export declare class ApplicationConfiguration {
     defaultSigner: WalletSigner;
-    defaultClient: HttpClient;
-    constructor(defaultSigner?: WalletSigner, defaultCliengConfig?: ClientConfig);
+    defaultClient: AxiosInstance;
+    constructor(defaultSigner?: WalletSigner);
 }
-export {};

package/lib/walletSdk/interactive/index.d.ts

@@ -1,16 +1,16 @@
-type ExtraFields = {
-    [key: string]: string;
+import { AxiosInstance } from "axios";
+import { Anchor } from "../Anchor";
+import { InteractivePostParams, InteractivePostResponse } from "../Types";
+type InteractiveParams = {
+    anchor: Anchor;
+    httpClient: AxiosInstance;
 };
-export declare enum FLOW_TYPE {
-    DEPOSIT = "deposit",
-    WITHDRAW = "withdraw"
-}
 export declare class Interactive {
-    private homeDomain;
     private anchor;
-    constructor(homeDomain: any, anchor: any);
-    deposit(accountAddress: string, assetCode: string, authToken: string, extraFields?: ExtraFields, fundsAccountAddress?: string): Promise<any>;
-    withdraw(accountAddress: string, assetCode: string, authToken: string, extraFields?: ExtraFields, fundsAccountAddress?: string): Promise<any>;
-    flow(accountAddress: string, assetCode: string, authToken: string, type: string, extraFields?: ExtraFields, fundsAccountAddress?: string): Promise<any>;
+    private httpClient;
+    constructor(params: InteractiveParams);
+    deposit({ accountAddress, assetCode, authToken, lang, extraFields, fundsAccountAddress, }: InteractivePostParams): Promise<InteractivePostResponse>;
+    withdraw({ accountAddress, assetCode, authToken, lang, extraFields, fundsAccountAddress, }: InteractivePostParams): Promise<InteractivePostResponse>;
+    private flow;
 }
 export {};

package/lib/walletSdk/recovery/index.d.ts

@@ -0,0 +1,18 @@
+import { AxiosInstance } from "axios";
+import { Server } from "stellar-sdk";
+import { Config } from "walletSdk";
+import { Stellar } from "../Horizon";
+type RecoveryParams = {
+    cfg: Config;
+    stellar: Stellar;
+    httpClient: AxiosInstance;
+    servers: Server[];
+};
+export declare class Recovery {
+    private cfg;
+    private stellar;
+    private httpClient;
+    private servers;
+    constructor(params: RecoveryParams);
+}
+export {};

package/lib/walletSdk/util/camelToSnakeCase.d.ts

@@ -0,0 +1,2 @@
+export declare const camelToSnakeCaseKey: (key: string) => string;
+export declare const camelToSnakeCaseObject: (obj: any) => {};

package/lib/walletSdk/util/sleep.d.ts

@@ -0,0 +1 @@
+export declare function sleep(delay: number): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stellar/typescript-wallet-sdk",
-  "version": "1.0.0-alpha.2",
+  "version": "1.0.0-beta.0",
   "engines": {
     "node": ">=18"
   },
@@ -14,23 +14,29 @@
     "@stellar/prettier-config": "^1.0.1",
     "@stellar/tsconfig": "^1.0.2",
     "@types/jest": "^29.4.0",
+    "@types/lodash": "^4.14.194",
+    "@types/sinon": "^10.0.15",
     "babel-jest": "^29.4.1",
     "eslint": "^8.33.0",
     "jest": "^29.4.1",
+    "sinon": "^15.1.0",
     "ts-jest": "^29.0.5",
+    "ts-loader": "^9.4.2",
     "tslib": "^2.5.0",
-    "typescript": "^5.0.4"
+    "typescript": "^5.0.4",
+    "webpack": "^5.83.1",
+    "webpack-cli": "^5.1.1"
   },
   "dependencies": {
-    "axios": "^1.3.2",
+    "axios": "^1.4.0",
     "https-browserify": "^1.0.0",
+    "lodash": "^4.17.21",
+    "query-string": "^7.1.3",
     "stellar-sdk": "^10.4.1",
     "stream-http": "^3.2.0",
-    "ts-loader": "^9.4.2",
     "url": "^0.11.0",
     "util": "^0.12.5",
-    "webpack": "^5.83.1",
-    "webpack-cli": "^5.1.1"
+    "utility-types": "^3.10.0"
   },
   "scripts": {
     "prepare": "yarn build",

package/src/index.ts

@@ -1,6 +1,44 @@
+/**
+ * Types
+ */
+import * as Types from "./walletSdk/Types";
+export { Types };
+
+/**
+ * Classes
+ */
+export { 
+  Wallet, 
+  Config, 
+  StellarConfiguration, 
+  ApplicationConfiguration 
+} from "./walletSdk";
+export { Anchor } from "./walletSdk/Anchor";
+export { Auth, WalletSigner, DefaultSigner } from "./walletSdk/Auth";
+export { 
+  PublicKeypair, 
+  SigningKeypair, 
+  AccountService, 
+  Stellar 
+} from "./walletSdk/Horizon";
+export { Interactive } from "./walletSdk/Interactive";
+export { Recovery } from "./walletSdk/Recovery";
+export { Watcher } from "./walletSdk/Watcher";
+
+/**
+ * Utils
+ */
+import * as Utils from "./walletSdk/Utils";
+export { Utils };
+
+/**
+ * Exceptions
+ */
+import * as Exceptions from "./walletSdk/Exceptions";
+export { Exceptions };
+
 import * as walletSdk from "./walletSdk";
 import { Keypair } from "stellar-sdk";
-
 // TODO - figure out why Keypair used in parent codebase throws error
 export { walletSdk, Keypair };
 export default { walletSdk };