Getting started with Session Keys

1
import { modularAccountClient } from "./client";
2
import { sessionKeyPluginActions } from "@account-kit/smart-contracts";
3
4
const extendedClient = modularAccountClient.extend(sessionKeyPluginActions);

1
import { modularAccountClient } from "./client.js";
2
import {
3
  accountLoupeActions,
4
  multiOwnerPluginActions,
5
  sessionKeyPluginActions,
6
  pluginManagerActions,
7
} from "@account-kit/smart-contracts";
8
9
const extendedClient = modularAccountClient.extend(sessionKeyPluginActions);
10
11
//---cut---
12
13
import { SessionKeyPlugin } from "@account-kit/smart-contracts";
14
15
// 1. check if the plugin is installed
16
const isPluginInstalled = await modularAccountClient
17
  .getInstalledPlugins({})
18
  // This checks using the default address for the chain, but you can always pass in your own plugin address here as an override
19
  .then((x) => x.includes(SessionKeyPlugin.meta.addresses[chain.id]));

1
import { modularAccountClient } from "./client";
2
import {
3
  accountLoupeActions,
4
  multiOwnerPluginActions,
5
  sessionKeyPluginActions,
6
  pluginManagerActions,
7
} from "@account-kit/smart-contracts";
8
9
const extendedClient = modularAccountClient.extend(sessionKeyPluginActions);
10
11
import { SessionKeyPlugin } from "@account-kit/smart-contracts";
12
13
// 1. check if the plugin is installed
14
const isPluginInstalled = await extendedClient
15
  .getInstalledPlugins({})
16
  // This checks using the default address for the chain, but you can always pass in your own plugin address here as an override
17
  .then((x) => x.includes(SessionKeyPlugin.meta.addresses[chain.id]));
18
19
//---cut---
20
import { SessionKeyPermissionsBuilder } from "@account-kit/smart-contracts";
21
22
// 2. if the plugin is not installed, then install it and set up the session key
23
if (!isPluginInstalled) {
24
  // lets create an initial permission set for the session key giving it an eth spend limit
25
  // if we don't set anything here, then the key will have 0 permissions
26
  const initialPermissions =
27
    new SessionKeyPermissionsBuilder().setNativeTokenSpendLimit({
28
      spendLimit: 1000000n,
29
    });
30
31
  const { hash } = await extendedClient.installSessionKeyPlugin({
32
    // 1st arg is the initial set of session keys
33
    // 2nd arg is the tags for the session keys
34
    // 3rd arg is the initial set of permissions
35
    args: [
36
      [await sessionKeySigner.getAddress()],
37
      [zeroHash],
38
      [initialPermissions.encode()],
39
    ],
40
  });
41
42
  await extendedClient.waitForUserOperationTransaction({ hash });
43
}

1
import { modularAccountClient } from "./client";
2
import {
3
  accountLoupeActions,
4
  multiOwnerPluginActions,
5
  sessionKeyPluginActions,
6
  pluginManagerActions,
7
} from "@account-kit/smart-contracts";
8
9
const extendedClient = modularAccountClient.extend(sessionKeyPluginActions);
10
11
// ---cut---
12
import { SessionKeyPermissionsBuilder } from "@account-kit/smart-contracts";
13
14
const initialPermissions =
15
  new SessionKeyPermissionsBuilder().setNativeTokenSpendLimit({
16
    spendLimit: 1000000n,
17
  });
18
19
const result = await extendedClient.updateKeyPermissions({
20
  args: [sessionKeyAddress, initialPermissions.encode()],
21
});

1
import { SessionKeyPermissionsBuilder } from "@account-kit/smart-contracts";
2
import { keccak256 } from "viem";
3
import { client } from "./base-client";
4
5
const result = await client.addSessionKey({
6
  key: "0xSessionKeyAddress",
7
  // tag is an identifier for the emitted SessionKeyAdded event
8
  tag: keccak256(new TextEncoder().encode("session-key-tag")),
9
  permissions: new SessionKeyPermissionsBuilder().encode(),
10
});

1
import { client } from "./base-client";
2
3
const result = await client.removeSessionKey({
4
  key: "0xSessionKeyAddress",
5
});

1
import { SessionKeyPermissionsBuilder } from "@account-kit/smart-contracts";
2
import { client } from "./base-client";
3
4
const result = await client.updateSessionKeyPermissions({
5
  key: "0xSessionKeyAddress",
6
  // add other permissions to the builder
7
  permissions: new SessionKeyPermissionsBuilder()
8
    .setTimeRange({
9
      validFrom: Math.round(Date.now() / 1000),
10
      // valid for 1 hour
11
      validUntil: Math.round(Date.now() / 1000 + 60 * 60),
12
    })
13
    .encode(),
14
});

1
import { client } from "./base-client.js";
2
3
const result = await client.rotateSessionKey({
4
  oldKey: "0xOldKey",
5
  newKey: "0xNewKey",
6
});