@faktoryfun/styx-sdk/dist/esm/index.d.ts

Bitcoin deposit SDK for Stacks applications, enabling trustless Bitcoin-to-sBTC deposits

import type { FeeEstimates, DepositCreateParams, DepositUpdateParams, TransactionPrepareParams, PreparedTransactionData, ExecuteTransactionResponse } from "./types";
export declare class StyxSDK {
    private api;
    constructor(baseUrl?: string, apiKey?: string);
    getFeeEstimates(): Promise<FeeEstimates>;
    updateDeposit(data: DepositUpdateParams): Promise<any>;
    getDepositHistory(userAddress: string): Promise<any[]>;
    getAllDepositsHistory(): Promise<any[]>;
    prepareTransaction(params: TransactionPrepareParams): Promise<any>;
    createDeposit(params: DepositCreateParams): Promise<string>;
    updateDepositStatus(params: {
        id: string;
        data: {
            btcTxId?: string;
            status: "initiated" | "broadcast" | "processing" | "confirmed" | "refund-requested" | "canceled";
        };
    }): Promise<any>;
    executeTransaction(params: {
        depositId: string;
        preparedData: PreparedTransactionData;
        walletProvider: "leather" | "xverse";
        btcAddress: string;
    }): Promise<ExecuteTransactionResponse>;
}
export declare const styxSDK: StyxSDK;
export default styxSDK;
export type { FeeEstimates, DepositCreateParams, DepositUpdateParams, TransactionPrepareParams, };
export * from "./types";
export * from "./constants";