@safe-global/relay-kit/dist/src/RelayKitBasePack.d.ts

SDK for Safe Smart Accounts with support for ERC-4337 and Relay

import Safe from '@safe-global/protocol-kit';
type RelayKitBasePackTypes = {
    EstimateFeeProps?: unknown;
    EstimateFeeResult?: unknown;
    CreateTransactionProps?: unknown;
    CreateTransactionResult: unknown;
    ExecuteTransactionProps: {
        executable: RelayKitBasePackTypes['CreateTransactionResult'];
        [key: string]: unknown;
    };
    ExecuteTransactionResult?: unknown;
};
type DefaultRelayKitBasePackTypes = {
    CreateTransactionResult: unknown;
    ExecuteTransactionProps: {
        executable: DefaultRelayKitBasePackTypes['CreateTransactionResult'];
        [key: string]: unknown;
    };
};
/**
 * Abstract class. The base class for all RelayKit packs.
 * It provides the Safe SDK instance and the abstract methods to be implemented by the packs.
 * @abstract
 * @template EstimateFeeProps
 * @template EstimateFeeResult
 * @template CreateTransactionProps
 * @template CreateTransactionResult,
 * @template ExecuteTransactionProps
 * @template ExecuteTransactionResult
 */
export declare abstract class RelayKitBasePack<T extends RelayKitBasePackTypes = DefaultRelayKitBasePackTypes> {
    /**
     * @type {Safe}
     */
    protocolKit: Safe;
    /**
     * Creates a new RelayKitBasePack instance.
     * The packs implemented using our SDK should extend this class and therefore provide a Safe SDK instance
     * @param {Safe} protocolKit - The Safe SDK instance
     */
    constructor(protocolKit: Safe);
    /**
     * Abstract function to get an estimate of the fee that will be paid for a transaction.
     * @abstract
     * @param {EstimateFeeProps} props - The props for fee estimation.
     * @returns Promise<EstimateFeeResult> - The estimated fee result.
     */
    abstract getEstimateFee(props: T['EstimateFeeProps']): Promise<T['EstimateFeeResult']>;
    /**
     * Abstract function to create a Safe transaction, designed to be executed using the relayer.
     * @abstract
     * @param {CreateTransactionProps} props - The props for transaction creation.
     * @returns Promise<CreateTransactionResult> - The output of the created transaction.
     */
    abstract createTransaction(props: T['CreateTransactionProps']): Promise<T['CreateTransactionResult']>;
    /**
     * Abstract function to execute a Safe transaction using a relayer.
     * @abstract
     * @param {ExecuteTransactionProps} props - The props for transaction execution.
     * @returns {Promise<ExecuteTransactionResult>} - Relay's response after executing the transaction.
     */
    abstract executeTransaction(props: T['ExecuteTransactionProps']): Promise<T['ExecuteTransactionResult']>;
}
export {};
//# sourceMappingURL=RelayKitBasePack.d.ts.map