Class Admin

The Admin class is responsible for the ownership of the PKP (Programmable Key Pair), the registration and management of tools, policies, and delegatees.

Properties

`Readonly` litNetwork

litNetwork: LitNetwork

Methods

addDelegatee

addDelegatee(pkpTokenId, delegatee): Promise<any>
Adds a delegatee for the PKP.
Parameters
- pkpTokenId: string
- delegatee: string
  The address to add as a delegatee.
Returns Promise<any>
A promise that resolves to the transaction receipt.

Throws
If the tool policy registry contract is not initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:542

disableTool

disableTool(pkpTokenId, toolIpfsCid): Promise<any>
Disables a tool for a given PKP.
Parameters
- pkpTokenId: string
  The token ID of the PKP.
- toolIpfsCid: string
  The IPFS CID of the tool to be disabled.
Returns Promise<any>
A promise that resolves to the transaction receipt.

Throws
If the tool policy registry contract is not initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:414

disableToolPolicyForDelegatee

disableToolPolicyForDelegatee(pkpTokenId, ipfsCid, delegatee): Promise<any>
Disables a policy for a specific tool and delegatee.
Parameters
- pkpTokenId: string
  The PKP token ID.
- ipfsCid: string
  The IPFS CID of the tool.
- delegatee: string
  The address of the delegatee.
Returns Promise<any>
A promise that resolves to the transaction receipt.

Throws
If the tool policy registry contract is not initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:813

disconnect

disconnect(): void
Disconnects the Lit node client.

Returns void
- Defined in packages/aw-signer/src/lib/admin.ts:987

enableTool

enableTool(pkpTokenId, toolIpfsCid): Promise<any>
Enables a tool for a given PKP.
Parameters
- pkpTokenId: string
  The token ID of the PKP.
- toolIpfsCid: string
  The IPFS CID of the tool to be enabled.
Returns Promise<any>
A promise that resolves to the transaction receipt.

Throws
If the tool policy registry contract is not initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:392

enableToolPolicyForDelegatee

enableToolPolicyForDelegatee(pkpTokenId, ipfsCid, delegatee): Promise<any>
Enables a policy for a specific tool and delegatee.
Parameters
- pkpTokenId: string
  The PKP token ID.
- ipfsCid: string
  The IPFS CID of the tool.
- delegatee: string
  The address of the delegatee.
Returns Promise<any>
A promise that resolves to the transaction receipt.

Throws
If the tool policy registry contract is not initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:785

getAllToolPolicyParametersForDelegatee

getAllToolPolicyParametersForDelegatee(pkpTokenId, ipfsCid, delegatee): Promise<any>
Retrieves all policy parameters for a tool and delegatee.
Parameters
- pkpTokenId: string
  The PKP token ID.
- ipfsCid: string
  The IPFS CID of the tool.
- delegatee: string
  The address of the delegatee.
Returns Promise<any>
A promise that resolves to an array of all policy parameter names and values.

Throws
If the tool policy registry contract is not initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:896

getDelegatees

getDelegatees(pkpTokenId): Promise<string[]>
Retrieves all delegatees for the PKP.
Parameters
- pkpTokenId: string
Returns Promise<string[]>
An array of delegatee addresses.

Throws
If the tool policy registry contract is not initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:505

getPermittedToolsForDelegatee

getPermittedToolsForDelegatee(pkpTokenId, delegatee): Promise<ToolInfoWithDelegateePolicy[]>
Gets all tools that are permitted for a specific delegatee.
Parameters
- pkpTokenId: string
  The PKP token ID.
- delegatee: string
  The address of the delegatee.
Returns Promise<ToolInfoWithDelegateePolicy[]>
A promise that resolves to an array of ToolInfoWithDelegateePolicy objects permitted for the delegatee.

Throws
If the tool policy registry contract is not initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:617

getPkpByTokenId

getPkpByTokenId(tokenId): Promise<PkpInfo>
Retrieves a PKP by its token ID.
Parameters
- tokenId: string
  The token ID of the PKP.
Returns Promise<PkpInfo>
A promise that resolves to the PKP metadata.

Throws
If the PKP is not found in storage.
- Defined in packages/aw-signer/src/lib/admin.ts:247

getPkps

getPkps(): Promise<PkpInfo[]>
Retrieves all PKPs stored in the Admin's (local) storage.

Returns Promise<PkpInfo[]>
An array of PKP metadata.
- Defined in packages/aw-signer/src/lib/admin.ts:237

getRegisteredTool

getRegisteredTool(pkpTokenId, toolIpfsCid): Promise<any>
Get a registered tool by its IPFS CID for a given PKP.
Parameters
- pkpTokenId: string
  The token ID of the PKP.
- toolIpfsCid: string
  The IPFS CID of the tool to be retrieved.
Returns Promise<any>
A promise that resolves to the tool information.

Throws
If the tool policy registry contract is not initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:461

getRegisteredToolsAndDelegateesForPkp

getRegisteredToolsAndDelegateesForPkp(pkpTokenId): Promise<RegisteredToolsResult>
Get all registered tools and categorize them based on whether they have policies
Parameters
- pkpTokenId: string
Returns Promise<RegisteredToolsResult>
Object containing
- toolsWithPolicies: Object mapping tool IPFS CIDs to their metadata and delegatee policies
- toolsWithoutPolicies: Object mapping tool IPFS CIDs to their metadata without 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
- Defined in packages/aw-signer/src/lib/admin.ts:484

getToolPolicyForDelegatee

getToolPolicyForDelegatee(pkpTokenId, ipfsCid, delegatee): Promise<{
enabled: boolean;
policyIpfsCid: string;
}>
Retrieves the policy for a specific tool and delegatee.
Parameters
- pkpTokenId: string
  The token ID of the PKP.
- ipfsCid: string
  The IPFS CID of the tool.
- delegatee: string
  The address of the delegatee.
Returns Promise<{
enabled: boolean;
policyIpfsCid: string;
}>
An object containing the policy IPFS CID and enabled status for the tool.

Throws
If the tool policy registry contract is not initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:695

getToolPolicyParameterForDelegatee

getToolPolicyParameterForDelegatee(pkpTokenId, ipfsCid, delegatee, parameterName): Promise<{
name: string;
value: string;
}[]>
Retrieves a specific policy parameter for a tool and delegatee.
Parameters
- pkpTokenId: string
  The PKP token ID.
- ipfsCid: string
  The IPFS CID of the tool.
- delegatee: string
  The address of the delegatee.
- parameterName: string
  The name of the policy parameter.
Returns Promise<{
name: string;
value: string;
}[]>
A promise that resolves to the policy parameter value.

Throws
If the tool policy registry contract is not initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:842

getToolPolicyParametersForDelegatee

getToolPolicyParametersForDelegatee(pkpTokenId, ipfsCid, delegatee, parameterNames): Promise<{
name: string;
value: string;
}[]>
Retrieves multiple policy parameters for a tool and delegatee.
Parameters
- pkpTokenId: string
  The PKP token ID.
- ipfsCid: string
  The IPFS CID of the tool.
- delegatee: string
  The address of the delegatee.
- parameterNames: string[]
  An array of policy parameter names.
Returns Promise<{
name: string;
value: string;
}[]>
A promise that resolves to an array of tuples containing policy parameter names and values.

Throws
If the tool policy registry contract is not initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:865

isDelegatee

isDelegatee(pkpTokenId, delegatee): Promise<any>
Checks if an address is a delegatee for the PKP.
Parameters
- pkpTokenId: string
- delegatee: string
  The address to check.
Returns Promise<any>
A promise that resolves to a boolean indicating whether the address is a delegatee.

Throws
If the tool policy registry contract is not initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:523

isToolPermittedForDelegatee

isToolPermittedForDelegatee(pkpTokenId, toolIpfsCid, delegatee): Promise<{
isEnabled: any;
isPermitted: any;
}>
Checks if a tool is permitted for a specific delegatee.
Parameters
- pkpTokenId: string
  The PKP token ID.
- toolIpfsCid: string
  The IPFS CID of the tool.
- delegatee: string
  The address of the delegatee.
Returns Promise<{
isEnabled: any;
isPermitted: any;
}>
A promise that resolves to an object containing isPermitted and isEnabled.

Throws
If the tool policy registry contract is not initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:587

isToolRegistered

isToolRegistered(pkpTokenId, toolIpfsCid): Promise<{
isEnabled: any;
isRegistered: any;
}>
Checks if a tool is registered for a given PKP.
Parameters
- pkpTokenId: string
  The token ID of the PKP.
- toolIpfsCid: string
  The IPFS CID of the tool to be checked.
Returns Promise<{
isEnabled: any;
isRegistered: any;
}>
A promise that resolves to an object containing:
- isRegistered: boolean indicating if the tool is registered
- isEnabled: boolean indicating if the tool is enabled
Throws
If the tool policy registry contract is not initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:438

mintPkp

mintPkp(): Promise<PkpInfo>
Mints a new PKP and saves the metadata to the Admin's (local) storage.

Returns Promise<PkpInfo>
A promise that resolves to the minted PKP metadata.

Throws
If the PKP minting fails.
- Defined in packages/aw-signer/src/lib/admin.ts:265

permitToolForDelegatee

permitToolForDelegatee(pkpTokenId, toolIpfsCid, delegatee): Promise<any>
Permits a tool for a specific delegatee.
Parameters
- pkpTokenId: string
  The PKP token ID.
- toolIpfsCid: string
  The IPFS CID of the tool.
- delegatee: string
  The address of the delegatee.
Returns Promise<any>
A promise that resolves to the transaction receipt.

Throws
If the tool policy registry contract is not initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:639

registerTool

registerTool(pkpTokenId, ipfsCid, options?): Promise<{
litContractsTxReceipt: ContractReceipt;
toolRegistryContractTxReceipt: any;
}>
Allows a tool to be used with the PKP.
Parameters
- pkpTokenId: string
- ipfsCid: string
  The IPFS CID of the tool.
- options: {
  enableTools?: boolean;
  signingScopes?: AUTH_METHOD_SCOPE_VALUES[];
  } = {}
  - Optional enableTools?: boolean
  - Optional signingScopes?: AUTH_METHOD_SCOPE_VALUES[]
Returns Promise<{
litContractsTxReceipt: ContractReceipt;
toolRegistryContractTxReceipt: any;
}>
A promise that resolves to the transaction receipt.

Throws
If the Admin instance is not properly initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:317

removeDelegatee

removeDelegatee(pkpTokenId, delegatee): Promise<any>
Removes a delegatee for the PKP.
Parameters
- pkpTokenId: string
  The PKP token ID.
- delegatee: string
  The address of the delegatee to remove.
Returns Promise<any>
A promise that resolves to the transaction receipt.

Throws
If the tool policy registry contract is not initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:564

removeTool

removeTool(pkpTokenId, ipfsCid): Promise<{
removeToolsTxReceipt: any;
revokePermittedActionTxReceipt: ContractReceipt;
}>
Removes a tool from the list of a PKP's permitted tools.
Parameters
- pkpTokenId: string
- ipfsCid: string
  The IPFS CID of the tool.
Returns Promise<{
removeToolsTxReceipt: any;
revokePermittedActionTxReceipt: ContractReceipt;
}>
A promise that resolves to the transaction receipt.

Throws
If the Admin instance is not properly initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:359

removeToolPolicyForDelegatee

removeToolPolicyForDelegatee(pkpTokenId, ipfsCid, delegatee): Promise<any>
Removes a policy for a specific tool and delegatee.
Parameters
- pkpTokenId: string
  The PKP token ID.
- ipfsCid: string
  The IPFS CID of the tool.
- delegatee: string
  The address of the delegatee.
Returns Promise<any>
A promise that resolves to the transaction receipt.

Throws
If the tool policy registry contract is not initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:757

removeToolPolicyParametersForDelegatee

removeToolPolicyParametersForDelegatee(pkpTokenId, ipfsCid, delegatee, parameterNames): Promise<any>
Removes multiple policy parameters for a tool and delegatee.
Parameters
- pkpTokenId: string
  The PKP token ID.
- ipfsCid: string
  The IPFS CID of the tool.
- delegatee: string
  The address of the delegatee.
- parameterNames: string[]
  An array of policy parameter names to remove.
Returns Promise<any>
A promise that resolves to the transaction receipt.

Throws
If the tool policy registry contract is not initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:961

setToolPolicyForDelegatee

setToolPolicyForDelegatee(pkpTokenId, ipfsCid, delegatee, policyIpfsCid, enablePolicies): Promise<any>
Sets or updates a policy for a specific tool and delegatee.
Parameters
- pkpTokenId: string
  The token ID of the PKP.
- ipfsCid: string
  The IPFS CID of the tool.
- delegatee: string
  The address of the delegatee.
- policyIpfsCid: string
  The IPFS CID of the policy to be set.
- enablePolicies: boolean
  Whether to enable the policy after setting it.
Returns Promise<any>
A promise that resolves to the transaction receipt.

Throws
If the tool policy registry contract is not initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:725

setToolPolicyParametersForDelegatee

setToolPolicyParametersForDelegatee(pkpTokenId, ipfsCid, delegatee, parameterNames, parameterValues): Promise<any>
Sets multiple policy parameters for a tool and delegatee.
Parameters
- pkpTokenId: string
  The PKP token ID.
- ipfsCid: string
  The IPFS CID of the tool.
- delegatee: string
  The address of the delegatee.
- parameterNames: string[]
  An array of policy parameter names.
- parameterValues: any[]
  An array of policy parameter values.
Returns Promise<any>
A promise that resolves to the transaction receipt.

Throws
If the tool policy registry contract is not initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:927

transferPkpOwnership

transferPkpOwnership(pkpTokenId, newOwner): Promise<ContractReceipt>
Transfers ownership of the PKP to a new owner.
Parameters
- pkpTokenId: string
- newOwner: string
  The address of the new owner.
Returns Promise<ContractReceipt>
A promise that resolves to the transaction receipt.

Throws
If the Admin instance is not properly initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:283

unpermitToolForDelegatee

unpermitToolForDelegatee(pkpTokenId, toolIpfsCid, delegatee): Promise<any>
Unpermits a tool for a specific delegatee.
Parameters
- pkpTokenId: string
  The PKP token ID.
- toolIpfsCid: string
  The IPFS CID of the tool.
- delegatee: string
  The address of the delegatee.
Returns Promise<any>
A promise that resolves to the transaction receipt.

Throws
If the tool policy registry contract is not initialized.
- Defined in packages/aw-signer/src/lib/admin.ts:667

`Static` create

create(adminConfig, agentConfig?): Promise<Admin>
Creates an instance of the Admin class. Initializes the Lit node client, contracts, and PKP.
Parameters
- adminConfig: AdminConfig
  Configuration for the Admin role.
- agentConfig: AgentConfig = {}
  Configuration for the agent, including the Lit network and debug mode.
Returns Promise<Admin>
A promise that resolves to an instance of the Admin class.

Throws
If the Lit network is not provided or the private key is missing.
- Defined in packages/aw-signer/src/lib/admin.ts:164

Class Admin

Index

Properties

Methods

Properties

Readonly litNetwork

Methods

addDelegatee

Parameters

Returns Promise<any>

Throws

disableTool

Parameters

Returns Promise<any>

Throws

disableToolPolicyForDelegatee

Parameters

Returns Promise<any>

Throws

disconnect

Returns void

enableTool

Parameters

Returns Promise<any>

Throws

enableToolPolicyForDelegatee

Parameters

Returns Promise<any>

Throws

getAllToolPolicyParametersForDelegatee

Parameters

Returns Promise<any>

Throws

getDelegatees

Parameters

Returns Promise<string[]>

Throws

getPermittedToolsForDelegatee

Parameters

Returns Promise<ToolInfoWithDelegateePolicy[]>

Throws

getPkpByTokenId

Parameters

Returns Promise<PkpInfo>

Throws

getPkps

Returns Promise<PkpInfo[]>

getRegisteredTool

Parameters

Returns Promise<any>

Throws

getRegisteredToolsAndDelegateesForPkp

Parameters

Returns Promise<RegisteredToolsResult>

getToolPolicyForDelegatee

Parameters

Returns Promise<{ enabled: boolean; policyIpfsCid: string; }>

Throws

getToolPolicyParameterForDelegatee

Parameters

Returns Promise<{ name: string; value: string; }[]>

Throws

getToolPolicyParametersForDelegatee

Parameters

Returns Promise<{ name: string; value: string; }[]>

Throws

isDelegatee

Parameters

Returns Promise<any>

Throws

isToolPermittedForDelegatee

Parameters

Returns Promise<{ isEnabled: any; isPermitted: any; }>

Throws

isToolRegistered

Parameters

Returns Promise<{ isEnabled: any; isRegistered: any; }>

Throws

mintPkp

Returns Promise<PkpInfo>

`Readonly` litNetwork

Returns Promise<{
enabled: boolean;
policyIpfsCid: string;
}>

Returns Promise<{
name: string;
value: string;
}[]>

Returns Promise<{
name: string;
value: string;
}[]>

Returns Promise<{
isEnabled: any;
isPermitted: any;
}>

Returns Promise<{
isEnabled: any;
isRegistered: any;
}>

`Optional` enableTools?: boolean

`Optional` signingScopes?: AUTH_METHOD_SCOPE_VALUES[]

Returns Promise<{
litContractsTxReceipt: ContractReceipt;
toolRegistryContractTxReceipt: any;
}>

Returns Promise<{
removeToolsTxReceipt: any;
revokePermittedActionTxReceipt: ContractReceipt;
}>

`Static` create