tari.js

This project provides a unified TypeScript library to connect and send requests to a Tari wallet. It's intended for web application developers that want to interact with a Tari wallet (connect, get substates, submit transactions, etc.).

Tari wallets supported:

• Tari Wallet Daemon
• MetaMask through the tari-snap

An example site (under the example folder) contains a web project that allows the user to connect to any type of Tari wallet and perform common actions.

Please read the TODO file for upcoming features.

Library building

You must have the tari-dan repo cloned at the same folder level as this repo.

Option 1: Local Build

To build the library locally: First you must install proto to manage node and pnpm versions

proto use
pnpm install
moon tarijs:build

The bundled files for deployment or publication will be located under the dist folder of each package.

Option 2: Docker Build

Alternatively, you can build the library using Docker:

# Build the Docker image
docker build -t tarijs .

# Run the container and copy the combined dist files
docker create --name tarijs-build tarijs
docker cp tarijs-build:/app/combined_dist/ ./dist
docker rm tarijs-build

This will create a combined build output in your local dist directory, containing all package distributions organized by package name, with the following structure:

dist/
├── tarijs/
├── tari_provider/
├── tari_permissions/
├── wallet_daemon/
├── tari_signer/
├── builders/
├── metamask_signer/
├── tari_universe/
├── tarijs_types/
├── indexer_provider/
└── walletconnect/

Each package's dist folder contains its compiled JavaScript files, type definitions, and other build artifacts, excluding node_modules.

Running the example site

To run the example site you will need to:

• Compile the library following the previous section.
• Have access to a Tari Wallet Daemon and to the Tari MetaMask Snap.
• Copy the example/.env.example file to example/.env and edit the correct environment variable values.

To run in development mode, in the packages/tarijs folder:

cd example
moon tarijs:build
pnpm run dev

For building and distribution, in the packages/tarijs folder

cd example
moon tarijs:build

The distribution files will be under the example/dist folder.

Documentation

This monorepo includes a documentation site located in the docusaurus folder. It's built using Docusaurus and generates a static website.

Modifying the Documentation

To start the documentation site:

$ moon tari-docs:start

This will open the documentation site in your browser at http://localhost:3000/tari.js/

You can now update the documentation by editing files in the docusaurus/tari-docs/docs/ folder. Changes will be reflected automatically.

Publishing documentation

The documentation is hosted on GitHub Pages and served from the /docs folder of the gh-pages branch. The documentation-deploy.yml workflow defines the deployment process.