Class Delegatee

Readonly litNetwork

disconnect

• disconnect(): void

• Disconnects the Lit node client.

  Returns void

executeTool

• executeTool(params): Promise<ExecuteJsResponse>

• Executes a tool with the provided parameters.

  Parameters

  • params: Omit<JsonExecutionSdkParams, "sessionSigs">

    The parameters for tool execution, excluding session signatures.

  Returns Promise<ExecuteJsResponse>

  A promise that resolves to the tool execution response.

  Throws

  If the execution fails or if the delegatee is not properly initialized.

getCredentials

• getCredentials<T>(requiredCredentialNames): Promise<{
      foundCredentials: Partial<CredentialsFor<T>>;
      missingCredentials: string[];
  }>

• Retrieves stored credentials required by a tool.

  Type Parameters

  • T

  Parameters

  • requiredCredentialNames: readonly string[]

    Names of the required credentials.

  Returns Promise<{
      foundCredentials: Partial<CredentialsFor<T>>;
      missingCredentials: string[];
  }>

  Object containing found credentials and list of any missing credentials.

getDelegatedPkps

• getDelegatedPkps(): Promise<DelegatedPkpInfo[]>

• Retrieves all delegated PKPs (Programmable Key Pairs) for the Delegatee.

  Returns Promise<DelegatedPkpInfo[]>

  A promise that resolves to an array of DelegatedPkpInfo objects.

  Throws

  If the tool policy registry contract, delegatee wallet, or Lit contracts are not initialized.

getPermittedToolsForPkp

• getPermittedToolsForPkp(pkpTokenId): Promise<PermittedToolsResult>

• Get all registered tools and categorize them based on whether they have policies

  Parameters

  • pkpTokenId: string

  Returns Promise<PermittedToolsResult>

  Object containing:

  • toolsWithPolicies: Object mapping tool IPFS CIDs to their metadata and delegatee policies
  • toolsWithoutPolicies: Array of tools that don't have policies
  • toolsUnknownWithPolicies: Object mapping unknown tool IPFS CIDs to their delegatee policies
  • toolsUnknownWithoutPolicies: Array of tool CIDs without policies that aren't in the registry

getToolPolicy

• getToolPolicy(pkpTokenId, ipfsCid): Promise<any>

• Retrieves the policy for a specific tool.

  Parameters

  • pkpTokenId: string

    The token ID of the PKP.
  • ipfsCid: string

    The IPFS CID of the tool.

  Returns Promise<any>

  An object containing the policy and version for the tool.

  Throws

  If the tool policy registry contract is not initialized.

getToolViaIntent

• getToolViaIntent(pkpTokenId, intent, intentMatcher): Promise<IntentMatcherResponse<any>>

• Matches a user's intent to an appropriate permitted tool.

  Parameters

  • pkpTokenId: string

    The token ID of the PKP.
  • intent: string

    The user's intent string.
  • intentMatcher: IntentMatcher

    The intent matcher implementation to use.

  Returns Promise<IntentMatcherResponse<any>>

  A promise that resolves to the matched tool and any extracted parameters.

  Throws

  If no matching tool is found or if the tool is not permitted.

setCredentials

• setCredentials<T>(credentials): Promise<void>

• Stores credentials for future tool executions.

  Type Parameters

  • T

  Parameters

  • credentials: Partial<CredentialsFor<T>>

    Object containing credential key-value pairs to store.

  Returns Promise<void>

  Throws

  If any credential value is not a string.

Static create

• create(delegateePrivateKey?, agentConfig?): Promise<Delegatee>

• Creates an instance of the Delegatee class. Initializes the Lit node client, contracts, and capacity credit.

  Parameters

  • Optional delegateePrivateKey: string

    Optional. The private key for the Delegatee role.
  • agentConfig: AgentConfig = {}

    Configuration for the agent, including the Lit network and debug mode.

  Returns Promise<Delegatee>

  A promise that resolves to an instance of the Delegatee class.

  Throws

  If the Lit network is not provided or the private key is missing.