Merge branch 'master' into wyatt/wrapped-keys-eip-712

Author: spacesailor24

siws-accs/browser/.env.example

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

siws-accs/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-accs/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-accs/browser/README.md

@@ -0,0 +1,54 @@
+# Sign-in With Solana Access Control Conditions
+
+The code example demonstrates how to create [Lit Access Control Conditions (ACCs)](https://developer.litprotocol.com/sdk/access-control/evm/basic-examples) that only allow access if a specific Solana wallet has signed a Sign-in With Solana (SIWS) message as defined by [Phantom's specification](https://github.com/phantom/sign-in-with-solana/tree/main?tab=readme-ov-file).
+
+This code example has a [corresponding doc page](https://developer.litprotocol.com/sdk/access-control/solana/siws-access-control) that covers the implementation in more detail, this repository acts as a reference implementation for you to use as a guide for implementing SIWS ACCs in your project.
+
+An example use case fo this functionality is permitting decryption capabilities to specific users on Solana based on their wallet address.
+
+## 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
+    - 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, 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-accs/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
+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
+
+The following diagram provides an overview of how this code example works:
+
+![Code Example Overview](./src/assets/siws-accs.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 Lit Action and ACCs that only returns true if the SIWS message was signed by your Solana public key.
+
+After successful execution, you should see `✅ Successfully signed SIWS message` in the JavaScript console and `Authentication Successful` 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 the generating the ACCs, generating Session Signatures, and executing the Lit Action
+- [litActionSiws.ts](./src/litActionSiws.ts): Contains the Lit Action code that authenticates the SIWS message, and executes the ACCs to check for authorization

siws-accs/browser/deno.jsonc

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

siws-accs/browser/deno.lock

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

siws-accs/browser/esbuild-shims.js

@@ -0,0 +1,15 @@
+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/litActionSiws.ts"],
+  outdir: "src/dist/",
+  bundle: true,
+  platform: "browser",
+  format: "esm",
+  target: "esnext",
+  minify: false,
+  inject: ["./esbuild-shims.js"],
+});
+await esbuild.stop();

siws-accs/browser/esbuild.js

@@ -0,0 +1,27 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Vite + React + TS</title>
+    <style>
+      body,
+      html {
+        margin: 0;
+        height: 100%;
+        display: flex;
+        justify-content: center;
+        align-items: center;
+      }
+      #root {
+        width: 100%;
+        text-align: center;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>

siws-accs/browser/index.html

@@ -0,0 +1,51 @@
+{
+  "name": "siws-accs-browser",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc -b && vite build",
+    "build:lit-action": "deno task bundle",
+    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "@esbuild-plugins/node-globals-polyfill": "^0.2.3",
+    "@esbuild-plugins/node-modules-polyfill": "^0.2.2",
+    "@lit-protocol/auth-browser": "^6.7.0",
+    "@lit-protocol/auth-helpers": "^6.5.3",
+    "@lit-protocol/constants": "^6.5.3",
+    "@lit-protocol/contracts-sdk": "^6.8.1",
+    "@lit-protocol/lit-node-client": "^6.5.3",
+    "@simplewebauthn/browser": "^10.0.0",
+    "@solana/wallet-adapter-base": "^0.9.23",
+    "@solana/wallet-adapter-react": "^0.15.35",
+    "@solana/wallet-adapter-react-ui": "^0.9.35",
+    "@solana/wallet-adapter-wallets": "^0.19.32",
+    "@solana/wallet-standard-features": "^1.2.0",
+    "@solana/wallet-standard-util": "^1.1.1",
+    "@solana/web3.js": "^1.95.3",
+    "@vitejs/plugin-react-swc": "^3.7.0",
+    "ethers": "v5",
+    "ipfs-only-hash": "^4.0.0",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "rollup-plugin-polyfill-node": "^0.13.0",
+    "vite-plugin-node-polyfills": "^0.22.0"
+  },
+  "devDependencies": {
+    "@lit-protocol/types": "^6.6.0",
+    "@types/react": "^18.3.3",
+    "@types/react-dom": "^18.3.0",
+    "@typescript-eslint/eslint-plugin": "^7.13.1",
+    "@typescript-eslint/parser": "^7.13.1",
+    "@vitejs/plugin-react": "^4.3.1",
+    "eslint": "^8.57.0",
+    "eslint-plugin-react-hooks": "^4.6.2",
+    "eslint-plugin-react-refresh": "^0.4.7",
+    "typescript": "^5.5.3",
+    "typestub-ipfs-only-hash": "^4.0.0",
+    "vite": "^5.3.1"
+  }
+}