Midnight Wallet API

Definition of the Midnight Wallet set of interfaces.

Structure

This is a plain yarn project that declares a set of TypeScript interfaces. All of them can be found in src/ directory.

Development setup

The tools with the corresponding versions used to build the code are listed in the .tool-versions file.

You can use asdf and just run asdf install to get the correct versions.

Another option is to use Nix. This project provides a flake with a devshell definition.

Configure Yarn with your credentials by following the Authentication setup document and setting the NODE_AUTH_TOKEN env variable. direnv is a recommended way to easily achieve this.

Lint

yarn eslint

Build

Remember to install the dependencies after cloning:

yarn install

Build:

yarn build

The generated TypeScript definitions and JavaScript code are written to dist/ directory.

Contributing

All new features must branch off the default branch main.

Release a new version

Please read our git workflow for how to branch and tag releases.

In order to release a new version, the version in package.json should be bumped.

After that, use the Releases feature from GitHub to create a tag with a name following the pattern vX.Y.Z. Cicero will detect it and automatically build and publish the new version.

Test

This is an interface only, without implementations, so no tests are provided. The CI will only try to lint and build the code to verify its correctness.

Documentation

To generate documentation files in docs folder:

yarn run build:markdown-docs