createSession method that can be used to create a session key for the connected Abstract Global Wallet.
Usage
// This example demonstrates how to create a session key for NFT minting on a specific contract.
// The session key:
// - Can only call the mint function on the specified NFT contract
// - Has a lifetime gas fee limit of 1 ETH
// - Expires after 24 hours
import { useAbstractClient } from "@abstract-foundation/agw-react";
import { LimitType } from "@abstract-foundation/agw-client/sessions";
import { toFunctionSelector, parseEther } from "viem";
import { privateKeyToAccount, generatePrivateKey } from "viem/accounts";
// Generate a new session key pair
const sessionPrivateKey = generatePrivateKey();
const sessionSigner = privateKeyToAccount(sessionPrivateKey);
export default function CreateSession() {
const { data: agwClient } = useAbstractClient();
async function createSession() {
if (!agwClient) return;
const { session } = await agwClient.createSession({
session: {
signer: sessionSigner.address,
expiresAt: BigInt(Math.floor(Date.now() / 1000) + 60 * 60 * 24),
feeLimit: {
limitType: LimitType.Lifetime,
limit: parseEther("1"),
period: BigInt(0),
},
callPolicies: [
{
target: "0xC4822AbB9F05646A9Ce44EFa6dDcda0Bf45595AA", // NFT contract
selector: toFunctionSelector("mint(address,uint256)"),
valueLimit: {
limitType: LimitType.Unlimited,
limit: BigInt(0),
period: BigInt(0),
},
maxValuePerUse: BigInt(0),
constraints: [],
}
],
transferPolicies: [],
},
});
}
}
// This example shows how to create a session key that can only transfer ETH to specific addresses.
// It sets up two recipients with different limits: one with a daily allowance,
// and another with a lifetime limit on total transfers.
import { useAbstractClient } from "@abstract-foundation/agw-react";
import { LimitType } from "@abstract-foundation/agw-client/sessions";
import { parseEther } from "viem";
import { privateKeyToAccount, generatePrivateKey } from "viem/accounts";
// Generate a new session key pair
const sessionPrivateKey = generatePrivateKey();
const sessionSigner = privateKeyToAccount(sessionPrivateKey);
export default function CreateSession() {
const { data: agwClient } = useAbstractClient();
async function createSession() {
if (!agwClient) return;
const { session } = await agwClient.createSession({
session: {
signer: sessionSigner.address,
expiresAt: BigInt(Math.floor(Date.now() / 1000) + 60 * 60 * 24 * 7), // 1 week
feeLimit: {
limitType: LimitType.Lifetime,
limit: parseEther("0.1"),
period: BigInt(0),
},
callPolicies: [],
transferPolicies: [
{
target: "0x1234567890123456789012345678901234567890", // Allowed recipient 1
maxValuePerUse: parseEther("0.1"), // Max 0.1 ETH per transfer
valueLimit: {
limitType: LimitType.Allowance,
limit: parseEther("1"), // Max 1 ETH per day
period: BigInt(60 * 60 * 24), // 24 hours
},
},
{
target: "0x9876543210987654321098765432109876543210", // Allowed recipient 2
maxValuePerUse: parseEther("0.5"), // Max 0.5 ETH per transfer
valueLimit: {
limitType: LimitType.Lifetime,
limit: parseEther("2"), // Max 2 ETH total
period: BigInt(0),
},
}
],
},
});
}
}
Parameters
Configuration for the session key, including:
Show Session Config Fields
Show Session Config Fields
Maximum gas fees that can be spent using this session key.
Show Limit Type
Show Limit Type
The type of limit to apply:
LimitType.Unlimited(0): No limitLimitType.Lifetime(1): Total limit over the session lifetimeLimitType.Allowance(2): Limit per time period
Array of policies defining which contract functions can be called.
Show CallPolicy Type
Show CallPolicy Type
Array of constraints on function parameters.
Show Constraint Type
Show Constraint Type