> ## Documentation Index > Fetch the complete documentation index at: https://litprotocol-feat-rusk-sdk.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # createLitClient # Functions > **createLitClient**(`{ network }`) ## Parameters The network to connect to. ```ts theme={null} 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 0x‑prefixed PKP public key. Bytes to sign. If hashing is enabled, the hash of this payload is signed. Signing scheme to use. 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. Defaults to EcdsaK256Sha256. Supports EcdsaK256Sha256, SchnorrK256Sha256, SchnorrK256Taproot. Target chain; determines hashing (e.g. keccak256 for ethereum, sha256 for bitcoin). Uses keccak256 prehashing when hashing is enabled. Uses SHA‑256 prehashing when hashing is enabled. Reserved in schema. Reserved in schema. Authorisation/session context Optional maximum price the user is willing to pay for this request. Optional. Controls message pre‑hashing before signing. Do not transform toSign; the payload is signed as‑is. Use when you already computed the digest (e.g. EIP‑712 typed data, pre‑computed tx/message hash). Auto‑hash toSign according to signingScheme and chain via LitMessageSchema. 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. No hashing is applied; toSign is signed as‑is. Auto‑hash mapping is not defined; avoid relying on auto‑hash with these chains. Compute the EIP‑712 digest client‑side and set bypassAutoHashing=true to sign the digest directly. #### Returns 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 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 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 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. 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 Base64-encoded ciphertext. SHA-256 hash (hex) of the plaintext data. Echo of provided metadata or inferred data type where applicable. ### decrypt Decrypt data previously encrypted with access control conditions. #### Parameters 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 The raw decrypted bytes. Present when metadata.dataType was provided and conversion is applicable. Metadata echo including dataType and optional file info. ### mintWithEoa Mint a PKP using an EOA. #### Parameters The signing account that will perform the mint on-chain. #### Returns Transaction hash of the mint. PKP token ID. 0x-hex uncompressed public key. Derived 0x-hex Ethereum address. ### mintWithAuth Mint a PKP using an authentication method. #### Parameters 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 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 Echo of the provided Lit Action CID. Mint result and PKP details from the chain API. ### authService.mintWithAuth Mint a PKP via the Auth Service. Parameters and returns mirror `mintWithAuth`. #### Parameters Optional. Override the Auth Service base URL; defaults to the network’s configured value. #### Returns ### getPKPPermissionsManager Create a PKP permissions manager instance. #### Parameters PKP identifier. Exactly one of the following must be provided. PKP token ID (stringified bigint). 0x‑prefixed uncompressed PKP public key. 0x‑prefixed PKP Ethereum address. Account used for permission transactions and reads. #### Returns Add a permitted Lit Action. Lit Action IPFS CID. Permission scopes (e.g., 'sign-anything'). ```ts theme={null} await manager.addPermittedAction({ ipfsId: "Qm...", scopes: ["sign-anything"] }); ``` Add a permitted address. 0x‑prefixed address to permit. Permission scopes. ```ts theme={null} await manager.addPermittedAddress({ address: "0xUser...", scopes: ["sign-anything"] }); ``` Permit an authentication method. ```ts theme={null} await manager.addPermittedAuthMethod({ authMethodType: 1, authMethodId: "0x...", userPubkey: "0x...", scopes: ["sign-anything"] }); ``` Permit a scope for an auth method. ```ts theme={null} await manager.addPermittedAuthMethodScope({ authMethodType: 1, authMethodId: "0x...", scopeId: 0 }); ``` ```ts theme={null} await manager.removePermittedAction({ ipfsId: "Qm..." }); ``` ```ts theme={null} await manager.removePermittedAddress({ address: "0xUser..." }); ``` ```ts theme={null} await manager.removePermittedAuthMethod({ authMethodType: 1, authMethodId: "0x..." }); ``` ```ts theme={null} await manager.removePermittedAuthMethodScope({ authMethodType: 1, authMethodId: "0x...", scopeId: 0 }); ``` ```ts theme={null} const ok = await manager.isPermittedAction({ ipfsId: "Qm..." }); ``` ```ts theme={null} const ok = await manager.isPermittedAddress({ address: "0xUser..." }); ``` Returns consolidated permissions (actions, addresses, authMethods). Batch perform add/remove operations. ```ts theme={null} 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 The account used for deposits, withdrawals, and queries. #### Returns Deposit funds to your own account. Amount to deposit in ETH (string), internally converted to Wei. ```ts theme={null} await paymentManager.deposit({ amountInEth: "0.1" }); ``` Deposit funds for another user. ```ts theme={null} await paymentManager.depositForUser({ userAddress: "0x...", amountInEth: "0.25" }); ``` Get total and available balances for a user. ```ts theme={null} const bal = await paymentManager.getBalance({ userAddress: "0x..." }); console.log(bal.totalBalance, bal.availableBalance); ``` Request withdrawal (starts delay period). ```ts theme={null} await paymentManager.requestWithdraw({ amountInEth: "0.05" }); ``` Execute withdrawal after delay. ```ts theme={null} await paymentManager.withdraw({ amountInEth: "0.05" }); ``` Get current withdrawal request for a user. ```ts theme={null} const info = await paymentManager.getWithdrawRequest({ userAddress: "0x..." }); ``` Get global withdrawal delay in seconds. ```ts theme={null} const delay = await paymentManager.getWithdrawDelay(); ``` Check whether a user's withdrawal can be executed now. ```ts theme={null} const { canExecute, timeRemaining } = await paymentManager.canExecuteWithdraw({ userAddress: "0x..." }); ``` Delegate payments to a user. ```ts theme={null} await paymentManager.delegatePayments({ userAddress: "0xUser..." }); ``` Undelegate payments from a user. ```ts theme={null} await paymentManager.undelegatePayments({ userAddress: "0xUser..." }); ``` Delegate payments to multiple users. ```ts theme={null} await paymentManager.delegatePaymentsBatch({ userAddresses: ["0xA...","0xB..."] }); ``` Undelegate payments from multiple users. ```ts theme={null} await paymentManager.undelegatePaymentsBatch({ userAddresses: ["0xA...","0xB..."] }); ``` Set payment restriction for caller. ```ts theme={null} await paymentManager.setRestriction({ totalMaxPrice: "1000000000000000000", requestsPerPeriod: "100", periodSeconds: "86400" }); ``` List payers for a user. ```ts theme={null} const payers = await paymentManager.getPayers({ userAddress: "0xUser..." }); ``` List users for a payer. ```ts theme={null} const users = await paymentManager.getUsers({ payerAddress: "0xPayer..." }); ``` Get restriction for a payer. ```ts theme={null} const r = await paymentManager.getRestriction({ payerAddress: "0xPayer..." }); ``` Batch get payers and restrictions for users. ```ts theme={null} 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 Address whose PKPs to fetch. #### Returns ### getPkpViemAccount Create a Viem-compatible account backed by a PKP. #### Parameters 0x-prefixed PKP public key. Authorisation context used for signing sessions. Viem chain configuration used by the returned account. #### Returns Standard Viem account methods that route to PKP signing under the hood. #### Returns 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). ### utils.getDerivedKeyId Resolve the uncompressed PKP public key for a given derived key identifier. #### Parameters 0x-prefixed bytes32 identifier (for example, keccak256(stringToBytes(`lit_action_${ipfsCid}`))). #### Returns 0x-prefixed uncompressed public key as returned by the PubkeyRouter contract. #### Example ```ts theme={null} import { keccak256, stringToBytes } from "viem"; const derivedKeyId = keccak256(stringToBytes(`lit_action_${ipfsCid}`)); const derivedPubkey = await litClient.utils.getDerivedKeyId(derivedKeyId); ``` > Note: this helper currently calls `PubkeyRouter.getDerivedPubkey` with the default Naga key set (`naga-keyset1`). See the [Derive Lit Action Public Keys guide](../../../../guides/lit-action-sign-as-action) for an end-to-end workflow. ### getChainConfig Returns the chain configuration for the current network. #### Parameters none #### Returns Viem chain configuration used by the returned account. RPC URL for the chain. ### disconnect Stop background state updates and release resources. #### Parameters none #### Returns void