Skip to content

Feat/get derived pubkey #973

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 24, 2025
Merged

Feat/get derived pubkey #973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c7d57d3
feat(lit-client,contracts): add `getDerivedKeyId` utils
Ansonhkg Oct 24, 2025
720ca41
feat(docs): add `getDerivedKeyId` utility and usage examples for deri…
Ansonhkg Oct 24, 2025
84c1b12
fmt
Ansonhkg Oct 24, 2025
4d339d1
chore: add changeset
Ansonhkg Oct 24, 2025
38a8e84
fix(networks): re-export the correct instance
Ansonhkg Oct 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/two-mangos-lead.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
'@lit-protocol/lit-client': minor
'@lit-protocol/contracts': minor
'@lit-protocol/networks': minor
'@lit-protocol/e2e': minor
---

introduce `litClient.utils.getDerivedKeyId` - a little helper to resolve the Lit Action public key outside of the Action runtime
18 changes: 18 additions & 0 deletions docs/guides/lit-action-sign-as-action.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,21 @@ const { keccak256, arrayify } = ethers.utils;
```

This approach keeps the derivation entirely within the Lit Action context. Because the public key depends only on the Action CID and signing scheme, you can rely on `Lit.Actions.getActionPublicKey` for a deterministic identity without needing to execute the Action externally first.

## Derive the Same Public Key from Client Code

If you prefer to resolve the Lit Action public key outside of the Action runtime - e.g., inside tests or other tooling—the SDK now exposes a helper that calls the on-chain PubkeyRouter contract.

```ts
import { createLitClient } from "@lit-protocol/lit-client";
import { nagaDev } from "@lit-protocol/networks";
import { keccak256, stringToBytes } from "viem";

const litClient = await createLitClient({ network: nagaDev });
const derivedKeyId = keccak256(stringToBytes(`lit_action_${actionIpfsCid}`));
const actionPublicKey = await litClient.utils.getDerivedKeyId(derivedKeyId);

console.log("Derived Lit Action pubkey:", actionPublicKey);
```

Under the hood, `getDerivedKeyId` routes through `PubkeyRouter.getDerivedPubkey`, passing the staking contract address and the default Naga key set (`naga-keyset1`) (will be dynamic in the future). This mirrors the same key derivation the nodes perform, letting you confirm identities or signatures without re-running the Lit Action.
29 changes: 28 additions & 1 deletion docs/sdk/sdk-reference/lit-client/functions/createLitClient.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1046,6 +1046,33 @@ Create a Viem-compatible account backed by a PKP.
</Expandable>
</ResponseField>

### utils.getDerivedKeyId

Resolve the uncompressed PKP public key for a given derived key identifier.

#### Parameters

<ResponseField name="derivedKeyId" type="string" required>
0x-prefixed bytes32 identifier (for example, <code>keccak256(stringToBytes(`lit_action_${ipfsCid}`))</code>).
</ResponseField>

#### Returns

<ResponseField name="result" type="Promise<string>">
0x-prefixed uncompressed public key as returned by the PubkeyRouter contract.
</ResponseField>

#### Example

```ts
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.
Expand Down Expand Up @@ -1074,4 +1101,4 @@ Stop background state updates and release resources.
none

#### Returns
void
void
5 changes: 0 additions & 5 deletions packages/contracts/dist/dev/develop.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15431,11 +15431,6 @@ module.exports = {
"name": "CallerNotOwner",
"type": "error"
},
{
"inputs": [],
"name": "MustBeLessThan100",
"type": "error"
},
{
"inputs": [],
"name": "MustBeNonzero",
Expand Down
5 changes: 0 additions & 5 deletions packages/contracts/dist/dev/develop.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15429,11 +15429,6 @@ export const develop = {
"name": "CallerNotOwner",
"type": "error"
},
{
"inputs": [],
"name": "MustBeLessThan100",
"type": "error"
},
{
"inputs": [],
"name": "MustBeNonzero",
Expand Down
5 changes: 0 additions & 5 deletions packages/contracts/dist/dev/develop.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15429,11 +15429,6 @@
"name": "CallerNotOwner",
"type": "error"
},
{
"inputs": [],
"name": "MustBeLessThan100",
"type": "error"
},
{
"inputs": [],
"name": "MustBeNonzero",
Expand Down
5 changes: 0 additions & 5 deletions packages/contracts/dist/dev/develop.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15429,11 +15429,6 @@ export const develop = {
"name": "CallerNotOwner",
"type": "error"
},
{
"inputs": [],
"name": "MustBeLessThan100",
"type": "error"
},
{
"inputs": [],
"name": "MustBeNonzero",
Expand Down
24 changes: 24 additions & 0 deletions packages/contracts/dist/signatures/datil-dev.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,6 +673,30 @@ const signatures = {
"stateMutability": "view",
"type": "function"
},
"getDerivedPubkey": {
"inputs": [
{
"internalType": "address",
"name": "stakingContract",
"type": "address"
},
{
"internalType": "bytes32",
"name": "derivedKeyId",
"type": "bytes32"
}
],
"name": "getDerivedPubkey",
"outputs": [
{
"internalType": "bytes",
"name": "",
"type": "bytes"
}
],
"stateMutability": "view",
"type": "function"
},
"getEthAddress": {
"inputs": [
{
Expand Down
24 changes: 24 additions & 0 deletions packages/contracts/dist/signatures/datil-dev.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,6 +673,30 @@ export const signatures = {
"stateMutability": "view",
"type": "function"
},
"getDerivedPubkey": {
"inputs": [
{
"internalType": "address",
"name": "stakingContract",
"type": "address"
},
{
"internalType": "bytes32",
"name": "derivedKeyId",
"type": "bytes32"
}
],
"name": "getDerivedPubkey",
"outputs": [
{
"internalType": "bytes",
"name": "",
"type": "bytes"
}
],
"stateMutability": "view",
"type": "function"
},
"getEthAddress": {
"inputs": [
{
Expand Down
24 changes: 24 additions & 0 deletions packages/contracts/dist/signatures/datil-dev.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,6 +673,30 @@ export const signatures = {
"stateMutability": "view",
"type": "function"
},
"getDerivedPubkey": {
"inputs": [
{
"internalType": "address",
"name": "stakingContract",
"type": "address"
},
{
"internalType": "bytes32",
"name": "derivedKeyId",
"type": "bytes32"
}
],
"name": "getDerivedPubkey",
"outputs": [
{
"internalType": "bytes",
"name": "",
"type": "bytes"
}
],
"stateMutability": "view",
"type": "function"
},
"getEthAddress": {
"inputs": [
{
Expand Down
24 changes: 24 additions & 0 deletions packages/contracts/dist/signatures/datil-test.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,6 +673,30 @@ const signatures = {
"stateMutability": "view",
"type": "function"
},
"getDerivedPubkey": {
"inputs": [
{
"internalType": "address",
"name": "stakingContract",
"type": "address"
},
{
"internalType": "bytes32",
"name": "derivedKeyId",
"type": "bytes32"
}
],
"name": "getDerivedPubkey",
"outputs": [
{
"internalType": "bytes",
"name": "",
"type": "bytes"
}
],
"stateMutability": "view",
"type": "function"
},
"getEthAddress": {
"inputs": [
{
Expand Down
24 changes: 24 additions & 0 deletions packages/contracts/dist/signatures/datil-test.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,6 +673,30 @@ export const signatures = {
"stateMutability": "view",
"type": "function"
},
"getDerivedPubkey": {
"inputs": [
{
"internalType": "address",
"name": "stakingContract",
"type": "address"
},
{
"internalType": "bytes32",
"name": "derivedKeyId",
"type": "bytes32"
}
],
"name": "getDerivedPubkey",
"outputs": [
{
"internalType": "bytes",
"name": "",
"type": "bytes"
}
],
"stateMutability": "view",
"type": "function"
},
"getEthAddress": {
"inputs": [
{
Expand Down
24 changes: 24 additions & 0 deletions packages/contracts/dist/signatures/datil-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,6 +673,30 @@ export const signatures = {
"stateMutability": "view",
"type": "function"
},
"getDerivedPubkey": {
"inputs": [
{
"internalType": "address",
"name": "stakingContract",
"type": "address"
},
{
"internalType": "bytes32",
"name": "derivedKeyId",
"type": "bytes32"
}
],
"name": "getDerivedPubkey",
"outputs": [
{
"internalType": "bytes",
"name": "",
"type": "bytes"
}
],
"stateMutability": "view",
"type": "function"
},
"getEthAddress": {
"inputs": [
{
Expand Down
24 changes: 24 additions & 0 deletions packages/contracts/dist/signatures/datil.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,6 +673,30 @@ const signatures = {
"stateMutability": "view",
"type": "function"
},
"getDerivedPubkey": {
"inputs": [
{
"internalType": "address",
"name": "stakingContract",
"type": "address"
},
{
"internalType": "bytes32",
"name": "derivedKeyId",
"type": "bytes32"
}
],
"name": "getDerivedPubkey",
"outputs": [
{
"internalType": "bytes",
"name": "",
"type": "bytes"
}
],
"stateMutability": "view",
"type": "function"
},
"getEthAddress": {
"inputs": [
{
Expand Down
24 changes: 24 additions & 0 deletions packages/contracts/dist/signatures/datil.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,6 +673,30 @@ export const signatures = {
"stateMutability": "view",
"type": "function"
},
"getDerivedPubkey": {
"inputs": [
{
"internalType": "address",
"name": "stakingContract",
"type": "address"
},
{
"internalType": "bytes32",
"name": "derivedKeyId",
"type": "bytes32"
}
],
"name": "getDerivedPubkey",
"outputs": [
{
"internalType": "bytes",
"name": "",
"type": "bytes"
}
],
"stateMutability": "view",
"type": "function"
},
"getEthAddress": {
"inputs": [
{
Expand Down
24 changes: 24 additions & 0 deletions packages/contracts/dist/signatures/datil.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,6 +673,30 @@ export const signatures = {
"stateMutability": "view",
"type": "function"
},
"getDerivedPubkey": {
"inputs": [
{
"internalType": "address",
"name": "stakingContract",
"type": "address"
},
{
"internalType": "bytes32",
"name": "derivedKeyId",
"type": "bytes32"
}
],
"name": "getDerivedPubkey",
"outputs": [
{
"internalType": "bytes",
"name": "",
"type": "bytes"
}
],
"stateMutability": "view",
"type": "function"
},
"getEthAddress": {
"inputs": [
{
Expand Down
Loading
Loading