The cardano-js-sdk from james-iohk

james-iohk / cardano-js-sdk Goto Github PK

View Code? Open in Web Editor NEW

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

License: Apache License 2.0

TypeScript 98.47% JavaScript 1.28% Shell 0.26%

cardano-js-sdk's Introduction

Cardano JS SDK

Overview

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

Cardano Provider Implementations

ℹ️ 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');
{
  plugins: [
    // see https://www.npmjs.com/package/bip39 README
    new IgnorePlugin(/^\.\/wordlists\/(?!english)/, /bip39\/src$/),
  ],
  experiments: {
    // Requires code splitting to work.
    // Must dynamically `import()` a chunk that imports '@cardano-sdk/*'.
    syncWebAssembly: true
  }
}

Additionally, for browser builds:

const { NormalModuleReplacementPlugin } = require('webpack');
{
  resolve: {
    fallback: {
      // Node.js polyfills. May want to install as explicit dependencies.
      stream: require.resolve('readable-stream'),
      buffer: require.resolve('buffer'),
    }
  },
  plugins: [
    // install "browser" version packages of these dependencies first
    new NormalModuleReplacementPlugin(
      /@emurgo\/cardano-serialization-lib-nodejs/,
      '@emurgo/cardano-serialization-lib-browser'
    ),
    new NormalModuleReplacementPlugin(
      /@emurgo\/cardano-message-signing-nodejs/,
      '@emurgo/cardano-message-signing-browser'
    )
  ]
}