Merge pull request #64 from LIT-Protocol/wyatt/siws

Inits SIWS example to generate Session Sigs and decrypt a string

Author: spacesailor24

siws-accs/browser/README.md

@@ -14,7 +14,7 @@ An example use case fo this functionality is permitting decryption capabilities
       - In order to pay for this, the corresponding Ethereum account must have Lit Test Tokens. If you do not have any, you can get some from [the faucet](https://chronicle-yellowstone-faucet.getlit.dev/)
     - Create a Lit Capacity Credit delegation Auth Sig
     - Create Lit Session Signatures for the request to the Lit network to execute a Lit Action that authenticates the SIWS message and check for authorization by executing the Access Control Conditions
-- This code example uses Node.js and Yarn, please have these installed before running the example
+- This code example uses Node.js, Yarn, and Deno please have these installed before running the example
 - The code example also expects the [Phantom wallet browser extension](https://chromewebstore.google.com/detail/phantom/bfnaelmomeimhlpmgjnjophhpkkoljpa?hl=en) to be installed and setup with a Solana wallet
 
 ## Installation and Setup

siws-authentication/browser/README.md

@@ -11,7 +11,7 @@ This code example has a [corresponding doc page](https://developer.litprotocol.c
     - Mint a Lit Capacity Credit if none was specific in the project's `.env` file
       - In order to pay for this, the corresponding Ethereum account must have Lit Test Tokens. If you do not have any, you can get some from [the faucet](https://chronicle-yellowstone-faucet.getlit.dev/)
     - Create a Lit Capacity Credit delegation Auth Sig
-- This code example uses Node.js and Yarn, please have these installed before running the example
+- This code example uses Node.js, Yarn, and Deno please have these installed before running the example
 - The code example also expects the [Phantom wallet browser extension](https://chromewebstore.google.com/detail/phantom/bfnaelmomeimhlpmgjnjophhpkkoljpa?hl=en) to be installed and setup with a Solana wallet
 
 ## Installation and Setup

siws-encryption/browser/.env.example

@@ -0,0 +1 @@
+VITE_ETHEREUM_PRIVATE_KEY=

siws-encryption/browser/.eslintrc.cjs

@@ -0,0 +1,18 @@
+module.exports = {
+  root: true,
+  env: { browser: true, es2020: true },
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:react-hooks/recommended",
+  ],
+  ignorePatterns: ["dist", ".eslintrc.cjs"],
+  parser: "@typescript-eslint/parser",
+  plugins: ["react-refresh"],
+  rules: {
+    "react-refresh/only-export-components": [
+      "warn",
+      { allowConstantExport: true },
+    ],
+  },
+};

siws-encryption/browser/.gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

siws-encryption/browser/README.md

@@ -0,0 +1,68 @@
+# Encrypting Data with Sign-in With Solana
+
+This example demonstrates how to use Lit Protocol to encrypt and decrypt data based on authenticated Solana public keys. It leverages three key components:
+
+1. Lit Access Control Conditions
+2. Sign-in With Solana (SIWS) messages (following [Phantom's specification](https://github.com/phantom/sign-in-with-solana/tree/main))
+3. Lit Actions
+
+By combining these technologies, we create a secure system for data decryption tied to Solana wallet authentication.
+
+This code example has a [corresponding doc page](https://developer.litprotocol.com/sdk/access-control/solana/siws-encryption) that covers the implementation in more detail, this repository acts as a reference implementation for you to use as a guide for restricting data decryption to specific Solana public keys in your project.
+
+## Prerequisites
+
+- An Ethereum private key
+  - This private key will be used to:
+    - Mint a Lit Capacity Credit if none was specific in the project's `.env` file
+      - In order to pay for this, the corresponding Ethereum account must have Lit Test Tokens. If you do not have any, you can get some from [the faucet](https://chronicle-yellowstone-faucet.getlit.dev/)
+    - Create a Lit Capacity Credit delegation Auth Sig
+    - Mint a PKP if none was specific in the project's `.env` file
+- This code example uses Node.js, Yarn, and Deno please have these installed before running the example
+- The code example also expects the [Phantom wallet browser extension](https://chromewebstore.google.com/detail/phantom/bfnaelmomeimhlpmgjnjophhpkkoljpa?hl=en) to be installed and setup with a Solana wallet
+
+## Installation and Setup
+
+1. Clone the repository
+2. `cd` into the code example directory: `cd siws-session-sigs/browser`
+3. Install the dependencies: `yarn`
+4. Create and fill in the `.env` file: `cp .env.example .env`
+   - `VITE_ETHEREUM_PRIVATE_KEY`: **Required** This is the Ethereum private key that will be used to mint a Lit Capacity Credit and create Lit Session Signatures
+   - `VITE_LIT_CAPACITY_CREDIT_TOKEN_ID`: **Optional** This is the ID of the Lit Capacity Credit to use for the PKP delegation Auth Sig
+   - `VITE_LIT_PKP_PUBLIC_KEY`: **Optional** This is the public key of the PKP to use for generating Session Signatures
+   - `VITE_LIT_PKP_TOKEN_ID`: **Optional** This is the ID of the PKP to use for generating Session Signatures
+5. Build the Lit Action file: `yarn build:lit-action`
+6. Start the development server: `yarn dev`
+
+## Executing the Example
+
+1. Open the app in your browser: http://localhost:5173
+2. Open the JavaScript browser console
+3. Click the `Select Wallet` button and connect your Phantom wallet
+4. Click the `Sign In` button to sign the SIWS message
+5. Enter some text in the encryption input field and click the `Encrypt` button
+6. Click the `Decrypt` button to decrypt the data
+
+The following diagram provides an overview of how this code example works:
+
+![Code Example Overview](./src/assets/siws-session-signatures.png)
+
+### Expected Output
+
+After clicking the `Sign In` button, the code example will submit your signed SIWS message to the Lit network to be authenticated using a Lit Action and will generate Session Signatures using the minted PKP if the signing Solana public key is authorized to use the PKP.
+
+After successful execution, you should see `✅ Got Session sigs` in the JavaScript console and `Session Sigs generated successfully` on the web page:
+
+![Successful execution](./src/assets/successful-execution.png)
+
+## Specific Files to Reference
+
+- [App.tsx](./src/App.tsx): Contains the frontend code and logic for the example
+- [SignInButton.tsx](./src/SignInButton.tsx): Contains the code for the `Sign In` button that creates and submits the SIWS message to the browser wallet extension
+- [litSiws.ts](./src/litSiws.ts): Contains the code for:
+  - Minting a Capacity Credit if none was specified in the `.env` file
+  - Generating the Capacity Credit delegation Auth Sig
+  - Minting a PKP if none was specified in the `.env` file
+  - Adding the permitted Auth Methods to the PKP
+  - Executing the Lit Action to authenticate the SIWS message and generate Session Signatures
+- [litActionSessionSigs.ts](./src/litActionSessionSigs.ts): Contains the Lit Action code that authenticates the SIWS message, checks the PKPs permitted Auth Methods, and signals the Lit Network to generate Session Signatures

siws-encryption/browser/deno.jsonc

@@ -0,0 +1,5 @@
+{
+  "tasks": {
+    "bundle": "deno run --allow-read --allow-write --allow-env --allow-net --allow-run esbuild.js"
+  }
+}

siws-encryption/browser/deno.lock

@@ -0,0 +1,3 @@
+globalThis.process = {
+  env: {},
+};

siws-encryption/browser/esbuild-shims.js

@@ -0,0 +1,18 @@
+import * as esbuild from "https://deno.land/x/[email protected]/mod.js";
+import { denoPlugins } from "jsr:@luca/esbuild-deno-loader@^0.10.3";
+
+esbuild.build({
+  plugins: [...denoPlugins()],
+  entryPoints: [
+    "src/litActions/litActionSessionSigs.ts",
+    "src/litActions/litActionDecrypt.ts",
+  ],
+  outdir: "src/litActions/dist/",
+  bundle: true,
+  platform: "browser",
+  format: "esm",
+  target: "esnext",
+  minify: false,
+  inject: ["./esbuild-shims.js"],
+});
+await esbuild.stop();