input-output-hk/cardano-js-sdk

Cardano JS SDK

Overview

A suite of TypeScript packages suitable for both Node.js and browser-based development.

• @cardano-sdk/core
• @cardano-sdk/input-selection
• @cardano-sdk/dapp-connector
• @cardano-sdk/governance
• @cardano-sdk/key-management
• @cardano-sdk/web-extension
• @cardano-sdk/wallet
• @cardano-sdk/projection
• @cardano-sdk/util-rxjs
• @cardano-sdk/util
• @cardano-sdk/util-dev
• @cardano-sdk/cardano-services
• @cardano-sdk/cardano-services-client

Supported Environments

Packages are distributed as both CommonJS and ESM modules.

• Node.js >=14.20.1
  • using with type="module" requires --experimental-specifier-resolution=node flag
• Browser via bundlers (see example webpack config)

Getting Started

The GETTING_STARTED guide provides a quick way to start experimenting.

Testing

• @cardano-sdk/golden-test-generator

Development

A Yarn Workspace maintaining a single version across all packages.

System Requirements

• nvm
• yarn
• Node.js 14 or later
• Docker Desktop 3.4 or later or a Docker installation that includes Compose V2

Clone

git clone \
  https://github.com/input-output-hk/cardano-js-sdk.git \
  && cd cardano-js-sdk

Install and Build

nvm install && \
nvm use && \
yarn install && \
yarn build

Run Tests

yarn test

or

yarn test:debug

Lint

yarn lint
yarn lint --fix

Cleanup

yarn cleanup

Update Cardano configuration subrepo

With yarn

Requires git-subrepo to be installed.

yarn config:update

With nix

Requires Nix, will install git-subrepo for you.

nix run .#config-update

Distribute

Pack

./scripts/pack.sh

Publish to npm.org

./scripts/publish.sh

Generate Docs

yarn docs

📖 Documentation