@fystack/sdk 0.1.10 → 0.1.12

package/dist/index.d.mts

@@ -1,6 +1,71 @@
 import { AbstractSigner, Provider, TransactionResponse, TypedDataDomain, TypedDataField } from 'ethers';
 import { TransactionRequest } from 'ethers/src.ts/providers';
 
+declare enum WalletType {
+    Hyper = "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"
+}
+declare enum WalletRole {
+    Admin = "wallet_admin",
+    Signer = "wallet_signer",
+    Viewer = "wallet_viewer"
+}
+declare enum WithdrawalStatus {
+    Pending = "pending",
+    PendingApproval = "pending_approval",
+    Approved = "approved",
+    Rejected = "rejected",
+    Processing = "processing",
+    Completed = "completed",
+    Failed = "failed"
+}
+declare enum SweepStrategy {
+    Periodic = "periodic"
+}
+declare enum SweepType {
+    Default = "default",
+    PaymentLink = "payment_link",
+    Checkout = "checkout"
+}
+declare enum ReserveType {
+    FixedUsd = "fixed_usd"
+}
+
 declare enum Environment {
     Local = "local",
     Sandbox = "sandbox",
@@ -24,6 +89,7 @@ interface APIEndpoints {
     rescanTransaction: () => string;
     requestWithdrawal: (walletId: string) => string;
     getWebhookPublicKey: (workspaceId: string) => string;
+    createSweepTask: (workspaceId: string) => string;
 }
 interface APIConfig {
     baseURL: string;
@@ -31,6 +97,247 @@ interface APIConfig {
 }
 declare const createAPI: (env: Environment) => APIConfig;
 
+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 WalletResponse {
+    id: string;
+    name: string;
+    value_usd: string;
+    role: WalletRole;
+}
+interface TopAssets {
+    symbol: string;
+    logo_url: string;
+}
+interface WalletByWorkspaceResponse {
+    id: string;
+    name: string;
+    role: string;
+    wallet_type: string;
+    value_usd: string;
+    top_assets: TopAssets[];
+    wallet_purpose: string;
+}
+interface RequestWithdrawalParams {
+    assetId: string;
+    amount: string;
+    recipientAddress: string;
+    notes?: string;
+    skipBalanceCheck?: boolean;
+}
+interface WithdrawalApproval {
+    id: string;
+    user_id: string;
+    status: string;
+    created_at: string;
+    updated_at: string;
+}
+interface WithdrawalTransaction {
+    id: string;
+    hash?: string;
+    status: string;
+    created_at: string;
+    updated_at: string;
+}
+interface TxCategory {
+    id: string;
+    name: string;
+}
+interface Withdrawal {
+    id: string;
+    created_at: string;
+    updated_at: string;
+    amount: string;
+    status: WithdrawalStatus;
+    recipient_address: string;
+    notes?: string;
+    withdrawal_approvals: WithdrawalApproval[];
+    creator_id: string;
+    asset_id: string;
+    asset?: WalletAssetDetail;
+    wallet_id: string;
+    transaction_id?: string;
+    transaction?: WithdrawalTransaction;
+    asset_hold_id: string;
+    error_reason?: string;
+    categories?: TxCategory[];
+}
+interface RequestWithdrawalResponse {
+    auto_approved: boolean;
+    withdrawal: Withdrawal;
+}
+interface WebhookPublicKeyResponse {
+    public_key: string;
+}
+interface CreateSweepTaskParams {
+    /** Display name for the sweep task */
+    name: string;
+    /** Sweep execution strategy */
+    strategy: SweepStrategy;
+    /** Minimum USD value in a wallet to trigger a sweep */
+    minTriggerValueUsd: number;
+    /** UUID of the destination wallet or address book record that receives swept funds */
+    destinationWalletId: string;
+    /** How often (in seconds) the sweep task checks wallet balances */
+    frequencyInSeconds: number;
+    /** List of wallet UUIDs to sweep from */
+    walletIds: string[];
+    /** Type of sweep task. Defaults to "default" */
+    sweepType?: SweepType;
+    /** Whether the destination is an internal wallet or an address book entry. Defaults to "internal_wallet" */
+    destinationType?: DestinationType;
+    /** Optional list of specific asset UUIDs to sweep. If omitted, all assets are swept */
+    assetIds?: string[];
+    /** Reserve strategy type (e.g. keep a fixed USD amount in the source wallet) */
+    reserveType?: ReserveType;
+    /** Fixed USD amount to reserve in each source wallet (used when reserveType is "fixed_usd") */
+    reserveAmountUsd?: number;
+    /** Percentage of USD value to reserve in each source wallet */
+    reservePercentageUsd?: number;
+    /** Whether the task is enabled. Defaults to true */
+    enabled?: boolean;
+}
+interface SweepTaskResponse {
+    id: string;
+    created_at: string;
+    updated_at: string;
+    name: string;
+    workspace_id: string;
+    strategy: string;
+    min_trigger_value_usd: string;
+    destination_wallet_id: string;
+    frequency_in_seconds: number;
+    gas_tank_wallet_id: string;
+    last_executed_at: string | null;
+    is_executing: boolean;
+    enabled: boolean;
+    created_by_user_id: string;
+    sweep_type: string;
+    destination_type: string;
+    deviation_rate: string;
+    reserve_type?: string;
+    reserve_amount_usd?: string;
+    reserve_percentage_usd?: string;
+}
+
 interface Network {
     id: string;
     created_at: string;
@@ -277,60 +584,6 @@ interface GetCheckoutPaymentResponse {
     deposit_qr: string;
 }
 
-declare enum WalletType {
-    Hyper = "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"
-}
-declare enum WalletRole {
-    Admin = "wallet_admin",
-    Signer = "wallet_signer",
-    Viewer = "wallet_viewer"
-}
-declare enum WithdrawalStatus {
-    Pending = "pending",
-    PendingApproval = "pending_approval",
-    Approved = "approved",
-    Rejected = "rejected",
-    Processing = "processing",
-    Completed = "completed",
-    Failed = "failed"
-}
-
 interface APIResponse {
     data: any;
     success: boolean;
@@ -406,6 +659,7 @@ declare class APIService {
      * @returns Webhook public key response with base64 encoded ed25519 public key
      */
     getWebhookPublicKey(workspaceId: string): Promise<WebhookPublicKeyResponse>;
+    createSweepTask(workspaceId: string, params: CreateSweepTaskParams): Promise<SweepTaskResponse>;
 }
 declare class PaymentService {
     private apiKey;
@@ -446,208 +700,34 @@ declare function transformRequestWithdrawalParams(data: RequestWithdrawalParams)
     amount: string;
     recipient_address: 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 WalletResponse {
-    id: string;
-    name: string;
-    value_usd: string;
-    role: WalletRole;
-}
-interface TopAssets {
-    symbol: string;
-    logo_url: string;
-}
-interface WalletByWorkspaceResponse {
-    id: string;
+declare function transformCreateSweepTaskParams(data: CreateSweepTaskParams): {
+    enabled?: boolean | undefined;
+    reserve_percentage_usd?: number | undefined;
+    reserve_amount_usd?: number | undefined;
+    reserve_type?: ReserveType | undefined;
+    asset_ids?: string[] | undefined;
+    destination_type?: DestinationType | undefined;
+    sweep_type?: SweepType | undefined;
     name: string;
-    role: string;
-    wallet_type: string;
-    value_usd: string;
-    top_assets: TopAssets[];
-    wallet_purpose: string;
-}
-interface RequestWithdrawalParams {
-    assetId: string;
-    amount: string;
-    recipientAddress: string;
-    notes?: string;
-    skipBalanceCheck?: boolean;
-}
-interface WithdrawalApproval {
-    id: string;
-    user_id: string;
-    status: string;
-    created_at: string;
-    updated_at: string;
-}
-interface WithdrawalTransaction {
-    id: string;
-    hash?: string;
-    status: string;
-    created_at: string;
-    updated_at: string;
-}
-interface TxCategory {
-    id: string;
-    name: string;
-}
-interface Withdrawal {
-    id: string;
-    created_at: string;
-    updated_at: string;
-    amount: string;
-    status: WithdrawalStatus;
-    recipient_address: string;
-    notes?: string;
-    withdrawal_approvals: WithdrawalApproval[];
-    creator_id: string;
-    asset_id: string;
-    asset?: WalletAssetDetail;
-    wallet_id: string;
-    transaction_id?: string;
-    transaction?: WithdrawalTransaction;
-    asset_hold_id: string;
-    error_reason?: string;
-    categories?: TxCategory[];
-}
-interface RequestWithdrawalResponse {
-    auto_approved: boolean;
-    withdrawal: Withdrawal;
-}
-interface WebhookPublicKeyResponse {
-    public_key: string;
-}
+    strategy: SweepStrategy;
+    min_trigger_value_usd: number;
+    destination_wallet_id: string;
+    frequency_in_seconds: number;
+    wallet_ids: string[];
+};
 
 interface SDKOptions {
     credentials: APICredentials;
     workspaceId?: string;
     environment?: Environment;
-    logger?: boolean;
+    /** Enable debug logging. Defaults to false */
+    debug?: boolean;
 }
 declare class FystackSDK {
     private apiService;
-    private enableLogging;
+    private debugEnabled;
     private workspaceId?;
+    automation: AutomationNamespace;
     constructor(options: SDKOptions);
     private log;
     /**
@@ -706,6 +786,17 @@ declare class FystackSDK {
      * @returns Promise with webhook public key (base64 encoded ed25519 public key)
      */
     getWebhookPublicKey(workspaceId: string): Promise<WebhookPublicKeyResponse>;
+    /** @internal */
+    _getApiService(): APIService;
+    /** @internal */
+    _log(message: string): void;
+    /** @internal */
+    _getWorkspaceId(): string;
+}
+declare class AutomationNamespace {
+    private sdk;
+    constructor(sdk: FystackSDK);
+    createSweepTask(params: CreateSweepTaskParams): Promise<SweepTaskResponse>;
 }
 
 interface StatusPollerOptions {
@@ -803,4 +894,4 @@ declare class SolanaSigner {
     private incorporateSignatureIntoTransaction;
 }
 
-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 RequestWithdrawalParams, type RequestWithdrawalResponse, type RescanTransactionParams, type SDKOptions, type SignRequestParams, type SignResponse, type SignatureStatusResponse, SolanaSigner, StatusPoller, type StatusPollerOptions, type SweepTaskParams, type TopAssets, TransactionError, type TransactionStatusResponse, TxApprovalStatus, type TxCategory, TxStatus, type WalletAsset, type WalletAssetDetail, type WalletAssetNetwork, type WalletByWorkspaceResponse, WalletCreationStatus, type WalletCreationStatusResponse, type WalletDetail, WalletPurpose, type WalletResponse, WalletRole, WalletType, type WebhookEvent, type WebhookPublicKeyResponse, WebhookService, type Withdrawal, type WithdrawalApproval, WithdrawalStatus, type WithdrawalTransaction, createAPI, get, post, transformCreateWalletPayload, transformRequestWithdrawalParams, transformRescanTransactionParams, transformWalletDetail };
+export { type APIConfig, type APICredentials, type APIEndpoints, APIService, AddressType, type ApprovalInfo, type CreateSweepTaskParams, type CreateWalletOptions, type CreateWalletPayload, type CreateWalletResponse, DEFAULT_POLLER_OPTIONS, type DepositAddressResponse, DestinationType, Environment, EtherSigner, FystackSDK, type HMACParams, PaymentService, type PaymentServiceParams, type RequestWithdrawalParams, type RequestWithdrawalResponse, type RescanTransactionParams, ReserveType, type SDKOptions, type SignRequestParams, type SignResponse, type SignatureStatusResponse, SolanaSigner, StatusPoller, type StatusPollerOptions, SweepStrategy, type SweepTaskParams, type SweepTaskResponse, SweepType, type TopAssets, TransactionError, type TransactionStatusResponse, TxApprovalStatus, type TxCategory, TxStatus, type WalletAsset, type WalletAssetDetail, type WalletAssetNetwork, type WalletByWorkspaceResponse, WalletCreationStatus, type WalletCreationStatusResponse, type WalletDetail, WalletPurpose, type WalletResponse, WalletRole, WalletType, type WebhookEvent, type WebhookPublicKeyResponse, WebhookService, type Withdrawal, type WithdrawalApproval, WithdrawalStatus, type WithdrawalTransaction, createAPI, get, post, transformCreateSweepTaskParams, transformCreateWalletPayload, transformRequestWithdrawalParams, transformRescanTransactionParams, transformWalletDetail };