-
Notifications
You must be signed in to change notification settings - Fork 88
feat(docs): add guide for deriving Lit Action public keys #968
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.
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,71 @@ | ||||||
| --- | ||||||
| title: 'Derive Lit Action Public Keys' | ||||||
| description: 'How to deterministically derive and verify a Lit Action identity without executing it externally.' | ||||||
| --- | ||||||
|
|
||||||
| # Derive a Lit Action Public Key Locally | ||||||
|
|
||||||
| ## Question | ||||||
|
|
||||||
| I want to call `Lit.Actions.signAsAction`. I know the action identity is derived from the Action's IPFS CID, but I cannot find a way to obtain the public key outside of the Action runtime. `Lit.Actions.getActionPublicKey` works within the Action, while `executeJs` only exposes `signatures.<name>.publicKey` after a signing operation. Is there a way to deterministically derive the Action's public key locally without running the Action? | ||||||
|
|
||||||
| ## Answer | ||||||
|
|
||||||
| Yes. Inside the Lit Action you can deterministically derive the Action identity (and therefore its public key) from the same inputs the nodes use: the Action's IPFS CID and the signing scheme. The snippet below shows the complete flow: | ||||||
|
|
||||||
| 1. Produce the 32-byte message hash the Lit nodes expect. | ||||||
| 2. Call `Lit.Actions.signAsAction` to sign that message with the Action identity. | ||||||
| 3. Derive the Action public key via `Lit.Actions.getActionPublicKey`, passing the Action CID and signing scheme. | ||||||
| 4. Optionally verify the signature with `Lit.Actions.verifyActionSignature`. | ||||||
|
|
||||||
| ```js | ||||||
| const { sigName, toSign } = jsParams; // 'publicKey' not required; derive it from the Action IPFS CID | ||||||
|
||||||
| const { sigName, toSign } = jsParams; // 'publicKey' not required; derive it from the Action IPFS CID | |
| const { sigName, toSign } = jsParams; // 'publicKey' not required in jsParams; it will be derived later from the Action IPFS CID |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The question describes obtaining the public key 'outside of the Action runtime' and 'locally without running the Action', but the answer demonstrates deriving the key from within the Action context. This creates confusion about whether the solution actually addresses the stated problem of getting the key without executing the Action.