Lit Protocol Javascript/Typescript SDK V4.2.0

The Lit JavaScript SDK provides developers with a framework for implementing Lit functionality into their own applications. Find installation instructions in the docs to get started with the Lit SDK based on your use case:

https://developer.litprotocol.com/SDK/Explanation/installation

This new V3 SDK is written in Typescript and is a complete rewrite of the old SDK. It is much more modular and easier to use, and has a much smaller bundle size.

yarn add @lit-protocol/lit-node-client-nodejs

yarn add @lit-protocol/lit-node-client

Packages

📝 If you're looking to use the Lit SDK, you're probably all set with just the lit-node-client .
Get started with interacting with Lit network!

Package	Category	Download
@lit-protocol/lit-node-client-nodejs
@lit-protocol/lit-node-client

If you're a tech-savvy user and wish to utilize only specific submodules that our main module relies upon, you can find individual packages listed below. This way, you can import only the necessary packages that cater to your specific use case::

Package	Category	Download
@lit-protocol/access-control-conditions
@lit-protocol/auth-helpers
@lit-protocol/bls-sdk
@lit-protocol/constants
@lit-protocol/contracts-sdk
@lit-protocol/core
@lit-protocol/crypto
@lit-protocol/ecdsa-sdk
@lit-protocol/encryption
@lit-protocol/logger
@lit-protocol/misc
@lit-protocol/nacl
@lit-protocol/pkp-base
@lit-protocol/pkp-client
@lit-protocol/pkp-cosmos
@lit-protocol/pkp-ethers
@lit-protocol/pkp-sui
@lit-protocol/pkp-walletconnect
@lit-protocol/sev-snp-utils-sdk
@lit-protocol/types
@lit-protocol/uint8arrays
@lit-protocol/auth-browser
@lit-protocol/misc-browser

API Doc

• V3 (Current): https://v3.api-docs.getlit.dev/

Old APIs Doc(s)

• V2: http://docs.lit-js-sdk-v2.litprotocol.com/
  

Contributing and developing to this SDK

Prerequisite

• node (v18.0.0)

Recommended

• NX Console: https://nx.dev/core-features/integrate-with-editors

Quick Start

The following commands will help you start developing with this repository.

First, install the dependencies via yarn:

yarn

Building

You can build the project with the following commands:

// for local development - It stripped away operations that don't matter for local dev
yarn build:dev

// you should never need to use yarn build unless you want to test or publish it
yarn build

Running Test Apps

The test apps are configured to automatically import all modules and expose all module functions. For browsers, you can access these functions using window.LitJsSdk_<package_name>.<function_name>

// Running apps...
// react: http://localhost:4003
// nodejs: in the terminal
yarn apps

or running individually

// react
yarn nx run react:serve

// nodejs
yarn nx run nodejs:serve

Run unit tests

yarn test:unit

Run E2E tests

// -- web
yarn test:e2e:web

// -- node
yarn test:e2e:node

Advanced

Creating a new library

By default, NX provides a command to generate a library nx generate @nx/js:library. However, it doesn't have an esbuild built-in so that we've created a custom tool that modify the build commands.

yarn gen:lib <package-name> <tag>

Create a new react demo app using the Lit JS SDK

yarn tools --create --react contracts-sdk --demo

Deleting a package or app

// delete an app from ./app/<app-name>
yarn delete:app <app-name>

// delete a package from ./packages/<package-name>
yarn delete:package <package-name>

Building

yarn build

Building target package

yarn nx run <project-name>:build

Building Local Changes

During development you may wish to build your code changes in packages/ in a client application to test the correctness of the functionality.

If you would like to establish a dependency between packages within this monorepo and an external client application that consumes these packages:

1. Run npm link at the root of the specific package you are making code changes in.

cd ./packages/*/<package-name>
npm link

2. Build the packages with or without dependencies

yarn build
# or
yarn nx run lit-node-client-nodejs:build --with-deps=false

3. In the client application, run npm link <package> --save to ensure that the package.json of the client application is updated with a file: link to the dependency. This effectively creates a symlink in the node_modules of the client application to the local dependency in this repository.

cd path/to/client-application
npm link <package> --save

Having done this setup, this is what the development cycle looks like moving forward:

1. Make code change
2. Rebuild specific package
3. Rebuild client application.

Publishing

You must have at least nodejs v18 to do this.

1. Install the latest packages with yarn install

2. Run yarn bump to bump the version

3. Build all the packages with yarn build

4. Run the unit tests with yarn test:unit & e2e node tests yarn test:e2e:nodejs locally & ensure that they pass

5. Update the docs with yarn gen:docs --push

6. Finally, publish with the @cayenne tag: yarn publish:cayenne

7. Commit these changes "Published version X.X.X"

Publishing to Serrano / Jalapno

git checkout serrano
yarn bump
yarn build
yarn node ./tools/scripts/pub.mjs --tag serrano-jalapeno

Testing

Quick Start on E2E Testing

The following will serve the react testing app and launch the cypress e2e testing after

yarn test:e2e:web
or
yarn test:e2e:node

Environments

There are currently three environments can be tested on, each of which can be generated from a custom command, which would automatically import all the libraries in ./packages/*. The UI of HTML & React are visually identical but they are using different libraries.

Unit Tests

yarn test:unit

E2E Testing with Metamask using Cypress (for Browser)

React

// E2E React
yarn tools --test --e2e react

Testing with a Local Lit Node

First, deploy your Lit Node Contracts, since the correct addresses will be pulled from the ../lit-assets/blockchain/contracts/deployed-lit-node-contracts-temp.json file.

Set these two env vars:

export LIT_JS_SDK_LOCAL_NODE_DEV="true"
export LIT_JS_SDK_FUNDED_WALLET_PRIVATE_KEY="putAFundedPrivateKeyOnChronicleHere"

Run:

yarn update:contracts-sdk --fetch
yarn update:contracts-sdk --gen
yarn build:packages

To run manual tests:

 yarn nx run nodejs:serve

ENV Vars

• LIT_JS_SDK_GITHUB_ACCESS_TOKEN - a github access token to get the contract ABIs from a private repo
• LIT_JS_SDK_LOCAL_NODE_DEV - set to true to use a local node
• LIT_JS_SDK_FUNDED_WALLET_PRIVATE_KEY - set to a funded wallet on Chronicle Testnet

Dockerfile

...coming soon

Other Commands

Interactive graph dependencies using NX

yarn graph

FAQs & Common Errors

  "scripts": {
    "start": "GENERATE_SOURCEMAP=false react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test",
    "eject": "react-scripts eject"
  },

"_buildWeb": {
    "executor": "@websaam/nx-esbuild:package",
    "options": {
      "banner": {
        "js": "import { createRequire } from 'module';const require = createRequire(import.meta.url);"
      },
      "globalName": "LitJsSdk_CoreBrowser",
      "outfile":"dist/packages/core-browser-vanilla/core-browser.js",
      "entryPoints": ["./packages/core-browser/src/index.ts"],
      "define": { "global": "window" },
      "plugins":[
        {
          "package": "esbuild-node-builtins",
          "function": "nodeBuiltIns"
        }
      ]
    }
  }

import crypto, { createHash } from 'crypto';
Object.defineProperty(globalThis, 'crypto', {
  value: {
    getRandomValues: (arr: any) => crypto.randomBytes(arr.length),
    subtle: {
      digest: (algorithm: string, data: Uint8Array) => {
        return new Promise((resolve, reject) =>
          resolve(
            createHash(algorithm.toLowerCase().replace('-', ''))
              .update(data)
              .digest()
          )
        );
      },
    },
  },
});