https://github.com/input-output-hk/cardano-js-sdk
JavaScript SDK for interacting with Cardano, providing various key management options, with support for popular hardware wallets
https://github.com/input-output-hk/cardano-js-sdk
Last synced: 20 days ago
JSON representation
JavaScript SDK for interacting with Cardano, providing various key management options, with support for popular hardware wallets
- Host: GitHub
- URL: https://github.com/input-output-hk/cardano-js-sdk
- Owner: input-output-hk
- License: apache-2.0
- Created: 2019-04-29T21:29:04.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-12T23:54:34.000Z (about 1 month ago)
- Last Synced: 2025-03-17T06:38:39.624Z (about 1 month ago)
- Language: TypeScript
- Homepage: https://input-output-hk.github.io/cardano-js-sdk/
- Size: 1.11 GB
- Stars: 220
- Watchers: 34
- Forks: 62
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- best-of-crypto - GitHub - 32% open · ⏱️ 05.06.2024): (Smart Contract Platforms)
README
Cardano JS SDK
[![PostIntegration][img_src_post-integration]][workflow_post-integration]
[![Release][img_src_release]][workflow_release]
## Overview
A suite of TypeScript packages suitable for both Node.js and browser-based development.
- [@cardano-sdk/core](./packages/core)
- [@cardano-sdk/crypto](./packages/crypto)
- [@cardano-sdk/input-selection](./packages/input-selection)
- [@cardano-sdk/dapp-connector](./packages/dapp-connector)
- [@cardano-sdk/governance](./packages/governance)
- [@cardano-sdk/key-management](./packages/key-management)
- [@cardano-sdk/web-extension](./packages/web-extension)
- [@cardano-sdk/wallet](./packages/wallet)
- [@cardano-sdk/projection](./packages/projection)
- [@cardano-sdk/util-rxjs](./packages/util-rxjs)
- [@cardano-sdk/util](./packages/util)
- [@cardano-sdk/util-dev](./packages/util-dev)
- [@cardano-sdk/cardano-services](./packages/cardano-services)
- [@cardano-sdk/cardano-services-client](./packages/cardano-services-client)### Supported Environments
Packages are distributed as both CommonJS and ESM modules.
- Node.js >=16.20.2
- using with `type="module"` requires `--experimental-specifier-resolution=node` flag
- Browser via bundlers (see [example webpack config](./packages/e2e/test/web-extension/webpack.config.js))### Getting Started
The [GETTING_STARTED](./GETTING_STARTED.md) guide provides a quick way to start experimenting.
### Testing
- [@cardano-sdk/golden-test-generator](./packages/golden-test-generator)
## Deployments
Automatic deployments are done for:
- [dev-preview](https://dev-preview.lw.iog.io/v1.0.0/health) - On each push to master
- [dev-preprod](https://dev-preprod.lw.iog.io/v1.0.0/health) - On each release
- [dev-mainnet](https://dev-mainnet.lw.iog.io/v1.0.0/health) - On each releaseManual deployments can be done via [STD Workflow](https://github.com/input-output-hk/cardano-js-sdk/actions/workflows/std.yml)
- Click 'Run workflow'
- Select branch
- Check checkboxes for environments that should be deployed
- Click 'Run workflow'## Development
A Yarn Workspace maintaining a single version across all packages.
#### System Requirements
- [nvm](https://github.com/nvm-sh/nvm)
- [yarn](https://yarnpkg.com/getting-started/install)
- [Node.js](https://nodejs.org/en/download) 16 or later
- [Docker Desktop] 3.4 or later or a Docker installation that includes Compose V2#### Clone
```bash
git clone \
https://github.com/input-output-hk/cardano-js-sdk.git \
&& cd cardano-js-sdk
```#### Install and Build
```bash
nvm install && \
nvm use && \
DETECT_CHROMEDRIVER_VERSION=true yarn global add chromedriver && \
yarn install && \
yarn build
```The web extension e2e tests uses [chromedriver](https://www.npmjs.com/package/chromedriver). `chromedriver` and your Chrome browser versions should match, if they don’t the driver will error. If you have issues, try running `yarn workspace @cardano-sdk/e2e remove chromedriver && yarn workspace @cardano-sdk/e2e add chromedriver` to reinstall the latest version.
#### Run Tests
```bash
yarn test
```or
```bash
yarn test:debug
```### Lint
```bash
yarn lint
yarn lint --fix
```### Cleanup
```
yarn cleanup
```### Update Cardano configuration subrepo
#### With `yarn`
Requires [git-subrepo](https://github.com/git-commands/git-subrepo) to be
installed.```
yarn config:update
```#### With `nix`
Requires [Nix](https://nixos.org/download.html), will install `git-subrepo`
for you.```
nix run .#config-update
```## Get CBOR representation of an on chain transaction
Once we have a [running network](packages/cardano-services/README.md#production) synced at least up to the block
containing the transaction we are interested in, issue following command to get the CBOR representation of the
transaction.```
yarn tx-cbor
```This works regardless of the local ports configuration through environment variables.
## Attic
Previously supported features, no longer supported, but packed with a reference branch.
- [RabbitMQ tx-submit provider and worker](https://github.com/input-output-hk/cardano-js-sdk/tree/attic/rabbitmq)
## Distribute
### Pack
```bash
./scripts/pack.sh
```### Publish to npm.org
```bash
./scripts/publish.sh
```### Generate Docs
```bash
yarn docs
```### Possible issues
- `yarn build --mode=skip-build` [in Docker image](https://github.com/input-output-hk/cardano-js-sdk/pull/1024)
[img_src_post-integration]: https://github.com/input-output-hk/cardano-js-sdk/actions/workflows/post_integration.yml/badge.svg
[workflow_post-integration]: https://github.com/input-output-hk/cardano-js-sdk/actions/workflows/post_integration.yml
[img_src_release]: https://github.com/input-output-hk/cardano-js-sdk/actions/workflows/release.yaml/badge.svg
[workflow_release]: https://github.com/input-output-hk/cardano-js-sdk/actions/workflows/release.yaml
[docker desktop]: https://docs.docker.com/desktop/
[let us know!]: https://github.com/input-output-hk/cardano-graphql/discussions/new