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

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

import type { FeeEstimates, DepositCreateParams, DepositUpdateParams, TransactionPrepareParams, PreparedTransactionData, ExecuteTransactionResponse, PoolStatus, Deposit, DepositHistoryResponse, DepositStatusUpdateParams, NetworkType, AIBTCDepositCreateParams, PoolConfig, AllowlistedPair } from "./types";
export declare class StyxSDK {
    private api;
    private network;
    constructor(baseUrl?: string, apiKey?: string, network?: NetworkType);
    getCurrentNetwork(): NetworkType;
    getFeeEstimates(): Promise<FeeEstimates>;
    updateDeposit(data: DepositUpdateParams): Promise<Deposit>;
    getDepositHistory(userAddress: string): Promise<Deposit[]>;
    getAllDepositsHistory(poolId?: string): Promise<DepositHistoryResponse>;
    prepareTransaction(params: TransactionPrepareParams): Promise<PreparedTransactionData>;
    createDeposit(params: DepositCreateParams): Promise<string>;
    updateDepositStatus(params: DepositStatusUpdateParams): Promise<Deposit>;
    executeTransaction(params: {
        depositId: string;
        preparedData: PreparedTransactionData;
        walletProvider: "leather" | "xverse";
        btcAddress: string;
    }): Promise<ExecuteTransactionResponse>;
    getPoolStatus(poolId?: string): Promise<PoolStatus>;
    getBTCPrice(): Promise<number | null>;
    getDepositStatus(depositId: string): Promise<Deposit>;
    getDepositStatusByTxId(btcTxId: string): Promise<Deposit>;
    getAvailablePools(): Promise<PoolConfig[]>;
    createAIBTCDeposit(data: Omit<AIBTCDepositCreateParams, "poolId">): Promise<string>;
    getAllowlistedPairs(poolId?: string): Promise<AllowlistedPair[]>;
    areSwapsPaused(poolId?: string): Promise<boolean>;
    isDexPairAllowed(ftContract: string, dexContract: string, poolId?: string): Promise<boolean>;
}
declare const sdk: StyxSDK;
export declare const styxSDK: StyxSDK;
export default sdk;
export declare const mainnetStyxSDK: StyxSDK;
export declare const testnetStyxSDK: StyxSDK;
export declare const regtestStyxSDK: StyxSDK;
export type { FeeEstimates, DepositCreateParams, DepositUpdateParams, TransactionPrepareParams, PoolStatus, Deposit, PreparedTransactionData, ExecuteTransactionResponse, DepositHistoryResponse, DepositStatusUpdateParams, NetworkType, AIBTCDepositCreateParams, PoolConfig, AllowlistedPair, };
export * from "./types";
export * from "./constants";
export { BitcoinDepositAPI } from "./api";