Merge pull request #77 from LIT-Protocol/wyatt/hacker-guide

Wyatt/hacker guide

Author: spacesailor24

hacker-guides/README.md

@@ -0,0 +1,33 @@
+# Lit Protocol Hackathon Starter Guide
+
+Welcome to the Lit Protocol Hackathon Starter Guide! This starter guide aims to simplify your onboarding process with the Lit Protocol, covering everything from installation to advanced functionalities like deploying Lit Actions and working with Programmable Key Pairs (PKPs).
+
+The Lit Protocol is a decentralized key management network that enables encryption, decryption, signing with distributed keys, and decentralized serverless functions.
+
+## Prerequisites
+
+- Node.js (v20 or higher)
+- npm or yarn
+- Basic understanding of JavaScript/TypeScript
+
+## How this Guide is Organized
+
+This guide is organized into several directories, each focusing on a different aspect of the Lit Protocol. It's intended that you start with the Getting Started directory, and then you can jump around to different directories based on your project needs.
+
+### Directories Overview
+
+- [Getting Started](./_getting-started/README.md):
+  - Overview of commonly used Lit terminology
+  - Installing commonly used Lit packages
+  - Connecting to a Lit Network with the Lit Node Client
+  - Generating an authenticated session to enable interaction with a Lit Network
+- [Encryption](./encryption/README.md)
+  - Client-side encryption/decryption
+  <!-- - Decryption within a Lit Action -->
+  - Access Control Conditions for encryption
+<!-- - [Decentralized Serverless Functions (Lit Actions)](./decentralized-serverless-functions/README.md)
+  - Deploying a Lit Action to IPFS
+  - Importing libraries into a Lit Action
+- [Signing with decentralized keys (Programmable Key Pairs)](./signing/README.md)
+  - Minting a Programmable Key Pair
+  - Signing data with a Programmable Key Pair in a Lit Action -->

hacker-guides/_getting-started/README.md

@@ -0,0 +1,147 @@
+<!-- omit in toc -->
+# Getting Started with the Lit SDK
+
+The Lit SDK is a set of libraries that enable various functionalities of the Lit Protocol. Each package is available on npm, and can be installed with your preferred JavaScript package manager.
+
+<!-- omit in toc -->
+## Table of Contents
+
+- [Lit Documentation](#lit-documentation)
+- [Core Terminology](#core-terminology)
+  - [Lit Node Client](#lit-node-client)
+  - [Lit Network](#lit-network)
+  - [Lit Chronicle Blockchain](#lit-chronicle-blockchain)
+  - [Session Signatures](#session-signatures)
+  - [Lit Resources and Abilities](#lit-resources-and-abilities)
+  - [Programmable Key Pair (PKP)](#programmable-key-pair-pkp)
+  - [Lit Action](#lit-action)
+- [Installing Common Lit SDK Packages](#installing-common-lit-sdk-packages)
+  - [@lit-protocol/lit-node-client](#lit-protocollit-node-client)
+  - [@lit-protocol/contracts-sdk](#lit-protocolcontracts-sdk)
+  - [@lit-protocol/constants](#lit-protocolconstants)
+  - [ethers.js@v5](#ethersjsv5)
+- [Next Steps](#next-steps)
+
+
+## Lit Documentation
+
+- [Lit Documentation](https://developer.litprotocol.com)
+  - This is the main source of information for the Lit Protocol. It contains guides, reference documentation, and other resources for developers.
+- [Lit SDK Api Documentation](https://v6-api-doc-lit-js-sdk.vercel.app)
+  - This is the API reference docs for the Lit SDK. It contains detailed information about the available methods and parameters for each package.
+- [Lit Actions Api Documentation](https://actions-docs.litprotocol.com)
+  - This is the API reference docs for Lit Actions. It contains detailed information about the available methods and parameters for Lit Actions.
+- [Lit Developer Code Examples](https://github.com/LIT-Protocol/developer-guides-code)
+  - This is a repository of code examples for various functionalities of the Lit Protocol. Each directory is a separate example demonstrating a specific functionality. Each example should include a `README.md` with a brief explanation of the code and how to run it.
+
+## Core Terminology
+
+### Lit Node Client
+
+An instance of the `LitNodeClient` class is used to interact with the Lit Network.
+
+### Lit Network
+
+The Lit Network is a decentralized network of nodes that are running the Lit Protocol on [AMD SEV-SNP](https://www.amd.com/content/dam/amd/en/documents/epyc-business-docs/solution-briefs/amd-secure-encrypted-virtualization-solution-brief.pdf) enabled hardware to provide the Multi-Party Computation (MPC) services that are used by the Lit Protocol.
+
+### Lit Chronicle Blockchain
+
+The blockchain used by the Lit Networks to store the state of the Lit Protocol such as Programmable Key Pairs (PKPs) and their permitted Authentication Methods.
+
+### Session Signatures
+
+A **Session** in the Lit Protocol is a temporary context that allows users to interact with Lit Resources securely without repeatedly signing transactions with their wallets. Sessions are established using an ephemeral **Session Key Pair** (a locally generated public and private key), where:
+
+- **Session Private Key**: Held securely by the user and used to sign requests to the Lit network.
+- **Session Public Key**: Shared with the Lit network and used by nodes to verify the session's requests.
+
+**Session Signatures** are aggregated signatures generated by Lit nodes. They authenticate a Session Key Pair, authorizing it to access specified Lit Resources with defined Abilities for a certain period. Essentially, Session Signatures delegate permissions from your authenticated blockchain account to an ephemeral Session Key.
+
+### Lit Resources and Abilities
+
+**Lit Resources** identify the core Lit assets that can be utilized within the Lit Protocol:
+
+- **Access Control Conditions (ACCs)**: Rules that express the conditions under which access to a resource is granted. They are used to determine who can decrypt data, but can also be used arbitrarily as a permissioning mechanism.
+- **Lit Actions**: Serverless functions that run on the Lit network.
+- **Programmable Key Pairs (PKPs)**: Distributed key pairs for signing.
+
+**Abilities** are specific permissions that define what actions can be performed with these resources. When generating a session (Session Signatures), you explicitly specify which resources the session can access, what abilities (permissions) the session has for each resource, and the duration these permissions are valid.
+
+This granular control ensures that sessions operate with the principle of least privilege, only having access to the specific resources and abilities they need.
+
+### Programmable Key Pair (PKP)
+
+A PKP is a key pair where the private key is generated by Lit's MPC network, and is never revealed in entirety to any single party. Instead, the private key is split into multiple shares and distributed to the MPC nodes. A threshold of the MPC nodes need to cooperate to construct signature shares that can be combined to form a valid signature.
+
+### Lit Action
+
+A Lit Action is a decentralized serverless function that is executed by each Lit Node in the network to reach consensus on the result of the function.
+
+## Installing Common Lit SDK Packages
+
+Below is a list of the most commonly used Lit SDK packages:
+
+### [@lit-protocol/lit-node-client](https://v6-api-doc-lit-js-sdk.vercel.app/modules/lit_node_client_src.html)
+
+Connects to a Lit Network and provides methods for interacting with the network, such as getting session signatures and performing encryption/decryption.
+
+This package is almost always required for any project using Lit.
+
+```bash
+npm install @lit-protocol/lit-node-client
+```
+
+```bash
+yarn add @lit-protocol/lit-node-client
+```
+
+### [@lit-protocol/contracts-sdk](https://v6-api-doc-lit-js-sdk.vercel.app/modules/contracts_sdk_src.html)
+
+Provides a set of interfaces and helper functions for interacting with the contracts that are deployed on the Lit Chronicle blockchain.
+
+This package is useful for minting Programmable Key Pairs (PKPs), and managing their permitted Authentication Methods.
+
+```bash
+npm install @lit-protocol/contracts-sdk
+```
+
+```bash
+yarn add @lit-protocol/contracts-sdk
+```
+
+### [@lit-protocol/constants](https://v6-api-doc-lit-js-sdk.vercel.app/modules/constants_src.html)
+
+A package containing useful constants for use across the SDK.
+
+Some useful constants include:
+
+- `LitNetwork`: An object containing the correct chain identifier for each available Lit Network.
+  - For the purposes of a hackathon, you should be using `LitNetwork.DatilDev`.
+- `LIT_RPC`: An object containing the RPC URLs for each available Lit blockchain network.
+  - For the purposes of a hackathon, you should be using `LIT_RPC.CHRONICLE_YELLOWSTONE`.
+
+```bash
+npm install @lit-protocol/constants
+```
+
+```bash
+yarn add @lit-protocol/constants
+```
+
+---
+
+### [ethers.js@v5](https://docs.ethers.org/v5/)
+
+A popular library for interacting with Ethereum-based blockchains. Lit uses version `v5` of ethers.js.
+
+```bash
+npm install ethers@v5
+```
+
+```bash
+yarn add ethers@v5
+```
+
+## Next Steps
+
+Now that you have an understanding of the core terminology and have installed the common Lit SDK packages, you can continue on to the code example for instantiating a `LitNodeClient` to connect to a Lit Network: [Connecting to Lit](./connecting-to-lit/README.md).

hacker-guides/_getting-started/authenticating-a-session/.env.example

@@ -0,0 +1 @@
+ETHEREUM_PRIVATE_KEY=

hacker-guides/_getting-started/authenticating-a-session/.mocharc.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://json.schemastore.org/mocharc.json",
+  "require": "tsx"
+}