Grant Permission

The Smart Sessions module provides two key actions when using smartSessionCreateActions: grantPermission and trustAttesters.

Important: The k1Validator module must be the active nexus module for creating smart sessions. This is automatically handled when you extend your client with smartSessionCreateActions.

grantPermission

Creates a new session with specified permissions and rules.

Usage

example.ts

import { usersNexusClient } from "./client"
import { smartSessionCreateActions } from "@biconomy/sdk"
 
const response = await usersNexusClient.grantPermission({
  sessionRequestedInfo: [{
    sessionPublicKey: "0x...",
    actionPoliciesInfo: [{
      contractAddress: "0x...",
      functionSelector: "0x...",
      sudo: true
    }]
  }]
});

Parameters

Note: For a detailed reference of all available configuration options and their types, see the Smart Session Types documentation. This will help you understand how different parameters map to policies and how they can be combined.

import { type Address } from "viem"
 
enum ParamCondition {
  EQUAL = 0,
  GREATER_THAN = 1,
  LESS_THAN = 2,
  GREATER_THAN_OR_EQUAL = 3,
  LESS_THAN_OR_EQUAL = 4,
  NOT_EQUAL = 5
}
 
type Usage = {
  /** Maximum number of times this rule can be used */
  limit: bigint
  /** Current usage count (typically starts at 0) */
  used: bigint
}
 
type Rule = {
  /** Type of comparison to perform */
  condition: ParamCondition
  /** Position of parameter in calldata.
   *
   * Example: transferWithMessage(address to, uint256 amount, string message)...
   * 
   *   const rules = [
   *     { offsetIndex: 0, ... }, // 'to' parameter
   *     { offsetIndex: 1, ... }, // 'amount' parameter
   *     { offsetIndex: 2, ... }  // offset to message data
   *   ]
   */
  offsetIndex: number
  /** Whether to track usage count */
  isLimited: boolean
  /** Value to compare against */
  ref: string | number | bigint
  /** Usage tracking configuration (required if isLimited is true) */
  usage?: Usage
}
 
type ActionPolicy = {
  /** Target contract address */
  contractAddress: Address
  /** Function selector to allow */
  functionSelector: string
  /** Array of validation rules for the function parameters */
  rules: Rule[]
}
 
type SessionConfig = {
  /** Public key for the session */
  sessionPublicKey: string
  /** Array of permission policies */
  actionPoliciesInfo: ActionPolicy[]
}
 
type GrantPermissionParams = {
  /** Array of session configurations */
  sessionRequestedInfo: SessionConfig[]
}

Response

Returns a promise that resolves to a transaction hash.

trustAttesters

Adds trusted attesters for session validation.

Usage

example.ts

import { usersNexusClient } from "./client"
import { smartSessionCreateActions } from "@biconomy/sdk"
import { MOCK_ATTESTER_ADDRESS, REGISTRY_ADDRESS } from "@rhinestone/module-sdk"
 
const response = await usersNexusClient.trustAttesters({
  attesters: [MOCK_ATTESTER_ADDRESS],
  registryAddress: REGISTRY_ADDRESS
});

Parameters

attesters: Array of attester addresses to trust

Response

Returns a promise that resolves to a transaction hash.