@fystack/sdk 0.1.7 → 0.1.9

package/dist/index.d.mts

@@ -22,6 +22,8 @@ interface APIEndpoints {
     getWalletAssets: (walletId: string) => string;
     getDepositAddress: (walletId: string, addressType: string) => string;
     rescanTransaction: () => string;
+    requestWithdrawal: (walletId: string) => string;
+    getWebhookPublicKey: (workspaceId: string) => string;
 }
 interface APIConfig {
     baseURL: string;
@@ -319,6 +321,15 @@ declare enum WalletRole {
     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;
@@ -361,9 +372,9 @@ declare class APIService {
     constructor(credentials: APICredentials, environment: Environment);
     getWallets(workspaceId: string): Promise<WalletByWorkspaceResponse[]>;
     getWalletDetail(addressType?: AddressType, walletId?: string): Promise<WalletDetail>;
-    requestSign(walletId: string, params: SignRequestParams): Promise<SignResponse>;
+    requestSign(walletId: string, params: SignRequestParams, options?: Record<string, string>): Promise<SignResponse>;
     getSignStatus(walletId: string, transactionId: string): Promise<SignatureStatusResponse>;
-    signTransaction(walletId: string, body: Record<string, any>): Promise<SignResponse>;
+    signTransaction(walletId: string, body: Record<string, any>, options?: Record<string, string>): Promise<SignResponse>;
     getTransactionStatus(walletId: string, transactionId: string): Promise<TransactionStatusResponse>;
     createWallet(payload: CreateWalletPayload): Promise<CreateWalletResponse>;
     createCheckout(payload: CreateCheckoutPayload): Promise<CreateCheckoutResponse>;
@@ -382,6 +393,19 @@ declare class APIService {
      * @returns API response
      */
     rescanTransaction(params: RescanTransactionParams): Promise<void>;
+    /**
+     * Requests a withdrawal from a wallet
+     * @param walletId The wallet ID
+     * @param params Withdrawal parameters
+     * @returns Withdrawal response with auto_approved status and withdrawal details
+     */
+    requestWithdrawal(walletId: string, params: RequestWithdrawalParams): Promise<RequestWithdrawalResponse>;
+    /**
+     * Gets the webhook public key for a workspace
+     * @param workspaceId The workspace ID
+     * @returns Webhook public key response with base64 encoded ed25519 public key
+     */
+    getWebhookPublicKey(workspaceId: string): Promise<WebhookPublicKeyResponse>;
 }
 declare class PaymentService {
     private apiKey;
@@ -415,6 +439,13 @@ declare function transformRescanTransactionParams(data: RescanTransactionParams)
     tx_hash: string;
     network_id: string;
 };
+declare function transformRequestWithdrawalParams(data: RequestWithdrawalParams): {
+    skip_balance_check?: boolean | undefined;
+    notes?: string | undefined;
+    asset_id: string;
+    amount: string;
+    recipient_address: string;
+};
 
 declare class TransactionError extends Error {
     readonly code: string;
@@ -555,6 +586,57 @@ interface WalletByWorkspaceResponse {
     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 SDKOptions {
     credentials: APICredentials;
@@ -611,6 +693,19 @@ declare class FystackSDK {
      * @returns Promise that resolves when the rescan is initiated
      */
     rescanTransaction(params: RescanTransactionParams): Promise<void>;
+    /**
+     * Requests a withdrawal from a wallet
+     * @param walletId The ID of the wallet to withdraw from
+     * @param params Withdrawal parameters including asset, amount, and recipient
+     * @returns Promise with withdrawal response including auto_approved status and withdrawal details
+     */
+    requestWithdrawal(walletId: string, params: RequestWithdrawalParams): Promise<RequestWithdrawalResponse>;
+    /**
+     * Gets the webhook public key for a workspace
+     * @param workspaceId The workspace ID
+     * @returns Promise with webhook public key (base64 encoded ed25519 public key)
+     */
+    getWebhookPublicKey(workspaceId: string): Promise<WebhookPublicKeyResponse>;
 }
 
 interface StatusPollerOptions {
@@ -646,10 +741,18 @@ declare class EtherSigner extends AbstractSigner {
     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>;
+    signTransaction(tx: TransactionRequest, options?: {
+        idempotencyKey?: string;
+    }): Promise<string>;
+    sendTransaction(tx: TransactionRequest, options?: {
+        idempotencyKey?: string;
+    }): Promise<TransactionResponse>;
+    signMessage(message: string | Uint8Array, options?: {
+        idempotencyKey?: string;
+    }): Promise<string>;
+    signTypedData(domain: TypedDataDomain, types: Record<string, Array<TypedDataField>>, value: Record<string, any>, options?: {
+        idempotencyKey?: string;
+    }): Promise<string>;
 }
 
 declare class SolanaSigner {
@@ -668,28 +771,36 @@ declare class SolanaSigner {
      * @param transaction Base64 encoded serialized transaction
      * @returns Signature as a base58 encoded string
      */
-    signTransaction(transaction: string): Promise<string>;
+    signTransaction(transaction: string, options?: {
+        idempotencyKey?: 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>;
+    signMessage(message: string | Uint8Array, options?: {
+        idempotencyKey?: string;
+    }): Promise<string>;
     /**
      * Signs and sends a Solana transaction
      * @param transaction Base64 encoded serialized transaction
      * @returns Transaction signature
      */
-    signAndSendTransaction(transaction: string): Promise<string>;
+    signAndSendTransaction(transaction: string, options?: {
+        idempotencyKey?: 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<{
+    signAllTransactions(transactions: string[], options?: {
+        idempotencyKey?: 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, 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, type TopAssets, TransactionError, type TransactionStatusResponse, TxApprovalStatus, TxStatus, type WalletAsset, type WalletAssetDetail, type WalletAssetNetwork, type WalletByWorkspaceResponse, WalletCreationStatus, type WalletCreationStatusResponse, type WalletDetail, WalletPurpose, type WalletResponse, WalletRole, WalletType, type WebhookEvent, WebhookService, createAPI, get, post, transformCreateWalletPayload, transformRescanTransactionParams, 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 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 };

package/dist/index.esm.d.ts

@@ -22,6 +22,8 @@ interface APIEndpoints {
     getWalletAssets: (walletId: string) => string;
     getDepositAddress: (walletId: string, addressType: string) => string;
     rescanTransaction: () => string;
+    requestWithdrawal: (walletId: string) => string;
+    getWebhookPublicKey: (workspaceId: string) => string;
 }
 interface APIConfig {
     baseURL: string;
@@ -319,6 +321,15 @@ declare enum WalletRole {
     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;
@@ -361,9 +372,9 @@ declare class APIService {
     constructor(credentials: APICredentials, environment: Environment);
     getWallets(workspaceId: string): Promise<WalletByWorkspaceResponse[]>;
     getWalletDetail(addressType?: AddressType, walletId?: string): Promise<WalletDetail>;
-    requestSign(walletId: string, params: SignRequestParams): Promise<SignResponse>;
+    requestSign(walletId: string, params: SignRequestParams, options?: Record<string, string>): Promise<SignResponse>;
     getSignStatus(walletId: string, transactionId: string): Promise<SignatureStatusResponse>;
-    signTransaction(walletId: string, body: Record<string, any>): Promise<SignResponse>;
+    signTransaction(walletId: string, body: Record<string, any>, options?: Record<string, string>): Promise<SignResponse>;
     getTransactionStatus(walletId: string, transactionId: string): Promise<TransactionStatusResponse>;
     createWallet(payload: CreateWalletPayload): Promise<CreateWalletResponse>;
     createCheckout(payload: CreateCheckoutPayload): Promise<CreateCheckoutResponse>;
@@ -382,6 +393,19 @@ declare class APIService {
      * @returns API response
      */
     rescanTransaction(params: RescanTransactionParams): Promise<void>;
+    /**
+     * Requests a withdrawal from a wallet
+     * @param walletId The wallet ID
+     * @param params Withdrawal parameters
+     * @returns Withdrawal response with auto_approved status and withdrawal details
+     */
+    requestWithdrawal(walletId: string, params: RequestWithdrawalParams): Promise<RequestWithdrawalResponse>;
+    /**
+     * Gets the webhook public key for a workspace
+     * @param workspaceId The workspace ID
+     * @returns Webhook public key response with base64 encoded ed25519 public key
+     */
+    getWebhookPublicKey(workspaceId: string): Promise<WebhookPublicKeyResponse>;
 }
 declare class PaymentService {
     private apiKey;
@@ -415,6 +439,13 @@ declare function transformRescanTransactionParams(data: RescanTransactionParams)
     tx_hash: string;
     network_id: string;
 };
+declare function transformRequestWithdrawalParams(data: RequestWithdrawalParams): {
+    skip_balance_check?: boolean | undefined;
+    notes?: string | undefined;
+    asset_id: string;
+    amount: string;
+    recipient_address: string;
+};
 
 declare class TransactionError extends Error {
     readonly code: string;
@@ -555,6 +586,57 @@ interface WalletByWorkspaceResponse {
     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 SDKOptions {
     credentials: APICredentials;
@@ -611,6 +693,19 @@ declare class FystackSDK {
      * @returns Promise that resolves when the rescan is initiated
      */
     rescanTransaction(params: RescanTransactionParams): Promise<void>;
+    /**
+     * Requests a withdrawal from a wallet
+     * @param walletId The ID of the wallet to withdraw from
+     * @param params Withdrawal parameters including asset, amount, and recipient
+     * @returns Promise with withdrawal response including auto_approved status and withdrawal details
+     */
+    requestWithdrawal(walletId: string, params: RequestWithdrawalParams): Promise<RequestWithdrawalResponse>;
+    /**
+     * Gets the webhook public key for a workspace
+     * @param workspaceId The workspace ID
+     * @returns Promise with webhook public key (base64 encoded ed25519 public key)
+     */
+    getWebhookPublicKey(workspaceId: string): Promise<WebhookPublicKeyResponse>;
 }
 
 interface StatusPollerOptions {
@@ -646,10 +741,18 @@ declare class EtherSigner extends AbstractSigner {
     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>;
+    signTransaction(tx: TransactionRequest, options?: {
+        idempotencyKey?: string;
+    }): Promise<string>;
+    sendTransaction(tx: TransactionRequest, options?: {
+        idempotencyKey?: string;
+    }): Promise<TransactionResponse>;
+    signMessage(message: string | Uint8Array, options?: {
+        idempotencyKey?: string;
+    }): Promise<string>;
+    signTypedData(domain: TypedDataDomain, types: Record<string, Array<TypedDataField>>, value: Record<string, any>, options?: {
+        idempotencyKey?: string;
+    }): Promise<string>;
 }
 
 declare class SolanaSigner {
@@ -668,28 +771,36 @@ declare class SolanaSigner {
      * @param transaction Base64 encoded serialized transaction
      * @returns Signature as a base58 encoded string
      */
-    signTransaction(transaction: string): Promise<string>;
+    signTransaction(transaction: string, options?: {
+        idempotencyKey?: 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>;
+    signMessage(message: string | Uint8Array, options?: {
+        idempotencyKey?: string;
+    }): Promise<string>;
     /**
      * Signs and sends a Solana transaction
      * @param transaction Base64 encoded serialized transaction
      * @returns Transaction signature
      */
-    signAndSendTransaction(transaction: string): Promise<string>;
+    signAndSendTransaction(transaction: string, options?: {
+        idempotencyKey?: 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<{
+    signAllTransactions(transactions: string[], options?: {
+        idempotencyKey?: 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, 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, type TopAssets, TransactionError, type TransactionStatusResponse, TxApprovalStatus, TxStatus, type WalletAsset, type WalletAssetDetail, type WalletAssetNetwork, type WalletByWorkspaceResponse, WalletCreationStatus, type WalletCreationStatusResponse, type WalletDetail, WalletPurpose, type WalletResponse, WalletRole, WalletType, type WebhookEvent, WebhookService, createAPI, get, post, transformCreateWalletPayload, transformRescanTransactionParams, 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 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 };