README.md

Lit Protocol Javascript/Typescript SDK V7.x.x

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

Quick Start

NodeJS Exclusive

Removed browser-specific methods, e.g., checkAndSignAuthSig

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

or..

Isomorphic Implementation

Operable in both Node.js and the browser

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/constants
@lit-protocol/contracts-sdk
@lit-protocol/core
@lit-protocol/crypto
@lit-protocol/encryption
@lit-protocol/logger
@lit-protocol/misc
@lit-protocol/nacl
@lit-protocol/pkp-base
@lit-protocol/pkp-cosmos
@lit-protocol/pkp-ethers
@lit-protocol/pkp-sui
@lit-protocol/pkp-walletconnect
@lit-protocol/types
@lit-protocol/uint8arrays
@lit-protocol/wasm
@lit-protocol/wrapped-keys
@lit-protocol/wrapped-keys-lit-actions
@lit-protocol/auth-browser
@lit-protocol/misc-browser

API Doc

Version	Link
V7 (Current)	7.x.x docs
V6	6.x.x docs
V5	5.x.x docs
V2	2.x.x docs

Contributing and developing to this SDK

Prerequisite

• node (v19.x or above)
• rust (v1.70.00 or above)
• wasm-pack

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

Run unit tests

yarn test:unit

Run E2E tests in nodejs

yarn test:local

Advanced

Creating a new library

nx generate @nx/js:library

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.

Building changes to Rust source

If changes are made to packages/wasm see here for info on building from source.

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:local locally & ensure that they pass

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

6. Finally, publish with yarn publish:packages

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

Testing

Quick Start on E2E Testing

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

yarn test:local

Unit Tests

yarn test:unit

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

Error Handling

This SDK uses custom error classes derived from @openagenda/verror to handle errors between packages and to the SDK consumers. Normal error handling is also supported as VError extends the native Error class, but using VError allows for better error composition and information propagation. You can check their documentation for the extra fields that are added to the error object and methods on how to handle them in a safe way.

Example

import { VError } from '@openagenda/verror';
import { LitNodeClientBadConfigError } from '@lit-protocol/constants';

try {
  const someNativeError = new Error('some native error');

  throw new LitNodeClientBadConfigError(
    {
      cause: someNativeError,
      info: {
        foo: 'bar',
      },
      meta: {
        baz: 'qux',
      },
    },
    'some useful message'
  );
} catch (e) {
  console.log(e.name); // LitNodeClientBadConfigError
  console.log(e.message); // some useful message: some native error
  console.log(e.info); // { foo: 'bar' }
  console.log(e.baz); // qux
  // VError.cause(e) is someNativeError
  // VError.info(e) is { foo: 'bar' }
  // VError.meta(e) is { baz: 'qux', code: 'lit_node_client_bad_config_error', kind: 'Config' }
  // Verror.fullStack(e) is the full stack trace composed of the error chain including the causes
}

Creating a new error

In file packages/constants/src/lib/errors.ts you can find the list of errors that are currently supported and add new ones if needed.

To create and use a new error, you need to:

1. Add the error information to the LIT_ERROR object in packages/constants/src/lib/errors.ts
2. Export the error from the errors.ts file at the end of the file
3. Import the error where you need it
4. Throw the error in your code adding all the information a user might need to know about the error such as the cause, the info, etc.

Dockerfile

...coming soon

Other Commands

Interactive graph dependencies using NX

yarn graph

FAQs & Common Errors

(React) Failed to parse source map from

In your React package.json, add GENERATE_SOURCEMAP=false to your start script

eg.

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

Reference Error: crypto is not defined

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()
          )
        );
      },
    },
  },
});

error Command failed with exit code 13.

Make sure your node version is above v18.0.0