@biconomy/sdk
Version:
SDK for Biconomy integration with support for account abstraction, smart accounts, ERC-4337.
120 lines • 4.49 kB
JavaScript
import { encodeFunctionData, getAddress } from "viem";
import { sendUserOperation } from "viem/account-abstraction";
import { getAction, parseAccount } from "viem/utils";
import { AccountNotFoundError } from "../../../account/utils/AccountNotFound.js";
import { addressEquals } from "../../../account/utils/Utils.js";
import { SMART_SESSIONS_ADDRESS, findTrustedAttesters, getTrustAttestersAction } from "../../../constants/index.js";
import { parseModuleTypeId } from "./supportsModule.js";
/**
* Installs a module on a given smart account.
*
* @param client - The client instance.
* @param parameters - Parameters including the smart account, module to install, and optional gas settings.
* @returns The hash of the user operation as a hexadecimal string.
* @throws {AccountNotFoundError} If the account is not found.
*
* @example
* import { installModule } from '@biconomy/sdk'
*
* const userOpHash = await installModule(nexusClient, {
* module: {
* type: 'executor',
* address: '0x...',
* context: '0x'
* }
* })
* console.log(userOpHash) // '0x...'
*/
export async function installModule(client, parameters) {
const { account: account_ = client.account, maxFeePerGas, maxPriorityFeePerGas, nonce, module: { address, initData, type } } = parameters;
if (!account_) {
throw new AccountNotFoundError({
docsPath: "/nexus-client/methods#sendtransaction"
});
}
const account = parseAccount(account_);
const calls = [
{
to: account.address,
value: BigInt(0),
data: encodeFunctionData({
abi: [
{
name: "installModule",
type: "function",
stateMutability: "nonpayable",
inputs: [
{
type: "uint256",
name: "moduleTypeId"
},
{
type: "address",
name: "module"
},
{
type: "bytes",
name: "initData"
}
],
outputs: []
}
],
functionName: "installModule",
args: [parseModuleTypeId(type), getAddress(address), initData ?? "0x"]
})
}
];
if (addressEquals(address, SMART_SESSIONS_ADDRESS)) {
const nexusAccount = account;
if (nexusAccount?.validatorAddress) {
calls.push({
to: nexusAccount.validatorAddress,
value: BigInt(0),
data: encodeFunctionData({
abi: [
{
name: "addSafeSender",
type: "function",
stateMutability: "nonpayable",
inputs: [
{
type: "address",
name: "sender"
}
],
outputs: []
}
],
functionName: "addSafeSender",
args: [address]
})
});
}
const publicClient = account?.client;
const trustedAttesters = await findTrustedAttesters({
client: publicClient,
accountAddress: account.address
});
const needToAddTrustAttesters = trustedAttesters.length === 0;
if (needToAddTrustAttesters && nexusAccount?.attesters?.length) {
const trustAttestersAction = getTrustAttestersAction({
attesters: nexusAccount.attesters,
threshold: 1
});
calls.push({
to: trustAttestersAction.target,
value: trustAttestersAction.value.valueOf(),
data: trustAttestersAction.callData
});
}
}
return getAction(client, sendUserOperation, "sendUserOperation")({
calls,
maxFeePerGas,
maxPriorityFeePerGas,
nonce,
account
});
}
//# sourceMappingURL=installModule.js.map