B58-Finance / cardano-js-sdk

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

Cardano JS SDK

---

Overview

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

• @cardano-sdk/core
• @cardano-sdk/cip2
• @cardano-sdk/cip30
• @cardano-sdk/wallet
• @cardano-sdk/util-dev

Cardano Provider Implementations

• @cardano-sdk/cardano-graphql-db-sync
• @cardano-sdk/blockfrost

ℹ️ Looking to use a Cardano service not listed here? Let us know!

Webpack

You may use the following config when bundling this SDK with Webpack:

const { IgnorePlugin, ProvidePlugin } = require('webpack');
{
  resolve: {
    // For browser builds only
    fallback: {
      // May want to install readable-stream as an explicit dependency
      stream: require.resolve('readable-stream'),
    }
  },
  plugins: [
    new HtmlWebpackHarddiskPlugin(),
    // see https://www.npmjs.com/package/isomorphic-bip39 README
    new IgnorePlugin(/^\.\/wordlists\/(?!english)/, /bip39\/src$/),
  ],
  experiments: {
    asyncWebAssembly: true
  }
}

Testing

• @cardano-sdk/golden-test-generator

Development

A Yarn Workspace maintaining a single version across all packages.

System Requirements

• Docker 17.12.0+
• Docker Compose

Install and Build

yarn install && \
yarn build

Run Tests

yarn testnet:up

In another terminal

yarn test

or

yarn test:debug

Lint

yarn lint

Cleanup

yarn cleanup

Distribute

Pack

./scripts/pack.sh

Publish to npm.org

./scripts/publish.sh

Generate Docs

yarn docs

Maintenance

Bump Version

yarn bump-version

Then update the sibling dependencies manually.

New package checklist

1. Extend packageMap in .versionrc.js
2. Extend pack.sh
3. Extend publish.sh

📖 Documentation