Overhaul #94

madschristensen99 · 2025-04-08T19:44:06Z

Pre-Merge Standard Guide Checklist

spacesailor24 · 2025-04-17T21:17:06Z

exampleLitActions/src/conditionalSigning.ts

+// Define the Lit Action code for conditional signing
+const litActionCode = `
+async () =>  {
+  try {
+    // test an access control condition
+    const testResult = await Lit.Actions.checkConditions({
+      conditions,
+      authSig,
+      chain,
+    });
+
+    if (!testResult) {
+      LitActions.setResponse({ response: "address does not have 1 or more Wei on Ethereum Mainnet" });
+      return;
+    }
+
+    const sigShare = await LitActions.signEcdsa({
+      toSign: dataToSign,
+      publicKey,
+      sigName: "sig",
+    });
+  } catch (error) {
+    LitActions.setResponse({ response: error.message });
+  }
+};
+`;


Can we always define the Lit Action code in a file called src/litAction.ts

Can we always define Lit Actions using the pattern:

const _litActionCode = async () => { // Lit Action code here... }; export const litActionCode = `(${_litActionCode.toString()})();`;

This gives us syntax highlighting for the Lit Action code

spacesailor24 · 2025-04-17T21:21:07Z

exampleLitActions/src/conditionalSigning.ts

+// Utility function to get environment variables
+const getEnv = (name: string): string => {
+  const value = process.env[name];
+  if (!value) {
+    console.warn(`Environment variable ${name} is not set`);
+  }
+  return value || "";
+};


We should always define util methods in a src/utils.ts file. Our goal with the main code example file (this file) is to be as lean as possible, focusing only on the code that makes this code example unique. We don't want to use to have to filter out boilerplate code to find the code they'll want to copy/paste into their project

spacesailor24 · 2025-04-17T21:22:20Z

exampleLitActions/src/conditionalSigning.ts

All code example files should be named src/index.ts for consistency across all the code examples. Basically every code example is going to at least have these three files: src/index.ts, src/utils.ts, and src/litAction.ts with the latter two being dependent on whether the code example actually needs them

spacesailor24 · 2025-04-17T21:24:02Z

exampleLitActions/src/conditionalSigning.ts

+// Result interface for our function
+interface ConditionalSigningResult {
+  success: boolean;
+  signatureResult?: Record<string, any>;
+  response?: string;
+  error?: string;
+}


We shouldn't return a custom type from the example functions, we should just return the raw Lit SDK response and then handle the parsing inside the test. We don't want to clutter the code example with code that's not technically required - it can become confusing for the user copy/pasting the example

spacesailor24 · 2025-04-18T03:55:30Z

exampleLitActions/src/conditionalSigning.ts

+    });
+
+    if (!testResult) {
+      LitActions.setResponse({ response: "address does not have 1 or more Wei on Ethereum Mainnet" });


on Ethereum Mainnet

This should use the chain variable since it's configurable

spacesailor24 · 2025-04-18T03:56:54Z

exampleLitActions/src/conditionalSigning.ts

+      sigName: "sig",
+    });
+  } catch (error) {
+    LitActions.setResponse({ response: error.message });


Instead of error.message, for all the code examples can you use error.message ? error.message : JSON.stringify(error) - it's what we're doing for the Vincent tools and should just be a pattern we establish for our LA code

spacesailor24 · 2025-04-18T04:07:36Z

exampleLitActions/src/conditionalSigning.ts

+      litNetwork: LIT_NETWORK.DatilTest,
+      debug: false,


For all code examples, can we make these ENVs? It makes it easier to test across the different Lit network when we want to debug something happening on a specific Lit network

spacesailor24 · 2025-04-18T04:07:49Z

exampleLitActions/src/conditionalSigning.ts

+      network: LIT_NETWORK.DatilTest,
+      debug: false,


ENVs for these as well

spacesailor24 · 2025-04-18T04:10:33Z

exampleLitActions/src/conditionalSigning.ts

+    let pkpPublicKey = LIT_PKP_PUBLIC_KEY;
+    if (!pkpPublicKey) {
+      console.log("🔄 PKP wasn't provided, minting a new one...");
+      const pkpInfo = (await litContracts.pkpNftContractUtils.write.mint()).pkp;
+      pkpPublicKey = pkpInfo.publicKey;
+      console.log("✅ PKP successfully minted");
+      console.log(`ℹ️  PKP token ID: ${pkpInfo.tokenId}`);
+      console.log(`ℹ️  PKP public key: ${pkpPublicKey}`);
+      console.log(`ℹ️  PKP ETH address: ${pkpInfo.ethAddress}`);
+    } else {
+      console.log(`ℹ️  Using provided PKP: ${pkpPublicKey}`);
+    }


So this is the type of functionality we want to abstract into a util function. It's going to be used by many code examples and isn't directly relevant to the code example which is covering how to conditional signing with a PKP. Really the code to highlight for this code example is in the Lit Action, we just need a PKP public key to send along with the Lit Action request

spacesailor24 · 2025-04-18T04:11:43Z

exampleLitActions/src/conditionalSigning.ts

+    // Handle Capacity Credit
+    let capacityTokenId = LIT_CAPACITY_CREDIT_TOKEN_ID;
+    if (!capacityTokenId) {
+      console.log("🔄 No Capacity Credit provided, minting a new one...");
+      capacityTokenId = (
+        await litContracts.mintCapacityCreditsNFT({
+          requestsPerKilosecond: 10,
+          daysUntilUTCMidnightExpiration: 1,
+        })
+      ).capacityTokenIdStr;
+      console.log(`✅ Minted new Capacity Credit with ID: ${capacityTokenId}`);
+    } else {
+      console.log(
+        `ℹ️  Using provided Capacity Credit with ID: ${capacityTokenId}`
+      );
+    }
+
+    // Create capacity delegation auth signature
+    console.log("🔄 Creating capacityDelegationAuthSig...");
+    const { capacityDelegationAuthSig } =
+      await litNodeClient.createCapacityDelegationAuthSig({
+        dAppOwnerWallet: ethersWallet,
+        capacityTokenId,
+        delegateeAddresses: [ethersWallet.address],
+        uses: "1",
+      });
+    console.log("✅ Capacity Delegation Auth Sig created");


These can also be abstracted into util functions

spacesailor24 · 2025-04-18T04:13:20Z

exampleLitActions/src/conditionalSigning.ts

+    // Create auth signature for the action
+    const authSig = await (async () => {
+      const toSign = await createSiweMessage({
+        uri: "http://localhost",
+        expiration: new Date(Date.now() + 1000 * 60 * 60 * 24).toISOString(), // 24 hours
+        walletAddress: await ethersWallet.getAddress(),
+        nonce: await litNodeClient.getLatestBlockhash(),
+        resources: [
+          {
+            resource: new LitActionResource("*"),
+            ability: LIT_ABILITY.LitActionExecution,
+          },
+        ],
+        litNodeClient: litNodeClient,
+      });
+      return await generateAuthSig({
+        signer: ethersWallet,
+        toSign,
+      });
+    })();


Another util methods that takes the resources as an array of Lit Resources (type is importable from our types package or auth package)

spacesailor24 · 2025-04-18T04:14:10Z

exampleLitActions/src/conditionalSigning.ts

+    return {
+      success: litActionResult.success,
+      signatureResult: litActionResult.signatures || {},
+      response: typeof litActionResult.response === 'string' 
+        ? litActionResult.response 
+        : JSON.stringify(litActionResult.response)
+    };


So we should just return litActionResult here, or just return litNodeClient.executeJs(...

spacesailor24 · 2025-04-18T04:14:38Z

exampleLitActions/src/conditionalSigning.ts

+    console.error("Error in conditional signing:", error);
+    return {
+      success: false,
+      error: error?.message || String(error)


Should also do error.message ? error.message : JSON.stringify(error) here

spacesailor24 · 2025-04-18T04:16:26Z

exampleLitActions/src/conditionalSigning.ts

+    // Get session signatures
+    const sessionSigs = await litNodeClient.getSessionSigs({
+      chain: CHAIN_TO_CHECK_CONDITION_ON,
+      capabilityAuthSigs: [capacityDelegationAuthSig],
+      expiration: new Date(Date.now() + 1000 * 60 * 60 * 24).toISOString(), // 24 hours
+      resourceAbilityRequests: [
+        {
+          resource: new LitActionResource("*"),
+          ability: LIT_ABILITY.LitActionExecution,
+        },
+      ],
+      authNeededCallback: async ({ resourceAbilityRequests, expiration, uri }) => {
+        const toSign = await createSiweMessage({
+          uri: uri || "",
+          expiration: expiration || "",
+          resources: resourceAbilityRequests || [],
+          walletAddress: await ethersWallet.getAddress(),
+          nonce: await litNodeClient.getLatestBlockhash(),
+          litNodeClient: litNodeClient,
+        });
+
+        return await generateAuthSig({
+          signer: ethersWallet,
+          toSign,
+        });
+      },
+    });


Can you something similar to console.log("✅ Capacity Delegation Auth Sig created"); after every major thing that happens in the code example? This help us find where to look at what went wrong while debugging - also just a nice status update when the user runs the code example

spacesailor24 · 2025-04-18T04:17:05Z

exampleLitActions/src/encryptDecrypt.ts

Apply the same comments from exampleLitActions/src/conditionalSigning.ts to this file

spacesailor24 · 2025-04-18T04:18:19Z

exampleLitActions/src/encryptDecrypt.ts

+// Define type for a basic access control condition compatible with Lit Protocol
+type LitAccessControlCondition = {
+  contractAddress: string;
+  standardContractType: string;
+  chain: string;
+  method: string;
+  parameters: string[];
+  returnValueTest: {
+    comparator: string;
+    value: string;
+  };
+};


Pretty sure this is already a defined type from the Lit SDK types package, or one of our packages

spacesailor24 · 2025-04-18T04:21:52Z

exampleLitActions/src/encryptDecrypt.ts

+    // Message to encrypt
+    const messageText = 'Hello world';
+
+    console.log("Encrypting message:", messageText);


Replace these types of console.logs with the style: console.log("✅ Capacity Delegation Auth Sig created");. So use the emojis:

✅ After something was done successfully, basically a status update that a step was successful

🔄 Use before a request that's likely to take some time to resolve e.g. sending a tx on-chain, minting a PKP, executing a LA

ℹ️ For important info worth calling out e.g. using a provided PKP instead of minting a new one, or minting PKP info

This should be our standard for these code examples, and each example should use this pattern

spacesailor24 · 2025-04-18T04:22:40Z

exampleLitActions/src/encryptDecrypt.ts

+    return {
+      response: {
+        response: decryptedMessage || messageText, // Fallback to original text if response is empty
+        originalResponse: executeResponse // Keep the original response for debugging
+      },
+      success: true
+    };


Just return litNodeClient.executeJs(...

spacesailor24 · 2025-04-18T04:23:00Z

exampleLitActions/src/encryptDecrypt.ts

+    // Disconnect from the Lit Node network
+    console.log("Disconnecting from Lit Node network...");
+    await litNodeClient.disconnect();


This should happen within a finally clause like in exampleLitActions/src/conditionalSigning.ts

spacesailor24 · 2025-04-18T04:24:05Z

exampleLitActions/src/encryptDecrypt.ts

+  } catch (error) {
+    console.error("Error in encryptDecrypt:", error);
+    return {
+      response: null,
+      success: false,
+      error
+    };
+  }


I don't think we should catch the error since we're not really doing any error handling - this would also automatically fail the test instead of us having to check response.success

spacesailor24 · 2025-04-18T04:25:03Z

exampleLitActions/src/fetch.ts

Apply the same comments from exampleLitActions/src/conditionalSigning.ts to this file

spacesailor24 · 2025-04-18T04:25:52Z

exampleLitActions/src/fetch.ts

+        publicKey:
+          "0x02e5896d70c1bc4b4844458748fe0f936c7919d7968341e391fb6d82c258192e64",


This should not be hardcoded, we should either use a PKP given to us as an ENV, or we should mint a new PKP like we do in exampleLitActions/src/conditionalSigning.ts

spacesailor24 · 2025-04-18T04:28:08Z

exampleLitActions/test/conditionalSigning.spec.ts

Update test to handle raw litNodeClient.executeJs response to determine if the code executed successfully or not

spacesailor24 · 2025-04-18T04:29:09Z

exampleLitActions/test/encryptDecrypt.spec.ts

+    const originalMessage = 'Hello world';
+
+    try {
+      const result = await encryptDecrypt();


We should pass the data to encrypt as a function parameter instead of hardcoding it

spacesailor24 · 2025-04-18T04:30:10Z

exampleLitActions/test/fetch.spec.ts

+  before(function() {
+    // Skip tests if required environment variables are missing
+    if (!process.env.ETHEREUM_PRIVATE_KEY) {
+      console.warn('⚠️ Tests require ETHEREUM_PRIVATE_KEY environment variable');
+      this.skip();
+    }
+  });


We shouldn't skip the tests an error should be thrown, and the getEnv util functions should catch/handle this

spacesailor24 · 2025-04-18T04:30:54Z

exampleLitActions/src/conditionalSigning.ts

+ * Execute conditional signing with Lit Protocol
+ * @returns Result of the conditional signing operation
+ */
+export const conditionalSigning = async (): Promise<ConditionalSigningResult> => {


Each code example should just be named runExample, this help us standardize the tests a little

madschristensen99 added 8 commits April 8, 2025 15:42

Create conditionalSigning.ts

c64251b

Add files via upload

08a4c6f

Create conditionalSigning.spec.ts

45d8412

add fetch and encrypt decrypt tests

8af7d10

add encrypt and decrypt test specs

9a52c69

remove artifact encryptDecrypt.ts

ff0b804

turn mock functionality into real functionality encryptDecrypt.ts

103020e

test success fetch.spec.ts

d2874ba

spacesailor24 requested review from spacesailor24 and awisniew207 April 11, 2025 21:46

madschristensen99 marked this pull request as ready for review April 14, 2025 18:55

spacesailor24 reviewed Apr 17, 2025

View reviewed changes

spacesailor24 self-requested a review April 18, 2025 03:42

spacesailor24 reviewed Apr 18, 2025

View reviewed changes

exampleLitActions/src/fetch.ts

Copy link

Contributor

spacesailor24 Apr 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apply the same comments from exampleLitActions/src/conditionalSigning.ts to this file

spacesailor24 reviewed Apr 18, 2025

View reviewed changes

spacesailor24 force-pushed the overhaul branch from 00efe9f to d2874ba Compare April 21, 2025 00:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Overhaul #94

Overhaul #94

madschristensen99 commented Apr 8, 2025

spacesailor24 Apr 17, 2025

spacesailor24 Apr 17, 2025

spacesailor24 Apr 17, 2025

spacesailor24 Apr 17, 2025 •

edited

Loading

spacesailor24 Apr 18, 2025

spacesailor24 Apr 18, 2025

spacesailor24 Apr 18, 2025

spacesailor24 Apr 18, 2025

spacesailor24 Apr 18, 2025

spacesailor24 Apr 18, 2025

spacesailor24 Apr 18, 2025

spacesailor24 Apr 18, 2025

spacesailor24 Apr 18, 2025

spacesailor24 Apr 18, 2025

spacesailor24 Apr 18, 2025

spacesailor24 Apr 18, 2025

spacesailor24 Apr 18, 2025

spacesailor24 Apr 18, 2025

spacesailor24 Apr 18, 2025

spacesailor24 Apr 18, 2025

spacesailor24 Apr 18, 2025

spacesailor24 Apr 18, 2025

spacesailor24 Apr 18, 2025

spacesailor24 Apr 18, 2025

spacesailor24 Apr 18, 2025

spacesailor24 Apr 18, 2025

		publicKey:
		"0x02e5896d70c1bc4b4844458748fe0f936c7919d7968341e391fb6d82c258192e64",

Overhaul #94

Are you sure you want to change the base?

Overhaul #94

Conversation

madschristensen99 commented Apr 8, 2025

Pre-Merge Standard Guide Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

spacesailor24 Apr 17, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

spacesailor24 Apr 17, 2025 •

edited

Loading