@stellar/typescript-wallet-sdk 1.2.0 → 1.3.0

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

@@ -1,5 +1,6 @@
 import { MemoType } from "stellar-sdk";
 import { Optional } from "utility-types";
+import { AuthToken } from "./auth";
 export interface AnchorServiceInfo {
     deposit: AssetInfoMap;
     withdraw: AssetInfoMap;
@@ -37,6 +38,7 @@ export interface ProcessingAnchorTransaction extends BaseTransaction {
     amount_out_asset?: string;
     amount_out: string;
     amount_fee_asset?: string;
+    quote_id?: string;
     amount_fee: string;
     completed_at?: string;
     stellar_transaction_id?: string;
@@ -57,6 +59,19 @@ export interface WithdrawTransaction extends ProcessingAnchorTransaction {
     withdraw_memo_type: MemoType;
     withdraw_anchor_account: string;
 }
+export type Sep6Transaction = DepositTransaction & WithdrawTransaction & {
+    from?: string;
+    external_extra?: string;
+    external_extra_text?: string;
+    required_info_message?: string;
+    required_info_updates?: any;
+    required_customer_info_message?: string;
+    required_customer_info_updates?: any;
+    instructions?: {
+        value: string;
+        description: string;
+    };
+};
 export interface ErrorTransaction extends Optional<DepositTransaction & WithdrawTransaction> {
 }
 export type AnchorTransaction = DepositTransaction | WithdrawTransaction | ErrorTransaction;
@@ -72,14 +87,14 @@ export interface Payment {
     fee: string;
 }
 export type GetTransactionParams = {
-    authToken: string;
+    authToken: AuthToken;
     id?: string;
     stellarTransactionId?: string;
     externalTransactionId?: string;
     lang?: string;
 };
 export type GetTransactionsParams = {
-    authToken: string;
+    authToken: AuthToken;
     assetCode: string;
     noOlderThan?: string;
     limit?: number;

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

@@ -7,7 +7,17 @@ export type AuthenticateParams = {
     memoId?: string;
     clientDomain?: string;
 };
-export type AuthToken = string;
+export declare class AuthToken {
+    token: string;
+    issuer: string;
+    issuedAt: string;
+    expiresAt: string;
+    clientDomain: string;
+    private principalAccount;
+    get account(): string;
+    get memo(): string;
+    static from: (str: string) => AuthToken;
+}
 export type ChallengeParams = {
     accountKp: AccountKeypair;
     memoId?: string;
@@ -33,3 +43,6 @@ export type SignWithDomainAccountParams = {
     networkPassphrase: NetworkPassphrase;
     accountKp: AccountKeypair;
 };
+export type HttpHeaders = {
+    [key: string]: string;
+};

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

@@ -1,15 +1,16 @@
-import { Memo, Server, Transaction } from "stellar-sdk";
+import { Memo, Horizon, Transaction } from "stellar-sdk";
 import { AccountKeypair } from "../Horizon/Account";
-import { TransactionBuilder } from "../Horizon/Transaction/TransactionBuilder";
+import { SponsoringBuilder, TransactionBuilder } from "walletSdk/Horizon";
+import { StellarAssetId } from "../Asset";
 export declare enum NETWORK_URLS {
     PUBLIC = "https://horizon.stellar.org",
     TESTNET = "https://horizon-testnet.stellar.org"
 }
 export type TransactionParams = {
     sourceAddress: AccountKeypair;
-    baseFee: number;
+    baseFee?: number;
     memo?: Memo;
-    timebounds?: Server.Timebounds | number;
+    timebounds?: Horizon.Server.Timebounds | number;
 };
 export type FeeBumpTransactionParams = {
     feeAddress: AccountKeypair;
@@ -20,8 +21,8 @@ export type SubmitWithFeeIncreaseParams = {
     sourceAddress: AccountKeypair;
     timeout: number;
     baseFeeIncrease: number;
-    buildingFunction: (TransactionBuilder: any) => TransactionBuilder;
-    signerFunction?: (Transaction: any) => Transaction;
+    buildingFunction: (builder: TransactionBuilder) => TransactionBuilder;
+    signerFunction?: (transaction: Transaction) => Transaction;
     baseFee?: number;
     memo?: Memo;
     maxFee?: number;
@@ -32,3 +33,13 @@ export declare enum HORIZON_ORDER {
     ASC = "asc",
     DESC = "desc"
 }
+export type PathPayParams = {
+    destinationAddress: string;
+    sendAsset: StellarAssetId;
+    destAsset: StellarAssetId;
+    sendAmount?: string;
+    destAmount?: string;
+    destMin?: string;
+    sendMax?: string;
+};
+export type CommonBuilder = TransactionBuilder | SponsoringBuilder;

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

@@ -1,5 +1,7 @@
-import { Server, Networks } from "stellar-sdk";
+import { RawAxiosRequestHeaders } from "axios";
+import { Networks } from "stellar-sdk";
 import { ApplicationConfiguration, StellarConfiguration } from "walletSdk";
+import { RecoveryServerMap } from "./recovery";
 export type WalletParams = {
     stellarConfiguration: StellarConfiguration;
     applicationConfiguration?: ApplicationConfiguration;
@@ -9,8 +11,8 @@ export type WalletAnchor = {
     homeDomain: string;
     language?: string;
 };
-export type WalletRecovery = {
-    servers: Server[];
+export type WalletRecoveryServers = {
+    servers: RecoveryServerMap;
 };
 export type ConfigParams = {
     stellarConfiguration: StellarConfiguration;
@@ -22,9 +24,19 @@ export type StellarConfigurationParams = {
     baseFee?: number;
     defaultTimeout?: number;
 };
+export type AxiosErrorData = {
+    status?: number;
+    statusText?: string;
+    responseData?: any;
+    headers?: RawAxiosRequestHeaders;
+};
 export * from "./anchor";
 export * from "./auth";
 export * from "./horizon";
+export * from "./recovery";
+export * from "./sep6";
+export * from "./sep12";
 export * from "./sep24";
+export * from "./sep38";
 export * from "./utils";
 export * from "./watcher";

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

@@ -0,0 +1,128 @@
+import { Transaction } from "stellar-sdk";
+import { WalletSigner } from "walletSdk/Auth";
+import { AccountKeypair, PublicKeypair } from "walletSdk/Horizon";
+import { AuthToken } from "./auth";
+import { CommonBuilder } from "./horizon";
+/**
+ * Configuration for recoverable wallet
+ * @param accountAddress Stellar address of the account that is registering
+ * @param deviceAddress Stellar address of the device that is added as a primary signer. It will
+ * replace the master key of [accountAddress]
+ * @param accountThreshold Low, medium, and high thresholds to set on the account
+ * @param accountIdentity A list of account identities to be registered with the recovery servers
+ * @param signerWeight Signer weight of the device and recovery keys to set
+ * @param sponsorAddress optional Stellar address of the account sponsoring this transaction
+ */
+export type RecoverableWalletConfig = {
+    accountAddress: AccountKeypair;
+    deviceAddress: AccountKeypair;
+    accountThreshold: AccountThreshold;
+    accountIdentity: RecoveryIdentityMap;
+    signerWeight: SignerWeight;
+    sponsorAddress?: AccountKeypair;
+    builderExtra?: (builder: CommonBuilder) => CommonBuilder;
+};
+export type RecoverableWallet = {
+    transaction: Transaction;
+    signers: string[];
+};
+export type AccountSigner = {
+    address: AccountKeypair;
+    weight: number;
+};
+/**
+ * Account weights threshold
+ * @param low Low threshold weight
+ * @param medium Medium threshold weight
+ * @param high High threshold weight
+ */
+export type AccountThreshold = {
+    low: number;
+    medium: number;
+    high: number;
+};
+export type SignerWeight = {
+    device: number;
+    recoveryServer: number;
+};
+/**
+ * Recovery server configuration
+ * @property {string} endpoint - Main endpoint (root domain) of SEP-30 recovery server. E.g. `https://testanchor.stellar.org`
+ * @property {string} authEndpoint - SEP-10 auth endpoint to be used. Should be in the format `<https://domain/auth>`. E.g. `https://testanchor.stellar.org/auth`
+ * @property {string} homeDomain - SEP-10 home domain. E.g. `testanchor.stellar.org`
+ * @property {WalletSigner} [walletSigner] - WalletSigner used to sign authentication
+ */
+export type RecoveryServer = {
+    endpoint: string;
+    authEndpoint: string;
+    homeDomain: string;
+    walletSigner?: WalletSigner;
+    clientDomain?: string;
+};
+export type RecoveryServerKey = string;
+export type RecoveryServerSigning = {
+    signerAddress: string;
+    authToken: AuthToken;
+};
+export type RecoveryServerSigningMap = {
+    [key: RecoveryServerKey]: RecoveryServerSigning;
+};
+export type RecoveryServerMap = {
+    [key: RecoveryServerKey]: RecoveryServer;
+};
+export type RecoveryAuthMap = {
+    [key: RecoveryServerKey]: AuthToken;
+};
+/**
+ * The role of the identity. This value is not used by the server and is stored and echoed back in
+ * responses as a way for a client to know conceptually who each identity represents
+ */
+export declare enum RecoveryRole {
+    OWNER = "owner",
+    SENDER = "sender",
+    RECEIVER = "receiver"
+}
+export declare enum RecoveryType {
+    STELLAR_ADDRESS = "stellar_address",
+    PHONE_NUMBER = "phone_number",
+    EMAIL = "email"
+}
+export type RecoveryAccountAuthMethod = {
+    type: RecoveryType;
+    value: string;
+};
+export type RecoveryAccountIdentity = {
+    role: RecoveryRole;
+    authMethods: RecoveryAccountAuthMethod[];
+};
+export type RecoveryIdentityMap = {
+    [key: RecoveryServerKey]: RecoveryAccountIdentity[];
+};
+export type RecoveryAccountRole = {
+    role: RecoveryRole;
+    authenticated?: boolean;
+};
+export type RecoveryAccountSigner = {
+    key: string;
+};
+export type RecoveryAccount = {
+    address: string;
+    identities: RecoveryAccountRole[];
+    signers: RecoveryAccountSigner[];
+};
+export type RecoverableIdentity = {
+    role: string;
+    authenticated?: boolean;
+};
+export type RecoverableSigner = {
+    key: PublicKeypair;
+    addedAt?: Date;
+};
+export type RecoverableAccountInfo = {
+    address: PublicKeypair;
+    identities: RecoverableIdentity[];
+    signers: RecoverableSigner[];
+};
+export type RecoveryAccountInfoMap = {
+    [key: RecoveryServerKey]: RecoverableAccountInfo;
+};

package/lib/walletSdk/Types/sep12.d.ts

@@ -0,0 +1,57 @@
+export type CustomerInfoMap = {
+    [key: string]: string;
+};
+export declare enum Sep12Status {
+    ACCEPTED = "ACCEPTED",
+    PROCESSING = "PROCESSING",
+    NEEDS_INFO = "NEEDS_INFO",
+    REJECTED = "REJECTED",
+    VERIFICATION_REQUIRED = "VERIFICATION_REQUIRED"
+}
+export declare enum Sep12Type {
+    string = "string",
+    binary = "binary",
+    number = "number",
+    date = "date"
+}
+export type Field = {
+    type: Sep12Type;
+    description: string;
+    choices?: Array<string>;
+    optional?: boolean;
+};
+export type ProvidedField = {
+    type: Sep12Type;
+    description: string;
+    choices?: Array<string>;
+    optional?: boolean;
+    status?: Sep12Status;
+    error?: string;
+};
+export type GetCustomerParams = {
+    id?: string;
+    type?: string;
+    memo?: string;
+    lang?: string;
+};
+export type GetCustomerResponse = {
+    id?: string;
+    status: Sep12Status;
+    fields?: {
+        [key: string]: Field;
+    };
+    provided_fields?: {
+        [key: string]: ProvidedField;
+    };
+    message?: string;
+};
+export type AddCustomerParams = {
+    sep9Info?: CustomerInfoMap;
+    sep9BinaryInfo?: CustomerInfoMap;
+    id?: string;
+    memo?: string;
+    type?: string;
+};
+export type AddCustomerResponse = {
+    id: string;
+};

package/lib/walletSdk/Types/sep38.d.ts

@@ -0,0 +1,93 @@
+import { AxiosInstance } from "axios";
+import { Anchor } from "../Anchor";
+import { AuthToken } from "./auth";
+export interface Sep38Info {
+    assets: Array<Sep38AssetInfo>;
+}
+export interface Sep38AssetInfo {
+    asset: string;
+    sell_delivery_methods?: Array<Sep38DeliveryMethod>;
+    buy_delivery_methods?: Array<Sep38DeliveryMethod>;
+    country_codes?: Array<string>;
+}
+export interface Sep38DeliveryMethod {
+    name: string;
+    description: string;
+}
+export type Sep38Params = {
+    anchor: Anchor;
+    httpClient: AxiosInstance;
+    authToken?: AuthToken;
+};
+export interface Sep38PricesParams {
+    sellAsset: string;
+    sellAmount: string;
+    sellDeliveryMethod?: string;
+    buyDeliveryMethod?: string;
+    countryCode?: string;
+}
+export interface Sep38PricesResponse {
+    buy_assets: Array<Sep38BuyAsset>;
+}
+export interface Sep38BuyAsset {
+    asset: string;
+    price: string;
+    decimals: number;
+}
+export interface Sep38PriceParams {
+    sellAsset: string;
+    buyAsset: string;
+    sellAmount?: string;
+    buyAmount?: string;
+    context: Sep38PriceContext;
+    sellDeliveryMethod?: string;
+    buyDeliveryMethod?: string;
+    countryCode?: string;
+}
+export declare enum Sep38PriceContext {
+    SEP6 = "sep6",
+    SEP24 = "sep24",
+    SEP31 = "sep31"
+}
+export interface Sep38PriceResponse {
+    total_price: string;
+    price: string;
+    sell_amount: string;
+    buy_amount: string;
+    fee: {
+        total: string;
+        asset: string;
+        details?: Array<Sep38FeeDetails>;
+    };
+}
+export interface Sep38FeeDetails {
+    name: string;
+    description?: string;
+    amount: string;
+}
+export interface Sep38PostQuoteParams {
+    sell_asset: string;
+    buy_asset: string;
+    sell_amount: string;
+    buy_amount: string;
+    context: Sep38PriceContext;
+    expire_after?: string;
+    sell_delivery_method?: string;
+    buy_delivery_method?: string;
+    country_code?: string;
+}
+export interface Sep38PostQuoteResponse {
+    id: string;
+    expires_at: string;
+    total_price: string;
+    price: string;
+    sell_asset: string;
+    sell_amount: string;
+    buy_asset: string;
+    buy_amount: string;
+    fee: {
+        total: string;
+        asset: string;
+        details?: Array<Sep38FeeDetails>;
+    };
+}

package/lib/walletSdk/Types/sep6.d.ts

@@ -0,0 +1,160 @@
+import { AxiosInstance } from "axios";
+import { Anchor } from "../Anchor";
+export interface Sep6EndpointInfo {
+    enabled: boolean;
+    authentication_required?: boolean;
+    description?: string;
+}
+export interface Sep6DepositInfo {
+    enabled: boolean;
+    authentication_required?: boolean;
+    fee_fixed?: number;
+    fee_percent?: number;
+    min_amount?: number;
+    max_amount?: number;
+    fields?: {
+        [key: string]: {
+            description: string;
+            optional?: boolean;
+            choices?: string[];
+        };
+    };
+}
+export interface Sep6WithdrawInfo {
+    enabled: boolean;
+    authentication_required?: boolean;
+    fee_fixed?: number;
+    fee_percent?: number;
+    min_amount?: number;
+    max_amount?: number;
+    types?: {
+        [key: string]: {
+            fields?: {
+                [key: string]: {
+                    description: string;
+                    optional?: boolean;
+                    choices?: string[];
+                };
+            };
+        };
+    };
+}
+export interface Sep6Info {
+    deposit: {
+        [key: string]: Sep6DepositInfo;
+    };
+    "deposit-exchange": {
+        [key: string]: Sep6DepositInfo;
+    };
+    withdraw: {
+        [key: string]: Sep6WithdrawInfo;
+    };
+    "withdraw-exchange": {
+        [key: string]: Sep6WithdrawInfo;
+    };
+    fee: {
+        enabled: boolean;
+        description: string;
+    };
+    transactions: Sep6EndpointInfo;
+    transaction: Sep6EndpointInfo;
+    features: {
+        account_creation: boolean;
+        claimable_balances: boolean;
+    };
+}
+export type Sep6Params = {
+    anchor: Anchor;
+    httpClient: AxiosInstance;
+};
+export interface Sep6DepositParams {
+    asset_code: string;
+    account: string;
+    memo_type?: string;
+    memo?: string;
+    email_address?: string;
+    type?: string;
+    lang?: string;
+    on_change_callback?: string;
+    amount?: string;
+    country_code?: string;
+    claimable_balance_supported?: string;
+    customer_id?: string;
+}
+export interface Sep6WithdrawParams {
+    asset_code: string;
+    type: string;
+    dest?: string;
+    dest_extra?: string;
+    account?: string;
+    memo?: string;
+    lang?: string;
+    on_change_callback?: string;
+    amount?: string;
+    country_code?: string;
+    refund_memo?: string;
+    refund_memo_type?: string;
+    customer_id?: string;
+}
+export type Sep6DepositResponse = Sep6DepositSuccess | Sep6MissingKYC | Sep6Pending;
+export interface Sep6DepositSuccess {
+    how?: string;
+    instructions?: {
+        [key: string]: {
+            value: string;
+            description: string;
+        };
+    };
+    id?: string;
+    eta?: number;
+    min_amoun?: number;
+    max_amount?: number;
+    fee_fixed?: number;
+    fee_percent?: number;
+    extra_info?: {
+        message?: string;
+    };
+}
+export interface Sep6MissingKYC {
+    type: string;
+    fields: Array<string>;
+}
+export interface Sep6Pending {
+    type: string;
+    status: string;
+    more_info_url?: string;
+    eta?: number;
+}
+export type Sep6WithdrawResponse = Sep6WithdrawSuccess | Sep6MissingKYC | Sep6Pending;
+export interface Sep6WithdrawSuccess {
+    account_id?: string;
+    memo_type?: string;
+    memo?: string;
+    id?: string;
+    eta?: number;
+    min_amount?: number;
+    max_amount?: number;
+    fee_fixed?: number;
+    fee_percent?: number;
+    extra_info?: {
+        message?: string;
+    };
+}
+export interface Sep6ExchangeParams {
+    destination_asset: string;
+    source_asset: string;
+    amount: string;
+    account?: string;
+    quote_id?: string;
+    memo_type?: string;
+    memo?: string;
+    email_address?: string;
+    type?: string;
+    lang?: string;
+    on_change_callback?: string;
+    country_code?: string;
+    claimable_balance_supported?: string;
+    customer_id?: string;
+    refund_memo?: string;
+    refund_memo_type?: string;
+}

package/lib/walletSdk/Types/watcher.d.ts

@@ -1,6 +1,7 @@
 import { AnchorTransaction } from "./anchor";
+import { AuthToken } from "./auth";
 export type WatchTransactionsParams = {
-    authToken: string;
+    authToken: AuthToken;
     assetCode: string;
     onMessage: (transaction: AnchorTransaction) => void;
     onError: (error: AnchorTransaction | Error) => void;
@@ -12,7 +13,7 @@ export type WatchTransactionsParams = {
     noOlderThan?: string;
 };
 export type WatchTransactionParams = {
-    authToken: string;
+    authToken: AuthToken;
     assetCode: string;
     id: string;
     onMessage: (transaction: AnchorTransaction) => void;
@@ -28,3 +29,7 @@ export interface WatcherResponse {
     refresh: WatcherRefreshFunction;
     stop: WatcherStopFunction;
 }
+export declare enum WatcherSepType {
+    SEP6 = "SEP6",
+    SEP24 = "SEP24"
+}

package/lib/walletSdk/Utils/extractAxiosErrorData.d.ts

@@ -0,0 +1,2 @@
+import { AxiosErrorData } from "../Types";
+export declare const extractAxiosErrorData: (error: Error) => AxiosErrorData;

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

@@ -1,3 +1,4 @@
 export * from "./camelToSnakeCase";
 export * from "./toml";
 export * from "./url";
+export * from "./extractAxiosErrorData";

package/lib/walletSdk/Utils/toml.d.ts

@@ -1,3 +1,3 @@
-import { StellarTomlResolver } from "stellar-sdk";
+import { StellarToml } from "stellar-sdk";
 import { TomlInfo } from "../Types";
-export declare const parseToml: (toml: StellarTomlResolver.StellarToml) => TomlInfo;
+export declare const parseToml: (toml: StellarToml.Api.StellarToml) => TomlInfo;

package/lib/walletSdk/Watcher/getTransactions.d.ts

@@ -0,0 +1,8 @@
+import { AxiosInstance } from "axios";
+import { AuthToken } from "../Types";
+export declare const _getTransactionsForAsset: <T>(authToken: AuthToken, params: {
+    [key: string]: string | number;
+}, endpoint: string, client: AxiosInstance) => Promise<T[]>;
+export declare const _getTransactionBy: <T>(authToken: AuthToken, params: {
+    [key: string]: string | number;
+}, endpoint: string, client: AxiosInstance) => Promise<T>;