Skip to content

Latest commit

 

History

History
167 lines (111 loc) · 5.99 KB

README.md

File metadata and controls

167 lines (111 loc) · 5.99 KB
Raw

cardano-addresses TypeScript binding

This is a Typescript (or Javascript) version of the cardano-addresses API.

For the time being, this module is experimental, and exposes only a subset of the functionality of the Haskell API. We would like to increase the TypeScript binding's coverage of the Haskell API in future, as needs arise.

How it works

This package comprises of four parts:

Development Info

NodeJS module: Building and testing

Start a nix develop .#cardano-addresses-js-shell in the repo top-level directory and run:

$ nix develop .#cardano-addresses-js-shell
$ cd jsapi
$ npm install && npm run build
...
$ npm run test

Behind the scenes, this will use Nix to make the ghcjs build of the cardano-addresses library. The path to this Javascript file is stored in the $CARDANO_ADDRESSES_JS environment variable.

Haskell module: Building and testing

To try it out run nix develop .# from the repo top-level directory:

$ nix develop .#
$ cd jsapi
$ js-unknown-ghcjs-cabal build cardano-addresses-jsapi:jsapi-test
$ node dist-newstyle/build/js-ghcjs/ghcjs-8.10.4/cardano-addresses-jsapi-3.5.0/t/jsapi-test/build/jsapi-test/jsapi-test.jsexe/all.js

That test initializes the api from a JS function that is called from Main.hs. To build .js file that might be easier to use from a JS app run:

$ nix build .#cardano-addresses-js
$ tree ./result
result
├── cardano-addresses-jsapi.cjs.js
├── cardano-addresses-jsapi.esm.js
├── cardano-addresses-jsapi.js
└── cardano-addresses-jsapi.mjs

This replaces the regular runmain.js with jsapi/glue/runmain.js. That exposes a single function you can call and pass in a continuation.

To initialize, call the runCardanoAddressesApi with a continuation that like the one in jsapi/glue/test.js. You will be passed api and cleanup.

TODO

  • More API endpoints depending on user needs.
  • Used "typed" objects as parameters for the inspectAddress API, instead of strings which must be parsed.
  • Add a build step to optimise output file sizes (i.e. minification, tree shaking, etc).
  • Solve issue on nodejs where registered event handlers remain after API cleanup, preventing the nodejs runtime from exiting.
  • Add helper functions to the JSaddle API so that it can output code for ES6 Promises.
  • Bring back headless testing of JSaddle code.
  • Replace TSDX with a better build system.
  • Automatically update docs in CI.
  • Add release workflow to CI which builds the package and uploads to NPM.

More details

NodeJS package

For better or worse, this is based on the TSDX template. The TSDX standard documentation follows...

Commands

To run TSDX, use:

npm start # or yarn start

This builds to /dist and runs the project in watch mode so any edits you save inside src causes a rebuild to /dist.

To do a one-off build, use npm run build or yarn build.

To run tests, use npm test or yarn test.

Configuration

Code quality is set up for you with prettier, and lint-staged. Adjust the respective fields in package.json accordingly.

Jest

Jest tests are set up to run with npm test or yarn test.

Bundle Analysis

size-limit is set up to calculate the real cost of your library with npm run size and visualize the bundle with npm run analyze.

Rollup

TSDX uses Rollup as a bundler and generates multiple rollup configs for various module formats and build settings. See Optimizations for details.

TypeScript

tsconfig.json is set up to interpret dom and esnext types, as well as react for jsx. Adjust according to your needs.

Continuous Integration

GitHub Actions

Two actions are added by default:

  • tsdx-build which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
  • tsdx-size which comments cost comparison of your library on every pull request using size-limit

Optimizations

Please see the main tsdx optimizations docs. In particular, know that you can take advantage of development-only optimizations:

// ./types/index.d.ts
declare var __DEV__: boolean;

// inside your code...
if (__DEV__) {
  console.log('foo');
}

You can also choose to install and use invariant and warning functions.

Module Formats

CJS, ESModules, and UMD module formats are supported.

The appropriate paths are configured in package.json and dist/index.js accordingly. Please report if any issues are found.

Publishing to NPM

TSDX recommend using np.