@stellar/typescript-wallet-sdk 1.4.1 → 1.6.0-beta.1719865729038

package/lib/index.d.ts

@@ -11,8 +11,10 @@ export { Anchor } from "./walletSdk/Anchor";
 export { Sep24 } from "./walletSdk/Anchor/Sep24";
 export { IssuedAssetId, NativeAssetId, FiatAssetId } from "./walletSdk/Asset";
 export { Sep10, WalletSigner, DefaultSigner } from "./walletSdk/Auth";
+export { AuthHeaderSigner, DefaultAuthHeaderSigner, DomainAuthHeaderSigner, } from "./walletSdk/Auth/AuthHeaderSigner";
 export { AccountKeypair, PublicKeypair, SigningKeypair, AccountService, Stellar, CommonTransactionBuilder, TransactionBuilder, SponsoringBuilder, } from "./walletSdk/Horizon";
 export { Recovery } from "./walletSdk/Recovery";
+export { Sep7Base, Sep7Pay, Sep7Tx, isValidSep7Uri, parseSep7Uri, sep7ReplacementsFromString, sep7ReplacementsToString, } from "./walletSdk/Uri";
 export { Watcher } from "./walletSdk/Watcher";
 /**
  * Utils

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

@@ -1,5 +1,5 @@
 import { AxiosInstance } from "axios";
-import { Config } from "walletSdk";
+import { Config } from "../";
 import { Sep10 } from "../Auth";
 import { Sep12 } from "../Customer";
 import { Sep6 } from "./Sep6";

package/lib/walletSdk/Auth/AuthHeaderSigner.d.ts

@@ -0,0 +1,61 @@
+import { AxiosInstance } from "axios";
+import { AuthHeaderClaims, AuthHeaderCreateTokenParams } from "../Types";
+export interface AuthHeaderSigner {
+    createToken({ claims, clientDomain, issuer, }: AuthHeaderCreateTokenParams): Promise<string>;
+}
+/**
+ * Signer for signing JWT for GET /Auth with a custodial private key
+ *
+ * @class
+ */
+export declare class DefaultAuthHeaderSigner implements AuthHeaderSigner {
+    expiration: number;
+    constructor(expiration?: number);
+    /**
+     * Create a signed JWT for the auth header
+     * @constructor
+     * @param {AuthHeaderCreateTokenParams} params - The create token parameters
+     * @param {AuthHeaderClaims} params.claims - the data to be signed in the JWT
+     * @param {string} [params.clientDomain] - the client domain hosting SEP-1 toml
+     * @param {AccountKeypair} [params.issuer] - the account signing the JWT
+     * @returns {Promise<string>} The signed JWT
+     */
+    createToken({ claims, clientDomain, issuer, }: AuthHeaderCreateTokenParams): Promise<string>;
+}
+/**
+ * Signer for signing JWT for GET /Auth using a remote server to sign.
+ *
+ * @class
+ */
+export declare class DomainAuthHeaderSigner implements AuthHeaderSigner {
+    signerUrl: string;
+    expiration: number;
+    httpClient: AxiosInstance;
+    constructor(signerUrl: string, expiration?: number, httpClient?: AxiosInstance);
+    /**
+     * Create a signed JWT for the auth header by using a remote server to sign the JWT
+     * @constructor
+     * @param {AuthHeaderCreateTokenParams} params - The create token parameters
+     * @param {AuthHeaderClaims} params.claims - the data to be signed in the JWT
+     * @param {string} [params.clientDomain] - the client domain hosting SEP-1 toml
+     * @param {AccountKeypair} [params.issuer] - unused, will not be used to sign
+     * @returns {Promise<string>} The signed JWT
+     */
+    createToken({ claims, clientDomain, issuer, }: AuthHeaderCreateTokenParams): Promise<string>;
+    /**
+     * Sign JWT by calling a remote server
+     * @constructor
+     * @param {SignTokenRemoteParams} params - the sign token params
+     * @param {AuthHeaderClaims} params.claims - the data to be signed in the JWT
+     * @param {string} params.clientDomain - the client domain hosting SEP-1 toml
+     * @param {number} params.expiration - when the token should expire
+     * @param {number} params.issuedAt - when the token was created
+     * @returns {Promise<string>} The signed JWT
+     */
+    signTokenRemote({ claims, clientDomain, expiration, issuedAt, }: {
+        claims: AuthHeaderClaims;
+        clientDomain: string;
+        expiration: number;
+        issuedAt: number;
+    }): Promise<string>;
+}

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

@@ -1,5 +1,5 @@
 import { AxiosInstance } from "axios";
-import { Config } from "walletSdk";
+import { Config } from "../";
 import { AuthenticateParams, AuthToken } from "../Types";
 export { WalletSigner, DefaultSigner } from "./WalletSigner";
 type Sep10Params = {
@@ -35,7 +35,7 @@ export declare class Sep10 {
      * @param {string} [params.clientDomain] - Domain hosting stellar.toml file containing `SIGNING_KEY`.
      * @returns {Promise<AuthToken>} The authentication token.
      */
-    authenticate({ accountKp, walletSigner, memoId, clientDomain, }: AuthenticateParams): Promise<AuthToken>;
+    authenticate({ accountKp, walletSigner, memoId, clientDomain, authHeaderSigner, }: AuthenticateParams): Promise<AuthToken>;
     private challenge;
     private sign;
     private getToken;

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

@@ -115,3 +115,24 @@ export declare class UnknownAnchorTransactionError extends Error {
 export declare class InvalidJsonError extends Error {
     constructor();
 }
+export declare class SigningKeypairMissingSecretError extends Error {
+    constructor();
+}
+export declare class DefaultSignerDomainAccountError extends Error {
+    constructor();
+}
+export declare class AuthHeaderSigningKeypairRequiredError extends Error {
+    constructor();
+}
+export declare class AuthHeaderClientDomainRequiredError extends Error {
+    constructor();
+}
+export declare class Sep7InvalidUriError extends Error {
+    constructor(reason: string);
+}
+export declare class Sep7LongMsgError extends Error {
+    constructor(msgMaxLength: number);
+}
+export declare class Sep7UriTypeNotSupportedError extends Error {
+    constructor(type: string);
+}

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

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { Horizon } from "@stellar/stellar-sdk";
-import { Config } from "walletSdk";
+import { Config } from "../";
 import { SigningKeypair } from "./Account";
 import { HORIZON_ORDER } from "../Types";
 /**

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

@@ -1,5 +1,5 @@
 import { Horizon, Transaction, FeeBumpTransaction } from "@stellar/stellar-sdk";
-import { Config } from "walletSdk";
+import { Config } from "../";
 import { AccountService } from "./AccountService";
 import { TransactionBuilder } from "./Transaction/TransactionBuilder";
 import { TransactionParams, SubmitWithFeeIncreaseParams, FeeBumpTransactionParams } from "../Types";

package/lib/walletSdk/Horizon/Transaction/TransactionBuilder.d.ts

@@ -1,5 +1,5 @@
 import { Account as StellarAccount, Transaction, Horizon, Memo, xdr } from "@stellar/stellar-sdk";
-import { Config } from "walletSdk";
+import { Config } from "../../";
 import { AccountKeypair } from "../Account";
 import { StellarAssetId } from "../../Asset";
 import { WithdrawTransaction, PathPayParams } from "../../Types";

package/lib/walletSdk/Recovery/AccountRecover.d.ts

@@ -1,6 +1,6 @@
 import { AxiosInstance } from "axios";
 import { Transaction } from "@stellar/stellar-sdk";
-import { RecoveryServer, RecoveryServerKey, RecoveryServerMap, RecoveryServerSigningMap } from "walletSdk/Types";
+import { RecoveryServer, RecoveryServerKey, RecoveryServerMap, RecoveryServerSigningMap } from "../Types";
 import { AccountKeypair, Stellar } from "../Horizon";
 /**
  * Used for Account Recovery using Sep-30.

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

@@ -1,7 +1,7 @@
 import { AxiosInstance } from "axios";
 import { Transaction } from "@stellar/stellar-sdk";
-import { Config } from "walletSdk";
-import { AccountSigner, AccountThreshold, CommonBuilder, RecoverableWallet, RecoverableWalletConfig, RecoveryAccountInfoMap, RecoveryAuthMap, RecoveryServerKey, RecoveryServerMap } from "walletSdk/Types";
+import { Config } from "../";
+import { AccountSigner, AccountThreshold, CommonBuilder, RecoverableWallet, RecoverableWalletConfig, RecoveryAccountInfoMap, RecoveryAuthMap, RecoveryServerKey, RecoveryServerMap } from "../Types";
 import { AccountRecover } from "./AccountRecover";
 import { Sep10 } from "../Auth";
 import { AccountKeypair, Stellar } from "../Horizon";

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

@@ -159,5 +159,9 @@ export declare enum TransactionStatus {
     /** Deposit/withdrawal size exceeded max_amount. */
     too_large = "too_large",
     /** Catch-all for any error not enumerated above. */
-    error = "error"
+    error = "error",
+    /** deposit/withdrawal is currently on hold for additional checks after receiving user's funds.
+     * Anchor may use this status to indicate to the user that transaction is being reviewed (for example,
+     * for compliance reasons). Once this status cleared, transaction should follow the regular flow */
+    on_hold = "on_hold"
 }

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

@@ -1,11 +1,13 @@
 import { Transaction } from "@stellar/stellar-sdk";
 import { WalletSigner } from "../Auth/WalletSigner";
 import { AccountKeypair, SigningKeypair } from "../Horizon/Account";
+import { AuthHeaderSigner } from "../Auth/AuthHeaderSigner";
 export type AuthenticateParams = {
     accountKp: AccountKeypair;
     walletSigner?: WalletSigner;
     memoId?: string;
     clientDomain?: string;
+    authHeaderSigner?: AuthHeaderSigner;
 };
 export declare class AuthToken {
     token: string;
@@ -22,6 +24,7 @@ export type ChallengeParams = {
     accountKp: AccountKeypair;
     memoId?: string;
     clientDomain?: string;
+    authHeaderSigner?: AuthHeaderSigner;
 };
 export type XdrEncodedTransaction = string;
 export type NetworkPassphrase = string;
@@ -56,3 +59,17 @@ export type SignChallengeTxnResponse = {
     transaction: XdrEncodedTransaction;
     networkPassphrase: NetworkPassphrase;
 };
+export type AuthHeaderClaims = {
+    account: string;
+    home_domain: string;
+    web_auth_endpoint: string;
+    memo?: string;
+    client_domain?: string;
+    exp?: number;
+    iat?: number;
+};
+export type AuthHeaderCreateTokenParams = {
+    claims: AuthHeaderClaims;
+    clientDomain?: string;
+    issuer?: AccountKeypair;
+};

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

@@ -1,6 +1,6 @@
 import { Memo, Horizon, Transaction } from "@stellar/stellar-sdk";
 import { AccountKeypair } from "../Horizon/Account";
-import { SponsoringBuilder, TransactionBuilder } from "walletSdk/Horizon";
+import { SponsoringBuilder, TransactionBuilder } from "../Horizon";
 import { StellarAssetId } from "../Asset";
 export declare enum NETWORK_URLS {
     PUBLIC = "https://horizon.stellar.org",

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

@@ -1,6 +1,6 @@
 import { RawAxiosRequestHeaders } from "axios";
 import { Networks } from "@stellar/stellar-sdk";
-import { ApplicationConfiguration, StellarConfiguration } from "walletSdk";
+import { ApplicationConfiguration, StellarConfiguration } from "../";
 import { RecoveryServerMap } from "./recovery";
 export type WalletParams = {
     stellarConfiguration: StellarConfiguration;
@@ -36,6 +36,7 @@ export * from "./auth";
 export * from "./horizon";
 export * from "./recovery";
 export * from "./sep6";
+export * from "./sep7";
 export * from "./sep12";
 export * from "./sep24";
 export * from "./sep38";

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

@@ -1,6 +1,6 @@
 import { Transaction } from "@stellar/stellar-sdk";
-import { WalletSigner } from "walletSdk/Auth";
-import { AccountKeypair, PublicKeypair } from "walletSdk/Horizon";
+import { WalletSigner } from "../Auth";
+import { AccountKeypair, PublicKeypair } from "../Horizon";
 import { AuthToken } from "./auth";
 import { CommonBuilder } from "./horizon";
 /**

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

@@ -0,0 +1,15 @@
+export declare const WEB_STELLAR_SCHEME = "web+stellar:";
+export declare enum Sep7OperationType {
+    tx = "tx",
+    pay = "pay"
+}
+export declare const URI_MSG_MAX_LENGTH = 300;
+export type Sep7Replacement = {
+    id: string;
+    path: string;
+    hint: string;
+};
+export type IsValidSep7UriResult = {
+    result: boolean;
+    reason?: string;
+};

package/lib/walletSdk/Uri/Sep7Base.d.ts

@@ -0,0 +1,187 @@
+import { Keypair, Networks } from "@stellar/stellar-sdk";
+import { Sep7OperationType } from "../Types";
+/**
+ * A base abstract class containing common functions that should be used by both
+ * Sep7Tx and Sep7Pay classes for parsing or constructing SEP-0007 Stellar URIs.
+ *
+ * @see https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0007.md#specification
+ */
+export declare abstract class Sep7Base {
+    protected uri: URL;
+    /**
+     * Creates a new instance of the Sep7 class.
+     *
+     * @constructor
+     * @param {URL | string} uri - uri to initialize the Sep7 instance.
+     */
+    constructor(uri: URL | string);
+    /**
+     * Should return a deep clone of this instance.
+     *
+     * @returns {Sep7Base} a deep clone of the Sep7Base extended instance.
+     */
+    abstract clone(): Sep7Base;
+    /**
+     * Returns a stringfied URL-decoded version of the 'uri' object.
+     *
+     * @returns {string} the uri decoded string value.
+     */
+    toString(): string;
+    /**
+     * Returns uri's pathname as the operation type.
+     *
+     * @returns {Sep7OperationType} the operation type, either "tx" or "pay".
+     */
+    get operationType(): Sep7OperationType;
+    /**
+     * Returns a URL-decoded version of the uri 'callback' param without
+     * the 'url:' prefix.
+     *
+     * The URI handler should send the signed XDR to this callback url, if this
+     * value is omitted then the URI handler should submit it to the network.
+     *
+     * @returns {string | undefined} URL-decoded 'callback' param if present.
+     */
+    get callback(): string | undefined;
+    /**
+     * Sets and URL-encodes the uri 'callback' param, appends the 'url:'
+     * prefix to it if not yet present.
+     *
+     * Deletes the uri 'callback' param if set as 'undefined'.
+     *
+     * The URI handler should send the signed XDR to this callback url, if this
+     * value is omitted then the URI handler should submit it to the network.
+     *
+     * @param {string | undefined} callback the uri 'callback' param to be set.
+     */
+    set callback(callback: string | undefined);
+    /**
+     * Returns a URL-decoded version of the uri 'msg' param.
+     *
+     * This message should indicate any additional information that the website
+     * or application wants to show the user in her wallet.
+     *
+     * @returns {string | undefined} URL-decoded 'msg' param if present.
+     */
+    get msg(): string | undefined;
+    /**
+     * Sets and URL-encodes the uri 'msg' param, the 'msg' param can't
+     * be larger than 300 characters.
+     *
+     * Deletes the uri 'msg' param if set as 'undefined'.
+     *
+     * This message should indicate any additional information that the website
+     * or application wants to show the user in her wallet.
+     *
+     * @param {string | undefined} msg the uri 'msg' param to be set.
+     * @throws {Sep7LongMsgError} if 'msg' length is bigger than 300.
+     */
+    set msg(msg: string | undefined);
+    /**
+     * Returns uri 'network_passphrase' param, if not present returns
+     * the PUBLIC Network value by default: 'Public Global Stellar Network ; September 2015'.
+     *
+     * @returns {Networks} the Stellar network passphrase considered for this uri.
+     */
+    get networkPassphrase(): Networks;
+    /**
+     * Sets the uri 'network_passphrase' param.
+     *
+     * Deletes the uri 'network_passphrase' param if set as 'undefined'.
+     *
+     * Only need to set it if this transaction is for a network other than
+     * the public network.
+     *
+     * @param {Networks | undefined} networkPassphrase the uri 'network_passphrase'
+     * param to be set.
+     */
+    set networkPassphrase(networkPassphrase: Networks | undefined);
+    /**
+     * Returns a URL-decoded version of the uri 'origin_domain' param.
+     *
+     * This should be a fully qualified domain name that specifies the originating
+     * domain of the URI request.
+     *
+     * @returns {string | undefined} URL-decoded 'origin_domain' param if present.
+     */
+    get originDomain(): string | undefined;
+    /**
+     * Sets and URL-encodes the uri 'origin_domain' param.
+     *
+     * Deletes the uri 'origin_domain' param if set as 'undefined'.
+     *
+     * This should be a fully qualified domain name that specifies the originating
+     * domain of the URI request.
+     *
+     * @param {string | undefined} originDomain the uri 'origin_domain' param
+     * to be set.
+     */
+    set originDomain(originDomain: string | undefined);
+    /**
+     * Returns a URL-decoded version of the uri 'signature' param.
+     *
+     * This should be a signature of the hash of the URI request (excluding the
+     * 'signature' field and value itself).
+     *
+     * Wallets should use the URI_REQUEST_SIGNING_KEY specified in the
+     * origin_domain's stellar.toml file to validate this signature.
+     * If the verification fails, wallets must alert the user.
+     *
+     * @returns {string | undefined} URL-decoded 'signature' param if present.
+     */
+    get signature(): string | undefined;
+    /**
+     * Signs the URI with the given keypair, which means it sets the 'signature' param.
+     *
+     * This should be the last step done before generating the URI string,
+     * otherwise the signature will be invalid for the URI.
+     *
+     * @see https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0007.md#request-signing
+     *
+     * @param {Keypair} keypair The keypair (including secret key), used to sign the request.
+     * This should be the keypair found in the URI_REQUEST_SIGNING_KEY field of the
+     * origin_domains' stellar.toml.
+     *
+     * @returns {string} the generated 'signature' param.
+     */
+    addSignature(keypair: Keypair): string;
+    /**
+     * Verifies that the signature added to the URI is valid.
+     *
+     * @see https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0007.md#request-signing
+     *
+     * @returns {Promise<boolean>} returns 'true' if the signature is valid for
+     * the current URI and origin_domain. Returns 'false' if signature verification
+     * fails, or if there is a problem looking up the stellar.toml associated with
+     * the origin_domain.
+     */
+    verifySignature(): Promise<boolean>;
+    /**
+     * Finds the uri param related to the inputted 'key', if any, and returns
+     * a URL-decoded version of it. Returns 'undefined' if key param not found.
+     *
+     * @param {string} key the uri param key.
+     *
+     * @returns {string | undefined} URL-decoded value of the uri param if found.
+     */
+    protected getParam(key: string): string | undefined;
+    /**
+     * Sets and URL-encodes a 'key=value' uri param.
+     *
+     * Deletes the uri param if 'value' set as 'undefined'.
+     *
+     * @param {string} key the uri param key.
+     * @param {string | undefined} value the uri param value to be set.
+     */
+    protected setParam(key: string, value: string | undefined): void;
+    /**
+     * Converts the URI request into the payload that will be signed by
+     * the 'addSignature' method.
+     *
+     * @see https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0007.md#request-signing
+     *
+     * @returns {Buffer} array of bytes to be signed with given keypair on
+     * the 'addSignature' method.
+     */
+    private createSignaturePayload;
+}

package/lib/walletSdk/Uri/Sep7Pay.d.ts

@@ -0,0 +1,121 @@
+import { MemoType } from "@stellar/stellar-sdk";
+import { Sep7Base } from "../Uri";
+/**
+ * The Sep-7 'pay' operation represents a request to pay a specific address
+ * with a specific asset, regardless of the source asset used by the payer.
+ *
+ * @see https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0007.md#operation-pay
+ */
+export declare class Sep7Pay extends Sep7Base {
+    /**
+     * Creates a Sep7Pay instance with given destination.
+     *
+     * @param {string} destination a valid Stellar address to receive the payment.
+     *
+     * @returns {Sep7Pay} the Sep7Pay instance.
+     */
+    static forDestination(destination: string): Sep7Pay;
+    /**
+     * Creates a new instance of the Sep7Pay class.
+     *
+     * @constructor
+     * @param {URL | string} [uri] - uri to initialize the Sep7 instance.
+     */
+    constructor(uri?: URL | string);
+    /**
+     * Returns a deep clone of this instance.
+     *
+     * @returns {Sep7Pay} a deep clone of this Sep7Pay instance.
+     */
+    clone(): Sep7Pay;
+    /**
+     * Gets the destination of the payment request, which should be a valid
+     * Stellar address.
+     *
+     * @returns {string | undefined} the 'destination' uri param if present.
+     */
+    get destination(): string | undefined;
+    /**
+     * Sets the destination of the payment request, which should be a valid
+     * Stellar address.
+     *
+     * Deletes the uri 'destination' param if set as 'undefined'.
+     *
+     * @param {string | undefined} destination the uri 'destination' param to be set.
+     */
+    set destination(destination: string | undefined);
+    /**
+     * Gets the amount that destination should receive.
+     *
+     * @returns {string | undefined} the 'amount' uri param if present.
+     */
+    get amount(): string | undefined;
+    /**
+     * Sets the amount that destination should receive.
+     *
+     * Deletes the uri 'amount' param if set as 'undefined'.
+     *
+     * @param {string | undefined} amount the uri 'amount' param to be set.
+     */
+    set amount(amount: string | undefined);
+    /**
+     * Gets the code from the asset that destination should receive.
+     *
+     * @returns {string | undefined} the 'asset_code' uri param if present.
+     */
+    get assetCode(): string | undefined;
+    /**
+     * Sets the code from the asset that destination should receive.
+     *
+     * Deletes the uri 'asset_code' param if set as 'undefined'.
+     *
+     * @param {string | undefined} assetCode the uri 'asset_code' param to be set.
+     */
+    set assetCode(assetCode: string | undefined);
+    /**
+     * Gets the account ID of asset issuer the destination should receive.
+     *
+     * @returns {string | undefined} the 'asset_issuer' uri param if present.
+     */
+    get assetIssuer(): string | undefined;
+    /**
+     * Sets the account ID of asset issuer the destination should receive.
+     *
+     * Deletes the uri 'asset_issuer' param if set as 'undefined'.
+     *
+     * @param {string | undefined} assetIssuer the uri 'asset_issuer' param to be set.
+     */
+    set assetIssuer(assetIssuer: string | undefined);
+    /**
+     * Gets the memo to be included in the payment / path payment.
+     * Memos of type MEMO_HASH and MEMO_RETURN should be base64-decoded
+     * after returned from this function.
+     *
+     * @returns {string | undefined} the 'memo' uri param if present.
+     */
+    get memo(): string | undefined;
+    /**
+     * Sets the memo to be included in the payment / path payment.
+     * Memos of type MEMO_HASH and MEMO_RETURN should be base64-encoded
+     * prior to being passed on this function.
+     *
+     * Deletes the uri 'memo' param if set as 'undefined'.
+     *
+     * @param {string | undefined} memo the uri 'memo' param to be set.
+     */
+    set memo(memo: string | undefined);
+    /**
+     * Gets the type of the memo.
+     *
+     * @returns {MemoType | undefined} the 'memo_type' uri param if present.
+     */
+    get memoType(): MemoType | undefined;
+    /**
+     * Sets the type of the memo.
+     *
+     * Deletes the uri 'memo_type' param if set as 'undefined'.
+     *
+     * @param {MemoType | undefined} memoType the uri 'memo_type' param to be set.
+     */
+    set memoType(memoType: MemoType | undefined);
+}