Wrapped Keys

[MaximusHaximus]

Description

• Updates wrapped keys to support multiple networks; Production for Habanero (and Datil in the future), TestNetworks for Cayenne and Manzano
• Adds new keyType and publicKey keys to the persisted metadata, and requires they are provided when consumers call the methods that require them
• Organizes types, constants, and logic by domain -- lit-actions-client contains all code specific to interacting with the lit actions, service-client contains all of the same for interactions with the wrapped keys backend, and api contains definitions of all top-level API methods that will be exposed to the consumer of the package
• Explicitly exporting types and methods from the top-level index.ts rather than blanket exporting everything in the package with * exports. The goal here is to facilitate us being able to modify the LIT action APIs without making breaking changes to the top-level API methods that consumers are using as we need to.
• Added a bunch of JSDocs and explicit types for parameters for API-exposed methods and their return values
• Removed a lot of duplicated JSDoc comments by using @typedef and @extends
• Removed the customXXXX methods, in favour of us instead add a basic documentation blurb to the JSDocs for prospective integrators that shows them how easy it is to get the private key metadata from the wrapped keys service, and then submit it to any custom LIT action, using the LitNodeClient instance that they already have in scope. The custom behaviour in the SDK exposes internals of LIT actions to our consumer API, and would cause us to get tickets against the wrapped-keys SDK that are actually issues with custom LIT Action implementations on top of making the API worse for consumers of the package who want to use 'supported' networks.

e.g.:

import { getPrivateKeyMetadata } from '@lit-protocol/wrapped-keys'

import { litNodeClient } from '@lit-protocol/lit-node-client'

await litNodeClient.connect({litNetwork: 'cayenne'});
const sessionSigs = await litNodeClient.getSessionSigs(...);
const keyMetadata = await getPrivateKeyMetadata({ litNodeClient, sessionSigs})
const customLitActionWithWrappedKeyResponse = await litNodeClient.executeJs({
  sessionSigs,
  ipfsId: litActionIpfsCid, // OR
  code: litActionCode, 
  jsParams: {
    accessControlConditions,
    keyMetadata,
  },
});

// Do whatever you want to with `customLitActionWithWrappedKeyResponse

Type of change

• [x] New feature (non-breaking change which adds functionality)
• [x] Breaking change (fix or feature that would cause existing functionality to not work as expected)
• [ ] This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

• Ran all local tests against Cayenne. The only ones that fail say they intentionally fail (?!?!?!)

Checklist:

• [x] My code follows the style guidelines of this project
• [x] I have performed a self-review of my code
• [x] I have commented my code, particularly in hard-to-understand areas
• [ ] I have made corresponding changes to the documentation
• [x] My changes generate no new warnings
• [ ] I have added tests that prove my fix is effective or that my feature works
• [x] New and existing unit tests pass locally with my changes
• [ ] Any dependent changes have been merged and published in downstream modules

[spacesailor24]

The local-tests/tests/testImportWrappedKey.ts test is importing a Solana key but says the keyType is K256

This test also isn't really testing if the key was imported correctly, but I think we'd have to use either getEncryptedKeyMetadata or the sign methods to verify it was

[spacesailor24]

Are there tests for getEncryptedKeyMetadata and storeEncryptedKeyMetadata?

[CLAassistant]

All committers have signed the CLA.

[MaximusHaximus]

Are there tests for getEncryptedKeyMetadata and storeEncryptedKeyMetadata?

Not directly; they are used by all of the other tests, so are extensively tested alreeady

[MaximusHaximus]

Addressed feedback and responded to some questions with questions @DashKash54 :)