Liquid Development Kit

Liquid Development Kit provides abstractions to speed-up implementation of elements-based wallets for browsers and NodeJS

Commands

• Run for development

$ yarn start

This builds to /dist and runs the project in watch mode so any edits you save inside src causes a rebuild to /dist.

• Build

$ yarn build.

• Test

$ yarn test

• Lint

$ yarn lint
# Fix errors
$ yarn lint --fix

Configuration

Code quality is set up for you with prettier, husky, and lint-staged. Adjust the respective fields in package.json accordingly.

Jest

Jest tests are set up to run with npm test or yarn test.

Bundle Analysis

size-limit is set up to calculate the real cost of your library with npm run size and visualize the bundle with npm run analyze.

Rollup

TSDX uses Rollup as a bundler and generates multiple rollup configs for various module formats and build settings. See Optimizations for details.

TypeScript

tsconfig.json is set up to interpret dom and esnext types, as well as react for jsx. Adjust according to your needs.

Continuous Integration

GitHub Actions

Two actions are added by default:

• main which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
• size which comments cost comparison of your library on every pull request using size-limit