@fystack/sdk 0.1.2 → 0.1.3

package/dist/types/index.d.ts

@@ -1,146 +1,6 @@
 import { AbstractSigner, Provider, TransactionResponse, TypedDataDomain, TypedDataField } from 'ethers';
 import { TransactionRequest } from 'ethers/src.ts/providers';
 
-declare class TransactionError extends Error {
-    readonly code: string;
-    readonly transactionId?: string | undefined;
-    readonly originalError?: Error | undefined;
-    constructor(message: string, code: string, transactionId?: string | undefined, originalError?: Error | undefined);
-}
-declare enum TxStatus {
-    Pending = "pending",
-    Completed = "completed",
-    Confirmed = "confirmed",
-    Failed = "failed",
-    PendingApproval = "pending_approval",
-    Rejected = "rejected"
-}
-declare enum TxApprovalStatus {
-    Pending = "pending",
-    Approved = "approved",
-    Rejected = "rejected"
-}
-interface APICredentials {
-    apiKey: string;
-    apiSecret: string;
-    authToken?: string;
-}
-interface WebhookEvent {
-    webhook_id: string;
-    resource_id: string;
-    url: string;
-    payload: any;
-    event: string;
-}
-interface SignRequestParams {
-    method: string;
-    message: string;
-    chain_id: number;
-    typed_data?: string;
-}
-interface SignResponse {
-    transaction_id: string;
-}
-interface SignatureStatusResponse {
-    status: TxStatus;
-    signature?: string;
-    transaction_id: string;
-    created_at: string;
-    updated_at: string;
-    approvals: Array<{
-        user_id: string;
-        status: TxApprovalStatus;
-    }>;
-}
-interface ApprovalInfo {
-    user_id: string;
-    status: TxApprovalStatus;
-}
-interface TransactionStatusResponse {
-    transaction_id: string;
-    status: TxStatus;
-    method: string;
-    hash?: string;
-    created_at: string;
-    updated_at: string;
-    approvals: ApprovalInfo[];
-    failed_reason?: string;
-}
-declare enum WalletType {
-    Standard = "standard",
-    MPC = "mpc"
-}
-interface CreateWalletOptions {
-    name: string;
-    walletType: WalletType;
-}
-declare enum WalletCreationStatus {
-    Pending = "pending",
-    Success = "success",
-    Error = "error"
-}
-interface CreateWalletResponse {
-    wallet_id: string;
-    status: WalletCreationStatus;
-}
-interface WalletCreationStatusResponse {
-    wallet_id: string;
-    status: WalletCreationStatus;
-}
-interface WalletAssetNetwork {
-    id: string;
-    created_at: string;
-    updated_at: string;
-    name: string;
-    description?: string;
-    is_evm: boolean;
-    chain_id: number;
-    native_currency: string;
-    is_testnet?: boolean;
-    internal_code: string;
-    explorer_tx: string;
-    explorer_address: string;
-    explorer_token: string;
-    confirmation_blocks: number;
-    block_interval_in_seconds: number;
-    disabled: boolean;
-    logo_url: string;
-}
-interface WalletAssetDetail {
-    id: string;
-    created_at: string;
-    updated_at: string;
-    name: string;
-    symbol: string;
-    decimals: number;
-    logo_url: string;
-    is_native: boolean;
-    address_type: string;
-    is_whitelisted: boolean;
-    address?: string;
-    network_id: string;
-    network?: WalletAssetNetwork;
-}
-interface WalletAsset {
-    id: string;
-    created_at: string;
-    updated_at: string;
-    wallet_id: string;
-    asset_id: string;
-    deposit_address: string;
-    hidden: boolean;
-    asset: WalletAssetDetail;
-}
-declare enum AddressType {
-    Evm = "evm",
-    Solana = "sol"
-}
-interface DepositAddressResponse {
-    asset_id?: string;
-    address: string;
-    qr_code: string;
-}
-
 declare enum Environment {
     Local = "local",
     Sandbox = "sandbox",
@@ -160,6 +20,7 @@ interface APIEndpoints {
     getWalletCreationStatus: (walletId: string) => string;
     getWalletAssets: (walletId: string) => string;
     getDepositAddress: (walletId: string, addressType: string) => string;
+    rescanTransaction: () => string;
 }
 interface APIConfig {
     baseURL: string;
@@ -167,129 +28,6 @@ interface APIConfig {
 }
 declare const createAPI: (env: Environment) => APIConfig;
 
-interface SDKOptions {
-    credentials: APICredentials;
-    environment?: Environment;
-    logger?: boolean;
-}
-declare class FystackSDK {
-    private apiService;
-    private enableLogging;
-    constructor(options: SDKOptions);
-    private log;
-    /**
-     * Creates a new wallet
-     * @param options Wallet creation options
-     * @param waitForCompletion Whether to wait for the wallet creation to complete
-     * @returns Promise with wallet ID and status
-     */
-    createWallet(options: CreateWalletOptions, waitForCompletion?: boolean): Promise<CreateWalletResponse>;
-    /**
-     * Gets the current status of a wallet creation process
-     * @param walletId The ID of the wallet being created
-     * @returns Promise with wallet creation status details
-     */
-    getWalletCreationStatus(walletId: string): Promise<WalletCreationStatusResponse>;
-    /**
-     * Waits for a wallet to be created and returns the final status
-     * @param walletId The ID of the wallet being created
-     * @returns Promise with wallet ID and final status
-     */
-    private waitForWalletCreation;
-    /**
-     * Gets assets associated with a wallet
-     * @param walletId The ID of the wallet
-     * @returns Promise with wallet assets
-     */
-    getWalletAssets(walletId: string): Promise<WalletAsset[]>;
-    /**
-     * Gets deposit address for a wallet by address type
-     * @param walletId The wallet ID
-     * @param addressType The type of address (evm, sol)
-     * @returns Promise with deposit address information
-     */
-    getDepositAddress(walletId: string, addressType: AddressType): Promise<DepositAddressResponse>;
-}
-
-interface StatusPollerOptions {
-    maxAttempts?: number;
-    interval?: number;
-    backoffFactor?: number;
-    maxInterval?: number;
-    timeoutMs?: number;
-}
-declare const DEFAULT_POLLER_OPTIONS: StatusPollerOptions;
-declare class StatusPoller {
-    private startTime;
-    private attempts;
-    private currentInterval;
-    private readonly options;
-    constructor(options?: StatusPollerOptions);
-    private wait;
-    private shouldContinue;
-    poll<T>(pollingFn: () => Promise<T>, successCondition: (result: T) => boolean, errorCondition?: (result: T) => boolean | void): Promise<T>;
-}
-
-declare class EtherSigner extends AbstractSigner {
-    private address;
-    private APICredentials;
-    private APIService;
-    private walletDetail;
-    private environment;
-    private pollerOptions?;
-    constructor(credentials: APICredentials, environment: Environment, provider?: null | Provider, pollerOptions?: StatusPollerOptions);
-    setWallet(walletId: string): void;
-    getAddress(): Promise<string>;
-    private getChainId;
-    connect(provider: null | Provider): EtherSigner;
-    private waitForSignature;
-    private waitForTransactonStatus;
-    signTransaction(tx: TransactionRequest): Promise<string>;
-    sendTransaction(tx: TransactionRequest): Promise<TransactionResponse>;
-    signMessage(message: string | Uint8Array): Promise<string>;
-    signTypedData(domain: TypedDataDomain, types: Record<string, Array<TypedDataField>>, value: Record<string, any>): Promise<string>;
-}
-
-declare class SolanaSigner {
-    private address;
-    private APIService;
-    private APIKey;
-    private walletDetail;
-    private pollerOptions?;
-    private APICredentials;
-    constructor(credentials: APICredentials, environment: Environment, pollerOptions?: StatusPollerOptions);
-    setWallet(walletId: string): void;
-    getAddress(): Promise<string>;
-    private waitForTransactionStatus;
-    /**
-     * Signs a Solana transaction
-     * @param transaction Base64 encoded serialized transaction
-     * @returns Signature as a base58 encoded string
-     */
-    signTransaction(transaction: string): Promise<string>;
-    /**
-     * Signs a Solana message
-     * @param message The message to sign (string or Uint8Array)
-     * @returns Signature as a base58 encoded string
-     */
-    signMessage(message: string | Uint8Array): Promise<string>;
-    /**
-     * Signs and sends a Solana transaction
-     * @param transaction Base64 encoded serialized transaction
-     * @returns Transaction signature
-     */
-    signAndSendTransaction(transaction: string): Promise<string>;
-    /**
-     * Signs multiple Solana transactions
-     * @param transactions Array of base64 encoded serialized transactions
-     * @returns Array of signatures as base58 encoded strings
-     */
-    signAllTransactions(transactions: string[]): Promise<{
-        transactions: string[];
-    }>;
-    private incorporateSignatureIntoTransaction;
-}
-
 interface Network {
     id: string;
     created_at: string;
@@ -536,6 +274,46 @@ interface GetCheckoutPaymentResponse {
     deposit_qr: string;
 }
 
+declare enum WalletType {
+    Standard = "standard",
+    MPC = "mpc"
+}
+declare enum WalletPurpose {
+    General = "general",
+    Gastank = "gas_tank",
+    Deployment = "deployment",
+    Custody = "custody",
+    User = "user",
+    Payment = "payment"
+}
+declare enum WalletCreationStatus {
+    Pending = "pending",
+    Success = "success",
+    Error = "error"
+}
+declare enum AddressType {
+    Evm = "evm",
+    Solana = "sol",
+    Tron = "tron"
+}
+declare enum DestinationType {
+    InternalWallet = "internal_wallet",
+    AddressBook = "address_book"
+}
+declare enum TxStatus {
+    Pending = "pending",
+    Completed = "completed",
+    Confirmed = "confirmed",
+    Failed = "failed",
+    PendingApproval = "pending_approval",
+    Rejected = "rejected"
+}
+declare enum TxApprovalStatus {
+    Pending = "pending",
+    Approved = "approved",
+    Rejected = "rejected"
+}
+
 interface APIResponse {
     data: any;
     success: boolean;
@@ -554,24 +332,28 @@ interface WalletDetail {
     AddressType: string;
     Address: string;
 }
+interface SweepTaskParams {
+    minTriggerValueUsd: number;
+    destinationWalletId: string;
+    destinationType: DestinationType;
+}
 interface CreateWalletPayload {
     name: string;
     walletType: WalletType;
+    walletPurpose?: WalletPurpose;
+    sweepTaskParams?: SweepTaskParams;
+    sweepTaskId?: string;
 }
 interface PaymentServiceParams {
     apiKey: string;
     environment: Environment;
 }
-declare enum WalletAddressType {
-    Evm = "evm",
-    Sol = "sol"
-}
 declare class APIService {
     private credentials;
     Webhook: WebhookService;
     private API;
     constructor(credentials: APICredentials, environment: Environment);
-    getWalletDetail(addressType?: WalletAddressType, walletId?: string): Promise<WalletDetail>;
+    getWalletDetail(addressType?: AddressType, walletId?: string): Promise<WalletDetail>;
     requestSign(walletId: string, params: SignRequestParams): Promise<SignResponse>;
     getSignStatus(walletId: string, transactionId: string): Promise<SignatureStatusResponse>;
     signTransaction(walletId: string, body: Record<string, any>): Promise<SignResponse>;
@@ -587,6 +369,12 @@ declare class APIService {
      * @returns Deposit address response
      */
     getDepositAddress(walletId: string, addressType: AddressType): Promise<DepositAddressResponse>;
+    /**
+     * Rescans a transaction on a specific network
+     * @param params Transaction hash and network ID
+     * @returns API response
+     */
+    rescanTransaction(params: RescanTransactionParams): Promise<void>;
 }
 declare class PaymentService {
     private apiKey;
@@ -606,8 +394,269 @@ declare function get(endpoint: string, headers?: Record<string, string>): Promis
 declare function post(endpoint: string, body: any, headers?: Record<string, string>): Promise<APIResponse>;
 declare function transformWalletDetail(data: Record<string, string>): WalletDetail;
 declare function transformCreateWalletPayload(data: CreateWalletPayload): {
+    sweep_task_id?: string | undefined;
+    sweep_task_params?: {
+        min_trigger_value_usd: number;
+        destination_wallet_id: string;
+        destination_type: DestinationType;
+    } | undefined;
+    wallet_purpose?: WalletPurpose | undefined;
     name: string;
     wallet_type: WalletType;
 };
+declare function transformRescanTransactionParams(data: RescanTransactionParams): {
+    tx_hash: string;
+    network_id: string;
+};
+
+declare class TransactionError extends Error {
+    readonly code: string;
+    readonly transactionId?: string | undefined;
+    readonly originalError?: Error | undefined;
+    constructor(message: string, code: string, transactionId?: string | undefined, originalError?: Error | undefined);
+}
+interface APICredentials {
+    apiKey: string;
+    apiSecret: string;
+    authToken?: string;
+}
+interface WebhookEvent {
+    webhook_id: string;
+    resource_id: string;
+    url: string;
+    payload: any;
+    event: string;
+}
+interface SignRequestParams {
+    method: string;
+    message: string;
+    chain_id: number;
+    typed_data?: string;
+}
+interface SignResponse {
+    transaction_id: string;
+}
+interface SignatureStatusResponse {
+    status: TxStatus;
+    signature?: string;
+    transaction_id: string;
+    created_at: string;
+    updated_at: string;
+    approvals: Array<{
+        user_id: string;
+        status: TxApprovalStatus;
+    }>;
+}
+interface ApprovalInfo {
+    user_id: string;
+    status: TxApprovalStatus;
+}
+interface TransactionStatusResponse {
+    transaction_id: string;
+    status: TxStatus;
+    method: string;
+    hash?: string;
+    created_at: string;
+    updated_at: string;
+    approvals: ApprovalInfo[];
+    failed_reason?: string;
+}
+interface CreateWalletOptions {
+    name: string;
+    walletType: WalletType;
+    walletPurpose?: WalletPurpose;
+    sweepTaskParams?: SweepTaskParams;
+    sweepTaskId?: string;
+}
+interface CreateWalletResponse {
+    wallet_id: string;
+    status: WalletCreationStatus;
+}
+interface WalletCreationStatusResponse {
+    wallet_id: string;
+    status: WalletCreationStatus;
+}
+interface WalletAssetNetwork {
+    id: string;
+    created_at: string;
+    updated_at: string;
+    name: string;
+    description?: string;
+    is_evm: boolean;
+    chain_id: number;
+    native_currency: string;
+    is_testnet?: boolean;
+    internal_code: string;
+    explorer_tx: string;
+    explorer_address: string;
+    explorer_token: string;
+    confirmation_blocks: number;
+    block_interval_in_seconds: number;
+    disabled: boolean;
+    logo_url: string;
+}
+interface WalletAssetDetail {
+    id: string;
+    created_at: string;
+    updated_at: string;
+    name: string;
+    symbol: string;
+    decimals: number;
+    logo_url: string;
+    is_native: boolean;
+    address_type: string;
+    is_whitelisted: boolean;
+    address?: string;
+    network_id: string;
+    network?: WalletAssetNetwork;
+}
+interface WalletAsset {
+    id: string;
+    created_at: string;
+    updated_at: string;
+    wallet_id: string;
+    asset_id: string;
+    deposit_address: string;
+    hidden: boolean;
+    asset: WalletAssetDetail;
+}
+interface DepositAddressResponse {
+    asset_id?: string;
+    address: string;
+    qr_code: string;
+}
+interface RescanTransactionParams {
+    txHash: string;
+    networkId: string;
+}
+
+interface SDKOptions {
+    credentials: APICredentials;
+    environment?: Environment;
+    logger?: boolean;
+}
+declare class FystackSDK {
+    private apiService;
+    private enableLogging;
+    constructor(options: SDKOptions);
+    private log;
+    /**
+     * Creates a new wallet
+     * @param options Wallet creation options
+     * @param waitForCompletion Whether to wait for the wallet creation to complete
+     * @returns Promise with wallet ID and status
+     */
+    createWallet(options: CreateWalletOptions, waitForCompletion?: boolean): Promise<CreateWalletResponse>;
+    /**
+     * Gets the current status of a wallet creation process
+     * @param walletId The ID of the wallet being created
+     * @returns Promise with wallet creation status details
+     */
+    getWalletCreationStatus(walletId: string): Promise<WalletCreationStatusResponse>;
+    /**
+     * Waits for a wallet to be created and returns the final status
+     * @param walletId The ID of the wallet being created
+     * @returns Promise with wallet ID and final status
+     */
+    private waitForWalletCreation;
+    /**
+     * Gets assets associated with a wallet
+     * @param walletId The ID of the wallet
+     * @returns Promise with wallet assets
+     */
+    getWalletAssets(walletId: string): Promise<WalletAsset[]>;
+    /**
+     * Gets deposit address for a wallet by address type
+     * @param walletId The wallet ID
+     * @param addressType The type of address (evm, sol)
+     * @returns Promise with deposit address information
+     */
+    getDepositAddress(walletId: string, addressType: AddressType): Promise<DepositAddressResponse>;
+    /**
+     * Rescans a transaction on a specific network
+     * @param params Transaction hash and network ID
+     * @returns Promise that resolves when the rescan is initiated
+     */
+    rescanTransaction(params: RescanTransactionParams): Promise<void>;
+}
+
+interface StatusPollerOptions {
+    maxAttempts?: number;
+    interval?: number;
+    backoffFactor?: number;
+    maxInterval?: number;
+    timeoutMs?: number;
+}
+declare const DEFAULT_POLLER_OPTIONS: StatusPollerOptions;
+declare class StatusPoller {
+    private startTime;
+    private attempts;
+    private currentInterval;
+    private readonly options;
+    constructor(options?: StatusPollerOptions);
+    private wait;
+    private shouldContinue;
+    poll<T>(pollingFn: () => Promise<T>, successCondition: (result: T) => boolean, errorCondition?: (result: T) => boolean | void): Promise<T>;
+}
+
+declare class EtherSigner extends AbstractSigner {
+    private address;
+    private APICredentials;
+    private APIService;
+    private walletDetail;
+    private environment;
+    private pollerOptions?;
+    constructor(credentials: APICredentials, environment: Environment, provider?: null | Provider, pollerOptions?: StatusPollerOptions);
+    setWallet(walletId: string): void;
+    getAddress(): Promise<string>;
+    private getChainId;
+    connect(provider: null | Provider): EtherSigner;
+    private waitForSignature;
+    private waitForTransactonStatus;
+    signTransaction(tx: TransactionRequest): Promise<string>;
+    sendTransaction(tx: TransactionRequest): Promise<TransactionResponse>;
+    signMessage(message: string | Uint8Array): Promise<string>;
+    signTypedData(domain: TypedDataDomain, types: Record<string, Array<TypedDataField>>, value: Record<string, any>): Promise<string>;
+}
+
+declare class SolanaSigner {
+    private address;
+    private APIService;
+    private APIKey;
+    private walletDetail;
+    private pollerOptions?;
+    private APICredentials;
+    constructor(credentials: APICredentials, environment: Environment, pollerOptions?: StatusPollerOptions);
+    setWallet(walletId: string): void;
+    getAddress(): Promise<string>;
+    private waitForTransactionStatus;
+    /**
+     * Signs a Solana transaction
+     * @param transaction Base64 encoded serialized transaction
+     * @returns Signature as a base58 encoded string
+     */
+    signTransaction(transaction: string): Promise<string>;
+    /**
+     * Signs a Solana message
+     * @param message The message to sign (string or Uint8Array)
+     * @returns Signature as a base58 encoded string
+     */
+    signMessage(message: string | Uint8Array): Promise<string>;
+    /**
+     * Signs and sends a Solana transaction
+     * @param transaction Base64 encoded serialized transaction
+     * @returns Transaction signature
+     */
+    signAndSendTransaction(transaction: string): Promise<string>;
+    /**
+     * Signs multiple Solana transactions
+     * @param transactions Array of base64 encoded serialized transactions
+     * @returns Array of signatures as base58 encoded strings
+     */
+    signAllTransactions(transactions: string[]): Promise<{
+        transactions: string[];
+    }>;
+    private incorporateSignatureIntoTransaction;
+}
 
-export { type APIConfig, type APICredentials, type APIEndpoints, APIService, AddressType, type ApprovalInfo, type CreateWalletOptions, type CreateWalletPayload, type CreateWalletResponse, DEFAULT_POLLER_OPTIONS, type DepositAddressResponse, Environment, EtherSigner, FystackSDK, type HMACParams, PaymentService, type PaymentServiceParams, type SDKOptions, type SignRequestParams, type SignResponse, type SignatureStatusResponse, SolanaSigner, StatusPoller, type StatusPollerOptions, TransactionError, type TransactionStatusResponse, TxApprovalStatus, TxStatus, WalletAddressType, type WalletAsset, type WalletAssetDetail, type WalletAssetNetwork, WalletCreationStatus, type WalletCreationStatusResponse, type WalletDetail, WalletType, type WebhookEvent, WebhookService, createAPI, get, post, transformCreateWalletPayload, transformWalletDetail };
+export { type APIConfig, type APICredentials, type APIEndpoints, APIService, AddressType, type ApprovalInfo, type CreateWalletOptions, type CreateWalletPayload, type CreateWalletResponse, DEFAULT_POLLER_OPTIONS, type DepositAddressResponse, DestinationType, Environment, EtherSigner, FystackSDK, type HMACParams, PaymentService, type PaymentServiceParams, type RescanTransactionParams, type SDKOptions, type SignRequestParams, type SignResponse, type SignatureStatusResponse, SolanaSigner, StatusPoller, type StatusPollerOptions, type SweepTaskParams, TransactionError, type TransactionStatusResponse, TxApprovalStatus, TxStatus, type WalletAsset, type WalletAssetDetail, type WalletAssetNetwork, WalletCreationStatus, type WalletCreationStatusResponse, type WalletDetail, WalletPurpose, WalletType, type WebhookEvent, WebhookService, createAPI, get, post, transformCreateWalletPayload, transformRescanTransactionParams, transformWalletDetail };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fystack/sdk",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Wallet SDK",
   "main": "dist/index.cjs",
   "types": "dist/types/index.d.ts",

package/readme.md

@@ -30,7 +30,13 @@ const sdk = new FystackSDK({
 
 const response = await sdk.createWallet({
   name: 'My Blockchain Wallet',
-  walletType: WalletType.MPC // Multi-Party Computation wallet
+  walletType: WalletType.MPC, // Multi-Party Computation wallet
+  walletPurpose: WalletPurpose.User,
+  sweepTaskParams: {
+    minTriggerValueUsd: 100,
+    destinationWalletId: '0e123131211323xx1213',
+    destinationType: DestinationType.InternalWallet
+  }
 })
 
 console.log('Wallet ID:', response.wallet_id)