SDK
Getting Started
Authentication
- PKP Native Auth
- PKP Custom Authentication
- EOA Authentication
Core API Methods
PKP Wallet Management
Access Control Conditions
Reference
- @lit-protocol/lit-client@beta
- @lit-protocol/auth@beta
Resources
On this page
- Functions
- Parameters
- Returns
- chain.raw.pkpSign
- Parameters
- Returns
- executeJs
- Parameters
- Returns
- encrypt
- Parameters
- Returns
- decrypt
- Parameters
- Returns
- mintWithEoa
- Parameters
- Returns
- mintWithAuth
- Parameters
- Returns
- mintWithCustomAuth
- Parameters
- Returns
- authService.mintWithAuth
- Parameters
- Returns
- getPKPPermissionsManager
- Parameters
- Returns
- getPaymentManager
- Parameters
- Returns
- viewPKPPermissions
- Parameters
- Returns
- viewPKPsByAddress
- Parameters
- Returns
- getPkpViemAccount
- Parameters
- Returns
- Returns
- getChainConfig
- Parameters
- Returns
- disconnect
- Parameters
- Returns
@lit-protocol/lit-client@beta
createLitClient
Functions
createLitClient({ network })
Parameters
The network to connect to.
Copy
import { nagaDev } from "@lit-protocol/networks";
const litClient = await createLitClient({ network: nagaDev });
Returns
Complete litClient object with all returned methods.
chain.raw.pkpSign
Signs arbitrary bytes with a PKP using the specified signing scheme on the chosen chain.Parameters
Show properties
Show properties
0x‑prefixed PKP public key.
Bytes to sign. If hashing is enabled, the hash of this payload is signed.
Signing scheme to use.
Show allowed values
Show allowed values
ECDSA over secp256k1 with SHA‑256 prehash.
ECDSA over P‑256 with SHA‑256 prehash.
ECDSA over P‑384 with SHA‑384 prehash.
Schnorr over Ed25519 with SHA‑512 prehash.
Schnorr over secp256k1 with SHA‑256 prehash.
Schnorr over P‑256 with SHA‑256 prehash.
Schnorr over P‑384 with SHA‑384 prehash.
Schnorr over Ristretto25519 with SHA‑512 prehash.
Schnorr over Ed448 with SHAKE‑256 prehash.
Schnorr over Jubjub (red) with BLAKE2b‑512 prehash.
Schnorr over secp256k1 (Taproot) variant.
Schnorr over Decaf377 (red) with BLAKE2b‑512 prehash.
Schnorrkel (Substrate) variant.
Authorisation/session context
Optional maximum price the user is willing to pay for this request.
Optional. Controls message pre‑hashing before signing.
Show behaviour
Show behaviour
Show auto‑hash mapping (ECDSA)
Show auto‑hash mapping (ECDSA)
Hash function used before signing.
Hash function used before signing.
Hash function used before signing.
Hash function used before signing.
Hash function used before signing.
Hash function used before signing.
Show auto‑hash mapping (FROST)
Show auto‑hash mapping (FROST)
No hashing is applied;
toSign is signed as‑is.Returns
Show properties
Show properties
The final signature for the request.
0x‑prefixed verifying (compressed) public key used to produce the signature.
0x‑prefixed hex of the exact payload that was signed (post‑hashing if applicable).
Recovery identifier when applicable to the scheme (0 or 1; may be null).
0x‑prefixed PKP public key associated with the signature.
The signature type/scheme used
executeJs
Execute a Lit Action (JS) on the network.Parameters
Show properties
Show properties
Inline JS code to run. Either code or ipfsId must be provided.
IPFS CID of a Lit Action to run. Either code or ipfsId must be provided.
Parameters injected into the Lit Action runtime before execution.
Authorisation/session context for node authorisation.
Optional maximum price the user is willing to pay.
Returns
Show properties
Show properties
The action-defined response payload.
Aggregated logs from nodes.
Signature map when action performs signing.
Optional claim results when present.
Optional debug info (allNodeResponses, allNodeLogs, rawNodeHTTPResponses).
encrypt
Encrypt data with access control conditions using BLS.Parameters
Show properties
Show properties
The data to encrypt. Strings/objects/arrays are internally converted to bytes. Objects/arrays are JSON-stringified first.
Target chain context for condition evaluation.
Standard access control conditions (ACC). Provide one of ACC, evmContractConditions, solRpcConditions, or unifiedAccessControlConditions.
EVM-specific contract conditions (mutually exclusive with other condition types).
Solana RPC conditions (mutually exclusive with other condition types).
Unified access control conditions (mutually exclusive with other condition types).
Optional metadata to describe the data being encrypted.
Show properties
Show properties
Expected data type for downstream conversion on decrypt.
MIME type for file-like data.
Original filename for file-like data.
File size in bytes.
Arbitrary custom metadata.
Returns
decrypt
Decrypt data previously encrypted with access control conditions.Parameters
Show properties
Show properties
Optional. Pass the full encrypted object from encrypt(). If omitted, provide fields below individually.
Base64-encoded ciphertext (required if data is not provided).
SHA-256 hash (hex) of the original plaintext (required if data is not provided).
One of ACC, evmContractConditions, solRpcConditions, or unifiedAccessControlConditions (must match encryption).
Target chain context for condition evaluation.
Authorisation/session context for node authorisation.
Optional maximum price the user is willing to pay for this request.
Returns
mintWithEoa
Mint a PKP using an EOA.Parameters
Show properties
Show properties
The signing account that will perform the mint on-chain.
Returns
mintWithAuth
Mint a PKP using an authentication method.Parameters
Show properties
Show properties
The signing account that will perform the mint on-chain.
Auth method payload (e.g., from ViemAccountAuthenticator): includes authMethodType, authMethodId, optional accessToken.
Permission scopes to attach to the minted PKP.
Returns
mintWithCustomAuth
Mint a PKP using custom authentication (Lit Action validator or IPFS CID).Parameters
Show properties
Show properties
The signing account for on-chain operations.
Authentication method details used alongside the validation Lit Action.
Lit Action IPFS CID (must start with “Qm” and be ≥ 46 chars).
Initial permission scope to grant.
If true, add the PKP’s own address as a permitted address.
If true, transfers the PKP to itself after minting.
Returns
authService.mintWithAuth
Mint a PKP via the Auth Service. Parameters and returns mirrormintWithAuth.
Parameters
Returns
getPKPPermissionsManager
Create a PKP permissions manager instance.Parameters
Hide properties
Hide properties
Account used for permission transactions and reads.
Returns
Hide properties
Hide properties
Permit an authentication method.
Show params
Show params
Show example
Show example
Copy
await manager.addPermittedAuthMethod({ authMethodType: 1, authMethodId: "0x...", userPubkey: "0x...", scopes: ["sign-anything"] });
Show params
Show params
Show example
Show example
Copy
await manager.removePermittedAction({ ipfsId: "Qm..." });
Show params
Show params
Show example
Show example
Copy
await manager.removePermittedAddress({ address: "0xUser..." });
Show params
Show params
Show example
Show example
Copy
const ok = await manager.isPermittedAction({ ipfsId: "Qm..." });
Show params
Show params
Show example
Show example
Copy
const ok = await manager.isPermittedAddress({ address: "0xUser..." });
Returns consolidated permissions (actions, addresses, authMethods).
Batch perform add/remove operations.
Show operations (array of)
Show operations (array of)
Show example
Show example
Copy
await manager.batchUpdatePermissions([
{ type: 'addAddress', address: '0xUser...', scopes: ['sign-anything'] },
{ type: 'addAction', ipfsId: 'Qm...', scopes: ['sign-anything'] },
]);
Remove all addresses, auth methods, and known test actions.
getPaymentManager
Get a Payment Manager for Ledger contract operations.Parameters
Show properties
Show properties
The account used for deposits, withdrawals, and queries.
Returns
Hide properties
Hide properties
Deposit funds to your own account.
Show params
Show params
Amount to deposit in ETH (string), internally converted to Wei.
Show example
Show example
Copy
await paymentManager.deposit({ amountInEth: "0.1" });
Get total and available balances for a user.
Show params
Show params
Show example
Show example
Copy
const bal = await paymentManager.getBalance({ userAddress: "0x..." });
console.log(bal.totalBalance, bal.availableBalance);
Request withdrawal (starts delay period).
Show params
Show params
Show example
Show example
Copy
await paymentManager.requestWithdraw({ amountInEth: "0.05" });
Execute withdrawal after delay.
Show params
Show params
Show example
Show example
Copy
await paymentManager.withdraw({ amountInEth: "0.05" });
Get current withdrawal request for a user.
Show params
Show params
Show example
Show example
Copy
const info = await paymentManager.getWithdrawRequest({ userAddress: "0x..." });
Get global withdrawal delay in seconds.
Show example
Show example
Copy
const delay = await paymentManager.getWithdrawDelay();
canExecuteWithdraw(params)
Promise<{ canExecute: boolean; timeRemaining?: number; withdrawRequest: WithdrawRequestInfo }>
Check whether a user’s withdrawal can be executed now.
Show params
Show params
Show example
Show example
Copy
const { canExecute, timeRemaining } = await paymentManager.canExecuteWithdraw({ userAddress: "0x..." });
Delegate payments to a user.
Show params
Show params
Show example
Show example
Copy
await paymentManager.delegatePayments({ userAddress: "0xUser..." });
Undelegate payments from a user.
Show params
Show params
Show example
Show example
Copy
await paymentManager.undelegatePayments({ userAddress: "0xUser..." });
Delegate payments to multiple users.
Show params
Show params
Show example
Show example
Copy
await paymentManager.delegatePaymentsBatch({ userAddresses: ["0xA...","0xB..."] });
Undelegate payments from multiple users.
Show params
Show params
Show example
Show example
Copy
await paymentManager.undelegatePaymentsBatch({ userAddresses: ["0xA...","0xB..."] });
List payers for a user.
Show params
Show params
Show example
Show example
Copy
const payers = await paymentManager.getPayers({ userAddress: "0xUser..." });
List users for a payer.
Show params
Show params
Show example
Show example
Copy
const users = await paymentManager.getUsers({ payerAddress: "0xPayer..." });
getRestriction(params)
Promise<{ totalMaxPrice: string; requestsPerPeriod: string; periodSeconds: string; raw: Restriction }>
Get restriction for a payer.
Show params
Show params
Show example
Show example
Copy
const r = await paymentManager.getRestriction({ payerAddress: "0xPayer..." });
getPayersAndRestrictions(params)
Promise<{ payers: string[][]; restrictions: { totalMaxPrice: string; requestsPerPeriod: string; periodSeconds: string; }[][]; raw: { payers: string[][]; restrictions: Restriction[][] } }>
Batch get payers and restrictions for users.
Show params
Show params
Show example
Show example
Copy
const res = await paymentManager.getPayersAndRestrictions({ userAddresses: ["0xA...","0xB..."] });
viewPKPPermissions
View current permissions context for a PKP.Parameters
Returns
viewPKPsByAddress
List PKPs owned by an address.Parameters
Returns
getPkpViemAccount
Create a Viem-compatible account backed by a PKP.Parameters
Returns
Show properties
Show properties
Standard Viem account methods that route to PKP signing under the hood.
Returns
Show properties
Show properties
The final signature for the request.
0x‑prefixed verifying (compressed) public key used to produce the signature.
0x‑prefixed hex of the exact payload that was signed (post‑hashing if applicable).
Recovery identifier when applicable to the scheme (0 or 1; may be null).
0x‑prefixed PKP public key associated with the signature.
The signature type/scheme used (e.g. ECDSA, Schnorr).
getChainConfig
Returns the chain configuration for the current network.Parameters
noneReturns
disconnect
Stop background state updates and release resources.Parameters
noneReturns
voidWas this page helpful?
Assistant
Responses are generated using AI and may contain mistakes.