@wuwei-labs/srsly/dist/types/instructions/closeBorrower.d.ts

TypeScript SDK for SRSLY

/**
 * @purpose Simplified closeBorrower instruction wrapper
 *
 * Thin convenience wrapper around Codama-generated closeBorrower instruction.
 * Closes a borrower's managed token account and BorrowerState.
 * Borrower-only — only the borrower may authorize the close (and pays
 * the transaction fee).
 */
import { type SdkConfig } from '../utils/config';
import { type UniversalSigner } from '../utils/signer';
import { prepareInstructions } from '../utils/instructions';
/**
 * Parameters for closing a borrower account
 */
export interface CloseBorrowerParams {
    /**
     * Borrower wallet — sole signer. Authorizes the close, pays the
     * transaction fee, and receives all reclaimed rent.
     * Accepts string address, web3.js Keypair, or @solana/kit signer.
     */
    borrower: UniversalSigner;
    /**
     * Sets compute units to allocate for the transaction.
     * @example 200000
     */
    computeUnits?: number;
}
/**
 * Close a borrower's managed ATA + BorrowerState PDA, refunding rent to
 * the borrower wallet. Borrower-only — call `claimBorrower` first to
 * sweep any remaining ATLAS.
 *
 * @param params - Close borrower parameters
 * @param config - Optional SDK configuration overrides
 * @returns Kit instruction (or web3.js if PublicKey in config)
 *
 * @example
 * ```typescript
 * const ix = await closeBorrower({ borrower: borrowerWallet });
 * ```
 */
export declare function closeBorrower(params: CloseBorrowerParams, config?: Partial<SdkConfig>): Promise<ReturnType<typeof prepareInstructions>>;
//# sourceMappingURL=closeBorrower.d.ts.map