SessionKeyPermissionsBuilder

Defined in: account-kit/smart-contracts/dist/types/src/msca/plugins/session-key/permissions.d.ts:37

A builder for creating the hex-encoded data for updating session key permissions.

Constructors

Constructor

1
new SessionKeyPermissionsBuilder(): SessionKeyPermissionsBuilder;

Returns

SessionKeyPermissionsBuilder

Methods

addContractAddressAccessEntry()

1
addContractAddressAccessEntry(entry): this;

Defined in: account-kit/smart-contracts/dist/types/src/msca/plugins/session-key/permissions.d.ts:79

Adds a contract access entry to the internal list of contract address access entries.

Example

1
import { SessionKeyPermissionsBuilder } from "@account-kit/smart-contracts";
2
3
const builder = new SessionKeyPermissionsBuilder();
4
builder.addContractAddressAccessEntry({
5
  contractAddress: "0x1234",
6
  isOnList: true,
7
  checkSelectors: true,
8
});

Parameters

Returns

this

the instance of the current class for chaining

addContractFunctionAccessEntry()

1
addContractFunctionAccessEntry(entry): this;

Defined in: account-kit/smart-contracts/dist/types/src/msca/plugins/session-key/permissions.d.ts:98

Adds a contract method entry to the _contractMethodAccessEntrys array.

Example

1
import { SessionKeyPermissionsBuilder } from "@account-kit/smart-contracts";
2
3
const builder = new SessionKeyPermissionsBuilder();
4
builder.addContractAddressAccessEntry({
5
  contractAddress: "0x1234",
6
  methodSelector: "0x45678",
7
  isOnList: true,
8
});

Parameters

Returns

this

The instance of the class for method chaining

addErc20TokenSpendLimit()

1
addErc20TokenSpendLimit(limit): this;

Defined in: account-kit/smart-contracts/dist/types/src/msca/plugins/session-key/permissions.d.ts:153

Adds an ERC20 token spend limit to the list of limits and returns the updated object.

Example

1
import { SessionKeyPermissionsBuilder } from "@account-kit/smart-contracts";
2
3
const builder = new SessionKeyPermissionsBuilder();
4
builder.addErc20TokenSpendLimit({
5
  tokenAddress: "0x1234",
6
  spendLimit: 1000000000000000000n,
7
  refreshInterval: 3600,
8
});

Parameters

Returns

this

The updated object with the new ERC20 token spend limit

encode()

1
encode(): `0x${string}`[];

Defined in: account-kit/smart-contracts/dist/types/src/msca/plugins/session-key/permissions.d.ts:200

Encodes various function calls into an array of hexadecimal strings based on the provided permissions and limits.

Example

1
import { SessionKeyPermissionsBuilder } from "@account-kit/smart-contracts";
2
3
const builder = new SessionKeyPermissionsBuilder();
4
builder.setRequiredPaymaster("0x1234");
5
const encoded = builder.encode();

Returns

`0x${string}`[]

An array of encoded hexadecimal strings representing the function calls for setting access control, permissions, and limits.

setContractAccessControlType()

1
setContractAccessControlType(aclType): this;

Defined in: account-kit/smart-contracts/dist/types/src/msca/plugins/session-key/permissions.d.ts:60

Sets the access control type for the contract and returns the current instance for method chaining.

Example

1
import { SessionKeyPermissionsBuilder } from "@account-kit/smart-contracts";
2
3
const builder = new SessionKeyPermissionsBuilder();
4
builder.setContractAccessControlType(SessionKeyAccessListType.ALLOWLIST);

Parameters

Returns

this

The current instance for method chaining

setGasSpendLimit()

1
setGasSpendLimit(limit): this;

Defined in: account-kit/smart-contracts/dist/types/src/msca/plugins/session-key/permissions.d.ts:170

Sets the gas spend limit and returns the current instance for method chaining.

Example

1
import { SessionKeyPermissionsBuilder } from "@account-kit/smart-contracts";
2
3
const builder = new SessionKeyPermissionsBuilder();
4
builder.setGasSpendLimit({
5
  spendLimit: 1000000000000000000n,
6
  refreshInterval: 3600,
7
});

Parameters

Returns

this

The current instance for chaining

setNativeTokenSpendLimit()

1
setNativeTokenSpendLimit(limit): this;

Defined in: account-kit/smart-contracts/dist/types/src/msca/plugins/session-key/permissions.d.ts:134

Sets the native token spend limit and returns the instance for chaining.

Example

1
import { SessionKeyPermissionsBuilder } from "@account-kit/smart-contracts";
2
3
const builder = new SessionKeyPermissionsBuilder();
4
builder.setNativeTokenSpendLimit({
5
  spendLimit: 1000000000000000000n,
6
  refreshInterval: 3600,
7
});

Parameters

Returns

this

The instance for chaining

setRequiredPaymaster()

1
setRequiredPaymaster(paymaster): this;

Defined in: account-kit/smart-contracts/dist/types/src/msca/plugins/session-key/permissions.d.ts:185

Sets the required paymaster address.

Example

1
import { SessionKeyPermissionsBuilder } from "@account-kit/smart-contracts";
2
3
const builder = new SessionKeyPermissionsBuilder();
4
builder.setRequiredPaymaster("0x1234");

Parameters

Returns

this

the current instance for method chaining

setTimeRange()

1
setTimeRange(timeRange): this;

Defined in: account-kit/smart-contracts/dist/types/src/msca/plugins/session-key/permissions.d.ts:116

Sets the time range for an object and returns the object itself for chaining.

Example

1
import { SessionKeyPermissionsBuilder } from "@account-kit/smart-contracts";
2
3
const builder = new SessionKeyPermissionsBuilder();
4
builder.setTimeRange({
5
  validFrom: Date.now(),
6
  validUntil: Date.now() + 15 * 60 * 1000,
7
});

Parameters

Returns

this

The current object for method chaining