Skip to content

🚧 Work in progress: JavaScript SDK for interacting with Cardano, providing various key management options, support for popular hardware wallets

License

Notifications You must be signed in to change notification settings

sean118/cardano-js-sdk

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cardano JS SDK

PostIntegration Nightly Release


Overview

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

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)

Testing

Development

A Yarn Workspace maintaining a single version across all packages.

System Requirements

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

About

🚧 Work in progress: JavaScript SDK for interacting with Cardano, providing various key management options, support for popular hardware wallets

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 75.8%
  • Nix 19.9%
  • Shell 2.8%
  • JavaScript 1.2%
  • Other 0.3%