Repository files navigation

Bitauth IDE is an online, integrated development environment for bitcoin (cash) contracts.

To get started, check out thebuilt-in guide. An introductory video is also availablein this blog post, and you can also get help or share feedback in theBitauth IDE Telegram group.

Unlocking scripts can be edited alongside the locking scripts they unlock. The interactive evaluation viewer is constantly updated to display every step of the resulting evaluation as you type.

Click on any stack item to log the program state at that step to the JavaScript developer console. TheLibauth library is available atwindow.libauth to make debugging easier.

Create and modify the templates entities and the variables they contribute to wallets and evaluations.

Review and modify the documentation included in the active template.

Projects can be shared and re-imported in JSON format via files, sharable links, or plain text.

Pull Requests are welcome!

This application requiresYarn for development. WithNode.js installed, theyarn package manager can be installed by runningcorepack enable. Onceyarn is installed:

git clone https://github.com/bitauth/bitauth-ide.gitcd bitauth-ideyarnyarn start

This will open Bitauth IDE in development mode.

Bitauth IDE usesYarn's Zero-Installs strategy – all ofBitauth IDE's dependencies are tracked in an independent git repository, and the dependency repo is automatically shallow-cloned into the.yarn directory.

To run all tests:

yarntest

To run all end-to-end tests locally, collect screenshots, and analyze code coverage:

yarn cov

Note that the end-to-end (e2e) tests also visually compare screenshots across test run. Because screenshots will differ slightly between platforms, this repo only stores and records results forlinux, the platform used by thecontinuous integration (CI) environment. Screenshots for macOS (darwin) and Windows (win32) are not committed to the repo, so you will need to run the tests once (prior to making any changes) to locally generate the baseline screenshots for your platform.

You can also run the e2e tests on the same platform as the CI environment using Docker. First, make sure Docker is running locally (consider usingDocker Desktop), then:

yarn start# in another tab:yarn e2e:docker

To run the e2e tests in Playwright's UI mode:

yarn e2e

To open the e2e test report in a browser (e.g. to review visual differences between screenshots):

yarn e2e:report

To build and run the production Progressive Web App (PWA):

yarn buildyarn preview