@base-org/account/dist/interface/payment/prepareRevoke.d.ts

Base Account SDK

import type { PrepareRevokeOptions, PrepareRevokeResult } from './types.js';
/**
 * Prepares call data for revoking a subscription.
 *
 * This function fetches the subscription (spend permission) details using its ID (permission hash)
 * and prepares the necessary call data to revoke the subscription. It wraps the lower-level
 * prepareRevokeCallData function with subscription-specific logic.
 *
 * The resulting call data includes the encoded transaction to revoke the spend permission.
 *
 * @param options - Options for preparing the revoke
 * @param options.id - The subscription ID (permission hash) returned from subscribe()
 * @param options.testnet - Whether this permission is on testnet (Base Sepolia). Defaults to false (mainnet)
 * @returns Promise<PrepareRevokeResult> - Call data for the revoke
 * @throws Error if the subscription cannot be found
 *
 * @example
 * ```typescript
 * import { base } from '@base-org/account/payment';
 *
 * // Prepare to revoke a subscription
 * const revokeCall = await base.subscription.prepareRevoke({
 *   id: '0x71319cd488f8e4f24687711ec5c95d9e0c1bacbf5c1064942937eba4c7cf2984',
 *   testnet: false
 * });
 *
 * // Send the call using your app's subscription owner account
 * await provider.request({
 *   method: 'wallet_sendCalls',
 *   params: [{
 *     version: '2.0.0',
 *     from: subscriptionOwner, // Must be the spender/subscription owner!
 *     chainId: testnet ? '0x14a34' : '0x2105',
 *     calls: [revokeCall],
 *   }],
 * });
 * ```
 */
export declare function prepareRevoke(options: PrepareRevokeOptions): Promise<PrepareRevokeResult>;
//# sourceMappingURL=prepareRevoke.d.ts.map