Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 1.25 KB

README.md

File metadata and controls

52 lines (34 loc) · 1.25 KB
Raw

🛠 tdex-sdk

JavaScript SDK for building trader-facing applications on top of TDEX

⬇️ Install

  • Install with yarn
$ yarn add tdex-sdk@beta
  • Install with npm
$ npm install --save tdex-sdk@beta

📄 Usage

In-depth documentation for using the tdex-sdk is available at docs.tdex.network

🛣 Roadmap

  • Swap protocol
  • Trade protocol
  • HD Wallet support
  • Browser support
  • Blinding support
  • Sign with WIF
  • Sign with Mnemonic
  • Sign with Liquality
  • Sign with Ledger Nano
  • Sign with Trezor

🖥 Local Development

Below is a list of commands you will probably find useful.

yarn start

Runs the project in development/watch mode. Your project will be rebuilt upon changes. Error messages are pretty printed and formatted for compatibility VS Code's Problems tab. Your library will be rebuilt if you make edits.

yarn build

Bundles the package to the dist and dist-web folder. The package is optimized and bundled with Rollup into multiple formats (CommonJS, UMD, and ES Module).

yarn test

Runs the test watcher (Jest) in an interactive mode. By default, runs tests related to files changed since the last commit.