checkGasSponsorshipEligibility

1
function checkGasSponsorshipEligibility<TTransport, TChain, TAccount, TContext>(
2
  client_,
3
  args,
4
): Promise<
5
  CheckGasSponsorshipEligibilityResult<
6
    TAccount,
7
    GetEntryPointFromAccount<
8
      TAccount,
9
      SmartContractAccount<string, keyof EntryPointRegistryBase<unknown>>
10
    >
11
  >
12
>;

Defined in: aa-sdk/core/src/actions/smartAccount/checkGasSponsorshipEligibility.ts:56

This function verifies the eligibility of the connected account for gas sponsorship concerning the upcoming UserOperation (UO) that is intended to be sent. Internally, this method invokes buildUserOperation, which navigates through the middleware pipeline, including the PaymasterMiddleware. Its purpose is to construct the UO struct meant for transmission to the bundler. Following the construction of the UO struct, this function verifies if the resulting structure contains a non-empty paymasterAndData field. You can utilize this method before sending the user operation to confirm its eligibility for gas sponsorship. Depending on the outcome, it allows you to tailor the user experience accordingly, based on eligibility.

Example

1
import { smartAccountClient } from "./smartAccountClient";
2
// [!code focus:99]
3
const { eligible } = await smartAccountClient.checkGasSponsorshipEligibility({
4
  uo: {
5
    data: "0xCalldata",
6
    target: "0xTarget",
7
    value: 0n,
8
  },
9
});
10
11
console.log(
12
  `User Operation is ${
13
    eligible ? "eligible" : "ineligible"
14
  } for gas sponsorship.`,
15
);

Type Parameters

Parameters

Returns

Promise<CheckGasSponsorshipEligibilityResult<TAccount, GetEntryPointFromAccount<TAccount, SmartContractAccount<string, keyof EntryPointRegistryBase<unknown>>>>>

a Promise containing a boolean indicating if the account is elgibile for sponsorship and the sponsored UO