@wuwei-labs/srsly
Version:
TypeScript SDK for SRSLY
53 lines • 2.02 kB
TypeScript
/**
* @purpose Simplified updateContractThread instruction wrapper
*
* Thin convenience wrapper around Codama-generated updateContractThread instruction.
* Funds additional lamports and/or updates the payment frequency for a contract thread.
*/
import { type Address } from '@solana/kit';
import { type SdkConfig } from '../utils/config';
import { type UniversalSigner } from '../utils/signer';
import { prepareInstructions } from '../utils/instructions';
import { type ScheduleParam } from '../params/schedule';
import { type SolParam } from '../params/sol';
/**
* Parameters for updating a contract automation thread
*/
export interface UpdateContractThreadParams {
/**
* Contract owner (payer for additional lamports)
* Accepts string address, web3.js Keypair, or @solana/kit signer
*/
owner: UniversalSigner;
/** Contract address whose thread to update */
contract: Address | string;
/**
* Additional SOL to top up the thread with.
* Accepts a plain number / bigint (lamports), `{ sol: number }`, or
* `{ lamports: number | bigint }`.
* @example { sol: 0.05 } // top up by 0.05 SOL
* @example { lamports: 50_000_000 }
* @default
* ```ts
* 0 // no additional funding
* ```
*/
lamports?: SolParam;
/** Optional new payment frequency (cron expression or named schedule) */
paymentsFreq?: ScheduleParam;
/**
* Sets compute units to allocate for the transaction.
* @example 400000
*/
computeUnits?: number;
}
/**
* Top up a contract thread's lamports balance and (optionally)
* reschedule its payment frequency.
*
* @param params - Thread update parameters
* @param config - Optional SDK configuration overrides
* @returns Kit instruction (or web3.js if PublicKey in config)
*/
export declare function updateContractThread(params: UpdateContractThreadParams, config?: Partial<SdkConfig>): Promise<ReturnType<typeof prepareInstructions>>;
//# sourceMappingURL=updateContractThread.d.ts.map