Skip to main content

Install the SDK

Install the client package in your app:

npm install @liquidium/client

Package runtime support

The published package provides ECMAScript module (ESM) and CommonJS entry points. Your runtime must provide global fetch and BigInt support. The package does not declare a Node.js engine range.

Build the repository

To build and test a local checkout, follow these steps:

  1. Clone the repository and enter its directory:

    git clone https://github.com/Liquidium-Inc/liquidium-sdk.git
    cd liquidium-sdk
  2. Install the workspace dependencies:

    pnpm install
  3. Build, type-check, and test the workspace:

    pnpm run build
    pnpm run typecheck
    pnpm run test

The repository development tools have the following requirements:

RequirementNotes
Node.js20.19 or later in the 20.x line, or 22.12 or later
pnpm11 or later for local development